encoderinterface.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Encoder Interface                                                ####
// ####                                                                  ####
// #### Version 1.00  --  February 16, 2001                              ####
// ####                                                                  ####
// #### Copyright (C) 1999  Thomas Dreibholz                             ####
// ####               2000  Universität Bonn, Abt. IV                    ####
// ####               2001  EMail: dreibh@iem.uni-due.de                 ####
// ####                     WWW:   https://www.uni-due.de/~be0001        ####
// ####                                                                  ####
// ##########################################################################


#ifndef ENCODERINTERFACE_H
#define ENCODERINTERFACE_H


#include "system.h"
#include "range.h"
#ifdef USE_TRANSPORTINFO
#include "transportinfo.h"
#else
#include "abstractqosdescription.h"
#endif


namespace Coral {


struct EncoderPacket
{
   void* Buffer;

   cardinal MaxLength;

   cardinal Layer;

   card8 PayloadType;

   bool Marker;

   card8 ErrorCode;
};



class EncoderInterface
{
   // ====== Destructor =====================================================
   public:
   virtual ~EncoderInterface();


   // ====== Encoder type ===================================================
   virtual const card16 getTypeID() const = 0;
   
   virtual const char* getTypeName() const = 0;


   // ====== Initialization/Clean-up ========================================
   virtual void activate() = 0;
   
   virtual void deactivate() = 0;
   
   virtual void reset() = 0;


   // ====== Encode frame ===================================================
#ifndef USE_TRANSPORTINFO

   virtual bool checkInterval(card64& time, bool& newRUList) = 0;
#endif


   virtual bool prepareNextFrame(const cardinal headerSize,
                                 const cardinal maxPacketSize,
                                 const cardinal flags = 0) = 0;

   virtual cardinal getNextPacket(EncoderPacket* packet) = 0;


   // ====== Settings =======================================================
#ifdef USE_TRANSPORTINFO

   virtual void getTransportInfo(TransportInfo& transportInfo,
                                 const cardinal headerSize,
                                 const cardinal maxPacketSize,
                                 const bool     calculateLevels = true) const = 0;

   virtual void setTransportInfo(TransportInfo& transportInfo,
                                 const cardinal headerSize,
                                 const cardinal maxPacketSize,
                                 const bool     calculateLevels = true) = 0;

   virtual void adaptQuality(const double   fractionLost,
                             const cardinal layer) = 0;

#else

   virtual AbstractQoSDescription* getQoSDescription(
                                      const cardinal pktHeaderSize,
                                      const cardinal pktMaxSize,
                                      const card64   offset) = 0;

   virtual void updateQuality(const AbstractQoSDescription* aqd) = 0;

#endif
};


}


#endif