Merge commit '0801853e640624537db386727b36fa97aa6258e7'
[ffmpeg.git] / 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="convergence_duration"      type="xsd:long"  />
65       <xsd:attribute name="convergence_duration_time" type="xsd:float" />
66       <xsd:attribute name="size"          type="xsd:long" use="required" />
67       <xsd:attribute name="pos"           type="xsd:long"  />
68       <xsd:attribute name="flags"         type="xsd:string" use="required" />
69       <xsd:attribute name="data"          type="xsd:string" />
70       <xsd:attribute name="data_hash"     type="xsd:string" />
71     </xsd:complexType>
72
73     <xsd:complexType name="packetSideDataListType">
74         <xsd:sequence>
75             <xsd:element name="side_data" type="ffprobe:packetSideDataType" minOccurs="1" maxOccurs="unbounded"/>
76         </xsd:sequence>
77     </xsd:complexType>
78     <xsd:complexType name="packetSideDataType">
79         <xsd:attribute name="side_data_type"              type="xsd:string"/>
80         <xsd:attribute name="side_data_size"              type="xsd:int"   />
81     </xsd:complexType>
82
83     <xsd:complexType name="frameType">
84       <xsd:sequence>
85             <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
86             <xsd:element name="logs" type="ffprobe:logsType" minOccurs="0" maxOccurs="1"/>
87             <xsd:element name="side_data_list" type="ffprobe:frameSideDataListType"   minOccurs="0" maxOccurs="1" />
88       </xsd:sequence>
89
90       <xsd:attribute name="media_type"    type="xsd:string" use="required"/>
91       <xsd:attribute name="stream_index"  type="xsd:int"  />
92       <xsd:attribute name="key_frame"     type="xsd:int"    use="required"/>
93       <xsd:attribute name="pts"           type="xsd:long" />
94       <xsd:attribute name="pts_time"      type="xsd:float"/>
95       <xsd:attribute name="pkt_pts"       type="xsd:long" />
96       <xsd:attribute name="pkt_pts_time"  type="xsd:float"/>
97       <xsd:attribute name="pkt_dts"       type="xsd:long" />
98       <xsd:attribute name="pkt_dts_time"  type="xsd:float"/>
99       <xsd:attribute name="best_effort_timestamp"      type="xsd:long" />
100       <xsd:attribute name="best_effort_timestamp_time" type="xsd:float" />
101       <xsd:attribute name="pkt_duration"  type="xsd:long" />
102       <xsd:attribute name="pkt_duration_time" type="xsd:float"/>
103       <xsd:attribute name="pkt_pos"       type="xsd:long" />
104       <xsd:attribute name="pkt_size"      type="xsd:int" />
105
106       <!-- audio attributes -->
107       <xsd:attribute name="sample_fmt"             type="xsd:string"/>
108       <xsd:attribute name="nb_samples"             type="xsd:long"  />
109       <xsd:attribute name="channels"               type="xsd:int"   />
110       <xsd:attribute name="channel_layout"         type="xsd:string"/>
111
112       <!-- video attributes -->
113       <xsd:attribute name="width"                  type="xsd:long"  />
114       <xsd:attribute name="height"                 type="xsd:long"  />
115       <xsd:attribute name="pix_fmt"                type="xsd:string"/>
116       <xsd:attribute name="sample_aspect_ratio"    type="xsd:string"/>
117       <xsd:attribute name="pict_type"              type="xsd:string"/>
118       <xsd:attribute name="coded_picture_number"   type="xsd:long"  />
119       <xsd:attribute name="display_picture_number" type="xsd:long"  />
120       <xsd:attribute name="interlaced_frame"       type="xsd:int"   />
121       <xsd:attribute name="top_field_first"        type="xsd:int"   />
122       <xsd:attribute name="repeat_pict"            type="xsd:int"   />
123       <xsd:attribute name="color_range"            type="xsd:string"/>
124       <xsd:attribute name="color_space"            type="xsd:string"/>
125       <xsd:attribute name="color_primaries"        type="xsd:string"/>
126       <xsd:attribute name="color_transfer"         type="xsd:string"/>
127       <xsd:attribute name="chroma_location"        type="xsd:string"/>
128     </xsd:complexType>
129
130     <xsd:complexType name="logsType">
131         <xsd:sequence>
132             <xsd:element name="log" type="ffprobe:logType" minOccurs="1" maxOccurs="unbounded"/>
133         </xsd:sequence>
134     </xsd:complexType>
135     <xsd:complexType name="logType">
136         <xsd:attribute name="context"                     type="xsd:string"/>
137         <xsd:attribute name="level"                       type="xsd:int"   />
138         <xsd:attribute name="category"                    type="xsd:int"   />
139         <xsd:attribute name="parent_context"              type="xsd:string"/>
140         <xsd:attribute name="parent_category"             type="xsd:int"   />
141         <xsd:attribute name="message"                     type="xsd:string"/>
142     </xsd:complexType>
143
144     <xsd:complexType name="frameSideDataListType">
145         <xsd:sequence>
146             <xsd:element name="side_data" type="ffprobe:frameSideDataType" minOccurs="1" maxOccurs="unbounded"/>
147         </xsd:sequence>
148     </xsd:complexType>
149     <xsd:complexType name="frameSideDataType">
150         <xsd:attribute name="side_data_type"              type="xsd:string"/>
151         <xsd:attribute name="side_data_size"              type="xsd:int"   />
152         <xsd:attribute name="timecode"                    type="xsd:string"/>
153     </xsd:complexType>
154
155     <xsd:complexType name="subtitleType">
156       <xsd:attribute name="media_type"         type="xsd:string" fixed="subtitle" use="required"/>
157       <xsd:attribute name="pts"                type="xsd:long" />
158       <xsd:attribute name="pts_time"           type="xsd:float"/>
159       <xsd:attribute name="format"             type="xsd:int"  />
160       <xsd:attribute name="start_display_time" type="xsd:int"  />
161       <xsd:attribute name="end_display_time"   type="xsd:int"  />
162       <xsd:attribute name="num_rects"          type="xsd:int"  />
163     </xsd:complexType>
164
165     <xsd:complexType name="streamsType">
166         <xsd:sequence>
167             <xsd:element name="stream" type="ffprobe:streamType" minOccurs="0" maxOccurs="unbounded"/>
168         </xsd:sequence>
169     </xsd:complexType>
170
171     <xsd:complexType name="programsType">
172         <xsd:sequence>
173             <xsd:element name="program" type="ffprobe:programType" minOccurs="0" maxOccurs="unbounded"/>
174         </xsd:sequence>
175     </xsd:complexType>
176
177     <xsd:complexType name="streamDispositionType">
178       <xsd:attribute name="default"          type="xsd:int" use="required" />
179       <xsd:attribute name="dub"              type="xsd:int" use="required" />
180       <xsd:attribute name="original"         type="xsd:int" use="required" />
181       <xsd:attribute name="comment"          type="xsd:int" use="required" />
182       <xsd:attribute name="lyrics"           type="xsd:int" use="required" />
183       <xsd:attribute name="karaoke"          type="xsd:int" use="required" />
184       <xsd:attribute name="forced"           type="xsd:int" use="required" />
185       <xsd:attribute name="hearing_impaired" type="xsd:int" use="required" />
186       <xsd:attribute name="visual_impaired"  type="xsd:int" use="required" />
187       <xsd:attribute name="clean_effects"    type="xsd:int" use="required" />
188       <xsd:attribute name="attached_pic"     type="xsd:int" use="required" />
189       <xsd:attribute name="timed_thumbnails" type="xsd:int" use="required" />
190     </xsd:complexType>
191
192     <xsd:complexType name="streamType">
193       <xsd:sequence>
194         <xsd:element name="disposition" type="ffprobe:streamDispositionType" minOccurs="0" maxOccurs="1"/>
195         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
196         <xsd:element name="side_data_list" type="ffprobe:packetSideDataListType"   minOccurs="0" maxOccurs="1" />
197       </xsd:sequence>
198
199       <xsd:attribute name="index"            type="xsd:int" use="required"/>
200       <xsd:attribute name="codec_name"       type="xsd:string" />
201       <xsd:attribute name="codec_long_name"  type="xsd:string" />
202       <xsd:attribute name="profile"          type="xsd:string" />
203       <xsd:attribute name="codec_type"       type="xsd:string" />
204       <xsd:attribute name="codec_time_base"  type="xsd:string" use="required"/>
205       <xsd:attribute name="codec_tag"        type="xsd:string" use="required"/>
206       <xsd:attribute name="codec_tag_string" type="xsd:string" use="required"/>
207       <xsd:attribute name="extradata"        type="xsd:string" />
208       <xsd:attribute name="extradata_hash"   type="xsd:string" />
209
210       <!-- video attributes -->
211       <xsd:attribute name="width"                type="xsd:int"/>
212       <xsd:attribute name="height"               type="xsd:int"/>
213       <xsd:attribute name="coded_width"          type="xsd:int"/>
214       <xsd:attribute name="coded_height"         type="xsd:int"/>
215       <xsd:attribute name="has_b_frames"         type="xsd:int"/>
216       <xsd:attribute name="sample_aspect_ratio"  type="xsd:string"/>
217       <xsd:attribute name="display_aspect_ratio" type="xsd:string"/>
218       <xsd:attribute name="pix_fmt"              type="xsd:string"/>
219       <xsd:attribute name="level"                type="xsd:int"/>
220       <xsd:attribute name="color_range"          type="xsd:string"/>
221       <xsd:attribute name="color_space"          type="xsd:string"/>
222       <xsd:attribute name="color_transfer"       type="xsd:string"/>
223       <xsd:attribute name="color_primaries"      type="xsd:string"/>
224       <xsd:attribute name="chroma_location"      type="xsd:string"/>
225       <xsd:attribute name="field_order"          type="xsd:string"/>
226       <xsd:attribute name="timecode"             type="xsd:string"/>
227       <xsd:attribute name="refs"                 type="xsd:int"/>
228
229       <!-- audio attributes -->
230       <xsd:attribute name="sample_fmt"       type="xsd:string"/>
231       <xsd:attribute name="sample_rate"      type="xsd:int"/>
232       <xsd:attribute name="channels"         type="xsd:int"/>
233       <xsd:attribute name="channel_layout"   type="xsd:string"/>
234       <xsd:attribute name="bits_per_sample"  type="xsd:int"/>
235
236       <xsd:attribute name="id"               type="xsd:string"/>
237       <xsd:attribute name="r_frame_rate"     type="xsd:string" use="required"/>
238       <xsd:attribute name="avg_frame_rate"   type="xsd:string" use="required"/>
239       <xsd:attribute name="time_base"        type="xsd:string" use="required"/>
240       <xsd:attribute name="start_pts"        type="xsd:long"/>
241       <xsd:attribute name="start_time"       type="xsd:float"/>
242       <xsd:attribute name="duration_ts"      type="xsd:long"/>
243       <xsd:attribute name="duration"         type="xsd:float"/>
244       <xsd:attribute name="bit_rate"         type="xsd:int"/>
245       <xsd:attribute name="max_bit_rate"     type="xsd:int"/>
246       <xsd:attribute name="bits_per_raw_sample" type="xsd:int"/>
247       <xsd:attribute name="nb_frames"        type="xsd:int"/>
248       <xsd:attribute name="nb_read_frames"   type="xsd:int"/>
249       <xsd:attribute name="nb_read_packets"  type="xsd:int"/>
250     </xsd:complexType>
251
252     <xsd:complexType name="programType">
253       <xsd:sequence>
254         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
255         <xsd:element name="streams" type="ffprobe:streamsType" minOccurs="0" maxOccurs="1"/>
256       </xsd:sequence>
257
258       <xsd:attribute name="program_id"           type="xsd:int"    use="required"/>
259       <xsd:attribute name="program_num"          type="xsd:int"    use="required"/>
260       <xsd:attribute name="nb_streams"           type="xsd:int"    use="required"/>
261       <xsd:attribute name="start_time"           type="xsd:float"/>
262       <xsd:attribute name="start_pts"            type="xsd:long"/>
263       <xsd:attribute name="end_time"             type="xsd:float"/>
264       <xsd:attribute name="end_pts"              type="xsd:long"/>
265       <xsd:attribute name="pmt_pid"              type="xsd:int"    use="required"/>
266       <xsd:attribute name="pcr_pid"              type="xsd:int"    use="required"/>
267     </xsd:complexType>
268
269     <xsd:complexType name="formatType">
270       <xsd:sequence>
271         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
272       </xsd:sequence>
273
274       <xsd:attribute name="filename"         type="xsd:string" use="required"/>
275       <xsd:attribute name="nb_streams"       type="xsd:int"    use="required"/>
276       <xsd:attribute name="nb_programs"      type="xsd:int"    use="required"/>
277       <xsd:attribute name="format_name"      type="xsd:string" use="required"/>
278       <xsd:attribute name="format_long_name" type="xsd:string"/>
279       <xsd:attribute name="start_time"       type="xsd:float"/>
280       <xsd:attribute name="duration"         type="xsd:float"/>
281       <xsd:attribute name="size"             type="xsd:long"/>
282       <xsd:attribute name="bit_rate"         type="xsd:long"/>
283       <xsd:attribute name="probe_score"      type="xsd:int"/>
284     </xsd:complexType>
285
286     <xsd:complexType name="tagType">
287       <xsd:attribute name="key"   type="xsd:string" use="required"/>
288       <xsd:attribute name="value" type="xsd:string" use="required"/>
289     </xsd:complexType>
290
291     <xsd:complexType name="errorType">
292       <xsd:attribute name="code"   type="xsd:int"    use="required"/>
293       <xsd:attribute name="string" type="xsd:string" use="required"/>
294     </xsd:complexType>
295
296     <xsd:complexType name="programVersionType">
297       <xsd:attribute name="version"          type="xsd:string" use="required"/>
298       <xsd:attribute name="copyright"        type="xsd:string" use="required"/>
299       <xsd:attribute name="build_date"       type="xsd:string"/>
300       <xsd:attribute name="build_time"       type="xsd:string"/>
301       <xsd:attribute name="compiler_ident"   type="xsd:string" use="required"/>
302       <xsd:attribute name="configuration"    type="xsd:string" use="required"/>
303     </xsd:complexType>
304
305     <xsd:complexType name="chaptersType">
306       <xsd:sequence>
307         <xsd:element name="chapter" type="ffprobe:chapterType" minOccurs="0" maxOccurs="unbounded"/>
308       </xsd:sequence>
309     </xsd:complexType>
310
311     <xsd:complexType name="chapterType">
312       <xsd:sequence>
313         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
314       </xsd:sequence>
315
316       <xsd:attribute name="id"         type="xsd:int" use="required"/>
317       <xsd:attribute name="time_base"  type="xsd:string" use="required"/>
318       <xsd:attribute name="start"      type="xsd:int" use="required"/>
319       <xsd:attribute name="start_time" type="xsd:float"/>
320       <xsd:attribute name="end"        type="xsd:int" use="required"/>
321       <xsd:attribute name="end_time"   type="xsd:float" use="required"/>
322     </xsd:complexType>
323
324     <xsd:complexType name="libraryVersionType">
325       <xsd:attribute name="name"        type="xsd:string" use="required"/>
326       <xsd:attribute name="major"       type="xsd:int"    use="required"/>
327       <xsd:attribute name="minor"       type="xsd:int"    use="required"/>
328       <xsd:attribute name="micro"       type="xsd:int"    use="required"/>
329       <xsd:attribute name="version"     type="xsd:int"    use="required"/>
330       <xsd:attribute name="ident"       type="xsd:string" use="required"/>
331     </xsd:complexType>
332
333     <xsd:complexType name="libraryVersionsType">
334         <xsd:sequence>
335           <xsd:element name="library_version" type="ffprobe:libraryVersionType" minOccurs="0" maxOccurs="unbounded"/>
336         </xsd:sequence>
337     </xsd:complexType>
338
339     <xsd:complexType name="pixelFormatFlagsType">
340       <xsd:attribute name="big_endian" type="xsd:int" use="required"/>
341       <xsd:attribute name="palette"    type="xsd:int" use="required"/>
342       <xsd:attribute name="bitstream"  type="xsd:int" use="required"/>
343       <xsd:attribute name="hwaccel"    type="xsd:int" use="required"/>
344       <xsd:attribute name="planar"     type="xsd:int" use="required"/>
345       <xsd:attribute name="rgb"        type="xsd:int" use="required"/>
346       <xsd:attribute name="pseudopal"  type="xsd:int" use="required"/>
347       <xsd:attribute name="alpha"      type="xsd:int" use="required"/>
348     </xsd:complexType>
349
350     <xsd:complexType name="pixelFormatComponentType">
351       <xsd:attribute name="index"      type="xsd:int" use="required"/>
352       <xsd:attribute name="bit_depth"  type="xsd:int" use="required"/>
353     </xsd:complexType>
354
355     <xsd:complexType name="pixelFormatComponentsType">
356       <xsd:sequence>
357         <xsd:element name="component" type="ffprobe:pixelFormatComponentType" minOccurs="0" maxOccurs="unbounded"/>
358       </xsd:sequence>
359     </xsd:complexType>
360
361     <xsd:complexType name="pixelFormatType">
362       <xsd:sequence>
363         <xsd:element name="flags" type="ffprobe:pixelFormatFlagsType" minOccurs="0" maxOccurs="1"/>
364         <xsd:element name="components" type="ffprobe:pixelFormatComponentsType" minOccurs="0" maxOccurs="1"/>
365       </xsd:sequence>
366
367       <xsd:attribute name="name"                type="xsd:string" use="required"/>
368       <xsd:attribute name="nb_components"       type="xsd:int"    use="required"/>
369       <xsd:attribute name="log2_chroma_w"       type="xsd:int"/>
370       <xsd:attribute name="log2_chroma_h"       type="xsd:int"/>
371       <xsd:attribute name="bits_per_pixel"      type="xsd:int"/>
372     </xsd:complexType>
373
374     <xsd:complexType name="pixelFormatsType">
375       <xsd:sequence>
376         <xsd:element name="pixel_format" type="ffprobe:pixelFormatType" minOccurs="0" maxOccurs="unbounded"/>
377       </xsd:sequence>
378     </xsd:complexType>
379 </xsd:schema>