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