MpResampler.h

Go to the documentation of this file.

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

// Author: Alexander Chemeris <Alexander DOT Chemeris AT SIPez DOT com> and Keith Kyzivat <kkyzivat AT SIPez DOT com>

#ifndef _MpResamplerBase_h_
#define _MpResamplerBase_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <mp/MpTypes.h>
#include <os/OsStatus.h>
#include <mp/MpMisc.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class MpResamplerBase
{
/* //////////////////////////////// PUBLIC //////////////////////////////// */
public:

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


   static
   MpResamplerBase *createResampler(uint32_t numChannels, 
                                    uint32_t inputRate, 
                                    uint32_t outputRate, 
                                    int32_t quality = -1);

   MpResamplerBase(uint32_t numChannels, 
                   uint32_t inputRate, 
                   uint32_t outputRate, 
                   int32_t quality);
   virtual ~MpResamplerBase();


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


   virtual OsStatus resetStream();

   virtual OsStatus resample(uint32_t channelIndex,
                             const MpAudioSample* pInBuf,
                             uint32_t inBufLength,
                             uint32_t& inSamplesProcessed,
                             MpAudioSample* pOutBuf,
                             uint32_t outBufLength,
                             uint32_t& outSamplesWritten);
   virtual OsStatus resampleInterleavedStereo(const MpAudioSample* pInBuf,
                                              uint32_t inBufLength,
                                              uint32_t& inSamplesProcessed,
                                              MpAudioSample* pOutBuf,
                                              uint32_t outBufLength,
                                              uint32_t& outSamplesWritten);
   OsStatus resampleBufPtr(const MpAudioBufPtr& inBuf, MpAudioBufPtr& outBuf,
                           uint32_t inRate, uint32_t outRate,
                           UtlString optionalIdStr = "");
   virtual OsStatus setInputRate(const uint32_t inputRate);
   virtual OsStatus setOutputRate(const uint32_t outputRate);
   virtual OsStatus setQuality(const int32_t quality);

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


   uint32_t getInputRate() const;

   uint32_t getOutputRate() const;

   int32_t getQuality() const;

   static inline
   int getNumSamplesConverted(uint32_t inputRate, uint32_t outputRate,
                              int numInputSamples, int &remainingSamplesNum);

   static inline
   int getNumSamplesOriginal(uint32_t inputRate, uint32_t outputRate,
                             int numOutputSamples, int &remainingSamplesNum);


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




/* ////////////////////////////// PROTECTED /////////////////////////////// */
protected:
   uint32_t mNumChannels;
   uint32_t mInputRate;
   uint32_t mOutputRate;
   int32_t mQuality;

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


};

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

int MpResamplerBase::getNumSamplesConverted(uint32_t inputRate, uint32_t outputRate,
                                            int numInputSamples, int &remainingSamplesNum)
{
   int numOutputSamples = outputRate*numInputSamples/inputRate;
   remainingSamplesNum = numInputSamples - inputRate*numOutputSamples/outputRate;
   return numOutputSamples;
}

int MpResamplerBase::getNumSamplesOriginal(uint32_t inputRate, uint32_t outputRate,
                                           int numOutputSamples, int &remainingSamplesNum)
{
   int numInputSamples = inputRate*numOutputSamples/outputRate;
   remainingSamplesNum = numOutputSamples - outputRate*numInputSamples/inputRate;
   return numInputSamples;
}

#endif  // _MpResamplerBase_h_