SdpCodecList.h

Go to the documentation of this file.

//
// Copyright (C) 2007-2013 SIPez LLC.  All rights reserved.
//
// 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 _SdpCodecList_h_
#define _SdpCodecList_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <sdp/SdpCodec.h>
#include <utl/UtlDList.h>
#include <os/OsRWMutex.h>

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

class SdpCodecList
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

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


   SdpCodecList(int numCodecs = 0,
                SdpCodec* codecArray[] = NULL);

   SdpCodecList(const SdpCodecList& rSdpCodecFactory);

   SdpCodecList& operator=(const SdpCodecList& rhs);

   virtual
   ~SdpCodecList();


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


   void addCodec(const SdpCodec& newCodec);

   void addCodecs(int numCodecs, SdpCodec* newCodecs[]);

   int addCodecs(const UtlString &codecList);
   int addCodecs(UtlSList& codecNameList);
   int addCodecs(int numTokens, const char* codecTokens[], int payloadIds[]);

   int addCodecs(int codecCount, SdpCodec::SdpCodecTypes codecTypes[]);
   void bindPayloadTypes();

   int unbindPayloadType(int payloadId);
   /*
    * @param payloadId - no op if not a dynamic payload ID (> SDP_CODEC_MAXIMUM_STATIC_CODEC), 
    *        codec payload ID to unbind (set to SDP_CODEC_UNKNOWN)
    *
    * @returns number of codecs unbound
    */

   void copyPayloadType(const SdpCodec& codec);

   void copyPayloadTypes(int numCodecs, const SdpCodec* codecArray[]);

   void copyPayloadTypes(const SdpCodecList& codecList);

   void limitCodecs(const SdpCodecList& includeOnlyCodecList);

   void clearCodecs(void);

   void setCodecCPULimit(int iLimit);

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


   const SdpCodec* getCodec(SdpCodec::SdpCodecTypes internalCodecId) const;

   const SdpCodec* getCodecByType(int payloadTypeId, UtlBoolean shouldLock = TRUE) const;

   const SdpCodec* getCodec(const char* MIMEType, 
                            const char* MIMESubType,
                            int sampleRate,
                            int numChannels,
                            const UtlString &fmtp) const;

   int getCodecCount() const;

   int getCodecCount(const char* MIMEType) const;

   void getCodecs(int& numCodecs,
                  SdpCodec**& codecArray) const;

   void getCodecs(int& numCodecs,
                  SdpCodec**& codecArray,
                  const char* MIMEType) const;

   void getCodecs(int& numCodecs, 
                  SdpCodec**& codecArray,
                  const char* MIMEType,
                  const char* subMimeType) const;

    static void freeArray(int arraySize, SdpCodec**& codecArray);
    /* 
     *  getCodecs allocates a codec pointer array and codecs.  This frees them.
     */

   void toString(UtlString& serializedFactory) const;

   int getCodecCPULimit() const;


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


    UtlBoolean containsCodec(const SdpCodec& codec, UtlBoolean exeact = FALSE) const;


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

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

   void addCodecNoLock(const SdpCodec& newCodec);

   UtlDList mCodecs;
   OsRWMutex mReadWriteMutex;
   int mCodecCPULimit;

};

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

#endif  // _SdpCodecList_h_