FFmpeg
asf.h
Go to the documentation of this file.
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 #include "metadata.h"
27 #include "riff.h"
28 
29 typedef enum ASFDataType {
32  ASF_BOOL = 2,
33  ASF_DWORD = 3,
34  ASF_QWORD = 4,
35  ASF_WORD = 5,
36  ASF_GUID = 6,
38 
39 typedef struct ASFMainHeader {
40  ff_asf_guid guid; ///< generated by client computer
41  uint64_t file_size; /**< in bytes
42  * invalid if broadcasting */
43  uint64_t create_time; /**< time of creation, in 100-nanosecond units since 1.1.1601
44  * invalid if broadcasting */
45  uint64_t play_time; /**< play time, in 100-nanosecond units
46  * invalid if broadcasting */
47  uint64_t send_time; /**< time to send file, in 100-nanosecond units
48  * invalid if broadcasting (could be ignored) */
49  uint32_t preroll; /**< timestamp of the first packet, in milliseconds
50  * if nonzero - subtract from time */
51  uint32_t ignore; ///< preroll is 64 bits - but let's just ignore it
52  uint32_t flags; /**< 0x01 - broadcast
53  * 0x02 - seekable
54  * rest is reserved should be 0 */
55  uint32_t min_pktsize; /**< size of a data packet
56  * invalid if broadcasting */
57  uint32_t max_pktsize; /**< shall be the same as for min_pktsize
58  * invalid if broadcasting */
59  uint32_t max_bitrate; /**< bandwidth of stream in bps
60  * should be the sum of bitrates of the
61  * individual media streams */
63 
64 
65 typedef struct ASFIndex {
66  uint32_t packet_number;
67  uint16_t packet_count;
68  uint64_t send_time;
69  uint64_t offset;
70 } ASFIndex;
71 
72 extern const ff_asf_guid ff_asf_header;
73 extern const ff_asf_guid ff_asf_file_header;
76 extern const ff_asf_guid ff_asf_audio_stream;
78 extern const ff_asf_guid ff_asf_video_stream;
79 extern const ff_asf_guid ff_asf_jfif_media;
85 extern const ff_asf_guid ff_asf_data_header;
86 extern const ff_asf_guid ff_asf_head1_guid;
87 extern const ff_asf_guid ff_asf_head2_guid;
95 extern const ff_asf_guid ff_asf_reserved_4;
96 extern const ff_asf_guid ff_asf_my_guid;
104 
105 extern const AVMetadataConv ff_asf_metadata_conv[];
106 
107 /**
108  * Handles both attached pictures as well as id3 tags.
109  *
110  * @return Returns < 0 on error, 1 if the type of the byte array
111  * is unsupported by this function and 0 otherwise.
112  */
114  int val_len);
115 
116 
117 #define ASF_PACKET_FLAG_ERROR_CORRECTION_PRESENT 0x80 //1000 0000
118 
119 
120 // ASF data packet structure
121 // =========================
122 //
123 //
124 // -----------------------------------
125 // | Error Correction Data | Optional
126 // -----------------------------------
127 // | Payload Parsing Information (PPI) |
128 // -----------------------------------
129 // | Payload Data |
130 // -----------------------------------
131 // | Padding Data |
132 // -----------------------------------
133 
134 
135 // PPI_FLAG - Payload parsing information flags
136 #define ASF_PPI_FLAG_MULTIPLE_PAYLOADS_PRESENT 1
137 
138 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_BYTE 0x02 //0000 0010
139 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_WORD 0x04 //0000 0100
140 #define ASF_PPI_FLAG_SEQUENCE_FIELD_IS_DWORD 0x06 //0000 0110
141 #define ASF_PPI_MASK_SEQUENCE_FIELD_SIZE 0x06 //0000 0110
142 
143 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_BYTE 0x08 //0000 1000
144 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_WORD 0x10 //0001 0000
145 #define ASF_PPI_FLAG_PADDING_LENGTH_FIELD_IS_DWORD 0x18 //0001 1000
146 #define ASF_PPI_MASK_PADDING_LENGTH_FIELD_SIZE 0x18 //0001 1000
147 
148 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_BYTE 0x20 //0010 0000
149 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_WORD 0x40 //0100 0000
150 #define ASF_PPI_FLAG_PACKET_LENGTH_FIELD_IS_DWORD 0x60 //0110 0000
151 #define ASF_PPI_MASK_PACKET_LENGTH_FIELD_SIZE 0x60 //0110 0000
152 
153 // PL_FLAG - Payload flags
154 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_BYTE 0x01 //0000 0001
155 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_WORD 0x02 //0000 0010
156 #define ASF_PL_FLAG_REPLICATED_DATA_LENGTH_FIELD_IS_DWORD 0x03 //0000 0011
157 #define ASF_PL_MASK_REPLICATED_DATA_LENGTH_FIELD_SIZE 0x03 //0000 0011
158 
159 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_BYTE 0x04 //0000 0100
160 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_WORD 0x08 //0000 1000
161 #define ASF_PL_FLAG_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_IS_DWORD 0x0c //0000 1100
162 #define ASF_PL_MASK_OFFSET_INTO_MEDIA_OBJECT_LENGTH_FIELD_SIZE 0x0c //0000 1100
163 
164 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_BYTE 0x10 //0001 0000
165 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_WORD 0x20 //0010 0000
166 #define ASF_PL_FLAG_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_IS_DWORD 0x30 //0011 0000
167 #define ASF_PL_MASK_MEDIA_OBJECT_NUMBER_LENGTH_FIELD_SIZE 0x30 //0011 0000
168 
169 #define ASF_PL_FLAG_STREAM_NUMBER_LENGTH_FIELD_IS_BYTE 0x40 //0100 0000
170 #define ASF_PL_MASK_STREAM_NUMBER_LENGTH_FIELD_SIZE 0xc0 //1100 0000
171 
172 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_BYTE 0x40 //0100 0000
173 #define ASF_PL_FLAG_PAYLOAD_LENGTH_FIELD_IS_WORD 0x80 //1000 0000
174 #define ASF_PL_MASK_PAYLOAD_LENGTH_FIELD_SIZE 0xc0 //1100 0000
175 
176 #define ASF_PL_FLAG_KEY_FRAME 0x80 //1000 0000
177 
178 #endif /* AVFORMAT_ASF_H */
name
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option name
Definition: writing_filters.txt:88
ASFIndex
Definition: asf.h:65
ASF_WORD
@ ASF_WORD
Definition: asf.h:35
ASFMainHeader::send_time
uint64_t send_time
time to send file, in 100-nanosecond units invalid if broadcasting (could be ignored)
Definition: asf.h:47
ff_asf_audio_stream
const ff_asf_guid ff_asf_audio_stream
Definition: asf_tags.c:39
ff_asf_simple_index_header
const ff_asf_guid ff_asf_simple_index_header
Definition: asf_tags.c:90
ASFMainHeader::preroll
uint32_t preroll
timestamp of the first packet, in milliseconds if nonzero - subtract from time
Definition: asf.h:49
ASF_BOOL
@ ASF_BOOL
Definition: asf.h:32
AVMetadataConv
Definition: metadata.h:34
ASF_UNICODE
@ ASF_UNICODE
Definition: asf.h:30
ASFMainHeader::flags
uint32_t flags
0x01 - broadcast 0x02 - seekable rest is reserved should be 0
Definition: asf.h:52
ASF_GUID
@ ASF_GUID
Definition: asf.h:36
ASFMainHeader::create_time
uint64_t create_time
time of creation, in 100-nanosecond units since 1.1.1601 invalid if broadcasting
Definition: asf.h:43
ff_asf_ext_stream_header
const ff_asf_guid ff_asf_ext_stream_header
Definition: asf_tags.c:35
s
#define s(width, name)
Definition: cbs_vp9.c:198
ff_asf_language_guid
const ff_asf_guid ff_asf_language_guid
Definition: asf_tags.c:124
ff_asf_video_stream
const ff_asf_guid ff_asf_video_stream
Definition: asf_tags.c:47
ff_asf_mutex_language
const ff_asf_guid ff_asf_mutex_language
Definition: asf_tags.c:148
ASF_BYTE_ARRAY
@ ASF_BYTE_ARRAY
Definition: asf.h:31
ff_asf_codec_comment1_header
const ff_asf_guid ff_asf_codec_comment1_header
Definition: asf_tags.c:70
ASFIndex::send_time
uint64_t send_time
Definition: asf.h:68
ASFMainHeader
Definition: asf.h:39
AVFormatContext
Format I/O context.
Definition: avformat.h:1255
ASF_QWORD
@ ASF_QWORD
Definition: asf.h:34
ff_asf_extended_content_header
const ff_asf_guid ff_asf_extended_content_header
Definition: asf_tags.c:86
ASFMainHeader::guid
ff_asf_guid guid
generated by client computer
Definition: asf.h:40
ff_asf_guid
uint8_t ff_asf_guid[16]
Definition: riff.h:96
ff_asf_head1_guid
const ff_asf_guid ff_asf_head1_guid
Definition: asf_tags.c:78
ASFMainHeader::ignore
uint32_t ignore
preroll is 64 bits - but let's just ignore it
Definition: asf.h:51
ASFMainHeader::play_time
uint64_t play_time
play time, in 100-nanosecond units invalid if broadcasting
Definition: asf.h:45
ff_asf_data_header
const ff_asf_guid ff_asf_data_header
Definition: asf_tags.c:74
ff_asf_extended_stream_properties_object
const ff_asf_guid ff_asf_extended_stream_properties_object
Definition: asf_tags.c:140
ASFIndex::packet_number
uint32_t packet_number
Definition: asf.h:66
ff_asf_file_header
const ff_asf_guid ff_asf_file_header
Definition: asf_tags.c:27
ff_asf_video_conceal_none
const ff_asf_guid ff_asf_video_conceal_none
Definition: asf_tags.c:55
ASFMainHeader::min_pktsize
uint32_t min_pktsize
size of a data packet invalid if broadcasting
Definition: asf.h:55
ASFMainHeader::max_pktsize
uint32_t max_pktsize
shall be the same as for min_pktsize invalid if broadcasting
Definition: asf.h:57
ASF_DWORD
@ ASF_DWORD
Definition: asf.h:33
ff_asf_reserved_4
const ff_asf_guid ff_asf_reserved_4
Definition: asf_tags.c:114
ff_asf_digital_signature
const ff_asf_guid ff_asf_digital_signature
Definition: asf_tags.c:136
ff_asf_comment_header
const ff_asf_guid ff_asf_comment_header
Definition: asf_tags.c:63
ff_asf_jfif_media
const ff_asf_guid ff_asf_jfif_media
Definition: asf_tags.c:51
ff_asf_ext_stream_audio_stream
const ff_asf_guid ff_asf_ext_stream_audio_stream
Definition: asf_tags.c:98
ASFIndex::offset
uint64_t offset
Definition: asf.h:69
ff_asf_ext_stream_embed_stream_header
const ff_asf_guid ff_asf_ext_stream_embed_stream_header
Definition: asf_tags.c:94
ff_asf_my_guid
const ff_asf_guid ff_asf_my_guid
Definition: asf_tags.c:120
ff_asf_codec_comment_header
const ff_asf_guid ff_asf_codec_comment_header
Definition: asf_tags.c:67
ff_asf_content_encryption
const ff_asf_guid ff_asf_content_encryption
Definition: asf_tags.c:128
ff_asf_head2_guid
const ff_asf_guid ff_asf_head2_guid
Definition: asf_tags.c:82
ff_asf_handle_byte_array
int ff_asf_handle_byte_array(AVFormatContext *s, const char *name, int val_len)
Handles both attached pictures as well as id3 tags.
Definition: asf.c:141
ff_asf_audio_conceal_spread
const ff_asf_guid ff_asf_audio_conceal_spread
Definition: asf_tags.c:43
metadata.h
ASFMainHeader::file_size
uint64_t file_size
in bytes invalid if broadcasting
Definition: asf.h:41
ff_asf_stream_header
const ff_asf_guid ff_asf_stream_header
Definition: asf_tags.c:31
avformat.h
ASFDataType
ASFDataType
Definition: asf.h:29
ff_asf_metadata_conv
const AVMetadataConv ff_asf_metadata_conv[]
Definition: asf.c:27
ff_asf_marker_header
const ff_asf_guid ff_asf_marker_header
Definition: asf_tags.c:110
ASFMainHeader::max_bitrate
uint32_t max_bitrate
bandwidth of stream in bps should be the sum of bitrates of the individual media streams
Definition: asf.h:59
ff_asf_group_mutual_exclusion_object
const ff_asf_guid ff_asf_group_mutual_exclusion_object
Definition: asf_tags.c:144
ff_asf_ext_content_encryption
const ff_asf_guid ff_asf_ext_content_encryption
Definition: asf_tags.c:132
riff.h
ff_asf_metadata_library_header
const ff_asf_guid ff_asf_metadata_library_header
Definition: asf_tags.c:106
ASFIndex::packet_count
uint16_t packet_count
Definition: asf.h:67
ff_asf_metadata_header
const ff_asf_guid ff_asf_metadata_header
Definition: asf_tags.c:102
ff_asf_header
const ff_asf_guid ff_asf_header
Definition: asf_tags.c:23
ff_asf_command_stream
const ff_asf_guid ff_asf_command_stream
Definition: asf_tags.c:59