File: Ap4Sample.h

package info (click to toggle)
kodi-inputstream-adaptive 2.6.14%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,036 kB
  • sloc: cpp: 53,019; ansic: 492; makefile: 10
file content (174 lines) | stat: -rw-r--r-- 6,319 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*****************************************************************
|
|    AP4 - Sample Objects
|
|    Copyright 2002-2008 Axiomatic Systems, LLC
|
|
|    This file is part of Bento4/AP4 (MP4 Atom Processing Library).
|
|    Unless you have obtained Bento4 under a difference license,
|    this version of Bento4 is Bento4|GPL.
|    Bento4|GPL 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 2, or (at your option)
|    any later version.
|
|    Bento4|GPL 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 Bento4|GPL; see the file COPYING.  If not, write to the
|    Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
|    02111-1307, USA.
|
 ****************************************************************/

#ifndef _AP4_SAMPLE_H_
#define _AP4_SAMPLE_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Ap4Types.h"

/*----------------------------------------------------------------------
|   class references
+---------------------------------------------------------------------*/
class AP4_ByteStream;
class AP4_DataBuffer;

/*----------------------------------------------------------------------
|   AP4_Sample DO NOT DERIVE FROM THIS CLASS
+---------------------------------------------------------------------*/
class AP4_Sample 
{
public:
    /**
     * Default constructor
     */
    AP4_Sample();

    /**
     * Copy constructor
     */
    AP4_Sample(const AP4_Sample& other);
    
    /**
     * Construct an AP4_Sample referencing a data stream
     *
     * @param data_stream The byte stream that contains the sample data. 
     * The sample object added to the track will keep a reference to that byte 
     * stream
     * @param offset Position of the first byte of sample data within the stream
     * @param size Size in bytes of the sample data
     * @param description_index Index of the sample description that applies to 
     * this sample
     * @param dts Decoding timestamp of the sample
     * @param cts_delta Difference between the CTS (composition/display timestamp) and the 
     * DTS (decoding timestamp), in the timescale of the media.
     * @param sync_flag Boolean flag indicating whether this is a sync sample
     * or not
     */
    AP4_Sample(AP4_ByteStream& data_stream,
               AP4_Position    offset,
               AP4_Size        size,
               AP4_UI32        duration,
               AP4_Ordinal     description_index,
               AP4_UI64        dts,
               AP4_UI32        cts_delta,
               bool            sync_flag);
               
    ~AP4_Sample(); // not virtual on purpose: do not derive from it

    // operators
    AP4_Sample&     operator=(const AP4_Sample& other);

    // methods
    AP4_Result      ReadData(AP4_DataBuffer& data);
    AP4_Result      ReadData(AP4_DataBuffer& data, 
                             AP4_Size        size, 
                             AP4_Size        offset = 0);
    void            Detach();
    
    // sample properties accessors
    AP4_ByteStream* GetDataStream();
    void            SetDataStream(AP4_ByteStream& stream);
    AP4_Position    GetOffset() const { return m_Offset; }
    void            SetOffset(AP4_Position offset) { m_Offset = offset; }
    AP4_Size        GetSize() { return m_Size; }
    void            SetSize(AP4_Size size) { m_Size = size; }
    AP4_Ordinal     GetDescriptionIndex() const { return m_DescriptionIndex; }
    void            SetDescriptionIndex(AP4_Ordinal index) { m_DescriptionIndex = index; }
    
    /**
     * Get the DTS (Decoding Time Stamp) of the sample in the timescale of the media
     */
    AP4_UI64        GetDts() const { return m_Dts; }

    /**
     * Set the DTS (Decoding Time Stamp) of the sample in the timescale of the media
     */
    void            SetDts(AP4_UI64 dts) { m_Dts = dts; }

    /**
     * Get the CTS (Composition Time Stamp) of the sample in the timescale of the media
     */
    AP4_UI64        GetCts() const { return m_Dts+m_CtsDelta; }

    /**
     * Set the CTS (Composition Time Stamp) of the sample in the timescale of the media
     */
    void            SetCts(AP4_UI64 cts) { m_CtsDelta = (cts > m_Dts) ? (AP4_UI32)(cts-m_Dts) : 0;  }

    /**
     * Get the CTS Delta (difference between the CTS (Composition Time Stamp) and DTS (Decoding Time Stamp)
     * of the sample in the timescale of the media.
     */
    AP4_UI32        GetCtsDelta() const { return m_CtsDelta; }

    /**
     * Set the CTS Delta (difference between the CTS (Composition Time Stamp) and DTS (Decoding Time Stamp)
     * of the sample in the timescale of the media.
     */
    void            SetCtsDelta(AP4_UI32 delta) { m_CtsDelta = (AP4_SI32)delta;  }

    /**
     * Get the duration of the sample in the timescale of the media
     */
    AP4_UI32        GetDuration() const { return m_Duration; }

    /**
     * Set the duration of the sample in the timescale of the media
     */
    void            SetDuration(AP4_UI32 duration) { m_Duration = duration; }

    /**
     * Return whether the sample is a sync (random-access point) sample or not.
     */
    bool            IsSync() const { return m_IsSync; }

    /**
     * Set whether the sample is a sync (random-access point) sample or not.
     */
    void            SetSync(bool is_sync) { m_IsSync = is_sync; }

    /**
     * Resets the sample: will also release any data stream reference
     */
    void            Reset();

private:
    AP4_ByteStream* m_DataStream;
    AP4_Position    m_Offset;
    AP4_Size        m_Size;
    AP4_UI32        m_Duration;
    AP4_Ordinal     m_DescriptionIndex;
    AP4_UI64        m_Dts;
    AP4_SI32        m_CtsDelta; // make this a signed value, because quicktime can use negative offsets
    bool            m_IsSync;
};

#endif // _AP4_SAMPLE_H_