resolve_api_probe.py

#!/usr/bin/env python
import os
import sys

# Open log file with buffering=1 (line buffered) at absolute workspace path
log_file = open(r"d:/04_ACTIVE_WORKBENCH/MetaFiller/probe_debug.log", "w", encoding="utf-8", buffering=1)
sys.stdout = log_file
sys.stderr = log_file

def log(msg):
    print(msg)
    log_file.flush()
    os.fsync(log_file.fileno())

def get_resolve():
    log("get_resolve: checking globals...")
    if "resolve" in globals():
        log("Connected via: Globals")
        return globals()["resolve"]

    log("get_resolve: checking PYTHONPATH/standard import...")
    try:
        log("Attempting DaVinciResolveScript import...")
        import DaVinciResolveScript as dvr_script
        log("Imported DaVinciResolveScript. Attempting scriptapp...")
        resolve = dvr_script.scriptapp("Resolve")
        if resolve:
            log("Connected via: DaVinciResolveScript import")
            return resolve
        else:
            log("scriptapp('Resolve') returned None")
    except Exception as e:
        log(f"Import/Connection failed: {e}")
    except BaseException as e:
        log(f"Import/Connection failed with BaseException: {e}")

    log("get_resolve: checking programdata path...")
    win_path = r"C:\ProgramData\Blackmagic Design\DaVinci Resolve\Support\Developer\Scripting\Modules"
    if os.path.exists(win_path):
        log(f"Adding path {win_path} to sys.path...")
        sys.path.append(win_path)
        try:
            log("Attempting import after sys.path addition...")
            import DaVinciResolveScript as dvr_script
            log("Imported DaVinciResolveScript. Attempting scriptapp...")
            resolve = dvr_script.scriptapp("Resolve")
            if resolve:
                log("Connected via: Import after adding sys.path")
                return resolve
            else:
                log("scriptapp('Resolve') returned None")
        except Exception as e:
            log(f"Import/Connection after path addition failed: {e}")
        except BaseException as e:
            log(f"Import/Connection after path addition failed with BaseException: {e}")
    else:
        log(f"Path does not exist: {win_path}")

    return None

def probe_resolve():
    log("probe_resolve started")
    resolve = get_resolve()
    if not resolve:
        log("ERROR: Could not connect to DaVinci Resolve. Ensure Resolve is running and scripting is enabled.")
        sys.exit(1)

    project_manager = resolve.GetProjectManager()
    project = project_manager.GetCurrentProject()
    if not project:
        log("ERROR: No project is currently open in DaVinci Resolve.")
        sys.exit(1)

    log(f"Current Project: {project.GetName()}")
    
    media_pool = project.GetMediaPool()
    root_folder = media_pool.GetRootFolder()
    clips = root_folder.GetClipList()
    
    if not clips:
        log("WARNING: Root folder of Media Pool is empty. Please import at least one clip to test metadata.")
        sys.exit(0)

    test_clip = clips[0]
    log(f"\n--- Clip Info ---")
    log(f"Clip Name: {test_clip.GetName()}")
    log(f"Clip Type: {test_clip.GetClipProperty('Type')}")

    log(f"\n--- Clip Metadata Dump (GetMetadata) ---")
    metadata = test_clip.GetMetadata()
    if metadata:
        for k, v in sorted(metadata.items()):
            log(f"  {k}: {v}")
    else:
        log("  No metadata found or returned None.")

    log(f"\n--- Clip Property Dump (GetClipProperty) ---")
    properties = test_clip.GetClipProperty()
    if properties:
        for k, v in sorted(properties.items()):
            log(f"  {k}: {v}")
    else:
        log("  No properties found or returned None.")

    log(f"\n--- Testing Metadata Setters ---")
    
    # scene/shot/take
    success_scene = test_clip.SetMetadata("Scene", "99")
    success_shot = test_clip.SetMetadata("Shot", "99 P/A")
    success_take = test_clip.SetMetadata("Take", "9")
    log(f"Set Scene to '99': {success_scene} (Current: {test_clip.GetMetadata('Scene')})")
    log(f"Set Shot to '99 P/A': {success_shot} (Current: {test_clip.GetMetadata('Shot')})")
    log(f"Set Take to '9': {success_take} (Current: {test_clip.GetMetadata('Take')})")
    
    # Camera #, Comments, Keywords
    success_camera = test_clip.SetMetadata("Camera #", "C")
    success_comments = test_clip.SetMetadata("Comments", "MetaFiller Probe Test")
    success_keywords = test_clip.SetMetadata("Keywords", "probe, test")
    log(f"Set Camera # to 'C': {success_camera} (Current: {test_clip.GetMetadata('Camera #')})")
    log(f"Set Comments to 'MetaFiller Probe Test': {success_comments} (Current: {test_clip.GetMetadata('Comments')})")
    log(f"Set Keywords to 'probe, test': {success_keywords} (Current: {test_clip.GetMetadata('Keywords')})")

    # Clip Color
    log(f"\n--- Testing Clip Color ---")
    original_color = test_clip.GetClipColor()
    log(f"Original Clip Color: {original_color}")
    
    success_color = test_clip.SetClipColor("Navy")
    log(f"Set Clip Color to 'Navy': {success_color} (Current: {test_clip.GetClipColor()})")
    
    # Restore original color
    if original_color:
        test_clip.SetClipColor(original_color)
    else:
        test_clip.SetClipColor("")

    # Flags
    log(f"\n--- Testing Flags ---")
    original_flags = test_clip.GetFlagList()
    log(f"Original Flags: {original_flags}")
    
    success_add_flag = test_clip.AddFlag("Red")
    log(f"Add 'Red' Flag: {success_add_flag} (Current Flags: {test_clip.GetFlagList()})")
    
    success_clear_flags = test_clip.ClearFlags()
    log(f"Clear Flags: {success_clear_flags} (Current Flags: {test_clip.GetFlagList()})")
    
    # Restore original flags
    if original_flags:
        for f in original_flags:
            test_clip.AddFlag(f)

    # 21.0.2 Tags / Take Tags
    log(f"\n--- Testing Tags / Take Status ---")
    tag_keys_to_test = ["Tag", "Take Tag", "Good Take", "Status", "Take Status", "Good/NG"]
    for key in tag_keys_to_test:
        prop_val = test_clip.GetClipProperty(key)
        meta_val = test_clip.GetMetadata(key)
        log(f"Key '{key}': GetClipProperty={prop_val}, GetMetadata={meta_val}")
        
    for key in ["Tag", "Take Tag"]:
        for val in ["Good Take", "Rejected", "Untagged", 1, 2, 0]:
            success_meta = test_clip.SetMetadata(key, str(val))
            success_prop = test_clip.SetClipProperty(key, val) if hasattr(test_clip, "SetClipProperty") else "SetClipProperty not supported"
            log(f"Set key '{key}' to '{val}': SetMetadata={success_meta}, SetClipProperty={success_prop} (Current metadata={test_clip.GetMetadata(key)}, property={test_clip.GetClipProperty(key)})")

    # Timeline Creation
    log(f"\n--- Testing Timeline Creation ---")
    try:
        test_timeline = media_pool.CreateTimelineFromClips("MetaFiller_Probe_Timeline", [test_clip])
        if test_timeline:
            log(f"SUCCESS: Created timeline 'MetaFiller_Probe_Timeline'")
        else:
            log("FAILED: CreateTimelineFromClips returned None")
    except Exception as e:
        log(f"ERROR testing timeline creation: {e}")

if __name__ == "__main__":
    probe_resolve()