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