encoderinterface.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Encoder Interface                                                ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### This program is distributed in the hope that it will be useful,  ####
// #### but WITHOUT ANY WARRANTY; without even the implied warranty of   ####
// #### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    ####
// #### GNU General Public License for more details.                     ####
// ####                                                                  ####
// #### You should have received a copy of the GNU General Public        ####
// #### License along with this program.  If not, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: encoderinterface.h 1293 2011-12-19 14:59:28Z dreibh $


#ifndef ENCODERINTERFACE_H
#define ENCODERINTERFACE_H


#include "tdsystem.h"
#include "abstractqosdescription.h"


struct EncoderPacket
{
   void* Buffer;

   cardinal MaxLength;

   cardinal Layer;

   card8 PayloadType;

   bool Marker;

   card8 ErrorCode;
};



class EncoderInterface
{
   // ====== Encoder type ===================================================
   public:
   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 ===================================================
   virtual bool checkInterval(card64& time, bool& newRUList) = 0;

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

   virtual cardinal getNextPacket(EncoderPacket* packet) = 0;


   // ====== Settings =======================================================
   virtual double getFrameRate() const = 0;

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

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


#endif