FEAPIHostDeclarations.h

Go to the documentation of this file.

//     /*!  \file FEAPIHostDeclarations.h 
//          \brief host interface for Feature Extraction 
//           plugin API (FEAPI). */
//
//        Copyright (c) 2006-2007, Ircam-Centre Pomidou
//        All rights reserved.
//
//        Redistribution and use in source and binary forms, with or without 
//        modification, are permitted provided that the following conditions 
//        are met:
//
//        *   Redistributions of source code must retain the above copyright 
//            notice, this list of conditions and the following disclaimer. 
//        *   Redistributions in binary form must reproduce the above 
//            copyright notice, this list of conditions and the following 
//            disclaimer in the documentation and/or other materials 
//            provided with the distribution. 
//        *   Neither the name of the FEAPI development team nor the names 
//            of its contributors may be used to endorse or promote products 
//            derived from this software without specific prior written 
//            permission. 
//
//        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
//        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
//        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
//        FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
//        COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
//        INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
//        BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
//        LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
//        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
//        LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
//        ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
//        POSSIBILITY OF SUCH DAMAGE.
//

#ifndef FEAPI_HOST_HEADER_H
#define FEAPI_HOST_HEADER_H

#include "FEAPI.h"

#ifdef WIN32
#include <windows.h>            // needed for dll handling
#include <io.h>                 // needed for file parsing
#elif MAC
#include <Carbon/Carbon.h>
#endif

typedef struct PluginFunctions_
{
    // declare function pointers
    FEAPI_CreatePluginInstance_t           pFunCreateInstance;
    FEAPI_DestroyPluginInstance_t          pFunDestroyInstance;
    FEAPI_GetPluginAPIVersion_t            pFunGetApiVersion;
    FEAPI_InitializePlugin_t               pFunInitializePlugin;
    FEAPI_GetPluginName_t                  pFunGetPluginName;
    FEAPI_GetPluginVendor_t                pFunGetPluginVendor;
    FEAPI_GetPluginProperty_t              pFunGetPluginProperty;
    FEAPI_GetPluginId_t                    pFunGetPluginId;
    FEAPI_GetPluginVendorVersion_t         pFunGetPluginVendorVersion;
    FEAPI_GetPluginDescription_t           pFunGetPluginDescription;
    FEAPI_GetPluginCopyright_t             pFunGetPluginCopyright;
    FEAPI_GetPluginNumOfInputs_t           pFunGetNumberOfInputs;
    FEAPI_GetPluginInputDescription_t      pFunGetInputDescription;
    FEAPI_GetPluginNumOfResults_t          pFunGetNumberOfResults;
    FEAPI_GetPluginResultDescription_t     pFunGetResultDescription;
    FEAPI_GetPluginNumOfParameters_t       pFunGetNumberOfParameters;
    FEAPI_GetPluginParameterDescription_t  pFunGetParameterDescription;
    FEAPI_SetPluginParameter_t             pFunSetParameter;
    FEAPI_GetPluginParameter_t             pFunGetParameter;
    FEAPI_ProcessPlugin_t                  pFunProcess;
    FEAPI_ProcessPluginDone_t              pFunProcessDone;
    FEAPI_GetPluginSizeOfResult_t          pFunGetSizeOfResult;
    FEAPI_GetPluginResult_t                pFunGetResult;
    FEAPI_GetPluginResultLatency_t         pFunGetResultLatency;
    FEAPI_ResetPlugin_t                    pFunReset;
} FEAPI_PluginFunctions_t;
 

typedef struct PluginFileNames_ FEAPI_PluginFileNames_t;

struct PluginFileNames_
{
    char    acFilename[4096];
    int     iMajorVersion;
    FEAPI_PluginFileNames_t *pNextPlugin;
};


#ifdef WIN32
typedef HMODULE FEAPI_ModuleHandle_t;
#elif MAC
typedef CFBundleRef FEAPI_ModuleHandle_t;
#endif


#endif //FEAPI_HOST_HEADER_H

---