mediacmd.h

Go to the documentation of this file.

/*
 * mediacmd.h
 *
 * Abstractions for sending commands to media processors.
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_OPAL_MEDIACMD_H
#define OPAL_OPAL_MEDIACMD_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>


class OpalMediaCommand : public PObject
{
  PCLASSINFO(OpalMediaCommand, PObject);
  public:
    OpalMediaCommand(
      const OpalMediaType & mediaType, 
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );

    virtual void PrintOn(
      ostream & strm    
    ) const;

    virtual Comparison Compare(
      const PObject & obj   
    ) const;

    // Redefine as pure, derived classes from here MUST implment it.
    virtual PObject * Clone() const = 0;

    virtual PString GetName() const = 0;

    virtual void * GetPlugInData() const;

    virtual unsigned * GetPlugInSize() const;

    const OpalMediaType & GetMediaType() const { return m_mediaType; }
    unsigned GetSessionID() const { return m_sessionID; }
    unsigned GetSyncSource() const { return m_ssrc; }

  protected:
    OpalMediaType m_mediaType;
    unsigned      m_sessionID;
    unsigned      m_ssrc;
};


#define OPAL_DEFINE_MEDIA_COMMAND(cls, name, mediaType) \
  class cls : public OpalMediaCommand \
  { \
      PCLASSINFO_WITH_CLONE(cls, OpalMediaCommand) \
    public: \
      cls(unsigned id = 0, unsigned ssrc = 0) : OpalMediaCommand(mediaType, id, ssrc) { } \
      virtual PString GetName() const { return name; } \
  }


class OpalMediaFlowControl : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalMediaFlowControl, OpalMediaCommand);
  public:
    OpalMediaFlowControl(
      OpalBandwidth bitRate,           
      const OpalMediaType & mediaType, 
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );
    OpalMediaFlowControl(
      OpalBandwidth bitRate,           
      const OpalMediaType & mediaType, 
      unsigned sessionID,              
      const RTP_SyncSourceArray & ssrcs 
    );

    virtual PString GetName() const;

    const OpalBandwidth & GetMaxBitRate() const { return m_bitRate; }
    const RTP_SyncSourceArray & GetSSRCs() const { return m_ssrcs; }

  protected:
    OpalBandwidth m_bitRate;
    RTP_SyncSourceArray m_ssrcs;
};


class OpalMediaPacketLoss : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalMediaPacketLoss, OpalMediaCommand);
  public:
    OpalMediaPacketLoss(
      unsigned packetLoss,             
      const OpalMediaType & mediaType, 
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );

    virtual PString GetName() const;

    unsigned GetPacketLoss() const { return m_packetLoss; }

  protected:
    unsigned m_packetLoss;
};


class OpalMediaMaxPayload : public OpalMediaCommand
{
    PCLASSINFO_WITH_CLONE(OpalMediaMaxPayload, OpalMediaCommand);
  public:
    OpalMediaMaxPayload(
      unsigned payloadSize,            
      const OpalMediaType & mediaType, 
      unsigned sessionID = 0,          
      unsigned ssrc = 0                
    );

    virtual PString GetName() const;

    unsigned GetPayloadSize() const { return m_payloadSize; }

  protected:
    unsigned m_payloadSize;
};


#endif // OPAL_OPAL_MEDIACMD_H


// End of File ///////////////////////////////////////////////////////////////