FEAPIExamplePluginZeroCrossings.h

Go to the documentation of this file.

//     /*! \file FEAPIExamplePluginZeroCrossings.h: \brief interface of the CZeroCrossings class. */
//
//        Copyright (c) 2005-2007, Alexander Lerch, zplane.development GbR
//        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.
//

#if !defined(ZERO_CROSSINGS_HEADER_INCLUDED__)
#define ZERO_CROSSINGS_HEADER_INCLUDED__


#include "FEAPIPluginBase.h"

template <class T>  class CRingBuffer; 

class CZeroCrossings : public CFeatureExtractBase
{
public:

    CZeroCrossings ();
    
    virtual ~CZeroCrossings ();


    // method declaration
    // if you do not intend to use some of these functions, just delete them and the default 
    // values will be returned

    FEAPI_Error_t      SetPluginParameter ( int iParameterIndex, 
                                            float fValue);

    float              GetPluginParameter ( int iParameterIndex);


    int                GetPluginResultLatency (int iResultIndex);

    float              GetPluginProperty (  FEAPI_PluginProperty_t ePluginProperty);

    FEAPI_Error_t      InitializePlugin (   float               fInputSampleRate, 
                                            int                 iNumberOfAudioChannels,
                                            int                 iHostApiMajorVersion,
                                            FEAPI_UserData_t     *pstUserData);

    FEAPI_Error_t      ProcessPlugin (  const float             **ppfInputBuffer, 
                                        const FEAPI_TimeStamp_t *ptFEAPI_TimeStamp,
                                        int                     iNumberOfFrames);

    FEAPI_Error_t      ProcessPluginDone ();


    int                GetPluginSizeOfResult (int iResultIndex);

    FEAPI_Error_t      GetPluginResult (     int iResultIndex, 
                                float *pfResult,
                                FEAPI_TimeStamp_t *ptFEAPI_TimeStamp);


    FEAPI_Error_t      ResetPlugin ();

private:

    struct InternalResults_t
    {
        bool                bHoldsResult;
        float               fResult;
        FEAPI_TimeStamp_t   tTimeStamp;
    };

    void WriteResult (int iResultIdx, float fValue, FEAPI_TimeStamp_t tTimStamp);

    // remove and add variables acc. your needs
    FEAPI_SignalDescription_t m_stResultDescription;
    FEAPI_TimeStamp_t         *m_ptLocalTimeStamp;


    float   m_afParameters[3],
            *m_pfProcessBuffer;

    CRingBuffer<float>  **m_ppCRingBuffer;

    InternalResults_t   **m_ppResults;

    int                 m_iSizeOfResultBuffer;
};

#endif // #if !defined(ZERO_CROSSINGS_HEADER_INCLUDED__)

---