Source: advancedaudiodecoder.h

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Advanced Audio Decoder                                           ####
// ####                                                                  ####
// #### Version 1.00  --  February 04, 2001                              ####
// ####                                                                  ####
// #### Copyright (C) 1999  Thomas Dreibholz                             ####
// ####               2000  Universität Bonn, Abt. IV                    ####
// ####               2001  EMail: Dreibholz@bigfoot.com                 ####
// ####                     WWW:   http://www.bigfoot.com/~dreibholz     ####
// ####                                                                  ####
// ##########################################################################


#ifndef ADVANCEDAUDIODECODER_H
#define ADVANCEDAUDIODECODER_H


#include "system.h"
#include "audiowriterinterface.h"
#include "audiodecoderinterface.h"
#include "timedthread.h"
#include "seqnumvalidator.h"
#include "audioquality.h"
#include "advancedaudiopacket.h"


#include <multimap.h>
#include <multiset.h>
#include <algo.h>


namespace Coral {


/**
  * This class is an advanced audio decoder. It does error correction by
  * using nearly redundant data of left and right channel to "reconstruct"
  * the full data.
  *
  * @short   Advanced Audio Decoder
  * @author  Thomas Dreibholz (Dreibholz@bigfoot.com)
  * @version 1.0
  */
class AdvancedAudioDecoder : public AudioDecoderInterface,
                             public TimedThread
{
   // ====== Constructor/Destructor =========================================
   public:
   /**
     * Constructor for the audio decoder.
     *
     * @param audioWriter AudioReaderInterface for the audio output.
     */
   AdvancedAudioDecoder(AudioWriterInterface* audioWriter);
   
   /**
     * Destructor.
     */
   ~AdvancedAudioDecoder();


   // ====== DecoderInterface implementation ================================
   /**
     * getTypeID() implementation of DecoderInterface.
     *
     * @see DecoderInterface#getTypeID
     */
   const card16 getTypeID() const;
   
   /**
     * getTypeName implementation of DecoderInterface.
     *
     * @see DecoderInterface#getTypeName
     */
   const char* getTypeName() const;
   
   /**
     * activate() implementation of DecoderInterface.
     *
     * @see DecoderInterface#activate
     */
   void activate();

   /**
     * deactivate() implementation of DecoderInterface.
     *
     * @see DecoderInterface#deactivate
     */
   void deactivate();

   /**
     * reset() implementation of DecoderInterface.
     *
     * @see DecoderInterface#reset
     */
   void reset();

   /**
     * getTransportInfo() implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getTransportInfo
     */
   void getTransportInfo(TransportInfo& transportInfo,
                         const cardinal headerSize,
                         const cardinal maxPacketSize,
                         const bool     calculateLevels) const;

   /**
     * getMediaInfo() implementation of DecoderInterface.
     *
     * @see DecoderInterface#getMediaInfo
     */
   void getMediaInfo(MediaInfo& mediaInfo) const;

   /**
     * getErrorCode() implementation of DecoderInterface.
     *
     * @see DecoderInterface#getErrorCode
     */
   card8 getErrorCode() const;
   
   /**
     * getPosition() implementation of DecoderInterface.
     *
     * @see DecoderInterface#getPosition
     */
   card64 getPosition() const;
   
   /**
     * getMaxPosition() implementation of DecoderInterface.
     *
     * @see DecoderInterface#getMaxPosition
     */
   card64 getMaxPosition() const;

   /**
     * checkNextPacket() implementation of DecoderInterface.
     *
     * @see DecoderInterface#checkNextPacket
     */
   bool checkNextPacket(DecoderPacket* decoderPacket);

   /**
     * handleNextPacket() implementation of DecoderInterface.
     *
     * @see DecoderInterface#handleNextPacket
     */
   void handleNextPacket(const DecoderPacket* decoderPacket);


   // ====== AudioDecoderInterface implementation ===========================
   /**
     * getSamplingRate() Implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getSamplingRate
     */
   card16 getSamplingRate() const;

   /**
     * getBits() Implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getBits
     */
   card8 getBits() const;

   /**
     * getChannels() Implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getChannels
     */
   card8 getChannels() const;

   /**
     * getByteOrder() Implementation of AudioQualityInterface.
     *
     * @see AudioQualityInterface#getByteOrder
     */
   card16 getByteOrder() const;


   /**
     * getBytesPerSecond() Implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getBytesPerSecond
     */
   cardinal getBytesPerSecond() const;

   /**
     * getBitsPerSample() Implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#getBitsPerSample
     */
   cardinal getBitsPerSample() const;


   /**
     * getWantedQuality() implementation of AudioDecoderInterface.
     *
     * see AudioDecoderInterface#getWantedQuality
     */
   AudioQuality getWantedQuality() const;

   /**
     * setWantedQuality() implementation of AudioDecoderInterface.
     *
     * @see AudioDecoderInterface#setWantedQuality
     */
   void setWantedQuality(const AudioQualityInterface& wantedQuality);


   // ====== Private data ===================================================
   private:
   void timerEvent();

   struct FrameFragment {
      cardinal Length;
      card16   Fragment;
      char     Data[0];
   };

   struct FrameNode {
      card64                               Position;
      card64                               MaxPosition;
      cardinal                             FrameSize;
      card16                               SamplingRate;
      card8                                Channels;
      card8                                Bits;
      card8                                ErrorCode;
      card8                                pad;
      multimap<const card16,FrameFragment*> FragmentSetLL;
      multimap<const card16,FrameFragment*> FragmentSetRL;
      multimap<const card16,FrameFragment*> FragmentSetLU;
      multimap<const card16,FrameFragment*> FragmentSetRU;
   };

   struct FrameNodeItem {
      card64     Position;
      FrameNode* Node;

      inline int operator<(const FrameNodeItem& item) const {
         return(Position < item.Position);
      }
   };

   card64 checkFragmentSeqNum(multimap<const card16,FrameFragment*>* set,
                              const card64                           last) const;
   void deleteFragments(multimap<const card16,FrameFragment*>* set);
   FrameFragment* getFragment(multimap<const card16, FrameFragment*>* set,
                              const card16                            fragmentNumber);


   static const cardinal FrameBufferSize =
      2 * ((AdvancedAudioPacket::AdvancedAudioFramesPerSecond /
           (16000 / AdvancedAudioPacket::AdvancedAudioMaxTransferDelay)) + 1);

   static const card64 BufferCleanUpDifference =
      (4 * FrameBufferSize * PositionStepsPerSecond) /
         AdvancedAudioPacket::AdvancedAudioFramesPerSecond;


   multiset<FrameNodeItem> FrameSet;
   AudioWriterInterface*   Device;
   AudioQuality            WantedQuality;
   card64                  Position;
   card64                  MaxPosition;

   SeqNumValidator SeqNumber[AdvancedAudioPacket::AdvancedAudioMaxQualityLayers];
   MediaInfo       Media;
   card16          AudioSamplingRate;
   card8           AudioBits;
   card8           AudioChannels;
   card8           ErrorCode;
};


}


#endif