ayon_third_party

`ThirdPartyDistAddon`

Bases: AYONAddon, ITrayAddon

Addon to deploy 3rd party binary dependencies.

Addon can also skip distribution of binaries from server and can use path/arguments defined by server.

Cares about supplying ffmpeg and oiiotool executables.

Source code in client/ayon_third_party/addon.py

class ThirdPartyDistAddon(AYONAddon, ITrayAddon):
    """Addon to deploy 3rd party binary dependencies.

    Addon can also skip distribution of binaries from server and can
    use path/arguments defined by server.

    Cares about supplying ffmpeg and oiiotool executables.
    """

    name = ADDON_NAME
    version = __version__

    def initialize(self, settings: dict[str, Any]) -> None:
        self._download_window: Optional["DownloadWindow"] = None

    def tray_exit(self) -> None:
        pass

    def tray_menu(self, tray_menu) -> None:
        pass

    def tray_init(self) -> None:
        pass

    def tray_start(self) -> None:
        download_ffmpeg = is_ffmpeg_download_needed()
        download_oiio = is_oiio_download_needed()
        if not download_oiio and not download_ffmpeg:
            return

        from .download_ui import show_download_window

        download_window = show_download_window(
            download_ffmpeg, download_oiio
        )
        download_window.finished.connect(self._on_download_finish)
        download_window.start()
        self._download_window = download_window

    def _on_download_finish(self) -> None:
        self._download_window.close()
        self._download_window = None

`download_ffmpeg(progress=None)`

Download ffmpeg from server.

Todos

Add safeguard to avoid downloading of the file from multiple processes at once.

Parameters:

Name	Type	Description	Default
`progress`	`TransferProgress`	Keep track about download.	`None`

Source code in client/ayon_third_party/utils.py

def download_ffmpeg(
    progress: Optional[TransferProgress] = None,
):
    """Download ffmpeg from server.

    Todos:
        Add safeguard to avoid downloading of the file from multiple
            processes at once.

    Args:
        progress (ayon_api.TransferProgress): Keep track about download.

    """

    files_info = get_server_files_info()
    file_info = _find_file_info("ffmpeg", files_info)
    if file_info is None:
        raise ValueError((
            "Couldn't find ffmpeg source file for platform '{}'"
        ).format(platform.system()))

    dirpath = get_downloaded_ffmpeg_root()
    log.debug(f"Downloading ffmpeg into: '{dirpath}'")
    if not _download_file(file_info, dirpath, progress=progress):
        log.debug("Other processed already downloaded and extracted ffmpeg.")

    _FFmpegArgs.download_needed = False
    _FFmpegArgs.downloaded_root = NOT_SET

`get_ffmpeg_arguments(tool_name='ffmpeg')`

Get arguments to run one of ffmpeg tools.

Parameters:

Name	Type	Description	Default
`tool_name`	`FFmpegToolname`	Name of tool for which arguments should be returned.	`'ffmpeg'`

Returns:

Type	Description
`Optional[list[str]]`	list[str]: Path to OpenImageIO directory.

Source code in client/ayon_third_party/utils.py

def get_ffmpeg_arguments(
    tool_name: "FFmpegToolname" = "ffmpeg"
) -> Optional[list[str]]:
    """Get arguments to run one of ffmpeg tools.

    Args:
        tool_name (FFmpegToolname): Name of
            tool for which arguments should be returned.

    Returns:
        list[str]: Path to OpenImageIO directory.

    """
    args = _FFmpegArgs.tools.get(tool_name, NOT_SET)
    if args is NOT_SET:
        args = _fill_ffmpeg_tool_args(tool_name)
    return copy.deepcopy(args)

`get_oiio_arguments(tool_name='oiiotool')`

Get arguments to run one of OpenImageIO tools.

Possible OIIO tools

oiiotool, maketx, iv, iinfo, igrep, idiff, iconvert

Parameters:

Name	Type	Description	Default
`tool_name`	`OIIOToolName`	Name of OIIO tool.	`'oiiotool'`

Returns:

Name	Type	Description
`str`	`Optional[list[str]]`	Path to zip info file.

Source code in client/ayon_third_party/utils.py

def get_oiio_arguments(
    tool_name: "OIIOToolName" = "oiiotool"
) -> Optional[list[str]]:
    """Get arguments to run one of OpenImageIO tools.

    Possible OIIO tools:
        oiiotool, maketx, iv, iinfo, igrep, idiff, iconvert

    Args:
        tool_name (OIIOToolName): Name of OIIO tool.

    Returns:
        str: Path to zip info file.

    """
    args = _OIIOArgs.tools.get(tool_name, NOT_SET)
    if args is NOT_SET:
        args = _fill_oiio_tool_args(tool_name)
    return copy.deepcopy(args)

`is_ffmpeg_download_needed(addon_settings=None)`

Check if is download needed.

Returns:

Name	Type	Description
`bool`	`bool`	Should be config downloaded.

Source code in client/ayon_third_party/utils.py

def is_ffmpeg_download_needed(
    addon_settings: Optional[dict[str, Any]] = None
) -> bool:
    """Check if is download needed.

    Returns:
        bool: Should be config downloaded.

    """
    if _FFmpegArgs.download_needed is not None:
        return _FFmpegArgs.download_needed

    if addon_settings is None:
        addon_settings = get_addon_settings()
    ffmpeg_settings = addon_settings["ffmpeg"]
    download_needed = False
    if ffmpeg_settings["use_downloaded"]:
        # Check what is required by server
        ffmpeg_root = get_downloaded_ffmpeg_root()
        progress_info = {}
        if ffmpeg_root:
            progress_path = os.path.join(
                ffmpeg_root, DIST_PROGRESS_FILENAME
            )
            progress_info = _read_progress_file(progress_path)
        download_needed = progress_info.get("state") != "done"

    _FFmpegArgs.download_needed = download_needed
    return _FFmpegArgs.download_needed

`is_oiio_download_needed(addon_settings=None)`

Check if is download needed.

Returns:

Name	Type	Description
`bool`	`bool`	Should be config downloaded.

Source code in client/ayon_third_party/utils.py

def is_oiio_download_needed(
    addon_settings: Optional[dict[str, Any]] = None
) -> bool:
    """Check if is download needed.

    Returns:
        bool: Should be config downloaded.

    """
    if _OIIOArgs.download_needed is not None:
        return _OIIOArgs.download_needed

    if addon_settings is None:
        addon_settings = get_addon_settings()
    oiio_settings = addon_settings["oiio"]

    download_needed = False
    if oiio_settings["use_downloaded"]:
        oiio_root = get_downloaded_oiio_root()
        progress_info = {}
        if oiio_root:
            progress_path = os.path.join(
                oiio_root, DIST_PROGRESS_FILENAME
            )
            progress_info = _read_progress_file(progress_path)
        download_needed = progress_info.get("state") != "done"
    _OIIOArgs.download_needed = download_needed
    return _OIIOArgs.download_needed