validate.py

#!/usr/bin/env python

# Copyright (c) 2019 Collabora Ltd
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# SPDX-License-Identifier: MIT

import argparse
import renderdoc as rd
import re

GL_REGEX_MATCH = [
    re.compile('glDraw.*')
]

def loadCapture(filename):
	# Open a capture file handle
	cap = rd.OpenCaptureFile()

	# Open a particular file - see also OpenBuffer to load from memory
	status = cap.OpenFile(filename, '', None)

	# Make sure the file opened successfully
	if status != rd.ReplayStatus.Succeeded:
		raise RuntimeError("Couldn't open file: " + str(status))

	# Make sure we can replay
	if not cap.LocalReplaySupport():
		raise RuntimeError("Capture cannot be replayed")

	# Initialise the replay
	status,controller = cap.OpenCapture(rd.ReplayOptions(), None)

	if status != rd.ReplayStatus.Succeeded:
		raise RuntimeError("Couldn't initialise replay: " + str(status))

	return cap,controller

def checkGLCalls(d):
    for regex in GL_REGEX_MATCH:
        if (regex.match(d.name)):
            return True

    # Iterate over the draw's children
    for d in d.children:
        if(checkGLCalls(d)):
            return True
    return False

def analyze(controller):
	# Iterate over all of the root drawcalls
    for d in controller.GetDrawcalls():
    	if(checkGLCalls(d)):
            print("Trace appears to be valid")
            return

    print("Trace contains no valid gl* calls")

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('trace', help="Trace file")
    args = parser.parse_args()
    rd.InitialiseReplay(rd.GlobalEnvironment(), [])

    cap,controller = loadCapture(args.trace)
    analyze(controller)
    controller.Shutdown()
    cap.Shutdown()  
    rd.ShutdownReplay()
    

if __name__ == "__main__":
    main()