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