]> git.sesse.net Git - ffmpeg/blob - doc/ffprobe.xsd
fftools/ffprobe: Add missing dispositions
[ffmpeg] / doc / ffprobe.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
4     targetNamespace="http://www.ffmpeg.org/schema/ffprobe"
5     xmlns:ffprobe="http://www.ffmpeg.org/schema/ffprobe">
6
7     <xsd:element name="ffprobe" type="ffprobe:ffprobeType"/>
8
9     <xsd:complexType name="ffprobeType">
10         <xsd:sequence>
11             <xsd:element name="program_version"  type="ffprobe:programVersionType"  minOccurs="0" maxOccurs="1" />
12             <xsd:element name="library_versions" type="ffprobe:libraryVersionsType" minOccurs="0" maxOccurs="1" />
13             <xsd:element name="pixel_formats"    type="ffprobe:pixelFormatsType"    minOccurs="0" maxOccurs="1" />
14             <xsd:element name="packets"  type="ffprobe:packetsType" minOccurs="0" maxOccurs="1" />
15             <xsd:element name="frames"   type="ffprobe:framesType"  minOccurs="0" maxOccurs="1" />
16             <xsd:element name="packets_and_frames" type="ffprobe:packetsAndFramesType" minOccurs="0" maxOccurs="1" />
17             <xsd:element name="programs" type="ffprobe:programsType" minOccurs="0" maxOccurs="1" />
18             <xsd:element name="streams"  type="ffprobe:streamsType" minOccurs="0" maxOccurs="1" />
19             <xsd:element name="chapters" type="ffprobe:chaptersType" minOccurs="0" maxOccurs="1" />
20             <xsd:element name="format"   type="ffprobe:formatType"  minOccurs="0" maxOccurs="1" />
21             <xsd:element name="error"    type="ffprobe:errorType"   minOccurs="0" maxOccurs="1" />
22         </xsd:sequence>
23     </xsd:complexType>
24
25     <xsd:complexType name="packetsType">
26         <xsd:sequence>
27             <xsd:element name="packet" type="ffprobe:packetType" minOccurs="0" maxOccurs="unbounded"/>
28         </xsd:sequence>
29     </xsd:complexType>
30
31     <xsd:complexType name="framesType">
32         <xsd:sequence>
33             <xsd:choice minOccurs="0" maxOccurs="unbounded">
34                 <xsd:element name="frame" type="ffprobe:frameType" minOccurs="0" maxOccurs="unbounded"/>
35                 <xsd:element name="subtitle" type="ffprobe:subtitleType" minOccurs="0" maxOccurs="unbounded"/>
36             </xsd:choice>
37         </xsd:sequence>
38     </xsd:complexType>
39
40     <xsd:complexType name="packetsAndFramesType">
41         <xsd:sequence>
42             <xsd:choice minOccurs="0" maxOccurs="unbounded">
43                 <xsd:element name="packet" type="ffprobe:packetType" minOccurs="0" maxOccurs="unbounded"/>
44                 <xsd:element name="frame" type="ffprobe:frameType" minOccurs="0" maxOccurs="unbounded"/>
45                 <xsd:element name="subtitle" type="ffprobe:subtitleType" minOccurs="0" maxOccurs="unbounded"/>
46             </xsd:choice>
47         </xsd:sequence>
48     </xsd:complexType>
49
50     <xsd:complexType name="packetType">
51       <xsd:sequence>
52         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
53         <xsd:element name="side_data_list" type="ffprobe:packetSideDataListType"   minOccurs="0" maxOccurs="1" />
54       </xsd:sequence>
55
56       <xsd:attribute name="codec_type"    type="xsd:string" use="required" />
57       <xsd:attribute name="stream_index"  type="xsd:int" use="required" />
58       <xsd:attribute name="pts"           type="xsd:long"  />
59       <xsd:attribute name="pts_time"      type="xsd:float" />
60       <xsd:attribute name="dts"           type="xsd:long"  />
61       <xsd:attribute name="dts_time"      type="xsd:float" />
62       <xsd:attribute name="duration"      type="xsd:long"  />
63       <xsd:attribute name="duration_time" type="xsd:float" />
64       <xsd:attribute name="size"          type="xsd:long" use="required" />
65       <xsd:attribute name="pos"           type="xsd:long"  />
66       <xsd:attribute name="flags"         type="xsd:string" use="required" />
67       <xsd:attribute name="data"          type="xsd:string" />
68       <xsd:attribute name="data_hash"     type="xsd:string" />
69     </xsd:complexType>
70
71     <xsd:complexType name="packetSideDataListType">
72         <xsd:sequence>
73             <xsd:element name="side_data" type="ffprobe:packetSideDataType" minOccurs="1" maxOccurs="unbounded"/>
74         </xsd:sequence>
75     </xsd:complexType>
76     <xsd:complexType name="packetSideDataType">
77         <xsd:attribute name="side_data_type"              type="xsd:string"/>
78         <xsd:attribute name="side_data_size"              type="xsd:int"   />
79     </xsd:complexType>
80
81     <xsd:complexType name="frameType">
82       <xsd:sequence>
83             <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
84             <xsd:element name="logs" type="ffprobe:logsType" minOccurs="0" maxOccurs="1"/>
85             <xsd:element name="side_data_list" type="ffprobe:frameSideDataListType"   minOccurs="0" maxOccurs="1" />
86       </xsd:sequence>
87
88       <xsd:attribute name="media_type"    type="xsd:string" use="required"/>
89       <xsd:attribute name="stream_index"  type="xsd:int"  />
90       <xsd:attribute name="key_frame"     type="xsd:int"    use="required"/>
91       <xsd:attribute name="pts"           type="xsd:long" />
92       <xsd:attribute name="pts_time"      type="xsd:float"/>
93       <xsd:attribute name="pkt_pts"       type="xsd:long" />
94       <xsd:attribute name="pkt_pts_time"  type="xsd:float"/>
95       <xsd:attribute name="pkt_dts"       type="xsd:long" />
96       <xsd:attribute name="pkt_dts_time"  type="xsd:float"/>
97       <xsd:attribute name="best_effort_timestamp"      type="xsd:long" />
98       <xsd:attribute name="best_effort_timestamp_time" type="xsd:float" />
99       <xsd:attribute name="pkt_duration"  type="xsd:long" />
100       <xsd:attribute name="pkt_duration_time" type="xsd:float"/>
101       <xsd:attribute name="pkt_pos"       type="xsd:long" />
102       <xsd:attribute name="pkt_size"      type="xsd:int" />
103
104       <!-- audio attributes -->
105       <xsd:attribute name="sample_fmt"             type="xsd:string"/>
106       <xsd:attribute name="nb_samples"             type="xsd:long"  />
107       <xsd:attribute name="channels"               type="xsd:int"   />
108       <xsd:attribute name="channel_layout"         type="xsd:string"/>
109
110       <!-- video attributes -->
111       <xsd:attribute name="width"                  type="xsd:long"  />
112       <xsd:attribute name="height"                 type="xsd:long"  />
113       <xsd:attribute name="pix_fmt"                type="xsd:string"/>
114       <xsd:attribute name="sample_aspect_ratio"    type="xsd:string"/>
115       <xsd:attribute name="pict_type"              type="xsd:string"/>
116       <xsd:attribute name="coded_picture_number"   type="xsd:long"  />
117       <xsd:attribute name="display_picture_number" type="xsd:long"  />
118       <xsd:attribute name="interlaced_frame"       type="xsd:int"   />
119       <xsd:attribute name="top_field_first"        type="xsd:int"   />
120       <xsd:attribute name="repeat_pict"            type="xsd:int"   />
121       <xsd:attribute name="color_range"            type="xsd:string"/>
122       <xsd:attribute name="color_space"            type="xsd:string"/>
123       <xsd:attribute name="color_primaries"        type="xsd:string"/>
124       <xsd:attribute name="color_transfer"         type="xsd:string"/>
125       <xsd:attribute name="chroma_location"        type="xsd:string"/>
126     </xsd:complexType>
127
128     <xsd:complexType name="logsType">
129         <xsd:sequence>
130             <xsd:element name="log" type="ffprobe:logType" minOccurs="1" maxOccurs="unbounded"/>
131         </xsd:sequence>
132     </xsd:complexType>
133     <xsd:complexType name="logType">
134         <xsd:attribute name="context"                     type="xsd:string"/>
135         <xsd:attribute name="level"                       type="xsd:int"   />
136         <xsd:attribute name="category"                    type="xsd:int"   />
137         <xsd:attribute name="parent_context"              type="xsd:string"/>
138         <xsd:attribute name="parent_category"             type="xsd:int"   />
139         <xsd:attribute name="message"                     type="xsd:string"/>
140     </xsd:complexType>
141
142     <xsd:complexType name="frameSideDataListType">
143         <xsd:sequence>
144             <xsd:element name="side_data" type="ffprobe:frameSideDataType" minOccurs="1" maxOccurs="unbounded"/>
145         </xsd:sequence>
146     </xsd:complexType>
147     <xsd:complexType name="frameSideDataType">
148         <xsd:sequence>
149             <xsd:element name="timecodes" type="ffprobe:frameSideDataTimecodeList" minOccurs="0" maxOccurs="1"/>
150         </xsd:sequence>
151
152         <xsd:attribute name="side_data_type"              type="xsd:string"/>
153         <xsd:attribute name="side_data_size"              type="xsd:int"   />
154         <xsd:attribute name="timecode"                    type="xsd:string"/>
155     </xsd:complexType>
156
157     <xsd:complexType name="frameSideDataTimecodeList">
158         <xsd:sequence>
159             <xsd:element name="timecode" type="ffprobe:frameSideDataTimecodeType" minOccurs="0" maxOccurs="unbounded"/>
160         </xsd:sequence>
161     </xsd:complexType>
162
163     <xsd:complexType name="frameSideDataTimecodeType">
164         <xsd:attribute name="value"              type="xsd:string"/>
165     </xsd:complexType>
166
167     <xsd:complexType name="subtitleType">
168       <xsd:attribute name="media_type"         type="xsd:string" fixed="subtitle" use="required"/>
169       <xsd:attribute name="pts"                type="xsd:long" />
170       <xsd:attribute name="pts_time"           type="xsd:float"/>
171       <xsd:attribute name="format"             type="xsd:int"  />
172       <xsd:attribute name="start_display_time" type="xsd:int"  />
173       <xsd:attribute name="end_display_time"   type="xsd:int"  />
174       <xsd:attribute name="num_rects"          type="xsd:int"  />
175     </xsd:complexType>
176
177     <xsd:complexType name="streamsType">
178         <xsd:sequence>
179             <xsd:element name="stream" type="ffprobe:streamType" minOccurs="0" maxOccurs="unbounded"/>
180         </xsd:sequence>
181     </xsd:complexType>
182
183     <xsd:complexType name="programsType">
184         <xsd:sequence>
185             <xsd:element name="program" type="ffprobe:programType" minOccurs="0" maxOccurs="unbounded"/>
186         </xsd:sequence>
187     </xsd:complexType>
188
189     <xsd:complexType name="streamDispositionType">
190       <xsd:attribute name="default"          type="xsd:int" use="required" />
191       <xsd:attribute name="dub"              type="xsd:int" use="required" />
192       <xsd:attribute name="original"         type="xsd:int" use="required" />
193       <xsd:attribute name="comment"          type="xsd:int" use="required" />
194       <xsd:attribute name="lyrics"           type="xsd:int" use="required" />
195       <xsd:attribute name="karaoke"          type="xsd:int" use="required" />
196       <xsd:attribute name="forced"           type="xsd:int" use="required" />
197       <xsd:attribute name="hearing_impaired" type="xsd:int" use="required" />
198       <xsd:attribute name="visual_impaired"  type="xsd:int" use="required" />
199       <xsd:attribute name="clean_effects"    type="xsd:int" use="required" />
200       <xsd:attribute name="attached_pic"     type="xsd:int" use="required" />
201       <xsd:attribute name="timed_thumbnails" type="xsd:int" use="required" />
202       <xsd:attribute name="captions"         type="xsd:int" use="required" />
203       <xsd:attribute name="descriptions"     type="xsd:int" use="required" />
204       <xsd:attribute name="metadata"         type="xsd:int" use="required" />
205       <xsd:attribute name="dependent"        type="xsd:int" use="required" />
206       <xsd:attribute name="still_image"      type="xsd:int" use="required" />
207     </xsd:complexType>
208
209     <xsd:complexType name="streamType">
210       <xsd:sequence>
211         <xsd:element name="disposition" type="ffprobe:streamDispositionType" minOccurs="0" maxOccurs="1"/>
212         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
213         <xsd:element name="side_data_list" type="ffprobe:packetSideDataListType"   minOccurs="0" maxOccurs="1" />
214       </xsd:sequence>
215
216       <xsd:attribute name="index"            type="xsd:int" use="required"/>
217       <xsd:attribute name="codec_name"       type="xsd:string" />
218       <xsd:attribute name="codec_long_name"  type="xsd:string" />
219       <xsd:attribute name="profile"          type="xsd:string" />
220       <xsd:attribute name="codec_type"       type="xsd:string" />
221       <xsd:attribute name="codec_tag"        type="xsd:string" use="required"/>
222       <xsd:attribute name="codec_tag_string" type="xsd:string" use="required"/>
223       <xsd:attribute name="extradata"        type="xsd:string" />
224       <xsd:attribute name="extradata_hash"   type="xsd:string" />
225
226       <!-- video attributes -->
227       <xsd:attribute name="width"                type="xsd:int"/>
228       <xsd:attribute name="height"               type="xsd:int"/>
229       <xsd:attribute name="coded_width"          type="xsd:int"/>
230       <xsd:attribute name="coded_height"         type="xsd:int"/>
231       <xsd:attribute name="closed_captions"      type="xsd:boolean"/>
232       <xsd:attribute name="has_b_frames"         type="xsd:int"/>
233       <xsd:attribute name="sample_aspect_ratio"  type="xsd:string"/>
234       <xsd:attribute name="display_aspect_ratio" type="xsd:string"/>
235       <xsd:attribute name="pix_fmt"              type="xsd:string"/>
236       <xsd:attribute name="level"                type="xsd:int"/>
237       <xsd:attribute name="color_range"          type="xsd:string"/>
238       <xsd:attribute name="color_space"          type="xsd:string"/>
239       <xsd:attribute name="color_transfer"       type="xsd:string"/>
240       <xsd:attribute name="color_primaries"      type="xsd:string"/>
241       <xsd:attribute name="chroma_location"      type="xsd:string"/>
242       <xsd:attribute name="field_order"          type="xsd:string"/>
243       <xsd:attribute name="refs"                 type="xsd:int"/>
244
245       <!-- audio attributes -->
246       <xsd:attribute name="sample_fmt"       type="xsd:string"/>
247       <xsd:attribute name="sample_rate"      type="xsd:int"/>
248       <xsd:attribute name="channels"         type="xsd:int"/>
249       <xsd:attribute name="channel_layout"   type="xsd:string"/>
250       <xsd:attribute name="bits_per_sample"  type="xsd:int"/>
251
252       <xsd:attribute name="id"               type="xsd:string"/>
253       <xsd:attribute name="r_frame_rate"     type="xsd:string" use="required"/>
254       <xsd:attribute name="avg_frame_rate"   type="xsd:string" use="required"/>
255       <xsd:attribute name="time_base"        type="xsd:string" use="required"/>
256       <xsd:attribute name="start_pts"        type="xsd:long"/>
257       <xsd:attribute name="start_time"       type="xsd:float"/>
258       <xsd:attribute name="duration_ts"      type="xsd:long"/>
259       <xsd:attribute name="duration"         type="xsd:float"/>
260       <xsd:attribute name="bit_rate"         type="xsd:int"/>
261       <xsd:attribute name="max_bit_rate"     type="xsd:int"/>
262       <xsd:attribute name="bits_per_raw_sample" type="xsd:int"/>
263       <xsd:attribute name="nb_frames"        type="xsd:int"/>
264       <xsd:attribute name="nb_read_frames"   type="xsd:int"/>
265       <xsd:attribute name="nb_read_packets"  type="xsd:int"/>
266     </xsd:complexType>
267
268     <xsd:complexType name="programType">
269       <xsd:sequence>
270         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
271         <xsd:element name="streams" type="ffprobe:streamsType" minOccurs="0" maxOccurs="1"/>
272       </xsd:sequence>
273
274       <xsd:attribute name="program_id"           type="xsd:int"    use="required"/>
275       <xsd:attribute name="program_num"          type="xsd:int"    use="required"/>
276       <xsd:attribute name="nb_streams"           type="xsd:int"    use="required"/>
277       <xsd:attribute name="start_time"           type="xsd:float"/>
278       <xsd:attribute name="start_pts"            type="xsd:long"/>
279       <xsd:attribute name="end_time"             type="xsd:float"/>
280       <xsd:attribute name="end_pts"              type="xsd:long"/>
281       <xsd:attribute name="pmt_pid"              type="xsd:int"    use="required"/>
282       <xsd:attribute name="pcr_pid"              type="xsd:int"    use="required"/>
283     </xsd:complexType>
284
285     <xsd:complexType name="formatType">
286       <xsd:sequence>
287         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
288       </xsd:sequence>
289
290       <xsd:attribute name="filename"         type="xsd:string" use="required"/>
291       <xsd:attribute name="nb_streams"       type="xsd:int"    use="required"/>
292       <xsd:attribute name="nb_programs"      type="xsd:int"    use="required"/>
293       <xsd:attribute name="format_name"      type="xsd:string" use="required"/>
294       <xsd:attribute name="format_long_name" type="xsd:string"/>
295       <xsd:attribute name="start_time"       type="xsd:float"/>
296       <xsd:attribute name="duration"         type="xsd:float"/>
297       <xsd:attribute name="size"             type="xsd:long"/>
298       <xsd:attribute name="bit_rate"         type="xsd:long"/>
299       <xsd:attribute name="probe_score"      type="xsd:int"/>
300     </xsd:complexType>
301
302     <xsd:complexType name="tagType">
303       <xsd:attribute name="key"   type="xsd:string" use="required"/>
304       <xsd:attribute name="value" type="xsd:string" use="required"/>
305     </xsd:complexType>
306
307     <xsd:complexType name="errorType">
308       <xsd:attribute name="code"   type="xsd:int"    use="required"/>
309       <xsd:attribute name="string" type="xsd:string" use="required"/>
310     </xsd:complexType>
311
312     <xsd:complexType name="programVersionType">
313       <xsd:attribute name="version"          type="xsd:string" use="required"/>
314       <xsd:attribute name="copyright"        type="xsd:string" use="required"/>
315       <xsd:attribute name="build_date"       type="xsd:string"/>
316       <xsd:attribute name="build_time"       type="xsd:string"/>
317       <xsd:attribute name="compiler_ident"   type="xsd:string" use="required"/>
318       <xsd:attribute name="configuration"    type="xsd:string" use="required"/>
319     </xsd:complexType>
320
321     <xsd:complexType name="chaptersType">
322       <xsd:sequence>
323         <xsd:element name="chapter" type="ffprobe:chapterType" minOccurs="0" maxOccurs="unbounded"/>
324       </xsd:sequence>
325     </xsd:complexType>
326
327     <xsd:complexType name="chapterType">
328       <xsd:sequence>
329         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
330       </xsd:sequence>
331
332       <xsd:attribute name="id"         type="xsd:int" use="required"/>
333       <xsd:attribute name="time_base"  type="xsd:string" use="required"/>
334       <xsd:attribute name="start"      type="xsd:int" use="required"/>
335       <xsd:attribute name="start_time" type="xsd:float"/>
336       <xsd:attribute name="end"        type="xsd:int" use="required"/>
337       <xsd:attribute name="end_time"   type="xsd:float" use="required"/>
338     </xsd:complexType>
339
340     <xsd:complexType name="libraryVersionType">
341       <xsd:attribute name="name"        type="xsd:string" use="required"/>
342       <xsd:attribute name="major"       type="xsd:int"    use="required"/>
343       <xsd:attribute name="minor"       type="xsd:int"    use="required"/>
344       <xsd:attribute name="micro"       type="xsd:int"    use="required"/>
345       <xsd:attribute name="version"     type="xsd:int"    use="required"/>
346       <xsd:attribute name="ident"       type="xsd:string" use="required"/>
347     </xsd:complexType>
348
349     <xsd:complexType name="libraryVersionsType">
350         <xsd:sequence>
351           <xsd:element name="library_version" type="ffprobe:libraryVersionType" minOccurs="0" maxOccurs="unbounded"/>
352         </xsd:sequence>
353     </xsd:complexType>
354
355     <xsd:complexType name="pixelFormatFlagsType">
356       <xsd:attribute name="big_endian" type="xsd:int" use="required"/>
357       <xsd:attribute name="palette"    type="xsd:int" use="required"/>
358       <xsd:attribute name="bitstream"  type="xsd:int" use="required"/>
359       <xsd:attribute name="hwaccel"    type="xsd:int" use="required"/>
360       <xsd:attribute name="planar"     type="xsd:int" use="required"/>
361       <xsd:attribute name="rgb"        type="xsd:int" use="required"/>
362       <xsd:attribute name="alpha"      type="xsd:int" use="required"/>
363     </xsd:complexType>
364
365     <xsd:complexType name="pixelFormatComponentType">
366       <xsd:attribute name="index"      type="xsd:int" use="required"/>
367       <xsd:attribute name="bit_depth"  type="xsd:int" use="required"/>
368     </xsd:complexType>
369
370     <xsd:complexType name="pixelFormatComponentsType">
371       <xsd:sequence>
372         <xsd:element name="component" type="ffprobe:pixelFormatComponentType" minOccurs="0" maxOccurs="unbounded"/>
373       </xsd:sequence>
374     </xsd:complexType>
375
376     <xsd:complexType name="pixelFormatType">
377       <xsd:sequence>
378         <xsd:element name="flags" type="ffprobe:pixelFormatFlagsType" minOccurs="0" maxOccurs="1"/>
379         <xsd:element name="components" type="ffprobe:pixelFormatComponentsType" minOccurs="0" maxOccurs="1"/>
380       </xsd:sequence>
381
382       <xsd:attribute name="name"                type="xsd:string" use="required"/>
383       <xsd:attribute name="nb_components"       type="xsd:int"    use="required"/>
384       <xsd:attribute name="log2_chroma_w"       type="xsd:int"/>
385       <xsd:attribute name="log2_chroma_h"       type="xsd:int"/>
386       <xsd:attribute name="bits_per_pixel"      type="xsd:int"/>
387     </xsd:complexType>
388
389     <xsd:complexType name="pixelFormatsType">
390       <xsd:sequence>
391         <xsd:element name="pixel_format" type="ffprobe:pixelFormatType" minOccurs="0" maxOccurs="unbounded"/>
392       </xsd:sequence>
393     </xsd:complexType>
394 </xsd:schema>