doxygenize comments
[ffmpeg.git] / libavformat / asf.h
1 /*
2  * Copyright (c) 2000, 2001 Fabrice Bellard.
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 #define PACKET_SIZE 3200
21
22 typedef struct {
23     int num;
24     unsigned char seq;
25     /* use for reading */
26     AVPacket pkt;
27     int frag_offset;
28     int timestamp;
29     int64_t duration;
30
31     int ds_span;                /* descrambling  */
32     int ds_packet_size;
33     int ds_chunk_size;
34
35     int64_t packet_pos;
36
37 } ASFStream;
38
39 typedef uint8_t GUID[16];
40
41 typedef struct {
42     GUID guid;                  ///< generated by client computer
43     uint64_t file_size;         /**< in bytes
44                                  *   invalid if broadcasting */
45     uint64_t create_time;       /**< time of creation, in 100-nanosecond units since 1.1.1601
46                                  *   invalid if broadcasting */
47     uint64_t play_time;         /**< play time, in 100-nanosecond units
48                                  * invalid if broadcasting */
49     uint64_t send_time;         /**< time to send file, in 100-nanosecond units
50                                  *   invalid if broadcasting (could be ignored) */
51     uint32_t preroll;           /**< timestamp of the first packet, in milliseconds
52                                  *   if nonzero - substract from time */
53     uint32_t ignore;            ///< preroll is 64bit - but let's just ignore it
54     uint32_t flags;             /**< 0x01 - broadcast
55                                  *   0x02 - seekable
56                                  *   rest is reserved should be 0 */
57     uint32_t min_pktsize;       /**< size of a data packet
58                                  *   invalid if broadcasting */
59     uint32_t max_pktsize;       /**< shall be the same as for min_pktsize
60                                  *   invalid if broadcasting */
61     uint32_t max_bitrate;       /**< bandwith of stream in bps
62                                  *   should be the sum of bitrates of the
63                                  *   individual media streams */
64 } ASFMainHeader;
65
66
67 typedef struct {
68     uint32_t packet_number;
69     uint16_t packet_count;
70 } ASFIndex;
71
72
73 typedef struct {
74     uint32_t seqno;
75     unsigned int packet_size;
76     int is_streamed;
77     int asfid2avid[128];                 ///< conversion table from asf ID 2 AVStream ID
78     ASFStream streams[128];              ///< it's max number and it's not that big
79     /* non streamed additonnal info */
80     uint64_t nb_packets;                 ///< how many packets are there in the file, invalid if broadcasting
81     int64_t duration;                    ///< in 100ns units
82     /* packet filling */
83     unsigned char multi_payloads_present;
84     int packet_size_left;
85     int prev_packet_sent_time;
86     int packet_timestamp_start;
87     int packet_timestamp_end;
88     unsigned int packet_nb_payloads;
89     int packet_nb_frames;
90     uint8_t packet_buf[PACKET_SIZE];
91     ByteIOContext pb;
92     /* only for reading */
93     uint64_t data_offset;                ///< begining of the first data packet
94     uint64_t data_object_offset;         ///< data object offset (excl. GUID & size)
95     uint64_t data_object_size;           ///< size of the data object
96     int index_read;
97
98     ASFMainHeader hdr;
99
100     int packet_flags;
101     int packet_property;
102     int packet_timestamp;
103     int packet_segsizetype;
104     int packet_segments;
105     int packet_seq;
106     int packet_replic_size;
107     int packet_key_frame;
108     int packet_padsize;
109     int packet_frag_offset;
110     int packet_frag_size;
111     int packet_frag_timestamp;
112     int packet_multi_size;
113     int packet_obj_size;
114     int packet_time_delta;
115     int packet_time_start;
116     int64_t packet_pos;
117
118     int stream_index;
119
120
121     int64_t last_indexed_pts;
122     ASFIndex* index_ptr;
123     uint32_t nb_index_count;
124     uint32_t nb_index_memory_alloc;
125     uint16_t maximum_packet;
126
127     ASFStream* asf_st;                   ///< currently decoded stream
128 } ASFContext;
129
130 static const GUID asf_header = {
131     0x30, 0x26, 0xB2, 0x75, 0x8E, 0x66, 0xCF, 0x11, 0xA6, 0xD9, 0x00, 0xAA, 0x00, 0x62, 0xCE, 0x6C
132 };
133
134 static const GUID file_header = {
135     0xA1, 0xDC, 0xAB, 0x8C, 0x47, 0xA9, 0xCF, 0x11, 0x8E, 0xE4, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65
136 };
137
138 static const GUID stream_header = {
139     0x91, 0x07, 0xDC, 0xB7, 0xB7, 0xA9, 0xCF, 0x11, 0x8E, 0xE6, 0x00, 0xC0, 0x0C, 0x20, 0x53, 0x65
140 };
141
142 static const GUID ext_stream_header = {
143     0xCB, 0xA5, 0xE6, 0x14, 0x72, 0xC6, 0x32, 0x43, 0x83, 0x99, 0xA9, 0x69, 0x52, 0x06, 0x5B, 0x5A
144 };
145
146 static const GUID audio_stream = {
147     0x40, 0x9E, 0x69, 0xF8, 0x4D, 0x5B, 0xCF, 0x11, 0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B
148 };
149
150 static const GUID audio_conceal_none = {
151     // 0x40, 0xa4, 0xf1, 0x49, 0x4ece, 0x11d0, 0xa3, 0xac, 0x00, 0xa0, 0xc9, 0x03, 0x48, 0xf6
152     // New value lifted from avifile
153     0x00, 0x57, 0xfb, 0x20, 0x55, 0x5B, 0xCF, 0x11, 0xa8, 0xfd, 0x00, 0x80, 0x5f, 0x5c, 0x44, 0x2b
154 };
155
156 static const GUID audio_conceal_spread = {
157      0x50, 0xCD, 0xC3, 0xBF, 0x8F, 0x61, 0xCF, 0x11, 0x8B, 0xB2, 0x00, 0xAA, 0x00, 0xB4, 0xE2, 0x20
158 };
159
160 static const GUID video_stream = {
161     0xC0, 0xEF, 0x19, 0xBC, 0x4D, 0x5B, 0xCF, 0x11, 0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B
162 };
163
164 static const GUID video_conceal_none = {
165     0x00, 0x57, 0xFB, 0x20, 0x55, 0x5B, 0xCF, 0x11, 0xA8, 0xFD, 0x00, 0x80, 0x5F, 0x5C, 0x44, 0x2B
166 };
167
168 static const GUID command_stream = {
169     0xC0, 0xCF, 0xDA, 0x59, 0xE6, 0x59, 0xD0, 0x11, 0xA3, 0xAC, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6
170 };
171
172 static const GUID comment_header = {
173     0x33, 0x26, 0xb2, 0x75, 0x8E, 0x66, 0xCF, 0x11, 0xa6, 0xd9, 0x00, 0xaa, 0x00, 0x62, 0xce, 0x6c
174 };
175
176 static const GUID codec_comment_header = {
177     0x40, 0x52, 0xD1, 0x86, 0x1D, 0x31, 0xD0, 0x11, 0xA3, 0xA4, 0x00, 0xA0, 0xC9, 0x03, 0x48, 0xF6
178 };
179 static const GUID codec_comment1_header = {
180     0x41, 0x52, 0xd1, 0x86, 0x1D, 0x31, 0xD0, 0x11, 0xa3, 0xa4, 0x00, 0xa0, 0xc9, 0x03, 0x48, 0xf6
181 };
182
183 static const GUID data_header = {
184     0x36, 0x26, 0xb2, 0x75, 0x8E, 0x66, 0xCF, 0x11, 0xa6, 0xd9, 0x00, 0xaa, 0x00, 0x62, 0xce, 0x6c
185 };
186
187 static const GUID head1_guid = {
188     0xb5, 0x03, 0xbf, 0x5f, 0x2E, 0xA9, 0xCF, 0x11, 0x8e, 0xe3, 0x00, 0xc0, 0x0c, 0x20, 0x53, 0x65
189 };
190
191 static const GUID head2_guid = {
192     0x11, 0xd2, 0xd3, 0xab, 0xBA, 0xA9, 0xCF, 0x11, 0x8e, 0xe6, 0x00, 0xc0, 0x0c, 0x20, 0x53, 0x65
193 };
194
195 static const GUID extended_content_header = {
196         0x40, 0xA4, 0xD0, 0xD2, 0x07, 0xE3, 0xD2, 0x11, 0x97, 0xF0, 0x00, 0xA0, 0xC9, 0x5E, 0xA8, 0x50
197 };
198
199 static const GUID simple_index_header = {
200         0x90, 0x08, 0x00, 0x33, 0xB1, 0xE5, 0xCF, 0x11, 0x89, 0xF4, 0x00, 0xA0, 0xC9, 0x03, 0x49, 0xCB
201 };
202
203 static const GUID ext_stream_embed_stream_header = {
204         0xe2, 0x65, 0xfb, 0x3a, 0xEF, 0x47, 0xF2, 0x40, 0xac, 0x2c, 0x70, 0xa9, 0x0d, 0x71, 0xd3, 0x43
205 };
206
207 static const GUID ext_stream_audio_stream = {
208         0x9d, 0x8c, 0x17, 0x31, 0xE1, 0x03, 0x28, 0x45, 0xb5, 0x82, 0x3d, 0xf9, 0xdb, 0x22, 0xf5, 0x03
209 };
210
211 /* I am not a number !!! This GUID is the one found on the PC used to
212    generate the stream */
213 static const GUID my_guid = {
214     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
215 };
216
217 #define ASF_PACKET_FLAG_ERROR_CORRECTION_PRESENT 0x80 //1000 0000
218
219
220 //   ASF data packet structure
221 //   =========================
222 //
223 //
224 //  -----------------------------------
225 // | Error Correction Data             |  Optional
226 //  -----------------------------------
227 // | Payload Parsing Information (PPI) |
228 //  -----------------------------------
229 // | Payload Data                      |
230 //  -----------------------------------
231 // | Padding Data                      |
232 //  -----------------------------------
233
234
235 // PPI_FLAG - Payload parsing information flags
236 #define ASF_PPI_FLAG_MULTIPLE_PAYLOADS_PRESENT 1
237
238 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_BYTE  0x02 //0000 0010
239 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_WORD  0x04 //0000 0100
240 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_DWORD 0x06 //0000 0110
241 #define ASF_PPI_MASK_SEQUENCE_FIELD_SIZE     0x06 //0000 0110
242
243 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_BYTE  0x08 //0000 1000
244 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_WORD  0x10 //0001 0000
245 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_DWORD 0x18 //0001 1000
246 #define ASF_PPI_MASK_PADDING_LENGTH_FIELD_SIZE     0x18 //0001 1000
247
248 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_BYTE  0x20 //0010 0000
249 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_WORD  0x40 //0100 0000
250 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_DWORD 0x60 //0110 0000
251 #define ASF_PPI_MASK_PACKET_LENGTH_FIELD_SIZE     0x60 //0110 0000
252
253 // PL_FLAG - Payload flags
254 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_BYTE   0x01 //0000 0001
255 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_WORD   0x02 //0000 0010
256 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_DWORD  0x03 //0000 0011
257 #define ASF_PL_MASK_REPLICATED_DATA_LENGTH_FIELD_SIZE      0x03 //0000 0011
258
259 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_BYTE  0x04 //0000 0100
260 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_WORD  0x08 //0000 1000
261 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_DWORD 0x0c //0000 1100
262 #define ASF_PL_MASK_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_SIZE     0x0c //0000 1100
263
264 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_BYTE  0x10 //0001 0000
265 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_WORD  0x20 //0010 0000
266 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_DWORD 0x30 //0011 0000
267 #define ASF_PL_MASK_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_SIZE     0x30 //0011 0000
268
269 #define ASF_PL_FLAG_STREAM_NUMBER_LENGTH_FIELD_IS_BYTE  0x40 //0100 0000
270 #define ASF_PL_MASK_STREAM_NUMBER_LENGTH_FIELD_SIZE     0xc0 //1100 0000
271
272 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_BYTE  0x40 //0100 0000
273 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_WORD  0x80 //1000 0000
274 #define ASF_PL_MASK_PAYLOAD_LENGTH_FIELD_SIZE     0xc0 //1100 0000
275
276 #define ASF_PL_FLAG_KEY_FRAME 0x80 //1000 0000