annotate vamp/load.py @ 81:0a2f2e7803ea

naming: PyPluginObject members snake_case

'''A high-level interface to the vampyhost extension module, for quickly and easily running Vamp audio analysis plugins on audio files and buffers.'''

import vampyhost

def list_plugins():
    return vampyhost.list_plugins()

def loadAndConfigureFor(data, sampleRate, key, parameters):
    plug = vampyhost.load_plugin(key, sampleRate,
                                vampyhost.ADAPT_INPUT_DOMAIN +
                                vampyhost.ADAPT_CHANNEL_COUNT)

    plug.set_parameter_values(parameters)

    stepSize = plug.get_preferred_step_size()
    blockSize = plug.get_preferred_block_size()

    if blockSize == 0:
        blockSize = 1024
    if stepSize == 0:
        stepSize = blockSize ##!!! or blockSize/2, but check this with input domain adapter

    channels = 1
    if data.ndim > 1:
        channels = data.shape[0]

    plug.initialise(channels, stepSize, blockSize)
    return (plug, stepSize, blockSize)