ffprobe: add support for subtitle frames
[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="packets"  type="ffprobe:packetsType" minOccurs="0" maxOccurs="1" />
12             <xsd:element name="frames"   type="ffprobe:framesType"  minOccurs="0" maxOccurs="1" />
13             <xsd:element name="streams"  type="ffprobe:streamsType" minOccurs="0" maxOccurs="1" />
14             <xsd:element name="programs" type="ffprobe:programsType" minOccurs="0" maxOccurs="1" />
15             <xsd:element name="chapters" type="ffprobe:chaptersType" minOccurs="0" maxOccurs="1" />
16             <xsd:element name="format"   type="ffprobe:formatType"  minOccurs="0" maxOccurs="1" />
17             <xsd:element name="error"    type="ffprobe:errorType"   minOccurs="0" maxOccurs="1" />
18             <xsd:element name="program_version"  type="ffprobe:programVersionType"  minOccurs="0" maxOccurs="1" />
19             <xsd:element name="library_versions" type="ffprobe:libraryVersionsType" minOccurs="0" maxOccurs="1" />
20         </xsd:sequence>
21     </xsd:complexType>
22
23     <xsd:complexType name="packetsType">
24         <xsd:sequence>
25             <xsd:element name="packet" type="ffprobe:packetType" minOccurs="0" maxOccurs="unbounded"/>
26         </xsd:sequence>
27     </xsd:complexType>
28
29     <xsd:complexType name="framesType">
30         <xsd:sequence>
31             <xsd:choice minOccurs="0" maxOccurs="unbounded">
32                 <xsd:element name="frame" type="ffprobe:frameType" minOccurs="0" maxOccurs="unbounded"/>
33                 <xsd:element name="subtitle" type="ffprobe:subtitleType" minOccurs="0" maxOccurs="unbounded"/>
34             </xsd:choice>
35         </xsd:sequence>
36     </xsd:complexType>
37
38     <xsd:complexType name="packetType">
39       <xsd:attribute name="codec_type"    type="xsd:string" use="required" />
40       <xsd:attribute name="stream_index"  type="xsd:int" use="required" />
41       <xsd:attribute name="pts"           type="xsd:long"  />
42       <xsd:attribute name="pts_time"      type="xsd:float" />
43       <xsd:attribute name="dts"           type="xsd:long"  />
44       <xsd:attribute name="dts_time"      type="xsd:float" />
45       <xsd:attribute name="duration"      type="xsd:long"  />
46       <xsd:attribute name="duration_time" type="xsd:float" />
47       <xsd:attribute name="convergence_duration"      type="xsd:long"  />
48       <xsd:attribute name="convergence_duration_time" type="xsd:float" />
49       <xsd:attribute name="size"          type="xsd:long" use="required" />
50       <xsd:attribute name="pos"           type="xsd:long"  />
51       <xsd:attribute name="flags"         type="xsd:string" use="required" />
52       <xsd:attribute name="data"          type="xsd:string" />
53     </xsd:complexType>
54
55     <xsd:complexType name="frameType">
56       <xsd:attribute name="media_type"    type="xsd:string" use="required"/>
57       <xsd:attribute name="key_frame"     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="pkt_pts"       type="xsd:long" />
61       <xsd:attribute name="pkt_pts_time"  type="xsd:float"/>
62       <xsd:attribute name="pkt_dts"       type="xsd:long" />
63       <xsd:attribute name="pkt_dts_time"  type="xsd:float"/>
64       <xsd:attribute name="pkt_duration"  type="xsd:long" />
65       <xsd:attribute name="pkt_duration_time" type="xsd:float"/>
66       <xsd:attribute name="pkt_pos"       type="xsd:long" />
67       <xsd:attribute name="pkt_size"      type="xsd:int" />
68
69       <!-- audio attributes -->
70       <xsd:attribute name="sample_fmt"             type="xsd:string"/>
71       <xsd:attribute name="nb_samples"             type="xsd:long"  />
72       <xsd:attribute name="channels"               type="xsd:int"   />
73       <xsd:attribute name="channel_layout"         type="xsd:string"/>
74
75       <!-- video attributes -->
76       <xsd:attribute name="width"                  type="xsd:long"  />
77       <xsd:attribute name="height"                 type="xsd:long"  />
78       <xsd:attribute name="pix_fmt"                type="xsd:string"/>
79       <xsd:attribute name="sample_aspect_ratio"    type="xsd:string"/>
80       <xsd:attribute name="pict_type"              type="xsd:string"/>
81       <xsd:attribute name="coded_picture_number"   type="xsd:long"  />
82       <xsd:attribute name="display_picture_number" type="xsd:long"  />
83       <xsd:attribute name="interlaced_frame"       type="xsd:int"   />
84       <xsd:attribute name="top_field_first"        type="xsd:int"   />
85       <xsd:attribute name="repeat_pict"            type="xsd:int"   />
86     </xsd:complexType>
87
88     <xsd:complexType name="subtitleType">
89       <xsd:attribute name="media_type"         type="xsd:string" fixed="subtitle" use="required"/>
90       <xsd:attribute name="pts"                type="xsd:long" />
91       <xsd:attribute name="pts_time"           type="xsd:float"/>
92       <xsd:attribute name="format"             type="xsd:int"  />
93       <xsd:attribute name="start_display_time" type="xsd:int"  />
94       <xsd:attribute name="end_display_time"   type="xsd:int"  />
95       <xsd:attribute name="num_rects"          type="xsd:int"  />
96     </xsd:complexType>
97
98     <xsd:complexType name="streamsType">
99         <xsd:sequence>
100             <xsd:element name="stream" type="ffprobe:streamType" minOccurs="0" maxOccurs="unbounded"/>
101         </xsd:sequence>
102     </xsd:complexType>
103
104     <xsd:complexType name="programsType">
105         <xsd:sequence>
106             <xsd:element name="program" type="ffprobe:programType" minOccurs="0" maxOccurs="unbounded"/>
107         </xsd:sequence>
108     </xsd:complexType>
109
110     <xsd:complexType name="streamDispositionType">
111       <xsd:attribute name="default"          type="xsd:int" use="required" />
112       <xsd:attribute name="dub"              type="xsd:int" use="required" />
113       <xsd:attribute name="original"         type="xsd:int" use="required" />
114       <xsd:attribute name="comment"          type="xsd:int" use="required" />
115       <xsd:attribute name="lyrics"           type="xsd:int" use="required" />
116       <xsd:attribute name="karaoke"          type="xsd:int" use="required" />
117       <xsd:attribute name="forced"           type="xsd:int" use="required" />
118       <xsd:attribute name="hearing_impaired" type="xsd:int" use="required" />
119       <xsd:attribute name="visual_impaired"  type="xsd:int" use="required" />
120       <xsd:attribute name="clean_effects"    type="xsd:int" use="required" />
121       <xsd:attribute name="attached_pic"     type="xsd:int" use="required" />
122     </xsd:complexType>
123
124     <xsd:complexType name="streamType">
125       <xsd:sequence>
126         <xsd:element name="disposition" type="ffprobe:streamDispositionType" minOccurs="0" maxOccurs="1"/>
127         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
128       </xsd:sequence>
129
130       <xsd:attribute name="index"            type="xsd:int" use="required"/>
131       <xsd:attribute name="codec_name"       type="xsd:string" />
132       <xsd:attribute name="codec_long_name"  type="xsd:string" />
133       <xsd:attribute name="profile"          type="xsd:string" />
134       <xsd:attribute name="codec_type"       type="xsd:string" />
135       <xsd:attribute name="codec_time_base"  type="xsd:string" use="required"/>
136       <xsd:attribute name="codec_tag"        type="xsd:string" use="required"/>
137       <xsd:attribute name="codec_tag_string" type="xsd:string" use="required"/>
138       <xsd:attribute name="extradata"        type="xsd:string" />
139
140       <!-- video attributes -->
141       <xsd:attribute name="width"                type="xsd:int"/>
142       <xsd:attribute name="height"               type="xsd:int"/>
143       <xsd:attribute name="has_b_frames"         type="xsd:int"/>
144       <xsd:attribute name="sample_aspect_ratio"  type="xsd:string"/>
145       <xsd:attribute name="display_aspect_ratio" type="xsd:string"/>
146       <xsd:attribute name="pix_fmt"              type="xsd:string"/>
147       <xsd:attribute name="level"                type="xsd:int"/>
148       <xsd:attribute name="timecode"             type="xsd:string"/>
149
150       <!-- audio attributes -->
151       <xsd:attribute name="sample_fmt"       type="xsd:string"/>
152       <xsd:attribute name="sample_rate"      type="xsd:int"/>
153       <xsd:attribute name="channels"         type="xsd:int"/>
154       <xsd:attribute name="channel_layout"   type="xsd:string"/>
155       <xsd:attribute name="bits_per_sample"  type="xsd:int"/>
156
157       <xsd:attribute name="id"               type="xsd:string"/>
158       <xsd:attribute name="r_frame_rate"     type="xsd:string" use="required"/>
159       <xsd:attribute name="avg_frame_rate"   type="xsd:string" use="required"/>
160       <xsd:attribute name="time_base"        type="xsd:string" use="required"/>
161       <xsd:attribute name="start_pts"        type="xsd:long"/>
162       <xsd:attribute name="start_time"       type="xsd:float"/>
163       <xsd:attribute name="duration_ts"      type="xsd:long"/>
164       <xsd:attribute name="duration"         type="xsd:float"/>
165       <xsd:attribute name="bit_rate"         type="xsd:int"/>
166       <xsd:attribute name="nb_frames"        type="xsd:int"/>
167       <xsd:attribute name="nb_read_frames"   type="xsd:int"/>
168       <xsd:attribute name="nb_read_packets"  type="xsd:int"/>
169     </xsd:complexType>
170
171     <xsd:complexType name="programType">
172       <xsd:sequence>
173         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
174         <xsd:element name="streams" type="ffprobe:streamsType" minOccurs="0" maxOccurs="1"/>
175       </xsd:sequence>
176
177       <xsd:attribute name="program_id"           type="xsd:int"    use="required"/>
178       <xsd:attribute name="program_num"          type="xsd:int"    use="required"/>
179       <xsd:attribute name="nb_streams"           type="xsd:int"    use="required"/>
180       <xsd:attribute name="start_time"           type="xsd:float"/>
181       <xsd:attribute name="start_pts"            type="xsd:long"/>
182       <xsd:attribute name="end_time"             type="xsd:float"/>
183       <xsd:attribute name="end_pts"              type="xsd:long"/>
184       <xsd:attribute name="pmt_pid"              type="xsd:int"    use="required"/>
185       <xsd:attribute name="pcr_pid"              type="xsd:int"    use="required"/>
186     </xsd:complexType>
187
188     <xsd:complexType name="formatType">
189       <xsd:sequence>
190         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
191       </xsd:sequence>
192
193       <xsd:attribute name="filename"         type="xsd:string" use="required"/>
194       <xsd:attribute name="nb_streams"       type="xsd:int"    use="required"/>
195       <xsd:attribute name="nb_programs"      type="xsd:int"    use="required"/>
196       <xsd:attribute name="format_name"      type="xsd:string" use="required"/>
197       <xsd:attribute name="format_long_name" type="xsd:string"/>
198       <xsd:attribute name="start_time"       type="xsd:float"/>
199       <xsd:attribute name="duration"         type="xsd:float"/>
200       <xsd:attribute name="size"             type="xsd:long"/>
201       <xsd:attribute name="bit_rate"         type="xsd:long"/>
202       <xsd:attribute name="probe_score"      type="xsd:int"/>
203     </xsd:complexType>
204
205     <xsd:complexType name="tagType">
206       <xsd:attribute name="key"   type="xsd:string" use="required"/>
207       <xsd:attribute name="value" type="xsd:string" use="required"/>
208     </xsd:complexType>
209
210     <xsd:complexType name="errorType">
211       <xsd:attribute name="code"   type="xsd:int"    use="required"/>
212       <xsd:attribute name="string" type="xsd:string" use="required"/>
213     </xsd:complexType>
214
215     <xsd:complexType name="programVersionType">
216       <xsd:attribute name="version"          type="xsd:string" use="required"/>
217       <xsd:attribute name="copyright"        type="xsd:string" use="required"/>
218       <xsd:attribute name="build_date"       type="xsd:string" use="required"/>
219       <xsd:attribute name="build_time"       type="xsd:string" use="required"/>
220       <xsd:attribute name="compiler_type"    type="xsd:string" use="required"/>
221       <xsd:attribute name="compiler_version" type="xsd:string" use="required"/>
222       <xsd:attribute name="configuration"    type="xsd:string" use="required"/>
223     </xsd:complexType>
224
225     <xsd:complexType name="chaptersType">
226       <xsd:sequence>
227         <xsd:element name="chapter" type="ffprobe:chapterType" minOccurs="0" maxOccurs="unbounded"/>
228       </xsd:sequence>
229     </xsd:complexType>
230
231     <xsd:complexType name="chapterType">
232       <xsd:sequence>
233         <xsd:element name="tag" type="ffprobe:tagType" minOccurs="0" maxOccurs="unbounded"/>
234       </xsd:sequence>
235
236       <xsd:attribute name="id"         type="xsd:int" use="required"/>
237       <xsd:attribute name="time_base"  type="xsd:string" use="required"/>
238       <xsd:attribute name="start"      type="xsd:int" use="required"/>
239       <xsd:attribute name="start_time" type="xsd:float"/>
240       <xsd:attribute name="end"        type="xsd:int" use="required"/>
241       <xsd:attribute name="end_time"   type="xsd:float" use="required"/>
242     </xsd:complexType>
243
244     <xsd:complexType name="libraryVersionType">
245       <xsd:attribute name="name"        type="xsd:string" use="required"/>
246       <xsd:attribute name="major"       type="xsd:int"    use="required"/>
247       <xsd:attribute name="minor"       type="xsd:int"    use="required"/>
248       <xsd:attribute name="micro"       type="xsd:int"    use="required"/>
249       <xsd:attribute name="version"     type="xsd:int"    use="required"/>
250       <xsd:attribute name="ident"       type="xsd:string" use="required"/>
251     </xsd:complexType>
252
253     <xsd:complexType name="libraryVersionsType">
254         <xsd:sequence>
255           <xsd:element name="library_version" type="ffprobe:libraryVersionType" minOccurs="0" maxOccurs="unbounded"/>
256         </xsd:sequence>
257     </xsd:complexType>
258 </xsd:schema>