MpCodecFactory.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _MpCodecFactory_h_
#define _MpCodecFactory_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/MpEncoderBase.h"
#include "mp/MpDecoderBase.h"
#include "mp/codecs/PlgDefsV1.h"
#include "mp/MpPlgStaffV1.h"
#include "mp/MpMisc.h"
#include "sdp/SdpCodecList.h"
#include "utl/UtlHashBag.h"
#include "utl/UtlHashBagIterator.h"
#include "os/OsSharedLibMgr.h"
#include "os/OsStatus.h"
#include "os/OsBSem.h"

// DEFINES
#ifdef __pingtel_on_posix__ // [
#  define CODEC_PLUGINS_FILTER "^codec_.*\\.so$"
#elif defined(WIN32) // __pingtel_on_posix__ ] [
#  define CODEC_PLUGINS_FILTER "^codec_.*\\.dll$"
#else // WIN32 ] [
#  error Unknown platform! Please specify correct codec plugins file filter.
#endif // ]


// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpFlowGraphBase;
class MpCodecSubInfo;


class MpCodecFactory
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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

 
   static
   MpCodecFactory* getMpCodecFactory(void);
   static
   void freeSingletonHandle();


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


   OsStatus loadDynCodec(const char* name);

   OsStatus loadAllDynCodecs(const char* path, const char* regexFilter);
   static
   MpCodecCallInfoV1* addStaticCodec(MpCodecCallInfoV1* sStaticCode);   


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


   OsStatus createDecoder(const UtlString &mime,
                          const UtlString &fmtp,
                          int sampleRate,
                          int numChannels,
                          int payloadType,
                          MpDecoderBase*& rpDecoder) const;
   OsStatus createEncoder(const UtlString &mime,
                          const UtlString &fmtp,
                          int sampleRate,
                          int numChannels,
                          int payloadType,
                          MpEncoderBase*& rpEncoder) const;
   void getCodecInfoArray(unsigned &count,
                          const MppCodecInfoV1_1 **&codecInfoArray) const;
   void addCodecsToList(SdpCodecList &codecList) const;

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



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

   MpCodecFactory();
   ~MpCodecFactory();

   MpCodecSubInfo* searchByMIME(const UtlString& mime,
                                int sampleRate,
                                int numChannels) const;

   void freeAllLoadedLibsAndCodec();

   void initializeStaticCodecs();
   static
   void freeStaticCodecs();

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

   UtlHashBag mCodecsInfo;                     
   mutable UtlBoolean mCodecInfoCacheValid;    
   mutable unsigned   mCachedCodecInfoNum;     
   mutable const MppCodecInfoV1_1** mpCodecInfoCache; 

   // Static data members used to enforce Singleton behavior
   static MpCodecFactory* spInstance; 
   static OsBSem sLock;               
   static MpCodecCallInfoV1* sStaticCodecsV1; 

   OsStatus addCodecWrapperV1(MpCodecCallInfoV1* wrapper);

   void updateCodecInfoCache() const;

   MpCodecFactory(const MpCodecFactory& rMpCodecFactory);

   MpCodecFactory& operator=(const MpCodecFactory& rhs);
};

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

#endif  // _MpCodecFactory_h_