Tools API Documentation

def __call__(self, inFilename: str, outFilename: str):
    """
    Internal call of the plugin, loads the plugin if necessary, then loads the input audio file and calls the
    `process` method.

    Args:
        inFilename: The path of the file to be processed
        outFilename: The path to which the processed file must be written
    """
    if not self._loaded:
        self.load()
        self._loaded = True
    loadSr = self.sr.value if self.sr.value else None
    data, self.sr.value = librosa.load(inFilename, sr=loadSr)
    self.process(data, outFilename)

def __init__(self, name: str, outType: FileType, icon: Optional[str] = 'settings', outExtension: Optional[str] = ''):
    """
    Creates a AudioPlugin instance.

    Args:
        name: The name is the plugin as it will be displayed within the web interface
        outType: The output type of the plugin
        icon: The name of the icon, must be one of the Angular Material Icon list
        outExtension: If specified, overrides the default file extension for the provided output file

    Note:
        Default file extensions for each type are:

        - Image: .png
        - Audio: .wav
        - Video: .mp4
        - Text: .txt
        - Misc: _no extension_
    """
    super(AudioPlugin, self).__init__(name, FileType.AUDIO, outType, icon, outExtension)

def process(self, data: np.ndarray, outFilename: str):
    """
    The main entrypoint of audio plugins, must be overriden in child class.
    The processed file must be saved at the path pointed by the argument `outFilename`.

    Args:
        data: The audio signal as a numpy ndarray
        outFilename: The path to which the processed file must be written
    """
    raise NotImplementedError

def __call__(self, inFilename: str, outFilename: str):
    """
    Internal call of the plugin, loads the plugin if necessary and calls the `process` method.

    Args:
        inFilename: The path of the file to be processed
        outFilename: The path to which the processed file must be written
    """
    if not self._loaded:
        self.load()
        self._loaded = True
    self.process(inFilename, outFilename)

def __init__(self, name: str, inType: FileType, outType: FileType, icon: Optional[str] = 'settings', outExtension: Optional[str] = ''):
    """
    Creates a BasePlugin instance.

    Args:
        name: The name is the plugin as it will be displayed within the web interface
        inType: The input type of the plugin
        outType: The output type of the plugin
        icon: The name of the icon, must be one of the Angular Material Icon list
        outExtension: If specified, overrides the default file extension for the provided output file

    Note:
        Default file extensions for each type are:

        - Image: .png
        - Audio: .wav
        - Video: .mp4
        - Text: .txt
        - Misc: _no extension_
    """
    self.name = name
    self.inType = inType
    self.outType = outType
    self.parameters = self._retrieveParameters(self.__class__, list())
    self.icon = icon
    if outExtension:
        self.outExtension = f".{outExtension.replace('.', '')}"
    else:
        self.outExtension = FileType.getDefaultExtension(self.outType)
    self._loaded = False

def getFileHash(self, dataFile: DataFile, params: dict) -> int:
    """
    Computes and returns a unique hash for the three elements:

    - Plugin
    - Input data file
    - Parameters

    Allows for caching already processed files.

    Args:
        dataFile: The DataFile instance of the file to process
        params: The user-specified parameters

    Returns:
        A unique hash for the combination (Plugin + File + Params)
    """
    parametersCopy = {name: parameter.value for name, parameter in self.parameters.items()}
    parametersCopy.update(params)
    parametersCopy["__datafile"] = dataFile.id
    parametersCopy["__plugin"] = self.name
    return hash(frozenset(parametersCopy.items()))

def load(self):
    """
    Can be overriden in child class. Will be called automatically once before the first call to `process` is issued.
    """
    pass

def process(self, inFilename: str, outFilename: str):
    """
    The main entrypoint of plugins, must be overriden in child class.
    The processed file must be saved at the path pointed by the argument `outFilename`.

    Args:
        inFilename: The path of the file to be processed
        outFilename: The path to which the processed file must be written
    """
    raise NotImplementedError

def setParameterValues(self, params: dict):
    """
    Overrides the values of all the parameters of the plugin to match the user-specified params dict.
    If not specified, they are set to their default value.

    Args:
        params: The user-specified params dict.
            The syntax of the latter is:
            ```python
            {
                "paramName1": value,
                "paramName2": value
            }
            ```
    """
    for parameter in self.parameters.values():
        parameter.reset()
    for name, value in params.items():
        self.parameters[name].value = value

def toJson(self) -> dict:
    """
    Generates and returns the JSON representation of the plugin.

    Returns:
        The JSON representation of the plugin as a dict
    """
    return {
        "className": self.__class__.__name__,
        "name": self.name,
        "inType": self.inType.value,
        "outType": self.outType.value,
        "parameters": [parameter.toJson(name) for name, parameter in self.parameters.items()],
        "icon": self.icon
    }

def __call__(self, inFilename, outFilename):
    """
    Internal call of the plugin, loads the plugin if necessary, then loads the input image file and calls the
    `process` method.

    Args:
        inFilename: The path of the file to be processed
        outFilename: The path to which the processed file must be written
    """
    if not self._loaded:
        self.load()
        self._loaded = True
    data = cv2.imread(inFilename)
    self.process(data, outFilename)

def __init__(self, name: str, outType: FileType, icon: Optional[str] = 'settings', outExtension: Optional[str] = ''):
    """
    Creates a ImagePlugin instance.

    Args:
        name: The name is the plugin as it will be displayed within the web interface
        outType: The output type of the plugin
        icon: The name of the icon, must be one of the Angular Material Icon list
        outExtension: If specified, overrides the default file extension for the provided output file

    Note:
        Default file extensions for each type are:

        - Image: .png
        - Audio: .wav
        - Video: .mp4
        - Text: .txt
        - Misc: _no extension_
    """
    super(ImagePlugin, self).__init__(name, FileType.IMAGE, outType, icon, outExtension)

def process(self, data: np.ndarray, outFilename):
    """
    The main entrypoint of image plugins, must be overriden in child class.
    The processed file must be saved at the path pointed by the argument `outFilename`.

    Args:
        data: The image as a numpy ndarray
        outFilename: The path to which the processed file must be written
    """
    raise NotImplementedError

def __init__(self, name: str, value: Union[int, float, str, bool]):
    """
    Create a PluginParameter instance.

    Args:
        name: The name of the parameter, it will be displayed within the web interface
        value: The default value of the parameter
    """
    self.name = name
    self.value = value
    self._defaultValue = value

def reset(self):
    """
    Sets back the value of the parameter to its default value.
    """
    self.value = self._defaultValue

def toJson(self, attributeName: str) -> dict:
    """
    Generates and returns the JSON representation of the parameter.

    Args:
        attributeName: The name of the Python instance

    Returns:
        The JSON representation of the parameter as a dict
    """
    return {
        "attributeName": attributeName,
        "name": self.name,
        "value": self._defaultValue,
        "default": self._defaultValue,
        "type": type(self.value).__name__
    }