draintarget.h

   1 /*
   2     Copyright 2004-2005 Chris Tallon
   3
   4     This file is part of VOMP.
   5
   6     VOMP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     VOMP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with VOMP; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 */
  20
  21 #ifndef DRAINTARGET_H
  22 #define DRAINTARGET_H
  23
  24 #include "defines.h"
  25 #include <list>
  26
  27 #define MPTYPE_VIDEO_MPEG2 0x00
  28 #define MPTYPE_MPEG_AUDIO 0x01
  29 #define MPTYPE_AC3 0x02
  30 #define MPTYPE_AC3_PRE13 0x03 //old vdr recording compatmode
  31 #define MPTYPE_MPEG_AUDIO_LAYER3 0x04 //for media mp3 playback
  32 #define MPTYPE_TELETEXT 0x05 //for EBU VBI teletext
  33 #define MPTYPE_VIDEO_H264 0x06
  34
  35
  36
  37 struct MediaPacket
  38 {
  39   ULONG pos_buffer; //position in stream buffer
  40   ULONG length; //length of the packet
  41   // The fields below are not needed by the MVP
  42   UCHAR type;
  43   ULLONG pts;
  44   ULLONG dts;
  45   bool synched;
  46   int index;
  47 #ifdef WIN32
  48   long long presentation_time;/* in 100 ns units*/
  49   bool disconti;
  50 #endif
  51 };
  52
  53 using namespace std;
  54 typedef list<MediaPacket> MediaPacketList;
  55
  56 class DrainTarget
  57 {
  58   public:
  59     DrainTarget();
  60     virtual ~DrainTarget();
  61
  62     virtual long long SetStartOffset(long long curreftime, bool *rsync)=0;
  63     virtual void ResetTimeOffsets()=0;
  64
  65     virtual bool dtsTimefix(){return false;} //determines if the draintargets needs a mixure of pts and dts or not
  66
  67 // The following two functions are used by the Stream
  68 // to deliver media packets to the front end (DrainTarget).
  69 //
  70 // First, the Stream calls PrepareMediaSample, which gives the front end
  71 // read-only access to the Stream's MediaPacketList. PrepareMediaSample should
  72 // examine the list to determine how much it wishes to consume, and
  73 // should copy any data it requires from the MediaPacket objects into
  74 // local storage.
  75 // This function call takes place under a mutex lock to ensure integrity
  76 // of the list structure. It should be fast and must not contain any
  77 // cancellation points, such as I/O calls for logging.
  78 //
  79 // Second, the Stream releases the mutex and calls DeliverMediaSample.
  80 // This function delivers data from the Stream buffer to the presentation
  81 // device and returns information to the Stream regarding how many MediaPackets
  82 // were consumed. Any data copied from the MediaPackets objects during
  83 // PrepareMediaSample is guaranteed by the Stream still to be valid
  84 // during the following DeliverMediaSample call.
  85
  86     // samplepos is equal to the number of bytes from the first MediaPacket
  87     // in the list that have already been consumed in a previous call.
  88     virtual void PrepareMediaSample(const MediaPacketList&, UINT samplepos)=0;
  89
  90     // The Stream guarantees that the value of *samplepos passed to
  91     // DeliverMediaSample will be equal to the value of samplepos passed to
  92     // PrepareMediaSample in the previous call.
  93     // This function should consume data from the buffer according to the
  94     // decisions made in PrepareMediaSample. Its return value and *samplepos
  95     // tell the Stream how much data it consumed.
  96     // If DeliverMediaSample returns X, the Stream will remove packets 0 to X-1
  97     // (inclusive) from the list before the next call.
  98     // DeliverMediaSample must also set *samplepos equal to the number of bytes
  99     // processed from packet X (usually zero).
 100         // It is allowed, that the draintarget modifies the part of the buffer, which belongs
 101         // to the mediapackets it is processing.
 102     virtual UINT DeliverMediaSample(UCHAR* buffer, UINT *samplepos)=0;
 103 };
 104
 105 #endif