davinci-resolve-mcp 2.23.0

package/src/granular/folder.py

@@ -0,0 +1,287 @@
+"""Folder-oriented tools for media pool folders."""
+
+from src.granular.common import *  # noqa: F401,F403
+
+resolve = ResolveProxy()
+
+@mcp.tool()
+def export_folder(folder_name: str, export_path: str, export_type: str = "DRB") -> str:
+    """Export a folder to a DRB file or other format.
+    
+    Args:
+        folder_name: Name of the folder to export
+        export_path: Path to save the exported file
+        export_type: Export format (DRB is default and currently the only supported option)
+    """
+    pm, current_project = get_current_project()
+    if not current_project:
+        return "Error: No project currently open"
+    
+    media_pool = current_project.GetMediaPool()
+    if not media_pool:
+        return "Error: Failed to get Media Pool"
+    
+    # Find the folder by name
+    target_folder = None
+    root_folder = media_pool.GetRootFolder()
+    
+    if folder_name.lower() == "root" or folder_name.lower() == "master":
+        target_folder = root_folder
+    else:
+        # Search for the folder by name
+        folders = get_all_media_pool_folders(media_pool)
+        for folder in folders:
+            if folder.GetName() == folder_name:
+                target_folder = folder
+                break
+    
+    if not target_folder:
+        return f"Error: Folder '{folder_name}' not found in Media Pool"
+    
+    # Check if directory exists, create if not
+    export_dir = os.path.dirname(export_path)
+    if not os.path.exists(export_dir) and export_dir:
+        try:
+            os.makedirs(export_dir)
+        except Exception as e:
+            return f"Error creating directory for export: {str(e)}"
+    
+    # Export the folder
+    try:
+        result = target_folder.Export(export_path)
+        if result:
+            return f"Successfully exported folder '{folder_name}' to '{export_path}'"
+        else:
+            return f"Failed to export folder '{folder_name}'"
+    except Exception as e:
+        return f"Error exporting folder: {str(e)}"
+
+
+@mcp.tool()
+def transcribe_folder_audio(folder_name: str, language: str = "en-US") -> str:
+    """Transcribe audio for all clips in a folder.
+    
+    Args:
+        folder_name: Name of the folder containing clips to transcribe
+        language: Language code for transcription (default: en-US)
+    """
+    pm, current_project = get_current_project()
+    if not current_project:
+        return "Error: No project currently open"
+    
+    media_pool = current_project.GetMediaPool()
+    if not media_pool:
+        return "Error: Failed to get Media Pool"
+    
+    # Find the folder by name
+    target_folder = None
+    root_folder = media_pool.GetRootFolder()
+    
+    if folder_name.lower() == "root" or folder_name.lower() == "master":
+        target_folder = root_folder
+    else:
+        # Search for the folder by name
+        folders = get_all_media_pool_folders(media_pool)
+        for folder in folders:
+            if folder.GetName() == folder_name:
+                target_folder = folder
+                break
+    
+    if not target_folder:
+        return f"Error: Folder '{folder_name}' not found in Media Pool"
+    
+    # Transcribe audio in the folder
+    try:
+        result = target_folder.TranscribeAudio(language)
+        if result:
+            return f"Successfully started audio transcription for folder '{folder_name}' in language '{language}'"
+        else:
+            return f"Failed to start audio transcription for folder '{folder_name}'"
+    except Exception as e:
+        return f"Error during audio transcription: {str(e)}"
+
+
+@mcp.tool()
+def clear_folder_transcription(folder_name: str) -> str:
+    """Clear audio transcription for all clips in a folder.
+    
+    Args:
+        folder_name: Name of the folder to clear transcriptions from
+    """
+    pm, current_project = get_current_project()
+    if not current_project:
+        return "Error: No project currently open"
+    
+    media_pool = current_project.GetMediaPool()
+    if not media_pool:
+        return "Error: Failed to get Media Pool"
+    
+    # Find the folder by name
+    target_folder = None
+    root_folder = media_pool.GetRootFolder()
+    
+    if folder_name.lower() == "root" or folder_name.lower() == "master":
+        target_folder = root_folder
+    else:
+        # Search for the folder by name
+        folders = get_all_media_pool_folders(media_pool)
+        for folder in folders:
+            if folder.GetName() == folder_name:
+                target_folder = folder
+                break
+    
+    if not target_folder:
+        return f"Error: Folder '{folder_name}' not found in Media Pool"
+    
+    # Clear transcription for the folder
+    try:
+        result = target_folder.ClearTranscription()
+        if result:
+            return f"Successfully cleared audio transcription for folder '{folder_name}'"
+        else:
+            return f"Failed to clear audio transcription for folder '{folder_name}'"
+    except Exception as e:
+        return f"Error clearing audio transcription: {str(e)}"
+
+
+@mcp.tool()
+def get_folder_clip_list(folder_path: str = "") -> Dict[str, Any]:
+    """Get list of clips in a Media Pool folder.
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    clips = folder.GetClipList()
+    if clips:
+        return {"folder": folder.GetName(), "clips": [{"name": c.GetName(), "unique_id": c.GetUniqueId()} for c in clips]}
+    return {"folder": folder.GetName(), "clips": []}
+
+
+@mcp.tool()
+def get_folder_subfolder_list(folder_path: str = "") -> Dict[str, Any]:
+    """Get list of subfolders in a Media Pool folder.
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    subs = folder.GetSubFolderList()
+    if subs:
+        return {"folder": folder.GetName(), "subfolders": [{"name": s.GetName(), "unique_id": s.GetUniqueId()} for s in subs]}
+    return {"folder": folder.GetName(), "subfolders": []}
+
+
+@mcp.tool()
+def get_folder_is_stale(folder_path: str = "") -> Dict[str, Any]:
+    """Check if a Media Pool folder is stale (needs refresh).
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    return {"folder": folder.GetName(), "is_stale": bool(folder.GetIsFolderStale())}
+
+
+@mcp.tool()
+def get_folder_unique_id(folder_path: str = "") -> Dict[str, Any]:
+    """Get the unique ID of a Media Pool folder.
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    return {"folder": folder.GetName(), "unique_id": folder.GetUniqueId()}
+
+
+@mcp.tool()
+def folder_export(file_path: str, folder_path: str = "") -> Dict[str, Any]:
+    """Export a Media Pool folder to a file.
+
+    Args:
+        file_path: Absolute path for the export.
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    result = folder.Export(file_path)
+    return {"success": bool(result), "file_path": file_path}
+
+
+@mcp.tool()
+def folder_transcribe_audio(folder_path: str = "") -> Dict[str, Any]:
+    """Transcribe audio for all clips in a Media Pool folder.
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    result = folder.TranscribeAudio()
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def folder_clear_transcription(folder_path: str = "") -> Dict[str, Any]:
+    """Clear transcription for all clips in a Media Pool folder.
+
+    Args:
+        folder_path: Path from root. Empty for current folder.
+    """
+    _, mp, err = _get_mp()
+    if err:
+        return err
+    if folder_path:
+        folder = _navigate_to_folder(mp, folder_path)
+        if not folder:
+            return {"error": f"Folder '{folder_path}' not found"}
+    else:
+        folder = mp.GetCurrentFolder()
+    result = folder.ClearTranscription()
+    return {"success": bool(result)}

package/src/granular/gallery.py

@@ -0,0 +1,306 @@
+"""Gallery, still album, and powergrade tools."""
+
+from src.granular.common import *  # noqa: F401,F403
+
+resolve = ResolveProxy()
+
+@mcp.tool(annotations=READ_ONLY_TOOL)
+def get_gallery_album_name() -> Dict[str, Any]:
+    """Get the name of the current gallery album."""
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    name = gallery.GetAlbumName()
+    return {"album_name": name if name else ""}
+
+
+@mcp.tool()
+def set_gallery_album_name(name: str) -> Dict[str, Any]:
+    """Set the name of the current gallery album.
+
+    Args:
+        name: New album name.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    result = gallery.SetAlbumName(name)
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def get_gallery_still_albums() -> Dict[str, Any]:
+    """Get list of all gallery still albums."""
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    albums = gallery.GetGalleryStillAlbums()
+    return {"albums": [str(a) for a in albums] if albums else []}
+
+
+@mcp.tool()
+def get_gallery_power_grade_albums() -> Dict[str, Any]:
+    """Get list of all gallery power grade albums."""
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    albums = gallery.GetGalleryPowerGradeAlbums()
+    return {"albums": [str(a) for a in albums] if albums else []}
+
+
+@mcp.tool()
+def get_current_still_album() -> Dict[str, Any]:
+    """Get the current still album."""
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    album = gallery.GetCurrentStillAlbum()
+    return {"has_album": album is not None}
+
+
+@mcp.tool()
+def set_current_still_album(album_index: int) -> Dict[str, Any]:
+    """Set the current still album by index.
+
+    Args:
+        album_index: 0-based index of the album in GetGalleryStillAlbums() list.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    result = gallery.SetCurrentStillAlbum(albums[album_index])
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def create_gallery_still_album(album_name: str = "") -> Dict[str, Any]:
+    """Create a new gallery still album.
+
+    Args:
+        album_name: Optional name for the new album.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    if album_name:
+        album = gallery.CreateGalleryStillAlbum(album_name)
+    else:
+        album = gallery.CreateGalleryStillAlbum()
+    return {"success": album is not None}
+
+
+@mcp.tool()
+def create_gallery_power_grade_album(album_name: str = "") -> Dict[str, Any]:
+    """Create a new gallery power grade album.
+
+    Args:
+        album_name: Optional name for the new album.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    if album_name:
+        album = gallery.CreateGalleryPowerGradeAlbum(album_name)
+    else:
+        album = gallery.CreateGalleryPowerGradeAlbum()
+    return {"success": album is not None}
+
+
+@mcp.tool()
+def get_album_stills(album_index: int = 0) -> Dict[str, Any]:
+    """Get list of stills in a gallery album.
+
+    Args:
+        album_index: 0-based index of the album. Default: 0.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    if not gallery:
+        return {"error": "Failed to get Gallery"}
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    stills = albums[album_index].GetStills()
+    return {"still_count": len(stills) if stills else 0}
+
+
+@mcp.tool()
+def get_still_label(album_index: int, still_index: int) -> Dict[str, Any]:
+    """Get the label of a still in a gallery album.
+
+    Args:
+        album_index: 0-based album index.
+        still_index: 0-based still index.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    stills = albums[album_index].GetStills()
+    if not stills or still_index >= len(stills):
+        return {"error": f"No still at index {still_index}"}
+    label = albums[album_index].GetLabel(stills[still_index])
+    return {"label": label if label else ""}
+
+
+@mcp.tool()
+def set_still_label(album_index: int, still_index: int, label: str) -> Dict[str, Any]:
+    """Set the label of a still in a gallery album.
+
+    Args:
+        album_index: 0-based album index.
+        still_index: 0-based still index.
+        label: New label for the still.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    stills = albums[album_index].GetStills()
+    if not stills or still_index >= len(stills):
+        return {"error": f"No still at index {still_index}"}
+    result = albums[album_index].SetLabel(stills[still_index], label)
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def import_stills_to_album(album_index: int, file_paths: List[str]) -> Dict[str, Any]:
+    """Import stills from file paths into a gallery album.
+
+    Args:
+        album_index: 0-based album index.
+        file_paths: List of absolute file paths to import.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    result = albums[album_index].ImportStills(file_paths)
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def export_stills_from_album(album_index: int, folder_path: str, file_prefix: str = "still", format: str = "dpx") -> Dict[str, Any]:
+    """Export stills from a gallery album.
+
+    Args:
+        album_index: 0-based album index.
+        folder_path: Directory to export to.
+        file_prefix: Filename prefix. Default: 'still'.
+        format: File format (dpx, cin, tif, jpg, png, ppm, bmp, xpm, drx). Default: 'dpx'.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    stills = albums[album_index].GetStills()
+    if not stills:
+        return {"error": "No stills in album"}
+    result = albums[album_index].ExportStills(stills, folder_path, file_prefix, format)
+    return {"success": bool(result)}
+
+
+@mcp.tool()
+def delete_stills_from_album(album_index: int, still_indices: List[int]) -> Dict[str, Any]:
+    """Delete stills from a gallery album.
+
+    Args:
+        album_index: 0-based album index.
+        still_indices: List of 0-based still indices to delete.
+    """
+    resolve = get_resolve()
+    if resolve is None:
+        return {"error": "Not connected to DaVinci Resolve"}
+    project = resolve.GetProjectManager().GetCurrentProject()
+    if not project:
+        return {"error": "No project open"}
+    gallery = project.GetGallery()
+    albums = gallery.GetGalleryStillAlbums()
+    if not albums or album_index >= len(albums):
+        return {"error": f"No album at index {album_index}"}
+    stills = albums[album_index].GetStills()
+    if not stills:
+        return {"error": "No stills in album"}
+    to_delete = [stills[i] for i in still_indices if i < len(stills)]
+    result = albums[album_index].DeleteStills(to_delete)
+    return {"success": bool(result)}