arcanus commited on
Commit
a2e264f
·
1 Parent(s): 5fdb03d

First model version

Browse files
ffmpeg/LICENSE DELETED
@@ -1,674 +0,0 @@
1
- GNU GENERAL PUBLIC LICENSE
2
- Version 3, 29 June 2007
3
-
4
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
- Everyone is permitted to copy and distribute verbatim copies
6
- of this license document, but changing it is not allowed.
7
-
8
- Preamble
9
-
10
- The GNU General Public License is a free, copyleft license for
11
- software and other kinds of works.
12
-
13
- The licenses for most software and other practical works are designed
14
- to take away your freedom to share and change the works. By contrast,
15
- the GNU General Public License is intended to guarantee your freedom to
16
- share and change all versions of a program--to make sure it remains free
17
- software for all its users. We, the Free Software Foundation, use the
18
- GNU General Public License for most of our software; it applies also to
19
- any other work released this way by its authors. You can apply it to
20
- your programs, too.
21
-
22
- When we speak of free software, we are referring to freedom, not
23
- price. Our General Public Licenses are designed to make sure that you
24
- have the freedom to distribute copies of free software (and charge for
25
- them if you wish), that you receive source code or can get it if you
26
- want it, that you can change the software or use pieces of it in new
27
- free programs, and that you know you can do these things.
28
-
29
- To protect your rights, we need to prevent others from denying you
30
- these rights or asking you to surrender the rights. Therefore, you have
31
- certain responsibilities if you distribute copies of the software, or if
32
- you modify it: responsibilities to respect the freedom of others.
33
-
34
- For example, if you distribute copies of such a program, whether
35
- gratis or for a fee, you must pass on to the recipients the same
36
- freedoms that you received. You must make sure that they, too, receive
37
- or can get the source code. And you must show them these terms so they
38
- know their rights.
39
-
40
- Developers that use the GNU GPL protect your rights with two steps:
41
- (1) assert copyright on the software, and (2) offer you this License
42
- giving you legal permission to copy, distribute and/or modify it.
43
-
44
- For the developers' and authors' protection, the GPL clearly explains
45
- that there is no warranty for this free software. For both users' and
46
- authors' sake, the GPL requires that modified versions be marked as
47
- changed, so that their problems will not be attributed erroneously to
48
- authors of previous versions.
49
-
50
- Some devices are designed to deny users access to install or run
51
- modified versions of the software inside them, although the manufacturer
52
- can do so. This is fundamentally incompatible with the aim of
53
- protecting users' freedom to change the software. The systematic
54
- pattern of such abuse occurs in the area of products for individuals to
55
- use, which is precisely where it is most unacceptable. Therefore, we
56
- have designed this version of the GPL to prohibit the practice for those
57
- products. If such problems arise substantially in other domains, we
58
- stand ready to extend this provision to those domains in future versions
59
- of the GPL, as needed to protect the freedom of users.
60
-
61
- Finally, every program is threatened constantly by software patents.
62
- States should not allow patents to restrict development and use of
63
- software on general-purpose computers, but in those that do, we wish to
64
- avoid the special danger that patents applied to a free program could
65
- make it effectively proprietary. To prevent this, the GPL assures that
66
- patents cannot be used to render the program non-free.
67
-
68
- The precise terms and conditions for copying, distribution and
69
- modification follow.
70
-
71
- TERMS AND CONDITIONS
72
-
73
- 0. Definitions.
74
-
75
- "This License" refers to version 3 of the GNU General Public License.
76
-
77
- "Copyright" also means copyright-like laws that apply to other kinds of
78
- works, such as semiconductor masks.
79
-
80
- "The Program" refers to any copyrightable work licensed under this
81
- License. Each licensee is addressed as "you". "Licensees" and
82
- "recipients" may be individuals or organizations.
83
-
84
- To "modify" a work means to copy from or adapt all or part of the work
85
- in a fashion requiring copyright permission, other than the making of an
86
- exact copy. The resulting work is called a "modified version" of the
87
- earlier work or a work "based on" the earlier work.
88
-
89
- A "covered work" means either the unmodified Program or a work based
90
- on the Program.
91
-
92
- To "propagate" a work means to do anything with it that, without
93
- permission, would make you directly or secondarily liable for
94
- infringement under applicable copyright law, except executing it on a
95
- computer or modifying a private copy. Propagation includes copying,
96
- distribution (with or without modification), making available to the
97
- public, and in some countries other activities as well.
98
-
99
- To "convey" a work means any kind of propagation that enables other
100
- parties to make or receive copies. Mere interaction with a user through
101
- a computer network, with no transfer of a copy, is not conveying.
102
-
103
- An interactive user interface displays "Appropriate Legal Notices"
104
- to the extent that it includes a convenient and prominently visible
105
- feature that (1) displays an appropriate copyright notice, and (2)
106
- tells the user that there is no warranty for the work (except to the
107
- extent that warranties are provided), that licensees may convey the
108
- work under this License, and how to view a copy of this License. If
109
- the interface presents a list of user commands or options, such as a
110
- menu, a prominent item in the list meets this criterion.
111
-
112
- 1. Source Code.
113
-
114
- The "source code" for a work means the preferred form of the work
115
- for making modifications to it. "Object code" means any non-source
116
- form of a work.
117
-
118
- A "Standard Interface" means an interface that either is an official
119
- standard defined by a recognized standards body, or, in the case of
120
- interfaces specified for a particular programming language, one that
121
- is widely used among developers working in that language.
122
-
123
- The "System Libraries" of an executable work include anything, other
124
- than the work as a whole, that (a) is included in the normal form of
125
- packaging a Major Component, but which is not part of that Major
126
- Component, and (b) serves only to enable use of the work with that
127
- Major Component, or to implement a Standard Interface for which an
128
- implementation is available to the public in source code form. A
129
- "Major Component", in this context, means a major essential component
130
- (kernel, window system, and so on) of the specific operating system
131
- (if any) on which the executable work runs, or a compiler used to
132
- produce the work, or an object code interpreter used to run it.
133
-
134
- The "Corresponding Source" for a work in object code form means all
135
- the source code needed to generate, install, and (for an executable
136
- work) run the object code and to modify the work, including scripts to
137
- control those activities. However, it does not include the work's
138
- System Libraries, or general-purpose tools or generally available free
139
- programs which are used unmodified in performing those activities but
140
- which are not part of the work. For example, Corresponding Source
141
- includes interface definition files associated with source files for
142
- the work, and the source code for shared libraries and dynamically
143
- linked subprograms that the work is specifically designed to require,
144
- such as by intimate data communication or control flow between those
145
- subprograms and other parts of the work.
146
-
147
- The Corresponding Source need not include anything that users
148
- can regenerate automatically from other parts of the Corresponding
149
- Source.
150
-
151
- The Corresponding Source for a work in source code form is that
152
- same work.
153
-
154
- 2. Basic Permissions.
155
-
156
- All rights granted under this License are granted for the term of
157
- copyright on the Program, and are irrevocable provided the stated
158
- conditions are met. This License explicitly affirms your unlimited
159
- permission to run the unmodified Program. The output from running a
160
- covered work is covered by this License only if the output, given its
161
- content, constitutes a covered work. This License acknowledges your
162
- rights of fair use or other equivalent, as provided by copyright law.
163
-
164
- You may make, run and propagate covered works that you do not
165
- convey, without conditions so long as your license otherwise remains
166
- in force. You may convey covered works to others for the sole purpose
167
- of having them make modifications exclusively for you, or provide you
168
- with facilities for running those works, provided that you comply with
169
- the terms of this License in conveying all material for which you do
170
- not control copyright. Those thus making or running the covered works
171
- for you must do so exclusively on your behalf, under your direction
172
- and control, on terms that prohibit them from making any copies of
173
- your copyrighted material outside their relationship with you.
174
-
175
- Conveying under any other circumstances is permitted solely under
176
- the conditions stated below. Sublicensing is not allowed; section 10
177
- makes it unnecessary.
178
-
179
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
-
181
- No covered work shall be deemed part of an effective technological
182
- measure under any applicable law fulfilling obligations under article
183
- 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
- similar laws prohibiting or restricting circumvention of such
185
- measures.
186
-
187
- When you convey a covered work, you waive any legal power to forbid
188
- circumvention of technological measures to the extent such circumvention
189
- is effected by exercising rights under this License with respect to
190
- the covered work, and you disclaim any intention to limit operation or
191
- modification of the work as a means of enforcing, against the work's
192
- users, your or third parties' legal rights to forbid circumvention of
193
- technological measures.
194
-
195
- 4. Conveying Verbatim Copies.
196
-
197
- You may convey verbatim copies of the Program's source code as you
198
- receive it, in any medium, provided that you conspicuously and
199
- appropriately publish on each copy an appropriate copyright notice;
200
- keep intact all notices stating that this License and any
201
- non-permissive terms added in accord with section 7 apply to the code;
202
- keep intact all notices of the absence of any warranty; and give all
203
- recipients a copy of this License along with the Program.
204
-
205
- You may charge any price or no price for each copy that you convey,
206
- and you may offer support or warranty protection for a fee.
207
-
208
- 5. Conveying Modified Source Versions.
209
-
210
- You may convey a work based on the Program, or the modifications to
211
- produce it from the Program, in the form of source code under the
212
- terms of section 4, provided that you also meet all of these conditions:
213
-
214
- a) The work must carry prominent notices stating that you modified
215
- it, and giving a relevant date.
216
-
217
- b) The work must carry prominent notices stating that it is
218
- released under this License and any conditions added under section
219
- 7. This requirement modifies the requirement in section 4 to
220
- "keep intact all notices".
221
-
222
- c) You must license the entire work, as a whole, under this
223
- License to anyone who comes into possession of a copy. This
224
- License will therefore apply, along with any applicable section 7
225
- additional terms, to the whole of the work, and all its parts,
226
- regardless of how they are packaged. This License gives no
227
- permission to license the work in any other way, but it does not
228
- invalidate such permission if you have separately received it.
229
-
230
- d) If the work has interactive user interfaces, each must display
231
- Appropriate Legal Notices; however, if the Program has interactive
232
- interfaces that do not display Appropriate Legal Notices, your
233
- work need not make them do so.
234
-
235
- A compilation of a covered work with other separate and independent
236
- works, which are not by their nature extensions of the covered work,
237
- and which are not combined with it such as to form a larger program,
238
- in or on a volume of a storage or distribution medium, is called an
239
- "aggregate" if the compilation and its resulting copyright are not
240
- used to limit the access or legal rights of the compilation's users
241
- beyond what the individual works permit. Inclusion of a covered work
242
- in an aggregate does not cause this License to apply to the other
243
- parts of the aggregate.
244
-
245
- 6. Conveying Non-Source Forms.
246
-
247
- You may convey a covered work in object code form under the terms
248
- of sections 4 and 5, provided that you also convey the
249
- machine-readable Corresponding Source under the terms of this License,
250
- in one of these ways:
251
-
252
- a) Convey the object code in, or embodied in, a physical product
253
- (including a physical distribution medium), accompanied by the
254
- Corresponding Source fixed on a durable physical medium
255
- customarily used for software interchange.
256
-
257
- b) Convey the object code in, or embodied in, a physical product
258
- (including a physical distribution medium), accompanied by a
259
- written offer, valid for at least three years and valid for as
260
- long as you offer spare parts or customer support for that product
261
- model, to give anyone who possesses the object code either (1) a
262
- copy of the Corresponding Source for all the software in the
263
- product that is covered by this License, on a durable physical
264
- medium customarily used for software interchange, for a price no
265
- more than your reasonable cost of physically performing this
266
- conveying of source, or (2) access to copy the
267
- Corresponding Source from a network server at no charge.
268
-
269
- c) Convey individual copies of the object code with a copy of the
270
- written offer to provide the Corresponding Source. This
271
- alternative is allowed only occasionally and noncommercially, and
272
- only if you received the object code with such an offer, in accord
273
- with subsection 6b.
274
-
275
- d) Convey the object code by offering access from a designated
276
- place (gratis or for a charge), and offer equivalent access to the
277
- Corresponding Source in the same way through the same place at no
278
- further charge. You need not require recipients to copy the
279
- Corresponding Source along with the object code. If the place to
280
- copy the object code is a network server, the Corresponding Source
281
- may be on a different server (operated by you or a third party)
282
- that supports equivalent copying facilities, provided you maintain
283
- clear directions next to the object code saying where to find the
284
- Corresponding Source. Regardless of what server hosts the
285
- Corresponding Source, you remain obligated to ensure that it is
286
- available for as long as needed to satisfy these requirements.
287
-
288
- e) Convey the object code using peer-to-peer transmission, provided
289
- you inform other peers where the object code and Corresponding
290
- Source of the work are being offered to the general public at no
291
- charge under subsection 6d.
292
-
293
- A separable portion of the object code, whose source code is excluded
294
- from the Corresponding Source as a System Library, need not be
295
- included in conveying the object code work.
296
-
297
- A "User Product" is either (1) a "consumer product", which means any
298
- tangible personal property which is normally used for personal, family,
299
- or household purposes, or (2) anything designed or sold for incorporation
300
- into a dwelling. In determining whether a product is a consumer product,
301
- doubtful cases shall be resolved in favor of coverage. For a particular
302
- product received by a particular user, "normally used" refers to a
303
- typical or common use of that class of product, regardless of the status
304
- of the particular user or of the way in which the particular user
305
- actually uses, or expects or is expected to use, the product. A product
306
- is a consumer product regardless of whether the product has substantial
307
- commercial, industrial or non-consumer uses, unless such uses represent
308
- the only significant mode of use of the product.
309
-
310
- "Installation Information" for a User Product means any methods,
311
- procedures, authorization keys, or other information required to install
312
- and execute modified versions of a covered work in that User Product from
313
- a modified version of its Corresponding Source. The information must
314
- suffice to ensure that the continued functioning of the modified object
315
- code is in no case prevented or interfered with solely because
316
- modification has been made.
317
-
318
- If you convey an object code work under this section in, or with, or
319
- specifically for use in, a User Product, and the conveying occurs as
320
- part of a transaction in which the right of possession and use of the
321
- User Product is transferred to the recipient in perpetuity or for a
322
- fixed term (regardless of how the transaction is characterized), the
323
- Corresponding Source conveyed under this section must be accompanied
324
- by the Installation Information. But this requirement does not apply
325
- if neither you nor any third party retains the ability to install
326
- modified object code on the User Product (for example, the work has
327
- been installed in ROM).
328
-
329
- The requirement to provide Installation Information does not include a
330
- requirement to continue to provide support service, warranty, or updates
331
- for a work that has been modified or installed by the recipient, or for
332
- the User Product in which it has been modified or installed. Access to a
333
- network may be denied when the modification itself materially and
334
- adversely affects the operation of the network or violates the rules and
335
- protocols for communication across the network.
336
-
337
- Corresponding Source conveyed, and Installation Information provided,
338
- in accord with this section must be in a format that is publicly
339
- documented (and with an implementation available to the public in
340
- source code form), and must require no special password or key for
341
- unpacking, reading or copying.
342
-
343
- 7. Additional Terms.
344
-
345
- "Additional permissions" are terms that supplement the terms of this
346
- License by making exceptions from one or more of its conditions.
347
- Additional permissions that are applicable to the entire Program shall
348
- be treated as though they were included in this License, to the extent
349
- that they are valid under applicable law. If additional permissions
350
- apply only to part of the Program, that part may be used separately
351
- under those permissions, but the entire Program remains governed by
352
- this License without regard to the additional permissions.
353
-
354
- When you convey a copy of a covered work, you may at your option
355
- remove any additional permissions from that copy, or from any part of
356
- it. (Additional permissions may be written to require their own
357
- removal in certain cases when you modify the work.) You may place
358
- additional permissions on material, added by you to a covered work,
359
- for which you have or can give appropriate copyright permission.
360
-
361
- Notwithstanding any other provision of this License, for material you
362
- add to a covered work, you may (if authorized by the copyright holders of
363
- that material) supplement the terms of this License with terms:
364
-
365
- a) Disclaiming warranty or limiting liability differently from the
366
- terms of sections 15 and 16 of this License; or
367
-
368
- b) Requiring preservation of specified reasonable legal notices or
369
- author attributions in that material or in the Appropriate Legal
370
- Notices displayed by works containing it; or
371
-
372
- c) Prohibiting misrepresentation of the origin of that material, or
373
- requiring that modified versions of such material be marked in
374
- reasonable ways as different from the original version; or
375
-
376
- d) Limiting the use for publicity purposes of names of licensors or
377
- authors of the material; or
378
-
379
- e) Declining to grant rights under trademark law for use of some
380
- trade names, trademarks, or service marks; or
381
-
382
- f) Requiring indemnification of licensors and authors of that
383
- material by anyone who conveys the material (or modified versions of
384
- it) with contractual assumptions of liability to the recipient, for
385
- any liability that these contractual assumptions directly impose on
386
- those licensors and authors.
387
-
388
- All other non-permissive additional terms are considered "further
389
- restrictions" within the meaning of section 10. If the Program as you
390
- received it, or any part of it, contains a notice stating that it is
391
- governed by this License along with a term that is a further
392
- restriction, you may remove that term. If a license document contains
393
- a further restriction but permits relicensing or conveying under this
394
- License, you may add to a covered work material governed by the terms
395
- of that license document, provided that the further restriction does
396
- not survive such relicensing or conveying.
397
-
398
- If you add terms to a covered work in accord with this section, you
399
- must place, in the relevant source files, a statement of the
400
- additional terms that apply to those files, or a notice indicating
401
- where to find the applicable terms.
402
-
403
- Additional terms, permissive or non-permissive, may be stated in the
404
- form of a separately written license, or stated as exceptions;
405
- the above requirements apply either way.
406
-
407
- 8. Termination.
408
-
409
- You may not propagate or modify a covered work except as expressly
410
- provided under this License. Any attempt otherwise to propagate or
411
- modify it is void, and will automatically terminate your rights under
412
- this License (including any patent licenses granted under the third
413
- paragraph of section 11).
414
-
415
- However, if you cease all violation of this License, then your
416
- license from a particular copyright holder is reinstated (a)
417
- provisionally, unless and until the copyright holder explicitly and
418
- finally terminates your license, and (b) permanently, if the copyright
419
- holder fails to notify you of the violation by some reasonable means
420
- prior to 60 days after the cessation.
421
-
422
- Moreover, your license from a particular copyright holder is
423
- reinstated permanently if the copyright holder notifies you of the
424
- violation by some reasonable means, this is the first time you have
425
- received notice of violation of this License (for any work) from that
426
- copyright holder, and you cure the violation prior to 30 days after
427
- your receipt of the notice.
428
-
429
- Termination of your rights under this section does not terminate the
430
- licenses of parties who have received copies or rights from you under
431
- this License. If your rights have been terminated and not permanently
432
- reinstated, you do not qualify to receive new licenses for the same
433
- material under section 10.
434
-
435
- 9. Acceptance Not Required for Having Copies.
436
-
437
- You are not required to accept this License in order to receive or
438
- run a copy of the Program. Ancillary propagation of a covered work
439
- occurring solely as a consequence of using peer-to-peer transmission
440
- to receive a copy likewise does not require acceptance. However,
441
- nothing other than this License grants you permission to propagate or
442
- modify any covered work. These actions infringe copyright if you do
443
- not accept this License. Therefore, by modifying or propagating a
444
- covered work, you indicate your acceptance of this License to do so.
445
-
446
- 10. Automatic Licensing of Downstream Recipients.
447
-
448
- Each time you convey a covered work, the recipient automatically
449
- receives a license from the original licensors, to run, modify and
450
- propagate that work, subject to this License. You are not responsible
451
- for enforcing compliance by third parties with this License.
452
-
453
- An "entity transaction" is a transaction transferring control of an
454
- organization, or substantially all assets of one, or subdividing an
455
- organization, or merging organizations. If propagation of a covered
456
- work results from an entity transaction, each party to that
457
- transaction who receives a copy of the work also receives whatever
458
- licenses to the work the party's predecessor in interest had or could
459
- give under the previous paragraph, plus a right to possession of the
460
- Corresponding Source of the work from the predecessor in interest, if
461
- the predecessor has it or can get it with reasonable efforts.
462
-
463
- You may not impose any further restrictions on the exercise of the
464
- rights granted or affirmed under this License. For example, you may
465
- not impose a license fee, royalty, or other charge for exercise of
466
- rights granted under this License, and you may not initiate litigation
467
- (including a cross-claim or counterclaim in a lawsuit) alleging that
468
- any patent claim is infringed by making, using, selling, offering for
469
- sale, or importing the Program or any portion of it.
470
-
471
- 11. Patents.
472
-
473
- A "contributor" is a copyright holder who authorizes use under this
474
- License of the Program or a work on which the Program is based. The
475
- work thus licensed is called the contributor's "contributor version".
476
-
477
- A contributor's "essential patent claims" are all patent claims
478
- owned or controlled by the contributor, whether already acquired or
479
- hereafter acquired, that would be infringed by some manner, permitted
480
- by this License, of making, using, or selling its contributor version,
481
- but do not include claims that would be infringed only as a
482
- consequence of further modification of the contributor version. For
483
- purposes of this definition, "control" includes the right to grant
484
- patent sublicenses in a manner consistent with the requirements of
485
- this License.
486
-
487
- Each contributor grants you a non-exclusive, worldwide, royalty-free
488
- patent license under the contributor's essential patent claims, to
489
- make, use, sell, offer for sale, import and otherwise run, modify and
490
- propagate the contents of its contributor version.
491
-
492
- In the following three paragraphs, a "patent license" is any express
493
- agreement or commitment, however denominated, not to enforce a patent
494
- (such as an express permission to practice a patent or covenant not to
495
- sue for patent infringement). To "grant" such a patent license to a
496
- party means to make such an agreement or commitment not to enforce a
497
- patent against the party.
498
-
499
- If you convey a covered work, knowingly relying on a patent license,
500
- and the Corresponding Source of the work is not available for anyone
501
- to copy, free of charge and under the terms of this License, through a
502
- publicly available network server or other readily accessible means,
503
- then you must either (1) cause the Corresponding Source to be so
504
- available, or (2) arrange to deprive yourself of the benefit of the
505
- patent license for this particular work, or (3) arrange, in a manner
506
- consistent with the requirements of this License, to extend the patent
507
- license to downstream recipients. "Knowingly relying" means you have
508
- actual knowledge that, but for the patent license, your conveying the
509
- covered work in a country, or your recipient's use of the covered work
510
- in a country, would infringe one or more identifiable patents in that
511
- country that you have reason to believe are valid.
512
-
513
- If, pursuant to or in connection with a single transaction or
514
- arrangement, you convey, or propagate by procuring conveyance of, a
515
- covered work, and grant a patent license to some of the parties
516
- receiving the covered work authorizing them to use, propagate, modify
517
- or convey a specific copy of the covered work, then the patent license
518
- you grant is automatically extended to all recipients of the covered
519
- work and works based on it.
520
-
521
- A patent license is "discriminatory" if it does not include within
522
- the scope of its coverage, prohibits the exercise of, or is
523
- conditioned on the non-exercise of one or more of the rights that are
524
- specifically granted under this License. You may not convey a covered
525
- work if you are a party to an arrangement with a third party that is
526
- in the business of distributing software, under which you make payment
527
- to the third party based on the extent of your activity of conveying
528
- the work, and under which the third party grants, to any of the
529
- parties who would receive the covered work from you, a discriminatory
530
- patent license (a) in connection with copies of the covered work
531
- conveyed by you (or copies made from those copies), or (b) primarily
532
- for and in connection with specific products or compilations that
533
- contain the covered work, unless you entered into that arrangement,
534
- or that patent license was granted, prior to 28 March 2007.
535
-
536
- Nothing in this License shall be construed as excluding or limiting
537
- any implied license or other defenses to infringement that may
538
- otherwise be available to you under applicable patent law.
539
-
540
- 12. No Surrender of Others' Freedom.
541
-
542
- If conditions are imposed on you (whether by court order, agreement or
543
- otherwise) that contradict the conditions of this License, they do not
544
- excuse you from the conditions of this License. If you cannot convey a
545
- covered work so as to satisfy simultaneously your obligations under this
546
- License and any other pertinent obligations, then as a consequence you may
547
- not convey it at all. For example, if you agree to terms that obligate you
548
- to collect a royalty for further conveying from those to whom you convey
549
- the Program, the only way you could satisfy both those terms and this
550
- License would be to refrain entirely from conveying the Program.
551
-
552
- 13. Use with the GNU Affero General Public License.
553
-
554
- Notwithstanding any other provision of this License, you have
555
- permission to link or combine any covered work with a work licensed
556
- under version 3 of the GNU Affero General Public License into a single
557
- combined work, and to convey the resulting work. The terms of this
558
- License will continue to apply to the part which is the covered work,
559
- but the special requirements of the GNU Affero General Public License,
560
- section 13, concerning interaction through a network will apply to the
561
- combination as such.
562
-
563
- 14. Revised Versions of this License.
564
-
565
- The Free Software Foundation may publish revised and/or new versions of
566
- the GNU General Public License from time to time. Such new versions will
567
- be similar in spirit to the present version, but may differ in detail to
568
- address new problems or concerns.
569
-
570
- Each version is given a distinguishing version number. If the
571
- Program specifies that a certain numbered version of the GNU General
572
- Public License "or any later version" applies to it, you have the
573
- option of following the terms and conditions either of that numbered
574
- version or of any later version published by the Free Software
575
- Foundation. If the Program does not specify a version number of the
576
- GNU General Public License, you may choose any version ever published
577
- by the Free Software Foundation.
578
-
579
- If the Program specifies that a proxy can decide which future
580
- versions of the GNU General Public License can be used, that proxy's
581
- public statement of acceptance of a version permanently authorizes you
582
- to choose that version for the Program.
583
-
584
- Later license versions may give you additional or different
585
- permissions. However, no additional obligations are imposed on any
586
- author or copyright holder as a result of your choosing to follow a
587
- later version.
588
-
589
- 15. Disclaimer of Warranty.
590
-
591
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
- APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
- HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
- OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
- THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
- PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
- IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
- ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
-
600
- 16. Limitation of Liability.
601
-
602
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
- WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
- THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
- GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
- USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
- DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
- PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
- EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
- SUCH DAMAGES.
611
-
612
- 17. Interpretation of Sections 15 and 16.
613
-
614
- If the disclaimer of warranty and limitation of liability provided
615
- above cannot be given local legal effect according to their terms,
616
- reviewing courts shall apply local law that most closely approximates
617
- an absolute waiver of all civil liability in connection with the
618
- Program, unless a warranty or assumption of liability accompanies a
619
- copy of the Program in return for a fee.
620
-
621
- END OF TERMS AND CONDITIONS
622
-
623
- How to Apply These Terms to Your New Programs
624
-
625
- If you develop a new program, and you want it to be of the greatest
626
- possible use to the public, the best way to achieve this is to make it
627
- free software which everyone can redistribute and change under these terms.
628
-
629
- To do so, attach the following notices to the program. It is safest
630
- to attach them to the start of each source file to most effectively
631
- state the exclusion of warranty; and each file should have at least
632
- the "copyright" line and a pointer to where the full notice is found.
633
-
634
- <one line to give the program's name and a brief idea of what it does.>
635
- Copyright (C) <year> <name of author>
636
-
637
- This program is free software: you can redistribute it and/or modify
638
- it under the terms of the GNU General Public License as published by
639
- the Free Software Foundation, either version 3 of the License, or
640
- (at your option) any later version.
641
-
642
- This program is distributed in the hope that it will be useful,
643
- but WITHOUT ANY WARRANTY; without even the implied warranty of
644
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
- GNU General Public License for more details.
646
-
647
- You should have received a copy of the GNU General Public License
648
- along with this program. If not, see <http://www.gnu.org/licenses/>.
649
-
650
- Also add information on how to contact you by electronic and paper mail.
651
-
652
- If the program does terminal interaction, make it output a short
653
- notice like this when it starts in an interactive mode:
654
-
655
- <program> Copyright (C) <year> <name of author>
656
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
- This is free software, and you are welcome to redistribute it
658
- under certain conditions; type `show c' for details.
659
-
660
- The hypothetical commands `show w' and `show c' should show the appropriate
661
- parts of the General Public License. Of course, your program's commands
662
- might be different; for a GUI interface, you would use an "about box".
663
-
664
- You should also get your employer (if you work as a programmer) or school,
665
- if any, to sign a "copyright disclaimer" for the program, if necessary.
666
- For more information on this, and how to apply and follow the GNU GPL, see
667
- <http://www.gnu.org/licenses/>.
668
-
669
- The GNU General Public License does not permit incorporating your program
670
- into proprietary programs. If your program is a subroutine library, you
671
- may consider it more useful to permit linking proprietary applications with
672
- the library. If this is what you want to do, use the GNU Lesser General
673
- Public License instead of this License. But first, please read
674
- <http://www.gnu.org/philosophy/why-not-lgpl.html>.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/README.txt DELETED
@@ -1,885 +0,0 @@
1
- FFmpeg 64-bit static Windows build from www.gyan.dev
2
-
3
- Version: 2024-11-28-git-bc991ca048-full_build-www.gyan.dev
4
-
5
- License: GPL v3
6
-
7
- Source Code: https://github.com/FFmpeg/FFmpeg/commit/bc991ca048
8
-
9
- External Assets
10
- frei0r plugins: https://www.gyan.dev/ffmpeg/builds/ffmpeg-frei0r-plugins
11
- lensfun database: https://www.gyan.dev/ffmpeg/builds/ffmpeg-lensfun-db
12
-
13
- git-full build configuration:
14
-
15
- ARCH x86 (generic)
16
- big-endian no
17
- runtime cpu detection yes
18
- standalone assembly yes
19
- x86 assembler nasm
20
- MMX enabled yes
21
- MMXEXT enabled yes
22
- 3DNow! enabled yes
23
- 3DNow! extended enabled yes
24
- SSE enabled yes
25
- SSSE3 enabled yes
26
- AESNI enabled yes
27
- AVX enabled yes
28
- AVX2 enabled yes
29
- AVX-512 enabled yes
30
- AVX-512ICL enabled yes
31
- XOP enabled yes
32
- FMA3 enabled yes
33
- FMA4 enabled yes
34
- i686 features enabled yes
35
- CMOV is fast yes
36
- EBX available yes
37
- EBP available yes
38
- debug symbols yes
39
- strip symbols yes
40
- optimize for size no
41
- optimizations yes
42
- static yes
43
- shared no
44
- postprocessing support yes
45
- network support yes
46
- threading support pthreads
47
- safe bitstream reader yes
48
- texi2html enabled no
49
- perl enabled yes
50
- pod2man enabled yes
51
- makeinfo enabled yes
52
- makeinfo supports HTML yes
53
- xmllint enabled yes
54
-
55
- External libraries:
56
- avisynth libilbc libtheora
57
- bzlib libjxl libtwolame
58
- chromaprint liblc3 libuavs3d
59
- frei0r liblensfun libvidstab
60
- gmp libmodplug libvmaf
61
- gnutls libmp3lame libvo_amrwbenc
62
- iconv libmysofa libvorbis
63
- ladspa libopencore_amrnb libvpx
64
- libaom libopencore_amrwb libvvenc
65
- libaribb24 libopenjpeg libwebp
66
- libaribcaption libopenmpt libx264
67
- libass libopus libx265
68
- libbluray libplacebo libxavs2
69
- libbs2b libqrencode libxevd
70
- libcaca libquirc libxeve
71
- libcdio librav1e libxml2
72
- libcodec2 librist libxvid
73
- libdav1d librubberband libzimg
74
- libdavs2 libshaderc libzmq
75
- libflite libshine libzvbi
76
- libfontconfig libsnappy lzma
77
- libfreetype libsoxr mediafoundation
78
- libfribidi libspeex sdl2
79
- libgme libsrt zlib
80
- libgsm libssh
81
- libharfbuzz libsvtav1
82
-
83
- External libraries providing hardware acceleration:
84
- amf d3d12va nvdec
85
- cuda dxva2 nvenc
86
- cuda_llvm ffnvcodec opencl
87
- cuvid libmfx vaapi
88
- d3d11va libvpl vulkan
89
-
90
- Libraries:
91
- avcodec avformat swresample
92
- avdevice avutil swscale
93
- avfilter postproc
94
-
95
- Programs:
96
- ffmpeg ffplay ffprobe
97
-
98
- Enabled decoders:
99
- aac g723_1 pcx
100
- aac_fixed g729 pdv
101
- aac_latm gdv pfm
102
- aasc gem pgm
103
- ac3 gif pgmyuv
104
- ac3_fixed gremlin_dpcm pgssub
105
- acelp_kelvin gsm pgx
106
- adpcm_4xm gsm_ms phm
107
- adpcm_adx h261 photocd
108
- adpcm_afc h263 pictor
109
- adpcm_agm h263i pixlet
110
- adpcm_aica h263p pjs
111
- adpcm_argo h264 png
112
- adpcm_ct h264_cuvid ppm
113
- adpcm_dtk h264_qsv prores
114
- adpcm_ea hap prosumer
115
- adpcm_ea_maxis_xa hca psd
116
- adpcm_ea_r1 hcom ptx
117
- adpcm_ea_r2 hdr qcelp
118
- adpcm_ea_r3 hevc qdm2
119
- adpcm_ea_xas hevc_cuvid qdmc
120
- adpcm_g722 hevc_qsv qdraw
121
- adpcm_g726 hnm4_video qoa
122
- adpcm_g726le hq_hqa qoi
123
- adpcm_ima_acorn hqx qpeg
124
- adpcm_ima_alp huffyuv qtrle
125
- adpcm_ima_amv hymt r10k
126
- adpcm_ima_apc iac r210
127
- adpcm_ima_apm idcin ra_144
128
- adpcm_ima_cunning idf ra_288
129
- adpcm_ima_dat4 iff_ilbm ralf
130
- adpcm_ima_dk3 ilbc rasc
131
- adpcm_ima_dk4 imc rawvideo
132
- adpcm_ima_ea_eacs imm4 realtext
133
- adpcm_ima_ea_sead imm5 rka
134
- adpcm_ima_iss indeo2 rl2
135
- adpcm_ima_moflex indeo3 roq
136
- adpcm_ima_mtf indeo4 roq_dpcm
137
- adpcm_ima_oki indeo5 rpza
138
- adpcm_ima_qt interplay_acm rscc
139
- adpcm_ima_rad interplay_dpcm rtv1
140
- adpcm_ima_smjpeg interplay_video rv10
141
- adpcm_ima_ssi ipu rv20
142
- adpcm_ima_wav jacosub rv30
143
- adpcm_ima_ws jpeg2000 rv40
144
- adpcm_ms jpegls rv60
145
- adpcm_mtaf jv s302m
146
- adpcm_psx kgv1 sami
147
- adpcm_sbpro_2 kmvc sanm
148
- adpcm_sbpro_3 lagarith sbc
149
- adpcm_sbpro_4 lead scpr
150
- adpcm_swf libaom_av1 screenpresso
151
- adpcm_thp libaribb24 sdx2_dpcm
152
- adpcm_thp_le libaribcaption sga
153
- adpcm_vima libcodec2 sgi
154
- adpcm_xa libdav1d sgirle
155
- adpcm_xmd libdavs2 sheervideo
156
- adpcm_yamaha libgsm shorten
157
- adpcm_zork libgsm_ms simbiosis_imx
158
- agm libilbc sipr
159
- aic libjxl siren
160
- alac liblc3 smackaud
161
- alias_pix libopencore_amrnb smacker
162
- als libopencore_amrwb smc
163
- amrnb libopus smvjpeg
164
- amrwb libspeex snow
165
- amv libuavs3d sol_dpcm
166
- anm libvorbis sonic
167
- ansi libvpx_vp8 sp5x
168
- anull libvpx_vp9 speedhq
169
- apac libxevd speex
170
- ape libzvbi_teletext srgc
171
- apng loco srt
172
- aptx lscr ssa
173
- aptx_hd m101 stl
174
- arbc mace3 subrip
175
- argo mace6 subviewer
176
- ass magicyuv subviewer1
177
- asv1 mdec sunrast
178
- asv2 media100 svq1
179
- atrac1 metasound svq3
180
- atrac3 microdvd tak
181
- atrac3al mimic targa
182
- atrac3p misc4 targa_y216
183
- atrac3pal mjpeg tdsc
184
- atrac9 mjpeg_cuvid text
185
- aura mjpeg_qsv theora
186
- aura2 mjpegb thp
187
- av1 mlp tiertexseqvideo
188
- av1_cuvid mmvideo tiff
189
- av1_qsv mobiclip tmv
190
- avrn motionpixels truehd
191
- avrp movtext truemotion1
192
- avs mp1 truemotion2
193
- avui mp1float truemotion2rt
194
- bethsoftvid mp2 truespeech
195
- bfi mp2float tscc
196
- bink mp3 tscc2
197
- binkaudio_dct mp3adu tta
198
- binkaudio_rdft mp3adufloat twinvq
199
- bintext mp3float txd
200
- bitpacked mp3on4 ulti
201
- bmp mp3on4float utvideo
202
- bmv_audio mpc7 v210
203
- bmv_video mpc8 v210x
204
- bonk mpeg1_cuvid v308
205
- brender_pix mpeg1video v408
206
- c93 mpeg2_cuvid v410
207
- cavs mpeg2_qsv vb
208
- cbd2_dpcm mpeg2video vble
209
- ccaption mpeg4 vbn
210
- cdgraphics mpeg4_cuvid vc1
211
- cdtoons mpegvideo vc1_cuvid
212
- cdxl mpl2 vc1_qsv
213
- cfhd msa1 vc1image
214
- cinepak mscc vcr1
215
- clearvideo msmpeg4v1 vmdaudio
216
- cljr msmpeg4v2 vmdvideo
217
- cllc msmpeg4v3 vmix
218
- comfortnoise msnsiren vmnc
219
- cook msp2 vnull
220
- cpia msrle vorbis
221
- cri mss1 vp3
222
- cscd mss2 vp4
223
- cyuv msvideo1 vp5
224
- dca mszh vp6
225
- dds mts2 vp6a
226
- derf_dpcm mv30 vp6f
227
- dfa mvc1 vp7
228
- dfpwm mvc2 vp8
229
- dirac mvdv vp8_cuvid
230
- dnxhd mvha vp8_qsv
231
- dolby_e mwsc vp9
232
- dpx mxpeg vp9_cuvid
233
- dsd_lsbf nellymoser vp9_qsv
234
- dsd_lsbf_planar notchlc vplayer
235
- dsd_msbf nuv vqa
236
- dsd_msbf_planar on2avc vqc
237
- dsicinaudio opus vvc
238
- dsicinvideo osq vvc_qsv
239
- dss_sp paf_audio wady_dpcm
240
- dst paf_video wavarc
241
- dvaudio pam wavpack
242
- dvbsub pbm wbmp
243
- dvdsub pcm_alaw wcmv
244
- dvvideo pcm_bluray webp
245
- dxa pcm_dvd webvtt
246
- dxtory pcm_f16le wmalossless
247
- dxv pcm_f24le wmapro
248
- eac3 pcm_f32be wmav1
249
- eacmv pcm_f32le wmav2
250
- eamad pcm_f64be wmavoice
251
- eatgq pcm_f64le wmv1
252
- eatgv pcm_lxf wmv2
253
- eatqi pcm_mulaw wmv3
254
- eightbps pcm_s16be wmv3image
255
- eightsvx_exp pcm_s16be_planar wnv1
256
- eightsvx_fib pcm_s16le wrapped_avframe
257
- escape124 pcm_s16le_planar ws_snd1
258
- escape130 pcm_s24be xan_dpcm
259
- evrc pcm_s24daud xan_wc3
260
- exr pcm_s24le xan_wc4
261
- fastaudio pcm_s24le_planar xbin
262
- ffv1 pcm_s32be xbm
263
- ffvhuff pcm_s32le xface
264
- ffwavesynth pcm_s32le_planar xl
265
- fic pcm_s64be xma1
266
- fits pcm_s64le xma2
267
- flac pcm_s8 xpm
268
- flashsv pcm_s8_planar xsub
269
- flashsv2 pcm_sga xwd
270
- flic pcm_u16be y41p
271
- flv pcm_u16le ylc
272
- fmvc pcm_u24be yop
273
- fourxm pcm_u24le yuv4
274
- fraps pcm_u32be zero12v
275
- frwu pcm_u32le zerocodec
276
- ftr pcm_u8 zlib
277
- g2m pcm_vidc zmbv
278
-
279
- Enabled encoders:
280
- a64multi hevc_nvenc pcm_s64be
281
- a64multi5 hevc_qsv pcm_s64le
282
- aac hevc_vaapi pcm_s8
283
- aac_mf hevc_vulkan pcm_s8_planar
284
- ac3 huffyuv pcm_u16be
285
- ac3_fixed jpeg2000 pcm_u16le
286
- ac3_mf jpegls pcm_u24be
287
- adpcm_adx libaom_av1 pcm_u24le
288
- adpcm_argo libcodec2 pcm_u32be
289
- adpcm_g722 libgsm pcm_u32le
290
- adpcm_g726 libgsm_ms pcm_u8
291
- adpcm_g726le libilbc pcm_vidc
292
- adpcm_ima_alp libjxl pcx
293
- adpcm_ima_amv liblc3 pfm
294
- adpcm_ima_apm libmp3lame pgm
295
- adpcm_ima_qt libopencore_amrnb pgmyuv
296
- adpcm_ima_ssi libopenjpeg phm
297
- adpcm_ima_wav libopus png
298
- adpcm_ima_ws librav1e ppm
299
- adpcm_ms libshine prores
300
- adpcm_swf libspeex prores_aw
301
- adpcm_yamaha libsvtav1 prores_ks
302
- alac libtheora qoi
303
- alias_pix libtwolame qtrle
304
- amv libvo_amrwbenc r10k
305
- anull libvorbis r210
306
- apng libvpx_vp8 ra_144
307
- aptx libvpx_vp9 rawvideo
308
- aptx_hd libvvenc roq
309
- ass libwebp roq_dpcm
310
- asv1 libwebp_anim rpza
311
- asv2 libx264 rv10
312
- av1_amf libx264rgb rv20
313
- av1_mf libx265 s302m
314
- av1_nvenc libxavs2 sbc
315
- av1_qsv libxeve sgi
316
- av1_vaapi libxvid smc
317
- avrp ljpeg snow
318
- avui magicyuv speedhq
319
- bitpacked mjpeg srt
320
- bmp mjpeg_qsv ssa
321
- cfhd mjpeg_vaapi subrip
322
- cinepak mlp sunrast
323
- cljr movtext svq1
324
- comfortnoise mp2 targa
325
- dca mp2fixed text
326
- dfpwm mp3_mf tiff
327
- dnxhd mpeg1video truehd
328
- dpx mpeg2_qsv tta
329
- dvbsub mpeg2_vaapi ttml
330
- dvdsub mpeg2video utvideo
331
- dvvideo mpeg4 v210
332
- dxv msmpeg4v2 v308
333
- eac3 msmpeg4v3 v408
334
- exr msrle v410
335
- ffv1 msvideo1 vbn
336
- ffv1_vulkan nellymoser vc2
337
- ffvhuff opus vnull
338
- fits pam vorbis
339
- flac pbm vp8_vaapi
340
- flashsv pcm_alaw vp9_qsv
341
- flashsv2 pcm_bluray vp9_vaapi
342
- flv pcm_dvd wavpack
343
- g723_1 pcm_f32be wbmp
344
- gif pcm_f32le webvtt
345
- h261 pcm_f64be wmav1
346
- h263 pcm_f64le wmav2
347
- h263p pcm_mulaw wmv1
348
- h264_amf pcm_s16be wmv2
349
- h264_mf pcm_s16be_planar wrapped_avframe
350
- h264_nvenc pcm_s16le xbm
351
- h264_qsv pcm_s16le_planar xface
352
- h264_vaapi pcm_s24be xsub
353
- h264_vulkan pcm_s24daud xwd
354
- hap pcm_s24le y41p
355
- hdr pcm_s24le_planar yuv4
356
- hevc_amf pcm_s32be zlib
357
- hevc_d3d12va pcm_s32le zmbv
358
- hevc_mf pcm_s32le_planar
359
-
360
- Enabled hwaccels:
361
- av1_d3d11va hevc_dxva2 vc1_dxva2
362
- av1_d3d11va2 hevc_nvdec vc1_nvdec
363
- av1_d3d12va hevc_vaapi vc1_vaapi
364
- av1_dxva2 hevc_vulkan vp8_nvdec
365
- av1_nvdec mjpeg_nvdec vp8_vaapi
366
- av1_vaapi mjpeg_vaapi vp9_d3d11va
367
- av1_vulkan mpeg1_nvdec vp9_d3d11va2
368
- h263_vaapi mpeg2_d3d11va vp9_d3d12va
369
- h264_d3d11va mpeg2_d3d11va2 vp9_dxva2
370
- h264_d3d11va2 mpeg2_d3d12va vp9_nvdec
371
- h264_d3d12va mpeg2_dxva2 vp9_vaapi
372
- h264_dxva2 mpeg2_nvdec vvc_vaapi
373
- h264_nvdec mpeg2_vaapi wmv3_d3d11va
374
- h264_vaapi mpeg4_nvdec wmv3_d3d11va2
375
- h264_vulkan mpeg4_vaapi wmv3_d3d12va
376
- hevc_d3d11va vc1_d3d11va wmv3_dxva2
377
- hevc_d3d11va2 vc1_d3d11va2 wmv3_nvdec
378
- hevc_d3d12va vc1_d3d12va wmv3_vaapi
379
-
380
- Enabled parsers:
381
- aac dvdsub mpegvideo
382
- aac_latm evc opus
383
- ac3 flac png
384
- adx ftr pnm
385
- amr g723_1 qoi
386
- av1 g729 rv34
387
- avs2 gif sbc
388
- avs3 gsm sipr
389
- bmp h261 tak
390
- cavsvideo h263 vc1
391
- cook h264 vorbis
392
- cri hdr vp3
393
- dca hevc vp8
394
- dirac ipu vp9
395
- dnxhd jpeg2000 vvc
396
- dnxuc jpegxl webp
397
- dolby_e misc4 xbm
398
- dpx mjpeg xma
399
- dvaudio mlp xwd
400
- dvbsub mpeg4video
401
- dvd_nav mpegaudio
402
-
403
- Enabled demuxers:
404
- aa idf pcm_f64le
405
- aac iff pcm_mulaw
406
- aax ifv pcm_s16be
407
- ac3 ilbc pcm_s16le
408
- ac4 image2 pcm_s24be
409
- ace image2_alias_pix pcm_s24le
410
- acm image2_brender_pix pcm_s32be
411
- act image2pipe pcm_s32le
412
- adf image_bmp_pipe pcm_s8
413
- adp image_cri_pipe pcm_u16be
414
- ads image_dds_pipe pcm_u16le
415
- adx image_dpx_pipe pcm_u24be
416
- aea image_exr_pipe pcm_u24le
417
- afc image_gem_pipe pcm_u32be
418
- aiff image_gif_pipe pcm_u32le
419
- aix image_hdr_pipe pcm_u8
420
- alp image_j2k_pipe pcm_vidc
421
- amr image_jpeg_pipe pdv
422
- amrnb image_jpegls_pipe pjs
423
- amrwb image_jpegxl_pipe pmp
424
- anm image_pam_pipe pp_bnk
425
- apac image_pbm_pipe pva
426
- apc image_pcx_pipe pvf
427
- ape image_pfm_pipe qcp
428
- apm image_pgm_pipe qoa
429
- apng image_pgmyuv_pipe r3d
430
- aptx image_pgx_pipe rawvideo
431
- aptx_hd image_phm_pipe rcwt
432
- aqtitle image_photocd_pipe realtext
433
- argo_asf image_pictor_pipe redspark
434
- argo_brp image_png_pipe rka
435
- argo_cvg image_ppm_pipe rl2
436
- asf image_psd_pipe rm
437
- asf_o image_qdraw_pipe roq
438
- ass image_qoi_pipe rpl
439
- ast image_sgi_pipe rsd
440
- au image_sunrast_pipe rso
441
- av1 image_svg_pipe rtp
442
- avi image_tiff_pipe rtsp
443
- avisynth image_vbn_pipe s337m
444
- avr image_webp_pipe sami
445
- avs image_xbm_pipe sap
446
- avs2 image_xpm_pipe sbc
447
- avs3 image_xwd_pipe sbg
448
- bethsoftvid imf scc
449
- bfi ingenient scd
450
- bfstm ipmovie sdns
451
- bink ipu sdp
452
- binka ircam sdr2
453
- bintext iss sds
454
- bit iv8 sdx
455
- bitpacked ivf segafilm
456
- bmv ivr ser
457
- boa jacosub sga
458
- bonk jpegxl_anim shorten
459
- brstm jv siff
460
- c93 kux simbiosis_imx
461
- caf kvag sln
462
- cavsvideo laf smacker
463
- cdg lc3 smjpeg
464
- cdxl libgme smush
465
- cine libmodplug sol
466
- codec2 libopenmpt sox
467
- codec2raw live_flv spdif
468
- concat lmlm4 srt
469
- dash loas stl
470
- data lrc str
471
- daud luodat subviewer
472
- dcstr lvf subviewer1
473
- derf lxf sup
474
- dfa m4v svag
475
- dfpwm matroska svs
476
- dhav mca swf
477
- dirac mcc tak
478
- dnxhd mgsts tedcaptions
479
- dsf microdvd thp
480
- dsicin mjpeg threedostr
481
- dss mjpeg_2000 tiertexseq
482
- dts mlp tmv
483
- dtshd mlv truehd
484
- dv mm tta
485
- dvbsub mmf tty
486
- dvbtxt mods txd
487
- dxa moflex ty
488
- ea mov usm
489
- ea_cdata mp3 v210
490
- eac3 mpc v210x
491
- epaf mpc8 vag
492
- evc mpegps vc1
493
- ffmetadata mpegts vc1t
494
- filmstrip mpegtsraw vividas
495
- fits mpegvideo vivo
496
- flac mpjpeg vmd
497
- flic mpl2 vobsub
498
- flv mpsub voc
499
- fourxm msf vpk
500
- frm msnwc_tcp vplayer
501
- fsb msp vqf
502
- fwse mtaf vvc
503
- g722 mtv w64
504
- g723_1 musx wady
505
- g726 mv wav
506
- g726le mvi wavarc
507
- g729 mxf wc3
508
- gdv mxg webm_dash_manifest
509
- genh nc webvtt
510
- gif nistsphere wsaud
511
- gsm nsp wsd
512
- gxf nsv wsvqa
513
- h261 nut wtv
514
- h263 nuv wv
515
- h264 obu wve
516
- hca ogg xa
517
- hcom oma xbin
518
- hevc osq xmd
519
- hls paf xmv
520
- hnm pcm_alaw xvag
521
- iamf pcm_f32be xwma
522
- ico pcm_f32le yop
523
- idcin pcm_f64be yuv4mpegpipe
524
-
525
- Enabled muxers:
526
- a64 h263 pcm_s24be
527
- ac3 h264 pcm_s24le
528
- ac4 hash pcm_s32be
529
- adts hds pcm_s32le
530
- adx hevc pcm_s8
531
- aea hls pcm_u16be
532
- aiff iamf pcm_u16le
533
- alp ico pcm_u24be
534
- amr ilbc pcm_u24le
535
- amv image2 pcm_u32be
536
- apm image2pipe pcm_u32le
537
- apng ipod pcm_u8
538
- aptx ircam pcm_vidc
539
- aptx_hd ismv psp
540
- argo_asf ivf rawvideo
541
- argo_cvg jacosub rcwt
542
- asf kvag rm
543
- asf_stream latm roq
544
- ass lc3 rso
545
- ast lrc rtp
546
- au m4v rtp_mpegts
547
- avi matroska rtsp
548
- avif matroska_audio sap
549
- avm2 md5 sbc
550
- avs2 microdvd scc
551
- avs3 mjpeg segafilm
552
- bit mkvtimestamp_v2 segment
553
- caf mlp smjpeg
554
- cavsvideo mmf smoothstreaming
555
- chromaprint mov sox
556
- codec2 mp2 spdif
557
- codec2raw mp3 spx
558
- crc mp4 srt
559
- dash mpeg1system stream_segment
560
- data mpeg1vcd streamhash
561
- daud mpeg1video sup
562
- dfpwm mpeg2dvd swf
563
- dirac mpeg2svcd tee
564
- dnxhd mpeg2video tg2
565
- dts mpeg2vob tgp
566
- dv mpegts truehd
567
- eac3 mpjpeg tta
568
- evc mxf ttml
569
- f4v mxf_d10 uncodedframecrc
570
- ffmetadata mxf_opatom vc1
571
- fifo null vc1t
572
- filmstrip nut voc
573
- fits obu vvc
574
- flac oga w64
575
- flv ogg wav
576
- framecrc ogv webm
577
- framehash oma webm_chunk
578
- framemd5 opus webm_dash_manifest
579
- g722 pcm_alaw webp
580
- g723_1 pcm_f32be webvtt
581
- g726 pcm_f32le wsaud
582
- g726le pcm_f64be wtv
583
- gif pcm_f64le wv
584
- gsm pcm_mulaw yuv4mpegpipe
585
- gxf pcm_s16be
586
- h261 pcm_s16le
587
-
588
- Enabled protocols:
589
- async http rtmp
590
- bluray httpproxy rtmpe
591
- cache https rtmps
592
- concat icecast rtmpt
593
- concatf ipfs_gateway rtmpte
594
- crypto ipns_gateway rtmpts
595
- data librist rtp
596
- fd libsrt srtp
597
- ffrtmpcrypt libssh subfile
598
- ffrtmphttp libzmq tcp
599
- file md5 tee
600
- ftp mmsh tls
601
- gopher mmst udp
602
- gophers pipe udplite
603
- hls prompeg
604
-
605
- Enabled filters:
606
- a3dscope ddagrab pan
607
- aap deband perlin
608
- abench deblock perms
609
- abitscope decimate perspective
610
- acompressor deconvolve phase
611
- acontrast dedot photosensitivity
612
- acopy deesser pixdesctest
613
- acrossfade deflate pixelize
614
- acrossover deflicker pixscope
615
- acrusher deinterlace_qsv pp
616
- acue deinterlace_vaapi pp7
617
- addroi dejudder premultiply
618
- adeclick delogo prewitt
619
- adeclip denoise_vaapi prewitt_opencl
620
- adecorrelate deshake procamp_vaapi
621
- adelay deshake_opencl program_opencl
622
- adenorm despill pseudocolor
623
- aderivative detelecine psnr
624
- adrawgraph dialoguenhance pullup
625
- adrc dilation qp
626
- adynamicequalizer dilation_opencl qrencode
627
- adynamicsmooth displace qrencodesrc
628
- aecho doubleweave quirc
629
- aemphasis drawbox random
630
- aeval drawbox_vaapi readeia608
631
- aevalsrc drawgraph readvitc
632
- aexciter drawgrid realtime
633
- afade drawtext remap
634
- afdelaysrc drmeter remap_opencl
635
- afftdn dynaudnorm removegrain
636
- afftfilt earwax removelogo
637
- afir ebur128 repeatfields
638
- afireqsrc edgedetect replaygain
639
- afirsrc elbg reverse
640
- aformat entropy rgbashift
641
- afreqshift epx rgbtestsrc
642
- afwtdn eq roberts
643
- agate equalizer roberts_opencl
644
- agraphmonitor erosion rotate
645
- ahistogram erosion_opencl rubberband
646
- aiir estdif sab
647
- aintegral exposure scale
648
- ainterleave extractplanes scale2ref
649
- alatency extrastereo scale_cuda
650
- alimiter fade scale_qsv
651
- allpass feedback scale_vaapi
652
- allrgb fftdnoiz scale_vulkan
653
- allyuv fftfilt scdet
654
- aloop field scharr
655
- alphaextract fieldhint scroll
656
- alphamerge fieldmatch segment
657
- amerge fieldorder select
658
- ametadata fillborders selectivecolor
659
- amix find_rect sendcmd
660
- amovie firequalizer separatefields
661
- amplify flanger setdar
662
- amultiply flip_vulkan setfield
663
- anequalizer flite setparams
664
- anlmdn floodfill setpts
665
- anlmf format setrange
666
- anlms fps setsar
667
- anoisesrc framepack settb
668
- anull framerate sharpness_vaapi
669
- anullsink framestep shear
670
- anullsrc freezedetect showcqt
671
- apad freezeframes showcwt
672
- aperms frei0r showfreqs
673
- aphasemeter frei0r_src showinfo
674
- aphaser fspp showpalette
675
- aphaseshift fsync showspatial
676
- apsnr gblur showspectrum
677
- apsyclip gblur_vulkan showspectrumpic
678
- apulsator geq showvolume
679
- arealtime gradfun showwaves
680
- aresample gradients showwavespic
681
- areverse graphmonitor shuffleframes
682
- arls grayworld shufflepixels
683
- arnndn greyedge shuffleplanes
684
- asdr guided sidechaincompress
685
- asegment haas sidechaingate
686
- aselect haldclut sidedata
687
- asendcmd haldclutsrc sierpinski
688
- asetnsamples hdcd signalstats
689
- asetpts headphone signature
690
- asetrate hflip silencedetect
691
- asettb hflip_vulkan silenceremove
692
- ashowinfo highpass sinc
693
- asidedata highshelf sine
694
- asisdr hilbert siti
695
- asoftclip histeq smartblur
696
- aspectralstats histogram smptebars
697
- asplit hqdn3d smptehdbars
698
- ass hqx sobel
699
- astats hstack sobel_opencl
700
- astreamselect hstack_qsv sofalizer
701
- asubboost hstack_vaapi spectrumsynth
702
- asubcut hsvhold speechnorm
703
- asupercut hsvkey split
704
- asuperpass hue spp
705
- asuperstop huesaturation ssim
706
- atadenoise hwdownload ssim360
707
- atempo hwmap stereo3d
708
- atilt hwupload stereotools
709
- atrim hwupload_cuda stereowiden
710
- avectorscope hysteresis streamselect
711
- avgblur identity subtitles
712
- avgblur_opencl idet super2xsai
713
- avgblur_vulkan il superequalizer
714
- avsynctest inflate surround
715
- axcorrelate interlace swaprect
716
- azmq interleave swapuv
717
- backgroundkey join tblend
718
- bandpass kerndeint telecine
719
- bandreject kirsch testsrc
720
- bass ladspa testsrc2
721
- bbox lagfun thistogram
722
- bench latency threshold
723
- bilateral lenscorrection thumbnail
724
- bilateral_cuda lensfun thumbnail_cuda
725
- biquad libplacebo tile
726
- bitplanenoise libvmaf tiltandshift
727
- blackdetect life tiltshelf
728
- blackframe limitdiff tinterlace
729
- blend limiter tlut2
730
- blend_vulkan loop tmedian
731
- blockdetect loudnorm tmidequalizer
732
- blurdetect lowpass tmix
733
- bm3d lowshelf tonemap
734
- boxblur lumakey tonemap_opencl
735
- boxblur_opencl lut tonemap_vaapi
736
- bs2b lut1d tpad
737
- bwdif lut2 transpose
738
- bwdif_cuda lut3d transpose_opencl
739
- bwdif_vulkan lutrgb transpose_vaapi
740
- cas lutyuv transpose_vulkan
741
- ccrepack mandelbrot treble
742
- cellauto maskedclamp tremolo
743
- channelmap maskedmax trim
744
- channelsplit maskedmerge unpremultiply
745
- chorus maskedmin unsharp
746
- chromaber_vulkan maskedthreshold unsharp_opencl
747
- chromahold maskfun untile
748
- chromakey mcdeint uspp
749
- chromakey_cuda mcompand v360
750
- chromanr median vaguedenoiser
751
- chromashift mergeplanes varblur
752
- ciescope mestimate vectorscope
753
- codecview metadata vflip
754
- color midequalizer vflip_vulkan
755
- color_vulkan minterpolate vfrdet
756
- colorbalance mix vibrance
757
- colorchannelmixer monochrome vibrato
758
- colorchart morpho vidstabdetect
759
- colorcontrast movie vidstabtransform
760
- colorcorrect mpdecimate vif
761
- colorhold mptestsrc vignette
762
- colorize msad virtualbass
763
- colorkey multiply vmafmotion
764
- colorkey_opencl negate volume
765
- colorlevels nlmeans volumedetect
766
- colormap nlmeans_opencl vpp_qsv
767
- colormatrix nlmeans_vulkan vstack
768
- colorspace nnedi vstack_qsv
769
- colorspace_cuda noformat vstack_vaapi
770
- colorspectrum noise w3fdif
771
- colortemperature normalize waveform
772
- compand null weave
773
- compensationdelay nullsink xbr
774
- concat nullsrc xcorrelate
775
- convolution openclsrc xfade
776
- convolution_opencl oscilloscope xfade_opencl
777
- convolve overlay xfade_vulkan
778
- copy overlay_cuda xmedian
779
- corr overlay_opencl xpsnr
780
- cover_rect overlay_qsv xstack
781
- crop overlay_vaapi xstack_qsv
782
- cropdetect overlay_vulkan xstack_vaapi
783
- crossfeed owdenoise yadif
784
- crystalizer pad yadif_cuda
785
- cue pad_opencl yaepblur
786
- curves pad_vaapi yuvtestsrc
787
- datascope pal100bars zmq
788
- dblur pal75bars zoneplate
789
- dcshift palettegen zoompan
790
- dctdnoiz paletteuse zscale
791
-
792
- Enabled bsfs:
793
- aac_adtstoasc h264_mp4toannexb pcm_rechunk
794
- av1_frame_merge h264_redundant_pps pgs_frame_merge
795
- av1_frame_split hapqa_extract prores_metadata
796
- av1_metadata hevc_metadata remove_extradata
797
- chomp hevc_mp4toannexb setts
798
- dca_core imx_dump_header showinfo
799
- dovi_rpu media100_to_mjpegb text2movsub
800
- dts2pts mjpeg2jpeg trace_headers
801
- dump_extradata mjpega_dump_header truehd_core
802
- dv_error_marker mov2textsub vp9_metadata
803
- eac3_core mpeg2_metadata vp9_raw_reorder
804
- evc_frame_merge mpeg4_unpack_bframes vp9_superframe
805
- extract_extradata noise vp9_superframe_split
806
- filter_units null vvc_metadata
807
- h264_metadata opus_metadata vvc_mp4toannexb
808
-
809
- Enabled indevs:
810
- dshow lavfi vfwcap
811
- gdigrab libcdio
812
-
813
- Enabled outdevs:
814
- caca sdl2
815
-
816
- git-full external libraries' versions:
817
-
818
- AMF v1.4.35-3-g8f5a645
819
- aom v3.11.0-110-g37c5c4e6aa
820
- aribb24 v1.0.3-5-g5e9be27
821
- aribcaption 1.1.1
822
- AviSynthPlus v3.7.3-80-g452cea05
823
- bs2b 3.1.0
824
- chromaprint 1.5.1
825
- codec2 1.2.0-103-gff00a6e2
826
- dav1d 1.5.0-42-gf8d2620
827
- davs2 1.7-1-gb41cf11
828
- ffnvcodec n12.2.72.0-1-g9934f17
829
- flite v2.2-55-g6c9f20d
830
- freetype VER-2-13-3
831
- frei0r v2.3.3-7-g9178c72
832
- fribidi v1.0.16
833
- gsm 1.0.22
834
- harfbuzz 10.1.0-17-g0b7beefd
835
- ladspa-sdk 1.17
836
- lame 3.100
837
- lc3 1.1.0
838
- lensfun v0.3.95-1587-g3a69a2e8
839
- libass 0.17.3-38-g159cefc
840
- libcdio-paranoia 10.2
841
- libgme 0.6.3
842
- libilbc v3.0.4-346-g6adb26d4a4
843
- libopencore-amrnb 0.1.6
844
- libopencore-amrwb 0.1.6
845
- libplacebo v7.349.0-26-g5788a82
846
- libsoxr 0.1.3
847
- libssh 0.11.1
848
- libtheora 1.1.1
849
- libwebp webp-rfc9649-8-g4c85d860
850
- oneVPL 2.13
851
- OpenCL-Headers v2024.10.24
852
- openmpt libopenmpt-0.6.20-19-gc8153cd77
853
- opus v1.5.2-22-g7db26934
854
- qrencode 4.1.1
855
- quirc 1.2
856
- rav1e p20241015
857
- rist 0.2.11
858
- rubberband v1.8.1
859
- SDL prerelease-2.29.2-432-gba433e4a5
860
- shaderc v2024.3-5-g8c4d729
861
- shine 3.1.1
862
- snappy 1.2.1
863
- speex Speex-1.2.1-29-gaca6801
864
- srt v1.5.4-5-g5f16494
865
- SVT-AV1 v2.3.0-58-gc642bb04
866
- twolame 0.4.0
867
- uavs3d v1.1-47-g1fd0491
868
- VAAPI 2.23.0.
869
- vidstab v1.1.1-13-g8dff7ad
870
- vmaf v3.0.0-99-g8cde19dc
871
- vo-amrwbenc 0.1.3
872
- vorbis v1.3.7-10-g84c02369
873
- vpx v1.15.0-28-g6f0c446c7
874
- vulkan-loader v1.3.302
875
- vvenc v1.12.0-40-g7cf1e5f
876
- x264 v0.164.3198
877
- x265 4.1-54-gfa2770934
878
- xavs2 1.4
879
- xevd 0.5.0
880
- xeve 0.5.1
881
- xvid v1.3.7
882
- zeromq 4.3.5
883
- zimg release-3.0.5-173-g30f368c
884
- zvbi v0.2.42-58-ga48ab3a
885
-
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/bootstrap.min.css DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/community.html DELETED
@@ -1,258 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Community
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Community
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Organisation-1" href="#Organisation-1">1 Organisation</a></li>
29
- <li><a id="toc-General-Assembly-1" href="#General-Assembly-1">2 General Assembly</a></li>
30
- <li><a id="toc-Voting-1" href="#Voting-1">3 Voting</a></li>
31
- <li><a id="toc-Technical-Committee-1" href="#Technical-Committee-1">4 Technical Committee</a>
32
- <ul class="toc-numbered-mark">
33
- <li><a id="toc-Resolution-Process-1" href="#Resolution-Process-1">4.1 Resolution Process</a>
34
- <ul class="toc-numbered-mark">
35
- <li><a id="toc-Seizing" href="#Seizing">4.1.1 Seizing</a></li>
36
- <li><a id="toc-Announcement" href="#Announcement">4.1.2 Announcement</a></li>
37
- <li><a id="toc-RFC-call" href="#RFC-call">4.1.3 RFC call</a></li>
38
- <li><a id="toc-Within-TC" href="#Within-TC">4.1.4 Within TC</a></li>
39
- <li><a id="toc-Decisions" href="#Decisions">4.1.5 Decisions</a></li>
40
- </ul></li>
41
- </ul></li>
42
- <li><a id="toc-Community-Committee-1" href="#Community-Committee-1">5 Community Committee</a></li>
43
- <li><a id="toc-Code-of-Conduct-1" href="#Code-of-Conduct-1">6 Code of Conduct</a></li>
44
- </ul>
45
- </div>
46
- </div>
47
-
48
- <a class="anchor" id="Organisation"></a><ul class="mini-toc">
49
- <li><a href="#Organisation-1" accesskey="1">Organisation</a></li>
50
- <li><a href="#General-Assembly-1" accesskey="2">General Assembly</a></li>
51
- <li><a href="#Voting-1" accesskey="3">Voting</a></li>
52
- <li><a href="#Technical-Committee-1" accesskey="4">Technical Committee</a></li>
53
- <li><a href="#Community-Committee-1" accesskey="5">Community Committee</a></li>
54
- <li><a href="#Code-of-Conduct-1" accesskey="6">Code of Conduct</a></li>
55
- </ul>
56
- <div class="chapter-level-extent" id="Organisation-1">
57
- <h2 class="chapter"><span>1 Organisation<a class="copiable-link" href="#Organisation-1"> &para;</a></span></h2>
58
-
59
- <p>The FFmpeg project is organized through a community working on global consensus.
60
- </p>
61
- <p>Decisions are taken by the ensemble of active members, through voting and are aided by two committees.
62
- </p>
63
- <a class="anchor" id="General-Assembly"></a></div>
64
- <div class="chapter-level-extent" id="General-Assembly-1">
65
- <h2 class="chapter"><span>2 General Assembly<a class="copiable-link" href="#General-Assembly-1"> &para;</a></span></h2>
66
-
67
- <p>The ensemble of active members is called the General Assembly (GA).
68
- </p>
69
- <p>The General Assembly is sovereign and legitimate for all its decisions regarding the FFmpeg project.
70
- </p>
71
- <p>The General Assembly is made up of active contributors.
72
- </p>
73
- <p>Contributors are considered &quot;active contributors&quot; if they have authored more than 20 patches in the last 36 months in the main FFmpeg repository, or if they have been voted in by the GA.
74
- </p>
75
- <p>The list of active contributors is updated twice each year, on 1st January and 1st July, 0:00 UTC.
76
- </p>
77
- <p>Additional members are added to the General Assembly through a vote after proposal by a member of the General Assembly. They are part of the GA for two years, after which they need a confirmation by the GA.
78
- </p>
79
- <p>A script to generate the current members of the general assembly (minus members voted in) can be found in &lsquo;tools/general_assembly.pl&lsquo;.
80
- </p>
81
- <a class="anchor" id="Voting"></a></div>
82
- <div class="chapter-level-extent" id="Voting-1">
83
- <h2 class="chapter"><span>3 Voting<a class="copiable-link" href="#Voting-1"> &para;</a></span></h2>
84
-
85
- <p>Voting is done using a ranked voting system, currently running on https://vote.ffmpeg.org/ .
86
- </p>
87
- <p>Majority vote means more than 50% of the expressed ballots.
88
- </p>
89
- <a class="anchor" id="Technical-Committee"></a></div>
90
- <div class="chapter-level-extent" id="Technical-Committee-1">
91
- <h2 class="chapter"><span>4 Technical Committee<a class="copiable-link" href="#Technical-Committee-1"> &para;</a></span></h2>
92
-
93
- <p>The Technical Committee (TC) is here to arbitrate and make decisions when technical conflicts occur in the project. They will consider the merits of all the positions, judge them and make a decision.
94
- </p>
95
- <p>The TC resolves technical conflicts but is not a technical steering committee.
96
- </p>
97
- <p>Decisions by the TC are binding for all the contributors.
98
- </p>
99
- <p>Decisions made by the TC can be re-opened after 1 year or by a majority vote of the General Assembly, requested by one of the member of the GA.
100
- </p>
101
- <p>The TC is elected by the General Assembly for a duration of 1 year, and is composed of 5 members. Members can be re-elected if they wish. A majority vote in the General Assembly can trigger a new election of the TC.
102
- </p>
103
- <p>The members of the TC can be elected from outside of the GA. Candidates for election can either be suggested or self-nominated.
104
- </p>
105
- <p>The conflict resolution process is detailed in the resolution process document.
106
- </p>
107
- <p>The TC can be contacted at &lt;tc@ffmpeg&gt;.
108
- </p>
109
- <a class="anchor" id="Resolution-Process"></a><ul class="mini-toc">
110
- <li><a href="#Resolution-Process-1" accesskey="1">Resolution Process</a></li>
111
- </ul>
112
- <div class="section-level-extent" id="Resolution-Process-1">
113
- <h3 class="section"><span>4.1 Resolution Process<a class="copiable-link" href="#Resolution-Process-1"> &para;</a></span></h3>
114
-
115
- <p>The Technical Committee (TC) is here to arbitrate and make decisions when technical conflicts occur in the project.
116
- </p>
117
- <p>The TC main role is to resolve technical conflicts. It is therefore not a technical steering committee, but it is understood that some decisions might impact the future of the project.
118
- </p>
119
- <ul class="mini-toc">
120
- <li><a href="#Seizing" accesskey="1">Seizing</a></li>
121
- <li><a href="#Announcement" accesskey="2">Announcement</a></li>
122
- <li><a href="#RFC-call" accesskey="3">RFC call</a></li>
123
- <li><a href="#Within-TC" accesskey="4">Within TC</a></li>
124
- <li><a href="#Decisions" accesskey="5">Decisions</a></li>
125
- </ul>
126
- <div class="subsection-level-extent" id="Seizing">
127
- <h4 class="subsection"><span>4.1.1 Seizing<a class="copiable-link" href="#Seizing"> &para;</a></span></h4>
128
-
129
- <p>The TC can take possession of any technical matter that it sees fit.
130
- </p>
131
- <p>To involve the TC in a matter, email tc&nbsp;or CC them on an ongoing discussion.
132
- </p>
133
- <p>As members of TC are developers, they also can email tc&nbsp;to raise an issue.
134
- </p></div>
135
- <div class="subsection-level-extent" id="Announcement">
136
- <h4 class="subsection"><span>4.1.2 Announcement<a class="copiable-link" href="#Announcement"> &para;</a></span></h4>
137
-
138
- <p>The TC, once seized, must announce itself on the main mailing list, with a [TC] tag.
139
- </p>
140
- <p>The TC has 2 modes of operation: a RFC one and an internal one.
141
- </p>
142
- <p>If the TC thinks it needs the input from the larger community, the TC can call for a RFC. Else, it can decide by itself.
143
- </p>
144
- <p>The decision to use a RFC process or an internal discussion is a discretionary decision of the TC.
145
- </p>
146
- <p>The TC can also reject a seizure for a few reasons such as: the matter was not discussed enough previously; it lacks expertise to reach a beneficial decision on the matter; or the matter is too trivial.
147
- </p></div>
148
- <div class="subsection-level-extent" id="RFC-call">
149
- <h4 class="subsection"><span>4.1.3 RFC call<a class="copiable-link" href="#RFC-call"> &para;</a></span></h4>
150
-
151
- <p>In the RFC mode, one person from the TC posts on the mailing list the technical question and will request input from the community.
152
- </p>
153
- <p>The mail will have the following specification:
154
- </p>
155
- <p>a precise title
156
- a specific tag [TC RFC]
157
- a top-level email
158
- contain a precise question that does not exceed 100 words and that is answerable by developers
159
- may have an extra description, or a link to a previous discussion, if deemed necessary,
160
- contain a precise end date for the answers.
161
- </p>
162
- <p>The answers from the community must be on the main mailing list and must have the following specification:
163
- </p>
164
- <p>keep the tag and the title unchanged
165
- limited to 400 words
166
- a first-level, answering directly to the main email
167
- answering to the question.
168
- </p>
169
- <p>Further replies to answers are permitted, as long as they conform to the community standards of politeness, they are limited to 100 words, and are not nested more than once. (max-depth=2)
170
- </p>
171
- <p>After the end-date, mails on the thread will be ignored.
172
- </p>
173
- <p>Violations of those rules will be escalated through the Community Committee.
174
- </p>
175
- <p>After all the emails are in, the TC has 96 hours to give its final decision. Exceptionally, the TC can request an extra delay, that will be notified on the mailing list.
176
- </p></div>
177
- <div class="subsection-level-extent" id="Within-TC">
178
- <h4 class="subsection"><span>4.1.4 Within TC<a class="copiable-link" href="#Within-TC"> &para;</a></span></h4>
179
-
180
- <p>In the internal case, the TC has 96 hours to give its final decision. Exceptionally, the TC can request an extra delay.
181
- </p></div>
182
- <div class="subsection-level-extent" id="Decisions">
183
- <h4 class="subsection"><span>4.1.5 Decisions<a class="copiable-link" href="#Decisions"> &para;</a></span></h4>
184
-
185
- <p>The decisions from the TC will be sent on the mailing list, with the [TC] tag.
186
- </p>
187
- <p>Internally, the TC should take decisions with a majority, or using ranked-choice voting.
188
- </p>
189
- <p>Each TC member must vote on such decision according to what is, in their view, best for the project.
190
- </p>
191
- <p>If a TC member feels they are affected by a conflict of interest with regards to the case, they should announce it and recuse themselves from the TC
192
- discussion and vote.
193
- </p>
194
- <p>A conflict of interest is presumed to occur when a TC member has a personal interest (e.g. financial) in a specific outcome of the case.
195
- </p>
196
- <p>The decision from the TC should be published with a summary of the reasons that lead to this decision.
197
- </p>
198
- <p>The decisions from the TC are final, until the matters are reopened after no less than one year.
199
- </p>
200
- <a class="anchor" id="Community-Committee"></a></div>
201
- </div>
202
- </div>
203
- <div class="chapter-level-extent" id="Community-Committee-1">
204
- <h2 class="chapter"><span>5 Community Committee<a class="copiable-link" href="#Community-Committee-1"> &para;</a></span></h2>
205
-
206
- <p>The Community Committee (CC) is here to arbitrage and make decisions when inter-personal conflicts occur in the project. It will decide quickly and take actions, for the sake of the project.
207
- </p>
208
- <p>The CC can remove privileges of offending members, including removal of commit access and temporary ban from the community.
209
- </p>
210
- <p>Decisions made by the CC can be re-opened after 1 year or by a majority vote of the General Assembly. Indefinite bans from the community must be confirmed by the General Assembly, in a majority vote.
211
- </p>
212
- <p>The CC is elected by the General Assembly for a duration of 1 year, and is composed of 5 members. Members can be re-elected if they wish. A majority vote in the General Assembly can trigger a new election of the CC.
213
- </p>
214
- <p>The members of the CC can be elected from outside of the GA. Candidates for election can either be suggested or self-nominated.
215
- </p>
216
- <p>The CC is governed by and responsible for enforcing the Code of Conduct.
217
- </p>
218
- <p>The CC can be contacted at &lt;cc@ffmpeg&gt;.
219
- </p>
220
- <a class="anchor" id="Code-of-Conduct"></a></div>
221
- <div class="chapter-level-extent" id="Code-of-Conduct-1">
222
- <h2 class="chapter"><span>6 Code of Conduct<a class="copiable-link" href="#Code-of-Conduct-1"> &para;</a></span></h2>
223
-
224
- <p>Be friendly and respectful towards others and third parties.
225
- Treat others the way you yourself want to be treated.
226
- </p>
227
- <p>Be considerate. Not everyone shares the same viewpoint and priorities as you do.
228
- Different opinions and interpretations help the project.
229
- Looking at issues from a different perspective assists development.
230
- </p>
231
- <p>Do not assume malice for things that can be attributed to incompetence. Even if
232
- it is malice, it&rsquo;s rarely good to start with that as initial assumption.
233
- </p>
234
- <p>Stay friendly even if someone acts contrarily. Everyone has a bad day
235
- once in a while.
236
- If you yourself have a bad day or are angry then try to take a break and reply
237
- once you are calm and without anger if you have to.
238
- </p>
239
- <p>Try to help other team members and cooperate if you can.
240
- </p>
241
- <p>The goal of software development is to create technical excellence, not for any
242
- individual to be better and &quot;win&quot; against the others. Large software projects
243
- are only possible and successful through teamwork.
244
- </p>
245
- <p>If someone struggles do not put them down. Give them a helping hand
246
- instead and point them in the right direction.
247
- </p>
248
- <p>Finally, keep in mind the immortal words of Bill and Ted,
249
- &quot;Be excellent to each other.&quot;
250
- </p>
251
- </div>
252
- </div>
253
- <p style="font-size: small;">
254
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
255
- </p>
256
- </div>
257
- </body>
258
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/default.css DELETED
@@ -1,165 +0,0 @@
1
- a.summary-letter {
2
- text-decoration: none;
3
- }
4
-
5
- a {
6
- color: #2D6198;
7
- }
8
-
9
- a:visited {
10
- color: #884488;
11
- }
12
-
13
- #banner {
14
- background-color: white;
15
- position: relative;
16
- text-align: center;
17
- }
18
-
19
- #banner img {
20
- margin-bottom: 1px;
21
- margin-top: 5px;
22
- }
23
-
24
- #body {
25
- margin-left: 1em;
26
- margin-right: 1em;
27
- }
28
-
29
- body {
30
- background-color: #313131;
31
- margin: 0;
32
- text-align: justify;
33
- }
34
-
35
- .center {
36
- margin-left: auto;
37
- margin-right: auto;
38
- text-align: center;
39
- }
40
-
41
- #container {
42
- background-color: white;
43
- color: #202020;
44
- margin-left: 1em;
45
- margin-right: 1em;
46
- }
47
-
48
- #footer {
49
- text-align: center;
50
- }
51
-
52
- h1 a, h2 a, h3 a, h4 a {
53
- text-decoration: inherit;
54
- color: inherit;
55
- }
56
-
57
- h1, h2, h3, h4 {
58
- padding-left: 0.4em;
59
- border-radius: 4px;
60
- padding-bottom: 0.25em;
61
- padding-top: 0.25em;
62
- border: 1px solid #6A996A;
63
- }
64
-
65
- h1 {
66
- background-color: #7BB37B;
67
- color: #151515;
68
- font-size: 1.2em;
69
- padding-bottom: 0.3em;
70
- padding-top: 0.3em;
71
- }
72
-
73
- h2 {
74
- color: #313131;
75
- font-size: 1.0em;
76
- background-color: #ABE3AB;
77
- }
78
-
79
- h3 {
80
- color: #313131;
81
- font-size: 0.9em;
82
- margin-bottom: -6px;
83
- background-color: #BBF3BB;
84
- }
85
-
86
- h4 {
87
- color: #313131;
88
- font-size: 0.8em;
89
- margin-bottom: -8px;
90
- background-color: #D1FDD1;
91
- }
92
-
93
- img {
94
- border: 0;
95
- }
96
-
97
- #navbar {
98
- background-color: #738073;
99
- border-bottom: 1px solid #5C665C;
100
- border-top: 1px solid #5C665C;
101
- margin-top: 12px;
102
- padding: 0.3em;
103
- position: relative;
104
- text-align: center;
105
- }
106
-
107
- #navbar a, #navbar_secondary a {
108
- color: white;
109
- padding: 0.3em;
110
- text-decoration: none;
111
- }
112
-
113
- #navbar a:hover, #navbar_secondary a:hover {
114
- background-color: #313131;
115
- color: white;
116
- text-decoration: none;
117
- }
118
-
119
- #navbar_secondary {
120
- background-color: #738073;
121
- border-bottom: 1px solid #5C665C;
122
- border-left: 1px solid #5C665C;
123
- border-right: 1px solid #5C665C;
124
- padding: 0.3em;
125
- position: relative;
126
- text-align: center;
127
- }
128
-
129
- p {
130
- margin-left: 1em;
131
- margin-right: 1em;
132
- }
133
-
134
- pre {
135
- margin-left: 3em;
136
- margin-right: 3em;
137
- padding: 0.3em;
138
- border: 1px solid #bbb;
139
- background-color: #f7f7f7;
140
- }
141
-
142
- dl dt {
143
- font-weight: bold;
144
- }
145
-
146
- #proj_desc {
147
- font-size: 1.2em;
148
- }
149
-
150
- #repos {
151
- margin-left: 1em;
152
- margin-right: 1em;
153
- border-collapse: collapse;
154
- border: solid 1px #6A996A;
155
- }
156
-
157
- #repos th {
158
- background-color: #7BB37B;
159
- border: solid 1px #6A996A;
160
- }
161
-
162
- #repos td {
163
- padding: 0.2em;
164
- border: solid 1px #6A996A;
165
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/developer.html DELETED
@@ -1,1241 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Developer Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Developer Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>
29
- <li><a id="toc-Coding-Rules-1" href="#Coding-Rules-1">2 Coding Rules</a>
30
- <ul class="toc-numbered-mark">
31
- <li><a id="toc-Language" href="#Language">2.1 Language</a>
32
- <ul class="toc-numbered-mark">
33
- <li><a id="toc-SIMD_002fDSP-1" href="#SIMD_002fDSP-1">2.1.1 SIMD/DSP</a></li>
34
- <li><a id="toc-Other-languages" href="#Other-languages">2.1.2 Other languages</a></li>
35
- </ul></li>
36
- <li><a id="toc-Code-formatting-conventions" href="#Code-formatting-conventions">2.2 Code formatting conventions</a>
37
- <ul class="toc-numbered-mark">
38
- <li><a id="toc-Examples" href="#Examples">2.2.1 Examples</a></li>
39
- <li><a id="toc-Vim-configuration" href="#Vim-configuration">2.2.2 Vim configuration</a></li>
40
- <li><a id="toc-Emacs-configuration" href="#Emacs-configuration">2.2.3 Emacs configuration</a></li>
41
- </ul></li>
42
- <li><a id="toc-Comments" href="#Comments">2.3 Comments</a></li>
43
- <li><a id="toc-Naming-conventions-1" href="#Naming-conventions-1">2.4 Naming conventions</a></li>
44
- <li><a id="toc-Miscellaneous-conventions" href="#Miscellaneous-conventions">2.5 Miscellaneous conventions</a></li>
45
- </ul></li>
46
- <li><a id="toc-Development-Policy-1" href="#Development-Policy-1">3 Development Policy</a>
47
- <ul class="toc-numbered-mark">
48
- <li><a id="toc-Code-behaviour" href="#Code-behaviour">3.1 Code behaviour</a></li>
49
- <li><a id="toc-Patches_002fCommitting" href="#Patches_002fCommitting">3.2 Patches/Committing</a></li>
50
- <li><a id="toc-Code" href="#Code">3.3 Code</a></li>
51
- <li><a id="toc-Library-public-interfaces" href="#Library-public-interfaces">3.4 Library public interfaces</a>
52
- <ul class="toc-numbered-mark">
53
- <li><a id="toc-Adding-new-interfaces" href="#Adding-new-interfaces">3.4.1 Adding new interfaces</a></li>
54
- <li><a id="toc-Removing-interfaces-1" href="#Removing-interfaces-1">3.4.2 Removing interfaces</a></li>
55
- <li><a id="toc-Major-version-bumps-1" href="#Major-version-bumps-1">3.4.3 Major version bumps</a></li>
56
- </ul></li>
57
- <li><a id="toc-Documentation_002fOther" href="#Documentation_002fOther">3.5 Documentation/Other</a></li>
58
- </ul></li>
59
- <li><a id="toc-Submitting-patches-1" href="#Submitting-patches-1">4 Submitting patches</a></li>
60
- <li><a id="toc-New-codecs-or-formats-checklist" href="#New-codecs-or-formats-checklist">5 New codecs or formats checklist</a></li>
61
- <li><a id="toc-Patch-submission-checklist" href="#Patch-submission-checklist">6 Patch submission checklist</a></li>
62
- <li><a id="toc-Patch-review-process" href="#Patch-review-process">7 Patch review process</a></li>
63
- <li><a id="toc-Regression-tests-1" href="#Regression-tests-1">8 Regression tests</a>
64
- <ul class="toc-numbered-mark">
65
- <li><a id="toc-Adding-files-to-the-fate_002dsuite-dataset" href="#Adding-files-to-the-fate_002dsuite-dataset">8.1 Adding files to the fate-suite dataset</a></li>
66
- <li><a id="toc-Visualizing-Test-Coverage" href="#Visualizing-Test-Coverage">8.2 Visualizing Test Coverage</a></li>
67
- <li><a id="toc-Using-Valgrind" href="#Using-Valgrind">8.3 Using Valgrind</a></li>
68
- </ul></li>
69
- <li><a id="toc-Maintenance-process" href="#Maintenance-process">9 Maintenance process</a>
70
- <ul class="toc-numbered-mark">
71
- <li><a id="toc-MAINTAINERS-1" href="#MAINTAINERS-1">9.1 MAINTAINERS</a></li>
72
- <li><a id="toc-Becoming-a-maintainer-1" href="#Becoming-a-maintainer-1">9.2 Becoming a maintainer</a></li>
73
- </ul></li>
74
- <li><a id="toc-Release-process-1" href="#Release-process-1">10 Release process</a>
75
- <ul class="toc-numbered-mark">
76
- <li><a id="toc-Criteria-for-Point-Releases-1" href="#Criteria-for-Point-Releases-1">10.1 Criteria for Point Releases</a></li>
77
- <li><a id="toc-Release-Checklist" href="#Release-Checklist">10.2 Release Checklist</a></li>
78
- </ul></li>
79
- </ul>
80
- </div>
81
- </div>
82
-
83
- <ul class="mini-toc">
84
- <li><a href="#Introduction" accesskey="1">Introduction</a></li>
85
- <li><a href="#Coding-Rules-1" accesskey="2">Coding Rules</a></li>
86
- <li><a href="#Development-Policy-1" accesskey="3">Development Policy</a></li>
87
- <li><a href="#Submitting-patches-1" accesskey="4">Submitting patches</a></li>
88
- <li><a href="#New-codecs-or-formats-checklist" accesskey="5">New codecs or formats checklist</a></li>
89
- <li><a href="#Patch-submission-checklist" accesskey="6">Patch submission checklist</a></li>
90
- <li><a href="#Patch-review-process" accesskey="7">Patch review process</a></li>
91
- <li><a href="#Regression-tests-1" accesskey="8">Regression tests</a></li>
92
- <li><a href="#Maintenance-process" accesskey="9">Maintenance process</a></li>
93
- <li><a href="#Release-process-1">Release process</a></li>
94
- </ul>
95
- <div class="chapter-level-extent" id="Introduction">
96
- <h2 class="chapter"><span>1 Introduction<a class="copiable-link" href="#Introduction"> &para;</a></span></h2>
97
-
98
- <p>This text is concerned with the development <em class="emph">of</em> FFmpeg itself. Information
99
- on using the FFmpeg libraries in other programs can be found elsewhere, e.g. in:
100
- </p><ul class="itemize mark-bullet">
101
- <li>the installed header files
102
- </li><li><a class="url" href="http://ffmpeg.org/doxygen/trunk/index.html">the Doxygen documentation</a>
103
- generated from the headers
104
- </li><li>the examples under <samp class="file">doc/examples</samp>
105
- </li></ul>
106
-
107
- <p>For more detailed legal information about the use of FFmpeg in
108
- external programs read the <samp class="file">LICENSE</samp> file in the source tree and
109
- consult <a class="url" href="https://ffmpeg.org/legal.html">https://ffmpeg.org/legal.html</a>.
110
- </p>
111
- <p>If you modify FFmpeg code for your own use case, you are highly encouraged to
112
- <em class="emph">submit your changes back to us</em>, using this document as a guide. There are
113
- both pragmatic and ideological reasons to do so:
114
- </p><ul class="itemize mark-bullet">
115
- <li>Maintaining external changes to keep up with upstream development is
116
- time-consuming and error-prone. With your code in the main tree, it will be
117
- maintained by FFmpeg developers.
118
- </li><li>FFmpeg developers include leading experts in the field who can find bugs or
119
- design flaws in your code.
120
- </li><li>By supporting the project you find useful you ensure it continues to be
121
- maintained and developed.
122
- </li></ul>
123
-
124
- <p>All proposed code changes should be submitted for review to
125
- <a class="url" href="mailto:[email protected]">the development mailing list</a>, as
126
- described in more detail in the <a class="ref" href="#Submitting-patches">Submitting patches</a> chapter. The code
127
- should comply with the <a class="ref" href="#Development-Policy">Development Policy</a> and follow the <a class="ref" href="#Coding-Rules">Coding Rules</a>.
128
- The developer making the commit and the author are responsible for their changes
129
- and should try to fix issues their commit causes.
130
- </p>
131
- <a class="anchor" id="Coding-Rules"></a></div>
132
- <div class="chapter-level-extent" id="Coding-Rules-1">
133
- <h2 class="chapter"><span>2 Coding Rules<a class="copiable-link" href="#Coding-Rules-1"> &para;</a></span></h2>
134
-
135
- <ul class="mini-toc">
136
- <li><a href="#Language" accesskey="1">Language</a></li>
137
- <li><a href="#Code-formatting-conventions" accesskey="2">Code formatting conventions</a></li>
138
- <li><a href="#Comments" accesskey="3">Comments</a></li>
139
- <li><a href="#Naming-conventions-1" accesskey="4">Naming conventions</a></li>
140
- <li><a href="#Miscellaneous-conventions" accesskey="5">Miscellaneous conventions</a></li>
141
- </ul>
142
- <div class="section-level-extent" id="Language">
143
- <h3 class="section"><span>2.1 Language<a class="copiable-link" href="#Language"> &para;</a></span></h3>
144
-
145
- <p>FFmpeg is mainly programmed in the ISO C11 language, except for the public
146
- headers which must stay C99 compatible.
147
- </p>
148
- <p>Compiler-specific extensions may be used with good reason, but must not be
149
- depended on, i.e. the code must still compile and work with compilers lacking
150
- the extension.
151
- </p>
152
- <p>The following C99 features must not be used anywhere in the codebase:
153
- </p><ul class="itemize mark-bullet">
154
- <li>variable-length arrays;
155
-
156
- </li><li>complex numbers;
157
-
158
- </li><li>mixed statements and declarations.
159
- </li></ul>
160
-
161
- <ul class="mini-toc">
162
- <li><a href="#SIMD_002fDSP-1" accesskey="1">SIMD/DSP</a></li>
163
- <li><a href="#Other-languages" accesskey="2">Other languages</a></li>
164
- </ul>
165
- <div class="subsection-level-extent" id="SIMD_002fDSP-1">
166
- <h4 class="subsection"><span>2.1.1 SIMD/DSP<a class="copiable-link" href="#SIMD_002fDSP-1"> &para;</a></span></h4>
167
- <a class="anchor" id="SIMD_002fDSP"></a>
168
- <p>As modern compilers are unable to generate efficient SIMD or other
169
- performance-critical DSP code from plain C, handwritten assembly is used.
170
- Usually such code is isolated in a separate function. Then the standard approach
171
- is writing multiple versions of this function – a plain C one that works
172
- everywhere and may also be useful for debugging, and potentially multiple
173
- architecture-specific optimized implementations. Initialization code then
174
- chooses the best available version at runtime and loads it into a function
175
- pointer; the function in question is then always called through this pointer.
176
- </p>
177
- <p>The specific syntax used for writing assembly is:
178
- </p><ul class="itemize mark-bullet">
179
- <li>NASM on x86;
180
-
181
- </li><li>GAS on ARM and RISC-V.
182
- </li></ul>
183
-
184
- <p>A unit testing framework for assembly called <code class="code">checkasm</code> lives under
185
- <samp class="file">tests/checkasm</samp>. All new assembly should come with <code class="code">checkasm</code> tests;
186
- adding tests for existing assembly that lacks them is also strongly encouraged.
187
- </p>
188
- </div>
189
- <div class="subsection-level-extent" id="Other-languages">
190
- <h4 class="subsection"><span>2.1.2 Other languages<a class="copiable-link" href="#Other-languages"> &para;</a></span></h4>
191
-
192
- <p>Other languages than C may be used in special cases:
193
- </p><ul class="itemize mark-bullet">
194
- <li>Compiler intrinsics or inline assembly when the code in question cannot be
195
- written in the standard way described in the <a class="ref" href="#SIMD_002fDSP">SIMD/DSP</a> section. This
196
- typically applies to code that needs to be inlined.
197
-
198
- </li><li>Objective-C where required for interacting with macOS-specific interfaces.
199
- </li></ul>
200
-
201
- </div>
202
- </div>
203
- <div class="section-level-extent" id="Code-formatting-conventions">
204
- <h3 class="section"><span>2.2 Code formatting conventions<a class="copiable-link" href="#Code-formatting-conventions"> &para;</a></span></h3>
205
-
206
- <p>There are the following guidelines regarding the code style in files:
207
- </p>
208
- <ul class="itemize mark-bullet">
209
- <li>Indent size is 4.
210
-
211
- </li><li>The TAB character is forbidden outside of Makefiles as is any
212
- form of trailing whitespace. Commits containing either will be
213
- rejected by the git repository.
214
-
215
- </li><li>You should try to limit your code lines to 80 characters; however, do so if
216
- and only if this improves readability.
217
-
218
- </li><li>K&amp;R coding style is used.
219
- </li></ul>
220
- <p>The presentation is one inspired by &rsquo;indent -i4 -kr -nut&rsquo;.
221
- </p>
222
- <ul class="mini-toc">
223
- <li><a href="#Examples" accesskey="1">Examples</a></li>
224
- <li><a href="#Vim-configuration" accesskey="2">Vim configuration</a></li>
225
- <li><a href="#Emacs-configuration" accesskey="3">Emacs configuration</a></li>
226
- </ul>
227
- <div class="subsection-level-extent" id="Examples">
228
- <h4 class="subsection"><span>2.2.1 Examples<a class="copiable-link" href="#Examples"> &para;</a></span></h4>
229
- <p>Some notable examples to illustrate common code style in FFmpeg:
230
- </p>
231
- <ul class="itemize mark-bullet">
232
- <li>Space around assignments and after
233
- <code class="code">if</code>/<code class="code">do</code>/<code class="code">while</code>/<code class="code">for</code> keywords:
234
-
235
- <div class="example user-c user-good">
236
- <pre class="example-preformatted">// Good
237
- if (condition)
238
- av_foo();
239
- </pre></div>
240
-
241
- <div class="example user-c user-good">
242
- <pre class="example-preformatted">// Good
243
- for (size_t i = 0; i &lt; len; i++)
244
- av_bar(i);
245
- </pre></div>
246
-
247
- <div class="example user-c user-good">
248
- <pre class="example-preformatted">// Good
249
- size_t size = 0;
250
- </pre></div>
251
-
252
- <p>However no spaces between the parentheses and condition, unless it helps
253
- readability of complex conditions, so the following should not be done:
254
- </p>
255
- <div class="example user-c user-bad">
256
- <pre class="example-preformatted">// Bad style
257
- if ( condition )
258
- av_foo();
259
- </pre></div>
260
-
261
- </li><li>No unnecessary parentheses, unless it helps readability:
262
-
263
- <div class="example user-c user-good">
264
- <pre class="example-preformatted">// Good
265
- int fields = ilace ? 2 : 1;
266
- </pre></div>
267
-
268
- </li><li>No braces around single-line blocks:
269
-
270
- <div class="example user-c user-good">
271
- <pre class="example-preformatted">// Good
272
- if (bits_pixel == 24)
273
- avctx-&gt;pix_fmt = AV_PIX_FMT_BGR24;
274
- else if (bits_pixel == 8)
275
- avctx-&gt;pix_fmt = AV_PIX_FMT_GRAY8;
276
- else {
277
- av_log(avctx, AV_LOG_ERROR, &quot;Invalid pixel format.\n&quot;);
278
- return AVERROR_INVALIDDATA;
279
- }
280
- </pre></div>
281
-
282
- </li><li>Avoid assignments in conditions where it makes sense:
283
-
284
- <div class="example user-c user-good">
285
- <pre class="example-preformatted">// Good
286
- video_enc-&gt;chroma_intra_matrix = av_mallocz(sizeof(*video_enc-&gt;chroma_intra_matrix) * 64)
287
- if (!video_enc-&gt;chroma_intra_matrix)
288
- return AVERROR(ENOMEM);
289
- </pre></div>
290
-
291
- <div class="example user-c user-bad">
292
- <pre class="example-preformatted">// Bad style
293
- if (!(video_enc-&gt;chroma_intra_matrix = av_mallocz(sizeof(*video_enc-&gt;chroma_intra_matrix) * 64)))
294
- return AVERROR(ENOMEM);
295
- </pre></div>
296
-
297
- <div class="example user-c user-good">
298
- <pre class="example-preformatted">// Ok
299
- while ((entry = av_dict_iterate(options, entry)))
300
- av_log(ctx, AV_LOG_INFO, &quot;Item '%s': '%s'\n&quot;, entry-&gt;key, entry-&gt;value);
301
- </pre></div>
302
-
303
- </li><li>When declaring a pointer variable, the <code class="code">*</code> goes with the variable not the type:
304
-
305
- <div class="example user-c user-good">
306
- <pre class="example-preformatted">// Good
307
- AVStream *stream;
308
- </pre></div>
309
-
310
- <div class="example user-c user-bad">
311
- <pre class="example-preformatted">// Bad style
312
- AVStream* stream;
313
- </pre></div>
314
-
315
- </li></ul>
316
-
317
- <p>If you work on a file that does not follow these guidelines consistently,
318
- change the parts that you are editing to follow these guidelines but do
319
- not make unrelated changes in the file to make it conform to these.
320
- </p>
321
- </div>
322
- <div class="subsection-level-extent" id="Vim-configuration">
323
- <h4 class="subsection"><span>2.2.2 Vim configuration<a class="copiable-link" href="#Vim-configuration"> &para;</a></span></h4>
324
- <p>In order to configure Vim to follow FFmpeg formatting conventions, paste
325
- the following snippet into your <samp class="file">.vimrc</samp>:
326
- </p><div class="example">
327
- <pre class="example-preformatted">&quot; indentation rules for FFmpeg: 4 spaces, no tabs
328
- set expandtab
329
- set shiftwidth=4
330
- set softtabstop=4
331
- set cindent
332
- set cinoptions=(0
333
- &quot; Allow tabs in Makefiles.
334
- autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
335
- &quot; Trailing whitespace and tabs are forbidden, so highlight them.
336
- highlight ForbiddenWhitespace ctermbg=red guibg=red
337
- match ForbiddenWhitespace /\s\+$\|\t/
338
- &quot; Do not highlight spaces at the end of line while typing on that line.
339
- autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@&lt;!$/
340
- </pre></div>
341
-
342
- </div>
343
- <div class="subsection-level-extent" id="Emacs-configuration">
344
- <h4 class="subsection"><span>2.2.3 Emacs configuration<a class="copiable-link" href="#Emacs-configuration"> &para;</a></span></h4>
345
- <p>For Emacs, add these roughly equivalent lines to your <samp class="file">.emacs.d/init.el</samp>:
346
- </p><div class="example lisp">
347
- <pre class="lisp-preformatted">(c-add-style &quot;ffmpeg&quot;
348
- '(&quot;k&amp;r&quot;
349
- (c-basic-offset . 4)
350
- (indent-tabs-mode . nil)
351
- (show-trailing-whitespace . t)
352
- (c-offsets-alist
353
- (statement-cont . (c-lineup-assignments +)))
354
- )
355
- )
356
- (setq c-default-style &quot;ffmpeg&quot;)
357
- </pre></div>
358
-
359
- </div>
360
- </div>
361
- <div class="section-level-extent" id="Comments">
362
- <h3 class="section"><span>2.3 Comments<a class="copiable-link" href="#Comments"> &para;</a></span></h3>
363
- <p>Use the JavaDoc/Doxygen format (see examples below) so that code documentation
364
- can be generated automatically. All nontrivial functions should have a comment
365
- above them explaining what the function does, even if it is just one sentence.
366
- All structures and their member variables should be documented, too.
367
- </p>
368
- <p>Avoid Qt-style and similar Doxygen syntax with <code class="code">!</code> in it, i.e. replace
369
- <code class="code">//!</code> with <code class="code">///</code> and similar. Also @ syntax should be employed
370
- for markup commands, i.e. use <code class="code">@param</code> and not <code class="code">\param</code>.
371
- </p>
372
- <div class="example">
373
- <pre class="example-preformatted">/**
374
- * @file
375
- * MPEG codec.
376
- * @author ...
377
- */
378
-
379
- /**
380
- * Summary sentence.
381
- * more text ...
382
- * ...
383
- */
384
- typedef struct Foobar {
385
- int var1; /**&lt; var1 description */
386
- int var2; ///&lt; var2 description
387
- /** var3 description */
388
- int var3;
389
- } Foobar;
390
-
391
- /**
392
- * Summary sentence.
393
- * more text ...
394
- * ...
395
- * @param my_parameter description of my_parameter
396
- * @return return value description
397
- */
398
- int myfunc(int my_parameter)
399
- ...
400
- </pre></div>
401
-
402
- <a class="anchor" id="Naming-conventions"></a></div>
403
- <div class="section-level-extent" id="Naming-conventions-1">
404
- <h3 class="section"><span>2.4 Naming conventions<a class="copiable-link" href="#Naming-conventions-1"> &para;</a></span></h3>
405
-
406
- <p>Names of functions, variables, and struct members must be lowercase, using
407
- underscores (_) to separate words. For example, &lsquo;<samp class="samp">avfilter_get_video_buffer</samp>&rsquo;
408
- is an acceptable function name and &lsquo;<samp class="samp">AVFilterGetVideo</samp>&rsquo; is not.
409
- </p>
410
- <p>Struct, union, enum, and typedeffed type names must use CamelCase. All structs
411
- and unions should be typedeffed to the same name as the struct/union tag, e.g.
412
- <code class="code">typedef struct AVFoo { ... } AVFoo;</code>. Enums are typically not
413
- typedeffed.
414
- </p>
415
- <p>Enumeration constants and macros must be UPPERCASE, except for macros
416
- masquerading as functions, which should use the function naming convention.
417
- </p>
418
- <p>All identifiers in the libraries should be namespaced as follows:
419
- </p><ul class="itemize mark-bullet">
420
- <li>No namespacing for identifiers with file and lower scope (e.g. local variables,
421
- static functions), and struct and union members,
422
-
423
- </li><li>The <code class="code">ff_</code> prefix must be used for variables and functions visible outside
424
- of file scope, but only used internally within a single library, e.g.
425
- &lsquo;<samp class="samp">ff_w64_demuxer</samp>&rsquo;. This prevents name collisions when FFmpeg is statically
426
- linked.
427
-
428
- </li><li>For variables and functions visible outside of file scope, used internally
429
- across multiple libraries, use <code class="code">avpriv_</code> as prefix, for example,
430
- &lsquo;<samp class="samp">avpriv_report_missing_feature</samp>&rsquo;.
431
-
432
- </li><li>All other internal identifiers, like private type or macro names, should be
433
- namespaced only to avoid possible internal conflicts. E.g. <code class="code">H264_NAL_SPS</code>
434
- vs. <code class="code">HEVC_NAL_SPS</code>.
435
-
436
- </li><li>Each library has its own prefix for public symbols, in addition to the
437
- commonly used <code class="code">av_</code> (<code class="code">avformat_</code> for libavformat,
438
- <code class="code">avcodec_</code> for libavcodec, <code class="code">swr_</code> for libswresample, etc).
439
- Check the existing code and choose names accordingly.
440
-
441
- </li><li>Other public identifiers (struct, union, enum, macro, type names) must use their
442
- library&rsquo;s public prefix (<code class="code">AV</code>, <code class="code">Sws</code>, or <code class="code">Swr</code>).
443
- </li></ul>
444
-
445
- <p>Furthermore, name space reserved for the system should not be invaded.
446
- Identifiers ending in <code class="code">_t</code> are reserved by
447
- <a class="url" href="http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02">POSIX</a>.
448
- Also avoid names starting with <code class="code">__</code> or <code class="code">_</code> followed by an uppercase
449
- letter as they are reserved by the C standard. Names starting with <code class="code">_</code>
450
- are reserved at the file level and may not be used for externally visible
451
- symbols. If in doubt, just avoid names starting with <code class="code">_</code> altogether.
452
- </p>
453
- </div>
454
- <div class="section-level-extent" id="Miscellaneous-conventions">
455
- <h3 class="section"><span>2.5 Miscellaneous conventions<a class="copiable-link" href="#Miscellaneous-conventions"> &para;</a></span></h3>
456
-
457
- <ul class="itemize mark-bullet">
458
- <li>Casts should be used only when necessary. Unneeded parentheses
459
- should also be avoided if they don&rsquo;t make the code easier to understand.
460
- </li></ul>
461
-
462
- <a class="anchor" id="Development-Policy"></a></div>
463
- </div>
464
- <div class="chapter-level-extent" id="Development-Policy-1">
465
- <h2 class="chapter"><span>3 Development Policy<a class="copiable-link" href="#Development-Policy-1"> &para;</a></span></h2>
466
-
467
- <ul class="mini-toc">
468
- <li><a href="#Code-behaviour" accesskey="1">Code behaviour</a></li>
469
- <li><a href="#Patches_002fCommitting" accesskey="2">Patches/Committing</a></li>
470
- <li><a href="#Code" accesskey="3">Code</a></li>
471
- <li><a href="#Library-public-interfaces" accesskey="4">Library public interfaces</a></li>
472
- <li><a href="#Documentation_002fOther" accesskey="5">Documentation/Other</a></li>
473
- </ul>
474
- <div class="section-level-extent" id="Code-behaviour">
475
- <h3 class="section"><span>3.1 Code behaviour<a class="copiable-link" href="#Code-behaviour"> &para;</a></span></h3>
476
-
477
- <h4 class="subheading" id="Correctness"><span>Correctness<a class="copiable-link" href="#Correctness"> &para;</a></span></h4>
478
- <p>The code must be valid. It must not crash, abort, access invalid pointers, leak
479
- memory, cause data races or signed integer overflow, or otherwise cause
480
- undefined behaviour. Error codes should be checked and, when applicable,
481
- forwarded to the caller.
482
- </p>
483
- <h4 class="subheading" id="Thread_002d-and-library_002dsafety"><span>Thread- and library-safety<a class="copiable-link" href="#Thread_002d-and-library_002dsafety"> &para;</a></span></h4>
484
- <p>Our libraries may be called by multiple independent callers in the same process.
485
- These calls may happen from any number of threads and the different call sites
486
- may not be aware of each other - e.g. a user program may be calling our
487
- libraries directly, and use one or more libraries that also call our libraries.
488
- The code must behave correctly under such conditions.
489
- </p>
490
- <h4 class="subheading" id="Robustness"><span>Robustness<a class="copiable-link" href="#Robustness"> &para;</a></span></h4>
491
- <p>The code must treat as untrusted any bytestream received from a caller or read
492
- from a file, network, etc. It must not misbehave when arbitrary data is sent to
493
- it - typically it should print an error message and return
494
- <code class="code">AVERROR_INVALIDDATA</code> on encountering invalid input data.
495
- </p>
496
- <h4 class="subheading" id="Memory-allocation"><span>Memory allocation<a class="copiable-link" href="#Memory-allocation"> &para;</a></span></h4>
497
- <p>The code must use the <code class="code">av_malloc()</code> family of functions from
498
- <samp class="file">libavutil/mem.h</samp> to perform all memory allocation, except in special cases
499
- (e.g. when interacting with an external library that requires a specific
500
- allocator to be used).
501
- </p>
502
- <p>All allocations should be checked and <code class="code">AVERROR(ENOMEM)</code> returned on
503
- failure. A common mistake is that error paths leak memory - make sure that does
504
- not happen.
505
- </p>
506
- <h4 class="subheading" id="stdio"><span>stdio<a class="copiable-link" href="#stdio"> &para;</a></span></h4>
507
- <p>Our libraries must not access the stdio streams stdin/stdout/stderr directly
508
- (e.g. via <code class="code">printf()</code> family of functions), as that is not library-safe. For
509
- logging, use <code class="code">av_log()</code>.
510
- </p>
511
- </div>
512
- <div class="section-level-extent" id="Patches_002fCommitting">
513
- <h3 class="section"><span>3.2 Patches/Committing<a class="copiable-link" href="#Patches_002fCommitting"> &para;</a></span></h3>
514
- <h4 class="subheading" id="Licenses-for-patches-must-be-compatible-with-FFmpeg_002e"><span>Licenses for patches must be compatible with FFmpeg.<a class="copiable-link" href="#Licenses-for-patches-must-be-compatible-with-FFmpeg_002e"> &para;</a></span></h4>
515
- <p>Contributions should be licensed under the
516
- <a class="uref" href="http://www.gnu.org/licenses/lgpl-2.1.html">LGPL 2.1</a>,
517
- including an &quot;or any later version&quot; clause, or, if you prefer
518
- a gift-style license, the
519
- <a class="uref" href="http://opensource.org/licenses/isc-license.txt">ISC</a> or
520
- <a class="uref" href="http://mit-license.org/">MIT</a> license.
521
- <a class="uref" href="http://www.gnu.org/licenses/gpl-2.0.html">GPL 2</a> including
522
- an &quot;or any later version&quot; clause is also acceptable, but LGPL is
523
- preferred.
524
- If you add a new file, give it a proper license header. Do not copy and
525
- paste it from a random place, use an existing file as template.
526
- </p>
527
- <h4 class="subheading" id="You-must-not-commit-code-which-breaks-FFmpeg_0021"><span>You must not commit code which breaks FFmpeg!<a class="copiable-link" href="#You-must-not-commit-code-which-breaks-FFmpeg_0021"> &para;</a></span></h4>
528
- <p>This means unfinished code which is enabled and breaks compilation,
529
- or compiles but does not work/breaks the regression tests. Code which
530
- is unfinished but disabled may be permitted under-circumstances, like
531
- missing samples or an implementation with a small subset of features.
532
- Always check the mailing list for any reviewers with issues and test
533
- FATE before you push.
534
- </p>
535
- <h4 class="subheading" id="Commit-messages"><span>Commit messages<a class="copiable-link" href="#Commit-messages"> &para;</a></span></h4>
536
- <p>Commit messages are highly important tools for informing other developers on
537
- what a given change does and why. Every commit must always have a properly
538
- filled out commit message with the following format:
539
- </p><div class="example">
540
- <pre class="example-preformatted">area changed: short 1 line description
541
-
542
- details describing what and why and giving references.
543
- </pre></div>
544
-
545
- <p>If the commit addresses a known bug on our bug tracker or other external issue
546
- (e.g. CVE), the commit message should include the relevant bug ID(s) or other
547
- external identifiers. Note that this should be done in addition to a proper
548
- explanation and not instead of it. Comments such as &quot;fixed!&quot; or &quot;Changed it.&quot;
549
- are not acceptable.
550
- </p>
551
- <p>When applying patches that have been discussed at length on the mailing list,
552
- reference the thread in the commit message.
553
- </p>
554
- <h4 class="subheading" id="Testing-must-be-adequate-but-not-excessive_002e"><span>Testing must be adequate but not excessive.<a class="copiable-link" href="#Testing-must-be-adequate-but-not-excessive_002e"> &para;</a></span></h4>
555
- <p>If it works for you, others, and passes FATE then it should be OK to commit
556
- it, provided it fits the other committing criteria. You should not worry about
557
- over-testing things. If your code has problems (portability, triggers
558
- compiler bugs, unusual environment etc) they will be reported and eventually
559
- fixed.
560
- </p>
561
- <h4 class="subheading" id="Do-not-commit-unrelated-changes-together_002e"><span>Do not commit unrelated changes together.<a class="copiable-link" href="#Do-not-commit-unrelated-changes-together_002e"> &para;</a></span></h4>
562
- <p>They should be split them into self-contained pieces. Also do not forget
563
- that if part B depends on part A, but A does not depend on B, then A can
564
- and should be committed first and separate from B. Keeping changes well
565
- split into self-contained parts makes reviewing and understanding them on
566
- the commit log mailing list easier. This also helps in case of debugging
567
- later on.
568
- Also if you have doubts about splitting or not splitting, do not hesitate to
569
- ask/discuss it on the developer mailing list.
570
- </p>
571
- <h4 class="subheading" id="Cosmetic-changes-should-be-kept-in-separate-patches_002e"><span>Cosmetic changes should be kept in separate patches.<a class="copiable-link" href="#Cosmetic-changes-should-be-kept-in-separate-patches_002e"> &para;</a></span></h4>
572
- <p>We refuse source indentation and other cosmetic changes if they are mixed
573
- with functional changes, such commits will be rejected and removed. Every
574
- developer has his own indentation style, you should not change it. Of course
575
- if you (re)write something, you can use your own style, even though we would
576
- prefer if the indentation throughout FFmpeg was consistent (Many projects
577
- force a given indentation style - we do not.). If you really need to make
578
- indentation changes (try to avoid this), separate them strictly from real
579
- changes.
580
- </p>
581
- <p>NOTE: If you had to put if(){ .. } over a large (&gt; 5 lines) chunk of code,
582
- then either do NOT change the indentation of the inner part within (do not
583
- move it to the right)! or do so in a separate commit
584
- </p>
585
- <h4 class="subheading" id="Credit-the-author-of-the-patch_002e"><span>Credit the author of the patch.<a class="copiable-link" href="#Credit-the-author-of-the-patch_002e"> &para;</a></span></h4>
586
- <p>Make sure the author of the commit is set correctly. (see git commit &ndash;author)
587
- If you apply a patch, send an
588
- answer to ffmpeg-devel (or wherever you got the patch from) saying that
589
- you applied the patch.
590
- </p>
591
- <h4 class="subheading" id="Credit-any-researchers"><span>Credit any researchers<a class="copiable-link" href="#Credit-any-researchers"> &para;</a></span></h4>
592
- <p>If a commit/patch fixes an issues found by some researcher, always credit the
593
- researcher in the commit message for finding/reporting the issue.
594
- </p>
595
- <h4 class="subheading" id="Always-wait-long-enough-before-pushing-changes"><span>Always wait long enough before pushing changes<a class="copiable-link" href="#Always-wait-long-enough-before-pushing-changes"> &para;</a></span></h4>
596
- <p>Do NOT commit to code actively maintained by others without permission.
597
- Send a patch to ffmpeg-devel. If no one answers within a reasonable
598
- time-frame (12h for build failures and security fixes, 3 days small changes,
599
- 1 week for big patches) then commit your patch if you think it is OK.
600
- Also note, the maintainer can simply ask for more time to review!
601
- </p>
602
- </div>
603
- <div class="section-level-extent" id="Code">
604
- <h3 class="section"><span>3.3 Code<a class="copiable-link" href="#Code"> &para;</a></span></h3>
605
- <h4 class="subheading" id="Warnings-for-correct-code-may-be-disabled-if-there-is-no-other-option_002e"><span>Warnings for correct code may be disabled if there is no other option.<a class="copiable-link" href="#Warnings-for-correct-code-may-be-disabled-if-there-is-no-other-option_002e"> &para;</a></span></h4>
606
- <p>Compiler warnings indicate potential bugs or code with bad style. If a type of
607
- warning always points to correct and clean code, that warning should
608
- be disabled, not the code changed.
609
- Thus the remaining warnings can either be bugs or correct code.
610
- If it is a bug, the bug has to be fixed. If it is not, the code should
611
- be changed to not generate a warning unless that causes a slowdown
612
- or obfuscates the code.
613
- </p>
614
- </div>
615
- <div class="section-level-extent" id="Library-public-interfaces">
616
- <h3 class="section"><span>3.4 Library public interfaces<a class="copiable-link" href="#Library-public-interfaces"> &para;</a></span></h3>
617
- <p>Every library in FFmpeg provides a set of public APIs in its installed headers,
618
- which are those listed in the variable <code class="code">HEADERS</code> in that library&rsquo;s
619
- <samp class="file">Makefile</samp>. All identifiers defined in those headers (except for those
620
- explicitly documented otherwise), and corresponding symbols exported from
621
- compiled shared or static libraries are considered public interfaces and must
622
- comply with the API and ABI compatibility rules described in this section.
623
- </p>
624
- <p>Public APIs must be backward compatible within a given major version. I.e. any
625
- valid user code that compiles and works with a given library version must still
626
- compile and work with any later version, as long as the major version number is
627
- unchanged. &quot;Valid user code&quot; here means code that is calling our APIs in a
628
- documented and/or intended manner and is not relying on any undefined behavior.
629
- Incrementing the major version may break backward compatibility, but only to the
630
- extent described in <a class="ref" href="#Major-version-bumps">Major version bumps</a>.
631
- </p>
632
- <p>We also guarantee backward ABI compatibility for shared and static libraries.
633
- I.e. it should be possible to replace a shared or static build of our library
634
- with a build of any later version (re-linking the user binary in the static
635
- case) without breaking any valid user binaries, as long as the major version
636
- number remains unchanged.
637
- </p>
638
- <ul class="mini-toc">
639
- <li><a href="#Adding-new-interfaces" accesskey="1">Adding new interfaces</a></li>
640
- <li><a href="#Removing-interfaces-1" accesskey="2">Removing interfaces</a></li>
641
- <li><a href="#Major-version-bumps-1" accesskey="3">Major version bumps</a></li>
642
- </ul>
643
- <div class="subsection-level-extent" id="Adding-new-interfaces">
644
- <h4 class="subsection"><span>3.4.1 Adding new interfaces<a class="copiable-link" href="#Adding-new-interfaces"> &para;</a></span></h4>
645
- <p>Any new public identifiers in installed headers are considered new API - this
646
- includes new functions, structs, macros, enum values, typedefs, new fields in
647
- existing structs, new installed headers, etc. Consider the following
648
- guidelines when adding new APIs.
649
- </p>
650
- <h4 class="subsubheading" id="Motivation"><span>Motivation<a class="copiable-link" href="#Motivation"> &para;</a></span></h4>
651
- <p>While new APIs can be added relatively easily, changing or removing them is much
652
- harder due to abovementioned compatibility requirements. You should then
653
- consider carefully whether the functionality you are adding really needs to be
654
- exposed to our callers as new public API.
655
- </p>
656
- <p>Your new API should have at least one well-established use case outside of the
657
- library that cannot be easily achieved with existing APIs. Every library in
658
- FFmpeg also has a defined scope - your new API must fit within it.
659
- </p>
660
- <h4 class="subsubheading" id="Replacing-existing-APIs"><span>Replacing existing APIs<a class="copiable-link" href="#Replacing-existing-APIs"> &para;</a></span></h4>
661
- <p>If your new API is replacing an existing one, it should be strictly superior to
662
- it, so that the advantages of using the new API outweight the cost to the
663
- callers of changing their code. After adding the new API you should then
664
- deprecate the old one and schedule it for removal, as described in
665
- <a class="ref" href="#Removing-interfaces">Removing interfaces</a>.
666
- </p>
667
- <p>If you deem an existing API deficient and want to fix it, the preferred approach
668
- in most cases is to add a differently-named replacement and deprecate the
669
- existing API rather than modify it. It is important to make the changes visible
670
- to our callers (e.g. through compile- or run-time deprecation warnings) and make
671
- it clear how to transition to the new API (e.g. in the Doxygen documentation or
672
- on the wiki).
673
- </p>
674
- <h4 class="subsubheading" id="API-design"><span>API design<a class="copiable-link" href="#API-design"> &para;</a></span></h4>
675
- <p>The FFmpeg libraries are used by a variety of callers to perform a wide range of
676
- multimedia-related processing tasks. You should therefore - within reason - try
677
- to design your new API for the broadest feasible set of use cases and avoid
678
- unnecessarily limiting it to a specific type of callers (e.g. just media
679
- playback or just transcoding).
680
- </p>
681
- <h4 class="subsubheading" id="Consistency"><span>Consistency<a class="copiable-link" href="#Consistency"> &para;</a></span></h4>
682
- <p>Check whether similar APIs already exist in FFmpeg. If they do, try to model
683
- your new addition on them to achieve better overall consistency.
684
- </p>
685
- <p>The naming of your new identifiers should follow the <a class="ref" href="#Naming-conventions">Naming conventions</a>
686
- and be aligned with other similar APIs, if applicable.
687
- </p>
688
- <h4 class="subsubheading" id="Extensibility"><span>Extensibility<a class="copiable-link" href="#Extensibility"> &para;</a></span></h4>
689
- <p>You should also consider how your API might be extended in the future in a
690
- backward-compatible way. If you are adding a new struct <code class="code">AVFoo</code>, the
691
- standard approach is requiring the caller to always allocate it through a
692
- constructor function, typically named <code class="code">av_foo_alloc()</code>. This way new fields
693
- may be added to the end of the struct without breaking ABI compatibility.
694
- Typically you will also want a destructor - <code class="code">av_foo_free(AVFoo**)</code> that
695
- frees the indirectly supplied object (and its contents, if applicable) and
696
- writes <code class="code">NULL</code> to the supplied pointer, thus eliminating the potential
697
- dangling pointer in the caller&rsquo;s memory.
698
- </p>
699
- <p>If you are adding new functions, consider whether it might be desirable to tweak
700
- their behavior in the future - you may want to add a flags argument, even though
701
- it would be unused initially.
702
- </p>
703
- <h4 class="subsubheading" id="Documentation"><span>Documentation<a class="copiable-link" href="#Documentation"> &para;</a></span></h4>
704
- <p>All new APIs must be documented as Doxygen-formatted comments above the
705
- identifiers you add to the public headers. You should also briefly mention the
706
- change in <samp class="file">doc/APIchanges</samp>.
707
- </p>
708
- <h4 class="subsubheading" id="Bump-the-version"><span>Bump the version<a class="copiable-link" href="#Bump-the-version"> &para;</a></span></h4>
709
- <p>Backward-incompatible API or ABI changes require incrementing (bumping) the
710
- major version number, as described in <a class="ref" href="#Major-version-bumps">Major version bumps</a>. Major
711
- bumps are significant events that happen on a schedule - so if your change
712
- strictly requires one you should add it under <code class="code">#if</code> preprocesor guards that
713
- disable it until the next major bump happens.
714
- </p>
715
- <p>New APIs that can be added without breaking API or ABI compatibility require
716
- bumping the minor version number.
717
- </p>
718
- <p>Incrementing the third (micro) version component means a noteworthy binary
719
- compatible change (e.g. encoder bug fix that matters for the decoder). The third
720
- component always starts at 100 to distinguish FFmpeg from Libav.
721
- </p>
722
- <a class="anchor" id="Removing-interfaces"></a></div>
723
- <div class="subsection-level-extent" id="Removing-interfaces-1">
724
- <h4 class="subsection"><span>3.4.2 Removing interfaces<a class="copiable-link" href="#Removing-interfaces-1"> &para;</a></span></h4>
725
- <p>Due to abovementioned compatibility guarantees, removing APIs is an involved
726
- process that should only be undertaken with good reason. Typically a deficient,
727
- restrictive, or otherwise inadequate API is replaced by a superior one, though
728
- it does at times happen that we remove an API without any replacement (e.g. when
729
- the feature it provides is deemed not worth the maintenance effort, out of scope
730
- of the project, fundamentally flawed, etc.).
731
- </p>
732
- <p>The removal has two steps - first the API is deprecated and scheduled for
733
- removal, but remains present and functional. The second step is actually
734
- removing the API - this is described in <a class="ref" href="#Major-version-bumps">Major version bumps</a>.
735
- </p>
736
- <p>To deprecate an API you should signal to our users that they should stop using
737
- it. E.g. if you intend to remove struct members or functions, you should mark
738
- them with <code class="code">attribute_deprecated</code>. When this cannot be done, it may be
739
- possible to detect the use of the deprecated API at runtime and print a warning
740
- (though take care not to print it too often). You should also document the
741
- deprecation (and the replacement, if applicable) in the relevant Doxygen
742
- documentation block.
743
- </p>
744
- <p>Finally, you should define a deprecation guard along the lines of
745
- <code class="code">#define FF_API_&lt;FOO&gt; (LIBAVBAR_VERSION_MAJOR &lt; XX)</code> (where XX is the major
746
- version in which the API will be removed) in <samp class="file">libavbar/version_major.h</samp>
747
- (<samp class="file">version.h</samp> in case of <code class="code">libavutil</code>). Then wrap all uses of the
748
- deprecated API in <code class="code">#if FF_API_&lt;FOO&gt; .... #endif</code>, so that the code will
749
- automatically get disabled once the major version reaches XX. You can also use
750
- <code class="code">FF_DISABLE_DEPRECATION_WARNINGS</code> and <code class="code">FF_ENABLE_DEPRECATION_WARNINGS</code>
751
- to suppress compiler deprecation warnings inside these guards. You should test
752
- that the code compiles and works with the guard macro evaluating to both true
753
- and false.
754
- </p>
755
- <a class="anchor" id="Major-version-bumps"></a></div>
756
- <div class="subsection-level-extent" id="Major-version-bumps-1">
757
- <h4 class="subsection"><span>3.4.3 Major version bumps<a class="copiable-link" href="#Major-version-bumps-1"> &para;</a></span></h4>
758
- <p>A major version bump signifies an API and/or ABI compatibility break. To reduce
759
- the negative effects on our callers, who are required to adapt their code,
760
- backward-incompatible changes during a major bump should be limited to:
761
- </p><ul class="itemize mark-bullet">
762
- <li>Removing previously deprecated APIs.
763
-
764
- </li><li>Performing ABI- but not API-breaking changes, like reordering struct contents.
765
- </li></ul>
766
-
767
- </div>
768
- </div>
769
- <div class="section-level-extent" id="Documentation_002fOther">
770
- <h3 class="section"><span>3.5 Documentation/Other<a class="copiable-link" href="#Documentation_002fOther"> &para;</a></span></h3>
771
- <h4 class="subheading" id="Subscribe-to-the-ffmpeg_002ddevel-mailing-list_002e"><span>Subscribe to the ffmpeg-devel mailing list.<a class="copiable-link" href="#Subscribe-to-the-ffmpeg_002ddevel-mailing-list_002e"> &para;</a></span></h4>
772
- <p>It is important to be subscribed to the
773
- <a class="uref" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel">ffmpeg-devel</a>
774
- mailing list. Almost any non-trivial patch is to be sent there for review.
775
- Other developers may have comments about your contribution. We expect you see
776
- those comments, and to improve it if requested. (N.B. Experienced committers
777
- have other channels, and may sometimes skip review for trivial fixes.) Also,
778
- discussion here about bug fixes and FFmpeg improvements by other developers may
779
- be helpful information for you. Finally, by being a list subscriber, your
780
- contribution will be posted immediately to the list, without the moderation
781
- hold which messages from non-subscribers experience.
782
- </p>
783
- <p>However, it is more important to the project that we receive your patch than
784
- that you be subscribed to the ffmpeg-devel list. If you have a patch, and don&rsquo;t
785
- want to subscribe and discuss the patch, then please do send it to the list
786
- anyway.
787
- </p>
788
- <h4 class="subheading" id="Subscribe-to-the-ffmpeg_002dcvslog-mailing-list_002e"><span>Subscribe to the ffmpeg-cvslog mailing list.<a class="copiable-link" href="#Subscribe-to-the-ffmpeg_002dcvslog-mailing-list_002e"> &para;</a></span></h4>
789
- <p>Diffs of all commits are sent to the
790
- <a class="uref" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-cvslog">ffmpeg-cvslog</a>
791
- mailing list. Some developers read this list to review all code base changes
792
- from all sources. Subscribing to this list is not mandatory.
793
- </p>
794
- <h4 class="subheading" id="Keep-the-documentation-up-to-date_002e"><span>Keep the documentation up to date.<a class="copiable-link" href="#Keep-the-documentation-up-to-date_002e"> &para;</a></span></h4>
795
- <p>Update the documentation if you change behavior or add features. If you are
796
- unsure how best to do this, send a patch to ffmpeg-devel, the documentation
797
- maintainer(s) will review and commit your stuff.
798
- </p>
799
- <h4 class="subheading" id="Important-discussions-should-be-accessible-to-all_002e"><span>Important discussions should be accessible to all.<a class="copiable-link" href="#Important-discussions-should-be-accessible-to-all_002e"> &para;</a></span></h4>
800
- <p>Try to keep important discussions and requests (also) on the public
801
- developer mailing list, so that all developers can benefit from them.
802
- </p>
803
- <h4 class="subheading" id="Check-your-entries-in-MAINTAINERS_002e"><span>Check your entries in MAINTAINERS.<a class="copiable-link" href="#Check-your-entries-in-MAINTAINERS_002e"> &para;</a></span></h4>
804
- <p>Make sure that no parts of the codebase that you maintain are missing from the
805
- <samp class="file">MAINTAINERS</samp> file. If something that you want to maintain is missing add it with
806
- your name after it.
807
- If at some point you no longer want to maintain some code, then please help in
808
- finding a new maintainer and also don&rsquo;t forget to update the <samp class="file">MAINTAINERS</samp> file.
809
- </p>
810
- <p>We think our rules are not too hard. If you have comments, contact us.
811
- </p>
812
- <a class="anchor" id="Submitting-patches"></a></div>
813
- </div>
814
- <div class="chapter-level-extent" id="Submitting-patches-1">
815
- <h2 class="chapter"><span>4 Submitting patches<a class="copiable-link" href="#Submitting-patches-1"> &para;</a></span></h2>
816
-
817
- <p>First, read the <a class="ref" href="#Coding-Rules">Coding Rules</a> above if you did not yet, in particular
818
- the rules regarding patch submission.
819
- </p>
820
- <p>When you submit your patch, please use <code class="code">git format-patch</code> or
821
- <code class="code">git send-email</code>. We cannot read other diffs :-).
822
- </p>
823
- <p>Also please do not submit a patch which contains several unrelated changes.
824
- Split it into separate, self-contained pieces. This does not mean splitting
825
- file by file. Instead, make the patch as small as possible while still
826
- keeping it as a logical unit that contains an individual change, even
827
- if it spans multiple files. This makes reviewing your patches much easier
828
- for us and greatly increases your chances of getting your patch applied.
829
- </p>
830
- <p>Use the patcheck tool of FFmpeg to check your patch.
831
- The tool is located in the tools directory.
832
- </p>
833
- <p>Run the <a class="ref" href="#Regression-tests">Regression tests</a> before submitting a patch in order to verify
834
- it does not cause unexpected problems.
835
- </p>
836
- <p>It also helps quite a bit if you tell us what the patch does (for example
837
- &rsquo;replaces lrint by lrintf&rsquo;), and why (for example &rsquo;*BSD isn&rsquo;t C99 compliant
838
- and has no lrint()&rsquo;)
839
- </p>
840
- <p>Also please if you send several patches, send each patch as a separate mail,
841
- do not attach several unrelated patches to the same mail.
842
- </p>
843
- <p>Patches should be posted to the
844
- <a class="uref" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel">ffmpeg-devel</a>
845
- mailing list. Use <code class="code">git send-email</code> when possible since it will properly
846
- send patches without requiring extra care. If you cannot, then send patches
847
- as base64-encoded attachments, so your patch is not trashed during
848
- transmission. Also ensure the correct mime type is used
849
- (text/x-diff or text/x-patch or at least text/plain) and that only one
850
- patch is inline or attached per mail.
851
- You can check <a class="url" href="https://patchwork.ffmpeg.org">https://patchwork.ffmpeg.org</a>, if your patch does not show up, its mime type
852
- likely was wrong.
853
- </p>
854
- <h4 class="subheading" id="How-to-setup-git-send_002demail_003f"><span>How to setup git send-email?<a class="copiable-link" href="#How-to-setup-git-send_002demail_003f"> &para;</a></span></h4>
855
-
856
- <p>Please see <a class="url" href="https://git-send-email.io/">https://git-send-email.io/</a>.
857
- For gmail additionally see <a class="url" href="https://shallowsky.com/blog/tech/email/gmail-app-passwds.html">https://shallowsky.com/blog/tech/email/gmail-app-passwds.html</a>.
858
- </p>
859
- <h4 class="subheading" id="Sending-patches-from-email-clients"><span>Sending patches from email clients<a class="copiable-link" href="#Sending-patches-from-email-clients"> &para;</a></span></h4>
860
- <p>Using <code class="code">git send-email</code> might not be desirable for everyone. The
861
- following trick allows to send patches via email clients in a safe
862
- way. It has been tested with Outlook and Thunderbird (with X-Unsent
863
- extension) and might work with other applications.
864
- </p>
865
- <p>Create your patch like this:
866
- </p>
867
- <pre class="verbatim">git format-patch -s -o &quot;outputfolder&quot; --add-header &quot;X-Unsent: 1&quot; --suffix .eml --to [email protected] -1 1a2b3c4d
868
- </pre>
869
- <p>Now you&rsquo;ll just need to open the eml file with the email application
870
- and execute &rsquo;Send&rsquo;.
871
- </p>
872
- <h4 class="subheading" id="Reviews"><span>Reviews<a class="copiable-link" href="#Reviews"> &para;</a></span></h4>
873
- <p>Your patch will be reviewed on the mailing list. You will likely be asked
874
- to make some changes and are expected to send in an improved version that
875
- incorporates the requests from the review. This process may go through
876
- several iterations. Once your patch is deemed good enough, some developer
877
- will pick it up and commit it to the official FFmpeg tree.
878
- </p>
879
- <p>Give us a few days to react. But if some time passes without reaction,
880
- send a reminder by email. Your patch should eventually be dealt with.
881
- </p>
882
-
883
- </div>
884
- <div class="chapter-level-extent" id="New-codecs-or-formats-checklist">
885
- <h2 class="chapter"><span>5 New codecs or formats checklist<a class="copiable-link" href="#New-codecs-or-formats-checklist"> &para;</a></span></h2>
886
-
887
- <ol class="enumerate">
888
- <li> Did you use av_cold for codec initialization and close functions?
889
-
890
- </li><li> Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or
891
- AVInputFormat/AVOutputFormat struct?
892
-
893
- </li><li> Did you bump the minor version number (and reset the micro version
894
- number) in <samp class="file">libavcodec/version.h</samp> or <samp class="file">libavformat/version.h</samp>?
895
-
896
- </li><li> Did you register it in <samp class="file">allcodecs.c</samp> or <samp class="file">allformats.c</samp>?
897
-
898
- </li><li> Did you add the AVCodecID to <samp class="file">codec_id.h</samp>?
899
- When adding new codec IDs, also add an entry to the codec descriptor
900
- list in <samp class="file">libavcodec/codec_desc.c</samp>.
901
-
902
- </li><li> If it has a FourCC, did you add it to <samp class="file">libavformat/riff.c</samp>,
903
- even if it is only a decoder?
904
-
905
- </li><li> Did you add a rule to compile the appropriate files in the Makefile?
906
- Remember to do this even if you&rsquo;re just adding a format to a file that is
907
- already being compiled by some other rule, like a raw demuxer.
908
-
909
- </li><li> Did you add an entry to the table of supported formats or codecs in
910
- <samp class="file">doc/general_contents.texi</samp>?
911
-
912
- </li><li> Did you add an entry in the Changelog?
913
-
914
- </li><li> If it depends on a parser or a library, did you add that dependency in
915
- configure?
916
-
917
- </li><li> Did you <code class="code">git add</code> the appropriate files before committing?
918
-
919
- </li><li> Did you make sure it compiles standalone, i.e. with
920
- <code class="code">configure --disable-everything --enable-decoder=foo</code>
921
- (or <code class="code">--enable-demuxer</code> or whatever your component is)?
922
- </li></ol>
923
-
924
-
925
- </div>
926
- <div class="chapter-level-extent" id="Patch-submission-checklist">
927
- <h2 class="chapter"><span>6 Patch submission checklist<a class="copiable-link" href="#Patch-submission-checklist"> &para;</a></span></h2>
928
-
929
- <ol class="enumerate">
930
- <li> Does <code class="code">make fate</code> pass with the patch applied?
931
-
932
- </li><li> Was the patch generated with git format-patch or send-email?
933
-
934
- </li><li> Did you sign-off your patch? (<code class="code">git commit -s</code>)
935
- See <a class="uref" href="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/process/submitting-patches.rst">Sign your work</a> for the meaning
936
- of <em class="dfn">sign-off</em>.
937
-
938
- </li><li> Did you provide a clear git commit log message?
939
-
940
- </li><li> Is the patch against latest FFmpeg git master branch?
941
-
942
- </li><li> Are you subscribed to ffmpeg-devel?
943
- (the list is subscribers only due to spam)
944
-
945
- </li><li> Have you checked that the changes are minimal, so that the same cannot be
946
- achieved with a smaller patch and/or simpler final code?
947
-
948
- </li><li> If the change is to speed critical code, did you benchmark it?
949
-
950
- </li><li> If you did any benchmarks, did you provide them in the mail?
951
-
952
- </li><li> Have you checked that the patch does not introduce buffer overflows or
953
- other security issues?
954
-
955
- </li><li> Did you test your decoder or demuxer against damaged data? If no, see
956
- tools/trasher, the noise bitstream filter, and
957
- <a class="uref" href="http://caca.zoy.org/wiki/zzuf">zzuf</a>. Your decoder or demuxer
958
- should not crash, end in a (near) infinite loop, or allocate ridiculous
959
- amounts of memory when fed damaged data.
960
-
961
- </li><li> Did you test your decoder or demuxer against sample files?
962
- Samples may be obtained at <a class="url" href="https://samples.ffmpeg.org">https://samples.ffmpeg.org</a>.
963
-
964
- </li><li> Does the patch not mix functional and cosmetic changes?
965
-
966
- </li><li> Did you add tabs or trailing whitespace to the code? Both are forbidden.
967
-
968
- </li><li> Is the patch attached to the email you send?
969
-
970
- </li><li> Is the mime type of the patch correct? It should be text/x-diff or
971
- text/x-patch or at least text/plain and not application/octet-stream.
972
-
973
- </li><li> If the patch fixes a bug, did you provide a verbose analysis of the bug?
974
-
975
- </li><li> If the patch fixes a bug, did you provide enough information, including
976
- a sample, so the bug can be reproduced and the fix can be verified?
977
- Note please do not attach samples &gt;100k to mails but rather provide a
978
- URL, you can upload to <a class="url" href="https://streams.videolan.org/upload/">https://streams.videolan.org/upload/</a>.
979
-
980
- </li><li> Did you provide a verbose summary about what the patch does change?
981
-
982
- </li><li> Did you provide a verbose explanation why it changes things like it does?
983
-
984
- </li><li> Did you provide a verbose summary of the user visible advantages and
985
- disadvantages if the patch is applied?
986
-
987
- </li><li> Did you provide an example so we can verify the new feature added by the
988
- patch easily?
989
-
990
- </li><li> If you added a new file, did you insert a license header? It should be
991
- taken from FFmpeg, not randomly copied and pasted from somewhere else.
992
-
993
- </li><li> You should maintain alphabetical order in alphabetically ordered lists as
994
- long as doing so does not break API/ABI compatibility.
995
-
996
- </li><li> Lines with similar content should be aligned vertically when doing so
997
- improves readability.
998
-
999
- </li><li> Consider adding a regression test for your code. All new modules
1000
- should be covered by tests. That includes demuxers, muxers, decoders, encoders
1001
- filters, bitstream filters, parsers. If its not possible to do that, add
1002
- an explanation why to your patchset, its ok to not test if theres a reason.
1003
-
1004
- </li><li> If you added NASM code please check that things still work with &ndash;disable-x86asm.
1005
-
1006
- </li><li> Test your code with valgrind and or Address Sanitizer to ensure it&rsquo;s free
1007
- of leaks, out of array accesses, etc.
1008
- </li></ol>
1009
-
1010
- </div>
1011
- <div class="chapter-level-extent" id="Patch-review-process">
1012
- <h2 class="chapter"><span>7 Patch review process<a class="copiable-link" href="#Patch-review-process"> &para;</a></span></h2>
1013
-
1014
- <p>All patches posted to ffmpeg-devel will be reviewed, unless they contain a
1015
- clear note that the patch is not for the git master branch.
1016
- Reviews and comments will be posted as replies to the patch on the
1017
- mailing list. The patch submitter then has to take care of every comment,
1018
- that can be by resubmitting a changed patch or by discussion. Resubmitted
1019
- patches will themselves be reviewed like any other patch. If at some point
1020
- a patch passes review with no comments then it is approved, that can for
1021
- simple and small patches happen immediately while large patches will generally
1022
- have to be changed and reviewed many times before they are approved.
1023
- After a patch is approved it will be committed to the repository.
1024
- </p>
1025
- <p>We will review all submitted patches, but sometimes we are quite busy so
1026
- especially for large patches this can take several weeks.
1027
- </p>
1028
- <p>If you feel that the review process is too slow and you are willing to try to
1029
- take over maintainership of the area of code you change then just clone
1030
- git master and maintain the area of code there. We will merge each area from
1031
- where its best maintained.
1032
- </p>
1033
- <p>When resubmitting patches, please do not make any significant changes
1034
- not related to the comments received during review. Such patches will
1035
- be rejected. Instead, submit significant changes or new features as
1036
- separate patches.
1037
- </p>
1038
- <p>Everyone is welcome to review patches. Also if you are waiting for your patch
1039
- to be reviewed, please consider helping to review other patches, that is a great
1040
- way to get everyone&rsquo;s patches reviewed sooner.
1041
- </p>
1042
- <a class="anchor" id="Regression-tests"></a></div>
1043
- <div class="chapter-level-extent" id="Regression-tests-1">
1044
- <h2 class="chapter"><span>8 Regression tests<a class="copiable-link" href="#Regression-tests-1"> &para;</a></span></h2>
1045
-
1046
- <p>Before submitting a patch (or committing to the repository), you should at least
1047
- test that you did not break anything.
1048
- </p>
1049
- <p>Running &rsquo;make fate&rsquo; accomplishes this, please see <a class="url" href="fate.html">fate.html</a> for details.
1050
- </p>
1051
- <p>[Of course, some patches may change the results of the regression tests. In
1052
- this case, the reference results of the regression tests shall be modified
1053
- accordingly].
1054
- </p>
1055
- <ul class="mini-toc">
1056
- <li><a href="#Adding-files-to-the-fate_002dsuite-dataset" accesskey="1">Adding files to the fate-suite dataset</a></li>
1057
- <li><a href="#Visualizing-Test-Coverage" accesskey="2">Visualizing Test Coverage</a></li>
1058
- <li><a href="#Using-Valgrind" accesskey="3">Using Valgrind</a></li>
1059
- </ul>
1060
- <div class="section-level-extent" id="Adding-files-to-the-fate_002dsuite-dataset">
1061
- <h3 class="section"><span>8.1 Adding files to the fate-suite dataset<a class="copiable-link" href="#Adding-files-to-the-fate_002dsuite-dataset"> &para;</a></span></h3>
1062
-
1063
- <p>If you need a sample uploaded send a mail to samples-request.
1064
- </p>
1065
- <p>When there is no muxer or encoder available to generate test media for a
1066
- specific test then the media has to be included in the fate-suite.
1067
- First please make sure that the sample file is as small as possible to test the
1068
- respective decoder or demuxer sufficiently. Large files increase network
1069
- bandwidth and disk space requirements.
1070
- Once you have a working fate test and fate sample, provide in the commit
1071
- message or introductory message for the patch series that you post to
1072
- the ffmpeg-devel mailing list, a direct link to download the sample media.
1073
- </p>
1074
- </div>
1075
- <div class="section-level-extent" id="Visualizing-Test-Coverage">
1076
- <h3 class="section"><span>8.2 Visualizing Test Coverage<a class="copiable-link" href="#Visualizing-Test-Coverage"> &para;</a></span></h3>
1077
-
1078
- <p>The FFmpeg build system allows visualizing the test coverage in an easy
1079
- manner with the coverage tools <code class="code">gcov</code>/<code class="code">lcov</code>. This involves
1080
- the following steps:
1081
- </p>
1082
- <ol class="enumerate">
1083
- <li> Configure to compile with instrumentation enabled:
1084
- <code class="code">configure --toolchain=gcov</code>.
1085
-
1086
- </li><li> Run your test case, either manually or via FATE. This can be either
1087
- the full FATE regression suite, or any arbitrary invocation of any
1088
- front-end tool provided by FFmpeg, in any combination.
1089
-
1090
- </li><li> Run <code class="code">make lcov</code> to generate coverage data in HTML format.
1091
-
1092
- </li><li> View <code class="code">lcov/index.html</code> in your preferred HTML viewer.
1093
- </li></ol>
1094
-
1095
- <p>You can use the command <code class="code">make lcov-reset</code> to reset the coverage
1096
- measurements. You will need to rerun <code class="code">make lcov</code> after running a
1097
- new test.
1098
- </p>
1099
- </div>
1100
- <div class="section-level-extent" id="Using-Valgrind">
1101
- <h3 class="section"><span>8.3 Using Valgrind<a class="copiable-link" href="#Using-Valgrind"> &para;</a></span></h3>
1102
-
1103
- <p>The configure script provides a shortcut for using valgrind to spot bugs
1104
- related to memory handling. Just add the option
1105
- <code class="code">--toolchain=valgrind-memcheck</code> or <code class="code">--toolchain=valgrind-massif</code>
1106
- to your configure line, and reasonable defaults will be set for running
1107
- FATE under the supervision of either the <strong class="strong">memcheck</strong> or the
1108
- <strong class="strong">massif</strong> tool of the valgrind suite.
1109
- </p>
1110
- <p>In case you need finer control over how valgrind is invoked, use the
1111
- <code class="code">--target-exec='valgrind &lt;your_custom_valgrind_options&gt;</code> option in
1112
- your configure line instead.
1113
- </p>
1114
- <a class="anchor" id="Maintenance"></a></div>
1115
- </div>
1116
- <div class="chapter-level-extent" id="Maintenance-process">
1117
- <h2 class="chapter"><span>9 Maintenance process<a class="copiable-link" href="#Maintenance-process"> &para;</a></span></h2>
1118
-
1119
- <a class="anchor" id="MAINTAINERS"></a><ul class="mini-toc">
1120
- <li><a href="#MAINTAINERS-1" accesskey="1">MAINTAINERS</a></li>
1121
- <li><a href="#Becoming-a-maintainer-1" accesskey="2">Becoming a maintainer</a></li>
1122
- </ul>
1123
- <div class="section-level-extent" id="MAINTAINERS-1">
1124
- <h3 class="section"><span>9.1 MAINTAINERS<a class="copiable-link" href="#MAINTAINERS-1"> &para;</a></span></h3>
1125
-
1126
- <p>The developers maintaining each part of the codebase are listed in <samp class="file">MAINTAINERS</samp>.
1127
- Being listed in <samp class="file">MAINTAINERS</samp>, gives one the right to have git write access to
1128
- the specific repository.
1129
- </p>
1130
- <a class="anchor" id="Becoming-a-maintainer"></a></div>
1131
- <div class="section-level-extent" id="Becoming-a-maintainer-1">
1132
- <h3 class="section"><span>9.2 Becoming a maintainer<a class="copiable-link" href="#Becoming-a-maintainer-1"> &para;</a></span></h3>
1133
-
1134
- <p>People add themselves to <samp class="file">MAINTAINERS</samp> by sending a patch like any other code
1135
- change. These get reviewed by the community like any other patch. It is expected
1136
- that, if someone has an objection to a new maintainer, she is willing to object
1137
- in public with her full name and is willing to take over maintainership for the area.
1138
- </p>
1139
-
1140
- <a class="anchor" id="Release-process"></a></div>
1141
- </div>
1142
- <div class="chapter-level-extent" id="Release-process-1">
1143
- <h2 class="chapter"><span>10 Release process<a class="copiable-link" href="#Release-process-1"> &para;</a></span></h2>
1144
-
1145
- <p>FFmpeg maintains a set of <strong class="strong">release branches</strong>, which are the
1146
- recommended deliverable for system integrators and distributors (such as
1147
- Linux distributions, etc.). At regular times, a <strong class="strong">release
1148
- manager</strong> prepares, tests and publishes tarballs on the
1149
- <a class="url" href="https://ffmpeg.org">https://ffmpeg.org</a> website.
1150
- </p>
1151
- <p>There are two kinds of releases:
1152
- </p>
1153
- <ol class="enumerate">
1154
- <li> <strong class="strong">Major releases</strong> always include the latest and greatest
1155
- features and functionality.
1156
-
1157
- </li><li> <strong class="strong">Point releases</strong> are cut from <strong class="strong">release</strong> branches,
1158
- which are named <code class="code">release/X</code>, with <code class="code">X</code> being the release
1159
- version number.
1160
- </li></ol>
1161
-
1162
- <p>Note that we promise to our users that shared libraries from any FFmpeg
1163
- release never break programs that have been <strong class="strong">compiled</strong> against
1164
- previous versions of <strong class="strong">the same release series</strong> in any case!
1165
- </p>
1166
- <p>However, from time to time, we do make API changes that require adaptations
1167
- in applications. Such changes are only allowed in (new) major releases and
1168
- require further steps such as bumping library version numbers and/or
1169
- adjustments to the symbol versioning file. Please discuss such changes
1170
- on the <strong class="strong">ffmpeg-devel</strong> mailing list in time to allow forward planning.
1171
- </p>
1172
- <a class="anchor" id="Criteria-for-Point-Releases"></a><ul class="mini-toc">
1173
- <li><a href="#Criteria-for-Point-Releases-1" accesskey="1">Criteria for Point Releases</a></li>
1174
- <li><a href="#Release-Checklist" accesskey="2">Release Checklist</a></li>
1175
- </ul>
1176
- <div class="section-level-extent" id="Criteria-for-Point-Releases-1">
1177
- <h3 class="section"><span>10.1 Criteria for Point Releases<a class="copiable-link" href="#Criteria-for-Point-Releases-1"> &para;</a></span></h3>
1178
-
1179
- <p>Changes that match the following criteria are valid candidates for
1180
- inclusion into a point release:
1181
- </p>
1182
- <ol class="enumerate">
1183
- <li> Fixes a security issue, preferably identified by a <strong class="strong">CVE
1184
- number</strong> issued by <a class="url" href="http://cve.mitre.org/">http://cve.mitre.org/</a>.
1185
-
1186
- </li><li> Fixes a documented bug in <a class="url" href="https://trac.ffmpeg.org">https://trac.ffmpeg.org</a>.
1187
-
1188
- </li><li> Improves the included documentation.
1189
-
1190
- </li><li> Retains both source code and binary compatibility with previous
1191
- point releases of the same release branch.
1192
- </li></ol>
1193
-
1194
- <p>The order for checking the rules is (1 OR 2 OR 3) AND 4.
1195
- </p>
1196
-
1197
- </div>
1198
- <div class="section-level-extent" id="Release-Checklist">
1199
- <h3 class="section"><span>10.2 Release Checklist<a class="copiable-link" href="#Release-Checklist"> &para;</a></span></h3>
1200
-
1201
- <p>The release process involves the following steps:
1202
- </p>
1203
- <ol class="enumerate">
1204
- <li> Ensure that the <samp class="file">RELEASE</samp> file contains the version number for
1205
- the upcoming release.
1206
-
1207
- </li><li> Add the release at <a class="url" href="https://trac.ffmpeg.org/admin/ticket/versions">https://trac.ffmpeg.org/admin/ticket/versions</a>.
1208
-
1209
- </li><li> Announce the intent to do a release to the mailing list.
1210
-
1211
- </li><li> Make sure all relevant security fixes have been backported. See
1212
- <a class="url" href="https://ffmpeg.org/security.html">https://ffmpeg.org/security.html</a>.
1213
-
1214
- </li><li> Ensure that the FATE regression suite still passes in the release
1215
- branch on at least <strong class="strong">i386</strong> and <strong class="strong">amd64</strong>
1216
- (cf. <a class="ref" href="#Regression-tests">Regression tests</a>).
1217
-
1218
- </li><li> Prepare the release tarballs in <code class="code">bz2</code> and <code class="code">gz</code> formats, and
1219
- supplementing files that contain <code class="code">gpg</code> signatures
1220
-
1221
- </li><li> Publish the tarballs at <a class="url" href="https://ffmpeg.org/releases">https://ffmpeg.org/releases</a>. Create and
1222
- push an annotated tag in the form <code class="code">nX</code>, with <code class="code">X</code>
1223
- containing the version number.
1224
-
1225
- </li><li> Propose and send a patch to the <strong class="strong">ffmpeg-devel</strong> mailing list
1226
- with a news entry for the website.
1227
-
1228
- </li><li> Publish the news entry.
1229
-
1230
- </li><li> Send an announcement to the mailing list.
1231
- </li></ol>
1232
-
1233
- </div>
1234
- </div>
1235
- </div>
1236
- <p style="font-size: small;">
1237
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
1238
- </p>
1239
- </div>
1240
- </body>
1241
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/faq.html DELETED
@@ -1,938 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg FAQ
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg FAQ
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-General-Questions" href="#General-Questions">1 General Questions</a>
29
- <ul class="toc-numbered-mark">
30
- <li><a id="toc-Why-doesn_0027t-FFmpeg-support-feature-_005bxyz_005d_003f" href="#Why-doesn_0027t-FFmpeg-support-feature-_005bxyz_005d_003f">1.1 Why doesn&rsquo;t FFmpeg support feature [xyz]?</a></li>
31
- <li><a id="toc-FFmpeg-does-not-support-codec-XXX_002e-Can-you-include-a-Windows-DLL-loader-to-support-it_003f" href="#FFmpeg-does-not-support-codec-XXX_002e-Can-you-include-a-Windows-DLL-loader-to-support-it_003f">1.2 FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?</a></li>
32
- <li><a id="toc-I-cannot-read-this-file-although-this-format-seems-to-be-supported-by-ffmpeg_002e" href="#I-cannot-read-this-file-although-this-format-seems-to-be-supported-by-ffmpeg_002e">1.3 I cannot read this file although this format seems to be supported by ffmpeg.</a></li>
33
- <li><a id="toc-Which-codecs-are-supported-by-Windows_003f" href="#Which-codecs-are-supported-by-Windows_003f">1.4 Which codecs are supported by Windows?</a></li>
34
- </ul></li>
35
- <li><a id="toc-Compilation" href="#Compilation">2 Compilation</a>
36
- <ul class="toc-numbered-mark">
37
- <li><a id="toc-error_003a-can_0027t-find-a-register-in-class-_0027GENERAL_005fREGS_0027-while-reloading-_0027asm_0027" href="#error_003a-can_0027t-find-a-register-in-class-_0027GENERAL_005fREGS_0027-while-reloading-_0027asm_0027">2.1 <code class="code">error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'</code></a></li>
38
- <li><a id="toc-I-have-installed-this-library-with-my-distro_0027s-package-manager_002e-Why-does-configure-not-see-it_003f" href="#I-have-installed-this-library-with-my-distro_0027s-package-manager_002e-Why-does-configure-not-see-it_003f">2.2 I have installed this library with my distro&rsquo;s package manager. Why does <code class="command">configure</code> not see it?</a></li>
39
- <li><a id="toc-How-do-I-make-pkg_002dconfig-find-my-libraries_003f" href="#How-do-I-make-pkg_002dconfig-find-my-libraries_003f">2.3 How do I make <code class="command">pkg-config</code> find my libraries?</a></li>
40
- <li><a id="toc-How-do-I-use-pkg_002dconfig-when-cross_002dcompiling_003f" href="#How-do-I-use-pkg_002dconfig-when-cross_002dcompiling_003f">2.4 How do I use <code class="command">pkg-config</code> when cross-compiling?</a></li>
41
- </ul></li>
42
- <li><a id="toc-Usage" href="#Usage">3 Usage</a>
43
- <ul class="toc-numbered-mark">
44
- <li><a id="toc-ffmpeg-does-not-work_003b-what-is-wrong_003f" href="#ffmpeg-does-not-work_003b-what-is-wrong_003f">3.1 ffmpeg does not work; what is wrong?</a></li>
45
- <li><a id="toc-How-do-I-encode-single-pictures-into-movies_003f" href="#How-do-I-encode-single-pictures-into-movies_003f">3.2 How do I encode single pictures into movies?</a></li>
46
- <li><a id="toc-How-do-I-encode-movie-to-single-pictures_003f" href="#How-do-I-encode-movie-to-single-pictures_003f">3.3 How do I encode movie to single pictures?</a></li>
47
- <li><a id="toc-Why-do-I-see-a-slight-quality-degradation-with-multithreaded-MPEG_002a-encoding_003f" href="#Why-do-I-see-a-slight-quality-degradation-with-multithreaded-MPEG_002a-encoding_003f">3.4 Why do I see a slight quality degradation with multithreaded MPEG* encoding?</a></li>
48
- <li><a id="toc-How-can-I-read-from-the-standard-input-or-write-to-the-standard-output_003f" href="#How-can-I-read-from-the-standard-input-or-write-to-the-standard-output_003f">3.5 How can I read from the standard input or write to the standard output?</a></li>
49
- <li><a id="toc-_002df-jpeg-doesn_0027t-work_002e" href="#g_t_002df-jpeg-doesn_0027t-work_002e">3.6 -f jpeg doesn&rsquo;t work.</a></li>
50
- <li><a id="toc-Why-can-I-not-change-the-frame-rate_003f" href="#Why-can-I-not-change-the-frame-rate_003f">3.7 Why can I not change the frame rate?</a></li>
51
- <li><a id="toc-How-do-I-encode-Xvid-or-DivX-video-with-ffmpeg_003f" href="#How-do-I-encode-Xvid-or-DivX-video-with-ffmpeg_003f">3.8 How do I encode Xvid or DivX video with ffmpeg?</a></li>
52
- <li><a id="toc-Which-are-good-parameters-for-encoding-high-quality-MPEG_002d4_003f" href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d4_003f">3.9 Which are good parameters for encoding high quality MPEG-4?</a></li>
53
- <li><a id="toc-Which-are-good-parameters-for-encoding-high-quality-MPEG_002d1_002fMPEG_002d2_003f" href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d1_002fMPEG_002d2_003f">3.10 Which are good parameters for encoding high quality MPEG-1/MPEG-2?</a></li>
54
- <li><a id="toc-Interlaced-video-looks-very-bad-when-encoded-with-ffmpeg_002c-what-is-wrong_003f" href="#Interlaced-video-looks-very-bad-when-encoded-with-ffmpeg_002c-what-is-wrong_003f">3.11 Interlaced video looks very bad when encoded with ffmpeg, what is wrong?</a></li>
55
- <li><a id="toc-How-can-I-read-DirectShow-files_003f" href="#How-can-I-read-DirectShow-files_003f">3.12 How can I read DirectShow files?</a></li>
56
- <li><a id="toc-How-can-I-join-video-files_003f" href="#How-can-I-join-video-files_003f">3.13 How can I join video files?</a></li>
57
- <li><a id="toc-How-can-I-concatenate-video-files_003f" href="#How-can-I-concatenate-video-files_003f">3.14 How can I concatenate video files?</a>
58
- <ul class="toc-numbered-mark">
59
- <li><a id="toc-Concatenating-using-the-concat-filter" href="#Concatenating-using-the-concat-filter">3.14.1 Concatenating using the concat <em class="emph">filter</em></a></li>
60
- <li><a id="toc-Concatenating-using-the-concat-demuxer" href="#Concatenating-using-the-concat-demuxer">3.14.2 Concatenating using the concat <em class="emph">demuxer</em></a></li>
61
- <li><a id="toc-Concatenating-using-the-concat-protocol-_0028file-level_0029" href="#Concatenating-using-the-concat-protocol-_0028file-level_0029">3.14.3 Concatenating using the concat <em class="emph">protocol</em> (file level)</a></li>
62
- <li><a id="toc-Concatenating-using-raw-audio-and-video" href="#Concatenating-using-raw-audio-and-video">3.14.4 Concatenating using raw audio and video</a></li>
63
- </ul></li>
64
- <li><a id="toc-Using-_002df-lavfi_002c-audio-becomes-mono-for-no-apparent-reason_002e" href="#Using-_002df-lavfi_002c-audio-becomes-mono-for-no-apparent-reason_002e">3.15 Using <samp class="option">-f lavfi</samp>, audio becomes mono for no apparent reason.</a></li>
65
- <li><a id="toc-Why-does-FFmpeg-not-see-the-subtitles-in-my-VOB-file_003f" href="#Why-does-FFmpeg-not-see-the-subtitles-in-my-VOB-file_003f">3.16 Why does FFmpeg not see the subtitles in my VOB file?</a></li>
66
- <li><a id="toc-Why-was-the-ffmpeg-_002dsameq-option-removed_003f-What-to-use-instead_003f" href="#Why-was-the-ffmpeg-_002dsameq-option-removed_003f-What-to-use-instead_003f">3.17 Why was the <code class="command">ffmpeg</code> <samp class="option">-sameq</samp> option removed? What to use instead?</a></li>
67
- <li><a id="toc-I-have-a-stretched-video_002c-why-does-scaling-not-fix-it_003f" href="#I-have-a-stretched-video_002c-why-does-scaling-not-fix-it_003f">3.18 I have a stretched video, why does scaling not fix it?</a></li>
68
- <li><a id="toc-How-do-I-run-ffmpeg-as-a-background-task_003f" href="#How-do-I-run-ffmpeg-as-a-background-task_003f">3.19 How do I run ffmpeg as a background task?</a></li>
69
- <li><a id="toc-How-do-I-prevent-ffmpeg-from-suspending-with-a-message-like-suspended-_0028tty-output_0029_003f" href="#How-do-I-prevent-ffmpeg-from-suspending-with-a-message-like-suspended-_0028tty-output_0029_003f">3.20 How do I prevent ffmpeg from suspending with a message like <em class="emph">suspended (tty output)</em>?</a></li>
70
- </ul></li>
71
- <li><a id="toc-Development" href="#Development">4 Development</a>
72
- <ul class="toc-numbered-mark">
73
- <li><a id="toc-Are-there-examples-illustrating-how-to-use-the-FFmpeg-libraries_002c-particularly-libavcodec-and-libavformat_003f" href="#Are-there-examples-illustrating-how-to-use-the-FFmpeg-libraries_002c-particularly-libavcodec-and-libavformat_003f">4.1 Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?</a></li>
74
- <li><a id="toc-Can-you-support-my-C-compiler-XXX_003f" href="#Can-you-support-my-C-compiler-XXX_003f">4.2 Can you support my C compiler XXX?</a></li>
75
- <li><a id="toc-Is-Microsoft-Visual-C_002b_002b-supported_003f" href="#Is-Microsoft-Visual-C_002b_002b-supported_003f">4.3 Is Microsoft Visual C++ supported?</a></li>
76
- <li><a id="toc-Can-you-add-automake_002c-libtool-or-autoconf-support_003f" href="#Can-you-add-automake_002c-libtool-or-autoconf-support_003f">4.4 Can you add automake, libtool or autoconf support?</a></li>
77
- <li><a id="toc-Why-not-rewrite-FFmpeg-in-object_002doriented-C_002b_002b_003f" href="#Why-not-rewrite-FFmpeg-in-object_002doriented-C_002b_002b_003f">4.5 Why not rewrite FFmpeg in object-oriented C++?</a></li>
78
- <li><a id="toc-Why-are-the-ffmpeg-programs-devoid-of-debugging-symbols_003f" href="#Why-are-the-ffmpeg-programs-devoid-of-debugging-symbols_003f">4.6 Why are the ffmpeg programs devoid of debugging symbols?</a></li>
79
- <li><a id="toc-I-do-not-like-the-LGPL_002c-can-I-contribute-code-under-the-GPL-instead_003f" href="#I-do-not-like-the-LGPL_002c-can-I-contribute-code-under-the-GPL-instead_003f">4.7 I do not like the LGPL, can I contribute code under the GPL instead?</a></li>
80
- <li><a id="toc-I_0027m-using-FFmpeg-from-within-my-C-application-but-the-linker-complains-about-missing-symbols-from-the-libraries-themselves_002e" href="#I_0027m-using-FFmpeg-from-within-my-C-application-but-the-linker-complains-about-missing-symbols-from-the-libraries-themselves_002e">4.8 I&rsquo;m using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.</a></li>
81
- <li><a id="toc-I_0027m-using-FFmpeg-from-within-my-C_002b_002b-application-but-the-linker-complains-about-missing-symbols-which-seem-to-be-available_002e" href="#I_0027m-using-FFmpeg-from-within-my-C_002b_002b-application-but-the-linker-complains-about-missing-symbols-which-seem-to-be-available_002e">4.9 I&rsquo;m using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.</a></li>
82
- <li><a id="toc-I_0027m-using-libavutil-from-within-my-C_002b_002b-application-but-the-compiler-complains-about-_0027UINT64_005fC_0027-was-not-declared-in-this-scope" href="#I_0027m-using-libavutil-from-within-my-C_002b_002b-application-but-the-compiler-complains-about-_0027UINT64_005fC_0027-was-not-declared-in-this-scope">4.10 I&rsquo;m using libavutil from within my C++ application but the compiler complains about &rsquo;UINT64_C&rsquo; was not declared in this scope</a></li>
83
- <li><a id="toc-I-have-a-file-in-memory-_002f-a-API-different-from-_002aopen_002f_002aread_002f-libc-how-do-I-use-it-with-libavformat_003f" href="#I-have-a-file-in-memory-_002f-a-API-different-from-_002aopen_002f_002aread_002f-libc-how-do-I-use-it-with-libavformat_003f">4.11 I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?</a></li>
84
- <li><a id="toc-Where-is-the-documentation-about-ffv1_002c-msmpeg4_002c-asv1_002c-4xm_003f" href="#Where-is-the-documentation-about-ffv1_002c-msmpeg4_002c-asv1_002c-4xm_003f">4.12 Where is the documentation about ffv1, msmpeg4, asv1, 4xm?</a></li>
85
- <li><a id="toc-How-do-I-feed-H_002e263_002dRTP-_0028and-other-codecs-in-RTP_0029-to-libavcodec_003f" href="#How-do-I-feed-H_002e263_002dRTP-_0028and-other-codecs-in-RTP_0029-to-libavcodec_003f">4.13 How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?</a></li>
86
- <li><a id="toc-AVStream_002er_005fframe_005frate-is-wrong_002c-it-is-much-larger-than-the-frame-rate_002e" href="#AVStream_002er_005fframe_005frate-is-wrong_002c-it-is-much-larger-than-the-frame-rate_002e">4.14 AVStream.r_frame_rate is wrong, it is much larger than the frame rate.</a></li>
87
- <li><a id="toc-Why-is-make-fate-not-running-all-tests_003f" href="#Why-is-make-fate-not-running-all-tests_003f">4.15 Why is <code class="code">make fate</code> not running all tests?</a></li>
88
- <li><a id="toc-Why-is-make-fate-not-finding-the-samples_003f" href="#Why-is-make-fate-not-finding-the-samples_003f">4.16 Why is <code class="code">make fate</code> not finding the samples?</a></li>
89
- </ul></li>
90
- </ul>
91
- </div>
92
- </div>
93
-
94
- <ul class="mini-toc">
95
- <li><a href="#General-Questions" accesskey="1">General Questions</a></li>
96
- <li><a href="#Compilation" accesskey="2">Compilation</a></li>
97
- <li><a href="#Usage" accesskey="3">Usage</a></li>
98
- <li><a href="#Development" accesskey="4">Development</a></li>
99
- </ul>
100
- <div class="chapter-level-extent" id="General-Questions">
101
- <h2 class="chapter"><span>1 General Questions<a class="copiable-link" href="#General-Questions"> &para;</a></span></h2>
102
-
103
- <ul class="mini-toc">
104
- <li><a href="#Why-doesn_0027t-FFmpeg-support-feature-_005bxyz_005d_003f" accesskey="1">Why doesn&rsquo;t FFmpeg support feature [xyz]?</a></li>
105
- <li><a href="#FFmpeg-does-not-support-codec-XXX_002e-Can-you-include-a-Windows-DLL-loader-to-support-it_003f" accesskey="2">FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?</a></li>
106
- <li><a href="#I-cannot-read-this-file-although-this-format-seems-to-be-supported-by-ffmpeg_002e" accesskey="3">I cannot read this file although this format seems to be supported by ffmpeg.</a></li>
107
- <li><a href="#Which-codecs-are-supported-by-Windows_003f" accesskey="4">Which codecs are supported by Windows?</a></li>
108
- </ul>
109
- <div class="section-level-extent" id="Why-doesn_0027t-FFmpeg-support-feature-_005bxyz_005d_003f">
110
- <h3 class="section"><span>1.1 Why doesn&rsquo;t FFmpeg support feature [xyz]?<a class="copiable-link" href="#Why-doesn_0027t-FFmpeg-support-feature-_005bxyz_005d_003f"> &para;</a></span></h3>
111
-
112
- <p>Because no one has taken on that task yet. FFmpeg development is
113
- driven by the tasks that are important to the individual developers.
114
- If there is a feature that is important to you, the best way to get
115
- it implemented is to undertake the task yourself or sponsor a developer.
116
- </p>
117
- </div>
118
- <div class="section-level-extent" id="FFmpeg-does-not-support-codec-XXX_002e-Can-you-include-a-Windows-DLL-loader-to-support-it_003f">
119
- <h3 class="section"><span>1.2 FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?<a class="copiable-link" href="#FFmpeg-does-not-support-codec-XXX_002e-Can-you-include-a-Windows-DLL-loader-to-support-it_003f"> &para;</a></span></h3>
120
-
121
- <p>No. Windows DLLs are not portable, bloated and often slow.
122
- Moreover FFmpeg strives to support all codecs natively.
123
- A DLL loader is not conducive to that goal.
124
- </p>
125
- </div>
126
- <div class="section-level-extent" id="I-cannot-read-this-file-although-this-format-seems-to-be-supported-by-ffmpeg_002e">
127
- <h3 class="section"><span>1.3 I cannot read this file although this format seems to be supported by ffmpeg.<a class="copiable-link" href="#I-cannot-read-this-file-although-this-format-seems-to-be-supported-by-ffmpeg_002e"> &para;</a></span></h3>
128
-
129
- <p>Even if ffmpeg can read the container format, it may not support all its
130
- codecs. Please consult the supported codec list in the ffmpeg
131
- documentation.
132
- </p>
133
- </div>
134
- <div class="section-level-extent" id="Which-codecs-are-supported-by-Windows_003f">
135
- <h3 class="section"><span>1.4 Which codecs are supported by Windows?<a class="copiable-link" href="#Which-codecs-are-supported-by-Windows_003f"> &para;</a></span></h3>
136
-
137
- <p>Windows does not support standard formats like MPEG very well, unless you
138
- install some additional codecs.
139
- </p>
140
- <p>The following list of video codecs should work on most Windows systems:
141
- </p><dl class="table">
142
- <dt><samp class="option">msmpeg4v2</samp></dt>
143
- <dd><p>.avi/.asf
144
- </p></dd>
145
- <dt><samp class="option">msmpeg4</samp></dt>
146
- <dd><p>.asf only
147
- </p></dd>
148
- <dt><samp class="option">wmv1</samp></dt>
149
- <dd><p>.asf only
150
- </p></dd>
151
- <dt><samp class="option">wmv2</samp></dt>
152
- <dd><p>.asf only
153
- </p></dd>
154
- <dt><samp class="option">mpeg4</samp></dt>
155
- <dd><p>Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
156
- </p></dd>
157
- <dt><samp class="option">mpeg1video</samp></dt>
158
- <dd><p>.mpg only
159
- </p></dd>
160
- </dl>
161
- <p>Note, ASF files often have .wmv or .wma extensions in Windows. It should also
162
- be mentioned that Microsoft claims a patent on the ASF format, and may sue
163
- or threaten users who create ASF files with non-Microsoft software. It is
164
- strongly advised to avoid ASF where possible.
165
- </p>
166
- <p>The following list of audio codecs should work on most Windows systems:
167
- </p><dl class="table">
168
- <dt><samp class="option">adpcm_ima_wav</samp></dt>
169
- <dt><samp class="option">adpcm_ms</samp></dt>
170
- <dt><samp class="option">pcm_s16le</samp></dt>
171
- <dd><p>always
172
- </p></dd>
173
- <dt><samp class="option">libmp3lame</samp></dt>
174
- <dd><p>If some MP3 codec like LAME is installed.
175
- </p></dd>
176
- </dl>
177
-
178
-
179
- </div>
180
- </div>
181
- <div class="chapter-level-extent" id="Compilation">
182
- <h2 class="chapter"><span>2 Compilation<a class="copiable-link" href="#Compilation"> &para;</a></span></h2>
183
-
184
- <ul class="mini-toc">
185
- <li><a href="#error_003a-can_0027t-find-a-register-in-class-_0027GENERAL_005fREGS_0027-while-reloading-_0027asm_0027" accesskey="1"><code class="code">error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'</code></a></li>
186
- <li><a href="#I-have-installed-this-library-with-my-distro_0027s-package-manager_002e-Why-does-configure-not-see-it_003f" accesskey="2">I have installed this library with my distro&rsquo;s package manager. Why does <code class="command">configure</code> not see it?</a></li>
187
- <li><a href="#How-do-I-make-pkg_002dconfig-find-my-libraries_003f" accesskey="3">How do I make <code class="command">pkg-config</code> find my libraries?</a></li>
188
- <li><a href="#How-do-I-use-pkg_002dconfig-when-cross_002dcompiling_003f" accesskey="4">How do I use <code class="command">pkg-config</code> when cross-compiling?</a></li>
189
- </ul>
190
- <div class="section-level-extent" id="error_003a-can_0027t-find-a-register-in-class-_0027GENERAL_005fREGS_0027-while-reloading-_0027asm_0027">
191
- <h3 class="section"><span>2.1 <code class="code">error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'</code><a class="copiable-link" href="#error_003a-can_0027t-find-a-register-in-class-_0027GENERAL_005fREGS_0027-while-reloading-_0027asm_0027"> &para;</a></span></h3>
192
-
193
- <p>This is a bug in gcc. Do not report it to us. Instead, please report it to
194
- the gcc developers. Note that we will not add workarounds for gcc bugs.
195
- </p>
196
- <p>Also note that (some of) the gcc developers believe this is not a bug or
197
- not a bug they should fix:
198
- <a class="url" href="https://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203">https://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203</a>.
199
- Then again, some of them do not know the difference between an undecidable
200
- problem and an NP-hard problem...
201
- </p>
202
- </div>
203
- <div class="section-level-extent" id="I-have-installed-this-library-with-my-distro_0027s-package-manager_002e-Why-does-configure-not-see-it_003f">
204
- <h3 class="section"><span>2.2 I have installed this library with my distro&rsquo;s package manager. Why does <code class="command">configure</code> not see it?<a class="copiable-link" href="#I-have-installed-this-library-with-my-distro_0027s-package-manager_002e-Why-does-configure-not-see-it_003f"> &para;</a></span></h3>
205
-
206
- <p>Distributions usually split libraries in several packages. The main package
207
- contains the files necessary to run programs using the library. The
208
- development package contains the files necessary to build programs using the
209
- library. Sometimes, docs and/or data are in a separate package too.
210
- </p>
211
- <p>To build FFmpeg, you need to install the development package. It is usually
212
- called <samp class="file">libfoo-dev</samp> or <samp class="file">libfoo-devel</samp>. You can remove it after the
213
- build is finished, but be sure to keep the main package.
214
- </p>
215
- </div>
216
- <div class="section-level-extent" id="How-do-I-make-pkg_002dconfig-find-my-libraries_003f">
217
- <h3 class="section"><span>2.3 How do I make <code class="command">pkg-config</code> find my libraries?<a class="copiable-link" href="#How-do-I-make-pkg_002dconfig-find-my-libraries_003f"> &para;</a></span></h3>
218
-
219
- <p>Somewhere along with your libraries, there is a <samp class="file">.pc</samp> file (or several)
220
- in a <samp class="file">pkgconfig</samp> directory. You need to set environment variables to
221
- point <code class="command">pkg-config</code> to these files.
222
- </p>
223
- <p>If you need to <em class="emph">add</em> directories to <code class="command">pkg-config</code>&rsquo;s search list
224
- (typical use case: library installed separately), add it to
225
- <code class="code">$PKG_CONFIG_PATH</code>:
226
- </p>
227
- <div class="example">
228
- <pre class="example-preformatted">export PKG_CONFIG_PATH=/opt/x264/lib/pkgconfig:/opt/opus/lib/pkgconfig
229
- </pre></div>
230
-
231
- <p>If you need to <em class="emph">replace</em> <code class="command">pkg-config</code>&rsquo;s search list
232
- (typical use case: cross-compiling), set it in
233
- <code class="code">$PKG_CONFIG_LIBDIR</code>:
234
- </p>
235
- <div class="example">
236
- <pre class="example-preformatted">export PKG_CONFIG_LIBDIR=/home/me/cross/usr/lib/pkgconfig:/home/me/cross/usr/local/lib/pkgconfig
237
- </pre></div>
238
-
239
- <p>If you need to know the library&rsquo;s internal dependencies (typical use: static
240
- linking), add the <code class="code">--static</code> option to <code class="command">pkg-config</code>:
241
- </p>
242
- <div class="example">
243
- <pre class="example-preformatted">./configure --pkg-config-flags=--static
244
- </pre></div>
245
-
246
- </div>
247
- <div class="section-level-extent" id="How-do-I-use-pkg_002dconfig-when-cross_002dcompiling_003f">
248
- <h3 class="section"><span>2.4 How do I use <code class="command">pkg-config</code> when cross-compiling?<a class="copiable-link" href="#How-do-I-use-pkg_002dconfig-when-cross_002dcompiling_003f"> &para;</a></span></h3>
249
-
250
- <p>The best way is to install <code class="command">pkg-config</code> in your cross-compilation
251
- environment. It will automatically use the cross-compilation libraries.
252
- </p>
253
- <p>You can also use <code class="command">pkg-config</code> from the host environment by
254
- specifying explicitly <code class="code">--pkg-config=pkg-config</code> to <code class="command">configure</code>.
255
- In that case, you must point <code class="command">pkg-config</code> to the correct directories
256
- using the <code class="code">PKG_CONFIG_LIBDIR</code>, as explained in the previous entry.
257
- </p>
258
- <p>As an intermediate solution, you can place in your cross-compilation
259
- environment a script that calls the host <code class="command">pkg-config</code> with
260
- <code class="code">PKG_CONFIG_LIBDIR</code> set. That script can look like that:
261
- </p>
262
- <div class="example">
263
- <pre class="example-preformatted">#!/bin/sh
264
- PKG_CONFIG_LIBDIR=/path/to/cross/lib/pkgconfig
265
- export PKG_CONFIG_LIBDIR
266
- exec /usr/bin/pkg-config &quot;$@&quot;
267
- </pre></div>
268
-
269
- </div>
270
- </div>
271
- <div class="chapter-level-extent" id="Usage">
272
- <h2 class="chapter"><span>3 Usage<a class="copiable-link" href="#Usage"> &para;</a></span></h2>
273
-
274
- <ul class="mini-toc">
275
- <li><a href="#ffmpeg-does-not-work_003b-what-is-wrong_003f" accesskey="1">ffmpeg does not work; what is wrong?</a></li>
276
- <li><a href="#How-do-I-encode-single-pictures-into-movies_003f" accesskey="2">How do I encode single pictures into movies?</a></li>
277
- <li><a href="#How-do-I-encode-movie-to-single-pictures_003f" accesskey="3">How do I encode movie to single pictures?</a></li>
278
- <li><a href="#Why-do-I-see-a-slight-quality-degradation-with-multithreaded-MPEG_002a-encoding_003f" accesskey="4">Why do I see a slight quality degradation with multithreaded MPEG* encoding?</a></li>
279
- <li><a href="#How-can-I-read-from-the-standard-input-or-write-to-the-standard-output_003f" accesskey="5">How can I read from the standard input or write to the standard output?</a></li>
280
- <li><a href="#g_t_002df-jpeg-doesn_0027t-work_002e" accesskey="6">-f jpeg doesn&rsquo;t work.</a></li>
281
- <li><a href="#Why-can-I-not-change-the-frame-rate_003f" accesskey="7">Why can I not change the frame rate?</a></li>
282
- <li><a href="#How-do-I-encode-Xvid-or-DivX-video-with-ffmpeg_003f" accesskey="8">How do I encode Xvid or DivX video with ffmpeg?</a></li>
283
- <li><a href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d4_003f" accesskey="9">Which are good parameters for encoding high quality MPEG-4?</a></li>
284
- <li><a href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d1_002fMPEG_002d2_003f">Which are good parameters for encoding high quality MPEG-1/MPEG-2?</a></li>
285
- <li><a href="#Interlaced-video-looks-very-bad-when-encoded-with-ffmpeg_002c-what-is-wrong_003f">Interlaced video looks very bad when encoded with ffmpeg, what is wrong?</a></li>
286
- <li><a href="#How-can-I-read-DirectShow-files_003f">How can I read DirectShow files?</a></li>
287
- <li><a href="#How-can-I-join-video-files_003f">How can I join video files?</a></li>
288
- <li><a href="#How-can-I-concatenate-video-files_003f">How can I concatenate video files?</a></li>
289
- <li><a href="#Using-_002df-lavfi_002c-audio-becomes-mono-for-no-apparent-reason_002e">Using <samp class="option">-f lavfi</samp>, audio becomes mono for no apparent reason.</a></li>
290
- <li><a href="#Why-does-FFmpeg-not-see-the-subtitles-in-my-VOB-file_003f">Why does FFmpeg not see the subtitles in my VOB file?</a></li>
291
- <li><a href="#Why-was-the-ffmpeg-_002dsameq-option-removed_003f-What-to-use-instead_003f">Why was the <code class="command">ffmpeg</code> <samp class="option">-sameq</samp> option removed? What to use instead?</a></li>
292
- <li><a href="#I-have-a-stretched-video_002c-why-does-scaling-not-fix-it_003f">I have a stretched video, why does scaling not fix it?</a></li>
293
- <li><a href="#How-do-I-run-ffmpeg-as-a-background-task_003f">How do I run ffmpeg as a background task?</a></li>
294
- <li><a href="#How-do-I-prevent-ffmpeg-from-suspending-with-a-message-like-suspended-_0028tty-output_0029_003f">How do I prevent ffmpeg from suspending with a message like <em class="emph">suspended (tty output)</em>?</a></li>
295
- </ul>
296
- <div class="section-level-extent" id="ffmpeg-does-not-work_003b-what-is-wrong_003f">
297
- <h3 class="section"><span>3.1 ffmpeg does not work; what is wrong?<a class="copiable-link" href="#ffmpeg-does-not-work_003b-what-is-wrong_003f"> &para;</a></span></h3>
298
-
299
- <p>Try a <code class="code">make distclean</code> in the ffmpeg source directory before the build.
300
- If this does not help see
301
- (<a class="url" href="https://ffmpeg.org/bugreports.html">https://ffmpeg.org/bugreports.html</a>).
302
- </p>
303
- </div>
304
- <div class="section-level-extent" id="How-do-I-encode-single-pictures-into-movies_003f">
305
- <h3 class="section"><span>3.2 How do I encode single pictures into movies?<a class="copiable-link" href="#How-do-I-encode-single-pictures-into-movies_003f"> &para;</a></span></h3>
306
-
307
- <p>First, rename your pictures to follow a numerical sequence.
308
- For example, img1.jpg, img2.jpg, img3.jpg,...
309
- Then you may run:
310
- </p>
311
- <div class="example">
312
- <pre class="example-preformatted">ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
313
- </pre></div>
314
-
315
- <p>Notice that &lsquo;<samp class="samp">%d</samp>&rsquo; is replaced by the image number.
316
- </p>
317
- <p><samp class="file">img%03d.jpg</samp> means the sequence <samp class="file">img001.jpg</samp>, <samp class="file">img002.jpg</samp>, etc.
318
- </p>
319
- <p>Use the <samp class="option">-start_number</samp> option to declare a starting number for
320
- the sequence. This is useful if your sequence does not start with
321
- <samp class="file">img001.jpg</samp> but is still in a numerical order. The following
322
- example will start with <samp class="file">img100.jpg</samp>:
323
- </p>
324
- <div class="example">
325
- <pre class="example-preformatted">ffmpeg -f image2 -start_number 100 -i img%d.jpg /tmp/a.mpg
326
- </pre></div>
327
-
328
- <p>If you have large number of pictures to rename, you can use the
329
- following command to ease the burden. The command, using the bourne
330
- shell syntax, symbolically links all files in the current directory
331
- that match <code class="code">*jpg</code> to the <samp class="file">/tmp</samp> directory in the sequence of
332
- <samp class="file">img001.jpg</samp>, <samp class="file">img002.jpg</samp> and so on.
333
- </p>
334
- <div class="example">
335
- <pre class="example-preformatted">x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s &quot;$i&quot; /tmp/img&quot;$counter&quot;.jpg; x=$(($x+1)); done
336
- </pre></div>
337
-
338
- <p>If you want to sequence them by oldest modified first, substitute
339
- <code class="code">$(ls -r -t *jpg)</code> in place of <code class="code">*jpg</code>.
340
- </p>
341
- <p>Then run:
342
- </p>
343
- <div class="example">
344
- <pre class="example-preformatted">ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
345
- </pre></div>
346
-
347
- <p>The same logic is used for any image format that ffmpeg reads.
348
- </p>
349
- <p>You can also use <code class="command">cat</code> to pipe images to ffmpeg:
350
- </p>
351
- <div class="example">
352
- <pre class="example-preformatted">cat *.jpg | ffmpeg -f image2pipe -c:v mjpeg -i - output.mpg
353
- </pre></div>
354
-
355
- </div>
356
- <div class="section-level-extent" id="How-do-I-encode-movie-to-single-pictures_003f">
357
- <h3 class="section"><span>3.3 How do I encode movie to single pictures?<a class="copiable-link" href="#How-do-I-encode-movie-to-single-pictures_003f"> &para;</a></span></h3>
358
-
359
- <p>Use:
360
- </p>
361
- <div class="example">
362
- <pre class="example-preformatted">ffmpeg -i movie.mpg movie%d.jpg
363
- </pre></div>
364
-
365
- <p>The <samp class="file">movie.mpg</samp> used as input will be converted to
366
- <samp class="file">movie1.jpg</samp>, <samp class="file">movie2.jpg</samp>, etc...
367
- </p>
368
- <p>Instead of relying on file format self-recognition, you may also use
369
- </p><dl class="table">
370
- <dt><samp class="option">-c:v ppm</samp></dt>
371
- <dt><samp class="option">-c:v png</samp></dt>
372
- <dt><samp class="option">-c:v mjpeg</samp></dt>
373
- </dl>
374
- <p>to force the encoding.
375
- </p>
376
- <p>Applying that to the previous example:
377
- </p><div class="example">
378
- <pre class="example-preformatted">ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
379
- </pre></div>
380
-
381
- <p>Beware that there is no &quot;jpeg&quot; codec. Use &quot;mjpeg&quot; instead.
382
- </p>
383
- </div>
384
- <div class="section-level-extent" id="Why-do-I-see-a-slight-quality-degradation-with-multithreaded-MPEG_002a-encoding_003f">
385
- <h3 class="section"><span>3.4 Why do I see a slight quality degradation with multithreaded MPEG* encoding?<a class="copiable-link" href="#Why-do-I-see-a-slight-quality-degradation-with-multithreaded-MPEG_002a-encoding_003f"> &para;</a></span></h3>
386
-
387
- <p>For multithreaded MPEG* encoding, the encoded slices must be independent,
388
- otherwise thread n would practically have to wait for n-1 to finish, so it&rsquo;s
389
- quite logical that there is a small reduction of quality. This is not a bug.
390
- </p>
391
- </div>
392
- <div class="section-level-extent" id="How-can-I-read-from-the-standard-input-or-write-to-the-standard-output_003f">
393
- <h3 class="section"><span>3.5 How can I read from the standard input or write to the standard output?<a class="copiable-link" href="#How-can-I-read-from-the-standard-input-or-write-to-the-standard-output_003f"> &para;</a></span></h3>
394
-
395
- <p>Use <samp class="file">-</samp> as file name.
396
- </p>
397
- </div>
398
- <div class="section-level-extent" id="g_t_002df-jpeg-doesn_0027t-work_002e">
399
- <h3 class="section"><span>3.6 -f jpeg doesn&rsquo;t work.<a class="copiable-link" href="#g_t_002df-jpeg-doesn_0027t-work_002e"> &para;</a></span></h3>
400
-
401
- <p>Try &rsquo;-f image2 test%d.jpg&rsquo;.
402
- </p>
403
- </div>
404
- <div class="section-level-extent" id="Why-can-I-not-change-the-frame-rate_003f">
405
- <h3 class="section"><span>3.7 Why can I not change the frame rate?<a class="copiable-link" href="#Why-can-I-not-change-the-frame-rate_003f"> &para;</a></span></h3>
406
-
407
- <p>Some codecs, like MPEG-1/2, only allow a small number of fixed frame rates.
408
- Choose a different codec with the -c:v command line option.
409
- </p>
410
- </div>
411
- <div class="section-level-extent" id="How-do-I-encode-Xvid-or-DivX-video-with-ffmpeg_003f">
412
- <h3 class="section"><span>3.8 How do I encode Xvid or DivX video with ffmpeg?<a class="copiable-link" href="#How-do-I-encode-Xvid-or-DivX-video-with-ffmpeg_003f"> &para;</a></span></h3>
413
-
414
- <p>Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
415
- standard (note that there are many other coding formats that use this
416
- same standard). Thus, use &rsquo;-c:v mpeg4&rsquo; to encode in these formats. The
417
- default fourcc stored in an MPEG-4-coded file will be &rsquo;FMP4&rsquo;. If you want
418
- a different fourcc, use the &rsquo;-vtag&rsquo; option. E.g., &rsquo;-vtag xvid&rsquo; will
419
- force the fourcc &rsquo;xvid&rsquo; to be stored as the video fourcc rather than the
420
- default.
421
- </p>
422
- </div>
423
- <div class="section-level-extent" id="Which-are-good-parameters-for-encoding-high-quality-MPEG_002d4_003f">
424
- <h3 class="section"><span>3.9 Which are good parameters for encoding high quality MPEG-4?<a class="copiable-link" href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d4_003f"> &para;</a></span></h3>
425
-
426
- <p>&rsquo;-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2&rsquo;,
427
- things to try: &rsquo;-bf 2&rsquo;, &rsquo;-mpv_flags qp_rd&rsquo;, &rsquo;-mpv_flags mv0&rsquo;, &rsquo;-mpv_flags skip_rd&rsquo;.
428
- </p>
429
- </div>
430
- <div class="section-level-extent" id="Which-are-good-parameters-for-encoding-high-quality-MPEG_002d1_002fMPEG_002d2_003f">
431
- <h3 class="section"><span>3.10 Which are good parameters for encoding high quality MPEG-1/MPEG-2?<a class="copiable-link" href="#Which-are-good-parameters-for-encoding-high-quality-MPEG_002d1_002fMPEG_002d2_003f"> &para;</a></span></h3>
432
-
433
- <p>&rsquo;-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2&rsquo;
434
- but beware the &rsquo;-g 100&rsquo; might cause problems with some decoders.
435
- Things to try: &rsquo;-bf 2&rsquo;, &rsquo;-mpv_flags qp_rd&rsquo;, &rsquo;-mpv_flags mv0&rsquo;, &rsquo;-mpv_flags skip_rd&rsquo;.
436
- </p>
437
- </div>
438
- <div class="section-level-extent" id="Interlaced-video-looks-very-bad-when-encoded-with-ffmpeg_002c-what-is-wrong_003f">
439
- <h3 class="section"><span>3.11 Interlaced video looks very bad when encoded with ffmpeg, what is wrong?<a class="copiable-link" href="#Interlaced-video-looks-very-bad-when-encoded-with-ffmpeg_002c-what-is-wrong_003f"> &para;</a></span></h3>
440
-
441
- <p>You should use &rsquo;-flags +ilme+ildct&rsquo; and maybe &rsquo;-flags +alt&rsquo; for interlaced
442
- material, and try &rsquo;-top 0/1&rsquo; if the result looks really messed-up.
443
- </p>
444
- </div>
445
- <div class="section-level-extent" id="How-can-I-read-DirectShow-files_003f">
446
- <h3 class="section"><span>3.12 How can I read DirectShow files?<a class="copiable-link" href="#How-can-I-read-DirectShow-files_003f"> &para;</a></span></h3>
447
-
448
- <p>If you have built FFmpeg with <code class="code">./configure --enable-avisynth</code>
449
- (only possible on MinGW/Cygwin platforms),
450
- then you may use any file that DirectShow can read as input.
451
- </p>
452
- <p>Just create an &quot;input.avs&quot; text file with this single line ...
453
- </p><div class="example">
454
- <pre class="example-preformatted">DirectShowSource(&quot;C:\path to your file\yourfile.asf&quot;)
455
- </pre></div>
456
- <p>... and then feed that text file to ffmpeg:
457
- </p><div class="example">
458
- <pre class="example-preformatted">ffmpeg -i input.avs
459
- </pre></div>
460
-
461
- <p>For ANY other help on AviSynth, please visit the
462
- <a class="uref" href="http://www.avisynth.org/">AviSynth homepage</a>.
463
- </p>
464
- </div>
465
- <div class="section-level-extent" id="How-can-I-join-video-files_003f">
466
- <h3 class="section"><span>3.13 How can I join video files?<a class="copiable-link" href="#How-can-I-join-video-files_003f"> &para;</a></span></h3>
467
-
468
- <p>To &quot;join&quot; video files is quite ambiguous. The following list explains the
469
- different kinds of &quot;joining&quot; and points out how those are addressed in
470
- FFmpeg. To join video files may mean:
471
- </p>
472
- <ul class="itemize mark-bullet">
473
- <li>To put them one after the other: this is called to <em class="emph">concatenate</em> them
474
- (in short: concat) and is addressed
475
- <a class="ref" href="#How-can-I-concatenate-video-files">in this very faq</a>.
476
-
477
- </li><li>To put them together in the same file, to let the user choose between the
478
- different versions (example: different audio languages): this is called to
479
- <em class="emph">multiplex</em> them together (in short: mux), and is done by simply
480
- invoking ffmpeg with several <samp class="option">-i</samp> options.
481
-
482
- </li><li>For audio, to put all channels together in a single stream (example: two
483
- mono streams into one stereo stream): this is sometimes called to
484
- <em class="emph">merge</em> them, and can be done using the
485
- <a class="url" href="ffmpeg-filters.html#amerge"><code class="code">amerge</code></a> filter.
486
-
487
- </li><li>For audio, to play one on top of the other: this is called to <em class="emph">mix</em>
488
- them, and can be done by first merging them into a single stream and then
489
- using the <a class="url" href="ffmpeg-filters.html#pan"><code class="code">pan</code></a> filter to mix
490
- the channels at will.
491
-
492
- </li><li>For video, to display both together, side by side or one on top of a part of
493
- the other; it can be done using the
494
- <a class="url" href="ffmpeg-filters.html#overlay"><code class="code">overlay</code></a> video filter.
495
-
496
- </li></ul>
497
-
498
- <a class="anchor" id="How-can-I-concatenate-video-files"></a></div>
499
- <div class="section-level-extent" id="How-can-I-concatenate-video-files_003f">
500
- <h3 class="section"><span>3.14 How can I concatenate video files?<a class="copiable-link" href="#How-can-I-concatenate-video-files_003f"> &para;</a></span></h3>
501
-
502
- <p>There are several solutions, depending on the exact circumstances.
503
- </p>
504
- <ul class="mini-toc">
505
- <li><a href="#Concatenating-using-the-concat-filter" accesskey="1">Concatenating using the concat <em class="emph">filter</em></a></li>
506
- <li><a href="#Concatenating-using-the-concat-demuxer" accesskey="2">Concatenating using the concat <em class="emph">demuxer</em></a></li>
507
- <li><a href="#Concatenating-using-the-concat-protocol-_0028file-level_0029" accesskey="3">Concatenating using the concat <em class="emph">protocol</em> (file level)</a></li>
508
- <li><a href="#Concatenating-using-raw-audio-and-video" accesskey="4">Concatenating using raw audio and video</a></li>
509
- </ul>
510
- <div class="subsection-level-extent" id="Concatenating-using-the-concat-filter">
511
- <h4 class="subsection"><span>3.14.1 Concatenating using the concat <em class="emph">filter</em><a class="copiable-link" href="#Concatenating-using-the-concat-filter"> &para;</a></span></h4>
512
-
513
- <p>FFmpeg has a <a class="url" href="ffmpeg-filters.html#concat"><code class="code">concat</code></a> filter designed specifically for that, with examples in the
514
- documentation. This operation is recommended if you need to re-encode.
515
- </p>
516
- </div>
517
- <div class="subsection-level-extent" id="Concatenating-using-the-concat-demuxer">
518
- <h4 class="subsection"><span>3.14.2 Concatenating using the concat <em class="emph">demuxer</em><a class="copiable-link" href="#Concatenating-using-the-concat-demuxer"> &para;</a></span></h4>
519
-
520
- <p>FFmpeg has a <a class="url" href="ffmpeg-formats.html#concat"><code class="code">concat</code></a> demuxer which you can use when you want to avoid a re-encode and
521
- your format doesn&rsquo;t support file level concatenation.
522
- </p>
523
- </div>
524
- <div class="subsection-level-extent" id="Concatenating-using-the-concat-protocol-_0028file-level_0029">
525
- <h4 class="subsection"><span>3.14.3 Concatenating using the concat <em class="emph">protocol</em> (file level)<a class="copiable-link" href="#Concatenating-using-the-concat-protocol-_0028file-level_0029"> &para;</a></span></h4>
526
-
527
- <p>FFmpeg has a <a class="url" href="ffmpeg-protocols.html#concat"><code class="code">concat</code></a> protocol designed specifically for that, with examples in the
528
- documentation.
529
- </p>
530
- <p>A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow one to concatenate
531
- video by merely concatenating the files containing them.
532
- </p>
533
- <p>Hence you may concatenate your multimedia files by first transcoding them to
534
- these privileged formats, then using the humble <code class="code">cat</code> command (or the
535
- equally humble <code class="code">copy</code> under Windows), and finally transcoding back to your
536
- format of choice.
537
- </p>
538
- <div class="example">
539
- <pre class="example-preformatted">ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
540
- ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
541
- cat intermediate1.mpg intermediate2.mpg &gt; intermediate_all.mpg
542
- ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
543
- </pre></div>
544
-
545
- <p>Additionally, you can use the <code class="code">concat</code> protocol instead of <code class="code">cat</code> or
546
- <code class="code">copy</code> which will avoid creation of a potentially huge intermediate file.
547
- </p>
548
- <div class="example">
549
- <pre class="example-preformatted">ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
550
- ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
551
- ffmpeg -i concat:&quot;intermediate1.mpg|intermediate2.mpg&quot; -c copy intermediate_all.mpg
552
- ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
553
- </pre></div>
554
-
555
- <p>Note that you may need to escape the character &quot;|&quot; which is special for many
556
- shells.
557
- </p>
558
- <p>Another option is usage of named pipes, should your platform support it:
559
- </p>
560
- <div class="example">
561
- <pre class="example-preformatted">mkfifo intermediate1.mpg
562
- mkfifo intermediate2.mpg
563
- ffmpeg -i input1.avi -qscale:v 1 -y intermediate1.mpg &lt; /dev/null &amp;
564
- ffmpeg -i input2.avi -qscale:v 1 -y intermediate2.mpg &lt; /dev/null &amp;
565
- cat intermediate1.mpg intermediate2.mpg |\
566
- ffmpeg -f mpeg -i - -c:v mpeg4 -c:a libmp3lame output.avi
567
- </pre></div>
568
-
569
- </div>
570
- <div class="subsection-level-extent" id="Concatenating-using-raw-audio-and-video">
571
- <h4 class="subsection"><span>3.14.4 Concatenating using raw audio and video<a class="copiable-link" href="#Concatenating-using-raw-audio-and-video"> &para;</a></span></h4>
572
-
573
- <p>Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also
574
- allow concatenation, and the transcoding step is almost lossless.
575
- When using multiple yuv4mpegpipe(s), the first line needs to be discarded
576
- from all but the first stream. This can be accomplished by piping through
577
- <code class="code">tail</code> as seen below. Note that when piping through <code class="code">tail</code> you
578
- must use command grouping, <code class="code">{ ;}</code>, to background properly.
579
- </p>
580
- <p>For example, let&rsquo;s say we want to concatenate two FLV files into an
581
- output.flv file:
582
- </p>
583
- <div class="example">
584
- <pre class="example-preformatted">mkfifo temp1.a
585
- mkfifo temp1.v
586
- mkfifo temp2.a
587
- mkfifo temp2.v
588
- mkfifo all.a
589
- mkfifo all.v
590
- ffmpeg -i input1.flv -vn -f u16le -c:a pcm_s16le -ac 2 -ar 44100 - &gt; temp1.a &lt; /dev/null &amp;
591
- ffmpeg -i input2.flv -vn -f u16le -c:a pcm_s16le -ac 2 -ar 44100 - &gt; temp2.a &lt; /dev/null &amp;
592
- ffmpeg -i input1.flv -an -f yuv4mpegpipe - &gt; temp1.v &lt; /dev/null &amp;
593
- { ffmpeg -i input2.flv -an -f yuv4mpegpipe - &lt; /dev/null | tail -n +2 &gt; temp2.v ; } &amp;
594
- cat temp1.a temp2.a &gt; all.a &amp;
595
- cat temp1.v temp2.v &gt; all.v &amp;
596
- ffmpeg -f u16le -c:a pcm_s16le -ac 2 -ar 44100 -i all.a \
597
- -f yuv4mpegpipe -i all.v \
598
- -y output.flv
599
- rm temp[12].[av] all.[av]
600
- </pre></div>
601
-
602
- </div>
603
- </div>
604
- <div class="section-level-extent" id="Using-_002df-lavfi_002c-audio-becomes-mono-for-no-apparent-reason_002e">
605
- <h3 class="section"><span>3.15 Using <samp class="option">-f lavfi</samp>, audio becomes mono for no apparent reason.<a class="copiable-link" href="#Using-_002df-lavfi_002c-audio-becomes-mono-for-no-apparent-reason_002e"> &para;</a></span></h3>
606
-
607
- <p>Use <samp class="option">-dumpgraph -</samp> to find out exactly where the channel layout is
608
- lost.
609
- </p>
610
- <p>Most likely, it is through <code class="code">auto-inserted aresample</code>. Try to understand
611
- why the converting filter was needed at that place.
612
- </p>
613
- <p>Just before the output is a likely place, as <samp class="option">-f lavfi</samp> currently
614
- only support packed S16.
615
- </p>
616
- <p>Then insert the correct <code class="code">aformat</code> explicitly in the filtergraph,
617
- specifying the exact format.
618
- </p>
619
- <div class="example">
620
- <pre class="example-preformatted">aformat=sample_fmts=s16:channel_layouts=stereo
621
- </pre></div>
622
-
623
- </div>
624
- <div class="section-level-extent" id="Why-does-FFmpeg-not-see-the-subtitles-in-my-VOB-file_003f">
625
- <h3 class="section"><span>3.16 Why does FFmpeg not see the subtitles in my VOB file?<a class="copiable-link" href="#Why-does-FFmpeg-not-see-the-subtitles-in-my-VOB-file_003f"> &para;</a></span></h3>
626
-
627
- <p>VOB and a few other formats do not have a global header that describes
628
- everything present in the file. Instead, applications are supposed to scan
629
- the file to see what it contains. Since VOB files are frequently large, only
630
- the beginning is scanned. If the subtitles happen only later in the file,
631
- they will not be initially detected.
632
- </p>
633
- <p>Some applications, including the <code class="code">ffmpeg</code> command-line tool, can only
634
- work with streams that were detected during the initial scan; streams that
635
- are detected later are ignored.
636
- </p>
637
- <p>The size of the initial scan is controlled by two options: <code class="code">probesize</code>
638
- (default ~5&nbsp;Mo) and <code class="code">analyzeduration</code> (default 5,000,000&nbsp;µs = 5&nbsp;s). For
639
- the subtitle stream to be detected, both values must be large enough.
640
- </p>
641
- </div>
642
- <div class="section-level-extent" id="Why-was-the-ffmpeg-_002dsameq-option-removed_003f-What-to-use-instead_003f">
643
- <h3 class="section"><span>3.17 Why was the <code class="command">ffmpeg</code> <samp class="option">-sameq</samp> option removed? What to use instead?<a class="copiable-link" href="#Why-was-the-ffmpeg-_002dsameq-option-removed_003f-What-to-use-instead_003f"> &para;</a></span></h3>
644
-
645
- <p>The <samp class="option">-sameq</samp> option meant &quot;same quantizer&quot;, and made sense only in a
646
- very limited set of cases. Unfortunately, a lot of people mistook it for
647
- &quot;same quality&quot; and used it in places where it did not make sense: it had
648
- roughly the expected visible effect, but achieved it in a very inefficient
649
- way.
650
- </p>
651
- <p>Each encoder has its own set of options to set the quality-vs-size balance,
652
- use the options for the encoder you are using to set the quality level to a
653
- point acceptable for your tastes. The most common options to do that are
654
- <samp class="option">-qscale</samp> and <samp class="option">-qmax</samp>, but you should peruse the documentation
655
- of the encoder you chose.
656
- </p>
657
- </div>
658
- <div class="section-level-extent" id="I-have-a-stretched-video_002c-why-does-scaling-not-fix-it_003f">
659
- <h3 class="section"><span>3.18 I have a stretched video, why does scaling not fix it?<a class="copiable-link" href="#I-have-a-stretched-video_002c-why-does-scaling-not-fix-it_003f"> &para;</a></span></h3>
660
-
661
- <p>A lot of video codecs and formats can store the <em class="emph">aspect ratio</em> of the
662
- video: this is the ratio between the width and the height of either the full
663
- image (DAR, display aspect ratio) or individual pixels (SAR, sample aspect
664
- ratio). For example, EGA screens at resolution 640×350 had 4:3 DAR and 35:48
665
- SAR.
666
- </p>
667
- <p>Most still image processing work with square pixels, i.e. 1:1 SAR, but a lot
668
- of video standards, especially from the analogic-numeric transition era, use
669
- non-square pixels.
670
- </p>
671
- <p>Most processing filters in FFmpeg handle the aspect ratio to avoid
672
- stretching the image: cropping adjusts the DAR to keep the SAR constant,
673
- scaling adjusts the SAR to keep the DAR constant.
674
- </p>
675
- <p>If you want to stretch, or “unstretch”, the image, you need to override the
676
- information with the
677
- <a class="url" href="ffmpeg-filters.html#setdar_002c-setsar"><code class="code">setdar or setsar filters</code></a>.
678
- </p>
679
- <p>Do not forget to examine carefully the original video to check whether the
680
- stretching comes from the image or from the aspect ratio information.
681
- </p>
682
- <p>For example, to fix a badly encoded EGA capture, use the following commands,
683
- either the first one to upscale to square pixels or the second one to set
684
- the correct aspect ratio or the third one to avoid transcoding (may not work
685
- depending on the format / codec / player / phase of the moon):
686
- </p>
687
- <div class="example">
688
- <pre class="example-preformatted">ffmpeg -i ega_screen.nut -vf scale=640:480,setsar=1 ega_screen_scaled.nut
689
- ffmpeg -i ega_screen.nut -vf setdar=4/3 ega_screen_anamorphic.nut
690
- ffmpeg -i ega_screen.nut -aspect 4/3 -c copy ega_screen_overridden.nut
691
- </pre></div>
692
-
693
- <a class="anchor" id="background-task"></a></div>
694
- <div class="section-level-extent" id="How-do-I-run-ffmpeg-as-a-background-task_003f">
695
- <h3 class="section"><span>3.19 How do I run ffmpeg as a background task?<a class="copiable-link" href="#How-do-I-run-ffmpeg-as-a-background-task_003f"> &para;</a></span></h3>
696
-
697
- <p>ffmpeg normally checks the console input, for entries like &quot;q&quot; to stop
698
- and &quot;?&quot; to give help, while performing operations. ffmpeg does not have a way of
699
- detecting when it is running as a background task.
700
- When it checks the console input, that can cause the process running ffmpeg
701
- in the background to suspend.
702
- </p>
703
- <p>To prevent those input checks, allowing ffmpeg to run as a background task,
704
- use the <a class="url" href="ffmpeg.html#stdin-option"><code class="code">-nostdin</code> option</a>
705
- in the ffmpeg invocation. This is effective whether you run ffmpeg in a shell
706
- or invoke ffmpeg in its own process via an operating system API.
707
- </p>
708
- <p>As an alternative, when you are running ffmpeg in a shell, you can redirect
709
- standard input to <code class="code">/dev/null</code> (on Linux and macOS)
710
- or <code class="code">NUL</code> (on Windows). You can do this redirect either
711
- on the ffmpeg invocation, or from a shell script which calls ffmpeg.
712
- </p>
713
- <p>For example:
714
- </p>
715
- <div class="example">
716
- <pre class="example-preformatted">ffmpeg -nostdin -i INPUT OUTPUT
717
- </pre></div>
718
-
719
- <p>or (on Linux, macOS, and other UNIX-like shells):
720
- </p>
721
- <div class="example">
722
- <pre class="example-preformatted">ffmpeg -i INPUT OUTPUT &lt;/dev/null
723
- </pre></div>
724
-
725
- <p>or (on Windows):
726
- </p>
727
- <div class="example">
728
- <pre class="example-preformatted">ffmpeg -i INPUT OUTPUT &lt;NUL
729
- </pre></div>
730
-
731
- </div>
732
- <div class="section-level-extent" id="How-do-I-prevent-ffmpeg-from-suspending-with-a-message-like-suspended-_0028tty-output_0029_003f">
733
- <h3 class="section"><span>3.20 How do I prevent ffmpeg from suspending with a message like <em class="emph">suspended (tty output)</em>?<a class="copiable-link" href="#How-do-I-prevent-ffmpeg-from-suspending-with-a-message-like-suspended-_0028tty-output_0029_003f"> &para;</a></span></h3>
734
-
735
- <p>If you run ffmpeg in the background, you may find that its process suspends.
736
- There may be a message like <em class="emph">suspended (tty output)</em>. The question is how
737
- to prevent the process from being suspended.
738
- </p>
739
- <p>For example:
740
- </p>
741
- <div class="example">
742
- <pre class="example-preformatted">% ffmpeg -i INPUT OUTPUT &amp;&gt; ~/tmp/log.txt &amp;
743
- [1] 93352
744
- %
745
- [1] + suspended (tty output) ffmpeg -i INPUT OUTPUT &amp;&gt;
746
- </pre></div>
747
-
748
- <p>The message &quot;tty output&quot; notwithstanding, the problem here is that
749
- ffmpeg normally checks the console input when it runs. The operating system
750
- detects this, and suspends the process until you can bring it to the
751
- foreground and attend to it.
752
- </p>
753
- <p>The solution is to use the right techniques to tell ffmpeg not to consult
754
- console input. You can use the
755
- <a class="url" href="ffmpeg.html#stdin-option"><code class="code">-nostdin</code> option</a>,
756
- or redirect standard input with <code class="code">&lt; /dev/null</code>.
757
- See FAQ
758
- <a class="ref" href="#background-task"><em class="emph">How do I run ffmpeg as a background task?</em></a>
759
- for details.
760
- </p>
761
- </div>
762
- </div>
763
- <div class="chapter-level-extent" id="Development">
764
- <h2 class="chapter"><span>4 Development<a class="copiable-link" href="#Development"> &para;</a></span></h2>
765
-
766
- <ul class="mini-toc">
767
- <li><a href="#Are-there-examples-illustrating-how-to-use-the-FFmpeg-libraries_002c-particularly-libavcodec-and-libavformat_003f" accesskey="1">Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?</a></li>
768
- <li><a href="#Can-you-support-my-C-compiler-XXX_003f" accesskey="2">Can you support my C compiler XXX?</a></li>
769
- <li><a href="#Is-Microsoft-Visual-C_002b_002b-supported_003f" accesskey="3">Is Microsoft Visual C++ supported?</a></li>
770
- <li><a href="#Can-you-add-automake_002c-libtool-or-autoconf-support_003f" accesskey="4">Can you add automake, libtool or autoconf support?</a></li>
771
- <li><a href="#Why-not-rewrite-FFmpeg-in-object_002doriented-C_002b_002b_003f" accesskey="5">Why not rewrite FFmpeg in object-oriented C++?</a></li>
772
- <li><a href="#Why-are-the-ffmpeg-programs-devoid-of-debugging-symbols_003f" accesskey="6">Why are the ffmpeg programs devoid of debugging symbols?</a></li>
773
- <li><a href="#I-do-not-like-the-LGPL_002c-can-I-contribute-code-under-the-GPL-instead_003f" accesskey="7">I do not like the LGPL, can I contribute code under the GPL instead?</a></li>
774
- <li><a href="#I_0027m-using-FFmpeg-from-within-my-C-application-but-the-linker-complains-about-missing-symbols-from-the-libraries-themselves_002e" accesskey="8">I&rsquo;m using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.</a></li>
775
- <li><a href="#I_0027m-using-FFmpeg-from-within-my-C_002b_002b-application-but-the-linker-complains-about-missing-symbols-which-seem-to-be-available_002e" accesskey="9">I&rsquo;m using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.</a></li>
776
- <li><a href="#I_0027m-using-libavutil-from-within-my-C_002b_002b-application-but-the-compiler-complains-about-_0027UINT64_005fC_0027-was-not-declared-in-this-scope">I&rsquo;m using libavutil from within my C++ application but the compiler complains about &rsquo;UINT64_C&rsquo; was not declared in this scope</a></li>
777
- <li><a href="#I-have-a-file-in-memory-_002f-a-API-different-from-_002aopen_002f_002aread_002f-libc-how-do-I-use-it-with-libavformat_003f">I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?</a></li>
778
- <li><a href="#Where-is-the-documentation-about-ffv1_002c-msmpeg4_002c-asv1_002c-4xm_003f">Where is the documentation about ffv1, msmpeg4, asv1, 4xm?</a></li>
779
- <li><a href="#How-do-I-feed-H_002e263_002dRTP-_0028and-other-codecs-in-RTP_0029-to-libavcodec_003f">How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?</a></li>
780
- <li><a href="#AVStream_002er_005fframe_005frate-is-wrong_002c-it-is-much-larger-than-the-frame-rate_002e">AVStream.r_frame_rate is wrong, it is much larger than the frame rate.</a></li>
781
- <li><a href="#Why-is-make-fate-not-running-all-tests_003f">Why is <code class="code">make fate</code> not running all tests?</a></li>
782
- <li><a href="#Why-is-make-fate-not-finding-the-samples_003f">Why is <code class="code">make fate</code> not finding the samples?</a></li>
783
- </ul>
784
- <div class="section-level-extent" id="Are-there-examples-illustrating-how-to-use-the-FFmpeg-libraries_002c-particularly-libavcodec-and-libavformat_003f">
785
- <h3 class="section"><span>4.1 Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?<a class="copiable-link" href="#Are-there-examples-illustrating-how-to-use-the-FFmpeg-libraries_002c-particularly-libavcodec-and-libavformat_003f"> &para;</a></span></h3>
786
-
787
- <p>Yes. Check the <samp class="file">doc/examples</samp> directory in the source
788
- repository, also available online at:
789
- <a class="url" href="https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples">https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples</a>.
790
- </p>
791
- <p>Examples are also installed by default, usually in
792
- <code class="code">$PREFIX/share/ffmpeg/examples</code>.
793
- </p>
794
- <p>Also you may read the Developers Guide of the FFmpeg documentation. Alternatively,
795
- examine the source code for one of the many open source projects that
796
- already incorporate FFmpeg at (<a class="url" href="projects.html">projects.html</a>).
797
- </p>
798
- </div>
799
- <div class="section-level-extent" id="Can-you-support-my-C-compiler-XXX_003f">
800
- <h3 class="section"><span>4.2 Can you support my C compiler XXX?<a class="copiable-link" href="#Can-you-support-my-C-compiler-XXX_003f"> &para;</a></span></h3>
801
-
802
- <p>It depends. If your compiler is C99-compliant, then patches to support
803
- it are likely to be welcome if they do not pollute the source code
804
- with <code class="code">#ifdef</code>s related to the compiler.
805
- </p>
806
- </div>
807
- <div class="section-level-extent" id="Is-Microsoft-Visual-C_002b_002b-supported_003f">
808
- <h3 class="section"><span>4.3 Is Microsoft Visual C++ supported?<a class="copiable-link" href="#Is-Microsoft-Visual-C_002b_002b-supported_003f"> &para;</a></span></h3>
809
-
810
- <p>Yes. Please see the <a class="uref" href="platform.html">Microsoft Visual C++</a>
811
- section in the FFmpeg documentation.
812
- </p>
813
- </div>
814
- <div class="section-level-extent" id="Can-you-add-automake_002c-libtool-or-autoconf-support_003f">
815
- <h3 class="section"><span>4.4 Can you add automake, libtool or autoconf support?<a class="copiable-link" href="#Can-you-add-automake_002c-libtool-or-autoconf-support_003f"> &para;</a></span></h3>
816
-
817
- <p>No. These tools are too bloated and they complicate the build.
818
- </p>
819
- </div>
820
- <div class="section-level-extent" id="Why-not-rewrite-FFmpeg-in-object_002doriented-C_002b_002b_003f">
821
- <h3 class="section"><span>4.5 Why not rewrite FFmpeg in object-oriented C++?<a class="copiable-link" href="#Why-not-rewrite-FFmpeg-in-object_002doriented-C_002b_002b_003f"> &para;</a></span></h3>
822
-
823
- <p>FFmpeg is already organized in a highly modular manner and does not need to
824
- be rewritten in a formal object language. Further, many of the developers
825
- favor straight C; it works for them. For more arguments on this matter,
826
- read <a class="uref" href="https://web.archive.org/web/20111004021423/http://kernel.org/pub/linux/docs/lkml/#s15">&quot;Programming Religion&quot;</a>.
827
- </p>
828
- </div>
829
- <div class="section-level-extent" id="Why-are-the-ffmpeg-programs-devoid-of-debugging-symbols_003f">
830
- <h3 class="section"><span>4.6 Why are the ffmpeg programs devoid of debugging symbols?<a class="copiable-link" href="#Why-are-the-ffmpeg-programs-devoid-of-debugging-symbols_003f"> &para;</a></span></h3>
831
-
832
- <p>The build process creates <code class="command">ffmpeg_g</code>, <code class="command">ffplay_g</code>, etc. which
833
- contain full debug information. Those binaries are stripped to create
834
- <code class="command">ffmpeg</code>, <code class="command">ffplay</code>, etc. If you need the debug information, use
835
- the *_g versions.
836
- </p>
837
- </div>
838
- <div class="section-level-extent" id="I-do-not-like-the-LGPL_002c-can-I-contribute-code-under-the-GPL-instead_003f">
839
- <h3 class="section"><span>4.7 I do not like the LGPL, can I contribute code under the GPL instead?<a class="copiable-link" href="#I-do-not-like-the-LGPL_002c-can-I-contribute-code-under-the-GPL-instead_003f"> &para;</a></span></h3>
840
-
841
- <p>Yes, as long as the code is optional and can easily and cleanly be placed
842
- under #if CONFIG_GPL without breaking anything. So, for example, a new codec
843
- or filter would be OK under GPL while a bug fix to LGPL code would not.
844
- </p>
845
- </div>
846
- <div class="section-level-extent" id="I_0027m-using-FFmpeg-from-within-my-C-application-but-the-linker-complains-about-missing-symbols-from-the-libraries-themselves_002e">
847
- <h3 class="section"><span>4.8 I&rsquo;m using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.<a class="copiable-link" href="#I_0027m-using-FFmpeg-from-within-my-C-application-but-the-linker-complains-about-missing-symbols-from-the-libraries-themselves_002e"> &para;</a></span></h3>
848
-
849
- <p>FFmpeg builds static libraries by default. In static libraries, dependencies
850
- are not handled. That has two consequences. First, you must specify the
851
- libraries in dependency order: <code class="code">-lavdevice</code> must come before
852
- <code class="code">-lavformat</code>, <code class="code">-lavutil</code> must come after everything else, etc.
853
- Second, external libraries that are used in FFmpeg have to be specified too.
854
- </p>
855
- <p>An easy way to get the full list of required libraries in dependency order
856
- is to use <code class="code">pkg-config</code>.
857
- </p>
858
- <div class="example">
859
- <pre class="example-preformatted">c99 -o program program.c $(pkg-config --cflags --libs libavformat libavcodec)
860
- </pre></div>
861
-
862
- <p>See <samp class="file">doc/example/Makefile</samp> and <samp class="file">doc/example/pc-uninstalled</samp> for
863
- more details.
864
- </p>
865
- </div>
866
- <div class="section-level-extent" id="I_0027m-using-FFmpeg-from-within-my-C_002b_002b-application-but-the-linker-complains-about-missing-symbols-which-seem-to-be-available_002e">
867
- <h3 class="section"><span>4.9 I&rsquo;m using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.<a class="copiable-link" href="#I_0027m-using-FFmpeg-from-within-my-C_002b_002b-application-but-the-linker-complains-about-missing-symbols-which-seem-to-be-available_002e"> &para;</a></span></h3>
868
-
869
- <p>FFmpeg is a pure C project, so to use the libraries within your C++ application
870
- you need to explicitly state that you are using a C library. You can do this by
871
- encompassing your FFmpeg includes using <code class="code">extern &quot;C&quot;</code>.
872
- </p>
873
- <p>See <a class="url" href="http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3">http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3</a>
874
- </p>
875
- </div>
876
- <div class="section-level-extent" id="I_0027m-using-libavutil-from-within-my-C_002b_002b-application-but-the-compiler-complains-about-_0027UINT64_005fC_0027-was-not-declared-in-this-scope">
877
- <h3 class="section"><span>4.10 I&rsquo;m using libavutil from within my C++ application but the compiler complains about &rsquo;UINT64_C&rsquo; was not declared in this scope<a class="copiable-link" href="#I_0027m-using-libavutil-from-within-my-C_002b_002b-application-but-the-compiler-complains-about-_0027UINT64_005fC_0027-was-not-declared-in-this-scope"> &para;</a></span></h3>
878
-
879
- <p>FFmpeg is a pure C project using C99 math features, in order to enable C++
880
- to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS
881
- </p>
882
- </div>
883
- <div class="section-level-extent" id="I-have-a-file-in-memory-_002f-a-API-different-from-_002aopen_002f_002aread_002f-libc-how-do-I-use-it-with-libavformat_003f">
884
- <h3 class="section"><span>4.11 I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?<a class="copiable-link" href="#I-have-a-file-in-memory-_002f-a-API-different-from-_002aopen_002f_002aread_002f-libc-how-do-I-use-it-with-libavformat_003f"> &para;</a></span></h3>
885
-
886
- <p>You have to create a custom AVIOContext using <code class="code">avio_alloc_context</code>,
887
- see <samp class="file">libavformat/aviobuf.c</samp> in FFmpeg and <samp class="file">libmpdemux/demux_lavf.c</samp> in MPlayer or MPlayer2 sources.
888
- </p>
889
- </div>
890
- <div class="section-level-extent" id="Where-is-the-documentation-about-ffv1_002c-msmpeg4_002c-asv1_002c-4xm_003f">
891
- <h3 class="section"><span>4.12 Where is the documentation about ffv1, msmpeg4, asv1, 4xm?<a class="copiable-link" href="#Where-is-the-documentation-about-ffv1_002c-msmpeg4_002c-asv1_002c-4xm_003f"> &para;</a></span></h3>
892
-
893
- <p>see <a class="url" href="https://www.ffmpeg.org/~michael/">https://www.ffmpeg.org/~michael/</a>
894
- </p>
895
- </div>
896
- <div class="section-level-extent" id="How-do-I-feed-H_002e263_002dRTP-_0028and-other-codecs-in-RTP_0029-to-libavcodec_003f">
897
- <h3 class="section"><span>4.13 How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?<a class="copiable-link" href="#How-do-I-feed-H_002e263_002dRTP-_0028and-other-codecs-in-RTP_0029-to-libavcodec_003f"> &para;</a></span></h3>
898
-
899
- <p>Even if peculiar since it is network oriented, RTP is a container like any
900
- other. You have to <em class="emph">demux</em> RTP before feeding the payload to libavcodec.
901
- In this specific case please look at RFC 4629 to see how it should be done.
902
- </p>
903
- </div>
904
- <div class="section-level-extent" id="AVStream_002er_005fframe_005frate-is-wrong_002c-it-is-much-larger-than-the-frame-rate_002e">
905
- <h3 class="section"><span>4.14 AVStream.r_frame_rate is wrong, it is much larger than the frame rate.<a class="copiable-link" href="#AVStream_002er_005fframe_005frate-is-wrong_002c-it-is-much-larger-than-the-frame-rate_002e"> &para;</a></span></h3>
906
-
907
- <p><code class="code">r_frame_rate</code> is NOT the average frame rate, it is the smallest frame rate
908
- that can accurately represent all timestamps. So no, it is not
909
- wrong if it is larger than the average!
910
- For example, if you have mixed 25 and 30 fps content, then <code class="code">r_frame_rate</code>
911
- will be 150 (it is the least common multiple).
912
- If you are looking for the average frame rate, see <code class="code">AVStream.avg_frame_rate</code>.
913
- </p>
914
- </div>
915
- <div class="section-level-extent" id="Why-is-make-fate-not-running-all-tests_003f">
916
- <h3 class="section"><span>4.15 Why is <code class="code">make fate</code> not running all tests?<a class="copiable-link" href="#Why-is-make-fate-not-running-all-tests_003f"> &para;</a></span></h3>
917
-
918
- <p>Make sure you have the fate-suite samples and the <code class="code">SAMPLES</code> Make variable
919
- or <code class="code">FATE_SAMPLES</code> environment variable or the <code class="code">--samples</code>
920
- <code class="command">configure</code> option is set to the right path.
921
- </p>
922
- </div>
923
- <div class="section-level-extent" id="Why-is-make-fate-not-finding-the-samples_003f">
924
- <h3 class="section"><span>4.16 Why is <code class="code">make fate</code> not finding the samples?<a class="copiable-link" href="#Why-is-make-fate-not-finding-the-samples_003f"> &para;</a></span></h3>
925
-
926
- <p>Do you happen to have a <code class="code">~</code> character in the samples path to indicate a
927
- home directory? The value is used in ways where the shell cannot expand it,
928
- causing FATE to not find files. Just replace <code class="code">~</code> by the full path.
929
- </p>
930
- </div>
931
- </div>
932
- </div>
933
- <p style="font-size: small;">
934
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
935
- </p>
936
- </div>
937
- </body>
938
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/fate.html DELETED
@@ -1,401 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Automated Testing Environment
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Automated Testing Environment
17
- </h1>
18
-
19
-
20
- <a name="Top"></a>
21
- <h4 class="Top">1</h4>
22
- <a class="top" id="SEC_Top"></a>
23
- <div class="element-contents" id="SEC_Contents">
24
- <h2 class="contents-heading">Table of Contents</h2>
25
-
26
- <div class="contents">
27
-
28
- <ul class="toc-numbered-mark">
29
- <li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>
30
- <li><a id="toc-Using-FATE-from-your-FFmpeg-source-directory" href="#Using-FATE-from-your-FFmpeg-source-directory">2 Using FATE from your FFmpeg source directory</a></li>
31
- <li><a id="toc-Submitting-the-results-to-the-FFmpeg-result-aggregation-server" href="#Submitting-the-results-to-the-FFmpeg-result-aggregation-server">3 Submitting the results to the FFmpeg result aggregation server</a></li>
32
- <li><a id="toc-Uploading-new-samples-to-the-fate-suite" href="#Uploading-new-samples-to-the-fate-suite">4 Uploading new samples to the fate suite</a></li>
33
- <li><a id="toc-FATE-makefile-targets-and-variables" href="#FATE-makefile-targets-and-variables">5 FATE makefile targets and variables</a>
34
- <ul class="toc-numbered-mark">
35
- <li><a id="toc-Makefile-targets" href="#Makefile-targets">5.1 Makefile targets</a></li>
36
- <li><a id="toc-Makefile-variables" href="#Makefile-variables">5.2 Makefile variables</a></li>
37
- <li><a id="toc-Examples" href="#Examples">5.3 Examples</a></li>
38
- </ul></li>
39
- </ul>
40
- </div>
41
- </div>
42
-
43
- <ul class="mini-toc">
44
- <li><a href="#Introduction" accesskey="1">Introduction</a></li>
45
- <li><a href="#Using-FATE-from-your-FFmpeg-source-directory" accesskey="2">Using FATE from your FFmpeg source directory</a></li>
46
- <li><a href="#Submitting-the-results-to-the-FFmpeg-result-aggregation-server" accesskey="3">Submitting the results to the FFmpeg result aggregation server</a></li>
47
- <li><a href="#Uploading-new-samples-to-the-fate-suite" accesskey="4">Uploading new samples to the fate suite</a></li>
48
- <li><a href="#FATE-makefile-targets-and-variables" accesskey="5">FATE makefile targets and variables</a></li>
49
- </ul>
50
- <div class="chapter-level-extent" id="Introduction">
51
- <h2 class="chapter"><span>1 Introduction<a class="copiable-link" href="#Introduction"> &para;</a></span></h2>
52
-
53
- <p>FATE is an extended regression suite on the client-side and a means
54
- for results aggregation and presentation on the server-side.
55
- </p>
56
- <p>The first part of this document explains how you can use FATE from
57
- your FFmpeg source directory to test your ffmpeg binary. The second
58
- part describes how you can run FATE to submit the results to FFmpeg&rsquo;s
59
- FATE server.
60
- </p>
61
- <p>In any way you can have a look at the publicly viewable FATE results
62
- by visiting this website:
63
- </p>
64
- <p><a class="url" href="http://fate.ffmpeg.org/">http://fate.ffmpeg.org/</a>
65
- </p>
66
- <p>This is especially recommended for all people contributing source
67
- code to FFmpeg, as it can be seen if some test on some platform broke
68
- with their recent contribution. This usually happens on the platforms
69
- the developers could not test on.
70
- </p>
71
- <p>The second part of this document describes how you can run FATE to
72
- submit your results to FFmpeg&rsquo;s FATE server. If you want to submit your
73
- results be sure to check that your combination of CPU, OS and compiler
74
- is not already listed on the above mentioned website.
75
- </p>
76
- <p>In the third part you can find a comprehensive listing of FATE makefile
77
- targets and variables.
78
- </p>
79
-
80
- </div>
81
- <div class="chapter-level-extent" id="Using-FATE-from-your-FFmpeg-source-directory">
82
- <h2 class="chapter"><span>2 Using FATE from your FFmpeg source directory<a class="copiable-link" href="#Using-FATE-from-your-FFmpeg-source-directory"> &para;</a></span></h2>
83
-
84
- <p>If you want to run FATE on your machine you need to have the samples
85
- in place. You can get the samples via the build target fate-rsync.
86
- Use this command from the top-level source directory:
87
- </p>
88
- <div class="example">
89
- <pre class="example-preformatted">make fate-rsync SAMPLES=fate-suite/
90
- make fate SAMPLES=fate-suite/
91
- </pre></div>
92
-
93
- <p>The above commands set the samples location by passing a makefile
94
- variable via command line. It is also possible to set the samples
95
- location at source configuration time by invoking configure with
96
- <samp class="option">--samples=&lt;path to the samples directory&gt;</samp>. Afterwards you can
97
- invoke the makefile targets without setting the <var class="var">SAMPLES</var> makefile
98
- variable. This is illustrated by the following commands:
99
- </p>
100
- <div class="example">
101
- <pre class="example-preformatted">./configure --samples=fate-suite/
102
- make fate-rsync
103
- make fate
104
- </pre></div>
105
-
106
- <p>Yet another way to tell FATE about the location of the sample
107
- directory is by making sure the environment variable FATE_SAMPLES
108
- contains the path to your samples directory. This can be achieved
109
- by e.g. putting that variable in your shell profile or by setting
110
- it in your interactive session.
111
- </p>
112
- <div class="example">
113
- <pre class="example-preformatted">FATE_SAMPLES=fate-suite/ make fate
114
- </pre></div>
115
-
116
- <div class="info">
117
- <p>Do not put a &rsquo;~&rsquo; character in the samples path to indicate a home
118
- directory. Because of shell nuances, this will cause FATE to fail.
119
- </p></div>
120
- <p>Beware that some assertions are disabled by default, so mind setting
121
- <samp class="option">--assert-level=&lt;level&gt;</samp> at configuration time, e.g. when seeking
122
- the highest possible test coverage:
123
- </p><div class="example">
124
- <pre class="example-preformatted">./configure --assert-level=2
125
- </pre></div>
126
- <p>Note that raising the assert level could have a performance impact.
127
- </p>
128
- <p>To get the complete list of tests, run the command:
129
- </p><div class="example">
130
- <pre class="example-preformatted">make fate-list
131
- </pre></div>
132
-
133
- <p>You can specify a subset of tests to run by specifying the
134
- corresponding elements from the list with the <code class="code">fate-</code> prefix,
135
- e.g. as in:
136
- </p><div class="example">
137
- <pre class="example-preformatted">make fate-ffprobe_compact fate-ffprobe_xml
138
- </pre></div>
139
-
140
- <p>This makes it easier to run a few tests in case of failure without
141
- running the complete test suite.
142
- </p>
143
- <p>To use a custom wrapper to run the test, pass <samp class="option">--target-exec</samp> to
144
- <code class="command">configure</code> or set the <var class="var">TARGET_EXEC</var> Make variable.
145
- </p>
146
-
147
- </div>
148
- <div class="chapter-level-extent" id="Submitting-the-results-to-the-FFmpeg-result-aggregation-server">
149
- <h2 class="chapter"><span>3 Submitting the results to the FFmpeg result aggregation server<a class="copiable-link" href="#Submitting-the-results-to-the-FFmpeg-result-aggregation-server"> &para;</a></span></h2>
150
-
151
- <p>To submit your results to the server you should run fate through the
152
- shell script <samp class="file">tests/fate.sh</samp> from the FFmpeg sources. This script needs
153
- to be invoked with a configuration file as its first argument.
154
- </p>
155
- <div class="example">
156
- <pre class="example-preformatted">tests/fate.sh /path/to/fate_config
157
- </pre></div>
158
-
159
- <p>A configuration file template with comments describing the individual
160
- configuration variables can be found at <samp class="file">doc/fate_config.sh.template</samp>.
161
- </p>
162
- <p>The mentioned configuration template is also available here:
163
- </p><pre class="verbatim">slot= # some unique identifier
164
- repo=git://source.ffmpeg.org/ffmpeg.git # the source repository
165
- #branch=release/2.6 # the branch to test
166
- samples= # path to samples directory
167
- workdir= # directory in which to do all the work
168
- #fate_recv=&quot;ssh -T [email protected]&quot; # command to submit report
169
- comment= # optional description
170
- build_only= # set to &quot;yes&quot; for a compile-only instance that skips tests
171
- ignore_tests=
172
-
173
- # the following are optional and map to configure options
174
- arch=
175
- cpu=
176
- cross_prefix=
177
- as=
178
- cc=
179
- ld=
180
- target_os=
181
- sysroot=
182
- target_exec=
183
- target_path=
184
- target_samples=
185
- extra_cflags=
186
- extra_ldflags=
187
- extra_libs=
188
- extra_conf= # extra configure options not covered above
189
-
190
- #make= # name of GNU make if not 'make'
191
- makeopts= # extra options passed to 'make'
192
- #makeopts_fate= # extra options passed to 'make' when running tests,
193
- # defaulting to makeopts above if this is not set
194
- #tar= # command to create a tar archive from its arguments on stdout,
195
- # defaults to 'tar c'
196
- #fate_targets= # targets to make when running fate; defaults to &quot;fate&quot;,
197
- # can be set to run a subset of tests, e.g. &quot;fate-checkasm&quot;.
198
-
199
- #fate_environments= # a list of names of configurations to run tests for;
200
- # each round is run with variables from ${${name}_env} set.
201
-
202
- # One example of using fate_environments:
203
-
204
- # target_exec=&quot;qemu-aarch64-static&quot;
205
- # fate_targets=&quot;fate-checkasm fate-cpu&quot;
206
- # fate_environments=&quot;sve128 sve256&quot;
207
- # sve128_env=&quot;QEMU_CPU=max,sve128=on&quot;
208
- # sve256_env=&quot;QEMU_CPU=max,sve256=on&quot;
209
-
210
- # The variables set by fate_environments can also be used explicitly
211
- # by target_exec, e.g. like this:
212
-
213
- # target_exec=&quot;qemu-aarch64-static -cpu \$(MY_CPU)&quot;
214
- # fate_targets=&quot;fate-checkasm fate-cpu&quot;
215
- # fate_environments=&quot;sve128 sve256&quot;
216
- # sve128_env=&quot;MY_CPU=max,sve128=on&quot;
217
- # sve256_env=&quot;MY_CPU=max,sve256=on&quot;
218
- </pre>
219
- <p>Create a configuration that suits your needs, based on the configuration
220
- template. The <code class="env">slot</code> configuration variable can be any string that is not
221
- yet used, but it is suggested that you name it adhering to the following
222
- pattern &lsquo;<samp class="samp"><var class="var">arch</var>-<var class="var">os</var>-<var class="var">compiler</var>-<var class="var">compiler version</var></samp>&rsquo;. The
223
- configuration file itself will be sourced in a shell script, therefore all
224
- shell features may be used. This enables you to setup the environment as you
225
- need it for your build.
226
- </p>
227
- <p>For your first test runs the <code class="env">fate_recv</code> variable should be empty or
228
- commented out. This will run everything as normal except that it will omit
229
- the submission of the results to the server. The following files should be
230
- present in $workdir as specified in the configuration file:
231
- </p>
232
- <ul class="itemize mark-bullet">
233
- <li>configure.log
234
- </li><li>compile.log
235
- </li><li>test.log
236
- </li><li>report
237
- </li><li>version
238
- </li></ul>
239
-
240
- <p>When you have everything working properly you can create an SSH key pair
241
- and send the public key to the FATE server administrator who can be contacted
242
- at the email address <a class="email" href="mailto:[email protected]">[email protected]</a>.
243
- </p>
244
- <p>Configure your SSH client to use public key authentication with that key
245
- when connecting to the FATE server. Also do not forget to check the identity
246
- of the server and to accept its host key. This can usually be achieved by
247
- running your SSH client manually and killing it after you accepted the key.
248
- The FATE server&rsquo;s fingerprint is:
249
- </p>
250
- <dl class="table">
251
- <dt>&lsquo;<samp class="samp">RSA</samp>&rsquo;</dt>
252
- <dd><p>d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51
253
- </p></dd>
254
- <dt>&lsquo;<samp class="samp">ECDSA</samp>&rsquo;</dt>
255
- <dd><p>76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86
256
- </p></dd>
257
- </dl>
258
-
259
- <p>If you have problems connecting to the FATE server, it may help to try out
260
- the <code class="command">ssh</code> command with one or more <samp class="option">-v</samp> options. You should
261
- get detailed output concerning your SSH configuration and the authentication
262
- process.
263
- </p>
264
- <p>The only thing left is to automate the execution of the fate.sh script and
265
- the synchronisation of the samples directory.
266
- </p>
267
- </div>
268
- <div class="chapter-level-extent" id="Uploading-new-samples-to-the-fate-suite">
269
- <h2 class="chapter"><span>4 Uploading new samples to the fate suite<a class="copiable-link" href="#Uploading-new-samples-to-the-fate-suite"> &para;</a></span></h2>
270
-
271
- <p>If you need a sample uploaded send a mail to samples-request.
272
- </p>
273
- <p>This is for developers who have an account on the fate suite server.
274
- If you upload new samples, please make sure they are as small as possible,
275
- space on each client, network bandwidth and so on benefit from smaller test cases.
276
- Also keep in mind older checkouts use existing sample files, that means in
277
- practice generally do not replace, remove or overwrite files as it likely would
278
- break older checkouts or releases.
279
- Also all needed samples for a commit should be uploaded, ideally 24
280
- hours, before the push.
281
- If you need an account for frequently uploading samples or you wish to help
282
- others by doing that send a mail to ffmpeg-devel.
283
- </p>
284
- <div class="example">
285
- <pre class="example-preformatted">#First update your local samples copy:
286
- rsync -vauL --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X fate-suite.ffmpeg.org:/home/samples/fate-suite/ ~/fate-suite
287
-
288
- #Then do a dry run checking what would be uploaded:
289
- rsync -vanL --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite
290
-
291
- #Upload the files:
292
- rsync -vaL --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite
293
- </pre></div>
294
-
295
-
296
- </div>
297
- <div class="chapter-level-extent" id="FATE-makefile-targets-and-variables">
298
- <h2 class="chapter"><span>5 FATE makefile targets and variables<a class="copiable-link" href="#FATE-makefile-targets-and-variables"> &para;</a></span></h2>
299
-
300
- <ul class="mini-toc">
301
- <li><a href="#Makefile-targets" accesskey="1">Makefile targets</a></li>
302
- <li><a href="#Makefile-variables" accesskey="2">Makefile variables</a></li>
303
- <li><a href="#Examples" accesskey="3">Examples</a></li>
304
- </ul>
305
- <div class="section-level-extent" id="Makefile-targets">
306
- <h3 class="section"><span>5.1 Makefile targets<a class="copiable-link" href="#Makefile-targets"> &para;</a></span></h3>
307
-
308
- <dl class="table">
309
- <dt><samp class="option">fate-rsync</samp></dt>
310
- <dd><p>Download/synchronize sample files to the configured samples directory.
311
- </p>
312
- </dd>
313
- <dt><samp class="option">fate-list</samp></dt>
314
- <dd><p>Will list all fate/regression test targets.
315
- </p>
316
- </dd>
317
- <dt><samp class="option">fate</samp></dt>
318
- <dd><p>Run the FATE test suite (requires the fate-suite dataset).
319
- </p></dd>
320
- </dl>
321
-
322
- </div>
323
- <div class="section-level-extent" id="Makefile-variables">
324
- <h3 class="section"><span>5.2 Makefile variables<a class="copiable-link" href="#Makefile-variables"> &para;</a></span></h3>
325
-
326
- <dl class="table">
327
- <dt><code class="env">V</code></dt>
328
- <dd><p>Verbosity level, can be set to 0, 1 or 2.
329
- </p><ul class="itemize mark-bullet">
330
- <li>0: show just the test arguments
331
- </li><li>1: show just the command used in the test
332
- </li><li>2: show everything
333
- </li></ul>
334
-
335
- </dd>
336
- <dt><code class="env">SAMPLES</code></dt>
337
- <dd><p>Specify or override the path to the FATE samples at make time, it has a
338
- meaning only while running the regression tests.
339
- </p>
340
- </dd>
341
- <dt><code class="env">THREADS</code></dt>
342
- <dd><p>Specify how many threads to use while running regression tests, it is
343
- quite useful to detect thread-related regressions.
344
- </p>
345
- <p>This variable may be set to the string &quot;random&quot;, optionally followed by a
346
- number, like &quot;random99&quot;, This will cause each test to use a random number of
347
- threads. If a number is specified, it is used as a maximum number of threads,
348
- otherwise 16 is the maximum.
349
- </p>
350
- <p>In case a test fails, the thread count used for it will be written into the
351
- errfile.
352
- </p>
353
- </dd>
354
- <dt><code class="env">THREAD_TYPE</code></dt>
355
- <dd><p>Specify which threading strategy test, either &lsquo;<samp class="samp">slice</samp>&rsquo; or &lsquo;<samp class="samp">frame</samp>&rsquo;,
356
- by default &lsquo;<samp class="samp">slice+frame</samp>&rsquo;
357
- </p>
358
- </dd>
359
- <dt><code class="env">CPUFLAGS</code></dt>
360
- <dd><p>Specify CPU flags.
361
- </p>
362
- </dd>
363
- <dt><code class="env">TARGET_EXEC</code></dt>
364
- <dd><p>Specify or override the wrapper used to run the tests.
365
- The <code class="env">TARGET_EXEC</code> option provides a way to run FATE wrapped in
366
- <code class="command">valgrind</code>, <code class="command">qemu-user</code> or <code class="command">wine</code> or on remote targets
367
- through <code class="command">ssh</code>.
368
- </p>
369
- </dd>
370
- <dt><code class="env">GEN</code></dt>
371
- <dd><p>Set to &lsquo;<samp class="samp">1</samp>&rsquo; to generate the missing or mismatched references.
372
- </p>
373
- </dd>
374
- <dt><code class="env">HWACCEL</code></dt>
375
- <dd><p>Specify which hardware acceleration to use while running regression tests,
376
- by default &lsquo;<samp class="samp">none</samp>&rsquo; is used.
377
- </p>
378
- </dd>
379
- <dt><code class="env">KEEP</code></dt>
380
- <dd><p>Set to &lsquo;<samp class="samp">1</samp>&rsquo; to keep temp files generated by fate test(s) when test is successful.
381
- Default is &lsquo;<samp class="samp">0</samp>&rsquo;, which removes these files. Files are always kept when a test
382
- fails.
383
- </p>
384
- </dd>
385
- </dl>
386
-
387
- </div>
388
- <div class="section-level-extent" id="Examples">
389
- <h3 class="section"><span>5.3 Examples<a class="copiable-link" href="#Examples"> &para;</a></span></h3>
390
-
391
- <div class="example">
392
- <pre class="example-preformatted">make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
393
- </pre></div>
394
- </div>
395
- </div>
396
- <p style="font-size: small;">
397
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
398
- </p>
399
- </div>
400
- </body>
401
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffmpeg-all.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-bitstream-filters.html DELETED
@@ -1,1381 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Bitstream Filters Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Bitstream Filters Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-Bitstream-Filters" href="#Bitstream-Filters">2 Bitstream Filters</a>
30
- <ul class="toc-numbered-mark">
31
- <li><a id="toc-aac_005fadtstoasc" href="#aac_005fadtstoasc">2.1 aac_adtstoasc</a></li>
32
- <li><a id="toc-av1_005fmetadata" href="#av1_005fmetadata">2.2 av1_metadata</a></li>
33
- <li><a id="toc-chomp" href="#chomp">2.3 chomp</a></li>
34
- <li><a id="toc-dca_005fcore" href="#dca_005fcore">2.4 dca_core</a></li>
35
- <li><a id="toc-dovi_005frpu" href="#dovi_005frpu">2.5 dovi_rpu</a></li>
36
- <li><a id="toc-dump_005fextra" href="#dump_005fextra">2.6 dump_extra</a></li>
37
- <li><a id="toc-dv_005ferror_005fmarker" href="#dv_005ferror_005fmarker">2.7 dv_error_marker</a></li>
38
- <li><a id="toc-eac3_005fcore" href="#eac3_005fcore">2.8 eac3_core</a></li>
39
- <li><a id="toc-extract_005fextradata" href="#extract_005fextradata">2.9 extract_extradata</a></li>
40
- <li><a id="toc-filter_005funits" href="#filter_005funits">2.10 filter_units</a></li>
41
- <li><a id="toc-hapqa_005fextract" href="#hapqa_005fextract">2.11 hapqa_extract</a></li>
42
- <li><a id="toc-h264_005fmetadata" href="#h264_005fmetadata">2.12 h264_metadata</a></li>
43
- <li><a id="toc-h264_005fmp4toannexb" href="#h264_005fmp4toannexb">2.13 h264_mp4toannexb</a></li>
44
- <li><a id="toc-h264_005fredundant_005fpps" href="#h264_005fredundant_005fpps">2.14 h264_redundant_pps</a></li>
45
- <li><a id="toc-hevc_005fmetadata" href="#hevc_005fmetadata">2.15 hevc_metadata</a></li>
46
- <li><a id="toc-hevc_005fmp4toannexb" href="#hevc_005fmp4toannexb">2.16 hevc_mp4toannexb</a></li>
47
- <li><a id="toc-imxdump" href="#imxdump">2.17 imxdump</a></li>
48
- <li><a id="toc-mjpeg2jpeg" href="#mjpeg2jpeg">2.18 mjpeg2jpeg</a></li>
49
- <li><a id="toc-mjpegadump" href="#mjpegadump">2.19 mjpegadump</a></li>
50
- <li><a id="toc-mov2textsub-1" href="#mov2textsub-1">2.20 mov2textsub</a></li>
51
- <li><a id="toc-mpeg2_005fmetadata" href="#mpeg2_005fmetadata">2.21 mpeg2_metadata</a></li>
52
- <li><a id="toc-mpeg4_005funpack_005fbframes" href="#mpeg4_005funpack_005fbframes">2.22 mpeg4_unpack_bframes</a></li>
53
- <li><a id="toc-noise" href="#noise">2.23 noise</a>
54
- <ul class="toc-numbered-mark">
55
- <li><a id="toc-Examples" href="#Examples">2.23.1 Examples</a></li>
56
- </ul></li>
57
- <li><a id="toc-null" href="#null">2.24 null</a></li>
58
- <li><a id="toc-pcm_005frechunk" href="#pcm_005frechunk">2.25 pcm_rechunk</a></li>
59
- <li><a id="toc-pgs_005fframe_005fmerge" href="#pgs_005fframe_005fmerge">2.26 pgs_frame_merge</a></li>
60
- <li><a id="toc-prores_005fmetadata" href="#prores_005fmetadata">2.27 prores_metadata</a></li>
61
- <li><a id="toc-remove_005fextra" href="#remove_005fextra">2.28 remove_extra</a></li>
62
- <li><a id="toc-setts" href="#setts">2.29 setts</a></li>
63
- <li><a id="toc-showinfo" href="#showinfo">2.30 showinfo</a></li>
64
- <li><a id="toc-text2movsub-1" href="#text2movsub-1">2.31 text2movsub</a></li>
65
- <li><a id="toc-trace_005fheaders" href="#trace_005fheaders">2.32 trace_headers</a></li>
66
- <li><a id="toc-truehd_005fcore" href="#truehd_005fcore">2.33 truehd_core</a></li>
67
- <li><a id="toc-vp9_005fmetadata" href="#vp9_005fmetadata">2.34 vp9_metadata</a></li>
68
- <li><a id="toc-vp9_005fsuperframe" href="#vp9_005fsuperframe">2.35 vp9_superframe</a></li>
69
- <li><a id="toc-vp9_005fsuperframe_005fsplit" href="#vp9_005fsuperframe_005fsplit">2.36 vp9_superframe_split</a></li>
70
- <li><a id="toc-vp9_005fraw_005freorder" href="#vp9_005fraw_005freorder">2.37 vp9_raw_reorder</a></li>
71
- </ul></li>
72
- <li><a id="toc-See-Also" href="#See-Also">3 See Also</a></li>
73
- <li><a id="toc-Authors" href="#Authors">4 Authors</a></li>
74
- </ul>
75
- </div>
76
- </div>
77
-
78
- <ul class="mini-toc">
79
- <li><a href="#Description" accesskey="1">Description</a></li>
80
- <li><a href="#Bitstream-Filters" accesskey="2">Bitstream Filters</a></li>
81
- <li><a href="#See-Also" accesskey="3">See Also</a></li>
82
- <li><a href="#Authors" accesskey="4">Authors</a></li>
83
- </ul>
84
- <div class="chapter-level-extent" id="Description">
85
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
86
-
87
- <p>This document describes the bitstream filters provided by the
88
- libavcodec library.
89
- </p>
90
- <p>A bitstream filter operates on the encoded stream data, and performs
91
- bitstream level modifications without performing decoding.
92
- </p>
93
-
94
- </div>
95
- <div class="chapter-level-extent" id="Bitstream-Filters">
96
- <h2 class="chapter"><span>2 Bitstream Filters<a class="copiable-link" href="#Bitstream-Filters"> &para;</a></span></h2>
97
-
98
- <p>When you configure your FFmpeg build, all the supported bitstream
99
- filters are enabled by default. You can list all available ones using
100
- the configure option <code class="code">--list-bsfs</code>.
101
- </p>
102
- <p>You can disable all the bitstream filters using the configure option
103
- <code class="code">--disable-bsfs</code>, and selectively enable any bitstream filter using
104
- the option <code class="code">--enable-bsf=BSF</code>, or you can disable a particular
105
- bitstream filter using the option <code class="code">--disable-bsf=BSF</code>.
106
- </p>
107
- <p>The option <code class="code">-bsfs</code> of the ff* tools will display the list of
108
- all the supported bitstream filters included in your build.
109
- </p>
110
- <p>The ff* tools have a -bsf option applied per stream, taking a
111
- comma-separated list of filters, whose parameters follow the filter
112
- name after a &rsquo;=&rsquo;.
113
- </p>
114
- <div class="example">
115
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
116
- </pre></div>
117
-
118
- <p>Below is a description of the currently available bitstream filters,
119
- with their parameters, if any.
120
- </p>
121
- <ul class="mini-toc">
122
- <li><a href="#aac_005fadtstoasc" accesskey="1">aac_adtstoasc</a></li>
123
- <li><a href="#av1_005fmetadata" accesskey="2">av1_metadata</a></li>
124
- <li><a href="#chomp" accesskey="3">chomp</a></li>
125
- <li><a href="#dca_005fcore" accesskey="4">dca_core</a></li>
126
- <li><a href="#dovi_005frpu" accesskey="5">dovi_rpu</a></li>
127
- <li><a href="#dump_005fextra" accesskey="6">dump_extra</a></li>
128
- <li><a href="#dv_005ferror_005fmarker" accesskey="7">dv_error_marker</a></li>
129
- <li><a href="#eac3_005fcore" accesskey="8">eac3_core</a></li>
130
- <li><a href="#extract_005fextradata" accesskey="9">extract_extradata</a></li>
131
- <li><a href="#filter_005funits">filter_units</a></li>
132
- <li><a href="#hapqa_005fextract">hapqa_extract</a></li>
133
- <li><a href="#h264_005fmetadata">h264_metadata</a></li>
134
- <li><a href="#h264_005fmp4toannexb">h264_mp4toannexb</a></li>
135
- <li><a href="#h264_005fredundant_005fpps">h264_redundant_pps</a></li>
136
- <li><a href="#hevc_005fmetadata">hevc_metadata</a></li>
137
- <li><a href="#hevc_005fmp4toannexb">hevc_mp4toannexb</a></li>
138
- <li><a href="#imxdump">imxdump</a></li>
139
- <li><a href="#mjpeg2jpeg">mjpeg2jpeg</a></li>
140
- <li><a href="#mjpegadump">mjpegadump</a></li>
141
- <li><a href="#mov2textsub-1">mov2textsub</a></li>
142
- <li><a href="#mpeg2_005fmetadata">mpeg2_metadata</a></li>
143
- <li><a href="#mpeg4_005funpack_005fbframes">mpeg4_unpack_bframes</a></li>
144
- <li><a href="#noise">noise</a></li>
145
- <li><a href="#null">null</a></li>
146
- <li><a href="#pcm_005frechunk">pcm_rechunk</a></li>
147
- <li><a href="#pgs_005fframe_005fmerge">pgs_frame_merge</a></li>
148
- <li><a href="#prores_005fmetadata">prores_metadata</a></li>
149
- <li><a href="#remove_005fextra">remove_extra</a></li>
150
- <li><a href="#setts">setts</a></li>
151
- <li><a href="#showinfo">showinfo</a></li>
152
- <li><a href="#text2movsub-1">text2movsub</a></li>
153
- <li><a href="#trace_005fheaders">trace_headers</a></li>
154
- <li><a href="#truehd_005fcore">truehd_core</a></li>
155
- <li><a href="#vp9_005fmetadata">vp9_metadata</a></li>
156
- <li><a href="#vp9_005fsuperframe">vp9_superframe</a></li>
157
- <li><a href="#vp9_005fsuperframe_005fsplit">vp9_superframe_split</a></li>
158
- <li><a href="#vp9_005fraw_005freorder">vp9_raw_reorder</a></li>
159
- </ul>
160
- <div class="section-level-extent" id="aac_005fadtstoasc">
161
- <h3 class="section"><span>2.1 aac_adtstoasc<a class="copiable-link" href="#aac_005fadtstoasc"> &para;</a></span></h3>
162
-
163
- <p>Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration
164
- bitstream.
165
- </p>
166
- <p>This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4
167
- ADTS header and removes the ADTS header.
168
- </p>
169
- <p>This filter is required for example when copying an AAC stream from a
170
- raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
171
- to MOV/MP4 files and related formats such as 3GP or M4A. Please note
172
- that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
173
- </p>
174
- </div>
175
- <div class="section-level-extent" id="av1_005fmetadata">
176
- <h3 class="section"><span>2.2 av1_metadata<a class="copiable-link" href="#av1_005fmetadata"> &para;</a></span></h3>
177
-
178
- <p>Modify metadata embedded in an AV1 stream.
179
- </p>
180
- <dl class="table">
181
- <dt><samp class="option">td</samp></dt>
182
- <dd><p>Insert or remove temporal delimiter OBUs in all temporal units of the
183
- stream.
184
- </p>
185
- <dl class="table">
186
- <dt>&lsquo;<samp class="samp">insert</samp>&rsquo;</dt>
187
- <dd><p>Insert a TD at the beginning of every TU which does not already have one.
188
- </p></dd>
189
- <dt>&lsquo;<samp class="samp">remove</samp>&rsquo;</dt>
190
- <dd><p>Remove the TD from the beginning of every TU which has one.
191
- </p></dd>
192
- </dl>
193
-
194
- </dd>
195
- <dt><samp class="option">color_primaries</samp></dt>
196
- <dt><samp class="option">transfer_characteristics</samp></dt>
197
- <dt><samp class="option">matrix_coefficients</samp></dt>
198
- <dd><p>Set the color description fields in the stream (see AV1 section 6.4.2).
199
- </p>
200
- </dd>
201
- <dt><samp class="option">color_range</samp></dt>
202
- <dd><p>Set the color range in the stream (see AV1 section 6.4.2; note that
203
- this cannot be set for streams using BT.709 primaries, sRGB transfer
204
- characteristic and identity (RGB) matrix coefficients).
205
- </p><dl class="table">
206
- <dt>&lsquo;<samp class="samp">tv</samp>&rsquo;</dt>
207
- <dd><p>Limited range.
208
- </p></dd>
209
- <dt>&lsquo;<samp class="samp">pc</samp>&rsquo;</dt>
210
- <dd><p>Full range.
211
- </p></dd>
212
- </dl>
213
-
214
- </dd>
215
- <dt><samp class="option">chroma_sample_position</samp></dt>
216
- <dd><p>Set the chroma sample location in the stream (see AV1 section 6.4.2).
217
- This can only be set for 4:2:0 streams.
218
- </p>
219
- <dl class="table">
220
- <dt>&lsquo;<samp class="samp">vertical</samp>&rsquo;</dt>
221
- <dd><p>Left position (matching the default in MPEG-2 and H.264).
222
- </p></dd>
223
- <dt>&lsquo;<samp class="samp">colocated</samp>&rsquo;</dt>
224
- <dd><p>Top-left position.
225
- </p></dd>
226
- </dl>
227
-
228
- </dd>
229
- <dt><samp class="option">tick_rate</samp></dt>
230
- <dd><p>Set the tick rate (<em class="emph">time_scale / num_units_in_display_tick</em>) in
231
- the timing info in the sequence header.
232
- </p></dd>
233
- <dt><samp class="option">num_ticks_per_picture</samp></dt>
234
- <dd><p>Set the number of ticks in each picture, to indicate that the stream
235
- has a fixed framerate. Ignored if <samp class="option">tick_rate</samp> is not also set.
236
- </p>
237
- </dd>
238
- <dt><samp class="option">delete_padding</samp></dt>
239
- <dd><p>Deletes Padding OBUs.
240
- </p>
241
- </dd>
242
- </dl>
243
-
244
- </div>
245
- <div class="section-level-extent" id="chomp">
246
- <h3 class="section"><span>2.3 chomp<a class="copiable-link" href="#chomp"> &para;</a></span></h3>
247
-
248
- <p>Remove zero padding at the end of a packet.
249
- </p>
250
- </div>
251
- <div class="section-level-extent" id="dca_005fcore">
252
- <h3 class="section"><span>2.4 dca_core<a class="copiable-link" href="#dca_005fcore"> &para;</a></span></h3>
253
-
254
- <p>Extract the core from a DCA/DTS stream, dropping extensions such as
255
- DTS-HD.
256
- </p>
257
- </div>
258
- <div class="section-level-extent" id="dovi_005frpu">
259
- <h3 class="section"><span>2.5 dovi_rpu<a class="copiable-link" href="#dovi_005frpu"> &para;</a></span></h3>
260
-
261
- <p>Manipulate Dolby Vision metadata in a HEVC/AV1 bitstream, optionally enabling
262
- metadata compression.
263
- </p>
264
- <dl class="table">
265
- <dt><samp class="option">strip</samp></dt>
266
- <dd><p>If enabled, strip all Dolby Vision metadata (configuration record + RPU data
267
- blocks) from the stream.
268
- </p></dd>
269
- <dt><samp class="option">compression</samp></dt>
270
- <dd><p>Which compression level to enable.
271
- </p><dl class="table">
272
- <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
273
- <dd><p>No metadata compression.
274
- </p></dd>
275
- <dt>&lsquo;<samp class="samp">limited</samp>&rsquo;</dt>
276
- <dd><p>Limited metadata compression scheme. Should be compatible with most devices.
277
- This is the default.
278
- </p></dd>
279
- <dt>&lsquo;<samp class="samp">extended</samp>&rsquo;</dt>
280
- <dd><p>Extended metadata compression. Devices are not required to support this. Note
281
- that this level currently behaves the same as &lsquo;<samp class="samp">limited</samp>&rsquo; in libavcodec.
282
- </p></dd>
283
- </dl>
284
- </dd>
285
- </dl>
286
-
287
- </div>
288
- <div class="section-level-extent" id="dump_005fextra">
289
- <h3 class="section"><span>2.6 dump_extra<a class="copiable-link" href="#dump_005fextra"> &para;</a></span></h3>
290
-
291
- <p>Add extradata to the beginning of the filtered packets except when
292
- said packets already exactly begin with the extradata that is intended
293
- to be added.
294
- </p>
295
- <dl class="table">
296
- <dt><samp class="option">freq</samp></dt>
297
- <dd><p>The additional argument specifies which packets should be filtered.
298
- It accepts the values:
299
- </p><dl class="table">
300
- <dt>&lsquo;<samp class="samp">k</samp>&rsquo;</dt>
301
- <dt>&lsquo;<samp class="samp">keyframe</samp>&rsquo;</dt>
302
- <dd><p>add extradata to all key packets
303
- </p>
304
- </dd>
305
- <dt>&lsquo;<samp class="samp">e</samp>&rsquo;</dt>
306
- <dt>&lsquo;<samp class="samp">all</samp>&rsquo;</dt>
307
- <dd><p>add extradata to all packets
308
- </p></dd>
309
- </dl>
310
- </dd>
311
- </dl>
312
-
313
- <p>If not specified it is assumed &lsquo;<samp class="samp">k</samp>&rsquo;.
314
- </p>
315
- <p>For example the following <code class="command">ffmpeg</code> command forces a global
316
- header (thus disabling individual packet headers) in the H.264 packets
317
- generated by the <code class="code">libx264</code> encoder, but corrects them by adding
318
- the header stored in extradata to the key packets:
319
- </p><div class="example">
320
- <pre class="example-preformatted">ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
321
- </pre></div>
322
-
323
- </div>
324
- <div class="section-level-extent" id="dv_005ferror_005fmarker">
325
- <h3 class="section"><span>2.7 dv_error_marker<a class="copiable-link" href="#dv_005ferror_005fmarker"> &para;</a></span></h3>
326
-
327
- <p>Blocks in DV which are marked as damaged are replaced by blocks of the specified color.
328
- </p>
329
- <dl class="table">
330
- <dt><samp class="option">color</samp></dt>
331
- <dd><p>The color to replace damaged blocks by
332
- </p></dd>
333
- <dt><samp class="option">sta</samp></dt>
334
- <dd><p>A 16 bit mask which specifies which of the 16 possible error status values are
335
- to be replaced by colored blocks. 0xFFFE is the default which replaces all non 0
336
- error status values.
337
- </p><dl class="table">
338
- <dt>&lsquo;<samp class="samp">ok</samp>&rsquo;</dt>
339
- <dd><p>No error, no concealment
340
- </p></dd>
341
- <dt>&lsquo;<samp class="samp">err</samp>&rsquo;</dt>
342
- <dd><p>Error, No concealment
343
- </p></dd>
344
- <dt>&lsquo;<samp class="samp">res</samp>&rsquo;</dt>
345
- <dd><p>Reserved
346
- </p></dd>
347
- <dt>&lsquo;<samp class="samp">notok</samp>&rsquo;</dt>
348
- <dd><p>Error or concealment
349
- </p></dd>
350
- <dt>&lsquo;<samp class="samp">notres</samp>&rsquo;</dt>
351
- <dd><p>Not reserved
352
- </p></dd>
353
- <dt>&lsquo;<samp class="samp">Aa, Ba, Ca, Ab, Bb, Cb, A, B, C, a, b, erri, erru</samp>&rsquo;</dt>
354
- <dd><p>The specific error status code
355
- </p></dd>
356
- </dl>
357
- <p>see page 44-46 or section 5.5 of
358
- <a class="url" href="http://web.archive.org/web/20060927044735/http://www.smpte.org/smpte_store/standards/pdf/s314m.pdf">http://web.archive.org/web/20060927044735/http://www.smpte.org/smpte_store/standards/pdf/s314m.pdf</a>
359
- </p>
360
- </dd>
361
- </dl>
362
-
363
- </div>
364
- <div class="section-level-extent" id="eac3_005fcore">
365
- <h3 class="section"><span>2.8 eac3_core<a class="copiable-link" href="#eac3_005fcore"> &para;</a></span></h3>
366
-
367
- <p>Extract the core from a E-AC-3 stream, dropping extra channels.
368
- </p>
369
- </div>
370
- <div class="section-level-extent" id="extract_005fextradata">
371
- <h3 class="section"><span>2.9 extract_extradata<a class="copiable-link" href="#extract_005fextradata"> &para;</a></span></h3>
372
-
373
- <p>Extract the in-band extradata.
374
- </p>
375
- <p>Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers,
376
- or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either &quot;in-band&quot; (i.e. as a part
377
- of the bitstream containing the coded frames) or &quot;out of band&quot; (e.g. on the
378
- container level). This latter form is called &quot;extradata&quot; in FFmpeg terminology.
379
- </p>
380
- <p>This bitstream filter detects the in-band headers and makes them available as
381
- extradata.
382
- </p>
383
- <dl class="table">
384
- <dt><samp class="option">remove</samp></dt>
385
- <dd><p>When this option is enabled, the long-term headers are removed from the
386
- bitstream after extraction.
387
- </p></dd>
388
- </dl>
389
-
390
- </div>
391
- <div class="section-level-extent" id="filter_005funits">
392
- <h3 class="section"><span>2.10 filter_units<a class="copiable-link" href="#filter_005funits"> &para;</a></span></h3>
393
-
394
- <p>Remove units with types in or not in a given set from the stream.
395
- </p>
396
- <dl class="table">
397
- <dt><samp class="option">pass_types</samp></dt>
398
- <dd><p>List of unit types or ranges of unit types to pass through while removing
399
- all others. This is specified as a &rsquo;|&rsquo;-separated list of unit type values
400
- or ranges of values with &rsquo;-&rsquo;.
401
- </p>
402
- </dd>
403
- <dt><samp class="option">remove_types</samp></dt>
404
- <dd><p>Identical to <samp class="option">pass_types</samp>, except the units in the given set
405
- removed and all others passed through.
406
- </p></dd>
407
- </dl>
408
-
409
- <p>The types used by pass_types and remove_types correspond to NAL unit types
410
- (nal_unit_type) in H.264, HEVC and H.266 (see Table 7-1 in the H.264
411
- and HEVC specifications or Table 5 in the H.266 specification), to
412
- marker values for JPEG (without 0xFF prefix) and to start codes without
413
- start code prefix (i.e. the byte following the 0x000001) for MPEG-2.
414
- For VP8 and VP9, every unit has type zero.
415
- </p>
416
- <p>Extradata is unchanged by this transformation, but note that if the stream
417
- contains inline parameter sets then the output may be unusable if they are
418
- removed.
419
- </p>
420
- <p>For example, to remove all non-VCL NAL units from an H.264 stream:
421
- </p><div class="example">
422
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
423
- </pre></div>
424
-
425
- <p>To remove all AUDs, SEI and filler from an H.265 stream:
426
- </p><div class="example">
427
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
428
- </pre></div>
429
-
430
- <p>To remove all user data from a MPEG-2 stream, including Closed Captions:
431
- </p><div class="example">
432
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=178' OUTPUT
433
- </pre></div>
434
-
435
- <p>To remove all SEI from a H264 stream, including Closed Captions:
436
- </p><div class="example">
437
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=6' OUTPUT
438
- </pre></div>
439
-
440
- <p>To remove all prefix and suffix SEI from a HEVC stream, including Closed Captions and dynamic HDR:
441
- </p><div class="example">
442
- <pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=39|40' OUTPUT
443
- </pre></div>
444
-
445
- </div>
446
- <div class="section-level-extent" id="hapqa_005fextract">
447
- <h3 class="section"><span>2.11 hapqa_extract<a class="copiable-link" href="#hapqa_005fextract"> &para;</a></span></h3>
448
-
449
- <p>Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file.
450
- </p>
451
- <dl class="table">
452
- <dt><samp class="option">texture</samp></dt>
453
- <dd><p>Specifies the texture to keep.
454
- </p>
455
- <dl class="table">
456
- <dt><samp class="option">color</samp></dt>
457
- <dt><samp class="option">alpha</samp></dt>
458
- </dl>
459
-
460
- </dd>
461
- </dl>
462
-
463
- <p>Convert HAPQA to HAPQ
464
- </p><div class="example">
465
- <pre class="example-preformatted">ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder=&quot;HAPQ&quot; hapq_file.mov
466
- </pre></div>
467
-
468
- <p>Convert HAPQA to HAPAlphaOnly
469
- </p><div class="example">
470
- <pre class="example-preformatted">ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder=&quot;HAPAlpha Only&quot; hapalphaonly_file.mov
471
- </pre></div>
472
-
473
- </div>
474
- <div class="section-level-extent" id="h264_005fmetadata">
475
- <h3 class="section"><span>2.12 h264_metadata<a class="copiable-link" href="#h264_005fmetadata"> &para;</a></span></h3>
476
-
477
- <p>Modify metadata embedded in an H.264 stream.
478
- </p>
479
- <dl class="table">
480
- <dt><samp class="option">aud</samp></dt>
481
- <dd><p>Insert or remove AUD NAL units in all access units of the stream.
482
- </p>
483
- <dl class="table">
484
- <dt>&lsquo;<samp class="samp">pass</samp>&rsquo;</dt>
485
- <dt>&lsquo;<samp class="samp">insert</samp>&rsquo;</dt>
486
- <dt>&lsquo;<samp class="samp">remove</samp>&rsquo;</dt>
487
- </dl>
488
-
489
- <p>Default is pass.
490
- </p>
491
- </dd>
492
- <dt><samp class="option">sample_aspect_ratio</samp></dt>
493
- <dd><p>Set the sample aspect ratio of the stream in the VUI parameters.
494
- See H.264 table E-1.
495
- </p>
496
- </dd>
497
- <dt><samp class="option">overscan_appropriate_flag</samp></dt>
498
- <dd><p>Set whether the stream is suitable for display using overscan
499
- or not (see H.264 section E.2.1).
500
- </p>
501
- </dd>
502
- <dt><samp class="option">video_format</samp></dt>
503
- <dt><samp class="option">video_full_range_flag</samp></dt>
504
- <dd><p>Set the video format in the stream (see H.264 section E.2.1 and
505
- table E-2).
506
- </p>
507
- </dd>
508
- <dt><samp class="option">colour_primaries</samp></dt>
509
- <dt><samp class="option">transfer_characteristics</samp></dt>
510
- <dt><samp class="option">matrix_coefficients</samp></dt>
511
- <dd><p>Set the colour description in the stream (see H.264 section E.2.1
512
- and tables E-3, E-4 and E-5).
513
- </p>
514
- </dd>
515
- <dt><samp class="option">chroma_sample_loc_type</samp></dt>
516
- <dd><p>Set the chroma sample location in the stream (see H.264 section
517
- E.2.1 and figure E-1).
518
- </p>
519
- </dd>
520
- <dt><samp class="option">tick_rate</samp></dt>
521
- <dd><p>Set the tick rate (time_scale / num_units_in_tick) in the VUI
522
- parameters. This is the smallest time unit representable in the
523
- stream, and in many cases represents the field rate of the stream
524
- (double the frame rate).
525
- </p></dd>
526
- <dt><samp class="option">fixed_frame_rate_flag</samp></dt>
527
- <dd><p>Set whether the stream has fixed framerate - typically this indicates
528
- that the framerate is exactly half the tick rate, but the exact
529
- meaning is dependent on interlacing and the picture structure (see
530
- H.264 section E.2.1 and table E-6).
531
- </p></dd>
532
- <dt><samp class="option">zero_new_constraint_set_flags</samp></dt>
533
- <dd><p>Zero constraint_set4_flag and constraint_set5_flag in the SPS. These
534
- bits were reserved in a previous version of the H.264 spec, and thus
535
- some hardware decoders require these to be zero. The result of zeroing
536
- this is still a valid bitstream.
537
- </p>
538
- </dd>
539
- <dt><samp class="option">crop_left</samp></dt>
540
- <dt><samp class="option">crop_right</samp></dt>
541
- <dt><samp class="option">crop_top</samp></dt>
542
- <dt><samp class="option">crop_bottom</samp></dt>
543
- <dd><p>Set the frame cropping offsets in the SPS. These values will replace
544
- the current ones if the stream is already cropped.
545
- </p>
546
- <p>These fields are set in pixels. Note that some sizes may not be
547
- representable if the chroma is subsampled or the stream is interlaced
548
- (see H.264 section 7.4.2.1.1).
549
- </p>
550
- </dd>
551
- <dt><samp class="option">sei_user_data</samp></dt>
552
- <dd><p>Insert a string as SEI unregistered user data. The argument must
553
- be of the form <em class="emph">UUID+string</em>, where the UUID is as hex digits
554
- possibly separated by hyphens, and the string can be anything.
555
- </p>
556
- <p>For example, &lsquo;<samp class="samp">086f3693-b7b3-4f2c-9653-21492feee5b8+hello</samp>&rsquo; will
557
- insert the string &ldquo;hello&rdquo; associated with the given UUID.
558
- </p>
559
- </dd>
560
- <dt><samp class="option">delete_filler</samp></dt>
561
- <dd><p>Deletes both filler NAL units and filler SEI messages.
562
- </p>
563
- </dd>
564
- <dt><samp class="option">display_orientation</samp></dt>
565
- <dd><p>Insert, extract or remove Display orientation SEI messages.
566
- See H.264 section D.1.27 and D.2.27 for syntax and semantics.
567
- </p>
568
- <dl class="table">
569
- <dt>&lsquo;<samp class="samp">pass</samp>&rsquo;</dt>
570
- <dt>&lsquo;<samp class="samp">insert</samp>&rsquo;</dt>
571
- <dt>&lsquo;<samp class="samp">remove</samp>&rsquo;</dt>
572
- <dt>&lsquo;<samp class="samp">extract</samp>&rsquo;</dt>
573
- </dl>
574
-
575
- <p>Default is pass.
576
- </p>
577
- <p>Insert mode works in conjunction with <code class="code">rotate</code> and <code class="code">flip</code> options.
578
- Any pre-existing Display orientation messages will be removed in insert or remove mode.
579
- Extract mode attaches the display matrix to the packet as side data.
580
- </p>
581
- </dd>
582
- <dt><samp class="option">rotate</samp></dt>
583
- <dd><p>Set rotation in display orientation SEI (anticlockwise angle in degrees).
584
- Range is -360 to +360. Default is NaN.
585
- </p>
586
- </dd>
587
- <dt><samp class="option">flip</samp></dt>
588
- <dd><p>Set flip in display orientation SEI.
589
- </p>
590
- <dl class="table">
591
- <dt>&lsquo;<samp class="samp">horizontal</samp>&rsquo;</dt>
592
- <dt>&lsquo;<samp class="samp">vertical</samp>&rsquo;</dt>
593
- </dl>
594
-
595
- <p>Default is unset.
596
- </p>
597
- </dd>
598
- <dt><samp class="option">level</samp></dt>
599
- <dd><p>Set the level in the SPS. Refer to H.264 section A.3 and tables A-1
600
- to A-5.
601
- </p>
602
- <p>The argument must be the name of a level (for example, &lsquo;<samp class="samp">4.2</samp>&rsquo;), a
603
- level_idc value (for example, &lsquo;<samp class="samp">42</samp>&rsquo;), or the special name &lsquo;<samp class="samp">auto</samp>&rsquo;
604
- indicating that the filter should attempt to guess the level from the
605
- input stream properties.
606
- </p>
607
- </dd>
608
- </dl>
609
-
610
- </div>
611
- <div class="section-level-extent" id="h264_005fmp4toannexb">
612
- <h3 class="section"><span>2.13 h264_mp4toannexb<a class="copiable-link" href="#h264_005fmp4toannexb"> &para;</a></span></h3>
613
-
614
- <p>Convert an H.264 bitstream from length prefixed mode to start code
615
- prefixed mode (as defined in the Annex B of the ITU-T H.264
616
- specification).
617
- </p>
618
- <p>This is required by some streaming formats, typically the MPEG-2
619
- transport stream format (muxer <code class="code">mpegts</code>).
620
- </p>
621
- <p>For example to remux an MP4 file containing an H.264 stream to mpegts
622
- format with <code class="command">ffmpeg</code>, you can use the command:
623
- </p>
624
- <div class="example">
625
- <pre class="example-preformatted">ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
626
- </pre></div>
627
-
628
- <p>Please note that this filter is auto-inserted for MPEG-TS (muxer
629
- <code class="code">mpegts</code>) and raw H.264 (muxer <code class="code">h264</code>) output formats.
630
- </p>
631
- </div>
632
- <div class="section-level-extent" id="h264_005fredundant_005fpps">
633
- <h3 class="section"><span>2.14 h264_redundant_pps<a class="copiable-link" href="#h264_005fredundant_005fpps"> &para;</a></span></h3>
634
-
635
- <p>This applies a specific fixup to some Blu-ray BDMV H264 streams
636
- which contain redundant PPSs. The PPSs modify irrelevant parameters
637
- of the stream, confusing other transformations which require
638
- the correct extradata.
639
- </p>
640
- <p>The encoder used on these impacted streams adds extra PPSs throughout
641
- the stream, varying the initial QP and whether weighted prediction
642
- was enabled. This causes issues after copying the stream into
643
- a global header container, as the starting PPS is not suitable
644
- for the rest of the stream. One side effect, for example,
645
- is seeking will return garbled output until a new PPS appears.
646
- </p>
647
- <p>This BSF removes the extra PPSs and rewrites the slice headers
648
- such that the stream uses a single leading PPS in the global header,
649
- which resolves the issue.
650
- </p>
651
- </div>
652
- <div class="section-level-extent" id="hevc_005fmetadata">
653
- <h3 class="section"><span>2.15 hevc_metadata<a class="copiable-link" href="#hevc_005fmetadata"> &para;</a></span></h3>
654
-
655
- <p>Modify metadata embedded in an HEVC stream.
656
- </p>
657
- <dl class="table">
658
- <dt><samp class="option">aud</samp></dt>
659
- <dd><p>Insert or remove AUD NAL units in all access units of the stream.
660
- </p>
661
- <dl class="table">
662
- <dt>&lsquo;<samp class="samp">insert</samp>&rsquo;</dt>
663
- <dt>&lsquo;<samp class="samp">remove</samp>&rsquo;</dt>
664
- </dl>
665
-
666
- </dd>
667
- <dt><samp class="option">sample_aspect_ratio</samp></dt>
668
- <dd><p>Set the sample aspect ratio in the stream in the VUI parameters.
669
- </p>
670
- </dd>
671
- <dt><samp class="option">video_format</samp></dt>
672
- <dt><samp class="option">video_full_range_flag</samp></dt>
673
- <dd><p>Set the video format in the stream (see H.265 section E.3.1 and
674
- table E.2).
675
- </p>
676
- </dd>
677
- <dt><samp class="option">colour_primaries</samp></dt>
678
- <dt><samp class="option">transfer_characteristics</samp></dt>
679
- <dt><samp class="option">matrix_coefficients</samp></dt>
680
- <dd><p>Set the colour description in the stream (see H.265 section E.3.1
681
- and tables E.3, E.4 and E.5).
682
- </p>
683
- </dd>
684
- <dt><samp class="option">chroma_sample_loc_type</samp></dt>
685
- <dd><p>Set the chroma sample location in the stream (see H.265 section
686
- E.3.1 and figure E.1).
687
- </p>
688
- </dd>
689
- <dt><samp class="option">tick_rate</samp></dt>
690
- <dd><p>Set the tick rate in the VPS and VUI parameters (time_scale /
691
- num_units_in_tick). Combined with <samp class="option">num_ticks_poc_diff_one</samp>, this can
692
- set a constant framerate in the stream. Note that it is likely to be
693
- overridden by container parameters when the stream is in a container.
694
- </p>
695
- </dd>
696
- <dt><samp class="option">num_ticks_poc_diff_one</samp></dt>
697
- <dd><p>Set poc_proportional_to_timing_flag in VPS and VUI and use this value
698
- to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and
699
- E.3.1). Ignored if <samp class="option">tick_rate</samp> is not also set.
700
- </p>
701
- </dd>
702
- <dt><samp class="option">crop_left</samp></dt>
703
- <dt><samp class="option">crop_right</samp></dt>
704
- <dt><samp class="option">crop_top</samp></dt>
705
- <dt><samp class="option">crop_bottom</samp></dt>
706
- <dd><p>Set the conformance window cropping offsets in the SPS. These values
707
- will replace the current ones if the stream is already cropped.
708
- </p>
709
- <p>These fields are set in pixels. Note that some sizes may not be
710
- representable if the chroma is subsampled (H.265 section 7.4.3.2.1).
711
- </p>
712
- </dd>
713
- <dt><samp class="option">width</samp></dt>
714
- <dt><samp class="option">height</samp></dt>
715
- <dd><p>Set width and height after crop.
716
- </p>
717
- </dd>
718
- <dt><samp class="option">level</samp></dt>
719
- <dd><p>Set the level in the VPS and SPS. See H.265 section A.4 and tables
720
- A.6 and A.7.
721
- </p>
722
- <p>The argument must be the name of a level (for example, &lsquo;<samp class="samp">5.1</samp>&rsquo;), a
723
- <em class="emph">general_level_idc</em> value (for example, &lsquo;<samp class="samp">153</samp>&rsquo; for level 5.1),
724
- or the special name &lsquo;<samp class="samp">auto</samp>&rsquo; indicating that the filter should
725
- attempt to guess the level from the input stream properties.
726
- </p>
727
- </dd>
728
- </dl>
729
-
730
- </div>
731
- <div class="section-level-extent" id="hevc_005fmp4toannexb">
732
- <h3 class="section"><span>2.16 hevc_mp4toannexb<a class="copiable-link" href="#hevc_005fmp4toannexb"> &para;</a></span></h3>
733
-
734
- <p>Convert an HEVC/H.265 bitstream from length prefixed mode to start code
735
- prefixed mode (as defined in the Annex B of the ITU-T H.265
736
- specification).
737
- </p>
738
- <p>This is required by some streaming formats, typically the MPEG-2
739
- transport stream format (muxer <code class="code">mpegts</code>).
740
- </p>
741
- <p>For example to remux an MP4 file containing an HEVC stream to mpegts
742
- format with <code class="command">ffmpeg</code>, you can use the command:
743
- </p>
744
- <div class="example">
745
- <pre class="example-preformatted">ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
746
- </pre></div>
747
-
748
- <p>Please note that this filter is auto-inserted for MPEG-TS (muxer
749
- <code class="code">mpegts</code>) and raw HEVC/H.265 (muxer <code class="code">h265</code> or
750
- <code class="code">hevc</code>) output formats.
751
- </p>
752
- </div>
753
- <div class="section-level-extent" id="imxdump">
754
- <h3 class="section"><span>2.17 imxdump<a class="copiable-link" href="#imxdump"> &para;</a></span></h3>
755
-
756
- <p>Modifies the bitstream to fit in MOV and to be usable by the Final Cut
757
- Pro decoder. This filter only applies to the mpeg2video codec, and is
758
- likely not needed for Final Cut Pro 7 and newer with the appropriate
759
- <samp class="option">-tag:v</samp>.
760
- </p>
761
- <p>For example, to remux 30 MB/sec NTSC IMX to MOV:
762
- </p>
763
- <div class="example">
764
- <pre class="example-preformatted">ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
765
- </pre></div>
766
-
767
- </div>
768
- <div class="section-level-extent" id="mjpeg2jpeg">
769
- <h3 class="section"><span>2.18 mjpeg2jpeg<a class="copiable-link" href="#mjpeg2jpeg"> &para;</a></span></h3>
770
-
771
- <p>Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
772
- </p>
773
- <p>MJPEG is a video codec wherein each video frame is essentially a
774
- JPEG image. The individual frames can be extracted without loss,
775
- e.g. by
776
- </p>
777
- <div class="example">
778
- <pre class="example-preformatted">ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
779
- </pre></div>
780
-
781
- <p>Unfortunately, these chunks are incomplete JPEG images, because
782
- they lack the DHT segment required for decoding. Quoting from
783
- <a class="url" href="http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml">http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml</a>:
784
- </p>
785
- <p>Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
786
- commented that &quot;MJPEG, or at least the MJPEG in AVIs having the
787
- MJPG fourcc, is restricted JPEG with a fixed &ndash; and *omitted* &ndash;
788
- Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
789
- and it must use basic Huffman encoding, not arithmetic or
790
- progressive. . . . You can indeed extract the MJPEG frames and
791
- decode them with a regular JPEG decoder, but you have to prepend
792
- the DHT segment to them, or else the decoder won&rsquo;t have any idea
793
- how to decompress the data. The exact table necessary is given in
794
- the OpenDML spec.&quot;
795
- </p>
796
- <p>This bitstream filter patches the header of frames extracted from an MJPEG
797
- stream (carrying the AVI1 header ID and lacking a DHT segment) to
798
- produce fully qualified JPEG images.
799
- </p>
800
- <div class="example">
801
- <pre class="example-preformatted">ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
802
- exiftran -i -9 frame*.jpg
803
- ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
804
- </pre></div>
805
-
806
- </div>
807
- <div class="section-level-extent" id="mjpegadump">
808
- <h3 class="section"><span>2.19 mjpegadump<a class="copiable-link" href="#mjpegadump"> &para;</a></span></h3>
809
-
810
- <p>Add an MJPEG A header to the bitstream, to enable decoding by
811
- Quicktime.
812
- </p>
813
- <a class="anchor" id="mov2textsub"></a></div>
814
- <div class="section-level-extent" id="mov2textsub-1">
815
- <h3 class="section"><span>2.20 mov2textsub<a class="copiable-link" href="#mov2textsub-1"> &para;</a></span></h3>
816
-
817
- <p>Extract a representable text file from MOV subtitles, stripping the
818
- metadata header from each subtitle packet.
819
- </p>
820
- <p>See also the <a class="ref" href="#text2movsub">text2movsub</a> filter.
821
- </p>
822
- </div>
823
- <div class="section-level-extent" id="mpeg2_005fmetadata">
824
- <h3 class="section"><span>2.21 mpeg2_metadata<a class="copiable-link" href="#mpeg2_005fmetadata"> &para;</a></span></h3>
825
-
826
- <p>Modify metadata embedded in an MPEG-2 stream.
827
- </p>
828
- <dl class="table">
829
- <dt><samp class="option">display_aspect_ratio</samp></dt>
830
- <dd><p>Set the display aspect ratio in the stream.
831
- </p>
832
- <p>The following fixed values are supported:
833
- </p><dl class="table">
834
- <dt><samp class="option">4/3</samp></dt>
835
- <dt><samp class="option">16/9</samp></dt>
836
- <dt><samp class="option">221/100</samp></dt>
837
- </dl>
838
- <p>Any other value will result in square pixels being signalled instead
839
- (see H.262 section 6.3.3 and table 6-3).
840
- </p>
841
- </dd>
842
- <dt><samp class="option">frame_rate</samp></dt>
843
- <dd><p>Set the frame rate in the stream. This is constructed from a table
844
- of known values combined with a small multiplier and divisor - if
845
- the supplied value is not exactly representable, the nearest
846
- representable value will be used instead (see H.262 section 6.3.3
847
- and table 6-4).
848
- </p>
849
- </dd>
850
- <dt><samp class="option">video_format</samp></dt>
851
- <dd><p>Set the video format in the stream (see H.262 section 6.3.6 and
852
- table 6-6).
853
- </p>
854
- </dd>
855
- <dt><samp class="option">colour_primaries</samp></dt>
856
- <dt><samp class="option">transfer_characteristics</samp></dt>
857
- <dt><samp class="option">matrix_coefficients</samp></dt>
858
- <dd><p>Set the colour description in the stream (see H.262 section 6.3.6
859
- and tables 6-7, 6-8 and 6-9).
860
- </p>
861
- </dd>
862
- </dl>
863
-
864
- </div>
865
- <div class="section-level-extent" id="mpeg4_005funpack_005fbframes">
866
- <h3 class="section"><span>2.22 mpeg4_unpack_bframes<a class="copiable-link" href="#mpeg4_005funpack_005fbframes"> &para;</a></span></h3>
867
-
868
- <p>Unpack DivX-style packed B-frames.
869
- </p>
870
- <p>DivX-style packed B-frames are not valid MPEG-4 and were only a
871
- workaround for the broken Video for Windows subsystem.
872
- They use more space, can cause minor AV sync issues, require more
873
- CPU power to decode (unless the player has some decoded picture queue
874
- to compensate the 2,0,2,0 frame per packet style) and cause
875
- trouble if copied into a standard container like mp4 or mpeg-ps/ts,
876
- because MPEG-4 decoders may not be able to decode them, since they are
877
- not valid MPEG-4.
878
- </p>
879
- <p>For example to fix an AVI file containing an MPEG-4 stream with
880
- DivX-style packed B-frames using <code class="command">ffmpeg</code>, you can use the command:
881
- </p>
882
- <div class="example">
883
- <pre class="example-preformatted">ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
884
- </pre></div>
885
-
886
- </div>
887
- <div class="section-level-extent" id="noise">
888
- <h3 class="section"><span>2.23 noise<a class="copiable-link" href="#noise"> &para;</a></span></h3>
889
-
890
- <p>Damages the contents of packets or simply drops them without damaging the
891
- container. Can be used for fuzzing or testing error resilience/concealment.
892
- </p>
893
- <p>Parameters:
894
- </p><dl class="table">
895
- <dt><samp class="option">amount</samp></dt>
896
- <dd><p>Accepts an expression whose evaluation per-packet determines how often bytes in that
897
- packet will be modified. A value below 0 will result in a variable frequency.
898
- Default is 0 which results in no modification. However, if neither amount nor drop is specified,
899
- amount will be set to <var class="var">-1</var>. See below for accepted variables.
900
- </p></dd>
901
- <dt><samp class="option">drop</samp></dt>
902
- <dd><p>Accepts an expression evaluated per-packet whose value determines whether that packet is dropped.
903
- Evaluation to a positive value results in the packet being dropped. Evaluation to a negative
904
- value results in a variable chance of it being dropped, roughly inverse in proportion to the magnitude
905
- of the value. Default is 0 which results in no drops. See below for accepted variables.
906
- </p></dd>
907
- <dt><samp class="option">dropamount</samp></dt>
908
- <dd><p>Accepts a non-negative integer, which assigns a variable chance of it being dropped, roughly inverse
909
- in proportion to the value. Default is 0 which results in no drops. This option is kept for backwards
910
- compatibility and is equivalent to setting drop to a negative value with the same magnitude
911
- i.e. <code class="code">dropamount=4</code> is the same as <code class="code">drop=-4</code>. Ignored if drop is also specified.
912
- </p></dd>
913
- </dl>
914
-
915
- <p>Both <code class="code">amount</code> and <code class="code">drop</code> accept expressions containing the following variables:
916
- </p>
917
- <dl class="table">
918
- <dt>&lsquo;<samp class="samp">n</samp>&rsquo;</dt>
919
- <dd><p>The index of the packet, starting from zero.
920
- </p></dd>
921
- <dt>&lsquo;<samp class="samp">tb</samp>&rsquo;</dt>
922
- <dd><p>The timebase for packet timestamps.
923
- </p></dd>
924
- <dt>&lsquo;<samp class="samp">pts</samp>&rsquo;</dt>
925
- <dd><p>Packet presentation timestamp.
926
- </p></dd>
927
- <dt>&lsquo;<samp class="samp">dts</samp>&rsquo;</dt>
928
- <dd><p>Packet decoding timestamp.
929
- </p></dd>
930
- <dt>&lsquo;<samp class="samp">nopts</samp>&rsquo;</dt>
931
- <dd><p>Constant representing AV_NOPTS_VALUE.
932
- </p></dd>
933
- <dt>&lsquo;<samp class="samp">startpts</samp>&rsquo;</dt>
934
- <dd><p>First non-AV_NOPTS_VALUE PTS seen in the stream.
935
- </p></dd>
936
- <dt>&lsquo;<samp class="samp">startdts</samp>&rsquo;</dt>
937
- <dd><p>First non-AV_NOPTS_VALUE DTS seen in the stream.
938
- </p></dd>
939
- <dt>&lsquo;<samp class="samp">duration</samp>&rsquo;</dt>
940
- <dt>&lsquo;<samp class="samp">d</samp>&rsquo;</dt>
941
- <dd><p>Packet duration, in timebase units.
942
- </p></dd>
943
- <dt>&lsquo;<samp class="samp">pos</samp>&rsquo;</dt>
944
- <dd><p>Packet position in input; may be -1 when unknown or not set.
945
- </p></dd>
946
- <dt>&lsquo;<samp class="samp">size</samp>&rsquo;</dt>
947
- <dd><p>Packet size, in bytes.
948
- </p></dd>
949
- <dt>&lsquo;<samp class="samp">key</samp>&rsquo;</dt>
950
- <dd><p>Whether packet is marked as a keyframe.
951
- </p></dd>
952
- <dt>&lsquo;<samp class="samp">state</samp>&rsquo;</dt>
953
- <dd><p>A pseudo random integer, primarily derived from the content of packet payload.
954
- </p></dd>
955
- </dl>
956
-
957
- <ul class="mini-toc">
958
- <li><a href="#Examples" accesskey="1">Examples</a></li>
959
- </ul>
960
- <div class="subsection-level-extent" id="Examples">
961
- <h4 class="subsection"><span>2.23.1 Examples<a class="copiable-link" href="#Examples"> &para;</a></span></h4>
962
- <p>Apply modification to every byte but don&rsquo;t drop any packets.
963
- </p><div class="example">
964
- <pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf noise=1 output.mkv
965
- </pre></div>
966
-
967
- <p>Drop every video packet not marked as a keyframe after timestamp 30s but do not
968
- modify any of the remaining packets.
969
- </p><div class="example">
970
- <pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v noise=drop='gt(t\,30)*not(key)' output.mkv
971
- </pre></div>
972
-
973
- <p>Drop one second of audio every 10 seconds and add some random noise to the rest.
974
- </p><div class="example">
975
- <pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:a noise=amount=-1:drop='between(mod(t\,10)\,9\,10)' output.mkv
976
- </pre></div>
977
-
978
- </div>
979
- </div>
980
- <div class="section-level-extent" id="null">
981
- <h3 class="section"><span>2.24 null<a class="copiable-link" href="#null"> &para;</a></span></h3>
982
- <p>This bitstream filter passes the packets through unchanged.
983
- </p>
984
- </div>
985
- <div class="section-level-extent" id="pcm_005frechunk">
986
- <h3 class="section"><span>2.25 pcm_rechunk<a class="copiable-link" href="#pcm_005frechunk"> &para;</a></span></h3>
987
-
988
- <p>Repacketize PCM audio to a fixed number of samples per packet or a fixed packet
989
- rate per second. This is similar to the <a data-manual="ffmpeg-filters" href="ffmpeg-filters.html#asetnsamples">asetnsamples audio
990
- filter</a> but works on audio packets instead of audio frames.
991
- </p>
992
- <dl class="table">
993
- <dt><samp class="option">nb_out_samples, n</samp></dt>
994
- <dd><p>Set the number of samples per each output audio packet. The number is intended
995
- as the number of samples <em class="emph">per each channel</em>. Default value is 1024.
996
- </p>
997
- </dd>
998
- <dt><samp class="option">pad, p</samp></dt>
999
- <dd><p>If set to 1, the filter will pad the last audio packet with silence, so that it
1000
- will contain the same number of samples (or roughly the same number of samples,
1001
- see <samp class="option">frame_rate</samp>) as the previous ones. Default value is 1.
1002
- </p>
1003
- </dd>
1004
- <dt><samp class="option">frame_rate, r</samp></dt>
1005
- <dd><p>This option makes the filter output a fixed number of packets per second instead
1006
- of a fixed number of samples per packet. If the audio sample rate is not
1007
- divisible by the frame rate then the number of samples will not be constant but
1008
- will vary slightly so that each packet will start as close to the frame
1009
- boundary as possible. Using this option has precedence over <samp class="option">nb_out_samples</samp>.
1010
- </p></dd>
1011
- </dl>
1012
-
1013
- <p>You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio
1014
- for NTSC frame rate using the <samp class="option">frame_rate</samp> option.
1015
- </p><div class="example">
1016
- <pre class="example-preformatted">ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
1017
- </pre></div>
1018
-
1019
- </div>
1020
- <div class="section-level-extent" id="pgs_005fframe_005fmerge">
1021
- <h3 class="section"><span>2.26 pgs_frame_merge<a class="copiable-link" href="#pgs_005fframe_005fmerge"> &para;</a></span></h3>
1022
-
1023
- <p>Merge a sequence of PGS Subtitle segments ending with an &quot;end of display set&quot;
1024
- segment into a single packet.
1025
- </p>
1026
- <p>This is required by some containers that support PGS subtitles
1027
- (muxer <code class="code">matroska</code>).
1028
- </p>
1029
- </div>
1030
- <div class="section-level-extent" id="prores_005fmetadata">
1031
- <h3 class="section"><span>2.27 prores_metadata<a class="copiable-link" href="#prores_005fmetadata"> &para;</a></span></h3>
1032
-
1033
- <p>Modify color property metadata embedded in prores stream.
1034
- </p>
1035
- <dl class="table">
1036
- <dt><samp class="option">color_primaries</samp></dt>
1037
- <dd><p>Set the color primaries.
1038
- Available values are:
1039
- </p>
1040
- <dl class="table">
1041
- <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
1042
- <dd><p>Keep the same color primaries property (default).
1043
- </p>
1044
- </dd>
1045
- <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
1046
- <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
1047
- <dt>&lsquo;<samp class="samp">bt470bg</samp>&rsquo;</dt>
1048
- <dd><p>BT601 625
1049
- </p>
1050
- </dd>
1051
- <dt>&lsquo;<samp class="samp">smpte170m</samp>&rsquo;</dt>
1052
- <dd><p>BT601 525
1053
- </p>
1054
- </dd>
1055
- <dt>&lsquo;<samp class="samp">bt2020</samp>&rsquo;</dt>
1056
- <dt>&lsquo;<samp class="samp">smpte431</samp>&rsquo;</dt>
1057
- <dd><p>DCI P3
1058
- </p>
1059
- </dd>
1060
- <dt>&lsquo;<samp class="samp">smpte432</samp>&rsquo;</dt>
1061
- <dd><p>P3 D65
1062
- </p>
1063
- </dd>
1064
- </dl>
1065
-
1066
- </dd>
1067
- <dt><samp class="option">transfer_characteristics</samp></dt>
1068
- <dd><p>Set the color transfer.
1069
- Available values are:
1070
- </p>
1071
- <dl class="table">
1072
- <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
1073
- <dd><p>Keep the same transfer characteristics property (default).
1074
- </p>
1075
- </dd>
1076
- <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
1077
- <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
1078
- <dd><p>BT 601, BT 709, BT 2020
1079
- </p></dd>
1080
- <dt>&lsquo;<samp class="samp">smpte2084</samp>&rsquo;</dt>
1081
- <dd><p>SMPTE ST 2084
1082
- </p></dd>
1083
- <dt>&lsquo;<samp class="samp">arib-std-b67</samp>&rsquo;</dt>
1084
- <dd><p>ARIB STD-B67
1085
- </p></dd>
1086
- </dl>
1087
-
1088
-
1089
- </dd>
1090
- <dt><samp class="option">matrix_coefficients</samp></dt>
1091
- <dd><p>Set the matrix coefficient.
1092
- Available values are:
1093
- </p>
1094
- <dl class="table">
1095
- <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
1096
- <dd><p>Keep the same colorspace property (default).
1097
- </p>
1098
- </dd>
1099
- <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
1100
- <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
1101
- <dt>&lsquo;<samp class="samp">smpte170m</samp>&rsquo;</dt>
1102
- <dd><p>BT 601
1103
- </p>
1104
- </dd>
1105
- <dt>&lsquo;<samp class="samp">bt2020nc</samp>&rsquo;</dt>
1106
- </dl>
1107
- </dd>
1108
- </dl>
1109
-
1110
- <p>Set Rec709 colorspace for each frame of the file
1111
- </p><div class="example">
1112
- <pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
1113
- </pre></div>
1114
-
1115
- <p>Set Hybrid Log-Gamma parameters for each frame of the file
1116
- </p><div class="example">
1117
- <pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
1118
- </pre></div>
1119
-
1120
- </div>
1121
- <div class="section-level-extent" id="remove_005fextra">
1122
- <h3 class="section"><span>2.28 remove_extra<a class="copiable-link" href="#remove_005fextra"> &para;</a></span></h3>
1123
-
1124
- <p>Remove extradata from packets.
1125
- </p>
1126
- <p>It accepts the following parameter:
1127
- </p><dl class="table">
1128
- <dt><samp class="option">freq</samp></dt>
1129
- <dd><p>Set which frame types to remove extradata from.
1130
- </p>
1131
- <dl class="table">
1132
- <dt>&lsquo;<samp class="samp">k</samp>&rsquo;</dt>
1133
- <dd><p>Remove extradata from non-keyframes only.
1134
- </p>
1135
- </dd>
1136
- <dt>&lsquo;<samp class="samp">keyframe</samp>&rsquo;</dt>
1137
- <dd><p>Remove extradata from keyframes only.
1138
- </p>
1139
- </dd>
1140
- <dt>&lsquo;<samp class="samp">e, all</samp>&rsquo;</dt>
1141
- <dd><p>Remove extradata from all frames.
1142
- </p>
1143
- </dd>
1144
- </dl>
1145
- </dd>
1146
- </dl>
1147
-
1148
- </div>
1149
- <div class="section-level-extent" id="setts">
1150
- <h3 class="section"><span>2.29 setts<a class="copiable-link" href="#setts"> &para;</a></span></h3>
1151
- <p>Set PTS and DTS in packets.
1152
- </p>
1153
- <p>It accepts the following parameters:
1154
- </p><dl class="table">
1155
- <dt><samp class="option">ts</samp></dt>
1156
- <dt><samp class="option">pts</samp></dt>
1157
- <dt><samp class="option">dts</samp></dt>
1158
- <dd><p>Set expressions for PTS, DTS or both.
1159
- </p></dd>
1160
- <dt><samp class="option">duration</samp></dt>
1161
- <dd><p>Set expression for duration.
1162
- </p></dd>
1163
- <dt><samp class="option">time_base</samp></dt>
1164
- <dd><p>Set output time base.
1165
- </p></dd>
1166
- </dl>
1167
-
1168
- <p>The expressions are evaluated through the eval API and can contain the following
1169
- constants:
1170
- </p>
1171
- <dl class="table">
1172
- <dt><samp class="option">N</samp></dt>
1173
- <dd><p>The count of the input packet. Starting from 0.
1174
- </p>
1175
- </dd>
1176
- <dt><samp class="option">TS</samp></dt>
1177
- <dd><p>The demux timestamp in input in case of <code class="code">ts</code> or <code class="code">dts</code> option or presentation
1178
- timestamp in case of <code class="code">pts</code> option.
1179
- </p>
1180
- </dd>
1181
- <dt><samp class="option">POS</samp></dt>
1182
- <dd><p>The original position in the file of the packet, or undefined if undefined
1183
- for the current packet
1184
- </p>
1185
- </dd>
1186
- <dt><samp class="option">DTS</samp></dt>
1187
- <dd><p>The demux timestamp in input.
1188
- </p>
1189
- </dd>
1190
- <dt><samp class="option">PTS</samp></dt>
1191
- <dd><p>The presentation timestamp in input.
1192
- </p>
1193
- </dd>
1194
- <dt><samp class="option">DURATION</samp></dt>
1195
- <dd><p>The duration in input.
1196
- </p>
1197
- </dd>
1198
- <dt><samp class="option">STARTDTS</samp></dt>
1199
- <dd><p>The DTS of the first packet.
1200
- </p>
1201
- </dd>
1202
- <dt><samp class="option">STARTPTS</samp></dt>
1203
- <dd><p>The PTS of the first packet.
1204
- </p>
1205
- </dd>
1206
- <dt><samp class="option">PREV_INDTS</samp></dt>
1207
- <dd><p>The previous input DTS.
1208
- </p>
1209
- </dd>
1210
- <dt><samp class="option">PREV_INPTS</samp></dt>
1211
- <dd><p>The previous input PTS.
1212
- </p>
1213
- </dd>
1214
- <dt><samp class="option">PREV_INDURATION</samp></dt>
1215
- <dd><p>The previous input duration.
1216
- </p>
1217
- </dd>
1218
- <dt><samp class="option">PREV_OUTDTS</samp></dt>
1219
- <dd><p>The previous output DTS.
1220
- </p>
1221
- </dd>
1222
- <dt><samp class="option">PREV_OUTPTS</samp></dt>
1223
- <dd><p>The previous output PTS.
1224
- </p>
1225
- </dd>
1226
- <dt><samp class="option">PREV_OUTDURATION</samp></dt>
1227
- <dd><p>The previous output duration.
1228
- </p>
1229
- </dd>
1230
- <dt><samp class="option">NEXT_DTS</samp></dt>
1231
- <dd><p>The next input DTS.
1232
- </p>
1233
- </dd>
1234
- <dt><samp class="option">NEXT_PTS</samp></dt>
1235
- <dd><p>The next input PTS.
1236
- </p>
1237
- </dd>
1238
- <dt><samp class="option">NEXT_DURATION</samp></dt>
1239
- <dd><p>The next input duration.
1240
- </p>
1241
- </dd>
1242
- <dt><samp class="option">TB</samp></dt>
1243
- <dd><p>The timebase of stream packet belongs.
1244
- </p>
1245
- </dd>
1246
- <dt><samp class="option">TB_OUT</samp></dt>
1247
- <dd><p>The output timebase.
1248
- </p>
1249
- </dd>
1250
- <dt><samp class="option">SR</samp></dt>
1251
- <dd><p>The sample rate of stream packet belongs.
1252
- </p>
1253
- </dd>
1254
- <dt><samp class="option">NOPTS</samp></dt>
1255
- <dd><p>The AV_NOPTS_VALUE constant.
1256
- </p></dd>
1257
- </dl>
1258
-
1259
- <p>For example, to set PTS equal to DTS (not recommended if B-frames are involved):
1260
- </p><div class="example">
1261
- <pre class="example-preformatted">ffmpeg -i INPUT -c:a copy -bsf:a setts=pts=DTS out.mkv
1262
- </pre></div>
1263
-
1264
- </div>
1265
- <div class="section-level-extent" id="showinfo">
1266
- <h3 class="section"><span>2.30 showinfo<a class="copiable-link" href="#showinfo"> &para;</a></span></h3>
1267
- <p>Log basic packet information. Mainly useful for testing, debugging,
1268
- and development.
1269
- </p>
1270
- <a class="anchor" id="text2movsub"></a></div>
1271
- <div class="section-level-extent" id="text2movsub-1">
1272
- <h3 class="section"><span>2.31 text2movsub<a class="copiable-link" href="#text2movsub-1"> &para;</a></span></h3>
1273
-
1274
- <p>Convert text subtitles to MOV subtitles (as used by the <code class="code">mov_text</code>
1275
- codec) with metadata headers.
1276
- </p>
1277
- <p>See also the <a class="ref" href="#mov2textsub">mov2textsub</a> filter.
1278
- </p>
1279
- </div>
1280
- <div class="section-level-extent" id="trace_005fheaders">
1281
- <h3 class="section"><span>2.32 trace_headers<a class="copiable-link" href="#trace_005fheaders"> &para;</a></span></h3>
1282
-
1283
- <p>Log trace output containing all syntax elements in the coded stream
1284
- headers (everything above the level of individual coded blocks).
1285
- This can be useful for debugging low-level stream issues.
1286
- </p>
1287
- <p>Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending
1288
- on the build only a subset of these may be available.
1289
- </p>
1290
- </div>
1291
- <div class="section-level-extent" id="truehd_005fcore">
1292
- <h3 class="section"><span>2.33 truehd_core<a class="copiable-link" href="#truehd_005fcore"> &para;</a></span></h3>
1293
-
1294
- <p>Extract the core from a TrueHD stream, dropping ATMOS data.
1295
- </p>
1296
- </div>
1297
- <div class="section-level-extent" id="vp9_005fmetadata">
1298
- <h3 class="section"><span>2.34 vp9_metadata<a class="copiable-link" href="#vp9_005fmetadata"> &para;</a></span></h3>
1299
-
1300
- <p>Modify metadata embedded in a VP9 stream.
1301
- </p>
1302
- <dl class="table">
1303
- <dt><samp class="option">color_space</samp></dt>
1304
- <dd><p>Set the color space value in the frame header. Note that any frame
1305
- set to RGB will be implicitly set to PC range and that RGB is
1306
- incompatible with profiles 0 and 2.
1307
- </p><dl class="table">
1308
- <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
1309
- <dt>&lsquo;<samp class="samp">bt601</samp>&rsquo;</dt>
1310
- <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
1311
- <dt>&lsquo;<samp class="samp">smpte170</samp>&rsquo;</dt>
1312
- <dt>&lsquo;<samp class="samp">smpte240</samp>&rsquo;</dt>
1313
- <dt>&lsquo;<samp class="samp">bt2020</samp>&rsquo;</dt>
1314
- <dt>&lsquo;<samp class="samp">rgb</samp>&rsquo;</dt>
1315
- </dl>
1316
-
1317
- </dd>
1318
- <dt><samp class="option">color_range</samp></dt>
1319
- <dd><p>Set the color range value in the frame header. Note that any value
1320
- imposed by the color space will take precedence over this value.
1321
- </p><dl class="table">
1322
- <dt>&lsquo;<samp class="samp">tv</samp>&rsquo;</dt>
1323
- <dt>&lsquo;<samp class="samp">pc</samp>&rsquo;</dt>
1324
- </dl>
1325
- </dd>
1326
- </dl>
1327
-
1328
- </div>
1329
- <div class="section-level-extent" id="vp9_005fsuperframe">
1330
- <h3 class="section"><span>2.35 vp9_superframe<a class="copiable-link" href="#vp9_005fsuperframe"> &para;</a></span></h3>
1331
-
1332
- <p>Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This
1333
- fixes merging of split/segmented VP9 streams where the alt-ref frame
1334
- was split from its visible counterpart.
1335
- </p>
1336
- </div>
1337
- <div class="section-level-extent" id="vp9_005fsuperframe_005fsplit">
1338
- <h3 class="section"><span>2.36 vp9_superframe_split<a class="copiable-link" href="#vp9_005fsuperframe_005fsplit"> &para;</a></span></h3>
1339
-
1340
- <p>Split VP9 superframes into single frames.
1341
- </p>
1342
- </div>
1343
- <div class="section-level-extent" id="vp9_005fraw_005freorder">
1344
- <h3 class="section"><span>2.37 vp9_raw_reorder<a class="copiable-link" href="#vp9_005fraw_005freorder"> &para;</a></span></h3>
1345
-
1346
- <p>Given a VP9 stream with correct timestamps but possibly out of order,
1347
- insert additional show-existing-frame packets to correct the ordering.
1348
- </p>
1349
-
1350
- </div>
1351
- </div>
1352
- <div class="chapter-level-extent" id="See-Also">
1353
- <h2 class="chapter"><span>3 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
1354
-
1355
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
1356
- <a class="url" href="libavcodec.html">libavcodec</a>
1357
- </p>
1358
-
1359
- </div>
1360
- <div class="chapter-level-extent" id="Authors">
1361
- <h2 class="chapter"><span>4 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
1362
-
1363
- <p>The FFmpeg developers.
1364
- </p>
1365
- <p>For details about the authorship, see the Git history of the project
1366
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
1367
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
1368
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
1369
- </p>
1370
- <p>Maintainers for the specific components are listed in the file
1371
- <samp class="file">MAINTAINERS</samp> in the source code tree.
1372
- </p>
1373
-
1374
- </div>
1375
- </div>
1376
- <p style="font-size: small;">
1377
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
1378
- </p>
1379
- </div>
1380
- </body>
1381
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffmpeg-codecs.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-devices.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-filters.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-formats.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-protocols.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffmpeg-resampler.html DELETED
@@ -1,361 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Resampler Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Resampler Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-Resampler-Options" href="#Resampler-Options">2 Resampler Options</a></li>
30
- <li><a id="toc-See-Also" href="#See-Also">3 See Also</a></li>
31
- <li><a id="toc-Authors" href="#Authors">4 Authors</a></li>
32
- </ul>
33
- </div>
34
- </div>
35
-
36
- <ul class="mini-toc">
37
- <li><a href="#Description" accesskey="1">Description</a></li>
38
- <li><a href="#Resampler-Options" accesskey="2">Resampler Options</a></li>
39
- <li><a href="#See-Also" accesskey="3">See Also</a></li>
40
- <li><a href="#Authors" accesskey="4">Authors</a></li>
41
- </ul>
42
- <div class="chapter-level-extent" id="Description">
43
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
44
-
45
- <p>The FFmpeg resampler provides a high-level interface to the
46
- libswresample library audio resampling utilities. In particular it
47
- allows one to perform audio resampling, audio channel layout rematrixing,
48
- and convert audio format and packing layout.
49
- </p>
50
-
51
- </div>
52
- <div class="chapter-level-extent" id="Resampler-Options">
53
- <h2 class="chapter"><span>2 Resampler Options<a class="copiable-link" href="#Resampler-Options"> &para;</a></span></h2>
54
-
55
- <p>The audio resampler supports the following named options.
56
- </p>
57
- <p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
58
- FFmpeg tools, <var class="var">option</var>=<var class="var">value</var> for the aresample filter,
59
- by setting the value explicitly in the
60
- <code class="code">SwrContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API for
61
- programmatic use.
62
- </p>
63
- <dl class="table">
64
- <dt><samp class="option">uchl, used_chlayout</samp></dt>
65
- <dd><p>Set used input channel layout. Default is unset. This option is
66
- only used for special remapping.
67
- </p>
68
- </dd>
69
- <dt><samp class="option">isr, in_sample_rate</samp></dt>
70
- <dd><p>Set the input sample rate. Default value is 0.
71
- </p>
72
- </dd>
73
- <dt><samp class="option">osr, out_sample_rate</samp></dt>
74
- <dd><p>Set the output sample rate. Default value is 0.
75
- </p>
76
- </dd>
77
- <dt><samp class="option">isf, in_sample_fmt</samp></dt>
78
- <dd><p>Specify the input sample format. It is set by default to <code class="code">none</code>.
79
- </p>
80
- </dd>
81
- <dt><samp class="option">osf, out_sample_fmt</samp></dt>
82
- <dd><p>Specify the output sample format. It is set by default to <code class="code">none</code>.
83
- </p>
84
- </dd>
85
- <dt><samp class="option">tsf, internal_sample_fmt</samp></dt>
86
- <dd><p>Set the internal sample format. Default value is <code class="code">none</code>.
87
- This will automatically be chosen when it is not explicitly set.
88
- </p>
89
- </dd>
90
- <dt><samp class="option">ichl, in_chlayout</samp></dt>
91
- <dt><samp class="option">ochl, out_chlayout</samp></dt>
92
- <dd><p>Set the input/output channel layout.
93
- </p>
94
- <p>See <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#channel-layout-syntax">the Channel Layout section in the ffmpeg-utils(1) manual</a>
95
- for the required syntax.
96
- </p>
97
- </dd>
98
- <dt><samp class="option">clev, center_mix_level</samp></dt>
99
- <dd><p>Set the center mix level. It is a value expressed in deciBel, and must be
100
- in the interval [-32,32].
101
- </p>
102
- </dd>
103
- <dt><samp class="option">slev, surround_mix_level</samp></dt>
104
- <dd><p>Set the surround mix level. It is a value expressed in deciBel, and must
105
- be in the interval [-32,32].
106
- </p>
107
- </dd>
108
- <dt><samp class="option">lfe_mix_level</samp></dt>
109
- <dd><p>Set LFE mix into non LFE level. It is used when there is a LFE input but no
110
- LFE output. It is a value expressed in deciBel, and must
111
- be in the interval [-32,32].
112
- </p>
113
- </dd>
114
- <dt><samp class="option">rmvol, rematrix_volume</samp></dt>
115
- <dd><p>Set rematrix volume. Default value is 1.0.
116
- </p>
117
- </dd>
118
- <dt><samp class="option">rematrix_maxval</samp></dt>
119
- <dd><p>Set maximum output value for rematrixing.
120
- This can be used to prevent clipping vs. preventing volume reduction.
121
- A value of 1.0 prevents clipping.
122
- </p>
123
- </dd>
124
- <dt><samp class="option">flags, swr_flags</samp></dt>
125
- <dd><p>Set flags used by the converter. Default value is 0.
126
- </p>
127
- <p>It supports the following individual flags:
128
- </p><dl class="table">
129
- <dt><samp class="option">res</samp></dt>
130
- <dd><p>force resampling, this flag forces resampling to be used even when the
131
- input and output sample rates match.
132
- </p></dd>
133
- </dl>
134
-
135
- </dd>
136
- <dt><samp class="option">dither_scale</samp></dt>
137
- <dd><p>Set the dither scale. Default value is 1.
138
- </p>
139
- </dd>
140
- <dt><samp class="option">dither_method</samp></dt>
141
- <dd><p>Set dither method. Default value is 0.
142
- </p>
143
- <p>Supported values:
144
- </p><dl class="table">
145
- <dt>&lsquo;<samp class="samp">rectangular</samp>&rsquo;</dt>
146
- <dd><p>select rectangular dither
147
- </p></dd>
148
- <dt>&lsquo;<samp class="samp">triangular</samp>&rsquo;</dt>
149
- <dd><p>select triangular dither
150
- </p></dd>
151
- <dt>&lsquo;<samp class="samp">triangular_hp</samp>&rsquo;</dt>
152
- <dd><p>select triangular dither with high pass
153
- </p></dd>
154
- <dt>&lsquo;<samp class="samp">lipshitz</samp>&rsquo;</dt>
155
- <dd><p>select Lipshitz noise shaping dither.
156
- </p></dd>
157
- <dt>&lsquo;<samp class="samp">shibata</samp>&rsquo;</dt>
158
- <dd><p>select Shibata noise shaping dither.
159
- </p></dd>
160
- <dt>&lsquo;<samp class="samp">low_shibata</samp>&rsquo;</dt>
161
- <dd><p>select low Shibata noise shaping dither.
162
- </p></dd>
163
- <dt>&lsquo;<samp class="samp">high_shibata</samp>&rsquo;</dt>
164
- <dd><p>select high Shibata noise shaping dither.
165
- </p></dd>
166
- <dt>&lsquo;<samp class="samp">f_weighted</samp>&rsquo;</dt>
167
- <dd><p>select f-weighted noise shaping dither
168
- </p></dd>
169
- <dt>&lsquo;<samp class="samp">modified_e_weighted</samp>&rsquo;</dt>
170
- <dd><p>select modified-e-weighted noise shaping dither
171
- </p></dd>
172
- <dt>&lsquo;<samp class="samp">improved_e_weighted</samp>&rsquo;</dt>
173
- <dd><p>select improved-e-weighted noise shaping dither
174
- </p>
175
- </dd>
176
- </dl>
177
-
178
- </dd>
179
- <dt><samp class="option">resampler</samp></dt>
180
- <dd><p>Set resampling engine. Default value is swr.
181
- </p>
182
- <p>Supported values:
183
- </p><dl class="table">
184
- <dt>&lsquo;<samp class="samp">swr</samp>&rsquo;</dt>
185
- <dd><p>select the native SW Resampler; filter options precision and cheby are not
186
- applicable in this case.
187
- </p></dd>
188
- <dt>&lsquo;<samp class="samp">soxr</samp>&rsquo;</dt>
189
- <dd><p>select the SoX Resampler (where available); compensation, and filter options
190
- filter_size, phase_shift, exact_rational, filter_type &amp; kaiser_beta, are not
191
- applicable in this case.
192
- </p></dd>
193
- </dl>
194
-
195
- </dd>
196
- <dt><samp class="option">filter_size</samp></dt>
197
- <dd><p>For swr only, set resampling filter size, default value is 32.
198
- </p>
199
- </dd>
200
- <dt><samp class="option">phase_shift</samp></dt>
201
- <dd><p>For swr only, set resampling phase shift, default value is 10, and must be in
202
- the interval [0,30].
203
- </p>
204
- </dd>
205
- <dt><samp class="option">linear_interp</samp></dt>
206
- <dd><p>Use linear interpolation when enabled (the default). Disable it if you want
207
- to preserve speed instead of quality when exact_rational fails.
208
- </p>
209
- </dd>
210
- <dt><samp class="option">exact_rational</samp></dt>
211
- <dd><p>For swr only, when enabled, try to use exact phase_count based on input and
212
- output sample rate. However, if it is larger than <code class="code">1 &lt;&lt; phase_shift</code>,
213
- the phase_count will be <code class="code">1 &lt;&lt; phase_shift</code> as fallback. Default is enabled.
214
- </p>
215
- </dd>
216
- <dt><samp class="option">cutoff</samp></dt>
217
- <dd><p>Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
218
- value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr
219
- (which, with a sample-rate of 44100, preserves the entire audio band to 20kHz).
220
- </p>
221
- </dd>
222
- <dt><samp class="option">precision</samp></dt>
223
- <dd><p>For soxr only, the precision in bits to which the resampled signal will be
224
- calculated. The default value of 20 (which, with suitable dithering, is
225
- appropriate for a destination bit-depth of 16) gives SoX&rsquo;s &rsquo;High Quality&rsquo;; a
226
- value of 28 gives SoX&rsquo;s &rsquo;Very High Quality&rsquo;.
227
- </p>
228
- </dd>
229
- <dt><samp class="option">cheby</samp></dt>
230
- <dd><p>For soxr only, selects passband rolloff none (Chebyshev) &amp; higher-precision
231
- approximation for &rsquo;irrational&rsquo; ratios. Default value is 0.
232
- </p>
233
- </dd>
234
- <dt><samp class="option">async</samp></dt>
235
- <dd><p>For swr only, simple 1 parameter audio sync to timestamps using stretching,
236
- squeezing, filling and trimming. Setting this to 1 will enable filling and
237
- trimming, larger values represent the maximum amount in samples that the data
238
- may be stretched or squeezed for each second.
239
- Default value is 0, thus no compensation is applied to make the samples match
240
- the audio timestamps.
241
- </p>
242
- </dd>
243
- <dt><samp class="option">first_pts</samp></dt>
244
- <dd><p>For swr only, assume the first pts should be this value. The time unit is 1 / sample rate.
245
- This allows for padding/trimming at the start of stream. By default, no
246
- assumption is made about the first frame&rsquo;s expected pts, so no padding or
247
- trimming is done. For example, this could be set to 0 to pad the beginning with
248
- silence if an audio stream starts after the video stream or to trim any samples
249
- with a negative pts due to encoder delay.
250
- </p>
251
- </dd>
252
- <dt><samp class="option">min_comp</samp></dt>
253
- <dd><p>For swr only, set the minimum difference between timestamps and audio data (in
254
- seconds) to trigger stretching/squeezing/filling or trimming of the
255
- data to make it match the timestamps. The default is that
256
- stretching/squeezing/filling and trimming is disabled
257
- (<samp class="option">min_comp</samp> = <code class="code">FLT_MAX</code>).
258
- </p>
259
- </dd>
260
- <dt><samp class="option">min_hard_comp</samp></dt>
261
- <dd><p>For swr only, set the minimum difference between timestamps and audio data (in
262
- seconds) to trigger adding/dropping samples to make it match the
263
- timestamps. This option effectively is a threshold to select between
264
- hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
265
- all compensation is by default disabled through <samp class="option">min_comp</samp>.
266
- The default is 0.1.
267
- </p>
268
- </dd>
269
- <dt><samp class="option">comp_duration</samp></dt>
270
- <dd><p>For swr only, set duration (in seconds) over which data is stretched/squeezed
271
- to make it match the timestamps. Must be a non-negative double float value,
272
- default value is 1.0.
273
- </p>
274
- </dd>
275
- <dt><samp class="option">max_soft_comp</samp></dt>
276
- <dd><p>For swr only, set maximum factor by which data is stretched/squeezed to make it
277
- match the timestamps. Must be a non-negative double float value, default value
278
- is 0.
279
- </p>
280
- </dd>
281
- <dt><samp class="option">matrix_encoding</samp></dt>
282
- <dd><p>Select matrixed stereo encoding.
283
- </p>
284
- <p>It accepts the following values:
285
- </p><dl class="table">
286
- <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
287
- <dd><p>select none
288
- </p></dd>
289
- <dt>&lsquo;<samp class="samp">dolby</samp>&rsquo;</dt>
290
- <dd><p>select Dolby
291
- </p></dd>
292
- <dt>&lsquo;<samp class="samp">dplii</samp>&rsquo;</dt>
293
- <dd><p>select Dolby Pro Logic II
294
- </p></dd>
295
- </dl>
296
-
297
- <p>Default value is <code class="code">none</code>.
298
- </p>
299
- </dd>
300
- <dt><samp class="option">filter_type</samp></dt>
301
- <dd><p>For swr only, select resampling filter type. This only affects resampling
302
- operations.
303
- </p>
304
- <p>It accepts the following values:
305
- </p><dl class="table">
306
- <dt>&lsquo;<samp class="samp">cubic</samp>&rsquo;</dt>
307
- <dd><p>select cubic
308
- </p></dd>
309
- <dt>&lsquo;<samp class="samp">blackman_nuttall</samp>&rsquo;</dt>
310
- <dd><p>select Blackman Nuttall windowed sinc
311
- </p></dd>
312
- <dt>&lsquo;<samp class="samp">kaiser</samp>&rsquo;</dt>
313
- <dd><p>select Kaiser windowed sinc
314
- </p></dd>
315
- </dl>
316
-
317
- </dd>
318
- <dt><samp class="option">kaiser_beta</samp></dt>
319
- <dd><p>For swr only, set Kaiser window beta value. Must be a double float value in the
320
- interval [2,16], default value is 9.
321
- </p>
322
- </dd>
323
- <dt><samp class="option">output_sample_bits</samp></dt>
324
- <dd><p>For swr only, set number of used output sample bits for dithering. Must be an integer in the
325
- interval [0,64], default value is 0, which means it&rsquo;s not used.
326
- </p>
327
- </dd>
328
- </dl>
329
-
330
-
331
- </div>
332
- <div class="chapter-level-extent" id="See-Also">
333
- <h2 class="chapter"><span>3 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
334
-
335
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
336
- <a class="url" href="libswresample.html">libswresample</a>
337
- </p>
338
-
339
- </div>
340
- <div class="chapter-level-extent" id="Authors">
341
- <h2 class="chapter"><span>4 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
342
-
343
- <p>The FFmpeg developers.
344
- </p>
345
- <p>For details about the authorship, see the Git history of the project
346
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
347
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
348
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
349
- </p>
350
- <p>Maintainers for the specific components are listed in the file
351
- <samp class="file">MAINTAINERS</samp> in the source code tree.
352
- </p>
353
-
354
- </div>
355
- </div>
356
- <p style="font-size: small;">
357
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
358
- </p>
359
- </div>
360
- </body>
361
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffmpeg-scaler.html DELETED
@@ -1,265 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Scaler Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Scaler Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-Scaler-Options" href="#Scaler-Options">2 Scaler Options</a></li>
30
- <li><a id="toc-See-Also" href="#See-Also">3 See Also</a></li>
31
- <li><a id="toc-Authors" href="#Authors">4 Authors</a></li>
32
- </ul>
33
- </div>
34
- </div>
35
-
36
- <ul class="mini-toc">
37
- <li><a href="#Description" accesskey="1">Description</a></li>
38
- <li><a href="#Scaler-Options" accesskey="2">Scaler Options</a></li>
39
- <li><a href="#See-Also" accesskey="3">See Also</a></li>
40
- <li><a href="#Authors" accesskey="4">Authors</a></li>
41
- </ul>
42
- <div class="chapter-level-extent" id="Description">
43
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
44
-
45
- <p>The FFmpeg rescaler provides a high-level interface to the libswscale
46
- library image conversion utilities. In particular it allows one to perform
47
- image rescaling and pixel format conversion.
48
- </p>
49
-
50
- <a class="anchor" id="scaler_005foptions"></a></div>
51
- <div class="chapter-level-extent" id="Scaler-Options">
52
- <h2 class="chapter"><span>2 Scaler Options<a class="copiable-link" href="#Scaler-Options"> &para;</a></span></h2>
53
-
54
- <p>The video scaler supports the following named options.
55
- </p>
56
- <p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
57
- FFmpeg tools, with a few API-only exceptions noted below.
58
- For programmatic use, they can be set explicitly in the
59
- <code class="code">SwsContext</code> options or through the <samp class="file">libavutil/opt.h</samp> API.
60
- </p>
61
- <dl class="table">
62
- <dd>
63
- <a class="anchor" id="sws_005fflags"></a></dd>
64
- <dt><samp class="option">sws_flags</samp></dt>
65
- <dd><p>Set the scaler flags. This is also used to set the scaling
66
- algorithm. Only a single algorithm should be selected. Default
67
- value is &lsquo;<samp class="samp">bicubic</samp>&rsquo;.
68
- </p>
69
- <p>It accepts the following values:
70
- </p><dl class="table">
71
- <dt>&lsquo;<samp class="samp">fast_bilinear</samp>&rsquo;</dt>
72
- <dd><p>Select fast bilinear scaling algorithm.
73
- </p>
74
- </dd>
75
- <dt>&lsquo;<samp class="samp">bilinear</samp>&rsquo;</dt>
76
- <dd><p>Select bilinear scaling algorithm.
77
- </p>
78
- </dd>
79
- <dt>&lsquo;<samp class="samp">bicubic</samp>&rsquo;</dt>
80
- <dd><p>Select bicubic scaling algorithm.
81
- </p>
82
- </dd>
83
- <dt>&lsquo;<samp class="samp">experimental</samp>&rsquo;</dt>
84
- <dd><p>Select experimental scaling algorithm.
85
- </p>
86
- </dd>
87
- <dt>&lsquo;<samp class="samp">neighbor</samp>&rsquo;</dt>
88
- <dd><p>Select nearest neighbor rescaling algorithm.
89
- </p>
90
- </dd>
91
- <dt>&lsquo;<samp class="samp">area</samp>&rsquo;</dt>
92
- <dd><p>Select averaging area rescaling algorithm.
93
- </p>
94
- </dd>
95
- <dt>&lsquo;<samp class="samp">bicublin</samp>&rsquo;</dt>
96
- <dd><p>Select bicubic scaling algorithm for the luma component, bilinear for
97
- chroma components.
98
- </p>
99
- </dd>
100
- <dt>&lsquo;<samp class="samp">gauss</samp>&rsquo;</dt>
101
- <dd><p>Select Gaussian rescaling algorithm.
102
- </p>
103
- </dd>
104
- <dt>&lsquo;<samp class="samp">sinc</samp>&rsquo;</dt>
105
- <dd><p>Select sinc rescaling algorithm.
106
- </p>
107
- </dd>
108
- <dt>&lsquo;<samp class="samp">lanczos</samp>&rsquo;</dt>
109
- <dd><p>Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be
110
- changed by setting <code class="code">param0</code>.
111
- </p>
112
- </dd>
113
- <dt>&lsquo;<samp class="samp">spline</samp>&rsquo;</dt>
114
- <dd><p>Select natural bicubic spline rescaling algorithm.
115
- </p>
116
- </dd>
117
- <dt>&lsquo;<samp class="samp">print_info</samp>&rsquo;</dt>
118
- <dd><p>Enable printing/debug logging.
119
- </p>
120
- </dd>
121
- <dt>&lsquo;<samp class="samp">accurate_rnd</samp>&rsquo;</dt>
122
- <dd><p>Enable accurate rounding.
123
- </p>
124
- </dd>
125
- <dt>&lsquo;<samp class="samp">full_chroma_int</samp>&rsquo;</dt>
126
- <dd><p>Enable full chroma interpolation.
127
- </p>
128
- </dd>
129
- <dt>&lsquo;<samp class="samp">full_chroma_inp</samp>&rsquo;</dt>
130
- <dd><p>Select full chroma input.
131
- </p>
132
- </dd>
133
- <dt>&lsquo;<samp class="samp">bitexact</samp>&rsquo;</dt>
134
- <dd><p>Enable bitexact output.
135
- </p></dd>
136
- </dl>
137
-
138
- </dd>
139
- <dt><samp class="option">srcw <var class="var">(API only)</var></samp></dt>
140
- <dd><p>Set source width.
141
- </p>
142
- </dd>
143
- <dt><samp class="option">srch <var class="var">(API only)</var></samp></dt>
144
- <dd><p>Set source height.
145
- </p>
146
- </dd>
147
- <dt><samp class="option">dstw <var class="var">(API only)</var></samp></dt>
148
- <dd><p>Set destination width.
149
- </p>
150
- </dd>
151
- <dt><samp class="option">dsth <var class="var">(API only)</var></samp></dt>
152
- <dd><p>Set destination height.
153
- </p>
154
- </dd>
155
- <dt><samp class="option">src_format <var class="var">(API only)</var></samp></dt>
156
- <dd><p>Set source pixel format (must be expressed as an integer).
157
- </p>
158
- </dd>
159
- <dt><samp class="option">dst_format <var class="var">(API only)</var></samp></dt>
160
- <dd><p>Set destination pixel format (must be expressed as an integer).
161
- </p>
162
- </dd>
163
- <dt><samp class="option">src_range <var class="var">(boolean)</var></samp></dt>
164
- <dd><p>If value is set to <code class="code">1</code>, indicates source is full range. Default value is
165
- <code class="code">0</code>, which indicates source is limited range.
166
- </p>
167
- </dd>
168
- <dt><samp class="option">dst_range <var class="var">(boolean)</var></samp></dt>
169
- <dd><p>If value is set to <code class="code">1</code>, enable full range for destination. Default value
170
- is <code class="code">0</code>, which enables limited range.
171
- </p>
172
- <a class="anchor" id="sws_005fparams"></a></dd>
173
- <dt><samp class="option">param0, param1</samp></dt>
174
- <dd><p>Set scaling algorithm parameters. The specified values are specific of
175
- some scaling algorithms and ignored by others. The specified values
176
- are floating point number values.
177
- </p>
178
- </dd>
179
- <dt><samp class="option">sws_dither</samp></dt>
180
- <dd><p>Set the dithering algorithm. Accepts one of the following
181
- values. Default value is &lsquo;<samp class="samp">auto</samp>&rsquo;.
182
- </p>
183
- <dl class="table">
184
- <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
185
- <dd><p>automatic choice
186
- </p>
187
- </dd>
188
- <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
189
- <dd><p>no dithering
190
- </p>
191
- </dd>
192
- <dt>&lsquo;<samp class="samp">bayer</samp>&rsquo;</dt>
193
- <dd><p>bayer dither
194
- </p>
195
- </dd>
196
- <dt>&lsquo;<samp class="samp">ed</samp>&rsquo;</dt>
197
- <dd><p>error diffusion dither
198
- </p>
199
- </dd>
200
- <dt>&lsquo;<samp class="samp">a_dither</samp>&rsquo;</dt>
201
- <dd><p>arithmetic dither, based using addition
202
- </p>
203
- </dd>
204
- <dt>&lsquo;<samp class="samp">x_dither</samp>&rsquo;</dt>
205
- <dd><p>arithmetic dither, based using xor (more random/less apparent patterning that
206
- a_dither).
207
- </p>
208
- </dd>
209
- </dl>
210
-
211
- </dd>
212
- <dt><samp class="option">alphablend</samp></dt>
213
- <dd><p>Set the alpha blending to use when the input has alpha but the output does not.
214
- Default value is &lsquo;<samp class="samp">none</samp>&rsquo;.
215
- </p>
216
- <dl class="table">
217
- <dt>&lsquo;<samp class="samp">uniform_color</samp>&rsquo;</dt>
218
- <dd><p>Blend onto a uniform background color
219
- </p>
220
- </dd>
221
- <dt>&lsquo;<samp class="samp">checkerboard</samp>&rsquo;</dt>
222
- <dd><p>Blend onto a checkerboard
223
- </p>
224
- </dd>
225
- <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
226
- <dd><p>No blending
227
- </p>
228
- </dd>
229
- </dl>
230
-
231
- </dd>
232
- </dl>
233
-
234
-
235
- </div>
236
- <div class="chapter-level-extent" id="See-Also">
237
- <h2 class="chapter"><span>3 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
238
-
239
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
240
- <a class="url" href="libswscale.html">libswscale</a>
241
- </p>
242
-
243
- </div>
244
- <div class="chapter-level-extent" id="Authors">
245
- <h2 class="chapter"><span>4 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
246
-
247
- <p>The FFmpeg developers.
248
- </p>
249
- <p>For details about the authorship, see the Git history of the project
250
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
251
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
252
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
253
- </p>
254
- <p>Maintainers for the specific components are listed in the file
255
- <samp class="file">MAINTAINERS</samp> in the source code tree.
256
- </p>
257
-
258
- </div>
259
- </div>
260
- <p style="font-size: small;">
261
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
262
- </p>
263
- </div>
264
- </body>
265
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffmpeg-utils.html DELETED
@@ -1,1583 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Utilities Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Utilities Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-Syntax" href="#Syntax">2 Syntax</a>
30
- <ul class="toc-numbered-mark">
31
- <li><a id="toc-Quoting-and-escaping" href="#Quoting-and-escaping">2.1 Quoting and escaping</a>
32
- <ul class="toc-numbered-mark">
33
- <li><a id="toc-Examples" href="#Examples">2.1.1 Examples</a></li>
34
- </ul></li>
35
- <li><a id="toc-Date" href="#Date">2.2 Date</a></li>
36
- <li><a id="toc-Time-duration" href="#Time-duration">2.3 Time duration</a>
37
- <ul class="toc-numbered-mark">
38
- <li><a id="toc-Examples-1" href="#Examples-1">2.3.1 Examples</a></li>
39
- </ul></li>
40
- <li><a id="toc-Video-size" href="#Video-size">2.4 Video size</a></li>
41
- <li><a id="toc-Video-rate" href="#Video-rate">2.5 Video rate</a></li>
42
- <li><a id="toc-Ratio" href="#Ratio">2.6 Ratio</a></li>
43
- <li><a id="toc-Color" href="#Color">2.7 Color</a></li>
44
- <li><a id="toc-Channel-Layout" href="#Channel-Layout">2.8 Channel Layout</a></li>
45
- </ul></li>
46
- <li><a id="toc-Expression-Evaluation" href="#Expression-Evaluation">3 Expression Evaluation</a></li>
47
- <li><a id="toc-See-Also" href="#See-Also">4 See Also</a></li>
48
- <li><a id="toc-Authors" href="#Authors">5 Authors</a></li>
49
- </ul>
50
- </div>
51
- </div>
52
-
53
- <ul class="mini-toc">
54
- <li><a href="#Description" accesskey="1">Description</a></li>
55
- <li><a href="#Syntax" accesskey="2">Syntax</a></li>
56
- <li><a href="#Expression-Evaluation" accesskey="3">Expression Evaluation</a></li>
57
- <li><a href="#See-Also" accesskey="4">See Also</a></li>
58
- <li><a href="#Authors" accesskey="5">Authors</a></li>
59
- </ul>
60
- <div class="chapter-level-extent" id="Description">
61
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
62
-
63
- <p>This document describes some generic features and utilities provided
64
- by the libavutil library.
65
- </p>
66
-
67
- </div>
68
- <div class="chapter-level-extent" id="Syntax">
69
- <h2 class="chapter"><span>2 Syntax<a class="copiable-link" href="#Syntax"> &para;</a></span></h2>
70
-
71
- <p>This section documents the syntax and formats employed by the FFmpeg
72
- libraries and tools.
73
- </p>
74
- <a class="anchor" id="quoting_005fand_005fescaping"></a><ul class="mini-toc">
75
- <li><a href="#Quoting-and-escaping" accesskey="1">Quoting and escaping</a></li>
76
- <li><a href="#Date" accesskey="2">Date</a></li>
77
- <li><a href="#Time-duration" accesskey="3">Time duration</a></li>
78
- <li><a href="#Video-size" accesskey="4">Video size</a></li>
79
- <li><a href="#Video-rate" accesskey="5">Video rate</a></li>
80
- <li><a href="#Ratio" accesskey="6">Ratio</a></li>
81
- <li><a href="#Color" accesskey="7">Color</a></li>
82
- <li><a href="#Channel-Layout" accesskey="8">Channel Layout</a></li>
83
- </ul>
84
- <div class="section-level-extent" id="Quoting-and-escaping">
85
- <h3 class="section"><span>2.1 Quoting and escaping<a class="copiable-link" href="#Quoting-and-escaping"> &para;</a></span></h3>
86
-
87
- <p>FFmpeg adopts the following quoting and escaping mechanism, unless
88
- explicitly specified. The following rules are applied:
89
- </p>
90
- <ul class="itemize mark-bullet">
91
- <li>&lsquo;<samp class="samp">'</samp>&rsquo; and &lsquo;<samp class="samp">\</samp>&rsquo; are special characters (respectively used for
92
- quoting and escaping). In addition to them, there might be other
93
- special characters depending on the specific syntax where the escaping
94
- and quoting are employed.
95
-
96
- </li><li>A special character is escaped by prefixing it with a &lsquo;<samp class="samp">\</samp>&rsquo;.
97
-
98
- </li><li>All characters enclosed between &lsquo;<samp class="samp">''</samp>&rsquo; are included literally in the
99
- parsed string. The quote character &lsquo;<samp class="samp">'</samp>&rsquo; itself cannot be quoted,
100
- so you may need to close the quote and escape it.
101
-
102
- </li><li>Leading and trailing whitespaces, unless escaped or quoted, are
103
- removed from the parsed string.
104
- </li></ul>
105
-
106
- <p>Note that you may need to add a second level of escaping when using
107
- the command line or a script, which depends on the syntax of the
108
- adopted shell language.
109
- </p>
110
- <p>The function <code class="code">av_get_token</code> defined in
111
- <samp class="file">libavutil/avstring.h</samp> can be used to parse a token quoted or
112
- escaped according to the rules defined above.
113
- </p>
114
- <p>The tool <samp class="file">tools/ffescape</samp> in the FFmpeg source tree can be used
115
- to automatically quote or escape a string in a script.
116
- </p>
117
- <ul class="mini-toc">
118
- <li><a href="#Examples" accesskey="1">Examples</a></li>
119
- </ul>
120
- <div class="subsection-level-extent" id="Examples">
121
- <h4 class="subsection"><span>2.1.1 Examples<a class="copiable-link" href="#Examples"> &para;</a></span></h4>
122
-
123
- <ul class="itemize mark-bullet">
124
- <li>Escape the string <code class="code">Crime d'Amour</code> containing the <code class="code">'</code> special
125
- character:
126
- <div class="example">
127
- <pre class="example-preformatted">Crime d\'Amour
128
- </pre></div>
129
-
130
- </li><li>The string above contains a quote, so the <code class="code">'</code> needs to be escaped
131
- when quoting it:
132
- <div class="example">
133
- <pre class="example-preformatted">'Crime d'\''Amour'
134
- </pre></div>
135
-
136
- </li><li>Include leading or trailing whitespaces using quoting:
137
- <div class="example">
138
- <pre class="example-preformatted">' this string starts and ends with whitespaces '
139
- </pre></div>
140
-
141
- </li><li>Escaping and quoting can be mixed together:
142
- <div class="example">
143
- <pre class="example-preformatted">' The string '\'string\'' is a string '
144
- </pre></div>
145
-
146
- </li><li>To include a literal &lsquo;<samp class="samp">\</samp>&rsquo; you can use either escaping or quoting:
147
- <div class="example">
148
- <pre class="example-preformatted">'c:\foo' can be written as c:\\foo
149
- </pre></div>
150
- </li></ul>
151
-
152
- <a class="anchor" id="date-syntax"></a></div>
153
- </div>
154
- <div class="section-level-extent" id="Date">
155
- <h3 class="section"><span>2.2 Date<a class="copiable-link" href="#Date"> &para;</a></span></h3>
156
-
157
- <p>The accepted syntax is:
158
- </p><div class="example">
159
- <pre class="example-preformatted">[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
160
- now
161
- </pre></div>
162
-
163
- <p>If the value is &quot;now&quot; it takes the current time.
164
- </p>
165
- <p>Time is local time unless Z is appended, in which case it is
166
- interpreted as UTC.
167
- If the year-month-day part is not specified it takes the current
168
- year-month-day.
169
- </p>
170
- <a class="anchor" id="time-duration-syntax"></a></div>
171
- <div class="section-level-extent" id="Time-duration">
172
- <h3 class="section"><span>2.3 Time duration<a class="copiable-link" href="#Time-duration"> &para;</a></span></h3>
173
-
174
- <p>There are two accepted syntaxes for expressing time duration.
175
- </p>
176
- <div class="example">
177
- <pre class="example-preformatted">[-][<var class="var">HH</var>:]<var class="var">MM</var>:<var class="var">SS</var>[.<var class="var">m</var>...]
178
- </pre></div>
179
-
180
- <p><var class="var">HH</var> expresses the number of hours, <var class="var">MM</var> the number of minutes
181
- for a maximum of 2 digits, and <var class="var">SS</var> the number of seconds for a
182
- maximum of 2 digits. The <var class="var">m</var> at the end expresses decimal value for
183
- <var class="var">SS</var>.
184
- </p>
185
- <p><em class="emph">or</em>
186
- </p>
187
- <div class="example">
188
- <pre class="example-preformatted">[-]<var class="var">S</var>+[.<var class="var">m</var>...][s|ms|us]
189
- </pre></div>
190
-
191
- <p><var class="var">S</var> expresses the number of seconds, with the optional decimal part
192
- <var class="var">m</var>. The optional literal suffixes &lsquo;<samp class="samp">s</samp>&rsquo;, &lsquo;<samp class="samp">ms</samp>&rsquo; or &lsquo;<samp class="samp">us</samp>&rsquo;
193
- indicate to interpret the value as seconds, milliseconds or microseconds,
194
- respectively.
195
- </p>
196
- <p>In both expressions, the optional &lsquo;<samp class="samp">-</samp>&rsquo; indicates negative duration.
197
- </p>
198
- <ul class="mini-toc">
199
- <li><a href="#Examples-1" accesskey="1">Examples</a></li>
200
- </ul>
201
- <div class="subsection-level-extent" id="Examples-1">
202
- <h4 class="subsection"><span>2.3.1 Examples<a class="copiable-link" href="#Examples-1"> &para;</a></span></h4>
203
-
204
- <p>The following examples are all valid time duration:
205
- </p>
206
- <dl class="table">
207
- <dt>&lsquo;<samp class="samp">55</samp>&rsquo;</dt>
208
- <dd><p>55 seconds
209
- </p>
210
- </dd>
211
- <dt>&lsquo;<samp class="samp">0.2</samp>&rsquo;</dt>
212
- <dd><p>0.2 seconds
213
- </p>
214
- </dd>
215
- <dt>&lsquo;<samp class="samp">200ms</samp>&rsquo;</dt>
216
- <dd><p>200 milliseconds, that&rsquo;s 0.2s
217
- </p>
218
- </dd>
219
- <dt>&lsquo;<samp class="samp">200000us</samp>&rsquo;</dt>
220
- <dd><p>200000 microseconds, that&rsquo;s 0.2s
221
- </p>
222
- </dd>
223
- <dt>&lsquo;<samp class="samp">12:03:45</samp>&rsquo;</dt>
224
- <dd><p>12 hours, 03 minutes and 45 seconds
225
- </p>
226
- </dd>
227
- <dt>&lsquo;<samp class="samp">23.189</samp>&rsquo;</dt>
228
- <dd><p>23.189 seconds
229
- </p></dd>
230
- </dl>
231
-
232
- <a class="anchor" id="video-size-syntax"></a></div>
233
- </div>
234
- <div class="section-level-extent" id="Video-size">
235
- <h3 class="section"><span>2.4 Video size<a class="copiable-link" href="#Video-size"> &para;</a></span></h3>
236
- <p>Specify the size of the sourced video, it may be a string of the form
237
- <var class="var">width</var>x<var class="var">height</var>, or the name of a size abbreviation.
238
- </p>
239
- <p>The following abbreviations are recognized:
240
- </p><dl class="table">
241
- <dt>&lsquo;<samp class="samp">ntsc</samp>&rsquo;</dt>
242
- <dd><p>720x480
243
- </p></dd>
244
- <dt>&lsquo;<samp class="samp">pal</samp>&rsquo;</dt>
245
- <dd><p>720x576
246
- </p></dd>
247
- <dt>&lsquo;<samp class="samp">qntsc</samp>&rsquo;</dt>
248
- <dd><p>352x240
249
- </p></dd>
250
- <dt>&lsquo;<samp class="samp">qpal</samp>&rsquo;</dt>
251
- <dd><p>352x288
252
- </p></dd>
253
- <dt>&lsquo;<samp class="samp">sntsc</samp>&rsquo;</dt>
254
- <dd><p>640x480
255
- </p></dd>
256
- <dt>&lsquo;<samp class="samp">spal</samp>&rsquo;</dt>
257
- <dd><p>768x576
258
- </p></dd>
259
- <dt>&lsquo;<samp class="samp">film</samp>&rsquo;</dt>
260
- <dd><p>352x240
261
- </p></dd>
262
- <dt>&lsquo;<samp class="samp">ntsc-film</samp>&rsquo;</dt>
263
- <dd><p>352x240
264
- </p></dd>
265
- <dt>&lsquo;<samp class="samp">sqcif</samp>&rsquo;</dt>
266
- <dd><p>128x96
267
- </p></dd>
268
- <dt>&lsquo;<samp class="samp">qcif</samp>&rsquo;</dt>
269
- <dd><p>176x144
270
- </p></dd>
271
- <dt>&lsquo;<samp class="samp">cif</samp>&rsquo;</dt>
272
- <dd><p>352x288
273
- </p></dd>
274
- <dt>&lsquo;<samp class="samp">4cif</samp>&rsquo;</dt>
275
- <dd><p>704x576
276
- </p></dd>
277
- <dt>&lsquo;<samp class="samp">16cif</samp>&rsquo;</dt>
278
- <dd><p>1408x1152
279
- </p></dd>
280
- <dt>&lsquo;<samp class="samp">qqvga</samp>&rsquo;</dt>
281
- <dd><p>160x120
282
- </p></dd>
283
- <dt>&lsquo;<samp class="samp">qvga</samp>&rsquo;</dt>
284
- <dd><p>320x240
285
- </p></dd>
286
- <dt>&lsquo;<samp class="samp">vga</samp>&rsquo;</dt>
287
- <dd><p>640x480
288
- </p></dd>
289
- <dt>&lsquo;<samp class="samp">svga</samp>&rsquo;</dt>
290
- <dd><p>800x600
291
- </p></dd>
292
- <dt>&lsquo;<samp class="samp">xga</samp>&rsquo;</dt>
293
- <dd><p>1024x768
294
- </p></dd>
295
- <dt>&lsquo;<samp class="samp">uxga</samp>&rsquo;</dt>
296
- <dd><p>1600x1200
297
- </p></dd>
298
- <dt>&lsquo;<samp class="samp">qxga</samp>&rsquo;</dt>
299
- <dd><p>2048x1536
300
- </p></dd>
301
- <dt>&lsquo;<samp class="samp">sxga</samp>&rsquo;</dt>
302
- <dd><p>1280x1024
303
- </p></dd>
304
- <dt>&lsquo;<samp class="samp">qsxga</samp>&rsquo;</dt>
305
- <dd><p>2560x2048
306
- </p></dd>
307
- <dt>&lsquo;<samp class="samp">hsxga</samp>&rsquo;</dt>
308
- <dd><p>5120x4096
309
- </p></dd>
310
- <dt>&lsquo;<samp class="samp">wvga</samp>&rsquo;</dt>
311
- <dd><p>852x480
312
- </p></dd>
313
- <dt>&lsquo;<samp class="samp">wxga</samp>&rsquo;</dt>
314
- <dd><p>1366x768
315
- </p></dd>
316
- <dt>&lsquo;<samp class="samp">wsxga</samp>&rsquo;</dt>
317
- <dd><p>1600x1024
318
- </p></dd>
319
- <dt>&lsquo;<samp class="samp">wuxga</samp>&rsquo;</dt>
320
- <dd><p>1920x1200
321
- </p></dd>
322
- <dt>&lsquo;<samp class="samp">woxga</samp>&rsquo;</dt>
323
- <dd><p>2560x1600
324
- </p></dd>
325
- <dt>&lsquo;<samp class="samp">wqsxga</samp>&rsquo;</dt>
326
- <dd><p>3200x2048
327
- </p></dd>
328
- <dt>&lsquo;<samp class="samp">wquxga</samp>&rsquo;</dt>
329
- <dd><p>3840x2400
330
- </p></dd>
331
- <dt>&lsquo;<samp class="samp">whsxga</samp>&rsquo;</dt>
332
- <dd><p>6400x4096
333
- </p></dd>
334
- <dt>&lsquo;<samp class="samp">whuxga</samp>&rsquo;</dt>
335
- <dd><p>7680x4800
336
- </p></dd>
337
- <dt>&lsquo;<samp class="samp">cga</samp>&rsquo;</dt>
338
- <dd><p>320x200
339
- </p></dd>
340
- <dt>&lsquo;<samp class="samp">ega</samp>&rsquo;</dt>
341
- <dd><p>640x350
342
- </p></dd>
343
- <dt>&lsquo;<samp class="samp">hd480</samp>&rsquo;</dt>
344
- <dd><p>852x480
345
- </p></dd>
346
- <dt>&lsquo;<samp class="samp">hd720</samp>&rsquo;</dt>
347
- <dd><p>1280x720
348
- </p></dd>
349
- <dt>&lsquo;<samp class="samp">hd1080</samp>&rsquo;</dt>
350
- <dd><p>1920x1080
351
- </p></dd>
352
- <dt>&lsquo;<samp class="samp">2k</samp>&rsquo;</dt>
353
- <dd><p>2048x1080
354
- </p></dd>
355
- <dt>&lsquo;<samp class="samp">2kflat</samp>&rsquo;</dt>
356
- <dd><p>1998x1080
357
- </p></dd>
358
- <dt>&lsquo;<samp class="samp">2kscope</samp>&rsquo;</dt>
359
- <dd><p>2048x858
360
- </p></dd>
361
- <dt>&lsquo;<samp class="samp">4k</samp>&rsquo;</dt>
362
- <dd><p>4096x2160
363
- </p></dd>
364
- <dt>&lsquo;<samp class="samp">4kflat</samp>&rsquo;</dt>
365
- <dd><p>3996x2160
366
- </p></dd>
367
- <dt>&lsquo;<samp class="samp">4kscope</samp>&rsquo;</dt>
368
- <dd><p>4096x1716
369
- </p></dd>
370
- <dt>&lsquo;<samp class="samp">nhd</samp>&rsquo;</dt>
371
- <dd><p>640x360
372
- </p></dd>
373
- <dt>&lsquo;<samp class="samp">hqvga</samp>&rsquo;</dt>
374
- <dd><p>240x160
375
- </p></dd>
376
- <dt>&lsquo;<samp class="samp">wqvga</samp>&rsquo;</dt>
377
- <dd><p>400x240
378
- </p></dd>
379
- <dt>&lsquo;<samp class="samp">fwqvga</samp>&rsquo;</dt>
380
- <dd><p>432x240
381
- </p></dd>
382
- <dt>&lsquo;<samp class="samp">hvga</samp>&rsquo;</dt>
383
- <dd><p>480x320
384
- </p></dd>
385
- <dt>&lsquo;<samp class="samp">qhd</samp>&rsquo;</dt>
386
- <dd><p>960x540
387
- </p></dd>
388
- <dt>&lsquo;<samp class="samp">2kdci</samp>&rsquo;</dt>
389
- <dd><p>2048x1080
390
- </p></dd>
391
- <dt>&lsquo;<samp class="samp">4kdci</samp>&rsquo;</dt>
392
- <dd><p>4096x2160
393
- </p></dd>
394
- <dt>&lsquo;<samp class="samp">uhd2160</samp>&rsquo;</dt>
395
- <dd><p>3840x2160
396
- </p></dd>
397
- <dt>&lsquo;<samp class="samp">uhd4320</samp>&rsquo;</dt>
398
- <dd><p>7680x4320
399
- </p></dd>
400
- </dl>
401
-
402
- <a class="anchor" id="video-rate-syntax"></a></div>
403
- <div class="section-level-extent" id="Video-rate">
404
- <h3 class="section"><span>2.5 Video rate<a class="copiable-link" href="#Video-rate"> &para;</a></span></h3>
405
-
406
- <p>Specify the frame rate of a video, expressed as the number of frames
407
- generated per second. It has to be a string in the format
408
- <var class="var">frame_rate_num</var>/<var class="var">frame_rate_den</var>, an integer number, a float
409
- number or a valid video frame rate abbreviation.
410
- </p>
411
- <p>The following abbreviations are recognized:
412
- </p><dl class="table">
413
- <dt>&lsquo;<samp class="samp">ntsc</samp>&rsquo;</dt>
414
- <dd><p>30000/1001
415
- </p></dd>
416
- <dt>&lsquo;<samp class="samp">pal</samp>&rsquo;</dt>
417
- <dd><p>25/1
418
- </p></dd>
419
- <dt>&lsquo;<samp class="samp">qntsc</samp>&rsquo;</dt>
420
- <dd><p>30000/1001
421
- </p></dd>
422
- <dt>&lsquo;<samp class="samp">qpal</samp>&rsquo;</dt>
423
- <dd><p>25/1
424
- </p></dd>
425
- <dt>&lsquo;<samp class="samp">sntsc</samp>&rsquo;</dt>
426
- <dd><p>30000/1001
427
- </p></dd>
428
- <dt>&lsquo;<samp class="samp">spal</samp>&rsquo;</dt>
429
- <dd><p>25/1
430
- </p></dd>
431
- <dt>&lsquo;<samp class="samp">film</samp>&rsquo;</dt>
432
- <dd><p>24/1
433
- </p></dd>
434
- <dt>&lsquo;<samp class="samp">ntsc-film</samp>&rsquo;</dt>
435
- <dd><p>24000/1001
436
- </p></dd>
437
- </dl>
438
-
439
- <a class="anchor" id="ratio-syntax"></a></div>
440
- <div class="section-level-extent" id="Ratio">
441
- <h3 class="section"><span>2.6 Ratio<a class="copiable-link" href="#Ratio"> &para;</a></span></h3>
442
-
443
- <p>A ratio can be expressed as an expression, or in the form
444
- <var class="var">numerator</var>:<var class="var">denominator</var>.
445
- </p>
446
- <p>Note that a ratio with infinite (1/0) or negative value is
447
- considered valid, so you should check on the returned value if you
448
- want to exclude those values.
449
- </p>
450
- <p>The undefined value can be expressed using the &quot;0:0&quot; string.
451
- </p>
452
- <a class="anchor" id="color-syntax"></a></div>
453
- <div class="section-level-extent" id="Color">
454
- <h3 class="section"><span>2.7 Color<a class="copiable-link" href="#Color"> &para;</a></span></h3>
455
-
456
- <p>It can be the name of a color as defined below (case insensitive match) or a
457
- <code class="code">[0x|#]RRGGBB[AA]</code> sequence, possibly followed by @ and a string
458
- representing the alpha component.
459
- </p>
460
- <p>The alpha component may be a string composed by &quot;0x&quot; followed by an
461
- hexadecimal number or a decimal number between 0.0 and 1.0, which
462
- represents the opacity value (&lsquo;<samp class="samp">0x00</samp>&rsquo; or &lsquo;<samp class="samp">0.0</samp>&rsquo; means completely
463
- transparent, &lsquo;<samp class="samp">0xff</samp>&rsquo; or &lsquo;<samp class="samp">1.0</samp>&rsquo; completely opaque). If the alpha
464
- component is not specified then &lsquo;<samp class="samp">0xff</samp>&rsquo; is assumed.
465
- </p>
466
- <p>The string &lsquo;<samp class="samp">random</samp>&rsquo; will result in a random color.
467
- </p>
468
- <p>The following names of colors are recognized:
469
- </p><dl class="table">
470
- <dt>&lsquo;<samp class="samp">AliceBlue</samp>&rsquo;</dt>
471
- <dd><p>0xF0F8FF
472
- </p></dd>
473
- <dt>&lsquo;<samp class="samp">AntiqueWhite</samp>&rsquo;</dt>
474
- <dd><p>0xFAEBD7
475
- </p></dd>
476
- <dt>&lsquo;<samp class="samp">Aqua</samp>&rsquo;</dt>
477
- <dd><p>0x00FFFF
478
- </p></dd>
479
- <dt>&lsquo;<samp class="samp">Aquamarine</samp>&rsquo;</dt>
480
- <dd><p>0x7FFFD4
481
- </p></dd>
482
- <dt>&lsquo;<samp class="samp">Azure</samp>&rsquo;</dt>
483
- <dd><p>0xF0FFFF
484
- </p></dd>
485
- <dt>&lsquo;<samp class="samp">Beige</samp>&rsquo;</dt>
486
- <dd><p>0xF5F5DC
487
- </p></dd>
488
- <dt>&lsquo;<samp class="samp">Bisque</samp>&rsquo;</dt>
489
- <dd><p>0xFFE4C4
490
- </p></dd>
491
- <dt>&lsquo;<samp class="samp">Black</samp>&rsquo;</dt>
492
- <dd><p>0x000000
493
- </p></dd>
494
- <dt>&lsquo;<samp class="samp">BlanchedAlmond</samp>&rsquo;</dt>
495
- <dd><p>0xFFEBCD
496
- </p></dd>
497
- <dt>&lsquo;<samp class="samp">Blue</samp>&rsquo;</dt>
498
- <dd><p>0x0000FF
499
- </p></dd>
500
- <dt>&lsquo;<samp class="samp">BlueViolet</samp>&rsquo;</dt>
501
- <dd><p>0x8A2BE2
502
- </p></dd>
503
- <dt>&lsquo;<samp class="samp">Brown</samp>&rsquo;</dt>
504
- <dd><p>0xA52A2A
505
- </p></dd>
506
- <dt>&lsquo;<samp class="samp">BurlyWood</samp>&rsquo;</dt>
507
- <dd><p>0xDEB887
508
- </p></dd>
509
- <dt>&lsquo;<samp class="samp">CadetBlue</samp>&rsquo;</dt>
510
- <dd><p>0x5F9EA0
511
- </p></dd>
512
- <dt>&lsquo;<samp class="samp">Chartreuse</samp>&rsquo;</dt>
513
- <dd><p>0x7FFF00
514
- </p></dd>
515
- <dt>&lsquo;<samp class="samp">Chocolate</samp>&rsquo;</dt>
516
- <dd><p>0xD2691E
517
- </p></dd>
518
- <dt>&lsquo;<samp class="samp">Coral</samp>&rsquo;</dt>
519
- <dd><p>0xFF7F50
520
- </p></dd>
521
- <dt>&lsquo;<samp class="samp">CornflowerBlue</samp>&rsquo;</dt>
522
- <dd><p>0x6495ED
523
- </p></dd>
524
- <dt>&lsquo;<samp class="samp">Cornsilk</samp>&rsquo;</dt>
525
- <dd><p>0xFFF8DC
526
- </p></dd>
527
- <dt>&lsquo;<samp class="samp">Crimson</samp>&rsquo;</dt>
528
- <dd><p>0xDC143C
529
- </p></dd>
530
- <dt>&lsquo;<samp class="samp">Cyan</samp>&rsquo;</dt>
531
- <dd><p>0x00FFFF
532
- </p></dd>
533
- <dt>&lsquo;<samp class="samp">DarkBlue</samp>&rsquo;</dt>
534
- <dd><p>0x00008B
535
- </p></dd>
536
- <dt>&lsquo;<samp class="samp">DarkCyan</samp>&rsquo;</dt>
537
- <dd><p>0x008B8B
538
- </p></dd>
539
- <dt>&lsquo;<samp class="samp">DarkGoldenRod</samp>&rsquo;</dt>
540
- <dd><p>0xB8860B
541
- </p></dd>
542
- <dt>&lsquo;<samp class="samp">DarkGray</samp>&rsquo;</dt>
543
- <dd><p>0xA9A9A9
544
- </p></dd>
545
- <dt>&lsquo;<samp class="samp">DarkGreen</samp>&rsquo;</dt>
546
- <dd><p>0x006400
547
- </p></dd>
548
- <dt>&lsquo;<samp class="samp">DarkKhaki</samp>&rsquo;</dt>
549
- <dd><p>0xBDB76B
550
- </p></dd>
551
- <dt>&lsquo;<samp class="samp">DarkMagenta</samp>&rsquo;</dt>
552
- <dd><p>0x8B008B
553
- </p></dd>
554
- <dt>&lsquo;<samp class="samp">DarkOliveGreen</samp>&rsquo;</dt>
555
- <dd><p>0x556B2F
556
- </p></dd>
557
- <dt>&lsquo;<samp class="samp">Darkorange</samp>&rsquo;</dt>
558
- <dd><p>0xFF8C00
559
- </p></dd>
560
- <dt>&lsquo;<samp class="samp">DarkOrchid</samp>&rsquo;</dt>
561
- <dd><p>0x9932CC
562
- </p></dd>
563
- <dt>&lsquo;<samp class="samp">DarkRed</samp>&rsquo;</dt>
564
- <dd><p>0x8B0000
565
- </p></dd>
566
- <dt>&lsquo;<samp class="samp">DarkSalmon</samp>&rsquo;</dt>
567
- <dd><p>0xE9967A
568
- </p></dd>
569
- <dt>&lsquo;<samp class="samp">DarkSeaGreen</samp>&rsquo;</dt>
570
- <dd><p>0x8FBC8F
571
- </p></dd>
572
- <dt>&lsquo;<samp class="samp">DarkSlateBlue</samp>&rsquo;</dt>
573
- <dd><p>0x483D8B
574
- </p></dd>
575
- <dt>&lsquo;<samp class="samp">DarkSlateGray</samp>&rsquo;</dt>
576
- <dd><p>0x2F4F4F
577
- </p></dd>
578
- <dt>&lsquo;<samp class="samp">DarkTurquoise</samp>&rsquo;</dt>
579
- <dd><p>0x00CED1
580
- </p></dd>
581
- <dt>&lsquo;<samp class="samp">DarkViolet</samp>&rsquo;</dt>
582
- <dd><p>0x9400D3
583
- </p></dd>
584
- <dt>&lsquo;<samp class="samp">DeepPink</samp>&rsquo;</dt>
585
- <dd><p>0xFF1493
586
- </p></dd>
587
- <dt>&lsquo;<samp class="samp">DeepSkyBlue</samp>&rsquo;</dt>
588
- <dd><p>0x00BFFF
589
- </p></dd>
590
- <dt>&lsquo;<samp class="samp">DimGray</samp>&rsquo;</dt>
591
- <dd><p>0x696969
592
- </p></dd>
593
- <dt>&lsquo;<samp class="samp">DodgerBlue</samp>&rsquo;</dt>
594
- <dd><p>0x1E90FF
595
- </p></dd>
596
- <dt>&lsquo;<samp class="samp">FireBrick</samp>&rsquo;</dt>
597
- <dd><p>0xB22222
598
- </p></dd>
599
- <dt>&lsquo;<samp class="samp">FloralWhite</samp>&rsquo;</dt>
600
- <dd><p>0xFFFAF0
601
- </p></dd>
602
- <dt>&lsquo;<samp class="samp">ForestGreen</samp>&rsquo;</dt>
603
- <dd><p>0x228B22
604
- </p></dd>
605
- <dt>&lsquo;<samp class="samp">Fuchsia</samp>&rsquo;</dt>
606
- <dd><p>0xFF00FF
607
- </p></dd>
608
- <dt>&lsquo;<samp class="samp">Gainsboro</samp>&rsquo;</dt>
609
- <dd><p>0xDCDCDC
610
- </p></dd>
611
- <dt>&lsquo;<samp class="samp">GhostWhite</samp>&rsquo;</dt>
612
- <dd><p>0xF8F8FF
613
- </p></dd>
614
- <dt>&lsquo;<samp class="samp">Gold</samp>&rsquo;</dt>
615
- <dd><p>0xFFD700
616
- </p></dd>
617
- <dt>&lsquo;<samp class="samp">GoldenRod</samp>&rsquo;</dt>
618
- <dd><p>0xDAA520
619
- </p></dd>
620
- <dt>&lsquo;<samp class="samp">Gray</samp>&rsquo;</dt>
621
- <dd><p>0x808080
622
- </p></dd>
623
- <dt>&lsquo;<samp class="samp">Green</samp>&rsquo;</dt>
624
- <dd><p>0x008000
625
- </p></dd>
626
- <dt>&lsquo;<samp class="samp">GreenYellow</samp>&rsquo;</dt>
627
- <dd><p>0xADFF2F
628
- </p></dd>
629
- <dt>&lsquo;<samp class="samp">HoneyDew</samp>&rsquo;</dt>
630
- <dd><p>0xF0FFF0
631
- </p></dd>
632
- <dt>&lsquo;<samp class="samp">HotPink</samp>&rsquo;</dt>
633
- <dd><p>0xFF69B4
634
- </p></dd>
635
- <dt>&lsquo;<samp class="samp">IndianRed</samp>&rsquo;</dt>
636
- <dd><p>0xCD5C5C
637
- </p></dd>
638
- <dt>&lsquo;<samp class="samp">Indigo</samp>&rsquo;</dt>
639
- <dd><p>0x4B0082
640
- </p></dd>
641
- <dt>&lsquo;<samp class="samp">Ivory</samp>&rsquo;</dt>
642
- <dd><p>0xFFFFF0
643
- </p></dd>
644
- <dt>&lsquo;<samp class="samp">Khaki</samp>&rsquo;</dt>
645
- <dd><p>0xF0E68C
646
- </p></dd>
647
- <dt>&lsquo;<samp class="samp">Lavender</samp>&rsquo;</dt>
648
- <dd><p>0xE6E6FA
649
- </p></dd>
650
- <dt>&lsquo;<samp class="samp">LavenderBlush</samp>&rsquo;</dt>
651
- <dd><p>0xFFF0F5
652
- </p></dd>
653
- <dt>&lsquo;<samp class="samp">LawnGreen</samp>&rsquo;</dt>
654
- <dd><p>0x7CFC00
655
- </p></dd>
656
- <dt>&lsquo;<samp class="samp">LemonChiffon</samp>&rsquo;</dt>
657
- <dd><p>0xFFFACD
658
- </p></dd>
659
- <dt>&lsquo;<samp class="samp">LightBlue</samp>&rsquo;</dt>
660
- <dd><p>0xADD8E6
661
- </p></dd>
662
- <dt>&lsquo;<samp class="samp">LightCoral</samp>&rsquo;</dt>
663
- <dd><p>0xF08080
664
- </p></dd>
665
- <dt>&lsquo;<samp class="samp">LightCyan</samp>&rsquo;</dt>
666
- <dd><p>0xE0FFFF
667
- </p></dd>
668
- <dt>&lsquo;<samp class="samp">LightGoldenRodYellow</samp>&rsquo;</dt>
669
- <dd><p>0xFAFAD2
670
- </p></dd>
671
- <dt>&lsquo;<samp class="samp">LightGreen</samp>&rsquo;</dt>
672
- <dd><p>0x90EE90
673
- </p></dd>
674
- <dt>&lsquo;<samp class="samp">LightGrey</samp>&rsquo;</dt>
675
- <dd><p>0xD3D3D3
676
- </p></dd>
677
- <dt>&lsquo;<samp class="samp">LightPink</samp>&rsquo;</dt>
678
- <dd><p>0xFFB6C1
679
- </p></dd>
680
- <dt>&lsquo;<samp class="samp">LightSalmon</samp>&rsquo;</dt>
681
- <dd><p>0xFFA07A
682
- </p></dd>
683
- <dt>&lsquo;<samp class="samp">LightSeaGreen</samp>&rsquo;</dt>
684
- <dd><p>0x20B2AA
685
- </p></dd>
686
- <dt>&lsquo;<samp class="samp">LightSkyBlue</samp>&rsquo;</dt>
687
- <dd><p>0x87CEFA
688
- </p></dd>
689
- <dt>&lsquo;<samp class="samp">LightSlateGray</samp>&rsquo;</dt>
690
- <dd><p>0x778899
691
- </p></dd>
692
- <dt>&lsquo;<samp class="samp">LightSteelBlue</samp>&rsquo;</dt>
693
- <dd><p>0xB0C4DE
694
- </p></dd>
695
- <dt>&lsquo;<samp class="samp">LightYellow</samp>&rsquo;</dt>
696
- <dd><p>0xFFFFE0
697
- </p></dd>
698
- <dt>&lsquo;<samp class="samp">Lime</samp>&rsquo;</dt>
699
- <dd><p>0x00FF00
700
- </p></dd>
701
- <dt>&lsquo;<samp class="samp">LimeGreen</samp>&rsquo;</dt>
702
- <dd><p>0x32CD32
703
- </p></dd>
704
- <dt>&lsquo;<samp class="samp">Linen</samp>&rsquo;</dt>
705
- <dd><p>0xFAF0E6
706
- </p></dd>
707
- <dt>&lsquo;<samp class="samp">Magenta</samp>&rsquo;</dt>
708
- <dd><p>0xFF00FF
709
- </p></dd>
710
- <dt>&lsquo;<samp class="samp">Maroon</samp>&rsquo;</dt>
711
- <dd><p>0x800000
712
- </p></dd>
713
- <dt>&lsquo;<samp class="samp">MediumAquaMarine</samp>&rsquo;</dt>
714
- <dd><p>0x66CDAA
715
- </p></dd>
716
- <dt>&lsquo;<samp class="samp">MediumBlue</samp>&rsquo;</dt>
717
- <dd><p>0x0000CD
718
- </p></dd>
719
- <dt>&lsquo;<samp class="samp">MediumOrchid</samp>&rsquo;</dt>
720
- <dd><p>0xBA55D3
721
- </p></dd>
722
- <dt>&lsquo;<samp class="samp">MediumPurple</samp>&rsquo;</dt>
723
- <dd><p>0x9370D8
724
- </p></dd>
725
- <dt>&lsquo;<samp class="samp">MediumSeaGreen</samp>&rsquo;</dt>
726
- <dd><p>0x3CB371
727
- </p></dd>
728
- <dt>&lsquo;<samp class="samp">MediumSlateBlue</samp>&rsquo;</dt>
729
- <dd><p>0x7B68EE
730
- </p></dd>
731
- <dt>&lsquo;<samp class="samp">MediumSpringGreen</samp>&rsquo;</dt>
732
- <dd><p>0x00FA9A
733
- </p></dd>
734
- <dt>&lsquo;<samp class="samp">MediumTurquoise</samp>&rsquo;</dt>
735
- <dd><p>0x48D1CC
736
- </p></dd>
737
- <dt>&lsquo;<samp class="samp">MediumVioletRed</samp>&rsquo;</dt>
738
- <dd><p>0xC71585
739
- </p></dd>
740
- <dt>&lsquo;<samp class="samp">MidnightBlue</samp>&rsquo;</dt>
741
- <dd><p>0x191970
742
- </p></dd>
743
- <dt>&lsquo;<samp class="samp">MintCream</samp>&rsquo;</dt>
744
- <dd><p>0xF5FFFA
745
- </p></dd>
746
- <dt>&lsquo;<samp class="samp">MistyRose</samp>&rsquo;</dt>
747
- <dd><p>0xFFE4E1
748
- </p></dd>
749
- <dt>&lsquo;<samp class="samp">Moccasin</samp>&rsquo;</dt>
750
- <dd><p>0xFFE4B5
751
- </p></dd>
752
- <dt>&lsquo;<samp class="samp">NavajoWhite</samp>&rsquo;</dt>
753
- <dd><p>0xFFDEAD
754
- </p></dd>
755
- <dt>&lsquo;<samp class="samp">Navy</samp>&rsquo;</dt>
756
- <dd><p>0x000080
757
- </p></dd>
758
- <dt>&lsquo;<samp class="samp">OldLace</samp>&rsquo;</dt>
759
- <dd><p>0xFDF5E6
760
- </p></dd>
761
- <dt>&lsquo;<samp class="samp">Olive</samp>&rsquo;</dt>
762
- <dd><p>0x808000
763
- </p></dd>
764
- <dt>&lsquo;<samp class="samp">OliveDrab</samp>&rsquo;</dt>
765
- <dd><p>0x6B8E23
766
- </p></dd>
767
- <dt>&lsquo;<samp class="samp">Orange</samp>&rsquo;</dt>
768
- <dd><p>0xFFA500
769
- </p></dd>
770
- <dt>&lsquo;<samp class="samp">OrangeRed</samp>&rsquo;</dt>
771
- <dd><p>0xFF4500
772
- </p></dd>
773
- <dt>&lsquo;<samp class="samp">Orchid</samp>&rsquo;</dt>
774
- <dd><p>0xDA70D6
775
- </p></dd>
776
- <dt>&lsquo;<samp class="samp">PaleGoldenRod</samp>&rsquo;</dt>
777
- <dd><p>0xEEE8AA
778
- </p></dd>
779
- <dt>&lsquo;<samp class="samp">PaleGreen</samp>&rsquo;</dt>
780
- <dd><p>0x98FB98
781
- </p></dd>
782
- <dt>&lsquo;<samp class="samp">PaleTurquoise</samp>&rsquo;</dt>
783
- <dd><p>0xAFEEEE
784
- </p></dd>
785
- <dt>&lsquo;<samp class="samp">PaleVioletRed</samp>&rsquo;</dt>
786
- <dd><p>0xD87093
787
- </p></dd>
788
- <dt>&lsquo;<samp class="samp">PapayaWhip</samp>&rsquo;</dt>
789
- <dd><p>0xFFEFD5
790
- </p></dd>
791
- <dt>&lsquo;<samp class="samp">PeachPuff</samp>&rsquo;</dt>
792
- <dd><p>0xFFDAB9
793
- </p></dd>
794
- <dt>&lsquo;<samp class="samp">Peru</samp>&rsquo;</dt>
795
- <dd><p>0xCD853F
796
- </p></dd>
797
- <dt>&lsquo;<samp class="samp">Pink</samp>&rsquo;</dt>
798
- <dd><p>0xFFC0CB
799
- </p></dd>
800
- <dt>&lsquo;<samp class="samp">Plum</samp>&rsquo;</dt>
801
- <dd><p>0xDDA0DD
802
- </p></dd>
803
- <dt>&lsquo;<samp class="samp">PowderBlue</samp>&rsquo;</dt>
804
- <dd><p>0xB0E0E6
805
- </p></dd>
806
- <dt>&lsquo;<samp class="samp">Purple</samp>&rsquo;</dt>
807
- <dd><p>0x800080
808
- </p></dd>
809
- <dt>&lsquo;<samp class="samp">Red</samp>&rsquo;</dt>
810
- <dd><p>0xFF0000
811
- </p></dd>
812
- <dt>&lsquo;<samp class="samp">RosyBrown</samp>&rsquo;</dt>
813
- <dd><p>0xBC8F8F
814
- </p></dd>
815
- <dt>&lsquo;<samp class="samp">RoyalBlue</samp>&rsquo;</dt>
816
- <dd><p>0x4169E1
817
- </p></dd>
818
- <dt>&lsquo;<samp class="samp">SaddleBrown</samp>&rsquo;</dt>
819
- <dd><p>0x8B4513
820
- </p></dd>
821
- <dt>&lsquo;<samp class="samp">Salmon</samp>&rsquo;</dt>
822
- <dd><p>0xFA8072
823
- </p></dd>
824
- <dt>&lsquo;<samp class="samp">SandyBrown</samp>&rsquo;</dt>
825
- <dd><p>0xF4A460
826
- </p></dd>
827
- <dt>&lsquo;<samp class="samp">SeaGreen</samp>&rsquo;</dt>
828
- <dd><p>0x2E8B57
829
- </p></dd>
830
- <dt>&lsquo;<samp class="samp">SeaShell</samp>&rsquo;</dt>
831
- <dd><p>0xFFF5EE
832
- </p></dd>
833
- <dt>&lsquo;<samp class="samp">Sienna</samp>&rsquo;</dt>
834
- <dd><p>0xA0522D
835
- </p></dd>
836
- <dt>&lsquo;<samp class="samp">Silver</samp>&rsquo;</dt>
837
- <dd><p>0xC0C0C0
838
- </p></dd>
839
- <dt>&lsquo;<samp class="samp">SkyBlue</samp>&rsquo;</dt>
840
- <dd><p>0x87CEEB
841
- </p></dd>
842
- <dt>&lsquo;<samp class="samp">SlateBlue</samp>&rsquo;</dt>
843
- <dd><p>0x6A5ACD
844
- </p></dd>
845
- <dt>&lsquo;<samp class="samp">SlateGray</samp>&rsquo;</dt>
846
- <dd><p>0x708090
847
- </p></dd>
848
- <dt>&lsquo;<samp class="samp">Snow</samp>&rsquo;</dt>
849
- <dd><p>0xFFFAFA
850
- </p></dd>
851
- <dt>&lsquo;<samp class="samp">SpringGreen</samp>&rsquo;</dt>
852
- <dd><p>0x00FF7F
853
- </p></dd>
854
- <dt>&lsquo;<samp class="samp">SteelBlue</samp>&rsquo;</dt>
855
- <dd><p>0x4682B4
856
- </p></dd>
857
- <dt>&lsquo;<samp class="samp">Tan</samp>&rsquo;</dt>
858
- <dd><p>0xD2B48C
859
- </p></dd>
860
- <dt>&lsquo;<samp class="samp">Teal</samp>&rsquo;</dt>
861
- <dd><p>0x008080
862
- </p></dd>
863
- <dt>&lsquo;<samp class="samp">Thistle</samp>&rsquo;</dt>
864
- <dd><p>0xD8BFD8
865
- </p></dd>
866
- <dt>&lsquo;<samp class="samp">Tomato</samp>&rsquo;</dt>
867
- <dd><p>0xFF6347
868
- </p></dd>
869
- <dt>&lsquo;<samp class="samp">Turquoise</samp>&rsquo;</dt>
870
- <dd><p>0x40E0D0
871
- </p></dd>
872
- <dt>&lsquo;<samp class="samp">Violet</samp>&rsquo;</dt>
873
- <dd><p>0xEE82EE
874
- </p></dd>
875
- <dt>&lsquo;<samp class="samp">Wheat</samp>&rsquo;</dt>
876
- <dd><p>0xF5DEB3
877
- </p></dd>
878
- <dt>&lsquo;<samp class="samp">White</samp>&rsquo;</dt>
879
- <dd><p>0xFFFFFF
880
- </p></dd>
881
- <dt>&lsquo;<samp class="samp">WhiteSmoke</samp>&rsquo;</dt>
882
- <dd><p>0xF5F5F5
883
- </p></dd>
884
- <dt>&lsquo;<samp class="samp">Yellow</samp>&rsquo;</dt>
885
- <dd><p>0xFFFF00
886
- </p></dd>
887
- <dt>&lsquo;<samp class="samp">YellowGreen</samp>&rsquo;</dt>
888
- <dd><p>0x9ACD32
889
- </p></dd>
890
- </dl>
891
-
892
- <a class="anchor" id="channel-layout-syntax"></a></div>
893
- <div class="section-level-extent" id="Channel-Layout">
894
- <h3 class="section"><span>2.8 Channel Layout<a class="copiable-link" href="#Channel-Layout"> &para;</a></span></h3>
895
-
896
- <p>A channel layout specifies the spatial disposition of the channels in
897
- a multi-channel audio stream. To specify a channel layout, FFmpeg
898
- makes use of a special syntax.
899
- </p>
900
- <p>Individual channels are identified by an id, as given by the table
901
- below:
902
- </p><dl class="table">
903
- <dt>&lsquo;<samp class="samp">FL</samp>&rsquo;</dt>
904
- <dd><p>front left
905
- </p></dd>
906
- <dt>&lsquo;<samp class="samp">FR</samp>&rsquo;</dt>
907
- <dd><p>front right
908
- </p></dd>
909
- <dt>&lsquo;<samp class="samp">FC</samp>&rsquo;</dt>
910
- <dd><p>front center
911
- </p></dd>
912
- <dt>&lsquo;<samp class="samp">LFE</samp>&rsquo;</dt>
913
- <dd><p>low frequency
914
- </p></dd>
915
- <dt>&lsquo;<samp class="samp">BL</samp>&rsquo;</dt>
916
- <dd><p>back left
917
- </p></dd>
918
- <dt>&lsquo;<samp class="samp">BR</samp>&rsquo;</dt>
919
- <dd><p>back right
920
- </p></dd>
921
- <dt>&lsquo;<samp class="samp">FLC</samp>&rsquo;</dt>
922
- <dd><p>front left-of-center
923
- </p></dd>
924
- <dt>&lsquo;<samp class="samp">FRC</samp>&rsquo;</dt>
925
- <dd><p>front right-of-center
926
- </p></dd>
927
- <dt>&lsquo;<samp class="samp">BC</samp>&rsquo;</dt>
928
- <dd><p>back center
929
- </p></dd>
930
- <dt>&lsquo;<samp class="samp">SL</samp>&rsquo;</dt>
931
- <dd><p>side left
932
- </p></dd>
933
- <dt>&lsquo;<samp class="samp">SR</samp>&rsquo;</dt>
934
- <dd><p>side right
935
- </p></dd>
936
- <dt>&lsquo;<samp class="samp">TC</samp>&rsquo;</dt>
937
- <dd><p>top center
938
- </p></dd>
939
- <dt>&lsquo;<samp class="samp">TFL</samp>&rsquo;</dt>
940
- <dd><p>top front left
941
- </p></dd>
942
- <dt>&lsquo;<samp class="samp">TFC</samp>&rsquo;</dt>
943
- <dd><p>top front center
944
- </p></dd>
945
- <dt>&lsquo;<samp class="samp">TFR</samp>&rsquo;</dt>
946
- <dd><p>top front right
947
- </p></dd>
948
- <dt>&lsquo;<samp class="samp">TBL</samp>&rsquo;</dt>
949
- <dd><p>top back left
950
- </p></dd>
951
- <dt>&lsquo;<samp class="samp">TBC</samp>&rsquo;</dt>
952
- <dd><p>top back center
953
- </p></dd>
954
- <dt>&lsquo;<samp class="samp">TBR</samp>&rsquo;</dt>
955
- <dd><p>top back right
956
- </p></dd>
957
- <dt>&lsquo;<samp class="samp">DL</samp>&rsquo;</dt>
958
- <dd><p>downmix left
959
- </p></dd>
960
- <dt>&lsquo;<samp class="samp">DR</samp>&rsquo;</dt>
961
- <dd><p>downmix right
962
- </p></dd>
963
- <dt>&lsquo;<samp class="samp">WL</samp>&rsquo;</dt>
964
- <dd><p>wide left
965
- </p></dd>
966
- <dt>&lsquo;<samp class="samp">WR</samp>&rsquo;</dt>
967
- <dd><p>wide right
968
- </p></dd>
969
- <dt>&lsquo;<samp class="samp">SDL</samp>&rsquo;</dt>
970
- <dd><p>surround direct left
971
- </p></dd>
972
- <dt>&lsquo;<samp class="samp">SDR</samp>&rsquo;</dt>
973
- <dd><p>surround direct right
974
- </p></dd>
975
- <dt>&lsquo;<samp class="samp">LFE2</samp>&rsquo;</dt>
976
- <dd><p>low frequency 2
977
- </p></dd>
978
- </dl>
979
-
980
- <p>Standard channel layout compositions can be specified by using the
981
- following identifiers:
982
- </p><dl class="table">
983
- <dt>&lsquo;<samp class="samp">mono</samp>&rsquo;</dt>
984
- <dd><p>FC
985
- </p></dd>
986
- <dt>&lsquo;<samp class="samp">stereo</samp>&rsquo;</dt>
987
- <dd><p>FL+FR
988
- </p></dd>
989
- <dt>&lsquo;<samp class="samp">2.1</samp>&rsquo;</dt>
990
- <dd><p>FL+FR+LFE
991
- </p></dd>
992
- <dt>&lsquo;<samp class="samp">3.0</samp>&rsquo;</dt>
993
- <dd><p>FL+FR+FC
994
- </p></dd>
995
- <dt>&lsquo;<samp class="samp">3.0(back)</samp>&rsquo;</dt>
996
- <dd><p>FL+FR+BC
997
- </p></dd>
998
- <dt>&lsquo;<samp class="samp">4.0</samp>&rsquo;</dt>
999
- <dd><p>FL+FR+FC+BC
1000
- </p></dd>
1001
- <dt>&lsquo;<samp class="samp">quad</samp>&rsquo;</dt>
1002
- <dd><p>FL+FR+BL+BR
1003
- </p></dd>
1004
- <dt>&lsquo;<samp class="samp">quad(side)</samp>&rsquo;</dt>
1005
- <dd><p>FL+FR+SL+SR
1006
- </p></dd>
1007
- <dt>&lsquo;<samp class="samp">3.1</samp>&rsquo;</dt>
1008
- <dd><p>FL+FR+FC+LFE
1009
- </p></dd>
1010
- <dt>&lsquo;<samp class="samp">5.0</samp>&rsquo;</dt>
1011
- <dd><p>FL+FR+FC+BL+BR
1012
- </p></dd>
1013
- <dt>&lsquo;<samp class="samp">5.0(side)</samp>&rsquo;</dt>
1014
- <dd><p>FL+FR+FC+SL+SR
1015
- </p></dd>
1016
- <dt>&lsquo;<samp class="samp">4.1</samp>&rsquo;</dt>
1017
- <dd><p>FL+FR+FC+LFE+BC
1018
- </p></dd>
1019
- <dt>&lsquo;<samp class="samp">5.1</samp>&rsquo;</dt>
1020
- <dd><p>FL+FR+FC+LFE+BL+BR
1021
- </p></dd>
1022
- <dt>&lsquo;<samp class="samp">5.1(side)</samp>&rsquo;</dt>
1023
- <dd><p>FL+FR+FC+LFE+SL+SR
1024
- </p></dd>
1025
- <dt>&lsquo;<samp class="samp">6.0</samp>&rsquo;</dt>
1026
- <dd><p>FL+FR+FC+BC+SL+SR
1027
- </p></dd>
1028
- <dt>&lsquo;<samp class="samp">6.0(front)</samp>&rsquo;</dt>
1029
- <dd><p>FL+FR+FLC+FRC+SL+SR
1030
- </p></dd>
1031
- <dt>&lsquo;<samp class="samp">3.1.2</samp>&rsquo;</dt>
1032
- <dd><p>FL+FR+FC+LFE+TFL+TFR
1033
- </p></dd>
1034
- <dt>&lsquo;<samp class="samp">hexagonal</samp>&rsquo;</dt>
1035
- <dd><p>FL+FR+FC+BL+BR+BC
1036
- </p></dd>
1037
- <dt>&lsquo;<samp class="samp">6.1</samp>&rsquo;</dt>
1038
- <dd><p>FL+FR+FC+LFE+BC+SL+SR
1039
- </p></dd>
1040
- <dt>&lsquo;<samp class="samp">6.1</samp>&rsquo;</dt>
1041
- <dd><p>FL+FR+FC+LFE+BL+BR+BC
1042
- </p></dd>
1043
- <dt>&lsquo;<samp class="samp">6.1(front)</samp>&rsquo;</dt>
1044
- <dd><p>FL+FR+LFE+FLC+FRC+SL+SR
1045
- </p></dd>
1046
- <dt>&lsquo;<samp class="samp">7.0</samp>&rsquo;</dt>
1047
- <dd><p>FL+FR+FC+BL+BR+SL+SR
1048
- </p></dd>
1049
- <dt>&lsquo;<samp class="samp">7.0(front)</samp>&rsquo;</dt>
1050
- <dd><p>FL+FR+FC+FLC+FRC+SL+SR
1051
- </p></dd>
1052
- <dt>&lsquo;<samp class="samp">7.1</samp>&rsquo;</dt>
1053
- <dd><p>FL+FR+FC+LFE+BL+BR+SL+SR
1054
- </p></dd>
1055
- <dt>&lsquo;<samp class="samp">7.1(wide)</samp>&rsquo;</dt>
1056
- <dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC
1057
- </p></dd>
1058
- <dt>&lsquo;<samp class="samp">7.1(wide-side)</samp>&rsquo;</dt>
1059
- <dd><p>FL+FR+FC+LFE+FLC+FRC+SL+SR
1060
- </p></dd>
1061
- <dt>&lsquo;<samp class="samp">5.1.2</samp>&rsquo;</dt>
1062
- <dd><p>FL+FR+FC+LFE+BL+BR+TFL+TFR
1063
- </p></dd>
1064
- <dt>&lsquo;<samp class="samp">octagonal</samp>&rsquo;</dt>
1065
- <dd><p>FL+FR+FC+BL+BR+BC+SL+SR
1066
- </p></dd>
1067
- <dt>&lsquo;<samp class="samp">cube</samp>&rsquo;</dt>
1068
- <dd><p>FL+FR+BL+BR+TFL+TFR+TBL+TBR
1069
- </p></dd>
1070
- <dt>&lsquo;<samp class="samp">5.1.4</samp>&rsquo;</dt>
1071
- <dd><p>FL+FR+FC+LFE+BL+BR+TFL+TFR+TBL+TBR
1072
- </p></dd>
1073
- <dt>&lsquo;<samp class="samp">7.1.2</samp>&rsquo;</dt>
1074
- <dd><p>FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR
1075
- </p></dd>
1076
- <dt>&lsquo;<samp class="samp">7.1.4</samp>&rsquo;</dt>
1077
- <dd><p>FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR+TBL+TBR
1078
- </p></dd>
1079
- <dt>&lsquo;<samp class="samp">7.2.3</samp>&rsquo;</dt>
1080
- <dd><p>FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR+TBC+LFE2
1081
- </p></dd>
1082
- <dt>&lsquo;<samp class="samp">9.1.4</samp>&rsquo;</dt>
1083
- <dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC+SL+SR+TFL+TFR+TBL+TBR
1084
- </p></dd>
1085
- <dt>&lsquo;<samp class="samp">hexadecagonal</samp>&rsquo;</dt>
1086
- <dd><p>FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR
1087
- </p></dd>
1088
- <dt>&lsquo;<samp class="samp">binaural</samp>&rsquo;</dt>
1089
- <dd><p>BIL+BIR
1090
- </p></dd>
1091
- <dt>&lsquo;<samp class="samp">downmix</samp>&rsquo;</dt>
1092
- <dd><p>DL+DR
1093
- </p></dd>
1094
- <dt>&lsquo;<samp class="samp">22.2</samp>&rsquo;</dt>
1095
- <dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC+BC+SL+SR+TC+TFL+TFC+TFR+TBL+TBC+TBR+LFE2+TSL+TSR+BFC+BFL+BFR
1096
- </p></dd>
1097
- </dl>
1098
-
1099
- <p>A custom channel layout can be specified as a sequence of terms, separated by &rsquo;+&rsquo;.
1100
- Each term can be:
1101
- </p><ul class="itemize mark-bullet">
1102
- <li>the name of a single channel (e.g. &lsquo;<samp class="samp">FL</samp>&rsquo;, &lsquo;<samp class="samp">FR</samp>&rsquo;, &lsquo;<samp class="samp">FC</samp>&rsquo;, &lsquo;<samp class="samp">LFE</samp>&rsquo;, etc.),
1103
- each optionally containing a custom name after a &rsquo;@&rsquo;, (e.g. &lsquo;<samp class="samp">FL@Left</samp>&rsquo;,
1104
- &lsquo;<samp class="samp">FR@Right</samp>&rsquo;, &lsquo;<samp class="samp">FC@Center</samp>&rsquo;, &lsquo;<samp class="samp">LFE@Low_Frequency</samp>&rsquo;, etc.)
1105
- </li></ul>
1106
-
1107
- <p>A standard channel layout can be specified by the following:
1108
- </p><ul class="itemize mark-bullet">
1109
- <li>the name of a single channel (e.g. &lsquo;<samp class="samp">FL</samp>&rsquo;, &lsquo;<samp class="samp">FR</samp>&rsquo;, &lsquo;<samp class="samp">FC</samp>&rsquo;, &lsquo;<samp class="samp">LFE</samp>&rsquo;, etc.)
1110
-
1111
- </li><li>the name of a standard channel layout (e.g. &lsquo;<samp class="samp">mono</samp>&rsquo;,
1112
- &lsquo;<samp class="samp">stereo</samp>&rsquo;, &lsquo;<samp class="samp">4.0</samp>&rsquo;, &lsquo;<samp class="samp">quad</samp>&rsquo;, &lsquo;<samp class="samp">5.0</samp>&rsquo;, etc.)
1113
-
1114
- </li><li>a number of channels, in decimal, followed by &rsquo;c&rsquo;, yielding the default channel
1115
- layout for that number of channels (see the function
1116
- <code class="code">av_channel_layout_default</code>). Note that not all channel counts have a
1117
- default layout.
1118
-
1119
- </li><li>a number of channels, in decimal, followed by &rsquo;C&rsquo;, yielding an unknown channel
1120
- layout with the specified number of channels. Note that not all channel layout
1121
- specification strings support unknown channel layouts.
1122
-
1123
- </li><li>a channel layout mask, in hexadecimal starting with &quot;0x&quot; (see the
1124
- <code class="code">AV_CH_*</code> macros in <samp class="file">libavutil/channel_layout.h</samp>.
1125
- </li></ul>
1126
-
1127
- <p>Before libavutil version 53 the trailing character &quot;c&quot; to specify a number of
1128
- channels was optional, but now it is required, while a channel layout mask can
1129
- also be specified as a decimal number (if and only if not followed by &quot;c&quot; or &quot;C&quot;).
1130
- </p>
1131
- <p>See also the function <code class="code">av_channel_layout_from_string</code> defined in
1132
- <samp class="file">libavutil/channel_layout.h</samp>.
1133
- </p>
1134
- </div>
1135
- </div>
1136
- <div class="chapter-level-extent" id="Expression-Evaluation">
1137
- <h2 class="chapter"><span>3 Expression Evaluation<a class="copiable-link" href="#Expression-Evaluation"> &para;</a></span></h2>
1138
-
1139
- <p>When evaluating an arithmetic expression, FFmpeg uses an internal
1140
- formula evaluator, implemented through the <samp class="file">libavutil/eval.h</samp>
1141
- interface.
1142
- </p>
1143
- <p>An expression may contain unary, binary operators, constants, and
1144
- functions.
1145
- </p>
1146
- <p>Two expressions <var class="var">expr1</var> and <var class="var">expr2</var> can be combined to form
1147
- another expression &quot;<var class="var">expr1</var>;<var class="var">expr2</var>&quot;.
1148
- <var class="var">expr1</var> and <var class="var">expr2</var> are evaluated in turn, and the new
1149
- expression evaluates to the value of <var class="var">expr2</var>.
1150
- </p>
1151
- <p>The following binary operators are available: <code class="code">+</code>, <code class="code">-</code>,
1152
- <code class="code">*</code>, <code class="code">/</code>, <code class="code">^</code>.
1153
- </p>
1154
- <p>The following unary operators are available: <code class="code">+</code>, <code class="code">-</code>.
1155
- </p>
1156
- <p>Some internal variables can be used to store and load intermediary
1157
- results. They can be accessed using the <code class="code">ld</code> and <code class="code">st</code>
1158
- functions with an index argument varying from 0 to 9 to specify which
1159
- internal variable to access.
1160
- </p>
1161
- <p>The following functions are available:
1162
- </p><dl class="table">
1163
- <dt><samp class="option">abs(x)</samp></dt>
1164
- <dd><p>Compute absolute value of <var class="var">x</var>.
1165
- </p>
1166
- </dd>
1167
- <dt><samp class="option">acos(x)</samp></dt>
1168
- <dd><p>Compute arccosine of <var class="var">x</var>.
1169
- </p>
1170
- </dd>
1171
- <dt><samp class="option">asin(x)</samp></dt>
1172
- <dd><p>Compute arcsine of <var class="var">x</var>.
1173
- </p>
1174
- </dd>
1175
- <dt><samp class="option">atan(x)</samp></dt>
1176
- <dd><p>Compute arctangent of <var class="var">x</var>.
1177
- </p>
1178
- </dd>
1179
- <dt><samp class="option">atan2(y, x)</samp></dt>
1180
- <dd><p>Compute principal value of the arc tangent of <var class="var">y</var>/<var class="var">x</var>.
1181
- </p>
1182
- </dd>
1183
- <dt><samp class="option">between(x, min, max)</samp></dt>
1184
- <dd><p>Return 1 if <var class="var">x</var> is greater than or equal to <var class="var">min</var> and lesser than or
1185
- equal to <var class="var">max</var>, 0 otherwise.
1186
- </p>
1187
- </dd>
1188
- <dt><samp class="option">bitand(x, y)</samp></dt>
1189
- <dt><samp class="option">bitor(x, y)</samp></dt>
1190
- <dd><p>Compute bitwise and/or operation on <var class="var">x</var> and <var class="var">y</var>.
1191
- </p>
1192
- <p>The results of the evaluation of <var class="var">x</var> and <var class="var">y</var> are converted to
1193
- integers before executing the bitwise operation.
1194
- </p>
1195
- <p>Note that both the conversion to integer and the conversion back to
1196
- floating point can lose precision. Beware of unexpected results for
1197
- large numbers (usually 2^53 and larger).
1198
- </p>
1199
- </dd>
1200
- <dt><samp class="option">ceil(expr)</samp></dt>
1201
- <dd><p>Round the value of expression <var class="var">expr</var> upwards to the nearest
1202
- integer. For example, &quot;ceil(1.5)&quot; is &quot;2.0&quot;.
1203
- </p>
1204
- </dd>
1205
- <dt><samp class="option">clip(x, min, max)</samp></dt>
1206
- <dd><p>Return the value of <var class="var">x</var> clipped between <var class="var">min</var> and <var class="var">max</var>.
1207
- </p>
1208
- </dd>
1209
- <dt><samp class="option">cos(x)</samp></dt>
1210
- <dd><p>Compute cosine of <var class="var">x</var>.
1211
- </p>
1212
- </dd>
1213
- <dt><samp class="option">cosh(x)</samp></dt>
1214
- <dd><p>Compute hyperbolic cosine of <var class="var">x</var>.
1215
- </p>
1216
- </dd>
1217
- <dt><samp class="option">eq(x, y)</samp></dt>
1218
- <dd><p>Return 1 if <var class="var">x</var> and <var class="var">y</var> are equivalent, 0 otherwise.
1219
- </p>
1220
- </dd>
1221
- <dt><samp class="option">exp(x)</samp></dt>
1222
- <dd><p>Compute exponential of <var class="var">x</var> (with base <code class="code">e</code>, the Euler&rsquo;s number).
1223
- </p>
1224
- </dd>
1225
- <dt><samp class="option">floor(expr)</samp></dt>
1226
- <dd><p>Round the value of expression <var class="var">expr</var> downwards to the nearest
1227
- integer. For example, &quot;floor(-1.5)&quot; is &quot;-2.0&quot;.
1228
- </p>
1229
- </dd>
1230
- <dt><samp class="option">gauss(x)</samp></dt>
1231
- <dd><p>Compute Gauss function of <var class="var">x</var>, corresponding to
1232
- <code class="code">exp(-x*x/2) / sqrt(2*PI)</code>.
1233
- </p>
1234
- </dd>
1235
- <dt><samp class="option">gcd(x, y)</samp></dt>
1236
- <dd><p>Return the greatest common divisor of <var class="var">x</var> and <var class="var">y</var>. If both <var class="var">x</var> and
1237
- <var class="var">y</var> are 0 or either or both are less than zero then behavior is undefined.
1238
- </p>
1239
- </dd>
1240
- <dt><samp class="option">gt(x, y)</samp></dt>
1241
- <dd><p>Return 1 if <var class="var">x</var> is greater than <var class="var">y</var>, 0 otherwise.
1242
- </p>
1243
- </dd>
1244
- <dt><samp class="option">gte(x, y)</samp></dt>
1245
- <dd><p>Return 1 if <var class="var">x</var> is greater than or equal to <var class="var">y</var>, 0 otherwise.
1246
- </p>
1247
- </dd>
1248
- <dt><samp class="option">hypot(x, y)</samp></dt>
1249
- <dd><p>This function is similar to the C function with the same name; it returns
1250
- &quot;sqrt(<var class="var">x</var>*<var class="var">x</var> + <var class="var">y</var>*<var class="var">y</var>)&quot;, the length of the hypotenuse of a
1251
- right triangle with sides of length <var class="var">x</var> and <var class="var">y</var>, or the distance of the
1252
- point (<var class="var">x</var>, <var class="var">y</var>) from the origin.
1253
- </p>
1254
- </dd>
1255
- <dt><samp class="option">if(x, y)</samp></dt>
1256
- <dd><p>Evaluate <var class="var">x</var>, and if the result is non-zero return the result of
1257
- the evaluation of <var class="var">y</var>, return 0 otherwise.
1258
- </p>
1259
- </dd>
1260
- <dt><samp class="option">if(x, y, z)</samp></dt>
1261
- <dd><p>Evaluate <var class="var">x</var>, and if the result is non-zero return the evaluation
1262
- result of <var class="var">y</var>, otherwise the evaluation result of <var class="var">z</var>.
1263
- </p>
1264
- </dd>
1265
- <dt><samp class="option">ifnot(x, y)</samp></dt>
1266
- <dd><p>Evaluate <var class="var">x</var>, and if the result is zero return the result of the
1267
- evaluation of <var class="var">y</var>, return 0 otherwise.
1268
- </p>
1269
- </dd>
1270
- <dt><samp class="option">ifnot(x, y, z)</samp></dt>
1271
- <dd><p>Evaluate <var class="var">x</var>, and if the result is zero return the evaluation
1272
- result of <var class="var">y</var>, otherwise the evaluation result of <var class="var">z</var>.
1273
- </p>
1274
- </dd>
1275
- <dt><samp class="option">isinf(x)</samp></dt>
1276
- <dd><p>Return 1.0 if <var class="var">x</var> is +/-INFINITY, 0.0 otherwise.
1277
- </p>
1278
- </dd>
1279
- <dt><samp class="option">isnan(x)</samp></dt>
1280
- <dd><p>Return 1.0 if <var class="var">x</var> is NAN, 0.0 otherwise.
1281
- </p>
1282
- </dd>
1283
- <dt><samp class="option">ld(idx)</samp></dt>
1284
- <dd><p>Load the value of the internal variable with index <var class="var">idx</var>, which was
1285
- previously stored with st(<var class="var">idx</var>, <var class="var">expr</var>).
1286
- The function returns the loaded value.
1287
- </p>
1288
- </dd>
1289
- <dt><samp class="option">lerp(x, y, z)</samp></dt>
1290
- <dd><p>Return linear interpolation between <var class="var">x</var> and <var class="var">y</var> by amount of <var class="var">z</var>.
1291
- </p>
1292
- </dd>
1293
- <dt><samp class="option">log(x)</samp></dt>
1294
- <dd><p>Compute natural logarithm of <var class="var">x</var>.
1295
- </p>
1296
- </dd>
1297
- <dt><samp class="option">lt(x, y)</samp></dt>
1298
- <dd><p>Return 1 if <var class="var">x</var> is lesser than <var class="var">y</var>, 0 otherwise.
1299
- </p>
1300
- </dd>
1301
- <dt><samp class="option">lte(x, y)</samp></dt>
1302
- <dd><p>Return 1 if <var class="var">x</var> is lesser than or equal to <var class="var">y</var>, 0 otherwise.
1303
- </p>
1304
- </dd>
1305
- <dt><samp class="option">max(x, y)</samp></dt>
1306
- <dd><p>Return the maximum between <var class="var">x</var> and <var class="var">y</var>.
1307
- </p>
1308
- </dd>
1309
- <dt><samp class="option">min(x, y)</samp></dt>
1310
- <dd><p>Return the minimum between <var class="var">x</var> and <var class="var">y</var>.
1311
- </p>
1312
- </dd>
1313
- <dt><samp class="option">mod(x, y)</samp></dt>
1314
- <dd><p>Compute the remainder of division of <var class="var">x</var> by <var class="var">y</var>.
1315
- </p>
1316
- </dd>
1317
- <dt><samp class="option">not(expr)</samp></dt>
1318
- <dd><p>Return 1.0 if <var class="var">expr</var> is zero, 0.0 otherwise.
1319
- </p>
1320
- </dd>
1321
- <dt><samp class="option">pow(x, y)</samp></dt>
1322
- <dd><p>Compute the power of <var class="var">x</var> elevated <var class="var">y</var>, it is equivalent to
1323
- &quot;(<var class="var">x</var>)^(<var class="var">y</var>)&quot;.
1324
- </p>
1325
- </dd>
1326
- <dt><samp class="option">print(t)</samp></dt>
1327
- <dt><samp class="option">print(t, l)</samp></dt>
1328
- <dd><p>Print the value of expression <var class="var">t</var> with loglevel <var class="var">l</var>. If <var class="var">l</var> is not
1329
- specified then a default log level is used.
1330
- Return the value of the expression printed.
1331
- </p>
1332
- </dd>
1333
- <dt><samp class="option">random(idx)</samp></dt>
1334
- <dd><p>Return a pseudo random value between 0.0 and 1.0. <var class="var">idx</var> is the
1335
- index of the internal variable used to save the seed/state, which can be
1336
- previously stored with <code class="code">st(idx)</code>.
1337
- </p>
1338
- <p>To initialize the seed, you need to store the seed value as a 64-bit
1339
- unsigned integer in the internal variable with index <var class="var">idx</var>.
1340
- </p>
1341
- <p>For example, to store the seed with value <code class="code">42</code> in the internal
1342
- variable with index <code class="code">0</code> and print a few random values:
1343
- </p><div class="example">
1344
- <pre class="example-preformatted">st(0,42); print(random(0)); print(random(0)); print(random(0))
1345
- </pre></div>
1346
-
1347
- </dd>
1348
- <dt><samp class="option">randomi(idx, min, max)</samp></dt>
1349
- <dd><p>Return a pseudo random value in the interval between <var class="var">min</var> and
1350
- <var class="var">max</var>. <var class="var">idx</var> is the index of the internal variable which will be used to
1351
- save the seed/state, which can be previously stored with <code class="code">st(idx)</code>.
1352
- </p>
1353
- <p>To initialize the seed, you need to store the seed value as a 64-bit
1354
- unsigned integer in the internal variable with index <var class="var">idx</var>.
1355
- </p>
1356
- </dd>
1357
- <dt><samp class="option">root(expr, max)</samp></dt>
1358
- <dd><p>Find an input value for which the function represented by <var class="var">expr</var>
1359
- with argument <var class="var">ld(0)</var> is 0 in the interval 0..<var class="var">max</var>.
1360
- </p>
1361
- <p>The expression in <var class="var">expr</var> must denote a continuous function or the
1362
- result is undefined.
1363
- </p>
1364
- <p><var class="var">ld(0)</var> is used to represent the function input value, which means that the
1365
- given expression will be evaluated multiple times with various input values that
1366
- the expression can access through <code class="code">ld(0)</code>. When the expression evaluates to
1367
- 0 then the corresponding input value will be returned.
1368
- </p>
1369
- </dd>
1370
- <dt><samp class="option">round(expr)</samp></dt>
1371
- <dd><p>Round the value of expression <var class="var">expr</var> to the nearest integer. For example,
1372
- &quot;round(1.5)&quot; is &quot;2.0&quot;.
1373
- </p>
1374
- </dd>
1375
- <dt><samp class="option">sgn(x)</samp></dt>
1376
- <dd><p>Compute sign of <var class="var">x</var>.
1377
- </p>
1378
- </dd>
1379
- <dt><samp class="option">sin(x)</samp></dt>
1380
- <dd><p>Compute sine of <var class="var">x</var>.
1381
- </p>
1382
- </dd>
1383
- <dt><samp class="option">sinh(x)</samp></dt>
1384
- <dd><p>Compute hyperbolic sine of <var class="var">x</var>.
1385
- </p>
1386
- </dd>
1387
- <dt><samp class="option">sqrt(expr)</samp></dt>
1388
- <dd><p>Compute the square root of <var class="var">expr</var>. This is equivalent to
1389
- &quot;(<var class="var">expr</var>)^.5&quot;.
1390
- </p>
1391
- </dd>
1392
- <dt><samp class="option">squish(x)</samp></dt>
1393
- <dd><p>Compute expression <code class="code">1/(1 + exp(4*x))</code>.
1394
- </p>
1395
- </dd>
1396
- <dt><samp class="option">st(idx, expr)</samp></dt>
1397
- <dd><p>Store the value of the expression <var class="var">expr</var> in an internal
1398
- variable. <var class="var">idx</var> specifies the index of the variable where to store
1399
- the value, and it is a value ranging from 0 to 9. The function returns
1400
- the value stored in the internal variable.
1401
- </p>
1402
- <p>The stored value can be retrieved with <code class="code">ld(var)</code>.
1403
- </p>
1404
- <p>Note: variables are currently not shared between expressions.
1405
- </p>
1406
- </dd>
1407
- <dt><samp class="option">tan(x)</samp></dt>
1408
- <dd><p>Compute tangent of <var class="var">x</var>.
1409
- </p>
1410
- </dd>
1411
- <dt><samp class="option">tanh(x)</samp></dt>
1412
- <dd><p>Compute hyperbolic tangent of <var class="var">x</var>.
1413
- </p>
1414
- </dd>
1415
- <dt><samp class="option">taylor(expr, x)</samp></dt>
1416
- <dt><samp class="option">taylor(expr, x, idx)</samp></dt>
1417
- <dd><p>Evaluate a Taylor series at <var class="var">x</var>, given an expression representing
1418
- the <code class="code">ld(idx)</code>-th derivative of a function at 0.
1419
- </p>
1420
- <p>When the series does not converge the result is undefined.
1421
- </p>
1422
- <p><var class="var">ld(idx)</var> is used to represent the derivative order in <var class="var">expr</var>,
1423
- which means that the given expression will be evaluated multiple times
1424
- with various input values that the expression can access through
1425
- <code class="code">ld(idx)</code>. If <var class="var">idx</var> is not specified then 0 is assumed.
1426
- </p>
1427
- <p>Note, when you have the derivatives at y instead of 0,
1428
- <code class="code">taylor(expr, x-y)</code> can be used.
1429
- </p>
1430
- </dd>
1431
- <dt><samp class="option">time(0)</samp></dt>
1432
- <dd><p>Return the current (wallclock) time in seconds.
1433
- </p>
1434
- </dd>
1435
- <dt><samp class="option">trunc(expr)</samp></dt>
1436
- <dd><p>Round the value of expression <var class="var">expr</var> towards zero to the nearest
1437
- integer. For example, &quot;trunc(-1.5)&quot; is &quot;-1.0&quot;.
1438
- </p>
1439
- </dd>
1440
- <dt><samp class="option">while(cond, expr)</samp></dt>
1441
- <dd><p>Evaluate expression <var class="var">expr</var> while the expression <var class="var">cond</var> is
1442
- non-zero, and returns the value of the last <var class="var">expr</var> evaluation, or
1443
- NAN if <var class="var">cond</var> was always false.
1444
- </p></dd>
1445
- </dl>
1446
-
1447
- <p>The following constants are available:
1448
- </p><dl class="table">
1449
- <dt><samp class="option">PI</samp></dt>
1450
- <dd><p>area of the unit disc, approximately 3.14
1451
- </p></dd>
1452
- <dt><samp class="option">E</samp></dt>
1453
- <dd><p>exp(1) (Euler&rsquo;s number), approximately 2.718
1454
- </p></dd>
1455
- <dt><samp class="option">PHI</samp></dt>
1456
- <dd><p>golden ratio (1+sqrt(5))/2, approximately 1.618
1457
- </p></dd>
1458
- </dl>
1459
-
1460
- <p>Assuming that an expression is considered &quot;true&quot; if it has a non-zero
1461
- value, note that:
1462
- </p>
1463
- <p><code class="code">*</code> works like AND
1464
- </p>
1465
- <p><code class="code">+</code> works like OR
1466
- </p>
1467
- <p>For example the construct:
1468
- </p><div class="example">
1469
- <pre class="example-preformatted">if (A AND B) then C
1470
- </pre></div>
1471
- <p>is equivalent to:
1472
- </p><div class="example">
1473
- <pre class="example-preformatted">if(A*B, C)
1474
- </pre></div>
1475
-
1476
- <p>In your C code, you can extend the list of unary and binary functions,
1477
- and define recognized constants, so that they are available for your
1478
- expressions.
1479
- </p>
1480
- <p>The evaluator also recognizes the International System unit prefixes.
1481
- If &rsquo;i&rsquo; is appended after the prefix, binary prefixes are used, which
1482
- are based on powers of 1024 instead of powers of 1000.
1483
- The &rsquo;B&rsquo; postfix multiplies the value by 8, and can be appended after a
1484
- unit prefix or used alone. This allows using for example &rsquo;KB&rsquo;, &rsquo;MiB&rsquo;,
1485
- &rsquo;G&rsquo; and &rsquo;B&rsquo; as number postfix.
1486
- </p>
1487
- <p>The list of available International System prefixes follows, with
1488
- indication of the corresponding powers of 10 and of 2.
1489
- </p><dl class="table">
1490
- <dt><samp class="option">y</samp></dt>
1491
- <dd><p>10^-24 / 2^-80
1492
- </p></dd>
1493
- <dt><samp class="option">z</samp></dt>
1494
- <dd><p>10^-21 / 2^-70
1495
- </p></dd>
1496
- <dt><samp class="option">a</samp></dt>
1497
- <dd><p>10^-18 / 2^-60
1498
- </p></dd>
1499
- <dt><samp class="option">f</samp></dt>
1500
- <dd><p>10^-15 / 2^-50
1501
- </p></dd>
1502
- <dt><samp class="option">p</samp></dt>
1503
- <dd><p>10^-12 / 2^-40
1504
- </p></dd>
1505
- <dt><samp class="option">n</samp></dt>
1506
- <dd><p>10^-9 / 2^-30
1507
- </p></dd>
1508
- <dt><samp class="option">u</samp></dt>
1509
- <dd><p>10^-6 / 2^-20
1510
- </p></dd>
1511
- <dt><samp class="option">m</samp></dt>
1512
- <dd><p>10^-3 / 2^-10
1513
- </p></dd>
1514
- <dt><samp class="option">c</samp></dt>
1515
- <dd><p>10^-2
1516
- </p></dd>
1517
- <dt><samp class="option">d</samp></dt>
1518
- <dd><p>10^-1
1519
- </p></dd>
1520
- <dt><samp class="option">h</samp></dt>
1521
- <dd><p>10^2
1522
- </p></dd>
1523
- <dt><samp class="option">k</samp></dt>
1524
- <dd><p>10^3 / 2^10
1525
- </p></dd>
1526
- <dt><samp class="option">K</samp></dt>
1527
- <dd><p>10^3 / 2^10
1528
- </p></dd>
1529
- <dt><samp class="option">M</samp></dt>
1530
- <dd><p>10^6 / 2^20
1531
- </p></dd>
1532
- <dt><samp class="option">G</samp></dt>
1533
- <dd><p>10^9 / 2^30
1534
- </p></dd>
1535
- <dt><samp class="option">T</samp></dt>
1536
- <dd><p>10^12 / 2^40
1537
- </p></dd>
1538
- <dt><samp class="option">P</samp></dt>
1539
- <dd><p>10^15 / 2^50
1540
- </p></dd>
1541
- <dt><samp class="option">E</samp></dt>
1542
- <dd><p>10^18 / 2^60
1543
- </p></dd>
1544
- <dt><samp class="option">Z</samp></dt>
1545
- <dd><p>10^21 / 2^70
1546
- </p></dd>
1547
- <dt><samp class="option">Y</samp></dt>
1548
- <dd><p>10^24 / 2^80
1549
- </p></dd>
1550
- </dl>
1551
-
1552
-
1553
- </div>
1554
- <div class="chapter-level-extent" id="See-Also">
1555
- <h2 class="chapter"><span>4 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
1556
-
1557
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
1558
- <a class="url" href="libavutil.html">libavutil</a>
1559
- </p>
1560
-
1561
- </div>
1562
- <div class="chapter-level-extent" id="Authors">
1563
- <h2 class="chapter"><span>5 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
1564
-
1565
- <p>The FFmpeg developers.
1566
- </p>
1567
- <p>For details about the authorship, see the Git history of the project
1568
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
1569
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
1570
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
1571
- </p>
1572
- <p>Maintainers for the specific components are listed in the file
1573
- <samp class="file">MAINTAINERS</samp> in the source code tree.
1574
- </p>
1575
-
1576
- </div>
1577
- </div>
1578
- <p style="font-size: small;">
1579
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
1580
- </p>
1581
- </div>
1582
- </body>
1583
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffmpeg.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffplay-all.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffplay.html DELETED
@@ -1,935 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- ffplay Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- ffplay Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Synopsis" href="#Synopsis">1 Synopsis</a></li>
29
- <li><a id="toc-Description" href="#Description">2 Description</a></li>
30
- <li><a id="toc-Options" href="#Options">3 Options</a>
31
- <ul class="toc-numbered-mark">
32
- <li><a id="toc-Stream-specifiers-1" href="#Stream-specifiers-1">3.1 Stream specifiers</a></li>
33
- <li><a id="toc-Generic-options" href="#Generic-options">3.2 Generic options</a></li>
34
- <li><a id="toc-AVOptions" href="#AVOptions">3.3 AVOptions</a></li>
35
- <li><a id="toc-Main-options" href="#Main-options">3.4 Main options</a></li>
36
- <li><a id="toc-Advanced-options" href="#Advanced-options">3.5 Advanced options</a></li>
37
- <li><a id="toc-While-playing" href="#While-playing">3.6 While playing</a></li>
38
- </ul></li>
39
- <li><a id="toc-See-Also" href="#See-Also">4 See Also</a></li>
40
- <li><a id="toc-Authors" href="#Authors">5 Authors</a></li>
41
- </ul>
42
- </div>
43
- </div>
44
-
45
- <ul class="mini-toc">
46
- <li><a href="#Synopsis" accesskey="1">Synopsis</a></li>
47
- <li><a href="#Description" accesskey="2">Description</a></li>
48
- <li><a href="#Options" accesskey="3">Options</a></li>
49
- <li><a href="#See-Also" accesskey="4">See Also</a></li>
50
- <li><a href="#Authors" accesskey="5">Authors</a></li>
51
- </ul>
52
- <div class="chapter-level-extent" id="Synopsis">
53
- <h2 class="chapter"><span>1 Synopsis<a class="copiable-link" href="#Synopsis"> &para;</a></span></h2>
54
-
55
- <p>ffplay [<var class="var">options</var>] [<samp class="file">input_url</samp>]
56
- </p>
57
- </div>
58
- <div class="chapter-level-extent" id="Description">
59
- <h2 class="chapter"><span>2 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
60
-
61
- <p>FFplay is a very simple and portable media player using the FFmpeg
62
- libraries and the SDL library. It is mostly used as a testbed for the
63
- various FFmpeg APIs.
64
- </p>
65
- </div>
66
- <div class="chapter-level-extent" id="Options">
67
- <h2 class="chapter"><span>3 Options<a class="copiable-link" href="#Options"> &para;</a></span></h2>
68
-
69
- <p>All the numerical options, if not specified otherwise, accept a string
70
- representing a number as input, which may be followed by one of the SI
71
- unit prefixes, for example: &rsquo;K&rsquo;, &rsquo;M&rsquo;, or &rsquo;G&rsquo;.
72
- </p>
73
- <p>If &rsquo;i&rsquo; is appended to the SI unit prefix, the complete prefix will be
74
- interpreted as a unit prefix for binary multiples, which are based on
75
- powers of 1024 instead of powers of 1000. Appending &rsquo;B&rsquo; to the SI unit
76
- prefix multiplies the value by 8. This allows using, for example:
77
- &rsquo;KB&rsquo;, &rsquo;MiB&rsquo;, &rsquo;G&rsquo; and &rsquo;B&rsquo; as number suffixes.
78
- </p>
79
- <p>Options which do not take arguments are boolean options, and set the
80
- corresponding value to true. They can be set to false by prefixing
81
- the option name with &quot;no&quot;. For example using &quot;-nofoo&quot;
82
- will set the boolean option with name &quot;foo&quot; to false.
83
- </p>
84
- <p>Options that take arguments support a special syntax where the argument given on
85
- the command line is interpreted as a path to the file from which the actual
86
- argument value is loaded. To use this feature, add a forward slash &rsquo;/&rsquo;
87
- immediately before the option name (after the leading dash). E.g.
88
- </p><div class="example">
89
- <pre class="example-preformatted">ffmpeg -i INPUT -/filter:v filter.script OUTPUT
90
- </pre></div>
91
- <p>will load a filtergraph description from the file named <samp class="file">filter.script</samp>.
92
- </p>
93
- <a class="anchor" id="Stream-specifiers"></a><ul class="mini-toc">
94
- <li><a href="#Stream-specifiers-1" accesskey="1">Stream specifiers</a></li>
95
- <li><a href="#Generic-options" accesskey="2">Generic options</a></li>
96
- <li><a href="#AVOptions" accesskey="3">AVOptions</a></li>
97
- <li><a href="#Main-options" accesskey="4">Main options</a></li>
98
- <li><a href="#Advanced-options" accesskey="5">Advanced options</a></li>
99
- <li><a href="#While-playing" accesskey="6">While playing</a></li>
100
- </ul>
101
- <div class="section-level-extent" id="Stream-specifiers-1">
102
- <h3 class="section"><span>3.1 Stream specifiers<a class="copiable-link" href="#Stream-specifiers-1"> &para;</a></span></h3>
103
- <p>Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
104
- are used to precisely specify which stream(s) a given option belongs to.
105
- </p>
106
- <p>A stream specifier is a string generally appended to the option name and
107
- separated from it by a colon. E.g. <code class="code">-codec:a:1 ac3</code> contains the
108
- <code class="code">a:1</code> stream specifier, which matches the second audio stream. Therefore, it
109
- would select the ac3 codec for the second audio stream.
110
- </p>
111
- <p>A stream specifier can match several streams, so that the option is applied to all
112
- of them. E.g. the stream specifier in <code class="code">-b:a 128k</code> matches all audio
113
- streams.
114
- </p>
115
- <p>An empty stream specifier matches all streams. For example, <code class="code">-codec copy</code>
116
- or <code class="code">-codec: copy</code> would copy all the streams without reencoding.
117
- </p>
118
- <p>Possible forms of stream specifiers are:
119
- </p><dl class="table">
120
- <dt><samp class="option"><var class="var">stream_index</var></samp></dt>
121
- <dd><p>Matches the stream with this index. E.g. <code class="code">-threads:1 4</code> would set the
122
- thread count for the second stream to 4. If <var class="var">stream_index</var> is used as an
123
- additional stream specifier (see below), then it selects stream number
124
- <var class="var">stream_index</var> from the matching streams. Stream numbering is based on the
125
- order of the streams as detected by libavformat except when a stream group
126
- specifier or program ID is also specified. In this case it is based on the
127
- ordering of the streams in the group or program.
128
- </p></dd>
129
- <dt><samp class="option"><var class="var">stream_type</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
130
- <dd><p><var class="var">stream_type</var> is one of following: &rsquo;v&rsquo; or &rsquo;V&rsquo; for video, &rsquo;a&rsquo; for audio, &rsquo;s&rsquo;
131
- for subtitle, &rsquo;d&rsquo; for data, and &rsquo;t&rsquo; for attachments. &rsquo;v&rsquo; matches all video
132
- streams, &rsquo;V&rsquo; only matches video streams which are not attached pictures, video
133
- thumbnails or cover arts. If <var class="var">additional_stream_specifier</var> is used, then
134
- it matches streams which both have this type and match the
135
- <var class="var">additional_stream_specifier</var>. Otherwise, it matches all streams of the
136
- specified type.
137
- </p></dd>
138
- <dt><samp class="option">g:<var class="var">group_specifier</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
139
- <dd><p>Matches streams which are in the group with the specifier <var class="var">group_specifier</var>.
140
- if <var class="var">additional_stream_specifier</var> is used, then it matches streams which both
141
- are part of the group and match the <var class="var">additional_stream_specifier</var>.
142
- <var class="var">group_specifier</var> may be one of the following:
143
- </p><dl class="table">
144
- <dt><samp class="option"><var class="var">group_index</var></samp></dt>
145
- <dd><p>Match the stream with this group index.
146
- </p></dd>
147
- <dt><samp class="option">#<var class="var">group_id</var> or i:<var class="var">group_id</var></samp></dt>
148
- <dd><p>Match the stream with this group id.
149
- </p></dd>
150
- </dl>
151
- </dd>
152
- <dt><samp class="option">p:<var class="var">program_id</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
153
- <dd><p>Matches streams which are in the program with the id <var class="var">program_id</var>. If
154
- <var class="var">additional_stream_specifier</var> is used, then it matches streams which both
155
- are part of the program and match the <var class="var">additional_stream_specifier</var>.
156
- </p>
157
- </dd>
158
- <dt><samp class="option">#<var class="var">stream_id</var> or i:<var class="var">stream_id</var></samp></dt>
159
- <dd><p>Match the stream by stream id (e.g. PID in MPEG-TS container).
160
- </p></dd>
161
- <dt><samp class="option">m:<var class="var">key</var>[:<var class="var">value</var>]</samp></dt>
162
- <dd><p>Matches streams with the metadata tag <var class="var">key</var> having the specified value. If
163
- <var class="var">value</var> is not given, matches streams that contain the given tag with any
164
- value. The colon character &rsquo;:&rsquo; in <var class="var">key</var> or <var class="var">value</var> needs to be
165
- backslash-escaped.
166
- </p></dd>
167
- <dt><samp class="option">disp:<var class="var">dispositions</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
168
- <dd><p>Matches streams with the given disposition(s). <var class="var">dispositions</var> is a list of
169
- one or more dispositions (as printed by the <samp class="option">-dispositions</samp> option)
170
- joined with &rsquo;+&rsquo;.
171
- </p></dd>
172
- <dt><samp class="option">u</samp></dt>
173
- <dd><p>Matches streams with usable configuration, the codec must be defined and the
174
- essential information such as video dimension or audio sample rate must be present.
175
- </p>
176
- <p>Note that in <code class="command">ffmpeg</code>, matching by metadata will only work properly for
177
- input files.
178
- </p></dd>
179
- </dl>
180
-
181
- </div>
182
- <div class="section-level-extent" id="Generic-options">
183
- <h3 class="section"><span>3.2 Generic options<a class="copiable-link" href="#Generic-options"> &para;</a></span></h3>
184
-
185
- <p>These options are shared amongst the ff* tools.
186
- </p>
187
- <dl class="table">
188
- <dt><samp class="option">-L</samp></dt>
189
- <dd><p>Show license.
190
- </p>
191
- </dd>
192
- <dt><samp class="option">-h, -?, -help, --help [<var class="var">arg</var>]</samp></dt>
193
- <dd><p>Show help. An optional parameter may be specified to print help about a specific
194
- item. If no argument is specified, only basic (non advanced) tool
195
- options are shown.
196
- </p>
197
- <p>Possible values of <var class="var">arg</var> are:
198
- </p><dl class="table">
199
- <dt><samp class="option">long</samp></dt>
200
- <dd><p>Print advanced tool options in addition to the basic tool options.
201
- </p>
202
- </dd>
203
- <dt><samp class="option">full</samp></dt>
204
- <dd><p>Print complete list of options, including shared and private options
205
- for encoders, decoders, demuxers, muxers, filters, etc.
206
- </p>
207
- </dd>
208
- <dt><samp class="option">decoder=<var class="var">decoder_name</var></samp></dt>
209
- <dd><p>Print detailed information about the decoder named <var class="var">decoder_name</var>. Use the
210
- <samp class="option">-decoders</samp> option to get a list of all decoders.
211
- </p>
212
- </dd>
213
- <dt><samp class="option">encoder=<var class="var">encoder_name</var></samp></dt>
214
- <dd><p>Print detailed information about the encoder named <var class="var">encoder_name</var>. Use the
215
- <samp class="option">-encoders</samp> option to get a list of all encoders.
216
- </p>
217
- </dd>
218
- <dt><samp class="option">demuxer=<var class="var">demuxer_name</var></samp></dt>
219
- <dd><p>Print detailed information about the demuxer named <var class="var">demuxer_name</var>. Use the
220
- <samp class="option">-formats</samp> option to get a list of all demuxers and muxers.
221
- </p>
222
- </dd>
223
- <dt><samp class="option">muxer=<var class="var">muxer_name</var></samp></dt>
224
- <dd><p>Print detailed information about the muxer named <var class="var">muxer_name</var>. Use the
225
- <samp class="option">-formats</samp> option to get a list of all muxers and demuxers.
226
- </p>
227
- </dd>
228
- <dt><samp class="option">filter=<var class="var">filter_name</var></samp></dt>
229
- <dd><p>Print detailed information about the filter named <var class="var">filter_name</var>. Use the
230
- <samp class="option">-filters</samp> option to get a list of all filters.
231
- </p>
232
- </dd>
233
- <dt><samp class="option">bsf=<var class="var">bitstream_filter_name</var></samp></dt>
234
- <dd><p>Print detailed information about the bitstream filter named <var class="var">bitstream_filter_name</var>.
235
- Use the <samp class="option">-bsfs</samp> option to get a list of all bitstream filters.
236
- </p>
237
- </dd>
238
- <dt><samp class="option">protocol=<var class="var">protocol_name</var></samp></dt>
239
- <dd><p>Print detailed information about the protocol named <var class="var">protocol_name</var>.
240
- Use the <samp class="option">-protocols</samp> option to get a list of all protocols.
241
- </p></dd>
242
- </dl>
243
-
244
- </dd>
245
- <dt><samp class="option">-version</samp></dt>
246
- <dd><p>Show version.
247
- </p>
248
- </dd>
249
- <dt><samp class="option">-buildconf</samp></dt>
250
- <dd><p>Show the build configuration, one option per line.
251
- </p>
252
- </dd>
253
- <dt><samp class="option">-formats</samp></dt>
254
- <dd><p>Show available formats (including devices).
255
- </p>
256
- </dd>
257
- <dt><samp class="option">-demuxers</samp></dt>
258
- <dd><p>Show available demuxers.
259
- </p>
260
- </dd>
261
- <dt><samp class="option">-muxers</samp></dt>
262
- <dd><p>Show available muxers.
263
- </p>
264
- </dd>
265
- <dt><samp class="option">-devices</samp></dt>
266
- <dd><p>Show available devices.
267
- </p>
268
- </dd>
269
- <dt><samp class="option">-codecs</samp></dt>
270
- <dd><p>Show all codecs known to libavcodec.
271
- </p>
272
- <p>Note that the term &rsquo;codec&rsquo; is used throughout this documentation as a shortcut
273
- for what is more correctly called a media bitstream format.
274
- </p>
275
- </dd>
276
- <dt><samp class="option">-decoders</samp></dt>
277
- <dd><p>Show available decoders.
278
- </p>
279
- </dd>
280
- <dt><samp class="option">-encoders</samp></dt>
281
- <dd><p>Show all available encoders.
282
- </p>
283
- </dd>
284
- <dt><samp class="option">-bsfs</samp></dt>
285
- <dd><p>Show available bitstream filters.
286
- </p>
287
- </dd>
288
- <dt><samp class="option">-protocols</samp></dt>
289
- <dd><p>Show available protocols.
290
- </p>
291
- </dd>
292
- <dt><samp class="option">-filters</samp></dt>
293
- <dd><p>Show available libavfilter filters.
294
- </p>
295
- </dd>
296
- <dt><samp class="option">-pix_fmts</samp></dt>
297
- <dd><p>Show available pixel formats.
298
- </p>
299
- </dd>
300
- <dt><samp class="option">-sample_fmts</samp></dt>
301
- <dd><p>Show available sample formats.
302
- </p>
303
- </dd>
304
- <dt><samp class="option">-layouts</samp></dt>
305
- <dd><p>Show channel names and standard channel layouts.
306
- </p>
307
- </dd>
308
- <dt><samp class="option">-dispositions</samp></dt>
309
- <dd><p>Show stream dispositions.
310
- </p>
311
- </dd>
312
- <dt><samp class="option">-colors</samp></dt>
313
- <dd><p>Show recognized color names.
314
- </p>
315
- </dd>
316
- <dt><samp class="option">-sources <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
317
- <dd><p>Show autodetected sources of the input device.
318
- Some devices may provide system-dependent source names that cannot be autodetected.
319
- The returned list cannot be assumed to be always complete.
320
- </p><div class="example">
321
- <pre class="example-preformatted">ffmpeg -sources pulse,server=192.168.0.4
322
- </pre></div>
323
-
324
- </dd>
325
- <dt><samp class="option">-sinks <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
326
- <dd><p>Show autodetected sinks of the output device.
327
- Some devices may provide system-dependent sink names that cannot be autodetected.
328
- The returned list cannot be assumed to be always complete.
329
- </p><div class="example">
330
- <pre class="example-preformatted">ffmpeg -sinks pulse,server=192.168.0.4
331
- </pre></div>
332
-
333
- </dd>
334
- <dt><samp class="option">-loglevel [<var class="var">flags</var>+]<var class="var">loglevel</var> | -v [<var class="var">flags</var>+]<var class="var">loglevel</var></samp></dt>
335
- <dd><p>Set logging level and flags used by the library.
336
- </p>
337
- <p>The optional <var class="var">flags</var> prefix can consist of the following values:
338
- </p><dl class="table">
339
- <dt>&lsquo;<samp class="samp">repeat</samp>&rsquo;</dt>
340
- <dd><p>Indicates that repeated log output should not be compressed to the first line
341
- and the &quot;Last message repeated n times&quot; line will be omitted.
342
- </p></dd>
343
- <dt>&lsquo;<samp class="samp">level</samp>&rsquo;</dt>
344
- <dd><p>Indicates that log output should add a <code class="code">[level]</code> prefix to each message
345
- line. This can be used as an alternative to log coloring, e.g. when dumping the
346
- log to file.
347
- </p></dd>
348
- </dl>
349
- <p>Flags can also be used alone by adding a &rsquo;+&rsquo;/&rsquo;-&rsquo; prefix to set/reset a single
350
- flag without affecting other <var class="var">flags</var> or changing <var class="var">loglevel</var>. When
351
- setting both <var class="var">flags</var> and <var class="var">loglevel</var>, a &rsquo;+&rsquo; separator is expected
352
- between the last <var class="var">flags</var> value and before <var class="var">loglevel</var>.
353
- </p>
354
- <p><var class="var">loglevel</var> is a string or a number containing one of the following values:
355
- </p><dl class="table">
356
- <dt>&lsquo;<samp class="samp">quiet, -8</samp>&rsquo;</dt>
357
- <dd><p>Show nothing at all; be silent.
358
- </p></dd>
359
- <dt>&lsquo;<samp class="samp">panic, 0</samp>&rsquo;</dt>
360
- <dd><p>Only show fatal errors which could lead the process to crash, such as
361
- an assertion failure. This is not currently used for anything.
362
- </p></dd>
363
- <dt>&lsquo;<samp class="samp">fatal, 8</samp>&rsquo;</dt>
364
- <dd><p>Only show fatal errors. These are errors after which the process absolutely
365
- cannot continue.
366
- </p></dd>
367
- <dt>&lsquo;<samp class="samp">error, 16</samp>&rsquo;</dt>
368
- <dd><p>Show all errors, including ones which can be recovered from.
369
- </p></dd>
370
- <dt>&lsquo;<samp class="samp">warning, 24</samp>&rsquo;</dt>
371
- <dd><p>Show all warnings and errors. Any message related to possibly
372
- incorrect or unexpected events will be shown.
373
- </p></dd>
374
- <dt>&lsquo;<samp class="samp">info, 32</samp>&rsquo;</dt>
375
- <dd><p>Show informative messages during processing. This is in addition to
376
- warnings and errors. This is the default value.
377
- </p></dd>
378
- <dt>&lsquo;<samp class="samp">verbose, 40</samp>&rsquo;</dt>
379
- <dd><p>Same as <code class="code">info</code>, except more verbose.
380
- </p></dd>
381
- <dt>&lsquo;<samp class="samp">debug, 48</samp>&rsquo;</dt>
382
- <dd><p>Show everything, including debugging information.
383
- </p></dd>
384
- <dt>&lsquo;<samp class="samp">trace, 56</samp>&rsquo;</dt>
385
- </dl>
386
-
387
- <p>For example to enable repeated log output, add the <code class="code">level</code> prefix, and set
388
- <var class="var">loglevel</var> to <code class="code">verbose</code>:
389
- </p><div class="example">
390
- <pre class="example-preformatted">ffmpeg -loglevel repeat+level+verbose -i input output
391
- </pre></div>
392
- <p>Another example that enables repeated log output without affecting current
393
- state of <code class="code">level</code> prefix flag or <var class="var">loglevel</var>:
394
- </p><div class="example">
395
- <pre class="example-preformatted">ffmpeg [...] -loglevel +repeat
396
- </pre></div>
397
-
398
- <p>By default the program logs to stderr. If coloring is supported by the
399
- terminal, colors are used to mark errors and warnings. Log coloring
400
- can be disabled setting the environment variable
401
- <code class="env">AV_LOG_FORCE_NOCOLOR</code>, or can be forced setting
402
- the environment variable <code class="env">AV_LOG_FORCE_COLOR</code>.
403
- </p>
404
- </dd>
405
- <dt><samp class="option">-report</samp></dt>
406
- <dd><p>Dump full command line and log output to a file named
407
- <code class="code"><var class="var">program</var>-<var class="var">YYYYMMDD</var>-<var class="var">HHMMSS</var>.log</code> in the current
408
- directory.
409
- This file can be useful for bug reports.
410
- It also implies <code class="code">-loglevel debug</code>.
411
- </p>
412
- <p>Setting the environment variable <code class="env">FFREPORT</code> to any value has the
413
- same effect. If the value is a &rsquo;:&rsquo;-separated key=value sequence, these
414
- options will affect the report; option values must be escaped if they
415
- contain special characters or the options delimiter &rsquo;:&rsquo; (see the
416
- &ldquo;Quoting and escaping&rdquo; section in the ffmpeg-utils manual).
417
- </p>
418
- <p>The following options are recognized:
419
- </p><dl class="table">
420
- <dt><samp class="option">file</samp></dt>
421
- <dd><p>set the file name to use for the report; <code class="code">%p</code> is expanded to the name
422
- of the program, <code class="code">%t</code> is expanded to a timestamp, <code class="code">%%</code> is expanded
423
- to a plain <code class="code">%</code>
424
- </p></dd>
425
- <dt><samp class="option">level</samp></dt>
426
- <dd><p>set the log verbosity level using a numerical value (see <code class="code">-loglevel</code>).
427
- </p></dd>
428
- </dl>
429
-
430
- <p>For example, to output a report to a file named <samp class="file">ffreport.log</samp>
431
- using a log level of <code class="code">32</code> (alias for log level <code class="code">info</code>):
432
- </p>
433
- <div class="example">
434
- <pre class="example-preformatted">FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
435
- </pre></div>
436
-
437
- <p>Errors in parsing the environment variable are not fatal, and will not
438
- appear in the report.
439
- </p>
440
- </dd>
441
- <dt><samp class="option">-hide_banner</samp></dt>
442
- <dd><p>Suppress printing banner.
443
- </p>
444
- <p>All FFmpeg tools will normally show a copyright notice, build options
445
- and library versions. This option can be used to suppress printing
446
- this information.
447
- </p>
448
- </dd>
449
- <dt><samp class="option">-cpuflags flags (<em class="emph">global</em>)</samp></dt>
450
- <dd><p>Allows setting and clearing cpu flags. This option is intended
451
- for testing. Do not use it unless you know what you&rsquo;re doing.
452
- </p><div class="example">
453
- <pre class="example-preformatted">ffmpeg -cpuflags -sse+mmx ...
454
- ffmpeg -cpuflags mmx ...
455
- ffmpeg -cpuflags 0 ...
456
- </pre></div>
457
- <p>Possible flags for this option are:
458
- </p><dl class="table">
459
- <dt>&lsquo;<samp class="samp">x86</samp>&rsquo;</dt>
460
- <dd><dl class="table">
461
- <dt>&lsquo;<samp class="samp">mmx</samp>&rsquo;</dt>
462
- <dt>&lsquo;<samp class="samp">mmxext</samp>&rsquo;</dt>
463
- <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
464
- <dt>&lsquo;<samp class="samp">sse2</samp>&rsquo;</dt>
465
- <dt>&lsquo;<samp class="samp">sse2slow</samp>&rsquo;</dt>
466
- <dt>&lsquo;<samp class="samp">sse3</samp>&rsquo;</dt>
467
- <dt>&lsquo;<samp class="samp">sse3slow</samp>&rsquo;</dt>
468
- <dt>&lsquo;<samp class="samp">ssse3</samp>&rsquo;</dt>
469
- <dt>&lsquo;<samp class="samp">atom</samp>&rsquo;</dt>
470
- <dt>&lsquo;<samp class="samp">sse4.1</samp>&rsquo;</dt>
471
- <dt>&lsquo;<samp class="samp">sse4.2</samp>&rsquo;</dt>
472
- <dt>&lsquo;<samp class="samp">avx</samp>&rsquo;</dt>
473
- <dt>&lsquo;<samp class="samp">avx2</samp>&rsquo;</dt>
474
- <dt>&lsquo;<samp class="samp">xop</samp>&rsquo;</dt>
475
- <dt>&lsquo;<samp class="samp">fma3</samp>&rsquo;</dt>
476
- <dt>&lsquo;<samp class="samp">fma4</samp>&rsquo;</dt>
477
- <dt>&lsquo;<samp class="samp">3dnow</samp>&rsquo;</dt>
478
- <dt>&lsquo;<samp class="samp">3dnowext</samp>&rsquo;</dt>
479
- <dt>&lsquo;<samp class="samp">bmi1</samp>&rsquo;</dt>
480
- <dt>&lsquo;<samp class="samp">bmi2</samp>&rsquo;</dt>
481
- <dt>&lsquo;<samp class="samp">cmov</samp>&rsquo;</dt>
482
- </dl>
483
- </dd>
484
- <dt>&lsquo;<samp class="samp">ARM</samp>&rsquo;</dt>
485
- <dd><dl class="table">
486
- <dt>&lsquo;<samp class="samp">armv5te</samp>&rsquo;</dt>
487
- <dt>&lsquo;<samp class="samp">armv6</samp>&rsquo;</dt>
488
- <dt>&lsquo;<samp class="samp">armv6t2</samp>&rsquo;</dt>
489
- <dt>&lsquo;<samp class="samp">vfp</samp>&rsquo;</dt>
490
- <dt>&lsquo;<samp class="samp">vfpv3</samp>&rsquo;</dt>
491
- <dt>&lsquo;<samp class="samp">neon</samp>&rsquo;</dt>
492
- <dt>&lsquo;<samp class="samp">setend</samp>&rsquo;</dt>
493
- </dl>
494
- </dd>
495
- <dt>&lsquo;<samp class="samp">AArch64</samp>&rsquo;</dt>
496
- <dd><dl class="table">
497
- <dt>&lsquo;<samp class="samp">armv8</samp>&rsquo;</dt>
498
- <dt>&lsquo;<samp class="samp">vfp</samp>&rsquo;</dt>
499
- <dt>&lsquo;<samp class="samp">neon</samp>&rsquo;</dt>
500
- </dl>
501
- </dd>
502
- <dt>&lsquo;<samp class="samp">PowerPC</samp>&rsquo;</dt>
503
- <dd><dl class="table">
504
- <dt>&lsquo;<samp class="samp">altivec</samp>&rsquo;</dt>
505
- </dl>
506
- </dd>
507
- <dt>&lsquo;<samp class="samp">Specific Processors</samp>&rsquo;</dt>
508
- <dd><dl class="table">
509
- <dt>&lsquo;<samp class="samp">pentium2</samp>&rsquo;</dt>
510
- <dt>&lsquo;<samp class="samp">pentium3</samp>&rsquo;</dt>
511
- <dt>&lsquo;<samp class="samp">pentium4</samp>&rsquo;</dt>
512
- <dt>&lsquo;<samp class="samp">k6</samp>&rsquo;</dt>
513
- <dt>&lsquo;<samp class="samp">k62</samp>&rsquo;</dt>
514
- <dt>&lsquo;<samp class="samp">athlon</samp>&rsquo;</dt>
515
- <dt>&lsquo;<samp class="samp">athlonxp</samp>&rsquo;</dt>
516
- <dt>&lsquo;<samp class="samp">k8</samp>&rsquo;</dt>
517
- </dl>
518
- </dd>
519
- </dl>
520
-
521
- </dd>
522
- <dt><samp class="option">-cpucount <var class="var">count</var> (<em class="emph">global</em>)</samp></dt>
523
- <dd><p>Override detection of CPU count. This option is intended
524
- for testing. Do not use it unless you know what you&rsquo;re doing.
525
- </p><div class="example">
526
- <pre class="example-preformatted">ffmpeg -cpucount 2
527
- </pre></div>
528
-
529
- </dd>
530
- <dt><samp class="option">-max_alloc <var class="var">bytes</var></samp></dt>
531
- <dd><p>Set the maximum size limit for allocating a block on the heap by ffmpeg&rsquo;s
532
- family of malloc functions. Exercise <strong class="strong">extreme caution</strong> when using
533
- this option. Don&rsquo;t use if you do not understand the full consequence of doing so.
534
- Default is INT_MAX.
535
- </p></dd>
536
- </dl>
537
-
538
- </div>
539
- <div class="section-level-extent" id="AVOptions">
540
- <h3 class="section"><span>3.3 AVOptions<a class="copiable-link" href="#AVOptions"> &para;</a></span></h3>
541
-
542
- <p>These options are provided directly by the libavformat, libavdevice and
543
- libavcodec libraries. To see the list of available AVOptions, use the
544
- <samp class="option">-help</samp> option. They are separated into two categories:
545
- </p><dl class="table">
546
- <dt><samp class="option">generic</samp></dt>
547
- <dd><p>These options can be set for any container, codec or device. Generic options
548
- are listed under AVFormatContext options for containers/devices and under
549
- AVCodecContext options for codecs.
550
- </p></dd>
551
- <dt><samp class="option">private</samp></dt>
552
- <dd><p>These options are specific to the given container, device or codec. Private
553
- options are listed under their corresponding containers/devices/codecs.
554
- </p></dd>
555
- </dl>
556
-
557
- <p>For example to write an ID3v2.3 header instead of a default ID3v2.4 to
558
- an MP3 file, use the <samp class="option">id3v2_version</samp> private option of the MP3
559
- muxer:
560
- </p><div class="example">
561
- <pre class="example-preformatted">ffmpeg -i input.flac -id3v2_version 3 out.mp3
562
- </pre></div>
563
-
564
- <p>All codec AVOptions are per-stream, and thus a stream specifier
565
- should be attached to them:
566
- </p><div class="example">
567
- <pre class="example-preformatted">ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
568
- </pre></div>
569
-
570
- <p>In the above example, a multichannel audio stream is mapped twice for output.
571
- The first instance is encoded with codec ac3 and bitrate 640k.
572
- The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using
573
- absolute index of the output stream.
574
- </p>
575
- <p>Note: the <samp class="option">-nooption</samp> syntax cannot be used for boolean
576
- AVOptions, use <samp class="option">-option 0</samp>/<samp class="option">-option 1</samp>.
577
- </p>
578
- <p>Note: the old undocumented way of specifying per-stream AVOptions by
579
- prepending v/a/s to the options name is now obsolete and will be
580
- removed soon.
581
- </p>
582
- </div>
583
- <div class="section-level-extent" id="Main-options">
584
- <h3 class="section"><span>3.4 Main options<a class="copiable-link" href="#Main-options"> &para;</a></span></h3>
585
-
586
- <dl class="table">
587
- <dt><samp class="option">-x <var class="var">width</var></samp></dt>
588
- <dd><p>Force displayed width.
589
- </p></dd>
590
- <dt><samp class="option">-y <var class="var">height</var></samp></dt>
591
- <dd><p>Force displayed height.
592
- </p></dd>
593
- <dt><samp class="option">-fs</samp></dt>
594
- <dd><p>Start in fullscreen mode.
595
- </p></dd>
596
- <dt><samp class="option">-an</samp></dt>
597
- <dd><p>Disable audio.
598
- </p></dd>
599
- <dt><samp class="option">-vn</samp></dt>
600
- <dd><p>Disable video.
601
- </p></dd>
602
- <dt><samp class="option">-sn</samp></dt>
603
- <dd><p>Disable subtitles.
604
- </p></dd>
605
- <dt><samp class="option">-ss <var class="var">pos</var></samp></dt>
606
- <dd><p>Seek to <var class="var">pos</var>. Note that in most formats it is not possible to seek
607
- exactly, so <code class="command">ffplay</code> will seek to the nearest seek point to
608
- <var class="var">pos</var>.
609
- </p>
610
- <p><var class="var">pos</var> must be a time duration specification,
611
- see <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#time-duration-syntax">the Time duration section in the ffmpeg-utils(1) manual</a>.
612
- </p></dd>
613
- <dt><samp class="option">-t <var class="var">duration</var></samp></dt>
614
- <dd><p>Play <var class="var">duration</var> seconds of audio/video.
615
- </p>
616
- <p><var class="var">duration</var> must be a time duration specification,
617
- see <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#time-duration-syntax">the Time duration section in the ffmpeg-utils(1) manual</a>.
618
- </p></dd>
619
- <dt><samp class="option">-bytes</samp></dt>
620
- <dd><p>Seek by bytes.
621
- </p></dd>
622
- <dt><samp class="option">-seek_interval</samp></dt>
623
- <dd><p>Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds.
624
- </p></dd>
625
- <dt><samp class="option">-nodisp</samp></dt>
626
- <dd><p>Disable graphical display.
627
- </p></dd>
628
- <dt><samp class="option">-noborder</samp></dt>
629
- <dd><p>Borderless window.
630
- </p></dd>
631
- <dt><samp class="option">-alwaysontop</samp></dt>
632
- <dd><p>Window always on top. Available on: X11 with SDL &gt;= 2.0.5, Windows SDL &gt;= 2.0.6.
633
- </p></dd>
634
- <dt><samp class="option">-volume</samp></dt>
635
- <dd><p>Set the startup volume. 0 means silence, 100 means no volume reduction or
636
- amplification. Negative values are treated as 0, values above 100 are treated
637
- as 100.
638
- </p></dd>
639
- <dt><samp class="option">-f <var class="var">fmt</var></samp></dt>
640
- <dd><p>Force format.
641
- </p></dd>
642
- <dt><samp class="option">-window_title <var class="var">title</var></samp></dt>
643
- <dd><p>Set window title (default is the input filename).
644
- </p></dd>
645
- <dt><samp class="option">-left <var class="var">title</var></samp></dt>
646
- <dd><p>Set the x position for the left of the window (default is a centered window).
647
- </p></dd>
648
- <dt><samp class="option">-top <var class="var">title</var></samp></dt>
649
- <dd><p>Set the y position for the top of the window (default is a centered window).
650
- </p></dd>
651
- <dt><samp class="option">-loop <var class="var">number</var></samp></dt>
652
- <dd><p>Loops movie playback &lt;number&gt; times. 0 means forever.
653
- </p></dd>
654
- <dt><samp class="option">-showmode <var class="var">mode</var></samp></dt>
655
- <dd><p>Set the show mode to use.
656
- Available values for <var class="var">mode</var> are:
657
- </p><dl class="table">
658
- <dt>&lsquo;<samp class="samp">0, video</samp>&rsquo;</dt>
659
- <dd><p>show video
660
- </p></dd>
661
- <dt>&lsquo;<samp class="samp">1, waves</samp>&rsquo;</dt>
662
- <dd><p>show audio waves
663
- </p></dd>
664
- <dt>&lsquo;<samp class="samp">2, rdft</samp>&rsquo;</dt>
665
- <dd><p>show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
666
- </p></dd>
667
- </dl>
668
-
669
- <p>Default value is &quot;video&quot;, if video is not present or cannot be played
670
- &quot;rdft&quot; is automatically selected.
671
- </p>
672
- <p>You can interactively cycle through the available show modes by
673
- pressing the key <kbd class="key">w</kbd>.
674
- </p>
675
- </dd>
676
- <dt><samp class="option">-vf <var class="var">filtergraph</var></samp></dt>
677
- <dd><p>Create the filtergraph specified by <var class="var">filtergraph</var> and use it to
678
- filter the video stream.
679
- </p>
680
- <p><var class="var">filtergraph</var> is a description of the filtergraph to apply to
681
- the stream, and must have a single video input and a single video
682
- output. In the filtergraph, the input is associated to the label
683
- <code class="code">in</code>, and the output to the label <code class="code">out</code>. See the
684
- ffmpeg-filters manual for more information about the filtergraph
685
- syntax.
686
- </p>
687
- <p>You can specify this parameter multiple times and cycle through the specified
688
- filtergraphs along with the show modes by pressing the key <kbd class="key">w</kbd>.
689
- </p>
690
- </dd>
691
- <dt><samp class="option">-af <var class="var">filtergraph</var></samp></dt>
692
- <dd><p><var class="var">filtergraph</var> is a description of the filtergraph to apply to
693
- the input audio.
694
- Use the option &quot;-filters&quot; to show all the available filters (including
695
- sources and sinks).
696
- </p>
697
- </dd>
698
- <dt><samp class="option">-i <var class="var">input_url</var></samp></dt>
699
- <dd><p>Read <var class="var">input_url</var>.
700
- </p></dd>
701
- </dl>
702
-
703
- </div>
704
- <div class="section-level-extent" id="Advanced-options">
705
- <h3 class="section"><span>3.5 Advanced options<a class="copiable-link" href="#Advanced-options"> &para;</a></span></h3>
706
- <dl class="table">
707
- <dt><samp class="option">-stats</samp></dt>
708
- <dd><p>Print several playback statistics, in particular show the stream
709
- duration, the codec parameters, the current position in the stream and
710
- the audio/video synchronisation drift. It is shown by default, unless the
711
- log level is lower than <code class="code">info</code>. Its display can be forced by manually
712
- specifying this option. To disable it, you need to specify <code class="code">-nostats</code>.
713
- </p>
714
- </dd>
715
- <dt><samp class="option">-fast</samp></dt>
716
- <dd><p>Non-spec-compliant optimizations.
717
- </p></dd>
718
- <dt><samp class="option">-genpts</samp></dt>
719
- <dd><p>Generate pts.
720
- </p></dd>
721
- <dt><samp class="option">-sync <var class="var">type</var></samp></dt>
722
- <dd><p>Set the master clock to audio (<code class="code">type=audio</code>), video
723
- (<code class="code">type=video</code>) or external (<code class="code">type=ext</code>). Default is audio. The
724
- master clock is used to control audio-video synchronization. Most media
725
- players use audio as master clock, but in some cases (streaming or high
726
- quality broadcast) it is necessary to change that. This option is mainly
727
- used for debugging purposes.
728
- </p></dd>
729
- <dt><samp class="option">-ast <var class="var">audio_stream_specifier</var></samp></dt>
730
- <dd><p>Select the desired audio stream using the given stream specifier. The stream
731
- specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
732
- is not specified, the &quot;best&quot; audio stream is selected in the program of the
733
- already selected video stream.
734
- </p></dd>
735
- <dt><samp class="option">-vst <var class="var">video_stream_specifier</var></samp></dt>
736
- <dd><p>Select the desired video stream using the given stream specifier. The stream
737
- specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
738
- is not specified, the &quot;best&quot; video stream is selected.
739
- </p></dd>
740
- <dt><samp class="option">-sst <var class="var">subtitle_stream_specifier</var></samp></dt>
741
- <dd><p>Select the desired subtitle stream using the given stream specifier. The stream
742
- specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
743
- is not specified, the &quot;best&quot; subtitle stream is selected in the program of the
744
- already selected video or audio stream.
745
- </p></dd>
746
- <dt><samp class="option">-autoexit</samp></dt>
747
- <dd><p>Exit when video is done playing.
748
- </p></dd>
749
- <dt><samp class="option">-exitonkeydown</samp></dt>
750
- <dd><p>Exit if any key is pressed.
751
- </p></dd>
752
- <dt><samp class="option">-exitonmousedown</samp></dt>
753
- <dd><p>Exit if any mouse button is pressed.
754
- </p>
755
- </dd>
756
- <dt><samp class="option">-codec:<var class="var">media_specifier</var> <var class="var">codec_name</var></samp></dt>
757
- <dd><p>Force a specific decoder implementation for the stream identified by
758
- <var class="var">media_specifier</var>, which can assume the values <code class="code">a</code> (audio),
759
- <code class="code">v</code> (video), and <code class="code">s</code> subtitle.
760
- </p>
761
- </dd>
762
- <dt><samp class="option">-acodec <var class="var">codec_name</var></samp></dt>
763
- <dd><p>Force a specific audio decoder.
764
- </p>
765
- </dd>
766
- <dt><samp class="option">-vcodec <var class="var">codec_name</var></samp></dt>
767
- <dd><p>Force a specific video decoder.
768
- </p>
769
- </dd>
770
- <dt><samp class="option">-scodec <var class="var">codec_name</var></samp></dt>
771
- <dd><p>Force a specific subtitle decoder.
772
- </p>
773
- </dd>
774
- <dt><samp class="option">-autorotate</samp></dt>
775
- <dd><p>Automatically rotate the video according to file metadata. Enabled by
776
- default, use <samp class="option">-noautorotate</samp> to disable it.
777
- </p>
778
- </dd>
779
- <dt><samp class="option">-framedrop</samp></dt>
780
- <dd><p>Drop video frames if video is out of sync. Enabled by default if the master
781
- clock is not set to video. Use this option to enable frame dropping for all
782
- master clock sources, use <samp class="option">-noframedrop</samp> to disable it.
783
- </p>
784
- </dd>
785
- <dt><samp class="option">-infbuf</samp></dt>
786
- <dd><p>Do not limit the input buffer size, read as much data as possible from the
787
- input as soon as possible. Enabled by default for realtime streams, where data
788
- may be dropped if not read in time. Use this option to enable infinite buffers
789
- for all inputs, use <samp class="option">-noinfbuf</samp> to disable it.
790
- </p>
791
- </dd>
792
- <dt><samp class="option">-filter_threads <var class="var">nb_threads</var></samp></dt>
793
- <dd><p>Defines how many threads are used to process a filter pipeline. Each pipeline
794
- will produce a thread pool with this many threads available for parallel
795
- processing. The default is 0 which means that the thread count will be
796
- determined by the number of available CPUs.
797
- </p>
798
- </dd>
799
- <dt><samp class="option">-enable_vulkan</samp></dt>
800
- <dd><p>Use vulkan renderer rather than SDL builtin renderer. Depends on libplacebo.
801
- </p>
802
- </dd>
803
- <dt><samp class="option">-vulkan_params</samp></dt>
804
- <dd>
805
- <p>Vulkan configuration using a list of <var class="var">key</var>=<var class="var">value</var> pairs separated by
806
- &quot;:&quot;.
807
- </p>
808
- </dd>
809
- <dt><samp class="option">-hwaccel</samp></dt>
810
- <dd><p>Use HW accelerated decoding. Enable this option will enable vulkan renderer
811
- automatically.
812
- </p>
813
- </dd>
814
- </dl>
815
-
816
- </div>
817
- <div class="section-level-extent" id="While-playing">
818
- <h3 class="section"><span>3.6 While playing<a class="copiable-link" href="#While-playing"> &para;</a></span></h3>
819
-
820
- <dl class="table">
821
- <dt><kbd class="key">q, ESC</kbd></dt>
822
- <dd><p>Quit.
823
- </p>
824
- </dd>
825
- <dt><kbd class="key">f</kbd></dt>
826
- <dd><p>Toggle full screen.
827
- </p>
828
- </dd>
829
- <dt><kbd class="key">p, SPC</kbd></dt>
830
- <dd><p>Pause.
831
- </p>
832
- </dd>
833
- <dt><kbd class="key">m</kbd></dt>
834
- <dd><p>Toggle mute.
835
- </p>
836
- </dd>
837
- <dt><kbd class="key">9, 0</kbd></dt>
838
- <dt><kbd class="key">/, *</kbd></dt>
839
- <dd><p>Decrease and increase volume respectively.
840
- </p>
841
- </dd>
842
- <dt><kbd class="key">a</kbd></dt>
843
- <dd><p>Cycle audio channel in the current program.
844
- </p>
845
- </dd>
846
- <dt><kbd class="key">v</kbd></dt>
847
- <dd><p>Cycle video channel.
848
- </p>
849
- </dd>
850
- <dt><kbd class="key">t</kbd></dt>
851
- <dd><p>Cycle subtitle channel in the current program.
852
- </p>
853
- </dd>
854
- <dt><kbd class="key">c</kbd></dt>
855
- <dd><p>Cycle program.
856
- </p>
857
- </dd>
858
- <dt><kbd class="key">w</kbd></dt>
859
- <dd><p>Cycle video filters or show modes.
860
- </p>
861
- </dd>
862
- <dt><kbd class="key">s</kbd></dt>
863
- <dd><p>Step to the next frame.
864
- </p>
865
- <p>Pause if the stream is not already paused, step to the next video
866
- frame, and pause.
867
- </p>
868
- </dd>
869
- <dt><kbd class="key">left/right</kbd></dt>
870
- <dd><p>Seek backward/forward 10 seconds.
871
- </p>
872
- </dd>
873
- <dt><kbd class="key">down/up</kbd></dt>
874
- <dd><p>Seek backward/forward 1 minute.
875
- </p>
876
- </dd>
877
- <dt><kbd class="key">page down/page up</kbd></dt>
878
- <dd><p>Seek to the previous/next chapter.
879
- or if there are no chapters
880
- Seek backward/forward 10 minutes.
881
- </p>
882
- </dd>
883
- <dt><kbd class="key">right mouse click</kbd></dt>
884
- <dd><p>Seek to percentage in file corresponding to fraction of width.
885
- </p>
886
- </dd>
887
- <dt><kbd class="key">left mouse double-click</kbd></dt>
888
- <dd><p>Toggle full screen.
889
- </p>
890
- </dd>
891
- </dl>
892
-
893
-
894
-
895
- </div>
896
- </div>
897
- <div class="chapter-level-extent" id="See-Also">
898
- <h2 class="chapter"><span>4 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
899
-
900
- <p><a class="url" href="ffplay-all.html">ffmpeg-all</a>,
901
- <a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
902
- <a class="url" href="ffmpeg-utils.html">ffmpeg-utils</a>,
903
- <a class="url" href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
904
- <a class="url" href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
905
- <a class="url" href="ffmpeg-codecs.html">ffmpeg-codecs</a>,
906
- <a class="url" href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>,
907
- <a class="url" href="ffmpeg-formats.html">ffmpeg-formats</a>,
908
- <a class="url" href="ffmpeg-devices.html">ffmpeg-devices</a>,
909
- <a class="url" href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
910
- <a class="url" href="ffmpeg-filters.html">ffmpeg-filters</a>
911
- </p>
912
-
913
- </div>
914
- <div class="chapter-level-extent" id="Authors">
915
- <h2 class="chapter"><span>5 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
916
-
917
- <p>The FFmpeg developers.
918
- </p>
919
- <p>For details about the authorship, see the Git history of the project
920
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
921
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
922
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
923
- </p>
924
- <p>Maintainers for the specific components are listed in the file
925
- <samp class="file">MAINTAINERS</samp> in the source code tree.
926
- </p>
927
-
928
- </div>
929
- </div>
930
- <p style="font-size: small;">
931
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
932
- </p>
933
- </div>
934
- </body>
935
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/ffprobe-all.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/ffprobe.html DELETED
@@ -1,1296 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- ffprobe Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- ffprobe Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Synopsis" href="#Synopsis">1 Synopsis</a></li>
29
- <li><a id="toc-Description" href="#Description">2 Description</a></li>
30
- <li><a id="toc-Options" href="#Options">3 Options</a>
31
- <ul class="toc-numbered-mark">
32
- <li><a id="toc-Stream-specifiers-1" href="#Stream-specifiers-1">3.1 Stream specifiers</a></li>
33
- <li><a id="toc-Generic-options" href="#Generic-options">3.2 Generic options</a></li>
34
- <li><a id="toc-AVOptions" href="#AVOptions">3.3 AVOptions</a></li>
35
- <li><a id="toc-Main-options" href="#Main-options">3.4 Main options</a></li>
36
- </ul></li>
37
- <li><a id="toc-Writers" href="#Writers">4 Writers</a>
38
- <ul class="toc-numbered-mark">
39
- <li><a id="toc-default" href="#default">4.1 default</a></li>
40
- <li><a id="toc-compact_002c-csv" href="#compact_002c-csv">4.2 compact, csv</a></li>
41
- <li><a id="toc-flat" href="#flat">4.3 flat</a></li>
42
- <li><a id="toc-ini" href="#ini">4.4 ini</a></li>
43
- <li><a id="toc-json" href="#json">4.5 json</a></li>
44
- <li><a id="toc-xml" href="#xml">4.6 xml</a></li>
45
- </ul></li>
46
- <li><a id="toc-Timecode" href="#Timecode">5 Timecode</a></li>
47
- <li><a id="toc-See-Also" href="#See-Also">6 See Also</a></li>
48
- <li><a id="toc-Authors" href="#Authors">7 Authors</a></li>
49
- </ul>
50
- </div>
51
- </div>
52
-
53
- <ul class="mini-toc">
54
- <li><a href="#Synopsis" accesskey="1">Synopsis</a></li>
55
- <li><a href="#Description" accesskey="2">Description</a></li>
56
- <li><a href="#Options" accesskey="3">Options</a></li>
57
- <li><a href="#Writers" accesskey="4">Writers</a></li>
58
- <li><a href="#Timecode" accesskey="5">Timecode</a></li>
59
- <li><a href="#See-Also" accesskey="6">See Also</a></li>
60
- <li><a href="#Authors" accesskey="7">Authors</a></li>
61
- </ul>
62
- <div class="chapter-level-extent" id="Synopsis">
63
- <h2 class="chapter"><span>1 Synopsis<a class="copiable-link" href="#Synopsis"> &para;</a></span></h2>
64
-
65
- <p>ffprobe [<var class="var">options</var>] <samp class="file">input_url</samp>
66
- </p>
67
- </div>
68
- <div class="chapter-level-extent" id="Description">
69
- <h2 class="chapter"><span>2 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
70
-
71
- <p>ffprobe gathers information from multimedia streams and prints it in
72
- human- and machine-readable fashion.
73
- </p>
74
- <p>For example it can be used to check the format of the container used
75
- by a multimedia stream and the format and type of each media stream
76
- contained in it.
77
- </p>
78
- <p>If a url is specified in input, ffprobe will try to open and
79
- probe the url content. If the url cannot be opened or recognized as
80
- a multimedia file, a positive exit code is returned.
81
- </p>
82
- <p>If no output is specified as output with <samp class="option">o</samp> ffprobe will write
83
- to stdout.
84
- </p>
85
- <p>ffprobe may be employed both as a standalone application or in
86
- combination with a textual filter, which may perform more
87
- sophisticated processing, e.g. statistical processing or plotting.
88
- </p>
89
- <p>Options are used to list some of the formats supported by ffprobe or
90
- for specifying which information to display, and for setting how
91
- ffprobe will show it.
92
- </p>
93
- <p>ffprobe output is designed to be easily parsable by a textual filter,
94
- and consists of one or more sections of a form defined by the selected
95
- writer, which is specified by the <samp class="option">output_format</samp> option.
96
- </p>
97
- <p>Sections may contain other nested sections, and are identified by a
98
- name (which may be shared by other sections), and an unique
99
- name. See the output of <samp class="option">sections</samp>.
100
- </p>
101
- <p>Metadata tags stored in the container or in the streams are recognized
102
- and printed in the corresponding &quot;FORMAT&quot;, &quot;STREAM&quot;, &quot;STREAM_GROUP_STREAM&quot;
103
- or &quot;PROGRAM_STREAM&quot; section.
104
- </p>
105
-
106
- </div>
107
- <div class="chapter-level-extent" id="Options">
108
- <h2 class="chapter"><span>3 Options<a class="copiable-link" href="#Options"> &para;</a></span></h2>
109
-
110
- <p>All the numerical options, if not specified otherwise, accept a string
111
- representing a number as input, which may be followed by one of the SI
112
- unit prefixes, for example: &rsquo;K&rsquo;, &rsquo;M&rsquo;, or &rsquo;G&rsquo;.
113
- </p>
114
- <p>If &rsquo;i&rsquo; is appended to the SI unit prefix, the complete prefix will be
115
- interpreted as a unit prefix for binary multiples, which are based on
116
- powers of 1024 instead of powers of 1000. Appending &rsquo;B&rsquo; to the SI unit
117
- prefix multiplies the value by 8. This allows using, for example:
118
- &rsquo;KB&rsquo;, &rsquo;MiB&rsquo;, &rsquo;G&rsquo; and &rsquo;B&rsquo; as number suffixes.
119
- </p>
120
- <p>Options which do not take arguments are boolean options, and set the
121
- corresponding value to true. They can be set to false by prefixing
122
- the option name with &quot;no&quot;. For example using &quot;-nofoo&quot;
123
- will set the boolean option with name &quot;foo&quot; to false.
124
- </p>
125
- <p>Options that take arguments support a special syntax where the argument given on
126
- the command line is interpreted as a path to the file from which the actual
127
- argument value is loaded. To use this feature, add a forward slash &rsquo;/&rsquo;
128
- immediately before the option name (after the leading dash). E.g.
129
- </p><div class="example">
130
- <pre class="example-preformatted">ffmpeg -i INPUT -/filter:v filter.script OUTPUT
131
- </pre></div>
132
- <p>will load a filtergraph description from the file named <samp class="file">filter.script</samp>.
133
- </p>
134
- <a class="anchor" id="Stream-specifiers"></a><ul class="mini-toc">
135
- <li><a href="#Stream-specifiers-1" accesskey="1">Stream specifiers</a></li>
136
- <li><a href="#Generic-options" accesskey="2">Generic options</a></li>
137
- <li><a href="#AVOptions" accesskey="3">AVOptions</a></li>
138
- <li><a href="#Main-options" accesskey="4">Main options</a></li>
139
- </ul>
140
- <div class="section-level-extent" id="Stream-specifiers-1">
141
- <h3 class="section"><span>3.1 Stream specifiers<a class="copiable-link" href="#Stream-specifiers-1"> &para;</a></span></h3>
142
- <p>Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
143
- are used to precisely specify which stream(s) a given option belongs to.
144
- </p>
145
- <p>A stream specifier is a string generally appended to the option name and
146
- separated from it by a colon. E.g. <code class="code">-codec:a:1 ac3</code> contains the
147
- <code class="code">a:1</code> stream specifier, which matches the second audio stream. Therefore, it
148
- would select the ac3 codec for the second audio stream.
149
- </p>
150
- <p>A stream specifier can match several streams, so that the option is applied to all
151
- of them. E.g. the stream specifier in <code class="code">-b:a 128k</code> matches all audio
152
- streams.
153
- </p>
154
- <p>An empty stream specifier matches all streams. For example, <code class="code">-codec copy</code>
155
- or <code class="code">-codec: copy</code> would copy all the streams without reencoding.
156
- </p>
157
- <p>Possible forms of stream specifiers are:
158
- </p><dl class="table">
159
- <dt><samp class="option"><var class="var">stream_index</var></samp></dt>
160
- <dd><p>Matches the stream with this index. E.g. <code class="code">-threads:1 4</code> would set the
161
- thread count for the second stream to 4. If <var class="var">stream_index</var> is used as an
162
- additional stream specifier (see below), then it selects stream number
163
- <var class="var">stream_index</var> from the matching streams. Stream numbering is based on the
164
- order of the streams as detected by libavformat except when a stream group
165
- specifier or program ID is also specified. In this case it is based on the
166
- ordering of the streams in the group or program.
167
- </p></dd>
168
- <dt><samp class="option"><var class="var">stream_type</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
169
- <dd><p><var class="var">stream_type</var> is one of following: &rsquo;v&rsquo; or &rsquo;V&rsquo; for video, &rsquo;a&rsquo; for audio, &rsquo;s&rsquo;
170
- for subtitle, &rsquo;d&rsquo; for data, and &rsquo;t&rsquo; for attachments. &rsquo;v&rsquo; matches all video
171
- streams, &rsquo;V&rsquo; only matches video streams which are not attached pictures, video
172
- thumbnails or cover arts. If <var class="var">additional_stream_specifier</var> is used, then
173
- it matches streams which both have this type and match the
174
- <var class="var">additional_stream_specifier</var>. Otherwise, it matches all streams of the
175
- specified type.
176
- </p></dd>
177
- <dt><samp class="option">g:<var class="var">group_specifier</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
178
- <dd><p>Matches streams which are in the group with the specifier <var class="var">group_specifier</var>.
179
- if <var class="var">additional_stream_specifier</var> is used, then it matches streams which both
180
- are part of the group and match the <var class="var">additional_stream_specifier</var>.
181
- <var class="var">group_specifier</var> may be one of the following:
182
- </p><dl class="table">
183
- <dt><samp class="option"><var class="var">group_index</var></samp></dt>
184
- <dd><p>Match the stream with this group index.
185
- </p></dd>
186
- <dt><samp class="option">#<var class="var">group_id</var> or i:<var class="var">group_id</var></samp></dt>
187
- <dd><p>Match the stream with this group id.
188
- </p></dd>
189
- </dl>
190
- </dd>
191
- <dt><samp class="option">p:<var class="var">program_id</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
192
- <dd><p>Matches streams which are in the program with the id <var class="var">program_id</var>. If
193
- <var class="var">additional_stream_specifier</var> is used, then it matches streams which both
194
- are part of the program and match the <var class="var">additional_stream_specifier</var>.
195
- </p>
196
- </dd>
197
- <dt><samp class="option">#<var class="var">stream_id</var> or i:<var class="var">stream_id</var></samp></dt>
198
- <dd><p>Match the stream by stream id (e.g. PID in MPEG-TS container).
199
- </p></dd>
200
- <dt><samp class="option">m:<var class="var">key</var>[:<var class="var">value</var>]</samp></dt>
201
- <dd><p>Matches streams with the metadata tag <var class="var">key</var> having the specified value. If
202
- <var class="var">value</var> is not given, matches streams that contain the given tag with any
203
- value. The colon character &rsquo;:&rsquo; in <var class="var">key</var> or <var class="var">value</var> needs to be
204
- backslash-escaped.
205
- </p></dd>
206
- <dt><samp class="option">disp:<var class="var">dispositions</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
207
- <dd><p>Matches streams with the given disposition(s). <var class="var">dispositions</var> is a list of
208
- one or more dispositions (as printed by the <samp class="option">-dispositions</samp> option)
209
- joined with &rsquo;+&rsquo;.
210
- </p></dd>
211
- <dt><samp class="option">u</samp></dt>
212
- <dd><p>Matches streams with usable configuration, the codec must be defined and the
213
- essential information such as video dimension or audio sample rate must be present.
214
- </p>
215
- <p>Note that in <code class="command">ffmpeg</code>, matching by metadata will only work properly for
216
- input files.
217
- </p></dd>
218
- </dl>
219
-
220
- </div>
221
- <div class="section-level-extent" id="Generic-options">
222
- <h3 class="section"><span>3.2 Generic options<a class="copiable-link" href="#Generic-options"> &para;</a></span></h3>
223
-
224
- <p>These options are shared amongst the ff* tools.
225
- </p>
226
- <dl class="table">
227
- <dt><samp class="option">-L</samp></dt>
228
- <dd><p>Show license.
229
- </p>
230
- </dd>
231
- <dt><samp class="option">-h, -?, -help, --help [<var class="var">arg</var>]</samp></dt>
232
- <dd><p>Show help. An optional parameter may be specified to print help about a specific
233
- item. If no argument is specified, only basic (non advanced) tool
234
- options are shown.
235
- </p>
236
- <p>Possible values of <var class="var">arg</var> are:
237
- </p><dl class="table">
238
- <dt><samp class="option">long</samp></dt>
239
- <dd><p>Print advanced tool options in addition to the basic tool options.
240
- </p>
241
- </dd>
242
- <dt><samp class="option">full</samp></dt>
243
- <dd><p>Print complete list of options, including shared and private options
244
- for encoders, decoders, demuxers, muxers, filters, etc.
245
- </p>
246
- </dd>
247
- <dt><samp class="option">decoder=<var class="var">decoder_name</var></samp></dt>
248
- <dd><p>Print detailed information about the decoder named <var class="var">decoder_name</var>. Use the
249
- <samp class="option">-decoders</samp> option to get a list of all decoders.
250
- </p>
251
- </dd>
252
- <dt><samp class="option">encoder=<var class="var">encoder_name</var></samp></dt>
253
- <dd><p>Print detailed information about the encoder named <var class="var">encoder_name</var>. Use the
254
- <samp class="option">-encoders</samp> option to get a list of all encoders.
255
- </p>
256
- </dd>
257
- <dt><samp class="option">demuxer=<var class="var">demuxer_name</var></samp></dt>
258
- <dd><p>Print detailed information about the demuxer named <var class="var">demuxer_name</var>. Use the
259
- <samp class="option">-formats</samp> option to get a list of all demuxers and muxers.
260
- </p>
261
- </dd>
262
- <dt><samp class="option">muxer=<var class="var">muxer_name</var></samp></dt>
263
- <dd><p>Print detailed information about the muxer named <var class="var">muxer_name</var>. Use the
264
- <samp class="option">-formats</samp> option to get a list of all muxers and demuxers.
265
- </p>
266
- </dd>
267
- <dt><samp class="option">filter=<var class="var">filter_name</var></samp></dt>
268
- <dd><p>Print detailed information about the filter named <var class="var">filter_name</var>. Use the
269
- <samp class="option">-filters</samp> option to get a list of all filters.
270
- </p>
271
- </dd>
272
- <dt><samp class="option">bsf=<var class="var">bitstream_filter_name</var></samp></dt>
273
- <dd><p>Print detailed information about the bitstream filter named <var class="var">bitstream_filter_name</var>.
274
- Use the <samp class="option">-bsfs</samp> option to get a list of all bitstream filters.
275
- </p>
276
- </dd>
277
- <dt><samp class="option">protocol=<var class="var">protocol_name</var></samp></dt>
278
- <dd><p>Print detailed information about the protocol named <var class="var">protocol_name</var>.
279
- Use the <samp class="option">-protocols</samp> option to get a list of all protocols.
280
- </p></dd>
281
- </dl>
282
-
283
- </dd>
284
- <dt><samp class="option">-version</samp></dt>
285
- <dd><p>Show version.
286
- </p>
287
- </dd>
288
- <dt><samp class="option">-buildconf</samp></dt>
289
- <dd><p>Show the build configuration, one option per line.
290
- </p>
291
- </dd>
292
- <dt><samp class="option">-formats</samp></dt>
293
- <dd><p>Show available formats (including devices).
294
- </p>
295
- </dd>
296
- <dt><samp class="option">-demuxers</samp></dt>
297
- <dd><p>Show available demuxers.
298
- </p>
299
- </dd>
300
- <dt><samp class="option">-muxers</samp></dt>
301
- <dd><p>Show available muxers.
302
- </p>
303
- </dd>
304
- <dt><samp class="option">-devices</samp></dt>
305
- <dd><p>Show available devices.
306
- </p>
307
- </dd>
308
- <dt><samp class="option">-codecs</samp></dt>
309
- <dd><p>Show all codecs known to libavcodec.
310
- </p>
311
- <p>Note that the term &rsquo;codec&rsquo; is used throughout this documentation as a shortcut
312
- for what is more correctly called a media bitstream format.
313
- </p>
314
- </dd>
315
- <dt><samp class="option">-decoders</samp></dt>
316
- <dd><p>Show available decoders.
317
- </p>
318
- </dd>
319
- <dt><samp class="option">-encoders</samp></dt>
320
- <dd><p>Show all available encoders.
321
- </p>
322
- </dd>
323
- <dt><samp class="option">-bsfs</samp></dt>
324
- <dd><p>Show available bitstream filters.
325
- </p>
326
- </dd>
327
- <dt><samp class="option">-protocols</samp></dt>
328
- <dd><p>Show available protocols.
329
- </p>
330
- </dd>
331
- <dt><samp class="option">-filters</samp></dt>
332
- <dd><p>Show available libavfilter filters.
333
- </p>
334
- </dd>
335
- <dt><samp class="option">-pix_fmts</samp></dt>
336
- <dd><p>Show available pixel formats.
337
- </p>
338
- </dd>
339
- <dt><samp class="option">-sample_fmts</samp></dt>
340
- <dd><p>Show available sample formats.
341
- </p>
342
- </dd>
343
- <dt><samp class="option">-layouts</samp></dt>
344
- <dd><p>Show channel names and standard channel layouts.
345
- </p>
346
- </dd>
347
- <dt><samp class="option">-dispositions</samp></dt>
348
- <dd><p>Show stream dispositions.
349
- </p>
350
- </dd>
351
- <dt><samp class="option">-colors</samp></dt>
352
- <dd><p>Show recognized color names.
353
- </p>
354
- </dd>
355
- <dt><samp class="option">-sources <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
356
- <dd><p>Show autodetected sources of the input device.
357
- Some devices may provide system-dependent source names that cannot be autodetected.
358
- The returned list cannot be assumed to be always complete.
359
- </p><div class="example">
360
- <pre class="example-preformatted">ffmpeg -sources pulse,server=192.168.0.4
361
- </pre></div>
362
-
363
- </dd>
364
- <dt><samp class="option">-sinks <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
365
- <dd><p>Show autodetected sinks of the output device.
366
- Some devices may provide system-dependent sink names that cannot be autodetected.
367
- The returned list cannot be assumed to be always complete.
368
- </p><div class="example">
369
- <pre class="example-preformatted">ffmpeg -sinks pulse,server=192.168.0.4
370
- </pre></div>
371
-
372
- </dd>
373
- <dt><samp class="option">-loglevel [<var class="var">flags</var>+]<var class="var">loglevel</var> | -v [<var class="var">flags</var>+]<var class="var">loglevel</var></samp></dt>
374
- <dd><p>Set logging level and flags used by the library.
375
- </p>
376
- <p>The optional <var class="var">flags</var> prefix can consist of the following values:
377
- </p><dl class="table">
378
- <dt>&lsquo;<samp class="samp">repeat</samp>&rsquo;</dt>
379
- <dd><p>Indicates that repeated log output should not be compressed to the first line
380
- and the &quot;Last message repeated n times&quot; line will be omitted.
381
- </p></dd>
382
- <dt>&lsquo;<samp class="samp">level</samp>&rsquo;</dt>
383
- <dd><p>Indicates that log output should add a <code class="code">[level]</code> prefix to each message
384
- line. This can be used as an alternative to log coloring, e.g. when dumping the
385
- log to file.
386
- </p></dd>
387
- </dl>
388
- <p>Flags can also be used alone by adding a &rsquo;+&rsquo;/&rsquo;-&rsquo; prefix to set/reset a single
389
- flag without affecting other <var class="var">flags</var> or changing <var class="var">loglevel</var>. When
390
- setting both <var class="var">flags</var> and <var class="var">loglevel</var>, a &rsquo;+&rsquo; separator is expected
391
- between the last <var class="var">flags</var> value and before <var class="var">loglevel</var>.
392
- </p>
393
- <p><var class="var">loglevel</var> is a string or a number containing one of the following values:
394
- </p><dl class="table">
395
- <dt>&lsquo;<samp class="samp">quiet, -8</samp>&rsquo;</dt>
396
- <dd><p>Show nothing at all; be silent.
397
- </p></dd>
398
- <dt>&lsquo;<samp class="samp">panic, 0</samp>&rsquo;</dt>
399
- <dd><p>Only show fatal errors which could lead the process to crash, such as
400
- an assertion failure. This is not currently used for anything.
401
- </p></dd>
402
- <dt>&lsquo;<samp class="samp">fatal, 8</samp>&rsquo;</dt>
403
- <dd><p>Only show fatal errors. These are errors after which the process absolutely
404
- cannot continue.
405
- </p></dd>
406
- <dt>&lsquo;<samp class="samp">error, 16</samp>&rsquo;</dt>
407
- <dd><p>Show all errors, including ones which can be recovered from.
408
- </p></dd>
409
- <dt>&lsquo;<samp class="samp">warning, 24</samp>&rsquo;</dt>
410
- <dd><p>Show all warnings and errors. Any message related to possibly
411
- incorrect or unexpected events will be shown.
412
- </p></dd>
413
- <dt>&lsquo;<samp class="samp">info, 32</samp>&rsquo;</dt>
414
- <dd><p>Show informative messages during processing. This is in addition to
415
- warnings and errors. This is the default value.
416
- </p></dd>
417
- <dt>&lsquo;<samp class="samp">verbose, 40</samp>&rsquo;</dt>
418
- <dd><p>Same as <code class="code">info</code>, except more verbose.
419
- </p></dd>
420
- <dt>&lsquo;<samp class="samp">debug, 48</samp>&rsquo;</dt>
421
- <dd><p>Show everything, including debugging information.
422
- </p></dd>
423
- <dt>&lsquo;<samp class="samp">trace, 56</samp>&rsquo;</dt>
424
- </dl>
425
-
426
- <p>For example to enable repeated log output, add the <code class="code">level</code> prefix, and set
427
- <var class="var">loglevel</var> to <code class="code">verbose</code>:
428
- </p><div class="example">
429
- <pre class="example-preformatted">ffmpeg -loglevel repeat+level+verbose -i input output
430
- </pre></div>
431
- <p>Another example that enables repeated log output without affecting current
432
- state of <code class="code">level</code> prefix flag or <var class="var">loglevel</var>:
433
- </p><div class="example">
434
- <pre class="example-preformatted">ffmpeg [...] -loglevel +repeat
435
- </pre></div>
436
-
437
- <p>By default the program logs to stderr. If coloring is supported by the
438
- terminal, colors are used to mark errors and warnings. Log coloring
439
- can be disabled setting the environment variable
440
- <code class="env">AV_LOG_FORCE_NOCOLOR</code>, or can be forced setting
441
- the environment variable <code class="env">AV_LOG_FORCE_COLOR</code>.
442
- </p>
443
- </dd>
444
- <dt><samp class="option">-report</samp></dt>
445
- <dd><p>Dump full command line and log output to a file named
446
- <code class="code"><var class="var">program</var>-<var class="var">YYYYMMDD</var>-<var class="var">HHMMSS</var>.log</code> in the current
447
- directory.
448
- This file can be useful for bug reports.
449
- It also implies <code class="code">-loglevel debug</code>.
450
- </p>
451
- <p>Setting the environment variable <code class="env">FFREPORT</code> to any value has the
452
- same effect. If the value is a &rsquo;:&rsquo;-separated key=value sequence, these
453
- options will affect the report; option values must be escaped if they
454
- contain special characters or the options delimiter &rsquo;:&rsquo; (see the
455
- &ldquo;Quoting and escaping&rdquo; section in the ffmpeg-utils manual).
456
- </p>
457
- <p>The following options are recognized:
458
- </p><dl class="table">
459
- <dt><samp class="option">file</samp></dt>
460
- <dd><p>set the file name to use for the report; <code class="code">%p</code> is expanded to the name
461
- of the program, <code class="code">%t</code> is expanded to a timestamp, <code class="code">%%</code> is expanded
462
- to a plain <code class="code">%</code>
463
- </p></dd>
464
- <dt><samp class="option">level</samp></dt>
465
- <dd><p>set the log verbosity level using a numerical value (see <code class="code">-loglevel</code>).
466
- </p></dd>
467
- </dl>
468
-
469
- <p>For example, to output a report to a file named <samp class="file">ffreport.log</samp>
470
- using a log level of <code class="code">32</code> (alias for log level <code class="code">info</code>):
471
- </p>
472
- <div class="example">
473
- <pre class="example-preformatted">FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
474
- </pre></div>
475
-
476
- <p>Errors in parsing the environment variable are not fatal, and will not
477
- appear in the report.
478
- </p>
479
- </dd>
480
- <dt><samp class="option">-hide_banner</samp></dt>
481
- <dd><p>Suppress printing banner.
482
- </p>
483
- <p>All FFmpeg tools will normally show a copyright notice, build options
484
- and library versions. This option can be used to suppress printing
485
- this information.
486
- </p>
487
- </dd>
488
- <dt><samp class="option">-cpuflags flags (<em class="emph">global</em>)</samp></dt>
489
- <dd><p>Allows setting and clearing cpu flags. This option is intended
490
- for testing. Do not use it unless you know what you&rsquo;re doing.
491
- </p><div class="example">
492
- <pre class="example-preformatted">ffmpeg -cpuflags -sse+mmx ...
493
- ffmpeg -cpuflags mmx ...
494
- ffmpeg -cpuflags 0 ...
495
- </pre></div>
496
- <p>Possible flags for this option are:
497
- </p><dl class="table">
498
- <dt>&lsquo;<samp class="samp">x86</samp>&rsquo;</dt>
499
- <dd><dl class="table">
500
- <dt>&lsquo;<samp class="samp">mmx</samp>&rsquo;</dt>
501
- <dt>&lsquo;<samp class="samp">mmxext</samp>&rsquo;</dt>
502
- <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
503
- <dt>&lsquo;<samp class="samp">sse2</samp>&rsquo;</dt>
504
- <dt>&lsquo;<samp class="samp">sse2slow</samp>&rsquo;</dt>
505
- <dt>&lsquo;<samp class="samp">sse3</samp>&rsquo;</dt>
506
- <dt>&lsquo;<samp class="samp">sse3slow</samp>&rsquo;</dt>
507
- <dt>&lsquo;<samp class="samp">ssse3</samp>&rsquo;</dt>
508
- <dt>&lsquo;<samp class="samp">atom</samp>&rsquo;</dt>
509
- <dt>&lsquo;<samp class="samp">sse4.1</samp>&rsquo;</dt>
510
- <dt>&lsquo;<samp class="samp">sse4.2</samp>&rsquo;</dt>
511
- <dt>&lsquo;<samp class="samp">avx</samp>&rsquo;</dt>
512
- <dt>&lsquo;<samp class="samp">avx2</samp>&rsquo;</dt>
513
- <dt>&lsquo;<samp class="samp">xop</samp>&rsquo;</dt>
514
- <dt>&lsquo;<samp class="samp">fma3</samp>&rsquo;</dt>
515
- <dt>&lsquo;<samp class="samp">fma4</samp>&rsquo;</dt>
516
- <dt>&lsquo;<samp class="samp">3dnow</samp>&rsquo;</dt>
517
- <dt>&lsquo;<samp class="samp">3dnowext</samp>&rsquo;</dt>
518
- <dt>&lsquo;<samp class="samp">bmi1</samp>&rsquo;</dt>
519
- <dt>&lsquo;<samp class="samp">bmi2</samp>&rsquo;</dt>
520
- <dt>&lsquo;<samp class="samp">cmov</samp>&rsquo;</dt>
521
- </dl>
522
- </dd>
523
- <dt>&lsquo;<samp class="samp">ARM</samp>&rsquo;</dt>
524
- <dd><dl class="table">
525
- <dt>&lsquo;<samp class="samp">armv5te</samp>&rsquo;</dt>
526
- <dt>&lsquo;<samp class="samp">armv6</samp>&rsquo;</dt>
527
- <dt>&lsquo;<samp class="samp">armv6t2</samp>&rsquo;</dt>
528
- <dt>&lsquo;<samp class="samp">vfp</samp>&rsquo;</dt>
529
- <dt>&lsquo;<samp class="samp">vfpv3</samp>&rsquo;</dt>
530
- <dt>&lsquo;<samp class="samp">neon</samp>&rsquo;</dt>
531
- <dt>&lsquo;<samp class="samp">setend</samp>&rsquo;</dt>
532
- </dl>
533
- </dd>
534
- <dt>&lsquo;<samp class="samp">AArch64</samp>&rsquo;</dt>
535
- <dd><dl class="table">
536
- <dt>&lsquo;<samp class="samp">armv8</samp>&rsquo;</dt>
537
- <dt>&lsquo;<samp class="samp">vfp</samp>&rsquo;</dt>
538
- <dt>&lsquo;<samp class="samp">neon</samp>&rsquo;</dt>
539
- </dl>
540
- </dd>
541
- <dt>&lsquo;<samp class="samp">PowerPC</samp>&rsquo;</dt>
542
- <dd><dl class="table">
543
- <dt>&lsquo;<samp class="samp">altivec</samp>&rsquo;</dt>
544
- </dl>
545
- </dd>
546
- <dt>&lsquo;<samp class="samp">Specific Processors</samp>&rsquo;</dt>
547
- <dd><dl class="table">
548
- <dt>&lsquo;<samp class="samp">pentium2</samp>&rsquo;</dt>
549
- <dt>&lsquo;<samp class="samp">pentium3</samp>&rsquo;</dt>
550
- <dt>&lsquo;<samp class="samp">pentium4</samp>&rsquo;</dt>
551
- <dt>&lsquo;<samp class="samp">k6</samp>&rsquo;</dt>
552
- <dt>&lsquo;<samp class="samp">k62</samp>&rsquo;</dt>
553
- <dt>&lsquo;<samp class="samp">athlon</samp>&rsquo;</dt>
554
- <dt>&lsquo;<samp class="samp">athlonxp</samp>&rsquo;</dt>
555
- <dt>&lsquo;<samp class="samp">k8</samp>&rsquo;</dt>
556
- </dl>
557
- </dd>
558
- </dl>
559
-
560
- </dd>
561
- <dt><samp class="option">-cpucount <var class="var">count</var> (<em class="emph">global</em>)</samp></dt>
562
- <dd><p>Override detection of CPU count. This option is intended
563
- for testing. Do not use it unless you know what you&rsquo;re doing.
564
- </p><div class="example">
565
- <pre class="example-preformatted">ffmpeg -cpucount 2
566
- </pre></div>
567
-
568
- </dd>
569
- <dt><samp class="option">-max_alloc <var class="var">bytes</var></samp></dt>
570
- <dd><p>Set the maximum size limit for allocating a block on the heap by ffmpeg&rsquo;s
571
- family of malloc functions. Exercise <strong class="strong">extreme caution</strong> when using
572
- this option. Don&rsquo;t use if you do not understand the full consequence of doing so.
573
- Default is INT_MAX.
574
- </p></dd>
575
- </dl>
576
-
577
- </div>
578
- <div class="section-level-extent" id="AVOptions">
579
- <h3 class="section"><span>3.3 AVOptions<a class="copiable-link" href="#AVOptions"> &para;</a></span></h3>
580
-
581
- <p>These options are provided directly by the libavformat, libavdevice and
582
- libavcodec libraries. To see the list of available AVOptions, use the
583
- <samp class="option">-help</samp> option. They are separated into two categories:
584
- </p><dl class="table">
585
- <dt><samp class="option">generic</samp></dt>
586
- <dd><p>These options can be set for any container, codec or device. Generic options
587
- are listed under AVFormatContext options for containers/devices and under
588
- AVCodecContext options for codecs.
589
- </p></dd>
590
- <dt><samp class="option">private</samp></dt>
591
- <dd><p>These options are specific to the given container, device or codec. Private
592
- options are listed under their corresponding containers/devices/codecs.
593
- </p></dd>
594
- </dl>
595
-
596
- <p>For example to write an ID3v2.3 header instead of a default ID3v2.4 to
597
- an MP3 file, use the <samp class="option">id3v2_version</samp> private option of the MP3
598
- muxer:
599
- </p><div class="example">
600
- <pre class="example-preformatted">ffmpeg -i input.flac -id3v2_version 3 out.mp3
601
- </pre></div>
602
-
603
- <p>All codec AVOptions are per-stream, and thus a stream specifier
604
- should be attached to them:
605
- </p><div class="example">
606
- <pre class="example-preformatted">ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
607
- </pre></div>
608
-
609
- <p>In the above example, a multichannel audio stream is mapped twice for output.
610
- The first instance is encoded with codec ac3 and bitrate 640k.
611
- The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using
612
- absolute index of the output stream.
613
- </p>
614
- <p>Note: the <samp class="option">-nooption</samp> syntax cannot be used for boolean
615
- AVOptions, use <samp class="option">-option 0</samp>/<samp class="option">-option 1</samp>.
616
- </p>
617
- <p>Note: the old undocumented way of specifying per-stream AVOptions by
618
- prepending v/a/s to the options name is now obsolete and will be
619
- removed soon.
620
- </p>
621
- </div>
622
- <div class="section-level-extent" id="Main-options">
623
- <h3 class="section"><span>3.4 Main options<a class="copiable-link" href="#Main-options"> &para;</a></span></h3>
624
-
625
- <dl class="table">
626
- <dt><samp class="option">-f <var class="var">format</var></samp></dt>
627
- <dd><p>Force format to use.
628
- </p>
629
- </dd>
630
- <dt><samp class="option">-unit</samp></dt>
631
- <dd><p>Show the unit of the displayed values.
632
- </p>
633
- </dd>
634
- <dt><samp class="option">-prefix</samp></dt>
635
- <dd><p>Use SI prefixes for the displayed values.
636
- Unless the &quot;-byte_binary_prefix&quot; option is used all the prefixes
637
- are decimal.
638
- </p>
639
- </dd>
640
- <dt><samp class="option">-byte_binary_prefix</samp></dt>
641
- <dd><p>Force the use of binary prefixes for byte values.
642
- </p>
643
- </dd>
644
- <dt><samp class="option">-sexagesimal</samp></dt>
645
- <dd><p>Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
646
- </p>
647
- </dd>
648
- <dt><samp class="option">-pretty</samp></dt>
649
- <dd><p>Prettify the format of the displayed values, it corresponds to the
650
- options &quot;-unit -prefix -byte_binary_prefix -sexagesimal&quot;.
651
- </p>
652
- </dd>
653
- <dt><samp class="option">-output_format, -of, -print_format <var class="var">writer_name</var>[=<var class="var">writer_options</var>]</samp></dt>
654
- <dd><p>Set the output printing format.
655
- </p>
656
- <p><var class="var">writer_name</var> specifies the name of the writer, and
657
- <var class="var">writer_options</var> specifies the options to be passed to the writer.
658
- </p>
659
- <p>For example for printing the output in JSON format, specify:
660
- </p><div class="example">
661
- <pre class="example-preformatted">-output_format json
662
- </pre></div>
663
-
664
- <p>For more details on the available output printing formats, see the
665
- Writers section below.
666
- </p>
667
- </dd>
668
- <dt><samp class="option">-sections</samp></dt>
669
- <dd><p>Print sections structure and section information, and exit. The output
670
- is not meant to be parsed by a machine.
671
- </p>
672
- </dd>
673
- <dt><samp class="option">-select_streams <var class="var">stream_specifier</var></samp></dt>
674
- <dd><p>Select only the streams specified by <var class="var">stream_specifier</var>. This
675
- option affects only the options related to streams
676
- (e.g. <code class="code">show_streams</code>, <code class="code">show_packets</code>, etc.).
677
- </p>
678
- <p>For example to show only audio streams, you can use the command:
679
- </p><div class="example">
680
- <pre class="example-preformatted">ffprobe -show_streams -select_streams a INPUT
681
- </pre></div>
682
-
683
- <p>To show only video packets belonging to the video stream with index 1:
684
- </p><div class="example">
685
- <pre class="example-preformatted">ffprobe -show_packets -select_streams v:1 INPUT
686
- </pre></div>
687
-
688
- </dd>
689
- <dt><samp class="option">-show_data</samp></dt>
690
- <dd><p>Show payload data, as a hexadecimal and ASCII dump. Coupled with
691
- <samp class="option">-show_packets</samp>, it will dump the packets&rsquo; data. Coupled with
692
- <samp class="option">-show_streams</samp>, it will dump the codec extradata.
693
- </p>
694
- <p>The dump is printed as the &quot;data&quot; field. It may contain newlines.
695
- </p>
696
- </dd>
697
- <dt><samp class="option">-show_data_hash <var class="var">algorithm</var></samp></dt>
698
- <dd><p>Show a hash of payload data, for packets with <samp class="option">-show_packets</samp> and for
699
- codec extradata with <samp class="option">-show_streams</samp>.
700
- </p>
701
- </dd>
702
- <dt><samp class="option">-show_error</samp></dt>
703
- <dd><p>Show information about the error found when trying to probe the input.
704
- </p>
705
- <p>The error information is printed within a section with name &quot;ERROR&quot;.
706
- </p>
707
- </dd>
708
- <dt><samp class="option">-show_format</samp></dt>
709
- <dd><p>Show information about the container format of the input multimedia
710
- stream.
711
- </p>
712
- <p>All the container format information is printed within a section with
713
- name &quot;FORMAT&quot;.
714
- </p>
715
- </dd>
716
- <dt><samp class="option">-show_format_entry <var class="var">name</var></samp></dt>
717
- <dd><p>Like <samp class="option">-show_format</samp>, but only prints the specified entry of the
718
- container format information, rather than all. This option may be given more
719
- than once, then all specified entries will be shown.
720
- </p>
721
- <p>This option is deprecated, use <code class="code">show_entries</code> instead.
722
- </p>
723
- </dd>
724
- <dt><samp class="option">-show_entries <var class="var">section_entries</var></samp></dt>
725
- <dd><p>Set list of entries to show.
726
- </p>
727
- <p>Entries are specified according to the following
728
- syntax. <var class="var">section_entries</var> contains a list of section entries
729
- separated by <code class="code">:</code>. Each section entry is composed by a section
730
- name (or unique name), optionally followed by a list of entries local
731
- to that section, separated by <code class="code">,</code>.
732
- </p>
733
- <p>If section name is specified but is followed by no <code class="code">=</code>, all
734
- entries are printed to output, together with all the contained
735
- sections. Otherwise only the entries specified in the local section
736
- entries list are printed. In particular, if <code class="code">=</code> is specified but
737
- the list of local entries is empty, then no entries will be shown for
738
- that section.
739
- </p>
740
- <p>Note that the order of specification of the local section entries is
741
- not honored in the output, and the usual display order will be
742
- retained.
743
- </p>
744
- <p>The formal syntax is given by:
745
- </p><div class="example">
746
- <pre class="example-preformatted"><var class="var">LOCAL_SECTION_ENTRIES</var> ::= <var class="var">SECTION_ENTRY_NAME</var>[,<var class="var">LOCAL_SECTION_ENTRIES</var>]
747
- <var class="var">SECTION_ENTRY</var> ::= <var class="var">SECTION_NAME</var>[=[<var class="var">LOCAL_SECTION_ENTRIES</var>]]
748
- <var class="var">SECTION_ENTRIES</var> ::= <var class="var">SECTION_ENTRY</var>[:<var class="var">SECTION_ENTRIES</var>]
749
- </pre></div>
750
-
751
- <p>For example, to show only the index and type of each stream, and the PTS
752
- time, duration time, and stream index of the packets, you can specify
753
- the argument:
754
- </p><div class="example">
755
- <pre class="example-preformatted">packet=pts_time,duration_time,stream_index : stream=index,codec_type
756
- </pre></div>
757
-
758
- <p>To show all the entries in the section &quot;format&quot;, but only the codec
759
- type in the section &quot;stream&quot;, specify the argument:
760
- </p><div class="example">
761
- <pre class="example-preformatted">format : stream=codec_type
762
- </pre></div>
763
-
764
- <p>To show all the tags in the stream and format sections:
765
- </p><div class="example">
766
- <pre class="example-preformatted">stream_tags : format_tags
767
- </pre></div>
768
-
769
- <p>To show only the <code class="code">title</code> tag (if available) in the stream
770
- sections:
771
- </p><div class="example">
772
- <pre class="example-preformatted">stream_tags=title
773
- </pre></div>
774
-
775
- </dd>
776
- <dt><samp class="option">-show_packets</samp></dt>
777
- <dd><p>Show information about each packet contained in the input multimedia
778
- stream.
779
- </p>
780
- <p>The information for each single packet is printed within a dedicated
781
- section with name &quot;PACKET&quot;.
782
- </p>
783
- </dd>
784
- <dt><samp class="option">-show_frames</samp></dt>
785
- <dd><p>Show information about each frame and subtitle contained in the input
786
- multimedia stream.
787
- </p>
788
- <p>The information for each single frame is printed within a dedicated
789
- section with name &quot;FRAME&quot; or &quot;SUBTITLE&quot;.
790
- </p>
791
- </dd>
792
- <dt><samp class="option">-show_log <var class="var">loglevel</var></samp></dt>
793
- <dd><p>Show logging information from the decoder about each frame according to
794
- the value set in <var class="var">loglevel</var>, (see <code class="code">-loglevel</code>). This option requires <code class="code">-show_frames</code>.
795
- </p>
796
- <p>The information for each log message is printed within a dedicated
797
- section with name &quot;LOG&quot;.
798
- </p>
799
- </dd>
800
- <dt><samp class="option">-show_streams</samp></dt>
801
- <dd><p>Show information about each media stream contained in the input
802
- multimedia stream.
803
- </p>
804
- <p>Each media stream information is printed within a dedicated section
805
- with name &quot;STREAM&quot;.
806
- </p>
807
- </dd>
808
- <dt><samp class="option">-show_programs</samp></dt>
809
- <dd><p>Show information about programs and their streams contained in the input
810
- multimedia stream.
811
- </p>
812
- <p>Each media stream information is printed within a dedicated section
813
- with name &quot;PROGRAM_STREAM&quot;.
814
- </p>
815
- </dd>
816
- <dt><samp class="option">-show_stream_groups</samp></dt>
817
- <dd><p>Show information about stream groups and their streams contained in the
818
- input multimedia stream.
819
- </p>
820
- <p>Each media stream information is printed within a dedicated section
821
- with name &quot;STREAM_GROUP_STREAM&quot;.
822
- </p>
823
- </dd>
824
- <dt><samp class="option">-show_chapters</samp></dt>
825
- <dd><p>Show information about chapters stored in the format.
826
- </p>
827
- <p>Each chapter is printed within a dedicated section with name &quot;CHAPTER&quot;.
828
- </p>
829
- </dd>
830
- <dt><samp class="option">-count_frames</samp></dt>
831
- <dd><p>Count the number of frames per stream and report it in the
832
- corresponding stream section.
833
- </p>
834
- </dd>
835
- <dt><samp class="option">-count_packets</samp></dt>
836
- <dd><p>Count the number of packets per stream and report it in the
837
- corresponding stream section.
838
- </p>
839
- </dd>
840
- <dt><samp class="option">-read_intervals <var class="var">read_intervals</var></samp></dt>
841
- <dd>
842
- <p>Read only the specified intervals. <var class="var">read_intervals</var> must be a
843
- sequence of interval specifications separated by &quot;,&quot;.
844
- <code class="command">ffprobe</code> will seek to the interval starting point, and will
845
- continue reading from that.
846
- </p>
847
- <p>Each interval is specified by two optional parts, separated by &quot;%&quot;.
848
- </p>
849
- <p>The first part specifies the interval start position. It is
850
- interpreted as an absolute position, or as a relative offset from the
851
- current position if it is preceded by the &quot;+&quot; character. If this first
852
- part is not specified, no seeking will be performed when reading this
853
- interval.
854
- </p>
855
- <p>The second part specifies the interval end position. It is interpreted
856
- as an absolute position, or as a relative offset from the current
857
- position if it is preceded by the &quot;+&quot; character. If the offset
858
- specification starts with &quot;#&quot;, it is interpreted as the number of
859
- packets to read (not including the flushing packets) from the interval
860
- start. If no second part is specified, the program will read until the
861
- end of the input.
862
- </p>
863
- <p>Note that seeking is not accurate, thus the actual interval start
864
- point may be different from the specified position. Also, when an
865
- interval duration is specified, the absolute end time will be computed
866
- by adding the duration to the interval start point found by seeking
867
- the file, rather than to the specified start value.
868
- </p>
869
- <p>The formal syntax is given by:
870
- </p><div class="example">
871
- <pre class="example-preformatted"><var class="var">INTERVAL</var> ::= [<var class="var">START</var>|+<var class="var">START_OFFSET</var>][%[<var class="var">END</var>|+<var class="var">END_OFFSET</var>]]
872
- <var class="var">INTERVALS</var> ::= <var class="var">INTERVAL</var>[,<var class="var">INTERVALS</var>]
873
- </pre></div>
874
-
875
- <p>A few examples follow.
876
- </p><ul class="itemize mark-bullet">
877
- <li>Seek to time 10, read packets until 20 seconds after the found seek
878
- point, then seek to position <code class="code">01:30</code> (1 minute and thirty
879
- seconds) and read packets until position <code class="code">01:45</code>.
880
- <div class="example">
881
- <pre class="example-preformatted">10%+20,01:30%01:45
882
- </pre></div>
883
-
884
- </li><li>Read only 42 packets after seeking to position <code class="code">01:23</code>:
885
- <div class="example">
886
- <pre class="example-preformatted">01:23%+#42
887
- </pre></div>
888
-
889
- </li><li>Read only the first 20 seconds from the start:
890
- <div class="example">
891
- <pre class="example-preformatted">%+20
892
- </pre></div>
893
-
894
- </li><li>Read from the start until position <code class="code">02:30</code>:
895
- <div class="example">
896
- <pre class="example-preformatted">%02:30
897
- </pre></div>
898
- </li></ul>
899
-
900
- </dd>
901
- <dt><samp class="option">-show_private_data, -private</samp></dt>
902
- <dd><p>Show private data, that is data depending on the format of the
903
- particular shown element.
904
- This option is enabled by default, but you may need to disable it
905
- for specific uses, for example when creating XSD-compliant XML output.
906
- </p>
907
- </dd>
908
- <dt><samp class="option">-show_program_version</samp></dt>
909
- <dd><p>Show information related to program version.
910
- </p>
911
- <p>Version information is printed within a section with name
912
- &quot;PROGRAM_VERSION&quot;.
913
- </p>
914
- </dd>
915
- <dt><samp class="option">-show_library_versions</samp></dt>
916
- <dd><p>Show information related to library versions.
917
- </p>
918
- <p>Version information for each library is printed within a section with
919
- name &quot;LIBRARY_VERSION&quot;.
920
- </p>
921
- </dd>
922
- <dt><samp class="option">-show_versions</samp></dt>
923
- <dd><p>Show information related to program and library versions. This is the
924
- equivalent of setting both <samp class="option">-show_program_version</samp> and
925
- <samp class="option">-show_library_versions</samp> options.
926
- </p>
927
- </dd>
928
- <dt><samp class="option">-show_pixel_formats</samp></dt>
929
- <dd><p>Show information about all pixel formats supported by FFmpeg.
930
- </p>
931
- <p>Pixel format information for each format is printed within a section
932
- with name &quot;PIXEL_FORMAT&quot;.
933
- </p>
934
- </dd>
935
- <dt><samp class="option">-show_optional_fields <var class="var">value</var></samp></dt>
936
- <dd><p>Some writers viz. JSON and XML, omit the printing of fields with invalid or non-applicable values,
937
- while other writers always print them. This option enables one to control this behaviour.
938
- Valid values are <code class="code">always</code>/<code class="code">1</code>, <code class="code">never</code>/<code class="code">0</code> and <code class="code">auto</code>/<code class="code">-1</code>.
939
- Default is <var class="var">auto</var>.
940
- </p>
941
- </dd>
942
- <dt><samp class="option">-bitexact</samp></dt>
943
- <dd><p>Force bitexact output, useful to produce output which is not dependent
944
- on the specific build.
945
- </p>
946
- </dd>
947
- <dt><samp class="option">-i <var class="var">input_url</var></samp></dt>
948
- <dd><p>Read <var class="var">input_url</var>.
949
- </p>
950
- </dd>
951
- <dt><samp class="option">-o <var class="var">output_url</var></samp></dt>
952
- <dd><p>Write output to <var class="var">output_url</var>. If not specified, the output is sent
953
- to stdout.
954
- </p>
955
- </dd>
956
- </dl>
957
-
958
- </div>
959
- </div>
960
- <div class="chapter-level-extent" id="Writers">
961
- <h2 class="chapter"><span>4 Writers<a class="copiable-link" href="#Writers"> &para;</a></span></h2>
962
-
963
- <p>A writer defines the output format adopted by <code class="command">ffprobe</code>, and will be
964
- used for printing all the parts of the output.
965
- </p>
966
- <p>A writer may accept one or more arguments, which specify the options
967
- to adopt. The options are specified as a list of <var class="var">key</var>=<var class="var">value</var>
968
- pairs, separated by &quot;:&quot;.
969
- </p>
970
- <p>All writers support the following options:
971
- </p>
972
- <dl class="table">
973
- <dt><samp class="option">string_validation, sv</samp></dt>
974
- <dd><p>Set string validation mode.
975
- </p>
976
- <p>The following values are accepted.
977
- </p><dl class="table">
978
- <dt>&lsquo;<samp class="samp">fail</samp>&rsquo;</dt>
979
- <dd><p>The writer will fail immediately in case an invalid string (UTF-8)
980
- sequence or code point is found in the input. This is especially
981
- useful to validate input metadata.
982
- </p>
983
- </dd>
984
- <dt>&lsquo;<samp class="samp">ignore</samp>&rsquo;</dt>
985
- <dd><p>Any validation error will be ignored. This will result in possibly
986
- broken output, especially with the json or xml writer.
987
- </p>
988
- </dd>
989
- <dt>&lsquo;<samp class="samp">replace</samp>&rsquo;</dt>
990
- <dd><p>The writer will substitute invalid UTF-8 sequences or code points with
991
- the string specified with the <samp class="option">string_validation_replacement</samp>.
992
- </p></dd>
993
- </dl>
994
-
995
- <p>Default value is &lsquo;<samp class="samp">replace</samp>&rsquo;.
996
- </p>
997
- </dd>
998
- <dt><samp class="option">string_validation_replacement, svr</samp></dt>
999
- <dd><p>Set replacement string to use in case <samp class="option">string_validation</samp> is
1000
- set to &lsquo;<samp class="samp">replace</samp>&rsquo;.
1001
- </p>
1002
- <p>In case the option is not specified, the writer will assume the empty
1003
- string, that is it will remove the invalid sequences from the input
1004
- strings.
1005
- </p></dd>
1006
- </dl>
1007
-
1008
- <p>A description of the currently available writers follows.
1009
- </p>
1010
- <ul class="mini-toc">
1011
- <li><a href="#default" accesskey="1">default</a></li>
1012
- <li><a href="#compact_002c-csv" accesskey="2">compact, csv</a></li>
1013
- <li><a href="#flat" accesskey="3">flat</a></li>
1014
- <li><a href="#ini" accesskey="4">ini</a></li>
1015
- <li><a href="#json" accesskey="5">json</a></li>
1016
- <li><a href="#xml" accesskey="6">xml</a></li>
1017
- </ul>
1018
- <div class="section-level-extent" id="default">
1019
- <h3 class="section"><span>4.1 default<a class="copiable-link" href="#default"> &para;</a></span></h3>
1020
- <p>Default format.
1021
- </p>
1022
- <p>Print each section in the form:
1023
- </p><div class="example">
1024
- <pre class="example-preformatted">[SECTION]
1025
- key1=val1
1026
- ...
1027
- keyN=valN
1028
- [/SECTION]
1029
- </pre></div>
1030
-
1031
- <p>Metadata tags are printed as a line in the corresponding FORMAT, STREAM,
1032
- STREAM_GROUP_STREAM or PROGRAM_STREAM section, and are prefixed by the
1033
- string &quot;TAG:&quot;.
1034
- </p>
1035
- <p>A description of the accepted options follows.
1036
- </p>
1037
- <dl class="table">
1038
- <dt><samp class="option">nokey, nk</samp></dt>
1039
- <dd><p>If set to 1 specify not to print the key of each field. Default value
1040
- is 0.
1041
- </p>
1042
- </dd>
1043
- <dt><samp class="option">noprint_wrappers, nw</samp></dt>
1044
- <dd><p>If set to 1 specify not to print the section header and footer.
1045
- Default value is 0.
1046
- </p></dd>
1047
- </dl>
1048
-
1049
- </div>
1050
- <div class="section-level-extent" id="compact_002c-csv">
1051
- <h3 class="section"><span>4.2 compact, csv<a class="copiable-link" href="#compact_002c-csv"> &para;</a></span></h3>
1052
- <p>Compact and CSV format.
1053
- </p>
1054
- <p>The <code class="code">csv</code> writer is equivalent to <code class="code">compact</code>, but supports
1055
- different defaults.
1056
- </p>
1057
- <p>Each section is printed on a single line.
1058
- If no option is specified, the output has the form:
1059
- </p><div class="example">
1060
- <pre class="example-preformatted">section|key1=val1| ... |keyN=valN
1061
- </pre></div>
1062
-
1063
- <p>Metadata tags are printed in the corresponding &quot;format&quot; or &quot;stream&quot;
1064
- section. A metadata tag key, if printed, is prefixed by the string
1065
- &quot;tag:&quot;.
1066
- </p>
1067
- <p>The description of the accepted options follows.
1068
- </p>
1069
- <dl class="table">
1070
- <dt><samp class="option">item_sep, s</samp></dt>
1071
- <dd><p>Specify the character to use for separating fields in the output line.
1072
- It must be a single printable character, it is &quot;|&quot; by default (&quot;,&quot; for
1073
- the <code class="code">csv</code> writer).
1074
- </p>
1075
- </dd>
1076
- <dt><samp class="option">nokey, nk</samp></dt>
1077
- <dd><p>If set to 1 specify not to print the key of each field. Its default
1078
- value is 0 (1 for the <code class="code">csv</code> writer).
1079
- </p>
1080
- </dd>
1081
- <dt><samp class="option">escape, e</samp></dt>
1082
- <dd><p>Set the escape mode to use, default to &quot;c&quot; (&quot;csv&quot; for the <code class="code">csv</code>
1083
- writer).
1084
- </p>
1085
- <p>It can assume one of the following values:
1086
- </p><dl class="table">
1087
- <dt><samp class="option">c</samp></dt>
1088
- <dd><p>Perform C-like escaping. Strings containing a newline (&lsquo;<samp class="samp">\n</samp>&rsquo;), carriage
1089
- return (&lsquo;<samp class="samp">\r</samp>&rsquo;), a tab (&lsquo;<samp class="samp">\t</samp>&rsquo;), a form feed (&lsquo;<samp class="samp">\f</samp>&rsquo;), the escaping
1090
- character (&lsquo;<samp class="samp">\</samp>&rsquo;) or the item separator character <var class="var">SEP</var> are escaped
1091
- using C-like fashioned escaping, so that a newline is converted to the
1092
- sequence &lsquo;<samp class="samp">\n</samp>&rsquo;, a carriage return to &lsquo;<samp class="samp">\r</samp>&rsquo;, &lsquo;<samp class="samp">\</samp>&rsquo; to &lsquo;<samp class="samp">\\</samp>&rsquo; and
1093
- the separator <var class="var">SEP</var> is converted to &lsquo;<samp class="samp">\<var class="var">SEP</var></samp>&rsquo;.
1094
- </p>
1095
- </dd>
1096
- <dt><samp class="option">csv</samp></dt>
1097
- <dd><p>Perform CSV-like escaping, as described in RFC4180. Strings
1098
- containing a newline (&lsquo;<samp class="samp">\n</samp>&rsquo;), a carriage return (&lsquo;<samp class="samp">\r</samp>&rsquo;), a double quote
1099
- (&lsquo;<samp class="samp">&quot;</samp>&rsquo;), or <var class="var">SEP</var> are enclosed in double-quotes.
1100
- </p>
1101
- </dd>
1102
- <dt><samp class="option">none</samp></dt>
1103
- <dd><p>Perform no escaping.
1104
- </p></dd>
1105
- </dl>
1106
-
1107
- </dd>
1108
- <dt><samp class="option">print_section, p</samp></dt>
1109
- <dd><p>Print the section name at the beginning of each line if the value is
1110
- <code class="code">1</code>, disable it with value set to <code class="code">0</code>. Default value is
1111
- <code class="code">1</code>.
1112
- </p>
1113
- </dd>
1114
- </dl>
1115
-
1116
- </div>
1117
- <div class="section-level-extent" id="flat">
1118
- <h3 class="section"><span>4.3 flat<a class="copiable-link" href="#flat"> &para;</a></span></h3>
1119
- <p>Flat format.
1120
- </p>
1121
- <p>A free-form output where each line contains an explicit key=value, such as
1122
- &quot;streams.stream.3.tags.foo=bar&quot;. The output is shell escaped, so it can be
1123
- directly embedded in sh scripts as long as the separator character is an
1124
- alphanumeric character or an underscore (see <var class="var">sep_char</var> option).
1125
- </p>
1126
- <p>The description of the accepted options follows.
1127
- </p>
1128
- <dl class="table">
1129
- <dt><samp class="option">sep_char, s</samp></dt>
1130
- <dd><p>Separator character used to separate the chapter, the section name, IDs and
1131
- potential tags in the printed field key.
1132
- </p>
1133
- <p>Default value is &lsquo;<samp class="samp">.</samp>&rsquo;.
1134
- </p>
1135
- </dd>
1136
- <dt><samp class="option">hierarchical, h</samp></dt>
1137
- <dd><p>Specify if the section name specification should be hierarchical. If
1138
- set to 1, and if there is more than one section in the current
1139
- chapter, the section name will be prefixed by the name of the
1140
- chapter. A value of 0 will disable this behavior.
1141
- </p>
1142
- <p>Default value is 1.
1143
- </p></dd>
1144
- </dl>
1145
-
1146
- </div>
1147
- <div class="section-level-extent" id="ini">
1148
- <h3 class="section"><span>4.4 ini<a class="copiable-link" href="#ini"> &para;</a></span></h3>
1149
- <p>INI format output.
1150
- </p>
1151
- <p>Print output in an INI based format.
1152
- </p>
1153
- <p>The following conventions are adopted:
1154
- </p>
1155
- <ul class="itemize mark-bullet">
1156
- <li>all key and values are UTF-8
1157
- </li><li>&lsquo;<samp class="samp">.</samp>&rsquo; is the subgroup separator
1158
- </li><li>newline, &lsquo;<samp class="samp">\t</samp>&rsquo;, &lsquo;<samp class="samp">\f</samp>&rsquo;, &lsquo;<samp class="samp">\b</samp>&rsquo; and the following characters are
1159
- escaped
1160
- </li><li>&lsquo;<samp class="samp">\</samp>&rsquo; is the escape character
1161
- </li><li>&lsquo;<samp class="samp">#</samp>&rsquo; is the comment indicator
1162
- </li><li>&lsquo;<samp class="samp">=</samp>&rsquo; is the key/value separator
1163
- </li><li>&lsquo;<samp class="samp">:</samp>&rsquo; is not used but usually parsed as key/value separator
1164
- </li></ul>
1165
-
1166
- <p>This writer accepts options as a list of <var class="var">key</var>=<var class="var">value</var> pairs,
1167
- separated by &lsquo;<samp class="samp">:</samp>&rsquo;.
1168
- </p>
1169
- <p>The description of the accepted options follows.
1170
- </p>
1171
- <dl class="table">
1172
- <dt><samp class="option">hierarchical, h</samp></dt>
1173
- <dd><p>Specify if the section name specification should be hierarchical. If
1174
- set to 1, and if there is more than one section in the current
1175
- chapter, the section name will be prefixed by the name of the
1176
- chapter. A value of 0 will disable this behavior.
1177
- </p>
1178
- <p>Default value is 1.
1179
- </p></dd>
1180
- </dl>
1181
-
1182
- </div>
1183
- <div class="section-level-extent" id="json">
1184
- <h3 class="section"><span>4.5 json<a class="copiable-link" href="#json"> &para;</a></span></h3>
1185
- <p>JSON based format.
1186
- </p>
1187
- <p>Each section is printed using JSON notation.
1188
- </p>
1189
- <p>The description of the accepted options follows.
1190
- </p>
1191
- <dl class="table">
1192
- <dt><samp class="option">compact, c</samp></dt>
1193
- <dd><p>If set to 1 enable compact output, that is each section will be
1194
- printed on a single line. Default value is 0.
1195
- </p></dd>
1196
- </dl>
1197
-
1198
- <p>For more information about JSON, see <a class="url" href="http://www.json.org/">http://www.json.org/</a>.
1199
- </p>
1200
- </div>
1201
- <div class="section-level-extent" id="xml">
1202
- <h3 class="section"><span>4.6 xml<a class="copiable-link" href="#xml"> &para;</a></span></h3>
1203
- <p>XML based format.
1204
- </p>
1205
- <p>The XML output is described in the XML schema description file
1206
- <samp class="file">ffprobe.xsd</samp> installed in the FFmpeg datadir.
1207
- </p>
1208
- <p>An updated version of the schema can be retrieved at the url
1209
- <a class="url" href="http://www.ffmpeg.org/schema/ffprobe.xsd">http://www.ffmpeg.org/schema/ffprobe.xsd</a>, which redirects to the
1210
- latest schema committed into the FFmpeg development source code tree.
1211
- </p>
1212
- <p>Note that the output issued will be compliant to the
1213
- <samp class="file">ffprobe.xsd</samp> schema only when no special global output options
1214
- (<samp class="option">unit</samp>, <samp class="option">prefix</samp>, <samp class="option">byte_binary_prefix</samp>,
1215
- <samp class="option">sexagesimal</samp> etc.) are specified.
1216
- </p>
1217
- <p>The description of the accepted options follows.
1218
- </p>
1219
- <dl class="table">
1220
- <dt><samp class="option">fully_qualified, q</samp></dt>
1221
- <dd><p>If set to 1 specify if the output should be fully qualified. Default
1222
- value is 0.
1223
- This is required for generating an XML file which can be validated
1224
- through an XSD file.
1225
- </p>
1226
- </dd>
1227
- <dt><samp class="option">xsd_strict, x</samp></dt>
1228
- <dd><p>If set to 1 perform more checks for ensuring that the output is XSD
1229
- compliant. Default value is 0.
1230
- This option automatically sets <samp class="option">fully_qualified</samp> to 1.
1231
- </p></dd>
1232
- </dl>
1233
-
1234
- <p>For more information about the XML format, see
1235
- <a class="url" href="https://www.w3.org/XML/">https://www.w3.org/XML/</a>.
1236
- </p>
1237
- </div>
1238
- </div>
1239
- <div class="chapter-level-extent" id="Timecode">
1240
- <h2 class="chapter"><span>5 Timecode<a class="copiable-link" href="#Timecode"> &para;</a></span></h2>
1241
-
1242
- <p><code class="command">ffprobe</code> supports Timecode extraction:
1243
- </p>
1244
- <ul class="itemize mark-bullet">
1245
- <li>MPEG1/2 timecode is extracted from the GOP, and is available in the video
1246
- stream details (<samp class="option">-show_streams</samp>, see <var class="var">timecode</var>).
1247
-
1248
- </li><li>MOV timecode is extracted from tmcd track, so is available in the tmcd
1249
- stream metadata (<samp class="option">-show_streams</samp>, see <var class="var">TAG:timecode</var>).
1250
-
1251
- </li><li>DV, GXF and AVI timecodes are available in format metadata
1252
- (<samp class="option">-show_format</samp>, see <var class="var">TAG:timecode</var>).
1253
-
1254
- </li></ul>
1255
-
1256
-
1257
- </div>
1258
- <div class="chapter-level-extent" id="See-Also">
1259
- <h2 class="chapter"><span>6 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
1260
-
1261
- <p><a class="url" href="ffprobe-all.html">ffprobe-all</a>,
1262
- <a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>,
1263
- <a class="url" href="ffmpeg-utils.html">ffmpeg-utils</a>,
1264
- <a class="url" href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
1265
- <a class="url" href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
1266
- <a class="url" href="ffmpeg-codecs.html">ffmpeg-codecs</a>,
1267
- <a class="url" href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>,
1268
- <a class="url" href="ffmpeg-formats.html">ffmpeg-formats</a>,
1269
- <a class="url" href="ffmpeg-devices.html">ffmpeg-devices</a>,
1270
- <a class="url" href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
1271
- <a class="url" href="ffmpeg-filters.html">ffmpeg-filters</a>
1272
- </p>
1273
-
1274
- </div>
1275
- <div class="chapter-level-extent" id="Authors">
1276
- <h2 class="chapter"><span>7 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
1277
-
1278
- <p>The FFmpeg developers.
1279
- </p>
1280
- <p>For details about the authorship, see the Git history of the project
1281
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
1282
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
1283
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
1284
- </p>
1285
- <p>Maintainers for the specific components are listed in the file
1286
- <samp class="file">MAINTAINERS</samp> in the source code tree.
1287
- </p>
1288
-
1289
- </div>
1290
- </div>
1291
- <p style="font-size: small;">
1292
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
1293
- </p>
1294
- </div>
1295
- </body>
1296
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/general.html DELETED
The diff for this file is too large to render. See raw diff
 
ffmpeg/doc/git-howto.html DELETED
@@ -1,621 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Using Git to develop FFmpeg
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Using Git to develop FFmpeg
17
- </h1>
18
-
19
-
20
-
21
- <div class="top-level-extent" id="SEC_Top">
22
-
23
- <div class="element-contents" id="SEC_Contents">
24
- <h2 class="contents-heading">Table of Contents</h2>
25
-
26
- <div class="contents">
27
-
28
- <ul class="toc-numbered-mark">
29
- <li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>
30
- <li><a id="toc-Basics-Usage" href="#Basics-Usage">2 Basics Usage</a>
31
- <ul class="toc-numbered-mark">
32
- <li><a id="toc-Get-Git" href="#Get-Git">2.1 Get Git</a></li>
33
- <li><a id="toc-Cloning-the-source-tree" href="#Cloning-the-source-tree">2.2 Cloning the source tree</a></li>
34
- <li><a id="toc-Updating-the-source-tree-to-the-latest-revision-1" href="#Updating-the-source-tree-to-the-latest-revision-1">2.3 Updating the source tree to the latest revision</a></li>
35
- <li><a id="toc-Rebasing-your-local-branches" href="#Rebasing-your-local-branches">2.4 Rebasing your local branches</a></li>
36
- <li><a id="toc-Adding_002fremoving-files_002fdirectories" href="#Adding_002fremoving-files_002fdirectories">2.5 Adding/removing files/directories</a></li>
37
- <li><a id="toc-Showing-modifications" href="#Showing-modifications">2.6 Showing modifications</a></li>
38
- <li><a id="toc-Inspecting-the-changelog" href="#Inspecting-the-changelog">2.7 Inspecting the changelog</a></li>
39
- <li><a id="toc-Checking-source-tree-status" href="#Checking-source-tree-status">2.8 Checking source tree status</a></li>
40
- <li><a id="toc-Committing" href="#Committing">2.9 Committing</a></li>
41
- <li><a id="toc-Writing-a-commit-message" href="#Writing-a-commit-message">2.10 Writing a commit message</a></li>
42
- <li><a id="toc-Preparing-a-patchset" href="#Preparing-a-patchset">2.11 Preparing a patchset</a></li>
43
- <li><a id="toc-Sending-patches-for-review" href="#Sending-patches-for-review">2.12 Sending patches for review</a></li>
44
- <li><a id="toc-Renaming_002fmoving_002fcopying-files-or-contents-of-files" href="#Renaming_002fmoving_002fcopying-files-or-contents-of-files">2.13 Renaming/moving/copying files or contents of files</a></li>
45
- </ul></li>
46
- <li><a id="toc-Git-configuration" href="#Git-configuration">3 Git configuration</a>
47
- <ul class="toc-numbered-mark">
48
- <li><a id="toc-Personal-Git-installation" href="#Personal-Git-installation">3.1 Personal Git installation</a></li>
49
- <li><a id="toc-Repository-configuration" href="#Repository-configuration">3.2 Repository configuration</a></li>
50
- </ul></li>
51
- <li><a id="toc-FFmpeg-specific" href="#FFmpeg-specific">4 FFmpeg specific</a>
52
- <ul class="toc-numbered-mark">
53
- <li><a id="toc-Reverting-broken-commits" href="#Reverting-broken-commits">4.1 Reverting broken commits</a></li>
54
- <li><a id="toc-Pushing-changes-to-remote-trees" href="#Pushing-changes-to-remote-trees">4.2 Pushing changes to remote trees</a></li>
55
- <li><a id="toc-Finding-a-specific-svn-revision" href="#Finding-a-specific-svn-revision">4.3 Finding a specific svn revision</a></li>
56
- </ul></li>
57
- <li><a id="toc-gpg-key-generation" href="#gpg-key-generation">5 gpg key generation</a></li>
58
- <li><a id="toc-Pre_002dpush-checklist" href="#Pre_002dpush-checklist">6 Pre-push checklist</a></li>
59
- <li><a id="toc-Server-Issues" href="#Server-Issues">7 Server Issues</a></li>
60
- </ul>
61
- </div>
62
- </div>
63
-
64
- <ul class="mini-toc">
65
- <li><a href="#Introduction" accesskey="1">Introduction</a></li>
66
- <li><a href="#Basics-Usage" accesskey="2">Basics Usage</a></li>
67
- <li><a href="#Git-configuration" accesskey="3">Git configuration</a></li>
68
- <li><a href="#FFmpeg-specific" accesskey="4">FFmpeg specific</a></li>
69
- <li><a href="#gpg-key-generation" accesskey="5">gpg key generation</a></li>
70
- <li><a href="#Pre_002dpush-checklist" accesskey="6">Pre-push checklist</a></li>
71
- <li><a href="#Server-Issues" accesskey="7">Server Issues</a></li>
72
- </ul>
73
- <div class="chapter-level-extent" id="Introduction">
74
- <h2 class="chapter"><span>1 Introduction<a class="copiable-link" href="#Introduction"> &para;</a></span></h2>
75
-
76
- <p>This document aims in giving some quick references on a set of useful Git
77
- commands. You should always use the extensive and detailed documentation
78
- provided directly by Git:
79
- </p>
80
- <div class="example">
81
- <pre class="example-preformatted">git --help
82
- man git
83
- </pre></div>
84
-
85
- <p>shows you the available subcommands,
86
- </p>
87
- <div class="example">
88
- <pre class="example-preformatted">git &lt;command&gt; --help
89
- man git-&lt;command&gt;
90
- </pre></div>
91
-
92
- <p>shows information about the subcommand &lt;command&gt;.
93
- </p>
94
- <p>Additional information could be found on the
95
- <a class="url" href="http://gitref.org">Git Reference</a> website.
96
- </p>
97
- <p>For more information about the Git project, visit the
98
- <a class="url" href="http://git-scm.com/">Git website</a>.
99
- </p>
100
- <p>Consult these resources whenever you have problems, they are quite exhaustive.
101
- </p>
102
- <p>What follows now is a basic introduction to Git and some FFmpeg-specific
103
- guidelines to ease the contribution to the project.
104
- </p>
105
- </div>
106
- <div class="chapter-level-extent" id="Basics-Usage">
107
- <h2 class="chapter"><span>2 Basics Usage<a class="copiable-link" href="#Basics-Usage"> &para;</a></span></h2>
108
-
109
- <ul class="mini-toc">
110
- <li><a href="#Get-Git" accesskey="1">Get Git</a></li>
111
- <li><a href="#Cloning-the-source-tree" accesskey="2">Cloning the source tree</a></li>
112
- <li><a href="#Updating-the-source-tree-to-the-latest-revision-1" accesskey="3">Updating the source tree to the latest revision</a></li>
113
- <li><a href="#Rebasing-your-local-branches" accesskey="4">Rebasing your local branches</a></li>
114
- <li><a href="#Adding_002fremoving-files_002fdirectories" accesskey="5">Adding/removing files/directories</a></li>
115
- <li><a href="#Showing-modifications" accesskey="6">Showing modifications</a></li>
116
- <li><a href="#Inspecting-the-changelog" accesskey="7">Inspecting the changelog</a></li>
117
- <li><a href="#Checking-source-tree-status" accesskey="8">Checking source tree status</a></li>
118
- <li><a href="#Committing" accesskey="9">Committing</a></li>
119
- <li><a href="#Writing-a-commit-message">Writing a commit message</a></li>
120
- <li><a href="#Preparing-a-patchset">Preparing a patchset</a></li>
121
- <li><a href="#Sending-patches-for-review">Sending patches for review</a></li>
122
- <li><a href="#Renaming_002fmoving_002fcopying-files-or-contents-of-files">Renaming/moving/copying files or contents of files</a></li>
123
- </ul>
124
- <div class="section-level-extent" id="Get-Git">
125
- <h3 class="section"><span>2.1 Get Git<a class="copiable-link" href="#Get-Git"> &para;</a></span></h3>
126
-
127
- <p>You can get Git from <a class="url" href="http://git-scm.com/">http://git-scm.com/</a>
128
- Most distribution and operating system provide a package for it.
129
- </p>
130
-
131
- </div>
132
- <div class="section-level-extent" id="Cloning-the-source-tree">
133
- <h3 class="section"><span>2.2 Cloning the source tree<a class="copiable-link" href="#Cloning-the-source-tree"> &para;</a></span></h3>
134
-
135
- <div class="example">
136
- <pre class="example-preformatted">git clone https://git.ffmpeg.org/ffmpeg.git &lt;target&gt;
137
- </pre></div>
138
-
139
- <p>This will put the FFmpeg sources into the directory <var class="var">&lt;target&gt;</var>.
140
- </p>
141
- <div class="example">
142
- <pre class="example-preformatted">git clone [email protected]:ffmpeg &lt;target&gt;
143
- </pre></div>
144
-
145
- <p>This will put the FFmpeg sources into the directory <var class="var">&lt;target&gt;</var> and let
146
- you push back your changes to the remote repository.
147
- </p>
148
- <div class="example">
149
- <pre class="example-preformatted">git clone [email protected]:ffmpeg-web &lt;target&gt;
150
- </pre></div>
151
-
152
- <p>This will put the source of the FFmpeg website into the directory
153
- <var class="var">&lt;target&gt;</var> and let you push back your changes to the remote repository.
154
- </p>
155
- <p>If you don&rsquo;t have write-access to the ffmpeg-web repository, you can
156
- create patches after making a read-only ffmpeg-web clone:
157
- </p>
158
- <div class="example">
159
- <pre class="example-preformatted">git clone git://ffmpeg.org/ffmpeg-web &lt;target&gt;
160
- </pre></div>
161
-
162
- <p>Make sure that you do not have Windows line endings in your checkouts,
163
- otherwise you may experience spurious compilation failures. One way to
164
- achieve this is to run
165
- </p>
166
- <div class="example">
167
- <pre class="example-preformatted">git config --global core.autocrlf false
168
- </pre></div>
169
-
170
-
171
- <a class="anchor" id="Updating-the-source-tree-to-the-latest-revision"></a></div>
172
- <div class="section-level-extent" id="Updating-the-source-tree-to-the-latest-revision-1">
173
- <h3 class="section"><span>2.3 Updating the source tree to the latest revision<a class="copiable-link" href="#Updating-the-source-tree-to-the-latest-revision-1"> &para;</a></span></h3>
174
-
175
- <div class="example">
176
- <pre class="example-preformatted">git pull (--rebase)
177
- </pre></div>
178
-
179
- <p>pulls in the latest changes from the tracked branch. The tracked branch
180
- can be remote. By default the master branch tracks the branch master in
181
- the remote origin.
182
- </p>
183
- <div class="warning">
184
- <p><code class="command">--rebase</code> (see below) is recommended.
185
- </p></div>
186
- </div>
187
- <div class="section-level-extent" id="Rebasing-your-local-branches">
188
- <h3 class="section"><span>2.4 Rebasing your local branches<a class="copiable-link" href="#Rebasing-your-local-branches"> &para;</a></span></h3>
189
-
190
- <div class="example">
191
- <pre class="example-preformatted">git pull --rebase
192
- </pre></div>
193
-
194
- <p>fetches the changes from the main repository and replays your local commits
195
- over it. This is required to keep all your local changes at the top of
196
- FFmpeg&rsquo;s master tree. The master tree will reject pushes with merge commits.
197
- </p>
198
-
199
- </div>
200
- <div class="section-level-extent" id="Adding_002fremoving-files_002fdirectories">
201
- <h3 class="section"><span>2.5 Adding/removing files/directories<a class="copiable-link" href="#Adding_002fremoving-files_002fdirectories"> &para;</a></span></h3>
202
-
203
- <div class="example">
204
- <pre class="example-preformatted">git add [-A] &lt;filename/dirname&gt;
205
- git rm [-r] &lt;filename/dirname&gt;
206
- </pre></div>
207
-
208
- <p>Git needs to get notified of all changes you make to your working
209
- directory that makes files appear or disappear.
210
- Line moves across files are automatically tracked.
211
- </p>
212
-
213
- </div>
214
- <div class="section-level-extent" id="Showing-modifications">
215
- <h3 class="section"><span>2.6 Showing modifications<a class="copiable-link" href="#Showing-modifications"> &para;</a></span></h3>
216
-
217
- <div class="example">
218
- <pre class="example-preformatted">git diff &lt;filename(s)&gt;
219
- </pre></div>
220
-
221
- <p>will show all local modifications in your working directory as unified diff.
222
- </p>
223
-
224
- </div>
225
- <div class="section-level-extent" id="Inspecting-the-changelog">
226
- <h3 class="section"><span>2.7 Inspecting the changelog<a class="copiable-link" href="#Inspecting-the-changelog"> &para;</a></span></h3>
227
-
228
- <div class="example">
229
- <pre class="example-preformatted">git log &lt;filename(s)&gt;
230
- </pre></div>
231
-
232
- <p>You may also use the graphical tools like <code class="command">gitview</code> or <code class="command">gitk</code>
233
- or the web interface available at <a class="url" href="http://source.ffmpeg.org/">http://source.ffmpeg.org/</a>.
234
- </p>
235
- </div>
236
- <div class="section-level-extent" id="Checking-source-tree-status">
237
- <h3 class="section"><span>2.8 Checking source tree status<a class="copiable-link" href="#Checking-source-tree-status"> &para;</a></span></h3>
238
-
239
- <div class="example">
240
- <pre class="example-preformatted">git status
241
- </pre></div>
242
-
243
- <p>detects all the changes you made and lists what actions will be taken in case
244
- of a commit (additions, modifications, deletions, etc.).
245
- </p>
246
-
247
- </div>
248
- <div class="section-level-extent" id="Committing">
249
- <h3 class="section"><span>2.9 Committing<a class="copiable-link" href="#Committing"> &para;</a></span></h3>
250
-
251
- <div class="example">
252
- <pre class="example-preformatted">git diff --check
253
- </pre></div>
254
-
255
- <p>to double check your changes before committing them to avoid trouble later
256
- on. All experienced developers do this on each and every commit, no matter
257
- how small.
258
- </p>
259
- <p>Every one of them has been saved from looking like a fool by this many times.
260
- It&rsquo;s very easy for stray debug output or cosmetic modifications to slip in,
261
- please avoid problems through this extra level of scrutiny.
262
- </p>
263
- <p>For cosmetics-only commits you should get (almost) empty output from
264
- </p>
265
- <div class="example">
266
- <pre class="example-preformatted">git diff -w -b &lt;filename(s)&gt;
267
- </pre></div>
268
-
269
- <p>Also check the output of
270
- </p>
271
- <div class="example">
272
- <pre class="example-preformatted">git status
273
- </pre></div>
274
-
275
- <p>to make sure you don&rsquo;t have untracked files or deletions.
276
- </p>
277
- <div class="example">
278
- <pre class="example-preformatted">git add [-i|-p|-A] &lt;filenames/dirnames&gt;
279
- </pre></div>
280
-
281
- <p>Make sure you have told Git your name, email address and GPG key
282
- </p>
283
- <div class="example">
284
- <pre class="example-preformatted">git config --global user.name &quot;My Name&quot;
285
- git config --global user.email [email protected]
286
- git config --global user.signingkey ABCDEF0123245
287
- </pre></div>
288
-
289
- <p>Enable signing all commits or use -S
290
- </p>
291
- <div class="example">
292
- <pre class="example-preformatted">git config --global commit.gpgsign true
293
- </pre></div>
294
-
295
- <p>Use <samp class="option">--global</samp> to set the global configuration for all your Git checkouts.
296
- </p>
297
- <p>Git will select the changes to the files for commit. Optionally you can use
298
- the interactive or the patch mode to select hunk by hunk what should be
299
- added to the commit.
300
- </p>
301
-
302
- <div class="example">
303
- <pre class="example-preformatted">git commit
304
- </pre></div>
305
-
306
- <p>Git will commit the selected changes to your current local branch.
307
- </p>
308
- <p>You will be prompted for a log message in an editor, which is either
309
- set in your personal configuration file through
310
- </p>
311
- <div class="example">
312
- <pre class="example-preformatted">git config --global core.editor
313
- </pre></div>
314
-
315
- <p>or set by one of the following environment variables:
316
- <var class="var">GIT_EDITOR</var>, <var class="var">VISUAL</var> or <var class="var">EDITOR</var>.
317
- </p>
318
- </div>
319
- <div class="section-level-extent" id="Writing-a-commit-message">
320
- <h3 class="section"><span>2.10 Writing a commit message<a class="copiable-link" href="#Writing-a-commit-message"> &para;</a></span></h3>
321
-
322
- <p>Log messages should be concise but descriptive.
323
- </p>
324
- <p>The first line must contain the context, a colon and a very short
325
- summary of what the commit does. Details can be added, if necessary,
326
- separated by an empty line. These details should not exceed 60-72 characters
327
- per line, except when containing code.
328
- </p>
329
- <p>Example of a good commit message:
330
- </p>
331
- <div class="example">
332
- <pre class="example-preformatted">avcodec/cbs: add a helper to read extradata within packet side data
333
-
334
- Using ff_cbs_read() on the raw buffer will not parse it as extradata,
335
- resulting in parsing errors for example when handling ISOBMFF avcC.
336
- This helper works around that.
337
- </pre></div>
338
-
339
- <div class="example">
340
- <pre class="example-preformatted">ptr might be NULL
341
- </pre></div>
342
-
343
- <p>If the summary on the first line is not enough, in the body of the message,
344
- explain why you made a change, what you did will be obvious from the changes
345
- themselves most of the time. Saying just &quot;bug fix&quot; or &quot;10l&quot; is bad. Remember
346
- that people of varying skill levels look at and educate themselves while
347
- reading through your code. Don&rsquo;t include filenames in log messages except in
348
- the context, Git provides that information.
349
- </p>
350
- <p>If the commit fixes a registered issue, state it in a separate line of the
351
- body: <code class="code">Fix Trac ticket #42.</code>
352
- </p>
353
- <p>The first line will be used to name
354
- the patch by <code class="command">git format-patch</code>.
355
- </p>
356
- <p>Common mistakes for the first line, as seen in <code class="command">git log --oneline</code>
357
- include: missing context at the beginning; description of what the code did
358
- before the patch; line too long or wrapped to the second line.
359
- </p>
360
- </div>
361
- <div class="section-level-extent" id="Preparing-a-patchset">
362
- <h3 class="section"><span>2.11 Preparing a patchset<a class="copiable-link" href="#Preparing-a-patchset"> &para;</a></span></h3>
363
-
364
- <div class="example">
365
- <pre class="example-preformatted">git format-patch &lt;commit&gt; [-o directory]
366
- </pre></div>
367
-
368
- <p>will generate a set of patches for each commit between <var class="var">&lt;commit&gt;</var> and
369
- current <var class="var">HEAD</var>. E.g.
370
- </p>
371
- <div class="example">
372
- <pre class="example-preformatted">git format-patch origin/master
373
- </pre></div>
374
-
375
- <p>will generate patches for all commits on current branch which are not
376
- present in upstream.
377
- A useful shortcut is also
378
- </p>
379
- <div class="example">
380
- <pre class="example-preformatted">git format-patch -n
381
- </pre></div>
382
-
383
- <p>which will generate patches from last <var class="var">n</var> commits.
384
- By default the patches are created in the current directory.
385
- </p>
386
- </div>
387
- <div class="section-level-extent" id="Sending-patches-for-review">
388
- <h3 class="section"><span>2.12 Sending patches for review<a class="copiable-link" href="#Sending-patches-for-review"> &para;</a></span></h3>
389
-
390
- <div class="example">
391
- <pre class="example-preformatted">git send-email &lt;commit list|directory&gt;
392
- </pre></div>
393
-
394
- <p>will send the patches created by <code class="command">git format-patch</code> or directly
395
- generates them. All the email fields can be configured in the global/local
396
- configuration or overridden by command line.
397
- Note that this tool must often be installed separately (e.g. <var class="var">git-email</var>
398
- package on Debian-based distros).
399
- </p>
400
-
401
- </div>
402
- <div class="section-level-extent" id="Renaming_002fmoving_002fcopying-files-or-contents-of-files">
403
- <h3 class="section"><span>2.13 Renaming/moving/copying files or contents of files<a class="copiable-link" href="#Renaming_002fmoving_002fcopying-files-or-contents-of-files"> &para;</a></span></h3>
404
-
405
- <p>Git automatically tracks such changes, making those normal commits.
406
- </p>
407
- <div class="example">
408
- <pre class="example-preformatted">mv/cp path/file otherpath/otherfile
409
- git add [-A] .
410
- git commit
411
- </pre></div>
412
-
413
-
414
- </div>
415
- </div>
416
- <div class="chapter-level-extent" id="Git-configuration">
417
- <h2 class="chapter"><span>3 Git configuration<a class="copiable-link" href="#Git-configuration"> &para;</a></span></h2>
418
-
419
- <p>In order to simplify a few workflows, it is advisable to configure both
420
- your personal Git installation and your local FFmpeg repository.
421
- </p>
422
- <ul class="mini-toc">
423
- <li><a href="#Personal-Git-installation" accesskey="1">Personal Git installation</a></li>
424
- <li><a href="#Repository-configuration" accesskey="2">Repository configuration</a></li>
425
- </ul>
426
- <div class="section-level-extent" id="Personal-Git-installation">
427
- <h3 class="section"><span>3.1 Personal Git installation<a class="copiable-link" href="#Personal-Git-installation"> &para;</a></span></h3>
428
-
429
- <p>Add the following to your <samp class="file">~/.gitconfig</samp> to help <code class="command">git send-email</code>
430
- and <code class="command">git format-patch</code> detect renames:
431
- </p>
432
- <div class="example">
433
- <pre class="example-preformatted">[diff]
434
- renames = copy
435
- </pre></div>
436
-
437
- </div>
438
- <div class="section-level-extent" id="Repository-configuration">
439
- <h3 class="section"><span>3.2 Repository configuration<a class="copiable-link" href="#Repository-configuration"> &para;</a></span></h3>
440
-
441
- <p>In order to have <code class="command">git send-email</code> automatically send patches
442
- to the ffmpeg-devel mailing list, add the following stanza
443
- to <samp class="file">/path/to/ffmpeg/repository/.git/config</samp>:
444
- </p>
445
- <div class="example">
446
- <pre class="example-preformatted">[sendemail]
447
448
- </pre></div>
449
-
450
- </div>
451
- </div>
452
- <div class="chapter-level-extent" id="FFmpeg-specific">
453
- <h2 class="chapter"><span>4 FFmpeg specific<a class="copiable-link" href="#FFmpeg-specific"> &para;</a></span></h2>
454
-
455
- <ul class="mini-toc">
456
- <li><a href="#Reverting-broken-commits" accesskey="1">Reverting broken commits</a></li>
457
- <li><a href="#Pushing-changes-to-remote-trees" accesskey="2">Pushing changes to remote trees</a></li>
458
- <li><a href="#Finding-a-specific-svn-revision" accesskey="3">Finding a specific svn revision</a></li>
459
- </ul>
460
- <div class="section-level-extent" id="Reverting-broken-commits">
461
- <h3 class="section"><span>4.1 Reverting broken commits<a class="copiable-link" href="#Reverting-broken-commits"> &para;</a></span></h3>
462
-
463
- <div class="example">
464
- <pre class="example-preformatted">git reset &lt;commit&gt;
465
- </pre></div>
466
-
467
- <p><code class="command">git reset</code> will uncommit the changes till <var class="var">&lt;commit&gt;</var> rewriting
468
- the current branch history.
469
- </p>
470
- <div class="example">
471
- <pre class="example-preformatted">git commit --amend
472
- </pre></div>
473
-
474
- <p>allows one to amend the last commit details quickly.
475
- </p>
476
- <div class="example">
477
- <pre class="example-preformatted">git rebase -i origin/master
478
- </pre></div>
479
-
480
- <p>will replay local commits over the main repository allowing to edit, merge
481
- or remove some of them in the process.
482
- </p>
483
- <div class="info">
484
- <p><code class="command">git reset</code>, <code class="command">git commit --amend</code> and <code class="command">git rebase</code>
485
- rewrite history, so you should use them ONLY on your local or topic branches.
486
- The main repository will reject those changes.
487
- </p></div>
488
- <div class="example">
489
- <pre class="example-preformatted">git revert &lt;commit&gt;
490
- </pre></div>
491
-
492
- <p><code class="command">git revert</code> will generate a revert commit. This will not make the
493
- faulty commit disappear from the history.
494
- </p>
495
- </div>
496
- <div class="section-level-extent" id="Pushing-changes-to-remote-trees">
497
- <h3 class="section"><span>4.2 Pushing changes to remote trees<a class="copiable-link" href="#Pushing-changes-to-remote-trees"> &para;</a></span></h3>
498
-
499
- <div class="example">
500
- <pre class="example-preformatted">git push origin master --dry-run
501
- </pre></div>
502
-
503
- <p>Will simulate a push of the local master branch to the default remote
504
- (<var class="var">origin</var>). And list which branches and ranges or commits would have been
505
- pushed.
506
- Git will prevent you from pushing changes if the local and remote trees are
507
- out of sync. Refer to <a class="ref" href="#Updating-the-source-tree-to-the-latest-revision">Updating the source tree to the latest revision</a>.
508
- </p>
509
- <div class="example">
510
- <pre class="example-preformatted">git remote add &lt;name&gt; &lt;url&gt;
511
- </pre></div>
512
-
513
- <p>Will add additional remote with a name reference, it is useful if you want
514
- to push your local branch for review on a remote host.
515
- </p>
516
- <div class="example">
517
- <pre class="example-preformatted">git push &lt;remote&gt; &lt;refspec&gt;
518
- </pre></div>
519
-
520
- <p>Will push the changes to the <var class="var">&lt;remote&gt;</var> repository.
521
- Omitting <var class="var">&lt;refspec&gt;</var> makes <code class="command">git push</code> update all the remote
522
- branches matching the local ones.
523
- </p>
524
- </div>
525
- <div class="section-level-extent" id="Finding-a-specific-svn-revision">
526
- <h3 class="section"><span>4.3 Finding a specific svn revision<a class="copiable-link" href="#Finding-a-specific-svn-revision"> &para;</a></span></h3>
527
-
528
- <p>Since version 1.7.1 Git supports &lsquo;<samp class="samp">:/foo</samp>&rsquo; syntax for specifying commits
529
- based on a regular expression. see man gitrevisions
530
- </p>
531
- <div class="example">
532
- <pre class="example-preformatted">git show :/'as revision 23456'
533
- </pre></div>
534
-
535
- <p>will show the svn changeset &lsquo;<samp class="samp">r23456</samp>&rsquo;. With older Git versions searching in
536
- the <code class="command">git log</code> output is the easiest option (especially if a pager with
537
- search capabilities is used).
538
- </p>
539
- <p>This commit can be checked out with
540
- </p>
541
- <div class="example">
542
- <pre class="example-preformatted">git checkout -b svn_23456 :/'as revision 23456'
543
- </pre></div>
544
-
545
- <p>or for Git &lt; 1.7.1 with
546
- </p>
547
- <div class="example">
548
- <pre class="example-preformatted">git checkout -b svn_23456 $SHA1
549
- </pre></div>
550
-
551
- <p>where <var class="var">$SHA1</var> is the commit hash from the <code class="command">git log</code> output.
552
- </p>
553
-
554
- </div>
555
- </div>
556
- <div class="chapter-level-extent" id="gpg-key-generation">
557
- <h2 class="chapter"><span>5 gpg key generation<a class="copiable-link" href="#gpg-key-generation"> &para;</a></span></h2>
558
-
559
- <p>If you have no gpg key yet, we recommend that you create a ed25519 based key as it
560
- is small, fast and secure. Especially it results in small signatures in git.
561
- </p>
562
- <div class="example">
563
- <pre class="example-preformatted">gpg --default-new-key-algo &quot;ed25519/cert,sign+cv25519/encr&quot; --quick-generate-key &quot;[email protected]&quot;
564
- </pre></div>
565
-
566
- <p>When generating a key, make sure the email specified matches the email used in git as some sites like
567
- github consider mismatches a reason to declare such commits unverified. After generating a key you
568
- can add it to the MAINTAINER file and upload it to a keyserver.
569
- </p>
570
- </div>
571
- <div class="chapter-level-extent" id="Pre_002dpush-checklist">
572
- <h2 class="chapter"><span>6 Pre-push checklist<a class="copiable-link" href="#Pre_002dpush-checklist"> &para;</a></span></h2>
573
-
574
- <p>Once you have a set of commits that you feel are ready for pushing,
575
- work through the following checklist to doublecheck everything is in
576
- proper order. This list tries to be exhaustive. In case you are just
577
- pushing a typo in a comment, some of the steps may be unnecessary.
578
- Apply your common sense, but if in doubt, err on the side of caution.
579
- </p>
580
- <p>First, make sure that the commits and branches you are going to push
581
- match what you want pushed and that nothing is missing, extraneous or
582
- wrong. You can see what will be pushed by running the git push command
583
- with <samp class="option">--dry-run</samp> first. And then inspecting the commits listed with
584
- <code class="command">git log -p 1234567..987654</code>. The <code class="command">git status</code> command
585
- may help in finding local changes that have been forgotten to be added.
586
- </p>
587
- <p>Next let the code pass through a full run of our test suite.
588
- </p>
589
- <ul class="itemize mark-bullet">
590
- <li><code class="command">make distclean</code>
591
- </li><li><code class="command">/path/to/ffmpeg/configure</code>
592
- </li><li><code class="command">make fate</code>
593
- </li><li>if fate fails due to missing samples run <code class="command">make fate-rsync</code> and retry
594
- </li></ul>
595
-
596
- <p>Make sure all your changes have been checked before pushing them, the
597
- test suite only checks against regressions and that only to some extend. It does
598
- obviously not check newly added features/code to be working unless you have
599
- added a test for that (which is recommended).
600
- </p>
601
- <p>Also note that every single commit should pass the test suite, not just
602
- the result of a series of patches.
603
- </p>
604
- <p>Once everything passed, push the changes to your public ffmpeg clone and post a
605
- merge request to ffmpeg-devel. You can also push them directly but this is not
606
- recommended.
607
- </p>
608
- </div>
609
- <div class="chapter-level-extent" id="Server-Issues">
610
- <h2 class="chapter"><span>7 Server Issues<a class="copiable-link" href="#Server-Issues"> &para;</a></span></h2>
611
-
612
- <p>Contact the project admins at <a class="email" href="mailto:[email protected]">[email protected]</a> if you have technical
613
- problems with the Git server.
614
- </p></div>
615
- </div>
616
- <p style="font-size: small;">
617
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
618
- </p>
619
- </div>
620
- </body>
621
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libavcodec.html DELETED
@@ -1,83 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libavcodec Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libavcodec Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libavcodec library provides a generic encoding/decoding framework
44
- and contains multiple decoders and encoders for audio, video and
45
- subtitle streams, and several bitstream filters.
46
- </p>
47
- <p>The shared architecture provides various services ranging from bit
48
- stream I/O to DSP optimizations, and makes it suitable for
49
- implementing robust and fast codecs as well as for experimentation.
50
- </p>
51
-
52
- </div>
53
- <div class="chapter-level-extent" id="See-Also">
54
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
55
-
56
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
57
- <a class="url" href="ffmpeg-codecs.html">ffmpeg-codecs</a>, <a class="url" href="ffmpeg-bitstream-filters.html">bitstream-filters</a>,
58
- <a class="url" href="libavutil.html">libavutil</a>
59
- </p>
60
-
61
- </div>
62
- <div class="chapter-level-extent" id="Authors">
63
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
64
-
65
- <p>The FFmpeg developers.
66
- </p>
67
- <p>For details about the authorship, see the Git history of the project
68
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
69
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
70
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
71
- </p>
72
- <p>Maintainers for the specific components are listed in the file
73
- <samp class="file">MAINTAINERS</samp> in the source code tree.
74
- </p>
75
-
76
- </div>
77
- </div>
78
- <p style="font-size: small;">
79
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
80
- </p>
81
- </div>
82
- </body>
83
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libavdevice.html DELETED
@@ -1,80 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libavdevice Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libavdevice Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libavdevice library provides a generic framework for grabbing from
44
- and rendering to many common multimedia input/output devices, and
45
- supports several input and output devices, including Video4Linux2,
46
- VfW, DShow, and ALSA.
47
- </p>
48
-
49
- </div>
50
- <div class="chapter-level-extent" id="See-Also">
51
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
52
-
53
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
54
- <a class="url" href="ffmpeg-devices.html">ffmpeg-devices</a>,
55
- <a class="url" href="libavutil.html">libavutil</a>, <a class="url" href="libavcodec.html">libavcodec</a>, <a class="url" href="libavformat.html">libavformat</a>
56
- </p>
57
-
58
- </div>
59
- <div class="chapter-level-extent" id="Authors">
60
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
61
-
62
- <p>The FFmpeg developers.
63
- </p>
64
- <p>For details about the authorship, see the Git history of the project
65
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
66
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
67
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
68
- </p>
69
- <p>Maintainers for the specific components are listed in the file
70
- <samp class="file">MAINTAINERS</samp> in the source code tree.
71
- </p>
72
-
73
- </div>
74
- </div>
75
- <p style="font-size: small;">
76
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
77
- </p>
78
- </div>
79
- </body>
80
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libavfilter.html DELETED
@@ -1,79 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libavfilter Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libavfilter Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libavfilter library provides a generic audio/video filtering
44
- framework containing several filters, sources and sinks.
45
- </p>
46
-
47
- </div>
48
- <div class="chapter-level-extent" id="See-Also">
49
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
50
-
51
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
52
- <a class="url" href="ffmpeg-filters.html">ffmpeg-filters</a>,
53
- <a class="url" href="libavutil.html">libavutil</a>, <a class="url" href="libswscale.html">libswscale</a>, <a class="url" href="libswresample.html">libswresample</a>,
54
- <a class="url" href="libavcodec.html">libavcodec</a>, <a class="url" href="libavformat.html">libavformat</a>, <a class="url" href="libavdevice.html">libavdevice</a>
55
- </p>
56
-
57
- </div>
58
- <div class="chapter-level-extent" id="Authors">
59
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
60
-
61
- <p>The FFmpeg developers.
62
- </p>
63
- <p>For details about the authorship, see the Git history of the project
64
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
65
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
66
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
67
- </p>
68
- <p>Maintainers for the specific components are listed in the file
69
- <samp class="file">MAINTAINERS</samp> in the source code tree.
70
- </p>
71
-
72
- </div>
73
- </div>
74
- <p style="font-size: small;">
75
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
76
- </p>
77
- </div>
78
- </body>
79
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libavformat.html DELETED
@@ -1,83 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libavformat Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libavformat Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libavformat library provides a generic framework for multiplexing
44
- and demultiplexing (muxing and demuxing) audio, video and subtitle
45
- streams. It encompasses multiple muxers and demuxers for multimedia
46
- container formats.
47
- </p>
48
- <p>It also supports several input and output protocols to access a media
49
- resource.
50
- </p>
51
-
52
- </div>
53
- <div class="chapter-level-extent" id="See-Also">
54
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
55
-
56
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
57
- <a class="url" href="ffmpeg-formats.html">ffmpeg-formats</a>, <a class="url" href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
58
- <a class="url" href="libavutil.html">libavutil</a>, <a class="url" href="libavcodec.html">libavcodec</a>
59
- </p>
60
-
61
- </div>
62
- <div class="chapter-level-extent" id="Authors">
63
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
64
-
65
- <p>The FFmpeg developers.
66
- </p>
67
- <p>For details about the authorship, see the Git history of the project
68
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
69
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
70
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
71
- </p>
72
- <p>Maintainers for the specific components are listed in the file
73
- <samp class="file">MAINTAINERS</samp> in the source code tree.
74
- </p>
75
-
76
- </div>
77
- </div>
78
- <p style="font-size: small;">
79
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
80
- </p>
81
- </div>
82
- </body>
83
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libavutil.html DELETED
@@ -1,102 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libavutil Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libavutil Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libavutil library is a utility library to aid portable
44
- multimedia programming. It contains safe portable string functions,
45
- random number generators, data structures, additional mathematics
46
- functions, cryptography and multimedia related functionality (like
47
- enumerations for pixel and sample formats). It is not a library for
48
- code needed by both libavcodec and libavformat.
49
- </p>
50
- <p>The goals for this library is to be:
51
- </p>
52
- <dl class="table">
53
- <dt><strong class="strong">Modular</strong></dt>
54
- <dd><p>It should have few interdependencies and the possibility of disabling individual
55
- parts during <code class="command">./configure</code>.
56
- </p>
57
- </dd>
58
- <dt><strong class="strong">Small</strong></dt>
59
- <dd><p>Both sources and objects should be small.
60
- </p>
61
- </dd>
62
- <dt><strong class="strong">Efficient</strong></dt>
63
- <dd><p>It should have low CPU and memory usage.
64
- </p>
65
- </dd>
66
- <dt><strong class="strong">Useful</strong></dt>
67
- <dd><p>It should avoid useless features that almost no one needs.
68
- </p></dd>
69
- </dl>
70
-
71
-
72
- </div>
73
- <div class="chapter-level-extent" id="See-Also">
74
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
75
-
76
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
77
- <a class="url" href="ffmpeg-utils.html">ffmpeg-utils</a>
78
- </p>
79
-
80
- </div>
81
- <div class="chapter-level-extent" id="Authors">
82
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
83
-
84
- <p>The FFmpeg developers.
85
- </p>
86
- <p>For details about the authorship, see the Git history of the project
87
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
88
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
89
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
90
- </p>
91
- <p>Maintainers for the specific components are listed in the file
92
- <samp class="file">MAINTAINERS</samp> in the source code tree.
93
- </p>
94
-
95
- </div>
96
- </div>
97
- <p style="font-size: small;">
98
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
99
- </p>
100
- </div>
101
- </body>
102
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libswresample.html DELETED
@@ -1,102 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libswresample Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libswresample Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libswresample library performs highly optimized audio resampling,
44
- rematrixing and sample format conversion operations.
45
- </p>
46
- <p>Specifically, this library performs the following conversions:
47
- </p>
48
- <ul class="itemize mark-bullet">
49
- <li><em class="emph">Resampling</em>: is the process of changing the audio rate, for
50
- example from a high sample rate of 44100Hz to 8000Hz. Audio
51
- conversion from high to low sample rate is a lossy process. Several
52
- resampling options and algorithms are available.
53
-
54
- </li><li><em class="emph">Format conversion</em>: is the process of converting the type of
55
- samples, for example from 16-bit signed samples to unsigned 8-bit or
56
- float samples. It also handles packing conversion, when passing from
57
- packed layout (all samples belonging to distinct channels interleaved
58
- in the same buffer), to planar layout (all samples belonging to the
59
- same channel stored in a dedicated buffer or &quot;plane&quot;).
60
-
61
- </li><li><em class="emph">Rematrixing</em>: is the process of changing the channel layout, for
62
- example from stereo to mono. When the input channels cannot be mapped
63
- to the output streams, the process is lossy, since it involves
64
- different gain factors and mixing.
65
- </li></ul>
66
-
67
- <p>Various other audio conversions (e.g. stretching and padding) are
68
- enabled through dedicated options.
69
- </p>
70
-
71
- </div>
72
- <div class="chapter-level-extent" id="See-Also">
73
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
74
-
75
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
76
- <a class="url" href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
77
- <a class="url" href="libavutil.html">libavutil</a>
78
- </p>
79
-
80
- </div>
81
- <div class="chapter-level-extent" id="Authors">
82
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
83
-
84
- <p>The FFmpeg developers.
85
- </p>
86
- <p>For details about the authorship, see the Git history of the project
87
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
88
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
89
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
90
- </p>
91
- <p>Maintainers for the specific components are listed in the file
92
- <samp class="file">MAINTAINERS</samp> in the source code tree.
93
- </p>
94
-
95
- </div>
96
- </div>
97
- <p style="font-size: small;">
98
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
99
- </p>
100
- </div>
101
- </body>
102
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/libswscale.html DELETED
@@ -1,96 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Libswscale Documentation
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Libswscale Documentation
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
29
- <li><a id="toc-See-Also" href="#See-Also">2 See Also</a></li>
30
- <li><a id="toc-Authors" href="#Authors">3 Authors</a></li>
31
- </ul>
32
- </div>
33
- </div>
34
-
35
- <ul class="mini-toc">
36
- <li><a href="#Description" accesskey="1">Description</a></li>
37
- <li><a href="#See-Also" accesskey="2">See Also</a></li>
38
- <li><a href="#Authors" accesskey="3">Authors</a></li>
39
- </ul>
40
- <div class="chapter-level-extent" id="Description">
41
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
42
-
43
- <p>The libswscale library performs highly optimized image scaling and
44
- colorspace and pixel format conversion operations.
45
- </p>
46
- <p>Specifically, this library performs the following conversions:
47
- </p>
48
- <ul class="itemize mark-bullet">
49
- <li><em class="emph">Rescaling</em>: is the process of changing the video size. Several
50
- rescaling options and algorithms are available. This is usually a
51
- lossy process.
52
-
53
- </li><li><em class="emph">Pixel format conversion</em>: is the process of converting the image
54
- format and colorspace of the image, for example from planar YUV420P to
55
- RGB24 packed. It also handles packing conversion, that is converts
56
- from packed layout (all pixels belonging to distinct planes
57
- interleaved in the same buffer), to planar layout (all samples
58
- belonging to the same plane stored in a dedicated buffer or &quot;plane&quot;).
59
-
60
- <p>This is usually a lossy process in case the source and destination
61
- colorspaces differ.
62
- </p></li></ul>
63
-
64
-
65
- </div>
66
- <div class="chapter-level-extent" id="See-Also">
67
- <h2 class="chapter"><span>2 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
68
-
69
- <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
70
- <a class="url" href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
71
- <a class="url" href="libavutil.html">libavutil</a>
72
- </p>
73
-
74
- </div>
75
- <div class="chapter-level-extent" id="Authors">
76
- <h2 class="chapter"><span>3 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
77
-
78
- <p>The FFmpeg developers.
79
- </p>
80
- <p>For details about the authorship, see the Git history of the project
81
- (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
82
- <code class="command">git log</code> in the FFmpeg source directory, or browsing the
83
- online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
84
- </p>
85
- <p>Maintainers for the specific components are listed in the file
86
- <samp class="file">MAINTAINERS</samp> in the source code tree.
87
- </p>
88
-
89
- </div>
90
- </div>
91
- <p style="font-size: small;">
92
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
93
- </p>
94
- </div>
95
- </body>
96
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/mailing-list-faq.html DELETED
@@ -1,522 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- FFmpeg Mailing List FAQ
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- FFmpeg Mailing List FAQ
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-General-Questions" href="#General-Questions">1 General Questions</a>
29
- <ul class="toc-numbered-mark">
30
- <li><a id="toc-What-is-a-mailing-list_003f" href="#What-is-a-mailing-list_003f">1.1 What is a mailing list?</a></li>
31
- <li><a id="toc-What-type-of-questions-can-I-ask_003f" href="#What-type-of-questions-can-I-ask_003f">1.2 What type of questions can I ask?</a></li>
32
- <li><a id="toc-How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f-1" href="#How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f-1">1.3 How do I ask a question or send a message to a mailing list?</a></li>
33
- </ul></li>
34
- <li><a id="toc-Subscribing-_002f-Unsubscribing" href="#Subscribing-_002f-Unsubscribing">2 Subscribing / Unsubscribing</a>
35
- <ul class="toc-numbered-mark">
36
- <li><a id="toc-How-do-I-subscribe_003f-1" href="#How-do-I-subscribe_003f-1">2.1 How do I subscribe?</a></li>
37
- <li><a id="toc-How-do-I-unsubscribe_003f" href="#How-do-I-unsubscribe_003f">2.2 How do I unsubscribe?</a></li>
38
- </ul></li>
39
- <li><a id="toc-Moderation-Queue" href="#Moderation-Queue">3 Moderation Queue</a>
40
- <ul class="toc-numbered-mark">
41
- <li><a id="toc-Why-is-my-message-awaiting-moderator-approval_003f-1" href="#Why-is-my-message-awaiting-moderator-approval_003f-1">3.1 Why is my message awaiting moderator approval?</a></li>
42
- <li><a id="toc-How-long-does-it-take-for-my-message-in-the-moderation-queue-to-be-approved_003f" href="#How-long-does-it-take-for-my-message-in-the-moderation-queue-to-be-approved_003f">3.2 How long does it take for my message in the moderation queue to be approved?</a></li>
43
- <li><a id="toc-How-do-I-delete-my-message-in-the-moderation-queue_003f-1" href="#How-do-I-delete-my-message-in-the-moderation-queue_003f-1">3.3 How do I delete my message in the moderation queue?</a></li>
44
- </ul></li>
45
- <li><a id="toc-Archives" href="#Archives">4 Archives</a>
46
- <ul class="toc-numbered-mark">
47
- <li><a id="toc-Where-are-the-archives_003f-1" href="#Where-are-the-archives_003f-1">4.1 Where are the archives?</a></li>
48
- <li><a id="toc-How-do-I-reply-to-a-message-in-the-archives_003f" href="#How-do-I-reply-to-a-message-in-the-archives_003f">4.2 How do I reply to a message in the archives?</a></li>
49
- <li><a id="toc-How-do-I-search-the-archives_003f" href="#How-do-I-search-the-archives_003f">4.3 How do I search the archives?</a></li>
50
- </ul></li>
51
- <li><a id="toc-Other" href="#Other">5 Other</a>
52
- <ul class="toc-numbered-mark">
53
- <li><a id="toc-Is-there-an-alternative-to-the-mailing-list_003f" href="#Is-there-an-alternative-to-the-mailing-list_003f">5.1 Is there an alternative to the mailing list?</a></li>
54
- <li><a id="toc-What-is-top_002dposting_003f-1" href="#What-is-top_002dposting_003f-1">5.2 What is top-posting?</a></li>
55
- <li><a id="toc-What-is-the-message-size-limit_003f-1" href="#What-is-the-message-size-limit_003f-1">5.3 What is the message size limit?</a></li>
56
- <li><a id="toc-Where-can-I-upload-sample-files_003f" href="#Where-can-I-upload-sample-files_003f">5.4 Where can I upload sample files?</a></li>
57
- <li><a id="toc-Will-I-receive-spam-if-I-send-and_002for-subscribe-to-a-mailing-list_003f" href="#Will-I-receive-spam-if-I-send-and_002for-subscribe-to-a-mailing-list_003f">5.5 Will I receive spam if I send and/or subscribe to a mailing list?</a></li>
58
- <li><a id="toc-How-do-I-filter-mailing-list-messages_003f" href="#How-do-I-filter-mailing-list-messages_003f">5.6 How do I filter mailing list messages?</a></li>
59
- <li><a id="toc-How-do-I-disable-mail-delivery-without-unsubscribing_003f-1" href="#How-do-I-disable-mail-delivery-without-unsubscribing_003f-1">5.7 How do I disable mail delivery without unsubscribing?</a></li>
60
- <li><a id="toc-Why-is-the-mailing-list-munging-my-address_003f-1" href="#Why-is-the-mailing-list-munging-my-address_003f-1">5.8 Why is the mailing list munging my address?</a></li>
61
- </ul></li>
62
- <li><a id="toc-Rules-and-Etiquette" href="#Rules-and-Etiquette">6 Rules and Etiquette</a>
63
- <ul class="toc-numbered-mark">
64
- <li><a id="toc-What-are-the-rules-and-the-proper-etiquette_003f" href="#What-are-the-rules-and-the-proper-etiquette_003f">6.1 What are the rules and the proper etiquette?</a></li>
65
- </ul></li>
66
- <li><a id="toc-Help" href="#Help">7 Help</a>
67
- <ul class="toc-numbered-mark">
68
- <li><a id="toc-Why-am-I-not-receiving-any-messages_003f" href="#Why-am-I-not-receiving-any-messages_003f">7.1 Why am I not receiving any messages?</a></li>
69
- <li><a id="toc-Why-are-my-sent-messages-not-showing-up_003f" href="#Why-are-my-sent-messages-not-showing-up_003f">7.2 Why are my sent messages not showing up?</a></li>
70
- <li><a id="toc-Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f-1" href="#Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f-1">7.3 Why do I keep getting unsubscribed from ffmpeg-devel?</a></li>
71
- <li><a id="toc-Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f-1" href="#Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f-1">7.4 Who do I contact if I have a problem with the mailing list?</a></li>
72
- </ul></li>
73
- </ul>
74
- </div>
75
- </div>
76
-
77
- <ul class="mini-toc">
78
- <li><a href="#General-Questions" accesskey="1">General Questions</a></li>
79
- <li><a href="#Subscribing-_002f-Unsubscribing" accesskey="2">Subscribing / Unsubscribing</a></li>
80
- <li><a href="#Moderation-Queue" accesskey="3">Moderation Queue</a></li>
81
- <li><a href="#Archives" accesskey="4">Archives</a></li>
82
- <li><a href="#Other" accesskey="5">Other</a></li>
83
- <li><a href="#Rules-and-Etiquette" accesskey="6">Rules and Etiquette</a></li>
84
- <li><a href="#Help" accesskey="7">Help</a></li>
85
- </ul>
86
- <div class="chapter-level-extent" id="General-Questions">
87
- <h2 class="chapter"><span>1 General Questions<a class="copiable-link" href="#General-Questions"> &para;</a></span></h2>
88
-
89
- <ul class="mini-toc">
90
- <li><a href="#What-is-a-mailing-list_003f" accesskey="1">What is a mailing list?</a></li>
91
- <li><a href="#What-type-of-questions-can-I-ask_003f" accesskey="2">What type of questions can I ask?</a></li>
92
- <li><a href="#How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f-1" accesskey="3">How do I ask a question or send a message to a mailing list?</a></li>
93
- </ul>
94
- <div class="section-level-extent" id="What-is-a-mailing-list_003f">
95
- <h3 class="section"><span>1.1 What is a mailing list?<a class="copiable-link" href="#What-is-a-mailing-list_003f"> &para;</a></span></h3>
96
-
97
- <p>A mailing list is not much different than emailing someone, but the
98
- main difference is that your message is received by everyone who
99
- subscribes to the list. It is somewhat like a forum but in email form.
100
- </p>
101
- <p>See the <a class="url" href="https://lists.ffmpeg.org/pipermail/ffmpeg-user/">ffmpeg-user archives</a>
102
- for examples.
103
- </p>
104
- </div>
105
- <div class="section-level-extent" id="What-type-of-questions-can-I-ask_003f">
106
- <h3 class="section"><span>1.2 What type of questions can I ask?<a class="copiable-link" href="#What-type-of-questions-can-I-ask_003f"> &para;</a></span></h3>
107
-
108
- <ul class="itemize mark-bullet">
109
- <li><a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/">ffmpeg-user</a>:
110
- For questions involving unscripted usage or compilation of the FFmpeg
111
- command-line tools (<code class="command">ffmpeg</code>, <code class="command">ffprobe</code>, <code class="command">ffplay</code>).
112
-
113
- </li><li><a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/libav-user/">libav-user</a>:
114
- For questions involving the FFmpeg libav* libraries (libavcodec,
115
- libavformat, libavfilter, etc).
116
-
117
- </li><li><a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-devel/">ffmpeg-devel</a>:
118
- For discussions involving the development of FFmpeg and for submitting
119
- patches. User questions should be asked at ffmpeg-user or libav-user.
120
- </li></ul>
121
-
122
- <p>To report a bug see <a class="url" href="https://ffmpeg.org/bugreports.html">https://ffmpeg.org/bugreports.html</a>.
123
- </p>
124
- <p>We cannot provide help for scripts and/or third-party tools.
125
- </p>
126
- <a class="anchor" id="How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f"></a></div>
127
- <div class="section-level-extent" id="How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f-1">
128
- <h3 class="section"><span>1.3 How do I ask a question or send a message to a mailing list?<a class="copiable-link" href="#How-do-I-ask-a-question-or-send-a-message-to-a-mailing-list_003f-1"> &para;</a></span></h3>
129
-
130
- <p>First you must <a class="ref" href="#How-do-I-subscribe_003f">subscribe</a>. Then all you have to do is
131
- send an email:
132
- </p>
133
- <ul class="itemize mark-bullet">
134
- <li>Email <a class="email" href="mailto:[email protected]">[email protected]</a> to send a message to the
135
- ffmpeg-user mailing list.
136
-
137
- </li><li>Email <a class="email" href="mailto:[email protected]">[email protected]</a> to send a message to the
138
- libav-user mailing list.
139
-
140
- </li><li>Email <a class="email" href="mailto:[email protected]">[email protected]</a> to send a message to the
141
- ffmpeg-devel mailing list.
142
- </li></ul>
143
-
144
- </div>
145
- </div>
146
- <div class="chapter-level-extent" id="Subscribing-_002f-Unsubscribing">
147
- <h2 class="chapter"><span>2 Subscribing / Unsubscribing<a class="copiable-link" href="#Subscribing-_002f-Unsubscribing"> &para;</a></span></h2>
148
-
149
- <a class="anchor" id="How-do-I-subscribe_003f"></a><ul class="mini-toc">
150
- <li><a href="#How-do-I-subscribe_003f-1" accesskey="1">How do I subscribe?</a></li>
151
- <li><a href="#How-do-I-unsubscribe_003f" accesskey="2">How do I unsubscribe?</a></li>
152
- </ul>
153
- <div class="section-level-extent" id="How-do-I-subscribe_003f-1">
154
- <h3 class="section"><span>2.1 How do I subscribe?<a class="copiable-link" href="#How-do-I-subscribe_003f-1"> &para;</a></span></h3>
155
-
156
- <p>Email <a class="email" href="mailto:[email protected]">[email protected]</a> with the subject
157
- <em class="emph">subscribe</em>.
158
- </p>
159
- <p>Or visit the <a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/">ffmpeg-user mailing list info page</a>
160
- and refer to the <em class="emph">Subscribing to ffmpeg-user</em> section.
161
- </p>
162
- <p>The process is the same for the other mailing lists.
163
- </p>
164
- </div>
165
- <div class="section-level-extent" id="How-do-I-unsubscribe_003f">
166
- <h3 class="section"><span>2.2 How do I unsubscribe?<a class="copiable-link" href="#How-do-I-unsubscribe_003f"> &para;</a></span></h3>
167
-
168
- <p>Email <a class="email" href="mailto:[email protected]">[email protected]</a> with subject <em class="emph">unsubscribe</em>.
169
- </p>
170
- <p>Or visit the <a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/">ffmpeg-user mailing list info page</a>,
171
- scroll to bottom of page, enter your email address in the box, and click
172
- the <em class="emph">Unsubscribe or edit options</em> button.
173
- </p>
174
- <p>The process is the same for the other mailing lists.
175
- </p>
176
- <p>Please avoid asking a mailing list admin to unsubscribe you unless you
177
- are absolutely unable to do so by yourself. See <a class="ref" href="#Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f">Who do I contact if I have a problem with the mailing list?</a>
178
- </p>
179
- <p>Note that it is possible to temporarily halt message delivery (vacation mode).
180
- See <a class="ref" href="#How-do-I-disable-mail-delivery-without-unsubscribing_003f">How do I disable mail delivery without unsubscribing?</a>
181
- </p>
182
- </div>
183
- </div>
184
- <div class="chapter-level-extent" id="Moderation-Queue">
185
- <h2 class="chapter"><span>3 Moderation Queue<a class="copiable-link" href="#Moderation-Queue"> &para;</a></span></h2>
186
- <a class="anchor" id="Why-is-my-message-awaiting-moderator-approval_003f"></a><ul class="mini-toc">
187
- <li><a href="#Why-is-my-message-awaiting-moderator-approval_003f-1" accesskey="1">Why is my message awaiting moderator approval?</a></li>
188
- <li><a href="#How-long-does-it-take-for-my-message-in-the-moderation-queue-to-be-approved_003f" accesskey="2">How long does it take for my message in the moderation queue to be approved?</a></li>
189
- <li><a href="#How-do-I-delete-my-message-in-the-moderation-queue_003f-1" accesskey="3">How do I delete my message in the moderation queue?</a></li>
190
- </ul>
191
- <div class="section-level-extent" id="Why-is-my-message-awaiting-moderator-approval_003f-1">
192
- <h3 class="section"><span>3.1 Why is my message awaiting moderator approval?<a class="copiable-link" href="#Why-is-my-message-awaiting-moderator-approval_003f-1"> &para;</a></span></h3>
193
-
194
- <p>Some messages are automatically held in the <em class="emph">moderation queue</em> and
195
- must be manually approved by a mailing list admin:
196
- </p>
197
- <p>These are:
198
- </p>
199
- <ul class="itemize mark-bullet">
200
- <li>Messages that exceed the <a class="ref" href="#What-is-the-message-size-limit_003f">message size limit</a>.
201
-
202
- </li><li>Messages from users whose accounts have been set with the <em class="emph">moderation flag</em>
203
- (very rarely occurs, but may if a user repeatedly ignores the rules
204
- or is abusive towards others).
205
- </li></ul>
206
-
207
- </div>
208
- <div class="section-level-extent" id="How-long-does-it-take-for-my-message-in-the-moderation-queue-to-be-approved_003f">
209
- <h3 class="section"><span>3.2 How long does it take for my message in the moderation queue to be approved?<a class="copiable-link" href="#How-long-does-it-take-for-my-message-in-the-moderation-queue-to-be-approved_003f"> &para;</a></span></h3>
210
-
211
- <p>The queue is not checked on a regular basis. You can ask on the
212
- <code class="t">#ffmpeg-devel</code> IRC channel on Libera Chat for someone to approve your message.
213
- </p>
214
- <a class="anchor" id="How-do-I-delete-my-message-in-the-moderation-queue_003f"></a></div>
215
- <div class="section-level-extent" id="How-do-I-delete-my-message-in-the-moderation-queue_003f-1">
216
- <h3 class="section"><span>3.3 How do I delete my message in the moderation queue?<a class="copiable-link" href="#How-do-I-delete-my-message-in-the-moderation-queue_003f-1"> &para;</a></span></h3>
217
-
218
- <p>You should have received an email with the subject <em class="emph">Your message to &lt;mailing list name&gt; awaits moderator approval</em>.
219
- A link is in the message that will allow you to delete your message
220
- unless a mailing list admin already approved or rejected it.
221
- </p>
222
- </div>
223
- </div>
224
- <div class="chapter-level-extent" id="Archives">
225
- <h2 class="chapter"><span>4 Archives<a class="copiable-link" href="#Archives"> &para;</a></span></h2>
226
-
227
- <a class="anchor" id="Where-are-the-archives_003f"></a><ul class="mini-toc">
228
- <li><a href="#Where-are-the-archives_003f-1" accesskey="1">Where are the archives?</a></li>
229
- <li><a href="#How-do-I-reply-to-a-message-in-the-archives_003f" accesskey="2">How do I reply to a message in the archives?</a></li>
230
- <li><a href="#How-do-I-search-the-archives_003f" accesskey="3">How do I search the archives?</a></li>
231
- </ul>
232
- <div class="section-level-extent" id="Where-are-the-archives_003f-1">
233
- <h3 class="section"><span>4.1 Where are the archives?<a class="copiable-link" href="#Where-are-the-archives_003f-1"> &para;</a></span></h3>
234
-
235
- <p>See the <em class="emph">Archives</em> section on the <a class="url" href="https://ffmpeg.org/contact.html">FFmpeg Contact</a>
236
- page for links to all FFmpeg mailing list archives.
237
- </p>
238
- <p>Note that the archives are split by month. Discussions that span
239
- several months will be split into separate months in the archives.
240
- </p>
241
- </div>
242
- <div class="section-level-extent" id="How-do-I-reply-to-a-message-in-the-archives_003f">
243
- <h3 class="section"><span>4.2 How do I reply to a message in the archives?<a class="copiable-link" href="#How-do-I-reply-to-a-message-in-the-archives_003f"> &para;</a></span></h3>
244
-
245
- <p>Click the email link at the top of the message just under the subject
246
- title. The link will provide the proper headers to keep the message
247
- within the thread.
248
- </p>
249
- <p>Note that you must be subscribed to send a message to the ffmpeg-user or
250
- libav-user mailing lists.
251
- </p>
252
- </div>
253
- <div class="section-level-extent" id="How-do-I-search-the-archives_003f">
254
- <h3 class="section"><span>4.3 How do I search the archives?<a class="copiable-link" href="#How-do-I-search-the-archives_003f"> &para;</a></span></h3>
255
-
256
- <p>Perform a site search using your favorite search engine. Example:
257
- </p>
258
- <p><code class="t">site:lists.ffmpeg.org/pipermail/ffmpeg-user/ &quot;search term&quot;</code>
259
- </p>
260
- </div>
261
- </div>
262
- <div class="chapter-level-extent" id="Other">
263
- <h2 class="chapter"><span>5 Other<a class="copiable-link" href="#Other"> &para;</a></span></h2>
264
-
265
- <ul class="mini-toc">
266
- <li><a href="#Is-there-an-alternative-to-the-mailing-list_003f" accesskey="1">Is there an alternative to the mailing list?</a></li>
267
- <li><a href="#What-is-top_002dposting_003f-1" accesskey="2">What is top-posting?</a></li>
268
- <li><a href="#What-is-the-message-size-limit_003f-1" accesskey="3">What is the message size limit?</a></li>
269
- <li><a href="#Where-can-I-upload-sample-files_003f" accesskey="4">Where can I upload sample files?</a></li>
270
- <li><a href="#Will-I-receive-spam-if-I-send-and_002for-subscribe-to-a-mailing-list_003f" accesskey="5">Will I receive spam if I send and/or subscribe to a mailing list?</a></li>
271
- <li><a href="#How-do-I-filter-mailing-list-messages_003f" accesskey="6">How do I filter mailing list messages?</a></li>
272
- <li><a href="#How-do-I-disable-mail-delivery-without-unsubscribing_003f-1" accesskey="7">How do I disable mail delivery without unsubscribing?</a></li>
273
- <li><a href="#Why-is-the-mailing-list-munging-my-address_003f-1" accesskey="8">Why is the mailing list munging my address?</a></li>
274
- </ul>
275
- <div class="section-level-extent" id="Is-there-an-alternative-to-the-mailing-list_003f">
276
- <h3 class="section"><span>5.1 Is there an alternative to the mailing list?<a class="copiable-link" href="#Is-there-an-alternative-to-the-mailing-list_003f"> &para;</a></span></h3>
277
-
278
- <p>You can ask for help in the official <code class="t">#ffmpeg</code> IRC channel on Libera Chat.
279
- </p>
280
- <p>There are also numerous third-party help sites such as
281
- <a class="url" href="https://superuser.com/tags/ffmpeg">Super User</a> and
282
- <a class="url" href="https://www.reddit.com/r/ffmpeg/">r/ffmpeg on reddit</a>.
283
- </p>
284
- <a class="anchor" id="What-is-top_002dposting_003f"></a></div>
285
- <div class="section-level-extent" id="What-is-top_002dposting_003f-1">
286
- <h3 class="section"><span>5.2 What is top-posting?<a class="copiable-link" href="#What-is-top_002dposting_003f-1"> &para;</a></span></h3>
287
-
288
- <p>See <a class="url" href="https://en.wikipedia.org/wiki/Posting_style#Top-posting">https://en.wikipedia.org/wiki/Posting_style#Top-posting</a>.
289
- </p>
290
- <p>Instead, use trimmed interleaved/inline replies (<a class="url" href="https://lists.ffmpeg.org/pipermail/ffmpeg-user/2017-April/035849.html">example</a>).
291
- </p>
292
- <a class="anchor" id="What-is-the-message-size-limit_003f"></a></div>
293
- <div class="section-level-extent" id="What-is-the-message-size-limit_003f-1">
294
- <h3 class="section"><span>5.3 What is the message size limit?<a class="copiable-link" href="#What-is-the-message-size-limit_003f-1"> &para;</a></span></h3>
295
-
296
- <p>The message size limit is 1000 kilobytes. Please provide links to larger files
297
- instead of attaching them.
298
- </p>
299
- </div>
300
- <div class="section-level-extent" id="Where-can-I-upload-sample-files_003f">
301
- <h3 class="section"><span>5.4 Where can I upload sample files?<a class="copiable-link" href="#Where-can-I-upload-sample-files_003f"> &para;</a></span></h3>
302
-
303
- <p>Anywhere that is not too annoying for us to use.
304
- </p>
305
- <p>Google Drive and Dropbox are acceptable if you need a file host, and
306
- <a class="url" href="https://0x0.st/">0x0.st</a> is good for files under 256 MiB.
307
- </p>
308
- <p>Small, short samples are preferred if possible.
309
- </p>
310
- </div>
311
- <div class="section-level-extent" id="Will-I-receive-spam-if-I-send-and_002for-subscribe-to-a-mailing-list_003f">
312
- <h3 class="section"><span>5.5 Will I receive spam if I send and/or subscribe to a mailing list?<a class="copiable-link" href="#Will-I-receive-spam-if-I-send-and_002for-subscribe-to-a-mailing-list_003f"> &para;</a></span></h3>
313
-
314
- <p>Highly unlikely.
315
- </p>
316
- <ul class="itemize mark-bullet">
317
- <li>The list of subscribed users is not public.
318
-
319
- </li><li>Email addresses in the archives are obfuscated.
320
-
321
- </li><li>Several unique test email accounts were utilized and none have yet
322
- received any spam.
323
- </li></ul>
324
-
325
- <p>However, you may see a spam in the mailing lists on rare occasions:
326
- </p>
327
- <ul class="itemize mark-bullet">
328
- <li>Spam in the moderation queue may be accidentally approved due to human
329
- error.
330
-
331
- </li><li>There have been a few messages from subscribed users who had their own
332
- email addresses hacked and spam messages from (or appearing to be from)
333
- the hacked account were sent to their contacts (a mailing list being a
334
- contact in these cases).
335
-
336
- </li><li>If you are subscribed to the bug tracker mailing list (ffmpeg-trac) you
337
- may see the occasional spam as a false bug report, but we take measures
338
- to try to prevent this.
339
- </li></ul>
340
-
341
- </div>
342
- <div class="section-level-extent" id="How-do-I-filter-mailing-list-messages_003f">
343
- <h3 class="section"><span>5.6 How do I filter mailing list messages?<a class="copiable-link" href="#How-do-I-filter-mailing-list-messages_003f"> &para;</a></span></h3>
344
-
345
- <p>Use the <em class="emph">List-Id</em>. For example, the ffmpeg-user mailing list is
346
- <code class="t">ffmpeg-user.ffmpeg.org</code>. You can view the List-Id in the raw message
347
- or headers.
348
- </p>
349
- <p>You can then filter the mailing list messages to their own folder.
350
- </p>
351
- <a class="anchor" id="How-do-I-disable-mail-delivery-without-unsubscribing_003f"></a></div>
352
- <div class="section-level-extent" id="How-do-I-disable-mail-delivery-without-unsubscribing_003f-1">
353
- <h3 class="section"><span>5.7 How do I disable mail delivery without unsubscribing?<a class="copiable-link" href="#How-do-I-disable-mail-delivery-without-unsubscribing_003f-1"> &para;</a></span></h3>
354
-
355
- <p>Sometimes you may want to temporarily stop receiving all mailing list
356
- messages. This &quot;vacation mode&quot; is simple to do:
357
- </p>
358
- <ol class="enumerate">
359
- <li> Go to the <a class="url" href="https://lists.ffmpeg.org/mailman/listinfo/ffmpeg-user/">ffmpeg-user mailing list info page</a>
360
-
361
- </li><li> Enter your email address in the box at very bottom of the page and click the
362
- <em class="emph">Unsubscribe or edit options</em> box.
363
-
364
- </li><li> Enter your password and click the <em class="emph">Log in</em> button.
365
-
366
- </li><li> Look for the <em class="emph">Mail delivery</em> option. Here you can disable/enable mail
367
- delivery. If you check <em class="emph">Set globally</em> it will apply your choice to all
368
- other FFmpeg mailing lists you are subscribed to.
369
- </li></ol>
370
-
371
- <p>Alternatively, from your subscribed address, send a message to <a class="email" href="mailto:[email protected]">[email protected]</a>
372
- with the subject <em class="emph">set delivery off</em>. To re-enable mail delivery send a
373
- message to <a class="email" href="mailto:[email protected]">[email protected]</a> with the subject
374
- <em class="emph">set delivery on</em>.
375
- </p>
376
- <a class="anchor" id="Why-is-the-mailing-list-munging-my-address_003f"></a></div>
377
- <div class="section-level-extent" id="Why-is-the-mailing-list-munging-my-address_003f-1">
378
- <h3 class="section"><span>5.8 Why is the mailing list munging my address?<a class="copiable-link" href="#Why-is-the-mailing-list-munging-my-address_003f-1"> &para;</a></span></h3>
379
-
380
- <p>This is due to subscribers that use an email service with a DMARC reject policy
381
- which adds difficulties to mailing list operators.
382
- </p>
383
- <p>The mailing list must re-write (munge) the <em class="emph">From:</em> header for such users;
384
- otherwise their email service will reject and bounce the message resulting in
385
- automatic unsubscribing from the mailing list.
386
- </p>
387
- <p>When sending a message these users will see <em class="emph">via &lt;mailing list name&gt;</em>
388
- added to their name and the <em class="emph">From:</em> address munged to the address of
389
- the particular mailing list.
390
- </p>
391
- <p>If you want to avoid this then please use a different email service.
392
- </p>
393
- <p>Note that ffmpeg-devel does not apply any munging as it causes issues with
394
- patch authorship. As a result users with an email service with a DMARC reject
395
- policy may be automatically unsubscribed due to rejected and bounced messages.
396
- </p>
397
- </div>
398
- </div>
399
- <div class="chapter-level-extent" id="Rules-and-Etiquette">
400
- <h2 class="chapter"><span>6 Rules and Etiquette<a class="copiable-link" href="#Rules-and-Etiquette"> &para;</a></span></h2>
401
-
402
- <ul class="mini-toc">
403
- <li><a href="#What-are-the-rules-and-the-proper-etiquette_003f" accesskey="1">What are the rules and the proper etiquette?</a></li>
404
- </ul>
405
- <div class="section-level-extent" id="What-are-the-rules-and-the-proper-etiquette_003f">
406
- <h3 class="section"><span>6.1 What are the rules and the proper etiquette?<a class="copiable-link" href="#What-are-the-rules-and-the-proper-etiquette_003f"> &para;</a></span></h3>
407
-
408
- <p>There may seem to be many things to remember, but we want to help and
409
- following these guidelines will allow you to get answers more quickly
410
- and help avoid getting ignored.
411
- </p>
412
- <ul class="itemize mark-bullet">
413
- <li>Always show your actual, unscripted <code class="command">ffmpeg</code> command and the
414
- complete, uncut console output from your command.
415
-
416
- </li><li>Use the most simple and minimal command that still shows the issue you
417
- are encountering.
418
-
419
- </li><li>Provide all necessary information so others can attempt to duplicate
420
- your issue. This includes the actual command, complete uncut console
421
- output, and any inputs that are required to duplicate the issue.
422
-
423
- </li><li>Use the latest <code class="command">ffmpeg</code> build you can get. See the <a class="url" href="https://ffmpeg.org/download.html">FFmpeg Download</a>
424
- page for links to recent builds for Linux, macOS, and Windows. Or
425
- compile from the current git master branch.
426
-
427
- </li><li>Avoid <a class="url" href="https://en.wikipedia.org/wiki/Posting_style#Top-posting">top-posting</a>.
428
- Also see <a class="ref" href="#What-is-top_002dposting_003f">What is top-posting?</a>
429
-
430
- </li><li>Avoid hijacking threads. Thread hijacking is replying to a message and
431
- changing the subject line to something unrelated to the original thread.
432
- Most email clients will still show the renamed message under the
433
- original thread. This can be confusing and these types of messages are
434
- often ignored.
435
-
436
- </li><li>Do not send screenshots. Copy and paste console text instead of making
437
- screenshots of the text.
438
-
439
- </li><li>Avoid sending email disclaimers and legalese if possible as this is a
440
- public list.
441
-
442
- </li><li>Avoid using the <code class="code">-loglevel debug</code>, <code class="code">-loglevel quiet</code>, and
443
- <code class="command">-hide_banner</code> options unless requested to do so.
444
-
445
- </li><li>If you attach files avoid compressing small files. Uncompressed is
446
- preferred.
447
-
448
- </li><li>Please do not send HTML-only messages. The mailing list will ignore the
449
- HTML component of your message. Most mail clients will automatically
450
- include a text component: this is what the mailing list will use.
451
-
452
- </li><li>Configuring your mail client to break lines after 70 or so characters is
453
- recommended.
454
-
455
- </li><li>Avoid sending the same message to multiple mailing lists.
456
-
457
- </li><li>Please follow our <a class="url" href="https://ffmpeg.org/community.html#Code-of-conduct">Code of Conduct</a>.
458
- </li></ul>
459
-
460
- </div>
461
- </div>
462
- <div class="chapter-level-extent" id="Help">
463
- <h2 class="chapter"><span>7 Help<a class="copiable-link" href="#Help"> &para;</a></span></h2>
464
-
465
- <ul class="mini-toc">
466
- <li><a href="#Why-am-I-not-receiving-any-messages_003f" accesskey="1">Why am I not receiving any messages?</a></li>
467
- <li><a href="#Why-are-my-sent-messages-not-showing-up_003f" accesskey="2">Why are my sent messages not showing up?</a></li>
468
- <li><a href="#Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f-1" accesskey="3">Why do I keep getting unsubscribed from ffmpeg-devel?</a></li>
469
- <li><a href="#Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f-1" accesskey="4">Who do I contact if I have a problem with the mailing list?</a></li>
470
- </ul>
471
- <div class="section-level-extent" id="Why-am-I-not-receiving-any-messages_003f">
472
- <h3 class="section"><span>7.1 Why am I not receiving any messages?<a class="copiable-link" href="#Why-am-I-not-receiving-any-messages_003f"> &para;</a></span></h3>
473
-
474
- <p>Some email providers have blacklists or spam filters that block or mark
475
- the mailing list messages as false positives. Unfortunately, the user is
476
- often not aware of this and is often out of their control.
477
- </p>
478
- <p>When possible we attempt to notify the provider to be removed from the
479
- blacklists or filters.
480
- </p>
481
- </div>
482
- <div class="section-level-extent" id="Why-are-my-sent-messages-not-showing-up_003f">
483
- <h3 class="section"><span>7.2 Why are my sent messages not showing up?<a class="copiable-link" href="#Why-are-my-sent-messages-not-showing-up_003f"> &para;</a></span></h3>
484
-
485
- <p>Excluding <a class="ref" href="#Why-is-my-message-awaiting-moderator-approval_003f">messages that are held in the moderation queue</a>
486
- there are a few other reasons why your messages may fail to appear:
487
- </p>
488
- <ul class="itemize mark-bullet">
489
- <li>HTML-only messages are ignored by the mailing lists. Most mail clients
490
- automatically include a text component alongside HTML email: this is what
491
- the mailing list will use. If it does not then consider your client to be
492
- broken, because sending a text component along with the HTML component to
493
- form a multi-part message is recommended by email standards.
494
-
495
- </li><li>Check your spam folder.
496
- </li></ul>
497
-
498
- <a class="anchor" id="Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f"></a></div>
499
- <div class="section-level-extent" id="Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f-1">
500
- <h3 class="section"><span>7.3 Why do I keep getting unsubscribed from ffmpeg-devel?<a class="copiable-link" href="#Why-do-I-keep-getting-unsubscribed-from-ffmpeg_002ddevel_003f-1"> &para;</a></span></h3>
501
-
502
- <p>Users with an email service that has a DMARC reject or quarantine policy may be
503
- automatically unsubscribed from the ffmpeg-devel mailing list due to the mailing
504
- list messages being continuously rejected and bounced back.
505
- </p>
506
- <p>Consider using a different email service.
507
- </p>
508
- <a class="anchor" id="Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f"></a></div>
509
- <div class="section-level-extent" id="Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f-1">
510
- <h3 class="section"><span>7.4 Who do I contact if I have a problem with the mailing list?<a class="copiable-link" href="#Who-do-I-contact-if-I-have-a-problem-with-the-mailing-list_003f-1"> &para;</a></span></h3>
511
-
512
- <p>Send a message to <a class="email" href="mailto:[email protected]">[email protected]</a>.
513
- </p>
514
- </div>
515
- </div>
516
- </div>
517
- <p style="font-size: small;">
518
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
519
- </p>
520
- </div>
521
- </body>
522
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/nut.html DELETED
@@ -1,241 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- NUT
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- NUT
17
- </h1>
18
-
19
-
20
-
21
- <div class="top-level-extent" id="SEC_Top">
22
-
23
- <div class="element-contents" id="SEC_Contents">
24
- <h2 class="contents-heading">Table of Contents</h2>
25
-
26
- <div class="contents">
27
-
28
- <ul class="toc-numbered-mark">
29
- <li><a id="toc-Description" href="#Description">1 Description</a></li>
30
- <li><a id="toc-Modes" href="#Modes">2 Modes</a>
31
- <ul class="toc-numbered-mark">
32
- <li><a id="toc-BROADCAST" href="#BROADCAST">2.1 BROADCAST</a></li>
33
- <li><a id="toc-PIPE" href="#PIPE">2.2 PIPE</a></li>
34
- </ul></li>
35
- <li><a id="toc-Container_002dspecific-codec-tags" href="#Container_002dspecific-codec-tags">3 Container-specific codec tags</a>
36
- <ul class="toc-numbered-mark">
37
- <li><a id="toc-Generic-raw-YUVA-formats" href="#Generic-raw-YUVA-formats">3.1 Generic raw YUVA formats</a></li>
38
- <li><a id="toc-Raw-Audio" href="#Raw-Audio">3.2 Raw Audio</a></li>
39
- <li><a id="toc-Subtitles" href="#Subtitles">3.3 Subtitles</a></li>
40
- <li><a id="toc-Raw-Data" href="#Raw-Data">3.4 Raw Data</a></li>
41
- <li><a id="toc-Codecs" href="#Codecs">3.5 Codecs</a></li>
42
- </ul></li>
43
- </ul>
44
- </div>
45
- </div>
46
-
47
- <ul class="mini-toc">
48
- <li><a href="#Description" accesskey="1">Description</a></li>
49
- <li><a href="#Modes" accesskey="2">Modes</a></li>
50
- <li><a href="#Container_002dspecific-codec-tags" accesskey="3">Container-specific codec tags</a></li>
51
- </ul>
52
- <div class="chapter-level-extent" id="Description">
53
- <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
54
- <p>NUT is a low overhead generic container format. It stores audio, video,
55
- subtitle and user-defined streams in a simple, yet efficient, way.
56
- </p>
57
- <p>It was created by a group of FFmpeg and MPlayer developers in 2003
58
- and was finalized in 2008.
59
- </p>
60
- <p>The official nut specification is at svn://svn.mplayerhq.hu/nut
61
- In case of any differences between this text and the official specification,
62
- the official specification shall prevail.
63
- </p>
64
- </div>
65
- <div class="chapter-level-extent" id="Modes">
66
- <h2 class="chapter"><span>2 Modes<a class="copiable-link" href="#Modes"> &para;</a></span></h2>
67
- <p>NUT has some variants signaled by using the flags field in its main header.
68
- </p>
69
- <table class="multitable">
70
- <tbody><tr><td width="40%">BROADCAST</td><td width="40%">Extend the syncpoint to report the sender wallclock</td></tr>
71
- <tr><td width="40%">PIPE</td><td width="40%">Omit completely the syncpoint</td></tr>
72
- </tbody>
73
- </table>
74
-
75
- <ul class="mini-toc">
76
- <li><a href="#BROADCAST" accesskey="1">BROADCAST</a></li>
77
- <li><a href="#PIPE" accesskey="2">PIPE</a></li>
78
- </ul>
79
- <div class="section-level-extent" id="BROADCAST">
80
- <h3 class="section"><span>2.1 BROADCAST<a class="copiable-link" href="#BROADCAST"> &para;</a></span></h3>
81
-
82
- <p>The BROADCAST variant provides a secondary time reference to facilitate
83
- detecting endpoint latency and network delays.
84
- It assumes all the endpoint clocks are synchronized.
85
- To be used in real-time scenarios.
86
- </p>
87
- </div>
88
- <div class="section-level-extent" id="PIPE">
89
- <h3 class="section"><span>2.2 PIPE<a class="copiable-link" href="#PIPE"> &para;</a></span></h3>
90
-
91
- <p>The PIPE variant assumes NUT is used as non-seekable intermediate container,
92
- by not using syncpoint removes unneeded overhead and reduces the overall
93
- memory usage.
94
- </p>
95
- </div>
96
- </div>
97
- <div class="chapter-level-extent" id="Container_002dspecific-codec-tags">
98
- <h2 class="chapter"><span>3 Container-specific codec tags<a class="copiable-link" href="#Container_002dspecific-codec-tags"> &para;</a></span></h2>
99
-
100
- <ul class="mini-toc">
101
- <li><a href="#Generic-raw-YUVA-formats" accesskey="1">Generic raw YUVA formats</a></li>
102
- <li><a href="#Raw-Audio" accesskey="2">Raw Audio</a></li>
103
- <li><a href="#Subtitles" accesskey="3">Subtitles</a></li>
104
- <li><a href="#Raw-Data" accesskey="4">Raw Data</a></li>
105
- <li><a href="#Codecs" accesskey="5">Codecs</a></li>
106
- </ul>
107
- <div class="section-level-extent" id="Generic-raw-YUVA-formats">
108
- <h3 class="section"><span>3.1 Generic raw YUVA formats<a class="copiable-link" href="#Generic-raw-YUVA-formats"> &para;</a></span></h3>
109
-
110
- <p>Since many exotic planar YUVA pixel formats are not considered by
111
- the AVI/QuickTime FourCC lists, the following scheme is adopted for
112
- representing them.
113
- </p>
114
- <p>The first two bytes can contain the values:
115
- Y1 = only Y
116
- Y2 = Y+A
117
- Y3 = YUV
118
- Y4 = YUVA
119
- </p>
120
- <p>The third byte represents the width and height chroma subsampling
121
- values for the UV planes, that is the amount to shift the luma
122
- width/height right to find the chroma width/height.
123
- </p>
124
- <p>The fourth byte is the number of bits used (8, 16, ...).
125
- </p>
126
- <p>If the order of bytes is inverted, that means that each component has
127
- to be read big-endian.
128
- </p>
129
- </div>
130
- <div class="section-level-extent" id="Raw-Audio">
131
- <h3 class="section"><span>3.2 Raw Audio<a class="copiable-link" href="#Raw-Audio"> &para;</a></span></h3>
132
-
133
- <table class="multitable">
134
- <tbody><tr><td width="40%">ALAW</td><td width="40%">A-LAW</td></tr>
135
- <tr><td width="40%">ULAW</td><td width="40%">MU-LAW</td></tr>
136
- <tr><td width="40%">P&lt;type&gt;&lt;interleaving&gt;&lt;bits&gt;</td><td width="40%">little-endian PCM</td></tr>
137
- <tr><td width="40%">&lt;bits&gt;&lt;interleaving&gt;&lt;type&gt;P</td><td width="40%">big-endian PCM</td></tr>
138
- </tbody>
139
- </table>
140
-
141
- <p>&lt;type&gt; is S for signed integer, U for unsigned integer, F for IEEE float
142
- &lt;interleaving&gt; is D for default, P is for planar.
143
- &lt;bits&gt; is 8/16/24/32
144
- </p>
145
- <div class="example">
146
- <pre class="example-preformatted">PFD[32] would for example be signed 32 bit little-endian IEEE float
147
- </pre></div>
148
-
149
- </div>
150
- <div class="section-level-extent" id="Subtitles">
151
- <h3 class="section"><span>3.3 Subtitles<a class="copiable-link" href="#Subtitles"> &para;</a></span></h3>
152
-
153
- <table class="multitable">
154
- <tbody><tr><td width="40%">UTF8</td><td width="40%">Raw UTF-8</td></tr>
155
- <tr><td width="40%">SSA[0]</td><td width="40%">SubStation Alpha</td></tr>
156
- <tr><td width="40%">DVDS</td><td width="40%">DVD subtitles</td></tr>
157
- <tr><td width="40%">DVBS</td><td width="40%">DVB subtitles</td></tr>
158
- </tbody>
159
- </table>
160
-
161
- </div>
162
- <div class="section-level-extent" id="Raw-Data">
163
- <h3 class="section"><span>3.4 Raw Data<a class="copiable-link" href="#Raw-Data"> &para;</a></span></h3>
164
-
165
- <table class="multitable">
166
- <tbody><tr><td width="40%">UTF8</td><td width="40%">Raw UTF-8</td></tr>
167
- </tbody>
168
- </table>
169
-
170
- </div>
171
- <div class="section-level-extent" id="Codecs">
172
- <h3 class="section"><span>3.5 Codecs<a class="copiable-link" href="#Codecs"> &para;</a></span></h3>
173
-
174
- <table class="multitable">
175
- <tbody><tr><td width="40%">3IV1</td><td width="40%">non-compliant MPEG-4 generated by old 3ivx</td></tr>
176
- <tr><td width="40%">ASV1</td><td width="40%">Asus Video</td></tr>
177
- <tr><td width="40%">ASV2</td><td width="40%">Asus Video 2</td></tr>
178
- <tr><td width="40%">CVID</td><td width="40%">Cinepak</td></tr>
179
- <tr><td width="40%">CYUV</td><td width="40%">Creative YUV</td></tr>
180
- <tr><td width="40%">DIVX</td><td width="40%">non-compliant MPEG-4 generated by old DivX</td></tr>
181
- <tr><td width="40%">DUCK</td><td width="40%">Truemotion 1</td></tr>
182
- <tr><td width="40%">FFV1</td><td width="40%">FFmpeg video 1</td></tr>
183
- <tr><td width="40%">FFVH</td><td width="40%">FFmpeg Huffyuv</td></tr>
184
- <tr><td width="40%">H261</td><td width="40%">ITU H.261</td></tr>
185
- <tr><td width="40%">H262</td><td width="40%">ITU H.262</td></tr>
186
- <tr><td width="40%">H263</td><td width="40%">ITU H.263</td></tr>
187
- <tr><td width="40%">H264</td><td width="40%">ITU H.264</td></tr>
188
- <tr><td width="40%">HFYU</td><td width="40%">Huffyuv</td></tr>
189
- <tr><td width="40%">I263</td><td width="40%">Intel H.263</td></tr>
190
- <tr><td width="40%">IV31</td><td width="40%">Indeo 3.1</td></tr>
191
- <tr><td width="40%">IV32</td><td width="40%">Indeo 3.2</td></tr>
192
- <tr><td width="40%">IV50</td><td width="40%">Indeo 5.0</td></tr>
193
- <tr><td width="40%">LJPG</td><td width="40%">ITU JPEG (lossless)</td></tr>
194
- <tr><td width="40%">MJLS</td><td width="40%">ITU JPEG-LS</td></tr>
195
- <tr><td width="40%">MJPG</td><td width="40%">ITU JPEG</td></tr>
196
- <tr><td width="40%">MPG4</td><td width="40%">MS MPEG-4v1 (not ISO MPEG-4)</td></tr>
197
- <tr><td width="40%">MP42</td><td width="40%">MS MPEG-4v2</td></tr>
198
- <tr><td width="40%">MP43</td><td width="40%">MS MPEG-4v3</td></tr>
199
- <tr><td width="40%">MP4V</td><td width="40%">ISO MPEG-4 Part 2 Video (from old encoders)</td></tr>
200
- <tr><td width="40%">mpg1</td><td width="40%">ISO MPEG-1 Video</td></tr>
201
- <tr><td width="40%">mpg2</td><td width="40%">ISO MPEG-2 Video</td></tr>
202
- <tr><td width="40%">MRLE</td><td width="40%">MS RLE</td></tr>
203
- <tr><td width="40%">MSVC</td><td width="40%">MS Video 1</td></tr>
204
- <tr><td width="40%">RT21</td><td width="40%">Indeo 2.1</td></tr>
205
- <tr><td width="40%">RV10</td><td width="40%">RealVideo 1.0</td></tr>
206
- <tr><td width="40%">RV20</td><td width="40%">RealVideo 2.0</td></tr>
207
- <tr><td width="40%">RV30</td><td width="40%">RealVideo 3.0</td></tr>
208
- <tr><td width="40%">RV40</td><td width="40%">RealVideo 4.0</td></tr>
209
- <tr><td width="40%">SNOW</td><td width="40%">FFmpeg Snow</td></tr>
210
- <tr><td width="40%">SVQ1</td><td width="40%">Sorenson Video 1</td></tr>
211
- <tr><td width="40%">SVQ3</td><td width="40%">Sorenson Video 3</td></tr>
212
- <tr><td width="40%">theo</td><td width="40%">Xiph Theora</td></tr>
213
- <tr><td width="40%">TM20</td><td width="40%">Truemotion 2.0</td></tr>
214
- <tr><td width="40%">UMP4</td><td width="40%">non-compliant MPEG-4 generated by UB Video MPEG-4</td></tr>
215
- <tr><td width="40%">VCR1</td><td width="40%">ATI VCR1</td></tr>
216
- <tr><td width="40%">VP30</td><td width="40%">VP 3.0</td></tr>
217
- <tr><td width="40%">VP31</td><td width="40%">VP 3.1</td></tr>
218
- <tr><td width="40%">VP50</td><td width="40%">VP 5.0</td></tr>
219
- <tr><td width="40%">VP60</td><td width="40%">VP 6.0</td></tr>
220
- <tr><td width="40%">VP61</td><td width="40%">VP 6.1</td></tr>
221
- <tr><td width="40%">VP62</td><td width="40%">VP 6.2</td></tr>
222
- <tr><td width="40%">VP70</td><td width="40%">VP 7.0</td></tr>
223
- <tr><td width="40%">WMV1</td><td width="40%">MS WMV7</td></tr>
224
- <tr><td width="40%">WMV2</td><td width="40%">MS WMV8</td></tr>
225
- <tr><td width="40%">WMV3</td><td width="40%">MS WMV9</td></tr>
226
- <tr><td width="40%">WV1F</td><td width="40%">non-compliant MPEG-4 generated by ?</td></tr>
227
- <tr><td width="40%">WVC1</td><td width="40%">VC-1</td></tr>
228
- <tr><td width="40%">XVID</td><td width="40%">non-compliant MPEG-4 generated by old Xvid</td></tr>
229
- <tr><td width="40%">XVIX</td><td width="40%">non-compliant MPEG-4 generated by old Xvid with interlacing bug</td></tr>
230
- </tbody>
231
- </table>
232
-
233
- </div>
234
- </div>
235
- </div>
236
- <p style="font-size: small;">
237
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
238
- </p>
239
- </div>
240
- </body>
241
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/platform.html DELETED
@@ -1,431 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
- <html>
3
- <!-- Created by , GNU Texinfo 7.1.1 -->
4
- <head>
5
- <meta charset="utf-8">
6
- <title>
7
- Platform Specific Information
8
- </title>
9
- <meta name="viewport" content="width=device-width,initial-scale=1.0">
10
- <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
11
- <link rel="stylesheet" type="text/css" href="style.min.css">
12
- </head>
13
- <body>
14
- <div class="container">
15
- <h1>
16
- Platform Specific Information
17
- </h1>
18
-
19
-
20
- <div class="top-level-extent" id="SEC_Top">
21
-
22
- <div class="element-contents" id="SEC_Contents">
23
- <h2 class="contents-heading">Table of Contents</h2>
24
-
25
- <div class="contents">
26
-
27
- <ul class="toc-numbered-mark">
28
- <li><a id="toc-Unix_002dlike" href="#Unix_002dlike">1 Unix-like</a>
29
- <ul class="toc-numbered-mark">
30
- <li><a id="toc-Advanced-linking-configuration" href="#Advanced-linking-configuration">1.1 Advanced linking configuration</a></li>
31
- <li><a id="toc-BSD" href="#BSD">1.2 BSD</a></li>
32
- <li><a id="toc-_0028Open_0029Solaris" href="#g_t_0028Open_0029Solaris">1.3 (Open)Solaris</a></li>
33
- <li><a id="toc-Darwin-_0028Mac-OS-X_002c-iPhone_0029" href="#Darwin-_0028Mac-OS-X_002c-iPhone_0029">1.4 Darwin (Mac OS X, iPhone)</a></li>
34
- </ul></li>
35
- <li><a id="toc-DOS" href="#DOS">2 DOS</a></li>
36
- <li><a id="toc-OS_002f2" href="#OS_002f2">3 OS/2</a></li>
37
- <li><a id="toc-Windows" href="#Windows">4 Windows</a>
38
- <ul class="toc-numbered-mark">
39
- <li><a id="toc-Native-Windows-compilation-using-MinGW-or-MinGW_002dw64" href="#Native-Windows-compilation-using-MinGW-or-MinGW_002dw64">4.1 Native Windows compilation using MinGW or MinGW-w64</a>
40
- <ul class="toc-numbered-mark">
41
- <li><a id="toc-Native-Windows-compilation-using-MSYS2" href="#Native-Windows-compilation-using-MSYS2">4.1.1 Native Windows compilation using MSYS2</a></li>
42
- </ul></li>
43
- <li><a id="toc-Microsoft-Visual-C_002b_002b-or-Intel-C_002b_002b-Compiler-for-Windows" href="#Microsoft-Visual-C_002b_002b-or-Intel-C_002b_002b-Compiler-for-Windows">4.2 Microsoft Visual C++ or Intel C++ Compiler for Windows</a>
44
- <ul class="toc-numbered-mark">
45
- <li><a id="toc-Linking-to-FFmpeg-with-Microsoft-Visual-C_002b_002b" href="#Linking-to-FFmpeg-with-Microsoft-Visual-C_002b_002b">4.2.1 Linking to FFmpeg with Microsoft Visual C++</a></li>
46
- </ul></li>
47
- <li><a id="toc-Cross-compilation-for-Windows-with-Linux-1" href="#Cross-compilation-for-Windows-with-Linux-1">4.3 Cross compilation for Windows with Linux</a></li>
48
- <li><a id="toc-Compilation-under-Cygwin" href="#Compilation-under-Cygwin">4.4 Compilation under Cygwin</a></li>
49
- <li><a id="toc-Crosscompilation-for-Windows-under-Cygwin" href="#Crosscompilation-for-Windows-under-Cygwin">4.5 Crosscompilation for Windows under Cygwin</a></li>
50
- </ul></li>
51
- </ul>
52
- </div>
53
- </div>
54
-
55
- <ul class="mini-toc">
56
- <li><a href="#Unix_002dlike" accesskey="1">Unix-like</a></li>
57
- <li><a href="#DOS" accesskey="2">DOS</a></li>
58
- <li><a href="#OS_002f2" accesskey="3">OS/2</a></li>
59
- <li><a href="#Windows" accesskey="4">Windows</a></li>
60
- </ul>
61
- <div class="chapter-level-extent" id="Unix_002dlike">
62
- <h2 class="chapter"><span>1 Unix-like<a class="copiable-link" href="#Unix_002dlike"> &para;</a></span></h2>
63
-
64
- <p>Some parts of FFmpeg cannot be built with version 2.15 of the GNU
65
- assembler which is still provided by a few AMD64 distributions. To
66
- make sure your compiler really uses the required version of gas
67
- after a binutils upgrade, run:
68
- </p>
69
- <div class="example">
70
- <pre class="example-preformatted">$(gcc -print-prog-name=as) --version
71
- </pre></div>
72
-
73
- <p>If not, then you should install a different compiler that has no
74
- hard-coded path to gas. In the worst case pass <code class="code">--disable-asm</code>
75
- to configure.
76
- </p>
77
- <ul class="mini-toc">
78
- <li><a href="#Advanced-linking-configuration" accesskey="1">Advanced linking configuration</a></li>
79
- <li><a href="#BSD" accesskey="2">BSD</a></li>
80
- <li><a href="#g_t_0028Open_0029Solaris" accesskey="3">(Open)Solaris</a></li>
81
- <li><a href="#Darwin-_0028Mac-OS-X_002c-iPhone_0029" accesskey="4">Darwin (Mac OS X, iPhone)</a></li>
82
- </ul>
83
- <div class="section-level-extent" id="Advanced-linking-configuration">
84
- <h3 class="section"><span>1.1 Advanced linking configuration<a class="copiable-link" href="#Advanced-linking-configuration"> &para;</a></span></h3>
85
-
86
- <p>If you compiled FFmpeg libraries statically and you want to use them to
87
- build your own shared library, you may need to force PIC support (with
88
- <code class="code">--enable-pic</code> during FFmpeg configure) and add the following option
89
- to your project LDFLAGS:
90
- </p>
91
- <div class="example">
92
- <pre class="example-preformatted">-Wl,-Bsymbolic
93
- </pre></div>
94
-
95
- <p>If your target platform requires position independent binaries, you should
96
- pass the correct linking flag (e.g. <code class="code">-pie</code>) to <code class="code">--extra-ldexeflags</code>.
97
- </p>
98
- </div>
99
- <div class="section-level-extent" id="BSD">
100
- <h3 class="section"><span>1.2 BSD<a class="copiable-link" href="#BSD"> &para;</a></span></h3>
101
-
102
- <p>BSD make will not build FFmpeg, you need to install and use GNU Make
103
- (<code class="command">gmake</code>).
104
- </p>
105
- </div>
106
- <div class="section-level-extent" id="g_t_0028Open_0029Solaris">
107
- <h3 class="section"><span>1.3 (Open)Solaris<a class="copiable-link" href="#g_t_0028Open_0029Solaris"> &para;</a></span></h3>
108
-
109
- <p>GNU Make is required to build FFmpeg, so you have to invoke (<code class="command">gmake</code>),
110
- standard Solaris Make will not work. When building with a non-c99 front-end
111
- (gcc, generic suncc) add either <code class="code">--extra-libs=/usr/lib/values-xpg6.o</code>
112
- or <code class="code">--extra-libs=/usr/lib/64/values-xpg6.o</code> to the configure options
113
- since the libc is not c99-compliant by default. The probes performed by
114
- configure may raise an exception leading to the death of configure itself
115
- due to a bug in the system shell. Simply invoke a different shell such as
116
- bash directly to work around this:
117
- </p>
118
- <div class="example">
119
- <pre class="example-preformatted">bash ./configure
120
- </pre></div>
121
-
122
- <a class="anchor" id="Darwin"></a></div>
123
- <div class="section-level-extent" id="Darwin-_0028Mac-OS-X_002c-iPhone_0029">
124
- <h3 class="section"><span>1.4 Darwin (Mac OS X, iPhone)<a class="copiable-link" href="#Darwin-_0028Mac-OS-X_002c-iPhone_0029"> &para;</a></span></h3>
125
-
126
- <p>The toolchain provided with Xcode is sufficient to build the basic
127
- unaccelerated code.
128
- </p>
129
- <p>Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
130
- <a class="url" href="https://github.com/FFmpeg/gas-preprocessor">https://github.com/FFmpeg/gas-preprocessor</a> or
131
- <a class="url" href="https://github.com/yuvi/gas-preprocessor">https://github.com/yuvi/gas-preprocessor</a>(currently outdated) to build the optimized
132
- assembly functions. Put the Perl script somewhere
133
- in your PATH, FFmpeg&rsquo;s configure will pick it up automatically.
134
- </p>
135
- <p>Mac OS X on amd64 and x86 requires <code class="command">nasm</code> to build most of the
136
- optimized assembly functions. <a class="uref" href="http://www.finkproject.org/">Fink</a>,
137
- <a class="uref" href="https://wiki.gentoo.org/wiki/Project:Prefix">Gentoo Prefix</a>,
138
- <a class="uref" href="https://mxcl.github.com/homebrew/">Homebrew</a>
139
- or <a class="uref" href="http://www.macports.org">MacPorts</a> can easily provide it.
140
- </p>
141
-
142
- </div>
143
- </div>
144
- <div class="chapter-level-extent" id="DOS">
145
- <h2 class="chapter"><span>2 DOS<a class="copiable-link" href="#DOS"> &para;</a></span></h2>
146
-
147
- <p>Using a cross-compiler is preferred for various reasons.
148
- <a class="url" href="http://www.delorie.com/howto/djgpp/linux-x-djgpp.html">http://www.delorie.com/howto/djgpp/linux-x-djgpp.html</a>
149
- </p>
150
-
151
- </div>
152
- <div class="chapter-level-extent" id="OS_002f2">
153
- <h2 class="chapter"><span>3 OS/2<a class="copiable-link" href="#OS_002f2"> &para;</a></span></h2>
154
-
155
- <p>For information about compiling FFmpeg on OS/2 see
156
- <a class="url" href="http://www.edm2.com/index.php/FFmpeg">http://www.edm2.com/index.php/FFmpeg</a>.
157
- </p>
158
-
159
- </div>
160
- <div class="chapter-level-extent" id="Windows">
161
- <h2 class="chapter"><span>4 Windows<a class="copiable-link" href="#Windows"> &para;</a></span></h2>
162
-
163
- <ul class="mini-toc">
164
- <li><a href="#Native-Windows-compilation-using-MinGW-or-MinGW_002dw64" accesskey="1">Native Windows compilation using MinGW or MinGW-w64</a></li>
165
- <li><a href="#Microsoft-Visual-C_002b_002b-or-Intel-C_002b_002b-Compiler-for-Windows" accesskey="2">Microsoft Visual C++ or Intel C++ Compiler for Windows</a></li>
166
- <li><a href="#Cross-compilation-for-Windows-with-Linux-1" accesskey="3">Cross compilation for Windows with Linux</a></li>
167
- <li><a href="#Compilation-under-Cygwin" accesskey="4">Compilation under Cygwin</a></li>
168
- <li><a href="#Crosscompilation-for-Windows-under-Cygwin" accesskey="5">Crosscompilation for Windows under Cygwin</a></li>
169
- </ul>
170
- <div class="section-level-extent" id="Native-Windows-compilation-using-MinGW-or-MinGW_002dw64">
171
- <h3 class="section"><span>4.1 Native Windows compilation using MinGW or MinGW-w64<a class="copiable-link" href="#Native-Windows-compilation-using-MinGW-or-MinGW_002dw64"> &para;</a></span></h3>
172
-
173
- <p>FFmpeg can be built to run natively on Windows using the MinGW-w64
174
- toolchain. Install the latest versions of MSYS2 and MinGW-w64 from
175
- <a class="url" href="http://msys2.github.io/">http://msys2.github.io/</a> and/or <a class="url" href="http://mingw-w64.sourceforge.net/">http://mingw-w64.sourceforge.net/</a>.
176
- You can find detailed installation instructions in the download section and
177
- the FAQ.
178
- </p>
179
- <p>Notes:
180
- </p>
181
- <ul class="itemize mark-bullet">
182
- <li>Building for the MSYS environment is discouraged, MSYS2 provides a full
183
- MinGW-w64 environment through <samp class="file">mingw64_shell.bat</samp> or
184
- <samp class="file">mingw32_shell.bat</samp> that should be used instead of the environment
185
- provided by <samp class="file">msys2_shell.bat</samp>.
186
-
187
- </li><li>Building using MSYS2 can be sped up by disabling implicit rules in the
188
- Makefile by calling <code class="code">make -r</code> instead of plain <code class="code">make</code>. This
189
- speed up is close to non-existent for normal one-off builds and is only
190
- noticeable when running make for a second time (for example during
191
- <code class="code">make install</code>).
192
-
193
- </li><li>In order to compile FFplay, you must have the MinGW development library
194
- of <a class="uref" href="http://www.libsdl.org/">SDL</a> and <code class="code">pkg-config</code> installed.
195
-
196
- </li><li>By using <code class="code">./configure --enable-shared</code> when configuring FFmpeg,
197
- you can build the FFmpeg libraries (e.g. libavutil, libavcodec,
198
- libavformat) as DLLs.
199
-
200
- </li></ul>
201
-
202
- <ul class="mini-toc">
203
- <li><a href="#Native-Windows-compilation-using-MSYS2" accesskey="1">Native Windows compilation using MSYS2</a></li>
204
- </ul>
205
- <div class="subsection-level-extent" id="Native-Windows-compilation-using-MSYS2">
206
- <h4 class="subsection"><span>4.1.1 Native Windows compilation using MSYS2<a class="copiable-link" href="#Native-Windows-compilation-using-MSYS2"> &para;</a></span></h4>
207
-
208
- <p>The MSYS2 MinGW-w64 environment provides ready to use toolchains and dependencies
209
- through <code class="command">pacman</code>.
210
- </p>
211
- <p>Make sure to use <samp class="file">mingw64_shell.bat</samp> or <samp class="file">mingw32_shell.bat</samp> to have
212
- the correct MinGW-w64 environment. The default install provides shortcuts to
213
- them under <code class="command">MinGW-w64 Win64 Shell</code> and <code class="command">MinGW-w64 Win32 Shell</code>.
214
- </p>
215
- <div class="example">
216
- <pre class="example-preformatted"># normal msys2 packages
217
- pacman -S make pkgconf diffutils
218
-
219
- # mingw-w64 packages and toolchains
220
- pacman -S mingw-w64-x86_64-nasm mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2
221
- </pre></div>
222
-
223
- <p>To target 32 bits replace <code class="code">x86_64</code> with <code class="code">i686</code> in the command above.
224
- </p>
225
- </div>
226
- </div>
227
- <div class="section-level-extent" id="Microsoft-Visual-C_002b_002b-or-Intel-C_002b_002b-Compiler-for-Windows">
228
- <h3 class="section"><span>4.2 Microsoft Visual C++ or Intel C++ Compiler for Windows<a class="copiable-link" href="#Microsoft-Visual-C_002b_002b-or-Intel-C_002b_002b-Compiler-for-Windows"> &para;</a></span></h3>
229
-
230
- <p>FFmpeg can be built with MSVC 2013 or later.
231
- </p>
232
- <p>You will need the following prerequisites:
233
- </p>
234
- <ul class="itemize mark-bullet">
235
- <li><a class="uref" href="http://msys2.github.io/">MSYS2</a>
236
- </li><li><a class="uref" href="http://www.nasm.us/">NASM</a>
237
- (Also available via MSYS2&rsquo;s package manager.)
238
- </li></ul>
239
-
240
- <p>To set up a proper environment in MSYS2, you need to run <code class="code">msys_shell.bat</code> from
241
- the Visual Studio or Intel Compiler command prompt.
242
- </p>
243
- <p>Place <code class="code">nasm.exe</code> somewhere in your <code class="code">PATH</code>.
244
- </p>
245
- <p>Next, make sure any other headers and libs you want to use, such as zlib, are
246
- located in a spot that the compiler can see. Do so by modifying the <code class="code">LIB</code>
247
- and <code class="code">INCLUDE</code> environment variables to include the <strong class="strong">Windows-style</strong>
248
- paths to these directories. Alternatively, you can try to use the
249
- <code class="code">--extra-cflags</code>/<code class="code">--extra-ldflags</code> configure options.
250
- </p>
251
- <p>Finally, run:
252
- </p>
253
- <div class="example">
254
- <pre class="example-preformatted">For MSVC:
255
- ./configure --toolchain=msvc
256
-
257
- For ICL:
258
- ./configure --toolchain=icl
259
-
260
- make
261
- make install
262
- </pre></div>
263
-
264
- <p>If you wish to compile shared libraries, add <code class="code">--enable-shared</code> to your
265
- configure options. Note that due to the way MSVC and ICL handle DLL imports and
266
- exports, you cannot compile static and shared libraries at the same time, and
267
- enabling shared libraries will automatically disable the static ones.
268
- </p>
269
- <p>Notes:
270
- </p>
271
- <ul class="itemize mark-bullet">
272
- <li>If you wish to build with zlib support, you will have to grab a compatible
273
- zlib binary from somewhere, with an MSVC import lib, or if you wish to link
274
- statically, you can follow the instructions below to build a compatible
275
- <code class="code">zlib.lib</code> with MSVC. Regardless of which method you use, you must still
276
- follow step 3, or compilation will fail.
277
- <ol class="enumerate">
278
- <li> Grab the <a class="uref" href="http://zlib.net/">zlib sources</a>.
279
- </li><li> Edit <code class="code">win32/Makefile.msc</code> so that it uses -MT instead of -MD, since
280
- this is how FFmpeg is built as well.
281
- </li><li> Edit <code class="code">zconf.h</code> and remove its inclusion of <code class="code">unistd.h</code>. This gets
282
- erroneously included when building FFmpeg.
283
- </li><li> Run <code class="code">nmake -f win32/Makefile.msc</code>.
284
- </li><li> Move <code class="code">zlib.lib</code>, <code class="code">zconf.h</code>, and <code class="code">zlib.h</code> to somewhere MSVC
285
- can see.
286
- </li></ol>
287
-
288
- </li><li>FFmpeg has been tested with the following on i686 and x86_64:
289
- <ul class="itemize mark-bullet">
290
- <li>Visual Studio 2013 Pro and Express
291
- </li><li>Intel Composer XE 2013
292
- </li><li>Intel Composer XE 2013 SP1
293
- </li></ul>
294
- <p>Anything else is not officially supported.
295
- </p>
296
- </li></ul>
297
-
298
- <ul class="mini-toc">
299
- <li><a href="#Linking-to-FFmpeg-with-Microsoft-Visual-C_002b_002b" accesskey="1">Linking to FFmpeg with Microsoft Visual C++</a></li>
300
- </ul>
301
- <div class="subsection-level-extent" id="Linking-to-FFmpeg-with-Microsoft-Visual-C_002b_002b">
302
- <h4 class="subsection"><span>4.2.1 Linking to FFmpeg with Microsoft Visual C++<a class="copiable-link" href="#Linking-to-FFmpeg-with-Microsoft-Visual-C_002b_002b"> &para;</a></span></h4>
303
-
304
- <p>If you plan to link with MSVC-built static libraries, you will need
305
- to make sure you have <code class="code">Runtime Library</code> set to
306
- <code class="code">Multi-threaded (/MT)</code> in your project&rsquo;s settings.
307
- </p>
308
- <p>You will need to define <code class="code">inline</code> to something MSVC understands:
309
- </p><div class="example">
310
- <pre class="example-preformatted">#define inline __inline
311
- </pre></div>
312
-
313
- <p>Also note, that as stated in <strong class="strong">Microsoft Visual C++</strong>, you will need
314
- an MSVC-compatible <a class="uref" href="http://code.google.com/p/msinttypes/">inttypes.h</a>.
315
- </p>
316
- <p>If you plan on using import libraries created by dlltool, you must
317
- set <code class="code">References</code> to <code class="code">No (/OPT:NOREF)</code> under the linker optimization
318
- settings, otherwise the resulting binaries will fail during runtime.
319
- This is not required when using import libraries generated by <code class="code">lib.exe</code>.
320
- This issue is reported upstream at
321
- <a class="url" href="http://sourceware.org/bugzilla/show_bug.cgi?id=12633">http://sourceware.org/bugzilla/show_bug.cgi?id=12633</a>.
322
- </p>
323
- <p>To create import libraries that work with the <code class="code">/OPT:REF</code> option
324
- (which is enabled by default in Release mode), follow these steps:
325
- </p>
326
- <ol class="enumerate">
327
- <li> Open the <em class="emph">Visual Studio Command Prompt</em>.
328
-
329
- <p>Alternatively, in a normal command line prompt, call <samp class="file">vcvars32.bat</samp>
330
- which sets up the environment variables for the Visual C++ tools
331
- (the standard location for this file is something like
332
- <samp class="file">C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat</samp>).
333
- </p>
334
- </li><li> Enter the <samp class="file">bin</samp> directory where the created LIB and DLL files
335
- are stored.
336
-
337
- </li><li> Generate new import libraries with <code class="command">lib.exe</code>:
338
-
339
- <div class="example">
340
- <pre class="example-preformatted">lib /machine:i386 /def:..\lib\foo-version.def /out:foo.lib
341
- </pre></div>
342
-
343
- <p>Replace <code class="code">foo-version</code> and <code class="code">foo</code> with the respective library names.
344
- </p>
345
- </li></ol>
346
-
347
- <a class="anchor" id="Cross-compilation-for-Windows-with-Linux"></a></div>
348
- </div>
349
- <div class="section-level-extent" id="Cross-compilation-for-Windows-with-Linux-1">
350
- <h3 class="section"><span>4.3 Cross compilation for Windows with Linux<a class="copiable-link" href="#Cross-compilation-for-Windows-with-Linux-1"> &para;</a></span></h3>
351
-
352
- <p>You must use the MinGW cross compilation tools available at
353
- <a class="url" href="http://www.mingw.org/">http://www.mingw.org/</a>.
354
- </p>
355
- <p>Then configure FFmpeg with the following options:
356
- </p><div class="example">
357
- <pre class="example-preformatted">./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
358
- </pre></div>
359
- <p>(you can change the cross-prefix according to the prefix chosen for the
360
- MinGW tools).
361
- </p>
362
- <p>Then you can easily test FFmpeg with <a class="uref" href="http://www.winehq.com/">Wine</a>.
363
- </p>
364
- </div>
365
- <div class="section-level-extent" id="Compilation-under-Cygwin">
366
- <h3 class="section"><span>4.4 Compilation under Cygwin<a class="copiable-link" href="#Compilation-under-Cygwin"> &para;</a></span></h3>
367
-
368
- <p>Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack
369
- llrint() in its C library.
370
- </p>
371
- <p>Install your Cygwin with all the &quot;Base&quot; packages, plus the
372
- following &quot;Devel&quot; ones:
373
- </p><div class="example">
374
- <pre class="example-preformatted">binutils, gcc4-core, make, git, mingw-runtime, texinfo
375
- </pre></div>
376
-
377
- <p>In order to run FATE you will also need the following &quot;Utils&quot; packages:
378
- </p><div class="example">
379
- <pre class="example-preformatted">diffutils
380
- </pre></div>
381
-
382
- <p>If you want to build FFmpeg with additional libraries, download Cygwin
383
- &quot;Devel&quot; packages for Ogg and Vorbis from any Cygwin packages repository:
384
- </p><div class="example">
385
- <pre class="example-preformatted">libogg-devel, libvorbis-devel
386
- </pre></div>
387
-
388
- <p>These library packages are only available from
389
- <a class="uref" href="http://sourceware.org/cygwinports/">Cygwin Ports</a>:
390
- </p>
391
- <div class="example">
392
- <pre class="example-preformatted">libSDL-devel, libgsm-devel, libmp3lame-devel,
393
- speex-devel, libtheora-devel, libxvidcore-devel
394
- </pre></div>
395
-
396
- <p>The recommendation for x264 is to build it from source, as it evolves too
397
- quickly for Cygwin Ports to be up to date.
398
- </p>
399
- </div>
400
- <div class="section-level-extent" id="Crosscompilation-for-Windows-under-Cygwin">
401
- <h3 class="section"><span>4.5 Crosscompilation for Windows under Cygwin<a class="copiable-link" href="#Crosscompilation-for-Windows-under-Cygwin"> &para;</a></span></h3>
402
-
403
- <p>With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
404
- </p>
405
- <p>Just install your Cygwin as explained before, plus these additional
406
- &quot;Devel&quot; packages:
407
- </p><div class="example">
408
- <pre class="example-preformatted">gcc-mingw-core, mingw-runtime, mingw-zlib
409
- </pre></div>
410
-
411
- <p>and add some special flags to your configure invocation.
412
- </p>
413
- <p>For a static build run
414
- </p><div class="example">
415
- <pre class="example-preformatted">./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
416
- </pre></div>
417
-
418
- <p>and for a build with shared libraries
419
- </p><div class="example">
420
- <pre class="example-preformatted">./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
421
- </pre></div>
422
-
423
- </div>
424
- </div>
425
- </div>
426
- <p style="font-size: small;">
427
- This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
428
- </p>
429
- </div>
430
- </body>
431
- </html>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/doc/style.min.css DELETED
@@ -1,23 +0,0 @@
1
- /*!
2
- The MIT License (MIT)
3
-
4
- Copyright (c) 2014 Barbara Lepage <[email protected]>
5
-
6
- Permission is hereby granted, free of charge, to any person obtaining a copy
7
- of this software and associated documentation files (the "Software"), to deal
8
- in the Software without restriction, including without limitation the rights
9
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
- copies of the Software, and to permit persons to whom the Software is
11
- furnished to do so, subject to the following conditions:
12
-
13
- The above copyright notice and this permission notice shall be included in all
14
- copies or substantial portions of the Software.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
- SOFTWARE.
23
- */body{background-color:#313131;color:#e6e6e6;text-align:justify}body, h1, h2, h3, h4, h5, h6{font-family:"Lucida Grande","Lucida Sans Unicode","Lucida Sans","Helvetica Neue",Helvetica,Verdana,Tahoma,sans-serif}a{color:#4cae4c}a strong{color:#e6e6e6}a:hover{color:#7fc77f}a:hover strong{color:#4cae4c}main{width:100% ! important;min-height:600px;margin:auto}h1, h2, h3, h4{font-weight:bold;text-align:left}h1, h2, h3{color:#bebebe}h1 strong, h2 strong, h3 strong{color:#e6e6e6}h4, h5, h6{color:#3c8b3c}h1{border-bottom:4px #bebebe solid;padding:20px 2%}h3{border-bottom:2px #bebebe solid;padding:15px 1%}h4{border-bottom:1px solid #e6e6e6;padding:10px 0;margin:20px 0;color:#e6e6e6}.list-group .list-group-item{background-color:#3e3e3e;border-color:black}.list-group.list-group-big .list-group-item{padding:25px}.list-group a.list-group-item{color:#7fc77f}.list-group a.list-group-item:hover{background-color:#313131;color:#4cae4c}.well{background-color:#242424;border-color:black;color:#bebebe}.well strong{color:#e6e6e6}.well code{background-color:#313131}.well hr{border-color:#3c8b3c}.well h3{margin:5px 0 15px 0;border:0;padding:0}.well a{color:#4cae4c}.well a.btn{color:white}.well small{display:block;padding:0 10px;font-style:italic}.well.example{padding-top:40px;margin-bottom:130px}.well.example pre{margin:50px;margin-bottom:30px;font-size:1.5em}.well.example .btn{margin-right:50px;margin-bottom:20px}.well.well-with-icon{min-height:136px}.well.well-with-icon .pull-right,.well.well-with-icon .pull-left{background-color:#4cae4c;color:#e6e6e6;padding:10px;border-radius:5px;margin:5px}.well.well-with-icon .pull-right{margin-left:20px}.well.well-with-icon .pull-left{margin-right:20px}a.well{display:block}a.well:hover{text-decoration:none;opacity:0.8}.info, .warning{margin:10px;padding:10px;background-color:#3e3e3e;color:#e6e6e6}.info code, .warning code{background-color:#313131}.info{border-left:10px #4cae4c solid}.warning{border-left:10px #ae4c4c solid}.with-icon{padding:30px}.with-icon .pull-left{padding-right:30px}.with-icon .pull-right{padding-left:30px}dd{margin-left:20px}code{background-color:#242424;color:#7fc77f;display:inline-block;margin:5px}.table{margin:20px 0;border-radius:4px}.table th,.table td,.table tr{border:1px solid #171717}.table tr th{background-color:#3e3e3e;border-bottom:2px solid #e6e6e6}.table tr:nth-child(odd){background-color:#242424}#sidebar-wrapper, .navbar{background-color:#171717;overflow-x:hidden}#sidebar-wrapper .sidebar-brand img,#sidebar-wrapper .navbar-brand img, .navbar .sidebar-brand img, .navbar .navbar-brand img{opacity:0.6;margin-right:8px}#sidebar-wrapper .sidebar-brand:hover,#sidebar-wrapper .navbar-brand:hover, .navbar .sidebar-brand:hover, .navbar .navbar-brand:hover{color:#fff}#sidebar-wrapper .sidebar-brand:hover img,#sidebar-wrapper .navbar-brand:hover img, .navbar .sidebar-brand:hover img, .navbar .navbar-brand:hover img{opacity:1}#sidebar-wrapper .sidebar-nav li ul, .navbar .sidebar-nav li ul{list-style-type:none;padding:0}#sidebar-wrapper .sidebar-nav li ul li, .navbar .sidebar-nav li ul li{line-height:20px}#sidebar-wrapper .sidebar-nav li ul li a, .navbar .sidebar-nav li ul li a{padding-left:20px}.content-header{height:auto;background-color:#242424}.content-header h1{color:#e6e6e6;display:block;margin:0;margin-bottom:20px;line-height:normal;border-bottom:none}#download h4, #index h4{margin-top:180px}#download h4.first, #index h4.first{margin-top:20px}#download h4.first small, #index h4.first small{color:inherit;font-size:1em}#download .btn-download-wrapper, #index .btn-download-wrapper{text-align:center;margin:160px auto}#download .btn-download-wrapper .btn, #index .btn-download-wrapper .btn{font-size:3em;padding:3%;display:inline-block;margin-bottom:5px}#download .btn-download-wrapper small, #index .btn-download-wrapper small{display:block;font-size:0.4em}#download h2.description, #index h2.description{color:#e6e6e6;font-size:2em;font-weight:bold;margin:120px 50px;line-height:2em}#download h2.description .label, #index h2.description .label{font-size:0.5em}#download .btn-download-wrapper{margin:40px auto}#download .os-selector{text-align:center;color:#e6e6e6;margin:30px 0}#download .os-selector a.btn-build{color:#e6e6e6;display:block;padding:20px;border-radius:2px}#download .os-selector .btn-build[href="#build-linux"]{background-color:#e43}#download .os-selector .btn-build[href="#build-linux"]:hover{color:#e43;background-color:#e6e6e6}#download .os-selector .btn-build[href="#build-windows"]{background-color:#06a}#download .os-selector .btn-build[href="#build-windows"]:hover{color:#06a;background-color:#e6e6e6}#download .os-selector .btn-build[href="#build-mac"]{background-color:darkgrey}#download .os-selector .btn-build[href="#build-mac"]:hover{color:darkgrey;background-color:#e6e6e6}#download .os-selector .tab-content{margin-top:20px}#download .os-selector #build-linux h3{color:#e43}#download .os-selector #build-windows h3{color:#06a}#download .os-selector #build-mac h3{color:darkgrey}footer{background-color:#242424;border-top:1px #101010 solid;padding:20px 0%}footer a{display:block}footer img[alt="FFmpeg"]{width:50%;display:block;margin:auto}.example.user-good pre{color:#bfbfbf;border:1px solid #357735;border-left:10px solid #357735;background-color:#242424}.example.user-bad pre{color:#bfbfbf;border:1px solid #ae4c4c;border-left:10px solid #ae4c4c;background-color:#242424}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/presets/libvpx-1080p.ffpreset DELETED
@@ -1,19 +0,0 @@
1
- vcodec=libvpx
2
-
3
- g=120
4
- lag-in-frames=16
5
- deadline=good
6
- cpu-used=0
7
- vprofile=1
8
- qmax=51
9
- qmin=11
10
- slices=4
11
- b=2M
12
-
13
- #ignored unless using -pass 2
14
- maxrate=24M
15
- minrate=100k
16
- auto-alt-ref=1
17
- arnr-maxframes=7
18
- arnr-strength=5
19
- arnr-type=centered
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/presets/libvpx-1080p50_60.ffpreset DELETED
@@ -1,19 +0,0 @@
1
- vcodec=libvpx
2
-
3
- g=120
4
- lag-in-frames=25
5
- deadline=good
6
- cpu-used=0
7
- vprofile=1
8
- qmax=51
9
- qmin=11
10
- slices=4
11
- b=2M
12
-
13
- #ignored unless using -pass 2
14
- maxrate=24M
15
- minrate=100k
16
- auto-alt-ref=1
17
- arnr-maxframes=7
18
- arnr-strength=5
19
- arnr-type=centered
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/presets/libvpx-360p.ffpreset DELETED
@@ -1,18 +0,0 @@
1
- vcodec=libvpx
2
-
3
- g=120
4
- lag-in-frames=16
5
- deadline=good
6
- cpu-used=0
7
- vprofile=0
8
- qmax=63
9
- qmin=0
10
- b=768k
11
-
12
- #ignored unless using -pass 2
13
- maxrate=1.5M
14
- minrate=40k
15
- auto-alt-ref=1
16
- arnr-maxframes=7
17
- arnr-strength=5
18
- arnr-type=centered
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/presets/libvpx-720p.ffpreset DELETED
@@ -1,19 +0,0 @@
1
- vcodec=libvpx
2
-
3
- g=120
4
- lag-in-frames=16
5
- deadline=good
6
- cpu-used=0
7
- vprofile=0
8
- qmax=51
9
- qmin=11
10
- slices=4
11
- b=2M
12
-
13
- #ignored unless using -pass 2
14
- maxrate=24M
15
- minrate=100k
16
- auto-alt-ref=1
17
- arnr-maxframes=7
18
- arnr-strength=5
19
- arnr-type=centered
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ffmpeg/presets/libvpx-720p50_60.ffpreset DELETED
@@ -1,19 +0,0 @@
1
- vcodec=libvpx
2
-
3
- g=120
4
- lag-in-frames=25
5
- deadline=good
6
- cpu-used=0
7
- vprofile=0
8
- qmax=51
9
- qmin=11
10
- slices=4
11
- b=2M
12
-
13
- #ignored unless using -pass 2
14
- maxrate=24M
15
- minrate=100k
16
- auto-alt-ref=1
17
- arnr-maxframes=7
18
- arnr-strength=5
19
- arnr-type=centered