]> git.vomp.tv Git - vompclient.git/blob - draintarget.h
Step back a bit when going from ffwd to play
[vompclient.git] / 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19 */
20
21 #ifndef DRAINTARGET_H
22 #define DRAINTARGET_H
23
24 #include "defines.h"
25 #include <list>
26
27 #define MPTYPE_VIDEO 0x00
28 #define MPTYPE_MPEG_AUDIO 0x01
29 #define MPTYPE_AC3 0x02
30 #define MPTYPE_AC3_PRE13 0x03 //old vdr recording compatmode
31
32 struct MediaPacket
33 {
34   ULONG pos_buffer; //position in stream buffer
35   ULONG length; //length of the packet
36   // The fields below are not needed by the MVP
37   UCHAR type;
38 #ifdef WIN32
39   ULLONG recording_byte_pos; //position in recording
40   ULLONG pts;
41   long long presentation_time;/* in 100 ns units*/
42   bool synched;
43   bool disconti;
44 #endif
45 };
46
47 using namespace std;
48 typedef list<MediaPacket> MediaPacketList;
49
50 class DrainTarget
51 {
52   public:
53     DrainTarget();
54     virtual ~DrainTarget();
55
56     virtual long long SetStartOffset(long long curreftime, bool *rsync)=0;
57     virtual void ResetTimeOffsets()=0;
58
59 // The following two functions are used by the Stream
60 // to deliver media packets to the front end (DrainTarget).
61 //
62 // First, the Stream calls PrepareMediaSample, which gives the front end
63 // read-only access to the Stream's MediaPacketList. PrepareMediaSample should
64 // examine the list to determine how much it wishes to consume, and
65 // should copy any data it requires from the MediaPacket objects into
66 // local storage.
67 // This function call takes place under a mutex lock to ensure integrity
68 // of the list structure. It should be fast and must not contain any
69 // cancellation points, such as I/O calls for logging.
70 //
71 // Second, the Stream releases the mutex and calls DeliverMediaSample.
72 // This function delivers data from the Stream buffer to the presentation
73 // device and returns information to the Stream regarding how many MediaPackets
74 // were consumed. Any data copied from the MediaPackets objects during
75 // PrepareMediaSample is guaranteed by the Stream still to be valid
76 // during the following DeliverMediaSample call.
77
78     // samplepos is equal to the number of bytes from the first MediaPacket
79     // in the list that have already been consumed in a previous call.
80     virtual void PrepareMediaSample(const MediaPacketList&, UINT samplepos)=0;
81
82     // The Stream guarantees that the value of *samplepos passed to
83     // DeliverMediaSample will be equal to the value of samplepos passed to
84     // PrepareMediaSample in the previous call.
85     // This function should consume data from the buffer according to the
86     // decisions made in PrepareMediaSample. Its return value and *samplepos
87     // tell the Stream how much data it consumed.
88     // If DeliverMediaSample returns X, the Stream will remove packets 0 to X-1
89     // (inclusive) from the list before the next call.
90     // DeliverMediaSample must also set *samplepos equal to the number of bytes
91     // processed from packet X (usually zero).
92     virtual UINT DeliverMediaSample(const UCHAR* buffer, UINT *samplepos)=0;
93 };
94
95 #endif