tdtfreader.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                    Master Thesis Implementation                  ####
// ####  Management of Layered Variable Bitrate Multimedia Streams over  ####
// ####                  DiffServ with A Priori Knowledge                ####
// ####                                                                  ####
// #### ================================================================ ####
// ####                                                                  ####
// ####                                                                  ####
// #### TDTF Reader                                                      ####
// ####                                                                  ####
// #### Version 1.00  --  February 19, 2001                              ####
// ####                                                                  ####
// #### Copyright (C) 2000/2001 Thomas Dreibholz                         ####
// #### University of Bonn, Department of Computer Science IV            ####
// #### EMail: dreibh@iem.uni-due.de                                     ####
// #### WWW:   https://www.uni-due.de/~be0001/diplom/index.html          ####
// ####                                                                  ####
// ##########################################################################


#ifndef TDTF_READER
#define TDTF_READER


#include "system.h"
#include "tdtf.h"
#include "synchronizable.h"


#include <multimap.h>


namespace Coral {


class TDTFReader
{
   // ====== Constructor/Destructor =========================================
   public:
   TDTFReader();

   virtual ~TDTFReader();


   // ====== Open/close TDTF trace file =====================================
   virtual bool open(const char* name, const bool readWrite = false);

   virtual void close();

   inline bool hasResourceUtilizationLists() const;

   inline card16 getMediaType() const;

   inline card16 getMediaSubtype() const;


   // ====== Frame rate methods =============================================
   bool isValidFrameRate(const double frameRate) const;

   double getNearestValidFrameRate(const double frameRate) const;

   inline double getMinFrameRate() const;

   inline double getMaxFrameRate() const;


   double getNextFrameRateForRate(const double frameRate) const;

   double getPrevFrameRateForRate(const double frameRate) const;


   // ====== Frame size methods =============================================
    cardinal getMaxByteCountForDelay(const card64   rtpPosition,
                                     const cardinal layer,
                                     const double   frameRate,
                                     const cardinal delay) const;

    cardinal getMaxFrameCountForDelay(const card64   rtpPosition,
                                      const cardinal layer,
                                      const double   frameRate,
                                      const cardinal delay) const;

   inline cardinal getPayloadFrameSizeForDelay(
                      const card64   rtpPosition,
                      const cardinal layer,
                      const double   frameRate,
                      const cardinal bufferDelay) const;

   cardinal getTraceFrameSize(const card64   rtpPosition,
                              const cardinal layer,
                              const double   frameRate) const;

   cardinal getTraceFrameID(const card64   rtpPosition,
                            const cardinal layer,
                            const double   frameRate) const;

   double getLayerScalability(const card64   rtpPosition,
                              const cardinal layer,
                              const double   frameRate) const;

   cardinal getLayerFlags(const card64   rtpPosition,
                          const cardinal layer,
                          const double   frameRate) const;

   cardinal getFrames(const double frameRate) const;

   cardinal getLayers(const double frameRate) const;


   // ====== Buffer delay methods ===========================================
   cardinal getMaxBufferDelay(const card64 rtpPosition,
                              const double frameRate) const;


   // ====== TDTF trace file access =========================================
   bool checkAccess(const cardinal position, const cardinal length) const;

   const TDTFPrefix* TDTFReader::getTDTFPrefix() const;

   const TDTFSuffix* TDTFReader::getTDTFSuffix() const;

   const MainIndexEntry* getMainIndexEntry(const double frameRate) const;

   const TraceHeader* getTraceHeader(const double frameRate) const;

   const PositionLengthIntervalIndexHeader* getIPLIHeader(
                                               const double frameRate) const;

   const IntervalHeader* getIntervalHeader(const cardinal position,
                                           const double   frameRate) const;

   const LayerHeader* getLayerHeader(const cardinal position,
                                     const cardinal layer,
                                     const double   frameRate) const;

   const EmpiricalEnvelope* getEmpiricalEnvelope(const cardinal position,
                                                 const cardinal layer,
                                                 const double   frameRate,
                                                 const bool     frameCount = false) const;


   // ====== Resource/utilization methods ===================================
   const ResourceUtilizationHeader* getResourceUtilizationHeader(
                                       const cardinal position,
                                       const double   frameRate) const;

   const UtilizationHeader* getFrameSizeUtilizationHeader(
                               const cardinal position,
                               const cardinal layer,
                               const double   frameRate) const;

   const UtilizationHeader* getFrameRateUtilizationHeader(
                               const cardinal position,
                               const double   frameRate) const;


   // ====== RTP position conversion ============================================
   inline cardinal positionToFramePosition(const double frameRate,
                                           const card64 rtpPosition) const;

   inline card64 framePositionToPosition(const double   frameRate,
                                         const cardinal framePosition) const;


   // ====== Printing methods ===============================================
   void printEmpiricalEnvelope(ostream&       os,
                               const cardinal position,
                               const double   frameRate,
                               const bool     frameCount,
                               const bool     compact) const;

   void print(ostream&     os,
              const double frameRate,
              const bool   printEE,
              const bool   compactEE,
              const bool   printRUL,
              const bool   printUC) const;


   // ====== Protected data =================================================
   public:
   struct MediaCacheEntry {
      int      InputFile;
      char*    InputMemory;
      cardinal InputLength;
      cardinal UserCount;
   };


   int                                 InputFile;
   char*                               InputMemory;
   cardinal                            InputLength;
   MediaCacheEntry*                    InputEntry;


   // ====== Protected data =================================================
   protected:
   MainIndexHeader*                    MainIndex;
   cardinal                            MainIndexEntries;

   ResourceUtilizationListIndexHeader* RULIndex;
   cardinal                            RULIndexEntries;

   double                              MinFrameRate;
   double                              MaxFrameRate;
   card16                              MediaType;
   card16                              MediaSubtype;


   // ====== Private data ===================================================
   private:
   static multimap<const String,MediaCacheEntry*> MediaCache;
   static Synchronizable                          MediaCacheSync;
};


}


#include "tdtfreader.icc"


#endif