annotate native/PyPluginObject.h @ 151:5a6b8f4be9b9 tracks tip

Docs

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    VampyHost

    Use Vamp audio analysis plugins in Python

    Gyorgy Fazekas and Chris Cannam
    Centre for Digital Music, Queen Mary, University of London
    Copyright 2008-2015 Queen Mary, University of London
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Except as contained in this notice, the names of the Centre for
    Digital Music; Queen Mary, University of London; and the authors
    shall not be used in advertising or otherwise to promote the sale,
    use or other dealings in this Software without prior written
    authorization.
*/

#ifndef PYPLUGINOBJECT_H
#define PYPLUGINOBJECT_H

#include <Python.h>
#include <vamp-hostsdk/Plugin.h>

#include <string>

struct PyPluginObject
{
    PyObject_HEAD
    Vamp::Plugin *plugin;
    bool isInitialised;
    size_t channels;
    size_t blockSize;
    size_t stepSize;
    PyObject *info;
    int inputDomain;
    PyObject *parameters;
    PyObject *programs;
};

extern PyTypeObject Plugin_Type;
#define PyPlugin_Check(v) PyObject_TypeCheck(v, &Plugin_Type)

extern PyObject *
PyPluginObject_From_Plugin(Vamp::Plugin *);

#endif