lavf: deprecate r_frame_rate.
[ffmpeg.git] / libavformat / asf.h
1 /*
2  * Copyright (c) 2000, 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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 #include "metadata.h"
27
28 #define PACKET_SIZE 3200
29
30 typedef struct {
31     int num;
32     unsigned char seq;
33     /* use for reading */
34     AVPacket pkt;
35     int frag_offset;
36     int timestamp;
37     int64_t duration;
38
39     int ds_span;                /* descrambling  */
40     int ds_packet_size;
41     int ds_chunk_size;
42
43     int64_t packet_pos;
44
45     uint16_t stream_language_index;
46
47     int      palette_changed;
48     uint32_t palette[256];
49 } ASFStream;
50
51 typedef uint8_t ff_asf_guid[16];
52
53 typedef struct {
54     ff_asf_guid guid;                  ///< generated by client computer
55     uint64_t file_size;         /**< in bytes
56                                  *   invalid if broadcasting */
57     uint64_t create_time;       /**< time of creation, in 100-nanosecond units since 1.1.1601
58                                  *   invalid if broadcasting */
59     uint64_t play_time;         /**< play time, in 100-nanosecond units
60                                  * invalid if broadcasting */
61     uint64_t send_time;         /**< time to send file, in 100-nanosecond units
62                                  *   invalid if broadcasting (could be ignored) */
63     uint32_t preroll;           /**< timestamp of the first packet, in milliseconds
64                                  *   if nonzero - subtract from time */
65     uint32_t ignore;            ///< preroll is 64bit - but let's just ignore it
66     uint32_t flags;             /**< 0x01 - broadcast
67                                  *   0x02 - seekable
68                                  *   rest is reserved should be 0 */
69     uint32_t min_pktsize;       /**< size of a data packet
70                                  *   invalid if broadcasting */
71     uint32_t max_pktsize;       /**< shall be the same as for min_pktsize
72                                  *   invalid if broadcasting */
73     uint32_t max_bitrate;       /**< bandwidth of stream in bps
74                                  *   should be the sum of bitrates of the
75                                  *   individual media streams */
76 } ASFMainHeader;
77
78
79 typedef struct {
80     uint32_t packet_number;
81     uint16_t packet_count;
82 } ASFIndex;
83
84 extern const ff_asf_guid ff_asf_header;
85 extern const ff_asf_guid ff_asf_file_header;
86 extern const ff_asf_guid ff_asf_stream_header;
87 extern const ff_asf_guid ff_asf_ext_stream_header;
88 extern const ff_asf_guid ff_asf_audio_stream;
89 extern const ff_asf_guid ff_asf_audio_conceal_none;
90 extern const ff_asf_guid ff_asf_audio_conceal_spread;
91 extern const ff_asf_guid ff_asf_video_stream;
92 extern const ff_asf_guid ff_asf_jfif_media;
93 extern const ff_asf_guid ff_asf_video_conceal_none;
94 extern const ff_asf_guid ff_asf_command_stream;
95 extern const ff_asf_guid ff_asf_comment_header;
96 extern const ff_asf_guid ff_asf_codec_comment_header;
97 extern const ff_asf_guid ff_asf_codec_comment1_header;
98 extern const ff_asf_guid ff_asf_data_header;
99 extern const ff_asf_guid ff_asf_head1_guid;
100 extern const ff_asf_guid ff_asf_head2_guid;
101 extern const ff_asf_guid ff_asf_extended_content_header;
102 extern const ff_asf_guid ff_asf_simple_index_header;
103 extern const ff_asf_guid ff_asf_ext_stream_embed_stream_header;
104 extern const ff_asf_guid ff_asf_ext_stream_audio_stream;
105 extern const ff_asf_guid ff_asf_metadata_header;
106 extern const ff_asf_guid ff_asf_marker_header;
107 extern const ff_asf_guid ff_asf_my_guid;
108 extern const ff_asf_guid ff_asf_language_guid;
109 extern const ff_asf_guid ff_asf_content_encryption;
110 extern const ff_asf_guid ff_asf_ext_content_encryption;
111 extern const ff_asf_guid ff_asf_digital_signature;
112
113 extern const AVMetadataConv ff_asf_metadata_conv[];
114
115 #define ASF_PACKET_FLAG_ERROR_CORRECTION_PRESENT 0x80 //1000 0000
116
117
118 //   ASF data packet structure
119 //   =========================
120 //
121 //
122 //  -----------------------------------
123 // | Error Correction Data             |  Optional
124 //  -----------------------------------
125 // | Payload Parsing Information (PPI) |
126 //  -----------------------------------
127 // | Payload Data                      |
128 //  -----------------------------------
129 // | Padding Data                      |
130 //  -----------------------------------
131
132
133 // PPI_FLAG - Payload parsing information flags
134 #define ASF_PPI_FLAG_MULTIPLE_PAYLOADS_PRESENT 1
135
136 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_BYTE  0x02 //0000 0010
137 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_WORD  0x04 //0000 0100
138 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_DWORD 0x06 //0000 0110
139 #define ASF_PPI_MASK_SEQUENCE_FIELD_SIZE     0x06 //0000 0110
140
141 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_BYTE  0x08 //0000 1000
142 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_WORD  0x10 //0001 0000
143 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_DWORD 0x18 //0001 1000
144 #define ASF_PPI_MASK_PADDING_LENGTH_FIELD_SIZE     0x18 //0001 1000
145
146 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_BYTE  0x20 //0010 0000
147 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_WORD  0x40 //0100 0000
148 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_DWORD 0x60 //0110 0000
149 #define ASF_PPI_MASK_PACKET_LENGTH_FIELD_SIZE     0x60 //0110 0000
150
151 // PL_FLAG - Payload flags
152 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_BYTE   0x01 //0000 0001
153 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_WORD   0x02 //0000 0010
154 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_DWORD  0x03 //0000 0011
155 #define ASF_PL_MASK_REPLICATED_DATA_LENGTH_FIELD_SIZE      0x03 //0000 0011
156
157 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_BYTE  0x04 //0000 0100
158 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_WORD  0x08 //0000 1000
159 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_DWORD 0x0c //0000 1100
160 #define ASF_PL_MASK_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_SIZE     0x0c //0000 1100
161
162 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_BYTE  0x10 //0001 0000
163 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_WORD  0x20 //0010 0000
164 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_DWORD 0x30 //0011 0000
165 #define ASF_PL_MASK_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_SIZE     0x30 //0011 0000
166
167 #define ASF_PL_FLAG_STREAM_NUMBER_LENGTH_FIELD_IS_BYTE  0x40 //0100 0000
168 #define ASF_PL_MASK_STREAM_NUMBER_LENGTH_FIELD_SIZE     0xc0 //1100 0000
169
170 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_BYTE  0x40 //0100 0000
171 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_WORD  0x80 //1000 0000
172 #define ASF_PL_MASK_PAYLOAD_LENGTH_FIELD_SIZE     0xc0 //1100 0000
173
174 #define ASF_PL_FLAG_KEY_FRAME 0x80 //1000 0000
175
176 extern AVInputFormat ff_asf_demuxer;
177
178 static av_always_inline int ff_guidcmp(const void *g1, const void *g2)
179 {
180     return memcmp(g1, g2, sizeof(ff_asf_guid));
181 }
182
183 void ff_get_guid(AVIOContext *s, ff_asf_guid *g);
184
185 #endif /* AVFORMAT_ASF_H */