Menu
▾
▴
[Feapi-commits] SF.net SVN: feapi: [65] trunk/FEAPI/include
|
From: <fea...@li...> - 2006-03-14 16:49:34
|
Revision: 65 Author: alex_lerch Date: 2006-03-14 08:49:03 -0800 (Tue, 14 Mar 2006) ViewCVS: http://svn.sourceforge.net/feapi/?rev=65&view=rev Log Message: ----------- Replaced the const variables in the API with enum. Note that the name of the values is slightly changed, unfortunately that could break existing hosts (replace FEAPI_ui* with FEAPI_k*). Under the reasonable assumption that there are no existing hosts, and for the sake of consistency, I changed them nevertheless. Modified Paths: -------------- trunk/FEAPI/build/Win/ExamplePluginFindRms/ExamplePluginFindRms.dsp trunk/FEAPI/build/Win/FEAPIHost_C/FEAPITestCL.dsp trunk/FEAPI/examples/host/FEAPI_MaxMSP_Host/feapi~.cpp trunk/FEAPI/examples/host/Host_C/FEAPIExampleHost_C.cpp trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindMax/FEAPIExamplePluginFindMax.cpp trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindRms/FEAPIExamplePluginFindRms.cpp trunk/FEAPI/examples/plugin/FEAPIExamplePluginLoudness/FEAPIExamplePluginLoudness.cpp trunk/FEAPI/examples/plugin/FEAPIExamplePluginSpectral/FEAPIExamplePluginSpectral.cpp trunk/FEAPI/examples/plugin/FEAPIExamplePluginZeroCrossings/FEAPIExamplePluginZeroCrossings.cpp trunk/FEAPI/include/FEAPI.h trunk/FEAPI/sdk/host/include/FEAPIPluginProxy.h trunk/FEAPI/sdk/plugin/include/FEAPIPluginBase.h trunk/FEAPI/sdk/plugin/src/FEAPIPluginBase.cpp Modified: trunk/FEAPI/build/Win/ExamplePluginFindRms/ExamplePluginFindRms.dsp =================================================================== --- trunk/FEAPI/build/Win/ExamplePluginFindRms/ExamplePluginFindRms.dsp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/build/Win/ExamplePluginFindRms/ExamplePluginFindRms.dsp 2006-03-14 16:49:03 UTC (rev 65) @@ -112,14 +112,6 @@ SOURCE=..\..\..\license\license.txt # End Source File # End Group -# Begin Group "Definition Files" - -# PROP Default_Filter "def" -# Begin Source File - -SOURCE=.\FEAPIExamplePluginFindRms.def -# End Source File -# End Group # Begin Group "FEAPI" # PROP Default_Filter "" Modified: trunk/FEAPI/build/Win/FEAPIHost_C/FEAPITestCL.dsp =================================================================== (Binary files differ) Modified: trunk/FEAPI/examples/host/FEAPI_MaxMSP_Host/feapi~.cpp =================================================================== --- trunk/FEAPI/examples/host/FEAPI_MaxMSP_Host/feapi~.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/host/FEAPI_MaxMSP_Host/feapi~.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -168,8 +168,8 @@ static void feapi_getname(feapi_t *self) { CFEAPIPluginProxy &plugin = self->plugin; - char text[FEAPI_uiMaxNameLength]; - memset(text,0,FEAPI_uiMaxNameLength); + char text[FEAPI_kMaxNameLength]; + memset(text,0,FEAPI_kMaxNameLength); plugin.GetPluginName(text); t_atom atoms[1]; @@ -182,8 +182,8 @@ static void feapi_getid(feapi_t *self) { CFEAPIPluginProxy &plugin = self->plugin; - char text[FEAPI_uiMaxNameLength]; - memset(text,0,FEAPI_uiMaxNameLength); + char text[FEAPI_kMaxNameLength]; + memset(text,0,FEAPI_kMaxNameLength); plugin.GetPluginId(text); t_atom atoms[1]; @@ -195,8 +195,8 @@ static void feapi_getcopyright(feapi_t *self) { CFEAPIPluginProxy &plugin = self->plugin; - char text[FEAPI_uiMaxUnitLength]; - memset(text,0,FEAPI_uiMaxUnitLength); + char text[FEAPI_kMaxUnitLength]; + memset(text,0,FEAPI_kMaxUnitLength); plugin.GetPluginCopyright(text); t_atom atoms[1]; @@ -208,8 +208,8 @@ static void feapi_getdescription(feapi_t *self) { CFEAPIPluginProxy &plugin = self->plugin; - char text[FEAPI_uiMaxDescriptionLength]; - memset(text,0,FEAPI_uiMaxDescriptionLength); + char text[FEAPI_kMaxDescriptionLength]; + memset(text,0,FEAPI_kMaxDescriptionLength); plugin.GetPluginDescription(text); t_atom atoms[1]; @@ -221,8 +221,8 @@ static void feapi_getvendor(feapi_t *self) { CFEAPIPluginProxy &plugin = self->plugin; - char text[FEAPI_uiMaxNameLength]; - memset(text,0,FEAPI_uiMaxNameLength); + char text[FEAPI_kMaxNameLength]; + memset(text,0,FEAPI_kMaxNameLength); plugin.GetPluginVendor(text); t_atom atoms[1]; @@ -241,9 +241,9 @@ CFEAPIPluginProxy &plugin = self->plugin; FEAPI_ParameterDescription_t description; - memset(description.acDescription,0,FEAPI_uiMaxDescriptionLength); - memset(description.acName,0,FEAPI_uiMaxNameLength); - memset(description.acUnit,0,FEAPI_uiMaxUnitLength); + memset(description.acDescription,0,FEAPI_kMaxDescriptionLength); + memset(description.acName,0,FEAPI_kMaxNameLength); + memset(description.acUnit,0,FEAPI_kMaxUnitLength); if(plugin.GetPluginParameterDescription(i,&description) != FEAPI_kNoError) return; @@ -287,9 +287,9 @@ CFEAPIPluginProxy &plugin = self->plugin; FEAPI_SignalDescription_t description; - memset(description.acDescription,0,FEAPI_uiMaxDescriptionLength); - memset(description.acName,0,FEAPI_uiMaxNameLength); - memset(description.acUnit,0,FEAPI_uiMaxUnitLength); + memset(description.acDescription,0,FEAPI_kMaxDescriptionLength); + memset(description.acName,0,FEAPI_kMaxNameLength); + memset(description.acUnit,0,FEAPI_kMaxUnitLength); if(plugin.GetPluginResultDescription(i,&description) != FEAPI_kNoError) return; @@ -416,8 +416,8 @@ if(plugin.Create() != FEAPI_kNoError) throw std::runtime_error("can't instantiate feapi plugin"); - char name[FEAPI_uiMaxNameLength]; - memset(name,0,FEAPI_uiMaxNameLength); + char name[FEAPI_kMaxNameLength]; + memset(name,0,FEAPI_kMaxNameLength); plugin.GetPluginName(name); #ifdef NDEBUG post(name); @@ -526,7 +526,7 @@ void feapi_assist (feapi_t *self, void *box, long msg,long arg, char *dst) { long maxsize = 64; - //long size = FEAPI_uiMaxNameLength; // max crashes with 1024 + //long size = FEAPI_kMaxNameLength; // max crashes with 1024 if (msg==ASSIST_INLET) { Modified: trunk/FEAPI/examples/host/Host_C/FEAPIExampleHost_C.cpp =================================================================== --- trunk/FEAPI/examples/host/Host_C/FEAPIExampleHost_C.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/host/Host_C/FEAPIExampleHost_C.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -76,7 +76,7 @@ char *pcInputPath = 0, *pcOutputPath = 0, - acResult[FEAPI_uiMaxDescriptionLength]; + acResult[FEAPI_kMaxDescriptionLength]; int iNumOfFramesNeeded = 0, iNumFramesRead = 0, Modified: trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindMax/FEAPIExamplePluginFindMax.cpp =================================================================== --- trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindMax/FEAPIExamplePluginFindMax.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindMax/FEAPIExamplePluginFindMax.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -206,10 +206,10 @@ //tmp.append (itoa(iInputIndex,actmp,10)); //itoa is not standard sprintf(actmp,"%d",iInputIndex); tmp.append(actmp); - tmp.copy (pstInputDescription->acName, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acName, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); - tmp.copy (pstInputDescription->acUnit, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acUnit, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); strcpy (pstInputDescription->acDescription, pstInputDescription->acName); Modified: trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindRms/FEAPIExamplePluginFindRms.cpp =================================================================== --- trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindRms/FEAPIExamplePluginFindRms.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/plugin/FEAPIExamplePluginFindRms/FEAPIExamplePluginFindRms.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -177,10 +177,10 @@ //tmp.append (itoa(iInputIndex,actmp,10)); //itoa is not standard sprintf(actmp,"%d",iInputIndex); tmp.append(actmp); - tmp.copy (pstInputDescription->acName, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acName, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); - tmp.copy (pstInputDescription->acUnit, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acUnit, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); strcpy (pstInputDescription->acDescription, pstInputDescription->acName); Modified: trunk/FEAPI/examples/plugin/FEAPIExamplePluginLoudness/FEAPIExamplePluginLoudness.cpp =================================================================== --- trunk/FEAPI/examples/plugin/FEAPIExamplePluginLoudness/FEAPIExamplePluginLoudness.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/plugin/FEAPIExamplePluginLoudness/FEAPIExamplePluginLoudness.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -462,10 +462,10 @@ char actmp[100]; sprintf(actmp,"%d",iInputIndex); tmp.append (actmp); - tmp.copy (pstInputDescription->acName, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acName, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); - tmp.copy (pstInputDescription->acUnit, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acUnit, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); strcpy (pstInputDescription->acDescription, pstInputDescription->acName); Modified: trunk/FEAPI/examples/plugin/FEAPIExamplePluginSpectral/FEAPIExamplePluginSpectral.cpp =================================================================== --- trunk/FEAPI/examples/plugin/FEAPIExamplePluginSpectral/FEAPIExamplePluginSpectral.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/plugin/FEAPIExamplePluginSpectral/FEAPIExamplePluginSpectral.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -400,10 +400,10 @@ std::string tmp = "Channel: "; char actmp[100] ; tmp.append (itoa(iInputIndex,actmp,10)); - tmp.copy (pstInputDescription->acName, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acName, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); - tmp.copy (pstInputDescription->acUnit, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acUnit, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); strcpy (pstInputDescription->acDescription, pstInputDescription->acName); Modified: trunk/FEAPI/examples/plugin/FEAPIExamplePluginZeroCrossings/FEAPIExamplePluginZeroCrossings.cpp =================================================================== --- trunk/FEAPI/examples/plugin/FEAPIExamplePluginZeroCrossings/FEAPIExamplePluginZeroCrossings.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/examples/plugin/FEAPIExamplePluginZeroCrossings/FEAPIExamplePluginZeroCrossings.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -270,10 +270,10 @@ char actmp[100] ; sprintf(actmp,"%d",iInputIndex); tmp.append (actmp); - tmp.copy (pstInputDescription->acName, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acName, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); - tmp.copy (pstInputDescription->acUnit, FEAPI_uiMaxNameLength); + tmp.copy (pstInputDescription->acUnit, FEAPI_kMaxNameLength); tmp.erase (0, tmp.length ()); strcpy (pstInputDescription->acDescription, pstInputDescription->acName); Modified: trunk/FEAPI/include/FEAPI.h =================================================================== --- trunk/FEAPI/include/FEAPI.h 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/include/FEAPI.h 2006-03-14 16:49:03 UTC (rev 65) @@ -119,35 +119,7 @@ // POSSIBILITY OF SUCH DAMAGE. // //////////////////////////////////////////////////////////////////////////////////// -// CVS INFORMATION -// -// $RCSfile$ -// $Author$ -// $Date$ -// -// $Log$ -// Revision 1.1.2.1 2006/01/19 14:06:57 remymuller -// directory reorganization -// -// Revision 1.2.2.1 2006/01/19 13:27:13 remymuller -// directory reorganization -// -// Revision 1.2 2005/05/20 17:08:36 alex_lerch -// - updated documentation -// - added "signal" typedef for inputs and results -// - changed function PluginCanDo to PluginGetProperty and changed the function itself to return values instead of bools -// - cosmetic changes -// -// Revision 1.1.1.1 2005/03/30 14:54:40 alex_lerch -// first draft version requiring several updates: -// - interface check -// - check of plugin base class -// - implementation of host base class -// - update of outdated documentation -// -// //////////////////////////////////////////////////////////////////////////////////// -//////////////////////////////////////////////////////////////////////////////////// // !!!Do never ever edit this file!!! //////////////////////////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////////////////////////// @@ -160,24 +132,27 @@ extern "C" { #endif -/* Maximum string lengths. */ -const unsigned int FEAPI_uiMaxNameLength = 1024; //!< maximum number of characters for a name string (including null terminator) -const unsigned int FEAPI_uiMaxUnitLength = 1024; //!< maximum number of characters for a unit string (including null terminator) -const unsigned int FEAPI_uiMaxDescriptionLength = 4096; //!< maximum number of characters for a description string (including null terminator) - //////////////////////////////////////////////////////////////////////////////////// // interface structures and types /** @defgroup types Interface Structures and Types * @{ */ +/* Maximum string lengths in API */ +typedef enum FEAPI_MaxStringLengths_t_tag +{ + FEAPI_kMaxNameLength = 1024, //!< maximum number of characters for a name string (including null terminator) + FEAPI_kMaxUnitLength = 1024, //!< maximum number of characters for a unit string (including null terminator) + FEAPI_kMaxDescriptionLength = 4096 //!< maximum number of characters for a description string (including null terminator) +} FEAPI_MaxStringLengths_t; + /*! Structure describing properties and other information about one result/feature. */ typedef struct FEAPI_SignalDescription_t_tag { - char acName[FEAPI_uiMaxNameLength]; //!< name of the result/feature (e.g. "Spectral Centroid", "Loudness", etc.) - char acUnit[FEAPI_uiMaxUnitLength]; //!< unit of the result/feature (e.g. "dB", "sone", "Hz", etc.) - char acDescription[FEAPI_uiMaxDescriptionLength]; //!< description of the result/feature (clear text description) + char acName[FEAPI_kMaxNameLength]; //!< name of the result/feature (e.g. "Spectral Centroid", "Loudness", etc.) + char acUnit[FEAPI_kMaxUnitLength]; //!< unit of the result/feature (e.g. "dB", "sone", "Hz", etc.) + char acDescription[FEAPI_kMaxDescriptionLength]; //!< description of the result/feature (clear text description) float fRangeMin; //!< minimum value of the result/feature (if no minimum value: minimum floating point value) float fRangeMax; //!< maximum value of the result/feature (if no maximum value: maximum floating point value) float fQuantizedTo; //!< quantization step size of the result/feature (e.g. 1 for integer result, -1 for no quantization) @@ -188,21 +163,21 @@ /*! Structure describing properties and other information about one parameter. */ typedef struct FEAPI_ParameterDescription_t_tag { - char acName[FEAPI_uiMaxNameLength]; //!< name of the parameter (e.g. "Gain", "Sensitivity", etc.) - char acUnit[FEAPI_uiMaxUnitLength]; //!< unit of the parameter (e.g. "dB", "Hz", etc.) - char acDescription[FEAPI_uiMaxDescriptionLength]; //!< description of the parameter (clear text description) + char acName[FEAPI_kMaxNameLength]; //!< name of the parameter (e.g. "Gain", "Sensitivity", etc.) + char acUnit[FEAPI_kMaxUnitLength]; //!< unit of the parameter (e.g. "dB", "Hz", etc.) + char acDescription[FEAPI_kMaxDescriptionLength]; //!< description of the parameter (clear text description) float fRangeMin, //!< minimum value of the parameter (if no minimum value: minimum floating point value) fRangeMax, //!< maximum value of the parameter (if no maximum value: maximum floating point value) fDefaultValue; //!< default value for the parameter float fQuantizedTo; //!< quantization step size of the parameter (e.g. 1 for integer quantization, -1 for no quantization) - int bIsChangeableInRealTime;//!< 0/false if the parameter has to be set before the processing starts and can not be changed during processing, 1 if the parameter can be changed during processing + int bIsChangeableInRealTime;//!< 0/false if the parameter has to be set before the processing starts and can not be changed during processing, 1 if the parameter can be changed during processing (*NOTE: you have to call initialize after changing a non-realtime parameter*) } FEAPI_ParameterDescription_t; /*! Structure for user/vendor defined commands. */ typedef struct FEAPI_UserData_t_tag { - char *pcUserString; //!< user defined string value (memory could be freed by host after function call) + char *pcUserString; //!< user defined string value (memory could be freed by host after function call, it has to be copied internally) void *pcUserData; //!< pointer to user defined data } FEAPI_UserData_t; @@ -223,7 +198,8 @@ /*! Enumerator for possible error return values, if any other value than FEAPI_kNoError is returned, the function was not able to execute the specified operation(s).<br> - All error defines are negative. */ + All error defines are negative. + \todo add more errors */ typedef enum FEAPI_Error_t_tag { FEAPI_kNoError = 0, //!< no error occurred @@ -278,13 +254,14 @@ typedef FEAPI_Error_t (*FEAPI_DestroyPluginInstance_t) ( FEAPI_PluginInstance_t *phInstanceHandle ); /*! - * initializes a new instance of the plugin + * initializes a new instance of the plugin, has to be called before processing and after changing a + * non-realtime parameter * * @param hInstanceHandle : handle to the instance * @param fInputSampleRate : sample rate of input(s) in Hz * @param iNumberOfAudioChannels : number of input audio channels - * @param iHostApiMajorVersion : major version number of host - * @param pstUserData : pointer to user or vendor defined data (may be NULL) + * @param iHostApiMajorVersion : major version number of *host* + * @param pstUserData : pointer to user/vendor defined data (may be NULL) * * @return FEAPI_Error_t : FEAPI_kNoError when no error */ @@ -300,7 +277,7 @@ * This is *not* the plugin version, therefore the function may be called without a previously * created instance. * - * @param eAPIMajorMinorOrSubVersion : flag which version type is requested + * @param eAPIMajorMinorOrSubVersion : flag to indicate which version type is requested * @return int : requested version number */ typedef int (*FEAPI_GetPluginAPIVersion_t) ( FEAPI_VersionInfo_t eAPIMajorMinorOrSubVersion ); //!< \todo change ints to (unsigned) ints where appropriate? @@ -310,7 +287,7 @@ * Gets the name of the plugin. * * @param hInstanceHandle : handle to instance - * @param *pcPluginName : pointer to buffer of FEAPI_uiMaxNameLength chars, the name will be copied to this buffer + * @param *pcPluginName : pointer to buffer of FEAPI_kMaxNameLength chars, the name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ typedef FEAPI_Error_t (*FEAPI_GetPluginName_t) ( FEAPI_PluginInstance_t hInstanceHandle, @@ -320,7 +297,7 @@ * Gets the vendor name of the plugin. * * @param hInstanceHandle : handle to instance - * @param *pcPluginVendor : pointer to buffer of FEAPI_uiMaxNameLength chars, the vendor name will be copied to this buffer + * @param *pcPluginVendor : pointer to buffer of FEAPI_kMaxNameLength chars, the vendor name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ typedef FEAPI_Error_t (*FEAPI_GetPluginVendor_t) (FEAPI_PluginInstance_t hInstanceHandle, @@ -340,7 +317,7 @@ * Gets the (vendor unique) plugin identification string. * * @param hInstanceHandle : handle to instance - * @param *pcPluginId : pointer to buffer of FEAPI_uiMaxNameLength chars, the id will be copied to this buffer + * @param *pcPluginId : pointer to buffer of FEAPI_kMaxNameLength chars, the id will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ typedef FEAPI_Error_t (*FEAPI_GetPluginId_t) (FEAPI_PluginInstance_t hInstanceHandle, @@ -360,7 +337,7 @@ * Gets the description of the plugin, containing information about what the plugin actually does. * * @param hInstanceHandle : handle to instance - * @param *pcPluginDescription : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin description will be copied to this buffer + * @param *pcPluginDescription : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin description will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ typedef FEAPI_Error_t (*FEAPI_GetPluginDescription_t) (FEAPI_PluginInstance_t hInstanceHandle, @@ -370,7 +347,7 @@ * Gets the copyright information for the plugin. * * @param hInstanceHandle : handle to instance - * @param *pcPluginCopyright : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer + * @param *pcPluginCopyright : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ typedef FEAPI_Error_t (*FEAPI_GetPluginCopyright_t) (FEAPI_PluginInstance_t hInstanceHandle, @@ -464,7 +441,7 @@ typedef FEAPI_Error_t (*FEAPI_ProcessPluginDone_t) (FEAPI_PluginInstance_t hInstanceHandle); /*! - * Gets the number of results/features to be calculated. + * Returns the number of results/features to be calculated. One result/feature can be a scalar or n-dimensional. * * @param hInstanceHandle : handle to instance * @return int : number of results @@ -484,11 +461,11 @@ FEAPI_SignalDescription_t *pstResultDescription); /*! - * Gets the size of one result in FEAPI_Signal_t values (4 bytes per value). + * Gets the size of one result in FEAPI_Signal_t values (4 bytes per value). * * @param hInstanceHandle : handle to instance * @param iResultIndex : index of the result/feature the size is requested for, index ranges from 0...NumOfResults-1 - * @return int : size of result in FEAPI_Signal_t values (4 bytes per value) + * @return int : size of result in FEAPI_Signal_t values (4 bytes per value). If the result/feature is a scalar, the return value is *always* 1. */ typedef int (*FEAPI_GetPluginSizeOfResult_t) (FEAPI_PluginInstance_t hInstanceHandle, int iResultIndex); Modified: trunk/FEAPI/sdk/host/include/FEAPIPluginProxy.h =================================================================== --- trunk/FEAPI/sdk/host/include/FEAPIPluginProxy.h 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/sdk/host/include/FEAPIPluginProxy.h 2006-03-14 16:49:03 UTC (rev 65) @@ -112,7 +112,7 @@ /*! * Gets the name of the plugin. * - * @param *pcPluginName : pointer to buffer of FEAPI_uiMaxNameLength chars, the name will be copied to this buffer + * @param *pcPluginName : pointer to buffer of FEAPI_kMaxNameLength chars, the name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginName ( char *pcPluginName); @@ -120,7 +120,7 @@ /*! * Gets the vendor name of the plugin. * - * @param *pcPluginVendor : pointer to buffer of FEAPI_uiMaxNameLength chars, the vendor name will be copied to this buffer + * @param *pcPluginVendor : pointer to buffer of FEAPI_kMaxNameLength chars, the vendor name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginVendor ( char *pcPluginVendor); @@ -136,7 +136,7 @@ /*! * Gets the (vendor unique) plugin identification string. * - * @param *pcPluginId : pointer to buffer of FEAPI_uiMaxNameLength chars, the id will be copied to this buffer + * @param *pcPluginId : pointer to buffer of FEAPI_kMaxNameLength chars, the id will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginId ( char *pcPluginId); @@ -152,7 +152,7 @@ /*! * Gets the description of the plugin, containing information about what the plugin actually does. * - * @param *pcPluginDescription : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin description will be copied to this buffer + * @param *pcPluginDescription : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin description will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginDescription (char *pcPluginDescription); @@ -160,7 +160,7 @@ /*! * Gets the copyright information for the plugin. * - * @param *pcPluginCopyright : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer + * @param *pcPluginCopyright : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginCopyright (char *pcPluginCopyright); Modified: trunk/FEAPI/sdk/plugin/include/FEAPIPluginBase.h =================================================================== --- trunk/FEAPI/sdk/plugin/include/FEAPIPluginBase.h 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/sdk/plugin/include/FEAPIPluginBase.h 2006-03-14 16:49:03 UTC (rev 65) @@ -122,7 +122,7 @@ /*! * Gets the name of the plugin. * - * @param *pcPluginName : pointer to buffer of FEAPI_uiMaxNameLength chars, the name will be copied to this buffer + * @param *pcPluginName : pointer to buffer of FEAPI_kMaxNameLength chars, the name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginName ( char *pcPluginName); @@ -130,7 +130,7 @@ /*! * Gets the vendor name of the plugin. * - * @param *pcPluginVendor : pointer to buffer of FEAPI_uiMaxNameLength chars, the vendor name will be copied to this buffer + * @param *pcPluginVendor : pointer to buffer of FEAPI_kMaxNameLength chars, the vendor name will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginVendor ( char *pcPluginVendor); @@ -146,7 +146,7 @@ /*! * Gets the (vendor unique) plugin identification string. * - * @param *pcPluginId : pointer to buffer of FEAPI_uiMaxNameLength chars, the id will be copied to this buffer + * @param *pcPluginId : pointer to buffer of FEAPI_kMaxNameLength chars, the id will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginId ( char *pcPluginId); @@ -162,7 +162,7 @@ /*! * Gets the description of the plugin, containing information about what the plugin actually does. * - * @param *pcPluginDescription : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin description will be copied to this buffer + * @param *pcPluginDescription : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin description will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginDescription (char *pcPluginDescription); @@ -170,7 +170,7 @@ /*! * Gets the copyright information for the plugin. * - * @param *pcPluginCopyright : pointer to buffer of FEAPI_uiMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer + * @param *pcPluginCopyright : pointer to buffer of FEAPI_kMaxDescriptionLength chars, the plugin copyright information will be copied to this buffer * @return FEAPI_Error_t : FEAPI_kNoError when no error */ FEAPI_Error_t GetPluginCopyright (char *pcPluginCopyright); Modified: trunk/FEAPI/sdk/plugin/src/FEAPIPluginBase.cpp =================================================================== --- trunk/FEAPI/sdk/plugin/src/FEAPIPluginBase.cpp 2006-03-14 11:15:31 UTC (rev 64) +++ trunk/FEAPI/sdk/plugin/src/FEAPIPluginBase.cpp 2006-03-14 16:49:03 UTC (rev 65) @@ -169,20 +169,20 @@ FEAPI_Error_t CFeatureExtractBase::GetPluginName (char *pcPluginName) { - m_cPluginName.copy (pcPluginName, FEAPI_uiMaxNameLength); + m_cPluginName.copy (pcPluginName, FEAPI_kMaxNameLength); return FEAPI_kNoError; } FEAPI_Error_t CFeatureExtractBase::GetPluginVendor (char *pcPluginVendor) { - m_cPluginVendor.copy (pcPluginVendor, FEAPI_uiMaxNameLength); + m_cPluginVendor.copy (pcPluginVendor, FEAPI_kMaxNameLength); return FEAPI_kNoError; } FEAPI_Error_t CFeatureExtractBase::GetPluginId (char *pcPluginId) { - m_cPluginId.copy (pcPluginId, FEAPI_uiMaxNameLength); + m_cPluginId.copy (pcPluginId, FEAPI_kMaxNameLength); return FEAPI_kNoError; } @@ -213,14 +213,14 @@ FEAPI_Error_t CFeatureExtractBase::GetPluginDescription (char *pcPluginDescription) { - m_cPluginDescription.copy (pcPluginDescription, FEAPI_uiMaxDescriptionLength); + m_cPluginDescription.copy (pcPluginDescription, FEAPI_kMaxDescriptionLength); return FEAPI_kNoError; } FEAPI_Error_t CFeatureExtractBase::GetPluginCopyright (char *pcPluginCopyright) { - m_cPluginCopyRight.copy (pcPluginCopyright, FEAPI_uiMaxNameLength); + m_cPluginCopyRight.copy (pcPluginCopyright, FEAPI_kMaxNameLength); return FEAPI_kNoError; } This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
