MpAudioBuf.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPfoundry Inc. 
// Licensed by SIPfoundry under the LGPL license. 
//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//  
// $$ 

#ifndef _INCLUDED_MPAUDIOBUF_H /* [ */
#define _INCLUDED_MPAUDIOBUF_H

// SYSTEM INCLUDES
#include <assert.h>

// APPLICATION INCLUDES
#include "mp/MpDataBuf.h"
#include "mp/MpTypes.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpAudioBufPtr;


struct MpAudioBuf : public MpDataBuf
{
    friend class MpAudioBufPtr;

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

    static MpBufPool *smpDefaultPool; 

/* ============================ CREATORS ================================== */




/* ============================ MANIPULATORS ============================== */


    void setSpeechType(MpSpeechType type) {mParams.mSpeechType = type;};


    bool setSamplesNumber(int samplesNum)
    {return mpData->setDataSize(samplesNum*sizeof(MpAudioSample));}

    void setTimecode(unsigned timecode) {assert(!"MpAudioBuf::setTimecode() is not implemented!");}

    void setAmplitude(MpAudioSample amplitude) {mParams.mAmplitude = amplitude;}

    void setClipping(UtlBoolean clipping) {mParams.mIsClipped = clipping;}

    void setEnergy(int energy) {mParams.mFrameEnergy = energy;}

    void setSpeechParams(const MpSpeechParams &params) {mParams = params;}


/* ============================ ACCESSORS ================================= */


    MpSpeechType getSpeechType() const {return mParams.mSpeechType;};

    const MpAudioSample *getSamplesPtr() const {return (const MpAudioSample*)getDataPtr();}

    MpAudioSample *getSamplesWritePtr() {return (MpAudioSample*)getDataWritePtr();}

    unsigned getSamplesNumber() const {return mpData->getDataSize()/sizeof(MpAudioSample);}

    unsigned getTimecode() const {assert(!"MpAudioBuf::getTimecode() is not implemented!"); return 0;}

    MpAudioSample getAmplitude() const {return mParams.mAmplitude;}

    UtlBoolean getClipping() const {return mParams.mIsClipped;}

    int getEnergy() const {return mParams.mFrameEnergy;}

    const MpSpeechParams &getSpeechParams() const {return mParams;}

    MpSpeechParams &getSpeechParams() {return mParams;}


/* ============================ INQUIRY =================================== */


    int compareSamples(const MpAudioBufPtr& frame,
                       unsigned int tolerance = 0) const;

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

    MpSpeechParams mParams;  

    void init();

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

    MpAudioBuf(const MpBuf &);
    MpAudioBuf &operator=(const MpBuf &);
};


class MpAudioBufPtr : public MpDataBufPtr {

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


    MPBUF_DEFAULT_CONSTRUCTOR(MpAudioBuf)

    
    MPBUFDATA_FROM_BASE_CONSTRUCTOR(MpAudioBuf, MP_BUF_AUDIO, MpDataBuf)

    
    MPBUF_TYPECHECKED_COPY(MpAudioBuf, MP_BUF_AUDIO, MpDataBuf)



/* ============================ MANIPULATORS ============================== */



/* ============================ ACCESSORS ================================= */


    MPBUF_MEMBER_ACCESS_OPERATOR(MpAudioBuf)

    
    MPBUF_CONST_MEMBER_ACCESS_OPERATOR(MpAudioBuf)



/* ============================ INQUIRY =================================== */





/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:


/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

};

/* ============================ INLINE METHODS ============================ */

#endif /* ] _INCLUDED_MPAUDIOBUF_H */