xavi
/
Airport
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
Airport/Music/ffmpeg/doc/ffprobe-all.html

30168 lines
1.1 MiB
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<meta charset="utf-8">
<title>
ffprobe Documentation
</title>
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="style.min.css">
</head>
<body>
<div class="container">
<h1>
ffprobe Documentation
</h1>
<div align="center">
</div>
<a name="SEC_Top"></a>
<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a name="toc-Synopsis" href="#Synopsis">1 Synopsis</a></li>
<li><a name="toc-Description" href="#Description">2 Description</a></li>
<li><a name="toc-Options" href="#Options">3 Options</a>
<ul class="no-bullet">
<li><a name="toc-Stream-specifiers-1" href="#Stream-specifiers-1">3.1 Stream specifiers</a></li>
<li><a name="toc-Generic-options" href="#Generic-options">3.2 Generic options</a></li>
<li><a name="toc-AVOptions" href="#AVOptions">3.3 AVOptions</a></li>
<li><a name="toc-Main-options" href="#Main-options">3.4 Main options</a></li>
</ul></li>
<li><a name="toc-Writers" href="#Writers">4 Writers</a>
<ul class="no-bullet">
<li><a name="toc-default" href="#default">4.1 default</a></li>
<li><a name="toc-compact_002c-csv" href="#compact_002c-csv">4.2 compact, csv</a></li>
<li><a name="toc-flat" href="#flat">4.3 flat</a></li>
<li><a name="toc-ini" href="#ini">4.4 ini</a></li>
<li><a name="toc-json" href="#json">4.5 json</a></li>
<li><a name="toc-xml" href="#xml">4.6 xml</a></li>
</ul></li>
<li><a name="toc-Timecode" href="#Timecode">5 Timecode</a></li>
<li><a name="toc-Syntax" href="#Syntax">6 Syntax</a>
<ul class="no-bullet">
<li><a name="toc-Quoting-and-escaping" href="#Quoting-and-escaping">6.1 Quoting and escaping</a>
<ul class="no-bullet">
<li><a name="toc-Examples" href="#Examples">6.1.1 Examples</a></li>
</ul></li>
<li><a name="toc-Date" href="#Date">6.2 Date</a></li>
<li><a name="toc-Time-duration" href="#Time-duration">6.3 Time duration</a>
<ul class="no-bullet">
<li><a name="toc-Examples-1" href="#Examples-1">6.3.1 Examples</a></li>
</ul></li>
<li><a name="toc-Video-size" href="#Video-size">6.4 Video size</a></li>
<li><a name="toc-Video-rate" href="#Video-rate">6.5 Video rate</a></li>
<li><a name="toc-Ratio" href="#Ratio">6.6 Ratio</a></li>
<li><a name="toc-Color" href="#Color">6.7 Color</a></li>
<li><a name="toc-Channel-Layout" href="#Channel-Layout">6.8 Channel Layout</a></li>
</ul></li>
<li><a name="toc-Expression-Evaluation" href="#Expression-Evaluation">7 Expression Evaluation</a></li>
<li><a name="toc-OpenCL-Options" href="#OpenCL-Options">8 OpenCL Options</a></li>
<li><a name="toc-Codec-Options" href="#Codec-Options">9 Codec Options</a></li>
<li><a name="toc-Decoders" href="#Decoders">10 Decoders</a></li>
<li><a name="toc-Video-Decoders" href="#Video-Decoders">11 Video Decoders</a>
<ul class="no-bullet">
<li><a name="toc-hevc" href="#hevc">11.1 hevc</a></li>
<li><a name="toc-rawvideo" href="#rawvideo">11.2 rawvideo</a>
<ul class="no-bullet">
<li><a name="toc-Options-1" href="#Options-1">11.2.1 Options</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Audio-Decoders" href="#Audio-Decoders">12 Audio Decoders</a>
<ul class="no-bullet">
<li><a name="toc-ac3" href="#ac3">12.1 ac3</a>
<ul class="no-bullet">
<li><a name="toc-AC_002d3-Decoder-Options" href="#AC_002d3-Decoder-Options">12.1.1 AC-3 Decoder Options</a></li>
</ul></li>
<li><a name="toc-flac" href="#flac">12.2 flac</a>
<ul class="no-bullet">
<li><a name="toc-FLAC-Decoder-options" href="#FLAC-Decoder-options">12.2.1 FLAC Decoder options</a></li>
</ul></li>
<li><a name="toc-ffwavesynth" href="#ffwavesynth">12.3 ffwavesynth</a></li>
<li><a name="toc-libcelt" href="#libcelt">12.4 libcelt</a></li>
<li><a name="toc-libgsm" href="#libgsm">12.5 libgsm</a></li>
<li><a name="toc-libilbc" href="#libilbc">12.6 libilbc</a>
<ul class="no-bullet">
<li><a name="toc-Options-2" href="#Options-2">12.6.1 Options</a></li>
</ul></li>
<li><a name="toc-libopencore_002damrnb" href="#libopencore_002damrnb">12.7 libopencore-amrnb</a></li>
<li><a name="toc-libopencore_002damrwb" href="#libopencore_002damrwb">12.8 libopencore-amrwb</a></li>
<li><a name="toc-libopus" href="#libopus">12.9 libopus</a></li>
</ul></li>
<li><a name="toc-Subtitles-Decoders" href="#Subtitles-Decoders">13 Subtitles Decoders</a>
<ul class="no-bullet">
<li><a name="toc-dvbsub" href="#dvbsub">13.1 dvbsub</a>
<ul class="no-bullet">
<li><a name="toc-Options-3" href="#Options-3">13.1.1 Options</a></li>
</ul></li>
<li><a name="toc-dvdsub" href="#dvdsub">13.2 dvdsub</a>
<ul class="no-bullet">
<li><a name="toc-Options-4" href="#Options-4">13.2.1 Options</a></li>
</ul></li>
<li><a name="toc-libzvbi_002dteletext" href="#libzvbi_002dteletext">13.3 libzvbi-teletext</a>
<ul class="no-bullet">
<li><a name="toc-Options-5" href="#Options-5">13.3.1 Options</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Bitstream-Filters" href="#Bitstream-Filters">14 Bitstream Filters</a>
<ul class="no-bullet">
<li><a name="toc-aac_005fadtstoasc" href="#aac_005fadtstoasc">14.1 aac_adtstoasc</a></li>
<li><a name="toc-chomp" href="#chomp">14.2 chomp</a></li>
<li><a name="toc-dump_005fextra" href="#dump_005fextra">14.3 dump_extra</a></li>
<li><a name="toc-dca_005fcore" href="#dca_005fcore">14.4 dca_core</a></li>
<li><a name="toc-h264_005fmp4toannexb" href="#h264_005fmp4toannexb">14.5 h264_mp4toannexb</a></li>
<li><a name="toc-imxdump" href="#imxdump">14.6 imxdump</a></li>
<li><a name="toc-mjpeg2jpeg" href="#mjpeg2jpeg">14.7 mjpeg2jpeg</a></li>
<li><a name="toc-mjpega_005fdump_005fheader" href="#mjpega_005fdump_005fheader">14.8 mjpega_dump_header</a></li>
<li><a name="toc-movsub" href="#movsub">14.9 movsub</a></li>
<li><a name="toc-mp3_005fheader_005fdecompress" href="#mp3_005fheader_005fdecompress">14.10 mp3_header_decompress</a></li>
<li><a name="toc-mpeg4_005funpack_005fbframes" href="#mpeg4_005funpack_005fbframes">14.11 mpeg4_unpack_bframes</a></li>
<li><a name="toc-noise" href="#noise">14.12 noise</a></li>
<li><a name="toc-remove_005fextra" href="#remove_005fextra">14.13 remove_extra</a></li>
</ul></li>
<li><a name="toc-Format-Options" href="#Format-Options">15 Format Options</a>
<ul class="no-bullet">
<li><a name="toc-Format-stream-specifiers-1" href="#Format-stream-specifiers-1">15.1 Format stream specifiers</a></li>
</ul></li>
<li><a name="toc-Demuxers" href="#Demuxers">16 Demuxers</a>
<ul class="no-bullet">
<li><a name="toc-aa" href="#aa">16.1 aa</a></li>
<li><a name="toc-applehttp" href="#applehttp">16.2 applehttp</a></li>
<li><a name="toc-apng" href="#apng">16.3 apng</a></li>
<li><a name="toc-asf" href="#asf">16.4 asf</a></li>
<li><a name="toc-concat-1" href="#concat-1">16.5 concat</a>
<ul class="no-bullet">
<li><a name="toc-Syntax-1" href="#Syntax-1">16.5.1 Syntax</a></li>
<li><a name="toc-Options-6" href="#Options-6">16.5.2 Options</a></li>
<li><a name="toc-Examples-2" href="#Examples-2">16.5.3 Examples</a></li>
</ul></li>
<li><a name="toc-flv" href="#flv">16.6 flv</a></li>
<li><a name="toc-libgme" href="#libgme">16.7 libgme</a></li>
<li><a name="toc-libopenmpt" href="#libopenmpt">16.8 libopenmpt</a></li>
<li><a name="toc-gif" href="#gif">16.9 gif</a></li>
<li><a name="toc-image2" href="#image2">16.10 image2</a>
<ul class="no-bullet">
<li><a name="toc-Examples-3" href="#Examples-3">16.10.1 Examples</a></li>
</ul></li>
<li><a name="toc-mov_002fmp4_002f3gp_002fQuickTime" href="#mov_002fmp4_002f3gp_002fQuickTime">16.11 mov/mp4/3gp/QuickTime</a></li>
<li><a name="toc-mpegts" href="#mpegts">16.12 mpegts</a></li>
<li><a name="toc-mpjpeg" href="#mpjpeg">16.13 mpjpeg</a></li>
<li><a name="toc-rawvideo-1" href="#rawvideo-1">16.14 rawvideo</a></li>
<li><a name="toc-sbg" href="#sbg">16.15 sbg</a></li>
<li><a name="toc-tedcaptions" href="#tedcaptions">16.16 tedcaptions</a></li>
</ul></li>
<li><a name="toc-Metadata" href="#Metadata">17 Metadata</a></li>
<li><a name="toc-Protocol-Options" href="#Protocol-Options">18 Protocol Options</a></li>
<li><a name="toc-Protocols" href="#Protocols">19 Protocols</a>
<ul class="no-bullet">
<li><a name="toc-async" href="#async">19.1 async</a></li>
<li><a name="toc-bluray" href="#bluray">19.2 bluray</a></li>
<li><a name="toc-cache" href="#cache">19.3 cache</a></li>
<li><a name="toc-concat-2" href="#concat-2">19.4 concat</a></li>
<li><a name="toc-crypto" href="#crypto">19.5 crypto</a></li>
<li><a name="toc-data" href="#data">19.6 data</a></li>
<li><a name="toc-file" href="#file">19.7 file</a></li>
<li><a name="toc-ftp" href="#ftp">19.8 ftp</a></li>
<li><a name="toc-gopher" href="#gopher">19.9 gopher</a></li>
<li><a name="toc-hls" href="#hls">19.10 hls</a></li>
<li><a name="toc-http" href="#http">19.11 http</a>
<ul class="no-bullet">
<li><a name="toc-HTTP-Cookies" href="#HTTP-Cookies">19.11.1 HTTP Cookies</a></li>
</ul></li>
<li><a name="toc-Icecast" href="#Icecast">19.12 Icecast</a></li>
<li><a name="toc-mmst" href="#mmst">19.13 mmst</a></li>
<li><a name="toc-mmsh" href="#mmsh">19.14 mmsh</a></li>
<li><a name="toc-md5" href="#md5">19.15 md5</a></li>
<li><a name="toc-pipe" href="#pipe">19.16 pipe</a></li>
<li><a name="toc-rtmp" href="#rtmp">19.17 rtmp</a></li>
<li><a name="toc-rtmpe" href="#rtmpe">19.18 rtmpe</a></li>
<li><a name="toc-rtmps" href="#rtmps">19.19 rtmps</a></li>
<li><a name="toc-rtmpt" href="#rtmpt">19.20 rtmpt</a></li>
<li><a name="toc-rtmpte" href="#rtmpte">19.21 rtmpte</a></li>
<li><a name="toc-rtmpts" href="#rtmpts">19.22 rtmpts</a></li>
<li><a name="toc-libsmbclient" href="#libsmbclient">19.23 libsmbclient</a></li>
<li><a name="toc-libssh" href="#libssh">19.24 libssh</a></li>
<li><a name="toc-librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte">19.25 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte</a></li>
<li><a name="toc-rtp" href="#rtp">19.26 rtp</a></li>
<li><a name="toc-rtsp" href="#rtsp">19.27 rtsp</a>
<ul class="no-bullet">
<li><a name="toc-Examples-4" href="#Examples-4">19.27.1 Examples</a></li>
</ul></li>
<li><a name="toc-sap" href="#sap">19.28 sap</a>
<ul class="no-bullet">
<li><a name="toc-Muxer" href="#Muxer">19.28.1 Muxer</a></li>
<li><a name="toc-Demuxer" href="#Demuxer">19.28.2 Demuxer</a></li>
</ul></li>
<li><a name="toc-sctp" href="#sctp">19.29 sctp</a></li>
<li><a name="toc-srtp" href="#srtp">19.30 srtp</a></li>
<li><a name="toc-subfile" href="#subfile">19.31 subfile</a></li>
<li><a name="toc-tee" href="#tee">19.32 tee</a></li>
<li><a name="toc-tcp" href="#tcp">19.33 tcp</a></li>
<li><a name="toc-tls" href="#tls">19.34 tls</a></li>
<li><a name="toc-udp" href="#udp">19.35 udp</a>
<ul class="no-bullet">
<li><a name="toc-Examples-5" href="#Examples-5">19.35.1 Examples</a></li>
</ul></li>
<li><a name="toc-unix" href="#unix">19.36 unix</a></li>
</ul></li>
<li><a name="toc-Device-Options" href="#Device-Options">20 Device Options</a></li>
<li><a name="toc-Input-Devices" href="#Input-Devices">21 Input Devices</a>
<ul class="no-bullet">
<li><a name="toc-alsa" href="#alsa">21.1 alsa</a>
<ul class="no-bullet">
<li><a name="toc-Options-7" href="#Options-7">21.1.1 Options</a></li>
</ul></li>
<li><a name="toc-avfoundation" href="#avfoundation">21.2 avfoundation</a>
<ul class="no-bullet">
<li><a name="toc-Options-8" href="#Options-8">21.2.1 Options</a></li>
<li><a name="toc-Examples-6" href="#Examples-6">21.2.2 Examples</a></li>
</ul></li>
<li><a name="toc-bktr" href="#bktr">21.3 bktr</a>
<ul class="no-bullet">
<li><a name="toc-Options-9" href="#Options-9">21.3.1 Options</a></li>
</ul></li>
<li><a name="toc-decklink" href="#decklink">21.4 decklink</a>
<ul class="no-bullet">
<li><a name="toc-Options-10" href="#Options-10">21.4.1 Options</a></li>
<li><a name="toc-Examples-7" href="#Examples-7">21.4.2 Examples</a></li>
</ul></li>
<li><a name="toc-dshow" href="#dshow">21.5 dshow</a>
<ul class="no-bullet">
<li><a name="toc-Options-11" href="#Options-11">21.5.1 Options</a></li>
<li><a name="toc-Examples-8" href="#Examples-8">21.5.2 Examples</a></li>
</ul></li>
<li><a name="toc-dv1394" href="#dv1394">21.6 dv1394</a>
<ul class="no-bullet">
<li><a name="toc-Options-12" href="#Options-12">21.6.1 Options</a></li>
</ul></li>
<li><a name="toc-fbdev" href="#fbdev">21.7 fbdev</a>
<ul class="no-bullet">
<li><a name="toc-Options-13" href="#Options-13">21.7.1 Options</a></li>
</ul></li>
<li><a name="toc-gdigrab" href="#gdigrab">21.8 gdigrab</a>
<ul class="no-bullet">
<li><a name="toc-Options-14" href="#Options-14">21.8.1 Options</a></li>
</ul></li>
<li><a name="toc-iec61883" href="#iec61883">21.9 iec61883</a>
<ul class="no-bullet">
<li><a name="toc-Options-15" href="#Options-15">21.9.1 Options</a></li>
<li><a name="toc-Examples-9" href="#Examples-9">21.9.2 Examples</a></li>
</ul></li>
<li><a name="toc-jack" href="#jack">21.10 jack</a>
<ul class="no-bullet">
<li><a name="toc-Options-16" href="#Options-16">21.10.1 Options</a></li>
</ul></li>
<li><a name="toc-lavfi" href="#lavfi">21.11 lavfi</a>
<ul class="no-bullet">
<li><a name="toc-Options-17" href="#Options-17">21.11.1 Options</a></li>
<li><a name="toc-Examples-10" href="#Examples-10">21.11.2 Examples</a></li>
</ul></li>
<li><a name="toc-libcdio" href="#libcdio">21.12 libcdio</a>
<ul class="no-bullet">
<li><a name="toc-Options-18" href="#Options-18">21.12.1 Options</a></li>
</ul></li>
<li><a name="toc-libdc1394" href="#libdc1394">21.13 libdc1394</a></li>
<li><a name="toc-openal" href="#openal">21.14 openal</a>
<ul class="no-bullet">
<li><a name="toc-Options-19" href="#Options-19">21.14.1 Options</a></li>
<li><a name="toc-Examples-11" href="#Examples-11">21.14.2 Examples</a></li>
</ul></li>
<li><a name="toc-oss" href="#oss">21.15 oss</a>
<ul class="no-bullet">
<li><a name="toc-Options-20" href="#Options-20">21.15.1 Options</a></li>
</ul></li>
<li><a name="toc-pulse" href="#pulse">21.16 pulse</a>
<ul class="no-bullet">
<li><a name="toc-Options-21" href="#Options-21">21.16.1 Options</a></li>
<li><a name="toc-Examples-12" href="#Examples-12">21.16.2 Examples</a></li>
</ul></li>
<li><a name="toc-qtkit" href="#qtkit">21.17 qtkit</a>
<ul class="no-bullet">
<li><a name="toc-Options-22" href="#Options-22">21.17.1 Options</a></li>
</ul></li>
<li><a name="toc-sndio" href="#sndio">21.18 sndio</a>
<ul class="no-bullet">
<li><a name="toc-Options-23" href="#Options-23">21.18.1 Options</a></li>
</ul></li>
<li><a name="toc-video4linux2_002c-v4l2" href="#video4linux2_002c-v4l2">21.19 video4linux2, v4l2</a>
<ul class="no-bullet">
<li><a name="toc-Options-24" href="#Options-24">21.19.1 Options</a></li>
</ul></li>
<li><a name="toc-vfwcap" href="#vfwcap">21.20 vfwcap</a>
<ul class="no-bullet">
<li><a name="toc-Options-25" href="#Options-25">21.20.1 Options</a></li>
</ul></li>
<li><a name="toc-x11grab" href="#x11grab">21.21 x11grab</a>
<ul class="no-bullet">
<li><a name="toc-Options-26" href="#Options-26">21.21.1 Options</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Resampler-Options" href="#Resampler-Options">22 Resampler Options</a></li>
<li><a name="toc-Scaler-Options" href="#Scaler-Options">23 Scaler Options</a></li>
<li><a name="toc-Filtering-Introduction" href="#Filtering-Introduction">24 Filtering Introduction</a></li>
<li><a name="toc-graph2dot" href="#graph2dot">25 graph2dot</a></li>
<li><a name="toc-Filtergraph-description" href="#Filtergraph-description">26 Filtergraph description</a>
<ul class="no-bullet">
<li><a name="toc-Filtergraph-syntax-1" href="#Filtergraph-syntax-1">26.1 Filtergraph syntax</a></li>
<li><a name="toc-Notes-on-filtergraph-escaping" href="#Notes-on-filtergraph-escaping">26.2 Notes on filtergraph escaping</a></li>
</ul></li>
<li><a name="toc-Timeline-editing" href="#Timeline-editing">27 Timeline editing</a></li>
<li><a name="toc-Audio-Filters" href="#Audio-Filters">28 Audio Filters</a>
<ul class="no-bullet">
<li><a name="toc-acompressor" href="#acompressor">28.1 acompressor</a></li>
<li><a name="toc-acrossfade" href="#acrossfade">28.2 acrossfade</a>
<ul class="no-bullet">
<li><a name="toc-Examples-13" href="#Examples-13">28.2.1 Examples</a></li>
</ul></li>
<li><a name="toc-acrusher" href="#acrusher">28.3 acrusher</a></li>
<li><a name="toc-adelay" href="#adelay">28.4 adelay</a>
<ul class="no-bullet">
<li><a name="toc-Examples-14" href="#Examples-14">28.4.1 Examples</a></li>
</ul></li>
<li><a name="toc-aecho" href="#aecho">28.5 aecho</a>
<ul class="no-bullet">
<li><a name="toc-Examples-15" href="#Examples-15">28.5.1 Examples</a></li>
</ul></li>
<li><a name="toc-aemphasis" href="#aemphasis">28.6 aemphasis</a></li>
<li><a name="toc-aeval" href="#aeval">28.7 aeval</a>
<ul class="no-bullet">
<li><a name="toc-Examples-16" href="#Examples-16">28.7.1 Examples</a></li>
</ul></li>
<li><a name="toc-afade-1" href="#afade-1">28.8 afade</a>
<ul class="no-bullet">
<li><a name="toc-Examples-17" href="#Examples-17">28.8.1 Examples</a></li>
</ul></li>
<li><a name="toc-afftfilt" href="#afftfilt">28.9 afftfilt</a>
<ul class="no-bullet">
<li><a name="toc-Examples-18" href="#Examples-18">28.9.1 Examples</a></li>
</ul></li>
<li><a name="toc-aformat-1" href="#aformat-1">28.10 aformat</a></li>
<li><a name="toc-agate" href="#agate">28.11 agate</a></li>
<li><a name="toc-alimiter" href="#alimiter">28.12 alimiter</a></li>
<li><a name="toc-allpass" href="#allpass">28.13 allpass</a></li>
<li><a name="toc-aloop" href="#aloop">28.14 aloop</a></li>
<li><a name="toc-amerge-1" href="#amerge-1">28.15 amerge</a>
<ul class="no-bullet">
<li><a name="toc-Examples-19" href="#Examples-19">28.15.1 Examples</a></li>
</ul></li>
<li><a name="toc-amix" href="#amix">28.16 amix</a></li>
<li><a name="toc-anequalizer" href="#anequalizer">28.17 anequalizer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-20" href="#Examples-20">28.17.1 Examples</a></li>
<li><a name="toc-Commands" href="#Commands">28.17.2 Commands</a></li>
</ul></li>
<li><a name="toc-anull" href="#anull">28.18 anull</a></li>
<li><a name="toc-apad" href="#apad">28.19 apad</a>
<ul class="no-bullet">
<li><a name="toc-Examples-21" href="#Examples-21">28.19.1 Examples</a></li>
</ul></li>
<li><a name="toc-aphaser" href="#aphaser">28.20 aphaser</a></li>
<li><a name="toc-apulsator" href="#apulsator">28.21 apulsator</a></li>
<li><a name="toc-aresample-1" href="#aresample-1">28.22 aresample</a>
<ul class="no-bullet">
<li><a name="toc-Examples-22" href="#Examples-22">28.22.1 Examples</a></li>
</ul></li>
<li><a name="toc-areverse" href="#areverse">28.23 areverse</a>
<ul class="no-bullet">
<li><a name="toc-Examples-23" href="#Examples-23">28.23.1 Examples</a></li>
</ul></li>
<li><a name="toc-asetnsamples" href="#asetnsamples">28.24 asetnsamples</a></li>
<li><a name="toc-asetrate" href="#asetrate">28.25 asetrate</a></li>
<li><a name="toc-ashowinfo" href="#ashowinfo">28.26 ashowinfo</a></li>
<li><a name="toc-astats-1" href="#astats-1">28.27 astats</a></li>
<li><a name="toc-asyncts" href="#asyncts">28.28 asyncts</a></li>
<li><a name="toc-atempo" href="#atempo">28.29 atempo</a>
<ul class="no-bullet">
<li><a name="toc-Examples-24" href="#Examples-24">28.29.1 Examples</a></li>
</ul></li>
<li><a name="toc-atrim" href="#atrim">28.30 atrim</a></li>
<li><a name="toc-bandpass" href="#bandpass">28.31 bandpass</a></li>
<li><a name="toc-bandreject" href="#bandreject">28.32 bandreject</a></li>
<li><a name="toc-bass" href="#bass">28.33 bass</a></li>
<li><a name="toc-biquad" href="#biquad">28.34 biquad</a></li>
<li><a name="toc-bs2b" href="#bs2b">28.35 bs2b</a></li>
<li><a name="toc-channelmap" href="#channelmap">28.36 channelmap</a></li>
<li><a name="toc-channelsplit" href="#channelsplit">28.37 channelsplit</a></li>
<li><a name="toc-chorus" href="#chorus">28.38 chorus</a>
<ul class="no-bullet">
<li><a name="toc-Examples-25" href="#Examples-25">28.38.1 Examples</a></li>
</ul></li>
<li><a name="toc-compand" href="#compand">28.39 compand</a>
<ul class="no-bullet">
<li><a name="toc-Examples-26" href="#Examples-26">28.39.1 Examples</a></li>
</ul></li>
<li><a name="toc-compensationdelay" href="#compensationdelay">28.40 compensationdelay</a></li>
<li><a name="toc-crystalizer" href="#crystalizer">28.41 crystalizer</a></li>
<li><a name="toc-dcshift" href="#dcshift">28.42 dcshift</a></li>
<li><a name="toc-dynaudnorm" href="#dynaudnorm">28.43 dynaudnorm</a></li>
<li><a name="toc-earwax" href="#earwax">28.44 earwax</a></li>
<li><a name="toc-equalizer" href="#equalizer">28.45 equalizer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-27" href="#Examples-27">28.45.1 Examples</a></li>
</ul></li>
<li><a name="toc-extrastereo" href="#extrastereo">28.46 extrastereo</a></li>
<li><a name="toc-firequalizer" href="#firequalizer">28.47 firequalizer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-28" href="#Examples-28">28.47.1 Examples</a></li>
</ul></li>
<li><a name="toc-flanger" href="#flanger">28.48 flanger</a></li>
<li><a name="toc-hdcd" href="#hdcd">28.49 hdcd</a></li>
<li><a name="toc-highpass" href="#highpass">28.50 highpass</a></li>
<li><a name="toc-join" href="#join">28.51 join</a></li>
<li><a name="toc-ladspa" href="#ladspa">28.52 ladspa</a>
<ul class="no-bullet">
<li><a name="toc-Examples-29" href="#Examples-29">28.52.1 Examples</a></li>
<li><a name="toc-Commands-1" href="#Commands-1">28.52.2 Commands</a></li>
</ul></li>
<li><a name="toc-loudnorm" href="#loudnorm">28.53 loudnorm</a></li>
<li><a name="toc-lowpass" href="#lowpass">28.54 lowpass</a></li>
<li><a name="toc-pan-1" href="#pan-1">28.55 pan</a>
<ul class="no-bullet">
<li><a name="toc-Mixing-examples" href="#Mixing-examples">28.55.1 Mixing examples</a></li>
<li><a name="toc-Remapping-examples" href="#Remapping-examples">28.55.2 Remapping examples</a></li>
</ul></li>
<li><a name="toc-replaygain" href="#replaygain">28.56 replaygain</a></li>
<li><a name="toc-resample" href="#resample">28.57 resample</a></li>
<li><a name="toc-rubberband" href="#rubberband">28.58 rubberband</a></li>
<li><a name="toc-sidechaincompress" href="#sidechaincompress">28.59 sidechaincompress</a>
<ul class="no-bullet">
<li><a name="toc-Examples-30" href="#Examples-30">28.59.1 Examples</a></li>
</ul></li>
<li><a name="toc-sidechaingate" href="#sidechaingate">28.60 sidechaingate</a></li>
<li><a name="toc-silencedetect" href="#silencedetect">28.61 silencedetect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-31" href="#Examples-31">28.61.1 Examples</a></li>
</ul></li>
<li><a name="toc-silenceremove" href="#silenceremove">28.62 silenceremove</a>
<ul class="no-bullet">
<li><a name="toc-Examples-32" href="#Examples-32">28.62.1 Examples</a></li>
</ul></li>
<li><a name="toc-sofalizer" href="#sofalizer">28.63 sofalizer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-33" href="#Examples-33">28.63.1 Examples</a></li>
</ul></li>
<li><a name="toc-stereotools" href="#stereotools">28.64 stereotools</a>
<ul class="no-bullet">
<li><a name="toc-Examples-34" href="#Examples-34">28.64.1 Examples</a></li>
</ul></li>
<li><a name="toc-stereowiden" href="#stereowiden">28.65 stereowiden</a></li>
<li><a name="toc-treble" href="#treble">28.66 treble</a></li>
<li><a name="toc-tremolo" href="#tremolo">28.67 tremolo</a></li>
<li><a name="toc-vibrato" href="#vibrato">28.68 vibrato</a></li>
<li><a name="toc-volume" href="#volume">28.69 volume</a>
<ul class="no-bullet">
<li><a name="toc-Commands-2" href="#Commands-2">28.69.1 Commands</a></li>
<li><a name="toc-Examples-35" href="#Examples-35">28.69.2 Examples</a></li>
</ul></li>
<li><a name="toc-volumedetect" href="#volumedetect">28.70 volumedetect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-36" href="#Examples-36">28.70.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Audio-Sources" href="#Audio-Sources">29 Audio Sources</a>
<ul class="no-bullet">
<li><a name="toc-abuffer" href="#abuffer">29.1 abuffer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-37" href="#Examples-37">29.1.1 Examples</a></li>
</ul></li>
<li><a name="toc-aevalsrc" href="#aevalsrc">29.2 aevalsrc</a>
<ul class="no-bullet">
<li><a name="toc-Examples-38" href="#Examples-38">29.2.1 Examples</a></li>
</ul></li>
<li><a name="toc-anullsrc" href="#anullsrc">29.3 anullsrc</a>
<ul class="no-bullet">
<li><a name="toc-Examples-39" href="#Examples-39">29.3.1 Examples</a></li>
</ul></li>
<li><a name="toc-flite" href="#flite">29.4 flite</a>
<ul class="no-bullet">
<li><a name="toc-Examples-40" href="#Examples-40">29.4.1 Examples</a></li>
</ul></li>
<li><a name="toc-anoisesrc" href="#anoisesrc">29.5 anoisesrc</a>
<ul class="no-bullet">
<li><a name="toc-Examples-41" href="#Examples-41">29.5.1 Examples</a></li>
</ul></li>
<li><a name="toc-sine" href="#sine">29.6 sine</a>
<ul class="no-bullet">
<li><a name="toc-Examples-42" href="#Examples-42">29.6.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Audio-Sinks" href="#Audio-Sinks">30 Audio Sinks</a>
<ul class="no-bullet">
<li><a name="toc-abuffersink" href="#abuffersink">30.1 abuffersink</a></li>
<li><a name="toc-anullsink" href="#anullsink">30.2 anullsink</a></li>
</ul></li>
<li><a name="toc-Video-Filters" href="#Video-Filters">31 Video Filters</a>
<ul class="no-bullet">
<li><a name="toc-alphaextract" href="#alphaextract">31.1 alphaextract</a></li>
<li><a name="toc-alphamerge" href="#alphamerge">31.2 alphamerge</a></li>
<li><a name="toc-ass" href="#ass">31.3 ass</a></li>
<li><a name="toc-atadenoise" href="#atadenoise">31.4 atadenoise</a></li>
<li><a name="toc-avgblur" href="#avgblur">31.5 avgblur</a></li>
<li><a name="toc-bbox" href="#bbox">31.6 bbox</a></li>
<li><a name="toc-bitplanenoise" href="#bitplanenoise">31.7 bitplanenoise</a></li>
<li><a name="toc-blackdetect" href="#blackdetect">31.8 blackdetect</a></li>
<li><a name="toc-blackframe" href="#blackframe">31.9 blackframe</a></li>
<li><a name="toc-blend_002c-tblend" href="#blend_002c-tblend">31.10 blend, tblend</a>
<ul class="no-bullet">
<li><a name="toc-Examples-43" href="#Examples-43">31.10.1 Examples</a></li>
</ul></li>
<li><a name="toc-boxblur" href="#boxblur">31.11 boxblur</a>
<ul class="no-bullet">
<li><a name="toc-Examples-44" href="#Examples-44">31.11.1 Examples</a></li>
</ul></li>
<li><a name="toc-bwdif" href="#bwdif">31.12 bwdif</a></li>
<li><a name="toc-chromakey" href="#chromakey">31.13 chromakey</a>
<ul class="no-bullet">
<li><a name="toc-Examples-45" href="#Examples-45">31.13.1 Examples</a></li>
</ul></li>
<li><a name="toc-ciescope" href="#ciescope">31.14 ciescope</a></li>
<li><a name="toc-codecview" href="#codecview">31.15 codecview</a>
<ul class="no-bullet">
<li><a name="toc-Examples-46" href="#Examples-46">31.15.1 Examples</a></li>
</ul></li>
<li><a name="toc-colorbalance" href="#colorbalance">31.16 colorbalance</a>
<ul class="no-bullet">
<li><a name="toc-Examples-47" href="#Examples-47">31.16.1 Examples</a></li>
</ul></li>
<li><a name="toc-colorkey" href="#colorkey">31.17 colorkey</a>
<ul class="no-bullet">
<li><a name="toc-Examples-48" href="#Examples-48">31.17.1 Examples</a></li>
</ul></li>
<li><a name="toc-colorlevels" href="#colorlevels">31.18 colorlevels</a>
<ul class="no-bullet">
<li><a name="toc-Examples-49" href="#Examples-49">31.18.1 Examples</a></li>
</ul></li>
<li><a name="toc-colorchannelmixer" href="#colorchannelmixer">31.19 colorchannelmixer</a>
<ul class="no-bullet">
<li><a name="toc-Examples-50" href="#Examples-50">31.19.1 Examples</a></li>
</ul></li>
<li><a name="toc-colormatrix" href="#colormatrix">31.20 colormatrix</a></li>
<li><a name="toc-colorspace" href="#colorspace">31.21 colorspace</a></li>
<li><a name="toc-convolution" href="#convolution">31.22 convolution</a>
<ul class="no-bullet">
<li><a name="toc-Examples-51" href="#Examples-51">31.22.1 Examples</a></li>
</ul></li>
<li><a name="toc-copy" href="#copy">31.23 copy</a></li>
<li><a name="toc-coreimage-1" href="#coreimage-1">31.24 coreimage</a>
<ul class="no-bullet">
<li><a name="toc-Examples-52" href="#Examples-52">31.24.1 Examples</a></li>
</ul></li>
<li><a name="toc-crop" href="#crop">31.25 crop</a>
<ul class="no-bullet">
<li><a name="toc-Examples-53" href="#Examples-53">31.25.1 Examples</a></li>
<li><a name="toc-Commands-3" href="#Commands-3">31.25.2 Commands</a></li>
</ul></li>
<li><a name="toc-cropdetect" href="#cropdetect">31.26 cropdetect</a></li>
<li><a name="toc-curves-1" href="#curves-1">31.27 curves</a>
<ul class="no-bullet">
<li><a name="toc-Examples-54" href="#Examples-54">31.27.1 Examples</a></li>
</ul></li>
<li><a name="toc-datascope" href="#datascope">31.28 datascope</a></li>
<li><a name="toc-dctdnoiz" href="#dctdnoiz">31.29 dctdnoiz</a>
<ul class="no-bullet">
<li><a name="toc-Examples-55" href="#Examples-55">31.29.1 Examples</a></li>
</ul></li>
<li><a name="toc-deband" href="#deband">31.30 deband</a></li>
<li><a name="toc-decimate-1" href="#decimate-1">31.31 decimate</a></li>
<li><a name="toc-deflate" href="#deflate">31.32 deflate</a></li>
<li><a name="toc-dejudder" href="#dejudder">31.33 dejudder</a></li>
<li><a name="toc-delogo" href="#delogo">31.34 delogo</a>
<ul class="no-bullet">
<li><a name="toc-Examples-56" href="#Examples-56">31.34.1 Examples</a></li>
</ul></li>
<li><a name="toc-deshake" href="#deshake">31.35 deshake</a></li>
<li><a name="toc-detelecine" href="#detelecine">31.36 detelecine</a></li>
<li><a name="toc-dilation" href="#dilation">31.37 dilation</a></li>
<li><a name="toc-displace" href="#displace">31.38 displace</a>
<ul class="no-bullet">
<li><a name="toc-Examples-57" href="#Examples-57">31.38.1 Examples</a></li>
</ul></li>
<li><a name="toc-drawbox" href="#drawbox">31.39 drawbox</a>
<ul class="no-bullet">
<li><a name="toc-Examples-58" href="#Examples-58">31.39.1 Examples</a></li>
</ul></li>
<li><a name="toc-drawgrid" href="#drawgrid">31.40 drawgrid</a>
<ul class="no-bullet">
<li><a name="toc-Examples-59" href="#Examples-59">31.40.1 Examples</a></li>
</ul></li>
<li><a name="toc-drawtext-1" href="#drawtext-1">31.41 drawtext</a>
<ul class="no-bullet">
<li><a name="toc-Syntax-2" href="#Syntax-2">31.41.1 Syntax</a></li>
<li><a name="toc-Text-expansion" href="#Text-expansion">31.41.2 Text expansion</a></li>
<li><a name="toc-Examples-60" href="#Examples-60">31.41.3 Examples</a></li>
</ul></li>
<li><a name="toc-edgedetect" href="#edgedetect">31.42 edgedetect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-61" href="#Examples-61">31.42.1 Examples</a></li>
</ul></li>
<li><a name="toc-eq" href="#eq">31.43 eq</a>
<ul class="no-bullet">
<li><a name="toc-Commands-4" href="#Commands-4">31.43.1 Commands</a></li>
</ul></li>
<li><a name="toc-erosion" href="#erosion">31.44 erosion</a></li>
<li><a name="toc-extractplanes" href="#extractplanes">31.45 extractplanes</a>
<ul class="no-bullet">
<li><a name="toc-Examples-62" href="#Examples-62">31.45.1 Examples</a></li>
</ul></li>
<li><a name="toc-elbg" href="#elbg">31.46 elbg</a></li>
<li><a name="toc-fade" href="#fade">31.47 fade</a>
<ul class="no-bullet">
<li><a name="toc-Examples-63" href="#Examples-63">31.47.1 Examples</a></li>
</ul></li>
<li><a name="toc-fftfilt" href="#fftfilt">31.48 fftfilt</a>
<ul class="no-bullet">
<li><a name="toc-Examples-64" href="#Examples-64">31.48.1 Examples</a></li>
</ul></li>
<li><a name="toc-field" href="#field">31.49 field</a></li>
<li><a name="toc-fieldhint" href="#fieldhint">31.50 fieldhint</a></li>
<li><a name="toc-fieldmatch" href="#fieldmatch">31.51 fieldmatch</a>
<ul class="no-bullet">
<li><a name="toc-p_002fc_002fn_002fu_002fb-meaning-1" href="#p_002fc_002fn_002fu_002fb-meaning-1">31.51.1 p/c/n/u/b meaning</a>
<ul class="no-bullet">
<li><a name="toc-p_002fc_002fn" href="#p_002fc_002fn">31.51.1.1 p/c/n</a></li>
<li><a name="toc-u_002fb" href="#u_002fb">31.51.1.2 u/b</a></li>
</ul></li>
<li><a name="toc-Examples-65" href="#Examples-65">31.51.2 Examples</a></li>
</ul></li>
<li><a name="toc-fieldorder" href="#fieldorder">31.52 fieldorder</a></li>
<li><a name="toc-fifo_002c-afifo" href="#fifo_002c-afifo">31.53 fifo, afifo</a></li>
<li><a name="toc-find_005frect" href="#find_005frect">31.54 find_rect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-66" href="#Examples-66">31.54.1 Examples</a></li>
</ul></li>
<li><a name="toc-cover_005frect" href="#cover_005frect">31.55 cover_rect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-67" href="#Examples-67">31.55.1 Examples</a></li>
</ul></li>
<li><a name="toc-format-1" href="#format-1">31.56 format</a>
<ul class="no-bullet">
<li><a name="toc-Examples-68" href="#Examples-68">31.56.1 Examples</a></li>
</ul></li>
<li><a name="toc-fps-1" href="#fps-1">31.57 fps</a>
<ul class="no-bullet">
<li><a name="toc-Examples-69" href="#Examples-69">31.57.1 Examples</a></li>
</ul></li>
<li><a name="toc-framepack" href="#framepack">31.58 framepack</a></li>
<li><a name="toc-framerate" href="#framerate">31.59 framerate</a></li>
<li><a name="toc-framestep" href="#framestep">31.60 framestep</a></li>
<li><a name="toc-frei0r-1" href="#frei0r-1">31.61 frei0r</a>
<ul class="no-bullet">
<li><a name="toc-Examples-70" href="#Examples-70">31.61.1 Examples</a></li>
</ul></li>
<li><a name="toc-fspp" href="#fspp">31.62 fspp</a></li>
<li><a name="toc-gblur" href="#gblur">31.63 gblur</a></li>
<li><a name="toc-geq" href="#geq">31.64 geq</a>
<ul class="no-bullet">
<li><a name="toc-Examples-71" href="#Examples-71">31.64.1 Examples</a></li>
</ul></li>
<li><a name="toc-gradfun" href="#gradfun">31.65 gradfun</a>
<ul class="no-bullet">
<li><a name="toc-Examples-72" href="#Examples-72">31.65.1 Examples</a></li>
</ul></li>
<li><a name="toc-haldclut-1" href="#haldclut-1">31.66 haldclut</a>
<ul class="no-bullet">
<li><a name="toc-Workflow-examples" href="#Workflow-examples">31.66.1 Workflow examples</a>
<ul class="no-bullet">
<li><a name="toc-Hald-CLUT-video-stream" href="#Hald-CLUT-video-stream">31.66.1.1 Hald CLUT video stream</a></li>
<li><a name="toc-Hald-CLUT-with-preview" href="#Hald-CLUT-with-preview">31.66.1.2 Hald CLUT with preview</a></li>
</ul></li>
</ul></li>
<li><a name="toc-hflip" href="#hflip">31.67 hflip</a></li>
<li><a name="toc-histeq" href="#histeq">31.68 histeq</a></li>
<li><a name="toc-histogram" href="#histogram">31.69 histogram</a>
<ul class="no-bullet">
<li><a name="toc-Examples-73" href="#Examples-73">31.69.1 Examples</a></li>
</ul></li>
<li><a name="toc-hqdn3d-1" href="#hqdn3d-1">31.70 hqdn3d</a></li>
<li><a name="toc-hwupload_005fcuda-1" href="#hwupload_005fcuda-1">31.71 hwupload_cuda</a></li>
<li><a name="toc-hqx" href="#hqx">31.72 hqx</a></li>
<li><a name="toc-hstack" href="#hstack">31.73 hstack</a></li>
<li><a name="toc-hue" href="#hue">31.74 hue</a>
<ul class="no-bullet">
<li><a name="toc-Examples-74" href="#Examples-74">31.74.1 Examples</a></li>
<li><a name="toc-Commands-5" href="#Commands-5">31.74.2 Commands</a></li>
</ul></li>
<li><a name="toc-hysteresis" href="#hysteresis">31.75 hysteresis</a></li>
<li><a name="toc-idet" href="#idet">31.76 idet</a></li>
<li><a name="toc-il" href="#il">31.77 il</a></li>
<li><a name="toc-inflate" href="#inflate">31.78 inflate</a></li>
<li><a name="toc-interlace" href="#interlace">31.79 interlace</a></li>
<li><a name="toc-kerndeint" href="#kerndeint">31.80 kerndeint</a>
<ul class="no-bullet">
<li><a name="toc-Examples-75" href="#Examples-75">31.80.1 Examples</a></li>
</ul></li>
<li><a name="toc-lenscorrection" href="#lenscorrection">31.81 lenscorrection</a>
<ul class="no-bullet">
<li><a name="toc-Options-27" href="#Options-27">31.81.1 Options</a></li>
</ul></li>
<li><a name="toc-loop" href="#loop">31.82 loop</a></li>
<li><a name="toc-lut3d-1" href="#lut3d-1">31.83 lut3d</a></li>
<li><a name="toc-lut_002c-lutrgb_002c-lutyuv" href="#lut_002c-lutrgb_002c-lutyuv">31.84 lut, lutrgb, lutyuv</a>
<ul class="no-bullet">
<li><a name="toc-Examples-76" href="#Examples-76">31.84.1 Examples</a></li>
</ul></li>
<li><a name="toc-lut2" href="#lut2">31.85 lut2</a>
<ul class="no-bullet">
<li><a name="toc-Examples-77" href="#Examples-77">31.85.1 Examples</a></li>
</ul></li>
<li><a name="toc-maskedclamp" href="#maskedclamp">31.86 maskedclamp</a></li>
<li><a name="toc-maskedmerge" href="#maskedmerge">31.87 maskedmerge</a></li>
<li><a name="toc-mcdeint" href="#mcdeint">31.88 mcdeint</a></li>
<li><a name="toc-mergeplanes" href="#mergeplanes">31.89 mergeplanes</a>
<ul class="no-bullet">
<li><a name="toc-Examples-78" href="#Examples-78">31.89.1 Examples</a></li>
</ul></li>
<li><a name="toc-mestimate" href="#mestimate">31.90 mestimate</a></li>
<li><a name="toc-minterpolate" href="#minterpolate">31.91 minterpolate</a></li>
<li><a name="toc-mpdecimate" href="#mpdecimate">31.92 mpdecimate</a></li>
<li><a name="toc-negate" href="#negate">31.93 negate</a></li>
<li><a name="toc-nlmeans" href="#nlmeans">31.94 nlmeans</a></li>
<li><a name="toc-nnedi" href="#nnedi">31.95 nnedi</a></li>
<li><a name="toc-noformat" href="#noformat">31.96 noformat</a>
<ul class="no-bullet">
<li><a name="toc-Examples-79" href="#Examples-79">31.96.1 Examples</a></li>
</ul></li>
<li><a name="toc-noise-1" href="#noise-1">31.97 noise</a>
<ul class="no-bullet">
<li><a name="toc-Examples-80" href="#Examples-80">31.97.1 Examples</a></li>
</ul></li>
<li><a name="toc-null" href="#null">31.98 null</a></li>
<li><a name="toc-ocr" href="#ocr">31.99 ocr</a></li>
<li><a name="toc-ocv" href="#ocv">31.100 ocv</a>
<ul class="no-bullet">
<li><a name="toc-dilate-1" href="#dilate-1">31.100.1 dilate</a></li>
<li><a name="toc-erode" href="#erode">31.100.2 erode</a></li>
<li><a name="toc-smooth" href="#smooth">31.100.3 smooth</a></li>
</ul></li>
<li><a name="toc-overlay-1" href="#overlay-1">31.101 overlay</a>
<ul class="no-bullet">
<li><a name="toc-Commands-6" href="#Commands-6">31.101.1 Commands</a></li>
<li><a name="toc-Examples-81" href="#Examples-81">31.101.2 Examples</a></li>
</ul></li>
<li><a name="toc-owdenoise" href="#owdenoise">31.102 owdenoise</a></li>
<li><a name="toc-pad-1" href="#pad-1">31.103 pad</a>
<ul class="no-bullet">
<li><a name="toc-Examples-82" href="#Examples-82">31.103.1 Examples</a></li>
</ul></li>
<li><a name="toc-palettegen-1" href="#palettegen-1">31.104 palettegen</a>
<ul class="no-bullet">
<li><a name="toc-Examples-83" href="#Examples-83">31.104.1 Examples</a></li>
</ul></li>
<li><a name="toc-paletteuse" href="#paletteuse">31.105 paletteuse</a>
<ul class="no-bullet">
<li><a name="toc-Examples-84" href="#Examples-84">31.105.1 Examples</a></li>
</ul></li>
<li><a name="toc-perspective" href="#perspective">31.106 perspective</a></li>
<li><a name="toc-phase" href="#phase">31.107 phase</a></li>
<li><a name="toc-pixdesctest" href="#pixdesctest">31.108 pixdesctest</a></li>
<li><a name="toc-pp" href="#pp">31.109 pp</a>
<ul class="no-bullet">
<li><a name="toc-Examples-85" href="#Examples-85">31.109.1 Examples</a></li>
</ul></li>
<li><a name="toc-pp7" href="#pp7">31.110 pp7</a></li>
<li><a name="toc-prewitt" href="#prewitt">31.111 prewitt</a></li>
<li><a name="toc-psnr" href="#psnr">31.112 psnr</a></li>
<li><a name="toc-pullup-1" href="#pullup-1">31.113 pullup</a></li>
<li><a name="toc-qp" href="#qp">31.114 qp</a>
<ul class="no-bullet">
<li><a name="toc-Examples-86" href="#Examples-86">31.114.1 Examples</a></li>
</ul></li>
<li><a name="toc-random" href="#random">31.115 random</a></li>
<li><a name="toc-readvitc" href="#readvitc">31.116 readvitc</a>
<ul class="no-bullet">
<li><a name="toc-Examples-87" href="#Examples-87">31.116.1 Examples</a></li>
</ul></li>
<li><a name="toc-remap" href="#remap">31.117 remap</a></li>
<li><a name="toc-removegrain" href="#removegrain">31.118 removegrain</a></li>
<li><a name="toc-removelogo" href="#removelogo">31.119 removelogo</a></li>
<li><a name="toc-repeatfields" href="#repeatfields">31.120 repeatfields</a></li>
<li><a name="toc-reverse" href="#reverse">31.121 reverse</a>
<ul class="no-bullet">
<li><a name="toc-Examples-88" href="#Examples-88">31.121.1 Examples</a></li>
</ul></li>
<li><a name="toc-rotate" href="#rotate">31.122 rotate</a>
<ul class="no-bullet">
<li><a name="toc-Examples-89" href="#Examples-89">31.122.1 Examples</a></li>
<li><a name="toc-Commands-7" href="#Commands-7">31.122.2 Commands</a></li>
</ul></li>
<li><a name="toc-sab" href="#sab">31.123 sab</a></li>
<li><a name="toc-scale-1" href="#scale-1">31.124 scale</a>
<ul class="no-bullet">
<li><a name="toc-Options-28" href="#Options-28">31.124.1 Options</a></li>
<li><a name="toc-Examples-90" href="#Examples-90">31.124.2 Examples</a></li>
<li><a name="toc-Commands-8" href="#Commands-8">31.124.3 Commands</a></li>
</ul></li>
<li><a name="toc-scale_005fnpp" href="#scale_005fnpp">31.125 scale_npp</a></li>
<li><a name="toc-scale2ref" href="#scale2ref">31.126 scale2ref</a>
<ul class="no-bullet">
<li><a name="toc-Examples-91" href="#Examples-91">31.126.1 Examples</a></li>
</ul></li>
<li><a name="toc-selectivecolor-1" href="#selectivecolor-1">31.127 selectivecolor</a>
<ul class="no-bullet">
<li><a name="toc-Examples-92" href="#Examples-92">31.127.1 Examples</a></li>
</ul></li>
<li><a name="toc-separatefields-1" href="#separatefields-1">31.128 separatefields</a></li>
<li><a name="toc-setdar_002c-setsar" href="#setdar_002c-setsar">31.129 setdar, setsar</a>
<ul class="no-bullet">
<li><a name="toc-Examples-93" href="#Examples-93">31.129.1 Examples</a></li>
</ul></li>
<li><a name="toc-setfield-1" href="#setfield-1">31.130 setfield</a></li>
<li><a name="toc-showinfo" href="#showinfo">31.131 showinfo</a></li>
<li><a name="toc-showpalette" href="#showpalette">31.132 showpalette</a></li>
<li><a name="toc-shuffleframes" href="#shuffleframes">31.133 shuffleframes</a>
<ul class="no-bullet">
<li><a name="toc-Examples-94" href="#Examples-94">31.133.1 Examples</a></li>
</ul></li>
<li><a name="toc-shuffleplanes" href="#shuffleplanes">31.134 shuffleplanes</a>
<ul class="no-bullet">
<li><a name="toc-Examples-95" href="#Examples-95">31.134.1 Examples</a></li>
</ul></li>
<li><a name="toc-signalstats-1" href="#signalstats-1">31.135 signalstats</a>
<ul class="no-bullet">
<li><a name="toc-Examples-96" href="#Examples-96">31.135.1 Examples</a></li>
</ul></li>
<li><a name="toc-smartblur-1" href="#smartblur-1">31.136 smartblur</a></li>
<li><a name="toc-ssim" href="#ssim">31.137 ssim</a></li>
<li><a name="toc-stereo3d" href="#stereo3d">31.138 stereo3d</a>
<ul class="no-bullet">
<li><a name="toc-Examples-97" href="#Examples-97">31.138.1 Examples</a></li>
</ul></li>
<li><a name="toc-streamselect_002c-astreamselect" href="#streamselect_002c-astreamselect">31.139 streamselect, astreamselect</a>
<ul class="no-bullet">
<li><a name="toc-Commands-9" href="#Commands-9">31.139.1 Commands</a></li>
<li><a name="toc-Examples-98" href="#Examples-98">31.139.2 Examples</a></li>
</ul></li>
<li><a name="toc-sobel" href="#sobel">31.140 sobel</a></li>
<li><a name="toc-spp-1" href="#spp-1">31.141 spp</a></li>
<li><a name="toc-subtitles-1" href="#subtitles-1">31.142 subtitles</a></li>
<li><a name="toc-super2xsai" href="#super2xsai">31.143 super2xsai</a></li>
<li><a name="toc-swaprect" href="#swaprect">31.144 swaprect</a></li>
<li><a name="toc-swapuv" href="#swapuv">31.145 swapuv</a></li>
<li><a name="toc-telecine" href="#telecine">31.146 telecine</a></li>
<li><a name="toc-thumbnail" href="#thumbnail">31.147 thumbnail</a>
<ul class="no-bullet">
<li><a name="toc-Examples-99" href="#Examples-99">31.147.1 Examples</a></li>
</ul></li>
<li><a name="toc-tile" href="#tile">31.148 tile</a>
<ul class="no-bullet">
<li><a name="toc-Examples-100" href="#Examples-100">31.148.1 Examples</a></li>
</ul></li>
<li><a name="toc-tinterlace" href="#tinterlace">31.149 tinterlace</a></li>
<li><a name="toc-transpose" href="#transpose">31.150 transpose</a></li>
<li><a name="toc-trim" href="#trim">31.151 trim</a></li>
<li><a name="toc-unsharp-1" href="#unsharp-1">31.152 unsharp</a>
<ul class="no-bullet">
<li><a name="toc-Examples-101" href="#Examples-101">31.152.1 Examples</a></li>
</ul></li>
<li><a name="toc-uspp" href="#uspp">31.153 uspp</a></li>
<li><a name="toc-vaguedenoiser" href="#vaguedenoiser">31.154 vaguedenoiser</a></li>
<li><a name="toc-vectorscope" href="#vectorscope">31.155 vectorscope</a></li>
<li><a name="toc-vidstabdetect-1" href="#vidstabdetect-1">31.156 vidstabdetect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-102" href="#Examples-102">31.156.1 Examples</a></li>
</ul></li>
<li><a name="toc-vidstabtransform-1" href="#vidstabtransform-1">31.157 vidstabtransform</a>
<ul class="no-bullet">
<li><a name="toc-Options-29" href="#Options-29">31.157.1 Options</a></li>
<li><a name="toc-Examples-103" href="#Examples-103">31.157.2 Examples</a></li>
</ul></li>
<li><a name="toc-vflip" href="#vflip">31.158 vflip</a></li>
<li><a name="toc-vignette-1" href="#vignette-1">31.159 vignette</a>
<ul class="no-bullet">
<li><a name="toc-Expressions" href="#Expressions">31.159.1 Expressions</a></li>
<li><a name="toc-Examples-104" href="#Examples-104">31.159.2 Examples</a></li>
</ul></li>
<li><a name="toc-vstack" href="#vstack">31.160 vstack</a></li>
<li><a name="toc-w3fdif" href="#w3fdif">31.161 w3fdif</a></li>
<li><a name="toc-waveform" href="#waveform">31.162 waveform</a></li>
<li><a name="toc-weave" href="#weave">31.163 weave</a>
<ul class="no-bullet">
<li><a name="toc-Examples-105" href="#Examples-105">31.163.1 Examples</a></li>
</ul></li>
<li><a name="toc-xbr" href="#xbr">31.164 xbr</a></li>
<li><a name="toc-yadif-1" href="#yadif-1">31.165 yadif</a></li>
<li><a name="toc-zoompan" href="#zoompan">31.166 zoompan</a>
<ul class="no-bullet">
<li><a name="toc-Examples-106" href="#Examples-106">31.166.1 Examples</a></li>
</ul></li>
<li><a name="toc-zscale" href="#zscale">31.167 zscale</a>
<ul class="no-bullet">
<li><a name="toc-Options-30" href="#Options-30">31.167.1 Options</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Video-Sources" href="#Video-Sources">32 Video Sources</a>
<ul class="no-bullet">
<li><a name="toc-buffer" href="#buffer">32.1 buffer</a></li>
<li><a name="toc-cellauto" href="#cellauto">32.2 cellauto</a>
<ul class="no-bullet">
<li><a name="toc-Examples-107" href="#Examples-107">32.2.1 Examples</a></li>
</ul></li>
<li><a name="toc-coreimagesrc-1" href="#coreimagesrc-1">32.3 coreimagesrc</a>
<ul class="no-bullet">
<li><a name="toc-Examples-108" href="#Examples-108">32.3.1 Examples</a></li>
</ul></li>
<li><a name="toc-mandelbrot" href="#mandelbrot">32.4 mandelbrot</a></li>
<li><a name="toc-mptestsrc" href="#mptestsrc">32.5 mptestsrc</a></li>
<li><a name="toc-frei0r_005fsrc" href="#frei0r_005fsrc">32.6 frei0r_src</a></li>
<li><a name="toc-life" href="#life">32.7 life</a>
<ul class="no-bullet">
<li><a name="toc-Examples-109" href="#Examples-109">32.7.1 Examples</a></li>
</ul></li>
<li><a name="toc-allrgb_002c-allyuv_002c-color_002c-haldclutsrc_002c-nullsrc_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc" href="#allrgb_002c-allyuv_002c-color_002c-haldclutsrc_002c-nullsrc_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc">32.8 allrgb, allyuv, color, haldclutsrc, nullsrc, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc</a>
<ul class="no-bullet">
<li><a name="toc-Commands-10" href="#Commands-10">32.8.1 Commands</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Video-Sinks" href="#Video-Sinks">33 Video Sinks</a>
<ul class="no-bullet">
<li><a name="toc-buffersink" href="#buffersink">33.1 buffersink</a></li>
<li><a name="toc-nullsink" href="#nullsink">33.2 nullsink</a></li>
</ul></li>
<li><a name="toc-Multimedia-Filters" href="#Multimedia-Filters">34 Multimedia Filters</a>
<ul class="no-bullet">
<li><a name="toc-ahistogram" href="#ahistogram">34.1 ahistogram</a></li>
<li><a name="toc-aphasemeter" href="#aphasemeter">34.2 aphasemeter</a></li>
<li><a name="toc-avectorscope" href="#avectorscope">34.3 avectorscope</a>
<ul class="no-bullet">
<li><a name="toc-Examples-110" href="#Examples-110">34.3.1 Examples</a></li>
</ul></li>
<li><a name="toc-bench_002c-abench" href="#bench_002c-abench">34.4 bench, abench</a>
<ul class="no-bullet">
<li><a name="toc-Examples-111" href="#Examples-111">34.4.1 Examples</a></li>
</ul></li>
<li><a name="toc-concat-3" href="#concat-3">34.5 concat</a>
<ul class="no-bullet">
<li><a name="toc-Examples-112" href="#Examples-112">34.5.1 Examples</a></li>
</ul></li>
<li><a name="toc-drawgraph_002c-adrawgraph" href="#drawgraph_002c-adrawgraph">34.6 drawgraph, adrawgraph</a></li>
<li><a name="toc-ebur128-1" href="#ebur128-1">34.7 ebur128</a>
<ul class="no-bullet">
<li><a name="toc-Examples-113" href="#Examples-113">34.7.1 Examples</a></li>
</ul></li>
<li><a name="toc-interleave_002c-ainterleave" href="#interleave_002c-ainterleave">34.8 interleave, ainterleave</a>
<ul class="no-bullet">
<li><a name="toc-Examples-114" href="#Examples-114">34.8.1 Examples</a></li>
</ul></li>
<li><a name="toc-metadata_002c-ametadata" href="#metadata_002c-ametadata">34.9 metadata, ametadata</a>
<ul class="no-bullet">
<li><a name="toc-Examples-115" href="#Examples-115">34.9.1 Examples</a></li>
</ul></li>
<li><a name="toc-perms_002c-aperms" href="#perms_002c-aperms">34.10 perms, aperms</a></li>
<li><a name="toc-realtime_002c-arealtime" href="#realtime_002c-arealtime">34.11 realtime, arealtime</a></li>
<li><a name="toc-select_002c-aselect" href="#select_002c-aselect">34.12 select, aselect</a>
<ul class="no-bullet">
<li><a name="toc-Examples-116" href="#Examples-116">34.12.1 Examples</a></li>
</ul></li>
<li><a name="toc-sendcmd_002c-asendcmd" href="#sendcmd_002c-asendcmd">34.13 sendcmd, asendcmd</a>
<ul class="no-bullet">
<li><a name="toc-Commands-syntax" href="#Commands-syntax">34.13.1 Commands syntax</a></li>
<li><a name="toc-Examples-117" href="#Examples-117">34.13.2 Examples</a></li>
</ul></li>
<li><a name="toc-setpts_002c-asetpts" href="#setpts_002c-asetpts">34.14 setpts, asetpts</a>
<ul class="no-bullet">
<li><a name="toc-Examples-118" href="#Examples-118">34.14.1 Examples</a></li>
</ul></li>
<li><a name="toc-settb_002c-asettb" href="#settb_002c-asettb">34.15 settb, asettb</a>
<ul class="no-bullet">
<li><a name="toc-Examples-119" href="#Examples-119">34.15.1 Examples</a></li>
</ul></li>
<li><a name="toc-showcqt" href="#showcqt">34.16 showcqt</a>
<ul class="no-bullet">
<li><a name="toc-Examples-120" href="#Examples-120">34.16.1 Examples</a></li>
</ul></li>
<li><a name="toc-showfreqs" href="#showfreqs">34.17 showfreqs</a></li>
<li><a name="toc-showspectrum-1" href="#showspectrum-1">34.18 showspectrum</a>
<ul class="no-bullet">
<li><a name="toc-Examples-121" href="#Examples-121">34.18.1 Examples</a></li>
</ul></li>
<li><a name="toc-showspectrumpic" href="#showspectrumpic">34.19 showspectrumpic</a>
<ul class="no-bullet">
<li><a name="toc-Examples-122" href="#Examples-122">34.19.1 Examples</a></li>
</ul></li>
<li><a name="toc-showvolume" href="#showvolume">34.20 showvolume</a></li>
<li><a name="toc-showwaves" href="#showwaves">34.21 showwaves</a>
<ul class="no-bullet">
<li><a name="toc-Examples-123" href="#Examples-123">34.21.1 Examples</a></li>
</ul></li>
<li><a name="toc-showwavespic" href="#showwavespic">34.22 showwavespic</a>
<ul class="no-bullet">
<li><a name="toc-Examples-124" href="#Examples-124">34.22.1 Examples</a></li>
</ul></li>
<li><a name="toc-spectrumsynth" href="#spectrumsynth">34.23 spectrumsynth</a>
<ul class="no-bullet">
<li><a name="toc-Examples-125" href="#Examples-125">34.23.1 Examples</a></li>
</ul></li>
<li><a name="toc-split_002c-asplit" href="#split_002c-asplit">34.24 split, asplit</a>
<ul class="no-bullet">
<li><a name="toc-Examples-126" href="#Examples-126">34.24.1 Examples</a></li>
</ul></li>
<li><a name="toc-zmq_002c-azmq" href="#zmq_002c-azmq">34.25 zmq, azmq</a>
<ul class="no-bullet">
<li><a name="toc-Examples-127" href="#Examples-127">34.25.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a name="toc-Multimedia-Sources" href="#Multimedia-Sources">35 Multimedia Sources</a>
<ul class="no-bullet">
<li><a name="toc-amovie" href="#amovie">35.1 amovie</a></li>
<li><a name="toc-movie-1" href="#movie-1">35.2 movie</a>
<ul class="no-bullet">
<li><a name="toc-Examples-128" href="#Examples-128">35.2.1 Examples</a></li>
<li><a name="toc-Commands-11" href="#Commands-11">35.2.2 Commands</a></li>
</ul></li>
</ul></li>
<li><a name="toc-See-Also" href="#See-Also">36 See Also</a></li>
<li><a name="toc-Authors" href="#Authors">37 Authors</a></li>
</ul>
</div>
<a name="Synopsis"></a>
<h2 class="chapter">1 Synopsis<span class="pull-right"><a class="anchor hidden-xs" href="#Synopsis" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Synopsis" aria-hidden="true">TOC</a></span></h2>
<p>ffprobe [<var>options</var>] [<samp>input_file</samp>]
</p>
<a name="Description"></a>
<h2 class="chapter">2 Description<span class="pull-right"><a class="anchor hidden-xs" href="#Description" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Description" aria-hidden="true">TOC</a></span></h2>
<p>ffprobe gathers information from multimedia streams and prints it in
human- and machine-readable fashion.
</p>
<p>For example it can be used to check the format of the container used
by a multimedia stream and the format and type of each media stream
contained in it.
</p>
<p>If a filename is specified in input, ffprobe will try to open and
probe the file content. If the file cannot be opened or recognized as
a multimedia file, a positive exit code is returned.
</p>
<p>ffprobe may be employed both as a standalone application or in
combination with a textual filter, which may perform more
sophisticated processing, e.g. statistical processing or plotting.
</p>
<p>Options are used to list some of the formats supported by ffprobe or
for specifying which information to display, and for setting how
ffprobe will show it.
</p>
<p>ffprobe output is designed to be easily parsable by a textual filter,
and consists of one or more sections of a form defined by the selected
writer, which is specified by the <samp>print_format</samp> option.
</p>
<p>Sections may contain other nested sections, and are identified by a
name (which may be shared by other sections), and an unique
name. See the output of <samp>sections</samp>.
</p>
<p>Metadata tags stored in the container or in the streams are recognized
and printed in the corresponding &quot;FORMAT&quot;, &quot;STREAM&quot; or &quot;PROGRAM_STREAM&quot;
section.
</p>
<a name="Options"></a>
<h2 class="chapter">3 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options" aria-hidden="true">TOC</a></span></h2>
<p>All the numerical options, if not specified otherwise, accept a string
representing a number as input, which may be followed by one of the SI
unit prefixes, for example: &rsquo;K&rsquo;, &rsquo;M&rsquo;, or &rsquo;G&rsquo;.
</p>
<p>If &rsquo;i&rsquo; is appended to the SI unit prefix, the complete prefix will be
interpreted as a unit prefix for binary multiples, which are based on
powers of 1024 instead of powers of 1000. Appending &rsquo;B&rsquo; to the SI unit
prefix multiplies the value by 8. This allows using, for example:
&rsquo;KB&rsquo;, &rsquo;MiB&rsquo;, &rsquo;G&rsquo; and &rsquo;B&rsquo; as number suffixes.
</p>
<p>Options which do not take arguments are boolean options, and set the
corresponding value to true. They can be set to false by prefixing
the option name with &quot;no&quot;. For example using &quot;-nofoo&quot;
will set the boolean option with name &quot;foo&quot; to false.
</p>
<a name="Stream-specifiers"></a><a name="Stream-specifiers-1"></a>
<h3 class="section">3.1 Stream specifiers<span class="pull-right"><a class="anchor hidden-xs" href="#Stream-specifiers-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Stream-specifiers-1" aria-hidden="true">TOC</a></span></h3>
<p>Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
are used to precisely specify which stream(s) a given option belongs to.
</p>
<p>A stream specifier is a string generally appended to the option name and
separated from it by a colon. E.g. <code>-codec:a:1 ac3</code> contains the
<code>a:1</code> stream specifier, which matches the second audio stream. Therefore, it
would select the ac3 codec for the second audio stream.
</p>
<p>A stream specifier can match several streams, so that the option is applied to all
of them. E.g. the stream specifier in <code>-b:a 128k</code> matches all audio
streams.
</p>
<p>An empty stream specifier matches all streams. For example, <code>-codec copy</code>
or <code>-codec: copy</code> would copy all the streams without reencoding.
</p>
<p>Possible forms of stream specifiers are:
</p><dl compact="compact">
<dt><samp><var>stream_index</var></samp></dt>
<dd><p>Matches the stream with this index. E.g. <code>-threads:1 4</code> would set the
thread count for the second stream to 4.
</p></dd>
<dt><samp><var>stream_type</var>[:<var>stream_index</var>]</samp></dt>
<dd><p><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;
for subtitle, &rsquo;d&rsquo; for data, and &rsquo;t&rsquo; for attachments. &rsquo;v&rsquo; matches all video
streams, &rsquo;V&rsquo; only matches video streams which are not attached pictures, video
thumbnails or cover arts. If <var>stream_index</var> is given, then it matches
stream number <var>stream_index</var> of this type. Otherwise, it matches all
streams of this type.
</p></dd>
<dt><samp>p:<var>program_id</var>[:<var>stream_index</var>]</samp></dt>
<dd><p>If <var>stream_index</var> is given, then it matches the stream with number <var>stream_index</var>
in the program with the id <var>program_id</var>. Otherwise, it matches all streams in the
program.
</p></dd>
<dt><samp>#<var>stream_id</var> or i:<var>stream_id</var></samp></dt>
<dd><p>Match the stream by stream id (e.g. PID in MPEG-TS container).
</p></dd>
<dt><samp>m:<var>key</var>[:<var>value</var>]</samp></dt>
<dd><p>Matches streams with the metadata tag <var>key</var> having the specified value. If
<var>value</var> is not given, matches streams that contain the given tag with any
value.
</p></dd>
<dt><samp>u</samp></dt>
<dd><p>Matches streams with usable configuration, the codec must be defined and the
essential information such as video dimension or audio sample rate must be present.
</p>
<p>Note that in <code>ffmpeg</code>, matching by metadata will only work properly for
input files.
</p></dd>
</dl>
<a name="Generic-options"></a>
<h3 class="section">3.2 Generic options<span class="pull-right"><a class="anchor hidden-xs" href="#Generic-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Generic-options" aria-hidden="true">TOC</a></span></h3>
<p>These options are shared amongst the ff* tools.
</p>
<dl compact="compact">
<dt><samp>-L</samp></dt>
<dd><p>Show license.
</p>
</dd>
<dt><samp>-h, -?, -help, --help [<var>arg</var>]</samp></dt>
<dd><p>Show help. An optional parameter may be specified to print help about a specific
item. If no argument is specified, only basic (non advanced) tool
options are shown.
</p>
<p>Possible values of <var>arg</var> are:
</p><dl compact="compact">
<dt><samp>long</samp></dt>
<dd><p>Print advanced tool options in addition to the basic tool options.
</p>
</dd>
<dt><samp>full</samp></dt>
<dd><p>Print complete list of options, including shared and private options
for encoders, decoders, demuxers, muxers, filters, etc.
</p>
</dd>
<dt><samp>decoder=<var>decoder_name</var></samp></dt>
<dd><p>Print detailed information about the decoder named <var>decoder_name</var>. Use the
<samp>-decoders</samp> option to get a list of all decoders.
</p>
</dd>
<dt><samp>encoder=<var>encoder_name</var></samp></dt>
<dd><p>Print detailed information about the encoder named <var>encoder_name</var>. Use the
<samp>-encoders</samp> option to get a list of all encoders.
</p>
</dd>
<dt><samp>demuxer=<var>demuxer_name</var></samp></dt>
<dd><p>Print detailed information about the demuxer named <var>demuxer_name</var>. Use the
<samp>-formats</samp> option to get a list of all demuxers and muxers.
</p>
</dd>
<dt><samp>muxer=<var>muxer_name</var></samp></dt>
<dd><p>Print detailed information about the muxer named <var>muxer_name</var>. Use the
<samp>-formats</samp> option to get a list of all muxers and demuxers.
</p>
</dd>
<dt><samp>filter=<var>filter_name</var></samp></dt>
<dd><p>Print detailed information about the filter name <var>filter_name</var>. Use the
<samp>-filters</samp> option to get a list of all filters.
</p></dd>
</dl>
</dd>
<dt><samp>-version</samp></dt>
<dd><p>Show version.
</p>
</dd>
<dt><samp>-formats</samp></dt>
<dd><p>Show available formats (including devices).
</p>
</dd>
<dt><samp>-devices</samp></dt>
<dd><p>Show available devices.
</p>
</dd>
<dt><samp>-codecs</samp></dt>
<dd><p>Show all codecs known to libavcodec.
</p>
<p>Note that the term &rsquo;codec&rsquo; is used throughout this documentation as a shortcut
for what is more correctly called a media bitstream format.
</p>
</dd>
<dt><samp>-decoders</samp></dt>
<dd><p>Show available decoders.
</p>
</dd>
<dt><samp>-encoders</samp></dt>
<dd><p>Show all available encoders.
</p>
</dd>
<dt><samp>-bsfs</samp></dt>
<dd><p>Show available bitstream filters.
</p>
</dd>
<dt><samp>-protocols</samp></dt>
<dd><p>Show available protocols.
</p>
</dd>
<dt><samp>-filters</samp></dt>
<dd><p>Show available libavfilter filters.
</p>
</dd>
<dt><samp>-pix_fmts</samp></dt>
<dd><p>Show available pixel formats.
</p>
</dd>
<dt><samp>-sample_fmts</samp></dt>
<dd><p>Show available sample formats.
</p>
</dd>
<dt><samp>-layouts</samp></dt>
<dd><p>Show channel names and standard channel layouts.
</p>
</dd>
<dt><samp>-colors</samp></dt>
<dd><p>Show recognized color names.
</p>
</dd>
<dt><samp>-sources <var>device</var>[,<var>opt1</var>=<var>val1</var>[,<var>opt2</var>=<var>val2</var>]...]</samp></dt>
<dd><p>Show autodetected sources of the intput device.
Some devices may provide system-dependent source names that cannot be autodetected.
The returned list cannot be assumed to be always complete.
</p><div class="example">
<pre class="example">ffmpeg -sources pulse,server=192.168.0.4
</pre></div>
</dd>
<dt><samp>-sinks <var>device</var>[,<var>opt1</var>=<var>val1</var>[,<var>opt2</var>=<var>val2</var>]...]</samp></dt>
<dd><p>Show autodetected sinks of the output device.
Some devices may provide system-dependent sink names that cannot be autodetected.
The returned list cannot be assumed to be always complete.
</p><div class="example">
<pre class="example">ffmpeg -sinks pulse,server=192.168.0.4
</pre></div>
</dd>
<dt><samp>-loglevel [repeat+]<var>loglevel</var> | -v [repeat+]<var>loglevel</var></samp></dt>
<dd><p>Set the logging level used by the library.
Adding &quot;repeat+&quot; indicates that repeated log output should not be compressed
to the first line and the &quot;Last message repeated n times&quot; line will be
omitted. &quot;repeat&quot; can also be used alone.
If &quot;repeat&quot; is used alone, and with no prior loglevel set, the default
loglevel will be used. If multiple loglevel parameters are given, using
&rsquo;repeat&rsquo; will not change the loglevel.
<var>loglevel</var> is a string or a number containing one of the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>quiet, -8</samp>&rsquo;</dt>
<dd><p>Show nothing at all; be silent.
</p></dd>
<dt>&lsquo;<samp>panic, 0</samp>&rsquo;</dt>
<dd><p>Only show fatal errors which could lead the process to crash, such as
an assertion failure. This is not currently used for anything.
</p></dd>
<dt>&lsquo;<samp>fatal, 8</samp>&rsquo;</dt>
<dd><p>Only show fatal errors. These are errors after which the process absolutely
cannot continue.
</p></dd>
<dt>&lsquo;<samp>error, 16</samp>&rsquo;</dt>
<dd><p>Show all errors, including ones which can be recovered from.
</p></dd>
<dt>&lsquo;<samp>warning, 24</samp>&rsquo;</dt>
<dd><p>Show all warnings and errors. Any message related to possibly
incorrect or unexpected events will be shown.
</p></dd>
<dt>&lsquo;<samp>info, 32</samp>&rsquo;</dt>
<dd><p>Show informative messages during processing. This is in addition to
warnings and errors. This is the default value.
</p></dd>
<dt>&lsquo;<samp>verbose, 40</samp>&rsquo;</dt>
<dd><p>Same as <code>info</code>, except more verbose.
</p></dd>
<dt>&lsquo;<samp>debug, 48</samp>&rsquo;</dt>
<dd><p>Show everything, including debugging information.
</p></dd>
<dt>&lsquo;<samp>trace, 56</samp>&rsquo;</dt>
</dl>
<p>By default the program logs to stderr. If coloring is supported by the
terminal, colors are used to mark errors and warnings. Log coloring
can be disabled setting the environment variable
<code>AV_LOG_FORCE_NOCOLOR</code> or <code>NO_COLOR</code>, or can be forced setting
the environment variable <code>AV_LOG_FORCE_COLOR</code>.
The use of the environment variable <code>NO_COLOR</code> is deprecated and
will be dropped in a future FFmpeg version.
</p>
</dd>
<dt><samp>-report</samp></dt>
<dd><p>Dump full command line and console output to a file named
<code><var>program</var>-<var>YYYYMMDD</var>-<var>HHMMSS</var>.log</code> in the current
directory.
This file can be useful for bug reports.
It also implies <code>-loglevel verbose</code>.
</p>
<p>Setting the environment variable <code>FFREPORT</code> to any value has the
same effect. If the value is a &rsquo;:&rsquo;-separated key=value sequence, these
options will affect the report; option values must be escaped if they
contain special characters or the options delimiter &rsquo;:&rsquo; (see the
&ldquo;Quoting and escaping&rdquo; section in the ffmpeg-utils manual).
</p>
<p>The following options are recognized:
</p><dl compact="compact">
<dt><samp>file</samp></dt>
<dd><p>set the file name to use for the report; <code>%p</code> is expanded to the name
of the program, <code>%t</code> is expanded to a timestamp, <code>%%</code> is expanded
to a plain <code>%</code>
</p></dd>
<dt><samp>level</samp></dt>
<dd><p>set the log verbosity level using a numerical value (see <code>-loglevel</code>).
</p></dd>
</dl>
<p>For example, to output a report to a file named <samp>ffreport.log</samp>
using a log level of <code>32</code> (alias for log level <code>info</code>):
</p>
<div class="example">
<pre class="example">FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
</pre></div>
<p>Errors in parsing the environment variable are not fatal, and will not
appear in the report.
</p>
</dd>
<dt><samp>-hide_banner</samp></dt>
<dd><p>Suppress printing banner.
</p>
<p>All FFmpeg tools will normally show a copyright notice, build options
and library versions. This option can be used to suppress printing
this information.
</p>
</dd>
<dt><samp>-cpuflags flags (<em>global</em>)</samp></dt>
<dd><p>Allows setting and clearing cpu flags. This option is intended
for testing. Do not use it unless you know what you&rsquo;re doing.
</p><div class="example">
<pre class="example">ffmpeg -cpuflags -sse+mmx ...
ffmpeg -cpuflags mmx ...
ffmpeg -cpuflags 0 ...
</pre></div>
<p>Possible flags for this option are:
</p><dl compact="compact">
<dt>&lsquo;<samp>x86</samp>&rsquo;</dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>mmx</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mmxext</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse2slow</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse3</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse3slow</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ssse3</samp>&rsquo;</dt>
<dt>&lsquo;<samp>atom</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse4.1</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sse4.2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>avx</samp>&rsquo;</dt>
<dt>&lsquo;<samp>avx2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>xop</samp>&rsquo;</dt>
<dt>&lsquo;<samp>fma3</samp>&rsquo;</dt>
<dt>&lsquo;<samp>fma4</samp>&rsquo;</dt>
<dt>&lsquo;<samp>3dnow</samp>&rsquo;</dt>
<dt>&lsquo;<samp>3dnowext</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bmi1</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bmi2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cmov</samp>&rsquo;</dt>
</dl>
</dd>
<dt>&lsquo;<samp>ARM</samp>&rsquo;</dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>armv5te</samp>&rsquo;</dt>
<dt>&lsquo;<samp>armv6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>armv6t2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vfp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vfpv3</samp>&rsquo;</dt>
<dt>&lsquo;<samp>neon</samp>&rsquo;</dt>
<dt>&lsquo;<samp>setend</samp>&rsquo;</dt>
</dl>
</dd>
<dt>&lsquo;<samp>AArch64</samp>&rsquo;</dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>armv8</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vfp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>neon</samp>&rsquo;</dt>
</dl>
</dd>
<dt>&lsquo;<samp>PowerPC</samp>&rsquo;</dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>altivec</samp>&rsquo;</dt>
</dl>
</dd>
<dt>&lsquo;<samp>Specific Processors</samp>&rsquo;</dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>pentium2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>pentium3</samp>&rsquo;</dt>
<dt>&lsquo;<samp>pentium4</samp>&rsquo;</dt>
<dt>&lsquo;<samp>k6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>k62</samp>&rsquo;</dt>
<dt>&lsquo;<samp>athlon</samp>&rsquo;</dt>
<dt>&lsquo;<samp>athlonxp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>k8</samp>&rsquo;</dt>
</dl>
</dd>
</dl>
</dd>
<dt><samp>-opencl_bench</samp></dt>
<dd><p>This option is used to benchmark all available OpenCL devices and print the
results. This option is only available when FFmpeg has been compiled with
<code>--enable-opencl</code>.
</p>
<p>When FFmpeg is configured with <code>--enable-opencl</code>, the options for the
global OpenCL context are set via <samp>-opencl_options</samp>. See the
&quot;OpenCL Options&quot; section in the ffmpeg-utils manual for the complete list of
supported options. Amongst others, these options include the ability to select
a specific platform and device to run the OpenCL code on. By default, FFmpeg
will run on the first device of the first platform. While the options for the
global OpenCL context provide flexibility to the user in selecting the OpenCL
device of their choice, most users would probably want to select the fastest
OpenCL device for their system.
</p>
<p>This option assists the selection of the most efficient configuration by
identifying the appropriate device for the user&rsquo;s system. The built-in
benchmark is run on all the OpenCL devices and the performance is measured for
each device. The devices in the results list are sorted based on their
performance with the fastest device listed first. The user can subsequently
invoke <code>ffmpeg</code> using the device deemed most appropriate via
<samp>-opencl_options</samp> to obtain the best performance for the OpenCL
accelerated code.
</p>
<p>Typical usage to use the fastest OpenCL device involve the following steps.
</p>
<p>Run the command:
</p><div class="example">
<pre class="example">ffmpeg -opencl_bench
</pre></div>
<p>Note down the platform ID (<var>pidx</var>) and device ID (<var>didx</var>) of the first
i.e. fastest device in the list.
Select the platform and device using the command:
</p><div class="example">
<pre class="example">ffmpeg -opencl_options platform_idx=<var>pidx</var>:device_idx=<var>didx</var> ...
</pre></div>
</dd>
<dt><samp>-opencl_options options (<em>global</em>)</samp></dt>
<dd><p>Set OpenCL environment options. This option is only available when
FFmpeg has been compiled with <code>--enable-opencl</code>.
</p>
<p><var>options</var> must be a list of <var>key</var>=<var>value</var> option pairs
separated by &rsquo;:&rsquo;. See the &ldquo;OpenCL Options&rdquo; section in the
ffmpeg-utils manual for the list of supported options.
</p></dd>
</dl>
<a name="AVOptions"></a>
<h3 class="section">3.3 AVOptions<span class="pull-right"><a class="anchor hidden-xs" href="#AVOptions" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-AVOptions" aria-hidden="true">TOC</a></span></h3>
<p>These options are provided directly by the libavformat, libavdevice and
libavcodec libraries. To see the list of available AVOptions, use the
<samp>-help</samp> option. They are separated into two categories:
</p><dl compact="compact">
<dt><samp>generic</samp></dt>
<dd><p>These options can be set for any container, codec or device. Generic options
are listed under AVFormatContext options for containers/devices and under
AVCodecContext options for codecs.
</p></dd>
<dt><samp>private</samp></dt>
<dd><p>These options are specific to the given container, device or codec. Private
options are listed under their corresponding containers/devices/codecs.
</p></dd>
</dl>
<p>For example to write an ID3v2.3 header instead of a default ID3v2.4 to
an MP3 file, use the <samp>id3v2_version</samp> private option of the MP3
muxer:
</p><div class="example">
<pre class="example">ffmpeg -i input.flac -id3v2_version 3 out.mp3
</pre></div>
<p>All codec AVOptions are per-stream, and thus a stream specifier
should be attached to them.
</p>
<p>Note: the <samp>-nooption</samp> syntax cannot be used for boolean
AVOptions, use <samp>-option 0</samp>/<samp>-option 1</samp>.
</p>
<p>Note: the old undocumented way of specifying per-stream AVOptions by
prepending v/a/s to the options name is now obsolete and will be
removed soon.
</p>
<a name="Main-options"></a>
<h3 class="section">3.4 Main options<span class="pull-right"><a class="anchor hidden-xs" href="#Main-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Main-options" aria-hidden="true">TOC</a></span></h3>
<dl compact="compact">
<dt><samp>-f <var>format</var></samp></dt>
<dd><p>Force format to use.
</p>
</dd>
<dt><samp>-unit</samp></dt>
<dd><p>Show the unit of the displayed values.
</p>
</dd>
<dt><samp>-prefix</samp></dt>
<dd><p>Use SI prefixes for the displayed values.
Unless the &quot;-byte_binary_prefix&quot; option is used all the prefixes
are decimal.
</p>
</dd>
<dt><samp>-byte_binary_prefix</samp></dt>
<dd><p>Force the use of binary prefixes for byte values.
</p>
</dd>
<dt><samp>-sexagesimal</samp></dt>
<dd><p>Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
</p>
</dd>
<dt><samp>-pretty</samp></dt>
<dd><p>Prettify the format of the displayed values, it corresponds to the
options &quot;-unit -prefix -byte_binary_prefix -sexagesimal&quot;.
</p>
</dd>
<dt><samp>-of, -print_format <var>writer_name</var>[=<var>writer_options</var>]</samp></dt>
<dd><p>Set the output printing format.
</p>
<p><var>writer_name</var> specifies the name of the writer, and
<var>writer_options</var> specifies the options to be passed to the writer.
</p>
<p>For example for printing the output in JSON format, specify:
</p><div class="example">
<pre class="example">-print_format json
</pre></div>
<p>For more details on the available output printing formats, see the
Writers section below.
</p>
</dd>
<dt><samp>-sections</samp></dt>
<dd><p>Print sections structure and section information, and exit. The output
is not meant to be parsed by a machine.
</p>
</dd>
<dt><samp>-select_streams <var>stream_specifier</var></samp></dt>
<dd><p>Select only the streams specified by <var>stream_specifier</var>. This
option affects only the options related to streams
(e.g. <code>show_streams</code>, <code>show_packets</code>, etc.).
</p>
<p>For example to show only audio streams, you can use the command:
</p><div class="example">
<pre class="example">ffprobe -show_streams -select_streams a INPUT
</pre></div>
<p>To show only video packets belonging to the video stream with index 1:
</p><div class="example">
<pre class="example">ffprobe -show_packets -select_streams v:1 INPUT
</pre></div>
</dd>
<dt><samp>-show_data</samp></dt>
<dd><p>Show payload data, as a hexadecimal and ASCII dump. Coupled with
<samp>-show_packets</samp>, it will dump the packets&rsquo; data. Coupled with
<samp>-show_streams</samp>, it will dump the codec extradata.
</p>
<p>The dump is printed as the &quot;data&quot; field. It may contain newlines.
</p>
</dd>
<dt><samp>-show_data_hash <var>algorithm</var></samp></dt>
<dd><p>Show a hash of payload data, for packets with <samp>-show_packets</samp> and for
codec extradata with <samp>-show_streams</samp>.
</p>
</dd>
<dt><samp>-show_error</samp></dt>
<dd><p>Show information about the error found when trying to probe the input.
</p>
<p>The error information is printed within a section with name &quot;ERROR&quot;.
</p>
</dd>
<dt><samp>-show_format</samp></dt>
<dd><p>Show information about the container format of the input multimedia
stream.
</p>
<p>All the container format information is printed within a section with
name &quot;FORMAT&quot;.
</p>
</dd>
<dt><samp>-show_format_entry <var>name</var></samp></dt>
<dd><p>Like <samp>-show_format</samp>, but only prints the specified entry of the
container format information, rather than all. This option may be given more
than once, then all specified entries will be shown.
</p>
<p>This option is deprecated, use <code>show_entries</code> instead.
</p>
</dd>
<dt><samp>-show_entries <var>section_entries</var></samp></dt>
<dd><p>Set list of entries to show.
</p>
<p>Entries are specified according to the following
syntax. <var>section_entries</var> contains a list of section entries
separated by <code>:</code>. Each section entry is composed by a section
name (or unique name), optionally followed by a list of entries local
to that section, separated by <code>,</code>.
</p>
<p>If section name is specified but is followed by no <code>=</code>, all
entries are printed to output, together with all the contained
sections. Otherwise only the entries specified in the local section
entries list are printed. In particular, if <code>=</code> is specified but
the list of local entries is empty, then no entries will be shown for
that section.
</p>
<p>Note that the order of specification of the local section entries is
not honored in the output, and the usual display order will be
retained.
</p>
<p>The formal syntax is given by:
</p><div class="example">
<pre class="example"><var>LOCAL_SECTION_ENTRIES</var> ::= <var>SECTION_ENTRY_NAME</var>[,<var>LOCAL_SECTION_ENTRIES</var>]
<var>SECTION_ENTRY</var> ::= <var>SECTION_NAME</var>[=[<var>LOCAL_SECTION_ENTRIES</var>]]
<var>SECTION_ENTRIES</var> ::= <var>SECTION_ENTRY</var>[:<var>SECTION_ENTRIES</var>]
</pre></div>
<p>For example, to show only the index and type of each stream, and the PTS
time, duration time, and stream index of the packets, you can specify
the argument:
</p><div class="example">
<pre class="example">packet=pts_time,duration_time,stream_index : stream=index,codec_type
</pre></div>
<p>To show all the entries in the section &quot;format&quot;, but only the codec
type in the section &quot;stream&quot;, specify the argument:
</p><div class="example">
<pre class="example">format : stream=codec_type
</pre></div>
<p>To show all the tags in the stream and format sections:
</p><div class="example">
<pre class="example">stream_tags : format_tags
</pre></div>
<p>To show only the <code>title</code> tag (if available) in the stream
sections:
</p><div class="example">
<pre class="example">stream_tags=title
</pre></div>
</dd>
<dt><samp>-show_packets</samp></dt>
<dd><p>Show information about each packet contained in the input multimedia
stream.
</p>
<p>The information for each single packet is printed within a dedicated
section with name &quot;PACKET&quot;.
</p>
</dd>
<dt><samp>-show_frames</samp></dt>
<dd><p>Show information about each frame and subtitle contained in the input
multimedia stream.
</p>
<p>The information for each single frame is printed within a dedicated
section with name &quot;FRAME&quot; or &quot;SUBTITLE&quot;.
</p>
</dd>
<dt><samp>-show_streams</samp></dt>
<dd><p>Show information about each media stream contained in the input
multimedia stream.
</p>
<p>Each media stream information is printed within a dedicated section
with name &quot;STREAM&quot;.
</p>
</dd>
<dt><samp>-show_programs</samp></dt>
<dd><p>Show information about programs and their streams contained in the input
multimedia stream.
</p>
<p>Each media stream information is printed within a dedicated section
with name &quot;PROGRAM_STREAM&quot;.
</p>
</dd>
<dt><samp>-show_chapters</samp></dt>
<dd><p>Show information about chapters stored in the format.
</p>
<p>Each chapter is printed within a dedicated section with name &quot;CHAPTER&quot;.
</p>
</dd>
<dt><samp>-count_frames</samp></dt>
<dd><p>Count the number of frames per stream and report it in the
corresponding stream section.
</p>
</dd>
<dt><samp>-count_packets</samp></dt>
<dd><p>Count the number of packets per stream and report it in the
corresponding stream section.
</p>
</dd>
<dt><samp>-read_intervals <var>read_intervals</var></samp></dt>
<dd>
<p>Read only the specified intervals. <var>read_intervals</var> must be a
sequence of interval specifications separated by &quot;,&quot;.
<code>ffprobe</code> will seek to the interval starting point, and will
continue reading from that.
</p>
<p>Each interval is specified by two optional parts, separated by &quot;%&quot;.
</p>
<p>The first part specifies the interval start position. It is
interpreted as an abolute position, or as a relative offset from the
current position if it is preceded by the &quot;+&quot; character. If this first
part is not specified, no seeking will be performed when reading this
interval.
</p>
<p>The second part specifies the interval end position. It is interpreted
as an absolute position, or as a relative offset from the current
position if it is preceded by the &quot;+&quot; character. If the offset
specification starts with &quot;#&quot;, it is interpreted as the number of
packets to read (not including the flushing packets) from the interval
start. If no second part is specified, the program will read until the
end of the input.
</p>
<p>Note that seeking is not accurate, thus the actual interval start
point may be different from the specified position. Also, when an
interval duration is specified, the absolute end time will be computed
by adding the duration to the interval start point found by seeking
the file, rather than to the specified start value.
</p>
<p>The formal syntax is given by:
</p><div class="example">
<pre class="example"><var>INTERVAL</var> ::= [<var>START</var>|+<var>START_OFFSET</var>][%[<var>END</var>|+<var>END_OFFSET</var>]]
<var>INTERVALS</var> ::= <var>INTERVAL</var>[,<var>INTERVALS</var>]
</pre></div>
<p>A few examples follow.
</p><ul>
<li> Seek to time 10, read packets until 20 seconds after the found seek
point, then seek to position <code>01:30</code> (1 minute and thirty
seconds) and read packets until position <code>01:45</code>.
<div class="example">
<pre class="example">10%+20,01:30%01:45
</pre></div>
</li><li> Read only 42 packets after seeking to position <code>01:23</code>:
<div class="example">
<pre class="example">01:23%+#42
</pre></div>
</li><li> Read only the first 20 seconds from the start:
<div class="example">
<pre class="example">%+20
</pre></div>
</li><li> Read from the start until position <code>02:30</code>:
<div class="example">
<pre class="example">%02:30
</pre></div>
</li></ul>
</dd>
<dt><samp>-show_private_data, -private</samp></dt>
<dd><p>Show private data, that is data depending on the format of the
particular shown element.
This option is enabled by default, but you may need to disable it
for specific uses, for example when creating XSD-compliant XML output.
</p>
</dd>
<dt><samp>-show_program_version</samp></dt>
<dd><p>Show information related to program version.
</p>
<p>Version information is printed within a section with name
&quot;PROGRAM_VERSION&quot;.
</p>
</dd>
<dt><samp>-show_library_versions</samp></dt>
<dd><p>Show information related to library versions.
</p>
<p>Version information for each library is printed within a section with
name &quot;LIBRARY_VERSION&quot;.
</p>
</dd>
<dt><samp>-show_versions</samp></dt>
<dd><p>Show information related to program and library versions. This is the
equivalent of setting both <samp>-show_program_version</samp> and
<samp>-show_library_versions</samp> options.
</p>
</dd>
<dt><samp>-show_pixel_formats</samp></dt>
<dd><p>Show information about all pixel formats supported by FFmpeg.
</p>
<p>Pixel format information for each format is printed within a section
with name &quot;PIXEL_FORMAT&quot;.
</p>
</dd>
<dt><samp>-bitexact</samp></dt>
<dd><p>Force bitexact output, useful to produce output which is not dependent
on the specific build.
</p>
</dd>
<dt><samp>-i <var>input_file</var></samp></dt>
<dd><p>Read <var>input_file</var>.
</p>
</dd>
</dl>
<a name="Writers"></a>
<h2 class="chapter">4 Writers<span class="pull-right"><a class="anchor hidden-xs" href="#Writers" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Writers" aria-hidden="true">TOC</a></span></h2>
<p>A writer defines the output format adopted by <code>ffprobe</code>, and will be
used for printing all the parts of the output.
</p>
<p>A writer may accept one or more arguments, which specify the options
to adopt. The options are specified as a list of <var>key</var>=<var>value</var>
pairs, separated by &quot;:&quot;.
</p>
<p>All writers support the following options:
</p>
<dl compact="compact">
<dt><samp>string_validation, sv</samp></dt>
<dd><p>Set string validation mode.
</p>
<p>The following values are accepted.
</p><dl compact="compact">
<dt>&lsquo;<samp>fail</samp>&rsquo;</dt>
<dd><p>The writer will fail immediately in case an invalid string (UTF-8)
sequence or code point is found in the input. This is especially
useful to validate input metadata.
</p>
</dd>
<dt>&lsquo;<samp>ignore</samp>&rsquo;</dt>
<dd><p>Any validation error will be ignored. This will result in possibly
broken output, especially with the json or xml writer.
</p>
</dd>
<dt>&lsquo;<samp>replace</samp>&rsquo;</dt>
<dd><p>The writer will substitute invalid UTF-8 sequences or code points with
the string specified with the <samp>string_validation_replacement</samp>.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>replace</samp>&rsquo;.
</p>
</dd>
<dt><samp>string_validation_replacement, svr</samp></dt>
<dd><p>Set replacement string to use in case <samp>string_validation</samp> is
set to &lsquo;<samp>replace</samp>&rsquo;.
</p>
<p>In case the option is not specified, the writer will assume the empty
string, that is it will remove the invalid sequences from the input
strings.
</p></dd>
</dl>
<p>A description of the currently available writers follows.
</p>
<a name="default"></a>
<h3 class="section">4.1 default<span class="pull-right"><a class="anchor hidden-xs" href="#default" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-default" aria-hidden="true">TOC</a></span></h3>
<p>Default format.
</p>
<p>Print each section in the form:
</p><div class="example">
<pre class="example">[SECTION]
key1=val1
...
keyN=valN
[/SECTION]
</pre></div>
<p>Metadata tags are printed as a line in the corresponding FORMAT, STREAM or
PROGRAM_STREAM section, and are prefixed by the string &quot;TAG:&quot;.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>nokey, nk</samp></dt>
<dd><p>If set to 1 specify not to print the key of each field. Default value
is 0.
</p>
</dd>
<dt><samp>noprint_wrappers, nw</samp></dt>
<dd><p>If set to 1 specify not to print the section header and footer.
Default value is 0.
</p></dd>
</dl>
<a name="compact_002c-csv"></a>
<h3 class="section">4.2 compact, csv<span class="pull-right"><a class="anchor hidden-xs" href="#compact_002c-csv" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-compact_002c-csv" aria-hidden="true">TOC</a></span></h3>
<p>Compact and CSV format.
</p>
<p>The <code>csv</code> writer is equivalent to <code>compact</code>, but supports
different defaults.
</p>
<p>Each section is printed on a single line.
If no option is specifid, the output has the form:
</p><div class="example">
<pre class="example">section|key1=val1| ... |keyN=valN
</pre></div>
<p>Metadata tags are printed in the corresponding &quot;format&quot; or &quot;stream&quot;
section. A metadata tag key, if printed, is prefixed by the string
&quot;tag:&quot;.
</p>
<p>The description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>item_sep, s</samp></dt>
<dd><p>Specify the character to use for separating fields in the output line.
It must be a single printable character, it is &quot;|&quot; by default (&quot;,&quot; for
the <code>csv</code> writer).
</p>
</dd>
<dt><samp>nokey, nk</samp></dt>
<dd><p>If set to 1 specify not to print the key of each field. Its default
value is 0 (1 for the <code>csv</code> writer).
</p>
</dd>
<dt><samp>escape, e</samp></dt>
<dd><p>Set the escape mode to use, default to &quot;c&quot; (&quot;csv&quot; for the <code>csv</code>
writer).
</p>
<p>It can assume one of the following values:
</p><dl compact="compact">
<dt><samp>c</samp></dt>
<dd><p>Perform C-like escaping. Strings containing a newline (&lsquo;<samp>\n</samp>&rsquo;), carriage
return (&lsquo;<samp>\r</samp>&rsquo;), a tab (&lsquo;<samp>\t</samp>&rsquo;), a form feed (&lsquo;<samp>\f</samp>&rsquo;), the escaping
character (&lsquo;<samp>\</samp>&rsquo;) or the item separator character <var>SEP</var> are escaped
using C-like fashioned escaping, so that a newline is converted to the
sequence &lsquo;<samp>\n</samp>&rsquo;, a carriage return to &lsquo;<samp>\r</samp>&rsquo;, &lsquo;<samp>\</samp>&rsquo; to &lsquo;<samp>\\</samp>&rsquo; and
the separator <var>SEP</var> is converted to &lsquo;<samp>\<var>SEP</var></samp>&rsquo;.
</p>
</dd>
<dt><samp>csv</samp></dt>
<dd><p>Perform CSV-like escaping, as described in RFC4180. Strings
containing a newline (&lsquo;<samp>\n</samp>&rsquo;), a carriage return (&lsquo;<samp>\r</samp>&rsquo;), a double quote
(&lsquo;<samp>&quot;</samp>&rsquo;), or <var>SEP</var> are enclosed in double-quotes.
</p>
</dd>
<dt><samp>none</samp></dt>
<dd><p>Perform no escaping.
</p></dd>
</dl>
</dd>
<dt><samp>print_section, p</samp></dt>
<dd><p>Print the section name at the begin of each line if the value is
<code>1</code>, disable it with value set to <code>0</code>. Default value is
<code>1</code>.
</p>
</dd>
</dl>
<a name="flat"></a>
<h3 class="section">4.3 flat<span class="pull-right"><a class="anchor hidden-xs" href="#flat" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flat" aria-hidden="true">TOC</a></span></h3>
<p>Flat format.
</p>
<p>A free-form output where each line contains an explicit key=value, such as
&quot;streams.stream.3.tags.foo=bar&quot;. The output is shell escaped, so it can be
directly embedded in sh scripts as long as the separator character is an
alphanumeric character or an underscore (see <var>sep_char</var> option).
</p>
<p>The description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>sep_char, s</samp></dt>
<dd><p>Separator character used to separate the chapter, the section name, IDs and
potential tags in the printed field key.
</p>
<p>Default value is &lsquo;<samp>.</samp>&rsquo;.
</p>
</dd>
<dt><samp>hierarchical, h</samp></dt>
<dd><p>Specify if the section name specification should be hierarchical. If
set to 1, and if there is more than one section in the current
chapter, the section name will be prefixed by the name of the
chapter. A value of 0 will disable this behavior.
</p>
<p>Default value is 1.
</p></dd>
</dl>
<a name="ini"></a>
<h3 class="section">4.4 ini<span class="pull-right"><a class="anchor hidden-xs" href="#ini" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ini" aria-hidden="true">TOC</a></span></h3>
<p>INI format output.
</p>
<p>Print output in an INI based format.
</p>
<p>The following conventions are adopted:
</p>
<ul>
<li> all key and values are UTF-8
</li><li> &lsquo;<samp>.</samp>&rsquo; is the subgroup separator
</li><li> newline, &lsquo;<samp>\t</samp>&rsquo;, &lsquo;<samp>\f</samp>&rsquo;, &lsquo;<samp>\b</samp>&rsquo; and the following characters are
escaped
</li><li> &lsquo;<samp>\</samp>&rsquo; is the escape character
</li><li> &lsquo;<samp>#</samp>&rsquo; is the comment indicator
</li><li> &lsquo;<samp>=</samp>&rsquo; is the key/value separator
</li><li> &lsquo;<samp>:</samp>&rsquo; is not used but usually parsed as key/value separator
</li></ul>
<p>This writer accepts options as a list of <var>key</var>=<var>value</var> pairs,
separated by &lsquo;<samp>:</samp>&rsquo;.
</p>
<p>The description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>hierarchical, h</samp></dt>
<dd><p>Specify if the section name specification should be hierarchical. If
set to 1, and if there is more than one section in the current
chapter, the section name will be prefixed by the name of the
chapter. A value of 0 will disable this behavior.
</p>
<p>Default value is 1.
</p></dd>
</dl>
<a name="json"></a>
<h3 class="section">4.5 json<span class="pull-right"><a class="anchor hidden-xs" href="#json" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-json" aria-hidden="true">TOC</a></span></h3>
<p>JSON based format.
</p>
<p>Each section is printed using JSON notation.
</p>
<p>The description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>compact, c</samp></dt>
<dd><p>If set to 1 enable compact output, that is each section will be
printed on a single line. Default value is 0.
</p></dd>
</dl>
<p>For more information about JSON, see <a href="http://www.json.org/">http://www.json.org/</a>.
</p>
<a name="xml"></a>
<h3 class="section">4.6 xml<span class="pull-right"><a class="anchor hidden-xs" href="#xml" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xml" aria-hidden="true">TOC</a></span></h3>
<p>XML based format.
</p>
<p>The XML output is described in the XML schema description file
<samp>ffprobe.xsd</samp> installed in the FFmpeg datadir.
</p>
<p>An updated version of the schema can be retrieved at the url
<a href="http://www.ffmpeg.org/schema/ffprobe.xsd">http://www.ffmpeg.org/schema/ffprobe.xsd</a>, which redirects to the
latest schema committed into the FFmpeg development source code tree.
</p>
<p>Note that the output issued will be compliant to the
<samp>ffprobe.xsd</samp> schema only when no special global output options
(<samp>unit</samp>, <samp>prefix</samp>, <samp>byte_binary_prefix</samp>,
<samp>sexagesimal</samp> etc.) are specified.
</p>
<p>The description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>fully_qualified, q</samp></dt>
<dd><p>If set to 1 specify if the output should be fully qualified. Default
value is 0.
This is required for generating an XML file which can be validated
through an XSD file.
</p>
</dd>
<dt><samp>xsd_compliant, x</samp></dt>
<dd><p>If set to 1 perform more checks for ensuring that the output is XSD
compliant. Default value is 0.
This option automatically sets <samp>fully_qualified</samp> to 1.
</p></dd>
</dl>
<p>For more information about the XML format, see
<a href="http://www.w3.org/XML/">http://www.w3.org/XML/</a>.
</p>
<a name="Timecode"></a>
<h2 class="chapter">5 Timecode<span class="pull-right"><a class="anchor hidden-xs" href="#Timecode" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Timecode" aria-hidden="true">TOC</a></span></h2>
<p><code>ffprobe</code> supports Timecode extraction:
</p>
<ul>
<li> MPEG1/2 timecode is extracted from the GOP, and is available in the video
stream details (<samp>-show_streams</samp>, see <var>timecode</var>).
</li><li> MOV timecode is extracted from tmcd track, so is available in the tmcd
stream metadata (<samp>-show_streams</samp>, see <var>TAG:timecode</var>).
</li><li> DV, GXF and AVI timecodes are available in format metadata
(<samp>-show_format</samp>, see <var>TAG:timecode</var>).
</li></ul>
<a name="Syntax"></a>
<h2 class="chapter">6 Syntax<span class="pull-right"><a class="anchor hidden-xs" href="#Syntax" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Syntax" aria-hidden="true">TOC</a></span></h2>
<p>This section documents the syntax and formats employed by the FFmpeg
libraries and tools.
</p>
<a name="quoting_005fand_005fescaping"></a><a name="Quoting-and-escaping"></a>
<h3 class="section">6.1 Quoting and escaping<span class="pull-right"><a class="anchor hidden-xs" href="#Quoting-and-escaping" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Quoting-and-escaping" aria-hidden="true">TOC</a></span></h3>
<p>FFmpeg adopts the following quoting and escaping mechanism, unless
explicitly specified. The following rules are applied:
</p>
<ul>
<li> &lsquo;<samp>'</samp>&rsquo; and &lsquo;<samp>\</samp>&rsquo; are special characters (respectively used for
quoting and escaping). In addition to them, there might be other
special characters depending on the specific syntax where the escaping
and quoting are employed.
</li><li> A special character is escaped by prefixing it with a &lsquo;<samp>\</samp>&rsquo;.
</li><li> All characters enclosed between &lsquo;<samp>''</samp>&rsquo; are included literally in the
parsed string. The quote character &lsquo;<samp>'</samp>&rsquo; itself cannot be quoted,
so you may need to close the quote and escape it.
</li><li> Leading and trailing whitespaces, unless escaped or quoted, are
removed from the parsed string.
</li></ul>
<p>Note that you may need to add a second level of escaping when using
the command line or a script, which depends on the syntax of the
adopted shell language.
</p>
<p>The function <code>av_get_token</code> defined in
<samp>libavutil/avstring.h</samp> can be used to parse a token quoted or
escaped according to the rules defined above.
</p>
<p>The tool <samp>tools/ffescape</samp> in the FFmpeg source tree can be used
to automatically quote or escape a string in a script.
</p>
<a name="Examples"></a>
<h4 class="subsection">6.1.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Escape the string <code>Crime d'Amour</code> containing the <code>'</code> special
character:
<div class="example">
<pre class="example">Crime d\'Amour
</pre></div>
</li><li> The string above contains a quote, so the <code>'</code> needs to be escaped
when quoting it:
<div class="example">
<pre class="example">'Crime d'\''Amour'
</pre></div>
</li><li> Include leading or trailing whitespaces using quoting:
<div class="example">
<pre class="example">' this string starts and ends with whitespaces '
</pre></div>
</li><li> Escaping and quoting can be mixed together:
<div class="example">
<pre class="example">' The string '\'string\'' is a string '
</pre></div>
</li><li> To include a literal &lsquo;<samp>\</samp>&rsquo; you can use either escaping or quoting:
<div class="example">
<pre class="example">'c:\foo' can be written as c:\\foo
</pre></div>
</li></ul>
<a name="date-syntax"></a><a name="Date"></a>
<h3 class="section">6.2 Date<span class="pull-right"><a class="anchor hidden-xs" href="#Date" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Date" aria-hidden="true">TOC</a></span></h3>
<p>The accepted syntax is:
</p><div class="example">
<pre class="example">[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
now
</pre></div>
<p>If the value is &quot;now&quot; it takes the current time.
</p>
<p>Time is local time unless Z is appended, in which case it is
interpreted as UTC.
If the year-month-day part is not specified it takes the current
year-month-day.
</p>
<a name="time-duration-syntax"></a><a name="Time-duration"></a>
<h3 class="section">6.3 Time duration<span class="pull-right"><a class="anchor hidden-xs" href="#Time-duration" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Time-duration" aria-hidden="true">TOC</a></span></h3>
<p>There are two accepted syntaxes for expressing time duration.
</p>
<div class="example">
<pre class="example">[-][<var>HH</var>:]<var>MM</var>:<var>SS</var>[.<var>m</var>...]
</pre></div>
<p><var>HH</var> expresses the number of hours, <var>MM</var> the number of minutes
for a maximum of 2 digits, and <var>SS</var> the number of seconds for a
maximum of 2 digits. The <var>m</var> at the end expresses decimal value for
<var>SS</var>.
</p>
<p><em>or</em>
</p>
<div class="example">
<pre class="example">[-]<var>S</var>+[.<var>m</var>...]
</pre></div>
<p><var>S</var> expresses the number of seconds, with the optional decimal part
<var>m</var>.
</p>
<p>In both expressions, the optional &lsquo;<samp>-</samp>&rsquo; indicates negative duration.
</p>
<a name="Examples-1"></a>
<h4 class="subsection">6.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-1" aria-hidden="true">TOC</a></span></h4>
<p>The following examples are all valid time duration:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>55</samp>&rsquo;</dt>
<dd><p>55 seconds
</p>
</dd>
<dt>&lsquo;<samp>12:03:45</samp>&rsquo;</dt>
<dd><p>12 hours, 03 minutes and 45 seconds
</p>
</dd>
<dt>&lsquo;<samp>23.189</samp>&rsquo;</dt>
<dd><p>23.189 seconds
</p></dd>
</dl>
<a name="video-size-syntax"></a><a name="Video-size"></a>
<h3 class="section">6.4 Video size<span class="pull-right"><a class="anchor hidden-xs" href="#Video-size" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-size" aria-hidden="true">TOC</a></span></h3>
<p>Specify the size of the sourced video, it may be a string of the form
<var>width</var>x<var>height</var>, or the name of a size abbreviation.
</p>
<p>The following abbreviations are recognized:
</p><dl compact="compact">
<dt>&lsquo;<samp>ntsc</samp>&rsquo;</dt>
<dd><p>720x480
</p></dd>
<dt>&lsquo;<samp>pal</samp>&rsquo;</dt>
<dd><p>720x576
</p></dd>
<dt>&lsquo;<samp>qntsc</samp>&rsquo;</dt>
<dd><p>352x240
</p></dd>
<dt>&lsquo;<samp>qpal</samp>&rsquo;</dt>
<dd><p>352x288
</p></dd>
<dt>&lsquo;<samp>sntsc</samp>&rsquo;</dt>
<dd><p>640x480
</p></dd>
<dt>&lsquo;<samp>spal</samp>&rsquo;</dt>
<dd><p>768x576
</p></dd>
<dt>&lsquo;<samp>film</samp>&rsquo;</dt>
<dd><p>352x240
</p></dd>
<dt>&lsquo;<samp>ntsc-film</samp>&rsquo;</dt>
<dd><p>352x240
</p></dd>
<dt>&lsquo;<samp>sqcif</samp>&rsquo;</dt>
<dd><p>128x96
</p></dd>
<dt>&lsquo;<samp>qcif</samp>&rsquo;</dt>
<dd><p>176x144
</p></dd>
<dt>&lsquo;<samp>cif</samp>&rsquo;</dt>
<dd><p>352x288
</p></dd>
<dt>&lsquo;<samp>4cif</samp>&rsquo;</dt>
<dd><p>704x576
</p></dd>
<dt>&lsquo;<samp>16cif</samp>&rsquo;</dt>
<dd><p>1408x1152
</p></dd>
<dt>&lsquo;<samp>qqvga</samp>&rsquo;</dt>
<dd><p>160x120
</p></dd>
<dt>&lsquo;<samp>qvga</samp>&rsquo;</dt>
<dd><p>320x240
</p></dd>
<dt>&lsquo;<samp>vga</samp>&rsquo;</dt>
<dd><p>640x480
</p></dd>
<dt>&lsquo;<samp>svga</samp>&rsquo;</dt>
<dd><p>800x600
</p></dd>
<dt>&lsquo;<samp>xga</samp>&rsquo;</dt>
<dd><p>1024x768
</p></dd>
<dt>&lsquo;<samp>uxga</samp>&rsquo;</dt>
<dd><p>1600x1200
</p></dd>
<dt>&lsquo;<samp>qxga</samp>&rsquo;</dt>
<dd><p>2048x1536
</p></dd>
<dt>&lsquo;<samp>sxga</samp>&rsquo;</dt>
<dd><p>1280x1024
</p></dd>
<dt>&lsquo;<samp>qsxga</samp>&rsquo;</dt>
<dd><p>2560x2048
</p></dd>
<dt>&lsquo;<samp>hsxga</samp>&rsquo;</dt>
<dd><p>5120x4096
</p></dd>
<dt>&lsquo;<samp>wvga</samp>&rsquo;</dt>
<dd><p>852x480
</p></dd>
<dt>&lsquo;<samp>wxga</samp>&rsquo;</dt>
<dd><p>1366x768
</p></dd>
<dt>&lsquo;<samp>wsxga</samp>&rsquo;</dt>
<dd><p>1600x1024
</p></dd>
<dt>&lsquo;<samp>wuxga</samp>&rsquo;</dt>
<dd><p>1920x1200
</p></dd>
<dt>&lsquo;<samp>woxga</samp>&rsquo;</dt>
<dd><p>2560x1600
</p></dd>
<dt>&lsquo;<samp>wqsxga</samp>&rsquo;</dt>
<dd><p>3200x2048
</p></dd>
<dt>&lsquo;<samp>wquxga</samp>&rsquo;</dt>
<dd><p>3840x2400
</p></dd>
<dt>&lsquo;<samp>whsxga</samp>&rsquo;</dt>
<dd><p>6400x4096
</p></dd>
<dt>&lsquo;<samp>whuxga</samp>&rsquo;</dt>
<dd><p>7680x4800
</p></dd>
<dt>&lsquo;<samp>cga</samp>&rsquo;</dt>
<dd><p>320x200
</p></dd>
<dt>&lsquo;<samp>ega</samp>&rsquo;</dt>
<dd><p>640x350
</p></dd>
<dt>&lsquo;<samp>hd480</samp>&rsquo;</dt>
<dd><p>852x480
</p></dd>
<dt>&lsquo;<samp>hd720</samp>&rsquo;</dt>
<dd><p>1280x720
</p></dd>
<dt>&lsquo;<samp>hd1080</samp>&rsquo;</dt>
<dd><p>1920x1080
</p></dd>
<dt>&lsquo;<samp>2k</samp>&rsquo;</dt>
<dd><p>2048x1080
</p></dd>
<dt>&lsquo;<samp>2kflat</samp>&rsquo;</dt>
<dd><p>1998x1080
</p></dd>
<dt>&lsquo;<samp>2kscope</samp>&rsquo;</dt>
<dd><p>2048x858
</p></dd>
<dt>&lsquo;<samp>4k</samp>&rsquo;</dt>
<dd><p>4096x2160
</p></dd>
<dt>&lsquo;<samp>4kflat</samp>&rsquo;</dt>
<dd><p>3996x2160
</p></dd>
<dt>&lsquo;<samp>4kscope</samp>&rsquo;</dt>
<dd><p>4096x1716
</p></dd>
<dt>&lsquo;<samp>nhd</samp>&rsquo;</dt>
<dd><p>640x360
</p></dd>
<dt>&lsquo;<samp>hqvga</samp>&rsquo;</dt>
<dd><p>240x160
</p></dd>
<dt>&lsquo;<samp>wqvga</samp>&rsquo;</dt>
<dd><p>400x240
</p></dd>
<dt>&lsquo;<samp>fwqvga</samp>&rsquo;</dt>
<dd><p>432x240
</p></dd>
<dt>&lsquo;<samp>hvga</samp>&rsquo;</dt>
<dd><p>480x320
</p></dd>
<dt>&lsquo;<samp>qhd</samp>&rsquo;</dt>
<dd><p>960x540
</p></dd>
<dt>&lsquo;<samp>2kdci</samp>&rsquo;</dt>
<dd><p>2048x1080
</p></dd>
<dt>&lsquo;<samp>4kdci</samp>&rsquo;</dt>
<dd><p>4096x2160
</p></dd>
<dt>&lsquo;<samp>uhd2160</samp>&rsquo;</dt>
<dd><p>3840x2160
</p></dd>
<dt>&lsquo;<samp>uhd4320</samp>&rsquo;</dt>
<dd><p>7680x4320
</p></dd>
</dl>
<a name="video-rate-syntax"></a><a name="Video-rate"></a>
<h3 class="section">6.5 Video rate<span class="pull-right"><a class="anchor hidden-xs" href="#Video-rate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-rate" aria-hidden="true">TOC</a></span></h3>
<p>Specify the frame rate of a video, expressed as the number of frames
generated per second. It has to be a string in the format
<var>frame_rate_num</var>/<var>frame_rate_den</var>, an integer number, a float
number or a valid video frame rate abbreviation.
</p>
<p>The following abbreviations are recognized:
</p><dl compact="compact">
<dt>&lsquo;<samp>ntsc</samp>&rsquo;</dt>
<dd><p>30000/1001
</p></dd>
<dt>&lsquo;<samp>pal</samp>&rsquo;</dt>
<dd><p>25/1
</p></dd>
<dt>&lsquo;<samp>qntsc</samp>&rsquo;</dt>
<dd><p>30000/1001
</p></dd>
<dt>&lsquo;<samp>qpal</samp>&rsquo;</dt>
<dd><p>25/1
</p></dd>
<dt>&lsquo;<samp>sntsc</samp>&rsquo;</dt>
<dd><p>30000/1001
</p></dd>
<dt>&lsquo;<samp>spal</samp>&rsquo;</dt>
<dd><p>25/1
</p></dd>
<dt>&lsquo;<samp>film</samp>&rsquo;</dt>
<dd><p>24/1
</p></dd>
<dt>&lsquo;<samp>ntsc-film</samp>&rsquo;</dt>
<dd><p>24000/1001
</p></dd>
</dl>
<a name="ratio-syntax"></a><a name="Ratio"></a>
<h3 class="section">6.6 Ratio<span class="pull-right"><a class="anchor hidden-xs" href="#Ratio" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Ratio" aria-hidden="true">TOC</a></span></h3>
<p>A ratio can be expressed as an expression, or in the form
<var>numerator</var>:<var>denominator</var>.
</p>
<p>Note that a ratio with infinite (1/0) or negative value is
considered valid, so you should check on the returned value if you
want to exclude those values.
</p>
<p>The undefined value can be expressed using the &quot;0:0&quot; string.
</p>
<a name="color-syntax"></a><a name="Color"></a>
<h3 class="section">6.7 Color<span class="pull-right"><a class="anchor hidden-xs" href="#Color" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Color" aria-hidden="true">TOC</a></span></h3>
<p>It can be the name of a color as defined below (case insensitive match) or a
<code>[0x|#]RRGGBB[AA]</code> sequence, possibly followed by @ and a string
representing the alpha component.
</p>
<p>The alpha component may be a string composed by &quot;0x&quot; followed by an
hexadecimal number or a decimal number between 0.0 and 1.0, which
represents the opacity value (&lsquo;<samp>0x00</samp>&rsquo; or &lsquo;<samp>0.0</samp>&rsquo; means completely
transparent, &lsquo;<samp>0xff</samp>&rsquo; or &lsquo;<samp>1.0</samp>&rsquo; completely opaque). If the alpha
component is not specified then &lsquo;<samp>0xff</samp>&rsquo; is assumed.
</p>
<p>The string &lsquo;<samp>random</samp>&rsquo; will result in a random color.
</p>
<p>The following names of colors are recognized:
</p><dl compact="compact">
<dt>&lsquo;<samp>AliceBlue</samp>&rsquo;</dt>
<dd><p>0xF0F8FF
</p></dd>
<dt>&lsquo;<samp>AntiqueWhite</samp>&rsquo;</dt>
<dd><p>0xFAEBD7
</p></dd>
<dt>&lsquo;<samp>Aqua</samp>&rsquo;</dt>
<dd><p>0x00FFFF
</p></dd>
<dt>&lsquo;<samp>Aquamarine</samp>&rsquo;</dt>
<dd><p>0x7FFFD4
</p></dd>
<dt>&lsquo;<samp>Azure</samp>&rsquo;</dt>
<dd><p>0xF0FFFF
</p></dd>
<dt>&lsquo;<samp>Beige</samp>&rsquo;</dt>
<dd><p>0xF5F5DC
</p></dd>
<dt>&lsquo;<samp>Bisque</samp>&rsquo;</dt>
<dd><p>0xFFE4C4
</p></dd>
<dt>&lsquo;<samp>Black</samp>&rsquo;</dt>
<dd><p>0x000000
</p></dd>
<dt>&lsquo;<samp>BlanchedAlmond</samp>&rsquo;</dt>
<dd><p>0xFFEBCD
</p></dd>
<dt>&lsquo;<samp>Blue</samp>&rsquo;</dt>
<dd><p>0x0000FF
</p></dd>
<dt>&lsquo;<samp>BlueViolet</samp>&rsquo;</dt>
<dd><p>0x8A2BE2
</p></dd>
<dt>&lsquo;<samp>Brown</samp>&rsquo;</dt>
<dd><p>0xA52A2A
</p></dd>
<dt>&lsquo;<samp>BurlyWood</samp>&rsquo;</dt>
<dd><p>0xDEB887
</p></dd>
<dt>&lsquo;<samp>CadetBlue</samp>&rsquo;</dt>
<dd><p>0x5F9EA0
</p></dd>
<dt>&lsquo;<samp>Chartreuse</samp>&rsquo;</dt>
<dd><p>0x7FFF00
</p></dd>
<dt>&lsquo;<samp>Chocolate</samp>&rsquo;</dt>
<dd><p>0xD2691E
</p></dd>
<dt>&lsquo;<samp>Coral</samp>&rsquo;</dt>
<dd><p>0xFF7F50
</p></dd>
<dt>&lsquo;<samp>CornflowerBlue</samp>&rsquo;</dt>
<dd><p>0x6495ED
</p></dd>
<dt>&lsquo;<samp>Cornsilk</samp>&rsquo;</dt>
<dd><p>0xFFF8DC
</p></dd>
<dt>&lsquo;<samp>Crimson</samp>&rsquo;</dt>
<dd><p>0xDC143C
</p></dd>
<dt>&lsquo;<samp>Cyan</samp>&rsquo;</dt>
<dd><p>0x00FFFF
</p></dd>
<dt>&lsquo;<samp>DarkBlue</samp>&rsquo;</dt>
<dd><p>0x00008B
</p></dd>
<dt>&lsquo;<samp>DarkCyan</samp>&rsquo;</dt>
<dd><p>0x008B8B
</p></dd>
<dt>&lsquo;<samp>DarkGoldenRod</samp>&rsquo;</dt>
<dd><p>0xB8860B
</p></dd>
<dt>&lsquo;<samp>DarkGray</samp>&rsquo;</dt>
<dd><p>0xA9A9A9
</p></dd>
<dt>&lsquo;<samp>DarkGreen</samp>&rsquo;</dt>
<dd><p>0x006400
</p></dd>
<dt>&lsquo;<samp>DarkKhaki</samp>&rsquo;</dt>
<dd><p>0xBDB76B
</p></dd>
<dt>&lsquo;<samp>DarkMagenta</samp>&rsquo;</dt>
<dd><p>0x8B008B
</p></dd>
<dt>&lsquo;<samp>DarkOliveGreen</samp>&rsquo;</dt>
<dd><p>0x556B2F
</p></dd>
<dt>&lsquo;<samp>Darkorange</samp>&rsquo;</dt>
<dd><p>0xFF8C00
</p></dd>
<dt>&lsquo;<samp>DarkOrchid</samp>&rsquo;</dt>
<dd><p>0x9932CC
</p></dd>
<dt>&lsquo;<samp>DarkRed</samp>&rsquo;</dt>
<dd><p>0x8B0000
</p></dd>
<dt>&lsquo;<samp>DarkSalmon</samp>&rsquo;</dt>
<dd><p>0xE9967A
</p></dd>
<dt>&lsquo;<samp>DarkSeaGreen</samp>&rsquo;</dt>
<dd><p>0x8FBC8F
</p></dd>
<dt>&lsquo;<samp>DarkSlateBlue</samp>&rsquo;</dt>
<dd><p>0x483D8B
</p></dd>
<dt>&lsquo;<samp>DarkSlateGray</samp>&rsquo;</dt>
<dd><p>0x2F4F4F
</p></dd>
<dt>&lsquo;<samp>DarkTurquoise</samp>&rsquo;</dt>
<dd><p>0x00CED1
</p></dd>
<dt>&lsquo;<samp>DarkViolet</samp>&rsquo;</dt>
<dd><p>0x9400D3
</p></dd>
<dt>&lsquo;<samp>DeepPink</samp>&rsquo;</dt>
<dd><p>0xFF1493
</p></dd>
<dt>&lsquo;<samp>DeepSkyBlue</samp>&rsquo;</dt>
<dd><p>0x00BFFF
</p></dd>
<dt>&lsquo;<samp>DimGray</samp>&rsquo;</dt>
<dd><p>0x696969
</p></dd>
<dt>&lsquo;<samp>DodgerBlue</samp>&rsquo;</dt>
<dd><p>0x1E90FF
</p></dd>
<dt>&lsquo;<samp>FireBrick</samp>&rsquo;</dt>
<dd><p>0xB22222
</p></dd>
<dt>&lsquo;<samp>FloralWhite</samp>&rsquo;</dt>
<dd><p>0xFFFAF0
</p></dd>
<dt>&lsquo;<samp>ForestGreen</samp>&rsquo;</dt>
<dd><p>0x228B22
</p></dd>
<dt>&lsquo;<samp>Fuchsia</samp>&rsquo;</dt>
<dd><p>0xFF00FF
</p></dd>
<dt>&lsquo;<samp>Gainsboro</samp>&rsquo;</dt>
<dd><p>0xDCDCDC
</p></dd>
<dt>&lsquo;<samp>GhostWhite</samp>&rsquo;</dt>
<dd><p>0xF8F8FF
</p></dd>
<dt>&lsquo;<samp>Gold</samp>&rsquo;</dt>
<dd><p>0xFFD700
</p></dd>
<dt>&lsquo;<samp>GoldenRod</samp>&rsquo;</dt>
<dd><p>0xDAA520
</p></dd>
<dt>&lsquo;<samp>Gray</samp>&rsquo;</dt>
<dd><p>0x808080
</p></dd>
<dt>&lsquo;<samp>Green</samp>&rsquo;</dt>
<dd><p>0x008000
</p></dd>
<dt>&lsquo;<samp>GreenYellow</samp>&rsquo;</dt>
<dd><p>0xADFF2F
</p></dd>
<dt>&lsquo;<samp>HoneyDew</samp>&rsquo;</dt>
<dd><p>0xF0FFF0
</p></dd>
<dt>&lsquo;<samp>HotPink</samp>&rsquo;</dt>
<dd><p>0xFF69B4
</p></dd>
<dt>&lsquo;<samp>IndianRed</samp>&rsquo;</dt>
<dd><p>0xCD5C5C
</p></dd>
<dt>&lsquo;<samp>Indigo</samp>&rsquo;</dt>
<dd><p>0x4B0082
</p></dd>
<dt>&lsquo;<samp>Ivory</samp>&rsquo;</dt>
<dd><p>0xFFFFF0
</p></dd>
<dt>&lsquo;<samp>Khaki</samp>&rsquo;</dt>
<dd><p>0xF0E68C
</p></dd>
<dt>&lsquo;<samp>Lavender</samp>&rsquo;</dt>
<dd><p>0xE6E6FA
</p></dd>
<dt>&lsquo;<samp>LavenderBlush</samp>&rsquo;</dt>
<dd><p>0xFFF0F5
</p></dd>
<dt>&lsquo;<samp>LawnGreen</samp>&rsquo;</dt>
<dd><p>0x7CFC00
</p></dd>
<dt>&lsquo;<samp>LemonChiffon</samp>&rsquo;</dt>
<dd><p>0xFFFACD
</p></dd>
<dt>&lsquo;<samp>LightBlue</samp>&rsquo;</dt>
<dd><p>0xADD8E6
</p></dd>
<dt>&lsquo;<samp>LightCoral</samp>&rsquo;</dt>
<dd><p>0xF08080
</p></dd>
<dt>&lsquo;<samp>LightCyan</samp>&rsquo;</dt>
<dd><p>0xE0FFFF
</p></dd>
<dt>&lsquo;<samp>LightGoldenRodYellow</samp>&rsquo;</dt>
<dd><p>0xFAFAD2
</p></dd>
<dt>&lsquo;<samp>LightGreen</samp>&rsquo;</dt>
<dd><p>0x90EE90
</p></dd>
<dt>&lsquo;<samp>LightGrey</samp>&rsquo;</dt>
<dd><p>0xD3D3D3
</p></dd>
<dt>&lsquo;<samp>LightPink</samp>&rsquo;</dt>
<dd><p>0xFFB6C1
</p></dd>
<dt>&lsquo;<samp>LightSalmon</samp>&rsquo;</dt>
<dd><p>0xFFA07A
</p></dd>
<dt>&lsquo;<samp>LightSeaGreen</samp>&rsquo;</dt>
<dd><p>0x20B2AA
</p></dd>
<dt>&lsquo;<samp>LightSkyBlue</samp>&rsquo;</dt>
<dd><p>0x87CEFA
</p></dd>
<dt>&lsquo;<samp>LightSlateGray</samp>&rsquo;</dt>
<dd><p>0x778899
</p></dd>
<dt>&lsquo;<samp>LightSteelBlue</samp>&rsquo;</dt>
<dd><p>0xB0C4DE
</p></dd>
<dt>&lsquo;<samp>LightYellow</samp>&rsquo;</dt>
<dd><p>0xFFFFE0
</p></dd>
<dt>&lsquo;<samp>Lime</samp>&rsquo;</dt>
<dd><p>0x00FF00
</p></dd>
<dt>&lsquo;<samp>LimeGreen</samp>&rsquo;</dt>
<dd><p>0x32CD32
</p></dd>
<dt>&lsquo;<samp>Linen</samp>&rsquo;</dt>
<dd><p>0xFAF0E6
</p></dd>
<dt>&lsquo;<samp>Magenta</samp>&rsquo;</dt>
<dd><p>0xFF00FF
</p></dd>
<dt>&lsquo;<samp>Maroon</samp>&rsquo;</dt>
<dd><p>0x800000
</p></dd>
<dt>&lsquo;<samp>MediumAquaMarine</samp>&rsquo;</dt>
<dd><p>0x66CDAA
</p></dd>
<dt>&lsquo;<samp>MediumBlue</samp>&rsquo;</dt>
<dd><p>0x0000CD
</p></dd>
<dt>&lsquo;<samp>MediumOrchid</samp>&rsquo;</dt>
<dd><p>0xBA55D3
</p></dd>
<dt>&lsquo;<samp>MediumPurple</samp>&rsquo;</dt>
<dd><p>0x9370D8
</p></dd>
<dt>&lsquo;<samp>MediumSeaGreen</samp>&rsquo;</dt>
<dd><p>0x3CB371
</p></dd>
<dt>&lsquo;<samp>MediumSlateBlue</samp>&rsquo;</dt>
<dd><p>0x7B68EE
</p></dd>
<dt>&lsquo;<samp>MediumSpringGreen</samp>&rsquo;</dt>
<dd><p>0x00FA9A
</p></dd>
<dt>&lsquo;<samp>MediumTurquoise</samp>&rsquo;</dt>
<dd><p>0x48D1CC
</p></dd>
<dt>&lsquo;<samp>MediumVioletRed</samp>&rsquo;</dt>
<dd><p>0xC71585
</p></dd>
<dt>&lsquo;<samp>MidnightBlue</samp>&rsquo;</dt>
<dd><p>0x191970
</p></dd>
<dt>&lsquo;<samp>MintCream</samp>&rsquo;</dt>
<dd><p>0xF5FFFA
</p></dd>
<dt>&lsquo;<samp>MistyRose</samp>&rsquo;</dt>
<dd><p>0xFFE4E1
</p></dd>
<dt>&lsquo;<samp>Moccasin</samp>&rsquo;</dt>
<dd><p>0xFFE4B5
</p></dd>
<dt>&lsquo;<samp>NavajoWhite</samp>&rsquo;</dt>
<dd><p>0xFFDEAD
</p></dd>
<dt>&lsquo;<samp>Navy</samp>&rsquo;</dt>
<dd><p>0x000080
</p></dd>
<dt>&lsquo;<samp>OldLace</samp>&rsquo;</dt>
<dd><p>0xFDF5E6
</p></dd>
<dt>&lsquo;<samp>Olive</samp>&rsquo;</dt>
<dd><p>0x808000
</p></dd>
<dt>&lsquo;<samp>OliveDrab</samp>&rsquo;</dt>
<dd><p>0x6B8E23
</p></dd>
<dt>&lsquo;<samp>Orange</samp>&rsquo;</dt>
<dd><p>0xFFA500
</p></dd>
<dt>&lsquo;<samp>OrangeRed</samp>&rsquo;</dt>
<dd><p>0xFF4500
</p></dd>
<dt>&lsquo;<samp>Orchid</samp>&rsquo;</dt>
<dd><p>0xDA70D6
</p></dd>
<dt>&lsquo;<samp>PaleGoldenRod</samp>&rsquo;</dt>
<dd><p>0xEEE8AA
</p></dd>
<dt>&lsquo;<samp>PaleGreen</samp>&rsquo;</dt>
<dd><p>0x98FB98
</p></dd>
<dt>&lsquo;<samp>PaleTurquoise</samp>&rsquo;</dt>
<dd><p>0xAFEEEE
</p></dd>
<dt>&lsquo;<samp>PaleVioletRed</samp>&rsquo;</dt>
<dd><p>0xD87093
</p></dd>
<dt>&lsquo;<samp>PapayaWhip</samp>&rsquo;</dt>
<dd><p>0xFFEFD5
</p></dd>
<dt>&lsquo;<samp>PeachPuff</samp>&rsquo;</dt>
<dd><p>0xFFDAB9
</p></dd>
<dt>&lsquo;<samp>Peru</samp>&rsquo;</dt>
<dd><p>0xCD853F
</p></dd>
<dt>&lsquo;<samp>Pink</samp>&rsquo;</dt>
<dd><p>0xFFC0CB
</p></dd>
<dt>&lsquo;<samp>Plum</samp>&rsquo;</dt>
<dd><p>0xDDA0DD
</p></dd>
<dt>&lsquo;<samp>PowderBlue</samp>&rsquo;</dt>
<dd><p>0xB0E0E6
</p></dd>
<dt>&lsquo;<samp>Purple</samp>&rsquo;</dt>
<dd><p>0x800080
</p></dd>
<dt>&lsquo;<samp>Red</samp>&rsquo;</dt>
<dd><p>0xFF0000
</p></dd>
<dt>&lsquo;<samp>RosyBrown</samp>&rsquo;</dt>
<dd><p>0xBC8F8F
</p></dd>
<dt>&lsquo;<samp>RoyalBlue</samp>&rsquo;</dt>
<dd><p>0x4169E1
</p></dd>
<dt>&lsquo;<samp>SaddleBrown</samp>&rsquo;</dt>
<dd><p>0x8B4513
</p></dd>
<dt>&lsquo;<samp>Salmon</samp>&rsquo;</dt>
<dd><p>0xFA8072
</p></dd>
<dt>&lsquo;<samp>SandyBrown</samp>&rsquo;</dt>
<dd><p>0xF4A460
</p></dd>
<dt>&lsquo;<samp>SeaGreen</samp>&rsquo;</dt>
<dd><p>0x2E8B57
</p></dd>
<dt>&lsquo;<samp>SeaShell</samp>&rsquo;</dt>
<dd><p>0xFFF5EE
</p></dd>
<dt>&lsquo;<samp>Sienna</samp>&rsquo;</dt>
<dd><p>0xA0522D
</p></dd>
<dt>&lsquo;<samp>Silver</samp>&rsquo;</dt>
<dd><p>0xC0C0C0
</p></dd>
<dt>&lsquo;<samp>SkyBlue</samp>&rsquo;</dt>
<dd><p>0x87CEEB
</p></dd>
<dt>&lsquo;<samp>SlateBlue</samp>&rsquo;</dt>
<dd><p>0x6A5ACD
</p></dd>
<dt>&lsquo;<samp>SlateGray</samp>&rsquo;</dt>
<dd><p>0x708090
</p></dd>
<dt>&lsquo;<samp>Snow</samp>&rsquo;</dt>
<dd><p>0xFFFAFA
</p></dd>
<dt>&lsquo;<samp>SpringGreen</samp>&rsquo;</dt>
<dd><p>0x00FF7F
</p></dd>
<dt>&lsquo;<samp>SteelBlue</samp>&rsquo;</dt>
<dd><p>0x4682B4
</p></dd>
<dt>&lsquo;<samp>Tan</samp>&rsquo;</dt>
<dd><p>0xD2B48C
</p></dd>
<dt>&lsquo;<samp>Teal</samp>&rsquo;</dt>
<dd><p>0x008080
</p></dd>
<dt>&lsquo;<samp>Thistle</samp>&rsquo;</dt>
<dd><p>0xD8BFD8
</p></dd>
<dt>&lsquo;<samp>Tomato</samp>&rsquo;</dt>
<dd><p>0xFF6347
</p></dd>
<dt>&lsquo;<samp>Turquoise</samp>&rsquo;</dt>
<dd><p>0x40E0D0
</p></dd>
<dt>&lsquo;<samp>Violet</samp>&rsquo;</dt>
<dd><p>0xEE82EE
</p></dd>
<dt>&lsquo;<samp>Wheat</samp>&rsquo;</dt>
<dd><p>0xF5DEB3
</p></dd>
<dt>&lsquo;<samp>White</samp>&rsquo;</dt>
<dd><p>0xFFFFFF
</p></dd>
<dt>&lsquo;<samp>WhiteSmoke</samp>&rsquo;</dt>
<dd><p>0xF5F5F5
</p></dd>
<dt>&lsquo;<samp>Yellow</samp>&rsquo;</dt>
<dd><p>0xFFFF00
</p></dd>
<dt>&lsquo;<samp>YellowGreen</samp>&rsquo;</dt>
<dd><p>0x9ACD32
</p></dd>
</dl>
<a name="channel-layout-syntax"></a><a name="Channel-Layout"></a>
<h3 class="section">6.8 Channel Layout<span class="pull-right"><a class="anchor hidden-xs" href="#Channel-Layout" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Channel-Layout" aria-hidden="true">TOC</a></span></h3>
<p>A channel layout specifies the spatial disposition of the channels in
a multi-channel audio stream. To specify a channel layout, FFmpeg
makes use of a special syntax.
</p>
<p>Individual channels are identified by an id, as given by the table
below:
</p><dl compact="compact">
<dt>&lsquo;<samp>FL</samp>&rsquo;</dt>
<dd><p>front left
</p></dd>
<dt>&lsquo;<samp>FR</samp>&rsquo;</dt>
<dd><p>front right
</p></dd>
<dt>&lsquo;<samp>FC</samp>&rsquo;</dt>
<dd><p>front center
</p></dd>
<dt>&lsquo;<samp>LFE</samp>&rsquo;</dt>
<dd><p>low frequency
</p></dd>
<dt>&lsquo;<samp>BL</samp>&rsquo;</dt>
<dd><p>back left
</p></dd>
<dt>&lsquo;<samp>BR</samp>&rsquo;</dt>
<dd><p>back right
</p></dd>
<dt>&lsquo;<samp>FLC</samp>&rsquo;</dt>
<dd><p>front left-of-center
</p></dd>
<dt>&lsquo;<samp>FRC</samp>&rsquo;</dt>
<dd><p>front right-of-center
</p></dd>
<dt>&lsquo;<samp>BC</samp>&rsquo;</dt>
<dd><p>back center
</p></dd>
<dt>&lsquo;<samp>SL</samp>&rsquo;</dt>
<dd><p>side left
</p></dd>
<dt>&lsquo;<samp>SR</samp>&rsquo;</dt>
<dd><p>side right
</p></dd>
<dt>&lsquo;<samp>TC</samp>&rsquo;</dt>
<dd><p>top center
</p></dd>
<dt>&lsquo;<samp>TFL</samp>&rsquo;</dt>
<dd><p>top front left
</p></dd>
<dt>&lsquo;<samp>TFC</samp>&rsquo;</dt>
<dd><p>top front center
</p></dd>
<dt>&lsquo;<samp>TFR</samp>&rsquo;</dt>
<dd><p>top front right
</p></dd>
<dt>&lsquo;<samp>TBL</samp>&rsquo;</dt>
<dd><p>top back left
</p></dd>
<dt>&lsquo;<samp>TBC</samp>&rsquo;</dt>
<dd><p>top back center
</p></dd>
<dt>&lsquo;<samp>TBR</samp>&rsquo;</dt>
<dd><p>top back right
</p></dd>
<dt>&lsquo;<samp>DL</samp>&rsquo;</dt>
<dd><p>downmix left
</p></dd>
<dt>&lsquo;<samp>DR</samp>&rsquo;</dt>
<dd><p>downmix right
</p></dd>
<dt>&lsquo;<samp>WL</samp>&rsquo;</dt>
<dd><p>wide left
</p></dd>
<dt>&lsquo;<samp>WR</samp>&rsquo;</dt>
<dd><p>wide right
</p></dd>
<dt>&lsquo;<samp>SDL</samp>&rsquo;</dt>
<dd><p>surround direct left
</p></dd>
<dt>&lsquo;<samp>SDR</samp>&rsquo;</dt>
<dd><p>surround direct right
</p></dd>
<dt>&lsquo;<samp>LFE2</samp>&rsquo;</dt>
<dd><p>low frequency 2
</p></dd>
</dl>
<p>Standard channel layout compositions can be specified by using the
following identifiers:
</p><dl compact="compact">
<dt>&lsquo;<samp>mono</samp>&rsquo;</dt>
<dd><p>FC
</p></dd>
<dt>&lsquo;<samp>stereo</samp>&rsquo;</dt>
<dd><p>FL+FR
</p></dd>
<dt>&lsquo;<samp>2.1</samp>&rsquo;</dt>
<dd><p>FL+FR+LFE
</p></dd>
<dt>&lsquo;<samp>3.0</samp>&rsquo;</dt>
<dd><p>FL+FR+FC
</p></dd>
<dt>&lsquo;<samp>3.0(back)</samp>&rsquo;</dt>
<dd><p>FL+FR+BC
</p></dd>
<dt>&lsquo;<samp>4.0</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BC
</p></dd>
<dt>&lsquo;<samp>quad</samp>&rsquo;</dt>
<dd><p>FL+FR+BL+BR
</p></dd>
<dt>&lsquo;<samp>quad(side)</samp>&rsquo;</dt>
<dd><p>FL+FR+SL+SR
</p></dd>
<dt>&lsquo;<samp>3.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE
</p></dd>
<dt>&lsquo;<samp>5.0</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BL+BR
</p></dd>
<dt>&lsquo;<samp>5.0(side)</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+SL+SR
</p></dd>
<dt>&lsquo;<samp>4.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BC
</p></dd>
<dt>&lsquo;<samp>5.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BL+BR
</p></dd>
<dt>&lsquo;<samp>5.1(side)</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+SL+SR
</p></dd>
<dt>&lsquo;<samp>6.0</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BC+SL+SR
</p></dd>
<dt>&lsquo;<samp>6.0(front)</samp>&rsquo;</dt>
<dd><p>FL+FR+FLC+FRC+SL+SR
</p></dd>
<dt>&lsquo;<samp>hexagonal</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BL+BR+BC
</p></dd>
<dt>&lsquo;<samp>6.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BC+SL+SR
</p></dd>
<dt>&lsquo;<samp>6.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+BC
</p></dd>
<dt>&lsquo;<samp>6.1(front)</samp>&rsquo;</dt>
<dd><p>FL+FR+LFE+FLC+FRC+SL+SR
</p></dd>
<dt>&lsquo;<samp>7.0</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BL+BR+SL+SR
</p></dd>
<dt>&lsquo;<samp>7.0(front)</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+FLC+FRC+SL+SR
</p></dd>
<dt>&lsquo;<samp>7.1</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+SL+SR
</p></dd>
<dt>&lsquo;<samp>7.1(wide)</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC
</p></dd>
<dt>&lsquo;<samp>7.1(wide-side)</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+LFE+FLC+FRC+SL+SR
</p></dd>
<dt>&lsquo;<samp>octagonal</samp>&rsquo;</dt>
<dd><p>FL+FR+FC+BL+BR+BC+SL+SR
</p></dd>
<dt>&lsquo;<samp>downmix</samp>&rsquo;</dt>
<dd><p>DL+DR
</p></dd>
</dl>
<p>A custom channel layout can be specified as a sequence of terms, separated by
&rsquo;+&rsquo; or &rsquo;|&rsquo;. Each term can be:
</p><ul>
<li> the name of a standard channel layout (e.g. &lsquo;<samp>mono</samp>&rsquo;,
&lsquo;<samp>stereo</samp>&rsquo;, &lsquo;<samp>4.0</samp>&rsquo;, &lsquo;<samp>quad</samp>&rsquo;, &lsquo;<samp>5.0</samp>&rsquo;, etc.)
</li><li> the name of a single channel (e.g. &lsquo;<samp>FL</samp>&rsquo;, &lsquo;<samp>FR</samp>&rsquo;, &lsquo;<samp>FC</samp>&rsquo;, &lsquo;<samp>LFE</samp>&rsquo;, etc.)
</li><li> a number of channels, in decimal, optionally followed by &rsquo;c&rsquo;, yielding
the default channel layout for that number of channels (see the
function <code>av_get_default_channel_layout</code>)
</li><li> a channel layout mask, in hexadecimal starting with &quot;0x&quot; (see the
<code>AV_CH_*</code> macros in <samp>libavutil/channel_layout.h</samp>.
</li></ul>
<p>Starting from libavutil version 53 the trailing character &quot;c&quot; to
specify a number of channels will be required, while a channel layout
mask could also be specified as a decimal number (if and only if not
followed by &quot;c&quot;).
</p>
<p>See also the function <code>av_get_channel_layout</code> defined in
<samp>libavutil/channel_layout.h</samp>.
</p>
<a name="Expression-Evaluation"></a>
<h2 class="chapter">7 Expression Evaluation<span class="pull-right"><a class="anchor hidden-xs" href="#Expression-Evaluation" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Expression-Evaluation" aria-hidden="true">TOC</a></span></h2>
<p>When evaluating an arithmetic expression, FFmpeg uses an internal
formula evaluator, implemented through the <samp>libavutil/eval.h</samp>
interface.
</p>
<p>An expression may contain unary, binary operators, constants, and
functions.
</p>
<p>Two expressions <var>expr1</var> and <var>expr2</var> can be combined to form
another expression &quot;<var>expr1</var>;<var>expr2</var>&quot;.
<var>expr1</var> and <var>expr2</var> are evaluated in turn, and the new
expression evaluates to the value of <var>expr2</var>.
</p>
<p>The following binary operators are available: <code>+</code>, <code>-</code>,
<code>*</code>, <code>/</code>, <code>^</code>.
</p>
<p>The following unary operators are available: <code>+</code>, <code>-</code>.
</p>
<p>The following functions are available:
</p><dl compact="compact">
<dt><samp>abs(x)</samp></dt>
<dd><p>Compute absolute value of <var>x</var>.
</p>
</dd>
<dt><samp>acos(x)</samp></dt>
<dd><p>Compute arccosine of <var>x</var>.
</p>
</dd>
<dt><samp>asin(x)</samp></dt>
<dd><p>Compute arcsine of <var>x</var>.
</p>
</dd>
<dt><samp>atan(x)</samp></dt>
<dd><p>Compute arctangent of <var>x</var>.
</p>
</dd>
<dt><samp>between(x, min, max)</samp></dt>
<dd><p>Return 1 if <var>x</var> is greater than or equal to <var>min</var> and lesser than or
equal to <var>max</var>, 0 otherwise.
</p>
</dd>
<dt><samp>bitand(x, y)</samp></dt>
<dt><samp>bitor(x, y)</samp></dt>
<dd><p>Compute bitwise and/or operation on <var>x</var> and <var>y</var>.
</p>
<p>The results of the evaluation of <var>x</var> and <var>y</var> are converted to
integers before executing the bitwise operation.
</p>
<p>Note that both the conversion to integer and the conversion back to
floating point can lose precision. Beware of unexpected results for
large numbers (usually 2^53 and larger).
</p>
</dd>
<dt><samp>ceil(expr)</samp></dt>
<dd><p>Round the value of expression <var>expr</var> upwards to the nearest
integer. For example, &quot;ceil(1.5)&quot; is &quot;2.0&quot;.
</p>
</dd>
<dt><samp>clip(x, min, max)</samp></dt>
<dd><p>Return the value of <var>x</var> clipped between <var>min</var> and <var>max</var>.
</p>
</dd>
<dt><samp>cos(x)</samp></dt>
<dd><p>Compute cosine of <var>x</var>.
</p>
</dd>
<dt><samp>cosh(x)</samp></dt>
<dd><p>Compute hyperbolic cosine of <var>x</var>.
</p>
</dd>
<dt><samp>eq(x, y)</samp></dt>
<dd><p>Return 1 if <var>x</var> and <var>y</var> are equivalent, 0 otherwise.
</p>
</dd>
<dt><samp>exp(x)</samp></dt>
<dd><p>Compute exponential of <var>x</var> (with base <code>e</code>, the Euler&rsquo;s number).
</p>
</dd>
<dt><samp>floor(expr)</samp></dt>
<dd><p>Round the value of expression <var>expr</var> downwards to the nearest
integer. For example, &quot;floor(-1.5)&quot; is &quot;-2.0&quot;.
</p>
</dd>
<dt><samp>gauss(x)</samp></dt>
<dd><p>Compute Gauss function of <var>x</var>, corresponding to
<code>exp(-x*x/2) / sqrt(2*PI)</code>.
</p>
</dd>
<dt><samp>gcd(x, y)</samp></dt>
<dd><p>Return the greatest common divisor of <var>x</var> and <var>y</var>. If both <var>x</var> and
<var>y</var> are 0 or either or both are less than zero then behavior is undefined.
</p>
</dd>
<dt><samp>gt(x, y)</samp></dt>
<dd><p>Return 1 if <var>x</var> is greater than <var>y</var>, 0 otherwise.
</p>
</dd>
<dt><samp>gte(x, y)</samp></dt>
<dd><p>Return 1 if <var>x</var> is greater than or equal to <var>y</var>, 0 otherwise.
</p>
</dd>
<dt><samp>hypot(x, y)</samp></dt>
<dd><p>This function is similar to the C function with the same name; it returns
&quot;sqrt(<var>x</var>*<var>x</var> + <var>y</var>*<var>y</var>)&quot;, the length of the hypotenuse of a
right triangle with sides of length <var>x</var> and <var>y</var>, or the distance of the
point (<var>x</var>, <var>y</var>) from the origin.
</p>
</dd>
<dt><samp>if(x, y)</samp></dt>
<dd><p>Evaluate <var>x</var>, and if the result is non-zero return the result of
the evaluation of <var>y</var>, return 0 otherwise.
</p>
</dd>
<dt><samp>if(x, y, z)</samp></dt>
<dd><p>Evaluate <var>x</var>, and if the result is non-zero return the evaluation
result of <var>y</var>, otherwise the evaluation result of <var>z</var>.
</p>
</dd>
<dt><samp>ifnot(x, y)</samp></dt>
<dd><p>Evaluate <var>x</var>, and if the result is zero return the result of the
evaluation of <var>y</var>, return 0 otherwise.
</p>
</dd>
<dt><samp>ifnot(x, y, z)</samp></dt>
<dd><p>Evaluate <var>x</var>, and if the result is zero return the evaluation
result of <var>y</var>, otherwise the evaluation result of <var>z</var>.
</p>
</dd>
<dt><samp>isinf(x)</samp></dt>
<dd><p>Return 1.0 if <var>x</var> is +/-INFINITY, 0.0 otherwise.
</p>
</dd>
<dt><samp>isnan(x)</samp></dt>
<dd><p>Return 1.0 if <var>x</var> is NAN, 0.0 otherwise.
</p>
</dd>
<dt><samp>ld(var)</samp></dt>
<dd><p>Load the value of the internal variable with number
<var>var</var>, which was previously stored with st(<var>var</var>, <var>expr</var>).
The function returns the loaded value.
</p>
</dd>
<dt><samp>log(x)</samp></dt>
<dd><p>Compute natural logarithm of <var>x</var>.
</p>
</dd>
<dt><samp>lt(x, y)</samp></dt>
<dd><p>Return 1 if <var>x</var> is lesser than <var>y</var>, 0 otherwise.
</p>
</dd>
<dt><samp>lte(x, y)</samp></dt>
<dd><p>Return 1 if <var>x</var> is lesser than or equal to <var>y</var>, 0 otherwise.
</p>
</dd>
<dt><samp>max(x, y)</samp></dt>
<dd><p>Return the maximum between <var>x</var> and <var>y</var>.
</p>
</dd>
<dt><samp>min(x, y)</samp></dt>
<dd><p>Return the minimum between <var>x</var> and <var>y</var>.
</p>
</dd>
<dt><samp>mod(x, y)</samp></dt>
<dd><p>Compute the remainder of division of <var>x</var> by <var>y</var>.
</p>
</dd>
<dt><samp>not(expr)</samp></dt>
<dd><p>Return 1.0 if <var>expr</var> is zero, 0.0 otherwise.
</p>
</dd>
<dt><samp>pow(x, y)</samp></dt>
<dd><p>Compute the power of <var>x</var> elevated <var>y</var>, it is equivalent to
&quot;(<var>x</var>)^(<var>y</var>)&quot;.
</p>
</dd>
<dt><samp>print(t)</samp></dt>
<dt><samp>print(t, l)</samp></dt>
<dd><p>Print the value of expression <var>t</var> with loglevel <var>l</var>. If
<var>l</var> is not specified then a default log level is used.
Returns the value of the expression printed.
</p>
<p>Prints t with loglevel l
</p>
</dd>
<dt><samp>random(x)</samp></dt>
<dd><p>Return a pseudo random value between 0.0 and 1.0. <var>x</var> is the index of the
internal variable which will be used to save the seed/state.
</p>
</dd>
<dt><samp>root(expr, max)</samp></dt>
<dd><p>Find an input value for which the function represented by <var>expr</var>
with argument <var>ld(0)</var> is 0 in the interval 0..<var>max</var>.
</p>
<p>The expression in <var>expr</var> must denote a continuous function or the
result is undefined.
</p>
<p><var>ld(0)</var> is used to represent the function input value, which means
that the given expression will be evaluated multiple times with
various input values that the expression can access through
<code>ld(0)</code>. When the expression evaluates to 0 then the
corresponding input value will be returned.
</p>
</dd>
<dt><samp>sin(x)</samp></dt>
<dd><p>Compute sine of <var>x</var>.
</p>
</dd>
<dt><samp>sinh(x)</samp></dt>
<dd><p>Compute hyperbolic sine of <var>x</var>.
</p>
</dd>
<dt><samp>sqrt(expr)</samp></dt>
<dd><p>Compute the square root of <var>expr</var>. This is equivalent to
&quot;(<var>expr</var>)^.5&quot;.
</p>
</dd>
<dt><samp>squish(x)</samp></dt>
<dd><p>Compute expression <code>1/(1 + exp(4*x))</code>.
</p>
</dd>
<dt><samp>st(var, expr)</samp></dt>
<dd><p>Store the value of the expression <var>expr</var> in an internal
variable. <var>var</var> specifies the number of the variable where to
store the value, and it is a value ranging from 0 to 9. The function
returns the value stored in the internal variable.
Note, Variables are currently not shared between expressions.
</p>
</dd>
<dt><samp>tan(x)</samp></dt>
<dd><p>Compute tangent of <var>x</var>.
</p>
</dd>
<dt><samp>tanh(x)</samp></dt>
<dd><p>Compute hyperbolic tangent of <var>x</var>.
</p>
</dd>
<dt><samp>taylor(expr, x)</samp></dt>
<dt><samp>taylor(expr, x, id)</samp></dt>
<dd><p>Evaluate a Taylor series at <var>x</var>, given an expression representing
the <code>ld(id)</code>-th derivative of a function at 0.
</p>
<p>When the series does not converge the result is undefined.
</p>
<p><var>ld(id)</var> is used to represent the derivative order in <var>expr</var>,
which means that the given expression will be evaluated multiple times
with various input values that the expression can access through
<code>ld(id)</code>. If <var>id</var> is not specified then 0 is assumed.
</p>
<p>Note, when you have the derivatives at y instead of 0,
<code>taylor(expr, x-y)</code> can be used.
</p>
</dd>
<dt><samp>time(0)</samp></dt>
<dd><p>Return the current (wallclock) time in seconds.
</p>
</dd>
<dt><samp>trunc(expr)</samp></dt>
<dd><p>Round the value of expression <var>expr</var> towards zero to the nearest
integer. For example, &quot;trunc(-1.5)&quot; is &quot;-1.0&quot;.
</p>
</dd>
<dt><samp>while(cond, expr)</samp></dt>
<dd><p>Evaluate expression <var>expr</var> while the expression <var>cond</var> is
non-zero, and returns the value of the last <var>expr</var> evaluation, or
NAN if <var>cond</var> was always false.
</p></dd>
</dl>
<p>The following constants are available:
</p><dl compact="compact">
<dt><samp>PI</samp></dt>
<dd><p>area of the unit disc, approximately 3.14
</p></dd>
<dt><samp>E</samp></dt>
<dd><p>exp(1) (Euler&rsquo;s number), approximately 2.718
</p></dd>
<dt><samp>PHI</samp></dt>
<dd><p>golden ratio (1+sqrt(5))/2, approximately 1.618
</p></dd>
</dl>
<p>Assuming that an expression is considered &quot;true&quot; if it has a non-zero
value, note that:
</p>
<p><code>*</code> works like AND
</p>
<p><code>+</code> works like OR
</p>
<p>For example the construct:
</p><div class="example">
<pre class="example">if (A AND B) then C
</pre></div>
<p>is equivalent to:
</p><div class="example">
<pre class="example">if(A*B, C)
</pre></div>
<p>In your C code, you can extend the list of unary and binary functions,
and define recognized constants, so that they are available for your
expressions.
</p>
<p>The evaluator also recognizes the International System unit prefixes.
If &rsquo;i&rsquo; is appended after the prefix, binary prefixes are used, which
are based on powers of 1024 instead of powers of 1000.
The &rsquo;B&rsquo; postfix multiplies the value by 8, and can be appended after a
unit prefix or used alone. This allows using for example &rsquo;KB&rsquo;, &rsquo;MiB&rsquo;,
&rsquo;G&rsquo; and &rsquo;B&rsquo; as number postfix.
</p>
<p>The list of available International System prefixes follows, with
indication of the corresponding powers of 10 and of 2.
</p><dl compact="compact">
<dt><samp>y</samp></dt>
<dd><p>10^-24 / 2^-80
</p></dd>
<dt><samp>z</samp></dt>
<dd><p>10^-21 / 2^-70
</p></dd>
<dt><samp>a</samp></dt>
<dd><p>10^-18 / 2^-60
</p></dd>
<dt><samp>f</samp></dt>
<dd><p>10^-15 / 2^-50
</p></dd>
<dt><samp>p</samp></dt>
<dd><p>10^-12 / 2^-40
</p></dd>
<dt><samp>n</samp></dt>
<dd><p>10^-9 / 2^-30
</p></dd>
<dt><samp>u</samp></dt>
<dd><p>10^-6 / 2^-20
</p></dd>
<dt><samp>m</samp></dt>
<dd><p>10^-3 / 2^-10
</p></dd>
<dt><samp>c</samp></dt>
<dd><p>10^-2
</p></dd>
<dt><samp>d</samp></dt>
<dd><p>10^-1
</p></dd>
<dt><samp>h</samp></dt>
<dd><p>10^2
</p></dd>
<dt><samp>k</samp></dt>
<dd><p>10^3 / 2^10
</p></dd>
<dt><samp>K</samp></dt>
<dd><p>10^3 / 2^10
</p></dd>
<dt><samp>M</samp></dt>
<dd><p>10^6 / 2^20
</p></dd>
<dt><samp>G</samp></dt>
<dd><p>10^9 / 2^30
</p></dd>
<dt><samp>T</samp></dt>
<dd><p>10^12 / 2^40
</p></dd>
<dt><samp>P</samp></dt>
<dd><p>10^15 / 2^40
</p></dd>
<dt><samp>E</samp></dt>
<dd><p>10^18 / 2^50
</p></dd>
<dt><samp>Z</samp></dt>
<dd><p>10^21 / 2^60
</p></dd>
<dt><samp>Y</samp></dt>
<dd><p>10^24 / 2^70
</p></dd>
</dl>
<a name="OpenCL-Options"></a>
<h2 class="chapter">8 OpenCL Options<span class="pull-right"><a class="anchor hidden-xs" href="#OpenCL-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-OpenCL-Options" aria-hidden="true">TOC</a></span></h2>
<p>When FFmpeg is configured with <code>--enable-opencl</code>, it is possible
to set the options for the global OpenCL context.
</p>
<p>The list of supported options follows:
</p>
<dl compact="compact">
<dt><samp>build_options</samp></dt>
<dd><p>Set build options used to compile the registered kernels.
</p>
<p>See reference &quot;OpenCL Specification Version: 1.2 chapter 5.6.4&quot;.
</p>
</dd>
<dt><samp>platform_idx</samp></dt>
<dd><p>Select the index of the platform to run OpenCL code.
</p>
<p>The specified index must be one of the indexes in the device list
which can be obtained with <code>ffmpeg -opencl_bench</code> or <code>av_opencl_get_device_list()</code>.
</p>
</dd>
<dt><samp>device_idx</samp></dt>
<dd><p>Select the index of the device used to run OpenCL code.
</p>
<p>The specified index must be one of the indexes in the device list which
can be obtained with <code>ffmpeg -opencl_bench</code> or <code>av_opencl_get_device_list()</code>.
</p>
</dd>
</dl>
<a name="codec_002doptions"></a><a name="Codec-Options"></a>
<h2 class="chapter">9 Codec Options<span class="pull-right"><a class="anchor hidden-xs" href="#Codec-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Codec-Options" aria-hidden="true">TOC</a></span></h2>
<p>libavcodec provides some generic global options, which can be set on
all the encoders and decoders. In addition each codec may support
so-called private options, which are specific for a given codec.
</p>
<p>Sometimes, a global option may only affect a specific kind of codec,
and may be nonsensical or ignored by another, so you need to be aware
of the meaning of the specified options. Also some options are
meant only for decoding or encoding.
</p>
<p>Options may be set by specifying -<var>option</var> <var>value</var> in the
FFmpeg tools, or by setting the value explicitly in the
<code>AVCodecContext</code> options or using the <samp>libavutil/opt.h</samp> API
for programmatic use.
</p>
<p>The list of supported options follow:
</p>
<dl compact="compact">
<dt><samp>b <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd><p>Set bitrate in bits/s. Default value is 200K.
</p>
</dd>
<dt><samp>ab <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dd><p>Set audio bitrate (in bits/s). Default value is 128K.
</p>
</dd>
<dt><samp>bt <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate
tolerance specifies how far ratecontrol is willing to deviate from the
target average bitrate value. This is not related to min/max
bitrate. Lowering tolerance too much has an adverse effect on quality.
</p>
</dd>
<dt><samp>flags <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd><p>Set generic flags.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>mv4</samp>&rsquo;</dt>
<dd><p>Use four motion vector by macroblock (mpeg4).
</p></dd>
<dt>&lsquo;<samp>qpel</samp>&rsquo;</dt>
<dd><p>Use 1/4 pel motion compensation.
</p></dd>
<dt>&lsquo;<samp>loop</samp>&rsquo;</dt>
<dd><p>Use loop filter.
</p></dd>
<dt>&lsquo;<samp>qscale</samp>&rsquo;</dt>
<dd><p>Use fixed qscale.
</p></dd>
<dt>&lsquo;<samp>gmc</samp>&rsquo;</dt>
<dd><p>Use gmc.
</p></dd>
<dt>&lsquo;<samp>mv0</samp>&rsquo;</dt>
<dd><p>Always try a mb with mv=&lt;0,0&gt;.
</p></dd>
<dt>&lsquo;<samp>input_preserved</samp>&rsquo;</dt>
<dt>&lsquo;<samp>pass1</samp>&rsquo;</dt>
<dd><p>Use internal 2pass ratecontrol in first pass mode.
</p></dd>
<dt>&lsquo;<samp>pass2</samp>&rsquo;</dt>
<dd><p>Use internal 2pass ratecontrol in second pass mode.
</p></dd>
<dt>&lsquo;<samp>gray</samp>&rsquo;</dt>
<dd><p>Only decode/encode grayscale.
</p></dd>
<dt>&lsquo;<samp>emu_edge</samp>&rsquo;</dt>
<dd><p>Do not draw edges.
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>Set error[?] variables during encoding.
</p></dd>
<dt>&lsquo;<samp>truncated</samp>&rsquo;</dt>
<dt>&lsquo;<samp>naq</samp>&rsquo;</dt>
<dd><p>Normalize adaptive quantization.
</p></dd>
<dt>&lsquo;<samp>ildct</samp>&rsquo;</dt>
<dd><p>Use interlaced DCT.
</p></dd>
<dt>&lsquo;<samp>low_delay</samp>&rsquo;</dt>
<dd><p>Force low delay.
</p></dd>
<dt>&lsquo;<samp>global_header</samp>&rsquo;</dt>
<dd><p>Place global headers in extradata instead of every keyframe.
</p></dd>
<dt>&lsquo;<samp>bitexact</samp>&rsquo;</dt>
<dd><p>Only write platform-, build- and time-independent data. (except (I)DCT).
This ensures that file and data checksums are reproducible and match between
platforms. Its primary use is for regression testing.
</p></dd>
<dt>&lsquo;<samp>aic</samp>&rsquo;</dt>
<dd><p>Apply H263 advanced intra coding / mpeg4 ac prediction.
</p></dd>
<dt>&lsquo;<samp>cbp</samp>&rsquo;</dt>
<dd><p>Deprecated, use mpegvideo private options instead.
</p></dd>
<dt>&lsquo;<samp>qprd</samp>&rsquo;</dt>
<dd><p>Deprecated, use mpegvideo private options instead.
</p></dd>
<dt>&lsquo;<samp>ilme</samp>&rsquo;</dt>
<dd><p>Apply interlaced motion estimation.
</p></dd>
<dt>&lsquo;<samp>cgop</samp>&rsquo;</dt>
<dd><p>Use closed gop.
</p></dd>
</dl>
</dd>
<dt><samp>me_method <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set motion estimation method.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>zero motion estimation (fastest)
</p></dd>
<dt>&lsquo;<samp>full</samp>&rsquo;</dt>
<dd><p>full motion estimation (slowest)
</p></dd>
<dt>&lsquo;<samp>epzs</samp>&rsquo;</dt>
<dd><p>EPZS motion estimation (default)
</p></dd>
<dt>&lsquo;<samp>esa</samp>&rsquo;</dt>
<dd><p>esa motion estimation (alias for full)
</p></dd>
<dt>&lsquo;<samp>tesa</samp>&rsquo;</dt>
<dd><p>tesa motion estimation
</p></dd>
<dt>&lsquo;<samp>dia</samp>&rsquo;</dt>
<dd><p>dia motion estimation (alias for epzs)
</p></dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>log motion estimation
</p></dd>
<dt>&lsquo;<samp>phods</samp>&rsquo;</dt>
<dd><p>phods motion estimation
</p></dd>
<dt>&lsquo;<samp>x1</samp>&rsquo;</dt>
<dd><p>X1 motion estimation
</p></dd>
<dt>&lsquo;<samp>hex</samp>&rsquo;</dt>
<dd><p>hex motion estimation
</p></dd>
<dt>&lsquo;<samp>umh</samp>&rsquo;</dt>
<dd><p>umh motion estimation
</p></dd>
<dt>&lsquo;<samp>iter</samp>&rsquo;</dt>
<dd><p>iter motion estimation
</p></dd>
</dl>
</dd>
<dt><samp>extradata_size <var>integer</var></samp></dt>
<dd><p>Set extradata size.
</p>
</dd>
<dt><samp>time_base <var>rational number</var></samp></dt>
<dd><p>Set codec time base.
</p>
<p>It is the fundamental unit of time (in seconds) in terms of which
frame timestamps are represented. For fixed-fps content, timebase
should be <code>1 / frame_rate</code> and timestamp increments should be
identically 1.
</p>
</dd>
<dt><samp>g <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set the group of picture (GOP) size. Default value is 12.
</p>
</dd>
<dt><samp>ar <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></dt>
<dd><p>Set audio sampling rate (in Hz).
</p>
</dd>
<dt><samp>ac <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></dt>
<dd><p>Set number of audio channels.
</p>
</dd>
<dt><samp>cutoff <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dd><p>Set cutoff bandwidth.
</p>
</dd>
<dt><samp>frame_size <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dd><p>Set audio frame size.
</p>
<p>Each submitted frame except the last must contain exactly frame_size
samples per channel. May be 0 when the codec has
CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not
restricted. It is set by some decoders to indicate constant frame
size.
</p>
</dd>
<dt><samp>frame_number <var>integer</var></samp></dt>
<dd><p>Set the frame number.
</p>
</dd>
<dt><samp>delay <var>integer</var></samp></dt>
<dt><samp>qcomp <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set video quantizer scale compression (VBR). It is used as a constant
in the ratecontrol equation. Recommended range for default rc_eq:
0.0-1.0.
</p>
</dd>
<dt><samp>qblur <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set video quantizer scale blur (VBR).
</p>
</dd>
<dt><samp>qmin <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set min video quantizer scale (VBR). Must be included between -1 and
69, default value is 2.
</p>
</dd>
<dt><samp>qmax <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set max video quantizer scale (VBR). Must be included between -1 and
1024, default value is 31.
</p>
</dd>
<dt><samp>qdiff <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set max difference between the quantizer scale (VBR).
</p>
</dd>
<dt><samp>bf <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set max number of B frames between non-B-frames.
</p>
<p>Must be an integer between -1 and 16. 0 means that B-frames are
disabled. If a value of -1 is used, it will choose an automatic value
depending on the encoder.
</p>
<p>Default value is 0.
</p>
</dd>
<dt><samp>b_qfactor <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set qp factor between P and B frames.
</p>
</dd>
<dt><samp>rc_strategy <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set ratecontrol method.
</p>
</dd>
<dt><samp>b_strategy <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set strategy to choose between I/P/B-frames.
</p>
</dd>
<dt><samp>ps <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set RTP payload size in bytes.
</p>
</dd>
<dt><samp>mv_bits <var>integer</var></samp></dt>
<dt><samp>header_bits <var>integer</var></samp></dt>
<dt><samp>i_tex_bits <var>integer</var></samp></dt>
<dt><samp>p_tex_bits <var>integer</var></samp></dt>
<dt><samp>i_count <var>integer</var></samp></dt>
<dt><samp>p_count <var>integer</var></samp></dt>
<dt><samp>skip_count <var>integer</var></samp></dt>
<dt><samp>misc_bits <var>integer</var></samp></dt>
<dt><samp>frame_bits <var>integer</var></samp></dt>
<dt><samp>codec_tag <var>integer</var></samp></dt>
<dt><samp>bug <var>flags</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Workaround not auto detected encoder bugs.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>autodetect</samp>&rsquo;</dt>
<dt>&lsquo;<samp>old_msmpeg4</samp>&rsquo;</dt>
<dd><p>some old lavc generated msmpeg4v3 files (no autodetection)
</p></dd>
<dt>&lsquo;<samp>xvid_ilace</samp>&rsquo;</dt>
<dd><p>Xvid interlacing bug (autodetected if fourcc==XVIX)
</p></dd>
<dt>&lsquo;<samp>ump4</samp>&rsquo;</dt>
<dd><p>(autodetected if fourcc==UMP4)
</p></dd>
<dt>&lsquo;<samp>no_padding</samp>&rsquo;</dt>
<dd><p>padding bug (autodetected)
</p></dd>
<dt>&lsquo;<samp>amv</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ac_vlc</samp>&rsquo;</dt>
<dd><p>illegal vlc bug (autodetected per fourcc)
</p></dd>
<dt>&lsquo;<samp>qpel_chroma</samp>&rsquo;</dt>
<dt>&lsquo;<samp>std_qpel</samp>&rsquo;</dt>
<dd><p>old standard qpel (autodetected per fourcc/version)
</p></dd>
<dt>&lsquo;<samp>qpel_chroma2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>direct_blocksize</samp>&rsquo;</dt>
<dd><p>direct-qpel-blocksize bug (autodetected per fourcc/version)
</p></dd>
<dt>&lsquo;<samp>edge</samp>&rsquo;</dt>
<dd><p>edge padding bug (autodetected per fourcc/version)
</p></dd>
<dt>&lsquo;<samp>hpel_chroma</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dc_clip</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ms</samp>&rsquo;</dt>
<dd><p>Workaround various bugs in microsoft broken decoders.
</p></dd>
<dt>&lsquo;<samp>trunc</samp>&rsquo;</dt>
<dd><p>trancated frames
</p></dd>
</dl>
</dd>
<dt><samp>lelim <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set single coefficient elimination threshold for luminance (negative
values also consider DC coefficient).
</p>
</dd>
<dt><samp>celim <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set single coefficient elimination threshold for chrominance (negative
values also consider dc coefficient)
</p>
</dd>
<dt><samp>strict <var>integer</var> (<em>decoding/encoding,audio,video</em>)</samp></dt>
<dd><p>Specify how strictly to follow the standards.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>very</samp>&rsquo;</dt>
<dd><p>strictly conform to an older more strict version of the spec or reference software
</p></dd>
<dt>&lsquo;<samp>strict</samp>&rsquo;</dt>
<dd><p>strictly conform to all the things in the spec no matter what consequences
</p></dd>
<dt>&lsquo;<samp>normal</samp>&rsquo;</dt>
<dt>&lsquo;<samp>unofficial</samp>&rsquo;</dt>
<dd><p>allow unofficial extensions
</p></dd>
<dt>&lsquo;<samp>experimental</samp>&rsquo;</dt>
<dd><p>allow non standardized experimental things, experimental
(unfinished/work in progress/not well tested) decoders and encoders.
Note: experimental decoders can pose a security risk, do not use this for
decoding untrusted input.
</p></dd>
</dl>
</dd>
<dt><samp>b_qoffset <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set QP offset between P and B frames.
</p>
</dd>
<dt><samp>err_detect <var>flags</var> (<em>decoding,audio,video</em>)</samp></dt>
<dd><p>Set error detection flags.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>crccheck</samp>&rsquo;</dt>
<dd><p>verify embedded CRCs
</p></dd>
<dt>&lsquo;<samp>bitstream</samp>&rsquo;</dt>
<dd><p>detect bitstream specification deviations
</p></dd>
<dt>&lsquo;<samp>buffer</samp>&rsquo;</dt>
<dd><p>detect improper bitstream length
</p></dd>
<dt>&lsquo;<samp>explode</samp>&rsquo;</dt>
<dd><p>abort decoding on minor error detection
</p></dd>
<dt>&lsquo;<samp>ignore_err</samp>&rsquo;</dt>
<dd><p>ignore decoding errors, and continue decoding.
This is useful if you want to analyze the content of a video and thus want
everything to be decoded no matter what. This option will not result in a video
that is pleasing to watch in case of errors.
</p></dd>
<dt>&lsquo;<samp>careful</samp>&rsquo;</dt>
<dd><p>consider things that violate the spec and have not been seen in the wild as errors
</p></dd>
<dt>&lsquo;<samp>compliant</samp>&rsquo;</dt>
<dd><p>consider all spec non compliancies as errors
</p></dd>
<dt>&lsquo;<samp>aggressive</samp>&rsquo;</dt>
<dd><p>consider things that a sane encoder should not do as an error
</p></dd>
</dl>
</dd>
<dt><samp>has_b_frames <var>integer</var></samp></dt>
<dt><samp>block_align <var>integer</var></samp></dt>
<dt><samp>mpeg_quant <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Use MPEG quantizers instead of H.263.
</p>
</dd>
<dt><samp>qsquish <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>How to keep quantizer between qmin and qmax (0 = clip, 1 = use
differentiable function).
</p>
</dd>
<dt><samp>rc_qmod_amp <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set experimental quantizer modulation.
</p>
</dd>
<dt><samp>rc_qmod_freq <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set experimental quantizer modulation.
</p>
</dd>
<dt><samp>rc_override_count <var>integer</var></samp></dt>
<dt><samp>rc_eq <var>string</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set rate control equation. When computing the expression, besides the
standard functions defined in the section &rsquo;Expression Evaluation&rsquo;, the
following functions are available: bits2qp(bits), qp2bits(qp). Also
the following constants are available: iTex pTex tex mv fCode iCount
mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex
avgTex.
</p>
</dd>
<dt><samp>maxrate <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd><p>Set max bitrate tolerance (in bits/s). Requires bufsize to be set.
</p>
</dd>
<dt><samp>minrate <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd><p>Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR
encode. It is of little use elsewise.
</p>
</dd>
<dt><samp>bufsize <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd><p>Set ratecontrol buffer size (in bits).
</p>
</dd>
<dt><samp>rc_buf_aggressivity <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Currently useless.
</p>
</dd>
<dt><samp>i_qfactor <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set QP factor between P and I frames.
</p>
</dd>
<dt><samp>i_qoffset <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set QP offset between P and I frames.
</p>
</dd>
<dt><samp>rc_init_cplx <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set initial complexity for 1-pass encoding.
</p>
</dd>
<dt><samp>dct <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set DCT algorithm.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>autoselect a good one (default)
</p></dd>
<dt>&lsquo;<samp>fastint</samp>&rsquo;</dt>
<dd><p>fast integer
</p></dd>
<dt>&lsquo;<samp>int</samp>&rsquo;</dt>
<dd><p>accurate integer
</p></dd>
<dt>&lsquo;<samp>mmx</samp>&rsquo;</dt>
<dt>&lsquo;<samp>altivec</samp>&rsquo;</dt>
<dt>&lsquo;<samp>faan</samp>&rsquo;</dt>
<dd><p>floating point AAN DCT
</p></dd>
</dl>
</dd>
<dt><samp>lumi_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Compress bright areas stronger than medium ones.
</p>
</dd>
<dt><samp>tcplx_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set temporal complexity masking.
</p>
</dd>
<dt><samp>scplx_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set spatial complexity masking.
</p>
</dd>
<dt><samp>p_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set inter masking.
</p>
</dd>
<dt><samp>dark_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Compress dark areas stronger than medium ones.
</p>
</dd>
<dt><samp>idct <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Select IDCT implementation.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dt>&lsquo;<samp>int</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simple</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simplemmx</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simpleauto</samp>&rsquo;</dt>
<dd><p>Automatically pick a IDCT compatible with the simple one
</p>
</dd>
<dt>&lsquo;<samp>arm</samp>&rsquo;</dt>
<dt>&lsquo;<samp>altivec</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sh4</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simplearm</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simplearmv5te</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simplearmv6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simpleneon</samp>&rsquo;</dt>
<dt>&lsquo;<samp>simplealpha</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ipp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>xvidmmx</samp>&rsquo;</dt>
<dt>&lsquo;<samp>faani</samp>&rsquo;</dt>
<dd><p>floating point AAN IDCT
</p></dd>
</dl>
</dd>
<dt><samp>slice_count <var>integer</var></samp></dt>
<dt><samp>ec <var>flags</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Set error concealment strategy.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>guess_mvs</samp>&rsquo;</dt>
<dd><p>iterative motion vector (MV) search (slow)
</p></dd>
<dt>&lsquo;<samp>deblock</samp>&rsquo;</dt>
<dd><p>use strong deblock filter for damaged MBs
</p></dd>
<dt>&lsquo;<samp>favor_inter</samp>&rsquo;</dt>
<dd><p>favor predicting from the previous frame instead of the current
</p></dd>
</dl>
</dd>
<dt><samp>bits_per_coded_sample <var>integer</var></samp></dt>
<dt><samp>pred <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set prediction method.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>left</samp>&rsquo;</dt>
<dt>&lsquo;<samp>plane</samp>&rsquo;</dt>
<dt>&lsquo;<samp>median</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>aspect <var>rational number</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set sample aspect ratio.
</p>
</dd>
<dt><samp>sar <var>rational number</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set sample aspect ratio. Alias to <var>aspect</var>.
</p>
</dd>
<dt><samp>debug <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd><p>Print specific debug info.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>pict</samp>&rsquo;</dt>
<dd><p>picture info
</p></dd>
<dt>&lsquo;<samp>rc</samp>&rsquo;</dt>
<dd><p>rate control
</p></dd>
<dt>&lsquo;<samp>bitstream</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mb_type</samp>&rsquo;</dt>
<dd><p>macroblock (MB) type
</p></dd>
<dt>&lsquo;<samp>qp</samp>&rsquo;</dt>
<dd><p>per-block quantization parameter (QP)
</p></dd>
<dt>&lsquo;<samp>mv</samp>&rsquo;</dt>
<dd><p>motion vector
</p></dd>
<dt>&lsquo;<samp>dct_coeff</samp>&rsquo;</dt>
<dt>&lsquo;<samp>green_metadata</samp>&rsquo;</dt>
<dd><p>display complexity metadata for the upcoming frame, GoP or for a given duration.
</p>
</dd>
<dt>&lsquo;<samp>skip</samp>&rsquo;</dt>
<dt>&lsquo;<samp>startcode</samp>&rsquo;</dt>
<dt>&lsquo;<samp>pts</samp>&rsquo;</dt>
<dt>&lsquo;<samp>er</samp>&rsquo;</dt>
<dd><p>error recognition
</p></dd>
<dt>&lsquo;<samp>mmco</samp>&rsquo;</dt>
<dd><p>memory management control operations (H.264)
</p></dd>
<dt>&lsquo;<samp>bugs</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vis_qp</samp>&rsquo;</dt>
<dd><p>visualize quantization parameter (QP), lower QP are tinted greener
</p></dd>
<dt>&lsquo;<samp>vis_mb_type</samp>&rsquo;</dt>
<dd><p>visualize block types
</p></dd>
<dt>&lsquo;<samp>buffers</samp>&rsquo;</dt>
<dd><p>picture buffer allocations
</p></dd>
<dt>&lsquo;<samp>thread_ops</samp>&rsquo;</dt>
<dd><p>threading operations
</p></dd>
<dt>&lsquo;<samp>nomc</samp>&rsquo;</dt>
<dd><p>skip motion compensation
</p></dd>
</dl>
</dd>
<dt><samp>vismv <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Visualize motion vectors (MVs).
</p>
<p>This option is deprecated, see the codecview filter instead.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>pf</samp>&rsquo;</dt>
<dd><p>forward predicted MVs of P-frames
</p></dd>
<dt>&lsquo;<samp>bf</samp>&rsquo;</dt>
<dd><p>forward predicted MVs of B-frames
</p></dd>
<dt>&lsquo;<samp>bb</samp>&rsquo;</dt>
<dd><p>backward predicted MVs of B-frames
</p></dd>
</dl>
</dd>
<dt><samp>cmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set full pel me compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>subcmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set sub pel me compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>mbcmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set macroblock compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>ildctcmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set interlaced dct compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>dia_size <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set diamond type &amp; size for motion estimation.
</p>
</dd>
<dt><samp>last_pred <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set amount of motion predictors from the previous frame.
</p>
</dd>
<dt><samp>preme <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set pre motion estimation.
</p>
</dd>
<dt><samp>precmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set pre motion estimation compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>pre_dia_size <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set diamond type &amp; size for motion estimation pre-pass.
</p>
</dd>
<dt><samp>subq <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set sub pel motion estimation quality.
</p>
</dd>
<dt><samp>dtg_active_format <var>integer</var></samp></dt>
<dt><samp>me_range <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set limit motion vectors range (1023 for DivX player).
</p>
</dd>
<dt><samp>ibias <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set intra quant bias.
</p>
</dd>
<dt><samp>pbias <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set inter quant bias.
</p>
</dd>
<dt><samp>color_table_id <var>integer</var></samp></dt>
<dt><samp>global_quality <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dt><samp>coder <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>vlc</samp>&rsquo;</dt>
<dd><p>variable length coder / huffman coder
</p></dd>
<dt>&lsquo;<samp>ac</samp>&rsquo;</dt>
<dd><p>arithmetic coder
</p></dd>
<dt>&lsquo;<samp>raw</samp>&rsquo;</dt>
<dd><p>raw (no encoding)
</p></dd>
<dt>&lsquo;<samp>rle</samp>&rsquo;</dt>
<dd><p>run-length coder
</p></dd>
<dt>&lsquo;<samp>deflate</samp>&rsquo;</dt>
<dd><p>deflate-based coder
</p></dd>
</dl>
</dd>
<dt><samp>context <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set context model.
</p>
</dd>
<dt><samp>slice_flags <var>integer</var></samp></dt>
<dt><samp>xvmc_acceleration <var>integer</var></samp></dt>
<dt><samp>mbd <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set macroblock decision algorithm (high quality mode).
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>simple</samp>&rsquo;</dt>
<dd><p>use mbcmp (default)
</p></dd>
<dt>&lsquo;<samp>bits</samp>&rsquo;</dt>
<dd><p>use fewest bits
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>use best rate distortion
</p></dd>
</dl>
</dd>
<dt><samp>stream_codec_tag <var>integer</var></samp></dt>
<dt><samp>sc_threshold <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set scene change threshold.
</p>
</dd>
<dt><samp>lmin <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set min lagrange factor (VBR).
</p>
</dd>
<dt><samp>lmax <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set max lagrange factor (VBR).
</p>
</dd>
<dt><samp>nr <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set noise reduction.
</p>
</dd>
<dt><samp>rc_init_occupancy <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set number of bits which should be loaded into the rc buffer before
decoding starts.
</p>
</dd>
<dt><samp>flags2 <var>flags</var> (<em>decoding/encoding,audio,video</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>fast</samp>&rsquo;</dt>
<dd><p>Allow non spec compliant speedup tricks.
</p></dd>
<dt>&lsquo;<samp>sgop</samp>&rsquo;</dt>
<dd><p>Deprecated, use mpegvideo private options instead.
</p></dd>
<dt>&lsquo;<samp>noout</samp>&rsquo;</dt>
<dd><p>Skip bitstream encoding.
</p></dd>
<dt>&lsquo;<samp>ignorecrop</samp>&rsquo;</dt>
<dd><p>Ignore cropping information from sps.
</p></dd>
<dt>&lsquo;<samp>local_header</samp>&rsquo;</dt>
<dd><p>Place global headers at every keyframe instead of in extradata.
</p></dd>
<dt>&lsquo;<samp>chunks</samp>&rsquo;</dt>
<dd><p>Frame data might be split into multiple chunks.
</p></dd>
<dt>&lsquo;<samp>showall</samp>&rsquo;</dt>
<dd><p>Show all frames before the first keyframe.
</p></dd>
<dt>&lsquo;<samp>skiprd</samp>&rsquo;</dt>
<dd><p>Deprecated, use mpegvideo private options instead.
</p></dd>
<dt>&lsquo;<samp>export_mvs</samp>&rsquo;</dt>
<dd><p>Export motion vectors into frame side-data (see <code>AV_FRAME_DATA_MOTION_VECTORS</code>)
for codecs that support it. See also <samp>doc/examples/export_mvs.c</samp>.
</p></dd>
</dl>
</dd>
<dt><samp>error <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dt><samp>qns <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Deprecated, use mpegvideo private options instead.
</p>
</dd>
<dt><samp>threads <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Set the number of threads to be used, in case the selected codec
implementation supports multi-threading.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>auto, 0</samp>&rsquo;</dt>
<dd><p>automatically select the number of threads to set
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>auto</samp>&rsquo;.
</p>
</dd>
<dt><samp>me_threshold <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set motion estimation threshold.
</p>
</dd>
<dt><samp>mb_threshold <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set macroblock threshold.
</p>
</dd>
<dt><samp>dc <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set intra_dc_precision.
</p>
</dd>
<dt><samp>nssew <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set nsse weight.
</p>
</dd>
<dt><samp>skip_top <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Set number of macroblock rows at the top which are skipped.
</p>
</dd>
<dt><samp>skip_bottom <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Set number of macroblock rows at the bottom which are skipped.
</p>
</dd>
<dt><samp>profile <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>unknown</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_main</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_low</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_ssr</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_ltp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_he</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_he_v2</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_ld</samp>&rsquo;</dt>
<dt>&lsquo;<samp>aac_eld</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg2_aac_low</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg2_aac_he</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg4_sp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg4_core</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg4_main</samp>&rsquo;</dt>
<dt>&lsquo;<samp>mpeg4_asp</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dts</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dts_es</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dts_96_24</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dts_hd_hra</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dts_hd_ma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>level <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>unknown</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>lowres <var>integer</var> (<em>decoding,audio,video</em>)</samp></dt>
<dd><p>Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions.
</p>
</dd>
<dt><samp>skip_threshold <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set frame skip threshold.
</p>
</dd>
<dt><samp>skip_factor <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set frame skip factor.
</p>
</dd>
<dt><samp>skip_exp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set frame skip exponent.
Negative values behave identical to the corresponding positive ones, except
that the score is normalized.
Positive values exist primarily for compatibility reasons and are not so useful.
</p>
</dd>
<dt><samp>skipcmp <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set frame skip compare function.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>sad</samp>&rsquo;</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>&lsquo;<samp>sse</samp>&rsquo;</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>&lsquo;<samp>satd</samp>&rsquo;</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>&lsquo;<samp>dct</samp>&rsquo;</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>&lsquo;<samp>psnr</samp>&rsquo;</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>&lsquo;<samp>bit</samp>&rsquo;</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>&lsquo;<samp>rd</samp>&rsquo;</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>&lsquo;<samp>zero</samp>&rsquo;</dt>
<dd><p>0
</p></dd>
<dt>&lsquo;<samp>vsad</samp>&rsquo;</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>&lsquo;<samp>vsse</samp>&rsquo;</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>&lsquo;<samp>nsse</samp>&rsquo;</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>&lsquo;<samp>w53</samp>&rsquo;</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>w97</samp>&rsquo;</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>&lsquo;<samp>dctmax</samp>&rsquo;</dt>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>border_mask <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Increase the quantizer for macroblocks close to borders.
</p>
</dd>
<dt><samp>mblmin <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set min macroblock lagrange factor (VBR).
</p>
</dd>
<dt><samp>mblmax <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set max macroblock lagrange factor (VBR).
</p>
</dd>
<dt><samp>mepc <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set motion estimation bitrate penalty compensation (1.0 = 256).
</p>
</dd>
<dt><samp>skip_loop_filter <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dt><samp>skip_idct <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dt><samp>skip_frame <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dd>
<p>Make decoder discard processing depending on the frame type selected
by the option value.
</p>
<p><samp>skip_loop_filter</samp> skips frame loop filtering, <samp>skip_idct</samp>
skips frame IDCT/dequantization, <samp>skip_frame</samp> skips decoding.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Discard no frame.
</p>
</dd>
<dt>&lsquo;<samp>default</samp>&rsquo;</dt>
<dd><p>Discard useless frames like 0-sized frames.
</p>
</dd>
<dt>&lsquo;<samp>noref</samp>&rsquo;</dt>
<dd><p>Discard all non-reference frames.
</p>
</dd>
<dt>&lsquo;<samp>bidir</samp>&rsquo;</dt>
<dd><p>Discard all bidirectional frames.
</p>
</dd>
<dt>&lsquo;<samp>nokey</samp>&rsquo;</dt>
<dd><p>Discard all frames excepts keyframes.
</p>
</dd>
<dt>&lsquo;<samp>all</samp>&rsquo;</dt>
<dd><p>Discard all frames.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>default</samp>&rsquo;.
</p>
</dd>
<dt><samp>bidir_refine <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Refine the two motion vectors used in bidirectional macroblocks.
</p>
</dd>
<dt><samp>brd_scale <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Downscale frames for dynamic B-frame decision.
</p>
</dd>
<dt><samp>keyint_min <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set minimum interval between IDR-frames.
</p>
</dd>
<dt><samp>refs <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set reference frames to consider for motion compensation.
</p>
</dd>
<dt><samp>chromaoffset <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set chroma qp offset from luma.
</p>
</dd>
<dt><samp>trellis <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dd><p>Set rate-distortion optimal quantization.
</p>
</dd>
<dt><samp>sc_factor <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set value multiplied by qscale for each frame and added to
scene_change_score.
</p>
</dd>
<dt><samp>mv0_threshold <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dt><samp>b_sensitivity <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Adjust sensitivity of b_frame_strategy 1.
</p>
</dd>
<dt><samp>compression_level <var>integer</var> (<em>encoding,audio,video</em>)</samp></dt>
<dt><samp>min_prediction_order <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dt><samp>max_prediction_order <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dt><samp>timecode_frame_start <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Set GOP timecode frame start number, in non drop frame format.
</p>
</dd>
<dt><samp>request_channels <var>integer</var> (<em>decoding,audio</em>)</samp></dt>
<dd><p>Set desired number of audio channels.
</p>
</dd>
<dt><samp>bits_per_raw_sample <var>integer</var></samp></dt>
<dt><samp>channel_layout <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></dt>
<dd>
<p>Possible values:
</p></dd>
<dt><samp>request_channel_layout <var>integer</var> (<em>decoding,audio</em>)</samp></dt>
<dd>
<p>Possible values:
</p></dd>
<dt><samp>rc_max_vbv_use <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dt><samp>rc_min_vbv_use <var>float</var> (<em>encoding,video</em>)</samp></dt>
<dt><samp>ticks_per_frame <var>integer</var> (<em>decoding/encoding,audio,video</em>)</samp></dt>
<dt><samp>color_primaries <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p></dd>
<dt>&lsquo;<samp>bt470m</samp>&rsquo;</dt>
<dd><p>BT.470 M
</p></dd>
<dt>&lsquo;<samp>bt470bg</samp>&rsquo;</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>&lsquo;<samp>film</samp>&rsquo;</dt>
<dd><p>Film
</p></dd>
<dt>&lsquo;<samp>bt2020</samp>&rsquo;</dt>
<dd><p>BT.2020
</p></dd>
<dt>&lsquo;<samp>smpte428_1</samp>&rsquo;</dt>
<dd><p>SMPTE ST 428-1
</p></dd>
<dt>&lsquo;<samp>smpte431</samp>&rsquo;</dt>
<dd><p>SMPTE 431-2
</p></dd>
<dt>&lsquo;<samp>smpte432</samp>&rsquo;</dt>
<dd><p>SMPTE 432-1
</p></dd>
</dl>
</dd>
<dt><samp>color_trc <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p></dd>
<dt>&lsquo;<samp>gamma22</samp>&rsquo;</dt>
<dd><p>BT.470 M
</p></dd>
<dt>&lsquo;<samp>gamma28</samp>&rsquo;</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>&lsquo;<samp>linear</samp>&rsquo;</dt>
<dd><p>Linear
</p></dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>Log
</p></dd>
<dt>&lsquo;<samp>log_sqrt</samp>&rsquo;</dt>
<dd><p>Log square root
</p></dd>
<dt>&lsquo;<samp>iec61966_2_4</samp>&rsquo;</dt>
<dd><p>IEC 61966-2-4
</p></dd>
<dt>&lsquo;<samp>bt1361</samp>&rsquo;</dt>
<dd><p>BT.1361
</p></dd>
<dt>&lsquo;<samp>iec61966_2_1</samp>&rsquo;</dt>
<dd><p>IEC 61966-2-1
</p></dd>
<dt>&lsquo;<samp>bt2020_10bit</samp>&rsquo;</dt>
<dd><p>BT.2020 - 10 bit
</p></dd>
<dt>&lsquo;<samp>bt2020_12bit</samp>&rsquo;</dt>
<dd><p>BT.2020 - 12 bit
</p></dd>
<dt>&lsquo;<samp>smpte2084</samp>&rsquo;</dt>
<dd><p>SMPTE ST 2084
</p></dd>
<dt>&lsquo;<samp>smpte428_1</samp>&rsquo;</dt>
<dd><p>SMPTE ST 428-1
</p></dd>
<dt>&lsquo;<samp>arib-std-b67</samp>&rsquo;</dt>
<dd><p>ARIB STD-B67
</p></dd>
</dl>
</dd>
<dt><samp>colorspace <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>rgb</samp>&rsquo;</dt>
<dd><p>RGB
</p></dd>
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p></dd>
<dt>&lsquo;<samp>fcc</samp>&rsquo;</dt>
<dd><p>FCC
</p></dd>
<dt>&lsquo;<samp>bt470bg</samp>&rsquo;</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>&lsquo;<samp>ycocg</samp>&rsquo;</dt>
<dd><p>YCOCG
</p></dd>
<dt>&lsquo;<samp>bt2020_ncl</samp>&rsquo;</dt>
<dd><p>BT.2020 NCL
</p></dd>
<dt>&lsquo;<samp>bt2020_cl</samp>&rsquo;</dt>
<dd><p>BT.2020 CL
</p></dd>
<dt>&lsquo;<samp>smpte2085</samp>&rsquo;</dt>
<dd><p>SMPTE 2085
</p></dd>
</dl>
</dd>
<dt><samp>color_range <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>If used as input parameter, it serves as a hint to the decoder, which
color_range the input has.
</p>
</dd>
<dt><samp>chroma_sample_location <var>integer</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dt><samp>log_level_offset <var>integer</var></samp></dt>
<dd><p>Set the log level offset.
</p>
</dd>
<dt><samp>slices <var>integer</var> (<em>encoding,video</em>)</samp></dt>
<dd><p>Number of slices, used in parallelized encoding.
</p>
</dd>
<dt><samp>thread_type <var>flags</var> (<em>decoding/encoding,video</em>)</samp></dt>
<dd><p>Select which multithreading methods to use.
</p>
<p>Use of &lsquo;<samp>frame</samp>&rsquo; will increase decoding delay by one frame per
thread, so clients which cannot provide future frames should not use
it.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>slice</samp>&rsquo;</dt>
<dd><p>Decode more than one part of a single frame at once.
</p>
<p>Multithreading using slices works only when the video was encoded with
slices.
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>Decode more than one frame at once.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>slice+frame</samp>&rsquo;.
</p>
</dd>
<dt><samp>audio_service_type <var>integer</var> (<em>encoding,audio</em>)</samp></dt>
<dd><p>Set audio service type.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>ma</samp>&rsquo;</dt>
<dd><p>Main Audio Service
</p></dd>
<dt>&lsquo;<samp>ef</samp>&rsquo;</dt>
<dd><p>Effects
</p></dd>
<dt>&lsquo;<samp>vi</samp>&rsquo;</dt>
<dd><p>Visually Impaired
</p></dd>
<dt>&lsquo;<samp>hi</samp>&rsquo;</dt>
<dd><p>Hearing Impaired
</p></dd>
<dt>&lsquo;<samp>di</samp>&rsquo;</dt>
<dd><p>Dialogue
</p></dd>
<dt>&lsquo;<samp>co</samp>&rsquo;</dt>
<dd><p>Commentary
</p></dd>
<dt>&lsquo;<samp>em</samp>&rsquo;</dt>
<dd><p>Emergency
</p></dd>
<dt>&lsquo;<samp>vo</samp>&rsquo;</dt>
<dd><p>Voice Over
</p></dd>
<dt>&lsquo;<samp>ka</samp>&rsquo;</dt>
<dd><p>Karaoke
</p></dd>
</dl>
</dd>
<dt><samp>request_sample_fmt <var>sample_fmt</var> (<em>decoding,audio</em>)</samp></dt>
<dd><p>Set sample format audio decoders should prefer. Default value is
<code>none</code>.
</p>
</dd>
<dt><samp>pkt_timebase <var>rational number</var></samp></dt>
<dt><samp>sub_charenc <var>encoding</var> (<em>decoding,subtitles</em>)</samp></dt>
<dd><p>Set the input subtitles character encoding.
</p>
</dd>
<dt><samp>field_order <var>field_order</var> (<em>video</em>)</samp></dt>
<dd><p>Set/override the field order of the video.
Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>progressive</samp>&rsquo;</dt>
<dd><p>Progressive video
</p></dd>
<dt>&lsquo;<samp>tt</samp>&rsquo;</dt>
<dd><p>Interlaced video, top field coded and displayed first
</p></dd>
<dt>&lsquo;<samp>bb</samp>&rsquo;</dt>
<dd><p>Interlaced video, bottom field coded and displayed first
</p></dd>
<dt>&lsquo;<samp>tb</samp>&rsquo;</dt>
<dd><p>Interlaced video, top coded first, bottom displayed first
</p></dd>
<dt>&lsquo;<samp>bt</samp>&rsquo;</dt>
<dd><p>Interlaced video, bottom coded first, top displayed first
</p></dd>
</dl>
</dd>
<dt><samp>skip_alpha <var>integer</var> (<em>decoding,video</em>)</samp></dt>
<dd><p>Set to 1 to disable processing alpha (transparency). This works like the
&lsquo;<samp>gray</samp>&rsquo; flag in the <samp>flags</samp> option which skips chroma information
instead of alpha. Default is 0.
</p>
</dd>
<dt><samp>codec_whitelist <var>list</var> (<em>input</em>)</samp></dt>
<dd><p>&quot;,&quot; separated list of allowed decoders. By default all are allowed.
</p>
</dd>
<dt><samp>dump_separator <var>string</var> (<em>input</em>)</samp></dt>
<dd><p>Separator used to separate the fields printed on the command line about the
Stream parameters.
For example to separate the fields with newlines and indention:
</p><div class="example">
<pre class="example">ffprobe -dump_separator &quot;
&quot; -i ~/videos/matrixbench_mpeg2.mpg
</pre></div>
</dd>
</dl>
<a name="Decoders"></a>
<h2 class="chapter">10 Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Decoders" aria-hidden="true">TOC</a></span></h2>
<p>Decoders are configured elements in FFmpeg which allow the decoding of
multimedia streams.
</p>
<p>When you configure your FFmpeg build, all the supported native decoders
are enabled by default. Decoders requiring an external library must be enabled
manually via the corresponding <code>--enable-lib</code> option. You can list all
available decoders using the configure option <code>--list-decoders</code>.
</p>
<p>You can disable all the decoders with the configure option
<code>--disable-decoders</code> and selectively enable / disable single decoders
with the options <code>--enable-decoder=<var>DECODER</var></code> /
<code>--disable-decoder=<var>DECODER</var></code>.
</p>
<p>The option <code>-decoders</code> of the ff* tools will display the list of
enabled decoders.
</p>
<a name="Video-Decoders"></a>
<h2 class="chapter">11 Video Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Decoders" aria-hidden="true">TOC</a></span></h2>
<p>A description of some of the currently available video decoders
follows.
</p>
<a name="hevc"></a>
<h3 class="section">11.1 hevc<span class="pull-right"><a class="anchor hidden-xs" href="#hevc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hevc" aria-hidden="true">TOC</a></span></h3>
<p>HEVC / H.265 decoder.
</p>
<p>Note: the <samp>skip_loop_filter</samp> option has effect only at level
<code>all</code>.
</p>
<a name="rawvideo"></a>
<h3 class="section">11.2 rawvideo<span class="pull-right"><a class="anchor hidden-xs" href="#rawvideo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rawvideo" aria-hidden="true">TOC</a></span></h3>
<p>Raw video decoder.
</p>
<p>This decoder decodes rawvideo streams.
</p>
<a name="Options-1"></a>
<h4 class="subsection">11.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-1" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>top <var>top_field_first</var></samp></dt>
<dd><p>Specify the assumed field type of the input video.
</p><dl compact="compact">
<dt><samp>-1</samp></dt>
<dd><p>the video is assumed to be progressive (default)
</p></dd>
<dt><samp>0</samp></dt>
<dd><p>bottom-field-first is assumed
</p></dd>
<dt><samp>1</samp></dt>
<dd><p>top-field-first is assumed
</p></dd>
</dl>
</dd>
</dl>
<a name="Audio-Decoders"></a>
<h2 class="chapter">12 Audio Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Decoders" aria-hidden="true">TOC</a></span></h2>
<p>A description of some of the currently available audio decoders
follows.
</p>
<a name="ac3"></a>
<h3 class="section">12.1 ac3<span class="pull-right"><a class="anchor hidden-xs" href="#ac3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ac3" aria-hidden="true">TOC</a></span></h3>
<p>AC-3 audio decoder.
</p>
<p>This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
the undocumented RealAudio 3 (a.k.a. dnet).
</p>
<a name="AC_002d3-Decoder-Options"></a>
<h4 class="subsection">12.1.1 AC-3 Decoder Options<span class="pull-right"><a class="anchor hidden-xs" href="#AC_002d3-Decoder-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-AC_002d3-Decoder-Options" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>-drc_scale <var>value</var></samp></dt>
<dd><p>Dynamic Range Scale Factor. The factor to apply to dynamic range values
from the AC-3 stream. This factor is applied exponentially.
There are 3 notable scale factor ranges:
</p><dl compact="compact">
<dt><samp>drc_scale == 0</samp></dt>
<dd><p>DRC disabled. Produces full range audio.
</p></dd>
<dt><samp>0 &lt; drc_scale &lt;= 1</samp></dt>
<dd><p>DRC enabled. Applies a fraction of the stream DRC value.
Audio reproduction is between full range and full compression.
</p></dd>
<dt><samp>drc_scale &gt; 1</samp></dt>
<dd><p>DRC enabled. Applies drc_scale asymmetrically.
Loud sounds are fully compressed. Soft sounds are enhanced.
</p></dd>
</dl>
</dd>
</dl>
<a name="flac"></a>
<h3 class="section">12.2 flac<span class="pull-right"><a class="anchor hidden-xs" href="#flac" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flac" aria-hidden="true">TOC</a></span></h3>
<p>FLAC audio decoder.
</p>
<p>This decoder aims to implement the complete FLAC specification from Xiph.
</p>
<a name="FLAC-Decoder-options"></a>
<h4 class="subsection">12.2.1 FLAC Decoder options<span class="pull-right"><a class="anchor hidden-xs" href="#FLAC-Decoder-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-FLAC-Decoder-options" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>-use_buggy_lpc</samp></dt>
<dd><p>The lavc FLAC encoder used to produce buggy streams with high lpc values
(like the default value). This option makes it possible to decode such streams
correctly by using lavc&rsquo;s old buggy lpc logic for decoding.
</p>
</dd>
</dl>
<a name="ffwavesynth"></a>
<h3 class="section">12.3 ffwavesynth<span class="pull-right"><a class="anchor hidden-xs" href="#ffwavesynth" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ffwavesynth" aria-hidden="true">TOC</a></span></h3>
<p>Internal wave synthetizer.
</p>
<p>This decoder generates wave patterns according to predefined sequences. Its
use is purely internal and the format of the data it accepts is not publicly
documented.
</p>
<a name="libcelt"></a>
<h3 class="section">12.4 libcelt<span class="pull-right"><a class="anchor hidden-xs" href="#libcelt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libcelt" aria-hidden="true">TOC</a></span></h3>
<p>libcelt decoder wrapper.
</p>
<p>libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec.
Requires the presence of the libcelt headers and library during configuration.
You need to explicitly configure the build with <code>--enable-libcelt</code>.
</p>
<a name="libgsm"></a>
<h3 class="section">12.5 libgsm<span class="pull-right"><a class="anchor hidden-xs" href="#libgsm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libgsm" aria-hidden="true">TOC</a></span></h3>
<p>libgsm decoder wrapper.
</p>
<p>libgsm allows libavcodec to decode the GSM full rate audio codec. Requires
the presence of the libgsm headers and library during configuration. You need
to explicitly configure the build with <code>--enable-libgsm</code>.
</p>
<p>This decoder supports both the ordinary GSM and the Microsoft variant.
</p>
<a name="libilbc"></a>
<h3 class="section">12.6 libilbc<span class="pull-right"><a class="anchor hidden-xs" href="#libilbc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libilbc" aria-hidden="true">TOC</a></span></h3>
<p>libilbc decoder wrapper.
</p>
<p>libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC)
audio codec. Requires the presence of the libilbc headers and library during
configuration. You need to explicitly configure the build with
<code>--enable-libilbc</code>.
</p>
<a name="Options-2"></a>
<h4 class="subsection">12.6.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-2" aria-hidden="true">TOC</a></span></h4>
<p>The following option is supported by the libilbc wrapper.
</p>
<dl compact="compact">
<dt><samp>enhance</samp></dt>
<dd>
<p>Enable the enhancement of the decoded audio when set to 1. The default
value is 0 (disabled).
</p>
</dd>
</dl>
<a name="libopencore_002damrnb"></a>
<h3 class="section">12.7 libopencore-amrnb<span class="pull-right"><a class="anchor hidden-xs" href="#libopencore_002damrnb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopencore_002damrnb" aria-hidden="true">TOC</a></span></h3>
<p>libopencore-amrnb decoder wrapper.
</p>
<p>libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate
Narrowband audio codec. Using it requires the presence of the
libopencore-amrnb headers and library during configuration. You need to
explicitly configure the build with <code>--enable-libopencore-amrnb</code>.
</p>
<p>An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB
without this library.
</p>
<a name="libopencore_002damrwb"></a>
<h3 class="section">12.8 libopencore-amrwb<span class="pull-right"><a class="anchor hidden-xs" href="#libopencore_002damrwb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopencore_002damrwb" aria-hidden="true">TOC</a></span></h3>
<p>libopencore-amrwb decoder wrapper.
</p>
<p>libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate
Wideband audio codec. Using it requires the presence of the
libopencore-amrwb headers and library during configuration. You need to
explicitly configure the build with <code>--enable-libopencore-amrwb</code>.
</p>
<p>An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB
without this library.
</p>
<a name="libopus"></a>
<h3 class="section">12.9 libopus<span class="pull-right"><a class="anchor hidden-xs" href="#libopus" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopus" aria-hidden="true">TOC</a></span></h3>
<p>libopus decoder wrapper.
</p>
<p>libopus allows libavcodec to decode the Opus Interactive Audio Codec.
Requires the presence of the libopus headers and library during
configuration. You need to explicitly configure the build with
<code>--enable-libopus</code>.
</p>
<p>An FFmpeg native decoder for Opus exists, so users can decode Opus
without this library.
</p>
<a name="Subtitles-Decoders"></a>
<h2 class="chapter">13 Subtitles Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Subtitles-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Subtitles-Decoders" aria-hidden="true">TOC</a></span></h2>
<a name="dvbsub"></a>
<h3 class="section">13.1 dvbsub<span class="pull-right"><a class="anchor hidden-xs" href="#dvbsub" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dvbsub" aria-hidden="true">TOC</a></span></h3>
<a name="Options-3"></a>
<h4 class="subsection">13.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-3" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>compute_clut</samp></dt>
<dd><dl compact="compact">
<dt><samp>-1</samp></dt>
<dd><p>Compute clut if no matching CLUT is in the stream.
</p></dd>
<dt><samp>0</samp></dt>
<dd><p>Never compute CLUT
</p></dd>
<dt><samp>1</samp></dt>
<dd><p>Always compute CLUT and override the one provided in the stream.
</p></dd>
</dl>
</dd>
<dt><samp>dvb_substream</samp></dt>
<dd><p>Selects the dvb substream, or all substreams if -1 which is default.
</p>
</dd>
</dl>
<a name="dvdsub"></a>
<h3 class="section">13.2 dvdsub<span class="pull-right"><a class="anchor hidden-xs" href="#dvdsub" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dvdsub" aria-hidden="true">TOC</a></span></h3>
<p>This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
also be found in VobSub file pairs and in some Matroska files.
</p>
<a name="Options-4"></a>
<h4 class="subsection">13.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-4" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-4" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>palette</samp></dt>
<dd><p>Specify the global palette used by the bitmaps. When stored in VobSub, the
palette is normally specified in the index file; in Matroska, the palette is
stored in the codec extra-data in the same format as in VobSub. In DVDs, the
palette is stored in the IFO file, and therefore not available when reading
from dumped VOB files.
</p>
<p>The format for this option is a string containing 16 24-bits hexadecimal
numbers (without 0x prefix) separated by comas, for example <code>0d00ee,
ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
</p>
</dd>
<dt><samp>ifo_palette</samp></dt>
<dd><p>Specify the IFO file from which the global palette is obtained.
(experimental)
</p>
</dd>
<dt><samp>forced_subs_only</samp></dt>
<dd><p>Only decode subtitle entries marked as forced. Some titles have forced
and non-forced subtitles in the same track. Setting this flag to <code>1</code>
will only keep the forced subtitles. Default value is <code>0</code>.
</p></dd>
</dl>
<a name="libzvbi_002dteletext"></a>
<h3 class="section">13.3 libzvbi-teletext<span class="pull-right"><a class="anchor hidden-xs" href="#libzvbi_002dteletext" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libzvbi_002dteletext" aria-hidden="true">TOC</a></span></h3>
<p>Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext
subtitles. Requires the presence of the libzvbi headers and library during
configuration. You need to explicitly configure the build with
<code>--enable-libzvbi</code>.
</p>
<a name="Options-5"></a>
<h4 class="subsection">13.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-5" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>txt_page</samp></dt>
<dd><p>List of teletext page numbers to decode. You may use the special * string to
match all pages. Pages that do not match the specified list are dropped.
Default value is *.
</p></dd>
<dt><samp>txt_chop_top</samp></dt>
<dd><p>Discards the top teletext line. Default value is 1.
</p></dd>
<dt><samp>txt_format</samp></dt>
<dd><p>Specifies the format of the decoded subtitles. The teletext decoder is capable
of decoding the teletext pages to bitmaps or to simple text, you should use
&quot;bitmap&quot; for teletext pages, because certain graphics and colors cannot be
expressed in simple text. You might use &quot;text&quot; for teletext based subtitles if
your application can handle simple text based subtitles. Default value is
bitmap.
</p></dd>
<dt><samp>txt_left</samp></dt>
<dd><p>X offset of generated bitmaps, default is 0.
</p></dd>
<dt><samp>txt_top</samp></dt>
<dd><p>Y offset of generated bitmaps, default is 0.
</p></dd>
<dt><samp>txt_chop_spaces</samp></dt>
<dd><p>Chops leading and trailing spaces and removes empty lines from the generated
text. This option is useful for teletext based subtitles where empty spaces may
be present at the start or at the end of the lines or empty lines may be
present between the subtitle lines because of double-sized teletext charactes.
Default value is 1.
</p></dd>
<dt><samp>txt_duration</samp></dt>
<dd><p>Sets the display duration of the decoded teletext pages or subtitles in
milliseconds. Default value is 30000 which is 30 seconds.
</p></dd>
<dt><samp>txt_transparent</samp></dt>
<dd><p>Force transparent background of the generated teletext bitmaps. Default value
is 0 which means an opaque background.
</p></dd>
<dt><samp>txt_opacity</samp></dt>
<dd><p>Sets the opacity (0-255) of the teletext background. If
<samp>txt_transparent</samp> is not set, it only affects characters between a start
box and an end box, typically subtitles. Default value is 0 if
<samp>txt_transparent</samp> is set, 255 otherwise.
</p>
</dd>
</dl>
<a name="Bitstream-Filters"></a>
<h2 class="chapter">14 Bitstream Filters<span class="pull-right"><a class="anchor hidden-xs" href="#Bitstream-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Bitstream-Filters" aria-hidden="true">TOC</a></span></h2>
<p>When you configure your FFmpeg build, all the supported bitstream
filters are enabled by default. You can list all available ones using
the configure option <code>--list-bsfs</code>.
</p>
<p>You can disable all the bitstream filters using the configure option
<code>--disable-bsfs</code>, and selectively enable any bitstream filter using
the option <code>--enable-bsf=BSF</code>, or you can disable a particular
bitstream filter using the option <code>--disable-bsf=BSF</code>.
</p>
<p>The option <code>-bsfs</code> of the ff* tools will display the list of
all the supported bitstream filters included in your build.
</p>
<p>The ff* tools have a -bsf option applied per stream, taking a
comma-separated list of filters, whose parameters follow the filter
name after a &rsquo;=&rsquo;.
</p>
<div class="example">
<pre class="example">ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
</pre></div>
<p>Below is a description of the currently available bitstream filters,
with their parameters, if any.
</p>
<a name="aac_005fadtstoasc"></a>
<h3 class="section">14.1 aac_adtstoasc<span class="pull-right"><a class="anchor hidden-xs" href="#aac_005fadtstoasc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aac_005fadtstoasc" aria-hidden="true">TOC</a></span></h3>
<p>Convert MPEG-2/4 AAC ADTS to MPEG-4 Audio Specific Configuration
bitstream filter.
</p>
<p>This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4
ADTS header and removes the ADTS header.
</p>
<p>This is required for example when copying an AAC stream from a raw
ADTS AAC container to a FLV or a MOV/MP4 file.
</p>
<a name="chomp"></a>
<h3 class="section">14.2 chomp<span class="pull-right"><a class="anchor hidden-xs" href="#chomp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chomp" aria-hidden="true">TOC</a></span></h3>
<p>Remove zero padding at the end of a packet.
</p>
<a name="dump_005fextra"></a>
<h3 class="section">14.3 dump_extra<span class="pull-right"><a class="anchor hidden-xs" href="#dump_005fextra" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dump_005fextra" aria-hidden="true">TOC</a></span></h3>
<p>Add extradata to the beginning of the filtered packets.
</p>
<p>The additional argument specifies which packets should be filtered.
It accepts the values:
</p><dl compact="compact">
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dd><p>add extradata to all key packets, but only if <var>local_header</var> is
set in the <samp>flags2</samp> codec context field
</p>
</dd>
<dt>&lsquo;<samp>k</samp>&rsquo;</dt>
<dd><p>add extradata to all key packets
</p>
</dd>
<dt>&lsquo;<samp>e</samp>&rsquo;</dt>
<dd><p>add extradata to all packets
</p></dd>
</dl>
<p>If not specified it is assumed &lsquo;<samp>k</samp>&rsquo;.
</p>
<p>For example the following <code>ffmpeg</code> command forces a global
header (thus disabling individual packet headers) in the H.264 packets
generated by the <code>libx264</code> encoder, but corrects them by adding
the header stored in extradata to the key packets:
</p><div class="example">
<pre class="example">ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
</pre></div>
<a name="dca_005fcore"></a>
<h3 class="section">14.4 dca_core<span class="pull-right"><a class="anchor hidden-xs" href="#dca_005fcore" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dca_005fcore" aria-hidden="true">TOC</a></span></h3>
<p>Extract DCA core from DTS-HD streams.
</p>
<a name="h264_005fmp4toannexb"></a>
<h3 class="section">14.5 h264_mp4toannexb<span class="pull-right"><a class="anchor hidden-xs" href="#h264_005fmp4toannexb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-h264_005fmp4toannexb" aria-hidden="true">TOC</a></span></h3>
<p>Convert an H.264 bitstream from length prefixed mode to start code
prefixed mode (as defined in the Annex B of the ITU-T H.264
specification).
</p>
<p>This is required by some streaming formats, typically the MPEG-2
transport stream format (&quot;mpegts&quot;).
</p>
<p>For example to remux an MP4 file containing an H.264 stream to mpegts
format with <code>ffmpeg</code>, you can use the command:
</p>
<div class="example">
<pre class="example">ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
</pre></div>
<a name="imxdump"></a>
<h3 class="section">14.6 imxdump<span class="pull-right"><a class="anchor hidden-xs" href="#imxdump" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-imxdump" aria-hidden="true">TOC</a></span></h3>
<p>Modifies the bitstream to fit in MOV and to be usable by the Final Cut
Pro decoder. This filter only applies to the mpeg2video codec, and is
likely not needed for Final Cut Pro 7 and newer with the appropriate
<samp>-tag:v</samp>.
</p>
<p>For example, to remux 30 MB/sec NTSC IMX to MOV:
</p>
<div class="example">
<pre class="example">ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
</pre></div>
<a name="mjpeg2jpeg"></a>
<h3 class="section">14.7 mjpeg2jpeg<span class="pull-right"><a class="anchor hidden-xs" href="#mjpeg2jpeg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mjpeg2jpeg" aria-hidden="true">TOC</a></span></h3>
<p>Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
</p>
<p>MJPEG is a video codec wherein each video frame is essentially a
JPEG image. The individual frames can be extracted without loss,
e.g. by
</p>
<div class="example">
<pre class="example">ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
</pre></div>
<p>Unfortunately, these chunks are incomplete JPEG images, because
they lack the DHT segment required for decoding. Quoting from
<a href="http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml">http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml</a>:
</p>
<p>Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
commented that &quot;MJPEG, or at least the MJPEG in AVIs having the
MJPG fourcc, is restricted JPEG with a fixed &ndash; and *omitted* &ndash;
Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
and it must use basic Huffman encoding, not arithmetic or
progressive. . . . You can indeed extract the MJPEG frames and
decode them with a regular JPEG decoder, but you have to prepend
the DHT segment to them, or else the decoder won&rsquo;t have any idea
how to decompress the data. The exact table necessary is given in
the OpenDML spec.&quot;
</p>
<p>This bitstream filter patches the header of frames extracted from an MJPEG
stream (carrying the AVI1 header ID and lacking a DHT segment) to
produce fully qualified JPEG images.
</p>
<div class="example">
<pre class="example">ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
exiftran -i -9 frame*.jpg
ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
</pre></div>
<a name="mjpega_005fdump_005fheader"></a>
<h3 class="section">14.8 mjpega_dump_header<span class="pull-right"><a class="anchor hidden-xs" href="#mjpega_005fdump_005fheader" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mjpega_005fdump_005fheader" aria-hidden="true">TOC</a></span></h3>
<a name="movsub"></a>
<h3 class="section">14.9 movsub<span class="pull-right"><a class="anchor hidden-xs" href="#movsub" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-movsub" aria-hidden="true">TOC</a></span></h3>
<a name="mp3_005fheader_005fdecompress"></a>
<h3 class="section">14.10 mp3_header_decompress<span class="pull-right"><a class="anchor hidden-xs" href="#mp3_005fheader_005fdecompress" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mp3_005fheader_005fdecompress" aria-hidden="true">TOC</a></span></h3>
<a name="mpeg4_005funpack_005fbframes"></a>
<h3 class="section">14.11 mpeg4_unpack_bframes<span class="pull-right"><a class="anchor hidden-xs" href="#mpeg4_005funpack_005fbframes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mpeg4_005funpack_005fbframes" aria-hidden="true">TOC</a></span></h3>
<p>Unpack DivX-style packed B-frames.
</p>
<p>DivX-style packed B-frames are not valid MPEG-4 and were only a
workaround for the broken Video for Windows subsystem.
They use more space, can cause minor AV sync issues, require more
CPU power to decode (unless the player has some decoded picture queue
to compensate the 2,0,2,0 frame per packet style) and cause
trouble if copied into a standard container like mp4 or mpeg-ps/ts,
because MPEG-4 decoders may not be able to decode them, since they are
not valid MPEG-4.
</p>
<p>For example to fix an AVI file containing an MPEG-4 stream with
DivX-style packed B-frames using <code>ffmpeg</code>, you can use the command:
</p>
<div class="example">
<pre class="example">ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
</pre></div>
<a name="noise"></a>
<h3 class="section">14.12 noise<span class="pull-right"><a class="anchor hidden-xs" href="#noise" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-noise" aria-hidden="true">TOC</a></span></h3>
<p>Damages the contents of packets without damaging the container. Can be
used for fuzzing or testing error resilience/concealment.
</p>
<p>Parameters:
A numeral string, whose value is related to how often output bytes will
be modified. Therefore, values below or equal to 0 are forbidden, and
the lower the more frequent bytes will be modified, with 1 meaning
every byte is modified.
</p>
<div class="example">
<pre class="example">ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
</pre></div>
<p>applies the modification to every byte.
</p>
<a name="remove_005fextra"></a>
<h3 class="section">14.13 remove_extra<span class="pull-right"><a class="anchor hidden-xs" href="#remove_005fextra" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-remove_005fextra" aria-hidden="true">TOC</a></span></h3>
<a name="Format-Options"></a>
<h2 class="chapter">15 Format Options<span class="pull-right"><a class="anchor hidden-xs" href="#Format-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Format-Options" aria-hidden="true">TOC</a></span></h2>
<p>The libavformat library provides some generic global options, which
can be set on all the muxers and demuxers. In addition each muxer or
demuxer may support so-called private options, which are specific for
that component.
</p>
<p>Options may be set by specifying -<var>option</var> <var>value</var> in the
FFmpeg tools, or by setting the value explicitly in the
<code>AVFormatContext</code> options or using the <samp>libavutil/opt.h</samp> API
for programmatic use.
</p>
<p>The list of supported options follows:
</p>
<dl compact="compact">
<dt><samp>avioflags <var>flags</var> (<em>input/output</em>)</samp></dt>
<dd><p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>direct</samp>&rsquo;</dt>
<dd><p>Reduce buffering.
</p></dd>
</dl>
</dd>
<dt><samp>probesize <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Set probing size in bytes, i.e. the size of the data to analyze to get
stream information. A higher value will enable detecting more
information in case it is dispersed into the stream, but will increase
latency. Must be an integer not lesser than 32. It is 5000000 by default.
</p>
</dd>
<dt><samp>packetsize <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Set packet size.
</p>
</dd>
<dt><samp>fflags <var>flags</var> (<em>input/output</em>)</samp></dt>
<dd><p>Set format flags.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>ignidx</samp>&rsquo;</dt>
<dd><p>Ignore index.
</p></dd>
<dt>&lsquo;<samp>fastseek</samp>&rsquo;</dt>
<dd><p>Enable fast, but inaccurate seeks for some formats.
</p></dd>
<dt>&lsquo;<samp>genpts</samp>&rsquo;</dt>
<dd><p>Generate PTS.
</p></dd>
<dt>&lsquo;<samp>nofillin</samp>&rsquo;</dt>
<dd><p>Do not fill in missing values that can be exactly calculated.
</p></dd>
<dt>&lsquo;<samp>noparse</samp>&rsquo;</dt>
<dd><p>Disable AVParsers, this needs <code>+nofillin</code> too.
</p></dd>
<dt>&lsquo;<samp>igndts</samp>&rsquo;</dt>
<dd><p>Ignore DTS.
</p></dd>
<dt>&lsquo;<samp>discardcorrupt</samp>&rsquo;</dt>
<dd><p>Discard corrupted frames.
</p></dd>
<dt>&lsquo;<samp>sortdts</samp>&rsquo;</dt>
<dd><p>Try to interleave output packets by DTS.
</p></dd>
<dt>&lsquo;<samp>keepside</samp>&rsquo;</dt>
<dd><p>Do not merge side data.
</p></dd>
<dt>&lsquo;<samp>latm</samp>&rsquo;</dt>
<dd><p>Enable RTP MP4A-LATM payload.
</p></dd>
<dt>&lsquo;<samp>nobuffer</samp>&rsquo;</dt>
<dd><p>Reduce the latency introduced by optional buffering
</p></dd>
<dt>&lsquo;<samp>bitexact</samp>&rsquo;</dt>
<dd><p>Only write platform-, build- and time-independent data.
This ensures that file and data checksums are reproducible and match between
platforms. Its primary use is for regression testing.
</p></dd>
<dt>&lsquo;<samp>shortest</samp>&rsquo;</dt>
<dd><p>Stop muxing at the end of the shortest stream.
It may be needed to increase max_interleave_delta to avoid flusing the longer
streams before EOF.
</p></dd>
</dl>
</dd>
<dt><samp>seek2any <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Allow seeking to non-keyframes on demuxer level when supported if set to 1.
Default is 0.
</p>
</dd>
<dt><samp>analyzeduration <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Specify how many microseconds are analyzed to probe the input. A
higher value will enable detecting more accurate information, but will
increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
</p>
</dd>
<dt><samp>cryptokey <var>hexadecimal string</var> (<em>input</em>)</samp></dt>
<dd><p>Set decryption key.
</p>
</dd>
<dt><samp>indexmem <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Set max memory used for timestamp index (per stream).
</p>
</dd>
<dt><samp>rtbufsize <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Set max memory used for buffering real-time frames.
</p>
</dd>
<dt><samp>fdebug <var>flags</var> (<em>input/output</em>)</samp></dt>
<dd><p>Print specific debug info.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>ts</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>max_delay <var>integer</var> (<em>input/output</em>)</samp></dt>
<dd><p>Set maximum muxing or demuxing delay in microseconds.
</p>
</dd>
<dt><samp>fpsprobesize <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Set number of frames used to probe fps.
</p>
</dd>
<dt><samp>audio_preload <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Set microseconds by which audio packets should be interleaved earlier.
</p>
</dd>
<dt><samp>chunk_duration <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Set microseconds for each chunk.
</p>
</dd>
<dt><samp>chunk_size <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Set size in bytes for each chunk.
</p>
</dd>
<dt><samp>err_detect, f_err_detect <var>flags</var> (<em>input</em>)</samp></dt>
<dd><p>Set error detection flags. <code>f_err_detect</code> is deprecated and
should be used only via the <code>ffmpeg</code> tool.
</p>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>crccheck</samp>&rsquo;</dt>
<dd><p>Verify embedded CRCs.
</p></dd>
<dt>&lsquo;<samp>bitstream</samp>&rsquo;</dt>
<dd><p>Detect bitstream specification deviations.
</p></dd>
<dt>&lsquo;<samp>buffer</samp>&rsquo;</dt>
<dd><p>Detect improper bitstream length.
</p></dd>
<dt>&lsquo;<samp>explode</samp>&rsquo;</dt>
<dd><p>Abort decoding on minor error detection.
</p></dd>
<dt>&lsquo;<samp>careful</samp>&rsquo;</dt>
<dd><p>Consider things that violate the spec and have not been seen in the
wild as errors.
</p></dd>
<dt>&lsquo;<samp>compliant</samp>&rsquo;</dt>
<dd><p>Consider all spec non compliancies as errors.
</p></dd>
<dt>&lsquo;<samp>aggressive</samp>&rsquo;</dt>
<dd><p>Consider things that a sane encoder should not do as an error.
</p></dd>
</dl>
</dd>
<dt><samp>max_interleave_delta <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Set maximum buffering duration for interleaving. The duration is
expressed in microseconds, and defaults to 1000000 (1 second).
</p>
<p>To ensure all the streams are interleaved correctly, libavformat will
wait until it has at least one packet for each stream before actually
writing any packets to the output file. When some streams are
&quot;sparse&quot; (i.e. there are large gaps between successive packets), this
can result in excessive buffering.
</p>
<p>This field specifies the maximum difference between the timestamps of the
first and the last packet in the muxing queue, above which libavformat
will output a packet regardless of whether it has queued a packet for all
the streams.
</p>
<p>If set to 0, libavformat will continue buffering packets until it has
a packet for each stream, regardless of the maximum timestamp
difference between the buffered packets.
</p>
</dd>
<dt><samp>use_wallclock_as_timestamps <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Use wallclock as timestamps if set to 1. Default is 0.
</p>
</dd>
<dt><samp>avoid_negative_ts <var>integer</var> (<em>output</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl compact="compact">
<dt>&lsquo;<samp>make_non_negative</samp>&rsquo;</dt>
<dd><p>Shift timestamps to make them non-negative.
Also note that this affects only leading negative timestamps, and not
non-monotonic negative timestamps.
</p></dd>
<dt>&lsquo;<samp>make_zero</samp>&rsquo;</dt>
<dd><p>Shift timestamps so that the first timestamp is 0.
</p></dd>
<dt>&lsquo;<samp>auto (default)</samp>&rsquo;</dt>
<dd><p>Enables shifting when required by the target format.
</p></dd>
<dt>&lsquo;<samp>disabled</samp>&rsquo;</dt>
<dd><p>Disables shifting of timestamp.
</p></dd>
</dl>
<p>When shifting is enabled, all output timestamps are shifted by the
same amount. Audio, video, and subtitles desynching and relative
timestamp differences are preserved compared to how they would have
been without shifting.
</p>
</dd>
<dt><samp>skip_initial_bytes <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Set number of bytes to skip before reading header and frames if set to 1.
Default is 0.
</p>
</dd>
<dt><samp>correct_ts_overflow <var>integer</var> (<em>input</em>)</samp></dt>
<dd><p>Correct single timestamp overflows if set to 1. Default is 1.
</p>
</dd>
<dt><samp>flush_packets <var>integer</var> (<em>output</em>)</samp></dt>
<dd><p>Flush the underlying I/O stream after each packet. Default 1 enables it, and
has the effect of reducing the latency; 0 disables it and may slightly
increase performance in some cases.
</p>
</dd>
<dt><samp>output_ts_offset <var>offset</var> (<em>output</em>)</samp></dt>
<dd><p>Set the output time offset.
</p>
<p><var>offset</var> must be a time duration specification,
see <a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>.
</p>
<p>The offset is added by the muxer to the output timestamps.
</p>
<p>Specifying a positive offset means that the corresponding streams are
delayed bt the time duration specified in <var>offset</var>. Default value
is <code>0</code> (meaning that no offset is applied).
</p>
</dd>
<dt><samp>format_whitelist <var>list</var> (<em>input</em>)</samp></dt>
<dd><p>&quot;,&quot; separated list of allowed demuxers. By default all are allowed.
</p>
</dd>
<dt><samp>dump_separator <var>string</var> (<em>input</em>)</samp></dt>
<dd><p>Separator used to separate the fields printed on the command line about the
Stream parameters.
For example to separate the fields with newlines and indention:
</p><div class="example">
<pre class="example">ffprobe -dump_separator &quot;
&quot; -i ~/videos/matrixbench_mpeg2.mpg
</pre></div>
</dd>
</dl>
<a name="Format-stream-specifiers"></a><a name="Format-stream-specifiers-1"></a>
<h3 class="section">15.1 Format stream specifiers<span class="pull-right"><a class="anchor hidden-xs" href="#Format-stream-specifiers-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Format-stream-specifiers-1" aria-hidden="true">TOC</a></span></h3>
<p>Format stream specifiers allow selection of one or more streams that
match specific properties.
</p>
<p>Possible forms of stream specifiers are:
</p><dl compact="compact">
<dt><samp><var>stream_index</var></samp></dt>
<dd><p>Matches the stream with this index.
</p>
</dd>
<dt><samp><var>stream_type</var>[:<var>stream_index</var>]</samp></dt>
<dd><p><var>stream_type</var> is one of following: &rsquo;v&rsquo; for video, &rsquo;a&rsquo; for audio,
&rsquo;s&rsquo; for subtitle, &rsquo;d&rsquo; for data, and &rsquo;t&rsquo; for attachments. If
<var>stream_index</var> is given, then it matches the stream number
<var>stream_index</var> of this type. Otherwise, it matches all streams of
this type.
</p>
</dd>
<dt><samp>p:<var>program_id</var>[:<var>stream_index</var>]</samp></dt>
<dd><p>If <var>stream_index</var> is given, then it matches the stream with number
<var>stream_index</var> in the program with the id
<var>program_id</var>. Otherwise, it matches all streams in the program.
</p>
</dd>
<dt><samp>#<var>stream_id</var></samp></dt>
<dd><p>Matches the stream by a format-specific ID.
</p></dd>
</dl>
<p>The exact semantics of stream specifiers is defined by the
<code>avformat_match_stream_specifier()</code> function declared in the
<samp>libavformat/avformat.h</samp> header.
</p>
<a name="Demuxers"></a>
<h2 class="chapter">16 Demuxers<span class="pull-right"><a class="anchor hidden-xs" href="#Demuxers" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Demuxers" aria-hidden="true">TOC</a></span></h2>
<p>Demuxers are configured elements in FFmpeg that can read the
multimedia streams from a particular type of file.
</p>
<p>When you configure your FFmpeg build, all the supported demuxers
are enabled by default. You can list all available ones using the
configure option <code>--list-demuxers</code>.
</p>
<p>You can disable all the demuxers using the configure option
<code>--disable-demuxers</code>, and selectively enable a single demuxer with
the option <code>--enable-demuxer=<var>DEMUXER</var></code>, or disable it
with the option <code>--disable-demuxer=<var>DEMUXER</var></code>.
</p>
<p>The option <code>-formats</code> of the ff* tools will display the list of
enabled demuxers.
</p>
<p>The description of some of the currently available demuxers follows.
</p>
<a name="aa"></a>
<h3 class="section">16.1 aa<span class="pull-right"><a class="anchor hidden-xs" href="#aa" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aa" aria-hidden="true">TOC</a></span></h3>
<p>Audible Format 2, 3, and 4 demuxer.
</p>
<p>This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.
</p>
<a name="applehttp"></a>
<h3 class="section">16.2 applehttp<span class="pull-right"><a class="anchor hidden-xs" href="#applehttp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-applehttp" aria-hidden="true">TOC</a></span></h3>
<p>Apple HTTP Live Streaming demuxer.
</p>
<p>This demuxer presents all AVStreams from all variant streams.
The id field is set to the bitrate variant index number. By setting
the discard flags on AVStreams (by pressing &rsquo;a&rsquo; or &rsquo;v&rsquo; in ffplay),
the caller can decide which variant streams to actually receive.
The total bitrate of the variant that the stream belongs to is
available in a metadata key named &quot;variant_bitrate&quot;.
</p>
<a name="apng"></a>
<h3 class="section">16.3 apng<span class="pull-right"><a class="anchor hidden-xs" href="#apng" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-apng" aria-hidden="true">TOC</a></span></h3>
<p>Animated Portable Network Graphics demuxer.
</p>
<p>This demuxer is used to demux APNG files.
All headers, but the PNG signature, up to (but not including) the first
fcTL chunk are transmitted as extradata.
Frames are then split as being all the chunks between two fcTL ones, or
between the last fcTL and IEND chunks.
</p>
<dl compact="compact">
<dt><samp>-ignore_loop <var>bool</var></samp></dt>
<dd><p>Ignore the loop variable in the file if set.
</p></dd>
<dt><samp>-max_fps <var>int</var></samp></dt>
<dd><p>Maximum framerate in frames per second (0 for no limit).
</p></dd>
<dt><samp>-default_fps <var>int</var></samp></dt>
<dd><p>Default framerate in frames per second when none is specified in the file
(0 meaning as fast as possible).
</p></dd>
</dl>
<a name="asf"></a>
<h3 class="section">16.4 asf<span class="pull-right"><a class="anchor hidden-xs" href="#asf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asf" aria-hidden="true">TOC</a></span></h3>
<p>Advanced Systems Format demuxer.
</p>
<p>This demuxer is used to demux ASF files and MMS network streams.
</p>
<dl compact="compact">
<dt><samp>-no_resync_search <var>bool</var></samp></dt>
<dd><p>Do not try to resynchronize by looking for a certain optional start code.
</p></dd>
</dl>
<a name="concat"></a><a name="concat-1"></a>
<h3 class="section">16.5 concat<span class="pull-right"><a class="anchor hidden-xs" href="#concat-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concat-1" aria-hidden="true">TOC</a></span></h3>
<p>Virtual concatenation script demuxer.
</p>
<p>This demuxer reads a list of files and other directives from a text file and
demuxes them one after the other, as if all their packets had been muxed
together.
</p>
<p>The timestamps in the files are adjusted so that the first file starts at 0
and each next file starts where the previous one finishes. Note that it is
done globally and may cause gaps if all streams do not have exactly the same
length.
</p>
<p>All files must have the same streams (same codecs, same time base, etc.).
</p>
<p>The duration of each file is used to adjust the timestamps of the next file:
if the duration is incorrect (because it was computed using the bit-rate or
because the file is truncated, for example), it can cause artifacts. The
<code>duration</code> directive can be used to override the duration stored in
each file.
</p>
<a name="Syntax-1"></a>
<h4 class="subsection">16.5.1 Syntax<span class="pull-right"><a class="anchor hidden-xs" href="#Syntax-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Syntax-1" aria-hidden="true">TOC</a></span></h4>
<p>The script is a text file in extended-ASCII, with one directive per line.
Empty lines, leading spaces and lines starting with &rsquo;#&rsquo; are ignored. The
following directive is recognized:
</p>
<dl compact="compact">
<dt><samp><code>file <var>path</var></code></samp></dt>
<dd><p>Path to a file to read; special characters and spaces must be escaped with
backslash or single quotes.
</p>
<p>All subsequent file-related directives apply to that file.
</p>
</dd>
<dt><samp><code>ffconcat version 1.0</code></samp></dt>
<dd><p>Identify the script type and version. It also sets the <samp>safe</samp> option
to 1 if it was -1.
</p>
<p>To make FFmpeg recognize the format automatically, this directive must
appear exactly as is (no extra space or byte-order-mark) on the very first
line of the script.
</p>
</dd>
<dt><samp><code>duration <var>dur</var></code></samp></dt>
<dd><p>Duration of the file. This information can be specified from the file;
specifying it here may be more efficient or help if the information from the
file is not available or accurate.
</p>
<p>If the duration is set for all files, then it is possible to seek in the
whole concatenated video.
</p>
</dd>
<dt><samp><code>inpoint <var>timestamp</var></code></samp></dt>
<dd><p>In point of the file. When the demuxer opens the file it instantly seeks to the
specified timestamp. Seeking is done so that all streams can be presented
successfully at In point.
</p>
<p>This directive works best with intra frame codecs, because for non-intra frame
ones you will usually get extra packets before the actual In point and the
decoded content will most likely contain frames before In point too.
</p>
<p>For each file, packets before the file In point will have timestamps less than
the calculated start timestamp of the file (negative in case of the first
file), and the duration of the files (if not specified by the <code>duration</code>
directive) will be reduced based on their specified In point.
</p>
<p>Because of potential packets before the specified In point, packet timestamps
may overlap between two concatenated files.
</p>
</dd>
<dt><samp><code>outpoint <var>timestamp</var></code></samp></dt>
<dd><p>Out point of the file. When the demuxer reaches the specified decoding
timestamp in any of the streams, it handles it as an end of file condition and
skips the current and all the remaining packets from all streams.
</p>
<p>Out point is exclusive, which means that the demuxer will not output packets
with a decoding timestamp greater or equal to Out point.
</p>
<p>This directive works best with intra frame codecs and formats where all streams
are tightly interleaved. For non-intra frame codecs you will usually get
additional packets with presentation timestamp after Out point therefore the
decoded content will most likely contain frames after Out point too. If your
streams are not tightly interleaved you may not get all the packets from all
streams before Out point and you may only will be able to decode the earliest
stream until Out point.
</p>
<p>The duration of the files (if not specified by the <code>duration</code>
directive) will be reduced based on their specified Out point.
</p>
</dd>
<dt><samp><code>file_packet_metadata <var>key=value</var></code></samp></dt>
<dd><p>Metadata of the packets of the file. The specified metadata will be set for
each file packet. You can specify this directive multiple times to add multiple
metadata entries.
</p>
</dd>
<dt><samp><code>stream</code></samp></dt>
<dd><p>Introduce a stream in the virtual file.
All subsequent stream-related directives apply to the last introduced
stream.
Some streams properties must be set in order to allow identifying the
matching streams in the subfiles.
If no streams are defined in the script, the streams from the first file are
copied.
</p>
</dd>
<dt><samp><code>exact_stream_id <var>id</var></code></samp></dt>
<dd><p>Set the id of the stream.
If this directive is given, the string with the corresponding id in the
subfiles will be used.
This is especially useful for MPEG-PS (VOB) files, where the order of the
streams is not reliable.
</p>
</dd>
</dl>
<a name="Options-6"></a>
<h4 class="subsection">16.5.2 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-6" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-6" aria-hidden="true">TOC</a></span></h4>
<p>This demuxer accepts the following option:
</p>
<dl compact="compact">
<dt><samp>safe</samp></dt>
<dd><p>If set to 1, reject unsafe file paths. A file path is considered safe if it
does not contain a protocol specification and is relative and all components
only contain characters from the portable character set (letters, digits,
period, underscore and hyphen) and have no period at the beginning of a
component.
</p>
<p>If set to 0, any file name is accepted.
</p>
<p>The default is 1.
</p>
<p>-1 is equivalent to 1 if the format was automatically
probed and 0 otherwise.
</p>
</dd>
<dt><samp>auto_convert</samp></dt>
<dd><p>If set to 1, try to perform automatic conversions on packet data to make the
streams concatenable.
The default is 1.
</p>
<p>Currently, the only conversion is adding the h264_mp4toannexb bitstream
filter to H.264 streams in MP4 format. This is necessary in particular if
there are resolution changes.
</p>
</dd>
<dt><samp>segment_time_metadata</samp></dt>
<dd><p>If set to 1, every packet will contain the <var>lavf.concat.start_time</var> and the
<var>lavf.concat.duration</var> packet metadata values which are the start_time and
the duration of the respective file segments in the concatenated output
expressed in microseconds. The duration metadata is only set if it is known
based on the concat file.
The default is 0.
</p>
</dd>
</dl>
<a name="Examples-2"></a>
<h4 class="subsection">16.5.3 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-2" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use absolute filenames and include some comments:
<div class="example">
<pre class="example"># my first filename
file /mnt/share/file-1.wav
# my second filename including whitespace
file '/mnt/share/file 2.wav'
# my third filename including whitespace plus single quote
file '/mnt/share/file 3'\''.wav'
</pre></div>
</li><li> Allow for input format auto-probing, use safe filenames and set the duration of
the first file:
<div class="example">
<pre class="example">ffconcat version 1.0
file file-1.wav
duration 20.0
file subdir/file-2.wav
</pre></div>
</li></ul>
<a name="flv"></a>
<h3 class="section">16.6 flv<span class="pull-right"><a class="anchor hidden-xs" href="#flv" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flv" aria-hidden="true">TOC</a></span></h3>
<p>Adobe Flash Video Format demuxer.
</p>
<p>This demuxer is used to demux FLV files and RTMP network streams.
</p>
<dl compact="compact">
<dt><samp>-flv_metadata <var>bool</var></samp></dt>
<dd><p>Allocate the streams according to the onMetaData array content.
</p></dd>
</dl>
<a name="libgme"></a>
<h3 class="section">16.7 libgme<span class="pull-right"><a class="anchor hidden-xs" href="#libgme" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libgme" aria-hidden="true">TOC</a></span></h3>
<p>The Game Music Emu library is a collection of video game music file emulators.
</p>
<p>See <a href="http://code.google.com/p/game-music-emu/">http://code.google.com/p/game-music-emu/</a> for more information.
</p>
<p>Some files have multiple tracks. The demuxer will pick the first track by
default. The <samp>track_index</samp> option can be used to select a different
track. Track indexes start at 0. The demuxer exports the number of tracks as
<var>tracks</var> meta data entry.
</p>
<p>For very large files, the <samp>max_size</samp> option may have to be adjusted.
</p>
<a name="libopenmpt"></a>
<h3 class="section">16.8 libopenmpt<span class="pull-right"><a class="anchor hidden-xs" href="#libopenmpt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopenmpt" aria-hidden="true">TOC</a></span></h3>
<p>libopenmpt based module demuxer
</p>
<p>See <a href="https://lib.openmpt.org/libopenmpt/">https://lib.openmpt.org/libopenmpt/</a> for more information.
</p>
<p>Some files have multiple subsongs (tracks) this can be set with the <samp>subsong</samp>
option.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>subsong</samp></dt>
<dd><p>Set the subsong index. This can be either &rsquo;all&rsquo;, &rsquo;auto&rsquo;, or the index of the
subsong. Subsong indexes start at 0. The default is &rsquo;auto&rsquo;.
</p>
<p>The default value is to let libopenmpt choose.
</p>
</dd>
<dt><samp>layout</samp></dt>
<dd><p>Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
The default value is STEREO.
</p>
</dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate for libopenmpt to output.
Range is from 1000 to INT_MAX. The value default is 48000.
</p></dd>
</dl>
<a name="gif"></a>
<h3 class="section">16.9 gif<span class="pull-right"><a class="anchor hidden-xs" href="#gif" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gif" aria-hidden="true">TOC</a></span></h3>
<p>Animated GIF demuxer.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>min_delay</samp></dt>
<dd><p>Set the minimum valid delay between frames in hundredths of seconds.
Range is 0 to 6000. Default value is 2.
</p>
</dd>
<dt><samp>max_gif_delay</samp></dt>
<dd><p>Set the maximum valid delay between frames in hundredth of seconds.
Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
the maximum value allowed by the specification.
</p>
</dd>
<dt><samp>default_delay</samp></dt>
<dd><p>Set the default delay between frames in hundredths of seconds.
Range is 0 to 6000. Default value is 10.
</p>
</dd>
<dt><samp>ignore_loop</samp></dt>
<dd><p>GIF files can contain information to loop a certain number of times (or
infinitely). If <samp>ignore_loop</samp> is set to 1, then the loop setting
from the input will be ignored and looping will not occur. If set to 0,
then looping will occur and will cycle the number of times according to
the GIF. Default value is 1.
</p></dd>
</dl>
<p>For example, with the overlay filter, place an infinitely looping GIF
over another video:
</p><div class="example">
<pre class="example">ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
</pre></div>
<p>Note that in the above example the shortest option for overlay filter is
used to end the output video at the length of the shortest input file,
which in this case is <samp>input.mp4</samp> as the GIF in this example loops
infinitely.
</p>
<a name="image2"></a>
<h3 class="section">16.10 image2<span class="pull-right"><a class="anchor hidden-xs" href="#image2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-image2" aria-hidden="true">TOC</a></span></h3>
<p>Image file demuxer.
</p>
<p>This demuxer reads from a list of image files specified by a pattern.
The syntax and meaning of the pattern is specified by the
option <var>pattern_type</var>.
</p>
<p>The pattern may contain a suffix which is used to automatically
determine the format of the images contained in the files.
</p>
<p>The size, the pixel format, and the format of each image must be the
same for all the files in the sequence.
</p>
<p>This demuxer accepts the following options:
</p><dl compact="compact">
<dt><samp>framerate</samp></dt>
<dd><p>Set the frame rate for the video stream. It defaults to 25.
</p></dd>
<dt><samp>loop</samp></dt>
<dd><p>If set to 1, loop over the input. Default value is 0.
</p></dd>
<dt><samp>pattern_type</samp></dt>
<dd><p>Select the pattern type used to interpret the provided filename.
</p>
<p><var>pattern_type</var> accepts one of the following values.
</p><dl compact="compact">
<dt><samp>none</samp></dt>
<dd><p>Disable pattern matching, therefore the video will only contain the specified
image. You should use this option if you do not want to create sequences from
multiple images and your filenames may contain special pattern characters.
</p></dd>
<dt><samp>sequence</samp></dt>
<dd><p>Select a sequence pattern type, used to specify a sequence of files
indexed by sequential numbers.
</p>
<p>A sequence pattern may contain the string &quot;%d&quot; or &quot;%0<var>N</var>d&quot;, which
specifies the position of the characters representing a sequential
number in each filename matched by the pattern. If the form
&quot;%d0<var>N</var>d&quot; is used, the string representing the number in each
filename is 0-padded and <var>N</var> is the total number of 0-padded
digits representing the number. The literal character &rsquo;%&rsquo; can be
specified in the pattern with the string &quot;%%&quot;.
</p>
<p>If the sequence pattern contains &quot;%d&quot; or &quot;%0<var>N</var>d&quot;, the first filename of
the file list specified by the pattern must contain a number
inclusively contained between <var>start_number</var> and
<var>start_number</var>+<var>start_number_range</var>-1, and all the following
numbers must be sequential.
</p>
<p>For example the pattern &quot;img-%03d.bmp&quot; will match a sequence of
filenames of the form <samp>img-001.bmp</samp>, <samp>img-002.bmp</samp>, ...,
<samp>img-010.bmp</samp>, etc.; the pattern &quot;i%%m%%g-%d.jpg&quot; will match a
sequence of filenames of the form <samp>i%m%g-1.jpg</samp>,
<samp>i%m%g-2.jpg</samp>, ..., <samp>i%m%g-10.jpg</samp>, etc.
</p>
<p>Note that the pattern must not necessarily contain &quot;%d&quot; or
&quot;%0<var>N</var>d&quot;, for example to convert a single image file
<samp>img.jpeg</samp> you can employ the command:
</p><div class="example">
<pre class="example">ffmpeg -i img.jpeg img.png
</pre></div>
</dd>
<dt><samp>glob</samp></dt>
<dd><p>Select a glob wildcard pattern type.
</p>
<p>The pattern is interpreted like a <code>glob()</code> pattern. This is only
selectable if libavformat was compiled with globbing support.
</p>
</dd>
<dt><samp>glob_sequence <em>(deprecated, will be removed)</em></samp></dt>
<dd><p>Select a mixed glob wildcard/sequence pattern.
</p>
<p>If your version of libavformat was compiled with globbing support, and
the provided pattern contains at least one glob meta character among
<code>%*?[]{}</code> that is preceded by an unescaped &quot;%&quot;, the pattern is
interpreted like a <code>glob()</code> pattern, otherwise it is interpreted
like a sequence pattern.
</p>
<p>All glob special characters <code>%*?[]{}</code> must be prefixed
with &quot;%&quot;. To escape a literal &quot;%&quot; you shall use &quot;%%&quot;.
</p>
<p>For example the pattern <code>foo-%*.jpeg</code> will match all the
filenames prefixed by &quot;foo-&quot; and terminating with &quot;.jpeg&quot;, and
<code>foo-%?%?%?.jpeg</code> will match all the filenames prefixed with
&quot;foo-&quot;, followed by a sequence of three characters, and terminating
with &quot;.jpeg&quot;.
</p>
<p>This pattern type is deprecated in favor of <var>glob</var> and
<var>sequence</var>.
</p></dd>
</dl>
<p>Default value is <var>glob_sequence</var>.
</p></dd>
<dt><samp>pixel_format</samp></dt>
<dd><p>Set the pixel format of the images to read. If not specified the pixel
format is guessed from the first image file in the sequence.
</p></dd>
<dt><samp>start_number</samp></dt>
<dd><p>Set the index of the file matched by the image file pattern to start
to read from. Default value is 0.
</p></dd>
<dt><samp>start_number_range</samp></dt>
<dd><p>Set the index interval range to check when looking for the first image
file in the sequence, starting from <var>start_number</var>. Default value
is 5.
</p></dd>
<dt><samp>ts_from_file</samp></dt>
<dd><p>If set to 1, will set frame timestamp to modification time of image file. Note
that monotonity of timestamps is not provided: images go in the same order as
without this option. Default value is 0.
If set to 2, will set frame timestamp to the modification time of the image file in
nanosecond precision.
</p></dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the video size of the images to read. If not specified the video
size is guessed from the first image file in the sequence.
</p></dd>
</dl>
<a name="Examples-3"></a>
<h4 class="subsection">16.10.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-3" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use <code>ffmpeg</code> for creating a video from the images in the file
sequence <samp>img-001.jpeg</samp>, <samp>img-002.jpeg</samp>, ..., assuming an
input frame rate of 10 frames per second:
<div class="example">
<pre class="example">ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
</pre></div>
</li><li> As above, but start by reading from a file with index 100 in the sequence:
<div class="example">
<pre class="example">ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
</pre></div>
</li><li> Read images matching the &quot;*.png&quot; glob pattern , that is all the files
terminating with the &quot;.png&quot; suffix:
<div class="example">
<pre class="example">ffmpeg -framerate 10 -pattern_type glob -i &quot;*.png&quot; out.mkv
</pre></div>
</li></ul>
<a name="mov_002fmp4_002f3gp_002fQuickTime"></a>
<h3 class="section">16.11 mov/mp4/3gp/QuickTime<span class="pull-right"><a class="anchor hidden-xs" href="#mov_002fmp4_002f3gp_002fQuickTime" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mov_002fmp4_002f3gp_002fQuickTime" aria-hidden="true">TOC</a></span></h3>
<p>QuickTime / MP4 demuxer.
</p>
<p>This demuxer accepts the following options:
</p><dl compact="compact">
<dt><samp>enable_drefs</samp></dt>
<dd><p>Enable loading of external tracks, disabled by default.
Enabling this can theoretically leak information in some use cases.
</p>
</dd>
<dt><samp>use_absolute_path</samp></dt>
<dd><p>Allows loading of external tracks via absolute paths, disabled by default.
Enabling this poses a security risk. It should only be enabled if the source
is known to be non malicious.
</p>
</dd>
</dl>
<a name="mpegts"></a>
<h3 class="section">16.12 mpegts<span class="pull-right"><a class="anchor hidden-xs" href="#mpegts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mpegts" aria-hidden="true">TOC</a></span></h3>
<p>MPEG-2 transport stream demuxer.
</p>
<p>This demuxer accepts the following options:
</p><dl compact="compact">
<dt><samp>resync_size</samp></dt>
<dd><p>Set size limit for looking up a new synchronization. Default value is
65536.
</p>
</dd>
<dt><samp>fix_teletext_pts</samp></dt>
<dd><p>Override teletext packet PTS and DTS values with the timestamps calculated
from the PCR of the first program which the teletext stream is part of and is
not discarded. Default value is 1, set this option to 0 if you want your
teletext packet PTS and DTS values untouched.
</p>
</dd>
<dt><samp>ts_packetsize</samp></dt>
<dd><p>Output option carrying the raw packet size in bytes.
Show the detected raw packet size, cannot be set by the user.
</p>
</dd>
<dt><samp>scan_all_pmts</samp></dt>
<dd><p>Scan and combine all PMTs. The value is an integer with value from -1
to 1 (-1 means automatic setting, 1 means enabled, 0 means
disabled). Default value is -1.
</p></dd>
</dl>
<a name="mpjpeg"></a>
<h3 class="section">16.13 mpjpeg<span class="pull-right"><a class="anchor hidden-xs" href="#mpjpeg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mpjpeg" aria-hidden="true">TOC</a></span></h3>
<p>MJPEG encapsulated in multi-part MIME demuxer.
</p>
<p>This demuxer allows reading of MJPEG, where each frame is represented as a part of
multipart/x-mixed-replace stream.
</p><dl compact="compact">
<dt><samp>strict_mime_boundary</samp></dt>
<dd><p>Default implementation applies a relaxed standard to multi-part MIME boundary detection,
to prevent regression with numerous existing endpoints not generating a proper MIME
MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
of the boundary value.
</p></dd>
</dl>
<a name="rawvideo-1"></a>
<h3 class="section">16.14 rawvideo<span class="pull-right"><a class="anchor hidden-xs" href="#rawvideo-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rawvideo-1" aria-hidden="true">TOC</a></span></h3>
<p>Raw video demuxer.
</p>
<p>This demuxer allows one to read raw video data. Since there is no header
specifying the assumed video parameters, the user must specify them
in order to be able to decode the data correctly.
</p>
<p>This demuxer accepts the following options:
</p><dl compact="compact">
<dt><samp>framerate</samp></dt>
<dd><p>Set input video frame rate. Default value is 25.
</p>
</dd>
<dt><samp>pixel_format</samp></dt>
<dd><p>Set the input video pixel format. Default value is <code>yuv420p</code>.
</p>
</dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the input video size. This value must be specified explicitly.
</p></dd>
</dl>
<p>For example to read a rawvideo file <samp>input.raw</samp> with
<code>ffplay</code>, assuming a pixel format of <code>rgb24</code>, a video
size of <code>320x240</code>, and a frame rate of 10 images per second, use
the command:
</p><div class="example">
<pre class="example">ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
</pre></div>
<a name="sbg"></a>
<h3 class="section">16.15 sbg<span class="pull-right"><a class="anchor hidden-xs" href="#sbg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sbg" aria-hidden="true">TOC</a></span></h3>
<p>SBaGen script demuxer.
</p>
<p>This demuxer reads the script language used by SBaGen
<a href="http://uazu.net/sbagen/">http://uazu.net/sbagen/</a> to generate binaural beats sessions. A SBG
script looks like that:
</p><div class="example">
<pre class="example">-SE
a: 300-2.5/3 440+4.5/0
b: 300-2.5/0 440+4.5/3
off: -
NOW == a
+0:07:00 == b
+0:14:00 == a
+0:21:00 == b
+0:30:00 off
</pre></div>
<p>A SBG script can mix absolute and relative timestamps. If the script uses
either only absolute timestamps (including the script start time) or only
relative ones, then its layout is fixed, and the conversion is
straightforward. On the other hand, if the script mixes both kind of
timestamps, then the <var>NOW</var> reference for relative timestamps will be
taken from the current time of day at the time the script is read, and the
script layout will be frozen according to that reference. That means that if
the script is directly played, the actual times will match the absolute
timestamps up to the sound controller&rsquo;s clock accuracy, but if the user
somehow pauses the playback or seeks, all times will be shifted accordingly.
</p>
<a name="tedcaptions"></a>
<h3 class="section">16.16 tedcaptions<span class="pull-right"><a class="anchor hidden-xs" href="#tedcaptions" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tedcaptions" aria-hidden="true">TOC</a></span></h3>
<p>JSON captions used for <a href="http://www.ted.com/">TED Talks</a>.
</p>
<p>TED does not provide links to the captions, but they can be guessed from the
page. The file <samp>tools/bookmarklets.html</samp> from the FFmpeg source tree
contains a bookmarklet to expose them.
</p>
<p>This demuxer accepts the following option:
</p><dl compact="compact">
<dt><samp>start_time</samp></dt>
<dd><p>Set the start time of the TED talk, in milliseconds. The default is 15000
(15s). It is used to sync the captions with the downloadable videos, because
they include a 15s intro.
</p></dd>
</dl>
<p>Example: convert the captions to a format most players understand:
</p><div class="example">
<pre class="example">ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
</pre></div>
<a name="Metadata"></a>
<h2 class="chapter">17 Metadata<span class="pull-right"><a class="anchor hidden-xs" href="#Metadata" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Metadata" aria-hidden="true">TOC</a></span></h2>
<p>FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded
INI-like text file and then load it back using the metadata muxer/demuxer.
</p>
<p>The file format is as follows:
</p><ol>
<li> A file consists of a header and a number of metadata tags divided into sections,
each on its own line.
</li><li> The header is a &lsquo;<samp>;FFMETADATA</samp>&rsquo; string, followed by a version number (now 1).
</li><li> Metadata tags are of the form &lsquo;<samp>key=value</samp>&rsquo;
</li><li> Immediately after header follows global metadata
</li><li> After global metadata there may be sections with per-stream/per-chapter
metadata.
</li><li> A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in
brackets (&lsquo;<samp>[</samp>&rsquo;, &lsquo;<samp>]</samp>&rsquo;) and ends with next section or end of file.
</li><li> At the beginning of a chapter section there may be an optional timebase to be
used for start/end values. It must be in form
&lsquo;<samp>TIMEBASE=<var>num</var>/<var>den</var></samp>&rsquo;, where <var>num</var> and <var>den</var> are
integers. If the timebase is missing then start/end times are assumed to
be in milliseconds.
<p>Next a chapter section must contain chapter start and end times in form
&lsquo;<samp>START=<var>num</var></samp>&rsquo;, &lsquo;<samp>END=<var>num</var></samp>&rsquo;, where <var>num</var> is a positive
integer.
</p>
</li><li> Empty lines and lines starting with &lsquo;<samp>;</samp>&rsquo; or &lsquo;<samp>#</samp>&rsquo; are ignored.
</li><li> Metadata keys or values containing special characters (&lsquo;<samp>=</samp>&rsquo;, &lsquo;<samp>;</samp>&rsquo;,
&lsquo;<samp>#</samp>&rsquo;, &lsquo;<samp>\</samp>&rsquo; and a newline) must be escaped with a backslash &lsquo;<samp>\</samp>&rsquo;.
</li><li> Note that whitespace in metadata (e.g. &lsquo;<samp>foo = bar</samp>&rsquo;) is considered to be
a part of the tag (in the example above key is &lsquo;<samp>foo </samp>&rsquo;, value is
&lsquo;<samp> bar</samp>&rsquo;).
</li></ol>
<p>A ffmetadata file might look like this:
</p><div class="example">
<pre class="example">;FFMETADATA1
title=bike\\shed
;this is a comment
artist=FFmpeg troll team
[CHAPTER]
TIMEBASE=1/1000
START=0
#chapter ends at 0:01:00
END=60000
title=chapter \#1
[STREAM]
title=multi\
line
</pre></div>
<p>By using the ffmetadata muxer and demuxer it is possible to extract
metadata from an input file to an ffmetadata file, and then transcode
the file into an output file with the edited ffmetadata file.
</p>
<p>Extracting an ffmetadata file with <samp>ffmpeg</samp> goes as follows:
</p><div class="example">
<pre class="example">ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
</pre></div>
<p>Reinserting edited metadata information from the FFMETADATAFILE file can
be done as:
</p><div class="example">
<pre class="example">ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
</pre></div>
<a name="Protocol-Options"></a>
<h2 class="chapter">18 Protocol Options<span class="pull-right"><a class="anchor hidden-xs" href="#Protocol-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Protocol-Options" aria-hidden="true">TOC</a></span></h2>
<p>The libavformat library provides some generic global options, which
can be set on all the protocols. In addition each protocol may support
so-called private options, which are specific for that component.
</p>
<p>The list of supported options follows:
</p>
<dl compact="compact">
<dt><samp>protocol_whitelist <var>list</var> (<em>input</em>)</samp></dt>
<dd><p>Set a &quot;,&quot;-separated list of allowed protocols. &quot;ALL&quot; matches all protocols. Protocols
prefixed by &quot;-&quot; are disabled.
All protocols are allowed by default but protocols used by an another
protocol (nested protocols) are restricted to a per protocol subset.
</p></dd>
</dl>
<a name="Protocols"></a>
<h2 class="chapter">19 Protocols<span class="pull-right"><a class="anchor hidden-xs" href="#Protocols" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Protocols" aria-hidden="true">TOC</a></span></h2>
<p>Protocols are configured elements in FFmpeg that enable access to
resources that require specific protocols.
</p>
<p>When you configure your FFmpeg build, all the supported protocols are
enabled by default. You can list all available ones using the
configure option &quot;&ndash;list-protocols&quot;.
</p>
<p>You can disable all the protocols using the configure option
&quot;&ndash;disable-protocols&quot;, and selectively enable a protocol using the
option &quot;&ndash;enable-protocol=<var>PROTOCOL</var>&quot;, or you can disable a
particular protocol using the option
&quot;&ndash;disable-protocol=<var>PROTOCOL</var>&quot;.
</p>
<p>The option &quot;-protocols&quot; of the ff* tools will display the list of
supported protocols.
</p>
<p>All protocols accept the following options:
</p>
<dl compact="compact">
<dt><samp>rw_timeout</samp></dt>
<dd><p>Maximum time to wait for (network) read/write operations to complete,
in microseconds.
</p></dd>
</dl>
<p>A description of the currently available protocols follows.
</p>
<a name="async"></a>
<h3 class="section">19.1 async<span class="pull-right"><a class="anchor hidden-xs" href="#async" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-async" aria-hidden="true">TOC</a></span></h3>
<p>Asynchronous data filling wrapper for input stream.
</p>
<p>Fill data in a background thread, to decouple I/O operation from demux thread.
</p>
<div class="example">
<pre class="example">async:<var>URL</var>
async:http://host/resource
async:cache:http://host/resource
</pre></div>
<a name="bluray"></a>
<h3 class="section">19.2 bluray<span class="pull-right"><a class="anchor hidden-xs" href="#bluray" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bluray" aria-hidden="true">TOC</a></span></h3>
<p>Read BluRay playlist.
</p>
<p>The accepted options are:
</p><dl compact="compact">
<dt><samp>angle</samp></dt>
<dd><p>BluRay angle
</p>
</dd>
<dt><samp>chapter</samp></dt>
<dd><p>Start chapter (1...N)
</p>
</dd>
<dt><samp>playlist</samp></dt>
<dd><p>Playlist to read (BDMV/PLAYLIST/?????.mpls)
</p>
</dd>
</dl>
<p>Examples:
</p>
<p>Read longest playlist from BluRay mounted to /mnt/bluray:
</p><div class="example">
<pre class="example">bluray:/mnt/bluray
</pre></div>
<p>Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
</p><div class="example">
<pre class="example">-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
</pre></div>
<a name="cache"></a>
<h3 class="section">19.3 cache<span class="pull-right"><a class="anchor hidden-xs" href="#cache" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cache" aria-hidden="true">TOC</a></span></h3>
<p>Caching wrapper for input stream.
</p>
<p>Cache the input stream to temporary file. It brings seeking capability to live streams.
</p>
<div class="example">
<pre class="example">cache:<var>URL</var>
</pre></div>
<a name="concat-2"></a>
<h3 class="section">19.4 concat<span class="pull-right"><a class="anchor hidden-xs" href="#concat-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concat-2" aria-hidden="true">TOC</a></span></h3>
<p>Physical concatenation protocol.
</p>
<p>Read and seek from many resources in sequence as if they were
a unique resource.
</p>
<p>A URL accepted by this protocol has the syntax:
</p><div class="example">
<pre class="example">concat:<var>URL1</var>|<var>URL2</var>|...|<var>URLN</var>
</pre></div>
<p>where <var>URL1</var>, <var>URL2</var>, ..., <var>URLN</var> are the urls of the
resource to be concatenated, each one possibly specifying a distinct
protocol.
</p>
<p>For example to read a sequence of files <samp>split1.mpeg</samp>,
<samp>split2.mpeg</samp>, <samp>split3.mpeg</samp> with <code>ffplay</code> use the
command:
</p><div class="example">
<pre class="example">ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
</pre></div>
<p>Note that you may need to escape the character &quot;|&quot; which is special for
many shells.
</p>
<a name="crypto"></a>
<h3 class="section">19.5 crypto<span class="pull-right"><a class="anchor hidden-xs" href="#crypto" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-crypto" aria-hidden="true">TOC</a></span></h3>
<p>AES-encrypted stream reading protocol.
</p>
<p>The accepted options are:
</p><dl compact="compact">
<dt><samp>key</samp></dt>
<dd><p>Set the AES decryption key binary block from given hexadecimal representation.
</p>
</dd>
<dt><samp>iv</samp></dt>
<dd><p>Set the AES decryption initialization vector binary block from given hexadecimal representation.
</p></dd>
</dl>
<p>Accepted URL formats:
</p><div class="example">
<pre class="example">crypto:<var>URL</var>
crypto+<var>URL</var>
</pre></div>
<a name="data"></a>
<h3 class="section">19.6 data<span class="pull-right"><a class="anchor hidden-xs" href="#data" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-data" aria-hidden="true">TOC</a></span></h3>
<p>Data in-line in the URI. See <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">http://en.wikipedia.org/wiki/Data_URI_scheme</a>.
</p>
<p>For example, to convert a GIF file given inline with <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -i &quot;data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=&quot; smiley.png
</pre></div>
<a name="file"></a>
<h3 class="section">19.7 file<span class="pull-right"><a class="anchor hidden-xs" href="#file" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-file" aria-hidden="true">TOC</a></span></h3>
<p>File access protocol.
</p>
<p>Read from or write to a file.
</p>
<p>A file URL can have the form:
</p><div class="example">
<pre class="example">file:<var>filename</var>
</pre></div>
<p>where <var>filename</var> is the path of the file to read.
</p>
<p>An URL that does not have a protocol prefix will be assumed to be a
file URL. Depending on the build, an URL that looks like a Windows
path with the drive letter at the beginning will also be assumed to be
a file URL (usually not the case in builds for unix-like systems).
</p>
<p>For example to read from a file <samp>input.mpeg</samp> with <code>ffmpeg</code>
use the command:
</p><div class="example">
<pre class="example">ffmpeg -i file:input.mpeg output.mpeg
</pre></div>
<p>This protocol accepts the following options:
</p>
<dl compact="compact">
<dt><samp>truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp>blocksize</samp></dt>
<dd><p>Set I/O operation maximum block size, in bytes. Default value is
<code>INT_MAX</code>, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable for files on slow medium.
</p></dd>
</dl>
<a name="ftp"></a>
<h3 class="section">19.8 ftp<span class="pull-right"><a class="anchor hidden-xs" href="#ftp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ftp" aria-hidden="true">TOC</a></span></h3>
<p>FTP (File Transfer Protocol).
</p>
<p>Read from or write to remote resources using FTP protocol.
</p>
<p>Following syntax is required.
</p><div class="example">
<pre class="example">ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl compact="compact">
<dt><samp>timeout</samp></dt>
<dd><p>Set timeout in microseconds of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout is
not specified.
</p>
</dd>
<dt><samp>ftp-anonymous-password</samp></dt>
<dd><p>Password used when login as anonymous user. Typically an e-mail address
should be used.
</p>
</dd>
<dt><samp>ftp-write-seekable</samp></dt>
<dd><p>Control seekability of connection during encoding. If set to 1 the
resource is supposed to be seekable, if set to 0 it is assumed not
to be seekable. Default value is 0.
</p></dd>
</dl>
<p>NOTE: Protocol can be used as output, but it is recommended to not do
it, unless special care is taken (tests, customized server configuration
etc.). Different FTP servers behave in different way during seek
operation. ff* tools may produce incomplete content due to server limitations.
</p>
<p>This protocol accepts the following options:
</p>
<dl compact="compact">
<dt><samp>follow</samp></dt>
<dd><p>If set to 1, the protocol will retry reading at the end of the file, allowing
reading files that still are being written. In order for this to terminate,
you either need to use the rw_timeout option, or use the interrupt callback
(for API users).
</p>
</dd>
</dl>
<a name="gopher"></a>
<h3 class="section">19.9 gopher<span class="pull-right"><a class="anchor hidden-xs" href="#gopher" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gopher" aria-hidden="true">TOC</a></span></h3>
<p>Gopher protocol.
</p>
<a name="hls"></a>
<h3 class="section">19.10 hls<span class="pull-right"><a class="anchor hidden-xs" href="#hls" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hls" aria-hidden="true">TOC</a></span></h3>
<p>Read Apple HTTP Live Streaming compliant segmented stream as
a uniform one. The M3U8 playlists describing the segments can be
remote HTTP resources or local files, accessed using the standard
file protocol.
The nested protocol is declared by specifying
&quot;+<var>proto</var>&quot; after the hls URI scheme name, where <var>proto</var>
is either &quot;file&quot; or &quot;http&quot;.
</p>
<div class="example">
<pre class="example">hls+http://host/path/to/remote/resource.m3u8
hls+file://path/to/local/resource.m3u8
</pre></div>
<p>Using this protocol is discouraged - the hls demuxer should work
just as well (if not, please report the issues) and is more complete.
To use the hls demuxer instead, simply use the direct URLs to the
m3u8 files.
</p>
<a name="http"></a>
<h3 class="section">19.11 http<span class="pull-right"><a class="anchor hidden-xs" href="#http" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-http" aria-hidden="true">TOC</a></span></h3>
<p>HTTP (Hyper Text Transfer Protocol).
</p>
<p>This protocol accepts the following options:
</p>
<dl compact="compact">
<dt><samp>seekable</samp></dt>
<dd><p>Control seekability of connection. If set to 1 the resource is
supposed to be seekable, if set to 0 it is assumed not to be seekable,
if set to -1 it will try to autodetect if it is seekable. Default
value is -1.
</p>
</dd>
<dt><samp>chunked_post</samp></dt>
<dd><p>If set to 1 use chunked Transfer-Encoding for posts, default is 1.
</p>
</dd>
<dt><samp>content_type</samp></dt>
<dd><p>Set a specific content type for the POST messages or for listen mode.
</p>
</dd>
<dt><samp>http_proxy</samp></dt>
<dd><p>set HTTP proxy to tunnel through e.g. http://example.com:1234
</p>
</dd>
<dt><samp>headers</samp></dt>
<dd><p>Set custom HTTP headers, can override built in default headers. The
value must be a string encoding the headers.
</p>
</dd>
<dt><samp>multiple_requests</samp></dt>
<dd><p>Use persistent connections if set to 1, default is 0.
</p>
</dd>
<dt><samp>post_data</samp></dt>
<dd><p>Set custom HTTP post data.
</p>
</dd>
<dt><samp>user_agent</samp></dt>
<dd><p>Override the User-Agent header. If not specified the protocol will use a
string describing the libavformat build. (&quot;Lavf/&lt;version&gt;&quot;)
</p>
</dd>
<dt><samp>user-agent</samp></dt>
<dd><p>This is a deprecated option, you can use user_agent instead it.
</p>
</dd>
<dt><samp>timeout</samp></dt>
<dd><p>Set timeout in microseconds of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout is
not specified.
</p>
</dd>
<dt><samp>reconnect_at_eof</samp></dt>
<dd><p>If set then eof is treated like an error and causes reconnection, this is useful
for live / endless streams.
</p>
</dd>
<dt><samp>reconnect_streamed</samp></dt>
<dd><p>If set then even streamed/non seekable streams will be reconnected on errors.
</p>
</dd>
<dt><samp>reconnect_delay_max</samp></dt>
<dd><p>Sets the maximum delay in seconds after which to give up reconnecting
</p>
</dd>
<dt><samp>mime_type</samp></dt>
<dd><p>Export the MIME type.
</p>
</dd>
<dt><samp>icy</samp></dt>
<dd><p>If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
supports this, the metadata has to be retrieved by the application by reading
the <samp>icy_metadata_headers</samp> and <samp>icy_metadata_packet</samp> options.
The default is 1.
</p>
</dd>
<dt><samp>icy_metadata_headers</samp></dt>
<dd><p>If the server supports ICY metadata, this contains the ICY-specific HTTP reply
headers, separated by newline characters.
</p>
</dd>
<dt><samp>icy_metadata_packet</samp></dt>
<dd><p>If the server supports ICY metadata, and <samp>icy</samp> was set to 1, this
contains the last non-empty metadata packet sent by the server. It should be
polled in regular intervals by applications interested in mid-stream metadata
updates.
</p>
</dd>
<dt><samp>cookies</samp></dt>
<dd><p>Set the cookies to be sent in future requests. The format of each cookie is the
same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
delimited by a newline character.
</p>
</dd>
<dt><samp>offset</samp></dt>
<dd><p>Set initial byte offset.
</p>
</dd>
<dt><samp>end_offset</samp></dt>
<dd><p>Try to limit the request to bytes preceding this offset.
</p>
</dd>
<dt><samp>method</samp></dt>
<dd><p>When used as a client option it sets the HTTP method for the request.
</p>
<p>When used as a server option it sets the HTTP method that is going to be
expected from the client(s).
If the expected and the received HTTP method do not match the client will
be given a Bad Request response.
When unset the HTTP method is not checked for now. This will be replaced by
autodetection in the future.
</p>
</dd>
<dt><samp>listen</samp></dt>
<dd><p>If set to 1 enables experimental HTTP server. This can be used to send data when
used as an output option, or read data from a client with HTTP POST when used as
an input option.
If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
in ffmpeg.c or ffserver.c and thus must not be used as a command line option.
</p><div class="example">
<pre class="example"># Server side (sending):
ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://<var>server</var>:<var>port</var>
# Client side (receiving):
ffmpeg -i http://<var>server</var>:<var>port</var> -c copy somefile.ogg
# Client can also be done with wget:
wget http://<var>server</var>:<var>port</var> -O somefile.ogg
# Server side (receiving):
ffmpeg -listen 1 -i http://<var>server</var>:<var>port</var> -c copy somefile.ogg
# Client side (sending):
ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://<var>server</var>:<var>port</var>
# Client can also be done with wget:
wget --post-file=somefile.ogg http://<var>server</var>:<var>port</var>
</pre></div>
</dd>
</dl>
<a name="HTTP-Cookies"></a>
<h4 class="subsection">19.11.1 HTTP Cookies<span class="pull-right"><a class="anchor hidden-xs" href="#HTTP-Cookies" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-HTTP-Cookies" aria-hidden="true">TOC</a></span></h4>
<p>Some HTTP requests will be denied unless cookie values are passed in with the
request. The <samp>cookies</samp> option allows these cookies to be specified. At
the very least, each cookie must specify a value along with a path and domain.
HTTP requests that match both the domain and path will automatically include the
cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
by a newline.
</p>
<p>The required syntax to play a stream specifying a cookie is:
</p><div class="example">
<pre class="example">ffplay -cookies &quot;nlqptid=nltid=tsn; path=/; domain=somedomain.com;&quot; http://somedomain.com/somestream.m3u8
</pre></div>
<a name="Icecast"></a>
<h3 class="section">19.12 Icecast<span class="pull-right"><a class="anchor hidden-xs" href="#Icecast" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Icecast" aria-hidden="true">TOC</a></span></h3>
<p>Icecast protocol (stream to Icecast servers)
</p>
<p>This protocol accepts the following options:
</p>
<dl compact="compact">
<dt><samp>ice_genre</samp></dt>
<dd><p>Set the stream genre.
</p>
</dd>
<dt><samp>ice_name</samp></dt>
<dd><p>Set the stream name.
</p>
</dd>
<dt><samp>ice_description</samp></dt>
<dd><p>Set the stream description.
</p>
</dd>
<dt><samp>ice_url</samp></dt>
<dd><p>Set the stream website URL.
</p>
</dd>
<dt><samp>ice_public</samp></dt>
<dd><p>Set if the stream should be public.
The default is 0 (not public).
</p>
</dd>
<dt><samp>user_agent</samp></dt>
<dd><p>Override the User-Agent header. If not specified a string of the form
&quot;Lavf/&lt;version&gt;&quot; will be used.
</p>
</dd>
<dt><samp>password</samp></dt>
<dd><p>Set the Icecast mountpoint password.
</p>
</dd>
<dt><samp>content_type</samp></dt>
<dd><p>Set the stream content type. This must be set if it is different from
audio/mpeg.
</p>
</dd>
<dt><samp>legacy_icecast</samp></dt>
<dd><p>This enables support for Icecast versions &lt; 2.4.0, that do not support the
HTTP PUT method but the SOURCE method.
</p>
</dd>
</dl>
<div class="example">
<pre class="example">icecast://[<var>username</var>[:<var>password</var>]@]<var>server</var>:<var>port</var>/<var>mountpoint</var>
</pre></div>
<a name="mmst"></a>
<h3 class="section">19.13 mmst<span class="pull-right"><a class="anchor hidden-xs" href="#mmst" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mmst" aria-hidden="true">TOC</a></span></h3>
<p>MMS (Microsoft Media Server) protocol over TCP.
</p>
<a name="mmsh"></a>
<h3 class="section">19.14 mmsh<span class="pull-right"><a class="anchor hidden-xs" href="#mmsh" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mmsh" aria-hidden="true">TOC</a></span></h3>
<p>MMS (Microsoft Media Server) protocol over HTTP.
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example">mmsh://<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>playpath</var>]
</pre></div>
<a name="md5"></a>
<h3 class="section">19.15 md5<span class="pull-right"><a class="anchor hidden-xs" href="#md5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-md5" aria-hidden="true">TOC</a></span></h3>
<p>MD5 output protocol.
</p>
<p>Computes the MD5 hash of the data to be written, and on close writes
this to the designated output or stdout if none is specified. It can
be used to test muxers without writing an actual file.
</p>
<p>Some examples follow.
</p><div class="example">
<pre class="example"># Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
ffmpeg -i input.flv -f avi -y md5:output.avi.md5
# Write the MD5 hash of the encoded AVI file to stdout.
ffmpeg -i input.flv -f avi -y md5:
</pre></div>
<p>Note that some formats (typically MOV) require the output protocol to
be seekable, so they will fail with the MD5 output protocol.
</p>
<a name="pipe"></a>
<h3 class="section">19.16 pipe<span class="pull-right"><a class="anchor hidden-xs" href="#pipe" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pipe" aria-hidden="true">TOC</a></span></h3>
<p>UNIX pipe access protocol.
</p>
<p>Read and write from UNIX pipes.
</p>
<p>The accepted syntax is:
</p><div class="example">
<pre class="example">pipe:[<var>number</var>]
</pre></div>
<p><var>number</var> is the number corresponding to the file descriptor of the
pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If <var>number</var>
is not specified, by default the stdout file descriptor will be used
for writing, stdin for reading.
</p>
<p>For example to read from stdin with <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">cat test.wav | ffmpeg -i pipe:0
# ...this is the same as...
cat test.wav | ffmpeg -i pipe:
</pre></div>
<p>For writing to stdout with <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -i test.wav -f avi pipe:1 | cat &gt; test.avi
# ...this is the same as...
ffmpeg -i test.wav -f avi pipe: | cat &gt; test.avi
</pre></div>
<p>This protocol accepts the following options:
</p>
<dl compact="compact">
<dt><samp>blocksize</samp></dt>
<dd><p>Set I/O operation maximum block size, in bytes. Default value is
<code>INT_MAX</code>, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable if data transmission is slow.
</p></dd>
</dl>
<p>Note that some formats (typically MOV), require the output protocol to
be seekable, so they will fail with the pipe output protocol.
</p>
<a name="rtmp"></a>
<h3 class="section">19.17 rtmp<span class="pull-right"><a class="anchor hidden-xs" href="#rtmp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmp" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Messaging Protocol.
</p>
<p>The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
content across a TCP/IP network.
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example">rtmp://[<var>username</var>:<var>password</var>@]<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>instance</var>][/<var>playpath</var>]
</pre></div>
<p>The accepted parameters are:
</p><dl compact="compact">
<dt><samp>username</samp></dt>
<dd><p>An optional username (mostly for publishing).
</p>
</dd>
<dt><samp>password</samp></dt>
<dd><p>An optional password (mostly for publishing).
</p>
</dd>
<dt><samp>server</samp></dt>
<dd><p>The address of the RTMP server.
</p>
</dd>
<dt><samp>port</samp></dt>
<dd><p>The number of the TCP port to use (by default is 1935).
</p>
</dd>
<dt><samp>app</samp></dt>
<dd><p>It is the name of the application to access. It usually corresponds to
the path where the application is installed on the RTMP server
(e.g. <samp>/ondemand/</samp>, <samp>/flash/live/</samp>, etc.). You can override
the value parsed from the URI through the <code>rtmp_app</code> option, too.
</p>
</dd>
<dt><samp>playpath</samp></dt>
<dd><p>It is the path or name of the resource to play with reference to the
application specified in <var>app</var>, may be prefixed by &quot;mp4:&quot;. You
can override the value parsed from the URI through the <code>rtmp_playpath</code>
option, too.
</p>
</dd>
<dt><samp>listen</samp></dt>
<dd><p>Act as a server, listening for an incoming connection.
</p>
</dd>
<dt><samp>timeout</samp></dt>
<dd><p>Maximum time to wait for the incoming connection. Implies listen.
</p></dd>
</dl>
<p>Additionally, the following parameters can be set via command line options
(or in code via <code>AVOption</code>s):
</p><dl compact="compact">
<dt><samp>rtmp_app</samp></dt>
<dd><p>Name of application to connect on the RTMP server. This option
overrides the parameter specified in the URI.
</p>
</dd>
<dt><samp>rtmp_buffer</samp></dt>
<dd><p>Set the client buffer time in milliseconds. The default is 3000.
</p>
</dd>
<dt><samp>rtmp_conn</samp></dt>
<dd><p>Extra arbitrary AMF connection parameters, parsed from a string,
e.g. like <code>B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0</code>.
Each value is prefixed by a single character denoting the type,
B for Boolean, N for number, S for string, O for object, or Z for null,
followed by a colon. For Booleans the data must be either 0 or 1 for
FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or
1 to end or begin an object, respectively. Data items in subobjects may
be named, by prefixing the type with &rsquo;N&rsquo; and specifying the name before
the value (i.e. <code>NB:myFlag:1</code>). This option may be used multiple
times to construct arbitrary AMF sequences.
</p>
</dd>
<dt><samp>rtmp_flashver</samp></dt>
<dd><p>Version of the Flash plugin used to run the SWF player. The default
is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
&lt;libavformat version&gt;).)
</p>
</dd>
<dt><samp>rtmp_flush_interval</samp></dt>
<dd><p>Number of packets flushed in the same request (RTMPT only). The default
is 10.
</p>
</dd>
<dt><samp>rtmp_live</samp></dt>
<dd><p>Specify that the media is a live stream. No resuming or seeking in
live streams is possible. The default value is <code>any</code>, which means the
subscriber first tries to play the live stream specified in the
playpath. If a live stream of that name is not found, it plays the
recorded stream. The other possible values are <code>live</code> and
<code>recorded</code>.
</p>
</dd>
<dt><samp>rtmp_pageurl</samp></dt>
<dd><p>URL of the web page in which the media was embedded. By default no
value will be sent.
</p>
</dd>
<dt><samp>rtmp_playpath</samp></dt>
<dd><p>Stream identifier to play or to publish. This option overrides the
parameter specified in the URI.
</p>
</dd>
<dt><samp>rtmp_subscribe</samp></dt>
<dd><p>Name of live stream to subscribe to. By default no value will be sent.
It is only sent if the option is specified or if rtmp_live
is set to live.
</p>
</dd>
<dt><samp>rtmp_swfhash</samp></dt>
<dd><p>SHA256 hash of the decompressed SWF file (32 bytes).
</p>
</dd>
<dt><samp>rtmp_swfsize</samp></dt>
<dd><p>Size of the decompressed SWF file, required for SWFVerification.
</p>
</dd>
<dt><samp>rtmp_swfurl</samp></dt>
<dd><p>URL of the SWF player for the media. By default no value will be sent.
</p>
</dd>
<dt><samp>rtmp_swfverify</samp></dt>
<dd><p>URL to player swf file, compute hash/size automatically.
</p>
</dd>
<dt><samp>rtmp_tcurl</samp></dt>
<dd><p>URL of the target stream. Defaults to proto://host[:port]/app.
</p>
</dd>
</dl>
<p>For example to read with <code>ffplay</code> a multimedia resource named
&quot;sample&quot; from the application &quot;vod&quot; from an RTMP server &quot;myserver&quot;:
</p><div class="example">
<pre class="example">ffplay rtmp://myserver/vod/sample
</pre></div>
<p>To publish to a password protected server, passing the playpath and
app names separately:
</p><div class="example">
<pre class="example">ffmpeg -re -i &lt;input&gt; -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
</pre></div>
<a name="rtmpe"></a>
<h3 class="section">19.18 rtmpe<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpe" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpe" aria-hidden="true">TOC</a></span></h3>
<p>Encrypted Real-Time Messaging Protocol.
</p>
<p>The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
streaming multimedia content within standard cryptographic primitives,
consisting of Diffie-Hellman key exchange and HMACSHA256, generating
a pair of RC4 keys.
</p>
<a name="rtmps"></a>
<h3 class="section">19.19 rtmps<span class="pull-right"><a class="anchor hidden-xs" href="#rtmps" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmps" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Messaging Protocol over a secure SSL connection.
</p>
<p>The Real-Time Messaging Protocol (RTMPS) is used for streaming
multimedia content across an encrypted connection.
</p>
<a name="rtmpt"></a>
<h3 class="section">19.20 rtmpt<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpt" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Messaging Protocol tunneled through HTTP.
</p>
<p>The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
for streaming multimedia content within HTTP requests to traverse
firewalls.
</p>
<a name="rtmpte"></a>
<h3 class="section">19.21 rtmpte<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpte" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpte" aria-hidden="true">TOC</a></span></h3>
<p>Encrypted Real-Time Messaging Protocol tunneled through HTTP.
</p>
<p>The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
is used for streaming multimedia content within HTTP requests to traverse
firewalls.
</p>
<a name="rtmpts"></a>
<h3 class="section">19.22 rtmpts<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpts" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Messaging Protocol tunneled through HTTPS.
</p>
<p>The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
for streaming multimedia content within HTTPS requests to traverse
firewalls.
</p>
<a name="libsmbclient"></a>
<h3 class="section">19.23 libsmbclient<span class="pull-right"><a class="anchor hidden-xs" href="#libsmbclient" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libsmbclient" aria-hidden="true">TOC</a></span></h3>
<p>libsmbclient permits one to manipulate CIFS/SMB network resources.
</p>
<p>Following syntax is required.
</p>
<div class="example">
<pre class="example">smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl compact="compact">
<dt><samp>timeout</samp></dt>
<dd><p>Set timeout in milliseconds of socket I/O operations used by the underlying
low level operation. By default it is set to -1, which means that the timeout
is not specified.
</p>
</dd>
<dt><samp>truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp>workgroup</samp></dt>
<dd><p>Set the workgroup used for making connections. By default workgroup is not specified.
</p>
</dd>
</dl>
<p>For more information see: <a href="http://www.samba.org/">http://www.samba.org/</a>.
</p>
<a name="libssh"></a>
<h3 class="section">19.24 libssh<span class="pull-right"><a class="anchor hidden-xs" href="#libssh" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libssh" aria-hidden="true">TOC</a></span></h3>
<p>Secure File Transfer Protocol via libssh
</p>
<p>Read from or write to remote resources using SFTP protocol.
</p>
<p>Following syntax is required.
</p>
<div class="example">
<pre class="example">sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl compact="compact">
<dt><samp>timeout</samp></dt>
<dd><p>Set timeout of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout
is not specified.
</p>
</dd>
<dt><samp>truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp>private_key</samp></dt>
<dd><p>Specify the path of the file containing private key to use during authorization.
By default libssh searches for keys in the <samp>~/.ssh/</samp> directory.
</p>
</dd>
</dl>
<p>Example: Play a file stored on remote server.
</p>
<div class="example">
<pre class="example">ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
</pre></div>
<a name="librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte"></a>
<h3 class="section">19.25 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte<span class="pull-right"><a class="anchor hidden-xs" href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Messaging Protocol and its variants supported through
librtmp.
</p>
<p>Requires the presence of the librtmp headers and library during
configuration. You need to explicitly configure the build with
&quot;&ndash;enable-librtmp&quot;. If enabled this will replace the native RTMP
protocol.
</p>
<p>This protocol provides most client functions and a few server
functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
variants of these encrypted types (RTMPTE, RTMPTS).
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example"><var>rtmp_proto</var>://<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>playpath</var>] <var>options</var>
</pre></div>
<p>where <var>rtmp_proto</var> is one of the strings &quot;rtmp&quot;, &quot;rtmpt&quot;, &quot;rtmpe&quot;,
&quot;rtmps&quot;, &quot;rtmpte&quot;, &quot;rtmpts&quot; corresponding to each RTMP variant, and
<var>server</var>, <var>port</var>, <var>app</var> and <var>playpath</var> have the same
meaning as specified for the RTMP native protocol.
<var>options</var> contains a list of space-separated options of the form
<var>key</var>=<var>val</var>.
</p>
<p>See the librtmp manual page (man 3 librtmp) for more information.
</p>
<p>For example, to stream a file in real-time to an RTMP server using
<code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
</pre></div>
<p>To play the same stream using <code>ffplay</code>:
</p><div class="example">
<pre class="example">ffplay &quot;rtmp://myserver/live/mystream live=1&quot;
</pre></div>
<a name="rtp"></a>
<h3 class="section">19.26 rtp<span class="pull-right"><a class="anchor hidden-xs" href="#rtp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtp" aria-hidden="true">TOC</a></span></h3>
<p>Real-time Transport Protocol.
</p>
<p>The required syntax for an RTP URL is:
rtp://<var>hostname</var>[:<var>port</var>][?<var>option</var>=<var>val</var>...]
</p>
<p><var>port</var> specifies the RTP port to use.
</p>
<p>The following URL options are supported:
</p>
<dl compact="compact">
<dt><samp>ttl=<var>n</var></samp></dt>
<dd><p>Set the TTL (Time-To-Live) value (for multicast only).
</p>
</dd>
<dt><samp>rtcpport=<var>n</var></samp></dt>
<dd><p>Set the remote RTCP port to <var>n</var>.
</p>
</dd>
<dt><samp>localrtpport=<var>n</var></samp></dt>
<dd><p>Set the local RTP port to <var>n</var>.
</p>
</dd>
<dt><samp>localrtcpport=<var>n</var>'</samp></dt>
<dd><p>Set the local RTCP port to <var>n</var>.
</p>
</dd>
<dt><samp>pkt_size=<var>n</var></samp></dt>
<dd><p>Set max packet size (in bytes) to <var>n</var>.
</p>
</dd>
<dt><samp>connect=0|1</samp></dt>
<dd><p>Do a <code>connect()</code> on the UDP socket (if set to 1) or not (if set
to 0).
</p>
</dd>
<dt><samp>sources=<var>ip</var>[,<var>ip</var>]</samp></dt>
<dd><p>List allowed source IP addresses.
</p>
</dd>
<dt><samp>block=<var>ip</var>[,<var>ip</var>]</samp></dt>
<dd><p>List disallowed (blocked) source IP addresses.
</p>
</dd>
<dt><samp>write_to_source=0|1</samp></dt>
<dd><p>Send packets to the source address of the latest received packet (if
set to 1) or to a default remote address (if set to 0).
</p>
</dd>
<dt><samp>localport=<var>n</var></samp></dt>
<dd><p>Set the local RTP port to <var>n</var>.
</p>
<p>This is a deprecated option. Instead, <samp>localrtpport</samp> should be
used.
</p>
</dd>
</dl>
<p>Important notes:
</p>
<ol>
<li> If <samp>rtcpport</samp> is not set the RTCP port will be set to the RTP
port value plus 1.
</li><li> If <samp>localrtpport</samp> (the local RTP port) is not set any available
port will be used for the local RTP and RTCP ports.
</li><li> If <samp>localrtcpport</samp> (the local RTCP port) is not set it will be
set to the local RTP port value plus 1.
</li></ol>
<a name="rtsp"></a>
<h3 class="section">19.27 rtsp<span class="pull-right"><a class="anchor hidden-xs" href="#rtsp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtsp" aria-hidden="true">TOC</a></span></h3>
<p>Real-Time Streaming Protocol.
</p>
<p>RTSP is not technically a protocol handler in libavformat, it is a demuxer
and muxer. The demuxer supports both normal RTSP (with data transferred
over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
data transferred over RDT).
</p>
<p>The muxer can be used to send a stream using RTSP ANNOUNCE to a server
supporting it (currently Darwin Streaming Server and Mischa Spiegelmock&rsquo;s
<a href="https://github.com/revmischa/rtsp-server">RTSP server</a>).
</p>
<p>The required syntax for a RTSP url is:
</p><div class="example">
<pre class="example">rtsp://<var>hostname</var>[:<var>port</var>]/<var>path</var>
</pre></div>
<p>Options can be set on the <code>ffmpeg</code>/<code>ffplay</code> command
line, or set in code via <code>AVOption</code>s or in
<code>avformat_open_input</code>.
</p>
<p>The following options are supported.
</p>
<dl compact="compact">
<dt><samp>initial_pause</samp></dt>
<dd><p>Do not start playing the stream immediately if set to 1. Default value
is 0.
</p>
</dd>
<dt><samp>rtsp_transport</samp></dt>
<dd><p>Set RTSP transport protocols.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>udp</samp>&rsquo;</dt>
<dd><p>Use UDP as lower transport protocol.
</p>
</dd>
<dt>&lsquo;<samp>tcp</samp>&rsquo;</dt>
<dd><p>Use TCP (interleaving within the RTSP control channel) as lower
transport protocol.
</p>
</dd>
<dt>&lsquo;<samp>udp_multicast</samp>&rsquo;</dt>
<dd><p>Use UDP multicast as lower transport protocol.
</p>
</dd>
<dt>&lsquo;<samp>http</samp>&rsquo;</dt>
<dd><p>Use HTTP tunneling as lower transport protocol, which is useful for
passing proxies.
</p></dd>
</dl>
<p>Multiple lower transport protocols may be specified, in that case they are
tried one at a time (if the setup of one fails, the next one is tried).
For the muxer, only the &lsquo;<samp>tcp</samp>&rsquo; and &lsquo;<samp>udp</samp>&rsquo; options are supported.
</p>
</dd>
<dt><samp>rtsp_flags</samp></dt>
<dd><p>Set RTSP flags.
</p>
<p>The following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>filter_src</samp>&rsquo;</dt>
<dd><p>Accept packets only from negotiated peer address and port.
</p></dd>
<dt>&lsquo;<samp>listen</samp>&rsquo;</dt>
<dd><p>Act as a server, listening for an incoming connection.
</p></dd>
<dt>&lsquo;<samp>prefer_tcp</samp>&rsquo;</dt>
<dd><p>Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>none</samp>&rsquo;.
</p>
</dd>
<dt><samp>allowed_media_types</samp></dt>
<dd><p>Set media types to accept from the server.
</p>
<p>The following flags are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>video</samp>&rsquo;</dt>
<dt>&lsquo;<samp>audio</samp>&rsquo;</dt>
<dt>&lsquo;<samp>data</samp>&rsquo;</dt>
</dl>
<p>By default it accepts all media types.
</p>
</dd>
<dt><samp>min_port</samp></dt>
<dd><p>Set minimum local UDP port. Default value is 5000.
</p>
</dd>
<dt><samp>max_port</samp></dt>
<dd><p>Set maximum local UDP port. Default value is 65000.
</p>
</dd>
<dt><samp>timeout</samp></dt>
<dd><p>Set maximum timeout (in seconds) to wait for incoming connections.
</p>
<p>A value of -1 means infinite (default). This option implies the
<samp>rtsp_flags</samp> set to &lsquo;<samp>listen</samp>&rsquo;.
</p>
</dd>
<dt><samp>reorder_queue_size</samp></dt>
<dd><p>Set number of packets to buffer for handling of reordered packets.
</p>
</dd>
<dt><samp>stimeout</samp></dt>
<dd><p>Set socket TCP I/O timeout in microseconds.
</p>
</dd>
<dt><samp>user-agent</samp></dt>
<dd><p>Override User-Agent header. If not specified, it defaults to the
libavformat identifier string.
</p></dd>
</dl>
<p>When receiving data over UDP, the demuxer tries to reorder received packets
(since they may arrive out of order, or packets may get lost totally). This
can be disabled by setting the maximum demuxing delay to zero (via
the <code>max_delay</code> field of AVFormatContext).
</p>
<p>When watching multi-bitrate Real-RTSP streams with <code>ffplay</code>, the
streams to display can be chosen with <code>-vst</code> <var>n</var> and
<code>-ast</code> <var>n</var> for video and audio respectively, and can be switched
on the fly by pressing <code>v</code> and <code>a</code>.
</p>
<a name="Examples-4"></a>
<h4 class="subsection">19.27.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-4" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-4" aria-hidden="true">TOC</a></span></h4>
<p>The following examples all make use of the <code>ffplay</code> and
<code>ffmpeg</code> tools.
</p>
<ul>
<li> Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
<div class="example">
<pre class="example">ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
</pre></div>
</li><li> Watch a stream tunneled over HTTP:
<div class="example">
<pre class="example">ffplay -rtsp_transport http rtsp://server/video.mp4
</pre></div>
</li><li> Send a stream in realtime to a RTSP server, for others to watch:
<div class="example">
<pre class="example">ffmpeg -re -i <var>input</var> -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
</pre></div>
</li><li> Receive a stream in realtime:
<div class="example">
<pre class="example">ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp <var>output</var>
</pre></div>
</li></ul>
<a name="sap"></a>
<h3 class="section">19.28 sap<span class="pull-right"><a class="anchor hidden-xs" href="#sap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sap" aria-hidden="true">TOC</a></span></h3>
<p>Session Announcement Protocol (RFC 2974). This is not technically a
protocol handler in libavformat, it is a muxer and demuxer.
It is used for signalling of RTP streams, by announcing the SDP for the
streams regularly on a separate port.
</p>
<a name="Muxer"></a>
<h4 class="subsection">19.28.1 Muxer<span class="pull-right"><a class="anchor hidden-xs" href="#Muxer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Muxer" aria-hidden="true">TOC</a></span></h4>
<p>The syntax for a SAP url given to the muxer is:
</p><div class="example">
<pre class="example">sap://<var>destination</var>[:<var>port</var>][?<var>options</var>]
</pre></div>
<p>The RTP packets are sent to <var>destination</var> on port <var>port</var>,
or to port 5004 if no port is specified.
<var>options</var> is a <code>&amp;</code>-separated list. The following options
are supported:
</p>
<dl compact="compact">
<dt><samp>announce_addr=<var>address</var></samp></dt>
<dd><p>Specify the destination IP address for sending the announcements to.
If omitted, the announcements are sent to the commonly used SAP
announcement multicast address 224.2.127.254 (sap.mcast.net), or
ff0e::2:7ffe if <var>destination</var> is an IPv6 address.
</p>
</dd>
<dt><samp>announce_port=<var>port</var></samp></dt>
<dd><p>Specify the port to send the announcements on, defaults to
9875 if not specified.
</p>
</dd>
<dt><samp>ttl=<var>ttl</var></samp></dt>
<dd><p>Specify the time to live value for the announcements and RTP packets,
defaults to 255.
</p>
</dd>
<dt><samp>same_port=<var>0|1</var></samp></dt>
<dd><p>If set to 1, send all RTP streams on the same port pair. If zero (the
default), all streams are sent on unique ports, with each stream on a
port 2 numbers higher than the previous.
VLC/Live555 requires this to be set to 1, to be able to receive the stream.
The RTP stack in libavformat for receiving requires all streams to be sent
on unique ports.
</p></dd>
</dl>
<p>Example command lines follow.
</p>
<p>To broadcast a stream on the local subnet, for watching in VLC:
</p>
<div class="example">
<pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://224.0.0.255?same_port=1
</pre></div>
<p>Similarly, for watching in <code>ffplay</code>:
</p>
<div class="example">
<pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://224.0.0.255
</pre></div>
<p>And for watching in <code>ffplay</code>, over IPv6:
</p>
<div class="example">
<pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://[ff0e::1:2:3:4]
</pre></div>
<a name="Demuxer"></a>
<h4 class="subsection">19.28.2 Demuxer<span class="pull-right"><a class="anchor hidden-xs" href="#Demuxer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Demuxer" aria-hidden="true">TOC</a></span></h4>
<p>The syntax for a SAP url given to the demuxer is:
</p><div class="example">
<pre class="example">sap://[<var>address</var>][:<var>port</var>]
</pre></div>
<p><var>address</var> is the multicast address to listen for announcements on,
if omitted, the default 224.2.127.254 (sap.mcast.net) is used. <var>port</var>
is the port that is listened on, 9875 if omitted.
</p>
<p>The demuxers listens for announcements on the given address and port.
Once an announcement is received, it tries to receive that particular stream.
</p>
<p>Example command lines follow.
</p>
<p>To play back the first stream announced on the normal SAP multicast address:
</p>
<div class="example">
<pre class="example">ffplay sap://
</pre></div>
<p>To play back the first stream announced on one the default IPv6 SAP multicast address:
</p>
<div class="example">
<pre class="example">ffplay sap://[ff0e::2:7ffe]
</pre></div>
<a name="sctp"></a>
<h3 class="section">19.29 sctp<span class="pull-right"><a class="anchor hidden-xs" href="#sctp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sctp" aria-hidden="true">TOC</a></span></h3>
<p>Stream Control Transmission Protocol.
</p>
<p>The accepted URL syntax is:
</p><div class="example">
<pre class="example">sctp://<var>host</var>:<var>port</var>[?<var>options</var>]
</pre></div>
<p>The protocol accepts the following options:
</p><dl compact="compact">
<dt><samp>listen</samp></dt>
<dd><p>If set to any value, listen for an incoming connection. Outgoing connection is done by default.
</p>
</dd>
<dt><samp>max_streams</samp></dt>
<dd><p>Set the maximum number of streams. By default no limit is set.
</p></dd>
</dl>
<a name="srtp"></a>
<h3 class="section">19.30 srtp<span class="pull-right"><a class="anchor hidden-xs" href="#srtp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-srtp" aria-hidden="true">TOC</a></span></h3>
<p>Secure Real-time Transport Protocol.
</p>
<p>The accepted options are:
</p><dl compact="compact">
<dt><samp>srtp_in_suite</samp></dt>
<dt><samp>srtp_out_suite</samp></dt>
<dd><p>Select input and output encoding suites.
</p>
<p>Supported values:
</p><dl compact="compact">
<dt>&lsquo;<samp>AES_CM_128_HMAC_SHA1_80</samp>&rsquo;</dt>
<dt>&lsquo;<samp>SRTP_AES128_CM_HMAC_SHA1_80</samp>&rsquo;</dt>
<dt>&lsquo;<samp>AES_CM_128_HMAC_SHA1_32</samp>&rsquo;</dt>
<dt>&lsquo;<samp>SRTP_AES128_CM_HMAC_SHA1_32</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>srtp_in_params</samp></dt>
<dt><samp>srtp_out_params</samp></dt>
<dd><p>Set input and output encoding parameters, which are expressed by a
base64-encoded representation of a binary block. The first 16 bytes of
this binary block are used as master key, the following 14 bytes are
used as master salt.
</p></dd>
</dl>
<a name="subfile"></a>
<h3 class="section">19.31 subfile<span class="pull-right"><a class="anchor hidden-xs" href="#subfile" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-subfile" aria-hidden="true">TOC</a></span></h3>
<p>Virtually extract a segment of a file or another stream.
The underlying stream must be seekable.
</p>
<p>Accepted options:
</p><dl compact="compact">
<dt><samp>start</samp></dt>
<dd><p>Start offset of the extracted segment, in bytes.
</p></dd>
<dt><samp>end</samp></dt>
<dd><p>End offset of the extracted segment, in bytes.
</p></dd>
</dl>
<p>Examples:
</p>
<p>Extract a chapter from a DVD VOB file (start and end sectors obtained
externally and multiplied by 2048):
</p><div class="example">
<pre class="example">subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
</pre></div>
<p>Play an AVI file directly from a TAR archive:
</p><div class="example">
<pre class="example">subfile,,start,183241728,end,366490624,,:archive.tar
</pre></div>
<a name="tee"></a>
<h3 class="section">19.32 tee<span class="pull-right"><a class="anchor hidden-xs" href="#tee" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tee" aria-hidden="true">TOC</a></span></h3>
<p>Writes the output to multiple protocols. The individual outputs are separated
by |
</p>
<div class="example">
<pre class="example">tee:file://path/to/local/this.avi|file://path/to/local/that.avi
</pre></div>
<a name="tcp"></a>
<h3 class="section">19.33 tcp<span class="pull-right"><a class="anchor hidden-xs" href="#tcp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tcp" aria-hidden="true">TOC</a></span></h3>
<p>Transmission Control Protocol.
</p>
<p>The required syntax for a TCP url is:
</p><div class="example">
<pre class="example">tcp://<var>hostname</var>:<var>port</var>[?<var>options</var>]
</pre></div>
<p><var>options</var> contains a list of &amp;-separated options of the form
<var>key</var>=<var>val</var>.
</p>
<p>The list of supported options follows.
</p>
<dl compact="compact">
<dt><samp>listen=<var>1|0</var></samp></dt>
<dd><p>Listen for an incoming connection. Default value is 0.
</p>
</dd>
<dt><samp>timeout=<var>microseconds</var></samp></dt>
<dd><p>Set raise error timeout, expressed in microseconds.
</p>
<p>This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
</p>
</dd>
<dt><samp>listen_timeout=<var>milliseconds</var></samp></dt>
<dd><p>Set listen timeout, expressed in milliseconds.
</p>
</dd>
<dt><samp>recv_buffer_size=<var>bytes</var></samp></dt>
<dd><p>Set receive buffer size, expressed bytes.
</p>
</dd>
<dt><samp>send_buffer_size=<var>bytes</var></samp></dt>
<dd><p>Set send buffer size, expressed bytes.
</p></dd>
</dl>
<p>The following example shows how to setup a listening TCP connection
with <code>ffmpeg</code>, which is then accessed with <code>ffplay</code>:
</p><div class="example">
<pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> tcp://<var>hostname</var>:<var>port</var>?listen
ffplay tcp://<var>hostname</var>:<var>port</var>
</pre></div>
<a name="tls"></a>
<h3 class="section">19.34 tls<span class="pull-right"><a class="anchor hidden-xs" href="#tls" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tls" aria-hidden="true">TOC</a></span></h3>
<p>Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
</p>
<p>The required syntax for a TLS/SSL url is:
</p><div class="example">
<pre class="example">tls://<var>hostname</var>:<var>port</var>[?<var>options</var>]
</pre></div>
<p>The following parameters can be set via command line options
(or in code via <code>AVOption</code>s):
</p>
<dl compact="compact">
<dt><samp>ca_file, cafile=<var>filename</var></samp></dt>
<dd><p>A file containing certificate authority (CA) root certificates to treat
as trusted. If the linked TLS library contains a default this might not
need to be specified for verification to work, but not all libraries and
setups have defaults built in.
The file must be in OpenSSL PEM format.
</p>
</dd>
<dt><samp>tls_verify=<var>1|0</var></samp></dt>
<dd><p>If enabled, try to verify the peer that we are communicating with.
Note, if using OpenSSL, this currently only makes sure that the
peer certificate is signed by one of the root certificates in the CA
database, but it does not validate that the certificate actually
matches the host name we are trying to connect to. (With GnuTLS,
the host name is validated as well.)
</p>
<p>This is disabled by default since it requires a CA database to be
provided by the caller in many cases.
</p>
</dd>
<dt><samp>cert_file, cert=<var>filename</var></samp></dt>
<dd><p>A file containing a certificate to use in the handshake with the peer.
(When operating as server, in listen mode, this is more often required
by the peer, while client certificates only are mandated in certain
setups.)
</p>
</dd>
<dt><samp>key_file, key=<var>filename</var></samp></dt>
<dd><p>A file containing the private key for the certificate.
</p>
</dd>
<dt><samp>listen=<var>1|0</var></samp></dt>
<dd><p>If enabled, listen for connections on the provided port, and assume
the server role in the handshake instead of the client role.
</p>
</dd>
</dl>
<p>Example command lines:
</p>
<p>To create a TLS/SSL server that serves an input stream.
</p>
<div class="example">
<pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> tls://<var>hostname</var>:<var>port</var>?listen&amp;cert=<var>server.crt</var>&amp;key=<var>server.key</var>
</pre></div>
<p>To play back a stream from the TLS/SSL server using <code>ffplay</code>:
</p>
<div class="example">
<pre class="example">ffplay tls://<var>hostname</var>:<var>port</var>
</pre></div>
<a name="udp"></a>
<h3 class="section">19.35 udp<span class="pull-right"><a class="anchor hidden-xs" href="#udp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-udp" aria-hidden="true">TOC</a></span></h3>
<p>User Datagram Protocol.
</p>
<p>The required syntax for an UDP URL is:
</p><div class="example">
<pre class="example">udp://<var>hostname</var>:<var>port</var>[?<var>options</var>]
</pre></div>
<p><var>options</var> contains a list of &amp;-separated options of the form <var>key</var>=<var>val</var>.
</p>
<p>In case threading is enabled on the system, a circular buffer is used
to store the incoming data, which allows one to reduce loss of data due to
UDP socket buffer overruns. The <var>fifo_size</var> and
<var>overrun_nonfatal</var> options are related to this buffer.
</p>
<p>The list of supported options follows.
</p>
<dl compact="compact">
<dt><samp>buffer_size=<var>size</var></samp></dt>
<dd><p>Set the UDP maximum socket buffer size in bytes. This is used to set either
the receive or send buffer size, depending on what the socket is used for.
Default is 64KB. See also <var>fifo_size</var>.
</p>
</dd>
<dt><samp>bitrate=<var>bitrate</var></samp></dt>
<dd><p>If set to nonzero, the output will have the specified constant bitrate if the
input has enough packets to sustain it.
</p>
</dd>
<dt><samp>burst_bits=<var>bits</var></samp></dt>
<dd><p>When using <var>bitrate</var> this specifies the maximum number of bits in
packet bursts.
</p>
</dd>
<dt><samp>localport=<var>port</var></samp></dt>
<dd><p>Override the local UDP port to bind with.
</p>
</dd>
<dt><samp>localaddr=<var>addr</var></samp></dt>
<dd><p>Choose the local IP address. This is useful e.g. if sending multicast
and the host has multiple interfaces, where the user can choose
which interface to send on by specifying the IP address of that interface.
</p>
</dd>
<dt><samp>pkt_size=<var>size</var></samp></dt>
<dd><p>Set the size in bytes of UDP packets.
</p>
</dd>
<dt><samp>reuse=<var>1|0</var></samp></dt>
<dd><p>Explicitly allow or disallow reusing UDP sockets.
</p>
</dd>
<dt><samp>ttl=<var>ttl</var></samp></dt>
<dd><p>Set the time to live value (for multicast only).
</p>
</dd>
<dt><samp>connect=<var>1|0</var></samp></dt>
<dd><p>Initialize the UDP socket with <code>connect()</code>. In this case, the
destination address can&rsquo;t be changed with ff_udp_set_remote_url later.
If the destination address isn&rsquo;t known at the start, this option can
be specified in ff_udp_set_remote_url, too.
This allows finding out the source address for the packets with getsockname,
and makes writes return with AVERROR(ECONNREFUSED) if &quot;destination
unreachable&quot; is received.
For receiving, this gives the benefit of only receiving packets from
the specified peer address/port.
</p>
</dd>
<dt><samp>sources=<var>address</var>[,<var>address</var>]</samp></dt>
<dd><p>Only receive packets sent to the multicast group from one of the
specified sender IP addresses.
</p>
</dd>
<dt><samp>block=<var>address</var>[,<var>address</var>]</samp></dt>
<dd><p>Ignore packets sent to the multicast group from the specified
sender IP addresses.
</p>
</dd>
<dt><samp>fifo_size=<var>units</var></samp></dt>
<dd><p>Set the UDP receiving circular buffer size, expressed as a number of
packets with size of 188 bytes. If not specified defaults to 7*4096.
</p>
</dd>
<dt><samp>overrun_nonfatal=<var>1|0</var></samp></dt>
<dd><p>Survive in case of UDP receiving circular buffer overrun. Default
value is 0.
</p>
</dd>
<dt><samp>timeout=<var>microseconds</var></samp></dt>
<dd><p>Set raise error timeout, expressed in microseconds.
</p>
<p>This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
</p>
</dd>
<dt><samp>broadcast=<var>1|0</var></samp></dt>
<dd><p>Explicitly allow or disallow UDP broadcasting.
</p>
<p>Note that broadcasting may not work properly on networks having
a broadcast storm protection.
</p></dd>
</dl>
<a name="Examples-5"></a>
<h4 class="subsection">19.35.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-5" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use <code>ffmpeg</code> to stream over UDP to a remote endpoint:
<div class="example">
<pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> udp://<var>hostname</var>:<var>port</var>
</pre></div>
</li><li> Use <code>ffmpeg</code> to stream in mpegts format over UDP using 188
sized UDP packets, using a large input buffer:
<div class="example">
<pre class="example">ffmpeg -i <var>input</var> -f mpegts udp://<var>hostname</var>:<var>port</var>?pkt_size=188&amp;buffer_size=65535
</pre></div>
</li><li> Use <code>ffmpeg</code> to receive over UDP from a remote endpoint:
<div class="example">
<pre class="example">ffmpeg -i udp://[<var>multicast-address</var>]:<var>port</var> ...
</pre></div>
</li></ul>
<a name="unix"></a>
<h3 class="section">19.36 unix<span class="pull-right"><a class="anchor hidden-xs" href="#unix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-unix" aria-hidden="true">TOC</a></span></h3>
<p>Unix local socket
</p>
<p>The required syntax for a Unix socket URL is:
</p>
<div class="example">
<pre class="example">unix://<var>filepath</var>
</pre></div>
<p>The following parameters can be set via command line options
(or in code via <code>AVOption</code>s):
</p>
<dl compact="compact">
<dt><samp>timeout</samp></dt>
<dd><p>Timeout in ms.
</p></dd>
<dt><samp>listen</samp></dt>
<dd><p>Create the Unix socket in listening mode.
</p></dd>
</dl>
<a name="Device-Options"></a>
<h2 class="chapter">20 Device Options<span class="pull-right"><a class="anchor hidden-xs" href="#Device-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Device-Options" aria-hidden="true">TOC</a></span></h2>
<p>The libavdevice library provides the same interface as
libavformat. Namely, an input device is considered like a demuxer, and
an output device like a muxer, and the interface and generic device
options are the same provided by libavformat (see the ffmpeg-formats
manual).
</p>
<p>In addition each input or output device may support so-called private
options, which are specific for that component.
</p>
<p>Options may be set by specifying -<var>option</var> <var>value</var> in the
FFmpeg tools, or by setting the value explicitly in the device
<code>AVFormatContext</code> options or using the <samp>libavutil/opt.h</samp> API
for programmatic use.
</p>
<a name="Input-Devices"></a>
<h2 class="chapter">21 Input Devices<span class="pull-right"><a class="anchor hidden-xs" href="#Input-Devices" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Input-Devices" aria-hidden="true">TOC</a></span></h2>
<p>Input devices are configured elements in FFmpeg which enable accessing
the data coming from a multimedia device attached to your system.
</p>
<p>When you configure your FFmpeg build, all the supported input devices
are enabled by default. You can list all available ones using the
configure option &quot;&ndash;list-indevs&quot;.
</p>
<p>You can disable all the input devices using the configure option
&quot;&ndash;disable-indevs&quot;, and selectively enable an input device using the
option &quot;&ndash;enable-indev=<var>INDEV</var>&quot;, or you can disable a particular
input device using the option &quot;&ndash;disable-indev=<var>INDEV</var>&quot;.
</p>
<p>The option &quot;-devices&quot; of the ff* tools will display the list of
supported input devices.
</p>
<p>A description of the currently available input devices follows.
</p>
<a name="alsa"></a>
<h3 class="section">21.1 alsa<span class="pull-right"><a class="anchor hidden-xs" href="#alsa" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-alsa" aria-hidden="true">TOC</a></span></h3>
<p>ALSA (Advanced Linux Sound Architecture) input device.
</p>
<p>To enable this input device during configuration you need libasound
installed on your system.
</p>
<p>This device allows capturing from an ALSA device. The name of the
device to capture has to be an ALSA card identifier.
</p>
<p>An ALSA identifier has the syntax:
</p><div class="example">
<pre class="example">hw:<var>CARD</var>[,<var>DEV</var>[,<var>SUBDEV</var>]]
</pre></div>
<p>where the <var>DEV</var> and <var>SUBDEV</var> components are optional.
</p>
<p>The three arguments (in order: <var>CARD</var>,<var>DEV</var>,<var>SUBDEV</var>)
specify card number or identifier, device number and subdevice number
(-1 means any).
</p>
<p>To see the list of cards currently recognized by your system check the
files <samp>/proc/asound/cards</samp> and <samp>/proc/asound/devices</samp>.
</p>
<p>For example to capture with <code>ffmpeg</code> from an ALSA device with
card id 0, you may run the command:
</p><div class="example">
<pre class="example">ffmpeg -f alsa -i hw:0 alsaout.wav
</pre></div>
<p>For more information see:
<a href="http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html">http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html</a>
</p>
<a name="Options-7"></a>
<h4 class="subsection">21.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-7" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
<a name="avfoundation"></a>
<h3 class="section">21.2 avfoundation<span class="pull-right"><a class="anchor hidden-xs" href="#avfoundation" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-avfoundation" aria-hidden="true">TOC</a></span></h3>
<p>AVFoundation input device.
</p>
<p>AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX &gt;= 10.7 as well as on iOS.
The older QTKit framework has been marked deprecated since OSX version 10.7.
</p>
<p>The input filename has to be given in the following syntax:
</p><div class="example">
<pre class="example">-i &quot;[[VIDEO]:[AUDIO]]&quot;
</pre></div>
<p>The first entry selects the video input while the latter selects the audio input.
The stream has to be specified by the device name or the device index as shown by the device list.
Alternatively, the video and/or audio input device can be chosen by index using the
<samp>
-video_device_index &lt;INDEX&gt;
</samp>
and/or
<samp>
-audio_device_index &lt;INDEX&gt;
</samp>
, overriding any
device name or index given in the input filename.
</p>
<p>All available devices can be enumerated by using <samp>-list_devices true</samp>, listing
all device names and corresponding indices.
</p>
<p>There are two device name aliases:
</p><dl compact="compact">
<dt><code>default</code></dt>
<dd><p>Select the AVFoundation default device of the corresponding type.
</p>
</dd>
<dt><code>none</code></dt>
<dd><p>Do not record the corresponding media type.
This is equivalent to specifying an empty device name or index.
</p>
</dd>
</dl>
<a name="Options-8"></a>
<h4 class="subsection">21.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-8" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-8" aria-hidden="true">TOC</a></span></h4>
<p>AVFoundation supports the following options:
</p>
<dl compact="compact">
<dt><samp>-list_devices &lt;TRUE|FALSE&gt;</samp></dt>
<dd><p>If set to true, a list of all available input devices is given showing all
device names and indices.
</p>
</dd>
<dt><samp>-video_device_index &lt;INDEX&gt;</samp></dt>
<dd><p>Specify the video device by its index. Overrides anything given in the input filename.
</p>
</dd>
<dt><samp>-audio_device_index &lt;INDEX&gt;</samp></dt>
<dd><p>Specify the audio device by its index. Overrides anything given in the input filename.
</p>
</dd>
<dt><samp>-pixel_format &lt;FORMAT&gt;</samp></dt>
<dd><p>Request the video device to use a specific pixel format.
If the specified format is not supported, a list of available formats is given
and the first one in this list is used instead. Available pixel formats are:
<code>monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
yuv420p, nv12, yuyv422, gray</code>
</p>
</dd>
<dt><samp>-framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default is <code>ntsc</code>, corresponding to a
frame rate of <code>30000/1001</code>.
</p>
</dd>
<dt><samp>-video_size</samp></dt>
<dd><p>Set the video frame size.
</p>
</dd>
<dt><samp>-capture_cursor</samp></dt>
<dd><p>Capture the mouse pointer. Default is 0.
</p>
</dd>
<dt><samp>-capture_mouse_clicks</samp></dt>
<dd><p>Capture the screen mouse clicks. Default is 0.
</p>
</dd>
</dl>
<a name="Examples-6"></a>
<h4 class="subsection">21.2.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-6" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-6" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Print the list of AVFoundation supported devices and exit:
<div class="example">
<pre class="example">$ ffmpeg -f avfoundation -list_devices true -i &quot;&quot;
</pre></div>
</li><li> Record video from video device 0 and audio from audio device 0 into out.avi:
<div class="example">
<pre class="example">$ ffmpeg -f avfoundation -i &quot;0:0&quot; out.avi
</pre></div>
</li><li> Record video from video device 2 and audio from audio device 1 into out.avi:
<div class="example">
<pre class="example">$ ffmpeg -f avfoundation -video_device_index 2 -i &quot;:1&quot; out.avi
</pre></div>
</li><li> Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
<div class="example">
<pre class="example">$ ffmpeg -f avfoundation -pixel_format bgr0 -i &quot;default:none&quot; out.avi
</pre></div>
</li></ul>
<a name="bktr"></a>
<h3 class="section">21.3 bktr<span class="pull-right"><a class="anchor hidden-xs" href="#bktr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bktr" aria-hidden="true">TOC</a></span></h3>
<p>BSD video input device.
</p>
<a name="Options-9"></a>
<h4 class="subsection">21.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-9" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-9" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>framerate</samp></dt>
<dd><p>Set the frame rate.
</p>
</dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the video frame size. Default is <code>vga</code>.
</p>
</dd>
<dt><samp>standard</samp></dt>
<dd>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>pal</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ntsc</samp>&rsquo;</dt>
<dt>&lsquo;<samp>secam</samp>&rsquo;</dt>
<dt>&lsquo;<samp>paln</samp>&rsquo;</dt>
<dt>&lsquo;<samp>palm</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ntscj</samp>&rsquo;</dt>
</dl>
</dd>
</dl>
<a name="decklink"></a>
<h3 class="section">21.4 decklink<span class="pull-right"><a class="anchor hidden-xs" href="#decklink" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-decklink" aria-hidden="true">TOC</a></span></h3>
<p>The decklink input device provides capture capabilities for Blackmagic
DeckLink devices.
</p>
<p>To enable this input device, you need the Blackmagic DeckLink SDK and you
need to configure with the appropriate <code>--extra-cflags</code>
and <code>--extra-ldflags</code>.
On Windows, you need to run the IDL files through <code>widl</code>.
</p>
<p>DeckLink is very picky about the formats it supports. Pixel format is
uyvy422 or v210, framerate and video size must be determined for your device with
<code>-list_formats 1</code>. Audio sample rate is always 48 kHz and the number
of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single
audio track.
</p>
<a name="Options-10"></a>
<h4 class="subsection">21.4.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-10" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-10" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>list_devices</samp></dt>
<dd><p>If set to <samp>true</samp>, print a list of devices and exit.
Defaults to <samp>false</samp>.
</p>
</dd>
<dt><samp>list_formats</samp></dt>
<dd><p>If set to <samp>true</samp>, print a list of supported formats and exit.
Defaults to <samp>false</samp>.
</p>
</dd>
<dt><samp>bm_v210</samp></dt>
<dd><p>If set to &lsquo;<samp>1</samp>&rsquo;, video is captured in 10 bit v210 instead
of uyvy422. Not all Blackmagic devices support this option.
</p>
</dd>
<dt><samp>teletext_lines</samp></dt>
<dd><p>If set to nonzero, an additional teletext stream will be captured from the
vertical ancillary data. This option is a bitmask of the VBI lines checked,
specifically lines 6 to 22, and lines 318 to 335. Line 6 is the LSB in the mask.
Selected lines which do not contain teletext information will be ignored. You
can use the special <samp>all</samp> constant to select all possible lines, or
<samp>standard</samp> to skip lines 6, 318 and 319, which are not compatible with all
receivers. Capturing teletext only works for SD PAL sources in 8 bit mode.
To use this option, ffmpeg needs to be compiled with <code>--enable-libzvbi</code>.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Defines number of audio channels to capture. Must be &lsquo;<samp>2</samp>&rsquo;, &lsquo;<samp>8</samp>&rsquo; or &lsquo;<samp>16</samp>&rsquo;.
Defaults to &lsquo;<samp>2</samp>&rsquo;.
</p>
</dd>
<dt><samp>duplex_mode</samp></dt>
<dd><p>Sets the decklink device duplex mode. Must be &lsquo;<samp>unset</samp>&rsquo;, &lsquo;<samp>half</samp>&rsquo; or &lsquo;<samp>full</samp>&rsquo;.
Defaults to &lsquo;<samp>unset</samp>&rsquo;.
</p>
</dd>
<dt><samp>video_input</samp></dt>
<dd><p>Sets the video input source. Must be &lsquo;<samp>unset</samp>&rsquo;, &lsquo;<samp>sdi</samp>&rsquo;, &lsquo;<samp>hdmi</samp>&rsquo;,
&lsquo;<samp>optical_sdi</samp>&rsquo;, &lsquo;<samp>component</samp>&rsquo;, &lsquo;<samp>composite</samp>&rsquo; or &lsquo;<samp>s_video</samp>&rsquo;.
Defaults to &lsquo;<samp>unset</samp>&rsquo;.
</p>
</dd>
<dt><samp>audio_input</samp></dt>
<dd><p>Sets the audio input source. Must be &lsquo;<samp>unset</samp>&rsquo;, &lsquo;<samp>embedded</samp>&rsquo;,
&lsquo;<samp>aes_ebu</samp>&rsquo;, &lsquo;<samp>analog</samp>&rsquo;, &lsquo;<samp>analog_xlr</samp>&rsquo;, &lsquo;<samp>analog_rca</samp>&rsquo; or
&lsquo;<samp>microphone</samp>&rsquo;. Defaults to &lsquo;<samp>unset</samp>&rsquo;.
</p>
</dd>
<dt><samp>video_pts</samp></dt>
<dd><p>Sets the video packet timestamp source. Must be &lsquo;<samp>video</samp>&rsquo;, &lsquo;<samp>audio</samp>&rsquo;,
&lsquo;<samp>reference</samp>&rsquo; or &lsquo;<samp>wallclock</samp>&rsquo;. Defaults to &lsquo;<samp>video</samp>&rsquo;.
</p>
</dd>
<dt><samp>audio_pts</samp></dt>
<dd><p>Sets the audio packet timestamp source. Must be &lsquo;<samp>video</samp>&rsquo;, &lsquo;<samp>audio</samp>&rsquo;,
&lsquo;<samp>reference</samp>&rsquo; or &lsquo;<samp>wallclock</samp>&rsquo;. Defaults to &lsquo;<samp>audio</samp>&rsquo;.
</p>
</dd>
</dl>
<a name="Examples-7"></a>
<h4 class="subsection">21.4.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-7" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> List input devices:
<div class="example">
<pre class="example">ffmpeg -f decklink -list_devices 1 -i dummy
</pre></div>
</li><li> List supported formats:
<div class="example">
<pre class="example">ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
</pre></div>
</li><li> Capture video clip at 1080i50 (format 11):
<div class="example">
<pre class="example">ffmpeg -f decklink -i 'Intensity Pro@11' -acodec copy -vcodec copy output.avi
</pre></div>
</li><li> Capture video clip at 1080i50 10 bit:
<div class="example">
<pre class="example">ffmpeg -bm_v210 1 -f decklink -i 'UltraStudio Mini Recorder@11' -acodec copy -vcodec copy output.avi
</pre></div>
</li><li> Capture video clip at 1080i50 with 16 audio channels:
<div class="example">
<pre class="example">ffmpeg -channels 16 -f decklink -i 'UltraStudio Mini Recorder@11' -acodec copy -vcodec copy output.avi
</pre></div>
</li></ul>
<a name="dshow"></a>
<h3 class="section">21.5 dshow<span class="pull-right"><a class="anchor hidden-xs" href="#dshow" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dshow" aria-hidden="true">TOC</a></span></h3>
<p>Windows DirectShow input device.
</p>
<p>DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
Currently only audio and video devices are supported.
</p>
<p>Multiple devices may be opened as separate inputs, but they may also be
opened on the same input, which should improve synchronism between them.
</p>
<p>The input name should be in the format:
</p>
<div class="example">
<pre class="example"><var>TYPE</var>=<var>NAME</var>[:<var>TYPE</var>=<var>NAME</var>]
</pre></div>
<p>where <var>TYPE</var> can be either <var>audio</var> or <var>video</var>,
and <var>NAME</var> is the device&rsquo;s name or alternative name..
</p>
<a name="Options-11"></a>
<h4 class="subsection">21.5.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-11" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-11" aria-hidden="true">TOC</a></span></h4>
<p>If no options are specified, the device&rsquo;s defaults are used.
If the device does not support the requested options, it will
fail to open.
</p>
<dl compact="compact">
<dt><samp>video_size</samp></dt>
<dd><p>Set the video size in the captured video.
</p>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>Set the frame rate in the captured video.
</p>
</dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate (in Hz) of the captured audio.
</p>
</dd>
<dt><samp>sample_size</samp></dt>
<dd><p>Set the sample size (in bits) of the captured audio.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels in the captured audio.
</p>
</dd>
<dt><samp>list_devices</samp></dt>
<dd><p>If set to <samp>true</samp>, print a list of devices and exit.
</p>
</dd>
<dt><samp>list_options</samp></dt>
<dd><p>If set to <samp>true</samp>, print a list of selected device&rsquo;s options
and exit.
</p>
</dd>
<dt><samp>video_device_number</samp></dt>
<dd><p>Set video device number for devices with the same name (starts at 0,
defaults to 0).
</p>
</dd>
<dt><samp>audio_device_number</samp></dt>
<dd><p>Set audio device number for devices with the same name (starts at 0,
defaults to 0).
</p>
</dd>
<dt><samp>pixel_format</samp></dt>
<dd><p>Select pixel format to be used by DirectShow. This may only be set when
the video codec is not set or set to rawvideo.
</p>
</dd>
<dt><samp>audio_buffer_size</samp></dt>
<dd><p>Set audio device buffer size in milliseconds (which can directly
impact latency, depending on the device).
Defaults to using the audio device&rsquo;s
default buffer size (typically some multiple of 500ms).
Setting this value too low can degrade performance.
See also
<a href="http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx">http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx</a>
</p>
</dd>
<dt><samp>video_pin_name</samp></dt>
<dd><p>Select video capture pin to use by name or alternative name.
</p>
</dd>
<dt><samp>audio_pin_name</samp></dt>
<dd><p>Select audio capture pin to use by name or alternative name.
</p>
</dd>
<dt><samp>crossbar_video_input_pin_number</samp></dt>
<dd><p>Select video input pin number for crossbar device. This will be
routed to the crossbar device&rsquo;s Video Decoder output pin.
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
</p>
</dd>
<dt><samp>crossbar_audio_input_pin_number</samp></dt>
<dd><p>Select audio input pin number for crossbar device. This will be
routed to the crossbar device&rsquo;s Audio Decoder output pin.
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
</p>
</dd>
<dt><samp>show_video_device_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display dialog
to the end user, allowing them to change video filter properties
and configurations manually.
Note that for crossbar devices, adjusting values in this dialog
may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
input frame rates, sizes, interlacing, etc. Changing these values can
enable different scan rates/frame rates and avoiding green bars at
the bottom, flickering scan lines, etc.
Note that with some devices, changing these properties can also affect future
invocations (sets new defaults) until system reboot occurs.
</p>
</dd>
<dt><samp>show_audio_device_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display dialog
to the end user, allowing them to change audio filter properties
and configurations manually.
</p>
</dd>
<dt><samp>show_video_crossbar_connection_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify crossbar pin routings, when it opens a video device.
</p>
</dd>
<dt><samp>show_audio_crossbar_connection_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify crossbar pin routings, when it opens an audio device.
</p>
</dd>
<dt><samp>show_analog_tv_tuner_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV channels and frequencies.
</p>
</dd>
<dt><samp>show_analog_tv_tuner_audio_dialog</samp></dt>
<dd><p>If set to <samp>true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV audio (like mono vs. stereo, Language A,B or C).
</p>
</dd>
<dt><samp>audio_device_load</samp></dt>
<dd><p>Load an audio capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this an audio capture source has to be specified, but it can
be anything even fake one.
</p>
</dd>
<dt><samp>audio_device_save</samp></dt>
<dd><p>Save the currently used audio capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.
</p>
</dd>
<dt><samp>video_device_load</samp></dt>
<dd><p>Load a video capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this a video capture source has to be specified, but it can
be anything even fake one.
</p>
</dd>
<dt><samp>video_device_save</samp></dt>
<dd><p>Save the currently used video capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.
</p>
</dd>
</dl>
<a name="Examples-8"></a>
<h4 class="subsection">21.5.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-8" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-8" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Print the list of DirectShow supported devices and exit:
<div class="example">
<pre class="example">$ ffmpeg -list_devices true -f dshow -i dummy
</pre></div>
</li><li> Open video device <var>Camera</var>:
<div class="example">
<pre class="example">$ ffmpeg -f dshow -i video=&quot;Camera&quot;
</pre></div>
</li><li> Open second video device with name <var>Camera</var>:
<div class="example">
<pre class="example">$ ffmpeg -f dshow -video_device_number 1 -i video=&quot;Camera&quot;
</pre></div>
</li><li> Open video device <var>Camera</var> and audio device <var>Microphone</var>:
<div class="example">
<pre class="example">$ ffmpeg -f dshow -i video=&quot;Camera&quot;:audio=&quot;Microphone&quot;
</pre></div>
</li><li> Print the list of supported options in selected device and exit:
<div class="example">
<pre class="example">$ ffmpeg -list_options true -f dshow -i video=&quot;Camera&quot;
</pre></div>
</li><li> Specify pin names to capture by name or alternative name, specify alternative device name:
<div class="example">
<pre class="example">$ ffmpeg -f dshow -audio_pin_name &quot;Audio Out&quot; -video_pin_name 2 -i video=video=&quot;@device_pnp_\\?\pci#ven_1a0a&amp;dev_6200&amp;subsys_62021461&amp;rev_01#4&amp;e2c7dd6&amp;0&amp;00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}&quot;:audio=&quot;Microphone&quot;
</pre></div>
</li><li> Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
<div class="example">
<pre class="example">$ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
-crossbar_audio_input_pin_number 3 -i video=&quot;AVerMedia BDA Analog Capture&quot;:audio=&quot;AVerMedia BDA Analog Capture&quot;
</pre></div>
</li></ul>
<a name="dv1394"></a>
<h3 class="section">21.6 dv1394<span class="pull-right"><a class="anchor hidden-xs" href="#dv1394" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dv1394" aria-hidden="true">TOC</a></span></h3>
<p>Linux DV 1394 input device.
</p>
<a name="Options-12"></a>
<h4 class="subsection">21.6.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-12" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-12" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>framerate</samp></dt>
<dd><p>Set the frame rate. Default is 25.
</p>
</dd>
<dt><samp>standard</samp></dt>
<dd>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>pal</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ntsc</samp>&rsquo;</dt>
</dl>
<p>Default value is <code>ntsc</code>.
</p>
</dd>
</dl>
<a name="fbdev"></a>
<h3 class="section">21.7 fbdev<span class="pull-right"><a class="anchor hidden-xs" href="#fbdev" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fbdev" aria-hidden="true">TOC</a></span></h3>
<p>Linux framebuffer input device.
</p>
<p>The Linux framebuffer is a graphic hardware-independent abstraction
layer to show graphics on a computer monitor, typically on the
console. It is accessed through a file device node, usually
<samp>/dev/fb0</samp>.
</p>
<p>For more detailed information read the file
Documentation/fb/framebuffer.txt included in the Linux source tree.
</p>
<p>See also <a href="http://linux-fbdev.sourceforge.net/">http://linux-fbdev.sourceforge.net/</a>, and fbset(1).
</p>
<p>To record from the framebuffer device <samp>/dev/fb0</samp> with
<code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
</pre></div>
<p>You can take a single screenshot image with the command:
</p><div class="example">
<pre class="example">ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
</pre></div>
<a name="Options-13"></a>
<h4 class="subsection">21.7.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-13" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-13" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>framerate</samp></dt>
<dd><p>Set the frame rate. Default is 25.
</p>
</dd>
</dl>
<a name="gdigrab"></a>
<h3 class="section">21.8 gdigrab<span class="pull-right"><a class="anchor hidden-xs" href="#gdigrab" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gdigrab" aria-hidden="true">TOC</a></span></h3>
<p>Win32 GDI-based screen capture device.
</p>
<p>This device allows you to capture a region of the display on Windows.
</p>
<p>There are two options for the input filename:
</p><div class="example">
<pre class="example">desktop
</pre></div>
<p>or
</p><div class="example">
<pre class="example">title=<var>window_title</var>
</pre></div>
<p>The first option will capture the entire desktop, or a fixed region of the
desktop. The second option will instead capture the contents of a single
window, regardless of its position on the screen.
</p>
<p>For example, to grab the entire desktop using <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
</pre></div>
<p>Grab a 640x480 region at position <code>10,20</code>:
</p><div class="example">
<pre class="example">ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
</pre></div>
<p>Grab the contents of the window named &quot;Calculator&quot;
</p><div class="example">
<pre class="example">ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
</pre></div>
<a name="Options-14"></a>
<h4 class="subsection">21.8.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-14" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-14" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>draw_mouse</samp></dt>
<dd><p>Specify whether to draw the mouse pointer. Use the value <code>0</code> to
not draw the pointer. Default value is <code>1</code>.
</p>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code>ntsc</code>,
corresponding to a frame rate of <code>30000/1001</code>.
</p>
</dd>
<dt><samp>show_region</samp></dt>
<dd><p>Show grabbed region on screen.
</p>
<p>If <var>show_region</var> is specified with <code>1</code>, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.
</p>
<p>Note that <var>show_region</var> is incompatible with grabbing the contents
of a single window.
</p>
<p>For example:
</p><div class="example">
<pre class="example">ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
</pre></div>
</dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the video frame size. The default is to capture the full screen if <samp>desktop</samp> is selected, or the full window size if <samp>title=<var>window_title</var></samp> is selected.
</p>
</dd>
<dt><samp>offset_x</samp></dt>
<dd><p>When capturing a region with <var>video_size</var>, set the distance from the left edge of the screen or desktop.
</p>
<p>Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative <var>offset_x</var> value to move the region to that monitor.
</p>
</dd>
<dt><samp>offset_y</samp></dt>
<dd><p>When capturing a region with <var>video_size</var>, set the distance from the top edge of the screen or desktop.
</p>
<p>Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative <var>offset_y</var> value to move the region to that monitor.
</p>
</dd>
</dl>
<a name="iec61883"></a>
<h3 class="section">21.9 iec61883<span class="pull-right"><a class="anchor hidden-xs" href="#iec61883" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-iec61883" aria-hidden="true">TOC</a></span></h3>
<p>FireWire DV/HDV input device using libiec61883.
</p>
<p>To enable this input device, you need libiec61883, libraw1394 and
libavc1394 installed on your system. Use the configure option
<code>--enable-libiec61883</code> to compile with the device enabled.
</p>
<p>The iec61883 capture device supports capturing from a video device
connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
FireWire stack (juju). This is the default DV/HDV input method in Linux
Kernel 2.6.37 and later, since the old FireWire stack was removed.
</p>
<p>Specify the FireWire port to be used as input file, or &quot;auto&quot;
to choose the first port connected.
</p>
<a name="Options-15"></a>
<h4 class="subsection">21.9.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-15" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-15" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>dvtype</samp></dt>
<dd><p>Override autodetection of DV/HDV. This should only be used if auto
detection does not work, or if usage of a different device type
should be prohibited. Treating a DV device as HDV (or vice versa) will
not work and result in undefined behavior.
The values <samp>auto</samp>, <samp>dv</samp> and <samp>hdv</samp> are supported.
</p>
</dd>
<dt><samp>dvbuffer</samp></dt>
<dd><p>Set maximum size of buffer for incoming data, in frames. For DV, this
is an exact value. For HDV, it is not frame exact, since HDV does
not have a fixed frame size.
</p>
</dd>
<dt><samp>dvguid</samp></dt>
<dd><p>Select the capture device by specifying its GUID. Capturing will only
be performed from the specified device and fails if no device with the
given GUID is found. This is useful to select the input if multiple
devices are connected at the same time.
Look at /sys/bus/firewire/devices to find out the GUIDs.
</p>
</dd>
</dl>
<a name="Examples-9"></a>
<h4 class="subsection">21.9.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-9" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-9" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Grab and show the input of a FireWire DV/HDV device.
<div class="example">
<pre class="example">ffplay -f iec61883 -i auto
</pre></div>
</li><li> Grab and record the input of a FireWire DV/HDV device,
using a packet buffer of 100000 packets if the source is HDV.
<div class="example">
<pre class="example">ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
</pre></div>
</li></ul>
<a name="jack"></a>
<h3 class="section">21.10 jack<span class="pull-right"><a class="anchor hidden-xs" href="#jack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-jack" aria-hidden="true">TOC</a></span></h3>
<p>JACK input device.
</p>
<p>To enable this input device during configuration you need libjack
installed on your system.
</p>
<p>A JACK input device creates one or more JACK writable clients, one for
each audio channel, with name <var>client_name</var>:input_<var>N</var>, where
<var>client_name</var> is the name provided by the application, and <var>N</var>
is a number which identifies the channel.
Each writable client will send the acquired data to the FFmpeg input
device.
</p>
<p>Once you have created one or more JACK readable clients, you need to
connect them to one or more JACK writable clients.
</p>
<p>To connect or disconnect JACK clients you can use the <code>jack_connect</code>
and <code>jack_disconnect</code> programs, or do it through a graphical interface,
for example with <code>qjackctl</code>.
</p>
<p>To list the JACK clients and their properties you can invoke the command
<code>jack_lsp</code>.
</p>
<p>Follows an example which shows how to capture a JACK readable client
with <code>ffmpeg</code>.
</p><div class="example">
<pre class="example"># Create a JACK writable client with name &quot;ffmpeg&quot;.
$ ffmpeg -f jack -i ffmpeg -y out.wav
# Start the sample jack_metro readable client.
$ jack_metro -b 120 -d 0.2 -f 4000
# List the current JACK clients.
$ jack_lsp -c
system:capture_1
system:capture_2
system:playback_1
system:playback_2
ffmpeg:input_1
metro:120_bpm
# Connect metro to the ffmpeg writable client.
$ jack_connect metro:120_bpm ffmpeg:input_1
</pre></div>
<p>For more information read:
<a href="http://jackaudio.org/">http://jackaudio.org/</a>
</p>
<a name="Options-16"></a>
<h4 class="subsection">21.10.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-16" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-16" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
<a name="lavfi"></a>
<h3 class="section">21.11 lavfi<span class="pull-right"><a class="anchor hidden-xs" href="#lavfi" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lavfi" aria-hidden="true">TOC</a></span></h3>
<p>Libavfilter input virtual device.
</p>
<p>This input device reads data from the open output pads of a libavfilter
filtergraph.
</p>
<p>For each filtergraph open output, the input device will create a
corresponding stream which is mapped to the generated output. Currently
only video data is supported. The filtergraph is specified through the
option <samp>graph</samp>.
</p>
<a name="Options-17"></a>
<h4 class="subsection">21.11.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-17" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-17" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>graph</samp></dt>
<dd><p>Specify the filtergraph to use as input. Each video open output must be
labelled by a unique string of the form &quot;out<var>N</var>&quot;, where <var>N</var> is a
number starting from 0 corresponding to the mapped input stream
generated by the device.
The first unlabelled output is automatically assigned to the &quot;out0&quot;
label, but all the others need to be specified explicitly.
</p>
<p>The suffix &quot;+subcc&quot; can be appended to the output label to create an extra
stream with the closed captions packets attached to that output
(experimental; only for EIA-608 / CEA-708 for now).
The subcc streams are created after all the normal streams, in the order of
the corresponding stream.
For example, if there is &quot;out19+subcc&quot;, &quot;out7+subcc&quot; and up to &quot;out42&quot;, the
stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
</p>
<p>If not specified defaults to the filename specified for the input
device.
</p>
</dd>
<dt><samp>graph_file</samp></dt>
<dd><p>Set the filename of the filtergraph to be read and sent to the other
filters. Syntax of the filtergraph is the same as the one specified by
the option <var>graph</var>.
</p>
</dd>
<dt><samp>dumpgraph</samp></dt>
<dd><p>Dump graph to stderr.
</p>
</dd>
</dl>
<a name="Examples-10"></a>
<h4 class="subsection">21.11.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-10" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-10" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Create a color video stream and play it back with <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi -graph &quot;color=c=pink [out0]&quot; dummy
</pre></div>
</li><li> As the previous example, but use filename for specifying the graph
description, and omit the &quot;out0&quot; label:
<div class="example">
<pre class="example">ffplay -f lavfi color=c=pink
</pre></div>
</li><li> Create three different video test filtered sources and play them:
<div class="example">
<pre class="example">ffplay -f lavfi -graph &quot;testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]&quot; test3
</pre></div>
</li><li> Read an audio stream from a file using the amovie source and play it
back with <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi &quot;amovie=test.wav&quot;
</pre></div>
</li><li> Read an audio stream and a video stream and play it back with
<code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi &quot;movie=test.avi[out0];amovie=test.wav[out1]&quot;
</pre></div>
</li><li> Dump decoded frames to images and closed captions to a file (experimental):
<div class="example">
<pre class="example">ffmpeg -f lavfi -i &quot;movie=test.ts[out0+subcc]&quot; -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
</pre></div>
</li></ul>
<a name="libcdio"></a>
<h3 class="section">21.12 libcdio<span class="pull-right"><a class="anchor hidden-xs" href="#libcdio" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libcdio" aria-hidden="true">TOC</a></span></h3>
<p>Audio-CD input device based on libcdio.
</p>
<p>To enable this input device during configuration you need libcdio
installed on your system. It requires the configure option
<code>--enable-libcdio</code>.
</p>
<p>This device allows playing and grabbing from an Audio-CD.
</p>
<p>For example to copy with <code>ffmpeg</code> the entire Audio-CD in <samp>/dev/sr0</samp>,
you may run the command:
</p><div class="example">
<pre class="example">ffmpeg -f libcdio -i /dev/sr0 cd.wav
</pre></div>
<a name="Options-18"></a>
<h4 class="subsection">21.12.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-18" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-18" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>speed</samp></dt>
<dd><p>Set drive reading speed. Default value is 0.
</p>
<p>The speed is specified CD-ROM speed units. The speed is set through
the libcdio <code>cdio_cddap_speed_set</code> function. On many CD-ROM
drives, specifying a value too large will result in using the fastest
speed.
</p>
</dd>
<dt><samp>paranoia_mode</samp></dt>
<dd><p>Set paranoia recovery mode flags. It accepts one of the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>disable</samp>&rsquo;</dt>
<dt>&lsquo;<samp>verify</samp>&rsquo;</dt>
<dt>&lsquo;<samp>overlap</samp>&rsquo;</dt>
<dt>&lsquo;<samp>neverskip</samp>&rsquo;</dt>
<dt>&lsquo;<samp>full</samp>&rsquo;</dt>
</dl>
<p>Default value is &lsquo;<samp>disable</samp>&rsquo;.
</p>
<p>For more information about the available recovery modes, consult the
paranoia project documentation.
</p></dd>
</dl>
<a name="libdc1394"></a>
<h3 class="section">21.13 libdc1394<span class="pull-right"><a class="anchor hidden-xs" href="#libdc1394" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libdc1394" aria-hidden="true">TOC</a></span></h3>
<p>IIDC1394 input device, based on libdc1394 and libraw1394.
</p>
<p>Requires the configure option <code>--enable-libdc1394</code>.
</p>
<a name="openal"></a>
<h3 class="section">21.14 openal<span class="pull-right"><a class="anchor hidden-xs" href="#openal" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-openal" aria-hidden="true">TOC</a></span></h3>
<p>The OpenAL input device provides audio capture on all systems with a
working OpenAL 1.1 implementation.
</p>
<p>To enable this input device during configuration, you need OpenAL
headers and libraries installed on your system, and need to configure
FFmpeg with <code>--enable-openal</code>.
</p>
<p>OpenAL headers and libraries should be provided as part of your OpenAL
implementation, or as an additional download (an SDK). Depending on your
installation you may need to specify additional flags via the
<code>--extra-cflags</code> and <code>--extra-ldflags</code> for allowing the build
system to locate the OpenAL headers and libraries.
</p>
<p>An incomplete list of OpenAL implementations follows:
</p>
<dl compact="compact">
<dt><strong>Creative</strong></dt>
<dd><p>The official Windows implementation, providing hardware acceleration
with supported devices and software fallback.
See <a href="http://openal.org/">http://openal.org/</a>.
</p></dd>
<dt><strong>OpenAL Soft</strong></dt>
<dd><p>Portable, open source (LGPL) software implementation. Includes
backends for the most common sound APIs on the Windows, Linux,
Solaris, and BSD operating systems.
See <a href="http://kcat.strangesoft.net/openal.html">http://kcat.strangesoft.net/openal.html</a>.
</p></dd>
<dt><strong>Apple</strong></dt>
<dd><p>OpenAL is part of Core Audio, the official Mac OS X Audio interface.
See <a href="http://developer.apple.com/technologies/mac/audio-and-video.html">http://developer.apple.com/technologies/mac/audio-and-video.html</a>
</p></dd>
</dl>
<p>This device allows one to capture from an audio input device handled
through OpenAL.
</p>
<p>You need to specify the name of the device to capture in the provided
filename. If the empty string is provided, the device will
automatically select the default device. You can get the list of the
supported devices by using the option <var>list_devices</var>.
</p>
<a name="Options-19"></a>
<h4 class="subsection">21.14.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-19" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-19" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels in the captured audio. Only the values
<samp>1</samp> (monaural) and <samp>2</samp> (stereo) are currently supported.
Defaults to <samp>2</samp>.
</p>
</dd>
<dt><samp>sample_size</samp></dt>
<dd><p>Set the sample size (in bits) of the captured audio. Only the values
<samp>8</samp> and <samp>16</samp> are currently supported. Defaults to
<samp>16</samp>.
</p>
</dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate (in Hz) of the captured audio.
Defaults to <samp>44.1k</samp>.
</p>
</dd>
<dt><samp>list_devices</samp></dt>
<dd><p>If set to <samp>true</samp>, print a list of devices and exit.
Defaults to <samp>false</samp>.
</p>
</dd>
</dl>
<a name="Examples-11"></a>
<h4 class="subsection">21.14.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-11" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-11" aria-hidden="true">TOC</a></span></h4>
<p>Print the list of OpenAL supported devices and exit:
</p><div class="example">
<pre class="example">$ ffmpeg -list_devices true -f openal -i dummy out.ogg
</pre></div>
<p>Capture from the OpenAL device <samp>DR-BT101 via PulseAudio</samp>:
</p><div class="example">
<pre class="example">$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
</pre></div>
<p>Capture from the default device (note the empty string &rdquo; as filename):
</p><div class="example">
<pre class="example">$ ffmpeg -f openal -i '' out.ogg
</pre></div>
<p>Capture from two devices simultaneously, writing to two different files,
within the same <code>ffmpeg</code> command:
</p><div class="example">
<pre class="example">$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
</pre></div>
<p>Note: not all OpenAL implementations support multiple simultaneous capture -
try the latest OpenAL Soft if the above does not work.
</p>
<a name="oss"></a>
<h3 class="section">21.15 oss<span class="pull-right"><a class="anchor hidden-xs" href="#oss" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-oss" aria-hidden="true">TOC</a></span></h3>
<p>Open Sound System input device.
</p>
<p>The filename to provide to the input device is the device node
representing the OSS input device, and is usually set to
<samp>/dev/dsp</samp>.
</p>
<p>For example to grab from <samp>/dev/dsp</samp> using <code>ffmpeg</code> use the
command:
</p><div class="example">
<pre class="example">ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
</pre></div>
<p>For more information about OSS see:
<a href="http://manuals.opensound.com/usersguide/dsp.html">http://manuals.opensound.com/usersguide/dsp.html</a>
</p>
<a name="Options-20"></a>
<h4 class="subsection">21.15.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-20" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-20" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
<a name="pulse"></a>
<h3 class="section">21.16 pulse<span class="pull-right"><a class="anchor hidden-xs" href="#pulse" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pulse" aria-hidden="true">TOC</a></span></h3>
<p>PulseAudio input device.
</p>
<p>To enable this output device you need to configure FFmpeg with <code>--enable-libpulse</code>.
</p>
<p>The filename to provide to the input device is a source device or the
string &quot;default&quot;
</p>
<p>To list the PulseAudio source devices and their properties you can invoke
the command <code>pactl list sources</code>.
</p>
<p>More information about PulseAudio can be found on <a href="http://www.pulseaudio.org">http://www.pulseaudio.org</a>.
</p>
<a name="Options-21"></a>
<h4 class="subsection">21.16.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-21" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-21" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>server</samp></dt>
<dd><p>Connect to a specific PulseAudio server, specified by an IP address.
Default server is used when not provided.
</p>
</dd>
<dt><samp>name</samp></dt>
<dd><p>Specify the application name PulseAudio will use when showing active clients,
by default it is the <code>LIBAVFORMAT_IDENT</code> string.
</p>
</dd>
<dt><samp>stream_name</samp></dt>
<dd><p>Specify the stream name PulseAudio will use when showing active streams,
by default it is &quot;record&quot;.
</p>
</dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>Specify the samplerate in Hz, by default 48kHz is used.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Specify the channels in use, by default 2 (stereo) is set.
</p>
</dd>
<dt><samp>frame_size</samp></dt>
<dd><p>Specify the number of bytes per frame, by default it is set to 1024.
</p>
</dd>
<dt><samp>fragment_size</samp></dt>
<dd><p>Specify the minimal buffering fragment in PulseAudio, it will affect the
audio latency. By default it is unset.
</p>
</dd>
<dt><samp>wallclock</samp></dt>
<dd><p>Set the initial PTS using the current time. Default is 1.
</p>
</dd>
</dl>
<a name="Examples-12"></a>
<h4 class="subsection">21.16.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-12" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-12" aria-hidden="true">TOC</a></span></h4>
<p>Record a stream from default device:
</p><div class="example">
<pre class="example">ffmpeg -f pulse -i default /tmp/pulse.wav
</pre></div>
<a name="qtkit"></a>
<h3 class="section">21.17 qtkit<span class="pull-right"><a class="anchor hidden-xs" href="#qtkit" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-qtkit" aria-hidden="true">TOC</a></span></h3>
<p>QTKit input device.
</p>
<p>The filename passed as input is parsed to contain either a device name or index.
The device index can also be given by using -video_device_index.
A given device index will override any given device name.
If the desired device consists of numbers only, use -video_device_index to identify it.
The default device will be chosen if an empty string or the device name &quot;default&quot; is given.
The available devices can be enumerated by using -list_devices.
</p>
<div class="example">
<pre class="example">ffmpeg -f qtkit -i &quot;0&quot; out.mpg
</pre></div>
<div class="example">
<pre class="example">ffmpeg -f qtkit -video_device_index 0 -i &quot;&quot; out.mpg
</pre></div>
<div class="example">
<pre class="example">ffmpeg -f qtkit -i &quot;default&quot; out.mpg
</pre></div>
<div class="example">
<pre class="example">ffmpeg -f qtkit -list_devices true -i &quot;&quot;
</pre></div>
<a name="Options-22"></a>
<h4 class="subsection">21.17.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-22" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-22" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>frame_rate</samp></dt>
<dd><p>Set frame rate. Default is 30.
</p>
</dd>
<dt><samp>list_devices</samp></dt>
<dd><p>If set to <code>true</code>, print a list of devices and exit. Default is
<code>false</code>.
</p>
</dd>
<dt><samp>video_device_index</samp></dt>
<dd><p>Select the video device by index for devices with the same name (starts at 0).
</p>
</dd>
</dl>
<a name="sndio"></a>
<h3 class="section">21.18 sndio<span class="pull-right"><a class="anchor hidden-xs" href="#sndio" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sndio" aria-hidden="true">TOC</a></span></h3>
<p>sndio input device.
</p>
<p>To enable this input device during configuration you need libsndio
installed on your system.
</p>
<p>The filename to provide to the input device is the device node
representing the sndio input device, and is usually set to
<samp>/dev/audio0</samp>.
</p>
<p>For example to grab from <samp>/dev/audio0</samp> using <code>ffmpeg</code> use the
command:
</p><div class="example">
<pre class="example">ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
</pre></div>
<a name="Options-23"></a>
<h4 class="subsection">21.18.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-23" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-23" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
<a name="video4linux2_002c-v4l2"></a>
<h3 class="section">21.19 video4linux2, v4l2<span class="pull-right"><a class="anchor hidden-xs" href="#video4linux2_002c-v4l2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-video4linux2_002c-v4l2" aria-hidden="true">TOC</a></span></h3>
<p>Video4Linux2 input video device.
</p>
<p>&quot;v4l2&quot; can be used as alias for &quot;video4linux2&quot;.
</p>
<p>If FFmpeg is built with v4l-utils support (by using the
<code>--enable-libv4l2</code> configure option), it is possible to use it with the
<code>-use_libv4l2</code> input device option.
</p>
<p>The name of the device to grab is a file device node, usually Linux
systems tend to automatically create such nodes when the device
(e.g. an USB webcam) is plugged into the system, and has a name of the
kind <samp>/dev/video<var>N</var></samp>, where <var>N</var> is a number associated to
the device.
</p>
<p>Video4Linux2 devices usually support a limited set of
<var>width</var>x<var>height</var> sizes and frame rates. You can check which are
supported using <code>-list_formats all</code> for Video4Linux2 devices.
Some devices, like TV cards, support one or more standards. It is possible
to list all the supported standards using <code>-list_standards all</code>.
</p>
<p>The time base for the timestamps is 1 microsecond. Depending on the kernel
version and configuration, the timestamps may be derived from the real time
clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
boot time, unaffected by NTP or manual changes to the clock). The
<samp>-timestamps abs</samp> or <samp>-ts abs</samp> option can be used to force
conversion into the real time clock.
</p>
<p>Some usage examples of the video4linux2 device with <code>ffmpeg</code>
and <code>ffplay</code>:
</p><ul>
<li> List supported formats for a video4linux2 device:
<div class="example">
<pre class="example">ffplay -f video4linux2 -list_formats all /dev/video0
</pre></div>
</li><li> Grab and show the input of a video4linux2 device:
<div class="example">
<pre class="example">ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
</pre></div>
</li><li> Grab and record the input of a video4linux2 device, leave the
frame rate and size as previously set:
<div class="example">
<pre class="example">ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
</pre></div>
</li></ul>
<p>For more information about Video4Linux, check <a href="http://linuxtv.org/">http://linuxtv.org/</a>.
</p>
<a name="Options-24"></a>
<h4 class="subsection">21.19.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-24" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-24" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>standard</samp></dt>
<dd><p>Set the standard. Must be the name of a supported standard. To get a
list of the supported standards, use the <samp>list_standards</samp>
option.
</p>
</dd>
<dt><samp>channel</samp></dt>
<dd><p>Set the input channel number. Default to -1, which means using the
previously selected channel.
</p>
</dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the video frame size. The argument must be a string in the form
<var>WIDTH</var>x<var>HEIGHT</var> or a valid size abbreviation.
</p>
</dd>
<dt><samp>pixel_format</samp></dt>
<dd><p>Select the pixel format (only valid for raw video input).
</p>
</dd>
<dt><samp>input_format</samp></dt>
<dd><p>Set the preferred pixel format (for raw video) or a codec name.
This option allows one to select the input format, when several are
available.
</p>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>Set the preferred video frame rate.
</p>
</dd>
<dt><samp>list_formats</samp></dt>
<dd><p>List available formats (supported pixel formats, codecs, and frame
sizes) and exit.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>all</samp>&rsquo;</dt>
<dd><p>Show all available (compressed and non-compressed) formats.
</p>
</dd>
<dt>&lsquo;<samp>raw</samp>&rsquo;</dt>
<dd><p>Show only raw video (non-compressed) formats.
</p>
</dd>
<dt>&lsquo;<samp>compressed</samp>&rsquo;</dt>
<dd><p>Show only compressed formats.
</p></dd>
</dl>
</dd>
<dt><samp>list_standards</samp></dt>
<dd><p>List supported standards and exit.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>all</samp>&rsquo;</dt>
<dd><p>Show all supported standards.
</p></dd>
</dl>
</dd>
<dt><samp>timestamps, ts</samp></dt>
<dd><p>Set type of timestamps for grabbed frames.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>default</samp>&rsquo;</dt>
<dd><p>Use timestamps from the kernel.
</p>
</dd>
<dt>&lsquo;<samp>abs</samp>&rsquo;</dt>
<dd><p>Use absolute timestamps (wall clock).
</p>
</dd>
<dt>&lsquo;<samp>mono2abs</samp>&rsquo;</dt>
<dd><p>Force conversion from monotonic to absolute timestamps.
</p></dd>
</dl>
<p>Default value is <code>default</code>.
</p>
</dd>
<dt><samp>use_libv4l2</samp></dt>
<dd><p>Use libv4l2 (v4l-utils) conversion functions. Default is 0.
</p>
</dd>
</dl>
<a name="vfwcap"></a>
<h3 class="section">21.20 vfwcap<span class="pull-right"><a class="anchor hidden-xs" href="#vfwcap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vfwcap" aria-hidden="true">TOC</a></span></h3>
<p>VfW (Video for Windows) capture input device.
</p>
<p>The filename passed as input is the capture driver number, ranging from
0 to 9. You may use &quot;list&quot; as filename to print a list of drivers. Any
other filename will be interpreted as device number 0.
</p>
<a name="Options-25"></a>
<h4 class="subsection">21.20.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-25" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-25" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>video_size</samp></dt>
<dd><p>Set the video frame size.
</p>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code>ntsc</code>,
corresponding to a frame rate of <code>30000/1001</code>.
</p>
</dd>
</dl>
<a name="x11grab"></a>
<h3 class="section">21.21 x11grab<span class="pull-right"><a class="anchor hidden-xs" href="#x11grab" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-x11grab" aria-hidden="true">TOC</a></span></h3>
<p>X11 video input device.
</p>
<p>To enable this input device during configuration you need libxcb
installed on your system. It will be automatically detected during
configuration.
</p>
<p>Alternatively, the configure option <samp>--enable-x11grab</samp> exists
for legacy Xlib users.
</p>
<p>This device allows one to capture a region of an X11 display.
</p>
<p>The filename passed as input has the syntax:
</p><div class="example">
<pre class="example">[<var>hostname</var>]:<var>display_number</var>.<var>screen_number</var>[+<var>x_offset</var>,<var>y_offset</var>]
</pre></div>
<p><var>hostname</var>:<var>display_number</var>.<var>screen_number</var> specifies the
X11 display name of the screen to grab from. <var>hostname</var> can be
omitted, and defaults to &quot;localhost&quot;. The environment variable
<code>DISPLAY</code> contains the default display name.
</p>
<p><var>x_offset</var> and <var>y_offset</var> specify the offsets of the grabbed
area with respect to the top-left border of the X11 screen. They
default to 0.
</p>
<p>Check the X11 documentation (e.g. <code>man X</code>) for more detailed
information.
</p>
<p>Use the <code>xdpyinfo</code> program for getting basic information about
the properties of your X11 display (e.g. grep for &quot;name&quot; or
&quot;dimensions&quot;).
</p>
<p>For example to grab from <samp>:0.0</samp> using <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
<p>Grab at position <code>10,20</code>:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
</pre></div>
<a name="Options-26"></a>
<h4 class="subsection">21.21.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-26" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-26" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>draw_mouse</samp></dt>
<dd><p>Specify whether to draw the mouse pointer. A value of <code>0</code> specifies
not to draw the pointer. Default value is <code>1</code>.
</p>
</dd>
<dt><samp>follow_mouse</samp></dt>
<dd><p>Make the grabbed area follow the mouse. The argument can be
<code>centered</code> or a number of pixels <var>PIXELS</var>.
</p>
<p>When it is specified with &quot;centered&quot;, the grabbing region follows the mouse
pointer and keeps the pointer at the center of region; otherwise, the region
follows only when the mouse pointer reaches within <var>PIXELS</var> (greater than
zero) to the edge of region.
</p>
<p>For example:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
<p>To follow only when the mouse pointer reaches within 100 pixels to edge:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code>ntsc</code>,
corresponding to a frame rate of <code>30000/1001</code>.
</p>
</dd>
<dt><samp>show_region</samp></dt>
<dd><p>Show grabbed region on screen.
</p>
<p>If <var>show_region</var> is specified with <code>1</code>, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.
</p>
</dd>
<dt><samp>region_border</samp></dt>
<dd><p>Set the region border thickness if <samp>-show_region 1</samp> is used.
Range is 1 to 128 and default is 3 (XCB-based x11grab only).
</p>
<p>For example:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
</pre></div>
<p>With <var>follow_mouse</var>:
</p><div class="example">
<pre class="example">ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
</dd>
<dt><samp>video_size</samp></dt>
<dd><p>Set the video frame size. Default value is <code>vga</code>.
</p>
</dd>
<dt><samp>use_shm</samp></dt>
<dd><p>Use the MIT-SHM extension for shared memory. Default value is <code>1</code>.
It may be necessary to disable it for remote displays (legacy x11grab
only).
</p>
</dd>
<dt><samp>grab_x</samp></dt>
<dt><samp>grab_y</samp></dt>
<dd><p>Set the grabbing region coordinates. They are expressed as offset from
the top left corner of the X11 window and correspond to the
<var>x_offset</var> and <var>y_offset</var> parameters in the device name. The
default value for both options is 0.
</p></dd>
</dl>
<a name="Resampler-Options"></a>
<h2 class="chapter">22 Resampler Options<span class="pull-right"><a class="anchor hidden-xs" href="#Resampler-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Resampler-Options" aria-hidden="true">TOC</a></span></h2>
<p>The audio resampler supports the following named options.
</p>
<p>Options may be set by specifying -<var>option</var> <var>value</var> in the
FFmpeg tools, <var>option</var>=<var>value</var> for the aresample filter,
by setting the value explicitly in the
<code>SwrContext</code> options or using the <samp>libavutil/opt.h</samp> API for
programmatic use.
</p>
<dl compact="compact">
<dt><samp>ich, in_channel_count</samp></dt>
<dd><p>Set the number of input channels. Default value is 0. Setting this
value is not mandatory if the corresponding channel layout
<samp>in_channel_layout</samp> is set.
</p>
</dd>
<dt><samp>och, out_channel_count</samp></dt>
<dd><p>Set the number of output channels. Default value is 0. Setting this
value is not mandatory if the corresponding channel layout
<samp>out_channel_layout</samp> is set.
</p>
</dd>
<dt><samp>uch, used_channel_count</samp></dt>
<dd><p>Set the number of used input channels. Default value is 0. This option is
only used for special remapping.
</p>
</dd>
<dt><samp>isr, in_sample_rate</samp></dt>
<dd><p>Set the input sample rate. Default value is 0.
</p>
</dd>
<dt><samp>osr, out_sample_rate</samp></dt>
<dd><p>Set the output sample rate. Default value is 0.
</p>
</dd>
<dt><samp>isf, in_sample_fmt</samp></dt>
<dd><p>Specify the input sample format. It is set by default to <code>none</code>.
</p>
</dd>
<dt><samp>osf, out_sample_fmt</samp></dt>
<dd><p>Specify the output sample format. It is set by default to <code>none</code>.
</p>
</dd>
<dt><samp>tsf, internal_sample_fmt</samp></dt>
<dd><p>Set the internal sample format. Default value is <code>none</code>.
This will automatically be chosen when it is not explicitly set.
</p>
</dd>
<dt><samp>icl, in_channel_layout</samp></dt>
<dt><samp>ocl, out_channel_layout</samp></dt>
<dd><p>Set the input/output channel layout.
</p>
<p>See <a href="ffmpeg-utils.html#channel-layout-syntax">(ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual</a>
for the required syntax.
</p>
</dd>
<dt><samp>clev, center_mix_level</samp></dt>
<dd><p>Set the center mix level. It is a value expressed in deciBel, and must be
in the interval [-32,32].
</p>
</dd>
<dt><samp>slev, surround_mix_level</samp></dt>
<dd><p>Set the surround mix level. It is a value expressed in deciBel, and must
be in the interval [-32,32].
</p>
</dd>
<dt><samp>lfe_mix_level</samp></dt>
<dd><p>Set LFE mix into non LFE level. It is used when there is a LFE input but no
LFE output. It is a value expressed in deciBel, and must
be in the interval [-32,32].
</p>
</dd>
<dt><samp>rmvol, rematrix_volume</samp></dt>
<dd><p>Set rematrix volume. Default value is 1.0.
</p>
</dd>
<dt><samp>rematrix_maxval</samp></dt>
<dd><p>Set maximum output value for rematrixing.
This can be used to prevent clipping vs. preventing volume reduction.
A value of 1.0 prevents clipping.
</p>
</dd>
<dt><samp>flags, swr_flags</samp></dt>
<dd><p>Set flags used by the converter. Default value is 0.
</p>
<p>It supports the following individual flags:
</p><dl compact="compact">
<dt><samp>res</samp></dt>
<dd><p>force resampling, this flag forces resampling to be used even when the
input and output sample rates match.
</p></dd>
</dl>
</dd>
<dt><samp>dither_scale</samp></dt>
<dd><p>Set the dither scale. Default value is 1.
</p>
</dd>
<dt><samp>dither_method</samp></dt>
<dd><p>Set dither method. Default value is 0.
</p>
<p>Supported values:
</p><dl compact="compact">
<dt>&lsquo;<samp>rectangular</samp>&rsquo;</dt>
<dd><p>select rectangular dither
</p></dd>
<dt>&lsquo;<samp>triangular</samp>&rsquo;</dt>
<dd><p>select triangular dither
</p></dd>
<dt>&lsquo;<samp>triangular_hp</samp>&rsquo;</dt>
<dd><p>select triangular dither with high pass
</p></dd>
<dt>&lsquo;<samp>lipshitz</samp>&rsquo;</dt>
<dd><p>select Lipshitz noise shaping dither.
</p></dd>
<dt>&lsquo;<samp>shibata</samp>&rsquo;</dt>
<dd><p>select Shibata noise shaping dither.
</p></dd>
<dt>&lsquo;<samp>low_shibata</samp>&rsquo;</dt>
<dd><p>select low Shibata noise shaping dither.
</p></dd>
<dt>&lsquo;<samp>high_shibata</samp>&rsquo;</dt>
<dd><p>select high Shibata noise shaping dither.
</p></dd>
<dt>&lsquo;<samp>f_weighted</samp>&rsquo;</dt>
<dd><p>select f-weighted noise shaping dither
</p></dd>
<dt>&lsquo;<samp>modified_e_weighted</samp>&rsquo;</dt>
<dd><p>select modified-e-weighted noise shaping dither
</p></dd>
<dt>&lsquo;<samp>improved_e_weighted</samp>&rsquo;</dt>
<dd><p>select improved-e-weighted noise shaping dither
</p>
</dd>
</dl>
</dd>
<dt><samp>resampler</samp></dt>
<dd><p>Set resampling engine. Default value is swr.
</p>
<p>Supported values:
</p><dl compact="compact">
<dt>&lsquo;<samp>swr</samp>&rsquo;</dt>
<dd><p>select the native SW Resampler; filter options precision and cheby are not
applicable in this case.
</p></dd>
<dt>&lsquo;<samp>soxr</samp>&rsquo;</dt>
<dd><p>select the SoX Resampler (where available); compensation, and filter options
filter_size, phase_shift, exact_rational, filter_type &amp; kaiser_beta, are not
applicable in this case.
</p></dd>
</dl>
</dd>
<dt><samp>filter_size</samp></dt>
<dd><p>For swr only, set resampling filter size, default value is 32.
</p>
</dd>
<dt><samp>phase_shift</samp></dt>
<dd><p>For swr only, set resampling phase shift, default value is 10, and must be in
the interval [0,30].
</p>
</dd>
<dt><samp>linear_interp</samp></dt>
<dd><p>Use linear interpolation if set to 1, default value is 0.
</p>
</dd>
<dt><samp>exact_rational</samp></dt>
<dd><p>For swr only, when enabled, try to use exact phase_count based on input and
output sample rate. However, if it is larger than <code>1 &lt;&lt; phase_shift</code>,
the phase_count will be <code>1 &lt;&lt; phase_shift</code> as fallback. Default is disabled.
</p>
</dd>
<dt><samp>cutoff</samp></dt>
<dd><p>Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr
(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz).
</p>
</dd>
<dt><samp>precision</samp></dt>
<dd><p>For soxr only, the precision in bits to which the resampled signal will be
calculated. The default value of 20 (which, with suitable dithering, is
appropriate for a destination bit-depth of 16) gives SoX&rsquo;s &rsquo;High Quality&rsquo;; a
value of 28 gives SoX&rsquo;s &rsquo;Very High Quality&rsquo;.
</p>
</dd>
<dt><samp>cheby</samp></dt>
<dd><p>For soxr only, selects passband rolloff none (Chebyshev) &amp; higher-precision
approximation for &rsquo;irrational&rsquo; ratios. Default value is 0.
</p>
</dd>
<dt><samp>async</samp></dt>
<dd><p>For swr only, simple 1 parameter audio sync to timestamps using stretching,
squeezing, filling and trimming. Setting this to 1 will enable filling and
trimming, larger values represent the maximum amount in samples that the data
may be stretched or squeezed for each second.
Default value is 0, thus no compensation is applied to make the samples match
the audio timestamps.
</p>
</dd>
<dt><samp>first_pts</samp></dt>
<dd><p>For swr only, assume the first pts should be this value. The time unit is 1 / sample rate.
This allows for padding/trimming at the start of stream. By default, no
assumption is made about the first frame&rsquo;s expected pts, so no padding or
trimming is done. For example, this could be set to 0 to pad the beginning with
silence if an audio stream starts after the video stream or to trim any samples
with a negative pts due to encoder delay.
</p>
</dd>
<dt><samp>min_comp</samp></dt>
<dd><p>For swr only, set the minimum difference between timestamps and audio data (in
seconds) to trigger stretching/squeezing/filling or trimming of the
data to make it match the timestamps. The default is that
stretching/squeezing/filling and trimming is disabled
(<samp>min_comp</samp> = <code>FLT_MAX</code>).
</p>
</dd>
<dt><samp>min_hard_comp</samp></dt>
<dd><p>For swr only, set the minimum difference between timestamps and audio data (in
seconds) to trigger adding/dropping samples to make it match the
timestamps. This option effectively is a threshold to select between
hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
all compensation is by default disabled through <samp>min_comp</samp>.
The default is 0.1.
</p>
</dd>
<dt><samp>comp_duration</samp></dt>
<dd><p>For swr only, set duration (in seconds) over which data is stretched/squeezed
to make it match the timestamps. Must be a non-negative double float value,
default value is 1.0.
</p>
</dd>
<dt><samp>max_soft_comp</samp></dt>
<dd><p>For swr only, set maximum factor by which data is stretched/squeezed to make it
match the timestamps. Must be a non-negative double float value, default value
is 0.
</p>
</dd>
<dt><samp>matrix_encoding</samp></dt>
<dd><p>Select matrixed stereo encoding.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>select none
</p></dd>
<dt>&lsquo;<samp>dolby</samp>&rsquo;</dt>
<dd><p>select Dolby
</p></dd>
<dt>&lsquo;<samp>dplii</samp>&rsquo;</dt>
<dd><p>select Dolby Pro Logic II
</p></dd>
</dl>
<p>Default value is <code>none</code>.
</p>
</dd>
<dt><samp>filter_type</samp></dt>
<dd><p>For swr only, select resampling filter type. This only affects resampling
operations.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>cubic</samp>&rsquo;</dt>
<dd><p>select cubic
</p></dd>
<dt>&lsquo;<samp>blackman_nuttall</samp>&rsquo;</dt>
<dd><p>select Blackman Nuttall windowed sinc
</p></dd>
<dt>&lsquo;<samp>kaiser</samp>&rsquo;</dt>
<dd><p>select Kaiser windowed sinc
</p></dd>
</dl>
</dd>
<dt><samp>kaiser_beta</samp></dt>
<dd><p>For swr only, set Kaiser window beta value. Must be a double float value in the
interval [2,16], default value is 9.
</p>
</dd>
<dt><samp>output_sample_bits</samp></dt>
<dd><p>For swr only, set number of used output sample bits for dithering. Must be an integer in the
interval [0,64], default value is 0, which means it&rsquo;s not used.
</p>
</dd>
</dl>
<a name="scaler_005foptions"></a><a name="Scaler-Options"></a>
<h2 class="chapter">23 Scaler Options<span class="pull-right"><a class="anchor hidden-xs" href="#Scaler-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Scaler-Options" aria-hidden="true">TOC</a></span></h2>
<p>The video scaler supports the following named options.
</p>
<p>Options may be set by specifying -<var>option</var> <var>value</var> in the
FFmpeg tools. For programmatic use, they can be set explicitly in the
<code>SwsContext</code> options or through the <samp>libavutil/opt.h</samp> API.
</p>
<dl compact="compact">
<dd>
<a name="sws_005fflags"></a></dd>
<dt><samp>sws_flags</samp></dt>
<dd><p>Set the scaler flags. This is also used to set the scaling
algorithm. Only a single algorithm should be selected.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>fast_bilinear</samp>&rsquo;</dt>
<dd><p>Select fast bilinear scaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>bilinear</samp>&rsquo;</dt>
<dd><p>Select bilinear scaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>bicubic</samp>&rsquo;</dt>
<dd><p>Select bicubic scaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>experimental</samp>&rsquo;</dt>
<dd><p>Select experimental scaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>neighbor</samp>&rsquo;</dt>
<dd><p>Select nearest neighbor rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>area</samp>&rsquo;</dt>
<dd><p>Select averaging area rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>bicublin</samp>&rsquo;</dt>
<dd><p>Select bicubic scaling algorithm for the luma component, bilinear for
chroma components.
</p>
</dd>
<dt>&lsquo;<samp>gauss</samp>&rsquo;</dt>
<dd><p>Select Gaussian rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>sinc</samp>&rsquo;</dt>
<dd><p>Select sinc rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>lanczos</samp>&rsquo;</dt>
<dd><p>Select Lanczos rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>spline</samp>&rsquo;</dt>
<dd><p>Select natural bicubic spline rescaling algorithm.
</p>
</dd>
<dt>&lsquo;<samp>print_info</samp>&rsquo;</dt>
<dd><p>Enable printing/debug logging.
</p>
</dd>
<dt>&lsquo;<samp>accurate_rnd</samp>&rsquo;</dt>
<dd><p>Enable accurate rounding.
</p>
</dd>
<dt>&lsquo;<samp>full_chroma_int</samp>&rsquo;</dt>
<dd><p>Enable full chroma interpolation.
</p>
</dd>
<dt>&lsquo;<samp>full_chroma_inp</samp>&rsquo;</dt>
<dd><p>Select full chroma input.
</p>
</dd>
<dt>&lsquo;<samp>bitexact</samp>&rsquo;</dt>
<dd><p>Enable bitexact output.
</p></dd>
</dl>
</dd>
<dt><samp>srcw</samp></dt>
<dd><p>Set source width.
</p>
</dd>
<dt><samp>srch</samp></dt>
<dd><p>Set source height.
</p>
</dd>
<dt><samp>dstw</samp></dt>
<dd><p>Set destination width.
</p>
</dd>
<dt><samp>dsth</samp></dt>
<dd><p>Set destination height.
</p>
</dd>
<dt><samp>src_format</samp></dt>
<dd><p>Set source pixel format (must be expressed as an integer).
</p>
</dd>
<dt><samp>dst_format</samp></dt>
<dd><p>Set destination pixel format (must be expressed as an integer).
</p>
</dd>
<dt><samp>src_range</samp></dt>
<dd><p>Select source range.
</p>
</dd>
<dt><samp>dst_range</samp></dt>
<dd><p>Select destination range.
</p>
<a name="sws_005fparams"></a></dd>
<dt><samp>param0, param1</samp></dt>
<dd><p>Set scaling algorithm parameters. The specified values are specific of
some scaling algorithms and ignored by others. The specified values
are floating point number values.
</p>
</dd>
<dt><samp>sws_dither</samp></dt>
<dd><p>Set the dithering algorithm. Accepts one of the following
values. Default value is &lsquo;<samp>auto</samp>&rsquo;.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>automatic choice
</p>
</dd>
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>no dithering
</p>
</dd>
<dt>&lsquo;<samp>bayer</samp>&rsquo;</dt>
<dd><p>bayer dither
</p>
</dd>
<dt>&lsquo;<samp>ed</samp>&rsquo;</dt>
<dd><p>error diffusion dither
</p>
</dd>
<dt>&lsquo;<samp>a_dither</samp>&rsquo;</dt>
<dd><p>arithmetic dither, based using addition
</p>
</dd>
<dt>&lsquo;<samp>x_dither</samp>&rsquo;</dt>
<dd><p>arithmetic dither, based using xor (more random/less apparent patterning that
a_dither).
</p>
</dd>
</dl>
</dd>
<dt><samp>alphablend</samp></dt>
<dd><p>Set the alpha blending to use when the input has alpha but the output does not.
Default value is &lsquo;<samp>none</samp>&rsquo;.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>uniform_color</samp>&rsquo;</dt>
<dd><p>Blend onto a uniform background color
</p>
</dd>
<dt>&lsquo;<samp>checkerboard</samp>&rsquo;</dt>
<dd><p>Blend onto a checkerboard
</p>
</dd>
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No blending
</p>
</dd>
</dl>
</dd>
</dl>
<a name="Filtering-Introduction"></a>
<h2 class="chapter">24 Filtering Introduction<span class="pull-right"><a class="anchor hidden-xs" href="#Filtering-Introduction" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Filtering-Introduction" aria-hidden="true">TOC</a></span></h2>
<p>Filtering in FFmpeg is enabled through the libavfilter library.
</p>
<p>In libavfilter, a filter can have multiple inputs and multiple
outputs.
To illustrate the sorts of things that are possible, we consider the
following filtergraph.
</p>
<pre class="verbatim"> [main]
input --&gt; split ---------------------&gt; overlay --&gt; output
| ^
|[tmp] [flip]|
+-----&gt; crop --&gt; vflip -------+
</pre>
<p>This filtergraph splits the input stream in two streams, then sends one
stream through the crop filter and the vflip filter, before merging it
back with the other stream by overlaying it on top. You can use the
following command to achieve this:
</p>
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf &quot;split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2&quot; OUTPUT
</pre></div>
<p>The result will be that the top half of the video is mirrored
onto the bottom half of the output video.
</p>
<p>Filters in the same linear chain are separated by commas, and distinct
linear chains of filters are separated by semicolons. In our example,
<var>crop,vflip</var> are in one linear chain, <var>split</var> and
<var>overlay</var> are separately in another. The points where the linear
chains join are labelled by names enclosed in square brackets. In the
example, the split filter generates two outputs that are associated to
the labels <var>[main]</var> and <var>[tmp]</var>.
</p>
<p>The stream sent to the second output of <var>split</var>, labelled as
<var>[tmp]</var>, is processed through the <var>crop</var> filter, which crops
away the lower half part of the video, and then vertically flipped. The
<var>overlay</var> filter takes in input the first unchanged output of the
split filter (which was labelled as <var>[main]</var>), and overlay on its
lower half the output generated by the <var>crop,vflip</var> filterchain.
</p>
<p>Some filters take in input a list of parameters: they are specified
after the filter name and an equal sign, and are separated from each other
by a colon.
</p>
<p>There exist so-called <var>source filters</var> that do not have an
audio/video input, and <var>sink filters</var> that will not have audio/video
output.
</p>
<a name="graph2dot"></a>
<h2 class="chapter">25 graph2dot<span class="pull-right"><a class="anchor hidden-xs" href="#graph2dot" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-graph2dot" aria-hidden="true">TOC</a></span></h2>
<p>The <samp>graph2dot</samp> program included in the FFmpeg <samp>tools</samp>
directory can be used to parse a filtergraph description and issue a
corresponding textual representation in the dot language.
</p>
<p>Invoke the command:
</p><div class="example">
<pre class="example">graph2dot -h
</pre></div>
<p>to see how to use <samp>graph2dot</samp>.
</p>
<p>You can then pass the dot description to the <samp>dot</samp> program (from
the graphviz suite of programs) and obtain a graphical representation
of the filtergraph.
</p>
<p>For example the sequence of commands:
</p><div class="example">
<pre class="example">echo <var>GRAPH_DESCRIPTION</var> | \
tools/graph2dot -o graph.tmp &amp;&amp; \
dot -Tpng graph.tmp -o graph.png &amp;&amp; \
display graph.png
</pre></div>
<p>can be used to create and display an image representing the graph
described by the <var>GRAPH_DESCRIPTION</var> string. Note that this string must be
a complete self-contained graph, with its inputs and outputs explicitly defined.
For example if your command line is of the form:
</p><div class="example">
<pre class="example">ffmpeg -i infile -vf scale=640:360 outfile
</pre></div>
<p>your <var>GRAPH_DESCRIPTION</var> string will need to be of the form:
</p><div class="example">
<pre class="example">nullsrc,scale=640:360,nullsink
</pre></div>
<p>you may also need to set the <var>nullsrc</var> parameters and add a <var>format</var>
filter in order to simulate a specific input file.
</p>
<a name="Filtergraph-description"></a>
<h2 class="chapter">26 Filtergraph description<span class="pull-right"><a class="anchor hidden-xs" href="#Filtergraph-description" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Filtergraph-description" aria-hidden="true">TOC</a></span></h2>
<p>A filtergraph is a directed graph of connected filters. It can contain
cycles, and there can be multiple links between a pair of
filters. Each link has one input pad on one side connecting it to one
filter from which it takes its input, and one output pad on the other
side connecting it to one filter accepting its output.
</p>
<p>Each filter in a filtergraph is an instance of a filter class
registered in the application, which defines the features and the
number of input and output pads of the filter.
</p>
<p>A filter with no input pads is called a &quot;source&quot;, and a filter with no
output pads is called a &quot;sink&quot;.
</p>
<a name="Filtergraph-syntax"></a><a name="Filtergraph-syntax-1"></a>
<h3 class="section">26.1 Filtergraph syntax<span class="pull-right"><a class="anchor hidden-xs" href="#Filtergraph-syntax-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Filtergraph-syntax-1" aria-hidden="true">TOC</a></span></h3>
<p>A filtergraph has a textual representation, which is recognized by the
<samp>-filter</samp>/<samp>-vf</samp>/<samp>-af</samp> and
<samp>-filter_complex</samp> options in <code>ffmpeg</code> and
<samp>-vf</samp>/<samp>-af</samp> in <code>ffplay</code>, and by the
<code>avfilter_graph_parse_ptr()</code> function defined in
<samp>libavfilter/avfilter.h</samp>.
</p>
<p>A filterchain consists of a sequence of connected filters, each one
connected to the previous one in the sequence. A filterchain is
represented by a list of &quot;,&quot;-separated filter descriptions.
</p>
<p>A filtergraph consists of a sequence of filterchains. A sequence of
filterchains is represented by a list of &quot;;&quot;-separated filterchain
descriptions.
</p>
<p>A filter is represented by a string of the form:
[<var>in_link_1</var>]...[<var>in_link_N</var>]<var>filter_name</var>=<var>arguments</var>[<var>out_link_1</var>]...[<var>out_link_M</var>]
</p>
<p><var>filter_name</var> is the name of the filter class of which the
described filter is an instance of, and has to be the name of one of
the filter classes registered in the program.
The name of the filter class is optionally followed by a string
&quot;=<var>arguments</var>&quot;.
</p>
<p><var>arguments</var> is a string which contains the parameters used to
initialize the filter instance. It may have one of two forms:
</p><ul>
<li> A &rsquo;:&rsquo;-separated list of <var>key=value</var> pairs.
</li><li> A &rsquo;:&rsquo;-separated list of <var>value</var>. In this case, the keys are assumed to be
the option names in the order they are declared. E.g. the <code>fade</code> filter
declares three options in this order &ndash; <samp>type</samp>, <samp>start_frame</samp> and
<samp>nb_frames</samp>. Then the parameter list <var>in:0:30</var> means that the value
<var>in</var> is assigned to the option <samp>type</samp>, <var>0</var> to
<samp>start_frame</samp> and <var>30</var> to <samp>nb_frames</samp>.
</li><li> A &rsquo;:&rsquo;-separated list of mixed direct <var>value</var> and long <var>key=value</var>
pairs. The direct <var>value</var> must precede the <var>key=value</var> pairs, and
follow the same constraints order of the previous point. The following
<var>key=value</var> pairs can be set in any preferred order.
</li></ul>
<p>If the option value itself is a list of items (e.g. the <code>format</code> filter
takes a list of pixel formats), the items in the list are usually separated by
&lsquo;<samp>|</samp>&rsquo;.
</p>
<p>The list of arguments can be quoted using the character &lsquo;<samp>'</samp>&rsquo; as initial
and ending mark, and the character &lsquo;<samp>\</samp>&rsquo; for escaping the characters
within the quoted text; otherwise the argument string is considered
terminated when the next special character (belonging to the set
&lsquo;<samp>[]=;,</samp>&rsquo;) is encountered.
</p>
<p>The name and arguments of the filter are optionally preceded and
followed by a list of link labels.
A link label allows one to name a link and associate it to a filter output
or input pad. The preceding labels <var>in_link_1</var>
... <var>in_link_N</var>, are associated to the filter input pads,
the following labels <var>out_link_1</var> ... <var>out_link_M</var>, are
associated to the output pads.
</p>
<p>When two link labels with the same name are found in the
filtergraph, a link between the corresponding input and output pad is
created.
</p>
<p>If an output pad is not labelled, it is linked by default to the first
unlabelled input pad of the next filter in the filterchain.
For example in the filterchain
</p><div class="example">
<pre class="example">nullsrc, split[L1], [L2]overlay, nullsink
</pre></div>
<p>the split filter instance has two output pads, and the overlay filter
instance two input pads. The first output pad of split is labelled
&quot;L1&quot;, the first input pad of overlay is labelled &quot;L2&quot;, and the second
output pad of split is linked to the second input pad of overlay,
which are both unlabelled.
</p>
<p>In a filter description, if the input label of the first filter is not
specified, &quot;in&quot; is assumed; if the output label of the last filter is not
specified, &quot;out&quot; is assumed.
</p>
<p>In a complete filterchain all the unlabelled filter input and output
pads must be connected. A filtergraph is considered valid if all the
filter input and output pads of all the filterchains are connected.
</p>
<p>Libavfilter will automatically insert <a href="#scale">scale</a> filters where format
conversion is required. It is possible to specify swscale flags
for those automatically inserted scalers by prepending
<code>sws_flags=<var>flags</var>;</code>
to the filtergraph description.
</p>
<p>Here is a BNF description of the filtergraph syntax:
</p><div class="example">
<pre class="example"><var>NAME</var> ::= sequence of alphanumeric characters and '_'
<var>LINKLABEL</var> ::= &quot;[&quot; <var>NAME</var> &quot;]&quot;
<var>LINKLABELS</var> ::= <var>LINKLABEL</var> [<var>LINKLABELS</var>]
<var>FILTER_ARGUMENTS</var> ::= sequence of chars (possibly quoted)
<var>FILTER</var> ::= [<var>LINKLABELS</var>] <var>NAME</var> [&quot;=&quot; <var>FILTER_ARGUMENTS</var>] [<var>LINKLABELS</var>]
<var>FILTERCHAIN</var> ::= <var>FILTER</var> [,<var>FILTERCHAIN</var>]
<var>FILTERGRAPH</var> ::= [sws_flags=<var>flags</var>;] <var>FILTERCHAIN</var> [;<var>FILTERGRAPH</var>]
</pre></div>
<a name="Notes-on-filtergraph-escaping"></a>
<h3 class="section">26.2 Notes on filtergraph escaping<span class="pull-right"><a class="anchor hidden-xs" href="#Notes-on-filtergraph-escaping" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Notes-on-filtergraph-escaping" aria-hidden="true">TOC</a></span></h3>
<p>Filtergraph description composition entails several levels of
escaping. See <a href="ffmpeg-utils.html#quoting_005fand_005fescaping">(ffmpeg-utils)the &quot;Quoting and escaping&quot;
section in the ffmpeg-utils(1) manual</a> for more
information about the employed escaping procedure.
</p>
<p>A first level escaping affects the content of each filter option
value, which may contain the special character <code>:</code> used to
separate values, or one of the escaping characters <code>\'</code>.
</p>
<p>A second level escaping affects the whole filter description, which
may contain the escaping characters <code>\'</code> or the special
characters <code>[],;</code> used by the filtergraph description.
</p>
<p>Finally, when you specify a filtergraph on a shell commandline, you
need to perform a third level escaping for the shell special
characters contained within it.
</p>
<p>For example, consider the following string to be embedded in
the <a href="#drawtext">drawtext</a> filter description <samp>text</samp> value:
</p><div class="example">
<pre class="example">this is a 'string': may contain one, or more, special characters
</pre></div>
<p>This string contains the <code>'</code> special escaping character, and the
<code>:</code> special character, so it needs to be escaped in this way:
</p><div class="example">
<pre class="example">text=this is a \'string\'\: may contain one, or more, special characters
</pre></div>
<p>A second level of escaping is required when embedding the filter
description in a filtergraph description, in order to escape all the
filtergraph special characters. Thus the example above becomes:
</p><div class="example">
<pre class="example">drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
</pre></div>
<p>(note that in addition to the <code>\'</code> escaping special characters,
also <code>,</code> needs to be escaped).
</p>
<p>Finally an additional level of escaping is needed when writing the
filtergraph description in a shell command, which depends on the
escaping rules of the adopted shell. For example, assuming that
<code>\</code> is special and needs to be escaped with another <code>\</code>, the
previous string will finally result in:
</p><div class="example">
<pre class="example">-vf &quot;drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters&quot;
</pre></div>
<a name="Timeline-editing"></a>
<h2 class="chapter">27 Timeline editing<span class="pull-right"><a class="anchor hidden-xs" href="#Timeline-editing" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Timeline-editing" aria-hidden="true">TOC</a></span></h2>
<p>Some filters support a generic <samp>enable</samp> option. For the filters
supporting timeline editing, this option can be set to an expression which is
evaluated before sending a frame to the filter. If the evaluation is non-zero,
the filter will be enabled, otherwise the frame will be sent unchanged to the
next filter in the filtergraph.
</p>
<p>The expression accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>t</samp>&rsquo;</dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt>&lsquo;<samp>n</samp>&rsquo;</dt>
<dd><p>sequential number of the input frame, starting from 0
</p>
</dd>
<dt>&lsquo;<samp>pos</samp>&rsquo;</dt>
<dd><p>the position in the file of the input frame, NAN if unknown
</p>
</dd>
<dt>&lsquo;<samp>w</samp>&rsquo;</dt>
<dt>&lsquo;<samp>h</samp>&rsquo;</dt>
<dd><p>width and height of the input frame if video
</p></dd>
</dl>
<p>Additionally, these filters support an <samp>enable</samp> command that can be used
to re-define the expression.
</p>
<p>Like any other filtering option, the <samp>enable</samp> option follows the same
rules.
</p>
<p>For example, to enable a blur filter (<a href="#smartblur">smartblur</a>) from 10 seconds to 3
minutes, and a <a href="#curves">curves</a> filter starting at 3 seconds:
</p><div class="example">
<pre class="example">smartblur = enable='between(t,10,3*60)',
curves = enable='gte(t,3)' : preset=cross_process
</pre></div>
<a name="Audio-Filters"></a>
<h2 class="chapter">28 Audio Filters<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Filters" aria-hidden="true">TOC</a></span></h2>
<p>When you configure your FFmpeg build, you can disable any of the
existing filters using <code>--disable-filters</code>.
The configure output will show the audio filters included in your
build.
</p>
<p>Below is a description of the currently available audio filters.
</p>
<a name="acompressor"></a>
<h3 class="section">28.1 acompressor<span class="pull-right"><a class="anchor hidden-xs" href="#acompressor" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acompressor" aria-hidden="true">TOC</a></span></h3>
<p>A compressor is mainly used to reduce the dynamic range of a signal.
Especially modern music is mostly compressed at a high ratio to
improve the overall loudness. It&rsquo;s done to get the highest attention
of a listener, &quot;fatten&quot; the sound and bring more &quot;power&quot; to the track.
If a signal is compressed too much it may sound dull or &quot;dead&quot;
afterwards or it may start to &quot;pump&quot; (which could be a powerful effect
but can also destroy a track completely).
The right compression is the key to reach a professional sound and is
the high art of mixing and mastering. Because of its complex settings
it may take a long time to get the right feeling for this kind of effect.
</p>
<p>Compression is done by detecting the volume above a chosen level
<code>threshold</code> and dividing it by the factor set with <code>ratio</code>.
So if you set the threshold to -12dB and your signal reaches -6dB a ratio
of 2:1 will result in a signal at -9dB. Because an exact manipulation of
the signal would cause distortion of the waveform the reduction can be
levelled over the time. This is done by setting &quot;Attack&quot; and &quot;Release&quot;.
<code>attack</code> determines how long the signal has to rise above the threshold
before any reduction will occur and <code>release</code> sets the time the signal
has to fall below the threshold to reduce the reduction again. Shorter signals
than the chosen attack time will be left untouched.
The overall reduction of the signal can be made up afterwards with the
<code>makeup</code> setting. So compressing the peaks of a signal about 6dB and
raising the makeup to this level results in a signal twice as loud than the
source. To gain a softer entry in the compression the <code>knee</code> flattens the
hard edge at the threshold in the range of the chosen decibels.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>If a signal of second stream rises above this level it will affect the gain
reduction of the first stream.
By default it is 0.125. Range is between 0.00097563 and 1.
</p>
</dd>
<dt><samp>ratio</samp></dt>
<dd><p>Set a ratio by which the signal is reduced. 1:2 means that if the level
rose 4dB above the threshold, it will be only 2dB above after the reduction.
Default is 2. Range is between 1 and 20.
</p>
</dd>
<dt><samp>attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction starts. Default is 20. Range is between 0.01 and 2000.
</p>
</dd>
<dt><samp>release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before
reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
</p>
</dd>
<dt><samp>makeup</samp></dt>
<dd><p>Set the amount by how much signal will be amplified after processing.
Default is 2. Range is from 1 and 64.
</p>
</dd>
<dt><samp>knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.82843. Range is between 1 and 8.
</p>
</dd>
<dt><samp>link</samp></dt>
<dd><p>Choose if the <code>average</code> level between all channels of input stream
or the louder(<code>maximum</code>) channel of input stream affects the
reduction. Default is <code>average</code>.
</p>
</dd>
<dt><samp>detection</samp></dt>
<dd><p>Should the exact signal be taken in case of <code>peak</code> or an RMS one in case
of <code>rms</code>. Default is <code>rms</code> which is mostly smoother.
</p>
</dd>
<dt><samp>mix</samp></dt>
<dd><p>How much to use compressed signal in output. Default is 1.
Range is between 0 and 1.
</p></dd>
</dl>
<a name="acrossfade"></a>
<h3 class="section">28.2 acrossfade<span class="pull-right"><a class="anchor hidden-xs" href="#acrossfade" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acrossfade" aria-hidden="true">TOC</a></span></h3>
<p>Apply cross fade from one input audio stream to another input audio stream.
The cross fade is applied for specified duration near the end of first stream.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>nb_samples, ns</samp></dt>
<dd><p>Specify the number of samples for which the cross fade effect has to last.
At the end of the cross fade effect the first input audio will be completely
silent. Default is 44100.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Specify the duration of the cross fade effect. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
By default the duration is determined by <var>nb_samples</var>.
If set this option is used instead of <var>nb_samples</var>.
</p>
</dd>
<dt><samp>overlap, o</samp></dt>
<dd><p>Should first stream end overlap with second stream start. Default is enabled.
</p>
</dd>
<dt><samp>curve1</samp></dt>
<dd><p>Set curve for cross fade transition for first stream.
</p>
</dd>
<dt><samp>curve2</samp></dt>
<dd><p>Set curve for cross fade transition for second stream.
</p>
<p>For description of available curve types see <a href="#afade">afade</a> filter description.
</p></dd>
</dl>
<a name="Examples-13"></a>
<h4 class="subsection">28.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-13" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-13" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Cross fade from one input to another:
<div class="example">
<pre class="example">ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
</pre></div>
</li><li> Cross fade from one input to another but without overlapping:
<div class="example">
<pre class="example">ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
</pre></div>
</li></ul>
<a name="acrusher"></a>
<h3 class="section">28.3 acrusher<span class="pull-right"><a class="anchor hidden-xs" href="#acrusher" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acrusher" aria-hidden="true">TOC</a></span></h3>
<p>Reduce audio bit resolution.
</p>
<p>This filter is bit crusher with enhanced functionality. A bit crusher
is used to audibly reduce number of bits an audio signal is sampled
with. This doesn&rsquo;t change the bit depth at all, it just produces the
effect. Material reduced in bit depth sounds more harsh and &quot;digital&quot;.
This filter is able to even round to continous values instead of discrete
bit depths.
Additionally it has a D/C offset which results in different crushing of
the lower and the upper half of the signal.
An Anti-Aliasing setting is able to produce &quot;softer&quot; crushing sounds.
</p>
<p>Another feature of this filter is the logarithmic mode.
This setting switches from linear distances between bits to logarithmic ones.
The result is a much more &quot;natural&quot; sounding crusher which doesn&rsquo;t gate low
signals for example. The human ear has a logarithmic perception, too
so this kind of crushing is much more pleasant.
Logarithmic crushing is also able to get anti-aliased.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set level in.
</p>
</dd>
<dt><samp>level_out</samp></dt>
<dd><p>Set level out.
</p>
</dd>
<dt><samp>bits</samp></dt>
<dd><p>Set bit reduction.
</p>
</dd>
<dt><samp>mix</samp></dt>
<dd><p>Set mixing ammount.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Can be linear: <code>lin</code> or logarithmic: <code>log</code>.
</p>
</dd>
<dt><samp>dc</samp></dt>
<dd><p>Set DC.
</p>
</dd>
<dt><samp>aa</samp></dt>
<dd><p>Set anti-aliasing.
</p>
</dd>
<dt><samp>samples</samp></dt>
<dd><p>Set sample reduction.
</p>
</dd>
<dt><samp>lfo</samp></dt>
<dd><p>Enable LFO. By default disabled.
</p>
</dd>
<dt><samp>lforange</samp></dt>
<dd><p>Set LFO range.
</p>
</dd>
<dt><samp>lforate</samp></dt>
<dd><p>Set LFO rate.
</p></dd>
</dl>
<a name="adelay"></a>
<h3 class="section">28.4 adelay<span class="pull-right"><a class="anchor hidden-xs" href="#adelay" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adelay" aria-hidden="true">TOC</a></span></h3>
<p>Delay one or more audio channels.
</p>
<p>Samples in delayed channel are filled with silence.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>delays</samp></dt>
<dd><p>Set list of delays in milliseconds for each channel separated by &rsquo;|&rsquo;.
At least one delay greater than 0 should be provided.
Unused delays will be silently ignored. If number of given delays is
smaller than number of channels all remaining channels will not be delayed.
If you want to delay exact number of samples, append &rsquo;S&rsquo; to number.
</p></dd>
</dl>
<a name="Examples-14"></a>
<h4 class="subsection">28.4.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-14" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-14" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave
the second channel (and any other channels that may be present) unchanged.
<div class="example">
<pre class="example">adelay=1500|0|500
</pre></div>
</li><li> Delay second channel by 500 samples, the third channel by 700 samples and leave
the first channel (and any other channels that may be present) unchanged.
<div class="example">
<pre class="example">adelay=0|500S|700S
</pre></div>
</li></ul>
<a name="aecho"></a>
<h3 class="section">28.5 aecho<span class="pull-right"><a class="anchor hidden-xs" href="#aecho" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aecho" aria-hidden="true">TOC</a></span></h3>
<p>Apply echoing to the input audio.
</p>
<p>Echoes are reflected sound and can occur naturally amongst mountains
(and sometimes large buildings) when talking or shouting; digital echo
effects emulate this behaviour and are often used to help fill out the
sound of a single instrument or vocal. The time difference between the
original signal and the reflection is the <code>delay</code>, and the
loudness of the reflected signal is the <code>decay</code>.
Multiple echoes can have different delays and decays.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>in_gain</samp></dt>
<dd><p>Set input gain of reflected signal. Default is <code>0.6</code>.
</p>
</dd>
<dt><samp>out_gain</samp></dt>
<dd><p>Set output gain of reflected signal. Default is <code>0.3</code>.
</p>
</dd>
<dt><samp>delays</samp></dt>
<dd><p>Set list of time intervals in milliseconds between original signal and reflections
separated by &rsquo;|&rsquo;. Allowed range for each <code>delay</code> is <code>(0 - 90000.0]</code>.
Default is <code>1000</code>.
</p>
</dd>
<dt><samp>decays</samp></dt>
<dd><p>Set list of loudnesses of reflected signals separated by &rsquo;|&rsquo;.
Allowed range for each <code>decay</code> is <code>(0 - 1.0]</code>.
Default is <code>0.5</code>.
</p></dd>
</dl>
<a name="Examples-15"></a>
<h4 class="subsection">28.5.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-15" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-15" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Make it sound as if there are twice as many instruments as are actually playing:
<div class="example">
<pre class="example">aecho=0.8:0.88:60:0.4
</pre></div>
</li><li> If delay is very short, then it sound like a (metallic) robot playing music:
<div class="example">
<pre class="example">aecho=0.8:0.88:6:0.4
</pre></div>
</li><li> A longer delay will sound like an open air concert in the mountains:
<div class="example">
<pre class="example">aecho=0.8:0.9:1000:0.3
</pre></div>
</li><li> Same as above but with one more mountain:
<div class="example">
<pre class="example">aecho=0.8:0.9:1000|1800:0.3|0.25
</pre></div>
</li></ul>
<a name="aemphasis"></a>
<h3 class="section">28.6 aemphasis<span class="pull-right"><a class="anchor hidden-xs" href="#aemphasis" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aemphasis" aria-hidden="true">TOC</a></span></h3>
<p>Audio emphasis filter creates or restores material directly taken from LPs or
emphased CDs with different filter curves. E.g. to store music on vinyl the
signal has to be altered by a filter first to even out the disadvantages of
this recording medium.
Once the material is played back the inverse filter has to be applied to
restore the distortion of the frequency response.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input gain.
</p>
</dd>
<dt><samp>level_out</samp></dt>
<dd><p>Set output gain.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set filter mode. For restoring material use <code>reproduction</code> mode, otherwise
use <code>production</code> mode. Default is <code>reproduction</code> mode.
</p>
</dd>
<dt><samp>type</samp></dt>
<dd><p>Set filter type. Selects medium. Can be one of the following:
</p>
<dl compact="compact">
<dt><samp>col</samp></dt>
<dd><p>select Columbia.
</p></dd>
<dt><samp>emi</samp></dt>
<dd><p>select EMI.
</p></dd>
<dt><samp>bsi</samp></dt>
<dd><p>select BSI (78RPM).
</p></dd>
<dt><samp>riaa</samp></dt>
<dd><p>select RIAA.
</p></dd>
<dt><samp>cd</samp></dt>
<dd><p>select Compact Disc (CD).
</p></dd>
<dt><samp>50fm</samp></dt>
<dd><p>select 50µs (FM).
</p></dd>
<dt><samp>75fm</samp></dt>
<dd><p>select 75µs (FM).
</p></dd>
<dt><samp>50kf</samp></dt>
<dd><p>select 50µs (FM-KF).
</p></dd>
<dt><samp>75kf</samp></dt>
<dd><p>select 75µs (FM-KF).
</p></dd>
</dl>
</dd>
</dl>
<a name="aeval"></a>
<h3 class="section">28.7 aeval<span class="pull-right"><a class="anchor hidden-xs" href="#aeval" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aeval" aria-hidden="true">TOC</a></span></h3>
<p>Modify an audio signal according to the specified expressions.
</p>
<p>This filter accepts one or more expressions (one for each channel),
which are evaluated and used to modify a corresponding audio signal.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>exprs</samp></dt>
<dd><p>Set the &rsquo;|&rsquo;-separated expressions list for each separate channel. If
the number of input channels is greater than the number of
expressions, the last specified expression is used for the remaining
output channels.
</p>
</dd>
<dt><samp>channel_layout, c</samp></dt>
<dd><p>Set output channel layout. If not specified, the channel layout is
specified by the number of expressions. If set to &lsquo;<samp>same</samp>&rsquo;, it will
use by default the same input channel layout.
</p></dd>
</dl>
<p>Each expression in <var>exprs</var> can contain the following constants and functions:
</p>
<dl compact="compact">
<dt><samp>ch</samp></dt>
<dd><p>channel number of the current expression
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>number of the evaluated sample, starting from 0
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>time of the evaluated sample expressed in seconds
</p>
</dd>
<dt><samp>nb_in_channels</samp></dt>
<dt><samp>nb_out_channels</samp></dt>
<dd><p>input and output number of channels
</p>
</dd>
<dt><samp>val(CH)</samp></dt>
<dd><p>the value of input channel with number <var>CH</var>
</p></dd>
</dl>
<p>Note: this filter is slow. For faster processing you should use a
dedicated filter.
</p>
<a name="Examples-16"></a>
<h4 class="subsection">28.7.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-16" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-16" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Half volume:
<div class="example">
<pre class="example">aeval=val(ch)/2:c=same
</pre></div>
</li><li> Invert phase of the second channel:
<div class="example">
<pre class="example">aeval=val(0)|-val(1)
</pre></div>
</li></ul>
<a name="afade"></a><a name="afade-1"></a>
<h3 class="section">28.8 afade<span class="pull-right"><a class="anchor hidden-xs" href="#afade-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afade-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply fade-in/out effect to input audio.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>type, t</samp></dt>
<dd><p>Specify the effect type, can be either <code>in</code> for fade-in, or
<code>out</code> for a fade-out effect. Default is <code>in</code>.
</p>
</dd>
<dt><samp>start_sample, ss</samp></dt>
<dd><p>Specify the number of the start sample for starting to apply the fade
effect. Default is 0.
</p>
</dd>
<dt><samp>nb_samples, ns</samp></dt>
<dd><p>Specify the number of samples for which the fade effect has to last. At
the end of the fade-in effect the output audio will have the same
volume as the input audio, at the end of the fade-out transition
the output audio will be silence. Default is 44100.
</p>
</dd>
<dt><samp>start_time, st</samp></dt>
<dd><p>Specify the start time of the fade effect. Default is 0.
The value must be specified as a time duration; see
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
If set this option is used instead of <var>start_sample</var>.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Specify the duration of the fade effect. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
At the end of the fade-in effect the output audio will have the same
volume as the input audio, at the end of the fade-out transition
the output audio will be silence.
By default the duration is determined by <var>nb_samples</var>.
If set this option is used instead of <var>nb_samples</var>.
</p>
</dd>
<dt><samp>curve</samp></dt>
<dd><p>Set curve for fade transition.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt><samp>tri</samp></dt>
<dd><p>select triangular, linear slope (default)
</p></dd>
<dt><samp>qsin</samp></dt>
<dd><p>select quarter of sine wave
</p></dd>
<dt><samp>hsin</samp></dt>
<dd><p>select half of sine wave
</p></dd>
<dt><samp>esin</samp></dt>
<dd><p>select exponential sine wave
</p></dd>
<dt><samp>log</samp></dt>
<dd><p>select logarithmic
</p></dd>
<dt><samp>ipar</samp></dt>
<dd><p>select inverted parabola
</p></dd>
<dt><samp>qua</samp></dt>
<dd><p>select quadratic
</p></dd>
<dt><samp>cub</samp></dt>
<dd><p>select cubic
</p></dd>
<dt><samp>squ</samp></dt>
<dd><p>select square root
</p></dd>
<dt><samp>cbr</samp></dt>
<dd><p>select cubic root
</p></dd>
<dt><samp>par</samp></dt>
<dd><p>select parabola
</p></dd>
<dt><samp>exp</samp></dt>
<dd><p>select exponential
</p></dd>
<dt><samp>iqsin</samp></dt>
<dd><p>select inverted quarter of sine wave
</p></dd>
<dt><samp>ihsin</samp></dt>
<dd><p>select inverted half of sine wave
</p></dd>
<dt><samp>dese</samp></dt>
<dd><p>select double-exponential seat
</p></dd>
<dt><samp>desi</samp></dt>
<dd><p>select double-exponential sigmoid
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-17"></a>
<h4 class="subsection">28.8.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-17" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-17" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Fade in first 15 seconds of audio:
<div class="example">
<pre class="example">afade=t=in:ss=0:d=15
</pre></div>
</li><li> Fade out last 25 seconds of a 900 seconds audio:
<div class="example">
<pre class="example">afade=t=out:st=875:d=25
</pre></div>
</li></ul>
<a name="afftfilt"></a>
<h3 class="section">28.9 afftfilt<span class="pull-right"><a class="anchor hidden-xs" href="#afftfilt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afftfilt" aria-hidden="true">TOC</a></span></h3>
<p>Apply arbitrary expressions to samples in frequency domain.
</p>
<dl compact="compact">
<dt><samp>real</samp></dt>
<dd><p>Set frequency domain real expression for each separate channel separated
by &rsquo;|&rsquo;. Default is &quot;1&quot;.
If the number of input channels is greater than the number of
expressions, the last specified expression is used for the remaining
output channels.
</p>
</dd>
<dt><samp>imag</samp></dt>
<dd><p>Set frequency domain imaginary expression for each separate channel
separated by &rsquo;|&rsquo;. If not set, <var>real</var> option is used.
</p>
<p>Each expression in <var>real</var> and <var>imag</var> can contain the following
constants:
</p>
<dl compact="compact">
<dt><samp>sr</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp>b</samp></dt>
<dd><p>current frequency bin number
</p>
</dd>
<dt><samp>nb</samp></dt>
<dd><p>number of available bins
</p>
</dd>
<dt><samp>ch</samp></dt>
<dd><p>channel number of the current expression
</p>
</dd>
<dt><samp>chs</samp></dt>
<dd><p>number of channels
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>current frame pts
</p></dd>
</dl>
</dd>
<dt><samp>win_size</samp></dt>
<dd><p>Set window size.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>w16</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w32</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w64</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w256</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w512</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w1024</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w2048</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w4096</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w8192</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w16384</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w32768</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w65536</samp>&rsquo;</dt>
</dl>
<p>Default is <code>w4096</code>
</p>
</dd>
<dt><samp>win_func</samp></dt>
<dd><p>Set window function. Default is <code>hann</code>.
</p>
</dd>
<dt><samp>overlap</samp></dt>
<dd><p>Set window overlap. If set to 1, the recommended overlap for selected
window function will be picked. Default is <code>0.75</code>.
</p></dd>
</dl>
<a name="Examples-18"></a>
<h4 class="subsection">28.9.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-18" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-18" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Leave almost only low frequencies in audio:
<div class="example">
<pre class="example">afftfilt=&quot;1-clip((b/nb)*b,0,1)&quot;
</pre></div>
</li></ul>
<a name="aformat"></a><a name="aformat-1"></a>
<h3 class="section">28.10 aformat<span class="pull-right"><a class="anchor hidden-xs" href="#aformat-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aformat-1" aria-hidden="true">TOC</a></span></h3>
<p>Set output format constraints for the input audio. The framework will
negotiate the most appropriate format to minimize conversions.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>sample_fmts</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of requested sample formats.
</p>
</dd>
<dt><samp>sample_rates</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of requested sample rates.
</p>
</dd>
<dt><samp>channel_layouts</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of requested channel layouts.
</p>
<p>See <a href="ffmpeg-utils.html#channel-layout-syntax">(ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual</a>
for the required syntax.
</p></dd>
</dl>
<p>If a parameter is omitted, all values are allowed.
</p>
<p>Force the output to either unsigned 8-bit or signed 16-bit stereo
</p><div class="example">
<pre class="example">aformat=sample_fmts=u8|s16:channel_layouts=stereo
</pre></div>
<a name="agate"></a>
<h3 class="section">28.11 agate<span class="pull-right"><a class="anchor hidden-xs" href="#agate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-agate" aria-hidden="true">TOC</a></span></h3>
<p>A gate is mainly used to reduce lower parts of a signal. This kind of signal
processing reduces disturbing noise between useful signals.
</p>
<p>Gating is done by detecting the volume below a chosen level <var>threshold</var>
and dividing it by the factor set with <var>ratio</var>. The bottom of the noise
floor is set via <var>range</var>. Because an exact manipulation of the signal
would cause distortion of the waveform the reduction can be levelled over
time. This is done by setting <var>attack</var> and <var>release</var>.
</p>
<p><var>attack</var> determines how long the signal has to fall below the threshold
before any reduction will occur and <var>release</var> sets the time the signal
has to rise above the threshold to reduce the reduction again.
Shorter signals than the chosen attack time will be left untouched.
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input level before filtering.
Default is 1. Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>range</samp></dt>
<dd><p>Set the level of gain reduction when the signal is below the threshold.
Default is 0.06125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>If a signal rises above this level the gain reduction is released.
Default is 0.125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp>ratio</samp></dt>
<dd><p>Set a ratio by which the signal is reduced.
Default is 2. Allowed range is from 1 to 9000.
</p>
</dd>
<dt><samp>attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction stops.
Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp>release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before the
reduction is increased again. Default is 250 milliseconds.
Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp>makeup</samp></dt>
<dd><p>Set amount of amplification of signal after processing.
Default is 1. Allowed range is from 1 to 64.
</p>
</dd>
<dt><samp>knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.828427125. Allowed range is from 1 to 8.
</p>
</dd>
<dt><samp>detection</samp></dt>
<dd><p>Choose if exact signal should be taken for detection or an RMS like one.
Default is <code>rms</code>. Can be <code>peak</code> or <code>rms</code>.
</p>
</dd>
<dt><samp>link</samp></dt>
<dd><p>Choose if the average level between all channels or the louder channel affects
the reduction.
Default is <code>average</code>. Can be <code>average</code> or <code>maximum</code>.
</p></dd>
</dl>
<a name="alimiter"></a>
<h3 class="section">28.12 alimiter<span class="pull-right"><a class="anchor hidden-xs" href="#alimiter" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-alimiter" aria-hidden="true">TOC</a></span></h3>
<p>The limiter prevents an input signal from rising over a desired threshold.
This limiter uses lookahead technology to prevent your signal from distorting.
It means that there is a small delay after the signal is processed. Keep in mind
that the delay it produces is the attack time you set.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input gain. Default is 1.
</p>
</dd>
<dt><samp>level_out</samp></dt>
<dd><p>Set output gain. Default is 1.
</p>
</dd>
<dt><samp>limit</samp></dt>
<dd><p>Don&rsquo;t let signals above this level pass the limiter. Default is 1.
</p>
</dd>
<dt><samp>attack</samp></dt>
<dd><p>The limiter will reach its attenuation level in this amount of time in
milliseconds. Default is 5 milliseconds.
</p>
</dd>
<dt><samp>release</samp></dt>
<dd><p>Come back from limiting to attenuation 1.0 in this amount of milliseconds.
Default is 50 milliseconds.
</p>
</dd>
<dt><samp>asc</samp></dt>
<dd><p>When gain reduction is always needed ASC takes care of releasing to an
average reduction level rather than reaching a reduction of 0 in the release
time.
</p>
</dd>
<dt><samp>asc_level</samp></dt>
<dd><p>Select how much the release time is affected by ASC, 0 means nearly no changes
in release time while 1 produces higher release times.
</p>
</dd>
<dt><samp>level</samp></dt>
<dd><p>Auto level output signal. Default is enabled.
This normalizes audio back to 0dB if enabled.
</p></dd>
</dl>
<p>Depending on picked setting it is recommended to upsample input 2x or 4x times
with <a href="#aresample">aresample</a> before applying this filter.
</p>
<a name="allpass"></a>
<h3 class="section">28.13 allpass<span class="pull-right"><a class="anchor hidden-xs" href="#allpass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-allpass" aria-hidden="true">TOC</a></span></h3>
<p>Apply a two-pole all-pass filter with central frequency (in Hz)
<var>frequency</var>, and filter-width <var>width</var>.
An all-pass filter changes the audio&rsquo;s frequency to phase relationship
without changing its frequency to amplitude relationship.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set frequency in Hz.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p></dd>
</dl>
<a name="aloop"></a>
<h3 class="section">28.14 aloop<span class="pull-right"><a class="anchor hidden-xs" href="#aloop" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aloop" aria-hidden="true">TOC</a></span></h3>
<p>Loop audio samples.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>loop</samp></dt>
<dd><p>Set the number of loops.
</p>
</dd>
<dt><samp>size</samp></dt>
<dd><p>Set maximal number of samples.
</p>
</dd>
<dt><samp>start</samp></dt>
<dd><p>Set first sample of loop.
</p></dd>
</dl>
<a name="amerge"></a><a name="amerge-1"></a>
<h3 class="section">28.15 amerge<span class="pull-right"><a class="anchor hidden-xs" href="#amerge-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amerge-1" aria-hidden="true">TOC</a></span></h3>
<p>Merge two or more audio streams into a single multi-channel stream.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>Set the number of inputs. Default is 2.
</p>
</dd>
</dl>
<p>If the channel layouts of the inputs are disjoint, and therefore compatible,
the channel layout of the output will be set accordingly and the channels
will be reordered as necessary. If the channel layouts of the inputs are not
disjoint, the output will have all the channels of the first input then all
the channels of the second input, in that order, and the channel layout of
the output will be the default value corresponding to the total number of
channels.
</p>
<p>For example, if the first input is in 2.1 (FL+FR+LF) and the second input
is FC+BL+BR, then the output will be in 5.1, with the channels in the
following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
first input, b1 is the first channel of the second input).
</p>
<p>On the other hand, if both input are in stereo, the output channels will be
in the default order: a1, a2, b1, b2, and the channel layout will be
arbitrarily set to 4.0, which may or may not be the expected value.
</p>
<p>All inputs must have the same sample rate, and format.
</p>
<p>If inputs do not have the same duration, the output will stop with the
shortest.
</p>
<a name="Examples-19"></a>
<h4 class="subsection">28.15.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-19" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-19" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Merge two mono files into a stereo stream:
<div class="example">
<pre class="example">amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
</pre></div>
</li><li> Multiple merges assuming 1 video stream and 6 audio streams in <samp>input.mkv</samp>:
<div class="example">
<pre class="example">ffmpeg -i input.mkv -filter_complex &quot;[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6&quot; -c:a pcm_s16le output.mkv
</pre></div>
</li></ul>
<a name="amix"></a>
<h3 class="section">28.16 amix<span class="pull-right"><a class="anchor hidden-xs" href="#amix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amix" aria-hidden="true">TOC</a></span></h3>
<p>Mixes multiple audio inputs into a single output.
</p>
<p>Note that this filter only supports float samples (the <var>amerge</var>
and <var>pan</var> audio filters support many formats). If the <var>amix</var>
input has integer samples then <a href="#aresample">aresample</a> will be automatically
inserted to perform the conversion to float samples.
</p>
<p>For example
</p><div class="example">
<pre class="example">ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
</pre></div>
<p>will mix 3 input audio streams to a single output with the same duration as the
first input and a dropout transition time of 3 seconds.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>The number of inputs. If unspecified, it defaults to 2.
</p>
</dd>
<dt><samp>duration</samp></dt>
<dd><p>How to determine the end-of-stream.
</p><dl compact="compact">
<dt><samp>longest</samp></dt>
<dd><p>The duration of the longest input. (default)
</p>
</dd>
<dt><samp>shortest</samp></dt>
<dd><p>The duration of the shortest input.
</p>
</dd>
<dt><samp>first</samp></dt>
<dd><p>The duration of the first input.
</p>
</dd>
</dl>
</dd>
<dt><samp>dropout_transition</samp></dt>
<dd><p>The transition time, in seconds, for volume renormalization when an input
stream ends. The default value is 2 seconds.
</p>
</dd>
</dl>
<a name="anequalizer"></a>
<h3 class="section">28.17 anequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#anequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anequalizer" aria-hidden="true">TOC</a></span></h3>
<p>High-order parametric multiband equalizer for each channel.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>params</samp></dt>
<dd>
<p>This option string is in format:
&quot;c<var>chn</var> f=<var>cf</var> w=<var>w</var> g=<var>g</var> t=<var>f</var> | ...&quot;
Each equalizer band is separated by &rsquo;|&rsquo;.
</p>
<dl compact="compact">
<dt><samp>chn</samp></dt>
<dd><p>Set channel number to which equalization will be applied.
If input doesn&rsquo;t have that channel the entry is ignored.
</p>
</dd>
<dt><samp>f</samp></dt>
<dd><p>Set central frequency for band.
If input doesn&rsquo;t have that frequency the entry is ignored.
</p>
</dd>
<dt><samp>w</samp></dt>
<dd><p>Set band width in hertz.
</p>
</dd>
<dt><samp>g</samp></dt>
<dd><p>Set band gain in dB.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>Set filter type for band, optional, can be:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>0</samp>&rsquo;</dt>
<dd><p>Butterworth, this is default.
</p>
</dd>
<dt>&lsquo;<samp>1</samp>&rsquo;</dt>
<dd><p>Chebyshev type 1.
</p>
</dd>
<dt>&lsquo;<samp>2</samp>&rsquo;</dt>
<dd><p>Chebyshev type 2.
</p></dd>
</dl>
</dd>
</dl>
</dd>
<dt><samp>curves</samp></dt>
<dd><p>With this option activated frequency response of anequalizer is displayed
in video stream.
</p>
</dd>
<dt><samp>size</samp></dt>
<dd><p>Set video stream size. Only useful if curves option is activated.
</p>
</dd>
<dt><samp>mgain</samp></dt>
<dd><p>Set max gain that will be displayed. Only useful if curves option is activated.
Setting this to reasonable value allows to display gain which is derived from
neighbour bands which are too close to each other and thus produce higher gain
when both are activated.
</p>
</dd>
<dt><samp>fscale</samp></dt>
<dd><p>Set frequency scale used to draw frequency response in video output.
Can be linear or logarithmic. Default is logarithmic.
</p>
</dd>
<dt><samp>colors</samp></dt>
<dd><p>Set color for each channel curve which is going to be displayed in video stream.
This is list of color names separated by space or by &rsquo;|&rsquo;.
Unrecognised or missing colors will be replaced by white color.
</p></dd>
</dl>
<a name="Examples-20"></a>
<h4 class="subsection">28.17.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-20" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-20" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Lower gain by 10 of central frequency 200Hz and width 100 Hz
for first 2 channels using Chebyshev type 1 filter:
<div class="example">
<pre class="example">anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
</pre></div>
</li></ul>
<a name="Commands"></a>
<h4 class="subsection">28.17.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>change</samp></dt>
<dd><p>Alter existing filter parameters.
Syntax for the commands is : &quot;<var>fN</var>|f=<var>freq</var>|w=<var>width</var>|g=<var>gain</var>&quot;
</p>
<p><var>fN</var> is existing filter number, starting from 0, if no such filter is available
error is returned.
<var>freq</var> set new frequency parameter.
<var>width</var> set new width parameter in herz.
<var>gain</var> set new gain parameter in dB.
</p>
<p>Full filter invocation with asendcmd may look like this:
asendcmd=c=&rsquo;4.0 anequalizer change 0|f=200|w=50|g=1&rsquo;,anequalizer=...
</p></dd>
</dl>
<a name="anull"></a>
<h3 class="section">28.18 anull<span class="pull-right"><a class="anchor hidden-xs" href="#anull" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anull" aria-hidden="true">TOC</a></span></h3>
<p>Pass the audio source unchanged to the output.
</p>
<a name="apad"></a>
<h3 class="section">28.19 apad<span class="pull-right"><a class="anchor hidden-xs" href="#apad" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-apad" aria-hidden="true">TOC</a></span></h3>
<p>Pad the end of an audio stream with silence.
</p>
<p>This can be used together with <code>ffmpeg</code> <samp>-shortest</samp> to
extend audio streams to the same length as the video stream.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>packet_size</samp></dt>
<dd><p>Set silence packet size. Default value is 4096.
</p>
</dd>
<dt><samp>pad_len</samp></dt>
<dd><p>Set the number of samples of silence to add to the end. After the
value is reached, the stream is terminated. This option is mutually
exclusive with <samp>whole_len</samp>.
</p>
</dd>
<dt><samp>whole_len</samp></dt>
<dd><p>Set the minimum total number of samples in the output audio stream. If
the value is longer than the input audio length, silence is added to
the end, until the value is reached. This option is mutually exclusive
with <samp>pad_len</samp>.
</p></dd>
</dl>
<p>If neither the <samp>pad_len</samp> nor the <samp>whole_len</samp> option is
set, the filter will add silence to the end of the input stream
indefinitely.
</p>
<a name="Examples-21"></a>
<h4 class="subsection">28.19.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-21" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-21" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Add 1024 samples of silence to the end of the input:
<div class="example">
<pre class="example">apad=pad_len=1024
</pre></div>
</li><li> Make sure the audio output will contain at least 10000 samples, pad
the input with silence if required:
<div class="example">
<pre class="example">apad=whole_len=10000
</pre></div>
</li><li> Use <code>ffmpeg</code> to pad the audio input with silence, so that the
video stream will always result the shortest and will be converted
until the end in the output file when using the <samp>shortest</samp>
option:
<div class="example">
<pre class="example">ffmpeg -i VIDEO -i AUDIO -filter_complex &quot;[1:0]apad&quot; -shortest OUTPUT
</pre></div>
</li></ul>
<a name="aphaser"></a>
<h3 class="section">28.20 aphaser<span class="pull-right"><a class="anchor hidden-xs" href="#aphaser" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aphaser" aria-hidden="true">TOC</a></span></h3>
<p>Add a phasing effect to the input audio.
</p>
<p>A phaser filter creates series of peaks and troughs in the frequency spectrum.
The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>in_gain</samp></dt>
<dd><p>Set input gain. Default is 0.4.
</p>
</dd>
<dt><samp>out_gain</samp></dt>
<dd><p>Set output gain. Default is 0.74
</p>
</dd>
<dt><samp>delay</samp></dt>
<dd><p>Set delay in milliseconds. Default is 3.0.
</p>
</dd>
<dt><samp>decay</samp></dt>
<dd><p>Set decay. Default is 0.4.
</p>
</dd>
<dt><samp>speed</samp></dt>
<dd><p>Set modulation speed in Hz. Default is 0.5.
</p>
</dd>
<dt><samp>type</samp></dt>
<dd><p>Set modulation type. Default is triangular.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>triangular, t</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sinusoidal, s</samp>&rsquo;</dt>
</dl>
</dd>
</dl>
<a name="apulsator"></a>
<h3 class="section">28.21 apulsator<span class="pull-right"><a class="anchor hidden-xs" href="#apulsator" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-apulsator" aria-hidden="true">TOC</a></span></h3>
<p>Audio pulsator is something between an autopanner and a tremolo.
But it can produce funny stereo effects as well. Pulsator changes the volume
of the left and right channel based on a LFO (low frequency oscillator) with
different waveforms and shifted phases.
This filter have the ability to define an offset between left and right
channel. An offset of 0 means that both LFO shapes match each other.
The left and right channel are altered equally - a conventional tremolo.
An offset of 50% means that the shape of the right channel is exactly shifted
in phase (or moved backwards about half of the frequency) - pulsator acts as
an autopanner. At 1 both curves match again. Every setting in between moves the
phase shift gapless between all stages and produces some &quot;bypassing&quot; sounds with
sine and triangle waveforms. The more you set the offset near 1 (starting from
the 0.5) the faster the signal passes from the left to the right speaker.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp>level_out</samp></dt>
<dd><p>Set output gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set waveform shape the LFO will use. Can be one of: sine, triangle, square,
sawup or sawdown. Default is sine.
</p>
</dd>
<dt><samp>amount</samp></dt>
<dd><p>Set modulation. Define how much of original signal is affected by the LFO.
</p>
</dd>
<dt><samp>offset_l</samp></dt>
<dd><p>Set left channel offset. Default is 0. Allowed range is [0 - 1].
</p>
</dd>
<dt><samp>offset_r</samp></dt>
<dd><p>Set right channel offset. Default is 0.5. Allowed range is [0 - 1].
</p>
</dd>
<dt><samp>width</samp></dt>
<dd><p>Set pulse width. Default is 1. Allowed range is [0 - 2].
</p>
</dd>
<dt><samp>timing</samp></dt>
<dd><p>Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz.
</p>
</dd>
<dt><samp>bpm</samp></dt>
<dd><p>Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing
is set to bpm.
</p>
</dd>
<dt><samp>ms</samp></dt>
<dd><p>Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing
is set to ms.
</p>
</dd>
<dt><samp>hz</samp></dt>
<dd><p>Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used
if timing is set to hz.
</p></dd>
</dl>
<a name="aresample"></a><a name="aresample-1"></a>
<h3 class="section">28.22 aresample<span class="pull-right"><a class="anchor hidden-xs" href="#aresample-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aresample-1" aria-hidden="true">TOC</a></span></h3>
<p>Resample the input audio to the specified parameters, using the
libswresample library. If none are specified then the filter will
automatically convert between its input and output.
</p>
<p>This filter is also able to stretch/squeeze the audio data to make it match
the timestamps or to inject silence / cut out audio to make it match the
timestamps, do a combination of both or do neither.
</p>
<p>The filter accepts the syntax
[<var>sample_rate</var>:]<var>resampler_options</var>, where <var>sample_rate</var>
expresses a sample rate and <var>resampler_options</var> is a list of
<var>key</var>=<var>value</var> pairs, separated by &quot;:&quot;. See the
ffmpeg-resampler manual for the complete list of supported options.
</p>
<a name="Examples-22"></a>
<h4 class="subsection">28.22.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-22" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-22" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Resample the input audio to 44100Hz:
<div class="example">
<pre class="example">aresample=44100
</pre></div>
</li><li> Stretch/squeeze samples to the given timestamps, with a maximum of 1000
samples per second compensation:
<div class="example">
<pre class="example">aresample=async=1000
</pre></div>
</li></ul>
<a name="areverse"></a>
<h3 class="section">28.23 areverse<span class="pull-right"><a class="anchor hidden-xs" href="#areverse" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-areverse" aria-hidden="true">TOC</a></span></h3>
<p>Reverse an audio clip.
</p>
<p>Warning: This filter requires memory to buffer the entire clip, so trimming
is suggested.
</p>
<a name="Examples-23"></a>
<h4 class="subsection">28.23.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-23" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-23" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Take the first 5 seconds of a clip, and reverse it.
<div class="example">
<pre class="example">atrim=end=5,areverse
</pre></div>
</li></ul>
<a name="asetnsamples"></a>
<h3 class="section">28.24 asetnsamples<span class="pull-right"><a class="anchor hidden-xs" href="#asetnsamples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asetnsamples" aria-hidden="true">TOC</a></span></h3>
<p>Set the number of samples per each output audio frame.
</p>
<p>The last output packet may contain a different number of samples, as
the filter will flush all the remaining samples when the input audio
signals its end.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>nb_out_samples, n</samp></dt>
<dd><p>Set the number of frames per each output audio frame. The number is
intended as the number of samples <em>per each channel</em>.
Default value is 1024.
</p>
</dd>
<dt><samp>pad, p</samp></dt>
<dd><p>If set to 1, the filter will pad the last audio frame with zeroes, so
that the last frame will contain the same number of samples as the
previous ones. Default value is 1.
</p></dd>
</dl>
<p>For example, to set the number of per-frame samples to 1234 and
disable padding for the last frame, use:
</p><div class="example">
<pre class="example">asetnsamples=n=1234:p=0
</pre></div>
<a name="asetrate"></a>
<h3 class="section">28.25 asetrate<span class="pull-right"><a class="anchor hidden-xs" href="#asetrate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asetrate" aria-hidden="true">TOC</a></span></h3>
<p>Set the sample rate without altering the PCM data.
This will result in a change of speed and pitch.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sample_rate, r</samp></dt>
<dd><p>Set the output sample rate. Default is 44100 Hz.
</p></dd>
</dl>
<a name="ashowinfo"></a>
<h3 class="section">28.26 ashowinfo<span class="pull-right"><a class="anchor hidden-xs" href="#ashowinfo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ashowinfo" aria-hidden="true">TOC</a></span></h3>
<p>Show a line containing various information for each input audio frame.
The input audio is not modified.
</p>
<p>The shown line contains a sequence of key/value pairs of the form
<var>key</var>:<var>value</var>.
</p>
<p>The following values are shown in the output:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>The presentation timestamp of the input frame, in time base units; the time base
depends on the filter input pad, and is usually 1/<var>sample_rate</var>.
</p>
</dd>
<dt><samp>pts_time</samp></dt>
<dd><p>The presentation timestamp of the input frame in seconds.
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>position of the frame in the input stream, -1 if this information in
unavailable and/or meaningless (for example in case of synthetic audio)
</p>
</dd>
<dt><samp>fmt</samp></dt>
<dd><p>The sample format.
</p>
</dd>
<dt><samp>chlayout</samp></dt>
<dd><p>The channel layout.
</p>
</dd>
<dt><samp>rate</samp></dt>
<dd><p>The sample rate for the audio frame.
</p>
</dd>
<dt><samp>nb_samples</samp></dt>
<dd><p>The number of samples (per channel) in the frame.
</p>
</dd>
<dt><samp>checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
audio, the data is treated as if all the planes were concatenated.
</p>
</dd>
<dt><samp>plane_checksums</samp></dt>
<dd><p>A list of Adler-32 checksums for each data plane.
</p></dd>
</dl>
<a name="astats"></a><a name="astats-1"></a>
<h3 class="section">28.27 astats<span class="pull-right"><a class="anchor hidden-xs" href="#astats-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-astats-1" aria-hidden="true">TOC</a></span></h3>
<p>Display time domain statistical information about the audio channels.
Statistics are calculated and displayed for each audio channel and,
where applicable, an overall figure is also given.
</p>
<p>It accepts the following option:
</p><dl compact="compact">
<dt><samp>length</samp></dt>
<dd><p>Short window length in seconds, used for peak and trough RMS measurement.
Default is <code>0.05</code> (50 milliseconds). Allowed range is <code>[0.1 - 10]</code>.
</p>
</dd>
<dt><samp>metadata</samp></dt>
<dd>
<p>Set metadata injection. All the metadata keys are prefixed with <code>lavfi.astats.X</code>,
where <code>X</code> is channel number starting from 1 or string <code>Overall</code>. Default is
disabled.
</p>
<p>Available keys for each channel are:
DC_offset
Min_level
Max_level
Min_difference
Max_difference
Mean_difference
Peak_level
RMS_peak
RMS_trough
Crest_factor
Flat_factor
Peak_count
Bit_depth
</p>
<p>and for Overall:
DC_offset
Min_level
Max_level
Min_difference
Max_difference
Mean_difference
Peak_level
RMS_level
RMS_peak
RMS_trough
Flat_factor
Peak_count
Bit_depth
Number_of_samples
</p>
<p>For example full key look like this <code>lavfi.astats.1.DC_offset</code> or
this <code>lavfi.astats.Overall.Peak_count</code>.
</p>
<p>For description what each key means read below.
</p>
</dd>
<dt><samp>reset</samp></dt>
<dd><p>Set number of frame after which stats are going to be recalculated.
Default is disabled.
</p></dd>
</dl>
<p>A description of each shown parameter follows:
</p>
<dl compact="compact">
<dt><samp>DC offset</samp></dt>
<dd><p>Mean amplitude displacement from zero.
</p>
</dd>
<dt><samp>Min level</samp></dt>
<dd><p>Minimal sample level.
</p>
</dd>
<dt><samp>Max level</samp></dt>
<dd><p>Maximal sample level.
</p>
</dd>
<dt><samp>Min difference</samp></dt>
<dd><p>Minimal difference between two consecutive samples.
</p>
</dd>
<dt><samp>Max difference</samp></dt>
<dd><p>Maximal difference between two consecutive samples.
</p>
</dd>
<dt><samp>Mean difference</samp></dt>
<dd><p>Mean difference between two consecutive samples.
The average of each difference between two consecutive samples.
</p>
</dd>
<dt><samp>Peak level dB</samp></dt>
<dt><samp>RMS level dB</samp></dt>
<dd><p>Standard peak and RMS level measured in dBFS.
</p>
</dd>
<dt><samp>RMS peak dB</samp></dt>
<dt><samp>RMS trough dB</samp></dt>
<dd><p>Peak and trough values for RMS level measured over a short window.
</p>
</dd>
<dt><samp>Crest factor</samp></dt>
<dd><p>Standard ratio of peak to RMS level (note: not in dB).
</p>
</dd>
<dt><samp>Flat factor</samp></dt>
<dd><p>Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
(i.e. either <var>Min level</var> or <var>Max level</var>).
</p>
</dd>
<dt><samp>Peak count</samp></dt>
<dd><p>Number of occasions (not the number of samples) that the signal attained either
<var>Min level</var> or <var>Max level</var>.
</p>
</dd>
<dt><samp>Bit depth</samp></dt>
<dd><p>Overall bit depth of audio. Number of bits used for each sample.
</p></dd>
</dl>
<a name="asyncts"></a>
<h3 class="section">28.28 asyncts<span class="pull-right"><a class="anchor hidden-xs" href="#asyncts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asyncts" aria-hidden="true">TOC</a></span></h3>
<p>Synchronize audio data with timestamps by squeezing/stretching it and/or
dropping samples/adding silence when needed.
</p>
<p>This filter is not built by default, please use <a href="#aresample">aresample</a> to do squeezing/stretching.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>compensate</samp></dt>
<dd><p>Enable stretching/squeezing the data to make it match the timestamps. Disabled
by default. When disabled, time gaps are covered with silence.
</p>
</dd>
<dt><samp>min_delta</samp></dt>
<dd><p>The minimum difference between timestamps and audio data (in seconds) to trigger
adding/dropping samples. The default value is 0.1. If you get an imperfect
sync with this filter, try setting this parameter to 0.
</p>
</dd>
<dt><samp>max_comp</samp></dt>
<dd><p>The maximum compensation in samples per second. Only relevant with compensate=1.
The default value is 500.
</p>
</dd>
<dt><samp>first_pts</samp></dt>
<dd><p>Assume that the first PTS should be this value. The time base is 1 / sample
rate. This allows for padding/trimming at the start of the stream. By default,
no assumption is made about the first frame&rsquo;s expected PTS, so no padding or
trimming is done. For example, this could be set to 0 to pad the beginning with
silence if an audio stream starts after the video stream or to trim any samples
with a negative PTS due to encoder delay.
</p>
</dd>
</dl>
<a name="atempo"></a>
<h3 class="section">28.29 atempo<span class="pull-right"><a class="anchor hidden-xs" href="#atempo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-atempo" aria-hidden="true">TOC</a></span></h3>
<p>Adjust audio tempo.
</p>
<p>The filter accepts exactly one parameter, the audio tempo. If not
specified then the filter will assume nominal 1.0 tempo. Tempo must
be in the [0.5, 2.0] range.
</p>
<a name="Examples-24"></a>
<h4 class="subsection">28.29.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-24" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-24" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Slow down audio to 80% tempo:
<div class="example">
<pre class="example">atempo=0.8
</pre></div>
</li><li> To speed up audio to 125% tempo:
<div class="example">
<pre class="example">atempo=1.25
</pre></div>
</li></ul>
<a name="atrim"></a>
<h3 class="section">28.30 atrim<span class="pull-right"><a class="anchor hidden-xs" href="#atrim" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-atrim" aria-hidden="true">TOC</a></span></h3>
<p>Trim the input so that the output contains one continuous subpart of the input.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>start</samp></dt>
<dd><p>Timestamp (in seconds) of the start of the section to keep. I.e. the audio
sample with the timestamp <var>start</var> will be the first sample in the output.
</p>
</dd>
<dt><samp>end</samp></dt>
<dd><p>Specify time of the first audio sample that will be dropped, i.e. the
audio sample immediately preceding the one with the timestamp <var>end</var> will be
the last sample in the output.
</p>
</dd>
<dt><samp>start_pts</samp></dt>
<dd><p>Same as <var>start</var>, except this option sets the start timestamp in samples
instead of seconds.
</p>
</dd>
<dt><samp>end_pts</samp></dt>
<dd><p>Same as <var>end</var>, except this option sets the end timestamp in samples instead
of seconds.
</p>
</dd>
<dt><samp>duration</samp></dt>
<dd><p>The maximum duration of the output in seconds.
</p>
</dd>
<dt><samp>start_sample</samp></dt>
<dd><p>The number of the first sample that should be output.
</p>
</dd>
<dt><samp>end_sample</samp></dt>
<dd><p>The number of the first sample that should be dropped.
</p></dd>
</dl>
<p><samp>start</samp>, <samp>end</samp>, and <samp>duration</samp> are expressed as time
duration specifications; see
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>.
</p>
<p>Note that the first two sets of the start/end options and the <samp>duration</samp>
option look at the frame timestamp, while the _sample options simply count the
samples that pass through the filter. So start/end_pts and start/end_sample will
give different results when the timestamps are wrong, inexact or do not start at
zero. Also note that this filter does not modify the timestamps. If you wish
to have the output timestamps start at zero, insert the asetpts filter after the
atrim filter.
</p>
<p>If multiple start or end options are set, this filter tries to be greedy and
keep all samples that match at least one of the specified constraints. To keep
only the part that matches all the constraints at once, chain multiple atrim
filters.
</p>
<p>The defaults are such that all the input is kept. So it is possible to set e.g.
just the end values to keep everything before the specified time.
</p>
<p>Examples:
</p><ul>
<li> Drop everything except the second minute of input:
<div class="example">
<pre class="example">ffmpeg -i INPUT -af atrim=60:120
</pre></div>
</li><li> Keep only the first 1000 samples:
<div class="example">
<pre class="example">ffmpeg -i INPUT -af atrim=end_sample=1000
</pre></div>
</li></ul>
<a name="bandpass"></a>
<h3 class="section">28.31 bandpass<span class="pull-right"><a class="anchor hidden-xs" href="#bandpass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bandpass" aria-hidden="true">TOC</a></span></h3>
<p>Apply a two-pole Butterworth band-pass filter with central
frequency <var>frequency</var>, and (3dB-point) band-width width.
The <var>csg</var> option selects a constant skirt gain (peak gain = Q)
instead of the default: constant 0dB peak gain.
The filter roll off at 6dB per octave (20dB per decade).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the filter&rsquo;s central frequency. Default is <code>3000</code>.
</p>
</dd>
<dt><samp>csg</samp></dt>
<dd><p>Constant skirt gain if set to 1. Defaults to 0.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p></dd>
</dl>
<a name="bandreject"></a>
<h3 class="section">28.32 bandreject<span class="pull-right"><a class="anchor hidden-xs" href="#bandreject" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bandreject" aria-hidden="true">TOC</a></span></h3>
<p>Apply a two-pole Butterworth band-reject filter with central
frequency <var>frequency</var>, and (3dB-point) band-width <var>width</var>.
The filter roll off at 6dB per octave (20dB per decade).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the filter&rsquo;s central frequency. Default is <code>3000</code>.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p></dd>
</dl>
<a name="bass"></a>
<h3 class="section">28.33 bass<span class="pull-right"><a class="anchor hidden-xs" href="#bass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bass" aria-hidden="true">TOC</a></span></h3>
<p>Boost or cut the bass (lower) frequencies of the audio using a two-pole
shelving filter with a response similar to that of a standard
hi-fi&rsquo;s tone-controls. This is also known as shelving equalisation (EQ).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>gain, g</samp></dt>
<dd><p>Give the gain at 0 Hz. Its useful range is about -20
(for a large cut) to +20 (for a large boost).
Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the filter&rsquo;s central frequency and so can be used
to extend or reduce the frequency range to be boosted or cut.
The default value is <code>100</code> Hz.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Determine how steep is the filter&rsquo;s shelf transition.
</p></dd>
</dl>
<a name="biquad"></a>
<h3 class="section">28.34 biquad<span class="pull-right"><a class="anchor hidden-xs" href="#biquad" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-biquad" aria-hidden="true">TOC</a></span></h3>
<p>Apply a biquad IIR filter with the given coefficients.
Where <var>b0</var>, <var>b1</var>, <var>b2</var> and <var>a0</var>, <var>a1</var>, <var>a2</var>
are the numerator and denominator coefficients respectively.
</p>
<a name="bs2b"></a>
<h3 class="section">28.35 bs2b<span class="pull-right"><a class="anchor hidden-xs" href="#bs2b" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bs2b" aria-hidden="true">TOC</a></span></h3>
<p>Bauer stereo to binaural transformation, which improves headphone listening of
stereo audio records.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>profile</samp></dt>
<dd><p>Pre-defined crossfeed level.
</p><dl compact="compact">
<dt><samp>default</samp></dt>
<dd><p>Default level (fcut=700, feed=50).
</p>
</dd>
<dt><samp>cmoy</samp></dt>
<dd><p>Chu Moy circuit (fcut=700, feed=60).
</p>
</dd>
<dt><samp>jmeier</samp></dt>
<dd><p>Jan Meier circuit (fcut=650, feed=95).
</p>
</dd>
</dl>
</dd>
<dt><samp>fcut</samp></dt>
<dd><p>Cut frequency (in Hz).
</p>
</dd>
<dt><samp>feed</samp></dt>
<dd><p>Feed level (in Hz).
</p>
</dd>
</dl>
<a name="channelmap"></a>
<h3 class="section">28.36 channelmap<span class="pull-right"><a class="anchor hidden-xs" href="#channelmap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-channelmap" aria-hidden="true">TOC</a></span></h3>
<p>Remap input channels to new locations.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>channel_layout</samp></dt>
<dd><p>The channel layout of the output stream.
</p>
</dd>
<dt><samp>map</samp></dt>
<dd><p>Map channels from input to output. The argument is a &rsquo;|&rsquo;-separated list of
mappings, each in the <code><var>in_channel</var>-<var>out_channel</var></code> or
<var>in_channel</var> form. <var>in_channel</var> can be either the name of the input
channel (e.g. FL for front left) or its index in the input channel layout.
<var>out_channel</var> is the name of the output channel or its index in the output
channel layout. If <var>out_channel</var> is not given then it is implicitly an
index, starting with zero and increasing by one for each mapping.
</p></dd>
</dl>
<p>If no mapping is present, the filter will implicitly map input channels to
output channels, preserving indices.
</p>
<p>For example, assuming a 5.1+downmix input MOV file,
</p><div class="example">
<pre class="example">ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
</pre></div>
<p>will create an output WAV file tagged as stereo from the downmix channels of
the input.
</p>
<p>To fix a 5.1 WAV improperly encoded in AAC&rsquo;s native channel order
</p><div class="example">
<pre class="example">ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
</pre></div>
<a name="channelsplit"></a>
<h3 class="section">28.37 channelsplit<span class="pull-right"><a class="anchor hidden-xs" href="#channelsplit" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-channelsplit" aria-hidden="true">TOC</a></span></h3>
<p>Split each channel from an input audio stream into a separate output stream.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>channel_layout</samp></dt>
<dd><p>The channel layout of the input stream. The default is &quot;stereo&quot;.
</p></dd>
</dl>
<p>For example, assuming a stereo input MP3 file,
</p><div class="example">
<pre class="example">ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
</pre></div>
<p>will create an output Matroska file with two audio streams, one containing only
the left channel and the other the right channel.
</p>
<p>Split a 5.1 WAV file into per-channel files:
</p><div class="example">
<pre class="example">ffmpeg -i in.wav -filter_complex
'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
side_right.wav
</pre></div>
<a name="chorus"></a>
<h3 class="section">28.38 chorus<span class="pull-right"><a class="anchor hidden-xs" href="#chorus" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chorus" aria-hidden="true">TOC</a></span></h3>
<p>Add a chorus effect to the audio.
</p>
<p>Can make a single vocal sound like a chorus, but can also be applied to instrumentation.
</p>
<p>Chorus resembles an echo effect with a short delay, but whereas with echo the delay is
constant, with chorus, it is varied using using sinusoidal or triangular modulation.
The modulation depth defines the range the modulated delay is played before or after
the delay. Hence the delayed sound will sound slower or faster, that is the delayed
sound tuned around the original one, like in a chorus where some vocals are slightly
off key.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>in_gain</samp></dt>
<dd><p>Set input gain. Default is 0.4.
</p>
</dd>
<dt><samp>out_gain</samp></dt>
<dd><p>Set output gain. Default is 0.4.
</p>
</dd>
<dt><samp>delays</samp></dt>
<dd><p>Set delays. A typical delay is around 40ms to 60ms.
</p>
</dd>
<dt><samp>decays</samp></dt>
<dd><p>Set decays.
</p>
</dd>
<dt><samp>speeds</samp></dt>
<dd><p>Set speeds.
</p>
</dd>
<dt><samp>depths</samp></dt>
<dd><p>Set depths.
</p></dd>
</dl>
<a name="Examples-25"></a>
<h4 class="subsection">28.38.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-25" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-25" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> A single delay:
<div class="example">
<pre class="example">chorus=0.7:0.9:55:0.4:0.25:2
</pre></div>
</li><li> Two delays:
<div class="example">
<pre class="example">chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
</pre></div>
</li><li> Fuller sounding chorus with three delays:
<div class="example">
<pre class="example">chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
</pre></div>
</li></ul>
<a name="compand"></a>
<h3 class="section">28.39 compand<span class="pull-right"><a class="anchor hidden-xs" href="#compand" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-compand" aria-hidden="true">TOC</a></span></h3>
<p>Compress or expand the audio&rsquo;s dynamic range.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>attacks</samp></dt>
<dt><samp>decays</samp></dt>
<dd><p>A list of times in seconds for each channel over which the instantaneous level
of the input signal is averaged to determine its volume. <var>attacks</var> refers to
increase of volume and <var>decays</var> refers to decrease of volume. For most
situations, the attack time (response to the audio getting louder) should be
shorter than the decay time, because the human ear is more sensitive to sudden
loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and
a typical value for decay is 0.8 seconds.
If specified number of attacks &amp; decays is lower than number of channels, the last
set attack/decay will be used for all remaining channels.
</p>
</dd>
<dt><samp>points</samp></dt>
<dd><p>A list of points for the transfer function, specified in dB relative to the
maximum possible signal amplitude. Each key points list must be defined using
the following syntax: <code>x0/y0|x1/y1|x2/y2|....</code> or
<code>x0/y0 x1/y1 x2/y2 ....</code>
</p>
<p>The input values must be in strictly increasing order but the transfer function
does not have to be monotonically rising. The point <code>0/0</code> is assumed but
may be overridden (by <code>0/out-dBn</code>). Typical values for the transfer
function are <code>-70/-70|-60/-20</code>.
</p>
</dd>
<dt><samp>soft-knee</samp></dt>
<dd><p>Set the curve radius in dB for all joints. It defaults to 0.01.
</p>
</dd>
<dt><samp>gain</samp></dt>
<dd><p>Set the additional gain in dB to be applied at all points on the transfer
function. This allows for easy adjustment of the overall gain.
It defaults to 0.
</p>
</dd>
<dt><samp>volume</samp></dt>
<dd><p>Set an initial volume, in dB, to be assumed for each channel when filtering
starts. This permits the user to supply a nominal level initially, so that, for
example, a very large gain is not applied to initial signal levels before the
companding has begun to operate. A typical value for audio which is initially
quiet is -90 dB. It defaults to 0.
</p>
</dd>
<dt><samp>delay</samp></dt>
<dd><p>Set a delay, in seconds. The input audio is analyzed immediately, but audio is
delayed before being fed to the volume adjuster. Specifying a delay
approximately equal to the attack/decay times allows the filter to effectively
operate in predictive rather than reactive mode. It defaults to 0.
</p>
</dd>
</dl>
<a name="Examples-26"></a>
<h4 class="subsection">28.39.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-26" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-26" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Make music with both quiet and loud passages suitable for listening to in a
noisy environment:
<div class="example">
<pre class="example">compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
</pre></div>
<p>Another example for audio with whisper and explosion parts:
</p><div class="example">
<pre class="example">compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
</pre></div>
</li><li> A noise gate for when the noise is at a lower level than the signal:
<div class="example">
<pre class="example">compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
</pre></div>
</li><li> Here is another noise gate, this time for when the noise is at a higher level
than the signal (making it, in some ways, similar to squelch):
<div class="example">
<pre class="example">compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
</pre></div>
</li><li> 2:1 compression starting at -6dB:
<div class="example">
<pre class="example">compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
</pre></div>
</li><li> 2:1 compression starting at -9dB:
<div class="example">
<pre class="example">compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
</pre></div>
</li><li> 2:1 compression starting at -12dB:
<div class="example">
<pre class="example">compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
</pre></div>
</li><li> 2:1 compression starting at -18dB:
<div class="example">
<pre class="example">compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
</pre></div>
</li><li> 3:1 compression starting at -15dB:
<div class="example">
<pre class="example">compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
</pre></div>
</li><li> Compressor/Gate:
<div class="example">
<pre class="example">compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
</pre></div>
</li><li> Expander:
<div class="example">
<pre class="example">compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3
</pre></div>
</li><li> Hard limiter at -6dB:
<div class="example">
<pre class="example">compand=attacks=0:points=-80/-80|-6/-6|20/-6
</pre></div>
</li><li> Hard limiter at -12dB:
<div class="example">
<pre class="example">compand=attacks=0:points=-80/-80|-12/-12|20/-12
</pre></div>
</li><li> Hard noise gate at -35 dB:
<div class="example">
<pre class="example">compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
</pre></div>
</li><li> Soft limiter:
<div class="example">
<pre class="example">compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
</pre></div>
</li></ul>
<a name="compensationdelay"></a>
<h3 class="section">28.40 compensationdelay<span class="pull-right"><a class="anchor hidden-xs" href="#compensationdelay" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-compensationdelay" aria-hidden="true">TOC</a></span></h3>
<p>Compensation Delay Line is a metric based delay to compensate differing
positions of microphones or speakers.
</p>
<p>For example, you have recorded guitar with two microphones placed in
different location. Because the front of sound wave has fixed speed in
normal conditions, the phasing of microphones can vary and depends on
their location and interposition. The best sound mix can be achieved when
these microphones are in phase (synchronized). Note that distance of
~30 cm between microphones makes one microphone to capture signal in
antiphase to another microphone. That makes the final mix sounding moody.
This filter helps to solve phasing problems by adding different delays
to each microphone track and make them synchronized.
</p>
<p>The best result can be reached when you take one track as base and
synchronize other tracks one by one with it.
Remember that synchronization/delay tolerance depends on sample rate, too.
Higher sample rates will give more tolerance.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>mm</samp></dt>
<dd><p>Set millimeters distance. This is compensation distance for fine tuning.
Default is 0.
</p>
</dd>
<dt><samp>cm</samp></dt>
<dd><p>Set cm distance. This is compensation distance for tightening distance setup.
Default is 0.
</p>
</dd>
<dt><samp>m</samp></dt>
<dd><p>Set meters distance. This is compensation distance for hard distance setup.
Default is 0.
</p>
</dd>
<dt><samp>dry</samp></dt>
<dd><p>Set dry amount. Amount of unprocessed (dry) signal.
Default is 0.
</p>
</dd>
<dt><samp>wet</samp></dt>
<dd><p>Set wet amount. Amount of processed (wet) signal.
Default is 1.
</p>
</dd>
<dt><samp>temp</samp></dt>
<dd><p>Set temperature degree in Celsius. This is the temperature of the environment.
Default is 20.
</p></dd>
</dl>
<a name="crystalizer"></a>
<h3 class="section">28.41 crystalizer<span class="pull-right"><a class="anchor hidden-xs" href="#crystalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-crystalizer" aria-hidden="true">TOC</a></span></h3>
<p>Simple algorithm to expand audio dynamic range.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>i</samp></dt>
<dd><p>Sets the intensity of effect (default: 2.0). Must be in range between 0.0
(unchanged sound) to 10.0 (maximum effect).
</p>
</dd>
<dt><samp>c</samp></dt>
<dd><p>Enable clipping. By default is enabled.
</p></dd>
</dl>
<a name="dcshift"></a>
<h3 class="section">28.42 dcshift<span class="pull-right"><a class="anchor hidden-xs" href="#dcshift" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dcshift" aria-hidden="true">TOC</a></span></h3>
<p>Apply a DC shift to the audio.
</p>
<p>This can be useful to remove a DC offset (caused perhaps by a hardware problem
in the recording chain) from the audio. The effect of a DC offset is reduced
headroom and hence volume. The <a href="#astats">astats</a> filter can be used to determine if
a signal has a DC offset.
</p>
<dl compact="compact">
<dt><samp>shift</samp></dt>
<dd><p>Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
the audio.
</p>
</dd>
<dt><samp>limitergain</samp></dt>
<dd><p>Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
used to prevent clipping.
</p></dd>
</dl>
<a name="dynaudnorm"></a>
<h3 class="section">28.43 dynaudnorm<span class="pull-right"><a class="anchor hidden-xs" href="#dynaudnorm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dynaudnorm" aria-hidden="true">TOC</a></span></h3>
<p>Dynamic Audio Normalizer.
</p>
<p>This filter applies a certain amount of gain to the input audio in order
to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in
contrast to more &quot;simple&quot; normalization algorithms, the Dynamic Audio
Normalizer *dynamically* re-adjusts the gain factor to the input audio.
This allows for applying extra gain to the &quot;quiet&quot; sections of the audio
while avoiding distortions or clipping the &quot;loud&quot; sections. In other words:
The Dynamic Audio Normalizer will &quot;even out&quot; the volume of quiet and loud
sections, in the sense that the volume of each section is brought to the
same target level. Note, however, that the Dynamic Audio Normalizer achieves
this goal *without* applying &quot;dynamic range compressing&quot;. It will retain 100%
of the dynamic range *within* each section of the audio file.
</p>
<dl compact="compact">
<dt><samp>f</samp></dt>
<dd><p>Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
Default is 500 milliseconds.
The Dynamic Audio Normalizer processes the input audio in small chunks,
referred to as frames. This is required, because a peak magnitude has no
meaning for just a single sample value. Instead, we need to determine the
peak magnitude for a contiguous sequence of sample values. While a &quot;standard&quot;
normalizer would simply use the peak magnitude of the complete file, the
Dynamic Audio Normalizer determines the peak magnitude individually for each
frame. The length of a frame is specified in milliseconds. By default, the
Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has
been found to give good results with most files.
Note that the exact frame length, in number of samples, will be determined
automatically, based on the sampling rate of the individual input audio file.
</p>
</dd>
<dt><samp>g</samp></dt>
<dd><p>Set the Gaussian filter window size. In range from 3 to 301, must be odd
number. Default is 31.
Probably the most important parameter of the Dynamic Audio Normalizer is the
<code>window size</code> of the Gaussian smoothing filter. The filter&rsquo;s window size
is specified in frames, centered around the current frame. For the sake of
simplicity, this must be an odd number. Consequently, the default value of 31
takes into account the current frame, as well as the 15 preceding frames and
the 15 subsequent frames. Using a larger window results in a stronger
smoothing effect and thus in less gain variation, i.e. slower gain
adaptation. Conversely, using a smaller window results in a weaker smoothing
effect and thus in more gain variation, i.e. faster gain adaptation.
In other words, the more you increase this value, the more the Dynamic Audio
Normalizer will behave like a &quot;traditional&quot; normalization filter. On the
contrary, the more you decrease this value, the more the Dynamic Audio
Normalizer will behave like a dynamic range compressor.
</p>
</dd>
<dt><samp>p</samp></dt>
<dd><p>Set the target peak value. This specifies the highest permissible magnitude
level for the normalized audio input. This filter will try to approach the
target peak magnitude as closely as possible, but at the same time it also
makes sure that the normalized signal will never exceed the peak magnitude.
A frame&rsquo;s maximum local gain factor is imposed directly by the target peak
magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
It is not recommended to go above this value.
</p>
</dd>
<dt><samp>m</samp></dt>
<dd><p>Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
The Dynamic Audio Normalizer determines the maximum possible (local) gain
factor for each input frame, i.e. the maximum gain factor that does not
result in clipping or distortion. The maximum gain factor is determined by
the frame&rsquo;s highest magnitude sample. However, the Dynamic Audio Normalizer
additionally bounds the frame&rsquo;s maximum gain factor by a predetermined
(global) maximum gain factor. This is done in order to avoid excessive gain
factors in &quot;silent&quot; or almost silent frames. By default, the maximum gain
factor is 10.0, For most inputs the default value should be sufficient and
it usually is not recommended to increase this value. Though, for input
with an extremely low overall volume level, it may be necessary to allow even
higher gain factors. Note, however, that the Dynamic Audio Normalizer does
not simply apply a &quot;hard&quot; threshold (i.e. cut off values above the threshold).
Instead, a &quot;sigmoid&quot; threshold function will be applied. This way, the
gain factors will smoothly approach the threshold value, but never exceed that
value.
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
By default, the Dynamic Audio Normalizer performs &quot;peak&quot; normalization.
This means that the maximum local gain factor for each frame is defined
(only) by the frame&rsquo;s highest magnitude sample. This way, the samples can
be amplified as much as possible without exceeding the maximum signal
level, i.e. without clipping. Optionally, however, the Dynamic Audio
Normalizer can also take into account the frame&rsquo;s root mean square,
abbreviated RMS. In electrical engineering, the RMS is commonly used to
determine the power of a time-varying signal. It is therefore considered
that the RMS is a better approximation of the &quot;perceived loudness&quot; than
just looking at the signal&rsquo;s peak magnitude. Consequently, by adjusting all
frames to a constant RMS value, a uniform &quot;perceived loudness&quot; can be
established. If a target RMS value has been specified, a frame&rsquo;s local gain
factor is defined as the factor that would result in exactly that RMS value.
Note, however, that the maximum local gain factor is still restricted by the
frame&rsquo;s highest magnitude sample, in order to prevent clipping.
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>Enable channels coupling. By default is enabled.
By default, the Dynamic Audio Normalizer will amplify all channels by the same
amount. This means the same gain factor will be applied to all channels, i.e.
the maximum possible gain factor is determined by the &quot;loudest&quot; channel.
However, in some recordings, it may happen that the volume of the different
channels is uneven, e.g. one channel may be &quot;quieter&quot; than the other one(s).
In this case, this option can be used to disable the channel coupling. This way,
the gain factor will be determined independently for each channel, depending
only on the individual channel&rsquo;s highest magnitude sample. This allows for
harmonizing the volume of the different channels.
</p>
</dd>
<dt><samp>c</samp></dt>
<dd><p>Enable DC bias correction. By default is disabled.
An audio signal (in the time domain) is a sequence of sample values.
In the Dynamic Audio Normalizer these sample values are represented in the
-1.0 to 1.0 range, regardless of the original input format. Normally, the
audio signal, or &quot;waveform&quot;, should be centered around the zero point.
That means if we calculate the mean value of all samples in a file, or in a
single frame, then the result should be 0.0 or at least very close to that
value. If, however, there is a significant deviation of the mean value from
0.0, in either positive or negative direction, this is referred to as a
DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic
Audio Normalizer provides optional DC bias correction.
With DC bias correction enabled, the Dynamic Audio Normalizer will determine
the mean value, or &quot;DC correction&quot; offset, of each input frame and subtract
that value from all of the frame&rsquo;s sample values which ensures those samples
are centered around 0.0 again. Also, in order to avoid &quot;gaps&quot; at the frame
boundaries, the DC correction offset values will be interpolated smoothly
between neighbouring frames.
</p>
</dd>
<dt><samp>b</samp></dt>
<dd><p>Enable alternative boundary mode. By default is disabled.
The Dynamic Audio Normalizer takes into account a certain neighbourhood
around each frame. This includes the preceding frames as well as the
subsequent frames. However, for the &quot;boundary&quot; frames, located at the very
beginning and at the very end of the audio file, not all neighbouring
frames are available. In particular, for the first few frames in the audio
file, the preceding frames are not known. And, similarly, for the last few
frames in the audio file, the subsequent frames are not known. Thus, the
question arises which gain factors should be assumed for the missing frames
in the &quot;boundary&quot; region. The Dynamic Audio Normalizer implements two modes
to deal with this situation. The default boundary mode assumes a gain factor
of exactly 1.0 for the missing frames, resulting in a smooth &quot;fade in&quot; and
&quot;fade out&quot; at the beginning and at the end of the input, respectively.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
By default, the Dynamic Audio Normalizer does not apply &quot;traditional&quot;
compression. This means that signal peaks will not be pruned and thus the
full dynamic range will be retained within each local neighbourhood. However,
in some cases it may be desirable to combine the Dynamic Audio Normalizer&rsquo;s
normalization algorithm with a more &quot;traditional&quot; compression.
For this purpose, the Dynamic Audio Normalizer provides an optional compression
(thresholding) function. If (and only if) the compression feature is enabled,
all input frames will be processed by a soft knee thresholding function prior
to the actual normalization process. Put simply, the thresholding function is
going to prune all samples whose magnitude exceeds a certain threshold value.
However, the Dynamic Audio Normalizer does not simply apply a fixed threshold
value. Instead, the threshold value will be adjusted for each individual
frame.
In general, smaller parameters result in stronger compression, and vice versa.
Values below 3.0 are not recommended, because audible distortion may appear.
</p></dd>
</dl>
<a name="earwax"></a>
<h3 class="section">28.44 earwax<span class="pull-right"><a class="anchor hidden-xs" href="#earwax" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-earwax" aria-hidden="true">TOC</a></span></h3>
<p>Make audio easier to listen to on headphones.
</p>
<p>This filter adds &lsquo;cues&rsquo; to 44.1kHz stereo (i.e. audio CD format) audio
so that when listened to on headphones the stereo image is moved from
inside your head (standard for headphones) to outside and in front of
the listener (standard for speakers).
</p>
<p>Ported from SoX.
</p>
<a name="equalizer"></a>
<h3 class="section">28.45 equalizer<span class="pull-right"><a class="anchor hidden-xs" href="#equalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-equalizer" aria-hidden="true">TOC</a></span></h3>
<p>Apply a two-pole peaking equalisation (EQ) filter. With this
filter, the signal-level at and around a selected frequency can
be increased or decreased, whilst (unlike bandpass and bandreject
filters) that at all other frequencies is unchanged.
</p>
<p>In order to produce complex equalisation curves, this filter can
be given several times, each with a different central frequency.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the filter&rsquo;s central frequency in Hz.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p>
</dd>
<dt><samp>gain, g</samp></dt>
<dd><p>Set the required gain or attenuation in dB.
Beware of clipping when using a positive gain.
</p></dd>
</dl>
<a name="Examples-27"></a>
<h4 class="subsection">28.45.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-27" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-27" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
<div class="example">
<pre class="example">equalizer=f=1000:width_type=h:width=200:g=-10
</pre></div>
</li><li> Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2:
<div class="example">
<pre class="example">equalizer=f=1000:width_type=q:width=1:g=2,equalizer=f=100:width_type=q:width=2:g=-5
</pre></div>
</li></ul>
<a name="extrastereo"></a>
<h3 class="section">28.46 extrastereo<span class="pull-right"><a class="anchor hidden-xs" href="#extrastereo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-extrastereo" aria-hidden="true">TOC</a></span></h3>
<p>Linearly increases the difference between left and right channels which
adds some sort of &quot;live&quot; effect to playback.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>m</samp></dt>
<dd><p>Sets the difference coefficient (default: 2.5). 0.0 means mono sound
(average of both channels), with 1.0 sound will be unchanged, with
-1.0 left and right channels will be swapped.
</p>
</dd>
<dt><samp>c</samp></dt>
<dd><p>Enable clipping. By default is enabled.
</p></dd>
</dl>
<a name="firequalizer"></a>
<h3 class="section">28.47 firequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#firequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-firequalizer" aria-hidden="true">TOC</a></span></h3>
<p>Apply FIR Equalization using arbitrary frequency response.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>gain</samp></dt>
<dd><p>Set gain curve equation (in dB). The expression can contain variables:
</p><dl compact="compact">
<dt><samp>f</samp></dt>
<dd><p>the evaluated frequency
</p></dd>
<dt><samp>sr</samp></dt>
<dd><p>sample rate
</p></dd>
<dt><samp>ch</samp></dt>
<dd><p>channel number, set to 0 when multichannels evaluation is disabled
</p></dd>
<dt><samp>chid</samp></dt>
<dd><p>channel id, see libavutil/channel_layout.h, set to the first channel id when
multichannels evaluation is disabled
</p></dd>
<dt><samp>chs</samp></dt>
<dd><p>number of channels
</p></dd>
<dt><samp>chlayout</samp></dt>
<dd><p>channel_layout, see libavutil/channel_layout.h
</p>
</dd>
</dl>
<p>and functions:
</p><dl compact="compact">
<dt><samp>gain_interpolate(f)</samp></dt>
<dd><p>interpolate gain on frequency f based on gain_entry
</p></dd>
</dl>
<p>This option is also available as command. Default is <code>gain_interpolate(f)</code>.
</p>
</dd>
<dt><samp>gain_entry</samp></dt>
<dd><p>Set gain entry for gain_interpolate function. The expression can
contain functions:
</p><dl compact="compact">
<dt><samp>entry(f, g)</samp></dt>
<dd><p>store gain entry at frequency f with value g
</p></dd>
</dl>
<p>This option is also available as command.
</p>
</dd>
<dt><samp>delay</samp></dt>
<dd><p>Set filter delay in seconds. Higher value means more accurate.
Default is <code>0.01</code>.
</p>
</dd>
<dt><samp>accuracy</samp></dt>
<dd><p>Set filter accuracy in Hz. Lower value means more accurate.
Default is <code>5</code>.
</p>
</dd>
<dt><samp>wfunc</samp></dt>
<dd><p>Set window function. Acceptable values are:
</p><dl compact="compact">
<dt><samp>rectangular</samp></dt>
<dd><p>rectangular window, useful when gain curve is already smooth
</p></dd>
<dt><samp>hann</samp></dt>
<dd><p>hann window (default)
</p></dd>
<dt><samp>hamming</samp></dt>
<dd><p>hamming window
</p></dd>
<dt><samp>blackman</samp></dt>
<dd><p>blackman window
</p></dd>
<dt><samp>nuttall3</samp></dt>
<dd><p>3-terms continuous 1st derivative nuttall window
</p></dd>
<dt><samp>mnuttall3</samp></dt>
<dd><p>minimum 3-terms discontinuous nuttall window
</p></dd>
<dt><samp>nuttall</samp></dt>
<dd><p>4-terms continuous 1st derivative nuttall window
</p></dd>
<dt><samp>bnuttall</samp></dt>
<dd><p>minimum 4-terms discontinuous nuttall (blackman-nuttall) window
</p></dd>
<dt><samp>bharris</samp></dt>
<dd><p>blackman-harris window
</p></dd>
</dl>
</dd>
<dt><samp>fixed</samp></dt>
<dd><p>If enabled, use fixed number of audio samples. This improves speed when
filtering with large delay. Default is disabled.
</p>
</dd>
<dt><samp>multi</samp></dt>
<dd><p>Enable multichannels evaluation on gain. Default is disabled.
</p>
</dd>
<dt><samp>zero_phase</samp></dt>
<dd><p>Enable zero phase mode by subtracting timestamp to compensate delay.
Default is disabled.
</p></dd>
</dl>
<a name="Examples-28"></a>
<h4 class="subsection">28.47.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-28" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-28" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> lowpass at 1000 Hz:
<div class="example">
<pre class="example">firequalizer=gain='if(lt(f,1000), 0, -INF)'
</pre></div>
</li><li> lowpass at 1000 Hz with gain_entry:
<div class="example">
<pre class="example">firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
</pre></div>
</li><li> custom equalization:
<div class="example">
<pre class="example">firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
</pre></div>
</li><li> higher delay with zero phase to compensate delay:
<div class="example">
<pre class="example">firequalizer=delay=0.1:fixed=on:zero_phase=on
</pre></div>
</li><li> lowpass on left channel, highpass on right channel:
<div class="example">
<pre class="example">firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
:gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
</pre></div>
</li></ul>
<a name="flanger"></a>
<h3 class="section">28.48 flanger<span class="pull-right"><a class="anchor hidden-xs" href="#flanger" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flanger" aria-hidden="true">TOC</a></span></h3>
<p>Apply a flanging effect to the audio.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>delay</samp></dt>
<dd><p>Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
</p>
</dd>
<dt><samp>depth</samp></dt>
<dd><p>Set added swep delay in milliseconds. Range from 0 to 10. Default value is 2.
</p>
</dd>
<dt><samp>regen</samp></dt>
<dd><p>Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
Default value is 0.
</p>
</dd>
<dt><samp>width</samp></dt>
<dd><p>Set percentage of delayed signal mixed with original. Range from 0 to 100.
Default value is 71.
</p>
</dd>
<dt><samp>speed</samp></dt>
<dd><p>Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
</p>
</dd>
<dt><samp>shape</samp></dt>
<dd><p>Set swept wave shape, can be <var>triangular</var> or <var>sinusoidal</var>.
Default value is <var>sinusoidal</var>.
</p>
</dd>
<dt><samp>phase</samp></dt>
<dd><p>Set swept wave percentage-shift for multi channel. Range from 0 to 100.
Default value is 25.
</p>
</dd>
<dt><samp>interp</samp></dt>
<dd><p>Set delay-line interpolation, <var>linear</var> or <var>quadratic</var>.
Default is <var>linear</var>.
</p></dd>
</dl>
<a name="hdcd"></a>
<h3 class="section">28.49 hdcd<span class="pull-right"><a class="anchor hidden-xs" href="#hdcd" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hdcd" aria-hidden="true">TOC</a></span></h3>
<p>Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with
embedded HDCD codes is expanded into a 20-bit PCM stream.
</p>
<p>The filter supports the Peak Extend and Low-level Gain Adjustment features
of HDCD, and detects the Transient Filter flag.
</p>
<div class="example">
<pre class="example">ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
</pre></div>
<p>When using the filter with wav, note the default encoding for wav is 16-bit,
so the resulting 20-bit stream will be truncated back to 16-bit. Use something
like <code>-acodec pcm_s24le</code> after the filter to get 24-bit PCM output.
</p><div class="example">
<pre class="example">ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
ffmpeg -i HDCD16.wav -af hdcd -acodec pcm_s24le OUT24.wav
</pre></div>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>disable_autoconvert</samp></dt>
<dd><p>Disable any automatic format conversion or resampling in the filter graph.
</p>
</dd>
<dt><samp>process_stereo</samp></dt>
<dd><p>Process the stereo channels together. If target_gain does not match between
channels, consider it invalid and use the last valid target_gain.
</p>
</dd>
<dt><samp>cdt_ms</samp></dt>
<dd><p>Set the code detect timer period in ms.
</p>
</dd>
<dt><samp>force_pe</samp></dt>
<dd><p>Always extend peaks above -3dBFS even if PE isn&rsquo;t signaled.
</p>
</dd>
<dt><samp>analyze_mode</samp></dt>
<dd><p>Replace audio with a solid tone and adjust the amplitude to signal some
specific aspect of the decoding process. The output file can be loaded in
an audio editor alongside the original to aid analysis.
</p>
<p><code>analyze_mode=pe:force_pe=true</code> can be used to see all samples above the PE level.
</p>
<p>Modes are:
</p><dl compact="compact">
<dt>&lsquo;<samp>0, off</samp>&rsquo;</dt>
<dd><p>Disabled
</p></dd>
<dt>&lsquo;<samp>1, lle</samp>&rsquo;</dt>
<dd><p>Gain adjustment level at each sample
</p></dd>
<dt>&lsquo;<samp>2, pe</samp>&rsquo;</dt>
<dd><p>Samples where peak extend occurs
</p></dd>
<dt>&lsquo;<samp>3, cdt</samp>&rsquo;</dt>
<dd><p>Samples where the code detect timer is active
</p></dd>
<dt>&lsquo;<samp>4, tgm</samp>&rsquo;</dt>
<dd><p>Samples where the target gain does not match between channels
</p></dd>
</dl>
</dd>
</dl>
<a name="highpass"></a>
<h3 class="section">28.50 highpass<span class="pull-right"><a class="anchor hidden-xs" href="#highpass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-highpass" aria-hidden="true">TOC</a></span></h3>
<p>Apply a high-pass filter with 3dB point frequency.
The filter can be either single-pole, or double-pole (the default).
The filter roll off at 6dB per pole per octave (20dB per pole per decade).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set frequency in Hz. Default is 3000.
</p>
</dd>
<dt><samp>poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
Applies only to double-pole filter.
The default is 0.707q and gives a Butterworth response.
</p></dd>
</dl>
<a name="join"></a>
<h3 class="section">28.51 join<span class="pull-right"><a class="anchor hidden-xs" href="#join" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-join" aria-hidden="true">TOC</a></span></h3>
<p>Join multiple input streams into one multi-channel stream.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>The number of input streams. It defaults to 2.
</p>
</dd>
<dt><samp>channel_layout</samp></dt>
<dd><p>The desired output channel layout. It defaults to stereo.
</p>
</dd>
<dt><samp>map</samp></dt>
<dd><p>Map channels from inputs to output. The argument is a &rsquo;|&rsquo;-separated list of
mappings, each in the <code><var>input_idx</var>.<var>in_channel</var>-<var>out_channel</var></code>
form. <var>input_idx</var> is the 0-based index of the input stream. <var>in_channel</var>
can be either the name of the input channel (e.g. FL for front left) or its
index in the specified input stream. <var>out_channel</var> is the name of the output
channel.
</p></dd>
</dl>
<p>The filter will attempt to guess the mappings when they are not specified
explicitly. It does so by first trying to find an unused matching input channel
and if that fails it picks the first unused input channel.
</p>
<p>Join 3 inputs (with properly set channel layouts):
</p><div class="example">
<pre class="example">ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
</pre></div>
<p>Build a 5.1 output from 6 single-channel streams:
</p><div class="example">
<pre class="example">ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
out
</pre></div>
<a name="ladspa"></a>
<h3 class="section">28.52 ladspa<span class="pull-right"><a class="anchor hidden-xs" href="#ladspa" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ladspa" aria-hidden="true">TOC</a></span></h3>
<p>Load a LADSPA (Linux Audio Developer&rsquo;s Simple Plugin API) plugin.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-ladspa</code>.
</p>
<dl compact="compact">
<dt><samp>file, f</samp></dt>
<dd><p>Specifies the name of LADSPA plugin library to load. If the environment
variable <code>LADSPA_PATH</code> is defined, the LADSPA plugin is searched in
each one of the directories specified by the colon separated list in
<code>LADSPA_PATH</code>, otherwise in the standard LADSPA paths, which are in
this order: <samp>HOME/.ladspa/lib/</samp>, <samp>/usr/local/lib/ladspa/</samp>,
<samp>/usr/lib/ladspa/</samp>.
</p>
</dd>
<dt><samp>plugin, p</samp></dt>
<dd><p>Specifies the plugin within the library. Some libraries contain only
one plugin, but others contain many of them. If this is not set filter
will list all available plugins within the specified library.
</p>
</dd>
<dt><samp>controls, c</samp></dt>
<dd><p>Set the &rsquo;|&rsquo; separated list of controls which are zero or more floating point
values that determine the behavior of the loaded plugin (for example delay,
threshold or gain).
Controls need to be defined using the following syntax:
c0=<var>value0</var>|c1=<var>value1</var>|c2=<var>value2</var>|..., where
<var>valuei</var> is the value set on the <var>i</var>-th control.
Alternatively they can be also defined using the following syntax:
<var>value0</var>|<var>value1</var>|<var>value2</var>|..., where
<var>valuei</var> is the value set on the <var>i</var>-th control.
If <samp>controls</samp> is set to <code>help</code>, all available controls and
their valid ranges are printed.
</p>
</dd>
<dt><samp>sample_rate, s</samp></dt>
<dd><p>Specify the sample rate, default to 44100. Only used if plugin have
zero inputs.
</p>
</dd>
<dt><samp>nb_samples, n</samp></dt>
<dd><p>Set the number of samples per channel per each output frame, default
is 1024. Only used if plugin have zero inputs.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Set the minimum duration of the sourced audio. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
Note that the resulting duration may be greater than the specified duration,
as the generated audio is always cut at the end of a complete frame.
If not specified, or the expressed duration is negative, the audio is
supposed to be generated forever.
Only used if plugin have zero inputs.
</p>
</dd>
</dl>
<a name="Examples-29"></a>
<h4 class="subsection">28.52.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-29" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-29" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> List all available plugins within amp (LADSPA example plugin) library:
<div class="example">
<pre class="example">ladspa=file=amp
</pre></div>
</li><li> List all available controls and their valid ranges for <code>vcf_notch</code>
plugin from <code>VCF</code> library:
<div class="example">
<pre class="example">ladspa=f=vcf:p=vcf_notch:c=help
</pre></div>
</li><li> Simulate low quality audio equipment using <code>Computer Music Toolkit</code> (CMT)
plugin library:
<div class="example">
<pre class="example">ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
</pre></div>
</li><li> Add reverberation to the audio using TAP-plugins
(Tom&rsquo;s Audio Processing plugins):
<div class="example">
<pre class="example">ladspa=file=tap_reverb:tap_reverb
</pre></div>
</li><li> Generate white noise, with 0.2 amplitude:
<div class="example">
<pre class="example">ladspa=file=cmt:noise_source_white:c=c0=.2
</pre></div>
</li><li> Generate 20 bpm clicks using plugin <code>C* Click - Metronome</code> from the
<code>C* Audio Plugin Suite</code> (CAPS) library:
<div class="example">
<pre class="example">ladspa=file=caps:Click:c=c1=20'
</pre></div>
</li><li> Apply <code>C* Eq10X2 - Stereo 10-band equaliser</code> effect:
<div class="example">
<pre class="example">ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
</pre></div>
</li><li> Increase volume by 20dB using fast lookahead limiter from Steve Harris
<code>SWH Plugins</code> collection:
<div class="example">
<pre class="example">ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
</pre></div>
</li><li> Attenuate low frequencies using Multiband EQ from Steve Harris
<code>SWH Plugins</code> collection:
<div class="example">
<pre class="example">ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
</pre></div>
</li></ul>
<a name="Commands-1"></a>
<h4 class="subsection">28.52.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-1" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>cN</samp></dt>
<dd><p>Modify the <var>N</var>-th control value.
</p>
<p>If the specified value is not valid, it is ignored and prior one is kept.
</p></dd>
</dl>
<a name="loudnorm"></a>
<h3 class="section">28.53 loudnorm<span class="pull-right"><a class="anchor hidden-xs" href="#loudnorm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-loudnorm" aria-hidden="true">TOC</a></span></h3>
<p>EBU R128 loudness normalization. Includes both dynamic and linear normalization modes.
Support for both single pass (livestreams, files) and double pass (files) modes.
This algorithm can target IL, LRA, and maximum true peak.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-libebur128</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>I, i</samp></dt>
<dd><p>Set integrated loudness target.
Range is -70.0 - -5.0. Default value is -24.0.
</p>
</dd>
<dt><samp>LRA, lra</samp></dt>
<dd><p>Set loudness range target.
Range is 1.0 - 20.0. Default value is 7.0.
</p>
</dd>
<dt><samp>TP, tp</samp></dt>
<dd><p>Set maximum true peak.
Range is -9.0 - +0.0. Default value is -2.0.
</p>
</dd>
<dt><samp>measured_I, measured_i</samp></dt>
<dd><p>Measured IL of input file.
Range is -99.0 - +0.0.
</p>
</dd>
<dt><samp>measured_LRA, measured_lra</samp></dt>
<dd><p>Measured LRA of input file.
Range is 0.0 - 99.0.
</p>
</dd>
<dt><samp>measured_TP, measured_tp</samp></dt>
<dd><p>Measured true peak of input file.
Range is -99.0 - +99.0.
</p>
</dd>
<dt><samp>measured_thresh</samp></dt>
<dd><p>Measured threshold of input file.
Range is -99.0 - +0.0.
</p>
</dd>
<dt><samp>offset</samp></dt>
<dd><p>Set offset gain. Gain is applied before the true-peak limiter.
Range is -99.0 - +99.0. Default is +0.0.
</p>
</dd>
<dt><samp>linear</samp></dt>
<dd><p>Normalize linearly if possible.
measured_I, measured_LRA, measured_TP, and measured_thresh must also
to be specified in order to use this mode.
Options are true or false. Default is true.
</p>
</dd>
<dt><samp>dual_mono</samp></dt>
<dd><p>Treat mono input files as &quot;dual-mono&quot;. If a mono file is intended for playback
on a stereo system, its EBU R128 measurement will be perceptually incorrect.
If set to <code>true</code>, this option will compensate for this effect.
Multi-channel input files are not affected by this option.
Options are true or false. Default is false.
</p>
</dd>
<dt><samp>print_format</samp></dt>
<dd><p>Set print format for stats. Options are summary, json, or none.
Default value is none.
</p></dd>
</dl>
<a name="lowpass"></a>
<h3 class="section">28.54 lowpass<span class="pull-right"><a class="anchor hidden-xs" href="#lowpass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lowpass" aria-hidden="true">TOC</a></span></h3>
<p>Apply a low-pass filter with 3dB point frequency.
The filter can be either single-pole or double-pole (the default).
The filter roll off at 6dB per pole per octave (20dB per pole per decade).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set frequency in Hz. Default is 500.
</p>
</dd>
<dt><samp>poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
Applies only to double-pole filter.
The default is 0.707q and gives a Butterworth response.
</p></dd>
</dl>
<a name="pan"></a><a name="pan-1"></a>
<h3 class="section">28.55 pan<span class="pull-right"><a class="anchor hidden-xs" href="#pan-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pan-1" aria-hidden="true">TOC</a></span></h3>
<p>Mix channels with specific gain levels. The filter accepts the output
channel layout followed by a set of channels definitions.
</p>
<p>This filter is also designed to efficiently remap the channels of an audio
stream.
</p>
<p>The filter accepts parameters of the form:
&quot;<var>l</var>|<var>outdef</var>|<var>outdef</var>|...&quot;
</p>
<dl compact="compact">
<dt><samp>l</samp></dt>
<dd><p>output channel layout or number of channels
</p>
</dd>
<dt><samp>outdef</samp></dt>
<dd><p>output channel specification, of the form:
&quot;<var>out_name</var>=[<var>gain</var>*]<var>in_name</var>[+[<var>gain</var>*]<var>in_name</var>...]&quot;
</p>
</dd>
<dt><samp>out_name</samp></dt>
<dd><p>output channel to define, either a channel name (FL, FR, etc.) or a channel
number (c0, c1, etc.)
</p>
</dd>
<dt><samp>gain</samp></dt>
<dd><p>multiplicative coefficient for the channel, 1 leaving the volume unchanged
</p>
</dd>
<dt><samp>in_name</samp></dt>
<dd><p>input channel to use, see out_name for details; it is not possible to mix
named and numbered input channels
</p></dd>
</dl>
<p>If the &lsquo;=&rsquo; in a channel specification is replaced by &lsquo;&lt;&rsquo;, then the gains for
that specification will be renormalized so that the total is 1, thus
avoiding clipping noise.
</p>
<a name="Mixing-examples"></a>
<h4 class="subsection">28.55.1 Mixing examples<span class="pull-right"><a class="anchor hidden-xs" href="#Mixing-examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Mixing-examples" aria-hidden="true">TOC</a></span></h4>
<p>For example, if you want to down-mix from stereo to mono, but with a bigger
factor for the left channel:
</p><div class="example">
<pre class="example">pan=1c|c0=0.9*c0+0.1*c1
</pre></div>
<p>A customized down-mix to stereo that works automatically for 3-, 4-, 5- and
7-channels surround:
</p><div class="example">
<pre class="example">pan=stereo| FL &lt; FL + 0.5*FC + 0.6*BL + 0.6*SL | FR &lt; FR + 0.5*FC + 0.6*BR + 0.6*SR
</pre></div>
<p>Note that <code>ffmpeg</code> integrates a default down-mix (and up-mix) system
that should be preferred (see &quot;-ac&quot; option) unless you have very specific
needs.
</p>
<a name="Remapping-examples"></a>
<h4 class="subsection">28.55.2 Remapping examples<span class="pull-right"><a class="anchor hidden-xs" href="#Remapping-examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Remapping-examples" aria-hidden="true">TOC</a></span></h4>
<p>The channel remapping will be effective if, and only if:
</p>
<ul>
<li> gain coefficients are zeroes or ones,
</li><li> only one input per channel output,
</li></ul>
<p>If all these conditions are satisfied, the filter will notify the user (&quot;Pure
channel mapping detected&quot;), and use an optimized and lossless method to do the
remapping.
</p>
<p>For example, if you have a 5.1 source and want a stereo audio stream by
dropping the extra channels:
</p><div class="example">
<pre class="example">pan=&quot;stereo| c0=FL | c1=FR&quot;
</pre></div>
<p>Given the same source, you can also switch front left and front right channels
and keep the input channel layout:
</p><div class="example">
<pre class="example">pan=&quot;5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5&quot;
</pre></div>
<p>If the input is a stereo audio stream, you can mute the front left channel (and
still keep the stereo channel layout) with:
</p><div class="example">
<pre class="example">pan=&quot;stereo|c1=c1&quot;
</pre></div>
<p>Still with a stereo audio stream input, you can copy the right channel in both
front left and right:
</p><div class="example">
<pre class="example">pan=&quot;stereo| c0=FR | c1=FR&quot;
</pre></div>
<a name="replaygain"></a>
<h3 class="section">28.56 replaygain<span class="pull-right"><a class="anchor hidden-xs" href="#replaygain" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-replaygain" aria-hidden="true">TOC</a></span></h3>
<p>ReplayGain scanner filter. This filter takes an audio stream as an input and
outputs it unchanged.
At end of filtering it displays <code>track_gain</code> and <code>track_peak</code>.
</p>
<a name="resample"></a>
<h3 class="section">28.57 resample<span class="pull-right"><a class="anchor hidden-xs" href="#resample" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-resample" aria-hidden="true">TOC</a></span></h3>
<p>Convert the audio sample format, sample rate and channel layout. It is
not meant to be used directly.
</p>
<a name="rubberband"></a>
<h3 class="section">28.58 rubberband<span class="pull-right"><a class="anchor hidden-xs" href="#rubberband" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rubberband" aria-hidden="true">TOC</a></span></h3>
<p>Apply time-stretching and pitch-shifting with librubberband.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>tempo</samp></dt>
<dd><p>Set tempo scale factor.
</p>
</dd>
<dt><samp>pitch</samp></dt>
<dd><p>Set pitch scale factor.
</p>
</dd>
<dt><samp>transients</samp></dt>
<dd><p>Set transients detector.
Possible values are:
</p><dl compact="compact">
<dt><var>crisp</var></dt>
<dt><var>mixed</var></dt>
<dt><var>smooth</var></dt>
</dl>
</dd>
<dt><samp>detector</samp></dt>
<dd><p>Set detector.
Possible values are:
</p><dl compact="compact">
<dt><var>compound</var></dt>
<dt><var>percussive</var></dt>
<dt><var>soft</var></dt>
</dl>
</dd>
<dt><samp>phase</samp></dt>
<dd><p>Set phase.
Possible values are:
</p><dl compact="compact">
<dt><var>laminar</var></dt>
<dt><var>independent</var></dt>
</dl>
</dd>
<dt><samp>window</samp></dt>
<dd><p>Set processing window size.
Possible values are:
</p><dl compact="compact">
<dt><var>standard</var></dt>
<dt><var>short</var></dt>
<dt><var>long</var></dt>
</dl>
</dd>
<dt><samp>smoothing</samp></dt>
<dd><p>Set smoothing.
Possible values are:
</p><dl compact="compact">
<dt><var>off</var></dt>
<dt><var>on</var></dt>
</dl>
</dd>
<dt><samp>formant</samp></dt>
<dd><p>Enable formant preservation when shift pitching.
Possible values are:
</p><dl compact="compact">
<dt><var>shifted</var></dt>
<dt><var>preserved</var></dt>
</dl>
</dd>
<dt><samp>pitchq</samp></dt>
<dd><p>Set pitch quality.
Possible values are:
</p><dl compact="compact">
<dt><var>quality</var></dt>
<dt><var>speed</var></dt>
<dt><var>consistency</var></dt>
</dl>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set channels.
Possible values are:
</p><dl compact="compact">
<dt><var>apart</var></dt>
<dt><var>together</var></dt>
</dl>
</dd>
</dl>
<a name="sidechaincompress"></a>
<h3 class="section">28.59 sidechaincompress<span class="pull-right"><a class="anchor hidden-xs" href="#sidechaincompress" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sidechaincompress" aria-hidden="true">TOC</a></span></h3>
<p>This filter acts like normal compressor but has the ability to compress
detected signal using second input signal.
It needs two input streams and returns one output stream.
First input stream will be processed depending on second stream signal.
The filtered signal then can be filtered with other filters in later stages of
processing. See <a href="#pan">pan</a> and <a href="#amerge">amerge</a> filter.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>If a signal of second stream raises above this level it will affect the gain
reduction of first stream.
By default is 0.125. Range is between 0.00097563 and 1.
</p>
</dd>
<dt><samp>ratio</samp></dt>
<dd><p>Set a ratio about which the signal is reduced. 1:2 means that if the level
raised 4dB above the threshold, it will be only 2dB above after the reduction.
Default is 2. Range is between 1 and 20.
</p>
</dd>
<dt><samp>attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction starts. Default is 20. Range is between 0.01 and 2000.
</p>
</dd>
<dt><samp>release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before
reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
</p>
</dd>
<dt><samp>makeup</samp></dt>
<dd><p>Set the amount by how much signal will be amplified after processing.
Default is 2. Range is from 1 and 64.
</p>
</dd>
<dt><samp>knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.82843. Range is between 1 and 8.
</p>
</dd>
<dt><samp>link</samp></dt>
<dd><p>Choose if the <code>average</code> level between all channels of side-chain stream
or the louder(<code>maximum</code>) channel of side-chain stream affects the
reduction. Default is <code>average</code>.
</p>
</dd>
<dt><samp>detection</samp></dt>
<dd><p>Should the exact signal be taken in case of <code>peak</code> or an RMS one in case
of <code>rms</code>. Default is <code>rms</code> which is mainly smoother.
</p>
</dd>
<dt><samp>level_sc</samp></dt>
<dd><p>Set sidechain gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp>mix</samp></dt>
<dd><p>How much to use compressed signal in output. Default is 1.
Range is between 0 and 1.
</p></dd>
</dl>
<a name="Examples-30"></a>
<h4 class="subsection">28.59.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-30" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-30" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Full ffmpeg example taking 2 audio inputs, 1st input to be compressed
depending on the signal of 2nd input and later compressed signal to be
merged with 2nd input:
<div class="example">
<pre class="example">ffmpeg -i main.flac -i sidechain.flac -filter_complex &quot;[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge&quot;
</pre></div>
</li></ul>
<a name="sidechaingate"></a>
<h3 class="section">28.60 sidechaingate<span class="pull-right"><a class="anchor hidden-xs" href="#sidechaingate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sidechaingate" aria-hidden="true">TOC</a></span></h3>
<p>A sidechain gate acts like a normal (wideband) gate but has the ability to
filter the detected signal before sending it to the gain reduction stage.
Normally a gate uses the full range signal to detect a level above the
threshold.
For example: If you cut all lower frequencies from your sidechain signal
the gate will decrease the volume of your track only if not enough highs
appear. With this technique you are able to reduce the resonation of a
natural drum or remove &quot;rumbling&quot; of muted strokes from a heavily distorted
guitar.
It needs two input streams and returns one output stream.
First input stream will be processed depending on second stream signal.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input level before filtering.
Default is 1. Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>range</samp></dt>
<dd><p>Set the level of gain reduction when the signal is below the threshold.
Default is 0.06125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>If a signal rises above this level the gain reduction is released.
Default is 0.125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp>ratio</samp></dt>
<dd><p>Set a ratio about which the signal is reduced.
Default is 2. Allowed range is from 1 to 9000.
</p>
</dd>
<dt><samp>attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction stops.
Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp>release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before the
reduction is increased again. Default is 250 milliseconds.
Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp>makeup</samp></dt>
<dd><p>Set amount of amplification of signal after processing.
Default is 1. Allowed range is from 1 to 64.
</p>
</dd>
<dt><samp>knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.828427125. Allowed range is from 1 to 8.
</p>
</dd>
<dt><samp>detection</samp></dt>
<dd><p>Choose if exact signal should be taken for detection or an RMS like one.
Default is rms. Can be peak or rms.
</p>
</dd>
<dt><samp>link</samp></dt>
<dd><p>Choose if the average level between all channels or the louder channel affects
the reduction.
Default is average. Can be average or maximum.
</p>
</dd>
<dt><samp>level_sc</samp></dt>
<dd><p>Set sidechain gain. Default is 1. Range is from 0.015625 to 64.
</p></dd>
</dl>
<a name="silencedetect"></a>
<h3 class="section">28.61 silencedetect<span class="pull-right"><a class="anchor hidden-xs" href="#silencedetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-silencedetect" aria-hidden="true">TOC</a></span></h3>
<p>Detect silence in an audio stream.
</p>
<p>This filter logs a message when it detects that the input audio volume is less
or equal to a noise tolerance value for a duration greater or equal to the
minimum detected noise duration.
</p>
<p>The printed times and duration are expressed in seconds.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>duration, d</samp></dt>
<dd><p>Set silence duration until notification (default is 2 seconds).
</p>
</dd>
<dt><samp>noise, n</samp></dt>
<dd><p>Set noise tolerance. Can be specified in dB (in case &quot;dB&quot; is appended to the
specified value) or amplitude ratio. Default is -60dB, or 0.001.
</p></dd>
</dl>
<a name="Examples-31"></a>
<h4 class="subsection">28.61.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-31" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-31" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Detect 5 seconds of silence with -50dB noise tolerance:
<div class="example">
<pre class="example">silencedetect=n=-50dB:d=5
</pre></div>
</li><li> Complete example with <code>ffmpeg</code> to detect silence with 0.0001 noise
tolerance in <samp>silence.mp3</samp>:
<div class="example">
<pre class="example">ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
</pre></div>
</li></ul>
<a name="silenceremove"></a>
<h3 class="section">28.62 silenceremove<span class="pull-right"><a class="anchor hidden-xs" href="#silenceremove" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-silenceremove" aria-hidden="true">TOC</a></span></h3>
<p>Remove silence from the beginning, middle or end of the audio.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>start_periods</samp></dt>
<dd><p>This value is used to indicate if audio should be trimmed at beginning of
the audio. A value of zero indicates no silence should be trimmed from the
beginning. When specifying a non-zero value, it trims audio up until it
finds non-silence. Normally, when trimming silence from beginning of audio
the <var>start_periods</var> will be <code>1</code> but it can be increased to higher
values to trim all audio up to specific count of non-silence periods.
Default value is <code>0</code>.
</p>
</dd>
<dt><samp>start_duration</samp></dt>
<dd><p>Specify the amount of time that non-silence must be detected before it stops
trimming audio. By increasing the duration, bursts of noises can be treated
as silence and trimmed off. Default value is <code>0</code>.
</p>
</dd>
<dt><samp>start_threshold</samp></dt>
<dd><p>This indicates what sample value should be treated as silence. For digital
audio, a value of <code>0</code> may be fine but for audio recorded from analog,
you may wish to increase the value to account for background noise.
Can be specified in dB (in case &quot;dB&quot; is appended to the specified value)
or amplitude ratio. Default value is <code>0</code>.
</p>
</dd>
<dt><samp>stop_periods</samp></dt>
<dd><p>Set the count for trimming silence from the end of audio.
To remove silence from the middle of a file, specify a <var>stop_periods</var>
that is negative. This value is then treated as a positive value and is
used to indicate the effect should restart processing as specified by
<var>start_periods</var>, making it suitable for removing periods of silence
in the middle of the audio.
Default value is <code>0</code>.
</p>
</dd>
<dt><samp>stop_duration</samp></dt>
<dd><p>Specify a duration of silence that must exist before audio is not copied any
more. By specifying a higher duration, silence that is wanted can be left in
the audio.
Default value is <code>0</code>.
</p>
</dd>
<dt><samp>stop_threshold</samp></dt>
<dd><p>This is the same as <samp>start_threshold</samp> but for trimming silence from
the end of audio.
Can be specified in dB (in case &quot;dB&quot; is appended to the specified value)
or amplitude ratio. Default value is <code>0</code>.
</p>
</dd>
<dt><samp>leave_silence</samp></dt>
<dd><p>This indicates that <var>stop_duration</var> length of audio should be left intact
at the beginning of each period of silence.
For example, if you want to remove long pauses between words but do not want
to remove the pauses completely. Default value is <code>0</code>.
</p>
</dd>
<dt><samp>detection</samp></dt>
<dd><p>Set how is silence detected. Can be <code>rms</code> or <code>peak</code>. Second is faster
and works better with digital silence which is exactly 0.
Default value is <code>rms</code>.
</p>
</dd>
<dt><samp>window</samp></dt>
<dd><p>Set ratio used to calculate size of window for detecting silence.
Default value is <code>0.02</code>. Allowed range is from <code>0</code> to <code>10</code>.
</p></dd>
</dl>
<a name="Examples-32"></a>
<h4 class="subsection">28.62.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-32" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-32" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> The following example shows how this filter can be used to start a recording
that does not contain the delay at the start which usually occurs between
pressing the record button and the start of the performance:
<div class="example">
<pre class="example">silenceremove=1:5:0.02
</pre></div>
</li><li> Trim all silence encountered from beginning to end where there is more than 1
second of silence in audio:
<div class="example">
<pre class="example">silenceremove=0:0:0:-1:1:-90dB
</pre></div>
</li></ul>
<a name="sofalizer"></a>
<h3 class="section">28.63 sofalizer<span class="pull-right"><a class="anchor hidden-xs" href="#sofalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sofalizer" aria-hidden="true">TOC</a></span></h3>
<p>SOFAlizer uses head-related transfer functions (HRTFs) to create virtual
loudspeakers around the user for binaural listening via headphones (audio
formats up to 9 channels supported).
The HRTFs are stored in SOFA files (see <a href="http://www.sofacoustics.org/">http://www.sofacoustics.org/</a> for a database).
SOFAlizer is developed at the Acoustics Research Institute (ARI) of the
Austrian Academy of Sciences.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-netcdf</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sofa</samp></dt>
<dd><p>Set the SOFA file used for rendering.
</p>
</dd>
<dt><samp>gain</samp></dt>
<dd><p>Set gain applied to audio. Value is in dB. Default is 0.
</p>
</dd>
<dt><samp>rotation</samp></dt>
<dd><p>Set rotation of virtual loudspeakers in deg. Default is 0.
</p>
</dd>
<dt><samp>elevation</samp></dt>
<dd><p>Set elevation of virtual speakers in deg. Default is 0.
</p>
</dd>
<dt><samp>radius</samp></dt>
<dd><p>Set distance in meters between loudspeakers and the listener with near-field
HRTFs. Default is 1.
</p>
</dd>
<dt><samp>type</samp></dt>
<dd><p>Set processing type. Can be <var>time</var> or <var>freq</var>. <var>time</var> is
processing audio in time domain which is slow.
<var>freq</var> is processing audio in frequency domain which is fast.
Default is <var>freq</var>.
</p>
</dd>
<dt><samp>speakers</samp></dt>
<dd><p>Set custom positions of virtual loudspeakers. Syntax for this option is:
&lt;CH&gt; &lt;AZIM&gt; &lt;ELEV&gt;[|&lt;CH&gt; &lt;AZIM&gt; &lt;ELEV&gt;|...].
Each virtual loudspeaker is described with short channel name following with
azimuth and elevation in degreees.
Each virtual loudspeaker description is separated by &rsquo;|&rsquo;.
For example to override front left and front right channel positions use:
&rsquo;speakers=FL 45 15|FR 345 15&rsquo;.
Descriptions with unrecognised channel names are ignored.
</p></dd>
</dl>
<a name="Examples-33"></a>
<h4 class="subsection">28.63.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-33" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-33" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Using ClubFritz6 sofa file:
<div class="example">
<pre class="example">sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
</pre></div>
</li><li> Using ClubFritz12 sofa file and bigger radius with small rotation:
<div class="example">
<pre class="example">sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
</pre></div>
</li><li> Similar as above but with custom speaker positions for front left, front right, rear left and rear right
and also with custom gain:
<div class="example">
<pre class="example">&quot;sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|RL 135|RR 225:gain=28&quot;
</pre></div>
</li></ul>
<a name="stereotools"></a>
<h3 class="section">28.64 stereotools<span class="pull-right"><a class="anchor hidden-xs" href="#stereotools" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-stereotools" aria-hidden="true">TOC</a></span></h3>
<p>This filter has some handy utilities to manage stereo signals, for converting
M/S stereo recordings to L/R signal while having control over the parameters
or spreading the stereo image of master track.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_in</samp></dt>
<dd><p>Set input level before filtering for both channels. Defaults is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>level_out</samp></dt>
<dd><p>Set output level after filtering for both channels. Defaults is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>balance_in</samp></dt>
<dd><p>Set input balance between both channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp>balance_out</samp></dt>
<dd><p>Set output balance between both channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp>softclip</samp></dt>
<dd><p>Enable softclipping. Results in analog distortion instead of harsh digital 0dB
clipping. Disabled by default.
</p>
</dd>
<dt><samp>mutel</samp></dt>
<dd><p>Mute the left channel. Disabled by default.
</p>
</dd>
<dt><samp>muter</samp></dt>
<dd><p>Mute the right channel. Disabled by default.
</p>
</dd>
<dt><samp>phasel</samp></dt>
<dd><p>Change the phase of the left channel. Disabled by default.
</p>
</dd>
<dt><samp>phaser</samp></dt>
<dd><p>Change the phase of the right channel. Disabled by default.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set stereo mode. Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>lr&gt;lr</samp>&rsquo;</dt>
<dd><p>Left/Right to Left/Right, this is default.
</p>
</dd>
<dt>&lsquo;<samp>lr&gt;ms</samp>&rsquo;</dt>
<dd><p>Left/Right to Mid/Side.
</p>
</dd>
<dt>&lsquo;<samp>ms&gt;lr</samp>&rsquo;</dt>
<dd><p>Mid/Side to Left/Right.
</p>
</dd>
<dt>&lsquo;<samp>lr&gt;ll</samp>&rsquo;</dt>
<dd><p>Left/Right to Left/Left.
</p>
</dd>
<dt>&lsquo;<samp>lr&gt;rr</samp>&rsquo;</dt>
<dd><p>Left/Right to Right/Right.
</p>
</dd>
<dt>&lsquo;<samp>lr&gt;l+r</samp>&rsquo;</dt>
<dd><p>Left/Right to Left + Right.
</p>
</dd>
<dt>&lsquo;<samp>lr&gt;rl</samp>&rsquo;</dt>
<dd><p>Left/Right to Right/Left.
</p></dd>
</dl>
</dd>
<dt><samp>slev</samp></dt>
<dd><p>Set level of side signal. Default is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>sbal</samp></dt>
<dd><p>Set balance of side signal. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp>mlev</samp></dt>
<dd><p>Set level of the middle signal. Default is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp>mpan</samp></dt>
<dd><p>Set middle signal pan. Default is 0. Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp>base</samp></dt>
<dd><p>Set stereo base between mono and inversed channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp>delay</samp></dt>
<dd><p>Set delay in milliseconds how much to delay left from right channel and
vice versa. Default is 0. Allowed range is from -20 to 20.
</p>
</dd>
<dt><samp>sclevel</samp></dt>
<dd><p>Set S/C level. Default is 1. Allowed range is from 1 to 100.
</p>
</dd>
<dt><samp>phase</samp></dt>
<dd><p>Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360.
</p></dd>
</dl>
<a name="Examples-34"></a>
<h4 class="subsection">28.64.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-34" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-34" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply karaoke like effect:
<div class="example">
<pre class="example">stereotools=mlev=0.015625
</pre></div>
</li><li> Convert M/S signal to L/R:
<div class="example">
<pre class="example">&quot;stereotools=mode=ms&gt;lr&quot;
</pre></div>
</li></ul>
<a name="stereowiden"></a>
<h3 class="section">28.65 stereowiden<span class="pull-right"><a class="anchor hidden-xs" href="#stereowiden" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-stereowiden" aria-hidden="true">TOC</a></span></h3>
<p>This filter enhance the stereo effect by suppressing signal common to both
channels and by delaying the signal of left into right and vice versa,
thereby widening the stereo effect.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>delay</samp></dt>
<dd><p>Time in milliseconds of the delay of left signal into right and vice versa.
Default is 20 milliseconds.
</p>
</dd>
<dt><samp>feedback</samp></dt>
<dd><p>Amount of gain in delayed signal into right and vice versa. Gives a delay
effect of left signal in right output and vice versa which gives widening
effect. Default is 0.3.
</p>
</dd>
<dt><samp>crossfeed</samp></dt>
<dd><p>Cross feed of left into right with inverted phase. This helps in suppressing
the mono. If the value is 1 it will cancel all the signal common to both
channels. Default is 0.3.
</p>
</dd>
<dt><samp>drymix</samp></dt>
<dd><p>Set level of input signal of original channel. Default is 0.8.
</p></dd>
</dl>
<a name="treble"></a>
<h3 class="section">28.66 treble<span class="pull-right"><a class="anchor hidden-xs" href="#treble" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-treble" aria-hidden="true">TOC</a></span></h3>
<p>Boost or cut treble (upper) frequencies of the audio using a two-pole
shelving filter with a response similar to that of a standard
hi-fi&rsquo;s tone-controls. This is also known as shelving equalisation (EQ).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>gain, g</samp></dt>
<dd><p>Give the gain at whichever is the lower of ~22 kHz and the
Nyquist frequency. Its useful range is about -20 (for a large cut)
to +20 (for a large boost). Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the filter&rsquo;s central frequency and so can be used
to extend or reduce the frequency range to be boosted or cut.
The default value is <code>3000</code> Hz.
</p>
</dd>
<dt><samp>width_type</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp>q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp>o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp>s</samp></dt>
<dd><p>slope
</p></dd>
</dl>
</dd>
<dt><samp>width, w</samp></dt>
<dd><p>Determine how steep is the filter&rsquo;s shelf transition.
</p></dd>
</dl>
<a name="tremolo"></a>
<h3 class="section">28.67 tremolo<span class="pull-right"><a class="anchor hidden-xs" href="#tremolo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tremolo" aria-hidden="true">TOC</a></span></h3>
<p>Sinusoidal amplitude modulation.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>f</samp></dt>
<dd><p>Modulation frequency in Hertz. Modulation frequencies in the subharmonic range
(20 Hz or lower) will result in a tremolo effect.
This filter may also be used as a ring modulator by specifying
a modulation frequency higher than 20 Hz.
Range is 0.1 - 20000.0. Default value is 5.0 Hz.
</p>
</dd>
<dt><samp>d</samp></dt>
<dd><p>Depth of modulation as a percentage. Range is 0.0 - 1.0.
Default value is 0.5.
</p></dd>
</dl>
<a name="vibrato"></a>
<h3 class="section">28.68 vibrato<span class="pull-right"><a class="anchor hidden-xs" href="#vibrato" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vibrato" aria-hidden="true">TOC</a></span></h3>
<p>Sinusoidal phase modulation.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>f</samp></dt>
<dd><p>Modulation frequency in Hertz.
Range is 0.1 - 20000.0. Default value is 5.0 Hz.
</p>
</dd>
<dt><samp>d</samp></dt>
<dd><p>Depth of modulation as a percentage. Range is 0.0 - 1.0.
Default value is 0.5.
</p></dd>
</dl>
<a name="volume"></a>
<h3 class="section">28.69 volume<span class="pull-right"><a class="anchor hidden-xs" href="#volume" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-volume" aria-hidden="true">TOC</a></span></h3>
<p>Adjust the input audio volume.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>volume</samp></dt>
<dd><p>Set audio volume expression.
</p>
<p>Output values are clipped to the maximum value.
</p>
<p>The output audio volume is given by the relation:
</p><div class="example">
<pre class="example"><var>output_volume</var> = <var>volume</var> * <var>input_volume</var>
</pre></div>
<p>The default value for <var>volume</var> is &quot;1.0&quot;.
</p>
</dd>
<dt><samp>precision</samp></dt>
<dd><p>This parameter represents the mathematical precision.
</p>
<p>It determines which input sample formats will be allowed, which affects the
precision of the volume scaling.
</p>
<dl compact="compact">
<dt><samp>fixed</samp></dt>
<dd><p>8-bit fixed-point; this limits input sample format to U8, S16, and S32.
</p></dd>
<dt><samp>float</samp></dt>
<dd><p>32-bit floating-point; this limits input sample format to FLT. (default)
</p></dd>
<dt><samp>double</samp></dt>
<dd><p>64-bit floating-point; this limits input sample format to DBL.
</p></dd>
</dl>
</dd>
<dt><samp>replaygain</samp></dt>
<dd><p>Choose the behaviour on encountering ReplayGain side data in input frames.
</p>
<dl compact="compact">
<dt><samp>drop</samp></dt>
<dd><p>Remove ReplayGain side data, ignoring its contents (the default).
</p>
</dd>
<dt><samp>ignore</samp></dt>
<dd><p>Ignore ReplayGain side data, but leave it in the frame.
</p>
</dd>
<dt><samp>track</samp></dt>
<dd><p>Prefer the track gain, if present.
</p>
</dd>
<dt><samp>album</samp></dt>
<dd><p>Prefer the album gain, if present.
</p></dd>
</dl>
</dd>
<dt><samp>replaygain_preamp</samp></dt>
<dd><p>Pre-amplification gain in dB to apply to the selected replaygain gain.
</p>
<p>Default value for <var>replaygain_preamp</var> is 0.0.
</p>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Set when the volume expression is evaluated.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>once</samp>&rsquo;</dt>
<dd><p>only evaluate expression once during the filter initialization, or
when the &lsquo;<samp>volume</samp>&rsquo; command is sent
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>evaluate expression for each incoming frame
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>once</samp>&rsquo;.
</p></dd>
</dl>
<p>The volume expression can contain the following parameters.
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>frame number (starting at zero)
</p></dd>
<dt><samp>nb_channels</samp></dt>
<dd><p>number of channels
</p></dd>
<dt><samp>nb_consumed_samples</samp></dt>
<dd><p>number of samples consumed by the filter
</p></dd>
<dt><samp>nb_samples</samp></dt>
<dd><p>number of samples in the current frame
</p></dd>
<dt><samp>pos</samp></dt>
<dd><p>original frame position in the file
</p></dd>
<dt><samp>pts</samp></dt>
<dd><p>frame PTS
</p></dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>sample rate
</p></dd>
<dt><samp>startpts</samp></dt>
<dd><p>PTS at start of stream
</p></dd>
<dt><samp>startt</samp></dt>
<dd><p>time at start of stream
</p></dd>
<dt><samp>t</samp></dt>
<dd><p>frame time
</p></dd>
<dt><samp>tb</samp></dt>
<dd><p>timestamp timebase
</p></dd>
<dt><samp>volume</samp></dt>
<dd><p>last set volume value
</p></dd>
</dl>
<p>Note that when <samp>eval</samp> is set to &lsquo;<samp>once</samp>&rsquo; only the
<var>sample_rate</var> and <var>tb</var> variables are available, all other
variables will evaluate to NAN.
</p>
<a name="Commands-2"></a>
<h4 class="subsection">28.69.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-2" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>volume</samp></dt>
<dd><p>Modify the volume expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
<dt><samp>replaygain_noclip</samp></dt>
<dd><p>Prevent clipping by limiting the gain applied.
</p>
<p>Default value for <var>replaygain_noclip</var> is 1.
</p>
</dd>
</dl>
<a name="Examples-35"></a>
<h4 class="subsection">28.69.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-35" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-35" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Halve the input audio volume:
<div class="example">
<pre class="example">volume=volume=0.5
volume=volume=1/2
volume=volume=-6.0206dB
</pre></div>
<p>In all the above example the named key for <samp>volume</samp> can be
omitted, for example like in:
</p><div class="example">
<pre class="example">volume=0.5
</pre></div>
</li><li> Increase input audio power by 6 decibels using fixed-point precision:
<div class="example">
<pre class="example">volume=volume=6dB:precision=fixed
</pre></div>
</li><li> Fade volume after time 10 with an annihilation period of 5 seconds:
<div class="example">
<pre class="example">volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
</pre></div>
</li></ul>
<a name="volumedetect"></a>
<h3 class="section">28.70 volumedetect<span class="pull-right"><a class="anchor hidden-xs" href="#volumedetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-volumedetect" aria-hidden="true">TOC</a></span></h3>
<p>Detect the volume of the input video.
</p>
<p>The filter has no parameters. The input is not modified. Statistics about
the volume will be printed in the log when the input stream end is reached.
</p>
<p>In particular it will show the mean volume (root mean square), maximum
volume (on a per-sample basis), and the beginning of a histogram of the
registered volume values (from the maximum value to a cumulated 1/1000 of
the samples).
</p>
<p>All volumes are in decibels relative to the maximum PCM value.
</p>
<a name="Examples-36"></a>
<h4 class="subsection">28.70.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-36" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-36" aria-hidden="true">TOC</a></span></h4>
<p>Here is an excerpt of the output:
</p><div class="example">
<pre class="example">[Parsed_volumedetect_0 &nbsp;0xa23120] mean_volume: -27 dB
[Parsed_volumedetect_0 &nbsp;0xa23120] max_volume: -4 dB
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_4db: 6
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_5db: 62
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_6db: 286
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_7db: 1042
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_8db: 2551
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_9db: 4609
[Parsed_volumedetect_0 &nbsp;0xa23120] histogram_10db: 8409
</pre></div>
<p>It means that:
</p><ul>
<li> The mean square energy is approximately -27 dB, or 10^-2.7.
</li><li> The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB.
</li><li> There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc.
</li></ul>
<p>In other words, raising the volume by +4 dB does not cause any clipping,
raising it by +5 dB causes clipping for 6 samples, etc.
</p>
<a name="Audio-Sources"></a>
<h2 class="chapter">29 Audio Sources<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Sources" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Sources" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available audio sources.
</p>
<a name="abuffer"></a>
<h3 class="section">29.1 abuffer<span class="pull-right"><a class="anchor hidden-xs" href="#abuffer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-abuffer" aria-hidden="true">TOC</a></span></h3>
<p>Buffer audio frames, and make them available to the filter chain.
</p>
<p>This source is mainly intended for a programmatic use, in particular
through the interface defined in <samp>libavfilter/asrc_abuffer.h</samp>.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>time_base</samp></dt>
<dd><p>The timebase which will be used for timestamps of submitted frames. It must be
either a floating-point number or in <var>numerator</var>/<var>denominator</var> form.
</p>
</dd>
<dt><samp>sample_rate</samp></dt>
<dd><p>The sample rate of the incoming audio buffers.
</p>
</dd>
<dt><samp>sample_fmt</samp></dt>
<dd><p>The sample format of the incoming audio buffers.
Either a sample format name or its corresponding integer representation from
the enum AVSampleFormat in <samp>libavutil/samplefmt.h</samp>
</p>
</dd>
<dt><samp>channel_layout</samp></dt>
<dd><p>The channel layout of the incoming audio buffers.
Either a channel layout name from channel_layout_map in
<samp>libavutil/channel_layout.c</samp> or its corresponding integer representation
from the AV_CH_LAYOUT_* macros in <samp>libavutil/channel_layout.h</samp>
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>The number of channels of the incoming audio buffers.
If both <var>channels</var> and <var>channel_layout</var> are specified, then they
must be consistent.
</p>
</dd>
</dl>
<a name="Examples-37"></a>
<h4 class="subsection">29.1.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-37" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-37" aria-hidden="true">TOC</a></span></h4>
<div class="example">
<pre class="example">abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
</pre></div>
<p>will instruct the source to accept planar 16bit signed stereo at 44100Hz.
Since the sample format with name &quot;s16p&quot; corresponds to the number
6 and the &quot;stereo&quot; channel layout corresponds to the value 0x3, this is
equivalent to:
</p><div class="example">
<pre class="example">abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
</pre></div>
<a name="aevalsrc"></a>
<h3 class="section">29.2 aevalsrc<span class="pull-right"><a class="anchor hidden-xs" href="#aevalsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aevalsrc" aria-hidden="true">TOC</a></span></h3>
<p>Generate an audio signal specified by an expression.
</p>
<p>This source accepts in input one or more expressions (one for each
channel), which are evaluated and used to generate a corresponding
audio signal.
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>exprs</samp></dt>
<dd><p>Set the &rsquo;|&rsquo;-separated expressions list for each separate channel. In case the
<samp>channel_layout</samp> option is not specified, the selected channel layout
depends on the number of provided expressions. Otherwise the last
specified expression is applied to the remaining output channels.
</p>
</dd>
<dt><samp>channel_layout, c</samp></dt>
<dd><p>Set the channel layout. The number of channels in the specified layout
must be equal to the number of specified expressions.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Set the minimum duration of the sourced audio. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
Note that the resulting duration may be greater than the specified
duration, as the generated audio is always cut at the end of a
complete frame.
</p>
<p>If not specified, or the expressed duration is negative, the audio is
supposed to be generated forever.
</p>
</dd>
<dt><samp>nb_samples, n</samp></dt>
<dd><p>Set the number of samples per channel per each output frame,
default to 1024.
</p>
</dd>
<dt><samp>sample_rate, s</samp></dt>
<dd><p>Specify the sample rate, default to 44100.
</p></dd>
</dl>
<p>Each expression in <var>exprs</var> can contain the following constants:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>number of the evaluated sample, starting from 0
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>time of the evaluated sample expressed in seconds, starting from 0
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>sample rate
</p>
</dd>
</dl>
<a name="Examples-38"></a>
<h4 class="subsection">29.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-38" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-38" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate silence:
<div class="example">
<pre class="example">aevalsrc=0
</pre></div>
</li><li> Generate a sin signal with frequency of 440 Hz, set sample rate to
8000 Hz:
<div class="example">
<pre class="example">aevalsrc=&quot;sin(440*2*PI*t):s=8000&quot;
</pre></div>
</li><li> Generate a two channels signal, specify the channel layout (Front
Center + Back Center) explicitly:
<div class="example">
<pre class="example">aevalsrc=&quot;sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC&quot;
</pre></div>
</li><li> Generate white noise:
<div class="example">
<pre class="example">aevalsrc=&quot;-2+random(0)&quot;
</pre></div>
</li><li> Generate an amplitude modulated signal:
<div class="example">
<pre class="example">aevalsrc=&quot;sin(10*2*PI*t)*sin(880*2*PI*t)&quot;
</pre></div>
</li><li> Generate 2.5 Hz binaural beats on a 360 Hz carrier:
<div class="example">
<pre class="example">aevalsrc=&quot;0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)&quot;
</pre></div>
</li></ul>
<a name="anullsrc"></a>
<h3 class="section">29.3 anullsrc<span class="pull-right"><a class="anchor hidden-xs" href="#anullsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anullsrc" aria-hidden="true">TOC</a></span></h3>
<p>The null audio source, return unprocessed audio frames. It is mainly useful
as a template and to be employed in analysis / debugging tools, or as
the source for filters which ignore the input data (for example the sox
synth filter).
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>channel_layout, cl</samp></dt>
<dd>
<p>Specifies the channel layout, and can be either an integer or a string
representing a channel layout. The default value of <var>channel_layout</var>
is &quot;stereo&quot;.
</p>
<p>Check the channel_layout_map definition in
<samp>libavutil/channel_layout.c</samp> for the mapping between strings and
channel layout values.
</p>
</dd>
<dt><samp>sample_rate, r</samp></dt>
<dd><p>Specifies the sample rate, and defaults to 44100.
</p>
</dd>
<dt><samp>nb_samples, n</samp></dt>
<dd><p>Set the number of samples per requested frames.
</p>
</dd>
</dl>
<a name="Examples-39"></a>
<h4 class="subsection">29.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-39" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-39" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
<div class="example">
<pre class="example">anullsrc=r=48000:cl=4
</pre></div>
</li><li> Do the same operation with a more obvious syntax:
<div class="example">
<pre class="example">anullsrc=r=48000:cl=mono
</pre></div>
</li></ul>
<p>All the parameters need to be explicitly defined.
</p>
<a name="flite"></a>
<h3 class="section">29.4 flite<span class="pull-right"><a class="anchor hidden-xs" href="#flite" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flite" aria-hidden="true">TOC</a></span></h3>
<p>Synthesize a voice utterance using the libflite library.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-libflite</code>.
</p>
<p>Note that the flite library is not thread-safe.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>list_voices</samp></dt>
<dd><p>If set to 1, list the names of the available voices and exit
immediately. Default value is 0.
</p>
</dd>
<dt><samp>nb_samples, n</samp></dt>
<dd><p>Set the maximum number of samples per frame. Default value is 512.
</p>
</dd>
<dt><samp>textfile</samp></dt>
<dd><p>Set the filename containing the text to speak.
</p>
</dd>
<dt><samp>text</samp></dt>
<dd><p>Set the text to speak.
</p>
</dd>
<dt><samp>voice, v</samp></dt>
<dd><p>Set the voice to use for the speech synthesis. Default value is
<code>kal</code>. See also the <var>list_voices</var> option.
</p></dd>
</dl>
<a name="Examples-40"></a>
<h4 class="subsection">29.4.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-40" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-40" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Read from file <samp>speech.txt</samp>, and synthesize the text using the
standard flite voice:
<div class="example">
<pre class="example">flite=textfile=speech.txt
</pre></div>
</li><li> Read the specified text selecting the <code>slt</code> voice:
<div class="example">
<pre class="example">flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
</pre></div>
</li><li> Input text to ffmpeg:
<div class="example">
<pre class="example">ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
</pre></div>
</li><li> Make <samp>ffplay</samp> speak the specified text, using <code>flite</code> and
the <code>lavfi</code> device:
<div class="example">
<pre class="example">ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
</pre></div>
</li></ul>
<p>For more information about libflite, check:
<a href="http://www.speech.cs.cmu.edu/flite/">http://www.speech.cs.cmu.edu/flite/</a>
</p>
<a name="anoisesrc"></a>
<h3 class="section">29.5 anoisesrc<span class="pull-right"><a class="anchor hidden-xs" href="#anoisesrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anoisesrc" aria-hidden="true">TOC</a></span></h3>
<p>Generate a noise audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sample_rate, r</samp></dt>
<dd><p>Specify the sample rate. Default value is 48000 Hz.
</p>
</dd>
<dt><samp>amplitude, a</samp></dt>
<dd><p>Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value
is 1.0.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Specify the duration of the generated audio stream. Not specifying this option
results in noise with an infinite length.
</p>
</dd>
<dt><samp>color, colour, c</samp></dt>
<dd><p>Specify the color of noise. Available noise colors are white, pink, and brown.
Default color is white.
</p>
</dd>
<dt><samp>seed, s</samp></dt>
<dd><p>Specify a value used to seed the PRNG.
</p>
</dd>
<dt><samp>nb_samples, n</samp></dt>
<dd><p>Set the number of samples per each output frame, default is 1024.
</p></dd>
</dl>
<a name="Examples-41"></a>
<h4 class="subsection">29.5.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-41" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-41" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5:
<div class="example">
<pre class="example">anoisesrc=d=60:c=pink:r=44100:a=0.5
</pre></div>
</li></ul>
<a name="sine"></a>
<h3 class="section">29.6 sine<span class="pull-right"><a class="anchor hidden-xs" href="#sine" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sine" aria-hidden="true">TOC</a></span></h3>
<p>Generate an audio signal made of a sine wave with amplitude 1/8.
</p>
<p>The audio signal is bit-exact.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>frequency, f</samp></dt>
<dd><p>Set the carrier frequency. Default is 440 Hz.
</p>
</dd>
<dt><samp>beep_factor, b</samp></dt>
<dd><p>Enable a periodic beep every second with frequency <var>beep_factor</var> times
the carrier frequency. Default is 0, meaning the beep is disabled.
</p>
</dd>
<dt><samp>sample_rate, r</samp></dt>
<dd><p>Specify the sample rate, default is 44100.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Specify the duration of the generated audio stream.
</p>
</dd>
<dt><samp>samples_per_frame</samp></dt>
<dd><p>Set the number of samples per output frame.
</p>
<p>The expression can contain the following constants:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>The (sequential) number of the output audio frame, starting from 0.
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>The PTS (Presentation TimeStamp) of the output audio frame,
expressed in <var>TB</var> units.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The PTS of the output audio frame, expressed in seconds.
</p>
</dd>
<dt><samp>TB</samp></dt>
<dd><p>The timebase of the output audio frames.
</p></dd>
</dl>
<p>Default is <code>1024</code>.
</p></dd>
</dl>
<a name="Examples-42"></a>
<h4 class="subsection">29.6.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-42" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-42" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate a simple 440 Hz sine wave:
<div class="example">
<pre class="example">sine
</pre></div>
</li><li> Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds:
<div class="example">
<pre class="example">sine=220:4:d=5
sine=f=220:b=4:d=5
sine=frequency=220:beep_factor=4:duration=5
</pre></div>
</li><li> Generate a 1 kHz sine wave following <code>1602,1601,1602,1601,1602</code> NTSC
pattern:
<div class="example">
<pre class="example">sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
</pre></div>
</li></ul>
<a name="Audio-Sinks"></a>
<h2 class="chapter">30 Audio Sinks<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Sinks" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Sinks" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available audio sinks.
</p>
<a name="abuffersink"></a>
<h3 class="section">30.1 abuffersink<span class="pull-right"><a class="anchor hidden-xs" href="#abuffersink" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-abuffersink" aria-hidden="true">TOC</a></span></h3>
<p>Buffer audio frames, and make them available to the end of filter chain.
</p>
<p>This sink is mainly intended for programmatic use, in particular
through the interface defined in <samp>libavfilter/buffersink.h</samp>
or the options system.
</p>
<p>It accepts a pointer to an AVABufferSinkContext structure, which
defines the incoming buffers&rsquo; formats, to be passed as the opaque
parameter to <code>avfilter_init_filter</code> for initialization.
</p><a name="anullsink"></a>
<h3 class="section">30.2 anullsink<span class="pull-right"><a class="anchor hidden-xs" href="#anullsink" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anullsink" aria-hidden="true">TOC</a></span></h3>
<p>Null audio sink; do absolutely nothing with the input audio. It is
mainly useful as a template and for use in analysis / debugging
tools.
</p>
<a name="Video-Filters"></a>
<h2 class="chapter">31 Video Filters<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Filters" aria-hidden="true">TOC</a></span></h2>
<p>When you configure your FFmpeg build, you can disable any of the
existing filters using <code>--disable-filters</code>.
The configure output will show the video filters included in your
build.
</p>
<p>Below is a description of the currently available video filters.
</p>
<a name="alphaextract"></a>
<h3 class="section">31.1 alphaextract<span class="pull-right"><a class="anchor hidden-xs" href="#alphaextract" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-alphaextract" aria-hidden="true">TOC</a></span></h3>
<p>Extract the alpha component from the input as a grayscale video. This
is especially useful with the <var>alphamerge</var> filter.
</p>
<a name="alphamerge"></a>
<h3 class="section">31.2 alphamerge<span class="pull-right"><a class="anchor hidden-xs" href="#alphamerge" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-alphamerge" aria-hidden="true">TOC</a></span></h3>
<p>Add or replace the alpha component of the primary input with the
grayscale value of a second input. This is intended for use with
<var>alphaextract</var> to allow the transmission or storage of frame
sequences that have alpha in a format that doesn&rsquo;t support an alpha
channel.
</p>
<p>For example, to reconstruct full frames from a normal YUV-encoded video
and a separate video created with <var>alphaextract</var>, you might use:
</p><div class="example">
<pre class="example">movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
</pre></div>
<p>Since this filter is designed for reconstruction, it operates on frame
sequences without considering timestamps, and terminates when either
input reaches end of stream. This will cause problems if your encoding
pipeline drops frames. If you&rsquo;re trying to apply an image as an
overlay to a video stream, consider the <var>overlay</var> filter instead.
</p>
<a name="ass"></a>
<h3 class="section">31.3 ass<span class="pull-right"><a class="anchor hidden-xs" href="#ass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ass" aria-hidden="true">TOC</a></span></h3>
<p>Same as the <a href="#subtitles">subtitles</a> filter, except that it doesn&rsquo;t require libavcodec
and libavformat to work. On the other hand, it is limited to ASS (Advanced
Substation Alpha) subtitles files.
</p>
<p>This filter accepts the following option in addition to the common options from
the <a href="#subtitles">subtitles</a> filter:
</p>
<dl compact="compact">
<dt><samp>shaping</samp></dt>
<dd><p>Set the shaping engine
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>The default libass shaping engine, which is the best available.
</p></dd>
<dt>&lsquo;<samp>simple</samp>&rsquo;</dt>
<dd><p>Fast, font-agnostic shaper that can do only substitutions
</p></dd>
<dt>&lsquo;<samp>complex</samp>&rsquo;</dt>
<dd><p>Slower shaper using OpenType for substitutions and positioning
</p></dd>
</dl>
<p>The default is <code>auto</code>.
</p></dd>
</dl>
<a name="atadenoise"></a>
<h3 class="section">31.4 atadenoise<span class="pull-right"><a class="anchor hidden-xs" href="#atadenoise" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-atadenoise" aria-hidden="true">TOC</a></span></h3>
<p>Apply an Adaptive Temporal Averaging Denoiser to the video input.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>0a</samp></dt>
<dd><p>Set threshold A for 1st plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp>0b</samp></dt>
<dd><p>Set threshold B for 1st plane. Default is 0.04.
Valid range is 0 to 5.
</p>
</dd>
<dt><samp>1a</samp></dt>
<dd><p>Set threshold A for 2nd plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp>1b</samp></dt>
<dd><p>Set threshold B for 2nd plane. Default is 0.04.
Valid range is 0 to 5.
</p>
</dd>
<dt><samp>2a</samp></dt>
<dd><p>Set threshold A for 3rd plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp>2b</samp></dt>
<dd><p>Set threshold B for 3rd plane. Default is 0.04.
Valid range is 0 to 5.
</p>
<p>Threshold A is designed to react on abrupt changes in the input signal and
threshold B is designed to react on continuous changes in the input signal.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>Set number of frames filter will use for averaging. Default is 33. Must be odd
number in range [5, 129].
</p>
</dd>
<dt><samp>p</samp></dt>
<dd><p>Set what planes of frame filter will use for averaging. Default is all.
</p></dd>
</dl>
<a name="avgblur"></a>
<h3 class="section">31.5 avgblur<span class="pull-right"><a class="anchor hidden-xs" href="#avgblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-avgblur" aria-hidden="true">TOC</a></span></h3>
<p>Apply average blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sizeX</samp></dt>
<dd><p>Set horizontal kernel size.
</p>
</dd>
<dt><samp>planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p>
</dd>
<dt><samp>sizeY</samp></dt>
<dd><p>Set vertical kernel size, if zero it will be same as <code>sizeX</code>.
Default is <code>0</code>.
</p></dd>
</dl>
<a name="bbox"></a>
<h3 class="section">31.6 bbox<span class="pull-right"><a class="anchor hidden-xs" href="#bbox" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bbox" aria-hidden="true">TOC</a></span></h3>
<p>Compute the bounding box for the non-black pixels in the input frame
luminance plane.
</p>
<p>This filter computes the bounding box containing all the pixels with a
luminance value greater than the minimum allowed value.
The parameters describing the bounding box are printed on the filter
log.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>min_val</samp></dt>
<dd><p>Set the minimal luminance value. Default is <code>16</code>.
</p></dd>
</dl>
<a name="bitplanenoise"></a>
<h3 class="section">31.7 bitplanenoise<span class="pull-right"><a class="anchor hidden-xs" href="#bitplanenoise" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bitplanenoise" aria-hidden="true">TOC</a></span></h3>
<p>Show and measure bit plane noise.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>bitplane</samp></dt>
<dd><p>Set which plane to analyze. Default is <code>1</code>.
</p>
</dd>
<dt><samp>filter</samp></dt>
<dd><p>Filter out noisy pixels from <code>bitplane</code> set above.
Default is disabled.
</p></dd>
</dl>
<a name="blackdetect"></a>
<h3 class="section">31.8 blackdetect<span class="pull-right"><a class="anchor hidden-xs" href="#blackdetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blackdetect" aria-hidden="true">TOC</a></span></h3>
<p>Detect video intervals that are (almost) completely black. Can be
useful to detect chapter transitions, commercials, or invalid
recordings. Output lines contains the time for the start, end and
duration of the detected black interval expressed in seconds.
</p>
<p>In order to display the output lines, you need to set the loglevel at
least to the AV_LOG_INFO value.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>black_min_duration, d</samp></dt>
<dd><p>Set the minimum detected black duration expressed in seconds. It must
be a non-negative floating point number.
</p>
<p>Default value is 2.0.
</p>
</dd>
<dt><samp>picture_black_ratio_th, pic_th</samp></dt>
<dd><p>Set the threshold for considering a picture &quot;black&quot;.
Express the minimum value for the ratio:
</p><div class="example">
<pre class="example"><var>nb_black_pixels</var> / <var>nb_pixels</var>
</pre></div>
<p>for which a picture is considered black.
Default value is 0.98.
</p>
</dd>
<dt><samp>pixel_black_th, pix_th</samp></dt>
<dd><p>Set the threshold for considering a pixel &quot;black&quot;.
</p>
<p>The threshold expresses the maximum pixel luminance value for which a
pixel is considered &quot;black&quot;. The provided value is scaled according to
the following equation:
</p><div class="example">
<pre class="example"><var>absolute_threshold</var> = <var>luminance_minimum_value</var> + <var>pixel_black_th</var> * <var>luminance_range_size</var>
</pre></div>
<p><var>luminance_range_size</var> and <var>luminance_minimum_value</var> depend on
the input video format, the range is [0-255] for YUV full-range
formats and [16-235] for YUV non full-range formats.
</p>
<p>Default value is 0.10.
</p></dd>
</dl>
<p>The following example sets the maximum pixel threshold to the minimum
value, and detects only black intervals of 2 or more seconds:
</p><div class="example">
<pre class="example">blackdetect=d=2:pix_th=0.00
</pre></div>
<a name="blackframe"></a>
<h3 class="section">31.9 blackframe<span class="pull-right"><a class="anchor hidden-xs" href="#blackframe" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blackframe" aria-hidden="true">TOC</a></span></h3>
<p>Detect frames that are (almost) completely black. Can be useful to
detect chapter transitions or commercials. Output lines consist of
the frame number of the detected frame, the percentage of blackness,
the position in the file if known or -1 and the timestamp in seconds.
</p>
<p>In order to display the output lines, you need to set the loglevel at
least to the AV_LOG_INFO value.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>amount</samp></dt>
<dd><p>The percentage of the pixels that have to be below the threshold; it defaults to
<code>98</code>.
</p>
</dd>
<dt><samp>threshold, thresh</samp></dt>
<dd><p>The threshold below which a pixel value is considered black; it defaults to
<code>32</code>.
</p>
</dd>
</dl>
<a name="blend_002c-tblend"></a>
<h3 class="section">31.10 blend, tblend<span class="pull-right"><a class="anchor hidden-xs" href="#blend_002c-tblend" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blend_002c-tblend" aria-hidden="true">TOC</a></span></h3>
<p>Blend two video frames into each other.
</p>
<p>The <code>blend</code> filter takes two input streams and outputs one
stream, the first input is the &quot;top&quot; layer and second input is
&quot;bottom&quot; layer. By default, the output terminates when the longest input terminates.
</p>
<p>The <code>tblend</code> (time blend) filter takes two consecutive frames
from one single stream, and outputs the result obtained by blending
the new frame on top of the old frame.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>c0_mode</samp></dt>
<dt><samp>c1_mode</samp></dt>
<dt><samp>c2_mode</samp></dt>
<dt><samp>c3_mode</samp></dt>
<dt><samp>all_mode</samp></dt>
<dd><p>Set blend mode for specific pixel component or all pixel components in case
of <var>all_mode</var>. Default value is <code>normal</code>.
</p>
<p>Available values for component modes are:
</p><dl compact="compact">
<dt>&lsquo;<samp>addition</samp>&rsquo;</dt>
<dt>&lsquo;<samp>addition128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>and</samp>&rsquo;</dt>
<dt>&lsquo;<samp>average</samp>&rsquo;</dt>
<dt>&lsquo;<samp>burn</samp>&rsquo;</dt>
<dt>&lsquo;<samp>darken</samp>&rsquo;</dt>
<dt>&lsquo;<samp>difference</samp>&rsquo;</dt>
<dt>&lsquo;<samp>difference128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>divide</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dodge</samp>&rsquo;</dt>
<dt>&lsquo;<samp>freeze</samp>&rsquo;</dt>
<dt>&lsquo;<samp>exclusion</samp>&rsquo;</dt>
<dt>&lsquo;<samp>glow</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hardlight</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hardmix</samp>&rsquo;</dt>
<dt>&lsquo;<samp>heat</samp>&rsquo;</dt>
<dt>&lsquo;<samp>lighten</samp>&rsquo;</dt>
<dt>&lsquo;<samp>linearlight</samp>&rsquo;</dt>
<dt>&lsquo;<samp>multiply</samp>&rsquo;</dt>
<dt>&lsquo;<samp>multiply128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>negation</samp>&rsquo;</dt>
<dt>&lsquo;<samp>normal</samp>&rsquo;</dt>
<dt>&lsquo;<samp>or</samp>&rsquo;</dt>
<dt>&lsquo;<samp>overlay</samp>&rsquo;</dt>
<dt>&lsquo;<samp>phoenix</samp>&rsquo;</dt>
<dt>&lsquo;<samp>pinlight</samp>&rsquo;</dt>
<dt>&lsquo;<samp>reflect</samp>&rsquo;</dt>
<dt>&lsquo;<samp>screen</samp>&rsquo;</dt>
<dt>&lsquo;<samp>softlight</samp>&rsquo;</dt>
<dt>&lsquo;<samp>subtract</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vividlight</samp>&rsquo;</dt>
<dt>&lsquo;<samp>xor</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>c0_opacity</samp></dt>
<dt><samp>c1_opacity</samp></dt>
<dt><samp>c2_opacity</samp></dt>
<dt><samp>c3_opacity</samp></dt>
<dt><samp>all_opacity</samp></dt>
<dd><p>Set blend opacity for specific pixel component or all pixel components in case
of <var>all_opacity</var>. Only used in combination with pixel component blend modes.
</p>
</dd>
<dt><samp>c0_expr</samp></dt>
<dt><samp>c1_expr</samp></dt>
<dt><samp>c2_expr</samp></dt>
<dt><samp>c3_expr</samp></dt>
<dt><samp>all_expr</samp></dt>
<dd><p>Set blend expression for specific pixel component or all pixel components in case
of <var>all_expr</var>. Note that related mode options will be ignored if those are set.
</p>
<p>The expressions can use the following variables:
</p>
<dl compact="compact">
<dt><samp>N</samp></dt>
<dd><p>The sequential number of the filtered frame, starting from <code>0</code>.
</p>
</dd>
<dt><samp>X</samp></dt>
<dt><samp>Y</samp></dt>
<dd><p>the coordinates of the current sample
</p>
</dd>
<dt><samp>W</samp></dt>
<dt><samp>H</samp></dt>
<dd><p>the width and height of currently filtered plane
</p>
</dd>
<dt><samp>SW</samp></dt>
<dt><samp>SH</samp></dt>
<dd><p>Width and height scale depending on the currently filtered plane. It is the
ratio between the corresponding luma plane number of pixels and the current
plane ones. E.g. for YUV4:2:0 the values are <code>1,1</code> for the luma plane, and
<code>0.5,0.5</code> for chroma planes.
</p>
</dd>
<dt><samp>T</samp></dt>
<dd><p>Time of the current frame, expressed in seconds.
</p>
</dd>
<dt><samp>TOP, A</samp></dt>
<dd><p>Value of pixel component at current location for first video frame (top layer).
</p>
</dd>
<dt><samp>BOTTOM, B</samp></dt>
<dd><p>Value of pixel component at current location for second video frame (bottom layer).
</p></dd>
</dl>
</dd>
<dt><samp>shortest</samp></dt>
<dd><p>Force termination when the shortest input terminates. Default is
<code>0</code>. This option is only defined for the <code>blend</code> filter.
</p>
</dd>
<dt><samp>repeatlast</samp></dt>
<dd><p>Continue applying the last bottom frame after the end of the stream. A value of
<code>0</code> disable the filter after the last frame of the bottom layer is reached.
Default is <code>1</code>. This option is only defined for the <code>blend</code> filter.
</p></dd>
</dl>
<a name="Examples-43"></a>
<h4 class="subsection">31.10.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-43" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-43" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply transition from bottom layer to top layer in first 10 seconds:
<div class="example">
<pre class="example">blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
</pre></div>
</li><li> Apply 1x1 checkerboard effect:
<div class="example">
<pre class="example">blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
</pre></div>
</li><li> Apply uncover left effect:
<div class="example">
<pre class="example">blend=all_expr='if(gte(N*SW+X,W),A,B)'
</pre></div>
</li><li> Apply uncover down effect:
<div class="example">
<pre class="example">blend=all_expr='if(gte(Y-N*SH,0),A,B)'
</pre></div>
</li><li> Apply uncover up-left effect:
<div class="example">
<pre class="example">blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
</pre></div>
</li><li> Split diagonally video and shows top and bottom layer on each side:
<div class="example">
<pre class="example">blend=all_expr=if(gt(X,Y*(W/H)),A,B)
</pre></div>
</li><li> Display differences between the current and the previous frame:
<div class="example">
<pre class="example">tblend=all_mode=difference128
</pre></div>
</li></ul>
<a name="boxblur"></a>
<h3 class="section">31.11 boxblur<span class="pull-right"><a class="anchor hidden-xs" href="#boxblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-boxblur" aria-hidden="true">TOC</a></span></h3>
<p>Apply a boxblur algorithm to the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>luma_radius, lr</samp></dt>
<dt><samp>luma_power, lp</samp></dt>
<dt><samp>chroma_radius, cr</samp></dt>
<dt><samp>chroma_power, cp</samp></dt>
<dt><samp>alpha_radius, ar</samp></dt>
<dt><samp>alpha_power, ap</samp></dt>
</dl>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>luma_radius, lr</samp></dt>
<dt><samp>chroma_radius, cr</samp></dt>
<dt><samp>alpha_radius, ar</samp></dt>
<dd><p>Set an expression for the box radius in pixels used for blurring the
corresponding input plane.
</p>
<p>The radius value must be a non-negative number, and must not be
greater than the value of the expression <code>min(w,h)/2</code> for the
luma and alpha planes, and of <code>min(cw,ch)/2</code> for the chroma
planes.
</p>
<p>Default value for <samp>luma_radius</samp> is &quot;2&quot;. If not specified,
<samp>chroma_radius</samp> and <samp>alpha_radius</samp> default to the
corresponding value set for <samp>luma_radius</samp>.
</p>
<p>The expressions can contain the following constants:
</p><dl compact="compact">
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The input width and height in pixels.
</p>
</dd>
<dt><samp>cw</samp></dt>
<dt><samp>ch</samp></dt>
<dd><p>The input chroma image width and height in pixels.
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>The horizontal and vertical chroma subsample values. For example, for the
pixel format &quot;yuv422p&quot;, <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p></dd>
</dl>
</dd>
<dt><samp>luma_power, lp</samp></dt>
<dt><samp>chroma_power, cp</samp></dt>
<dt><samp>alpha_power, ap</samp></dt>
<dd><p>Specify how many times the boxblur filter is applied to the
corresponding plane.
</p>
<p>Default value for <samp>luma_power</samp> is 2. If not specified,
<samp>chroma_power</samp> and <samp>alpha_power</samp> default to the
corresponding value set for <samp>luma_power</samp>.
</p>
<p>A value of 0 will disable the effect.
</p></dd>
</dl>
<a name="Examples-44"></a>
<h4 class="subsection">31.11.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-44" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-44" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply a boxblur filter with the luma, chroma, and alpha radii
set to 2:
<div class="example">
<pre class="example">boxblur=luma_radius=2:luma_power=1
boxblur=2:1
</pre></div>
</li><li> Set the luma radius to 2, and alpha and chroma radius to 0:
<div class="example">
<pre class="example">boxblur=2:1:cr=0:ar=0
</pre></div>
</li><li> Set the luma and chroma radii to a fraction of the video dimension:
<div class="example">
<pre class="example">boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
</pre></div>
</li></ul>
<a name="bwdif"></a>
<h3 class="section">31.12 bwdif<span class="pull-right"><a class="anchor hidden-xs" href="#bwdif" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bwdif" aria-hidden="true">TOC</a></span></h3>
<p>Deinterlace the input video (&quot;bwdif&quot; stands for &quot;Bob Weaver
Deinterlacing Filter&quot;).
</p>
<p>Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic
interpolation algorithms.
It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl compact="compact">
<dt><samp>0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp>1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code>send_field</code>.
</p>
</dd>
<dt><samp>parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl compact="compact">
<dt><samp>0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp>1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp>-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code>auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp>deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accept one of the following
values:
</p>
<dl compact="compact">
<dt><samp>0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp>1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code>all</code>.
</p></dd>
</dl>
<a name="chromakey"></a>
<h3 class="section">31.13 chromakey<span class="pull-right"><a class="anchor hidden-xs" href="#chromakey" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromakey" aria-hidden="true">TOC</a></span></h3>
<p>YUV colorspace color/chroma keying.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>color</samp></dt>
<dd><p>The color which will be replaced with transparency.
</p>
</dd>
<dt><samp>similarity</samp></dt>
<dd><p>Similarity percentage with the key color.
</p>
<p>0.01 matches only the exact key color, while 1.0 matches everything.
</p>
</dd>
<dt><samp>blend</samp></dt>
<dd><p>Blend percentage.
</p>
<p>0.0 makes pixels either fully transparent, or not transparent at all.
</p>
<p>Higher values result in semi-transparent pixels, with a higher transparency
the more similar the pixels color is to the key color.
</p>
</dd>
<dt><samp>yuv</samp></dt>
<dd><p>Signals that the color passed is already in YUV instead of RGB.
</p>
<p>Litteral colors like &quot;green&quot; or &quot;red&quot; don&rsquo;t make sense with this enabled anymore.
This can be used to pass exact YUV values as hexadecimal numbers.
</p></dd>
</dl>
<a name="Examples-45"></a>
<h4 class="subsection">31.13.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-45" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-45" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Make every green pixel in the input image transparent:
<div class="example">
<pre class="example">ffmpeg -i input.png -vf chromakey=green out.png
</pre></div>
</li><li> Overlay a greenscreen-video on top of a static black background.
<div class="example">
<pre class="example">ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex &quot;[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]&quot; -map &quot;[out]&quot; output.mkv
</pre></div>
</li></ul>
<a name="ciescope"></a>
<h3 class="section">31.14 ciescope<span class="pull-right"><a class="anchor hidden-xs" href="#ciescope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ciescope" aria-hidden="true">TOC</a></span></h3>
<p>Display CIE color diagram with pixels overlaid onto it.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>system</samp></dt>
<dd><p>Set color system.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>ntsc, 470m</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ebu, 470bg</samp>&rsquo;</dt>
<dt>&lsquo;<samp>smpte</samp>&rsquo;</dt>
<dt>&lsquo;<samp>240m</samp>&rsquo;</dt>
<dt>&lsquo;<samp>apple</samp>&rsquo;</dt>
<dt>&lsquo;<samp>widergb</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cie1931</samp>&rsquo;</dt>
<dt>&lsquo;<samp>rec709, hdtv</samp>&rsquo;</dt>
<dt>&lsquo;<samp>uhdtv, rec2020</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>cie</samp></dt>
<dd><p>Set CIE system.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>xyy</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ucs</samp>&rsquo;</dt>
<dt>&lsquo;<samp>luv</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>gamuts</samp></dt>
<dd><p>Set what gamuts to draw.
</p>
<p>See <code>system</code> option for available values.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set ciescope size, by default set to 512.
</p>
</dd>
<dt><samp>intensity, i</samp></dt>
<dd><p>Set intensity used to map input pixel values to CIE diagram.
</p>
</dd>
<dt><samp>contrast</samp></dt>
<dd><p>Set contrast used to draw tongue colors that are out of active color system gamut.
</p>
</dd>
<dt><samp>corrgamma</samp></dt>
<dd><p>Correct gamma displayed on scope, by default enabled.
</p>
</dd>
<dt><samp>showwhite</samp></dt>
<dd><p>Show white point on CIE diagram, by default disabled.
</p>
</dd>
<dt><samp>gamma</samp></dt>
<dd><p>Set input gamma. Used only with XYZ input color space.
</p></dd>
</dl>
<a name="codecview"></a>
<h3 class="section">31.15 codecview<span class="pull-right"><a class="anchor hidden-xs" href="#codecview" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-codecview" aria-hidden="true">TOC</a></span></h3>
<p>Visualize information exported by some codecs.
</p>
<p>Some codecs can export information through frames using side-data or other
means. For example, some MPEG based codecs export motion vectors through the
<var>export_mvs</var> flag in the codec <samp>flags2</samp> option.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>mv</samp></dt>
<dd><p>Set motion vectors to visualize.
</p>
<p>Available flags for <var>mv</var> are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>pf</samp>&rsquo;</dt>
<dd><p>forward predicted MVs of P-frames
</p></dd>
<dt>&lsquo;<samp>bf</samp>&rsquo;</dt>
<dd><p>forward predicted MVs of B-frames
</p></dd>
<dt>&lsquo;<samp>bb</samp>&rsquo;</dt>
<dd><p>backward predicted MVs of B-frames
</p></dd>
</dl>
</dd>
<dt><samp>qp</samp></dt>
<dd><p>Display quantization parameters using the chroma planes.
</p>
</dd>
<dt><samp>mv_type, mvt</samp></dt>
<dd><p>Set motion vectors type to visualize. Includes MVs from all frames unless specified by <var>frame_type</var> option.
</p>
<p>Available flags for <var>mv_type</var> are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>fp</samp>&rsquo;</dt>
<dd><p>forward predicted MVs
</p></dd>
<dt>&lsquo;<samp>bp</samp>&rsquo;</dt>
<dd><p>backward predicted MVs
</p></dd>
</dl>
</dd>
<dt><samp>frame_type, ft</samp></dt>
<dd><p>Set frame type to visualize motion vectors of.
</p>
<p>Available flags for <var>frame_type</var> are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>if</samp>&rsquo;</dt>
<dd><p>intra-coded frames (I-frames)
</p></dd>
<dt>&lsquo;<samp>pf</samp>&rsquo;</dt>
<dd><p>predicted frames (P-frames)
</p></dd>
<dt>&lsquo;<samp>bf</samp>&rsquo;</dt>
<dd><p>bi-directionally predicted frames (B-frames)
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-46"></a>
<h4 class="subsection">31.15.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-46" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-46" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Visualize forward predicted MVs of all frames using <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv_type=fp
</pre></div>
</li><li> Visualize multi-directionals MVs of P and B-Frames using <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
</pre></div>
</li></ul>
<a name="colorbalance"></a>
<h3 class="section">31.16 colorbalance<span class="pull-right"><a class="anchor hidden-xs" href="#colorbalance" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorbalance" aria-hidden="true">TOC</a></span></h3>
<p>Modify intensity of primary colors (red, green and blue) of input frames.
</p>
<p>The filter allows an input frame to be adjusted in the shadows, midtones or highlights
regions for the red-cyan, green-magenta or blue-yellow balance.
</p>
<p>A positive adjustment value shifts the balance towards the primary color, a negative
value towards the complementary color.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rs</samp></dt>
<dt><samp>gs</samp></dt>
<dt><samp>bs</samp></dt>
<dd><p>Adjust red, green and blue shadows (darkest pixels).
</p>
</dd>
<dt><samp>rm</samp></dt>
<dt><samp>gm</samp></dt>
<dt><samp>bm</samp></dt>
<dd><p>Adjust red, green and blue midtones (medium pixels).
</p>
</dd>
<dt><samp>rh</samp></dt>
<dt><samp>gh</samp></dt>
<dt><samp>bh</samp></dt>
<dd><p>Adjust red, green and blue highlights (brightest pixels).
</p>
<p>Allowed ranges for options are <code>[-1.0, 1.0]</code>. Defaults are <code>0</code>.
</p></dd>
</dl>
<a name="Examples-47"></a>
<h4 class="subsection">31.16.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-47" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-47" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Add red color cast to shadows:
<div class="example">
<pre class="example">colorbalance=rs=.3
</pre></div>
</li></ul>
<a name="colorkey"></a>
<h3 class="section">31.17 colorkey<span class="pull-right"><a class="anchor hidden-xs" href="#colorkey" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorkey" aria-hidden="true">TOC</a></span></h3>
<p>RGB colorspace color keying.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>color</samp></dt>
<dd><p>The color which will be replaced with transparency.
</p>
</dd>
<dt><samp>similarity</samp></dt>
<dd><p>Similarity percentage with the key color.
</p>
<p>0.01 matches only the exact key color, while 1.0 matches everything.
</p>
</dd>
<dt><samp>blend</samp></dt>
<dd><p>Blend percentage.
</p>
<p>0.0 makes pixels either fully transparent, or not transparent at all.
</p>
<p>Higher values result in semi-transparent pixels, with a higher transparency
the more similar the pixels color is to the key color.
</p></dd>
</dl>
<a name="Examples-48"></a>
<h4 class="subsection">31.17.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-48" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-48" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Make every green pixel in the input image transparent:
<div class="example">
<pre class="example">ffmpeg -i input.png -vf colorkey=green out.png
</pre></div>
</li><li> Overlay a greenscreen-video on top of a static background image.
<div class="example">
<pre class="example">ffmpeg -i background.png -i video.mp4 -filter_complex &quot;[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]&quot; -map &quot;[out]&quot; output.flv
</pre></div>
</li></ul>
<a name="colorlevels"></a>
<h3 class="section">31.18 colorlevels<span class="pull-right"><a class="anchor hidden-xs" href="#colorlevels" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorlevels" aria-hidden="true">TOC</a></span></h3>
<p>Adjust video input frames using levels.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rimin</samp></dt>
<dt><samp>gimin</samp></dt>
<dt><samp>bimin</samp></dt>
<dt><samp>aimin</samp></dt>
<dd><p>Adjust red, green, blue and alpha input black point.
Allowed ranges for options are <code>[-1.0, 1.0]</code>. Defaults are <code>0</code>.
</p>
</dd>
<dt><samp>rimax</samp></dt>
<dt><samp>gimax</samp></dt>
<dt><samp>bimax</samp></dt>
<dt><samp>aimax</samp></dt>
<dd><p>Adjust red, green, blue and alpha input white point.
Allowed ranges for options are <code>[-1.0, 1.0]</code>. Defaults are <code>1</code>.
</p>
<p>Input levels are used to lighten highlights (bright tones), darken shadows
(dark tones), change the balance of bright and dark tones.
</p>
</dd>
<dt><samp>romin</samp></dt>
<dt><samp>gomin</samp></dt>
<dt><samp>bomin</samp></dt>
<dt><samp>aomin</samp></dt>
<dd><p>Adjust red, green, blue and alpha output black point.
Allowed ranges for options are <code>[0, 1.0]</code>. Defaults are <code>0</code>.
</p>
</dd>
<dt><samp>romax</samp></dt>
<dt><samp>gomax</samp></dt>
<dt><samp>bomax</samp></dt>
<dt><samp>aomax</samp></dt>
<dd><p>Adjust red, green, blue and alpha output white point.
Allowed ranges for options are <code>[0, 1.0]</code>. Defaults are <code>1</code>.
</p>
<p>Output levels allows manual selection of a constrained output level range.
</p></dd>
</dl>
<a name="Examples-49"></a>
<h4 class="subsection">31.18.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-49" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-49" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Make video output darker:
<div class="example">
<pre class="example">colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
</pre></div>
</li><li> Increase contrast:
<div class="example">
<pre class="example">colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
</pre></div>
</li><li> Make video output lighter:
<div class="example">
<pre class="example">colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
</pre></div>
</li><li> Increase brightness:
<div class="example">
<pre class="example">colorlevels=romin=0.5:gomin=0.5:bomin=0.5
</pre></div>
</li></ul>
<a name="colorchannelmixer"></a>
<h3 class="section">31.19 colorchannelmixer<span class="pull-right"><a class="anchor hidden-xs" href="#colorchannelmixer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorchannelmixer" aria-hidden="true">TOC</a></span></h3>
<p>Adjust video input frames by re-mixing color channels.
</p>
<p>This filter modifies a color channel by adding the values associated to
the other channels of the same pixels. For example if the value to
modify is red, the output value will be:
</p><div class="example">
<pre class="example"><var>red</var>=<var>red</var>*<var>rr</var> + <var>blue</var>*<var>rb</var> + <var>green</var>*<var>rg</var> + <var>alpha</var>*<var>ra</var>
</pre></div>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rr</samp></dt>
<dt><samp>rg</samp></dt>
<dt><samp>rb</samp></dt>
<dt><samp>ra</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output red channel.
Default is <code>1</code> for <var>rr</var>, and <code>0</code> for <var>rg</var>, <var>rb</var> and <var>ra</var>.
</p>
</dd>
<dt><samp>gr</samp></dt>
<dt><samp>gg</samp></dt>
<dt><samp>gb</samp></dt>
<dt><samp>ga</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output green channel.
Default is <code>1</code> for <var>gg</var>, and <code>0</code> for <var>gr</var>, <var>gb</var> and <var>ga</var>.
</p>
</dd>
<dt><samp>br</samp></dt>
<dt><samp>bg</samp></dt>
<dt><samp>bb</samp></dt>
<dt><samp>ba</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output blue channel.
Default is <code>1</code> for <var>bb</var>, and <code>0</code> for <var>br</var>, <var>bg</var> and <var>ba</var>.
</p>
</dd>
<dt><samp>ar</samp></dt>
<dt><samp>ag</samp></dt>
<dt><samp>ab</samp></dt>
<dt><samp>aa</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
Default is <code>1</code> for <var>aa</var>, and <code>0</code> for <var>ar</var>, <var>ag</var> and <var>ab</var>.
</p>
<p>Allowed ranges for options are <code>[-2.0, 2.0]</code>.
</p></dd>
</dl>
<a name="Examples-50"></a>
<h4 class="subsection">31.19.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-50" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-50" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Convert source to grayscale:
<div class="example">
<pre class="example">colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
</pre></div>
</li><li> Simulate sepia tones:
<div class="example">
<pre class="example">colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
</pre></div>
</li></ul>
<a name="colormatrix"></a>
<h3 class="section">31.20 colormatrix<span class="pull-right"><a class="anchor hidden-xs" href="#colormatrix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colormatrix" aria-hidden="true">TOC</a></span></h3>
<p>Convert color matrix.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>src</samp></dt>
<dt><samp>dst</samp></dt>
<dd><p>Specify the source and destination color matrix. Both values must be
specified.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p>
</dd>
<dt>&lsquo;<samp>bt601</samp>&rsquo;</dt>
<dd><p>BT.601
</p>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>&lsquo;<samp>fcc</samp>&rsquo;</dt>
<dd><p>FCC
</p>
</dd>
<dt>&lsquo;<samp>bt2020</samp>&rsquo;</dt>
<dd><p>BT.2020
</p></dd>
</dl>
</dd>
</dl>
<p>For example to convert from BT.601 to SMPTE-240M, use the command:
</p><div class="example">
<pre class="example">colormatrix=bt601:smpte240m
</pre></div>
<a name="colorspace"></a>
<h3 class="section">31.21 colorspace<span class="pull-right"><a class="anchor hidden-xs" href="#colorspace" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorspace" aria-hidden="true">TOC</a></span></h3>
<p>Convert colorspace, transfer characteristics or color primaries.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dd><a name="all"></a></dd>
<dt><samp>all</samp></dt>
<dd><p>Specify all color properties at once.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt470m</samp>&rsquo;</dt>
<dd><p>BT.470M
</p>
</dd>
<dt>&lsquo;<samp>bt470bg</samp>&rsquo;</dt>
<dd><p>BT.470BG
</p>
</dd>
<dt>&lsquo;<samp>bt601-6-525</samp>&rsquo;</dt>
<dd><p>BT.601-6 525
</p>
</dd>
<dt>&lsquo;<samp>bt601-6-625</samp>&rsquo;</dt>
<dd><p>BT.601-6 625
</p>
</dd>
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p>
</dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE-170M
</p>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>&lsquo;<samp>bt2020</samp>&rsquo;</dt>
<dd><p>BT.2020
</p>
</dd>
</dl>
<a name="space"></a></dd>
<dt><samp>space</samp></dt>
<dd><p>Specify output colorspace.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p>
</dd>
<dt>&lsquo;<samp>fcc</samp>&rsquo;</dt>
<dd><p>FCC
</p>
</dd>
<dt>&lsquo;<samp>bt470bg</samp>&rsquo;</dt>
<dd><p>BT.470BG or BT.601-6 625
</p>
</dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE-170M or BT.601-6 525
</p>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>&lsquo;<samp>bt2020ncl</samp>&rsquo;</dt>
<dd><p>BT.2020 with non-constant luminance
</p>
</dd>
</dl>
<a name="trc"></a></dd>
<dt><samp>trc</samp></dt>
<dd><p>Specify output transfer characteristics.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p>
</dd>
<dt>&lsquo;<samp>gamma22</samp>&rsquo;</dt>
<dd><p>Constant gamma of 2.2
</p>
</dd>
<dt>&lsquo;<samp>gamma28</samp>&rsquo;</dt>
<dd><p>Constant gamma of 2.8
</p>
</dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE-170M, BT.601-6 625 or BT.601-6 525
</p>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>&lsquo;<samp>bt2020-10</samp>&rsquo;</dt>
<dd><p>BT.2020 for 10-bits content
</p>
</dd>
<dt>&lsquo;<samp>bt2020-12</samp>&rsquo;</dt>
<dd><p>BT.2020 for 12-bits content
</p>
</dd>
</dl>
<a name="primaries"></a></dd>
<dt><samp>primaries</samp></dt>
<dd><p>Specify output color primaries.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>BT.709
</p>
</dd>
<dt>&lsquo;<samp>bt470m</samp>&rsquo;</dt>
<dd><p>BT.470M
</p>
</dd>
<dt>&lsquo;<samp>bt470bg</samp>&rsquo;</dt>
<dd><p>BT.470BG or BT.601-6 625
</p>
</dd>
<dt>&lsquo;<samp>smpte170m</samp>&rsquo;</dt>
<dd><p>SMPTE-170M or BT.601-6 525
</p>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>&lsquo;<samp>bt2020</samp>&rsquo;</dt>
<dd><p>BT.2020
</p>
</dd>
</dl>
<a name="range"></a></dd>
<dt><samp>range</samp></dt>
<dd><p>Specify output color range.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>mpeg</samp>&rsquo;</dt>
<dd><p>MPEG (restricted) range
</p>
</dd>
<dt>&lsquo;<samp>jpeg</samp>&rsquo;</dt>
<dd><p>JPEG (full) range
</p>
</dd>
</dl>
</dd>
<dt><samp>format</samp></dt>
<dd><p>Specify output color format.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>yuv420p</samp>&rsquo;</dt>
<dd><p>YUV 4:2:0 planar 8-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv420p10</samp>&rsquo;</dt>
<dd><p>YUV 4:2:0 planar 10-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv420p12</samp>&rsquo;</dt>
<dd><p>YUV 4:2:0 planar 12-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv422p</samp>&rsquo;</dt>
<dd><p>YUV 4:2:2 planar 8-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv422p10</samp>&rsquo;</dt>
<dd><p>YUV 4:2:2 planar 10-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv422p12</samp>&rsquo;</dt>
<dd><p>YUV 4:2:2 planar 12-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv444p</samp>&rsquo;</dt>
<dd><p>YUV 4:4:4 planar 8-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv444p10</samp>&rsquo;</dt>
<dd><p>YUV 4:4:4 planar 10-bits
</p>
</dd>
<dt>&lsquo;<samp>yuv444p12</samp>&rsquo;</dt>
<dd><p>YUV 4:4:4 planar 12-bits
</p>
</dd>
</dl>
</dd>
<dt><samp>fast</samp></dt>
<dd><p>Do a fast conversion, which skips gamma/primary correction. This will take
significantly less CPU, but will be mathematically incorrect. To get output
compatible with that produced by the colormatrix filter, use fast=1.
</p>
</dd>
<dt><samp>dither</samp></dt>
<dd><p>Specify dithering mode.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No dithering
</p>
</dd>
<dt>&lsquo;<samp>fsb</samp>&rsquo;</dt>
<dd><p>Floyd-Steinberg dithering
</p></dd>
</dl>
</dd>
<dt><samp>wpadapt</samp></dt>
<dd><p>Whitepoint adaptation mode.
</p>
<p>The accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bradford</samp>&rsquo;</dt>
<dd><p>Bradford whitepoint adaptation
</p>
</dd>
<dt>&lsquo;<samp>vonkries</samp>&rsquo;</dt>
<dd><p>von Kries whitepoint adaptation
</p>
</dd>
<dt>&lsquo;<samp>identity</samp>&rsquo;</dt>
<dd><p>identity whitepoint adaptation (i.e. no whitepoint adaptation)
</p></dd>
</dl>
</dd>
<dt><samp>iall</samp></dt>
<dd><p>Override all input properties at once. Same accepted values as <a href="#all">all</a>.
</p>
</dd>
<dt><samp>ispace</samp></dt>
<dd><p>Override input colorspace. Same accepted values as <a href="#space">space</a>.
</p>
</dd>
<dt><samp>iprimaries</samp></dt>
<dd><p>Override input color primaries. Same accepted values as <a href="#primaries">primaries</a>.
</p>
</dd>
<dt><samp>itrc</samp></dt>
<dd><p>Override input transfer characteristics. Same accepted values as <a href="#trc">trc</a>.
</p>
</dd>
<dt><samp>irange</samp></dt>
<dd><p>Override input color range. Same accepted values as <a href="#range">range</a>.
</p>
</dd>
</dl>
<p>The filter converts the transfer characteristics, color space and color
primaries to the specified user values. The output value, if not specified,
is set to a default value based on the &quot;all&quot; property. If that property is
also not specified, the filter will log an error. The output color range and
format default to the same value as the input color range and format. The
input transfer characteristics, color space, color primaries and color range
should be set on the input data. If any of these are missing, the filter will
log an error and no conversion will take place.
</p>
<p>For example to convert the input to SMPTE-240M, use the command:
</p><div class="example">
<pre class="example">colorspace=smpte240m
</pre></div>
<a name="convolution"></a>
<h3 class="section">31.22 convolution<span class="pull-right"><a class="anchor hidden-xs" href="#convolution" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-convolution" aria-hidden="true">TOC</a></span></h3>
<p>Apply convolution 3x3 or 5x5 filter.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>0m</samp></dt>
<dt><samp>1m</samp></dt>
<dt><samp>2m</samp></dt>
<dt><samp>3m</samp></dt>
<dd><p>Set matrix for each plane.
Matrix is sequence of 9 or 25 signed integers.
</p>
</dd>
<dt><samp>0rdiv</samp></dt>
<dt><samp>1rdiv</samp></dt>
<dt><samp>2rdiv</samp></dt>
<dt><samp>3rdiv</samp></dt>
<dd><p>Set multiplier for calculated value for each plane.
</p>
</dd>
<dt><samp>0bias</samp></dt>
<dt><samp>1bias</samp></dt>
<dt><samp>2bias</samp></dt>
<dt><samp>3bias</samp></dt>
<dd><p>Set bias for each plane. This value is added to the result of the multiplication.
Useful for making the overall image brighter or darker. Default is 0.0.
</p></dd>
</dl>
<a name="Examples-51"></a>
<h4 class="subsection">31.22.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-51" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-51" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply sharpen:
<div class="example">
<pre class="example">convolution=&quot;0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0&quot;
</pre></div>
</li><li> Apply blur:
<div class="example">
<pre class="example">convolution=&quot;1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9&quot;
</pre></div>
</li><li> Apply edge enhance:
<div class="example">
<pre class="example">convolution=&quot;0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128&quot;
</pre></div>
</li><li> Apply edge detect:
<div class="example">
<pre class="example">convolution=&quot;0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128&quot;
</pre></div>
</li><li> Apply emboss:
<div class="example">
<pre class="example">convolution=&quot;-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2&quot;
</pre></div>
</li></ul>
<a name="copy"></a>
<h3 class="section">31.23 copy<span class="pull-right"><a class="anchor hidden-xs" href="#copy" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-copy" aria-hidden="true">TOC</a></span></h3>
<p>Copy the input source unchanged to the output. This is mainly useful for
testing purposes.
</p>
<a name="coreimage"></a><a name="coreimage-1"></a>
<h3 class="section">31.24 coreimage<span class="pull-right"><a class="anchor hidden-xs" href="#coreimage-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-coreimage-1" aria-hidden="true">TOC</a></span></h3>
<p>Video filtering on GPU using Apple&rsquo;s CoreImage API on OSX.
</p>
<p>Hardware acceleration is based on an OpenGL context. Usually, this means it is
processed by video hardware. However, software-based OpenGL implementations
exist which means there is no guarantee for hardware processing. It depends on
the respective OSX.
</p>
<p>There are many filters and image generators provided by Apple that come with a
large variety of options. The filter has to be referenced by its name along
with its options.
</p>
<p>The coreimage filter accepts the following options:
</p><dl compact="compact">
<dt><samp>list_filters</samp></dt>
<dd><p>List all available filters and generators along with all their respective
options as well as possible minimum and maximum values along with the default
values.
</p><div class="example">
<pre class="example">list_filters=true
</pre></div>
</dd>
<dt><samp>filter</samp></dt>
<dd><p>Specify all filters by their respective name and options.
Use <var>list_filters</var> to determine all valid filter names and options.
Numerical options are specified by a float value and are automatically clamped
to their respective value range. Vector and color options have to be specified
by a list of space separated float values. Character escaping has to be done.
A special option name <code>default</code> is available to use default options for a
filter.
</p>
<p>It is required to specify either <code>default</code> or at least one of the filter options.
All omitted options are used with their default values.
The syntax of the filter string is as follows:
</p><div class="example">
<pre class="example">filter=&lt;NAME&gt;@&lt;OPTION&gt;=&lt;VALUE&gt;[@&lt;OPTION&gt;=&lt;VALUE&gt;][@...][#&lt;NAME&gt;@&lt;OPTION&gt;=&lt;VALUE&gt;[@&lt;OPTION&gt;=&lt;VALUE&gt;][@...]][#...]
</pre></div>
</dd>
<dt><samp>output_rect</samp></dt>
<dd><p>Specify a rectangle where the output of the filter chain is copied into the
input image. It is given by a list of space separated float values:
</p><div class="example">
<pre class="example">output_rect=x\ y\ width\ height
</pre></div>
<p>If not given, the output rectangle equals the dimensions of the input image.
The output rectangle is automatically cropped at the borders of the input
image. Negative values are valid for each component.
</p><div class="example">
<pre class="example">output_rect=25\ 25\ 100\ 100
</pre></div>
</dd>
</dl>
<p>Several filters can be chained for successive processing without GPU-HOST
transfers allowing for fast processing of complex filter chains.
Currently, only filters with zero (generators) or exactly one (filters) input
image and one output image are supported. Also, transition filters are not yet
usable as intended.
</p>
<p>Some filters generate output images with additional padding depending on the
respective filter kernel. The padding is automatically removed to ensure the
filter output has the same size as the input image.
</p>
<p>For image generators, the size of the output image is determined by the
previous output image of the filter chain or the input image of the whole
filterchain, respectively. The generators do not use the pixel information of
this image to generate their output. However, the generated output is
blended onto this image, resulting in partial or complete coverage of the
output image.
</p>
<p>The <a href="#coreimagesrc">coreimagesrc</a> video source can be used for generating input images
which are directly fed into the filter chain. By using it, providing input
images by another video source or an input video is not required.
</p>
<a name="Examples-52"></a>
<h4 class="subsection">31.24.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-52" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-52" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> List all filters available:
<div class="example">
<pre class="example">coreimage=list_filters=true
</pre></div>
</li><li> Use the CIBoxBlur filter with default options to blur an image:
<div class="example">
<pre class="example">coreimage=filter=CIBoxBlur@default
</pre></div>
</li><li> Use a filter chain with CISepiaTone at default values and CIVignetteEffect with
its center at 100x100 and a radius of 50 pixels:
<div class="example">
<pre class="example">coreimage=filter=CIBoxBlur@default#CIVignetteEffect@inputCenter=100\ 100@inputRadius=50
</pre></div>
</li><li> Use nullsrc and CIQRCodeGenerator to create a QR code for the FFmpeg homepage,
given as complete and escaped command-line for Apple&rsquo;s standard bash shell:
<div class="example">
<pre class="example">ffmpeg -f lavfi -i nullsrc=s=100x100,coreimage=filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
</pre></div>
</li></ul>
<a name="crop"></a>
<h3 class="section">31.25 crop<span class="pull-right"><a class="anchor hidden-xs" href="#crop" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-crop" aria-hidden="true">TOC</a></span></h3>
<p>Crop the input video to given dimensions.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>w, out_w</samp></dt>
<dd><p>The width of the output video. It defaults to <code>iw</code>.
This expression is evaluated only once during the filter
configuration, or when the &lsquo;<samp>w</samp>&rsquo; or &lsquo;<samp>out_w</samp>&rsquo; command is sent.
</p>
</dd>
<dt><samp>h, out_h</samp></dt>
<dd><p>The height of the output video. It defaults to <code>ih</code>.
This expression is evaluated only once during the filter
configuration, or when the &lsquo;<samp>h</samp>&rsquo; or &lsquo;<samp>out_h</samp>&rsquo; command is sent.
</p>
</dd>
<dt><samp>x</samp></dt>
<dd><p>The horizontal position, in the input video, of the left edge of the output
video. It defaults to <code>(in_w-out_w)/2</code>.
This expression is evaluated per-frame.
</p>
</dd>
<dt><samp>y</samp></dt>
<dd><p>The vertical position, in the input video, of the top edge of the output video.
It defaults to <code>(in_h-out_h)/2</code>.
This expression is evaluated per-frame.
</p>
</dd>
<dt><samp>keep_aspect</samp></dt>
<dd><p>If set to 1 will force the output display aspect ratio
to be the same of the input, by changing the output sample aspect
ratio. It defaults to 0.
</p>
</dd>
<dt><samp>exact</samp></dt>
<dd><p>Enable exact cropping. If enabled, subsampled videos will be cropped at exact
width/height/x/y as specified and will not be rounded to nearest smaller value.
It defaults to 0.
</p></dd>
</dl>
<p>The <var>out_w</var>, <var>out_h</var>, <var>x</var>, <var>y</var> parameters are
expressions containing the following constants:
</p>
<dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The computed values for <var>x</var> and <var>y</var>. They are evaluated for
each new frame.
</p>
</dd>
<dt><samp>in_w</samp></dt>
<dt><samp>in_h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>iw</samp></dt>
<dt><samp>ih</samp></dt>
<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>.
</p>
</dd>
<dt><samp>out_w</samp></dt>
<dt><samp>out_h</samp></dt>
<dd><p>The output (cropped) width and height.
</p>
</dd>
<dt><samp>ow</samp></dt>
<dt><samp>oh</samp></dt>
<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>.
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>same as <var>iw</var> / <var>ih</var>
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp>dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var>iw</var> / <var>ih</var>) * <var>sar</var>
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>The number of the input frame, starting from 0.
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The timestamp expressed in seconds. It&rsquo;s NAN if the input timestamp is unknown.
</p>
</dd>
</dl>
<p>The expression for <var>out_w</var> may depend on the value of <var>out_h</var>,
and the expression for <var>out_h</var> may depend on <var>out_w</var>, but they
cannot depend on <var>x</var> and <var>y</var>, as <var>x</var> and <var>y</var> are
evaluated after <var>out_w</var> and <var>out_h</var>.
</p>
<p>The <var>x</var> and <var>y</var> parameters specify the expressions for the
position of the top-left corner of the output (non-cropped) area. They
are evaluated for each frame. If the evaluated value is not valid, it
is approximated to the nearest valid value.
</p>
<p>The expression for <var>x</var> may depend on <var>y</var>, and the expression
for <var>y</var> may depend on <var>x</var>.
</p>
<a name="Examples-53"></a>
<h4 class="subsection">31.25.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-53" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-53" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Crop area with size 100x100 at position (12,34).
<div class="example">
<pre class="example">crop=100:100:12:34
</pre></div>
<p>Using named options, the example above becomes:
</p><div class="example">
<pre class="example">crop=w=100:h=100:x=12:y=34
</pre></div>
</li><li> Crop the central input area with size 100x100:
<div class="example">
<pre class="example">crop=100:100
</pre></div>
</li><li> Crop the central input area with size 2/3 of the input video:
<div class="example">
<pre class="example">crop=2/3*in_w:2/3*in_h
</pre></div>
</li><li> Crop the input video central square:
<div class="example">
<pre class="example">crop=out_w=in_h
crop=in_h
</pre></div>
</li><li> Delimit the rectangle with the top-left corner placed at position
100:100 and the right-bottom corner corresponding to the right-bottom
corner of the input image.
<div class="example">
<pre class="example">crop=in_w-100:in_h-100:100:100
</pre></div>
</li><li> Crop 10 pixels from the left and right borders, and 20 pixels from
the top and bottom borders
<div class="example">
<pre class="example">crop=in_w-2*10:in_h-2*20
</pre></div>
</li><li> Keep only the bottom right quarter of the input image:
<div class="example">
<pre class="example">crop=in_w/2:in_h/2:in_w/2:in_h/2
</pre></div>
</li><li> Crop height for getting Greek harmony:
<div class="example">
<pre class="example">crop=in_w:1/PHI*in_w
</pre></div>
</li><li> Apply trembling effect:
<div class="example">
<pre class="example">crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
</pre></div>
</li><li> Apply erratic camera effect depending on timestamp:
<div class="example">
<pre class="example">crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)&quot;
</pre></div>
</li><li> Set x depending on the value of y:
<div class="example">
<pre class="example">crop=in_w/2:in_h/2:y:10+10*sin(n/10)
</pre></div>
</li></ul>
<a name="Commands-3"></a>
<h4 class="subsection">31.25.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-3" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>w, out_w</samp></dt>
<dt><samp>h, out_h</samp></dt>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Set width/height of the output video and the horizontal/vertical position
in the input video.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a name="cropdetect"></a>
<h3 class="section">31.26 cropdetect<span class="pull-right"><a class="anchor hidden-xs" href="#cropdetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cropdetect" aria-hidden="true">TOC</a></span></h3>
<p>Auto-detect the crop size.
</p>
<p>It calculates the necessary cropping parameters and prints the
recommended parameters via the logging system. The detected dimensions
correspond to the non-black area of the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>limit</samp></dt>
<dd><p>Set higher black value threshold, which can be optionally specified
from nothing (0) to everything (255 for 8-bit based formats). An intensity
value greater to the set value is considered non-black. It defaults to 24.
You can also specify a value between 0.0 and 1.0 which will be scaled depending
on the bitdepth of the pixel format.
</p>
</dd>
<dt><samp>round</samp></dt>
<dd><p>The value which the width/height should be divisible by. It defaults to
16. The offset is automatically adjusted to center the video. Use 2 to
get only even dimensions (needed for 4:2:2 video). 16 is best when
encoding to most video codecs.
</p>
</dd>
<dt><samp>reset_count, reset</samp></dt>
<dd><p>Set the counter that determines after how many frames cropdetect will
reset the previously detected largest video area and start over to
detect the current optimal crop area. Default value is 0.
</p>
<p>This can be useful when channel logos distort the video area. 0
indicates &rsquo;never reset&rsquo;, and returns the largest area encountered during
playback.
</p></dd>
</dl>
<a name="curves"></a><a name="curves-1"></a>
<h3 class="section">31.27 curves<span class="pull-right"><a class="anchor hidden-xs" href="#curves-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-curves-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply color adjustments using curves.
</p>
<p>This filter is similar to the Adobe Photoshop and GIMP curves tools. Each
component (red, green and blue) has its values defined by <var>N</var> key points
tied from each other using a smooth curve. The x-axis represents the pixel
values from the input frame, and the y-axis the new pixel values to be set for
the output frame.
</p>
<p>By default, a component curve is defined by the two points <var>(0;0)</var> and
<var>(1;1)</var>. This creates a straight line where each original pixel value is
&quot;adjusted&quot; to its own value, which means no change to the image.
</p>
<p>The filter allows you to redefine these two points and add some more. A new
curve (using a natural cubic spline interpolation) will be define to pass
smoothly through all these new coordinates. The new defined points needs to be
strictly increasing over the x-axis, and their <var>x</var> and <var>y</var> values must
be in the <var>[0;1]</var> interval. If the computed curves happened to go outside
the vector spaces, the values will be clipped accordingly.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>preset</samp></dt>
<dd><p>Select one of the available color presets. This option can be used in addition
to the <samp>r</samp>, <samp>g</samp>, <samp>b</samp> parameters; in this case, the later
options takes priority on the preset values.
Available presets are:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dt>&lsquo;<samp>color_negative</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cross_process</samp>&rsquo;</dt>
<dt>&lsquo;<samp>darker</samp>&rsquo;</dt>
<dt>&lsquo;<samp>increase_contrast</samp>&rsquo;</dt>
<dt>&lsquo;<samp>lighter</samp>&rsquo;</dt>
<dt>&lsquo;<samp>linear_contrast</samp>&rsquo;</dt>
<dt>&lsquo;<samp>medium_contrast</samp>&rsquo;</dt>
<dt>&lsquo;<samp>negative</samp>&rsquo;</dt>
<dt>&lsquo;<samp>strong_contrast</samp>&rsquo;</dt>
<dt>&lsquo;<samp>vintage</samp>&rsquo;</dt>
</dl>
<p>Default is <code>none</code>.
</p></dd>
<dt><samp>master, m</samp></dt>
<dd><p>Set the master key points. These points will define a second pass mapping. It
is sometimes called a &quot;luminance&quot; or &quot;value&quot; mapping. It can be used with
<samp>r</samp>, <samp>g</samp>, <samp>b</samp> or <samp>all</samp> since it acts like a
post-processing LUT.
</p></dd>
<dt><samp>red, r</samp></dt>
<dd><p>Set the key points for the red component.
</p></dd>
<dt><samp>green, g</samp></dt>
<dd><p>Set the key points for the green component.
</p></dd>
<dt><samp>blue, b</samp></dt>
<dd><p>Set the key points for the blue component.
</p></dd>
<dt><samp>all</samp></dt>
<dd><p>Set the key points for all components (not including master).
Can be used in addition to the other key points component
options. In this case, the unset component(s) will fallback on this
<samp>all</samp> setting.
</p></dd>
<dt><samp>psfile</samp></dt>
<dd><p>Specify a Photoshop curves file (<code>.acv</code>) to import the settings from.
</p></dd>
<dt><samp>plot</samp></dt>
<dd><p>Save Gnuplot script of the curves in specified file.
</p></dd>
</dl>
<p>To avoid some filtergraph syntax conflicts, each key points list need to be
defined using the following syntax: <code>x0/y0 x1/y1 x2/y2 ...</code>.
</p>
<a name="Examples-54"></a>
<h4 class="subsection">31.27.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-54" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-54" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Increase slightly the middle level of blue:
<div class="example">
<pre class="example">curves=blue='0/0 0.5/0.58 1/1'
</pre></div>
</li><li> Vintage effect:
<div class="example">
<pre class="example">curves=r='0/0.11 .42/.51 1/0.95':g='0/0 0.50/0.48 1/1':b='0/0.22 .49/.44 1/0.8'
</pre></div>
<p>Here we obtain the following coordinates for each components:
</p><dl compact="compact">
<dt><var>red</var></dt>
<dd><p><code>(0;0.11) (0.42;0.51) (1;0.95)</code>
</p></dd>
<dt><var>green</var></dt>
<dd><p><code>(0;0) (0.50;0.48) (1;1)</code>
</p></dd>
<dt><var>blue</var></dt>
<dd><p><code>(0;0.22) (0.49;0.44) (1;0.80)</code>
</p></dd>
</dl>
</li><li> The previous example can also be achieved with the associated built-in preset:
<div class="example">
<pre class="example">curves=preset=vintage
</pre></div>
</li><li> Or simply:
<div class="example">
<pre class="example">curves=vintage
</pre></div>
</li><li> Use a Photoshop preset and redefine the points of the green component:
<div class="example">
<pre class="example">curves=psfile='MyCurvesPresets/purple.acv':green='0/0 0.45/0.53 1/1'
</pre></div>
</li><li> Check out the curves of the <code>cross_process</code> profile using <code>ffmpeg</code>
and <code>gnuplot</code>:
<div class="example">
<pre class="example">ffmpeg -f lavfi -i color -vf curves=cross_process:plot=/tmp/curves.plt -frames:v 1 -f null -
gnuplot -p /tmp/curves.plt
</pre></div>
</li></ul>
<a name="datascope"></a>
<h3 class="section">31.28 datascope<span class="pull-right"><a class="anchor hidden-xs" href="#datascope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-datascope" aria-hidden="true">TOC</a></span></h3>
<p>Video data analysis filter.
</p>
<p>This filter shows hexadecimal pixel values of part of video.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Set output video size.
</p>
</dd>
<dt><samp>x</samp></dt>
<dd><p>Set x offset from where to pick pixels.
</p>
</dd>
<dt><samp>y</samp></dt>
<dd><p>Set y offset from where to pick pixels.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set scope mode, can be one of the following:
</p><dl compact="compact">
<dt>&lsquo;<samp>mono</samp>&rsquo;</dt>
<dd><p>Draw hexadecimal pixel values with white color on black background.
</p>
</dd>
<dt>&lsquo;<samp>color</samp>&rsquo;</dt>
<dd><p>Draw hexadecimal pixel values with input video pixel color on black
background.
</p>
</dd>
<dt>&lsquo;<samp>color2</samp>&rsquo;</dt>
<dd><p>Draw hexadecimal pixel values on color background picked from input video,
the text color is picked in such way so its always visible.
</p></dd>
</dl>
</dd>
<dt><samp>axis</samp></dt>
<dd><p>Draw rows and columns numbers on left and top of video.
</p>
</dd>
<dt><samp>opacity</samp></dt>
<dd><p>Set background opacity.
</p></dd>
</dl>
<a name="dctdnoiz"></a>
<h3 class="section">31.29 dctdnoiz<span class="pull-right"><a class="anchor hidden-xs" href="#dctdnoiz" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dctdnoiz" aria-hidden="true">TOC</a></span></h3>
<p>Denoise frames using 2D DCT (frequency domain filtering).
</p>
<p>This filter is not designed for real time.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sigma, s</samp></dt>
<dd><p>Set the noise sigma constant.
</p>
<p>This <var>sigma</var> defines a hard threshold of <code>3 * sigma</code>; every DCT
coefficient (absolute value) below this threshold with be dropped.
</p>
<p>If you need a more advanced filtering, see <samp>expr</samp>.
</p>
<p>Default is <code>0</code>.
</p>
</dd>
<dt><samp>overlap</samp></dt>
<dd><p>Set number overlapping pixels for each block. Since the filter can be slow, you
may want to reduce this value, at the cost of a less effective filter and the
risk of various artefacts.
</p>
<p>If the overlapping value doesn&rsquo;t permit processing the whole input width or
height, a warning will be displayed and according borders won&rsquo;t be denoised.
</p>
<p>Default value is <var>blocksize</var>-1, which is the best possible setting.
</p>
</dd>
<dt><samp>expr, e</samp></dt>
<dd><p>Set the coefficient factor expression.
</p>
<p>For each coefficient of a DCT block, this expression will be evaluated as a
multiplier value for the coefficient.
</p>
<p>If this is option is set, the <samp>sigma</samp> option will be ignored.
</p>
<p>The absolute value of the coefficient can be accessed through the <var>c</var>
variable.
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>Set the <var>blocksize</var> using the number of bits. <code>1&lt;&lt;<var>n</var></code> defines the
<var>blocksize</var>, which is the width and height of the processed blocks.
</p>
<p>The default value is <var>3</var> (8x8) and can be raised to <var>4</var> for a
<var>blocksize</var> of 16x16. Note that changing this setting has huge consequences
on the speed processing. Also, a larger block size does not necessarily means a
better de-noising.
</p></dd>
</dl>
<a name="Examples-55"></a>
<h4 class="subsection">31.29.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-55" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-55" aria-hidden="true">TOC</a></span></h4>
<p>Apply a denoise with a <samp>sigma</samp> of <code>4.5</code>:
</p><div class="example">
<pre class="example">dctdnoiz=4.5
</pre></div>
<p>The same operation can be achieved using the expression system:
</p><div class="example">
<pre class="example">dctdnoiz=e='gte(c, 4.5*3)'
</pre></div>
<p>Violent denoise using a block size of <code>16x16</code>:
</p><div class="example">
<pre class="example">dctdnoiz=15:n=4
</pre></div>
<a name="deband"></a>
<h3 class="section">31.30 deband<span class="pull-right"><a class="anchor hidden-xs" href="#deband" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deband" aria-hidden="true">TOC</a></span></h3>
<p>Remove banding artifacts from input video.
It works by replacing banded pixels with average value of referenced pixels.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>1thr</samp></dt>
<dt><samp>2thr</samp></dt>
<dt><samp>3thr</samp></dt>
<dt><samp>4thr</samp></dt>
<dd><p>Set banding detection threshold for each plane. Default is 0.02.
Valid range is 0.00003 to 0.5.
If difference between current pixel and reference pixel is less than threshold,
it will be considered as banded.
</p>
</dd>
<dt><samp>range, r</samp></dt>
<dd><p>Banding detection range in pixels. Default is 16. If positive, random number
in range 0 to set value will be used. If negative, exact absolute value
will be used.
The range defines square of four pixels around current pixel.
</p>
</dd>
<dt><samp>direction, d</samp></dt>
<dd><p>Set direction in radians from which four pixel will be compared. If positive,
random direction from 0 to set direction will be picked. If negative, exact of
absolute value will be picked. For example direction 0, -PI or -2*PI radians
will pick only pixels on same row and -PI/2 will pick only pixels on same
column.
</p>
</dd>
<dt><samp>blur</samp></dt>
<dd><p>If enabled, current pixel is compared with average value of all four
surrounding pixels. The default is enabled. If disabled current pixel is
compared with all four surrounding pixels. The pixel is considered banded
if only all four differences with surrounding pixels are less than threshold.
</p></dd>
</dl>
<a name="decimate"></a><a name="decimate-1"></a>
<h3 class="section">31.31 decimate<span class="pull-right"><a class="anchor hidden-xs" href="#decimate-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-decimate-1" aria-hidden="true">TOC</a></span></h3>
<p>Drop duplicated frames at regular intervals.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>cycle</samp></dt>
<dd><p>Set the number of frames from which one will be dropped. Setting this to
<var>N</var> means one frame in every batch of <var>N</var> frames will be dropped.
Default is <code>5</code>.
</p>
</dd>
<dt><samp>dupthresh</samp></dt>
<dd><p>Set the threshold for duplicate detection. If the difference metric for a frame
is less than or equal to this value, then it is declared as duplicate. Default
is <code>1.1</code>
</p>
</dd>
<dt><samp>scthresh</samp></dt>
<dd><p>Set scene change threshold. Default is <code>15</code>.
</p>
</dd>
<dt><samp>blockx</samp></dt>
<dt><samp>blocky</samp></dt>
<dd><p>Set the size of the x and y-axis blocks used during metric calculations.
Larger blocks give better noise suppression, but also give worse detection of
small movements. Must be a power of two. Default is <code>32</code>.
</p>
</dd>
<dt><samp>ppsrc</samp></dt>
<dd><p>Mark main input as a pre-processed input and activate clean source input
stream. This allows the input to be pre-processed with various filters to help
the metrics calculation while keeping the frame selection lossless. When set to
<code>1</code>, the first stream is for the pre-processed input, and the second
stream is the clean source from where the kept frames are chosen. Default is
<code>0</code>.
</p>
</dd>
<dt><samp>chroma</samp></dt>
<dd><p>Set whether or not chroma is considered in the metric calculations. Default is
<code>1</code>.
</p></dd>
</dl>
<a name="deflate"></a>
<h3 class="section">31.32 deflate<span class="pull-right"><a class="anchor hidden-xs" href="#deflate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deflate" aria-hidden="true">TOC</a></span></h3>
<p>Apply deflate effect to the video.
</p>
<p>This filter replaces the pixel by the local(3x3) average by taking into account
only values lower than the pixel.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>threshold0</samp></dt>
<dt><samp>threshold1</samp></dt>
<dt><samp>threshold2</samp></dt>
<dt><samp>threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p></dd>
</dl>
<a name="dejudder"></a>
<h3 class="section">31.33 dejudder<span class="pull-right"><a class="anchor hidden-xs" href="#dejudder" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dejudder" aria-hidden="true">TOC</a></span></h3>
<p>Remove judder produced by partially interlaced telecined content.
</p>
<p>Judder can be introduced, for instance, by <a href="#pullup">pullup</a> filter. If the original
source was partially telecined content then the output of <code>pullup,dejudder</code>
will have a variable frame rate. May change the recorded frame rate of the
container. Aside from that change, this filter will not affect constant frame
rate video.
</p>
<p>The option available in this filter is:
</p><dl compact="compact">
<dt><samp>cycle</samp></dt>
<dd><p>Specify the length of the window over which the judder repeats.
</p>
<p>Accepts any integer greater than 1. Useful values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>4</samp>&rsquo;</dt>
<dd><p>If the original was telecined from 24 to 30 fps (Film to NTSC).
</p>
</dd>
<dt>&lsquo;<samp>5</samp>&rsquo;</dt>
<dd><p>If the original was telecined from 25 to 30 fps (PAL to NTSC).
</p>
</dd>
<dt>&lsquo;<samp>20</samp>&rsquo;</dt>
<dd><p>If a mixture of the two.
</p></dd>
</dl>
<p>The default is &lsquo;<samp>4</samp>&rsquo;.
</p></dd>
</dl>
<a name="delogo"></a>
<h3 class="section">31.34 delogo<span class="pull-right"><a class="anchor hidden-xs" href="#delogo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-delogo" aria-hidden="true">TOC</a></span></h3>
<p>Suppress a TV station logo by a simple interpolation of the surrounding
pixels. Just set a rectangle covering the logo and watch it disappear
(and sometimes something even uglier appear - your mileage may vary).
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Specify the top left corner coordinates of the logo. They must be
specified.
</p>
</dd>
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>Specify the width and height of the logo to clear. They must be
specified.
</p>
</dd>
<dt><samp>band, t</samp></dt>
<dd><p>Specify the thickness of the fuzzy edge of the rectangle (added to
<var>w</var> and <var>h</var>). The default value is 1. This option is
deprecated, setting higher values should no longer be necessary and
is not recommended.
</p>
</dd>
<dt><samp>show</samp></dt>
<dd><p>When set to 1, a green rectangle is drawn on the screen to simplify
finding the right <var>x</var>, <var>y</var>, <var>w</var>, and <var>h</var> parameters.
The default value is 0.
</p>
<p>The rectangle is drawn on the outermost pixels which will be (partly)
replaced with interpolated values. The values of the next pixels
immediately outside this rectangle in each direction will be used to
compute the interpolated pixel values inside the rectangle.
</p>
</dd>
</dl>
<a name="Examples-56"></a>
<h4 class="subsection">31.34.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-56" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-56" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Set a rectangle covering the area with top left corner coordinates 0,0
and size 100x77, and a band of size 10:
<div class="example">
<pre class="example">delogo=x=0:y=0:w=100:h=77:band=10
</pre></div>
</li></ul>
<a name="deshake"></a>
<h3 class="section">31.35 deshake<span class="pull-right"><a class="anchor hidden-xs" href="#deshake" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deshake" aria-hidden="true">TOC</a></span></h3>
<p>Attempt to fix small changes in horizontal and/or vertical shift. This
filter helps remove camera shake from hand-holding a camera, bumping a
tripod, moving on a vehicle, etc.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>Specify a rectangular area where to limit the search for motion
vectors.
If desired the search for motion vectors can be limited to a
rectangular area of the frame defined by its top left corner, width
and height. These parameters have the same meaning as the drawbox
filter which can be used to visualise the position of the bounding
box.
</p>
<p>This is useful when simultaneous movement of subjects within the frame
might be confused for camera motion by the motion vector search.
</p>
<p>If any or all of <var>x</var>, <var>y</var>, <var>w</var> and <var>h</var> are set to -1
then the full frame is used. This allows later options to be set
without specifying the bounding box for the motion vector search.
</p>
<p>Default - search the whole frame.
</p>
</dd>
<dt><samp>rx</samp></dt>
<dt><samp>ry</samp></dt>
<dd><p>Specify the maximum extent of movement in x and y directions in the
range 0-64 pixels. Default 16.
</p>
</dd>
<dt><samp>edge</samp></dt>
<dd><p>Specify how to generate pixels to fill blanks at the edge of the
frame. Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>blank, 0</samp>&rsquo;</dt>
<dd><p>Fill zeroes at blank locations
</p></dd>
<dt>&lsquo;<samp>original, 1</samp>&rsquo;</dt>
<dd><p>Original image at blank locations
</p></dd>
<dt>&lsquo;<samp>clamp, 2</samp>&rsquo;</dt>
<dd><p>Extruded edge value at blank locations
</p></dd>
<dt>&lsquo;<samp>mirror, 3</samp>&rsquo;</dt>
<dd><p>Mirrored edge at blank locations
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>mirror</samp>&rsquo;.
</p>
</dd>
<dt><samp>blocksize</samp></dt>
<dd><p>Specify the blocksize to use for motion search. Range 4-128 pixels,
default 8.
</p>
</dd>
<dt><samp>contrast</samp></dt>
<dd><p>Specify the contrast threshold for blocks. Only blocks with more than
the specified contrast (difference between darkest and lightest
pixels) will be considered. Range 1-255, default 125.
</p>
</dd>
<dt><samp>search</samp></dt>
<dd><p>Specify the search strategy. Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>exhaustive, 0</samp>&rsquo;</dt>
<dd><p>Set exhaustive search
</p></dd>
<dt>&lsquo;<samp>less, 1</samp>&rsquo;</dt>
<dd><p>Set less exhaustive search.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>exhaustive</samp>&rsquo;.
</p>
</dd>
<dt><samp>filename</samp></dt>
<dd><p>If set then a detailed log of the motion search is written to the
specified file.
</p>
</dd>
<dt><samp>opencl</samp></dt>
<dd><p>If set to 1, specify using OpenCL capabilities, only available if
FFmpeg was configured with <code>--enable-opencl</code>. Default value is 0.
</p>
</dd>
</dl>
<a name="detelecine"></a>
<h3 class="section">31.36 detelecine<span class="pull-right"><a class="anchor hidden-xs" href="#detelecine" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-detelecine" aria-hidden="true">TOC</a></span></h3>
<p>Apply an exact inverse of the telecine operation. It requires a predefined
pattern specified using the pattern option which must be the same as that passed
to the telecine filter.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>first_field</samp></dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>top, t</samp>&rsquo;</dt>
<dd><p>top field first
</p></dd>
<dt>&lsquo;<samp>bottom, b</samp>&rsquo;</dt>
<dd><p>bottom field first
The default value is <code>top</code>.
</p></dd>
</dl>
</dd>
<dt><samp>pattern</samp></dt>
<dd><p>A string of numbers representing the pulldown pattern you wish to apply.
The default value is <code>23</code>.
</p>
</dd>
<dt><samp>start_frame</samp></dt>
<dd><p>A number representing position of the first frame with respect to the telecine
pattern. This is to be used if the stream is cut. The default value is <code>0</code>.
</p></dd>
</dl>
<a name="dilation"></a>
<h3 class="section">31.37 dilation<span class="pull-right"><a class="anchor hidden-xs" href="#dilation" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dilation" aria-hidden="true">TOC</a></span></h3>
<p>Apply dilation effect to the video.
</p>
<p>This filter replaces the pixel by the local(3x3) maximum.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>threshold0</samp></dt>
<dt><samp>threshold1</samp></dt>
<dt><samp>threshold2</samp></dt>
<dt><samp>threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p>
</dd>
<dt><samp>coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
pixels are used.
</p>
<p>Flags to local 3x3 coordinates maps like this:
</p>
<p>1 2 3
4 5
6 7 8
</p></dd>
</dl>
<a name="displace"></a>
<h3 class="section">31.38 displace<span class="pull-right"><a class="anchor hidden-xs" href="#displace" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-displace" aria-hidden="true">TOC</a></span></h3>
<p>Displace pixels as indicated by second and third input stream.
</p>
<p>It takes three input streams and outputs one stream, the first input is the
source, and second and third input are displacement maps.
</p>
<p>The second input specifies how much to displace pixels along the
x-axis, while the third input specifies how much to displace pixels
along the y-axis.
If one of displacement map streams terminates, last frame from that
displacement map will be used.
</p>
<p>Note that once generated, displacements maps can be reused over and over again.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>edge</samp></dt>
<dd><p>Set displace behavior for pixels that are out of range.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>blank</samp>&rsquo;</dt>
<dd><p>Missing pixels are replaced by black pixels.
</p>
</dd>
<dt>&lsquo;<samp>smear</samp>&rsquo;</dt>
<dd><p>Adjacent pixels will spread out to replace missing pixels.
</p>
</dd>
<dt>&lsquo;<samp>wrap</samp>&rsquo;</dt>
<dd><p>Out of range pixels are wrapped so they point to pixels of other side.
</p></dd>
</dl>
<p>Default is &lsquo;<samp>smear</samp>&rsquo;.
</p>
</dd>
</dl>
<a name="Examples-57"></a>
<h4 class="subsection">31.38.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-57" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-57" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Add ripple effect to rgb input of video size hd720:
<div class="example">
<pre class="example">ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
</pre></div>
</li><li> Add wave effect to rgb input of video size hd720:
<div class="example">
<pre class="example">ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
</pre></div>
</li></ul>
<a name="drawbox"></a>
<h3 class="section">31.39 drawbox<span class="pull-right"><a class="anchor hidden-xs" href="#drawbox" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drawbox" aria-hidden="true">TOC</a></span></h3>
<p>Draw a colored box on the input image.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The expressions which specify the top left corner coordinates of the box. It defaults to 0.
</p>
</dd>
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>The expressions which specify the width and height of the box; if 0 they are interpreted as
the input width and height. It defaults to 0.
</p>
</dd>
<dt><samp>color, c</samp></dt>
<dd><p>Specify the color of the box to write. For the general syntax of this option,
check the &quot;Color&quot; section in the ffmpeg-utils manual. If the special
value <code>invert</code> is used, the box edge color is the same as the
video with inverted luma.
</p>
</dd>
<dt><samp>thickness, t</samp></dt>
<dd><p>The expression which sets the thickness of the box edge. Default value is <code>3</code>.
</p>
<p>See below for the list of accepted constants.
</p></dd>
</dl>
<p>The parameters for <var>x</var>, <var>y</var>, <var>w</var> and <var>h</var> and <var>t</var> are expressions containing the
following constants:
</p>
<dl compact="compact">
<dt><samp>dar</samp></dt>
<dd><p>The input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var>.
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><samp>in_h, ih</samp></dt>
<dt><samp>in_w, iw</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The x and y offset coordinates where the box is drawn.
</p>
</dd>
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The width and height of the drawn box.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The thickness of the drawn box.
</p>
<p>These constants allow the <var>x</var>, <var>y</var>, <var>w</var>, <var>h</var> and <var>t</var> expressions to refer to
each other, so you may for example specify <code>y=x/dar</code> or <code>h=w/dar</code>.
</p>
</dd>
</dl>
<a name="Examples-58"></a>
<h4 class="subsection">31.39.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-58" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-58" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Draw a black box around the edge of the input image:
<div class="example">
<pre class="example">drawbox
</pre></div>
</li><li> Draw a box with color red and an opacity of 50%:
<div class="example">
<pre class="example">drawbox=10:20:200:60:red@0.5
</pre></div>
<p>The previous example can be specified as:
</p><div class="example">
<pre class="example">drawbox=x=10:y=20:w=200:h=60:color=red@0.5
</pre></div>
</li><li> Fill the box with pink color:
<div class="example">
<pre class="example">drawbox=x=10:y=10:w=100:h=100:color=pink@0.5:t=max
</pre></div>
</li><li> Draw a 2-pixel red 2.40:1 mask:
<div class="example">
<pre class="example">drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
</pre></div>
</li></ul>
<a name="drawgrid"></a>
<h3 class="section">31.40 drawgrid<span class="pull-right"><a class="anchor hidden-xs" href="#drawgrid" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drawgrid" aria-hidden="true">TOC</a></span></h3>
<p>Draw a grid on the input image.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
</p>
</dd>
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
input width and height, respectively, minus <code>thickness</code>, so image gets
framed. Default to 0.
</p>
</dd>
<dt><samp>color, c</samp></dt>
<dd><p>Specify the color of the grid. For the general syntax of this option,
check the &quot;Color&quot; section in the ffmpeg-utils manual. If the special
value <code>invert</code> is used, the grid color is the same as the
video with inverted luma.
</p>
</dd>
<dt><samp>thickness, t</samp></dt>
<dd><p>The expression which sets the thickness of the grid line. Default value is <code>1</code>.
</p>
<p>See below for the list of accepted constants.
</p></dd>
</dl>
<p>The parameters for <var>x</var>, <var>y</var>, <var>w</var> and <var>h</var> and <var>t</var> are expressions containing the
following constants:
</p>
<dl compact="compact">
<dt><samp>dar</samp></dt>
<dd><p>The input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var>.
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><samp>in_h, ih</samp></dt>
<dt><samp>in_w, iw</samp></dt>
<dd><p>The input grid cell width and height.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The x and y coordinates of some point of grid intersection (meant to configure offset).
</p>
</dd>
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The width and height of the drawn cell.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The thickness of the drawn cell.
</p>
<p>These constants allow the <var>x</var>, <var>y</var>, <var>w</var>, <var>h</var> and <var>t</var> expressions to refer to
each other, so you may for example specify <code>y=x/dar</code> or <code>h=w/dar</code>.
</p>
</dd>
</dl>
<a name="Examples-59"></a>
<h4 class="subsection">31.40.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-59" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-59" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%:
<div class="example">
<pre class="example">drawgrid=width=100:height=100:thickness=2:color=red@0.5
</pre></div>
</li><li> Draw a white 3x3 grid with an opacity of 50%:
<div class="example">
<pre class="example">drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
</pre></div>
</li></ul>
<a name="drawtext"></a><a name="drawtext-1"></a>
<h3 class="section">31.41 drawtext<span class="pull-right"><a class="anchor hidden-xs" href="#drawtext-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drawtext-1" aria-hidden="true">TOC</a></span></h3>
<p>Draw a text string or text from a specified file on top of a video, using the
libfreetype library.
</p>
<p>To enable compilation of this filter, you need to configure FFmpeg with
<code>--enable-libfreetype</code>.
To enable default font fallback and the <var>font</var> option you need to
configure FFmpeg with <code>--enable-libfontconfig</code>.
To enable the <var>text_shaping</var> option, you need to configure FFmpeg with
<code>--enable-libfribidi</code>.
</p>
<a name="Syntax-2"></a>
<h4 class="subsection">31.41.1 Syntax<span class="pull-right"><a class="anchor hidden-xs" href="#Syntax-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Syntax-2" aria-hidden="true">TOC</a></span></h4>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>box</samp></dt>
<dd><p>Used to draw a box around text using the background color.
The value must be either 1 (enable) or 0 (disable).
The default value of <var>box</var> is 0.
</p>
</dd>
<dt><samp>boxborderw</samp></dt>
<dd><p>Set the width of the border to be drawn around the box using <var>boxcolor</var>.
The default value of <var>boxborderw</var> is 0.
</p>
</dd>
<dt><samp>boxcolor</samp></dt>
<dd><p>The color to be used for drawing box around text. For the syntax of this
option, check the &quot;Color&quot; section in the ffmpeg-utils manual.
</p>
<p>The default value of <var>boxcolor</var> is &quot;white&quot;.
</p>
</dd>
<dt><samp>borderw</samp></dt>
<dd><p>Set the width of the border to be drawn around the text using <var>bordercolor</var>.
The default value of <var>borderw</var> is 0.
</p>
</dd>
<dt><samp>bordercolor</samp></dt>
<dd><p>Set the color to be used for drawing border around text. For the syntax of this
option, check the &quot;Color&quot; section in the ffmpeg-utils manual.
</p>
<p>The default value of <var>bordercolor</var> is &quot;black&quot;.
</p>
</dd>
<dt><samp>expansion</samp></dt>
<dd><p>Select how the <var>text</var> is expanded. Can be either <code>none</code>,
<code>strftime</code> (deprecated) or
<code>normal</code> (default). See the <a href="#drawtext_005fexpansion">Text expansion</a> section
below for details.
</p>
</dd>
<dt><samp>fix_bounds</samp></dt>
<dd><p>If true, check and fix text coords to avoid clipping.
</p>
</dd>
<dt><samp>fontcolor</samp></dt>
<dd><p>The color to be used for drawing fonts. For the syntax of this option, check
the &quot;Color&quot; section in the ffmpeg-utils manual.
</p>
<p>The default value of <var>fontcolor</var> is &quot;black&quot;.
</p>
</dd>
<dt><samp>fontcolor_expr</samp></dt>
<dd><p>String which is expanded the same way as <var>text</var> to obtain dynamic
<var>fontcolor</var> value. By default this option has empty value and is not
processed. When this option is set, it overrides <var>fontcolor</var> option.
</p>
</dd>
<dt><samp>font</samp></dt>
<dd><p>The font family to be used for drawing text. By default Sans.
</p>
</dd>
<dt><samp>fontfile</samp></dt>
<dd><p>The font file to be used for drawing text. The path must be included.
This parameter is mandatory if the fontconfig support is disabled.
</p>
</dd>
<dt><samp>draw</samp></dt>
<dd><p>This option does not exist, please see the timeline system
</p>
</dd>
<dt><samp>alpha</samp></dt>
<dd><p>Draw the text applying alpha blending. The value can
be a number between 0.0 and 1.0.
The expression accepts the same variables <var>x, y</var> as well.
The default value is 1.
Please see <var>fontcolor_expr</var>.
</p>
</dd>
<dt><samp>fontsize</samp></dt>
<dd><p>The font size to be used for drawing text.
The default value of <var>fontsize</var> is 16.
</p>
</dd>
<dt><samp>text_shaping</samp></dt>
<dd><p>If set to 1, attempt to shape the text (for example, reverse the order of
right-to-left text and join Arabic characters) before drawing it.
Otherwise, just draw the text exactly as given.
By default 1 (if supported).
</p>
</dd>
<dt><samp>ft_load_flags</samp></dt>
<dd><p>The flags to be used for loading the fonts.
</p>
<p>The flags map the corresponding flags supported by libfreetype, and are
a combination of the following values:
</p><dl compact="compact">
<dt><var>default</var></dt>
<dt><var>no_scale</var></dt>
<dt><var>no_hinting</var></dt>
<dt><var>render</var></dt>
<dt><var>no_bitmap</var></dt>
<dt><var>vertical_layout</var></dt>
<dt><var>force_autohint</var></dt>
<dt><var>crop_bitmap</var></dt>
<dt><var>pedantic</var></dt>
<dt><var>ignore_global_advance_width</var></dt>
<dt><var>no_recurse</var></dt>
<dt><var>ignore_transform</var></dt>
<dt><var>monochrome</var></dt>
<dt><var>linear_design</var></dt>
<dt><var>no_autohint</var></dt>
</dl>
<p>Default value is &quot;default&quot;.
</p>
<p>For more information consult the documentation for the FT_LOAD_*
libfreetype flags.
</p>
</dd>
<dt><samp>shadowcolor</samp></dt>
<dd><p>The color to be used for drawing a shadow behind the drawn text. For the
syntax of this option, check the &quot;Color&quot; section in the ffmpeg-utils manual.
</p>
<p>The default value of <var>shadowcolor</var> is &quot;black&quot;.
</p>
</dd>
<dt><samp>shadowx</samp></dt>
<dt><samp>shadowy</samp></dt>
<dd><p>The x and y offsets for the text shadow position with respect to the
position of the text. They can be either positive or negative
values. The default value for both is &quot;0&quot;.
</p>
</dd>
<dt><samp>start_number</samp></dt>
<dd><p>The starting frame number for the n/frame_num variable. The default value
is &quot;0&quot;.
</p>
</dd>
<dt><samp>tabsize</samp></dt>
<dd><p>The size in number of spaces to use for rendering the tab.
Default value is 4.
</p>
</dd>
<dt><samp>timecode</samp></dt>
<dd><p>Set the initial timecode representation in &quot;hh:mm:ss[:;.]ff&quot;
format. It can be used with or without text parameter. <var>timecode_rate</var>
option must be specified.
</p>
</dd>
<dt><samp>timecode_rate, rate, r</samp></dt>
<dd><p>Set the timecode frame rate (timecode only).
</p>
</dd>
<dt><samp>text</samp></dt>
<dd><p>The text string to be drawn. The text must be a sequence of UTF-8
encoded characters.
This parameter is mandatory if no file is specified with the parameter
<var>textfile</var>.
</p>
</dd>
<dt><samp>textfile</samp></dt>
<dd><p>A text file containing text to be drawn. The text must be a sequence
of UTF-8 encoded characters.
</p>
<p>This parameter is mandatory if no text string is specified with the
parameter <var>text</var>.
</p>
<p>If both <var>text</var> and <var>textfile</var> are specified, an error is thrown.
</p>
</dd>
<dt><samp>reload</samp></dt>
<dd><p>If set to 1, the <var>textfile</var> will be reloaded before each frame.
Be sure to update it atomically, or it may be read partially, or even fail.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The expressions which specify the offsets where text will be drawn
within the video frame. They are relative to the top/left border of the
output image.
</p>
<p>The default value of <var>x</var> and <var>y</var> is &quot;0&quot;.
</p>
<p>See below for the list of accepted constants and functions.
</p></dd>
</dl>
<p>The parameters for <var>x</var> and <var>y</var> are expressions containing the
following constants and functions:
</p>
<dl compact="compact">
<dt><samp>dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var>
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><samp>line_h, lh</samp></dt>
<dd><p>the height of each text line
</p>
</dd>
<dt><samp>main_h, h, H</samp></dt>
<dd><p>the input height
</p>
</dd>
<dt><samp>main_w, w, W</samp></dt>
<dd><p>the input width
</p>
</dd>
<dt><samp>max_glyph_a, ascent</samp></dt>
<dd><p>the maximum distance from the baseline to the highest/upper grid
coordinate used to place a glyph outline point, for all the rendered
glyphs.
It is a positive value, due to the grid&rsquo;s orientation with the Y axis
upwards.
</p>
</dd>
<dt><samp>max_glyph_d, descent</samp></dt>
<dd><p>the maximum distance from the baseline to the lowest grid coordinate
used to place a glyph outline point, for all the rendered glyphs.
This is a negative value, due to the grid&rsquo;s orientation, with the Y axis
upwards.
</p>
</dd>
<dt><samp>max_glyph_h</samp></dt>
<dd><p>maximum glyph height, that is the maximum height for all the glyphs
contained in the rendered text, it is equivalent to <var>ascent</var> -
<var>descent</var>.
</p>
</dd>
<dt><samp>max_glyph_w</samp></dt>
<dd><p>maximum glyph width, that is the maximum width for all the glyphs
contained in the rendered text
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp>rand(min, max)</samp></dt>
<dd><p>return a random number included between <var>min</var> and <var>max</var>
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt><samp>text_h, th</samp></dt>
<dd><p>the height of the rendered text
</p>
</dd>
<dt><samp>text_w, tw</samp></dt>
<dd><p>the width of the rendered text
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>the x and y offset coordinates where the text is drawn.
</p>
<p>These parameters allow the <var>x</var> and <var>y</var> expressions to refer
each other, so you can for example specify <code>y=x/dar</code>.
</p></dd>
</dl>
<a name="drawtext_005fexpansion"></a><a name="Text-expansion"></a>
<h4 class="subsection">31.41.2 Text expansion<span class="pull-right"><a class="anchor hidden-xs" href="#Text-expansion" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Text-expansion" aria-hidden="true">TOC</a></span></h4>
<p>If <samp>expansion</samp> is set to <code>strftime</code>,
the filter recognizes strftime() sequences in the provided text and
expands them accordingly. Check the documentation of strftime(). This
feature is deprecated.
</p>
<p>If <samp>expansion</samp> is set to <code>none</code>, the text is printed verbatim.
</p>
<p>If <samp>expansion</samp> is set to <code>normal</code> (which is the default),
the following expansion mechanism is used.
</p>
<p>The backslash character &lsquo;<samp>\</samp>&rsquo;, followed by any character, always expands to
the second character.
</p>
<p>Sequences of the form <code>%{...}</code> are expanded. The text between the
braces is a function name, possibly followed by arguments separated by &rsquo;:&rsquo;.
If the arguments contain special characters or delimiters (&rsquo;:&rsquo; or &rsquo;}&rsquo;),
they should be escaped.
</p>
<p>Note that they probably must also be escaped as the value for the
<samp>text</samp> option in the filter argument string and as the filter
argument in the filtergraph description, and possibly also for the shell,
that makes up to four levels of escaping; using a text file avoids these
problems.
</p>
<p>The following functions are available:
</p>
<dl compact="compact">
<dt><code>expr, e</code></dt>
<dd><p>The expression evaluation result.
</p>
<p>It must take one argument specifying the expression to be evaluated,
which accepts the same constants and functions as the <var>x</var> and
<var>y</var> values. Note that not all constants should be used, for
example the text size is not known when evaluating the expression, so
the constants <var>text_w</var> and <var>text_h</var> will have an undefined
value.
</p>
</dd>
<dt><code>expr_int_format, eif</code></dt>
<dd><p>Evaluate the expression&rsquo;s value and output as formatted integer.
</p>
<p>The first argument is the expression to be evaluated, just as for the <var>expr</var> function.
The second argument specifies the output format. Allowed values are &lsquo;<samp>x</samp>&rsquo;,
&lsquo;<samp>X</samp>&rsquo;, &lsquo;<samp>d</samp>&rsquo; and &lsquo;<samp>u</samp>&rsquo;. They are treated exactly as in the
<code>printf</code> function.
The third parameter is optional and sets the number of positions taken by the output.
It can be used to add padding with zeros from the left.
</p>
</dd>
<dt><code>gmtime</code></dt>
<dd><p>The time at which the filter is running, expressed in UTC.
It can accept an argument: a strftime() format string.
</p>
</dd>
<dt><code>localtime</code></dt>
<dd><p>The time at which the filter is running, expressed in the local time zone.
It can accept an argument: a strftime() format string.
</p>
</dd>
<dt><code>metadata</code></dt>
<dd><p>Frame metadata. Takes one or two arguments.
</p>
<p>The first argument is mandatory and specifies the metadata key.
</p>
<p>The second argument is optional and specifies a default value, used when the
metadata key is not found or empty.
</p>
</dd>
<dt><code>n, frame_num</code></dt>
<dd><p>The frame number, starting from 0.
</p>
</dd>
<dt><code>pict_type</code></dt>
<dd><p>A 1 character description of the current picture type.
</p>
</dd>
<dt><code>pts</code></dt>
<dd><p>The timestamp of the current frame.
It can take up to three arguments.
</p>
<p>The first argument is the format of the timestamp; it defaults to <code>flt</code>
for seconds as a decimal number with microsecond accuracy; <code>hms</code> stands
for a formatted <var>[-]HH:MM:SS.mmm</var> timestamp with millisecond accuracy.
<code>gmtime</code> stands for the timestamp of the frame formatted as UTC time;
<code>localtime</code> stands for the timestamp of the frame formatted as
local time zone time.
</p>
<p>The second argument is an offset added to the timestamp.
</p>
<p>If the format is set to <code>localtime</code> or <code>gmtime</code>,
a third argument may be supplied: a strftime() format string.
By default, <var>YYYY-MM-DD HH:MM:SS</var> format will be used.
</p></dd>
</dl>
<a name="Examples-60"></a>
<h4 class="subsection">31.41.3 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-60" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-60" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Draw &quot;Test Text&quot; with font FreeSerif, using the default values for the
optional parameters.
<div class="example">
<pre class="example">drawtext=&quot;fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'&quot;
</pre></div>
</li><li> Draw &rsquo;Test Text&rsquo; with font FreeSerif of size 24 at position x=100
and y=50 (counting from the top-left corner of the screen), text is
yellow with a red box around it. Both the text and the box have an
opacity of 20%.
<div class="example">
<pre class="example">drawtext=&quot;fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2&quot;
</pre></div>
<p>Note that the double quotes are not necessary if spaces are not used
within the parameter list.
</p>
</li><li> Show the text at the center of the video frame:
<div class="example">
<pre class="example">drawtext=&quot;fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2&quot;
</pre></div>
</li><li> Show the text at a random position, switching to a new position every 30 seconds:
<div class="example">
<pre class="example">drawtext=&quot;fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=if(eq(mod(t\,30)\,0)\,rand(0\,(w-text_w))\,x):y=if(eq(mod(t\,30)\,0)\,rand(0\,(h-text_h))\,y)&quot;
</pre></div>
</li><li> Show a text line sliding from right to left in the last row of the video
frame. The file <samp>LONG_LINE</samp> is assumed to contain a single line
with no newlines.
<div class="example">
<pre class="example">drawtext=&quot;fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t&quot;
</pre></div>
</li><li> Show the content of file <samp>CREDITS</samp> off the bottom of the frame and scroll up.
<div class="example">
<pre class="example">drawtext=&quot;fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t&quot;
</pre></div>
</li><li> Draw a single green letter &quot;g&quot;, at the center of the input video.
The glyph baseline is placed at half screen height.
<div class="example">
<pre class="example">drawtext=&quot;fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent&quot;
</pre></div>
</li><li> Show text for 1 second every 3 seconds:
<div class="example">
<pre class="example">drawtext=&quot;fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'&quot;
</pre></div>
</li><li> Use fontconfig to set the font. Note that the colons need to be escaped.
<div class="example">
<pre class="example">drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
</pre></div>
</li><li> Print the date of a real-time encoding (see strftime(3)):
<div class="example">
<pre class="example">drawtext='fontfile=FreeSans.ttf:text=%{localtime\:%a %b %d %Y}'
</pre></div>
</li><li> Show text fading in and out (appearing/disappearing):
<div class="example">
<pre class="example">#!/bin/sh
DS=1.0 # display start
DE=10.0 # display end
FID=1.5 # fade in duration
FOD=5 # fade out duration
ffplay -f lavfi &quot;color,drawtext=text=TEST:fontsize=50:fontfile=FreeSerif.ttf:fontcolor_expr=ff0000%{eif\\\\: clip(255*(1*between(t\\, $DS + $FID\\, $DE - $FOD) + ((t - $DS)/$FID)*between(t\\, $DS\\, $DS + $FID) + (-(t - $DE)/$FOD)*between(t\\, $DE - $FOD\\, $DE) )\\, 0\\, 255) \\\\: x\\\\: 2 }&quot;
</pre></div>
</li></ul>
<p>For more information about libfreetype, check:
<a href="http://www.freetype.org/">http://www.freetype.org/</a>.
</p>
<p>For more information about fontconfig, check:
<a href="http://freedesktop.org/software/fontconfig/fontconfig-user.html">http://freedesktop.org/software/fontconfig/fontconfig-user.html</a>.
</p>
<p>For more information about libfribidi, check:
<a href="http://fribidi.org/">http://fribidi.org/</a>.
</p>
<a name="edgedetect"></a>
<h3 class="section">31.42 edgedetect<span class="pull-right"><a class="anchor hidden-xs" href="#edgedetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-edgedetect" aria-hidden="true">TOC</a></span></h3>
<p>Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>low</samp></dt>
<dt><samp>high</samp></dt>
<dd><p>Set low and high threshold values used by the Canny thresholding
algorithm.
</p>
<p>The high threshold selects the &quot;strong&quot; edge pixels, which are then
connected through 8-connectivity with the &quot;weak&quot; edge pixels selected
by the low threshold.
</p>
<p><var>low</var> and <var>high</var> threshold values must be chosen in the range
[0,1], and <var>low</var> should be lesser or equal to <var>high</var>.
</p>
<p>Default value for <var>low</var> is <code>20/255</code>, and default value for <var>high</var>
is <code>50/255</code>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Define the drawing mode.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>wires</samp>&rsquo;</dt>
<dd><p>Draw white/gray wires on black background.
</p>
</dd>
<dt>&lsquo;<samp>colormix</samp>&rsquo;</dt>
<dd><p>Mix the colors to create a paint/cartoon effect.
</p></dd>
</dl>
<p>Default value is <var>wires</var>.
</p></dd>
</dl>
<a name="Examples-61"></a>
<h4 class="subsection">31.42.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-61" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-61" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Standard edge detection with custom values for the hysteresis thresholding:
<div class="example">
<pre class="example">edgedetect=low=0.1:high=0.4
</pre></div>
</li><li> Painting effect without thresholding:
<div class="example">
<pre class="example">edgedetect=mode=colormix:high=0
</pre></div>
</li></ul>
<a name="eq"></a>
<h3 class="section">31.43 eq<span class="pull-right"><a class="anchor hidden-xs" href="#eq" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-eq" aria-hidden="true">TOC</a></span></h3>
<p>Set brightness, contrast, saturation and approximate gamma adjustment.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>contrast</samp></dt>
<dd><p>Set the contrast expression. The value must be a float value in range
<code>-2.0</code> to <code>2.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>brightness</samp></dt>
<dd><p>Set the brightness expression. The value must be a float value in
range <code>-1.0</code> to <code>1.0</code>. The default value is &quot;0&quot;.
</p>
</dd>
<dt><samp>saturation</samp></dt>
<dd><p>Set the saturation expression. The value must be a float in
range <code>0.0</code> to <code>3.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>gamma</samp></dt>
<dd><p>Set the gamma expression. The value must be a float in range
<code>0.1</code> to <code>10.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>gamma_r</samp></dt>
<dd><p>Set the gamma expression for red. The value must be a float in
range <code>0.1</code> to <code>10.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>gamma_g</samp></dt>
<dd><p>Set the gamma expression for green. The value must be a float in range
<code>0.1</code> to <code>10.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>gamma_b</samp></dt>
<dd><p>Set the gamma expression for blue. The value must be a float in range
<code>0.1</code> to <code>10.0</code>. The default value is &quot;1&quot;.
</p>
</dd>
<dt><samp>gamma_weight</samp></dt>
<dd><p>Set the gamma weight expression. It can be used to reduce the effect
of a high gamma value on bright image areas, e.g. keep them from
getting overamplified and just plain white. The value must be a float
in range <code>0.0</code> to <code>1.0</code>. A value of <code>0.0</code> turns the
gamma correction all the way down while <code>1.0</code> leaves it at its
full strength. Default is &quot;1&quot;.
</p>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Set when the expressions for brightness, contrast, saturation and
gamma expressions are evaluated.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>init</samp>&rsquo;</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>init</samp>&rsquo;.
</p></dd>
</dl>
<p>The expressions accept the following parameters:
</p><dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>frame count of the input frame starting from 0
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>byte position of the corresponding packet in the input file, NAN if
unspecified
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p></dd>
</dl>
<a name="Commands-4"></a>
<h4 class="subsection">31.43.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-4" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-4" aria-hidden="true">TOC</a></span></h4>
<p>The filter supports the following commands:
</p>
<dl compact="compact">
<dt><samp>contrast</samp></dt>
<dd><p>Set the contrast expression.
</p>
</dd>
<dt><samp>brightness</samp></dt>
<dd><p>Set the brightness expression.
</p>
</dd>
<dt><samp>saturation</samp></dt>
<dd><p>Set the saturation expression.
</p>
</dd>
<dt><samp>gamma</samp></dt>
<dd><p>Set the gamma expression.
</p>
</dd>
<dt><samp>gamma_r</samp></dt>
<dd><p>Set the gamma_r expression.
</p>
</dd>
<dt><samp>gamma_g</samp></dt>
<dd><p>Set gamma_g expression.
</p>
</dd>
<dt><samp>gamma_b</samp></dt>
<dd><p>Set gamma_b expression.
</p>
</dd>
<dt><samp>gamma_weight</samp></dt>
<dd><p>Set gamma_weight expression.
</p>
<p>The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p>
</dd>
</dl>
<a name="erosion"></a>
<h3 class="section">31.44 erosion<span class="pull-right"><a class="anchor hidden-xs" href="#erosion" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-erosion" aria-hidden="true">TOC</a></span></h3>
<p>Apply erosion effect to the video.
</p>
<p>This filter replaces the pixel by the local(3x3) minimum.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>threshold0</samp></dt>
<dt><samp>threshold1</samp></dt>
<dt><samp>threshold2</samp></dt>
<dt><samp>threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p>
</dd>
<dt><samp>coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
pixels are used.
</p>
<p>Flags to local 3x3 coordinates maps like this:
</p>
<p>1 2 3
4 5
6 7 8
</p></dd>
</dl>
<a name="extractplanes"></a>
<h3 class="section">31.45 extractplanes<span class="pull-right"><a class="anchor hidden-xs" href="#extractplanes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-extractplanes" aria-hidden="true">TOC</a></span></h3>
<p>Extract color channel components from input video stream into
separate grayscale video streams.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>planes</samp></dt>
<dd><p>Set plane(s) to extract.
</p>
<p>Available values for planes are:
</p><dl compact="compact">
<dt>&lsquo;<samp>y</samp>&rsquo;</dt>
<dt>&lsquo;<samp>u</samp>&rsquo;</dt>
<dt>&lsquo;<samp>v</samp>&rsquo;</dt>
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dt>&lsquo;<samp>r</samp>&rsquo;</dt>
<dt>&lsquo;<samp>g</samp>&rsquo;</dt>
<dt>&lsquo;<samp>b</samp>&rsquo;</dt>
</dl>
<p>Choosing planes not available in the input will result in an error.
That means you cannot select <code>r</code>, <code>g</code>, <code>b</code> planes
with <code>y</code>, <code>u</code>, <code>v</code> planes at same time.
</p></dd>
</dl>
<a name="Examples-62"></a>
<h4 class="subsection">31.45.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-62" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-62" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Extract luma, u and v color channel component from input video frame
into 3 grayscale outputs:
<div class="example">
<pre class="example">ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
</pre></div>
</li></ul>
<a name="elbg"></a>
<h3 class="section">31.46 elbg<span class="pull-right"><a class="anchor hidden-xs" href="#elbg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-elbg" aria-hidden="true">TOC</a></span></h3>
<p>Apply a posterize effect using the ELBG (Enhanced LBG) algorithm.
</p>
<p>For each input image, the filter will compute the optimal mapping from
the input to the output given the codebook length, that is the number
of distinct output colors.
</p>
<p>This filter accepts the following options.
</p>
<dl compact="compact">
<dt><samp>codebook_length, l</samp></dt>
<dd><p>Set codebook length. The value must be a positive integer, and
represents the number of distinct output colors. Default value is 256.
</p>
</dd>
<dt><samp>nb_steps, n</samp></dt>
<dd><p>Set the maximum number of iterations to apply for computing the optimal
mapping. The higher the value the better the result and the higher the
computation time. Default value is 1.
</p>
</dd>
<dt><samp>seed, s</samp></dt>
<dd><p>Set a random seed, must be an integer included between 0 and
UINT32_MAX. If not specified, or if explicitly set to -1, the filter
will try to use a good random seed on a best effort basis.
</p>
</dd>
<dt><samp>pal8</samp></dt>
<dd><p>Set pal8 output pixel format. This option does not work with codebook
length greater than 256.
</p></dd>
</dl>
<a name="fade"></a>
<h3 class="section">31.47 fade<span class="pull-right"><a class="anchor hidden-xs" href="#fade" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fade" aria-hidden="true">TOC</a></span></h3>
<p>Apply a fade-in/out effect to the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>type, t</samp></dt>
<dd><p>The effect type can be either &quot;in&quot; for a fade-in, or &quot;out&quot; for a fade-out
effect.
Default is <code>in</code>.
</p>
</dd>
<dt><samp>start_frame, s</samp></dt>
<dd><p>Specify the number of the frame to start applying the fade
effect at. Default is 0.
</p>
</dd>
<dt><samp>nb_frames, n</samp></dt>
<dd><p>The number of frames that the fade effect lasts. At the end of the
fade-in effect, the output video will have the same intensity as the input video.
At the end of the fade-out transition, the output video will be filled with the
selected <samp>color</samp>.
Default is 25.
</p>
</dd>
<dt><samp>alpha</samp></dt>
<dd><p>If set to 1, fade only alpha channel, if one exists on the input.
Default value is 0.
</p>
</dd>
<dt><samp>start_time, st</samp></dt>
<dd><p>Specify the timestamp (in seconds) of the frame to start to apply the fade
effect. If both start_frame and start_time are specified, the fade will start at
whichever comes last. Default is 0.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>The number of seconds for which the fade effect has to last. At the end of the
fade-in effect the output video will have the same intensity as the input video,
at the end of the fade-out transition the output video will be filled with the
selected <samp>color</samp>.
If both duration and nb_frames are specified, duration is used. Default is 0
(nb_frames is used by default).
</p>
</dd>
<dt><samp>color, c</samp></dt>
<dd><p>Specify the color of the fade. Default is &quot;black&quot;.
</p></dd>
</dl>
<a name="Examples-63"></a>
<h4 class="subsection">31.47.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-63" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-63" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Fade in the first 30 frames of video:
<div class="example">
<pre class="example">fade=in:0:30
</pre></div>
<p>The command above is equivalent to:
</p><div class="example">
<pre class="example">fade=t=in:s=0:n=30
</pre></div>
</li><li> Fade out the last 45 frames of a 200-frame video:
<div class="example">
<pre class="example">fade=out:155:45
fade=type=out:start_frame=155:nb_frames=45
</pre></div>
</li><li> Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video:
<div class="example">
<pre class="example">fade=in:0:25, fade=out:975:25
</pre></div>
</li><li> Make the first 5 frames yellow, then fade in from frame 5-24:
<div class="example">
<pre class="example">fade=in:5:20:color=yellow
</pre></div>
</li><li> Fade in alpha over first 25 frames of video:
<div class="example">
<pre class="example">fade=in:0:25:alpha=1
</pre></div>
</li><li> Make the first 5.5 seconds black, then fade in for 0.5 seconds:
<div class="example">
<pre class="example">fade=t=in:st=5.5:d=0.5
</pre></div>
</li></ul>
<a name="fftfilt"></a>
<h3 class="section">31.48 fftfilt<span class="pull-right"><a class="anchor hidden-xs" href="#fftfilt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fftfilt" aria-hidden="true">TOC</a></span></h3>
<p>Apply arbitrary expressions to samples in frequency domain
</p>
<dl compact="compact">
<dt><samp>dc_Y</samp></dt>
<dd><p>Adjust the dc value (gain) of the luma plane of the image. The filter
accepts an integer value in range <code>0</code> to <code>1000</code>. The default
value is set to <code>0</code>.
</p>
</dd>
<dt><samp>dc_U</samp></dt>
<dd><p>Adjust the dc value (gain) of the 1st chroma plane of the image. The
filter accepts an integer value in range <code>0</code> to <code>1000</code>. The
default value is set to <code>0</code>.
</p>
</dd>
<dt><samp>dc_V</samp></dt>
<dd><p>Adjust the dc value (gain) of the 2nd chroma plane of the image. The
filter accepts an integer value in range <code>0</code> to <code>1000</code>. The
default value is set to <code>0</code>.
</p>
</dd>
<dt><samp>weight_Y</samp></dt>
<dd><p>Set the frequency domain weight expression for the luma plane.
</p>
</dd>
<dt><samp>weight_U</samp></dt>
<dd><p>Set the frequency domain weight expression for the 1st chroma plane.
</p>
</dd>
<dt><samp>weight_V</samp></dt>
<dd><p>Set the frequency domain weight expression for the 2nd chroma plane.
</p>
<p>The filter accepts the following variables:
</p></dd>
<dt><samp>X</samp></dt>
<dt><samp>Y</samp></dt>
<dd><p>The coordinates of the current sample.
</p>
</dd>
<dt><samp>W</samp></dt>
<dt><samp>H</samp></dt>
<dd><p>The width and height of the image.
</p></dd>
</dl>
<a name="Examples-64"></a>
<h4 class="subsection">31.48.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-64" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-64" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> High-pass:
<div class="example">
<pre class="example">fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
</pre></div>
</li><li> Low-pass:
<div class="example">
<pre class="example">fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
</pre></div>
</li><li> Sharpen:
<div class="example">
<pre class="example">fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
</pre></div>
</li><li> Blur:
<div class="example">
<pre class="example">fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
</pre></div>
</li></ul>
<a name="field"></a>
<h3 class="section">31.49 field<span class="pull-right"><a class="anchor hidden-xs" href="#field" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-field" aria-hidden="true">TOC</a></span></h3>
<p>Extract a single field from an interlaced image using stride
arithmetic to avoid wasting CPU time. The output frames are marked as
non-interlaced.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>type</samp></dt>
<dd><p>Specify whether to extract the top (if the value is <code>0</code> or
<code>top</code>) or the bottom field (if the value is <code>1</code> or
<code>bottom</code>).
</p></dd>
</dl>
<a name="fieldhint"></a>
<h3 class="section">31.50 fieldhint<span class="pull-right"><a class="anchor hidden-xs" href="#fieldhint" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fieldhint" aria-hidden="true">TOC</a></span></h3>
<p>Create new frames by copying the top and bottom fields from surrounding frames
supplied as numbers by the hint file.
</p>
<dl compact="compact">
<dt><samp>hint</samp></dt>
<dd><p>Set file containing hints: absolute/relative frame numbers.
</p>
<p>There must be one line for each frame in a clip. Each line must contain two
numbers separated by the comma, optionally followed by <code>-</code> or <code>+</code>.
Numbers supplied on each line of file can not be out of [N-1,N+1] where N
is current frame number for <code>absolute</code> mode or out of [-1, 1] range
for <code>relative</code> mode. First number tells from which frame to pick up top
field and second number tells from which frame to pick up bottom field.
</p>
<p>If optionally followed by <code>+</code> output frame will be marked as interlaced,
else if followed by <code>-</code> output frame will be marked as progressive, else
it will be marked same as input frame.
If line starts with <code>#</code> or <code>;</code> that line is skipped.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Can be item <code>absolute</code> or <code>relative</code>. Default is <code>absolute</code>.
</p></dd>
</dl>
<p>Example of first several lines of <code>hint</code> file for <code>relative</code> mode:
</p><div class="example">
<pre class="example">0,0 - # first frame
1,0 - # second frame, use third's frame top field and second's frame bottom field
1,0 - # third frame, use fourth's frame top field and third's frame bottom field
1,0 -
0,0 -
0,0 -
1,0 -
1,0 -
1,0 -
0,0 -
0,0 -
1,0 -
1,0 -
1,0 -
0,0 -
</pre></div>
<a name="fieldmatch"></a>
<h3 class="section">31.51 fieldmatch<span class="pull-right"><a class="anchor hidden-xs" href="#fieldmatch" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fieldmatch" aria-hidden="true">TOC</a></span></h3>
<p>Field matching filter for inverse telecine. It is meant to reconstruct the
progressive frames from a telecined stream. The filter does not drop duplicated
frames, so to achieve a complete inverse telecine <code>fieldmatch</code> needs to be
followed by a decimation filter such as <a href="#decimate">decimate</a> in the filtergraph.
</p>
<p>The separation of the field matching and the decimation is notably motivated by
the possibility of inserting a de-interlacing filter fallback between the two.
If the source has mixed telecined and real interlaced content,
<code>fieldmatch</code> will not be able to match fields for the interlaced parts.
But these remaining combed frames will be marked as interlaced, and thus can be
de-interlaced by a later filter such as <a href="#yadif">yadif</a> before decimation.
</p>
<p>In addition to the various configuration options, <code>fieldmatch</code> can take an
optional second stream, activated through the <samp>ppsrc</samp> option. If
enabled, the frames reconstruction will be based on the fields and frames from
this second stream. This allows the first input to be pre-processed in order to
help the various algorithms of the filter, while keeping the output lossless
(assuming the fields are matched properly). Typically, a field-aware denoiser,
or brightness/contrast adjustments can help.
</p>
<p>Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project)
and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from
which <code>fieldmatch</code> is based on. While the semantic and usage are very
close, some behaviour and options names can differ.
</p>
<p>The <a href="#decimate">decimate</a> filter currently only works for constant frame rate input.
If your input has mixed telecined (30fps) and progressive content with a lower
framerate like 24fps use the following filterchain to produce the necessary cfr
stream: <code>dejudder,fps=30000/1001,fieldmatch,decimate</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>order</samp></dt>
<dd><p>Specify the assumed field order of the input stream. Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>Auto detect parity (use FFmpeg&rsquo;s internal parity value).
</p></dd>
<dt>&lsquo;<samp>bff</samp>&rsquo;</dt>
<dd><p>Assume bottom field first.
</p></dd>
<dt>&lsquo;<samp>tff</samp>&rsquo;</dt>
<dd><p>Assume top field first.
</p></dd>
</dl>
<p>Note that it is sometimes recommended not to trust the parity announced by the
stream.
</p>
<p>Default value is <var>auto</var>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set the matching mode or strategy to use. <samp>pc</samp> mode is the safest in the
sense that it won&rsquo;t risk creating jerkiness due to duplicate frames when
possible, but if there are bad edits or blended fields it will end up
outputting combed frames when a good match might actually exist. On the other
hand, <samp>pcn_ub</samp> mode is the most risky in terms of creating jerkiness,
but will almost always find a good frame if there is one. The other values are
all somewhere in between <samp>pc</samp> and <samp>pcn_ub</samp> in terms of risking
jerkiness and creating duplicate frames versus finding good matches in sections
with bad edits, orphaned fields, blended fields, etc.
</p>
<p>More details about p/c/n/u/b are available in <a href="#p_002fc_002fn_002fu_002fb-meaning">p/c/n/u/b meaning</a> section.
</p>
<p>Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>pc</samp>&rsquo;</dt>
<dd><p>2-way matching (p/c)
</p></dd>
<dt>&lsquo;<samp>pc_n</samp>&rsquo;</dt>
<dd><p>2-way matching, and trying 3rd match if still combed (p/c + n)
</p></dd>
<dt>&lsquo;<samp>pc_u</samp>&rsquo;</dt>
<dd><p>2-way matching, and trying 3rd match (same order) if still combed (p/c + u)
</p></dd>
<dt>&lsquo;<samp>pc_n_ub</samp>&rsquo;</dt>
<dd><p>2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if
still combed (p/c + n + u/b)
</p></dd>
<dt>&lsquo;<samp>pcn</samp>&rsquo;</dt>
<dd><p>3-way matching (p/c/n)
</p></dd>
<dt>&lsquo;<samp>pcn_ub</samp>&rsquo;</dt>
<dd><p>3-way matching, and trying 4th/5th matches if all 3 of the original matches are
detected as combed (p/c/n + u/b)
</p></dd>
</dl>
<p>The parenthesis at the end indicate the matches that would be used for that
mode assuming <samp>order</samp>=<var>tff</var> (and <samp>field</samp> on <var>auto</var> or
<var>top</var>).
</p>
<p>In terms of speed <samp>pc</samp> mode is by far the fastest and <samp>pcn_ub</samp> is
the slowest.
</p>
<p>Default value is <var>pc_n</var>.
</p>
</dd>
<dt><samp>ppsrc</samp></dt>
<dd><p>Mark the main input stream as a pre-processed input, and enable the secondary
input stream as the clean source to pick the fields from. See the filter
introduction for more details. It is similar to the <samp>clip2</samp> feature from
VFM/TFM.
</p>
<p>Default value is <code>0</code> (disabled).
</p>
</dd>
<dt><samp>field</samp></dt>
<dd><p>Set the field to match from. It is recommended to set this to the same value as
<samp>order</samp> unless you experience matching failures with that setting. In
certain circumstances changing the field that is used to match from can have a
large impact on matching performance. Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>Automatic (same value as <samp>order</samp>).
</p></dd>
<dt>&lsquo;<samp>bottom</samp>&rsquo;</dt>
<dd><p>Match from the bottom field.
</p></dd>
<dt>&lsquo;<samp>top</samp>&rsquo;</dt>
<dd><p>Match from the top field.
</p></dd>
</dl>
<p>Default value is <var>auto</var>.
</p>
</dd>
<dt><samp>mchroma</samp></dt>
<dd><p>Set whether or not chroma is included during the match comparisons. In most
cases it is recommended to leave this enabled. You should set this to <code>0</code>
only if your clip has bad chroma problems such as heavy rainbowing or other
artifacts. Setting this to <code>0</code> could also be used to speed things up at
the cost of some accuracy.
</p>
<p>Default value is <code>1</code>.
</p>
</dd>
<dt><samp>y0</samp></dt>
<dt><samp>y1</samp></dt>
<dd><p>These define an exclusion band which excludes the lines between <samp>y0</samp> and
<samp>y1</samp> from being included in the field matching decision. An exclusion
band can be used to ignore subtitles, a logo, or other things that may
interfere with the matching. <samp>y0</samp> sets the starting scan line and
<samp>y1</samp> sets the ending line; all lines in between <samp>y0</samp> and
<samp>y1</samp> (including <samp>y0</samp> and <samp>y1</samp>) will be ignored. Setting
<samp>y0</samp> and <samp>y1</samp> to the same value will disable the feature.
<samp>y0</samp> and <samp>y1</samp> defaults to <code>0</code>.
</p>
</dd>
<dt><samp>scthresh</samp></dt>
<dd><p>Set the scene change detection threshold as a percentage of maximum change on
the luma plane. Good values are in the <code>[8.0, 14.0]</code> range. Scene change
detection is only relevant in case <samp>combmatch</samp>=<var>sc</var>. The range for
<samp>scthresh</samp> is <code>[0.0, 100.0]</code>.
</p>
<p>Default value is <code>12.0</code>.
</p>
</dd>
<dt><samp>combmatch</samp></dt>
<dd><p>When <samp>combatch</samp> is not <var>none</var>, <code>fieldmatch</code> will take into
account the combed scores of matches when deciding what match to use as the
final match. Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No final matching based on combed scores.
</p></dd>
<dt>&lsquo;<samp>sc</samp>&rsquo;</dt>
<dd><p>Combed scores are only used when a scene change is detected.
</p></dd>
<dt>&lsquo;<samp>full</samp>&rsquo;</dt>
<dd><p>Use combed scores all the time.
</p></dd>
</dl>
<p>Default is <var>sc</var>.
</p>
</dd>
<dt><samp>combdbg</samp></dt>
<dd><p>Force <code>fieldmatch</code> to calculate the combed metrics for certain matches and
print them. This setting is known as <samp>micout</samp> in TFM/VFM vocabulary.
Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No forced calculation.
</p></dd>
<dt>&lsquo;<samp>pcn</samp>&rsquo;</dt>
<dd><p>Force p/c/n calculations.
</p></dd>
<dt>&lsquo;<samp>pcnub</samp>&rsquo;</dt>
<dd><p>Force p/c/n/u/b calculations.
</p></dd>
</dl>
<p>Default value is <var>none</var>.
</p>
</dd>
<dt><samp>cthresh</samp></dt>
<dd><p>This is the area combing threshold used for combed frame detection. This
essentially controls how &quot;strong&quot; or &quot;visible&quot; combing must be to be detected.
Larger values mean combing must be more visible and smaller values mean combing
can be less visible or strong and still be detected. Valid settings are from
<code>-1</code> (every pixel will be detected as combed) to <code>255</code> (no pixel will
be detected as combed). This is basically a pixel difference value. A good
range is <code>[8, 12]</code>.
</p>
<p>Default value is <code>9</code>.
</p>
</dd>
<dt><samp>chroma</samp></dt>
<dd><p>Sets whether or not chroma is considered in the combed frame decision. Only
disable this if your source has chroma problems (rainbowing, etc.) that are
causing problems for the combed frame detection with chroma enabled. Actually,
using <samp>chroma</samp>=<var>0</var> is usually more reliable, except for the case
where there is chroma only combing in the source.
</p>
<p>Default value is <code>0</code>.
</p>
</dd>
<dt><samp>blockx</samp></dt>
<dt><samp>blocky</samp></dt>
<dd><p>Respectively set the x-axis and y-axis size of the window used during combed
frame detection. This has to do with the size of the area in which
<samp>combpel</samp> pixels are required to be detected as combed for a frame to be
declared combed. See the <samp>combpel</samp> parameter description for more info.
Possible values are any number that is a power of 2 starting at 4 and going up
to 512.
</p>
<p>Default value is <code>16</code>.
</p>
</dd>
<dt><samp>combpel</samp></dt>
<dd><p>The number of combed pixels inside any of the <samp>blocky</samp> by
<samp>blockx</samp> size blocks on the frame for the frame to be detected as
combed. While <samp>cthresh</samp> controls how &quot;visible&quot; the combing must be, this
setting controls &quot;how much&quot; combing there must be in any localized area (a
window defined by the <samp>blockx</samp> and <samp>blocky</samp> settings) on the
frame. Minimum value is <code>0</code> and maximum is <code>blocky x blockx</code> (at
which point no frames will ever be detected as combed). This setting is known
as <samp>MI</samp> in TFM/VFM vocabulary.
</p>
<p>Default value is <code>80</code>.
</p></dd>
</dl>
<a name="p_002fc_002fn_002fu_002fb-meaning"></a><a name="p_002fc_002fn_002fu_002fb-meaning-1"></a>
<h4 class="subsection">31.51.1 p/c/n/u/b meaning<span class="pull-right"><a class="anchor hidden-xs" href="#p_002fc_002fn_002fu_002fb-meaning-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-p_002fc_002fn_002fu_002fb-meaning-1" aria-hidden="true">TOC</a></span></h4>
<a name="p_002fc_002fn"></a>
<h4 class="subsubsection">31.51.1.1 p/c/n<span class="pull-right"><a class="anchor hidden-xs" href="#p_002fc_002fn" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-p_002fc_002fn" aria-hidden="true">TOC</a></span></h4>
<p>We assume the following telecined stream:
</p>
<div class="example">
<pre class="example">Top fields: 1 2 2 3 4
Bottom fields: 1 2 3 4 4
</pre></div>
<p>The numbers correspond to the progressive frame the fields relate to. Here, the
first two frames are progressive, the 3rd and 4th are combed, and so on.
</p>
<p>When <code>fieldmatch</code> is configured to run a matching from bottom
(<samp>field</samp>=<var>bottom</var>) this is how this input stream get transformed:
</p>
<div class="example">
<pre class="example">Input stream:
T 1 2 2 3 4
B 1 2 3 4 4 &lt;-- matching reference
Matches: c c n n c
Output stream:
T 1 2 3 4 4
B 1 2 3 4 4
</pre></div>
<p>As a result of the field matching, we can see that some frames get duplicated.
To perform a complete inverse telecine, you need to rely on a decimation filter
after this operation. See for instance the <a href="#decimate">decimate</a> filter.
</p>
<p>The same operation now matching from top fields (<samp>field</samp>=<var>top</var>)
looks like this:
</p>
<div class="example">
<pre class="example">Input stream:
T 1 2 2 3 4 &lt;-- matching reference
B 1 2 3 4 4
Matches: c c p p c
Output stream:
T 1 2 2 3 4
B 1 2 2 3 4
</pre></div>
<p>In these examples, we can see what <var>p</var>, <var>c</var> and <var>n</var> mean;
basically, they refer to the frame and field of the opposite parity:
</p>
<ul>
<li> <var>p</var> matches the field of the opposite parity in the previous frame
</li><li> <var>c</var> matches the field of the opposite parity in the current frame
</li><li> <var>n</var> matches the field of the opposite parity in the next frame
</li></ul>
<a name="u_002fb"></a>
<h4 class="subsubsection">31.51.1.2 u/b<span class="pull-right"><a class="anchor hidden-xs" href="#u_002fb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-u_002fb" aria-hidden="true">TOC</a></span></h4>
<p>The <var>u</var> and <var>b</var> matching are a bit special in the sense that they match
from the opposite parity flag. In the following examples, we assume that we are
currently matching the 2nd frame (Top:2, bottom:2). According to the match, a
&rsquo;x&rsquo; is placed above and below each matched fields.
</p>
<p>With bottom matching (<samp>field</samp>=<var>bottom</var>):
</p><div class="example">
<pre class="example">Match: c p n b u
x x x x x
Top 1 2 2 1 2 2 1 2 2 1 2 2 1 2 2
Bottom 1 2 3 1 2 3 1 2 3 1 2 3 1 2 3
x x x x x
Output frames:
2 1 2 2 2
2 2 2 1 3
</pre></div>
<p>With top matching (<samp>field</samp>=<var>top</var>):
</p><div class="example">
<pre class="example">Match: c p n b u
x x x x x
Top 1 2 2 1 2 2 1 2 2 1 2 2 1 2 2
Bottom 1 2 3 1 2 3 1 2 3 1 2 3 1 2 3
x x x x x
Output frames:
2 2 2 1 2
2 1 3 2 2
</pre></div>
<a name="Examples-65"></a>
<h4 class="subsection">31.51.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-65" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-65" aria-hidden="true">TOC</a></span></h4>
<p>Simple IVTC of a top field first telecined stream:
</p><div class="example">
<pre class="example">fieldmatch=order=tff:combmatch=none, decimate
</pre></div>
<p>Advanced IVTC, with fallback on <a href="#yadif">yadif</a> for still combed frames:
</p><div class="example">
<pre class="example">fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
</pre></div>
<a name="fieldorder"></a>
<h3 class="section">31.52 fieldorder<span class="pull-right"><a class="anchor hidden-xs" href="#fieldorder" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fieldorder" aria-hidden="true">TOC</a></span></h3>
<p>Transform the field order of the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>order</samp></dt>
<dd><p>The output field order. Valid values are <var>tff</var> for top field first or <var>bff</var>
for bottom field first.
</p></dd>
</dl>
<p>The default value is &lsquo;<samp>tff</samp>&rsquo;.
</p>
<p>The transformation is done by shifting the picture content up or down
by one line, and filling the remaining line with appropriate picture content.
This method is consistent with most broadcast field order converters.
</p>
<p>If the input video is not flagged as being interlaced, or it is already
flagged as being of the required output field order, then this filter does
not alter the incoming video.
</p>
<p>It is very useful when converting to or from PAL DV material,
which is bottom field first.
</p>
<p>For example:
</p><div class="example">
<pre class="example">ffmpeg -i in.vob -vf &quot;fieldorder=bff&quot; out.dv
</pre></div>
<a name="fifo_002c-afifo"></a>
<h3 class="section">31.53 fifo, afifo<span class="pull-right"><a class="anchor hidden-xs" href="#fifo_002c-afifo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fifo_002c-afifo" aria-hidden="true">TOC</a></span></h3>
<p>Buffer input images and send them when they are requested.
</p>
<p>It is mainly useful when auto-inserted by the libavfilter
framework.
</p>
<p>It does not take parameters.
</p>
<a name="find_005frect"></a>
<h3 class="section">31.54 find_rect<span class="pull-right"><a class="anchor hidden-xs" href="#find_005frect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-find_005frect" aria-hidden="true">TOC</a></span></h3>
<p>Find a rectangular object
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>object</samp></dt>
<dd><p>Filepath of the object image, needs to be in gray8.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>Detection threshold, default is 0.5.
</p>
</dd>
<dt><samp>mipmaps</samp></dt>
<dd><p>Number of mipmaps, default is 3.
</p>
</dd>
<dt><samp>xmin, ymin, xmax, ymax</samp></dt>
<dd><p>Specifies the rectangle in which to search.
</p></dd>
</dl>
<a name="Examples-66"></a>
<h4 class="subsection">31.54.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-66" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-66" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate a representative palette of a given video using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
</pre></div>
</li></ul>
<a name="cover_005frect"></a>
<h3 class="section">31.55 cover_rect<span class="pull-right"><a class="anchor hidden-xs" href="#cover_005frect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cover_005frect" aria-hidden="true">TOC</a></span></h3>
<p>Cover a rectangular object
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>cover</samp></dt>
<dd><p>Filepath of the optional cover image, needs to be in yuv420.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set covering mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>cover</samp>&rsquo;</dt>
<dd><p>cover it by the supplied image
</p></dd>
<dt>&lsquo;<samp>blur</samp>&rsquo;</dt>
<dd><p>cover it by interpolating the surrounding pixels
</p></dd>
</dl>
<p>Default value is <var>blur</var>.
</p></dd>
</dl>
<a name="Examples-67"></a>
<h4 class="subsection">31.55.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-67" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-67" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate a representative palette of a given video using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
</pre></div>
</li></ul>
<a name="format"></a><a name="format-1"></a>
<h3 class="section">31.56 format<span class="pull-right"><a class="anchor hidden-xs" href="#format-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-format-1" aria-hidden="true">TOC</a></span></h3>
<p>Convert the input video to one of the specified pixel formats.
Libavfilter will try to pick one that is suitable as input to
the next filter.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>pix_fmts</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of pixel format names, such as
&quot;pix_fmts=yuv420p|monow|rgb24&quot;.
</p>
</dd>
</dl>
<a name="Examples-68"></a>
<h4 class="subsection">31.56.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-68" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-68" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Convert the input video to the <var>yuv420p</var> format
<div class="example">
<pre class="example">format=pix_fmts=yuv420p
</pre></div>
<p>Convert the input video to any of the formats in the list
</p><div class="example">
<pre class="example">format=pix_fmts=yuv420p|yuv444p|yuv410p
</pre></div>
</li></ul>
<a name="fps"></a><a name="fps-1"></a>
<h3 class="section">31.57 fps<span class="pull-right"><a class="anchor hidden-xs" href="#fps-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fps-1" aria-hidden="true">TOC</a></span></h3>
<p>Convert the video to specified constant frame rate by duplicating or dropping
frames as necessary.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>fps</samp></dt>
<dd><p>The desired output frame rate. The default is <code>25</code>.
</p>
</dd>
<dt><samp>round</samp></dt>
<dd><p>Rounding method.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><samp>zero</samp></dt>
<dd><p>zero round towards 0
</p></dd>
<dt><samp>inf</samp></dt>
<dd><p>round away from 0
</p></dd>
<dt><samp>down</samp></dt>
<dd><p>round towards -infinity
</p></dd>
<dt><samp>up</samp></dt>
<dd><p>round towards +infinity
</p></dd>
<dt><samp>near</samp></dt>
<dd><p>round to nearest
</p></dd>
</dl>
<p>The default is <code>near</code>.
</p>
</dd>
<dt><samp>start_time</samp></dt>
<dd><p>Assume the first PTS should be the given value, in seconds. This allows for
padding/trimming at the start of stream. By default, no assumption is made
about the first frame&rsquo;s expected PTS, so no padding or trimming is done.
For example, this could be set to 0 to pad the beginning with duplicates of
the first frame if a video stream starts after the audio stream or to trim any
frames with a negative PTS.
</p>
</dd>
</dl>
<p>Alternatively, the options can be specified as a flat string:
<var>fps</var>[:<var>round</var>].
</p>
<p>See also the <a href="#setpts">setpts</a> filter.
</p>
<a name="Examples-69"></a>
<h4 class="subsection">31.57.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-69" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-69" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> A typical usage in order to set the fps to 25:
<div class="example">
<pre class="example">fps=fps=25
</pre></div>
</li><li> Sets the fps to 24, using abbreviation and rounding method to round to nearest:
<div class="example">
<pre class="example">fps=fps=film:round=near
</pre></div>
</li></ul>
<a name="framepack"></a>
<h3 class="section">31.58 framepack<span class="pull-right"><a class="anchor hidden-xs" href="#framepack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-framepack" aria-hidden="true">TOC</a></span></h3>
<p>Pack two different video streams into a stereoscopic video, setting proper
metadata on supported codecs. The two views should have the same size and
framerate and processing will stop when the shorter video ends. Please note
that you may conveniently adjust view properties with the <a href="#scale">scale</a> and
<a href="#fps">fps</a> filters.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>format</samp></dt>
<dd><p>The desired packing format. Supported values are:
</p>
<dl compact="compact">
<dt><samp>sbs</samp></dt>
<dd><p>The views are next to each other (default).
</p>
</dd>
<dt><samp>tab</samp></dt>
<dd><p>The views are on top of each other.
</p>
</dd>
<dt><samp>lines</samp></dt>
<dd><p>The views are packed by line.
</p>
</dd>
<dt><samp>columns</samp></dt>
<dd><p>The views are packed by column.
</p>
</dd>
<dt><samp>frameseq</samp></dt>
<dd><p>The views are temporally interleaved.
</p>
</dd>
</dl>
</dd>
</dl>
<p>Some examples:
</p>
<div class="example">
<pre class="example"># Convert left and right views into a frame-sequential video
ffmpeg -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
# Convert views into a side-by-side video with the same output resolution as the input
ffmpeg -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
</pre></div>
<a name="framerate"></a>
<h3 class="section">31.59 framerate<span class="pull-right"><a class="anchor hidden-xs" href="#framerate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-framerate" aria-hidden="true">TOC</a></span></h3>
<p>Change the frame rate by interpolating new video output frames from the source
frames.
</p>
<p>This filter is not designed to function correctly with interlaced media. If
you wish to change the frame rate of interlaced media then you are required
to deinterlace before this filter and re-interlace after this filter.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>fps</samp></dt>
<dd><p>Specify the output frames per second. This option can also be specified
as a value alone. The default is <code>50</code>.
</p>
</dd>
<dt><samp>interp_start</samp></dt>
<dd><p>Specify the start of a range where the output frame will be created as a
linear interpolation of two frames. The range is [<code>0</code>-<code>255</code>],
the default is <code>15</code>.
</p>
</dd>
<dt><samp>interp_end</samp></dt>
<dd><p>Specify the end of a range where the output frame will be created as a
linear interpolation of two frames. The range is [<code>0</code>-<code>255</code>],
the default is <code>240</code>.
</p>
</dd>
<dt><samp>scene</samp></dt>
<dd><p>Specify the level at which a scene change is detected as a value between
0 and 100 to indicate a new scene; a low value reflects a low
probability for the current frame to introduce a new scene, while a higher
value means the current frame is more likely to be one.
The default is <code>7</code>.
</p>
</dd>
<dt><samp>flags</samp></dt>
<dd><p>Specify flags influencing the filter process.
</p>
<p>Available value for <var>flags</var> is:
</p>
<dl compact="compact">
<dt><samp>scene_change_detect, scd</samp></dt>
<dd><p>Enable scene change detection using the value of the option <var>scene</var>.
This flag is enabled by default.
</p></dd>
</dl>
</dd>
</dl>
<a name="framestep"></a>
<h3 class="section">31.60 framestep<span class="pull-right"><a class="anchor hidden-xs" href="#framestep" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-framestep" aria-hidden="true">TOC</a></span></h3>
<p>Select one frame every N-th frame.
</p>
<p>This filter accepts the following option:
</p><dl compact="compact">
<dt><samp>step</samp></dt>
<dd><p>Select frame after every <code>step</code> frames.
Allowed values are positive integers higher than 0. Default value is <code>1</code>.
</p></dd>
</dl>
<a name="frei0r"></a><a name="frei0r-1"></a>
<h3 class="section">31.61 frei0r<span class="pull-right"><a class="anchor hidden-xs" href="#frei0r-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-frei0r-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply a frei0r effect to the input video.
</p>
<p>To enable the compilation of this filter, you need to install the frei0r
header and configure FFmpeg with <code>--enable-frei0r</code>.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>filter_name</samp></dt>
<dd><p>The name of the frei0r effect to load. If the environment variable
<code>FREI0R_PATH</code> is defined, the frei0r effect is searched for in each of the
directories specified by the colon-separated list in <code>FREIOR_PATH</code>.
Otherwise, the standard frei0r paths are searched, in this order:
<samp>HOME/.frei0r-1/lib/</samp>, <samp>/usr/local/lib/frei0r-1/</samp>,
<samp>/usr/lib/frei0r-1/</samp>.
</p>
</dd>
<dt><samp>filter_params</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of parameters to pass to the frei0r effect.
</p>
</dd>
</dl>
<p>A frei0r effect parameter can be a boolean (its value is either
&quot;y&quot; or &quot;n&quot;), a double, a color (specified as
<var>R</var>/<var>G</var>/<var>B</var>, where <var>R</var>, <var>G</var>, and <var>B</var> are floating point
numbers between 0.0 and 1.0, inclusive) or by a color description specified in the &quot;Color&quot;
section in the ffmpeg-utils manual), a position (specified as <var>X</var>/<var>Y</var>, where
<var>X</var> and <var>Y</var> are floating point numbers) and/or a string.
</p>
<p>The number and types of parameters depend on the loaded effect. If an
effect parameter is not specified, the default value is set.
</p>
<a name="Examples-70"></a>
<h4 class="subsection">31.61.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-70" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-70" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply the distort0r effect, setting the first two double parameters:
<div class="example">
<pre class="example">frei0r=filter_name=distort0r:filter_params=0.5|0.01
</pre></div>
</li><li> Apply the colordistance effect, taking a color as the first parameter:
<div class="example">
<pre class="example">frei0r=colordistance:0.2/0.3/0.4
frei0r=colordistance:violet
frei0r=colordistance:0x112233
</pre></div>
</li><li> Apply the perspective effect, specifying the top left and top right image
positions:
<div class="example">
<pre class="example">frei0r=perspective:0.2/0.2|0.8/0.2
</pre></div>
</li></ul>
<p>For more information, see
<a href="http://frei0r.dyne.org">http://frei0r.dyne.org</a>
</p>
<a name="fspp"></a>
<h3 class="section">31.62 fspp<span class="pull-right"><a class="anchor hidden-xs" href="#fspp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fspp" aria-hidden="true">TOC</a></span></h3>
<p>Apply fast and simple postprocessing. It is a faster version of <a href="#spp">spp</a>.
</p>
<p>It splits (I)DCT into horizontal/vertical passes. Unlike the simple post-
processing filter, one of them is performed once per block, not per pixel.
This allows for much higher speed.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 4-5. Default value is <code>4</code>.
</p>
</dd>
<dt><samp>qp</samp></dt>
<dd><p>Force a constant quantization parameter. It accepts an integer in range 0-63.
If not set, the filter will use the QP from the video stream (if available).
</p>
</dd>
<dt><samp>strength</samp></dt>
<dd><p>Set filter strength. It accepts an integer in range -15 to 32. Lower values mean
more details but also more artifacts, while higher values make the image smoother
but also blurrier. Default value is <code>0</code> − PSNR optimal.
</p>
</dd>
<dt><samp>use_bframe_qp</samp></dt>
<dd><p>Enable the use of the QP from the B-Frames if set to <code>1</code>. Using this
option may cause flicker since the B-Frames have often larger QP. Default is
<code>0</code> (not enabled).
</p>
</dd>
</dl>
<a name="gblur"></a>
<h3 class="section">31.63 gblur<span class="pull-right"><a class="anchor hidden-xs" href="#gblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gblur" aria-hidden="true">TOC</a></span></h3>
<p>Apply Gaussian blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sigma</samp></dt>
<dd><p>Set horizontal sigma, standard deviation of Gaussian blur. Default is <code>0.5</code>.
</p>
</dd>
<dt><samp>steps</samp></dt>
<dd><p>Set number of steps for Gaussian approximation. Defauls is <code>1</code>.
</p>
</dd>
<dt><samp>planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p>
</dd>
<dt><samp>sigmaV</samp></dt>
<dd><p>Set vertical sigma, if negative it will be same as <code>sigma</code>.
Default is <code>-1</code>.
</p></dd>
</dl>
<a name="geq"></a>
<h3 class="section">31.64 geq<span class="pull-right"><a class="anchor hidden-xs" href="#geq" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-geq" aria-hidden="true">TOC</a></span></h3>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>lum_expr, lum</samp></dt>
<dd><p>Set the luminance expression.
</p></dd>
<dt><samp>cb_expr, cb</samp></dt>
<dd><p>Set the chrominance blue expression.
</p></dd>
<dt><samp>cr_expr, cr</samp></dt>
<dd><p>Set the chrominance red expression.
</p></dd>
<dt><samp>alpha_expr, a</samp></dt>
<dd><p>Set the alpha expression.
</p></dd>
<dt><samp>red_expr, r</samp></dt>
<dd><p>Set the red expression.
</p></dd>
<dt><samp>green_expr, g</samp></dt>
<dd><p>Set the green expression.
</p></dd>
<dt><samp>blue_expr, b</samp></dt>
<dd><p>Set the blue expression.
</p></dd>
</dl>
<p>The colorspace is selected according to the specified options. If one
of the <samp>lum_expr</samp>, <samp>cb_expr</samp>, or <samp>cr_expr</samp>
options is specified, the filter will automatically select a YCbCr
colorspace. If one of the <samp>red_expr</samp>, <samp>green_expr</samp>, or
<samp>blue_expr</samp> options is specified, it will select an RGB
colorspace.
</p>
<p>If one of the chrominance expression is not defined, it falls back on the other
one. If no alpha expression is specified it will evaluate to opaque value.
If none of chrominance expressions are specified, they will evaluate
to the luminance expression.
</p>
<p>The expressions can use the following variables and functions:
</p>
<dl compact="compact">
<dt><samp>N</samp></dt>
<dd><p>The sequential number of the filtered frame, starting from <code>0</code>.
</p>
</dd>
<dt><samp>X</samp></dt>
<dt><samp>Y</samp></dt>
<dd><p>The coordinates of the current sample.
</p>
</dd>
<dt><samp>W</samp></dt>
<dt><samp>H</samp></dt>
<dd><p>The width and height of the image.
</p>
</dd>
<dt><samp>SW</samp></dt>
<dt><samp>SH</samp></dt>
<dd><p>Width and height scale depending on the currently filtered plane. It is the
ratio between the corresponding luma plane number of pixels and the current
plane ones. E.g. for YUV4:2:0 the values are <code>1,1</code> for the luma plane, and
<code>0.5,0.5</code> for chroma planes.
</p>
</dd>
<dt><samp>T</samp></dt>
<dd><p>Time of the current frame, expressed in seconds.
</p>
</dd>
<dt><samp>p(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the current
plane.
</p>
</dd>
<dt><samp>lum(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the luminance
plane.
</p>
</dd>
<dt><samp>cb(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the
blue-difference chroma plane. Return 0 if there is no such plane.
</p>
</dd>
<dt><samp>cr(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the
red-difference chroma plane. Return 0 if there is no such plane.
</p>
</dd>
<dt><samp>r(x, y)</samp></dt>
<dt><samp>g(x, y)</samp></dt>
<dt><samp>b(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the
red/green/blue component. Return 0 if there is no such component.
</p>
</dd>
<dt><samp>alpha(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the alpha
plane. Return 0 if there is no such plane.
</p></dd>
</dl>
<p>For functions, if <var>x</var> and <var>y</var> are outside the area, the value will be
automatically clipped to the closer edge.
</p>
<a name="Examples-71"></a>
<h4 class="subsection">31.64.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-71" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-71" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Flip the image horizontally:
<div class="example">
<pre class="example">geq=p(W-X\,Y)
</pre></div>
</li><li> Generate a bidimensional sine wave, with angle <code>PI/3</code> and a
wavelength of 100 pixels:
<div class="example">
<pre class="example">geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
</pre></div>
</li><li> Generate a fancy enigmatic moving light:
<div class="example">
<pre class="example">nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
</pre></div>
</li><li> Generate a quick emboss effect:
<div class="example">
<pre class="example">format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
</pre></div>
</li><li> Modify RGB components depending on pixel position:
<div class="example">
<pre class="example">geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
</pre></div>
</li><li> Create a radial gradient that is the same size as the input (also see
the <a href="#vignette">vignette</a> filter):
<div class="example">
<pre class="example">geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
</pre></div>
</li></ul>
<a name="gradfun"></a>
<h3 class="section">31.65 gradfun<span class="pull-right"><a class="anchor hidden-xs" href="#gradfun" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gradfun" aria-hidden="true">TOC</a></span></h3>
<p>Fix the banding artifacts that are sometimes introduced into nearly flat
regions by truncation to 8-bit color depth.
Interpolate the gradients that should go where the bands are, and
dither them.
</p>
<p>It is designed for playback only. Do not use it prior to
lossy compression, because compression tends to lose the dither and
bring back the bands.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>strength</samp></dt>
<dd><p>The maximum amount by which the filter will change any one pixel. This is also
the threshold for detecting nearly flat regions. Acceptable values range from
.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the
valid range.
</p>
</dd>
<dt><samp>radius</samp></dt>
<dd><p>The neighborhood to fit the gradient to. A larger radius makes for smoother
gradients, but also prevents the filter from modifying the pixels near detailed
regions. Acceptable values are 8-32; the default value is 16. Out-of-range
values will be clipped to the valid range.
</p>
</dd>
</dl>
<p>Alternatively, the options can be specified as a flat string:
<var>strength</var>[:<var>radius</var>]
</p>
<a name="Examples-72"></a>
<h4 class="subsection">31.65.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-72" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-72" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply the filter with a <code>3.5</code> strength and radius of <code>8</code>:
<div class="example">
<pre class="example">gradfun=3.5:8
</pre></div>
</li><li> Specify radius, omitting the strength (which will fall-back to the default
value):
<div class="example">
<pre class="example">gradfun=radius=8
</pre></div>
</li></ul>
<a name="haldclut"></a><a name="haldclut-1"></a>
<h3 class="section">31.66 haldclut<span class="pull-right"><a class="anchor hidden-xs" href="#haldclut-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-haldclut-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply a Hald CLUT to a video stream.
</p>
<p>First input is the video stream to process, and second one is the Hald CLUT.
The Hald CLUT input can be a simple picture or a complete video stream.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>shortest</samp></dt>
<dd><p>Force termination when the shortest input terminates. Default is <code>0</code>.
</p></dd>
<dt><samp>repeatlast</samp></dt>
<dd><p>Continue applying the last CLUT after the end of the stream. A value of
<code>0</code> disable the filter after the last frame of the CLUT is reached.
Default is <code>1</code>.
</p></dd>
</dl>
<p><code>haldclut</code> also has the same interpolation options as <a href="#lut3d">lut3d</a> (both
filters share the same internals).
</p>
<p>More information about the Hald CLUT can be found on Eskil Steenberg&rsquo;s website
(Hald CLUT author) at <a href="http://www.quelsolaar.com/technology/clut.html">http://www.quelsolaar.com/technology/clut.html</a>.
</p>
<a name="Workflow-examples"></a>
<h4 class="subsection">31.66.1 Workflow examples<span class="pull-right"><a class="anchor hidden-xs" href="#Workflow-examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Workflow-examples" aria-hidden="true">TOC</a></span></h4>
<a name="Hald-CLUT-video-stream"></a>
<h4 class="subsubsection">31.66.1.1 Hald CLUT video stream<span class="pull-right"><a class="anchor hidden-xs" href="#Hald-CLUT-video-stream" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Hald-CLUT-video-stream" aria-hidden="true">TOC</a></span></h4>
<p>Generate an identity Hald CLUT stream altered with various effects:
</p><div class="example">
<pre class="example">ffmpeg -f lavfi -i <a href="#haldclutsrc">haldclutsrc</a>=8 -vf &quot;hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process&quot; -t 10 -c:v ffv1 clut.nut
</pre></div>
<p>Note: make sure you use a lossless codec.
</p>
<p>Then use it with <code>haldclut</code> to apply it on some random stream:
</p><div class="example">
<pre class="example">ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
</pre></div>
<p>The Hald CLUT will be applied to the 10 first seconds (duration of
<samp>clut.nut</samp>), then the latest picture of that CLUT stream will be applied
to the remaining frames of the <code>mandelbrot</code> stream.
</p>
<a name="Hald-CLUT-with-preview"></a>
<h4 class="subsubsection">31.66.1.2 Hald CLUT with preview<span class="pull-right"><a class="anchor hidden-xs" href="#Hald-CLUT-with-preview" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Hald-CLUT-with-preview" aria-hidden="true">TOC</a></span></h4>
<p>A Hald CLUT is supposed to be a squared image of <code>Level*Level*Level</code> by
<code>Level*Level*Level</code> pixels. For a given Hald CLUT, FFmpeg will select the
biggest possible square starting at the top left of the picture. The remaining
padding pixels (bottom or right) will be ignored. This area can be used to add
a preview of the Hald CLUT.
</p>
<p>Typically, the following generated Hald CLUT will be supported by the
<code>haldclut</code> filter:
</p>
<div class="example">
<pre class="example">ffmpeg -f lavfi -i <a href="#haldclutsrc">haldclutsrc</a>=8 -vf &quot;
pad=iw+320 [padded_clut];
smptebars=s=320x256, split [a][b];
[padded_clut][a] overlay=W-320:h, curves=color_negative [main];
[main][b] overlay=W-320&quot; -frames:v 1 clut.png
</pre></div>
<p>It contains the original and a preview of the effect of the CLUT: SMPTE color
bars are displayed on the right-top, and below the same color bars processed by
the color changes.
</p>
<p>Then, the effect of this Hald CLUT can be visualized with:
</p><div class="example">
<pre class="example">ffplay input.mkv -vf &quot;movie=clut.png, [in] haldclut&quot;
</pre></div>
<a name="hflip"></a>
<h3 class="section">31.67 hflip<span class="pull-right"><a class="anchor hidden-xs" href="#hflip" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hflip" aria-hidden="true">TOC</a></span></h3>
<p>Flip the input video horizontally.
</p>
<p>For example, to horizontally flip the input video with <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -i in.avi -vf &quot;hflip&quot; out.avi
</pre></div>
<a name="histeq"></a>
<h3 class="section">31.68 histeq<span class="pull-right"><a class="anchor hidden-xs" href="#histeq" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-histeq" aria-hidden="true">TOC</a></span></h3>
<p>This filter applies a global color histogram equalization on a
per-frame basis.
</p>
<p>It can be used to correct video that has a compressed range of pixel
intensities. The filter redistributes the pixel intensities to
equalize their distribution across the intensity range. It may be
viewed as an &quot;automatically adjusting contrast filter&quot;. This filter is
useful only for correcting degraded or poorly captured source
video.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>strength</samp></dt>
<dd><p>Determine the amount of equalization to be applied. As the strength
is reduced, the distribution of pixel intensities more-and-more
approaches that of the input frame. The value must be a float number
in the range [0,1] and defaults to 0.200.
</p>
</dd>
<dt><samp>intensity</samp></dt>
<dd><p>Set the maximum intensity that can generated and scale the output
values appropriately. The strength should be set as desired and then
the intensity can be limited if needed to avoid washing-out. The value
must be a float number in the range [0,1] and defaults to 0.210.
</p>
</dd>
<dt><samp>antibanding</samp></dt>
<dd><p>Set the antibanding level. If enabled the filter will randomly vary
the luminance of output pixels by a small amount to avoid banding of
the histogram. Possible values are <code>none</code>, <code>weak</code> or
<code>strong</code>. It defaults to <code>none</code>.
</p></dd>
</dl>
<a name="histogram"></a>
<h3 class="section">31.69 histogram<span class="pull-right"><a class="anchor hidden-xs" href="#histogram" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-histogram" aria-hidden="true">TOC</a></span></h3>
<p>Compute and draw a color distribution histogram for the input video.
</p>
<p>The computed histogram is a representation of the color component
distribution in an image.
</p>
<p>Standard histogram displays the color components distribution in an image.
Displays color graph for each color component. Shows distribution of
the Y, U, V, A or R, G, B components, depending on input format, in the
current frame. Below each graph a color component scale meter is shown.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>level_height</samp></dt>
<dd><p>Set height of level. Default value is <code>200</code>.
Allowed range is [50, 2048].
</p>
</dd>
<dt><samp>scale_height</samp></dt>
<dd><p>Set height of color scale. Default value is <code>12</code>.
Allowed range is [0, 40].
</p>
</dd>
<dt><samp>display_mode</samp></dt>
<dd><p>Set display mode.
It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>parade</samp>&rsquo;</dt>
<dd><p>Per color component graphs are placed below each other.
</p>
</dd>
<dt>&lsquo;<samp>overlay</samp>&rsquo;</dt>
<dd><p>Presents information identical to that in the <code>parade</code>, except
that the graphs representing color components are superimposed directly
over one another.
</p></dd>
</dl>
<p>Default is <code>parade</code>.
</p>
</dd>
<dt><samp>levels_mode</samp></dt>
<dd><p>Set mode. Can be either <code>linear</code>, or <code>logarithmic</code>.
Default is <code>linear</code>.
</p>
</dd>
<dt><samp>components</samp></dt>
<dd><p>Set what color components to display.
Default is <code>7</code>.
</p>
</dd>
<dt><samp>fgopacity</samp></dt>
<dd><p>Set foreground opacity. Default is <code>0.7</code>.
</p>
</dd>
<dt><samp>bgopacity</samp></dt>
<dd><p>Set background opacity. Default is <code>0.5</code>.
</p></dd>
</dl>
<a name="Examples-73"></a>
<h4 class="subsection">31.69.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-73" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-73" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Calculate and draw histogram:
<div class="example">
<pre class="example">ffplay -i input -vf histogram
</pre></div>
</li></ul>
<a name="hqdn3d"></a><a name="hqdn3d-1"></a>
<h3 class="section">31.70 hqdn3d<span class="pull-right"><a class="anchor hidden-xs" href="#hqdn3d-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hqdn3d-1" aria-hidden="true">TOC</a></span></h3>
<p>This is a high precision/quality 3d denoise filter. It aims to reduce
image noise, producing smooth images and making still images really
still. It should enhance compressibility.
</p>
<p>It accepts the following optional parameters:
</p>
<dl compact="compact">
<dt><samp>luma_spatial</samp></dt>
<dd><p>A non-negative floating point number which specifies spatial luma strength.
It defaults to 4.0.
</p>
</dd>
<dt><samp>chroma_spatial</samp></dt>
<dd><p>A non-negative floating point number which specifies spatial chroma strength.
It defaults to 3.0*<var>luma_spatial</var>/4.0.
</p>
</dd>
<dt><samp>luma_tmp</samp></dt>
<dd><p>A floating point number which specifies luma temporal strength. It defaults to
6.0*<var>luma_spatial</var>/4.0.
</p>
</dd>
<dt><samp>chroma_tmp</samp></dt>
<dd><p>A floating point number which specifies chroma temporal strength. It defaults to
<var>luma_tmp</var>*<var>chroma_spatial</var>/<var>luma_spatial</var>.
</p></dd>
</dl>
<a name="hwupload_005fcuda"></a><a name="hwupload_005fcuda-1"></a>
<h3 class="section">31.71 hwupload_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#hwupload_005fcuda-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hwupload_005fcuda-1" aria-hidden="true">TOC</a></span></h3>
<p>Upload system memory frames to a CUDA device.
</p>
<p>It accepts the following optional parameters:
</p>
<dl compact="compact">
<dt><samp>device</samp></dt>
<dd><p>The number of the CUDA device to use
</p></dd>
</dl>
<a name="hqx"></a>
<h3 class="section">31.72 hqx<span class="pull-right"><a class="anchor hidden-xs" href="#hqx" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hqx" aria-hidden="true">TOC</a></span></h3>
<p>Apply a high-quality magnification filter designed for pixel art. This filter
was originally created by Maxim Stepin.
</p>
<p>It accepts the following option:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>Set the scaling dimension: <code>2</code> for <code>hq2x</code>, <code>3</code> for
<code>hq3x</code> and <code>4</code> for <code>hq4x</code>.
Default is <code>3</code>.
</p></dd>
</dl>
<a name="hstack"></a>
<h3 class="section">31.73 hstack<span class="pull-right"><a class="anchor hidden-xs" href="#hstack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hstack" aria-hidden="true">TOC</a></span></h3>
<p>Stack input videos horizontally.
</p>
<p>All streams must be of same pixel format and of same height.
</p>
<p>Note that this filter is faster than using <a href="#overlay">overlay</a> and <a href="#pad">pad</a> filter
to create same output.
</p>
<p>The filter accept the following option:
</p>
<dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>Set number of input streams. Default is 2.
</p>
</dd>
<dt><samp>shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p></dd>
</dl>
<a name="hue"></a>
<h3 class="section">31.74 hue<span class="pull-right"><a class="anchor hidden-xs" href="#hue" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hue" aria-hidden="true">TOC</a></span></h3>
<p>Modify the hue and/or the saturation of the input.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>h</samp></dt>
<dd><p>Specify the hue angle as a number of degrees. It accepts an expression,
and defaults to &quot;0&quot;.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>Specify the saturation in the [-10,10] range. It accepts an expression and
defaults to &quot;1&quot;.
</p>
</dd>
<dt><samp>H</samp></dt>
<dd><p>Specify the hue angle as a number of radians. It accepts an
expression, and defaults to &quot;0&quot;.
</p>
</dd>
<dt><samp>b</samp></dt>
<dd><p>Specify the brightness in the [-10,10] range. It accepts an expression and
defaults to &quot;0&quot;.
</p></dd>
</dl>
<p><samp>h</samp> and <samp>H</samp> are mutually exclusive, and can&rsquo;t be
specified at the same time.
</p>
<p>The <samp>b</samp>, <samp>h</samp>, <samp>H</samp> and <samp>s</samp> option values are
expressions containing the following constants:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>frame count of the input frame starting from 0
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>presentation timestamp of the input frame expressed in time base units
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt><samp>tb</samp></dt>
<dd><p>time base of the input video
</p></dd>
</dl>
<a name="Examples-74"></a>
<h4 class="subsection">31.74.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-74" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-74" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Set the hue to 90 degrees and the saturation to 1.0:
<div class="example">
<pre class="example">hue=h=90:s=1
</pre></div>
</li><li> Same command but expressing the hue in radians:
<div class="example">
<pre class="example">hue=H=PI/2:s=1
</pre></div>
</li><li> Rotate hue and make the saturation swing between 0
and 2 over a period of 1 second:
<div class="example">
<pre class="example">hue=&quot;H=2*PI*t: s=sin(2*PI*t)+1&quot;
</pre></div>
</li><li> Apply a 3 seconds saturation fade-in effect starting at 0:
<div class="example">
<pre class="example">hue=&quot;s=min(t/3\,1)&quot;
</pre></div>
<p>The general fade-in expression can be written as:
</p><div class="example">
<pre class="example">hue=&quot;s=min(0\, max((t-START)/DURATION\, 1))&quot;
</pre></div>
</li><li> Apply a 3 seconds saturation fade-out effect starting at 5 seconds:
<div class="example">
<pre class="example">hue=&quot;s=max(0\, min(1\, (8-t)/3))&quot;
</pre></div>
<p>The general fade-out expression can be written as:
</p><div class="example">
<pre class="example">hue=&quot;s=max(0\, min(1\, (START+DURATION-t)/DURATION))&quot;
</pre></div>
</li></ul>
<a name="Commands-5"></a>
<h4 class="subsection">31.74.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-5" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>b</samp></dt>
<dt><samp>s</samp></dt>
<dt><samp>h</samp></dt>
<dt><samp>H</samp></dt>
<dd><p>Modify the hue and/or the saturation and/or brightness of the input video.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a name="hysteresis"></a>
<h3 class="section">31.75 hysteresis<span class="pull-right"><a class="anchor hidden-xs" href="#hysteresis" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hysteresis" aria-hidden="true">TOC</a></span></h3>
<p>Grow first stream into second stream by connecting components.
This allows to build more robust edge masks.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp>threshold</samp></dt>
<dd><p>Set threshold which is used in filtering. If pixel component value is higher than
this value filter algorithm for connecting components is activated.
By default value is 0.
</p></dd>
</dl>
<a name="idet"></a>
<h3 class="section">31.76 idet<span class="pull-right"><a class="anchor hidden-xs" href="#idet" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-idet" aria-hidden="true">TOC</a></span></h3>
<p>Detect video interlacing type.
</p>
<p>This filter tries to detect if the input frames are interlaced, progressive,
top or bottom field first. It will also try to detect fields that are
repeated between adjacent frames (a sign of telecine).
</p>
<p>Single frame detection considers only immediately adjacent frames when classifying each frame.
Multiple frame detection incorporates the classification history of previous frames.
</p>
<p>The filter will log these metadata values:
</p>
<dl compact="compact">
<dt><samp>single.current_frame</samp></dt>
<dd><p>Detected type of current frame using single-frame detection. One of:
&ldquo;tff&rdquo; (top field first), &ldquo;bff&rdquo; (bottom field first),
&ldquo;progressive&rdquo;, or &ldquo;undetermined&rdquo;
</p>
</dd>
<dt><samp>single.tff</samp></dt>
<dd><p>Cumulative number of frames detected as top field first using single-frame detection.
</p>
</dd>
<dt><samp>multiple.tff</samp></dt>
<dd><p>Cumulative number of frames detected as top field first using multiple-frame detection.
</p>
</dd>
<dt><samp>single.bff</samp></dt>
<dd><p>Cumulative number of frames detected as bottom field first using single-frame detection.
</p>
</dd>
<dt><samp>multiple.current_frame</samp></dt>
<dd><p>Detected type of current frame using multiple-frame detection. One of:
&ldquo;tff&rdquo; (top field first), &ldquo;bff&rdquo; (bottom field first),
&ldquo;progressive&rdquo;, or &ldquo;undetermined&rdquo;
</p>
</dd>
<dt><samp>multiple.bff</samp></dt>
<dd><p>Cumulative number of frames detected as bottom field first using multiple-frame detection.
</p>
</dd>
<dt><samp>single.progressive</samp></dt>
<dd><p>Cumulative number of frames detected as progressive using single-frame detection.
</p>
</dd>
<dt><samp>multiple.progressive</samp></dt>
<dd><p>Cumulative number of frames detected as progressive using multiple-frame detection.
</p>
</dd>
<dt><samp>single.undetermined</samp></dt>
<dd><p>Cumulative number of frames that could not be classified using single-frame detection.
</p>
</dd>
<dt><samp>multiple.undetermined</samp></dt>
<dd><p>Cumulative number of frames that could not be classified using multiple-frame detection.
</p>
</dd>
<dt><samp>repeated.current_frame</samp></dt>
<dd><p>Which field in the current frame is repeated from the last. One of &ldquo;neither&rdquo;, &ldquo;top&rdquo;, or &ldquo;bottom&rdquo;.
</p>
</dd>
<dt><samp>repeated.neither</samp></dt>
<dd><p>Cumulative number of frames with no repeated field.
</p>
</dd>
<dt><samp>repeated.top</samp></dt>
<dd><p>Cumulative number of frames with the top field repeated from the previous frame&rsquo;s top field.
</p>
</dd>
<dt><samp>repeated.bottom</samp></dt>
<dd><p>Cumulative number of frames with the bottom field repeated from the previous frame&rsquo;s bottom field.
</p></dd>
</dl>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>intl_thres</samp></dt>
<dd><p>Set interlacing threshold.
</p></dd>
<dt><samp>prog_thres</samp></dt>
<dd><p>Set progressive threshold.
</p></dd>
<dt><samp>rep_thres</samp></dt>
<dd><p>Threshold for repeated field detection.
</p></dd>
<dt><samp>half_life</samp></dt>
<dd><p>Number of frames after which a given frame&rsquo;s contribution to the
statistics is halved (i.e., it contributes only 0.5 to its
classification). The default of 0 means that all frames seen are given
full weight of 1.0 forever.
</p></dd>
<dt><samp>analyze_interlaced_flag</samp></dt>
<dd><p>When this is not 0 then idet will use the specified number of frames to determine
if the interlaced flag is accurate, it will not count undetermined frames.
If the flag is found to be accurate it will be used without any further
computations, if it is found to be inaccurate it will be cleared without any
further computations. This allows inserting the idet filter as a low computational
method to clean up the interlaced flag
</p></dd>
</dl>
<a name="il"></a>
<h3 class="section">31.77 il<span class="pull-right"><a class="anchor hidden-xs" href="#il" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-il" aria-hidden="true">TOC</a></span></h3>
<p>Deinterleave or interleave fields.
</p>
<p>This filter allows one to process interlaced images fields without
deinterlacing them. Deinterleaving splits the input frame into 2
fields (so called half pictures). Odd lines are moved to the top
half of the output image, even lines to the bottom half.
You can process (filter) them independently and then re-interleave them.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>luma_mode, l</samp></dt>
<dt><samp>chroma_mode, c</samp></dt>
<dt><samp>alpha_mode, a</samp></dt>
<dd><p>Available values for <var>luma_mode</var>, <var>chroma_mode</var> and
<var>alpha_mode</var> are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Do nothing.
</p>
</dd>
<dt>&lsquo;<samp>deinterleave, d</samp>&rsquo;</dt>
<dd><p>Deinterleave fields, placing one above the other.
</p>
</dd>
<dt>&lsquo;<samp>interleave, i</samp>&rsquo;</dt>
<dd><p>Interleave fields. Reverse the effect of deinterleaving.
</p></dd>
</dl>
<p>Default value is <code>none</code>.
</p>
</dd>
<dt><samp>luma_swap, ls</samp></dt>
<dt><samp>chroma_swap, cs</samp></dt>
<dt><samp>alpha_swap, as</samp></dt>
<dd><p>Swap luma/chroma/alpha fields. Exchange even &amp; odd lines. Default value is <code>0</code>.
</p></dd>
</dl>
<a name="inflate"></a>
<h3 class="section">31.78 inflate<span class="pull-right"><a class="anchor hidden-xs" href="#inflate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-inflate" aria-hidden="true">TOC</a></span></h3>
<p>Apply inflate effect to the video.
</p>
<p>This filter replaces the pixel by the local(3x3) average by taking into account
only values higher than the pixel.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>threshold0</samp></dt>
<dt><samp>threshold1</samp></dt>
<dt><samp>threshold2</samp></dt>
<dt><samp>threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p></dd>
</dl>
<a name="interlace"></a>
<h3 class="section">31.79 interlace<span class="pull-right"><a class="anchor hidden-xs" href="#interlace" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-interlace" aria-hidden="true">TOC</a></span></h3>
<p>Simple interlacing filter from progressive contents. This interleaves upper (or
lower) lines from odd frames with lower (or upper) lines from even frames,
halving the frame rate and preserving image height.
</p>
<div class="example">
<pre class="example"> Original Original New Frame
Frame 'j' Frame 'j+1' (tff)
========== =========== ==================
Line 0 --------------------&gt; Frame 'j' Line 0
Line 1 Line 1 ----&gt; Frame 'j+1' Line 1
Line 2 ---------------------&gt; Frame 'j' Line 2
Line 3 Line 3 ----&gt; Frame 'j+1' Line 3
... ... ...
New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
</pre></div>
<p>It accepts the following optional parameters:
</p>
<dl compact="compact">
<dt><samp>scan</samp></dt>
<dd><p>This determines whether the interlaced frame is taken from the even
(tff - default) or odd (bff) lines of the progressive frame.
</p>
</dd>
<dt><samp>lowpass</samp></dt>
<dd><p>Enable (default) or disable the vertical lowpass filter to avoid twitter
interlacing and reduce moire patterns.
</p></dd>
</dl>
<a name="kerndeint"></a>
<h3 class="section">31.80 kerndeint<span class="pull-right"><a class="anchor hidden-xs" href="#kerndeint" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-kerndeint" aria-hidden="true">TOC</a></span></h3>
<p>Deinterlace input video by applying Donald Graft&rsquo;s adaptive kernel
deinterling. Work on interlaced parts of a video to produce
progressive frames.
</p>
<p>The description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>thresh</samp></dt>
<dd><p>Set the threshold which affects the filter&rsquo;s tolerance when
determining if a pixel line must be processed. It must be an integer
in the range [0,255] and defaults to 10. A value of 0 will result in
applying the process on every pixels.
</p>
</dd>
<dt><samp>map</samp></dt>
<dd><p>Paint pixels exceeding the threshold value to white if set to 1.
Default is 0.
</p>
</dd>
<dt><samp>order</samp></dt>
<dd><p>Set the fields order. Swap fields if set to 1, leave fields alone if
0. Default is 0.
</p>
</dd>
<dt><samp>sharp</samp></dt>
<dd><p>Enable additional sharpening if set to 1. Default is 0.
</p>
</dd>
<dt><samp>twoway</samp></dt>
<dd><p>Enable twoway sharpening if set to 1. Default is 0.
</p></dd>
</dl>
<a name="Examples-75"></a>
<h4 class="subsection">31.80.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-75" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-75" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply default values:
<div class="example">
<pre class="example">kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
</pre></div>
</li><li> Enable additional sharpening:
<div class="example">
<pre class="example">kerndeint=sharp=1
</pre></div>
</li><li> Paint processed pixels in white:
<div class="example">
<pre class="example">kerndeint=map=1
</pre></div>
</li></ul>
<a name="lenscorrection"></a>
<h3 class="section">31.81 lenscorrection<span class="pull-right"><a class="anchor hidden-xs" href="#lenscorrection" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lenscorrection" aria-hidden="true">TOC</a></span></h3>
<p>Correct radial lens distortion
</p>
<p>This filter can be used to correct for radial distortion as can result from the use
of wide angle lenses, and thereby re-rectify the image. To find the right parameters
one can use tools available for example as part of opencv or simply trial-and-error.
To use opencv use the calibration sample (under samples/cpp) from the opencv sources
and extract the k1 and k2 coefficients from the resulting matrix.
</p>
<p>Note that effectively the same filter is available in the open-source tools Krita and
Digikam from the KDE project.
</p>
<p>In contrast to the <a href="#vignette">vignette</a> filter, which can also be used to compensate lens errors,
this filter corrects the distortion of the image, whereas <a href="#vignette">vignette</a> corrects the
brightness distribution, so you may want to use both filters together in certain
cases, though you will have to take care of ordering, i.e. whether vignetting should
be applied before or after lens correction.
</p>
<a name="Options-27"></a>
<h4 class="subsection">31.81.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-27" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-27" aria-hidden="true">TOC</a></span></h4>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>cx</samp></dt>
<dd><p>Relative x-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
width.
</p></dd>
<dt><samp>cy</samp></dt>
<dd><p>Relative y-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
height.
</p></dd>
<dt><samp>k1</samp></dt>
<dd><p>Coefficient of the quadratic correction term. 0.5 means no correction.
</p></dd>
<dt><samp>k2</samp></dt>
<dd><p>Coefficient of the double quadratic correction term. 0.5 means no correction.
</p></dd>
</dl>
<p>The formula that generates the correction is:
</p>
<p><var>r_src</var> = <var>r_tgt</var> * (1 + <var>k1</var> * (<var>r_tgt</var> / <var>r_0</var>)^2 + <var>k2</var> * (<var>r_tgt</var> / <var>r_0</var>)^4)
</p>
<p>where <var>r_0</var> is halve of the image diagonal and <var>r_src</var> and <var>r_tgt</var> are the
distances from the focal point in the source and target images, respectively.
</p>
<a name="loop"></a>
<h3 class="section">31.82 loop<span class="pull-right"><a class="anchor hidden-xs" href="#loop" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-loop" aria-hidden="true">TOC</a></span></h3>
<p>Loop video frames.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>loop</samp></dt>
<dd><p>Set the number of loops.
</p>
</dd>
<dt><samp>size</samp></dt>
<dd><p>Set maximal size in number of frames.
</p>
</dd>
<dt><samp>start</samp></dt>
<dd><p>Set first frame of loop.
</p></dd>
</dl>
<a name="lut3d"></a><a name="lut3d-1"></a>
<h3 class="section">31.83 lut3d<span class="pull-right"><a class="anchor hidden-xs" href="#lut3d-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lut3d-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply a 3D LUT to an input video.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>file</samp></dt>
<dd><p>Set the 3D LUT file name.
</p>
<p>Currently supported formats:
</p><dl compact="compact">
<dt>&lsquo;<samp>3dl</samp>&rsquo;</dt>
<dd><p>AfterEffects
</p></dd>
<dt>&lsquo;<samp>cube</samp>&rsquo;</dt>
<dd><p>Iridas
</p></dd>
<dt>&lsquo;<samp>dat</samp>&rsquo;</dt>
<dd><p>DaVinci
</p></dd>
<dt>&lsquo;<samp>m3d</samp>&rsquo;</dt>
<dd><p>Pandora
</p></dd>
</dl>
</dd>
<dt><samp>interp</samp></dt>
<dd><p>Select interpolation mode.
</p>
<p>Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>nearest</samp>&rsquo;</dt>
<dd><p>Use values from the nearest defined point.
</p></dd>
<dt>&lsquo;<samp>trilinear</samp>&rsquo;</dt>
<dd><p>Interpolate values using the 8 points defining a cube.
</p></dd>
<dt>&lsquo;<samp>tetrahedral</samp>&rsquo;</dt>
<dd><p>Interpolate values using a tetrahedron.
</p></dd>
</dl>
</dd>
</dl>
<a name="lut_002c-lutrgb_002c-lutyuv"></a>
<h3 class="section">31.84 lut, lutrgb, lutyuv<span class="pull-right"><a class="anchor hidden-xs" href="#lut_002c-lutrgb_002c-lutyuv" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lut_002c-lutrgb_002c-lutyuv" aria-hidden="true">TOC</a></span></h3>
<p>Compute a look-up table for binding each pixel component input value
to an output value, and apply it to the input video.
</p>
<p><var>lutyuv</var> applies a lookup table to a YUV input video, <var>lutrgb</var>
to an RGB input video.
</p>
<p>These filters accept the following parameters:
</p><dl compact="compact">
<dt><samp>c0</samp></dt>
<dd><p>set first pixel component expression
</p></dd>
<dt><samp>c1</samp></dt>
<dd><p>set second pixel component expression
</p></dd>
<dt><samp>c2</samp></dt>
<dd><p>set third pixel component expression
</p></dd>
<dt><samp>c3</samp></dt>
<dd><p>set fourth pixel component expression, corresponds to the alpha component
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>set red component expression
</p></dd>
<dt><samp>g</samp></dt>
<dd><p>set green component expression
</p></dd>
<dt><samp>b</samp></dt>
<dd><p>set blue component expression
</p></dd>
<dt><samp>a</samp></dt>
<dd><p>alpha component expression
</p>
</dd>
<dt><samp>y</samp></dt>
<dd><p>set Y/luminance component expression
</p></dd>
<dt><samp>u</samp></dt>
<dd><p>set U/Cb component expression
</p></dd>
<dt><samp>v</samp></dt>
<dd><p>set V/Cr component expression
</p></dd>
</dl>
<p>Each of them specifies the expression to use for computing the lookup table for
the corresponding pixel component values.
</p>
<p>The exact component associated to each of the <var>c*</var> options depends on the
format in input.
</p>
<p>The <var>lut</var> filter requires either YUV or RGB pixel formats in input,
<var>lutrgb</var> requires RGB pixel formats in input, and <var>lutyuv</var> requires YUV.
</p>
<p>The expressions can contain the following constants and functions:
</p>
<dl compact="compact">
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>val</samp></dt>
<dd><p>The input value for the pixel component.
</p>
</dd>
<dt><samp>clipval</samp></dt>
<dd><p>The input value, clipped to the <var>minval</var>-<var>maxval</var> range.
</p>
</dd>
<dt><samp>maxval</samp></dt>
<dd><p>The maximum value for the pixel component.
</p>
</dd>
<dt><samp>minval</samp></dt>
<dd><p>The minimum value for the pixel component.
</p>
</dd>
<dt><samp>negval</samp></dt>
<dd><p>The negated value for the pixel component value, clipped to the
<var>minval</var>-<var>maxval</var> range; it corresponds to the expression
&quot;maxval-clipval+minval&quot;.
</p>
</dd>
<dt><samp>clip(val)</samp></dt>
<dd><p>The computed value in <var>val</var>, clipped to the
<var>minval</var>-<var>maxval</var> range.
</p>
</dd>
<dt><samp>gammaval(gamma)</samp></dt>
<dd><p>The computed gamma correction value of the pixel component value,
clipped to the <var>minval</var>-<var>maxval</var> range. It corresponds to the
expression
&quot;pow((clipval-minval)/(maxval-minval)\,<var>gamma</var>)*(maxval-minval)+minval&quot;
</p>
</dd>
</dl>
<p>All expressions default to &quot;val&quot;.
</p>
<a name="Examples-76"></a>
<h4 class="subsection">31.84.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-76" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-76" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Negate input video:
<div class="example">
<pre class="example">lutrgb=&quot;r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val&quot;
lutyuv=&quot;y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val&quot;
</pre></div>
<p>The above is the same as:
</p><div class="example">
<pre class="example">lutrgb=&quot;r=negval:g=negval:b=negval&quot;
lutyuv=&quot;y=negval:u=negval:v=negval&quot;
</pre></div>
</li><li> Negate luminance:
<div class="example">
<pre class="example">lutyuv=y=negval
</pre></div>
</li><li> Remove chroma components, turning the video into a graytone image:
<div class="example">
<pre class="example">lutyuv=&quot;u=128:v=128&quot;
</pre></div>
</li><li> Apply a luma burning effect:
<div class="example">
<pre class="example">lutyuv=&quot;y=2*val&quot;
</pre></div>
</li><li> Remove green and blue components:
<div class="example">
<pre class="example">lutrgb=&quot;g=0:b=0&quot;
</pre></div>
</li><li> Set a constant alpha channel value on input:
<div class="example">
<pre class="example">format=rgba,lutrgb=a=&quot;maxval-minval/2&quot;
</pre></div>
</li><li> Correct luminance gamma by a factor of 0.5:
<div class="example">
<pre class="example">lutyuv=y=gammaval(0.5)
</pre></div>
</li><li> Discard least significant bits of luma:
<div class="example">
<pre class="example">lutyuv=y='bitand(val, 128+64+32)'
</pre></div>
</li><li> Technicolor like effect:
<div class="example">
<pre class="example">lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
</pre></div>
</li></ul>
<a name="lut2"></a>
<h3 class="section">31.85 lut2<span class="pull-right"><a class="anchor hidden-xs" href="#lut2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lut2" aria-hidden="true">TOC</a></span></h3>
<p>Compute and apply a lookup table from two video inputs.
</p>
<p>This filter accepts the following parameters:
</p><dl compact="compact">
<dt><samp>c0</samp></dt>
<dd><p>set first pixel component expression
</p></dd>
<dt><samp>c1</samp></dt>
<dd><p>set second pixel component expression
</p></dd>
<dt><samp>c2</samp></dt>
<dd><p>set third pixel component expression
</p></dd>
<dt><samp>c3</samp></dt>
<dd><p>set fourth pixel component expression, corresponds to the alpha component
</p></dd>
</dl>
<p>Each of them specifies the expression to use for computing the lookup table for
the corresponding pixel component values.
</p>
<p>The exact component associated to each of the <var>c*</var> options depends on the
format in inputs.
</p>
<p>The expressions can contain the following constants:
</p>
<dl compact="compact">
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>x</samp></dt>
<dd><p>The first input value for the pixel component.
</p>
</dd>
<dt><samp>y</samp></dt>
<dd><p>The second input value for the pixel component.
</p>
</dd>
<dt><samp>bdx</samp></dt>
<dd><p>The first input video bit depth.
</p>
</dd>
<dt><samp>bdy</samp></dt>
<dd><p>The second input video bit depth.
</p></dd>
</dl>
<p>All expressions default to &quot;x&quot;.
</p>
<a name="Examples-77"></a>
<h4 class="subsection">31.85.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-77" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-77" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Highlight differences between two RGB video streams:
<div class="example">
<pre class="example">lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1)'
</pre></div>
</li><li> Highlight differences between two YUV video streams:
<div class="example">
<pre class="example">lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1)'
</pre></div>
</li></ul>
<a name="maskedclamp"></a>
<h3 class="section">31.86 maskedclamp<span class="pull-right"><a class="anchor hidden-xs" href="#maskedclamp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskedclamp" aria-hidden="true">TOC</a></span></h3>
<p>Clamp the first input stream with the second input and third input stream.
</p>
<p>Returns the value of first stream to be between second input
stream - <code>undershoot</code> and third input stream + <code>overshoot</code>.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>undershoot</samp></dt>
<dd><p>Default value is <code>0</code>.
</p>
</dd>
<dt><samp>overshoot</samp></dt>
<dd><p>Default value is <code>0</code>.
</p>
</dd>
<dt><samp>planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<a name="maskedmerge"></a>
<h3 class="section">31.87 maskedmerge<span class="pull-right"><a class="anchor hidden-xs" href="#maskedmerge" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskedmerge" aria-hidden="true">TOC</a></span></h3>
<p>Merge the first input stream with the second input stream using per pixel
weights in the third input stream.
</p>
<p>A value of 0 in the third stream pixel component means that pixel component
from first stream is returned unchanged, while maximum value (eg. 255 for
8-bit videos) means that pixel component from second stream is returned
unchanged. Intermediate values define the amount of merging between both
input stream&rsquo;s pixel components.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<a name="mcdeint"></a>
<h3 class="section">31.88 mcdeint<span class="pull-right"><a class="anchor hidden-xs" href="#mcdeint" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mcdeint" aria-hidden="true">TOC</a></span></h3>
<p>Apply motion-compensation deinterlacing.
</p>
<p>It needs one field per frame as input and must thus be used together
with yadif=1/3 or equivalent.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Set the deinterlacing mode.
</p>
<p>It accepts one of the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>fast</samp>&rsquo;</dt>
<dt>&lsquo;<samp>medium</samp>&rsquo;</dt>
<dt>&lsquo;<samp>slow</samp>&rsquo;</dt>
<dd><p>use iterative motion estimation
</p></dd>
<dt>&lsquo;<samp>extra_slow</samp>&rsquo;</dt>
<dd><p>like &lsquo;<samp>slow</samp>&rsquo;, but use multiple reference frames.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>fast</samp>&rsquo;.
</p>
</dd>
<dt><samp>parity</samp></dt>
<dd><p>Set the picture field parity assumed for the input video. It must be
one of the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>0, tff</samp>&rsquo;</dt>
<dd><p>assume top field first
</p></dd>
<dt>&lsquo;<samp>1, bff</samp>&rsquo;</dt>
<dd><p>assume bottom field first
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>bff</samp>&rsquo;.
</p>
</dd>
<dt><samp>qp</samp></dt>
<dd><p>Set per-block quantization parameter (QP) used by the internal
encoder.
</p>
<p>Higher values should result in a smoother motion vector field but less
optimal individual vectors. Default value is 1.
</p></dd>
</dl>
<a name="mergeplanes"></a>
<h3 class="section">31.89 mergeplanes<span class="pull-right"><a class="anchor hidden-xs" href="#mergeplanes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mergeplanes" aria-hidden="true">TOC</a></span></h3>
<p>Merge color channel components from several video streams.
</p>
<p>The filter accepts up to 4 input streams, and merge selected input
planes to the output video.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>mapping</samp></dt>
<dd><p>Set input to output plane mapping. Default is <code>0</code>.
</p>
<p>The mappings is specified as a bitmap. It should be specified as a
hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. &rsquo;Aa&rsquo; describes the
mapping for the first plane of the output stream. &rsquo;A&rsquo; sets the number of
the input stream to use (from 0 to 3), and &rsquo;a&rsquo; the plane number of the
corresponding input to use (from 0 to 3). The rest of the mappings is
similar, &rsquo;Bb&rsquo; describes the mapping for the output stream second
plane, &rsquo;Cc&rsquo; describes the mapping for the output stream third plane and
&rsquo;Dd&rsquo; describes the mapping for the output stream fourth plane.
</p>
</dd>
<dt><samp>format</samp></dt>
<dd><p>Set output pixel format. Default is <code>yuva444p</code>.
</p></dd>
</dl>
<a name="Examples-78"></a>
<h4 class="subsection">31.89.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-78" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-78" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Merge three gray video streams of same width and height into single video stream:
<div class="example">
<pre class="example">[a0][a1][a2]mergeplanes=0x001020:yuv444p
</pre></div>
</li><li> Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream:
<div class="example">
<pre class="example">[a0][a1]mergeplanes=0x00010210:yuva444p
</pre></div>
</li><li> Swap Y and A plane in yuva444p stream:
<div class="example">
<pre class="example">format=yuva444p,mergeplanes=0x03010200:yuva444p
</pre></div>
</li><li> Swap U and V plane in yuv420p stream:
<div class="example">
<pre class="example">format=yuv420p,mergeplanes=0x000201:yuv420p
</pre></div>
</li><li> Cast a rgb24 clip to yuv444p:
<div class="example">
<pre class="example">format=rgb24,mergeplanes=0x000102:yuv444p
</pre></div>
</li></ul>
<a name="mestimate"></a>
<h3 class="section">31.90 mestimate<span class="pull-right"><a class="anchor hidden-xs" href="#mestimate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mestimate" aria-hidden="true">TOC</a></span></h3>
<p>Estimate and export motion vectors using block matching algorithms.
Motion vectors are stored in frame side data to be used by other filters.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>method</samp></dt>
<dd><p>Specify the motion estimation method. Accepts one of the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>esa</samp>&rsquo;</dt>
<dd><p>Exhaustive search algorithm.
</p></dd>
<dt>&lsquo;<samp>tss</samp>&rsquo;</dt>
<dd><p>Three step search algorithm.
</p></dd>
<dt>&lsquo;<samp>tdls</samp>&rsquo;</dt>
<dd><p>Two dimensional logarithmic search algorithm.
</p></dd>
<dt>&lsquo;<samp>ntss</samp>&rsquo;</dt>
<dd><p>New three step search algorithm.
</p></dd>
<dt>&lsquo;<samp>fss</samp>&rsquo;</dt>
<dd><p>Four step search algorithm.
</p></dd>
<dt>&lsquo;<samp>ds</samp>&rsquo;</dt>
<dd><p>Diamond search algorithm.
</p></dd>
<dt>&lsquo;<samp>hexbs</samp>&rsquo;</dt>
<dd><p>Hexagon-based search algorithm.
</p></dd>
<dt>&lsquo;<samp>epzs</samp>&rsquo;</dt>
<dd><p>Enhanced predictive zonal search algorithm.
</p></dd>
<dt>&lsquo;<samp>umh</samp>&rsquo;</dt>
<dd><p>Uneven multi-hexagon search algorithm.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>esa</samp>&rsquo;.
</p>
</dd>
<dt><samp>mb_size</samp></dt>
<dd><p>Macroblock size. Default <code>16</code>.
</p>
</dd>
<dt><samp>search_param</samp></dt>
<dd><p>Search parameter. Default <code>7</code>.
</p></dd>
</dl>
<a name="minterpolate"></a>
<h3 class="section">31.91 minterpolate<span class="pull-right"><a class="anchor hidden-xs" href="#minterpolate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-minterpolate" aria-hidden="true">TOC</a></span></h3>
<p>Convert the video to specified frame rate using motion interpolation.
</p>
<p>This filter accepts the following options:
</p><dl compact="compact">
<dt><samp>fps</samp></dt>
<dd><p>Specify the output frame rate. This can be rational e.g. <code>60000/1001</code>. Frames are dropped if <var>fps</var> is lower than source fps. Default <code>60</code>.
</p>
</dd>
<dt><samp>mi_mode</samp></dt>
<dd><p>Motion interpolation mode. Following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>dup</samp>&rsquo;</dt>
<dd><p>Duplicate previous or next frame for interpolating new ones.
</p></dd>
<dt>&lsquo;<samp>blend</samp>&rsquo;</dt>
<dd><p>Blend source frames. Interpolated frame is mean of previous and next frames.
</p></dd>
<dt>&lsquo;<samp>mci</samp>&rsquo;</dt>
<dd><p>Motion compensated interpolation. Following options are effective when this mode is selected:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>mc_mode</samp>&rsquo;</dt>
<dd><p>Motion compensation mode. Following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>obmc</samp>&rsquo;</dt>
<dd><p>Overlapped block motion compensation.
</p></dd>
<dt>&lsquo;<samp>aobmc</samp>&rsquo;</dt>
<dd><p>Adaptive overlapped block motion compensation. Window weighting coefficients are controlled adaptively according to the reliabilities of the neighboring motion vectors to reduce oversmoothing.
</p></dd>
</dl>
<p>Default mode is &lsquo;<samp>obmc</samp>&rsquo;.
</p>
</dd>
<dt>&lsquo;<samp>me_mode</samp>&rsquo;</dt>
<dd><p>Motion estimation mode. Following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>bidir</samp>&rsquo;</dt>
<dd><p>Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions.
</p></dd>
<dt>&lsquo;<samp>bilat</samp>&rsquo;</dt>
<dd><p>Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame.
</p></dd>
</dl>
<p>Default mode is &lsquo;<samp>bilat</samp>&rsquo;.
</p>
</dd>
<dt>&lsquo;<samp>me</samp>&rsquo;</dt>
<dd><p>The algorithm to be used for motion estimation. Following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>esa</samp>&rsquo;</dt>
<dd><p>Exhaustive search algorithm.
</p></dd>
<dt>&lsquo;<samp>tss</samp>&rsquo;</dt>
<dd><p>Three step search algorithm.
</p></dd>
<dt>&lsquo;<samp>tdls</samp>&rsquo;</dt>
<dd><p>Two dimensional logarithmic search algorithm.
</p></dd>
<dt>&lsquo;<samp>ntss</samp>&rsquo;</dt>
<dd><p>New three step search algorithm.
</p></dd>
<dt>&lsquo;<samp>fss</samp>&rsquo;</dt>
<dd><p>Four step search algorithm.
</p></dd>
<dt>&lsquo;<samp>ds</samp>&rsquo;</dt>
<dd><p>Diamond search algorithm.
</p></dd>
<dt>&lsquo;<samp>hexbs</samp>&rsquo;</dt>
<dd><p>Hexagon-based search algorithm.
</p></dd>
<dt>&lsquo;<samp>epzs</samp>&rsquo;</dt>
<dd><p>Enhanced predictive zonal search algorithm.
</p></dd>
<dt>&lsquo;<samp>umh</samp>&rsquo;</dt>
<dd><p>Uneven multi-hexagon search algorithm.
</p></dd>
</dl>
<p>Default algorithm is &lsquo;<samp>epzs</samp>&rsquo;.
</p>
</dd>
<dt>&lsquo;<samp>mb_size</samp>&rsquo;</dt>
<dd><p>Macroblock size. Default <code>16</code>.
</p>
</dd>
<dt>&lsquo;<samp>search_param</samp>&rsquo;</dt>
<dd><p>Motion estimation search parameter. Default <code>32</code>.
</p>
</dd>
<dt>&lsquo;<samp>vsmbc</samp>&rsquo;</dt>
<dd><p>Enable variable-size block motion compensation. Motion estimation is applied with smaller block sizes at object boundaries in order to make the them less blur. Default is <code>0</code> (disabled).
</p></dd>
</dl>
</dd>
</dl>
</dd>
<dt><samp>scd</samp></dt>
<dd><p>Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Disable scene change detection.
</p></dd>
<dt>&lsquo;<samp>fdiff</samp>&rsquo;</dt>
<dd><p>Frame difference. Corresponding pixel values are compared and if it statisfies <var>scd_threshold</var> scene change is detected.
</p></dd>
</dl>
<p>Default method is &lsquo;<samp>fdiff</samp>&rsquo;.
</p>
</dd>
<dt><samp>scd_threshold</samp></dt>
<dd><p>Scene change detection threshold. Default is <code>5.0</code>.
</p></dd>
</dl>
<a name="mpdecimate"></a>
<h3 class="section">31.92 mpdecimate<span class="pull-right"><a class="anchor hidden-xs" href="#mpdecimate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mpdecimate" aria-hidden="true">TOC</a></span></h3>
<p>Drop frames that do not differ greatly from the previous frame in
order to reduce frame rate.
</p>
<p>The main use of this filter is for very-low-bitrate encoding
(e.g. streaming over dialup modem), but it could in theory be used for
fixing movies that were inverse-telecined incorrectly.
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>max</samp></dt>
<dd><p>Set the maximum number of consecutive frames which can be dropped (if
positive), or the minimum interval between dropped frames (if
negative). If the value is 0, the frame is dropped unregarding the
number of previous sequentially dropped frames.
</p>
<p>Default value is 0.
</p>
</dd>
<dt><samp>hi</samp></dt>
<dt><samp>lo</samp></dt>
<dt><samp>frac</samp></dt>
<dd><p>Set the dropping threshold values.
</p>
<p>Values for <samp>hi</samp> and <samp>lo</samp> are for 8x8 pixel blocks and
represent actual pixel value differences, so a threshold of 64
corresponds to 1 unit of difference for each pixel, or the same spread
out differently over the block.
</p>
<p>A frame is a candidate for dropping if no 8x8 blocks differ by more
than a threshold of <samp>hi</samp>, and if no more than <samp>frac</samp> blocks (1
meaning the whole image) differ by more than a threshold of <samp>lo</samp>.
</p>
<p>Default value for <samp>hi</samp> is 64*12, default value for <samp>lo</samp> is
64*5, and default value for <samp>frac</samp> is 0.33.
</p></dd>
</dl>
<a name="negate"></a>
<h3 class="section">31.93 negate<span class="pull-right"><a class="anchor hidden-xs" href="#negate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-negate" aria-hidden="true">TOC</a></span></h3>
<p>Negate input video.
</p>
<p>It accepts an integer in input; if non-zero it negates the
alpha component (if available). The default value in input is 0.
</p>
<a name="nlmeans"></a>
<h3 class="section">31.94 nlmeans<span class="pull-right"><a class="anchor hidden-xs" href="#nlmeans" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-nlmeans" aria-hidden="true">TOC</a></span></h3>
<p>Denoise frames using Non-Local Means algorithm.
</p>
<p>Each pixel is adjusted by looking for other pixels with similar contexts. This
context similarity is defined by comparing their surrounding patches of size
<samp>p</samp>x<samp>p</samp>. Patches are searched in an area of <samp>r</samp>x<samp>r</samp>
around the pixel.
</p>
<p>Note that the research area defines centers for patches, which means some
patches will be made of pixels outside that research area.
</p>
<p>The filter accepts the following options.
</p>
<dl compact="compact">
<dt><samp>s</samp></dt>
<dd><p>Set denoising strength.
</p>
</dd>
<dt><samp>p</samp></dt>
<dd><p>Set patch size.
</p>
</dd>
<dt><samp>pc</samp></dt>
<dd><p>Same as <samp>p</samp> but for chroma planes.
</p>
<p>The default value is <var>0</var> and means automatic.
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>Set research size.
</p>
</dd>
<dt><samp>rc</samp></dt>
<dd><p>Same as <samp>r</samp> but for chroma planes.
</p>
<p>The default value is <var>0</var> and means automatic.
</p></dd>
</dl>
<a name="nnedi"></a>
<h3 class="section">31.95 nnedi<span class="pull-right"><a class="anchor hidden-xs" href="#nnedi" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-nnedi" aria-hidden="true">TOC</a></span></h3>
<p>Deinterlace video using neural network edge directed interpolation.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>weights</samp></dt>
<dd><p>Mandatory option, without binary file filter can not work.
Currently file can be found here:
https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin
</p>
</dd>
<dt><samp>deint</samp></dt>
<dd><p>Set which frames to deinterlace, by default it is <code>all</code>.
Can be <code>all</code> or <code>interlaced</code>.
</p>
</dd>
<dt><samp>field</samp></dt>
<dd><p>Set mode of operation.
</p>
<p>Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>af</samp>&rsquo;</dt>
<dd><p>Use frame flags, both fields.
</p></dd>
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dd><p>Use frame flags, single field.
</p></dd>
<dt>&lsquo;<samp>t</samp>&rsquo;</dt>
<dd><p>Use top field only.
</p></dd>
<dt>&lsquo;<samp>b</samp>&rsquo;</dt>
<dd><p>Use bottom field only.
</p></dd>
<dt>&lsquo;<samp>tf</samp>&rsquo;</dt>
<dd><p>Use both fields, top first.
</p></dd>
<dt>&lsquo;<samp>bf</samp>&rsquo;</dt>
<dd><p>Use both fields, bottom first.
</p></dd>
</dl>
</dd>
<dt><samp>planes</samp></dt>
<dd><p>Set which planes to process, by default filter process all frames.
</p>
</dd>
<dt><samp>nsize</samp></dt>
<dd><p>Set size of local neighborhood around each pixel, used by the predictor neural
network.
</p>
<p>Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>s8x6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s16x6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s32x6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s48x6</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s8x4</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s16x4</samp>&rsquo;</dt>
<dt>&lsquo;<samp>s32x4</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>nns</samp></dt>
<dd><p>Set the number of neurons in predicctor neural network.
Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>n16</samp>&rsquo;</dt>
<dt>&lsquo;<samp>n32</samp>&rsquo;</dt>
<dt>&lsquo;<samp>n64</samp>&rsquo;</dt>
<dt>&lsquo;<samp>n128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>n256</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>qual</samp></dt>
<dd><p>Controls the number of different neural network predictions that are blended
together to compute the final output value. Can be <code>fast</code>, default or
<code>slow</code>.
</p>
</dd>
<dt><samp>etype</samp></dt>
<dd><p>Set which set of weights to use in the predictor.
Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dd><p>weights trained to minimize absolute error
</p></dd>
<dt>&lsquo;<samp>s</samp>&rsquo;</dt>
<dd><p>weights trained to minimize squared error
</p></dd>
</dl>
</dd>
<dt><samp>pscrn</samp></dt>
<dd><p>Controls whether or not the prescreener neural network is used to decide
which pixels should be processed by the predictor neural network and which
can be handled by simple cubic interpolation.
The prescreener is trained to know whether cubic interpolation will be
sufficient for a pixel or whether it should be predicted by the predictor nn.
The computational complexity of the prescreener nn is much less than that of
the predictor nn. Since most pixels can be handled by cubic interpolation,
using the prescreener generally results in much faster processing.
The prescreener is pretty accurate, so the difference between using it and not
using it is almost always unnoticeable.
</p>
<p>Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dt>&lsquo;<samp>original</samp>&rsquo;</dt>
<dt>&lsquo;<samp>new</samp>&rsquo;</dt>
</dl>
<p>Default is <code>new</code>.
</p>
</dd>
<dt><samp>fapprox</samp></dt>
<dd><p>Set various debugging flags.
</p></dd>
</dl>
<a name="noformat"></a>
<h3 class="section">31.96 noformat<span class="pull-right"><a class="anchor hidden-xs" href="#noformat" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-noformat" aria-hidden="true">TOC</a></span></h3>
<p>Force libavfilter not to use any of the specified pixel formats for the
input to the next filter.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>pix_fmts</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of pixel format names, such as
apix_fmts=yuv420p|monow|rgb24&quot;.
</p>
</dd>
</dl>
<a name="Examples-79"></a>
<h4 class="subsection">31.96.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-79" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-79" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Force libavfilter to use a format different from <var>yuv420p</var> for the
input to the vflip filter:
<div class="example">
<pre class="example">noformat=pix_fmts=yuv420p,vflip
</pre></div>
</li><li> Convert the input video to any of the formats not contained in the list:
<div class="example">
<pre class="example">noformat=yuv420p|yuv444p|yuv410p
</pre></div>
</li></ul>
<a name="noise-1"></a>
<h3 class="section">31.97 noise<span class="pull-right"><a class="anchor hidden-xs" href="#noise-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-noise-1" aria-hidden="true">TOC</a></span></h3>
<p>Add noise on video input frame.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>all_seed</samp></dt>
<dt><samp>c0_seed</samp></dt>
<dt><samp>c1_seed</samp></dt>
<dt><samp>c2_seed</samp></dt>
<dt><samp>c3_seed</samp></dt>
<dd><p>Set noise seed for specific pixel component or all pixel components in case
of <var>all_seed</var>. Default value is <code>123457</code>.
</p>
</dd>
<dt><samp>all_strength, alls</samp></dt>
<dt><samp>c0_strength, c0s</samp></dt>
<dt><samp>c1_strength, c1s</samp></dt>
<dt><samp>c2_strength, c2s</samp></dt>
<dt><samp>c3_strength, c3s</samp></dt>
<dd><p>Set noise strength for specific pixel component or all pixel components in case
<var>all_strength</var>. Default value is <code>0</code>. Allowed range is [0, 100].
</p>
</dd>
<dt><samp>all_flags, allf</samp></dt>
<dt><samp>c0_flags, c0f</samp></dt>
<dt><samp>c1_flags, c1f</samp></dt>
<dt><samp>c2_flags, c2f</samp></dt>
<dt><samp>c3_flags, c3f</samp></dt>
<dd><p>Set pixel component flags or set flags for all components if <var>all_flags</var>.
Available values for component flags are:
</p><dl compact="compact">
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dd><p>averaged temporal noise (smoother)
</p></dd>
<dt>&lsquo;<samp>p</samp>&rsquo;</dt>
<dd><p>mix random noise with a (semi)regular pattern
</p></dd>
<dt>&lsquo;<samp>t</samp>&rsquo;</dt>
<dd><p>temporal noise (noise pattern changes between frames)
</p></dd>
<dt>&lsquo;<samp>u</samp>&rsquo;</dt>
<dd><p>uniform noise (gaussian otherwise)
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-80"></a>
<h4 class="subsection">31.97.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-80" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-80" aria-hidden="true">TOC</a></span></h4>
<p>Add temporal and uniform noise to input video:
</p><div class="example">
<pre class="example">noise=alls=20:allf=t+u
</pre></div>
<a name="null"></a>
<h3 class="section">31.98 null<span class="pull-right"><a class="anchor hidden-xs" href="#null" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-null" aria-hidden="true">TOC</a></span></h3>
<p>Pass the video source unchanged to the output.
</p>
<a name="ocr"></a>
<h3 class="section">31.99 ocr<span class="pull-right"><a class="anchor hidden-xs" href="#ocr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ocr" aria-hidden="true">TOC</a></span></h3>
<p>Optical Character Recognition
</p>
<p>This filter uses Tesseract for optical character recognition.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>datapath</samp></dt>
<dd><p>Set datapath to tesseract data. Default is to use whatever was
set at installation.
</p>
</dd>
<dt><samp>language</samp></dt>
<dd><p>Set language, default is &quot;eng&quot;.
</p>
</dd>
<dt><samp>whitelist</samp></dt>
<dd><p>Set character whitelist.
</p>
</dd>
<dt><samp>blacklist</samp></dt>
<dd><p>Set character blacklist.
</p></dd>
</dl>
<p>The filter exports recognized text as the frame metadata <code>lavfi.ocr.text</code>.
</p>
<a name="ocv"></a>
<h3 class="section">31.100 ocv<span class="pull-right"><a class="anchor hidden-xs" href="#ocv" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ocv" aria-hidden="true">TOC</a></span></h3>
<p>Apply a video transform using libopencv.
</p>
<p>To enable this filter, install the libopencv library and headers and
configure FFmpeg with <code>--enable-libopencv</code>.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>filter_name</samp></dt>
<dd><p>The name of the libopencv filter to apply.
</p>
</dd>
<dt><samp>filter_params</samp></dt>
<dd><p>The parameters to pass to the libopencv filter. If not specified, the default
values are assumed.
</p>
</dd>
</dl>
<p>Refer to the official libopencv documentation for more precise
information:
<a href="http://docs.opencv.org/master/modules/imgproc/doc/filtering.html">http://docs.opencv.org/master/modules/imgproc/doc/filtering.html</a>
</p>
<p>Several libopencv filters are supported; see the following subsections.
</p>
<a name="dilate"></a><a name="dilate-1"></a>
<h4 class="subsection">31.100.1 dilate<span class="pull-right"><a class="anchor hidden-xs" href="#dilate-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dilate-1" aria-hidden="true">TOC</a></span></h4>
<p>Dilate an image by using a specific structuring element.
It corresponds to the libopencv function <code>cvDilate</code>.
</p>
<p>It accepts the parameters: <var>struct_el</var>|<var>nb_iterations</var>.
</p>
<p><var>struct_el</var> represents a structuring element, and has the syntax:
<var>cols</var>x<var>rows</var>+<var>anchor_x</var>x<var>anchor_y</var>/<var>shape</var>
</p>
<p><var>cols</var> and <var>rows</var> represent the number of columns and rows of
the structuring element, <var>anchor_x</var> and <var>anchor_y</var> the anchor
point, and <var>shape</var> the shape for the structuring element. <var>shape</var>
must be &quot;rect&quot;, &quot;cross&quot;, &quot;ellipse&quot;, or &quot;custom&quot;.
</p>
<p>If the value for <var>shape</var> is &quot;custom&quot;, it must be followed by a
string of the form &quot;=<var>filename</var>&quot;. The file with name
<var>filename</var> is assumed to represent a binary image, with each
printable character corresponding to a bright pixel. When a custom
<var>shape</var> is used, <var>cols</var> and <var>rows</var> are ignored, the number
or columns and rows of the read file are assumed instead.
</p>
<p>The default value for <var>struct_el</var> is &quot;3x3+0x0/rect&quot;.
</p>
<p><var>nb_iterations</var> specifies the number of times the transform is
applied to the image, and defaults to 1.
</p>
<p>Some examples:
</p><div class="example">
<pre class="example"># Use the default values
ocv=dilate
# Dilate using a structuring element with a 5x5 cross, iterating two times
ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
# Read the shape from the file diamond.shape, iterating two times.
# The file diamond.shape may contain a pattern of characters like this
# *
# ***
# *****
# ***
# *
# The specified columns and rows are ignored
# but the anchor point coordinates are not
ocv=dilate:0x0+2x2/custom=diamond.shape|2
</pre></div>
<a name="erode"></a>
<h4 class="subsection">31.100.2 erode<span class="pull-right"><a class="anchor hidden-xs" href="#erode" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-erode" aria-hidden="true">TOC</a></span></h4>
<p>Erode an image by using a specific structuring element.
It corresponds to the libopencv function <code>cvErode</code>.
</p>
<p>It accepts the parameters: <var>struct_el</var>:<var>nb_iterations</var>,
with the same syntax and semantics as the <a href="#dilate">dilate</a> filter.
</p>
<a name="smooth"></a>
<h4 class="subsection">31.100.3 smooth<span class="pull-right"><a class="anchor hidden-xs" href="#smooth" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-smooth" aria-hidden="true">TOC</a></span></h4>
<p>Smooth the input video.
</p>
<p>The filter takes the following parameters:
<var>type</var>|<var>param1</var>|<var>param2</var>|<var>param3</var>|<var>param4</var>.
</p>
<p><var>type</var> is the type of smooth filter to apply, and must be one of
the following values: &quot;blur&quot;, &quot;blur_no_scale&quot;, &quot;median&quot;, &quot;gaussian&quot;,
or &quot;bilateral&quot;. The default value is &quot;gaussian&quot;.
</p>
<p>The meaning of <var>param1</var>, <var>param2</var>, <var>param3</var>, and <var>param4</var>
depend on the smooth type. <var>param1</var> and
<var>param2</var> accept integer positive values or 0. <var>param3</var> and
<var>param4</var> accept floating point values.
</p>
<p>The default value for <var>param1</var> is 3. The default value for the
other parameters is 0.
</p>
<p>These parameters correspond to the parameters assigned to the
libopencv function <code>cvSmooth</code>.
</p>
<a name="overlay"></a><a name="overlay-1"></a>
<h3 class="section">31.101 overlay<span class="pull-right"><a class="anchor hidden-xs" href="#overlay-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-overlay-1" aria-hidden="true">TOC</a></span></h3>
<p>Overlay one video on top of another.
</p>
<p>It takes two inputs and has one output. The first input is the &quot;main&quot;
video on which the second input is overlaid.
</p>
<p>It accepts the following parameters:
</p>
<p>A description of the accepted options follows.
</p>
<dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Set the expression for the x and y coordinates of the overlaid video
on the main video. Default value is &quot;0&quot; for both expressions. In case
the expression is invalid, it is set to a huge value (meaning that the
overlay will not be displayed within the output visible area).
</p>
</dd>
<dt><samp>eof_action</samp></dt>
<dd><p>The action to take when EOF is encountered on the secondary input; it accepts
one of the following values:
</p>
<dl compact="compact">
<dt><samp>repeat</samp></dt>
<dd><p>Repeat the last frame (the default).
</p></dd>
<dt><samp>endall</samp></dt>
<dd><p>End both streams.
</p></dd>
<dt><samp>pass</samp></dt>
<dd><p>Pass the main input through.
</p></dd>
</dl>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Set when the expressions for <samp>x</samp>, and <samp>y</samp> are evaluated.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>init</samp>&rsquo;</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>frame</samp>&rsquo;.
</p>
</dd>
<dt><samp>shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p>
</dd>
<dt><samp>format</samp></dt>
<dd><p>Set the format for the output video.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>yuv420</samp>&rsquo;</dt>
<dd><p>force YUV420 output
</p>
</dd>
<dt>&lsquo;<samp>yuv422</samp>&rsquo;</dt>
<dd><p>force YUV422 output
</p>
</dd>
<dt>&lsquo;<samp>yuv444</samp>&rsquo;</dt>
<dd><p>force YUV444 output
</p>
</dd>
<dt>&lsquo;<samp>rgb</samp>&rsquo;</dt>
<dd><p>force RGB output
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>yuv420</samp>&rsquo;.
</p>
</dd>
<dt><samp>rgb <em>(deprecated)</em></samp></dt>
<dd><p>If set to 1, force the filter to accept inputs in the RGB
color space. Default value is 0. This option is deprecated, use
<samp>format</samp> instead.
</p>
</dd>
<dt><samp>repeatlast</samp></dt>
<dd><p>If set to 1, force the filter to draw the last overlay frame over the
main input until the end of the stream. A value of 0 disables this
behavior. Default value is 1.
</p></dd>
</dl>
<p>The <samp>x</samp>, and <samp>y</samp> expressions can contain the following
parameters.
</p>
<dl compact="compact">
<dt><samp>main_w, W</samp></dt>
<dt><samp>main_h, H</samp></dt>
<dd><p>The main input width and height.
</p>
</dd>
<dt><samp>overlay_w, w</samp></dt>
<dt><samp>overlay_h, h</samp></dt>
<dd><p>The overlay input width and height.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The computed values for <var>x</var> and <var>y</var>. They are evaluated for
each new frame.
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values of the output
format. For example for the pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and
<var>vsub</var> is 1.
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The timestamp, expressed in seconds. It&rsquo;s NAN if the input timestamp is unknown.
</p>
</dd>
</dl>
<p>Note that the <var>n</var>, <var>pos</var>, <var>t</var> variables are available only
when evaluation is done <em>per frame</em>, and will evaluate to NAN
when <samp>eval</samp> is set to &lsquo;<samp>init</samp>&rsquo;.
</p>
<p>Be aware that frames are taken from each input video in timestamp
order, hence, if their initial timestamps differ, it is a good idea
to pass the two inputs through a <var>setpts=PTS-STARTPTS</var> filter to
have them begin in the same zero timestamp, as the example for
the <var>movie</var> filter does.
</p>
<p>You can chain together more overlays but you should test the
efficiency of such approach.
</p>
<a name="Commands-6"></a>
<h4 class="subsection">31.101.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-6" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-6" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Modify the x and y of the overlay input.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a name="Examples-81"></a>
<h4 class="subsection">31.101.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-81" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-81" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Draw the overlay at 10 pixels from the bottom right corner of the main
video:
<div class="example">
<pre class="example">overlay=main_w-overlay_w-10:main_h-overlay_h-10
</pre></div>
<p>Using named options the example above becomes:
</p><div class="example">
<pre class="example">overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
</pre></div>
</li><li> Insert a transparent PNG logo in the bottom left corner of the input,
using the <code>ffmpeg</code> tool with the <code>-filter_complex</code> option:
<div class="example">
<pre class="example">ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
</pre></div>
</li><li> Insert 2 different transparent PNG logos (second logo on bottom
right corner) using the <code>ffmpeg</code> tool:
<div class="example">
<pre class="example">ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
</pre></div>
</li><li> Add a transparent color layer on top of the main video; <code>WxH</code>
must specify the size of the main input to the overlay filter:
<div class="example">
<pre class="example">color=color=red@.3:size=WxH [over]; [in][over] overlay [out]
</pre></div>
</li><li> Play an original video and a filtered version (here with the deshake
filter) side by side using the <code>ffplay</code> tool:
<div class="example">
<pre class="example">ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
</pre></div>
<p>The above command is the same as:
</p><div class="example">
<pre class="example">ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
</pre></div>
</li><li> Make a sliding overlay appearing from the left to the right top part of the
screen starting since time 2:
<div class="example">
<pre class="example">overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
</pre></div>
</li><li> Compose output by putting two input videos side to side:
<div class="example">
<pre class="example">ffmpeg -i left.avi -i right.avi -filter_complex &quot;
nullsrc=size=200x100 [background];
[0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
[1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
[background][left] overlay=shortest=1 [background+left];
[background+left][right] overlay=shortest=1:x=100 [left+right]
&quot;
</pre></div>
</li><li> Mask 10-20 seconds of a video by applying the delogo filter to a section
<div class="example">
<pre class="example">ffmpeg -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
-vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
masked.avi
</pre></div>
</li><li> Chain several overlays in cascade:
<div class="example">
<pre class="example">nullsrc=s=200x200 [bg];
testsrc=s=100x100, split=4 [in0][in1][in2][in3];
[in0] lutrgb=r=0, [bg] overlay=0:0 [mid0];
[in1] lutrgb=g=0, [mid0] overlay=100:0 [mid1];
[in2] lutrgb=b=0, [mid1] overlay=0:100 [mid2];
[in3] null, [mid2] overlay=100:100 [out0]
</pre></div>
</li></ul>
<a name="owdenoise"></a>
<h3 class="section">31.102 owdenoise<span class="pull-right"><a class="anchor hidden-xs" href="#owdenoise" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-owdenoise" aria-hidden="true">TOC</a></span></h3>
<p>Apply Overcomplete Wavelet denoiser.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>depth</samp></dt>
<dd><p>Set depth.
</p>
<p>Larger depth values will denoise lower frequency components more, but
slow down filtering.
</p>
<p>Must be an int in the range 8-16, default is <code>8</code>.
</p>
</dd>
<dt><samp>luma_strength, ls</samp></dt>
<dd><p>Set luma strength.
</p>
<p>Must be a double value in the range 0-1000, default is <code>1.0</code>.
</p>
</dd>
<dt><samp>chroma_strength, cs</samp></dt>
<dd><p>Set chroma strength.
</p>
<p>Must be a double value in the range 0-1000, default is <code>1.0</code>.
</p></dd>
</dl>
<a name="pad"></a><a name="pad-1"></a>
<h3 class="section">31.103 pad<span class="pull-right"><a class="anchor hidden-xs" href="#pad-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pad-1" aria-hidden="true">TOC</a></span></h3>
<p>Add paddings to the input image, and place the original input at the
provided <var>x</var>, <var>y</var> coordinates.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>Specify an expression for the size of the output image with the
paddings added. If the value for <var>width</var> or <var>height</var> is 0, the
corresponding input size is used for the output.
</p>
<p>The <var>width</var> expression can reference the value set by the
<var>height</var> expression, and vice versa.
</p>
<p>The default value of <var>width</var> and <var>height</var> is 0.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Specify the offsets to place the input image at within the padded area,
with respect to the top/left border of the output image.
</p>
<p>The <var>x</var> expression can reference the value set by the <var>y</var>
expression, and vice versa.
</p>
<p>The default value of <var>x</var> and <var>y</var> is 0.
</p>
</dd>
<dt><samp>color</samp></dt>
<dd><p>Specify the color of the padded area. For the syntax of this option,
check the &quot;Color&quot; section in the ffmpeg-utils manual.
</p>
<p>The default value of <var>color</var> is &quot;black&quot;.
</p></dd>
</dl>
<p>The value for the <var>width</var>, <var>height</var>, <var>x</var>, and <var>y</var>
options are expressions containing the following constants:
</p>
<dl compact="compact">
<dt><samp>in_w</samp></dt>
<dt><samp>in_h</samp></dt>
<dd><p>The input video width and height.
</p>
</dd>
<dt><samp>iw</samp></dt>
<dt><samp>ih</samp></dt>
<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>.
</p>
</dd>
<dt><samp>out_w</samp></dt>
<dt><samp>out_h</samp></dt>
<dd><p>The output width and height (the size of the padded area), as
specified by the <var>width</var> and <var>height</var> expressions.
</p>
</dd>
<dt><samp>ow</samp></dt>
<dt><samp>oh</samp></dt>
<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>The x and y offsets as specified by the <var>x</var> and <var>y</var>
expressions, or NAN if not yet specified.
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>same as <var>iw</var> / <var>ih</var>
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp>dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var>iw</var> / <var>ih</var>) * <var>sar</var>
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>The horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p></dd>
</dl>
<a name="Examples-82"></a>
<h4 class="subsection">31.103.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-82" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-82" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Add paddings with the color &quot;violet&quot; to the input video. The output video
size is 640x480, and the top-left corner of the input video is placed at
column 0, row 40
<div class="example">
<pre class="example">pad=640:480:0:40:violet
</pre></div>
<p>The example above is equivalent to the following command:
</p><div class="example">
<pre class="example">pad=width=640:height=480:x=0:y=40:color=violet
</pre></div>
</li><li> Pad the input to get an output with dimensions increased by 3/2,
and put the input video at the center of the padded area:
<div class="example">
<pre class="example">pad=&quot;3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2&quot;
</pre></div>
</li><li> Pad the input to get a squared output with size equal to the maximum
value between the input width and height, and put the input video at
the center of the padded area:
<div class="example">
<pre class="example">pad=&quot;max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2&quot;
</pre></div>
</li><li> Pad the input to get a final w/h ratio of 16:9:
<div class="example">
<pre class="example">pad=&quot;ih*16/9:ih:(ow-iw)/2:(oh-ih)/2&quot;
</pre></div>
</li><li> In case of anamorphic video, in order to set the output display aspect
correctly, it is necessary to use <var>sar</var> in the expression,
according to the relation:
<div class="example">
<pre class="example">(ih * X / ih) * sar = output_dar
X = output_dar / sar
</pre></div>
<p>Thus the previous example needs to be modified to:
</p><div class="example">
<pre class="example">pad=&quot;ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2&quot;
</pre></div>
</li><li> Double the output size and put the input video in the bottom-right
corner of the output padded area:
<div class="example">
<pre class="example">pad=&quot;2*iw:2*ih:ow-iw:oh-ih&quot;
</pre></div>
</li></ul>
<a name="palettegen"></a><a name="palettegen-1"></a>
<h3 class="section">31.104 palettegen<span class="pull-right"><a class="anchor hidden-xs" href="#palettegen-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-palettegen-1" aria-hidden="true">TOC</a></span></h3>
<p>Generate one palette for a whole video stream.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>max_colors</samp></dt>
<dd><p>Set the maximum number of colors to quantize in the palette.
Note: the palette will still contain 256 colors; the unused palette entries
will be black.
</p>
</dd>
<dt><samp>reserve_transparent</samp></dt>
<dd><p>Create a palette of 255 colors maximum and reserve the last one for
transparency. Reserving the transparency color is useful for GIF optimization.
If not set, the maximum of colors in the palette will be 256. You probably want
to disable this option for a standalone image.
Set by default.
</p>
</dd>
<dt><samp>stats_mode</samp></dt>
<dd><p>Set statistics mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>full</samp>&rsquo;</dt>
<dd><p>Compute full frame histograms.
</p></dd>
<dt>&lsquo;<samp>diff</samp>&rsquo;</dt>
<dd><p>Compute histograms only for the part that differs from previous frame. This
might be relevant to give more importance to the moving part of your input if
the background is static.
</p></dd>
<dt>&lsquo;<samp>single</samp>&rsquo;</dt>
<dd><p>Compute new histogram for each frame.
</p></dd>
</dl>
<p>Default value is <var>full</var>.
</p></dd>
</dl>
<p>The filter also exports the frame metadata <code>lavfi.color_quant_ratio</code>
(<code>nb_color_in / nb_color_out</code>) which you can use to evaluate the degree of
color quantization of the palette. This information is also visible at
<var>info</var> logging level.
</p>
<a name="Examples-83"></a>
<h4 class="subsection">31.104.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-83" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-83" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Generate a representative palette of a given video using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i input.mkv -vf palettegen palette.png
</pre></div>
</li></ul>
<a name="paletteuse"></a>
<h3 class="section">31.105 paletteuse<span class="pull-right"><a class="anchor hidden-xs" href="#paletteuse" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-paletteuse" aria-hidden="true">TOC</a></span></h3>
<p>Use a palette to downsample an input video stream.
</p>
<p>The filter takes two inputs: one video stream and a palette. The palette must
be a 256 pixels image.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>dither</samp></dt>
<dd><p>Select dithering mode. Available algorithms are:
</p><dl compact="compact">
<dt>&lsquo;<samp>bayer</samp>&rsquo;</dt>
<dd><p>Ordered 8x8 bayer dithering (deterministic)
</p></dd>
<dt>&lsquo;<samp>heckbert</samp>&rsquo;</dt>
<dd><p>Dithering as defined by Paul Heckbert in 1982 (simple error diffusion).
Note: this dithering is sometimes considered &quot;wrong&quot; and is included as a
reference.
</p></dd>
<dt>&lsquo;<samp>floyd_steinberg</samp>&rsquo;</dt>
<dd><p>Floyd and Steingberg dithering (error diffusion)
</p></dd>
<dt>&lsquo;<samp>sierra2</samp>&rsquo;</dt>
<dd><p>Frankie Sierra dithering v2 (error diffusion)
</p></dd>
<dt>&lsquo;<samp>sierra2_4a</samp>&rsquo;</dt>
<dd><p>Frankie Sierra dithering v2 &quot;Lite&quot; (error diffusion)
</p></dd>
</dl>
<p>Default is <var>sierra2_4a</var>.
</p>
</dd>
<dt><samp>bayer_scale</samp></dt>
<dd><p>When <var>bayer</var> dithering is selected, this option defines the scale of the
pattern (how much the crosshatch pattern is visible). A low value means more
visible pattern for less banding, and higher value means less visible pattern
at the cost of more banding.
</p>
<p>The option must be an integer value in the range [0,5]. Default is <var>2</var>.
</p>
</dd>
<dt><samp>diff_mode</samp></dt>
<dd><p>If set, define the zone to process
</p>
<dl compact="compact">
<dt>&lsquo;<samp>rectangle</samp>&rsquo;</dt>
<dd><p>Only the changing rectangle will be reprocessed. This is similar to GIF
cropping/offsetting compression mechanism. This option can be useful for speed
if only a part of the image is changing, and has use cases such as limiting the
scope of the error diffusal <samp>dither</samp> to the rectangle that bounds the
moving scene (it leads to more deterministic output if the scene doesn&rsquo;t change
much, and as a result less moving noise and better GIF compression).
</p></dd>
</dl>
<p>Default is <var>none</var>.
</p>
</dd>
<dt><samp>new</samp></dt>
<dd><p>Take new palette for each output frame.
</p></dd>
</dl>
<a name="Examples-84"></a>
<h4 class="subsection">31.105.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-84" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-84" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use a palette (generated for example with <a href="#palettegen">palettegen</a>) to encode a GIF
using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
</pre></div>
</li></ul>
<a name="perspective"></a>
<h3 class="section">31.106 perspective<span class="pull-right"><a class="anchor hidden-xs" href="#perspective" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-perspective" aria-hidden="true">TOC</a></span></h3>
<p>Correct perspective of video not recorded perpendicular to the screen.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>x0</samp></dt>
<dt><samp>y0</samp></dt>
<dt><samp>x1</samp></dt>
<dt><samp>y1</samp></dt>
<dt><samp>x2</samp></dt>
<dt><samp>y2</samp></dt>
<dt><samp>x3</samp></dt>
<dt><samp>y3</samp></dt>
<dd><p>Set coordinates expression for top left, top right, bottom left and bottom right corners.
Default values are <code>0:0:W:0:0:H:W:H</code> with which perspective will remain unchanged.
If the <code>sense</code> option is set to <code>source</code>, then the specified points will be sent
to the corners of the destination. If the <code>sense</code> option is set to <code>destination</code>,
then the corners of the source will be sent to the specified coordinates.
</p>
<p>The expressions can use the following variables:
</p>
<dl compact="compact">
<dt><samp>W</samp></dt>
<dt><samp>H</samp></dt>
<dd><p>the width and height of video frame.
</p></dd>
<dt><samp>in</samp></dt>
<dd><p>Input frame count.
</p></dd>
<dt><samp>on</samp></dt>
<dd><p>Output frame count.
</p></dd>
</dl>
</dd>
<dt><samp>interpolation</samp></dt>
<dd><p>Set interpolation for perspective correction.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>linear</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cubic</samp>&rsquo;</dt>
</dl>
<p>Default value is &lsquo;<samp>linear</samp>&rsquo;.
</p>
</dd>
<dt><samp>sense</samp></dt>
<dd><p>Set interpretation of coordinate options.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>0, source</samp>&rsquo;</dt>
<dd>
<p>Send point in the source specified by the given coordinates to
the corners of the destination.
</p>
</dd>
<dt>&lsquo;<samp>1, destination</samp>&rsquo;</dt>
<dd>
<p>Send the corners of the source to the point in the destination specified
by the given coordinates.
</p>
<p>Default value is &lsquo;<samp>source</samp>&rsquo;.
</p></dd>
</dl>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Set when the expressions for coordinates <samp>x0,y0,...x3,y3</samp> are evaluated.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>init</samp>&rsquo;</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>init</samp>&rsquo;.
</p></dd>
</dl>
<a name="phase"></a>
<h3 class="section">31.107 phase<span class="pull-right"><a class="anchor hidden-xs" href="#phase" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-phase" aria-hidden="true">TOC</a></span></h3>
<p>Delay interlaced video by one field time so that the field order changes.
</p>
<p>The intended use is to fix PAL movies that have been captured with the
opposite field order to the film-to-video transfer.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Set phase mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>t</samp>&rsquo;</dt>
<dd><p>Capture field order top-first, transfer bottom-first.
Filter will delay the bottom field.
</p>
</dd>
<dt>&lsquo;<samp>b</samp>&rsquo;</dt>
<dd><p>Capture field order bottom-first, transfer top-first.
Filter will delay the top field.
</p>
</dd>
<dt>&lsquo;<samp>p</samp>&rsquo;</dt>
<dd><p>Capture and transfer with the same field order. This mode only exists
for the documentation of the other options to refer to, but if you
actually select it, the filter will faithfully do nothing.
</p>
</dd>
<dt>&lsquo;<samp>a</samp>&rsquo;</dt>
<dd><p>Capture field order determined automatically by field flags, transfer
opposite.
Filter selects among &lsquo;<samp>t</samp>&rsquo; and &lsquo;<samp>b</samp>&rsquo; modes on a frame by frame
basis using field flags. If no field information is available,
then this works just like &lsquo;<samp>u</samp>&rsquo;.
</p>
</dd>
<dt>&lsquo;<samp>u</samp>&rsquo;</dt>
<dd><p>Capture unknown or varying, transfer opposite.
Filter selects among &lsquo;<samp>t</samp>&rsquo; and &lsquo;<samp>b</samp>&rsquo; on a frame by frame basis by
analyzing the images and selecting the alternative that produces best
match between the fields.
</p>
</dd>
<dt>&lsquo;<samp>T</samp>&rsquo;</dt>
<dd><p>Capture top-first, transfer unknown or varying.
Filter selects among &lsquo;<samp>t</samp>&rsquo; and &lsquo;<samp>p</samp>&rsquo; using image analysis.
</p>
</dd>
<dt>&lsquo;<samp>B</samp>&rsquo;</dt>
<dd><p>Capture bottom-first, transfer unknown or varying.
Filter selects among &lsquo;<samp>b</samp>&rsquo; and &lsquo;<samp>p</samp>&rsquo; using image analysis.
</p>
</dd>
<dt>&lsquo;<samp>A</samp>&rsquo;</dt>
<dd><p>Capture determined by field flags, transfer unknown or varying.
Filter selects among &lsquo;<samp>t</samp>&rsquo;, &lsquo;<samp>b</samp>&rsquo; and &lsquo;<samp>p</samp>&rsquo; using field flags and
image analysis. If no field information is available, then this works just
like &lsquo;<samp>U</samp>&rsquo;. This is the default mode.
</p>
</dd>
<dt>&lsquo;<samp>U</samp>&rsquo;</dt>
<dd><p>Both capture and transfer unknown or varying.
Filter selects among &lsquo;<samp>t</samp>&rsquo;, &lsquo;<samp>b</samp>&rsquo; and &lsquo;<samp>p</samp>&rsquo; using image analysis only.
</p></dd>
</dl>
</dd>
</dl>
<a name="pixdesctest"></a>
<h3 class="section">31.108 pixdesctest<span class="pull-right"><a class="anchor hidden-xs" href="#pixdesctest" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pixdesctest" aria-hidden="true">TOC</a></span></h3>
<p>Pixel format descriptor test filter, mainly useful for internal
testing. The output video should be equal to the input video.
</p>
<p>For example:
</p><div class="example">
<pre class="example">format=monow, pixdesctest
</pre></div>
<p>can be used to test the monowhite pixel format descriptor definition.
</p>
<a name="pp"></a>
<h3 class="section">31.109 pp<span class="pull-right"><a class="anchor hidden-xs" href="#pp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pp" aria-hidden="true">TOC</a></span></h3>
<p>Enable the specified chain of postprocessing subfilters using libpostproc. This
library should be automatically selected with a GPL build (<code>--enable-gpl</code>).
Subfilters must be separated by &rsquo;/&rsquo; and can be disabled by prepending a &rsquo;-&rsquo;.
Each subfilter and some options have a short and a long name that can be used
interchangeably, i.e. dr/dering are the same.
</p>
<p>The filters accept the following options:
</p>
<dl compact="compact">
<dt><samp>subfilters</samp></dt>
<dd><p>Set postprocessing subfilters string.
</p></dd>
</dl>
<p>All subfilters share common options to determine their scope:
</p>
<dl compact="compact">
<dt><samp>a/autoq</samp></dt>
<dd><p>Honor the quality commands for this subfilter.
</p>
</dd>
<dt><samp>c/chrom</samp></dt>
<dd><p>Do chrominance filtering, too (default).
</p>
</dd>
<dt><samp>y/nochrom</samp></dt>
<dd><p>Do luminance filtering only (no chrominance).
</p>
</dd>
<dt><samp>n/noluma</samp></dt>
<dd><p>Do chrominance filtering only (no luminance).
</p></dd>
</dl>
<p>These options can be appended after the subfilter name, separated by a &rsquo;|&rsquo;.
</p>
<p>Available subfilters are:
</p>
<dl compact="compact">
<dt><samp>hb/hdeblock[|difference[|flatness]]</samp></dt>
<dd><p>Horizontal deblocking filter
</p><dl compact="compact">
<dt><samp>difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>).
</p></dd>
<dt><samp>flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>).
</p></dd>
</dl>
</dd>
<dt><samp>vb/vdeblock[|difference[|flatness]]</samp></dt>
<dd><p>Vertical deblocking filter
</p><dl compact="compact">
<dt><samp>difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>).
</p></dd>
<dt><samp>flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>).
</p></dd>
</dl>
</dd>
<dt><samp>ha/hadeblock[|difference[|flatness]]</samp></dt>
<dd><p>Accurate horizontal deblocking filter
</p><dl compact="compact">
<dt><samp>difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>).
</p></dd>
<dt><samp>flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>).
</p></dd>
</dl>
</dd>
<dt><samp>va/vadeblock[|difference[|flatness]]</samp></dt>
<dd><p>Accurate vertical deblocking filter
</p><dl compact="compact">
<dt><samp>difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>).
</p></dd>
<dt><samp>flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>).
</p></dd>
</dl>
</dd>
</dl>
<p>The horizontal and vertical deblocking filters share the difference and
flatness values so you cannot set different horizontal and vertical
thresholds.
</p>
<dl compact="compact">
<dt><samp>h1/x1hdeblock</samp></dt>
<dd><p>Experimental horizontal deblocking filter
</p>
</dd>
<dt><samp>v1/x1vdeblock</samp></dt>
<dd><p>Experimental vertical deblocking filter
</p>
</dd>
<dt><samp>dr/dering</samp></dt>
<dd><p>Deringing filter
</p>
</dd>
<dt><samp>tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer</samp></dt>
<dd><dl compact="compact">
<dt><samp>threshold1</samp></dt>
<dd><p>larger -&gt; stronger filtering
</p></dd>
<dt><samp>threshold2</samp></dt>
<dd><p>larger -&gt; stronger filtering
</p></dd>
<dt><samp>threshold3</samp></dt>
<dd><p>larger -&gt; stronger filtering
</p></dd>
</dl>
</dd>
<dt><samp>al/autolevels[:f/fullyrange], automatic brightness / contrast correction</samp></dt>
<dd><dl compact="compact">
<dt><samp>f/fullyrange</samp></dt>
<dd><p>Stretch luminance to <code>0-255</code>.
</p></dd>
</dl>
</dd>
<dt><samp>lb/linblenddeint</samp></dt>
<dd><p>Linear blend deinterlacing filter that deinterlaces the given block by
filtering all lines with a <code>(1 2 1)</code> filter.
</p>
</dd>
<dt><samp>li/linipoldeint</samp></dt>
<dd><p>Linear interpolating deinterlacing filter that deinterlaces the given block by
linearly interpolating every second line.
</p>
</dd>
<dt><samp>ci/cubicipoldeint</samp></dt>
<dd><p>Cubic interpolating deinterlacing filter deinterlaces the given block by
cubically interpolating every second line.
</p>
</dd>
<dt><samp>md/mediandeint</samp></dt>
<dd><p>Median deinterlacing filter that deinterlaces the given block by applying a
median filter to every second line.
</p>
</dd>
<dt><samp>fd/ffmpegdeint</samp></dt>
<dd><p>FFmpeg deinterlacing filter that deinterlaces the given block by filtering every
second line with a <code>(-1 4 2 4 -1)</code> filter.
</p>
</dd>
<dt><samp>l5/lowpass5</samp></dt>
<dd><p>Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given
block by filtering all lines with a <code>(-1 2 6 2 -1)</code> filter.
</p>
</dd>
<dt><samp>fq/forceQuant[|quantizer]</samp></dt>
<dd><p>Overrides the quantizer table from the input with the constant quantizer you
specify.
</p><dl compact="compact">
<dt><samp>quantizer</samp></dt>
<dd><p>Quantizer to use
</p></dd>
</dl>
</dd>
<dt><samp>de/default</samp></dt>
<dd><p>Default pp filter combination (<code>hb|a,vb|a,dr|a</code>)
</p>
</dd>
<dt><samp>fa/fast</samp></dt>
<dd><p>Fast pp filter combination (<code>h1|a,v1|a,dr|a</code>)
</p>
</dd>
<dt><samp>ac</samp></dt>
<dd><p>High quality pp filter combination (<code>ha|a|128|7,va|a,dr|a</code>)
</p></dd>
</dl>
<a name="Examples-85"></a>
<h4 class="subsection">31.109.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-85" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-85" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply horizontal and vertical deblocking, deringing and automatic
brightness/contrast:
<div class="example">
<pre class="example">pp=hb/vb/dr/al
</pre></div>
</li><li> Apply default filters without brightness/contrast correction:
<div class="example">
<pre class="example">pp=de/-al
</pre></div>
</li><li> Apply default filters and temporal denoiser:
<div class="example">
<pre class="example">pp=default/tmpnoise|1|2|3
</pre></div>
</li><li> Apply deblocking on luminance only, and switch vertical deblocking on or off
automatically depending on available CPU time:
<div class="example">
<pre class="example">pp=hb|y/vb|a
</pre></div>
</li></ul>
<a name="pp7"></a>
<h3 class="section">31.110 pp7<span class="pull-right"><a class="anchor hidden-xs" href="#pp7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pp7" aria-hidden="true">TOC</a></span></h3>
<p>Apply Postprocessing filter 7. It is variant of the <a href="#spp">spp</a> filter,
similar to spp = 6 with 7 point DCT, where only the center sample is
used after IDCT.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>qp</samp></dt>
<dd><p>Force a constant quantization parameter. It accepts an integer in range
0 to 63. If not set, the filter will use the QP from the video stream
(if available).
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set thresholding mode. Available modes are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>hard</samp>&rsquo;</dt>
<dd><p>Set hard thresholding.
</p></dd>
<dt>&lsquo;<samp>soft</samp>&rsquo;</dt>
<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier).
</p></dd>
<dt>&lsquo;<samp>medium</samp>&rsquo;</dt>
<dd><p>Set medium thresholding (good results, default).
</p></dd>
</dl>
</dd>
</dl>
<a name="prewitt"></a>
<h3 class="section">31.111 prewitt<span class="pull-right"><a class="anchor hidden-xs" href="#prewitt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-prewitt" aria-hidden="true">TOC</a></span></h3>
<p>Apply prewitt operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp>delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<a name="psnr"></a>
<h3 class="section">31.112 psnr<span class="pull-right"><a class="anchor hidden-xs" href="#psnr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-psnr" aria-hidden="true">TOC</a></span></h3>
<p>Obtain the average, maximum and minimum PSNR (Peak Signal to Noise
Ratio) between two input videos.
</p>
<p>This filter takes in input two input videos, the first input is
considered the &quot;main&quot; source and is passed unchanged to the
output. The second input is used as a &quot;reference&quot; video for computing
the PSNR.
</p>
<p>Both video inputs must have the same resolution and pixel format for
this filter to work correctly. Also it assumes that both inputs
have the same number of frames, which are compared one by one.
</p>
<p>The obtained average PSNR is printed through the logging system.
</p>
<p>The filter stores the accumulated MSE (mean squared error) of each
frame, and at the end of the processing it is averaged across all frames
equally, and the following formula is applied to obtain the PSNR:
</p>
<div class="example">
<pre class="example">PSNR = 10*log10(MAX^2/MSE)
</pre></div>
<p>Where MAX is the average of the maximum values of each component of the
image.
</p>
<p>The description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>stats_file, f</samp></dt>
<dd><p>If specified the filter will use the named file to save the PSNR of
each individual frame. When filename equals &quot;-&quot; the data is sent to
standard output.
</p>
</dd>
<dt><samp>stats_version</samp></dt>
<dd><p>Specifies which version of the stats file format to use. Details of
each format are written below.
Default value is 1.
</p>
</dd>
<dt><samp>stats_add_max</samp></dt>
<dd><p>Determines whether the max value is output to the stats log.
Default value is 0.
Requires stats_version &gt;= 2. If this is set and stats_version &lt; 2,
the filter will return an error.
</p></dd>
</dl>
<p>The file printed if <var>stats_file</var> is selected, contains a sequence of
key/value pairs of the form <var>key</var>:<var>value</var> for each compared
couple of frames.
</p>
<p>If a <var>stats_version</var> greater than 1 is specified, a header line precedes
the list of per-frame-pair stats, with key value pairs following the frame
format with the following parameters:
</p>
<dl compact="compact">
<dt><samp>psnr_log_version</samp></dt>
<dd><p>The version of the log file format. Will match <var>stats_version</var>.
</p>
</dd>
<dt><samp>fields</samp></dt>
<dd><p>A comma separated list of the per-frame-pair parameters included in
the log.
</p></dd>
</dl>
<p>A description of each shown per-frame-pair parameter follows:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>sequential number of the input frame, starting from 1
</p>
</dd>
<dt><samp>mse_avg</samp></dt>
<dd><p>Mean Square Error pixel-by-pixel average difference of the compared
frames, averaged over all the image components.
</p>
</dd>
<dt><samp>mse_y, mse_u, mse_v, mse_r, mse_g, mse_g, mse_a</samp></dt>
<dd><p>Mean Square Error pixel-by-pixel average difference of the compared
frames for the component specified by the suffix.
</p>
</dd>
<dt><samp>psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a</samp></dt>
<dd><p>Peak Signal to Noise ratio of the compared frames for the component
specified by the suffix.
</p>
</dd>
<dt><samp>max_avg, max_y, max_u, max_v</samp></dt>
<dd><p>Maximum allowed value for each channel, and average over all
channels.
</p></dd>
</dl>
<p>For example:
</p><div class="example">
<pre class="example">movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
[main][ref] psnr=&quot;stats_file=stats.log&quot; [out]
</pre></div>
<p>On this example the input file being processed is compared with the
reference file <samp>ref_movie.mpg</samp>. The PSNR of each individual frame
is stored in <samp>stats.log</samp>.
</p>
<a name="pullup"></a><a name="pullup-1"></a>
<h3 class="section">31.113 pullup<span class="pull-right"><a class="anchor hidden-xs" href="#pullup-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pullup-1" aria-hidden="true">TOC</a></span></h3>
<p>Pulldown reversal (inverse telecine) filter, capable of handling mixed
hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive
content.
</p>
<p>The pullup filter is designed to take advantage of future context in making
its decisions. This filter is stateless in the sense that it does not lock
onto a pattern to follow, but it instead looks forward to the following
fields in order to identify matches and rebuild progressive frames.
</p>
<p>To produce content with an even framerate, insert the fps filter after
pullup, use <code>fps=24000/1001</code> if the input frame rate is 29.97fps,
<code>fps=24</code> for 30fps and the (rare) telecined 25fps input.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>jl</samp></dt>
<dt><samp>jr</samp></dt>
<dt><samp>jt</samp></dt>
<dt><samp>jb</samp></dt>
<dd><p>These options set the amount of &quot;junk&quot; to ignore at the left, right, top, and
bottom of the image, respectively. Left and right are in units of 8 pixels,
while top and bottom are in units of 2 lines.
The default is 8 pixels on each side.
</p>
</dd>
<dt><samp>sb</samp></dt>
<dd><p>Set the strict breaks. Setting this option to 1 will reduce the chances of
filter generating an occasional mismatched frame, but it may also cause an
excessive number of frames to be dropped during high motion sequences.
Conversely, setting it to -1 will make filter match fields more easily.
This may help processing of video where there is slight blurring between
the fields, but may also cause there to be interlaced frames in the output.
Default value is <code>0</code>.
</p>
</dd>
<dt><samp>mp</samp></dt>
<dd><p>Set the metric plane to use. It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>l</samp>&rsquo;</dt>
<dd><p>Use luma plane.
</p>
</dd>
<dt>&lsquo;<samp>u</samp>&rsquo;</dt>
<dd><p>Use chroma blue plane.
</p>
</dd>
<dt>&lsquo;<samp>v</samp>&rsquo;</dt>
<dd><p>Use chroma red plane.
</p></dd>
</dl>
<p>This option may be set to use chroma plane instead of the default luma plane
for doing filter&rsquo;s computations. This may improve accuracy on very clean
source material, but more likely will decrease accuracy, especially if there
is chroma noise (rainbow effect) or any grayscale video.
The main purpose of setting <samp>mp</samp> to a chroma plane is to reduce CPU
load and make pullup usable in realtime on slow machines.
</p></dd>
</dl>
<p>For best results (without duplicated frames in the output file) it is
necessary to change the output frame rate. For example, to inverse
telecine NTSC input:
</p><div class="example">
<pre class="example">ffmpeg -i input -vf pullup -r 24000/1001 ...
</pre></div>
<a name="qp"></a>
<h3 class="section">31.114 qp<span class="pull-right"><a class="anchor hidden-xs" href="#qp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-qp" aria-hidden="true">TOC</a></span></h3>
<p>Change video quantization parameters (QP).
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>qp</samp></dt>
<dd><p>Set expression for quantization parameter.
</p></dd>
</dl>
<p>The expression is evaluated through the eval API and can contain, among others,
the following constants:
</p>
<dl compact="compact">
<dt><var>known</var></dt>
<dd><p>1 if index is not 129, 0 otherwise.
</p>
</dd>
<dt><var>qp</var></dt>
<dd><p>Sequentional index starting from -129 to 128.
</p></dd>
</dl>
<a name="Examples-86"></a>
<h4 class="subsection">31.114.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-86" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-86" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Some equation like:
<div class="example">
<pre class="example">qp=2+2*sin(PI*qp)
</pre></div>
</li></ul>
<a name="random"></a>
<h3 class="section">31.115 random<span class="pull-right"><a class="anchor hidden-xs" href="#random" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-random" aria-hidden="true">TOC</a></span></h3>
<p>Flush video frames from internal cache of frames into a random order.
No frame is discarded.
Inspired by <a href="#frei0r">frei0r</a> nervous filter.
</p>
<dl compact="compact">
<dt><samp>frames</samp></dt>
<dd><p>Set size in number of frames of internal cache, in range from <code>2</code> to
<code>512</code>. Default is <code>30</code>.
</p>
</dd>
<dt><samp>seed</samp></dt>
<dd><p>Set seed for random number generator, must be an integer included between
<code>0</code> and <code>UINT32_MAX</code>. If not specified, or if explicitly set to
less than <code>0</code>, the filter will try to use a good random seed on a
best effort basis.
</p></dd>
</dl>
<a name="readvitc"></a>
<h3 class="section">31.116 readvitc<span class="pull-right"><a class="anchor hidden-xs" href="#readvitc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-readvitc" aria-hidden="true">TOC</a></span></h3>
<p>Read vertical interval timecode (VITC) information from the top lines of a
video frame.
</p>
<p>The filter adds frame metadata key <code>lavfi.readvitc.tc_str</code> with the
timecode value, if a valid timecode has been detected. Further metadata key
<code>lavfi.readvitc.found</code> is set to 0/1 depending on whether
timecode data has been found or not.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>scan_max</samp></dt>
<dd><p>Set the maximum number of lines to scan for VITC data. If the value is set to
<code>-1</code> the full video frame is scanned. Default is <code>45</code>.
</p>
</dd>
<dt><samp>thr_b</samp></dt>
<dd><p>Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0],
default value is <code>0.2</code>. The value must be equal or less than <code>thr_w</code>.
</p>
</dd>
<dt><samp>thr_w</samp></dt>
<dd><p>Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0],
default value is <code>0.6</code>. The value must be equal or greater than <code>thr_b</code>.
</p></dd>
</dl>
<a name="Examples-87"></a>
<h4 class="subsection">31.116.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-87" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-87" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Detect and draw VITC data onto the video frame; if no valid VITC is detected,
draw <code>--:--:--:--</code> as a placeholder:
<div class="example">
<pre class="example">ffmpeg -i input.avi -filter:v 'readvitc,drawtext=fontfile=FreeMono.ttf:text=%{metadata\\:lavfi.readvitc.tc_str\\:--\\\\\\:--\\\\\\:--\\\\\\:--}:x=(w-tw)/2:y=400-ascent'
</pre></div>
</li></ul>
<a name="remap"></a>
<h3 class="section">31.117 remap<span class="pull-right"><a class="anchor hidden-xs" href="#remap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-remap" aria-hidden="true">TOC</a></span></h3>
<p>Remap pixels using 2nd: Xmap and 3rd: Ymap input video stream.
</p>
<p>Destination pixel at position (X, Y) will be picked from source (x, y) position
where x = Xmap(X, Y) and y = Ymap(X, Y). If mapping values are out of range, zero
value for pixel will be used for destination pixel.
</p>
<p>Xmap and Ymap input video streams must be of same dimensions. Output video stream
will have Xmap/Ymap video stream dimensions.
Xmap and Ymap input video streams are 16bit depth, single channel.
</p>
<a name="removegrain"></a>
<h3 class="section">31.118 removegrain<span class="pull-right"><a class="anchor hidden-xs" href="#removegrain" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-removegrain" aria-hidden="true">TOC</a></span></h3>
<p>The removegrain filter is a spatial denoiser for progressive video.
</p>
<dl compact="compact">
<dt><samp>m0</samp></dt>
<dd><p>Set mode for the first plane.
</p>
</dd>
<dt><samp>m1</samp></dt>
<dd><p>Set mode for the second plane.
</p>
</dd>
<dt><samp>m2</samp></dt>
<dd><p>Set mode for the third plane.
</p>
</dd>
<dt><samp>m3</samp></dt>
<dd><p>Set mode for the fourth plane.
</p></dd>
</dl>
<p>Range of mode is from 0 to 24. Description of each mode follows:
</p>
<dl compact="compact">
<dt><var>0</var></dt>
<dd><p>Leave input plane unchanged. Default.
</p>
</dd>
<dt><var>1</var></dt>
<dd><p>Clips the pixel with the minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var>2</var></dt>
<dd><p>Clips the pixel with the second minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var>3</var></dt>
<dd><p>Clips the pixel with the third minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var>4</var></dt>
<dd><p>Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels.
This is equivalent to a median filter.
</p>
</dd>
<dt><var>5</var></dt>
<dd><p>Line-sensitive clipping giving the minimal change.
</p>
</dd>
<dt><var>6</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var>7</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var>8</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var>9</var></dt>
<dd><p>Line-sensitive clipping on a line where the neighbours pixels are the closest.
</p>
</dd>
<dt><var>10</var></dt>
<dd><p>Replaces the target pixel with the closest neighbour.
</p>
</dd>
<dt><var>11</var></dt>
<dd><p>[1 2 1] horizontal and vertical kernel blur.
</p>
</dd>
<dt><var>12</var></dt>
<dd><p>Same as mode 11.
</p>
</dd>
<dt><var>13</var></dt>
<dd><p>Bob mode, interpolates top field from the line where the neighbours
pixels are the closest.
</p>
</dd>
<dt><var>14</var></dt>
<dd><p>Bob mode, interpolates bottom field from the line where the neighbours
pixels are the closest.
</p>
</dd>
<dt><var>15</var></dt>
<dd><p>Bob mode, interpolates top field. Same as 13 but with a more complicated
interpolation formula.
</p>
</dd>
<dt><var>16</var></dt>
<dd><p>Bob mode, interpolates bottom field. Same as 14 but with a more complicated
interpolation formula.
</p>
</dd>
<dt><var>17</var></dt>
<dd><p>Clips the pixel with the minimum and maximum of respectively the maximum and
minimum of each pair of opposite neighbour pixels.
</p>
</dd>
<dt><var>18</var></dt>
<dd><p>Line-sensitive clipping using opposite neighbours whose greatest distance from
the current pixel is minimal.
</p>
</dd>
<dt><var>19</var></dt>
<dd><p>Replaces the pixel with the average of its 8 neighbours.
</p>
</dd>
<dt><var>20</var></dt>
<dd><p>Averages the 9 pixels ([1 1 1] horizontal and vertical blur).
</p>
</dd>
<dt><var>21</var></dt>
<dd><p>Clips pixels using the averages of opposite neighbour.
</p>
</dd>
<dt><var>22</var></dt>
<dd><p>Same as mode 21 but simpler and faster.
</p>
</dd>
<dt><var>23</var></dt>
<dd><p>Small edge and halo removal, but reputed useless.
</p>
</dd>
<dt><var>24</var></dt>
<dd><p>Similar as 23.
</p></dd>
</dl>
<a name="removelogo"></a>
<h3 class="section">31.119 removelogo<span class="pull-right"><a class="anchor hidden-xs" href="#removelogo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-removelogo" aria-hidden="true">TOC</a></span></h3>
<p>Suppress a TV station logo, using an image file to determine which
pixels comprise the logo. It works by filling in the pixels that
comprise the logo with neighboring pixels.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>filename, f</samp></dt>
<dd><p>Set the filter bitmap file, which can be any image format supported by
libavformat. The width and height of the image file must match those of the
video stream being processed.
</p></dd>
</dl>
<p>Pixels in the provided bitmap image with a value of zero are not
considered part of the logo, non-zero pixels are considered part of
the logo. If you use white (255) for the logo and black (0) for the
rest, you will be safe. For making the filter bitmap, it is
recommended to take a screen capture of a black frame with the logo
visible, and then using a threshold filter followed by the erode
filter once or twice.
</p>
<p>If needed, little splotches can be fixed manually. Remember that if
logo pixels are not covered, the filter quality will be much
reduced. Marking too many pixels as part of the logo does not hurt as
much, but it will increase the amount of blurring needed to cover over
the image and will destroy more information than necessary, and extra
pixels will slow things down on a large logo.
</p>
<a name="repeatfields"></a>
<h3 class="section">31.120 repeatfields<span class="pull-right"><a class="anchor hidden-xs" href="#repeatfields" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-repeatfields" aria-hidden="true">TOC</a></span></h3>
<p>This filter uses the repeat_field flag from the Video ES headers and hard repeats
fields based on its value.
</p>
<a name="reverse"></a>
<h3 class="section">31.121 reverse<span class="pull-right"><a class="anchor hidden-xs" href="#reverse" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-reverse" aria-hidden="true">TOC</a></span></h3>
<p>Reverse a video clip.
</p>
<p>Warning: This filter requires memory to buffer the entire clip, so trimming
is suggested.
</p>
<a name="Examples-88"></a>
<h4 class="subsection">31.121.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-88" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-88" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Take the first 5 seconds of a clip, and reverse it.
<div class="example">
<pre class="example">trim=end=5,reverse
</pre></div>
</li></ul>
<a name="rotate"></a>
<h3 class="section">31.122 rotate<span class="pull-right"><a class="anchor hidden-xs" href="#rotate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rotate" aria-hidden="true">TOC</a></span></h3>
<p>Rotate video by an arbitrary angle expressed in radians.
</p>
<p>The filter accepts the following options:
</p>
<p>A description of the optional parameters follows.
</p><dl compact="compact">
<dt><samp>angle, a</samp></dt>
<dd><p>Set an expression for the angle by which to rotate the input video
clockwise, expressed as a number of radians. A negative value will
result in a counter-clockwise rotation. By default it is set to &quot;0&quot;.
</p>
<p>This expression is evaluated for each frame.
</p>
</dd>
<dt><samp>out_w, ow</samp></dt>
<dd><p>Set the output width expression, default value is &quot;iw&quot;.
This expression is evaluated just once during configuration.
</p>
</dd>
<dt><samp>out_h, oh</samp></dt>
<dd><p>Set the output height expression, default value is &quot;ih&quot;.
This expression is evaluated just once during configuration.
</p>
</dd>
<dt><samp>bilinear</samp></dt>
<dd><p>Enable bilinear interpolation if set to 1, a value of 0 disables
it. Default value is 1.
</p>
</dd>
<dt><samp>fillcolor, c</samp></dt>
<dd><p>Set the color used to fill the output area not covered by the rotated
image. For the general syntax of this option, check the &quot;Color&quot; section in the
ffmpeg-utils manual. If the special value &quot;none&quot; is selected then no
background is printed (useful for example if the background is never shown).
</p>
<p>Default value is &quot;black&quot;.
</p></dd>
</dl>
<p>The expressions for the angle and the output size can contain the
following constants and functions:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>sequential number of the input frame, starting from 0. It is always NAN
before the first frame is filtered.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>time in seconds of the input frame, it is set to 0 when the filter is
configured. It is always NAN before the first frame is filtered.
</p>
</dd>
<dt><samp>hsub</samp></dt>
<dt><samp>vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><samp>in_w, iw</samp></dt>
<dt><samp>in_h, ih</samp></dt>
<dd><p>the input video width and height
</p>
</dd>
<dt><samp>out_w, ow</samp></dt>
<dt><samp>out_h, oh</samp></dt>
<dd><p>the output width and height, that is the size of the padded area as
specified by the <var>width</var> and <var>height</var> expressions
</p>
</dd>
<dt><samp>rotw(a)</samp></dt>
<dt><samp>roth(a)</samp></dt>
<dd><p>the minimal width/height required for completely containing the input
video rotated by <var>a</var> radians.
</p>
<p>These are only available when computing the <samp>out_w</samp> and
<samp>out_h</samp> expressions.
</p></dd>
</dl>
<a name="Examples-89"></a>
<h4 class="subsection">31.122.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-89" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-89" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Rotate the input by PI/6 radians clockwise:
<div class="example">
<pre class="example">rotate=PI/6
</pre></div>
</li><li> Rotate the input by PI/6 radians counter-clockwise:
<div class="example">
<pre class="example">rotate=-PI/6
</pre></div>
</li><li> Rotate the input by 45 degrees clockwise:
<div class="example">
<pre class="example">rotate=45*PI/180
</pre></div>
</li><li> Apply a constant rotation with period T, starting from an angle of PI/3:
<div class="example">
<pre class="example">rotate=PI/3+2*PI*t/T
</pre></div>
</li><li> Make the input video rotation oscillating with a period of T
seconds and an amplitude of A radians:
<div class="example">
<pre class="example">rotate=A*sin(2*PI/T*t)
</pre></div>
</li><li> Rotate the video, output size is chosen so that the whole rotating
input video is always completely contained in the output:
<div class="example">
<pre class="example">rotate='2*PI*t:ow=hypot(iw,ih):oh=ow'
</pre></div>
</li><li> Rotate the video, reduce the output size so that no background is ever
shown:
<div class="example">
<pre class="example">rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
</pre></div>
</li></ul>
<a name="Commands-7"></a>
<h4 class="subsection">31.122.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-7" aria-hidden="true">TOC</a></span></h4>
<p>The filter supports the following commands:
</p>
<dl compact="compact">
<dt><samp>a, angle</samp></dt>
<dd><p>Set the angle expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a name="sab"></a>
<h3 class="section">31.123 sab<span class="pull-right"><a class="anchor hidden-xs" href="#sab" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sab" aria-hidden="true">TOC</a></span></h3>
<p>Apply Shape Adaptive Blur.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>luma_radius, lr</samp></dt>
<dd><p>Set luma blur filter strength, must be a value in range 0.1-4.0, default
value is 1.0. A greater value will result in a more blurred image, and
in slower processing.
</p>
</dd>
<dt><samp>luma_pre_filter_radius, lpfr</samp></dt>
<dd><p>Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default
value is 1.0.
</p>
</dd>
<dt><samp>luma_strength, ls</samp></dt>
<dd><p>Set luma maximum difference between pixels to still be considered, must
be a value in the 0.1-100.0 range, default value is 1.0.
</p>
</dd>
<dt><samp>chroma_radius, cr</samp></dt>
<dd><p>Set chroma blur filter strength, must be a value in range -0.9-4.0. A
greater value will result in a more blurred image, and in slower
processing.
</p>
</dd>
<dt><samp>chroma_pre_filter_radius, cpfr</samp></dt>
<dd><p>Set chroma pre-filter radius, must be a value in the -0.9-2.0 range.
</p>
</dd>
<dt><samp>chroma_strength, cs</samp></dt>
<dd><p>Set chroma maximum difference between pixels to still be considered,
must be a value in the -0.9-100.0 range.
</p></dd>
</dl>
<p>Each chroma option value, if not explicitly specified, is set to the
corresponding luma option value.
</p>
<a name="scale"></a><a name="scale-1"></a>
<h3 class="section">31.124 scale<span class="pull-right"><a class="anchor hidden-xs" href="#scale-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale-1" aria-hidden="true">TOC</a></span></h3>
<p>Scale (resize) the input video, using the libswscale library.
</p>
<p>The scale filter forces the output display aspect ratio to be the same
of the input, by changing the output sample aspect ratio.
</p>
<p>If the input image format is different from the format requested by
the next filter, the scale filter will convert the input to the
requested format.
</p>
<a name="Options-28"></a>
<h4 class="subsection">31.124.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-28" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-28" aria-hidden="true">TOC</a></span></h4>
<p>The filter accepts the following options, or any of the options
supported by the libswscale scaler.
</p>
<p>See <a href="ffmpeg-scaler.html#scaler_005foptions">(ffmpeg-scaler)the ffmpeg-scaler manual</a> for
the complete list of scaler options.
</p>
<dl compact="compact">
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>Set the output video dimension expression. Default value is the input
dimension.
</p>
<p>If the value is 0, the input width is used for the output.
</p>
<p>If one of the values is -1, the scale filter will use a value that
maintains the aspect ratio of the input image, calculated from the
other specified dimension. If both of them are -1, the input size is
used
</p>
<p>If one of the values is -n with n &gt; 1, the scale filter will also use a value
that maintains the aspect ratio of the input image, calculated from the other
specified dimension. After that it will, however, make sure that the calculated
dimension is divisible by n and adjust the value if necessary.
</p>
<p>See below for the list of accepted constants for use in the dimension
expression.
</p>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Specify when to evaluate <var>width</var> and <var>height</var> expression. It accepts the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>init</samp>&rsquo;</dt>
<dd><p>Only evaluate expressions once during the filter initialization or when a command is processed.
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>Evaluate expressions for each incoming frame.
</p>
</dd>
</dl>
<p>Default value is &lsquo;<samp>init</samp>&rsquo;.
</p>
</dd>
<dt><samp>interl</samp></dt>
<dd><p>Set the interlacing mode. It accepts the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>1</samp>&rsquo;</dt>
<dd><p>Force interlaced aware scaling.
</p>
</dd>
<dt>&lsquo;<samp>0</samp>&rsquo;</dt>
<dd><p>Do not apply interlaced scaling.
</p>
</dd>
<dt>&lsquo;<samp>-1</samp>&rsquo;</dt>
<dd><p>Select interlaced aware scaling depending on whether the source frames
are flagged as interlaced or not.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>0</samp>&rsquo;.
</p>
</dd>
<dt><samp>flags</samp></dt>
<dd><p>Set libswscale scaling flags. See
<a href="ffmpeg-scaler.html#sws_005fflags">(ffmpeg-scaler)the ffmpeg-scaler manual</a> for the
complete list of values. If not explicitly specified the filter applies
the default flags.
</p>
</dd>
<dt><samp>param0, param1</samp></dt>
<dd><p>Set libswscale input parameters for scaling algorithms that need them. See
<a href="ffmpeg-scaler.html#sws_005fparams">(ffmpeg-scaler)the ffmpeg-scaler manual</a> for the
complete documentation. If not explicitly specified the filter applies
empty parameters.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the video size. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>in_color_matrix</samp></dt>
<dt><samp>out_color_matrix</samp></dt>
<dd><p>Set in/output YCbCr color space type.
</p>
<p>This allows the autodetected value to be overridden as well as allows forcing
a specific value used for the output and encoder.
</p>
<p>If not specified, the color space type depends on the pixel format.
</p>
<p>Possible values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>Choose automatically.
</p>
</dd>
<dt>&lsquo;<samp>bt709</samp>&rsquo;</dt>
<dd><p>Format conforming to International Telecommunication Union (ITU)
Recommendation BT.709.
</p>
</dd>
<dt>&lsquo;<samp>fcc</samp>&rsquo;</dt>
<dd><p>Set color space conforming to the United States Federal Communications
Commission (FCC) Code of Federal Regulations (CFR) Title 47 (2003) 73.682 (a).
</p>
</dd>
<dt>&lsquo;<samp>bt601</samp>&rsquo;</dt>
<dd><p>Set color space conforming to:
</p>
<ul>
<li> ITU Radiocommunication Sector (ITU-R) Recommendation BT.601
</li><li> ITU-R Rec. BT.470-6 (1998) Systems B, B1, and G
</li><li> Society of Motion Picture and Television Engineers (SMPTE) ST 170:2004
</li></ul>
</dd>
<dt>&lsquo;<samp>smpte240m</samp>&rsquo;</dt>
<dd><p>Set color space conforming to SMPTE ST 240:1999.
</p></dd>
</dl>
</dd>
<dt><samp>in_range</samp></dt>
<dt><samp>out_range</samp></dt>
<dd><p>Set in/output YCbCr sample range.
</p>
<p>This allows the autodetected value to be overridden as well as allows forcing
a specific value used for the output and encoder. If not specified, the
range depends on the pixel format. Possible values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>Choose automatically.
</p>
</dd>
<dt>&lsquo;<samp>jpeg/full/pc</samp>&rsquo;</dt>
<dd><p>Set full range (0-255 in case of 8-bit luma).
</p>
</dd>
<dt>&lsquo;<samp>mpeg/tv</samp>&rsquo;</dt>
<dd><p>Set &quot;MPEG&quot; range (16-235 in case of 8-bit luma).
</p></dd>
</dl>
</dd>
<dt><samp>force_original_aspect_ratio</samp></dt>
<dd><p>Enable decreasing or increasing output video width or height if necessary to
keep the original aspect ratio. Possible values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>disable</samp>&rsquo;</dt>
<dd><p>Scale the video as specified and disable this feature.
</p>
</dd>
<dt>&lsquo;<samp>decrease</samp>&rsquo;</dt>
<dd><p>The output video dimensions will automatically be decreased if needed.
</p>
</dd>
<dt>&lsquo;<samp>increase</samp>&rsquo;</dt>
<dd><p>The output video dimensions will automatically be increased if needed.
</p>
</dd>
</dl>
<p>One useful instance of this option is that when you know a specific device&rsquo;s
maximum allowed resolution, you can use this to limit the output video to
that, while retaining the aspect ratio. For example, device A allows
1280x720 playback, and your video is 1920x800. Using this option (set it to
decrease) and specifying 1280x720 to the command line makes the output
1280x533.
</p>
<p>Please note that this is a different thing than specifying -1 for <samp>w</samp>
or <samp>h</samp>, you still need to specify the output resolution for this option
to work.
</p>
</dd>
</dl>
<p>The values of the <samp>w</samp> and <samp>h</samp> options are expressions
containing the following constants:
</p>
<dl compact="compact">
<dt><var>in_w</var></dt>
<dt><var>in_h</var></dt>
<dd><p>The input width and height
</p>
</dd>
<dt><var>iw</var></dt>
<dt><var>ih</var></dt>
<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>.
</p>
</dd>
<dt><var>out_w</var></dt>
<dt><var>out_h</var></dt>
<dd><p>The output (scaled) width and height
</p>
</dd>
<dt><var>ow</var></dt>
<dt><var>oh</var></dt>
<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>
</p>
</dd>
<dt><var>a</var></dt>
<dd><p>The same as <var>iw</var> / <var>ih</var>
</p>
</dd>
<dt><var>sar</var></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><var>dar</var></dt>
<dd><p>The input display aspect ratio. Calculated from <code>(iw / ih) * sar</code>.
</p>
</dd>
<dt><var>hsub</var></dt>
<dt><var>vsub</var></dt>
<dd><p>horizontal and vertical input chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><var>ohsub</var></dt>
<dt><var>ovsub</var></dt>
<dd><p>horizontal and vertical output chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p></dd>
</dl>
<a name="Examples-90"></a>
<h4 class="subsection">31.124.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-90" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-90" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Scale the input video to a size of 200x100
<div class="example">
<pre class="example">scale=w=200:h=100
</pre></div>
<p>This is equivalent to:
</p><div class="example">
<pre class="example">scale=200:100
</pre></div>
<p>or:
</p><div class="example">
<pre class="example">scale=200x100
</pre></div>
</li><li> Specify a size abbreviation for the output size:
<div class="example">
<pre class="example">scale=qcif
</pre></div>
<p>which can also be written as:
</p><div class="example">
<pre class="example">scale=size=qcif
</pre></div>
</li><li> Scale the input to 2x:
<div class="example">
<pre class="example">scale=w=2*iw:h=2*ih
</pre></div>
</li><li> The above is the same as:
<div class="example">
<pre class="example">scale=2*in_w:2*in_h
</pre></div>
</li><li> Scale the input to 2x with forced interlaced scaling:
<div class="example">
<pre class="example">scale=2*iw:2*ih:interl=1
</pre></div>
</li><li> Scale the input to half size:
<div class="example">
<pre class="example">scale=w=iw/2:h=ih/2
</pre></div>
</li><li> Increase the width, and set the height to the same size:
<div class="example">
<pre class="example">scale=3/2*iw:ow
</pre></div>
</li><li> Seek Greek harmony:
<div class="example">
<pre class="example">scale=iw:1/PHI*iw
scale=ih*PHI:ih
</pre></div>
</li><li> Increase the height, and set the width to 3/2 of the height:
<div class="example">
<pre class="example">scale=w=3/2*oh:h=3/5*ih
</pre></div>
</li><li> Increase the size, making the size a multiple of the chroma
subsample values:
<div class="example">
<pre class="example">scale=&quot;trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub&quot;
</pre></div>
</li><li> Increase the width to a maximum of 500 pixels,
keeping the same aspect ratio as the input:
<div class="example">
<pre class="example">scale=w='min(500\, iw*3/2):h=-1'
</pre></div>
</li></ul>
<a name="Commands-8"></a>
<h4 class="subsection">31.124.3 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-8" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-8" aria-hidden="true">TOC</a></span></h4>
<p>This filter supports the following commands:
</p><dl compact="compact">
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>Set the output video dimension expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a name="scale_005fnpp"></a>
<h3 class="section">31.125 scale_npp<span class="pull-right"><a class="anchor hidden-xs" href="#scale_005fnpp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale_005fnpp" aria-hidden="true">TOC</a></span></h3>
<p>Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel
format conversion on CUDA video frames. Setting the output width and height
works in the same way as for the <var>scale</var> filter.
</p>
<p>The following additional options are accepted:
</p><dl compact="compact">
<dt><samp>format</samp></dt>
<dd><p>The pixel format of the output CUDA frames. If set to the string &quot;same&quot; (the
default), the input format will be kept. Note that automatic format negotiation
and conversion is not yet supported for hardware frames
</p>
</dd>
<dt><samp>interp_algo</samp></dt>
<dd><p>The interpolation algorithm used for resizing. One of the following:
</p><dl compact="compact">
<dt><samp>nn</samp></dt>
<dd><p>Nearest neighbour.
</p>
</dd>
<dt><samp>linear</samp></dt>
<dt><samp>cubic</samp></dt>
<dt><samp>cubic2p_bspline</samp></dt>
<dd><p>2-parameter cubic (B=1, C=0)
</p>
</dd>
<dt><samp>cubic2p_catmullrom</samp></dt>
<dd><p>2-parameter cubic (B=0, C=1/2)
</p>
</dd>
<dt><samp>cubic2p_b05c03</samp></dt>
<dd><p>2-parameter cubic (B=1/2, C=3/10)
</p>
</dd>
<dt><samp>super</samp></dt>
<dd><p>Supersampling
</p>
</dd>
<dt><samp>lanczos</samp></dt>
</dl>
</dd>
</dl>
<a name="scale2ref"></a>
<h3 class="section">31.126 scale2ref<span class="pull-right"><a class="anchor hidden-xs" href="#scale2ref" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale2ref" aria-hidden="true">TOC</a></span></h3>
<p>Scale (resize) the input video, based on a reference video.
</p>
<p>See the scale filter for available options, scale2ref supports the same but
uses the reference video instead of the main input as basis.
</p>
<a name="Examples-91"></a>
<h4 class="subsection">31.126.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-91" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-91" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Scale a subtitle stream to match the main video in size before overlaying
<div class="example">
<pre class="example">'scale2ref[b][a];[a][b]overlay'
</pre></div>
</li></ul>
<a name="selectivecolor"></a><a name="selectivecolor-1"></a>
<h3 class="section">31.127 selectivecolor<span class="pull-right"><a class="anchor hidden-xs" href="#selectivecolor-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-selectivecolor-1" aria-hidden="true">TOC</a></span></h3>
<p>Adjust cyan, magenta, yellow and black (CMYK) to certain ranges of colors (such
as &quot;reds&quot;, &quot;yellows&quot;, &quot;greens&quot;, &quot;cyans&quot;, ...). The adjustment range is defined
by the &quot;purity&quot; of the color (that is, how saturated it already is).
</p>
<p>This filter is similar to the Adobe Photoshop Selective Color tool.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>correction_method</samp></dt>
<dd><p>Select color correction method.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>absolute</samp>&rsquo;</dt>
<dd><p>Specified adjustments are applied &quot;as-is&quot; (added/subtracted to original pixel
component value).
</p></dd>
<dt>&lsquo;<samp>relative</samp>&rsquo;</dt>
<dd><p>Specified adjustments are relative to the original component value.
</p></dd>
</dl>
<p>Default is <code>absolute</code>.
</p></dd>
<dt><samp>reds</samp></dt>
<dd><p>Adjustments for red pixels (pixels where the red component is the maximum)
</p></dd>
<dt><samp>yellows</samp></dt>
<dd><p>Adjustments for yellow pixels (pixels where the blue component is the minimum)
</p></dd>
<dt><samp>greens</samp></dt>
<dd><p>Adjustments for green pixels (pixels where the green component is the maximum)
</p></dd>
<dt><samp>cyans</samp></dt>
<dd><p>Adjustments for cyan pixels (pixels where the red component is the minimum)
</p></dd>
<dt><samp>blues</samp></dt>
<dd><p>Adjustments for blue pixels (pixels where the blue component is the maximum)
</p></dd>
<dt><samp>magentas</samp></dt>
<dd><p>Adjustments for magenta pixels (pixels where the green component is the minimum)
</p></dd>
<dt><samp>whites</samp></dt>
<dd><p>Adjustments for white pixels (pixels where all components are greater than 128)
</p></dd>
<dt><samp>neutrals</samp></dt>
<dd><p>Adjustments for all pixels except pure black and pure white
</p></dd>
<dt><samp>blacks</samp></dt>
<dd><p>Adjustments for black pixels (pixels where all components are lesser than 128)
</p></dd>
<dt><samp>psfile</samp></dt>
<dd><p>Specify a Photoshop selective color file (<code>.asv</code>) to import the settings from.
</p></dd>
</dl>
<p>All the adjustment settings (<samp>reds</samp>, <samp>yellows</samp>, ...) accept up to
4 space separated floating point adjustment values in the [-1,1] range,
respectively to adjust the amount of cyan, magenta, yellow and black for the
pixels of its range.
</p>
<a name="Examples-92"></a>
<h4 class="subsection">31.127.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-92" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-92" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Increase cyan by 50% and reduce yellow by 33% in every green areas, and
increase magenta by 27% in blue areas:
<div class="example">
<pre class="example">selectivecolor=greens=.5 0 -.33 0:blues=0 .27
</pre></div>
</li><li> Use a Photoshop selective color preset:
<div class="example">
<pre class="example">selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
</pre></div>
</li></ul>
<a name="separatefields"></a><a name="separatefields-1"></a>
<h3 class="section">31.128 separatefields<span class="pull-right"><a class="anchor hidden-xs" href="#separatefields-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-separatefields-1" aria-hidden="true">TOC</a></span></h3>
<p>The <code>separatefields</code> takes a frame-based video input and splits
each frame into its components fields, producing a new half height clip
with twice the frame rate and twice the frame count.
</p>
<p>This filter use field-dominance information in frame to decide which
of each pair of fields to place first in the output.
If it gets it wrong use <a href="#setfield">setfield</a> filter before <code>separatefields</code> filter.
</p>
<a name="setdar_002c-setsar"></a>
<h3 class="section">31.129 setdar, setsar<span class="pull-right"><a class="anchor hidden-xs" href="#setdar_002c-setsar" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-setdar_002c-setsar" aria-hidden="true">TOC</a></span></h3>
<p>The <code>setdar</code> filter sets the Display Aspect Ratio for the filter
output video.
</p>
<p>This is done by changing the specified Sample (aka Pixel) Aspect
Ratio, according to the following equation:
</p><div class="example">
<pre class="example"><var>DAR</var> = <var>HORIZONTAL_RESOLUTION</var> / <var>VERTICAL_RESOLUTION</var> * <var>SAR</var>
</pre></div>
<p>Keep in mind that the <code>setdar</code> filter does not modify the pixel
dimensions of the video frame. Also, the display aspect ratio set by
this filter may be changed by later filters in the filterchain,
e.g. in case of scaling or if another &quot;setdar&quot; or a &quot;setsar&quot; filter is
applied.
</p>
<p>The <code>setsar</code> filter sets the Sample (aka Pixel) Aspect Ratio for
the filter output video.
</p>
<p>Note that as a consequence of the application of this filter, the
output display aspect ratio will change according to the equation
above.
</p>
<p>Keep in mind that the sample aspect ratio set by the <code>setsar</code>
filter may be changed by later filters in the filterchain, e.g. if
another &quot;setsar&quot; or a &quot;setdar&quot; filter is applied.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>r, ratio, dar (<code>setdar</code> only), sar (<code>setsar</code> only)</samp></dt>
<dd><p>Set the aspect ratio used by the filter.
</p>
<p>The parameter can be a floating point number string, an expression, or
a string of the form <var>num</var>:<var>den</var>, where <var>num</var> and
<var>den</var> are the numerator and denominator of the aspect ratio. If
the parameter is not specified, it is assumed the value &quot;0&quot;.
In case the form &quot;<var>num</var>:<var>den</var>&quot; is used, the <code>:</code> character
should be escaped.
</p>
</dd>
<dt><samp>max</samp></dt>
<dd><p>Set the maximum integer value to use for expressing numerator and
denominator when reducing the expressed aspect ratio to a rational.
Default value is <code>100</code>.
</p>
</dd>
</dl>
<p>The parameter <var>sar</var> is an expression containing
the following constants:
</p>
<dl compact="compact">
<dt><samp>E, PI, PHI</samp></dt>
<dd><p>These are approximated values for the mathematical constants e
(Euler&rsquo;s number), pi (Greek pi), and phi (the golden ratio).
</p>
</dd>
<dt><samp>w, h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>These are the same as <var>w</var> / <var>h</var>.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp>dar</samp></dt>
<dd><p>The input display aspect ratio. It is the same as
(<var>w</var> / <var>h</var>) * <var>sar</var>.
</p>
</dd>
<dt><samp>hsub, vsub</samp></dt>
<dd><p>Horizontal and vertical chroma subsample values. For example, for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p></dd>
</dl>
<a name="Examples-93"></a>
<h4 class="subsection">31.129.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-93" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-93" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> To change the display aspect ratio to 16:9, specify one of the following:
<div class="example">
<pre class="example">setdar=dar=1.77777
setdar=dar=16/9
</pre></div>
</li><li> To change the sample aspect ratio to 10:11, specify:
<div class="example">
<pre class="example">setsar=sar=10/11
</pre></div>
</li><li> To set a display aspect ratio of 16:9, and specify a maximum integer value of
1000 in the aspect ratio reduction, use the command:
<div class="example">
<pre class="example">setdar=ratio=16/9:max=1000
</pre></div>
</li></ul>
<a name="setfield"></a><a name="setfield-1"></a>
<h3 class="section">31.130 setfield<span class="pull-right"><a class="anchor hidden-xs" href="#setfield-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-setfield-1" aria-hidden="true">TOC</a></span></h3>
<p>Force field for the output video frame.
</p>
<p>The <code>setfield</code> filter marks the interlace type field for the
output frames. It does not change the input frame, but only sets the
corresponding property, which affects how the frame is treated by
following filters (e.g. <code>fieldorder</code> or <code>yadif</code>).
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dd><p>Keep the same field property.
</p>
</dd>
<dt>&lsquo;<samp>bff</samp>&rsquo;</dt>
<dd><p>Mark the frame as bottom-field-first.
</p>
</dd>
<dt>&lsquo;<samp>tff</samp>&rsquo;</dt>
<dd><p>Mark the frame as top-field-first.
</p>
</dd>
<dt>&lsquo;<samp>prog</samp>&rsquo;</dt>
<dd><p>Mark the frame as progressive.
</p></dd>
</dl>
</dd>
</dl>
<a name="showinfo"></a>
<h3 class="section">31.131 showinfo<span class="pull-right"><a class="anchor hidden-xs" href="#showinfo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showinfo" aria-hidden="true">TOC</a></span></h3>
<p>Show a line containing various information for each input video frame.
The input video is not modified.
</p>
<p>The shown line contains a sequence of key/value pairs of the form
<var>key</var>:<var>value</var>.
</p>
<p>The following values are shown in the output:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>The Presentation TimeStamp of the input frame, expressed as a number of
time base units. The time base unit depends on the filter input pad.
</p>
</dd>
<dt><samp>pts_time</samp></dt>
<dd><p>The Presentation TimeStamp of the input frame, expressed as a number of
seconds.
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>The position of the frame in the input stream, or -1 if this information is
unavailable and/or meaningless (for example in case of synthetic video).
</p>
</dd>
<dt><samp>fmt</samp></dt>
<dd><p>The pixel format name.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>The sample aspect ratio of the input frame, expressed in the form
<var>num</var>/<var>den</var>.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>The size of the input frame. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>i</samp></dt>
<dd><p>The type of interlaced mode (&quot;P&quot; for &quot;progressive&quot;, &quot;T&quot; for top field first, &quot;B&quot;
for bottom field first).
</p>
</dd>
<dt><samp>iskey</samp></dt>
<dd><p>This is 1 if the frame is a key frame, 0 otherwise.
</p>
</dd>
<dt><samp>type</samp></dt>
<dd><p>The picture type of the input frame (&quot;I&quot; for an I-frame, &quot;P&quot; for a
P-frame, &quot;B&quot; for a B-frame, or &quot;?&quot; for an unknown type).
Also refer to the documentation of the <code>AVPictureType</code> enum and of
the <code>av_get_picture_type_char</code> function defined in
<samp>libavutil/avutil.h</samp>.
</p>
</dd>
<dt><samp>checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame.
</p>
</dd>
<dt><samp>plane_checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
expressed in the form &quot;[<var>c0</var> <var>c1</var> <var>c2</var> <var>c3</var>]&quot;.
</p></dd>
</dl>
<a name="showpalette"></a>
<h3 class="section">31.132 showpalette<span class="pull-right"><a class="anchor hidden-xs" href="#showpalette" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showpalette" aria-hidden="true">TOC</a></span></h3>
<p>Displays the 256 colors palette of each frame. This filter is only relevant for
<var>pal8</var> pixel format frames.
</p>
<p>It accepts the following option:
</p>
<dl compact="compact">
<dt><samp>s</samp></dt>
<dd><p>Set the size of the box used to represent one palette color entry. Default is
<code>30</code> (for a <code>30x30</code> pixel box).
</p></dd>
</dl>
<a name="shuffleframes"></a>
<h3 class="section">31.133 shuffleframes<span class="pull-right"><a class="anchor hidden-xs" href="#shuffleframes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-shuffleframes" aria-hidden="true">TOC</a></span></h3>
<p>Reorder and/or duplicate video frames.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>mapping</samp></dt>
<dd><p>Set the destination indexes of input frames.
This is space or &rsquo;|&rsquo; separated list of indexes that maps input frames to output
frames. Number of indexes also sets maximal value that each index may have.
</p></dd>
</dl>
<p>The first frame has the index 0. The default is to keep the input unchanged.
</p>
<a name="Examples-94"></a>
<h4 class="subsection">31.133.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-94" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-94" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Swap second and third frame of every three frames of the input:
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf &quot;shuffleframes=0 2 1&quot; OUTPUT
</pre></div>
</li><li> Swap 10th and 1st frame of every ten frames of the input:
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf &quot;shuffleframes=9 1 2 3 4 5 6 7 8 0&quot; OUTPUT
</pre></div>
</li></ul>
<a name="shuffleplanes"></a>
<h3 class="section">31.134 shuffleplanes<span class="pull-right"><a class="anchor hidden-xs" href="#shuffleplanes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-shuffleplanes" aria-hidden="true">TOC</a></span></h3>
<p>Reorder and/or duplicate video planes.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>map0</samp></dt>
<dd><p>The index of the input plane to be used as the first output plane.
</p>
</dd>
<dt><samp>map1</samp></dt>
<dd><p>The index of the input plane to be used as the second output plane.
</p>
</dd>
<dt><samp>map2</samp></dt>
<dd><p>The index of the input plane to be used as the third output plane.
</p>
</dd>
<dt><samp>map3</samp></dt>
<dd><p>The index of the input plane to be used as the fourth output plane.
</p>
</dd>
</dl>
<p>The first plane has the index 0. The default is to keep the input unchanged.
</p>
<a name="Examples-95"></a>
<h4 class="subsection">31.134.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-95" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-95" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Swap the second and third planes of the input:
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
</pre></div>
</li></ul>
<a name="signalstats"></a><a name="signalstats-1"></a>
<h3 class="section">31.135 signalstats<span class="pull-right"><a class="anchor hidden-xs" href="#signalstats-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-signalstats-1" aria-hidden="true">TOC</a></span></h3>
<p>Evaluate various visual metrics that assist in determining issues associated
with the digitization of analog video media.
</p>
<p>By default the filter will log these metadata values:
</p>
<dl compact="compact">
<dt><samp>YMIN</samp></dt>
<dd><p>Display the minimal Y value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>YLOW</samp></dt>
<dd><p>Display the Y value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>YAVG</samp></dt>
<dd><p>Display the average Y value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp>YHIGH</samp></dt>
<dd><p>Display the Y value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>YMAX</samp></dt>
<dd><p>Display the maximum Y value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>UMIN</samp></dt>
<dd><p>Display the minimal U value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>ULOW</samp></dt>
<dd><p>Display the U value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>UAVG</samp></dt>
<dd><p>Display the average U value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp>UHIGH</samp></dt>
<dd><p>Display the U value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>UMAX</samp></dt>
<dd><p>Display the maximum U value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>VMIN</samp></dt>
<dd><p>Display the minimal V value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>VLOW</samp></dt>
<dd><p>Display the V value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>VAVG</samp></dt>
<dd><p>Display the average V value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp>VHIGH</samp></dt>
<dd><p>Display the V value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>VMAX</samp></dt>
<dd><p>Display the maximum V value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp>SATMIN</samp></dt>
<dd><p>Display the minimal saturation value contained within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp>SATLOW</samp></dt>
<dd><p>Display the saturation value at the 10% percentile within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp>SATAVG</samp></dt>
<dd><p>Display the average saturation value within the input frame. Expressed in range
of [0-~181.02].
</p>
</dd>
<dt><samp>SATHIGH</samp></dt>
<dd><p>Display the saturation value at the 90% percentile within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp>SATMAX</samp></dt>
<dd><p>Display the maximum saturation value contained within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp>HUEMED</samp></dt>
<dd><p>Display the median value for hue within the input frame. Expressed in range of
[0-360].
</p>
</dd>
<dt><samp>HUEAVG</samp></dt>
<dd><p>Display the average value for hue within the input frame. Expressed in range of
[0-360].
</p>
</dd>
<dt><samp>YDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the Y
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp>UDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the U
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp>VDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the V
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp>YBITDEPTH</samp></dt>
<dd><p>Display bit depth of Y plane in current frame.
Expressed in range of [0-16].
</p>
</dd>
<dt><samp>UBITDEPTH</samp></dt>
<dd><p>Display bit depth of U plane in current frame.
Expressed in range of [0-16].
</p>
</dd>
<dt><samp>VBITDEPTH</samp></dt>
<dd><p>Display bit depth of V plane in current frame.
Expressed in range of [0-16].
</p></dd>
</dl>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>stat</samp></dt>
<dt><samp>out</samp></dt>
<dd>
<p><samp>stat</samp> specify an additional form of image analysis.
<samp>out</samp> output video with the specified type of pixel highlighted.
</p>
<p>Both options accept the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>tout</samp>&rsquo;</dt>
<dd><p>Identify <var>temporal outliers</var> pixels. A <var>temporal outlier</var> is a pixel
unlike the neighboring pixels of the same field. Examples of temporal outliers
include the results of video dropouts, head clogs, or tape tracking issues.
</p>
</dd>
<dt>&lsquo;<samp>vrep</samp>&rsquo;</dt>
<dd><p>Identify <var>vertical line repetition</var>. Vertical line repetition includes
similar rows of pixels within a frame. In born-digital video vertical line
repetition is common, but this pattern is uncommon in video digitized from an
analog source. When it occurs in video that results from the digitization of an
analog source it can indicate concealment from a dropout compensator.
</p>
</dd>
<dt>&lsquo;<samp>brng</samp>&rsquo;</dt>
<dd><p>Identify pixels that fall outside of legal broadcast range.
</p></dd>
</dl>
</dd>
<dt><samp>color, c</samp></dt>
<dd><p>Set the highlight color for the <samp>out</samp> option. The default color is
yellow.
</p></dd>
</dl>
<a name="Examples-96"></a>
<h4 class="subsection">31.135.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-96" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-96" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Output data of various video metrics:
<div class="example">
<pre class="example">ffprobe -f lavfi movie=example.mov,signalstats=&quot;stat=tout+vrep+brng&quot; -show_frames
</pre></div>
</li><li> Output specific data about the minimum and maximum values of the Y plane per frame:
<div class="example">
<pre class="example">ffprobe -f lavfi movie=example.mov,signalstats -show_entries frame_tags=lavfi.signalstats.YMAX,lavfi.signalstats.YMIN
</pre></div>
</li><li> Playback video while highlighting pixels that are outside of broadcast range in red.
<div class="example">
<pre class="example">ffplay example.mov -vf signalstats=&quot;out=brng:color=red&quot;
</pre></div>
</li><li> Playback video with signalstats metadata drawn over the frame.
<div class="example">
<pre class="example">ffplay example.mov -vf signalstats=stat=brng+vrep+tout,drawtext=fontfile=FreeSerif.ttf:textfile=signalstat_drawtext.txt
</pre></div>
<p>The contents of signalstat_drawtext.txt used in the command are:
</p><div class="example">
<pre class="example">time %{pts:hms}
Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
</pre></div>
</li></ul>
<a name="smartblur"></a><a name="smartblur-1"></a>
<h3 class="section">31.136 smartblur<span class="pull-right"><a class="anchor hidden-xs" href="#smartblur-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-smartblur-1" aria-hidden="true">TOC</a></span></h3>
<p>Blur the input video without impacting the outlines.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>luma_radius, lr</samp></dt>
<dd><p>Set the luma radius. The option value must be a float number in
the range [0.1,5.0] that specifies the variance of the gaussian filter
used to blur the image (slower if larger). Default value is 1.0.
</p>
</dd>
<dt><samp>luma_strength, ls</samp></dt>
<dd><p>Set the luma strength. The option value must be a float number
in the range [-1.0,1.0] that configures the blurring. A value included
in [0.0,1.0] will blur the image whereas a value included in
[-1.0,0.0] will sharpen the image. Default value is 1.0.
</p>
</dd>
<dt><samp>luma_threshold, lt</samp></dt>
<dd><p>Set the luma threshold used as a coefficient to determine
whether a pixel should be blurred or not. The option value must be an
integer in the range [-30,30]. A value of 0 will filter all the image,
a value included in [0,30] will filter flat areas and a value included
in [-30,0] will filter edges. Default value is 0.
</p>
</dd>
<dt><samp>chroma_radius, cr</samp></dt>
<dd><p>Set the chroma radius. The option value must be a float number in
the range [0.1,5.0] that specifies the variance of the gaussian filter
used to blur the image (slower if larger). Default value is 1.0.
</p>
</dd>
<dt><samp>chroma_strength, cs</samp></dt>
<dd><p>Set the chroma strength. The option value must be a float number
in the range [-1.0,1.0] that configures the blurring. A value included
in [0.0,1.0] will blur the image whereas a value included in
[-1.0,0.0] will sharpen the image. Default value is 1.0.
</p>
</dd>
<dt><samp>chroma_threshold, ct</samp></dt>
<dd><p>Set the chroma threshold used as a coefficient to determine
whether a pixel should be blurred or not. The option value must be an
integer in the range [-30,30]. A value of 0 will filter all the image,
a value included in [0,30] will filter flat areas and a value included
in [-30,0] will filter edges. Default value is 0.
</p></dd>
</dl>
<p>If a chroma option is not explicitly set, the corresponding luma value
is set.
</p>
<a name="ssim"></a>
<h3 class="section">31.137 ssim<span class="pull-right"><a class="anchor hidden-xs" href="#ssim" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ssim" aria-hidden="true">TOC</a></span></h3>
<p>Obtain the SSIM (Structural SImilarity Metric) between two input videos.
</p>
<p>This filter takes in input two input videos, the first input is
considered the &quot;main&quot; source and is passed unchanged to the
output. The second input is used as a &quot;reference&quot; video for computing
the SSIM.
</p>
<p>Both video inputs must have the same resolution and pixel format for
this filter to work correctly. Also it assumes that both inputs
have the same number of frames, which are compared one by one.
</p>
<p>The filter stores the calculated SSIM of each frame.
</p>
<p>The description of the accepted parameters follows.
</p>
<dl compact="compact">
<dt><samp>stats_file, f</samp></dt>
<dd><p>If specified the filter will use the named file to save the SSIM of
each individual frame. When filename equals &quot;-&quot; the data is sent to
standard output.
</p></dd>
</dl>
<p>The file printed if <var>stats_file</var> is selected, contains a sequence of
key/value pairs of the form <var>key</var>:<var>value</var> for each compared
couple of frames.
</p>
<p>A description of each shown parameter follows:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>sequential number of the input frame, starting from 1
</p>
</dd>
<dt><samp>Y, U, V, R, G, B</samp></dt>
<dd><p>SSIM of the compared frames for the component specified by the suffix.
</p>
</dd>
<dt><samp>All</samp></dt>
<dd><p>SSIM of the compared frames for the whole frame.
</p>
</dd>
<dt><samp>dB</samp></dt>
<dd><p>Same as above but in dB representation.
</p></dd>
</dl>
<p>For example:
</p><div class="example">
<pre class="example">movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
[main][ref] ssim=&quot;stats_file=stats.log&quot; [out]
</pre></div>
<p>On this example the input file being processed is compared with the
reference file <samp>ref_movie.mpg</samp>. The SSIM of each individual frame
is stored in <samp>stats.log</samp>.
</p>
<p>Another example with both psnr and ssim at same time:
</p><div class="example">
<pre class="example">ffmpeg -i main.mpg -i ref.mpg -lavfi &quot;ssim;[0:v][1:v]psnr&quot; -f null -
</pre></div>
<a name="stereo3d"></a>
<h3 class="section">31.138 stereo3d<span class="pull-right"><a class="anchor hidden-xs" href="#stereo3d" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-stereo3d" aria-hidden="true">TOC</a></span></h3>
<p>Convert between different stereoscopic image formats.
</p>
<p>The filters accept the following options:
</p>
<dl compact="compact">
<dt><samp>in</samp></dt>
<dd><p>Set stereoscopic image format of input.
</p>
<p>Available values for input image formats are:
</p><dl compact="compact">
<dt>&lsquo;<samp>sbsl</samp>&rsquo;</dt>
<dd><p>side by side parallel (left eye left, right eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbsr</samp>&rsquo;</dt>
<dd><p>side by side crosseye (right eye left, left eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbs2l</samp>&rsquo;</dt>
<dd><p>side by side parallel with half width resolution
(left eye left, right eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbs2r</samp>&rsquo;</dt>
<dd><p>side by side crosseye with half width resolution
(right eye left, left eye right)
</p>
</dd>
<dt>&lsquo;<samp>abl</samp>&rsquo;</dt>
<dd><p>above-below (left eye above, right eye below)
</p>
</dd>
<dt>&lsquo;<samp>abr</samp>&rsquo;</dt>
<dd><p>above-below (right eye above, left eye below)
</p>
</dd>
<dt>&lsquo;<samp>ab2l</samp>&rsquo;</dt>
<dd><p>above-below with half height resolution
(left eye above, right eye below)
</p>
</dd>
<dt>&lsquo;<samp>ab2r</samp>&rsquo;</dt>
<dd><p>above-below with half height resolution
(right eye above, left eye below)
</p>
</dd>
<dt>&lsquo;<samp>al</samp>&rsquo;</dt>
<dd><p>alternating frames (left eye first, right eye second)
</p>
</dd>
<dt>&lsquo;<samp>ar</samp>&rsquo;</dt>
<dd><p>alternating frames (right eye first, left eye second)
</p>
</dd>
<dt>&lsquo;<samp>irl</samp>&rsquo;</dt>
<dd><p>interleaved rows (left eye has top row, right eye starts on next row)
</p>
</dd>
<dt>&lsquo;<samp>irr</samp>&rsquo;</dt>
<dd><p>interleaved rows (right eye has top row, left eye starts on next row)
</p>
</dd>
<dt>&lsquo;<samp>icl</samp>&rsquo;</dt>
<dd><p>interleaved columns, left eye first
</p>
</dd>
<dt>&lsquo;<samp>icr</samp>&rsquo;</dt>
<dd><p>interleaved columns, right eye first
</p>
<p>Default value is &lsquo;<samp>sbsl</samp>&rsquo;.
</p></dd>
</dl>
</dd>
<dt><samp>out</samp></dt>
<dd><p>Set stereoscopic image format of output.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>sbsl</samp>&rsquo;</dt>
<dd><p>side by side parallel (left eye left, right eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbsr</samp>&rsquo;</dt>
<dd><p>side by side crosseye (right eye left, left eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbs2l</samp>&rsquo;</dt>
<dd><p>side by side parallel with half width resolution
(left eye left, right eye right)
</p>
</dd>
<dt>&lsquo;<samp>sbs2r</samp>&rsquo;</dt>
<dd><p>side by side crosseye with half width resolution
(right eye left, left eye right)
</p>
</dd>
<dt>&lsquo;<samp>abl</samp>&rsquo;</dt>
<dd><p>above-below (left eye above, right eye below)
</p>
</dd>
<dt>&lsquo;<samp>abr</samp>&rsquo;</dt>
<dd><p>above-below (right eye above, left eye below)
</p>
</dd>
<dt>&lsquo;<samp>ab2l</samp>&rsquo;</dt>
<dd><p>above-below with half height resolution
(left eye above, right eye below)
</p>
</dd>
<dt>&lsquo;<samp>ab2r</samp>&rsquo;</dt>
<dd><p>above-below with half height resolution
(right eye above, left eye below)
</p>
</dd>
<dt>&lsquo;<samp>al</samp>&rsquo;</dt>
<dd><p>alternating frames (left eye first, right eye second)
</p>
</dd>
<dt>&lsquo;<samp>ar</samp>&rsquo;</dt>
<dd><p>alternating frames (right eye first, left eye second)
</p>
</dd>
<dt>&lsquo;<samp>irl</samp>&rsquo;</dt>
<dd><p>interleaved rows (left eye has top row, right eye starts on next row)
</p>
</dd>
<dt>&lsquo;<samp>irr</samp>&rsquo;</dt>
<dd><p>interleaved rows (right eye has top row, left eye starts on next row)
</p>
</dd>
<dt>&lsquo;<samp>arbg</samp>&rsquo;</dt>
<dd><p>anaglyph red/blue gray
(red filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>argg</samp>&rsquo;</dt>
<dd><p>anaglyph red/green gray
(red filter on left eye, green filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>arcg</samp>&rsquo;</dt>
<dd><p>anaglyph red/cyan gray
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>arch</samp>&rsquo;</dt>
<dd><p>anaglyph red/cyan half colored
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>arcc</samp>&rsquo;</dt>
<dd><p>anaglyph red/cyan color
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>arcd</samp>&rsquo;</dt>
<dd><p>anaglyph red/cyan color optimized with the least squares projection of dubois
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>agmg</samp>&rsquo;</dt>
<dd><p>anaglyph green/magenta gray
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>agmh</samp>&rsquo;</dt>
<dd><p>anaglyph green/magenta half colored
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>agmc</samp>&rsquo;</dt>
<dd><p>anaglyph green/magenta colored
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>agmd</samp>&rsquo;</dt>
<dd><p>anaglyph green/magenta color optimized with the least squares projection of dubois
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>aybg</samp>&rsquo;</dt>
<dd><p>anaglyph yellow/blue gray
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>aybh</samp>&rsquo;</dt>
<dd><p>anaglyph yellow/blue half colored
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>aybc</samp>&rsquo;</dt>
<dd><p>anaglyph yellow/blue colored
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>aybd</samp>&rsquo;</dt>
<dd><p>anaglyph yellow/blue color optimized with the least squares projection of dubois
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>&lsquo;<samp>ml</samp>&rsquo;</dt>
<dd><p>mono output (left eye only)
</p>
</dd>
<dt>&lsquo;<samp>mr</samp>&rsquo;</dt>
<dd><p>mono output (right eye only)
</p>
</dd>
<dt>&lsquo;<samp>chl</samp>&rsquo;</dt>
<dd><p>checkerboard, left eye first
</p>
</dd>
<dt>&lsquo;<samp>chr</samp>&rsquo;</dt>
<dd><p>checkerboard, right eye first
</p>
</dd>
<dt>&lsquo;<samp>icl</samp>&rsquo;</dt>
<dd><p>interleaved columns, left eye first
</p>
</dd>
<dt>&lsquo;<samp>icr</samp>&rsquo;</dt>
<dd><p>interleaved columns, right eye first
</p>
</dd>
<dt>&lsquo;<samp>hdmi</samp>&rsquo;</dt>
<dd><p>HDMI frame pack
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>arcd</samp>&rsquo;.
</p></dd>
</dl>
<a name="Examples-97"></a>
<h4 class="subsection">31.138.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-97" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-97" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Convert input video from side by side parallel to anaglyph yellow/blue dubois:
<div class="example">
<pre class="example">stereo3d=sbsl:aybd
</pre></div>
</li><li> Convert input video from above below (left eye above, right eye below) to side by side crosseye.
<div class="example">
<pre class="example">stereo3d=abl:sbsr
</pre></div>
</li></ul>
<a name="streamselect_002c-astreamselect"></a>
<h3 class="section">31.139 streamselect, astreamselect<span class="pull-right"><a class="anchor hidden-xs" href="#streamselect_002c-astreamselect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-streamselect_002c-astreamselect" aria-hidden="true">TOC</a></span></h3>
<p>Select video or audio streams.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>Set number of inputs. Default is 2.
</p>
</dd>
<dt><samp>map</samp></dt>
<dd><p>Set input indexes to remap to outputs.
</p></dd>
</dl>
<a name="Commands-9"></a>
<h4 class="subsection">31.139.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-9" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-9" aria-hidden="true">TOC</a></span></h4>
<p>The <code>streamselect</code> and <code>astreamselect</code> filter supports the following
commands:
</p>
<dl compact="compact">
<dt><samp>map</samp></dt>
<dd><p>Set input indexes to remap to outputs.
</p></dd>
</dl>
<a name="Examples-98"></a>
<h4 class="subsection">31.139.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-98" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-98" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Select first 5 seconds 1st stream and rest of time 2nd stream:
<div class="example">
<pre class="example">sendcmd='5.0 streamselect map 1',streamselect=inputs=2:map=0
</pre></div>
</li><li> Same as above, but for audio:
<div class="example">
<pre class="example">asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
</pre></div>
</li></ul>
<a name="sobel"></a>
<h3 class="section">31.140 sobel<span class="pull-right"><a class="anchor hidden-xs" href="#sobel" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sobel" aria-hidden="true">TOC</a></span></h3>
<p>Apply sobel operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl compact="compact">
<dt><samp>planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp>delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<a name="spp"></a><a name="spp-1"></a>
<h3 class="section">31.141 spp<span class="pull-right"><a class="anchor hidden-xs" href="#spp-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-spp-1" aria-hidden="true">TOC</a></span></h3>
<p>Apply a simple postprocessing filter that compresses and decompresses the image
at several (or - in the case of <samp>quality</samp> level <code>6</code> - all) shifts
and average the results.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 0-6. If set to <code>0</code>, the filter will have no
effect. A value of <code>6</code> means the higher quality. For each increment of
that value the speed drops by a factor of approximately 2. Default value is
<code>3</code>.
</p>
</dd>
<dt><samp>qp</samp></dt>
<dd><p>Force a constant quantization parameter. If not set, the filter will use the QP
from the video stream (if available).
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set thresholding mode. Available modes are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>hard</samp>&rsquo;</dt>
<dd><p>Set hard thresholding (default).
</p></dd>
<dt>&lsquo;<samp>soft</samp>&rsquo;</dt>
<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier).
</p></dd>
</dl>
</dd>
<dt><samp>use_bframe_qp</samp></dt>
<dd><p>Enable the use of the QP from the B-Frames if set to <code>1</code>. Using this
option may cause flicker since the B-Frames have often larger QP. Default is
<code>0</code> (not enabled).
</p></dd>
</dl>
<a name="subtitles"></a><a name="subtitles-1"></a>
<h3 class="section">31.142 subtitles<span class="pull-right"><a class="anchor hidden-xs" href="#subtitles-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-subtitles-1" aria-hidden="true">TOC</a></span></h3>
<p>Draw subtitles on top of input video using the libass library.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-libass</code>. This filter also requires a build with libavcodec and
libavformat to convert the passed subtitles file to ASS (Advanced Substation
Alpha) subtitles format.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>filename, f</samp></dt>
<dd><p>Set the filename of the subtitle file to read. It must be specified.
</p>
</dd>
<dt><samp>original_size</samp></dt>
<dd><p>Specify the size of the original video, the video for which the ASS file
was composed. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Due to a misdesign in ASS aspect ratio arithmetic, this is necessary to
correctly scale the fonts if the aspect ratio has been changed.
</p>
</dd>
<dt><samp>fontsdir</samp></dt>
<dd><p>Set a directory path containing fonts that can be used by the filter.
These fonts will be used in addition to whatever the font provider uses.
</p>
</dd>
<dt><samp>charenc</samp></dt>
<dd><p>Set subtitles input character encoding. <code>subtitles</code> filter only. Only
useful if not UTF-8.
</p>
</dd>
<dt><samp>stream_index, si</samp></dt>
<dd><p>Set subtitles stream index. <code>subtitles</code> filter only.
</p>
</dd>
<dt><samp>force_style</samp></dt>
<dd><p>Override default style or script info parameters of the subtitles. It accepts a
string containing ASS style format <code>KEY=VALUE</code> couples separated by &quot;,&quot;.
</p></dd>
</dl>
<p>If the first key is not specified, it is assumed that the first value
specifies the <samp>filename</samp>.
</p>
<p>For example, to render the file <samp>sub.srt</samp> on top of the input
video, use the command:
</p><div class="example">
<pre class="example">subtitles=sub.srt
</pre></div>
<p>which is equivalent to:
</p><div class="example">
<pre class="example">subtitles=filename=sub.srt
</pre></div>
<p>To render the default subtitles stream from file <samp>video.mkv</samp>, use:
</p><div class="example">
<pre class="example">subtitles=video.mkv
</pre></div>
<p>To render the second subtitles stream from that file, use:
</p><div class="example">
<pre class="example">subtitles=video.mkv:si=1
</pre></div>
<p>To make the subtitles stream from <samp>sub.srt</samp> appear in transparent green
<code>DejaVu Serif</code>, use:
</p><div class="example">
<pre class="example">subtitles=sub.srt:force_style='FontName=DejaVu Serif,PrimaryColour=&amp;HAA00FF00'
</pre></div>
<a name="super2xsai"></a>
<h3 class="section">31.143 super2xsai<span class="pull-right"><a class="anchor hidden-xs" href="#super2xsai" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-super2xsai" aria-hidden="true">TOC</a></span></h3>
<p>Scale the input by 2x and smooth using the Super2xSaI (Scale and
Interpolate) pixel art scaling algorithm.
</p>
<p>Useful for enlarging pixel art images without reducing sharpness.
</p>
<a name="swaprect"></a>
<h3 class="section">31.144 swaprect<span class="pull-right"><a class="anchor hidden-xs" href="#swaprect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-swaprect" aria-hidden="true">TOC</a></span></h3>
<p>Swap two rectangular objects in video.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>w</samp></dt>
<dd><p>Set object width.
</p>
</dd>
<dt><samp>h</samp></dt>
<dd><p>Set object height.
</p>
</dd>
<dt><samp>x1</samp></dt>
<dd><p>Set 1st rect x coordinate.
</p>
</dd>
<dt><samp>y1</samp></dt>
<dd><p>Set 1st rect y coordinate.
</p>
</dd>
<dt><samp>x2</samp></dt>
<dd><p>Set 2nd rect x coordinate.
</p>
</dd>
<dt><samp>y2</samp></dt>
<dd><p>Set 2nd rect y coordinate.
</p>
<p>All expressions are evaluated once for each frame.
</p></dd>
</dl>
<p>The all options are expressions containing the following constants:
</p>
<dl compact="compact">
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>same as <var>w</var> / <var>h</var>
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp>dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var>
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>The number of the input frame, starting from 0.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The timestamp expressed in seconds. It&rsquo;s NAN if the input timestamp is unknown.
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown
</p></dd>
</dl>
<a name="swapuv"></a>
<h3 class="section">31.145 swapuv<span class="pull-right"><a class="anchor hidden-xs" href="#swapuv" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-swapuv" aria-hidden="true">TOC</a></span></h3>
<p>Swap U &amp; V plane.
</p>
<a name="telecine"></a>
<h3 class="section">31.146 telecine<span class="pull-right"><a class="anchor hidden-xs" href="#telecine" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-telecine" aria-hidden="true">TOC</a></span></h3>
<p>Apply telecine process to the video.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>first_field</samp></dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>top, t</samp>&rsquo;</dt>
<dd><p>top field first
</p></dd>
<dt>&lsquo;<samp>bottom, b</samp>&rsquo;</dt>
<dd><p>bottom field first
The default value is <code>top</code>.
</p></dd>
</dl>
</dd>
<dt><samp>pattern</samp></dt>
<dd><p>A string of numbers representing the pulldown pattern you wish to apply.
The default value is <code>23</code>.
</p></dd>
</dl>
<div class="example">
<pre class="example">Some typical patterns:
NTSC output (30i):
27.5p: 32222
24p: 23 (classic)
24p: 2332 (preferred)
20p: 33
18p: 334
16p: 3444
PAL output (25i):
27.5p: 12222
24p: 222222222223 (&quot;Euro pulldown&quot;)
16.67p: 33
16p: 33333334
</pre></div>
<a name="thumbnail"></a>
<h3 class="section">31.147 thumbnail<span class="pull-right"><a class="anchor hidden-xs" href="#thumbnail" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-thumbnail" aria-hidden="true">TOC</a></span></h3>
<p>Select the most representative frame in a given sequence of consecutive frames.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>Set the frames batch size to analyze; in a set of <var>n</var> frames, the filter
will pick one of them, and then handle the next batch of <var>n</var> frames until
the end. Default is <code>100</code>.
</p></dd>
</dl>
<p>Since the filter keeps track of the whole frames sequence, a bigger <var>n</var>
value will result in a higher memory usage, so a high value is not recommended.
</p>
<a name="Examples-99"></a>
<h4 class="subsection">31.147.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-99" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-99" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Extract one picture each 50 frames:
<div class="example">
<pre class="example">thumbnail=50
</pre></div>
</li><li> Complete example of a thumbnail creation with <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
</pre></div>
</li></ul>
<a name="tile"></a>
<h3 class="section">31.148 tile<span class="pull-right"><a class="anchor hidden-xs" href="#tile" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tile" aria-hidden="true">TOC</a></span></h3>
<p>Tile several successive frames together.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>layout</samp></dt>
<dd><p>Set the grid size (i.e. the number of lines and columns). For the syntax of
this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>nb_frames</samp></dt>
<dd><p>Set the maximum number of frames to render in the given area. It must be less
than or equal to <var>w</var>x<var>h</var>. The default value is <code>0</code>, meaning all
the area will be used.
</p>
</dd>
<dt><samp>margin</samp></dt>
<dd><p>Set the outer border margin in pixels.
</p>
</dd>
<dt><samp>padding</samp></dt>
<dd><p>Set the inner border thickness (i.e. the number of pixels between frames). For
more advanced padding options (such as having different values for the edges),
refer to the pad video filter.
</p>
</dd>
<dt><samp>color</samp></dt>
<dd><p>Specify the color of the unused area. For the syntax of this option, check the
&quot;Color&quot; section in the ffmpeg-utils manual. The default value of <var>color</var>
is &quot;black&quot;.
</p></dd>
</dl>
<a name="Examples-100"></a>
<h4 class="subsection">31.148.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-100" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-100" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Produce 8x8 PNG tiles of all keyframes (<samp>-skip_frame nokey</samp>) in a movie:
<div class="example">
<pre class="example">ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
</pre></div>
<p>The <samp>-vsync 0</samp> is necessary to prevent <code>ffmpeg</code> from
duplicating each output frame to accommodate the originally detected frame
rate.
</p>
</li><li> Display <code>5</code> pictures in an area of <code>3x2</code> frames,
with <code>7</code> pixels between them, and <code>2</code> pixels of initial margin, using
mixed flat and named options:
<div class="example">
<pre class="example">tile=3x2:nb_frames=5:padding=7:margin=2
</pre></div>
</li></ul>
<a name="tinterlace"></a>
<h3 class="section">31.149 tinterlace<span class="pull-right"><a class="anchor hidden-xs" href="#tinterlace" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tinterlace" aria-hidden="true">TOC</a></span></h3>
<p>Perform various types of temporal field interlacing.
</p>
<p>Frames are counted starting from 1, so the first input frame is
considered odd.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Specify the mode of the interlacing. This option can also be specified
as a value alone. See below for a list of values for this option.
</p>
<p>Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>merge, 0</samp>&rsquo;</dt>
<dd><p>Move odd frames into the upper field, even into the lower field,
generating a double height frame at half frame rate.
</p><div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
11111 33333
22222 44444
11111 33333
22222 44444
11111 33333
22222 44444
11111 33333
22222 44444
</pre></div>
</dd>
<dt>&lsquo;<samp>drop_even, 1</samp>&rsquo;</dt>
<dd><p>Only output odd frames, even frames are dropped, generating a frame with
unchanged height at half frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
11111 33333
11111 33333
11111 33333
11111 33333
</pre></div>
</dd>
<dt>&lsquo;<samp>drop_odd, 2</samp>&rsquo;</dt>
<dd><p>Only output even frames, odd frames are dropped, generating a frame with
unchanged height at half frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
22222 44444
22222 44444
22222 44444
22222 44444
</pre></div>
</dd>
<dt>&lsquo;<samp>pad, 3</samp>&rsquo;</dt>
<dd><p>Expand each frame to full height, but pad alternate lines with black,
generating a frame with double height at the same input frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
11111 ..... 33333 .....
..... 22222 ..... 44444
11111 ..... 33333 .....
..... 22222 ..... 44444
11111 ..... 33333 .....
..... 22222 ..... 44444
11111 ..... 33333 .....
..... 22222 ..... 44444
</pre></div>
</dd>
<dt>&lsquo;<samp>interleave_top, 4</samp>&rsquo;</dt>
<dd><p>Interleave the upper field from odd frames with the lower field from
even frames, generating a frame with unchanged height at half frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111&lt;- 22222 33333&lt;- 44444
11111 22222&lt;- 33333 44444&lt;-
11111&lt;- 22222 33333&lt;- 44444
11111 22222&lt;- 33333 44444&lt;-
Output:
11111 33333
22222 44444
11111 33333
22222 44444
</pre></div>
</dd>
<dt>&lsquo;<samp>interleave_bottom, 5</samp>&rsquo;</dt>
<dd><p>Interleave the lower field from odd frames with the upper field from
even frames, generating a frame with unchanged height at half frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222&lt;- 33333 44444&lt;-
11111&lt;- 22222 33333&lt;- 44444
11111 22222&lt;- 33333 44444&lt;-
11111&lt;- 22222 33333&lt;- 44444
Output:
22222 44444
11111 33333
22222 44444
11111 33333
</pre></div>
</dd>
<dt>&lsquo;<samp>interlacex2, 6</samp>&rsquo;</dt>
<dd><p>Double frame rate with unchanged height. Frames are inserted each
containing the second temporal field from the previous input frame and
the first temporal field from the next input frame. This mode relies on
the top_field_first flag. Useful for interlaced video displays with no
field synchronisation.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
11111 22222 22222 33333 33333 44444 44444
11111 11111 22222 22222 33333 33333 44444
11111 22222 22222 33333 33333 44444 44444
11111 11111 22222 22222 33333 33333 44444
</pre></div>
</dd>
<dt>&lsquo;<samp>mergex2, 7</samp>&rsquo;</dt>
<dd><p>Move odd frames into the upper field, even into the lower field,
generating a double height frame at same frame rate.
</p>
<div class="example">
<pre class="example"> ------&gt; time
Input:
Frame 1 Frame 2 Frame 3 Frame 4
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
11111 22222 33333 44444
Output:
11111 33333 33333 55555
22222 22222 44444 44444
11111 33333 33333 55555
22222 22222 44444 44444
11111 33333 33333 55555
22222 22222 44444 44444
11111 33333 33333 55555
22222 22222 44444 44444
</pre></div>
</dd>
</dl>
<p>Numeric values are deprecated but are accepted for backward
compatibility reasons.
</p>
<p>Default mode is <code>merge</code>.
</p>
</dd>
<dt><samp>flags</samp></dt>
<dd><p>Specify flags influencing the filter process.
</p>
<p>Available value for <var>flags</var> is:
</p>
<dl compact="compact">
<dt><samp>low_pass_filter, vlfp</samp></dt>
<dd><p>Enable vertical low-pass filtering in the filter.
Vertical low-pass filtering is required when creating an interlaced
destination from a progressive source which contains high-frequency
vertical detail. Filtering will reduce interlace &rsquo;twitter&rsquo; and Moire
patterning.
</p>
<p>Vertical low-pass filtering can only be enabled for <samp>mode</samp>
<var>interleave_top</var> and <var>interleave_bottom</var>.
</p>
</dd>
</dl>
</dd>
</dl>
<a name="transpose"></a>
<h3 class="section">31.150 transpose<span class="pull-right"><a class="anchor hidden-xs" href="#transpose" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-transpose" aria-hidden="true">TOC</a></span></h3>
<p>Transpose rows with columns in the input video and optionally flip it.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>dir</samp></dt>
<dd><p>Specify the transposition direction.
</p>
<p>Can assume the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>0, 4, cclock_flip</samp>&rsquo;</dt>
<dd><p>Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
</p><div class="example">
<pre class="example">L.R L.l
. . -&gt; . .
l.r R.r
</pre></div>
</dd>
<dt>&lsquo;<samp>1, 5, clock</samp>&rsquo;</dt>
<dd><p>Rotate by 90 degrees clockwise, that is:
</p><div class="example">
<pre class="example">L.R l.L
. . -&gt; . .
l.r r.R
</pre></div>
</dd>
<dt>&lsquo;<samp>2, 6, cclock</samp>&rsquo;</dt>
<dd><p>Rotate by 90 degrees counterclockwise, that is:
</p><div class="example">
<pre class="example">L.R R.r
. . -&gt; . .
l.r L.l
</pre></div>
</dd>
<dt>&lsquo;<samp>3, 7, clock_flip</samp>&rsquo;</dt>
<dd><p>Rotate by 90 degrees clockwise and vertically flip, that is:
</p><div class="example">
<pre class="example">L.R r.R
. . -&gt; . .
l.r l.L
</pre></div>
</dd>
</dl>
<p>For values between 4-7, the transposition is only done if the input
video geometry is portrait and not landscape. These values are
deprecated, the <code>passthrough</code> option should be used instead.
</p>
<p>Numerical values are deprecated, and should be dropped in favor of
symbolic constants.
</p>
</dd>
<dt><samp>passthrough</samp></dt>
<dd><p>Do not apply the transposition if the input geometry matches the one
specified by the specified value. It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Always apply transposition.
</p></dd>
<dt>&lsquo;<samp>portrait</samp>&rsquo;</dt>
<dd><p>Preserve portrait geometry (when <var>height</var> &gt;= <var>width</var>).
</p></dd>
<dt>&lsquo;<samp>landscape</samp>&rsquo;</dt>
<dd><p>Preserve landscape geometry (when <var>width</var> &gt;= <var>height</var>).
</p></dd>
</dl>
<p>Default value is <code>none</code>.
</p></dd>
</dl>
<p>For example to rotate by 90 degrees clockwise and preserve portrait
layout:
</p><div class="example">
<pre class="example">transpose=dir=1:passthrough=portrait
</pre></div>
<p>The command above can also be specified as:
</p><div class="example">
<pre class="example">transpose=1:portrait
</pre></div>
<a name="trim"></a>
<h3 class="section">31.151 trim<span class="pull-right"><a class="anchor hidden-xs" href="#trim" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-trim" aria-hidden="true">TOC</a></span></h3>
<p>Trim the input so that the output contains one continuous subpart of the input.
</p>
<p>It accepts the following parameters:
</p><dl compact="compact">
<dt><samp>start</samp></dt>
<dd><p>Specify the time of the start of the kept section, i.e. the frame with the
timestamp <var>start</var> will be the first frame in the output.
</p>
</dd>
<dt><samp>end</samp></dt>
<dd><p>Specify the time of the first frame that will be dropped, i.e. the frame
immediately preceding the one with the timestamp <var>end</var> will be the last
frame in the output.
</p>
</dd>
<dt><samp>start_pts</samp></dt>
<dd><p>This is the same as <var>start</var>, except this option sets the start timestamp
in timebase units instead of seconds.
</p>
</dd>
<dt><samp>end_pts</samp></dt>
<dd><p>This is the same as <var>end</var>, except this option sets the end timestamp
in timebase units instead of seconds.
</p>
</dd>
<dt><samp>duration</samp></dt>
<dd><p>The maximum duration of the output in seconds.
</p>
</dd>
<dt><samp>start_frame</samp></dt>
<dd><p>The number of the first frame that should be passed to the output.
</p>
</dd>
<dt><samp>end_frame</samp></dt>
<dd><p>The number of the first frame that should be dropped.
</p></dd>
</dl>
<p><samp>start</samp>, <samp>end</samp>, and <samp>duration</samp> are expressed as time
duration specifications; see
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
</p>
<p>Note that the first two sets of the start/end options and the <samp>duration</samp>
option look at the frame timestamp, while the _frame variants simply count the
frames that pass through the filter. Also note that this filter does not modify
the timestamps. If you wish for the output timestamps to start at zero, insert a
setpts filter after the trim filter.
</p>
<p>If multiple start or end options are set, this filter tries to be greedy and
keep all the frames that match at least one of the specified constraints. To keep
only the part that matches all the constraints at once, chain multiple trim
filters.
</p>
<p>The defaults are such that all the input is kept. So it is possible to set e.g.
just the end values to keep everything before the specified time.
</p>
<p>Examples:
</p><ul>
<li> Drop everything except the second minute of input:
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf trim=60:120
</pre></div>
</li><li> Keep only the first second:
<div class="example">
<pre class="example">ffmpeg -i INPUT -vf trim=duration=1
</pre></div>
</li></ul>
<a name="unsharp"></a><a name="unsharp-1"></a>
<h3 class="section">31.152 unsharp<span class="pull-right"><a class="anchor hidden-xs" href="#unsharp-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-unsharp-1" aria-hidden="true">TOC</a></span></h3>
<p>Sharpen or blur the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>luma_msize_x, lx</samp></dt>
<dd><p>Set the luma matrix horizontal size. It must be an odd integer between
3 and 23. The default value is 5.
</p>
</dd>
<dt><samp>luma_msize_y, ly</samp></dt>
<dd><p>Set the luma matrix vertical size. It must be an odd integer between 3
and 23. The default value is 5.
</p>
</dd>
<dt><samp>luma_amount, la</samp></dt>
<dd><p>Set the luma effect strength. It must be a floating point number, reasonable
values lay between -1.5 and 1.5.
</p>
<p>Negative values will blur the input video, while positive values will
sharpen it, a value of zero will disable the effect.
</p>
<p>Default value is 1.0.
</p>
</dd>
<dt><samp>chroma_msize_x, cx</samp></dt>
<dd><p>Set the chroma matrix horizontal size. It must be an odd integer
between 3 and 23. The default value is 5.
</p>
</dd>
<dt><samp>chroma_msize_y, cy</samp></dt>
<dd><p>Set the chroma matrix vertical size. It must be an odd integer
between 3 and 23. The default value is 5.
</p>
</dd>
<dt><samp>chroma_amount, ca</samp></dt>
<dd><p>Set the chroma effect strength. It must be a floating point number, reasonable
values lay between -1.5 and 1.5.
</p>
<p>Negative values will blur the input video, while positive values will
sharpen it, a value of zero will disable the effect.
</p>
<p>Default value is 0.0.
</p>
</dd>
<dt><samp>opencl</samp></dt>
<dd><p>If set to 1, specify using OpenCL capabilities, only available if
FFmpeg was configured with <code>--enable-opencl</code>. Default value is 0.
</p>
</dd>
</dl>
<p>All parameters are optional and default to the equivalent of the
string &rsquo;5:5:1.0:5:5:0.0&rsquo;.
</p>
<a name="Examples-101"></a>
<h4 class="subsection">31.152.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-101" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-101" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply strong luma sharpen effect:
<div class="example">
<pre class="example">unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
</pre></div>
</li><li> Apply a strong blur of both luma and chroma parameters:
<div class="example">
<pre class="example">unsharp=7:7:-2:7:7:-2
</pre></div>
</li></ul>
<a name="uspp"></a>
<h3 class="section">31.153 uspp<span class="pull-right"><a class="anchor hidden-xs" href="#uspp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-uspp" aria-hidden="true">TOC</a></span></h3>
<p>Apply ultra slow/simple postprocessing filter that compresses and decompresses
the image at several (or - in the case of <samp>quality</samp> level <code>8</code> - all)
shifts and average the results.
</p>
<p>The way this differs from the behavior of spp is that uspp actually encodes &amp;
decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8
DCT similar to MJPEG.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 0-8. If set to <code>0</code>, the filter will have no
effect. A value of <code>8</code> means the higher quality. For each increment of
that value the speed drops by a factor of approximately 2. Default value is
<code>3</code>.
</p>
</dd>
<dt><samp>qp</samp></dt>
<dd><p>Force a constant quantization parameter. If not set, the filter will use the QP
from the video stream (if available).
</p></dd>
</dl>
<a name="vaguedenoiser"></a>
<h3 class="section">31.154 vaguedenoiser<span class="pull-right"><a class="anchor hidden-xs" href="#vaguedenoiser" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vaguedenoiser" aria-hidden="true">TOC</a></span></h3>
<p>Apply a wavelet based denoiser.
</p>
<p>It transforms each frame from the video input into the wavelet domain,
using Cohen-Daubechies-Feauveau 9/7. Then it applies some filtering to
the obtained coefficients. It does an inverse wavelet transform after.
Due to wavelet properties, it should give a nice smoothed result, and
reduced noise, without blurring picture features.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>threshold</samp></dt>
<dd><p>The filtering strength. The higher, the more filtered the video will be.
Hard thresholding can use a higher threshold than soft thresholding
before the video looks overfiltered.
</p>
</dd>
<dt><samp>method</samp></dt>
<dd><p>The filtering method the filter will use.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>hard</samp>&rsquo;</dt>
<dd><p>All values under the threshold will be zeroed.
</p>
</dd>
<dt>&lsquo;<samp>soft</samp>&rsquo;</dt>
<dd><p>All values under the threshold will be zeroed. All values above will be
reduced by the threshold.
</p>
</dd>
<dt>&lsquo;<samp>garrote</samp>&rsquo;</dt>
<dd><p>Scales or nullifies coefficients - intermediary between (more) soft and
(less) hard thresholding.
</p></dd>
</dl>
</dd>
<dt><samp>nsteps</samp></dt>
<dd><p>Number of times, the wavelet will decompose the picture. Picture can&rsquo;t
be decomposed beyond a particular point (typically, 8 for a 640x480
frame - as 2^9 = 512 &gt; 480)
</p>
</dd>
<dt><samp>percent</samp></dt>
<dd><p>Partial of full denoising (limited coefficients shrinking), from 0 to 100.
</p>
</dd>
<dt><samp>planes</samp></dt>
<dd><p>A list of the planes to process. By default all planes are processed.
</p></dd>
</dl>
<a name="vectorscope"></a>
<h3 class="section">31.155 vectorscope<span class="pull-right"><a class="anchor hidden-xs" href="#vectorscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vectorscope" aria-hidden="true">TOC</a></span></h3>
<p>Display 2 color component values in the two dimensional graph (which is called
a vectorscope).
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode, m</samp></dt>
<dd><p>Set vectorscope mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>gray</samp>&rsquo;</dt>
<dd><p>Gray values are displayed on graph, higher brightness means more pixels have
same component color value on location in graph. This is the default mode.
</p>
</dd>
<dt>&lsquo;<samp>color</samp>&rsquo;</dt>
<dd><p>Gray values are displayed on graph. Surrounding pixels values which are not
present in video frame are drawn in gradient of 2 color components which are
set by option <code>x</code> and <code>y</code>. The 3rd color component is static.
</p>
</dd>
<dt>&lsquo;<samp>color2</samp>&rsquo;</dt>
<dd><p>Actual color components values present in video frame are displayed on graph.
</p>
</dd>
<dt>&lsquo;<samp>color3</samp>&rsquo;</dt>
<dd><p>Similar as color2 but higher frequency of same values <code>x</code> and <code>y</code>
on graph increases value of another color component, which is luminance by
default values of <code>x</code> and <code>y</code>.
</p>
</dd>
<dt>&lsquo;<samp>color4</samp>&rsquo;</dt>
<dd><p>Actual colors present in video frame are displayed on graph. If two different
colors map to same position on graph then color with higher value of component
not present in graph is picked.
</p>
</dd>
<dt>&lsquo;<samp>color5</samp>&rsquo;</dt>
<dd><p>Gray values are displayed on graph. Similar to <code>color</code> but with 3rd color
component picked from radial gradient.
</p></dd>
</dl>
</dd>
<dt><samp>x</samp></dt>
<dd><p>Set which color component will be represented on X-axis. Default is <code>1</code>.
</p>
</dd>
<dt><samp>y</samp></dt>
<dd><p>Set which color component will be represented on Y-axis. Default is <code>2</code>.
</p>
</dd>
<dt><samp>intensity, i</samp></dt>
<dd><p>Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness
of color component which represents frequency of (X, Y) location in graph.
</p>
</dd>
<dt><samp>envelope, e</samp></dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No envelope, this is default.
</p>
</dd>
<dt>&lsquo;<samp>instant</samp>&rsquo;</dt>
<dd><p>Instant envelope, even darkest single pixel will be clearly highlighted.
</p>
</dd>
<dt>&lsquo;<samp>peak</samp>&rsquo;</dt>
<dd><p>Hold maximum and minimum values presented in graph over time. This way you
can still spot out of range values without constantly looking at vectorscope.
</p>
</dd>
<dt>&lsquo;<samp>peak+instant</samp>&rsquo;</dt>
<dd><p>Peak and instant envelope combined together.
</p></dd>
</dl>
</dd>
<dt><samp>graticule, g</samp></dt>
<dd><p>Set what kind of graticule to draw.
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dt>&lsquo;<samp>green</samp>&rsquo;</dt>
<dt>&lsquo;<samp>color</samp>&rsquo;</dt>
</dl>
</dd>
<dt><samp>opacity, o</samp></dt>
<dd><p>Set graticule opacity.
</p>
</dd>
<dt><samp>flags, f</samp></dt>
<dd><p>Set graticule flags.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>white</samp>&rsquo;</dt>
<dd><p>Draw graticule for white point.
</p>
</dd>
<dt>&lsquo;<samp>black</samp>&rsquo;</dt>
<dd><p>Draw graticule for black point.
</p>
</dd>
<dt>&lsquo;<samp>name</samp>&rsquo;</dt>
<dd><p>Draw color points short names.
</p></dd>
</dl>
</dd>
<dt><samp>bgopacity, b</samp></dt>
<dd><p>Set background opacity.
</p>
</dd>
<dt><samp>lthreshold, l</samp></dt>
<dd><p>Set low threshold for color component not represented on X or Y axis.
Values lower than this value will be ignored. Default is 0.
Note this value is multiplied with actual max possible value one pixel component
can have. So for 8-bit input and low threshold value of 0.1 actual threshold
is 0.1 * 255 = 25.
</p>
</dd>
<dt><samp>hthreshold, h</samp></dt>
<dd><p>Set high threshold for color component not represented on X or Y axis.
Values higher than this value will be ignored. Default is 1.
Note this value is multiplied with actual max possible value one pixel component
can have. So for 8-bit input and high threshold value of 0.9 actual threshold
is 0.9 * 255 = 230.
</p>
</dd>
<dt><samp>colorspace, c</samp></dt>
<dd><p>Set what kind of colorspace to use when drawing graticule.
</p><dl compact="compact">
<dt>&lsquo;<samp>auto</samp>&rsquo;</dt>
<dt>&lsquo;<samp>601</samp>&rsquo;</dt>
<dt>&lsquo;<samp>709</samp>&rsquo;</dt>
</dl>
<p>Default is auto.
</p></dd>
</dl>
<a name="vidstabdetect"></a><a name="vidstabdetect-1"></a>
<h3 class="section">31.156 vidstabdetect<span class="pull-right"><a class="anchor hidden-xs" href="#vidstabdetect-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vidstabdetect-1" aria-hidden="true">TOC</a></span></h3>
<p>Analyze video stabilization/deshaking. Perform pass 1 of 2, see
<a href="#vidstabtransform">vidstabtransform</a> for pass 2.
</p>
<p>This filter generates a file with relative translation and rotation
transform information about subsequent frames, which is then used by
the <a href="#vidstabtransform">vidstabtransform</a> filter.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-libvidstab</code>.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>result</samp></dt>
<dd><p>Set the path to the file used to write the transforms information.
Default value is <samp>transforms.trf</samp>.
</p>
</dd>
<dt><samp>shakiness</samp></dt>
<dd><p>Set how shaky the video is and how quick the camera is. It accepts an
integer in the range 1-10, a value of 1 means little shakiness, a
value of 10 means strong shakiness. Default value is 5.
</p>
</dd>
<dt><samp>accuracy</samp></dt>
<dd><p>Set the accuracy of the detection process. It must be a value in the
range 1-15. A value of 1 means low accuracy, a value of 15 means high
accuracy. Default value is 15.
</p>
</dd>
<dt><samp>stepsize</samp></dt>
<dd><p>Set stepsize of the search process. The region around minimum is
scanned with 1 pixel resolution. Default value is 6.
</p>
</dd>
<dt><samp>mincontrast</samp></dt>
<dd><p>Set minimum contrast. Below this value a local measurement field is
discarded. Must be a floating point value in the range 0-1. Default
value is 0.3.
</p>
</dd>
<dt><samp>tripod</samp></dt>
<dd><p>Set reference frame number for tripod mode.
</p>
<p>If enabled, the motion of the frames is compared to a reference frame
in the filtered stream, identified by the specified number. The idea
is to compensate all movements in a more-or-less static scene and keep
the camera view absolutely still.
</p>
<p>If set to 0, it is disabled. The frames are counted starting from 1.
</p>
</dd>
<dt><samp>show</samp></dt>
<dd><p>Show fields and transforms in the resulting frames. It accepts an
integer in the range 0-2. Default value is 0, which disables any
visualization.
</p></dd>
</dl>
<a name="Examples-102"></a>
<h4 class="subsection">31.156.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-102" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-102" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use default values:
<div class="example">
<pre class="example">vidstabdetect
</pre></div>
</li><li> Analyze strongly shaky movie and put the results in file
<samp>mytransforms.trf</samp>:
<div class="example">
<pre class="example">vidstabdetect=shakiness=10:accuracy=15:result=&quot;mytransforms.trf&quot;
</pre></div>
</li><li> Visualize the result of internal transformations in the resulting
video:
<div class="example">
<pre class="example">vidstabdetect=show=1
</pre></div>
</li><li> Analyze a video with medium shakiness using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
</pre></div>
</li></ul>
<a name="vidstabtransform"></a><a name="vidstabtransform-1"></a>
<h3 class="section">31.157 vidstabtransform<span class="pull-right"><a class="anchor hidden-xs" href="#vidstabtransform-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vidstabtransform-1" aria-hidden="true">TOC</a></span></h3>
<p>Video stabilization/deshaking: pass 2 of 2,
see <a href="#vidstabdetect">vidstabdetect</a> for pass 1.
</p>
<p>Read a file with transform information for each frame and
apply/compensate them. Together with the <a href="#vidstabdetect">vidstabdetect</a>
filter this can be used to deshake videos. See also
<a href="http://public.hronopik.de/vid.stab">http://public.hronopik.de/vid.stab</a>. It is important to also use
the <a href="#unsharp">unsharp</a> filter, see below.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code>--enable-libvidstab</code>.
</p>
<a name="Options-29"></a>
<h4 class="subsection">31.157.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-29" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-29" aria-hidden="true">TOC</a></span></h4>
<dl compact="compact">
<dt><samp>input</samp></dt>
<dd><p>Set path to the file used to read the transforms. Default value is
<samp>transforms.trf</samp>.
</p>
</dd>
<dt><samp>smoothing</samp></dt>
<dd><p>Set the number of frames (value*2 + 1) used for lowpass filtering the
camera movements. Default value is 10.
</p>
<p>For example a number of 10 means that 21 frames are used (10 in the
past and 10 in the future) to smoothen the motion in the video. A
larger value leads to a smoother video, but limits the acceleration of
the camera (pan/tilt movements). 0 is a special case where a static
camera is simulated.
</p>
</dd>
<dt><samp>optalgo</samp></dt>
<dd><p>Set the camera path optimization algorithm.
</p>
<p>Accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>gauss</samp>&rsquo;</dt>
<dd><p>gaussian kernel low-pass filter on camera motion (default)
</p></dd>
<dt>&lsquo;<samp>avg</samp>&rsquo;</dt>
<dd><p>averaging on transformations
</p></dd>
</dl>
</dd>
<dt><samp>maxshift</samp></dt>
<dd><p>Set maximal number of pixels to translate frames. Default value is -1,
meaning no limit.
</p>
</dd>
<dt><samp>maxangle</samp></dt>
<dd><p>Set maximal angle in radians (degree*PI/180) to rotate frames. Default
value is -1, meaning no limit.
</p>
</dd>
<dt><samp>crop</samp></dt>
<dd><p>Specify how to deal with borders that may be visible due to movement
compensation.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>keep</samp>&rsquo;</dt>
<dd><p>keep image information from previous frame (default)
</p></dd>
<dt>&lsquo;<samp>black</samp>&rsquo;</dt>
<dd><p>fill the border black
</p></dd>
</dl>
</dd>
<dt><samp>invert</samp></dt>
<dd><p>Invert transforms if set to 1. Default value is 0.
</p>
</dd>
<dt><samp>relative</samp></dt>
<dd><p>Consider transforms as relative to previous frame if set to 1,
absolute if set to 0. Default value is 0.
</p>
</dd>
<dt><samp>zoom</samp></dt>
<dd><p>Set percentage to zoom. A positive value will result in a zoom-in
effect, a negative value in a zoom-out effect. Default value is 0 (no
zoom).
</p>
</dd>
<dt><samp>optzoom</samp></dt>
<dd><p>Set optimal zooming to avoid borders.
</p>
<p>Accepted values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>0</samp>&rsquo;</dt>
<dd><p>disabled
</p></dd>
<dt>&lsquo;<samp>1</samp>&rsquo;</dt>
<dd><p>optimal static zoom value is determined (only very strong movements
will lead to visible borders) (default)
</p></dd>
<dt>&lsquo;<samp>2</samp>&rsquo;</dt>
<dd><p>optimal adaptive zoom value is determined (no borders will be
visible), see <samp>zoomspeed</samp>
</p></dd>
</dl>
<p>Note that the value given at zoom is added to the one calculated here.
</p>
</dd>
<dt><samp>zoomspeed</samp></dt>
<dd><p>Set percent to zoom maximally each frame (enabled when
<samp>optzoom</samp> is set to 2). Range is from 0 to 5, default value is
0.25.
</p>
</dd>
<dt><samp>interpol</samp></dt>
<dd><p>Specify type of interpolation.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>no</samp>&rsquo;</dt>
<dd><p>no interpolation
</p></dd>
<dt>&lsquo;<samp>linear</samp>&rsquo;</dt>
<dd><p>linear only horizontal
</p></dd>
<dt>&lsquo;<samp>bilinear</samp>&rsquo;</dt>
<dd><p>linear in both directions (default)
</p></dd>
<dt>&lsquo;<samp>bicubic</samp>&rsquo;</dt>
<dd><p>cubic in both directions (slow)
</p></dd>
</dl>
</dd>
<dt><samp>tripod</samp></dt>
<dd><p>Enable virtual tripod mode if set to 1, which is equivalent to
<code>relative=0:smoothing=0</code>. Default value is 0.
</p>
<p>Use also <code>tripod</code> option of <a href="#vidstabdetect">vidstabdetect</a>.
</p>
</dd>
<dt><samp>debug</samp></dt>
<dd><p>Increase log verbosity if set to 1. Also the detected global motions
are written to the temporary file <samp>global_motions.trf</samp>. Default
value is 0.
</p></dd>
</dl>
<a name="Examples-103"></a>
<h4 class="subsection">31.157.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-103" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-103" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use <code>ffmpeg</code> for a typical stabilization with default values:
<div class="example">
<pre class="example">ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
</pre></div>
<p>Note the use of the <a href="#unsharp">unsharp</a> filter which is always recommended.
</p>
</li><li> Zoom in a bit more and load transform data from a given file:
<div class="example">
<pre class="example">vidstabtransform=zoom=5:input=&quot;mytransforms.trf&quot;
</pre></div>
</li><li> Smoothen the video even more:
<div class="example">
<pre class="example">vidstabtransform=smoothing=30
</pre></div>
</li></ul>
<a name="vflip"></a>
<h3 class="section">31.158 vflip<span class="pull-right"><a class="anchor hidden-xs" href="#vflip" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vflip" aria-hidden="true">TOC</a></span></h3>
<p>Flip the input video vertically.
</p>
<p>For example, to vertically flip a video with <code>ffmpeg</code>:
</p><div class="example">
<pre class="example">ffmpeg -i in.avi -vf &quot;vflip&quot; out.avi
</pre></div>
<a name="vignette"></a><a name="vignette-1"></a>
<h3 class="section">31.159 vignette<span class="pull-right"><a class="anchor hidden-xs" href="#vignette-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vignette-1" aria-hidden="true">TOC</a></span></h3>
<p>Make or reverse a natural vignetting effect.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>angle, a</samp></dt>
<dd><p>Set lens angle expression as a number of radians.
</p>
<p>The value is clipped in the <code>[0,PI/2]</code> range.
</p>
<p>Default value: <code>&quot;PI/5&quot;</code>
</p>
</dd>
<dt><samp>x0</samp></dt>
<dt><samp>y0</samp></dt>
<dd><p>Set center coordinates expressions. Respectively <code>&quot;w/2&quot;</code> and <code>&quot;h/2&quot;</code>
by default.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set forward/backward mode.
</p>
<p>Available modes are:
</p><dl compact="compact">
<dt>&lsquo;<samp>forward</samp>&rsquo;</dt>
<dd><p>The larger the distance from the central point, the darker the image becomes.
</p>
</dd>
<dt>&lsquo;<samp>backward</samp>&rsquo;</dt>
<dd><p>The larger the distance from the central point, the brighter the image becomes.
This can be used to reverse a vignette effect, though there is no automatic
detection to extract the lens <samp>angle</samp> and other settings (yet). It can
also be used to create a burning effect.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>forward</samp>&rsquo;.
</p>
</dd>
<dt><samp>eval</samp></dt>
<dd><p>Set evaluation mode for the expressions (<samp>angle</samp>, <samp>x0</samp>, <samp>y0</samp>).
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>init</samp>&rsquo;</dt>
<dd><p>Evaluate expressions only once during the filter initialization.
</p>
</dd>
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>Evaluate expressions for each incoming frame. This is way slower than the
&lsquo;<samp>init</samp>&rsquo; mode since it requires all the scalers to be re-computed, but it
allows advanced dynamic expressions.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>init</samp>&rsquo;.
</p>
</dd>
<dt><samp>dither</samp></dt>
<dd><p>Set dithering to reduce the circular banding effects. Default is <code>1</code>
(enabled).
</p>
</dd>
<dt><samp>aspect</samp></dt>
<dd><p>Set vignette aspect. This setting allows one to adjust the shape of the vignette.
Setting this value to the SAR of the input will make a rectangular vignetting
following the dimensions of the video.
</p>
<p>Default is <code>1/1</code>.
</p></dd>
</dl>
<a name="Expressions"></a>
<h4 class="subsection">31.159.1 Expressions<span class="pull-right"><a class="anchor hidden-xs" href="#Expressions" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Expressions" aria-hidden="true">TOC</a></span></h4>
<p>The <samp>alpha</samp>, <samp>x0</samp> and <samp>y0</samp> expressions can contain the
following parameters.
</p>
<dl compact="compact">
<dt><samp>w</samp></dt>
<dt><samp>h</samp></dt>
<dd><p>input width and height
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in
<var>TB</var> units, NAN if undefined
</p>
</dd>
<dt><samp>r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>the PTS (Presentation TimeStamp) of the filtered video frame,
expressed in seconds, NAN if undefined
</p>
</dd>
<dt><samp>tb</samp></dt>
<dd><p>time base of the input video
</p></dd>
</dl>
<a name="Examples-104"></a>
<h4 class="subsection">31.159.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-104" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-104" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Apply simple strong vignetting effect:
<div class="example">
<pre class="example">vignette=PI/4
</pre></div>
</li><li> Make a flickering vignetting:
<div class="example">
<pre class="example">vignette='PI/4+random(1)*PI/50':eval=frame
</pre></div>
</li></ul>
<a name="vstack"></a>
<h3 class="section">31.160 vstack<span class="pull-right"><a class="anchor hidden-xs" href="#vstack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vstack" aria-hidden="true">TOC</a></span></h3>
<p>Stack input videos vertically.
</p>
<p>All streams must be of same pixel format and of same width.
</p>
<p>Note that this filter is faster than using <a href="#overlay">overlay</a> and <a href="#pad">pad</a> filter
to create same output.
</p>
<p>The filter accept the following option:
</p>
<dl compact="compact">
<dt><samp>inputs</samp></dt>
<dd><p>Set number of input streams. Default is 2.
</p>
</dd>
<dt><samp>shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p></dd>
</dl>
<a name="w3fdif"></a>
<h3 class="section">31.161 w3fdif<span class="pull-right"><a class="anchor hidden-xs" href="#w3fdif" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-w3fdif" aria-hidden="true">TOC</a></span></h3>
<p>Deinterlace the input video (&quot;w3fdif&quot; stands for &quot;Weston 3 Field
Deinterlacing Filter&quot;).
</p>
<p>Based on the process described by Martin Weston for BBC R&amp;D, and
implemented based on the de-interlace algorithm written by Jim
Easterbrook for BBC R&amp;D, the Weston 3 field deinterlacing filter
uses filter coefficients calculated by BBC R&amp;D.
</p>
<p>There are two sets of filter coefficients, so called &quot;simple&quot;:
and &quot;complex&quot;. Which set of filter coefficients is used can
be set by passing an optional parameter:
</p>
<dl compact="compact">
<dt><samp>filter</samp></dt>
<dd><p>Set the interlacing filter coefficients. Accepts one of the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>simple</samp>&rsquo;</dt>
<dd><p>Simple filter coefficient set.
</p></dd>
<dt>&lsquo;<samp>complex</samp>&rsquo;</dt>
<dd><p>More-complex filter coefficient set.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>complex</samp>&rsquo;.
</p>
</dd>
<dt><samp>deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accept one of the following values:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>all</samp>&rsquo;</dt>
<dd><p>Deinterlace all frames,
</p></dd>
<dt>&lsquo;<samp>interlaced</samp>&rsquo;</dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>all</samp>&rsquo;.
</p></dd>
</dl>
<a name="waveform"></a>
<h3 class="section">31.162 waveform<span class="pull-right"><a class="anchor hidden-xs" href="#waveform" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-waveform" aria-hidden="true">TOC</a></span></h3>
<p>Video waveform monitor.
</p>
<p>The waveform monitor plots color component intensity. By default luminance
only. Each column of the waveform corresponds to a column of pixels in the
source video.
</p>
<p>It accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode, m</samp></dt>
<dd><p>Can be either <code>row</code>, or <code>column</code>. Default is <code>column</code>.
In row mode, the graph on the left side represents color component value 0 and
the right side represents value = 255. In column mode, the top side represents
color component value = 0 and bottom side represents value = 255.
</p>
</dd>
<dt><samp>intensity, i</samp></dt>
<dd><p>Set intensity. Smaller values are useful to find out how many values of the same
luminance are distributed across input rows/columns.
Default value is <code>0.04</code>. Allowed range is [0, 1].
</p>
</dd>
<dt><samp>mirror, r</samp></dt>
<dd><p>Set mirroring mode. <code>0</code> means unmirrored, <code>1</code> means mirrored.
In mirrored mode, higher values will be represented on the left
side for <code>row</code> mode and at the top for <code>column</code> mode. Default is
<code>1</code> (mirrored).
</p>
</dd>
<dt><samp>display, d</samp></dt>
<dd><p>Set display mode.
It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>overlay</samp>&rsquo;</dt>
<dd><p>Presents information identical to that in the <code>parade</code>, except
that the graphs representing color components are superimposed directly
over one another.
</p>
<p>This display mode makes it easier to spot relative differences or similarities
in overlapping areas of the color components that are supposed to be identical,
such as neutral whites, grays, or blacks.
</p>
</dd>
<dt>&lsquo;<samp>stack</samp>&rsquo;</dt>
<dd><p>Display separate graph for the color components side by side in
<code>row</code> mode or one below the other in <code>column</code> mode.
</p>
</dd>
<dt>&lsquo;<samp>parade</samp>&rsquo;</dt>
<dd><p>Display separate graph for the color components side by side in
<code>column</code> mode or one below the other in <code>row</code> mode.
</p>
<p>Using this display mode makes it easy to spot color casts in the highlights
and shadows of an image, by comparing the contours of the top and the bottom
graphs of each waveform. Since whites, grays, and blacks are characterized
by exactly equal amounts of red, green, and blue, neutral areas of the picture
should display three waveforms of roughly equal width/height. If not, the
correction is easy to perform by making level adjustments the three waveforms.
</p></dd>
</dl>
<p>Default is <code>stack</code>.
</p>
</dd>
<dt><samp>components, c</samp></dt>
<dd><p>Set which color components to display. Default is 1, which means only luminance
or red color component if input is in RGB colorspace. If is set for example to
7 it will display all 3 (if) available color components.
</p>
</dd>
<dt><samp>envelope, e</samp></dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>No envelope, this is default.
</p>
</dd>
<dt>&lsquo;<samp>instant</samp>&rsquo;</dt>
<dd><p>Instant envelope, minimum and maximum values presented in graph will be easily
visible even with small <code>step</code> value.
</p>
</dd>
<dt>&lsquo;<samp>peak</samp>&rsquo;</dt>
<dd><p>Hold minimum and maximum values presented in graph across time. This way you
can still spot out of range values without constantly looking at waveforms.
</p>
</dd>
<dt>&lsquo;<samp>peak+instant</samp>&rsquo;</dt>
<dd><p>Peak and instant envelope combined together.
</p></dd>
</dl>
</dd>
<dt><samp>filter, f</samp></dt>
<dd><dl compact="compact">
<dt>&lsquo;<samp>lowpass</samp>&rsquo;</dt>
<dd><p>No filtering, this is default.
</p>
</dd>
<dt>&lsquo;<samp>flat</samp>&rsquo;</dt>
<dd><p>Luma and chroma combined together.
</p>
</dd>
<dt>&lsquo;<samp>aflat</samp>&rsquo;</dt>
<dd><p>Similar as above, but shows difference between blue and red chroma.
</p>
</dd>
<dt>&lsquo;<samp>chroma</samp>&rsquo;</dt>
<dd><p>Displays only chroma.
</p>
</dd>
<dt>&lsquo;<samp>color</samp>&rsquo;</dt>
<dd><p>Displays actual color value on waveform.
</p>
</dd>
<dt>&lsquo;<samp>acolor</samp>&rsquo;</dt>
<dd><p>Similar as above, but with luma showing frequency of chroma values.
</p></dd>
</dl>
</dd>
<dt><samp>graticule, g</samp></dt>
<dd><p>Set which graticule to display.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Do not display graticule.
</p>
</dd>
<dt>&lsquo;<samp>green</samp>&rsquo;</dt>
<dd><p>Display green graticule showing legal broadcast ranges.
</p></dd>
</dl>
</dd>
<dt><samp>opacity, o</samp></dt>
<dd><p>Set graticule opacity.
</p>
</dd>
<dt><samp>flags, fl</samp></dt>
<dd><p>Set graticule flags.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>numbers</samp>&rsquo;</dt>
<dd><p>Draw numbers above lines. By default enabled.
</p>
</dd>
<dt>&lsquo;<samp>dots</samp>&rsquo;</dt>
<dd><p>Draw dots instead of lines.
</p></dd>
</dl>
</dd>
<dt><samp>scale, s</samp></dt>
<dd><p>Set scale used for displaying graticule.
</p>
<dl compact="compact">
<dt>&lsquo;<samp>digital</samp>&rsquo;</dt>
<dt>&lsquo;<samp>millivolts</samp>&rsquo;</dt>
<dt>&lsquo;<samp>ire</samp>&rsquo;</dt>
</dl>
<p>Default is digital.
</p>
</dd>
<dt><samp>bgopacity, b</samp></dt>
<dd><p>Set background opacity.
</p></dd>
</dl>
<a name="weave"></a>
<h3 class="section">31.163 weave<span class="pull-right"><a class="anchor hidden-xs" href="#weave" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-weave" aria-hidden="true">TOC</a></span></h3>
<p>The <code>weave</code> takes a field-based video input and join
each two sequential fields into single frame, producing a new double
height clip with half the frame rate and half the frame count.
</p>
<p>It accepts the following option:
</p>
<dl compact="compact">
<dt><samp>first_field</samp></dt>
<dd><p>Set first field. Available values are:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>top, t</samp>&rsquo;</dt>
<dd><p>Set the frame as top-field-first.
</p>
</dd>
<dt>&lsquo;<samp>bottom, b</samp>&rsquo;</dt>
<dd><p>Set the frame as bottom-field-first.
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-105"></a>
<h4 class="subsection">31.163.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-105" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-105" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Interlace video using <a href="#select">select</a> and <a href="#separatefields">separatefields</a> filter:
<div class="example">
<pre class="example">separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
</pre></div>
</li></ul>
<a name="xbr"></a>
<h3 class="section">31.164 xbr<span class="pull-right"><a class="anchor hidden-xs" href="#xbr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xbr" aria-hidden="true">TOC</a></span></h3>
<p>Apply the xBR high-quality magnification filter which is designed for pixel
art. It follows a set of edge-detection rules, see
<a href="http://www.libretro.com/forums/viewtopic.php?f=6&amp;t=134">http://www.libretro.com/forums/viewtopic.php?f=6&amp;t=134</a>.
</p>
<p>It accepts the following option:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>Set the scaling dimension: <code>2</code> for <code>2xBR</code>, <code>3</code> for
<code>3xBR</code> and <code>4</code> for <code>4xBR</code>.
Default is <code>3</code>.
</p></dd>
</dl>
<a name="yadif"></a><a name="yadif-1"></a>
<h3 class="section">31.165 yadif<span class="pull-right"><a class="anchor hidden-xs" href="#yadif-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-yadif-1" aria-hidden="true">TOC</a></span></h3>
<p>Deinterlace the input video (&quot;yadif&quot; means &quot;yet another deinterlacing
filter&quot;).
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl compact="compact">
<dt><samp>0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp>1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
<dt><samp>2, send_frame_nospatial</samp></dt>
<dd><p>Like <code>send_frame</code>, but it skips the spatial interlacing check.
</p></dd>
<dt><samp>3, send_field_nospatial</samp></dt>
<dd><p>Like <code>send_field</code>, but it skips the spatial interlacing check.
</p></dd>
</dl>
<p>The default value is <code>send_frame</code>.
</p>
</dd>
<dt><samp>parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl compact="compact">
<dt><samp>0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp>1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp>-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code>auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp>deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accept one of the following
values:
</p>
<dl compact="compact">
<dt><samp>0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp>1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code>all</code>.
</p></dd>
</dl>
<a name="zoompan"></a>
<h3 class="section">31.166 zoompan<span class="pull-right"><a class="anchor hidden-xs" href="#zoompan" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-zoompan" aria-hidden="true">TOC</a></span></h3>
<p>Apply Zoom &amp; Pan effect.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>zoom, z</samp></dt>
<dd><p>Set the zoom expression. Default is 1.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Set the x and y expression. Default is 0.
</p>
</dd>
<dt><samp>d</samp></dt>
<dd><p>Set the duration expression in number of frames.
This sets for how many number of frames effect will last for
single input image.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>Set the output image size, default is &rsquo;hd720&rsquo;.
</p>
</dd>
<dt><samp>fps</samp></dt>
<dd><p>Set the output frame rate, default is &rsquo;25&rsquo;.
</p></dd>
</dl>
<p>Each expression can contain the following constants:
</p>
<dl compact="compact">
<dt><samp>in_w, iw</samp></dt>
<dd><p>Input width.
</p>
</dd>
<dt><samp>in_h, ih</samp></dt>
<dd><p>Input height.
</p>
</dd>
<dt><samp>out_w, ow</samp></dt>
<dd><p>Output width.
</p>
</dd>
<dt><samp>out_h, oh</samp></dt>
<dd><p>Output height.
</p>
</dd>
<dt><samp>in</samp></dt>
<dd><p>Input frame count.
</p>
</dd>
<dt><samp>on</samp></dt>
<dd><p>Output frame count.
</p>
</dd>
<dt><samp>x</samp></dt>
<dt><samp>y</samp></dt>
<dd><p>Last calculated &rsquo;x&rsquo; and &rsquo;y&rsquo; position from &rsquo;x&rsquo; and &rsquo;y&rsquo; expression
for current input frame.
</p>
</dd>
<dt><samp>px</samp></dt>
<dt><samp>py</samp></dt>
<dd><p>&rsquo;x&rsquo; and &rsquo;y&rsquo; of last output frame of previous input frame or 0 when there was
not yet such frame (first input frame).
</p>
</dd>
<dt><samp>zoom</samp></dt>
<dd><p>Last calculated zoom from &rsquo;z&rsquo; expression for current input frame.
</p>
</dd>
<dt><samp>pzoom</samp></dt>
<dd><p>Last calculated zoom of last output frame of previous input frame.
</p>
</dd>
<dt><samp>duration</samp></dt>
<dd><p>Number of output frames for current input frame. Calculated from &rsquo;d&rsquo; expression
for each input frame.
</p>
</dd>
<dt><samp>pduration</samp></dt>
<dd><p>number of output frames created for previous input frame
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>Rational number: input width / input height
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>sample aspect ratio
</p>
</dd>
<dt><samp>dar</samp></dt>
<dd><p>display aspect ratio
</p>
</dd>
</dl>
<a name="Examples-106"></a>
<h4 class="subsection">31.166.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-106" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-106" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Zoom-in up to 1.5 and pan at same time to some spot near center of picture:
<div class="example">
<pre class="example">zoompan=z='min(zoom+0.0015,1.5)':d=700:x='if(gte(zoom,1.5),x,x+1/a)':y='if(gte(zoom,1.5),y,y+1)':s=640x360
</pre></div>
</li><li> Zoom-in up to 1.5 and pan always at center of picture:
<div class="example">
<pre class="example">zoompan=z='min(zoom+0.0015,1.5)':d=700:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
</pre></div>
</li><li> Same as above but without pausing:
<div class="example">
<pre class="example">zoompan=z='min(max(zoom,pzoom)+0.0015,1.5)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
</pre></div>
</li></ul>
<a name="zscale"></a>
<h3 class="section">31.167 zscale<span class="pull-right"><a class="anchor hidden-xs" href="#zscale" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-zscale" aria-hidden="true">TOC</a></span></h3>
<p>Scale (resize) the input video, using the z.lib library:
https://github.com/sekrit-twc/zimg.
</p>
<p>The zscale filter forces the output display aspect ratio to be the same
as the input, by changing the output sample aspect ratio.
</p>
<p>If the input image format is different from the format requested by
the next filter, the zscale filter will convert the input to the
requested format.
</p>
<a name="Options-30"></a>
<h4 class="subsection">31.167.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-30" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-30" aria-hidden="true">TOC</a></span></h4>
<p>The filter accepts the following options.
</p>
<dl compact="compact">
<dt><samp>width, w</samp></dt>
<dt><samp>height, h</samp></dt>
<dd><p>Set the output video dimension expression. Default value is the input
dimension.
</p>
<p>If the <var>width</var> or <var>w</var> is 0, the input width is used for the output.
If the <var>height</var> or <var>h</var> is 0, the input height is used for the output.
</p>
<p>If one of the values is -1, the zscale filter will use a value that
maintains the aspect ratio of the input image, calculated from the
other specified dimension. If both of them are -1, the input size is
used
</p>
<p>If one of the values is -n with n &gt; 1, the zscale filter will also use a value
that maintains the aspect ratio of the input image, calculated from the other
specified dimension. After that it will, however, make sure that the calculated
dimension is divisible by n and adjust the value if necessary.
</p>
<p>See below for the list of accepted constants for use in the dimension
expression.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the video size. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>dither, d</samp></dt>
<dd><p>Set the dither type.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>none</var></dt>
<dt><var>ordered</var></dt>
<dt><var>random</var></dt>
<dt><var>error_diffusion</var></dt>
</dl>
<p>Default is none.
</p>
</dd>
<dt><samp>filter, f</samp></dt>
<dd><p>Set the resize filter type.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>point</var></dt>
<dt><var>bilinear</var></dt>
<dt><var>bicubic</var></dt>
<dt><var>spline16</var></dt>
<dt><var>spline36</var></dt>
<dt><var>lanczos</var></dt>
</dl>
<p>Default is bilinear.
</p>
</dd>
<dt><samp>range, r</samp></dt>
<dd><p>Set the color range.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>limited</var></dt>
<dt><var>full</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>primaries, p</samp></dt>
<dd><p>Set the color primaries.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>170m</var></dt>
<dt><var>240m</var></dt>
<dt><var>2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>transfer, t</samp></dt>
<dd><p>Set the transfer characteristics.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>601</var></dt>
<dt><var>linear</var></dt>
<dt><var>2020_10</var></dt>
<dt><var>2020_12</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>matrix, m</samp></dt>
<dd><p>Set the colorspace matrix.
</p>
<p>Possible value are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>470bg</var></dt>
<dt><var>170m</var></dt>
<dt><var>2020_ncl</var></dt>
<dt><var>2020_cl</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>rangein, rin</samp></dt>
<dd><p>Set the input color range.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>limited</var></dt>
<dt><var>full</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>primariesin, pin</samp></dt>
<dd><p>Set the input color primaries.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>170m</var></dt>
<dt><var>240m</var></dt>
<dt><var>2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>transferin, tin</samp></dt>
<dd><p>Set the input transfer characteristics.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>601</var></dt>
<dt><var>linear</var></dt>
<dt><var>2020_10</var></dt>
<dt><var>2020_12</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp>matrixin, min</samp></dt>
<dd><p>Set the input colorspace matrix.
</p>
<p>Possible value are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>709</var></dt>
<dt><var>unspecified</var></dt>
<dt><var>470bg</var></dt>
<dt><var>170m</var></dt>
<dt><var>2020_ncl</var></dt>
<dt><var>2020_cl</var></dt>
</dl>
</dd>
<dt><samp>chromal, c</samp></dt>
<dd><p>Set the output chroma location.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>left</var></dt>
<dt><var>center</var></dt>
<dt><var>topleft</var></dt>
<dt><var>top</var></dt>
<dt><var>bottomleft</var></dt>
<dt><var>bottom</var></dt>
</dl>
</dd>
<dt><samp>chromalin, cin</samp></dt>
<dd><p>Set the input chroma location.
</p>
<p>Possible values are:
</p><dl compact="compact">
<dt><var>input</var></dt>
<dt><var>left</var></dt>
<dt><var>center</var></dt>
<dt><var>topleft</var></dt>
<dt><var>top</var></dt>
<dt><var>bottomleft</var></dt>
<dt><var>bottom</var></dt>
</dl>
</dd>
</dl>
<p>The values of the <samp>w</samp> and <samp>h</samp> options are expressions
containing the following constants:
</p>
<dl compact="compact">
<dt><var>in_w</var></dt>
<dt><var>in_h</var></dt>
<dd><p>The input width and height
</p>
</dd>
<dt><var>iw</var></dt>
<dt><var>ih</var></dt>
<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>.
</p>
</dd>
<dt><var>out_w</var></dt>
<dt><var>out_h</var></dt>
<dd><p>The output (scaled) width and height
</p>
</dd>
<dt><var>ow</var></dt>
<dt><var>oh</var></dt>
<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>
</p>
</dd>
<dt><var>a</var></dt>
<dd><p>The same as <var>iw</var> / <var>ih</var>
</p>
</dd>
<dt><var>sar</var></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><var>dar</var></dt>
<dd><p>The input display aspect ratio. Calculated from <code>(iw / ih) * sar</code>.
</p>
</dd>
<dt><var>hsub</var></dt>
<dt><var>vsub</var></dt>
<dd><p>horizontal and vertical input chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p>
</dd>
<dt><var>ohsub</var></dt>
<dt><var>ovsub</var></dt>
<dd><p>horizontal and vertical output chroma subsample values. For example for the
pixel format &quot;yuv422p&quot; <var>hsub</var> is 2 and <var>vsub</var> is 1.
</p></dd>
</dl>
<a name="Video-Sources"></a>
<h2 class="chapter">32 Video Sources<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Sources" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Sources" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available video sources.
</p>
<a name="buffer"></a>
<h3 class="section">32.1 buffer<span class="pull-right"><a class="anchor hidden-xs" href="#buffer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-buffer" aria-hidden="true">TOC</a></span></h3>
<p>Buffer video frames, and make them available to the filter chain.
</p>
<p>This source is mainly intended for a programmatic use, in particular
through the interface defined in <samp>libavfilter/vsrc_buffer.h</samp>.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>video_size</samp></dt>
<dd><p>Specify the size (width and height) of the buffered video frames. For the
syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>width</samp></dt>
<dd><p>The input video width.
</p>
</dd>
<dt><samp>height</samp></dt>
<dd><p>The input video height.
</p>
</dd>
<dt><samp>pix_fmt</samp></dt>
<dd><p>A string representing the pixel format of the buffered video frames.
It may be a number corresponding to a pixel format, or a pixel format
name.
</p>
</dd>
<dt><samp>time_base</samp></dt>
<dd><p>Specify the timebase assumed by the timestamps of the buffered frames.
</p>
</dd>
<dt><samp>frame_rate</samp></dt>
<dd><p>Specify the frame rate expected for the video stream.
</p>
</dd>
<dt><samp>pixel_aspect, sar</samp></dt>
<dd><p>The sample (pixel) aspect ratio of the input video.
</p>
</dd>
<dt><samp>sws_param</samp></dt>
<dd><p>Specify the optional parameters to be used for the scale filter which
is automatically inserted when an input change is detected in the
input size or format.
</p>
</dd>
<dt><samp>hw_frames_ctx</samp></dt>
<dd><p>When using a hardware pixel format, this should be a reference to an
AVHWFramesContext describing input frames.
</p></dd>
</dl>
<p>For example:
</p><div class="example">
<pre class="example">buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
</pre></div>
<p>will instruct the source to accept video frames with size 320x240 and
with format &quot;yuv410p&quot;, assuming 1/24 as the timestamps timebase and
square pixels (1:1 sample aspect ratio).
Since the pixel format with name &quot;yuv410p&quot; corresponds to the number 6
(check the enum AVPixelFormat definition in <samp>libavutil/pixfmt.h</samp>),
this example corresponds to:
</p><div class="example">
<pre class="example">buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
</pre></div>
<p>Alternatively, the options can be specified as a flat string, but this
syntax is deprecated:
</p>
<p><var>width</var>:<var>height</var>:<var>pix_fmt</var>:<var>time_base.num</var>:<var>time_base.den</var>:<var>pixel_aspect.num</var>:<var>pixel_aspect.den</var>[:<var>sws_param</var>]
</p>
<a name="cellauto"></a>
<h3 class="section">32.2 cellauto<span class="pull-right"><a class="anchor hidden-xs" href="#cellauto" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cellauto" aria-hidden="true">TOC</a></span></h3>
<p>Create a pattern generated by an elementary cellular automaton.
</p>
<p>The initial state of the cellular automaton can be defined through the
<samp>filename</samp> and <samp>pattern</samp> options. If such options are
not specified an initial state is created randomly.
</p>
<p>At each new frame a new row in the video is filled with the result of
the cellular automaton next generation. The behavior when the whole
frame is filled is defined by the <samp>scroll</samp> option.
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>filename, f</samp></dt>
<dd><p>Read the initial cellular automaton state, i.e. the starting row, from
the specified file.
In the file, each non-whitespace character is considered an alive
cell, a newline will terminate the row, and further characters in the
file will be ignored.
</p>
</dd>
<dt><samp>pattern, p</samp></dt>
<dd><p>Read the initial cellular automaton state, i.e. the starting row, from
the specified string.
</p>
<p>Each non-whitespace character in the string is considered an alive
cell, a newline will terminate the row, and further characters in the
string will be ignored.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set the video rate, that is the number of frames generated per second.
Default is 25.
</p>
</dd>
<dt><samp>random_fill_ratio, ratio</samp></dt>
<dd><p>Set the random fill ratio for the initial cellular automaton row. It
is a floating point number value ranging from 0 to 1, defaults to
1/PHI.
</p>
<p>This option is ignored when a file or a pattern is specified.
</p>
</dd>
<dt><samp>random_seed, seed</samp></dt>
<dd><p>Set the seed for filling randomly the initial row, must be an integer
included between 0 and UINT32_MAX. If not specified, or if explicitly
set to -1, the filter will try to use a good random seed on a best
effort basis.
</p>
</dd>
<dt><samp>rule</samp></dt>
<dd><p>Set the cellular automaton rule, it is a number ranging from 0 to 255.
Default value is 110.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the size of the output video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
<p>If <samp>filename</samp> or <samp>pattern</samp> is specified, the size is set
by default to the width of the specified initial state row, and the
height is set to <var>width</var> * PHI.
</p>
<p>If <samp>size</samp> is set, it must contain the width of the specified
pattern string, and the specified pattern will be centered in the
larger row.
</p>
<p>If a filename or a pattern string is not specified, the size value
defaults to &quot;320x518&quot; (used for a randomly generated initial state).
</p>
</dd>
<dt><samp>scroll</samp></dt>
<dd><p>If set to 1, scroll the output upward when all the rows in the output
have been already filled. If set to 0, the new generated row will be
written over the top row just after the bottom row is filled.
Defaults to 1.
</p>
</dd>
<dt><samp>start_full, full</samp></dt>
<dd><p>If set to 1, completely fill the output with generated rows before
outputting the first frame.
This is the default behavior, for disabling set the value to 0.
</p>
</dd>
<dt><samp>stitch</samp></dt>
<dd><p>If set to 1, stitch the left and right row edges together.
This is the default behavior, for disabling set the value to 0.
</p></dd>
</dl>
<a name="Examples-107"></a>
<h4 class="subsection">32.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-107" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-107" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Read the initial state from <samp>pattern</samp>, and specify an output of
size 200x400.
<div class="example">
<pre class="example">cellauto=f=pattern:s=200x400
</pre></div>
</li><li> Generate a random initial row with a width of 200 cells, with a fill
ratio of 2/3:
<div class="example">
<pre class="example">cellauto=ratio=2/3:s=200x200
</pre></div>
</li><li> Create a pattern generated by rule 18 starting by a single alive cell
centered on an initial row with width 100:
<div class="example">
<pre class="example">cellauto=p=@:s=100x400:full=0:rule=18
</pre></div>
</li><li> Specify a more elaborated initial pattern:
<div class="example">
<pre class="example">cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
</pre></div>
</li></ul>
<a name="coreimagesrc"></a><a name="coreimagesrc-1"></a>
<h3 class="section">32.3 coreimagesrc<span class="pull-right"><a class="anchor hidden-xs" href="#coreimagesrc-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-coreimagesrc-1" aria-hidden="true">TOC</a></span></h3>
<p>Video source generated on GPU using Apple&rsquo;s CoreImage API on OSX.
</p>
<p>This video source is a specialized version of the <a href="#coreimage">coreimage</a> video filter.
Use a core image generator at the beginning of the applied filterchain to
generate the content.
</p>
<p>The coreimagesrc video source accepts the following options:
</p><dl compact="compact">
<dt><samp>list_generators</samp></dt>
<dd><p>List all available generators along with all their respective options as well as
possible minimum and maximum values along with the default values.
</p><div class="example">
<pre class="example">list_generators=true
</pre></div>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Specify the size of the sourced video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
The default value is <code>320x240</code>.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var>frame_rate_num</var>/<var>frame_rate_den</var>, an integer number, a floating point
number or a valid video frame rate abbreviation. The default value is
&quot;25&quot;.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>Set the sample aspect ratio of the sourced video.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Set the duration of the sourced video. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
</p>
<p>If not specified, or the expressed duration is negative, the video is
supposed to be generated forever.
</p></dd>
</dl>
<p>Additionally, all options of the <a href="#coreimage">coreimage</a> video filter are accepted.
A complete filterchain can be used for further processing of the
generated input without CPU-HOST transfer. See <a href="#coreimage">coreimage</a> documentation
and examples for details.
</p>
<a name="Examples-108"></a>
<h4 class="subsection">32.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-108" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-108" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Use CIQRCodeGenerator to create a QR code for the FFmpeg homepage,
given as complete and escaped command-line for Apple&rsquo;s standard bash shell:
<div class="example">
<pre class="example">ffmpeg -f lavfi -i coreimagesrc=s=100x100:filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
</pre></div>
<p>This example is equivalent to the QRCode example of <a href="#coreimage">coreimage</a> without the
need for a nullsrc video source.
</p></li></ul>
<a name="mandelbrot"></a>
<h3 class="section">32.4 mandelbrot<span class="pull-right"><a class="anchor hidden-xs" href="#mandelbrot" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mandelbrot" aria-hidden="true">TOC</a></span></h3>
<p>Generate a Mandelbrot set fractal, and progressively zoom towards the
point specified with <var>start_x</var> and <var>start_y</var>.
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>end_pts</samp></dt>
<dd><p>Set the terminal pts value. Default value is 400.
</p>
</dd>
<dt><samp>end_scale</samp></dt>
<dd><p>Set the terminal scale value.
Must be a floating point value. Default value is 0.3.
</p>
</dd>
<dt><samp>inner</samp></dt>
<dd><p>Set the inner coloring mode, that is the algorithm used to draw the
Mandelbrot fractal internal region.
</p>
<p>It shall assume one of the following values:
</p><dl compact="compact">
<dt><samp>black</samp></dt>
<dd><p>Set black mode.
</p></dd>
<dt><samp>convergence</samp></dt>
<dd><p>Show time until convergence.
</p></dd>
<dt><samp>mincol</samp></dt>
<dd><p>Set color based on point closest to the origin of the iterations.
</p></dd>
<dt><samp>period</samp></dt>
<dd><p>Set period mode.
</p></dd>
</dl>
<p>Default value is <var>mincol</var>.
</p>
</dd>
<dt><samp>bailout</samp></dt>
<dd><p>Set the bailout value. Default value is 10.0.
</p>
</dd>
<dt><samp>maxiter</samp></dt>
<dd><p>Set the maximum of iterations performed by the rendering
algorithm. Default value is 7189.
</p>
</dd>
<dt><samp>outer</samp></dt>
<dd><p>Set outer coloring mode.
It shall assume one of following values:
</p><dl compact="compact">
<dt><samp>iteration_count</samp></dt>
<dd><p>Set iteration cound mode.
</p></dd>
<dt><samp>normalized_iteration_count</samp></dt>
<dd><p>set normalized iteration count mode.
</p></dd>
</dl>
<p>Default value is <var>normalized_iteration_count</var>.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is &quot;25&quot;.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set frame size. For the syntax of this option, check the &quot;Video
size&quot; section in the ffmpeg-utils manual. Default value is &quot;640x480&quot;.
</p>
</dd>
<dt><samp>start_scale</samp></dt>
<dd><p>Set the initial scale value. Default value is 3.0.
</p>
</dd>
<dt><samp>start_x</samp></dt>
<dd><p>Set the initial x position. Must be a floating point value between
-100 and 100. Default value is -0.743643887037158704752191506114774.
</p>
</dd>
<dt><samp>start_y</samp></dt>
<dd><p>Set the initial y position. Must be a floating point value between
-100 and 100. Default value is -0.131825904205311970493132056385139.
</p></dd>
</dl>
<a name="mptestsrc"></a>
<h3 class="section">32.5 mptestsrc<span class="pull-right"><a class="anchor hidden-xs" href="#mptestsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mptestsrc" aria-hidden="true">TOC</a></span></h3>
<p>Generate various test patterns, as generated by the MPlayer test filter.
</p>
<p>The size of the generated video is fixed, and is 256x256.
This source is useful in particular for testing encoding features.
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var>frame_rate_num</var>/<var>frame_rate_den</var>, an integer number, a floating point
number or a valid video frame rate abbreviation. The default value is
&quot;25&quot;.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Set the duration of the sourced video. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
</p>
<p>If not specified, or the expressed duration is negative, the video is
supposed to be generated forever.
</p>
</dd>
<dt><samp>test, t</samp></dt>
<dd>
<p>Set the number or the name of the test to perform. Supported tests are:
</p><dl compact="compact">
<dt><samp>dc_luma</samp></dt>
<dt><samp>dc_chroma</samp></dt>
<dt><samp>freq_luma</samp></dt>
<dt><samp>freq_chroma</samp></dt>
<dt><samp>amp_luma</samp></dt>
<dt><samp>amp_chroma</samp></dt>
<dt><samp>cbp</samp></dt>
<dt><samp>mv</samp></dt>
<dt><samp>ring1</samp></dt>
<dt><samp>ring2</samp></dt>
<dt><samp>all</samp></dt>
</dl>
<p>Default value is &quot;all&quot;, which will cycle through the list of all tests.
</p></dd>
</dl>
<p>Some examples:
</p><div class="example">
<pre class="example">mptestsrc=t=dc_luma
</pre></div>
<p>will generate a &quot;dc_luma&quot; test pattern.
</p>
<a name="frei0r_005fsrc"></a>
<h3 class="section">32.6 frei0r_src<span class="pull-right"><a class="anchor hidden-xs" href="#frei0r_005fsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-frei0r_005fsrc" aria-hidden="true">TOC</a></span></h3>
<p>Provide a frei0r source.
</p>
<p>To enable compilation of this filter you need to install the frei0r
header and configure FFmpeg with <code>--enable-frei0r</code>.
</p>
<p>This source accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>size</samp></dt>
<dd><p>The size of the video to generate. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
</dd>
<dt><samp>framerate</samp></dt>
<dd><p>The framerate of the generated video. It may be a string of the form
<var>num</var>/<var>den</var> or a frame rate abbreviation.
</p>
</dd>
<dt><samp>filter_name</samp></dt>
<dd><p>The name to the frei0r source to load. For more information regarding frei0r and
how to set the parameters, read the <a href="#frei0r">frei0r</a> section in the video filters
documentation.
</p>
</dd>
<dt><samp>filter_params</samp></dt>
<dd><p>A &rsquo;|&rsquo;-separated list of parameters to pass to the frei0r source.
</p>
</dd>
</dl>
<p>For example, to generate a frei0r partik0l source with size 200x200
and frame rate 10 which is overlaid on the overlay filter main input:
</p><div class="example">
<pre class="example">frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
</pre></div>
<a name="life"></a>
<h3 class="section">32.7 life<span class="pull-right"><a class="anchor hidden-xs" href="#life" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-life" aria-hidden="true">TOC</a></span></h3>
<p>Generate a life pattern.
</p>
<p>This source is based on a generalization of John Conway&rsquo;s life game.
</p>
<p>The sourced input represents a life grid, each pixel represents a cell
which can be in one of two possible states, alive or dead. Every cell
interacts with its eight neighbours, which are the cells that are
horizontally, vertically, or diagonally adjacent.
</p>
<p>At each interaction the grid evolves according to the adopted rule,
which specifies the number of neighbor alive cells which will make a
cell stay alive or born. The <samp>rule</samp> option allows one to specify
the rule to adopt.
</p>
<p>This source accepts the following options:
</p>
<dl compact="compact">
<dt><samp>filename, f</samp></dt>
<dd><p>Set the file from which to read the initial grid state. In the file,
each non-whitespace character is considered an alive cell, and newline
is used to delimit the end of each row.
</p>
<p>If this option is not specified, the initial grid is generated
randomly.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set the video rate, that is the number of frames generated per second.
Default is 25.
</p>
</dd>
<dt><samp>random_fill_ratio, ratio</samp></dt>
<dd><p>Set the random fill ratio for the initial random grid. It is a
floating point number value ranging from 0 to 1, defaults to 1/PHI.
It is ignored when a file is specified.
</p>
</dd>
<dt><samp>random_seed, seed</samp></dt>
<dd><p>Set the seed for filling the initial random grid, must be an integer
included between 0 and UINT32_MAX. If not specified, or if explicitly
set to -1, the filter will try to use a good random seed on a best
effort basis.
</p>
</dd>
<dt><samp>rule</samp></dt>
<dd><p>Set the life rule.
</p>
<p>A rule can be specified with a code of the kind &quot;S<var>NS</var>/B<var>NB</var>&quot;,
where <var>NS</var> and <var>NB</var> are sequences of numbers in the range 0-8,
<var>NS</var> specifies the number of alive neighbor cells which make a
live cell stay alive, and <var>NB</var> the number of alive neighbor cells
which make a dead cell to become alive (i.e. to &quot;born&quot;).
&quot;s&quot; and &quot;b&quot; can be used in place of &quot;S&quot; and &quot;B&quot;, respectively.
</p>
<p>Alternatively a rule can be specified by an 18-bits integer. The 9
high order bits are used to encode the next cell state if it is alive
for each number of neighbor alive cells, the low order bits specify
the rule for &quot;borning&quot; new cells. Higher order bits encode for an
higher number of neighbor cells.
For example the number 6153 = <code>(12&lt;&lt;9)+9</code> specifies a stay alive
rule of 12 and a born rule of 9, which corresponds to &quot;S23/B03&quot;.
</p>
<p>Default value is &quot;S23/B3&quot;, which is the original Conway&rsquo;s game of life
rule, and will keep a cell alive if it has 2 or 3 neighbor alive
cells, and will born a new cell if there are three alive cells around
a dead cell.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the size of the output video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
</p>
<p>If <samp>filename</samp> is specified, the size is set by default to the
same size of the input file. If <samp>size</samp> is set, it must contain
the size specified in the input file, and the initial grid defined in
that file is centered in the larger resulting area.
</p>
<p>If a filename is not specified, the size value defaults to &quot;320x240&quot;
(used for a randomly generated initial grid).
</p>
</dd>
<dt><samp>stitch</samp></dt>
<dd><p>If set to 1, stitch the left and right grid edges together, and the
top and bottom edges also. Defaults to 1.
</p>
</dd>
<dt><samp>mold</samp></dt>
<dd><p>Set cell mold speed. If set, a dead cell will go from <samp>death_color</samp> to
<samp>mold_color</samp> with a step of <samp>mold</samp>. <samp>mold</samp> can have a
value from 0 to 255.
</p>
</dd>
<dt><samp>life_color</samp></dt>
<dd><p>Set the color of living (or new born) cells.
</p>
</dd>
<dt><samp>death_color</samp></dt>
<dd><p>Set the color of dead cells. If <samp>mold</samp> is set, this is the first color
used to represent a dead cell.
</p>
</dd>
<dt><samp>mold_color</samp></dt>
<dd><p>Set mold color, for definitely dead and moldy cells.
</p>
<p>For the syntax of these 3 color options, check the &quot;Color&quot; section in the
ffmpeg-utils manual.
</p></dd>
</dl>
<a name="Examples-109"></a>
<h4 class="subsection">32.7.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-109" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-109" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Read a grid from <samp>pattern</samp>, and center it on a grid of size
300x300 pixels:
<div class="example">
<pre class="example">life=f=pattern:s=300x300
</pre></div>
</li><li> Generate a random grid of size 200x200, with a fill ratio of 2/3:
<div class="example">
<pre class="example">life=ratio=2/3:s=200x200
</pre></div>
</li><li> Specify a custom rule for evolving a randomly generated grid:
<div class="example">
<pre class="example">life=rule=S14/B34
</pre></div>
</li><li> Full example with slow death effect (mold) using <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
</pre></div>
</li></ul>
<a name="allrgb"></a><a name="allyuv"></a><a name="color"></a><a name="haldclutsrc"></a><a name="nullsrc"></a><a name="rgbtestsrc"></a><a name="smptebars"></a><a name="smptehdbars"></a><a name="testsrc"></a><a name="testsrc2"></a><a name="yuvtestsrc"></a><a name="allrgb_002c-allyuv_002c-color_002c-haldclutsrc_002c-nullsrc_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc"></a>
<h3 class="section">32.8 allrgb, allyuv, color, haldclutsrc, nullsrc, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc<span class="pull-right"><a class="anchor hidden-xs" href="#allrgb_002c-allyuv_002c-color_002c-haldclutsrc_002c-nullsrc_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-allrgb_002c-allyuv_002c-color_002c-haldclutsrc_002c-nullsrc_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc" aria-hidden="true">TOC</a></span></h3>
<p>The <code>allrgb</code> source returns frames of size 4096x4096 of all rgb colors.
</p>
<p>The <code>allyuv</code> source returns frames of size 4096x4096 of all yuv colors.
</p>
<p>The <code>color</code> source provides an uniformly colored input.
</p>
<p>The <code>haldclutsrc</code> source provides an identity Hald CLUT. See also
<a href="#haldclut">haldclut</a> filter.
</p>
<p>The <code>nullsrc</code> source returns unprocessed video frames. It is
mainly useful to be employed in analysis / debugging tools, or as the
source for filters which ignore the input data.
</p>
<p>The <code>rgbtestsrc</code> source generates an RGB test pattern useful for
detecting RGB vs BGR issues. You should see a red, green and blue
stripe from top to bottom.
</p>
<p>The <code>smptebars</code> source generates a color bars pattern, based on
the SMPTE Engineering Guideline EG 1-1990.
</p>
<p>The <code>smptehdbars</code> source generates a color bars pattern, based on
the SMPTE RP 219-2002.
</p>
<p>The <code>testsrc</code> source generates a test video pattern, showing a
color pattern, a scrolling gradient and a timestamp. This is mainly
intended for testing purposes.
</p>
<p>The <code>testsrc2</code> source is similar to testsrc, but supports more
pixel formats instead of just <code>rgb24</code>. This allows using it as an
input for other tests without requiring a format conversion.
</p>
<p>The <code>yuvtestsrc</code> source generates an YUV test pattern. You should
see a y, cb and cr stripe from top to bottom.
</p>
<p>The sources accept the following parameters:
</p>
<dl compact="compact">
<dt><samp>color, c</samp></dt>
<dd><p>Specify the color of the source, only available in the <code>color</code>
source. For the syntax of this option, check the &quot;Color&quot; section in the
ffmpeg-utils manual.
</p>
</dd>
<dt><samp>level</samp></dt>
<dd><p>Specify the level of the Hald CLUT, only available in the <code>haldclutsrc</code>
source. A level of <code>N</code> generates a picture of <code>N*N*N</code> by <code>N*N*N</code>
pixels to be used as identity matrix for 3D lookup tables. Each component is
coded on a <code>1/(N*N)</code> scale.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Specify the size of the sourced video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
The default value is <code>320x240</code>.
</p>
<p>This option is not available with the <code>haldclutsrc</code> filter.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var>frame_rate_num</var>/<var>frame_rate_den</var>, an integer number, a floating point
number or a valid video frame rate abbreviation. The default value is
&quot;25&quot;.
</p>
</dd>
<dt><samp>sar</samp></dt>
<dd><p>Set the sample aspect ratio of the sourced video.
</p>
</dd>
<dt><samp>duration, d</samp></dt>
<dd><p>Set the duration of the sourced video. See
<a href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a>
for the accepted syntax.
</p>
<p>If not specified, or the expressed duration is negative, the video is
supposed to be generated forever.
</p>
</dd>
<dt><samp>decimals, n</samp></dt>
<dd><p>Set the number of decimals to show in the timestamp, only available in the
<code>testsrc</code> source.
</p>
<p>The displayed timestamp value will correspond to the original
timestamp value multiplied by the power of 10 of the specified
value. Default value is 0.
</p></dd>
</dl>
<p>For example the following:
</p><div class="example">
<pre class="example">testsrc=duration=5.3:size=qcif:rate=10
</pre></div>
<p>will generate a video with a duration of 5.3 seconds, with size
176x144 and a frame rate of 10 frames per second.
</p>
<p>The following graph description will generate a red source
with an opacity of 0.2, with size &quot;qcif&quot; and a frame rate of 10
frames per second.
</p><div class="example">
<pre class="example">color=c=red@0.2:s=qcif:r=10
</pre></div>
<p>If the input content is to be ignored, <code>nullsrc</code> can be used. The
following command generates noise in the luminance plane by employing
the <code>geq</code> filter:
</p><div class="example">
<pre class="example">nullsrc=s=256x256, geq=random(1)*255:128:128
</pre></div>
<a name="Commands-10"></a>
<h4 class="subsection">32.8.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-10" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-10" aria-hidden="true">TOC</a></span></h4>
<p>The <code>color</code> source supports the following commands:
</p>
<dl compact="compact">
<dt><samp>c, color</samp></dt>
<dd><p>Set the color of the created image. Accepts the same syntax of the
corresponding <samp>color</samp> option.
</p></dd>
</dl>
<a name="Video-Sinks"></a>
<h2 class="chapter">33 Video Sinks<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Sinks" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Sinks" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available video sinks.
</p>
<a name="buffersink"></a>
<h3 class="section">33.1 buffersink<span class="pull-right"><a class="anchor hidden-xs" href="#buffersink" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-buffersink" aria-hidden="true">TOC</a></span></h3>
<p>Buffer video frames, and make them available to the end of the filter
graph.
</p>
<p>This sink is mainly intended for programmatic use, in particular
through the interface defined in <samp>libavfilter/buffersink.h</samp>
or the options system.
</p>
<p>It accepts a pointer to an AVBufferSinkContext structure, which
defines the incoming buffers&rsquo; formats, to be passed as the opaque
parameter to <code>avfilter_init_filter</code> for initialization.
</p>
<a name="nullsink"></a>
<h3 class="section">33.2 nullsink<span class="pull-right"><a class="anchor hidden-xs" href="#nullsink" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-nullsink" aria-hidden="true">TOC</a></span></h3>
<p>Null video sink: do absolutely nothing with the input video. It is
mainly useful as a template and for use in analysis / debugging
tools.
</p>
<a name="Multimedia-Filters"></a>
<h2 class="chapter">34 Multimedia Filters<span class="pull-right"><a class="anchor hidden-xs" href="#Multimedia-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Multimedia-Filters" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available multimedia filters.
</p>
<a name="ahistogram"></a>
<h3 class="section">34.1 ahistogram<span class="pull-right"><a class="anchor hidden-xs" href="#ahistogram" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ahistogram" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output, displaying the volume histogram.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>dmode</samp></dt>
<dd><p>Specify how histogram is calculated.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>single</samp>&rsquo;</dt>
<dd><p>Use single histogram for all channels.
</p></dd>
<dt>&lsquo;<samp>separate</samp>&rsquo;</dt>
<dd><p>Use separate histogram for each channel.
</p></dd>
</dl>
<p>Default is <code>single</code>.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is &quot;25&quot;.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>hd720</code>.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set display scale.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>logarithmic
</p></dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>square root
</p></dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>cubic root
</p></dd>
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>linear
</p></dd>
<dt>&lsquo;<samp>rlog</samp>&rsquo;</dt>
<dd><p>reverse logarithmic
</p></dd>
</dl>
<p>Default is <code>log</code>.
</p>
</dd>
<dt><samp>ascale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>logarithmic
</p></dd>
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>linear
</p></dd>
</dl>
<p>Default is <code>log</code>.
</p>
</dd>
<dt><samp>acount</samp></dt>
<dd><p>Set how much frames to accumulate in histogram.
Defauls is 1. Setting this to -1 accumulates all frames.
</p>
</dd>
<dt><samp>rheight</samp></dt>
<dd><p>Set histogram ratio of window height.
</p>
</dd>
<dt><samp>slide</samp></dt>
<dd><p>Set sonogram sliding.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>replace</samp>&rsquo;</dt>
<dd><p>replace old rows with new ones.
</p></dd>
<dt>&lsquo;<samp>scroll</samp>&rsquo;</dt>
<dd><p>scroll from top to bottom.
</p></dd>
</dl>
<p>Default is <code>replace</code>.
</p></dd>
</dl>
<a name="aphasemeter"></a>
<h3 class="section">34.2 aphasemeter<span class="pull-right"><a class="anchor hidden-xs" href="#aphasemeter" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aphasemeter" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output, displaying the audio phase.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code>25</code>.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>800x400</code>.
</p>
</dd>
<dt><samp>rc</samp></dt>
<dt><samp>gc</samp></dt>
<dt><samp>bc</samp></dt>
<dd><p>Specify the red, green, blue contrast. Default values are <code>2</code>,
<code>7</code> and <code>1</code>.
Allowed range is <code>[0, 255]</code>.
</p>
</dd>
<dt><samp>mpc</samp></dt>
<dd><p>Set color which will be used for drawing median phase. If color is
<code>none</code> which is default, no median phase value will be drawn.
</p></dd>
</dl>
<p>The filter also exports the frame metadata <code>lavfi.aphasemeter.phase</code> which
represents mean phase of current audio frame. Value is in range <code>[-1, 1]</code>.
The <code>-1</code> means left and right channels are completely out of phase and
<code>1</code> means channels are in phase.
</p>
<a name="avectorscope"></a>
<h3 class="section">34.3 avectorscope<span class="pull-right"><a class="anchor hidden-xs" href="#avectorscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-avectorscope" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output, representing the audio vector
scope.
</p>
<p>The filter is used to measure the difference between channels of stereo
audio stream. A monoaural signal, consisting of identical left and right
signal, results in straight vertical line. Any stereo separation is visible
as a deviation from this line, creating a Lissajous figure.
If the straight (or deviation from it) but horizontal line appears this
indicates that the left and right channels are out of phase.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode, m</samp></dt>
<dd><p>Set the vectorscope mode.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>lissajous</samp>&rsquo;</dt>
<dd><p>Lissajous rotated by 45 degrees.
</p>
</dd>
<dt>&lsquo;<samp>lissajous_xy</samp>&rsquo;</dt>
<dd><p>Same as above but not rotated.
</p>
</dd>
<dt>&lsquo;<samp>polar</samp>&rsquo;</dt>
<dd><p>Shape resembling half of circle.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>lissajous</samp>&rsquo;.
</p>
</dd>
<dt><samp>size, s</samp></dt>
<dd><p>Set the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>400x400</code>.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code>25</code>.
</p>
</dd>
<dt><samp>rc</samp></dt>
<dt><samp>gc</samp></dt>
<dt><samp>bc</samp></dt>
<dt><samp>ac</samp></dt>
<dd><p>Specify the red, green, blue and alpha contrast. Default values are <code>40</code>,
<code>160</code>, <code>80</code> and <code>255</code>.
Allowed range is <code>[0, 255]</code>.
</p>
</dd>
<dt><samp>rf</samp></dt>
<dt><samp>gf</samp></dt>
<dt><samp>bf</samp></dt>
<dt><samp>af</samp></dt>
<dd><p>Specify the red, green, blue and alpha fade. Default values are <code>15</code>,
<code>10</code>, <code>5</code> and <code>5</code>.
Allowed range is <code>[0, 255]</code>.
</p>
</dd>
<dt><samp>zoom</samp></dt>
<dd><p>Set the zoom factor. Default value is <code>1</code>. Allowed range is <code>[1, 10]</code>.
</p>
</dd>
<dt><samp>draw</samp></dt>
<dd><p>Set the vectorscope drawing mode.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>dot</samp>&rsquo;</dt>
<dd><p>Draw dot for each sample.
</p>
</dd>
<dt>&lsquo;<samp>line</samp>&rsquo;</dt>
<dd><p>Draw line between previous and current sample.
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>dot</samp>&rsquo;.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Specify amplitude scale of audio samples.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>Linear.
</p>
</dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>Square root.
</p>
</dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>Cubic root.
</p>
</dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>Logarithmic.
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-110"></a>
<h4 class="subsection">34.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-110" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-110" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Complete example using <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
[a] avectorscope=zoom=1.3:rc=2:gc=200:bc=10:rf=1:gf=8:bf=7 [out0]'
</pre></div>
</li></ul>
<a name="bench_002c-abench"></a>
<h3 class="section">34.4 bench, abench<span class="pull-right"><a class="anchor hidden-xs" href="#bench_002c-abench" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bench_002c-abench" aria-hidden="true">TOC</a></span></h3>
<p>Benchmark part of a filtergraph.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>action</samp></dt>
<dd><p>Start or stop a timer.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>start</samp>&rsquo;</dt>
<dd><p>Get the current time, set it as frame metadata (using the key
<code>lavfi.bench.start_time</code>), and forward the frame to the next filter.
</p>
</dd>
<dt>&lsquo;<samp>stop</samp>&rsquo;</dt>
<dd><p>Get the current time and fetch the <code>lavfi.bench.start_time</code> metadata from
the input frame metadata to get the time difference. Time difference, average,
maximum and minimum time (respectively <code>t</code>, <code>avg</code>, <code>max</code> and
<code>min</code>) are then printed. The timestamps are expressed in seconds.
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-111"></a>
<h4 class="subsection">34.4.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-111" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-111" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Benchmark <a href="#selectivecolor">selectivecolor</a> filter:
<div class="example">
<pre class="example">bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
</pre></div>
</li></ul>
<a name="concat-3"></a>
<h3 class="section">34.5 concat<span class="pull-right"><a class="anchor hidden-xs" href="#concat-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concat-3" aria-hidden="true">TOC</a></span></h3>
<p>Concatenate audio and video streams, joining them together one after the
other.
</p>
<p>The filter works on segments of synchronized video and audio streams. All
segments must have the same number of streams of each type, and that will
also be the number of streams at output.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>Set the number of segments. Default is 2.
</p>
</dd>
<dt><samp>v</samp></dt>
<dd><p>Set the number of output video streams, that is also the number of video
streams in each segment. Default is 1.
</p>
</dd>
<dt><samp>a</samp></dt>
<dd><p>Set the number of output audio streams, that is also the number of audio
streams in each segment. Default is 0.
</p>
</dd>
<dt><samp>unsafe</samp></dt>
<dd><p>Activate unsafe mode: do not fail if segments have a different format.
</p>
</dd>
</dl>
<p>The filter has <var>v</var>+<var>a</var> outputs: first <var>v</var> video outputs, then
<var>a</var> audio outputs.
</p>
<p>There are <var>n</var>x(<var>v</var>+<var>a</var>) inputs: first the inputs for the first
segment, in the same order as the outputs, then the inputs for the second
segment, etc.
</p>
<p>Related streams do not always have exactly the same duration, for various
reasons including codec frame size or sloppy authoring. For that reason,
related synchronized streams (e.g. a video and its audio track) should be
concatenated at once. The concat filter will use the duration of the longest
stream in each segment (except the last one), and if necessary pad shorter
audio streams with silence.
</p>
<p>For this filter to work correctly, all segments must start at timestamp 0.
</p>
<p>All corresponding streams must have the same parameters in all segments; the
filtering system will automatically select a common pixel format for video
streams, and a common sample format, sample rate and channel layout for
audio streams, but other settings, such as resolution, must be converted
explicitly by the user.
</p>
<p>Different frame rates are acceptable but will result in variable frame rate
at output; be sure to configure the output file to handle it.
</p>
<a name="Examples-112"></a>
<h4 class="subsection">34.5.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-112" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-112" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Concatenate an opening, an episode and an ending, all in bilingual version
(video in stream 0, audio in streams 1 and 2):
<div class="example">
<pre class="example">ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
'[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
concat=n=3:v=1:a=2 [v] [a1] [a2]' \
-map '[v]' -map '[a1]' -map '[a2]' output.mkv
</pre></div>
</li><li> Concatenate two parts, handling audio and video separately, using the
(a)movie sources, and adjusting the resolution:
<div class="example">
<pre class="example">movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
[v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
</pre></div>
<p>Note that a desync will happen at the stitch if the audio and video streams
do not have exactly the same duration in the first file.
</p>
</li></ul>
<a name="drawgraph_002c-adrawgraph"></a>
<h3 class="section">34.6 drawgraph, adrawgraph<span class="pull-right"><a class="anchor hidden-xs" href="#drawgraph_002c-adrawgraph" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drawgraph_002c-adrawgraph" aria-hidden="true">TOC</a></span></h3>
<p>Draw a graph using input video or audio metadata.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>m1</samp></dt>
<dd><p>Set 1st frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp>fg1</samp></dt>
<dd><p>Set 1st foreground color expression.
</p>
</dd>
<dt><samp>m2</samp></dt>
<dd><p>Set 2nd frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp>fg2</samp></dt>
<dd><p>Set 2nd foreground color expression.
</p>
</dd>
<dt><samp>m3</samp></dt>
<dd><p>Set 3rd frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp>fg3</samp></dt>
<dd><p>Set 3rd foreground color expression.
</p>
</dd>
<dt><samp>m4</samp></dt>
<dd><p>Set 4th frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp>fg4</samp></dt>
<dd><p>Set 4th foreground color expression.
</p>
</dd>
<dt><samp>min</samp></dt>
<dd><p>Set minimal value of metadata value.
</p>
</dd>
<dt><samp>max</samp></dt>
<dd><p>Set maximal value of metadata value.
</p>
</dd>
<dt><samp>bg</samp></dt>
<dd><p>Set graph background color. Default is white.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set graph mode.
</p>
<p>Available values for mode is:
</p><dl compact="compact">
<dt>&lsquo;<samp>bar</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dot</samp>&rsquo;</dt>
<dt>&lsquo;<samp>line</samp>&rsquo;</dt>
</dl>
<p>Default is <code>line</code>.
</p>
</dd>
<dt><samp>slide</samp></dt>
<dd><p>Set slide mode.
</p>
<p>Available values for slide is:
</p><dl compact="compact">
<dt>&lsquo;<samp>frame</samp>&rsquo;</dt>
<dd><p>Draw new frame when right border is reached.
</p>
</dd>
<dt>&lsquo;<samp>replace</samp>&rsquo;</dt>
<dd><p>Replace old columns with new ones.
</p>
</dd>
<dt>&lsquo;<samp>scroll</samp>&rsquo;</dt>
<dd><p>Scroll from right to left.
</p>
</dd>
<dt>&lsquo;<samp>rscroll</samp>&rsquo;</dt>
<dd><p>Scroll from left to right.
</p>
</dd>
<dt>&lsquo;<samp>picture</samp>&rsquo;</dt>
<dd><p>Draw single picture.
</p></dd>
</dl>
<p>Default is <code>frame</code>.
</p>
</dd>
<dt><samp>size</samp></dt>
<dd><p>Set size of graph video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
The default value is <code>900x256</code>.
</p>
<p>The foreground color expressions can use the following variables:
</p><dl compact="compact">
<dt><samp>MIN</samp></dt>
<dd><p>Minimal value of metadata value.
</p>
</dd>
<dt><samp>MAX</samp></dt>
<dd><p>Maximal value of metadata value.
</p>
</dd>
<dt><samp>VAL</samp></dt>
<dd><p>Current metadata key value.
</p></dd>
</dl>
<p>The color is defined as 0xAABBGGRR.
</p></dd>
</dl>
<p>Example using metadata from <a href="#signalstats">signalstats</a> filter:
</p><div class="example">
<pre class="example">signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
</pre></div>
<p>Example using metadata from <a href="#ebur128">ebur128</a> filter:
</p><div class="example">
<pre class="example">ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
</pre></div>
<a name="ebur128"></a><a name="ebur128-1"></a>
<h3 class="section">34.7 ebur128<span class="pull-right"><a class="anchor hidden-xs" href="#ebur128-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ebur128-1" aria-hidden="true">TOC</a></span></h3>
<p>EBU R128 scanner filter. This filter takes an audio stream as input and outputs
it unchanged. By default, it logs a message at a frequency of 10Hz with the
Momentary loudness (identified by <code>M</code>), Short-term loudness (<code>S</code>),
Integrated loudness (<code>I</code>) and Loudness Range (<code>LRA</code>).
</p>
<p>The filter also has a video output (see the <var>video</var> option) with a real
time graph to observe the loudness evolution. The graphic contains the logged
message mentioned above, so it is not printed anymore when this option is set,
unless the verbose logging is set. The main graphing area contains the
short-term loudness (3 seconds of analysis), and the gauge on the right is for
the momentary loudness (400 milliseconds).
</p>
<p>More information about the Loudness Recommendation EBU R128 on
<a href="http://tech.ebu.ch/loudness">http://tech.ebu.ch/loudness</a>.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>video</samp></dt>
<dd><p>Activate the video output. The audio stream is passed unchanged whether this
option is set or no. The video stream will be the first output stream if
activated. Default is <code>0</code>.
</p>
</dd>
<dt><samp>size</samp></dt>
<dd><p>Set the video size. This option is for video only. For the syntax of this
option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default and minimum resolution is <code>640x480</code>.
</p>
</dd>
<dt><samp>meter</samp></dt>
<dd><p>Set the EBU scale meter. Default is <code>9</code>. Common values are <code>9</code> and
<code>18</code>, respectively for EBU scale meter +9 and EBU scale meter +18. Any
other integer value between this range is allowed.
</p>
</dd>
<dt><samp>metadata</samp></dt>
<dd><p>Set metadata injection. If set to <code>1</code>, the audio input will be segmented
into 100ms output frames, each of them containing various loudness information
in metadata. All the metadata keys are prefixed with <code>lavfi.r128.</code>.
</p>
<p>Default is <code>0</code>.
</p>
</dd>
<dt><samp>framelog</samp></dt>
<dd><p>Force the frame logging level.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>info</samp>&rsquo;</dt>
<dd><p>information logging level
</p></dd>
<dt>&lsquo;<samp>verbose</samp>&rsquo;</dt>
<dd><p>verbose logging level
</p></dd>
</dl>
<p>By default, the logging level is set to <var>info</var>. If the <samp>video</samp> or
the <samp>metadata</samp> options are set, it switches to <var>verbose</var>.
</p>
</dd>
<dt><samp>peak</samp></dt>
<dd><p>Set peak mode(s).
</p>
<p>Available modes can be cumulated (the option is a <code>flag</code> type). Possible
values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Disable any peak mode (default).
</p></dd>
<dt>&lsquo;<samp>sample</samp>&rsquo;</dt>
<dd><p>Enable sample-peak mode.
</p>
<p>Simple peak mode looking for the higher sample value. It logs a message
for sample-peak (identified by <code>SPK</code>).
</p></dd>
<dt>&lsquo;<samp>true</samp>&rsquo;</dt>
<dd><p>Enable true-peak mode.
</p>
<p>If enabled, the peak lookup is done on an over-sampled version of the input
stream for better peak accuracy. It logs a message for true-peak.
(identified by <code>TPK</code>) and true-peak per frame (identified by <code>FTPK</code>).
This mode requires a build with <code>libswresample</code>.
</p></dd>
</dl>
</dd>
<dt><samp>dualmono</samp></dt>
<dd><p>Treat mono input files as &quot;dual mono&quot;. If a mono file is intended for playback
on a stereo system, its EBU R128 measurement will be perceptually incorrect.
If set to <code>true</code>, this option will compensate for this effect.
Multi-channel input files are not affected by this option.
</p>
</dd>
<dt><samp>panlaw</samp></dt>
<dd><p>Set a specific pan law to be used for the measurement of dual mono files.
This parameter is optional, and has a default value of -3.01dB.
</p></dd>
</dl>
<a name="Examples-113"></a>
<h4 class="subsection">34.7.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-113" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-113" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Real-time graph using <code>ffplay</code>, with a EBU scale meter +18:
<div class="example">
<pre class="example">ffplay -f lavfi -i &quot;amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]&quot;
</pre></div>
</li><li> Run an analysis with <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
</pre></div>
</li></ul>
<a name="interleave_002c-ainterleave"></a>
<h3 class="section">34.8 interleave, ainterleave<span class="pull-right"><a class="anchor hidden-xs" href="#interleave_002c-ainterleave" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-interleave_002c-ainterleave" aria-hidden="true">TOC</a></span></h3>
<p>Temporally interleave frames from several inputs.
</p>
<p><code>interleave</code> works with video inputs, <code>ainterleave</code> with audio.
</p>
<p>These filters read frames from several inputs and send the oldest
queued frame to the output.
</p>
<p>Input streams must have well defined, monotonically increasing frame
timestamp values.
</p>
<p>In order to submit one frame to output, these filters need to enqueue
at least one frame for each input, so they cannot work in case one
input is not yet terminated and will not receive incoming frames.
</p>
<p>For example consider the case when one input is a <code>select</code> filter
which always drops input frames. The <code>interleave</code> filter will keep
reading from that input, but it will never be able to send new frames
to output until the input sends an end-of-stream signal.
</p>
<p>Also, depending on inputs synchronization, the filters will drop
frames in case one input receives more frames than the other ones, and
the queue is already filled.
</p>
<p>These filters accept the following options:
</p>
<dl compact="compact">
<dt><samp>nb_inputs, n</samp></dt>
<dd><p>Set the number of different inputs, it is 2 by default.
</p></dd>
</dl>
<a name="Examples-114"></a>
<h4 class="subsection">34.8.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-114" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-114" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Interleave frames belonging to different streams using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i bambi.avi -i pr0n.mkv -filter_complex &quot;[0:v][1:v] interleave&quot; out.avi
</pre></div>
</li><li> Add flickering blur effect:
<div class="example">
<pre class="example">select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
</pre></div>
</li></ul>
<a name="metadata_002c-ametadata"></a>
<h3 class="section">34.9 metadata, ametadata<span class="pull-right"><a class="anchor hidden-xs" href="#metadata_002c-ametadata" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-metadata_002c-ametadata" aria-hidden="true">TOC</a></span></h3>
<p>Manipulate frame metadata.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Set mode of operation of the filter.
</p>
<p>Can be one of the following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>select</samp>&rsquo;</dt>
<dd><p>If both <code>value</code> and <code>key</code> is set, select frames
which have such metadata. If only <code>key</code> is set, select
every frame that has such key in metadata.
</p>
</dd>
<dt>&lsquo;<samp>add</samp>&rsquo;</dt>
<dd><p>Add new metadata <code>key</code> and <code>value</code>. If key is already available
do nothing.
</p>
</dd>
<dt>&lsquo;<samp>modify</samp>&rsquo;</dt>
<dd><p>Modify value of already present key.
</p>
</dd>
<dt>&lsquo;<samp>delete</samp>&rsquo;</dt>
<dd><p>If <code>value</code> is set, delete only keys that have such value.
Otherwise, delete key. If <code>key</code> is not set, delete all metadata values in
the frame.
</p>
</dd>
<dt>&lsquo;<samp>print</samp>&rsquo;</dt>
<dd><p>Print key and its value if metadata was found. If <code>key</code> is not set print all
metadata values available in frame.
</p></dd>
</dl>
</dd>
<dt><samp>key</samp></dt>
<dd><p>Set key used with all modes. Must be set for all modes except <code>print</code> and <code>delete</code>.
</p>
</dd>
<dt><samp>value</samp></dt>
<dd><p>Set metadata value which will be used. This option is mandatory for
<code>modify</code> and <code>add</code> mode.
</p>
</dd>
<dt><samp>function</samp></dt>
<dd><p>Which function to use when comparing metadata value and <code>value</code>.
</p>
<p>Can be one of following:
</p>
<dl compact="compact">
<dt>&lsquo;<samp>same_str</samp>&rsquo;</dt>
<dd><p>Values are interpreted as strings, returns true if metadata value is same as <code>value</code>.
</p>
</dd>
<dt>&lsquo;<samp>starts_with</samp>&rsquo;</dt>
<dd><p>Values are interpreted as strings, returns true if metadata value starts with
the <code>value</code> option string.
</p>
</dd>
<dt>&lsquo;<samp>less</samp>&rsquo;</dt>
<dd><p>Values are interpreted as floats, returns true if metadata value is less than <code>value</code>.
</p>
</dd>
<dt>&lsquo;<samp>equal</samp>&rsquo;</dt>
<dd><p>Values are interpreted as floats, returns true if <code>value</code> is equal with metadata value.
</p>
</dd>
<dt>&lsquo;<samp>greater</samp>&rsquo;</dt>
<dd><p>Values are interpreted as floats, returns true if metadata value is greater than <code>value</code>.
</p>
</dd>
<dt>&lsquo;<samp>expr</samp>&rsquo;</dt>
<dd><p>Values are interpreted as floats, returns true if expression from option <code>expr</code>
evaluates to true.
</p></dd>
</dl>
</dd>
<dt><samp>expr</samp></dt>
<dd><p>Set expression which is used when <code>function</code> is set to <code>expr</code>.
The expression is evaluated through the eval API and can contain the following
constants:
</p>
<dl compact="compact">
<dt><samp>VALUE1</samp></dt>
<dd><p>Float representation of <code>value</code> from metadata key.
</p>
</dd>
<dt><samp>VALUE2</samp></dt>
<dd><p>Float representation of <code>value</code> as supplied by user in <code>value</code> option.
</p>
</dd>
<dt><samp>file</samp></dt>
<dd><p>If specified in <code>print</code> mode, output is written to the named file. Instead of
plain filename any writable url can be specified. Filename &ldquo;-&rdquo; is a shorthand
for standard output. If <code>file</code> option is not set, output is written to the log
with AV_LOG_INFO loglevel.
</p></dd>
</dl>
</dd>
</dl>
<a name="Examples-115"></a>
<h4 class="subsection">34.9.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-115" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-115" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Print all metadata values for frames with key <code>lavfi.singnalstats.YDIF</code> with values
between 0 and 1.
<div class="example">
<pre class="example">signalstats,metadata=print:key=lavfi.signalstats.YDIF:value=0:function=expr:expr='between(VALUE1,0,1)'
</pre></div>
</li><li> Print silencedetect output to file <samp>metadata.txt</samp>.
<div class="example">
<pre class="example">silencedetect,ametadata=mode=print:file=metadata.txt
</pre></div>
</li><li> Direct all metadata to a pipe with file descriptor 4.
<div class="example">
<pre class="example">metadata=mode=print:file='pipe\:4'
</pre></div>
</li></ul>
<a name="perms_002c-aperms"></a>
<h3 class="section">34.10 perms, aperms<span class="pull-right"><a class="anchor hidden-xs" href="#perms_002c-aperms" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-perms_002c-aperms" aria-hidden="true">TOC</a></span></h3>
<p>Set read/write permissions for the output frames.
</p>
<p>These filters are mainly aimed at developers to test direct path in the
following filter in the filtergraph.
</p>
<p>The filters accept the following options:
</p>
<dl compact="compact">
<dt><samp>mode</samp></dt>
<dd><p>Select the permissions mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>none</samp>&rsquo;</dt>
<dd><p>Do nothing. This is the default.
</p></dd>
<dt>&lsquo;<samp>ro</samp>&rsquo;</dt>
<dd><p>Set all the output frames read-only.
</p></dd>
<dt>&lsquo;<samp>rw</samp>&rsquo;</dt>
<dd><p>Set all the output frames directly writable.
</p></dd>
<dt>&lsquo;<samp>toggle</samp>&rsquo;</dt>
<dd><p>Make the frame read-only if writable, and writable if read-only.
</p></dd>
<dt>&lsquo;<samp>random</samp>&rsquo;</dt>
<dd><p>Set each output frame read-only or writable randomly.
</p></dd>
</dl>
</dd>
<dt><samp>seed</samp></dt>
<dd><p>Set the seed for the <var>random</var> mode, must be an integer included between
<code>0</code> and <code>UINT32_MAX</code>. If not specified, or if explicitly set to
<code>-1</code>, the filter will try to use a good random seed on a best effort
basis.
</p></dd>
</dl>
<p>Note: in case of auto-inserted filter between the permission filter and the
following one, the permission might not be received as expected in that
following filter. Inserting a <a href="#format">format</a> or <a href="#aformat">aformat</a> filter before the
perms/aperms filter can avoid this problem.
</p>
<a name="realtime_002c-arealtime"></a>
<h3 class="section">34.11 realtime, arealtime<span class="pull-right"><a class="anchor hidden-xs" href="#realtime_002c-arealtime" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-realtime_002c-arealtime" aria-hidden="true">TOC</a></span></h3>
<p>Slow down filtering to match real time approximatively.
</p>
<p>These filters will pause the filtering for a variable amount of time to
match the output rate with the input timestamps.
They are similar to the <samp>re</samp> option to <code>ffmpeg</code>.
</p>
<p>They accept the following options:
</p>
<dl compact="compact">
<dt><samp>limit</samp></dt>
<dd><p>Time limit for the pauses. Any pause longer than that will be considered
a timestamp discontinuity and reset the timer. Default is 2 seconds.
</p></dd>
</dl>
<a name="select"></a><a name="select_002c-aselect"></a>
<h3 class="section">34.12 select, aselect<span class="pull-right"><a class="anchor hidden-xs" href="#select_002c-aselect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-select_002c-aselect" aria-hidden="true">TOC</a></span></h3>
<p>Select frames to pass in output.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>expr, e</samp></dt>
<dd><p>Set expression, which is evaluated for each input frame.
</p>
<p>If the expression is evaluated to zero, the frame is discarded.
</p>
<p>If the evaluation result is negative or NaN, the frame is sent to the
first output; otherwise it is sent to the output with index
<code>ceil(val)-1</code>, assuming that the input index starts from 0.
</p>
<p>For example a value of <code>1.2</code> corresponds to the output with index
<code>ceil(1.2)-1 = 2-1 = 1</code>, that is the second output.
</p>
</dd>
<dt><samp>outputs, n</samp></dt>
<dd><p>Set the number of outputs. The output to which to send the selected
frame is based on the result of the evaluation. Default value is 1.
</p></dd>
</dl>
<p>The expression can contain the following constants:
</p>
<dl compact="compact">
<dt><samp>n</samp></dt>
<dd><p>The (sequential) number of the filtered frame, starting from 0.
</p>
</dd>
<dt><samp>selected_n</samp></dt>
<dd><p>The (sequential) number of the selected frame, starting from 0.
</p>
</dd>
<dt><samp>prev_selected_n</samp></dt>
<dd><p>The sequential number of the last selected frame. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>TB</samp></dt>
<dd><p>The timebase of the input timestamps.
</p>
</dd>
<dt><samp>pts</samp></dt>
<dd><p>The PTS (Presentation TimeStamp) of the filtered video frame,
expressed in <var>TB</var> units. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>t</samp></dt>
<dd><p>The PTS of the filtered video frame,
expressed in seconds. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>prev_pts</samp></dt>
<dd><p>The PTS of the previously filtered video frame. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>prev_selected_pts</samp></dt>
<dd><p>The PTS of the last previously filtered video frame. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>prev_selected_t</samp></dt>
<dd><p>The PTS of the last previously selected video frame. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>start_pts</samp></dt>
<dd><p>The PTS of the first video frame in the video. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>start_t</samp></dt>
<dd><p>The time of the first video frame in the video. It&rsquo;s NAN if undefined.
</p>
</dd>
<dt><samp>pict_type <em>(video only)</em></samp></dt>
<dd><p>The type of the filtered frame. It can assume one of the following
values:
</p><dl compact="compact">
<dt><samp>I</samp></dt>
<dt><samp>P</samp></dt>
<dt><samp>B</samp></dt>
<dt><samp>S</samp></dt>
<dt><samp>SI</samp></dt>
<dt><samp>SP</samp></dt>
<dt><samp>BI</samp></dt>
</dl>
</dd>
<dt><samp>interlace_type <em>(video only)</em></samp></dt>
<dd><p>The frame interlace type. It can assume one of the following values:
</p><dl compact="compact">
<dt><samp>PROGRESSIVE</samp></dt>
<dd><p>The frame is progressive (not interlaced).
</p></dd>
<dt><samp>TOPFIRST</samp></dt>
<dd><p>The frame is top-field-first.
</p></dd>
<dt><samp>BOTTOMFIRST</samp></dt>
<dd><p>The frame is bottom-field-first.
</p></dd>
</dl>
</dd>
<dt><samp>consumed_sample_n <em>(audio only)</em></samp></dt>
<dd><p>the number of selected samples before the current frame
</p>
</dd>
<dt><samp>samples_n <em>(audio only)</em></samp></dt>
<dd><p>the number of samples in the current frame
</p>
</dd>
<dt><samp>sample_rate <em>(audio only)</em></samp></dt>
<dd><p>the input sample rate
</p>
</dd>
<dt><samp>key</samp></dt>
<dd><p>This is 1 if the filtered frame is a key-frame, 0 otherwise.
</p>
</dd>
<dt><samp>pos</samp></dt>
<dd><p>the position in the file of the filtered frame, -1 if the information
is not available (e.g. for synthetic video)
</p>
</dd>
<dt><samp>scene <em>(video only)</em></samp></dt>
<dd><p>value between 0 and 1 to indicate a new scene; a low value reflects a low
probability for the current frame to introduce a new scene, while a higher
value means the current frame is more likely to be one (see the example below)
</p>
</dd>
<dt><samp>concatdec_select</samp></dt>
<dd><p>The concat demuxer can select only part of a concat input file by setting an
inpoint and an outpoint, but the output packets may not be entirely contained
in the selected interval. By using this variable, it is possible to skip frames
generated by the concat demuxer which are not exactly contained in the selected
interval.
</p>
<p>This works by comparing the frame pts against the <var>lavf.concat.start_time</var>
and the <var>lavf.concat.duration</var> packet metadata values which are also
present in the decoded frames.
</p>
<p>The <var>concatdec_select</var> variable is -1 if the frame pts is at least
start_time and either the duration metadata is missing or the frame pts is less
than start_time + duration, 0 otherwise, and NaN if the start_time metadata is
missing.
</p>
<p>That basically means that an input frame is selected if its pts is within the
interval set by the concat demuxer.
</p>
</dd>
</dl>
<p>The default value of the select expression is &quot;1&quot;.
</p>
<a name="Examples-116"></a>
<h4 class="subsection">34.12.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-116" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-116" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Select all frames in input:
<div class="example">
<pre class="example">select
</pre></div>
<p>The example above is the same as:
</p><div class="example">
<pre class="example">select=1
</pre></div>
</li><li> Skip all frames:
<div class="example">
<pre class="example">select=0
</pre></div>
</li><li> Select only I-frames:
<div class="example">
<pre class="example">select='eq(pict_type\,I)'
</pre></div>
</li><li> Select one frame every 100:
<div class="example">
<pre class="example">select='not(mod(n\,100))'
</pre></div>
</li><li> Select only frames contained in the 10-20 time interval:
<div class="example">
<pre class="example">select=between(t\,10\,20)
</pre></div>
</li><li> Select only I-frames contained in the 10-20 time interval:
<div class="example">
<pre class="example">select=between(t\,10\,20)*eq(pict_type\,I)
</pre></div>
</li><li> Select frames with a minimum distance of 10 seconds:
<div class="example">
<pre class="example">select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
</pre></div>
</li><li> Use aselect to select only audio frames with samples number &gt; 100:
<div class="example">
<pre class="example">aselect='gt(samples_n\,100)'
</pre></div>
</li><li> Create a mosaic of the first scenes:
<div class="example">
<pre class="example">ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
</pre></div>
<p>Comparing <var>scene</var> against a value between 0.3 and 0.5 is generally a sane
choice.
</p>
</li><li> Send even and odd frames to separate outputs, and compose them:
<div class="example">
<pre class="example">select=n=2:e='mod(n, 2)+1' [odd][even]; [odd] pad=h=2*ih [tmp]; [tmp][even] overlay=y=h
</pre></div>
</li><li> Select useful frames from an ffconcat file which is using inpoints and
outpoints but where the source files are not intra frame only.
<div class="example">
<pre class="example">ffmpeg -copyts -vsync 0 -segment_time_metadata 1 -i input.ffconcat -vf select=concatdec_select -af aselect=concatdec_select output.avi
</pre></div>
</li></ul>
<a name="sendcmd_002c-asendcmd"></a>
<h3 class="section">34.13 sendcmd, asendcmd<span class="pull-right"><a class="anchor hidden-xs" href="#sendcmd_002c-asendcmd" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sendcmd_002c-asendcmd" aria-hidden="true">TOC</a></span></h3>
<p>Send commands to filters in the filtergraph.
</p>
<p>These filters read commands to be sent to other filters in the
filtergraph.
</p>
<p><code>sendcmd</code> must be inserted between two video filters,
<code>asendcmd</code> must be inserted between two audio filters, but apart
from that they act the same way.
</p>
<p>The specification of commands can be provided in the filter arguments
with the <var>commands</var> option, or in a file specified by the
<var>filename</var> option.
</p>
<p>These filters accept the following options:
</p><dl compact="compact">
<dt><samp>commands, c</samp></dt>
<dd><p>Set the commands to be read and sent to the other filters.
</p></dd>
<dt><samp>filename, f</samp></dt>
<dd><p>Set the filename of the commands to be read and sent to the other
filters.
</p></dd>
</dl>
<a name="Commands-syntax"></a>
<h4 class="subsection">34.13.1 Commands syntax<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-syntax" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-syntax" aria-hidden="true">TOC</a></span></h4>
<p>A commands description consists of a sequence of interval
specifications, comprising a list of commands to be executed when a
particular event related to that interval occurs. The occurring event
is typically the current frame time entering or leaving a given time
interval.
</p>
<p>An interval is specified by the following syntax:
</p><div class="example">
<pre class="example"><var>START</var>[-<var>END</var>] <var>COMMANDS</var>;
</pre></div>
<p>The time interval is specified by the <var>START</var> and <var>END</var> times.
<var>END</var> is optional and defaults to the maximum time.
</p>
<p>The current frame time is considered within the specified interval if
it is included in the interval [<var>START</var>, <var>END</var>), that is when
the time is greater or equal to <var>START</var> and is lesser than
<var>END</var>.
</p>
<p><var>COMMANDS</var> consists of a sequence of one or more command
specifications, separated by &quot;,&quot;, relating to that interval. The
syntax of a command specification is given by:
</p><div class="example">
<pre class="example">[<var>FLAGS</var>] <var>TARGET</var> <var>COMMAND</var> <var>ARG</var>
</pre></div>
<p><var>FLAGS</var> is optional and specifies the type of events relating to
the time interval which enable sending the specified command, and must
be a non-null sequence of identifier flags separated by &quot;+&quot; or &quot;|&quot; and
enclosed between &quot;[&quot; and &quot;]&quot;.
</p>
<p>The following flags are recognized:
</p><dl compact="compact">
<dt><samp>enter</samp></dt>
<dd><p>The command is sent when the current frame timestamp enters the
specified interval. In other words, the command is sent when the
previous frame timestamp was not in the given interval, and the
current is.
</p>
</dd>
<dt><samp>leave</samp></dt>
<dd><p>The command is sent when the current frame timestamp leaves the
specified interval. In other words, the command is sent when the
previous frame timestamp was in the given interval, and the
current is not.
</p></dd>
</dl>
<p>If <var>FLAGS</var> is not specified, a default value of <code>[enter]</code> is
assumed.
</p>
<p><var>TARGET</var> specifies the target of the command, usually the name of
the filter class or a specific filter instance name.
</p>
<p><var>COMMAND</var> specifies the name of the command for the target filter.
</p>
<p><var>ARG</var> is optional and specifies the optional list of argument for
the given <var>COMMAND</var>.
</p>
<p>Between one interval specification and another, whitespaces, or
sequences of characters starting with <code>#</code> until the end of line,
are ignored and can be used to annotate comments.
</p>
<p>A simplified BNF description of the commands specification syntax
follows:
</p><div class="example">
<pre class="example"><var>COMMAND_FLAG</var> ::= &quot;enter&quot; | &quot;leave&quot;
<var>COMMAND_FLAGS</var> ::= <var>COMMAND_FLAG</var> [(+|&quot;|&quot;)<var>COMMAND_FLAG</var>]
<var>COMMAND</var> ::= [&quot;[&quot; <var>COMMAND_FLAGS</var> &quot;]&quot;] <var>TARGET</var> <var>COMMAND</var> [<var>ARG</var>]
<var>COMMANDS</var> ::= <var>COMMAND</var> [,<var>COMMANDS</var>]
<var>INTERVAL</var> ::= <var>START</var>[-<var>END</var>] <var>COMMANDS</var>
<var>INTERVALS</var> ::= <var>INTERVAL</var>[;<var>INTERVALS</var>]
</pre></div>
<a name="Examples-117"></a>
<h4 class="subsection">34.13.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-117" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-117" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Specify audio tempo change at second 4:
<div class="example">
<pre class="example">asendcmd=c='4.0 atempo tempo 1.5',atempo
</pre></div>
</li><li> Specify a list of drawtext and hue commands in a file.
<div class="example">
<pre class="example"># show text in the interval 5-10
5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
[leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
# desaturate the image in the interval 15-20
15.0-20.0 [enter] hue s 0,
[enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
[leave] hue s 1,
[leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
# apply an exponential saturation fade-out effect, starting from time 25
25 [enter] hue s exp(25-t)
</pre></div>
<p>A filtergraph allowing to read and process the above command list
stored in a file <samp>test.cmd</samp>, can be specified with:
</p><div class="example">
<pre class="example">sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
</pre></div>
</li></ul>
<a name="setpts"></a><a name="setpts_002c-asetpts"></a>
<h3 class="section">34.14 setpts, asetpts<span class="pull-right"><a class="anchor hidden-xs" href="#setpts_002c-asetpts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-setpts_002c-asetpts" aria-hidden="true">TOC</a></span></h3>
<p>Change the PTS (presentation timestamp) of the input frames.
</p>
<p><code>setpts</code> works on video frames, <code>asetpts</code> on audio frames.
</p>
<p>This filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>expr</samp></dt>
<dd><p>The expression which is evaluated for each frame to construct its timestamp.
</p>
</dd>
</dl>
<p>The expression is evaluated through the eval API and can contain the following
constants:
</p>
<dl compact="compact">
<dt><samp>FRAME_RATE</samp></dt>
<dd><p>frame rate, only defined for constant frame-rate video
</p>
</dd>
<dt><samp>PTS</samp></dt>
<dd><p>The presentation timestamp in input
</p>
</dd>
<dt><samp>N</samp></dt>
<dd><p>The count of the input frame for video or the number of consumed samples,
not including the current frame for audio, starting from 0.
</p>
</dd>
<dt><samp>NB_CONSUMED_SAMPLES</samp></dt>
<dd><p>The number of consumed samples, not including the current frame (only
audio)
</p>
</dd>
<dt><samp>NB_SAMPLES, S</samp></dt>
<dd><p>The number of samples in the current frame (only audio)
</p>
</dd>
<dt><samp>SAMPLE_RATE, SR</samp></dt>
<dd><p>The audio sample rate.
</p>
</dd>
<dt><samp>STARTPTS</samp></dt>
<dd><p>The PTS of the first frame.
</p>
</dd>
<dt><samp>STARTT</samp></dt>
<dd><p>the time in seconds of the first frame
</p>
</dd>
<dt><samp>INTERLACED</samp></dt>
<dd><p>State whether the current frame is interlaced.
</p>
</dd>
<dt><samp>T</samp></dt>
<dd><p>the time in seconds of the current frame
</p>
</dd>
<dt><samp>POS</samp></dt>
<dd><p>original position in the file of the frame, or undefined if undefined
for the current frame
</p>
</dd>
<dt><samp>PREV_INPTS</samp></dt>
<dd><p>The previous input PTS.
</p>
</dd>
<dt><samp>PREV_INT</samp></dt>
<dd><p>previous input time in seconds
</p>
</dd>
<dt><samp>PREV_OUTPTS</samp></dt>
<dd><p>The previous output PTS.
</p>
</dd>
<dt><samp>PREV_OUTT</samp></dt>
<dd><p>previous output time in seconds
</p>
</dd>
<dt><samp>RTCTIME</samp></dt>
<dd><p>The wallclock (RTC) time in microseconds. This is deprecated, use time(0)
instead.
</p>
</dd>
<dt><samp>RTCSTART</samp></dt>
<dd><p>The wallclock (RTC) time at the start of the movie in microseconds.
</p>
</dd>
<dt><samp>TB</samp></dt>
<dd><p>The timebase of the input timestamps.
</p>
</dd>
</dl>
<a name="Examples-118"></a>
<h4 class="subsection">34.14.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-118" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-118" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Start counting PTS from zero
<div class="example">
<pre class="example">setpts=PTS-STARTPTS
</pre></div>
</li><li> Apply fast motion effect:
<div class="example">
<pre class="example">setpts=0.5*PTS
</pre></div>
</li><li> Apply slow motion effect:
<div class="example">
<pre class="example">setpts=2.0*PTS
</pre></div>
</li><li> Set fixed rate of 25 frames per second:
<div class="example">
<pre class="example">setpts=N/(25*TB)
</pre></div>
</li><li> Set fixed rate 25 fps with some jitter:
<div class="example">
<pre class="example">setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
</pre></div>
</li><li> Apply an offset of 10 seconds to the input PTS:
<div class="example">
<pre class="example">setpts=PTS+10/TB
</pre></div>
</li><li> Generate timestamps from a &quot;live source&quot; and rebase onto the current timebase:
<div class="example">
<pre class="example">setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
</pre></div>
</li><li> Generate timestamps by counting samples:
<div class="example">
<pre class="example">asetpts=N/SR/TB
</pre></div>
</li></ul>
<a name="settb_002c-asettb"></a>
<h3 class="section">34.15 settb, asettb<span class="pull-right"><a class="anchor hidden-xs" href="#settb_002c-asettb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-settb_002c-asettb" aria-hidden="true">TOC</a></span></h3>
<p>Set the timebase to use for the output frames timestamps.
It is mainly useful for testing timebase configuration.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>expr, tb</samp></dt>
<dd><p>The expression which is evaluated into the output timebase.
</p>
</dd>
</dl>
<p>The value for <samp>tb</samp> is an arithmetic expression representing a
rational. The expression can contain the constants &quot;AVTB&quot; (the default
timebase), &quot;intb&quot; (the input timebase) and &quot;sr&quot; (the sample rate,
audio only). Default value is &quot;intb&quot;.
</p>
<a name="Examples-119"></a>
<h4 class="subsection">34.15.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-119" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-119" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Set the timebase to 1/25:
<div class="example">
<pre class="example">settb=expr=1/25
</pre></div>
</li><li> Set the timebase to 1/10:
<div class="example">
<pre class="example">settb=expr=0.1
</pre></div>
</li><li> Set the timebase to 1001/1000:
<div class="example">
<pre class="example">settb=1+0.001
</pre></div>
</li><li> Set the timebase to 2*intb:
<div class="example">
<pre class="example">settb=2*intb
</pre></div>
</li><li> Set the default timebase value:
<div class="example">
<pre class="example">settb=AVTB
</pre></div>
</li></ul>
<a name="showcqt"></a>
<h3 class="section">34.16 showcqt<span class="pull-right"><a class="anchor hidden-xs" href="#showcqt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showcqt" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output representing frequency spectrum
logarithmically using Brown-Puckette constant Q transform algorithm with
direct frequency domain coefficient calculation (but the transform itself
is not really constant Q, instead the Q factor is actually variable/clamped),
with musical tone scale, from E0 to D#10.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. It must be even. For the syntax of this option,
check the <a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>1920x1080</code>.
</p>
</dd>
<dt><samp>fps, rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code>25</code>.
</p>
</dd>
<dt><samp>bar_h</samp></dt>
<dd><p>Set the bargraph height. It must be even. Default value is <code>-1</code> which
computes the bargraph height automatically.
</p>
</dd>
<dt><samp>axis_h</samp></dt>
<dd><p>Set the axis height. It must be even. Default value is <code>-1</code> which computes
the axis height automatically.
</p>
</dd>
<dt><samp>sono_h</samp></dt>
<dd><p>Set the sonogram height. It must be even. Default value is <code>-1</code> which
computes the sonogram height automatically.
</p>
</dd>
<dt><samp>fullhd</samp></dt>
<dd><p>Set the fullhd resolution. This option is deprecated, use <var>size</var>, <var>s</var>
instead. Default value is <code>1</code>.
</p>
</dd>
<dt><samp>sono_v, volume</samp></dt>
<dd><p>Specify the sonogram volume expression. It can contain variables:
</p><dl compact="compact">
<dt><samp>bar_v</samp></dt>
<dd><p>the <var>bar_v</var> evaluated expression
</p></dd>
<dt><samp>frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp>timeclamp, tc</samp></dt>
<dd><p>the value of <var>timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl compact="compact">
<dt><samp>a_weighting(f)</samp></dt>
<dd><p>A-weighting of equal loudness
</p></dd>
<dt><samp>b_weighting(f)</samp></dt>
<dd><p>B-weighting of equal loudness
</p></dd>
<dt><samp>c_weighting(f)</samp></dt>
<dd><p>C-weighting of equal loudness.
</p></dd>
</dl>
<p>Default value is <code>16</code>.
</p>
</dd>
<dt><samp>bar_v, volume2</samp></dt>
<dd><p>Specify the bargraph volume expression. It can contain variables:
</p><dl compact="compact">
<dt><samp>sono_v</samp></dt>
<dd><p>the <var>sono_v</var> evaluated expression
</p></dd>
<dt><samp>frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp>timeclamp, tc</samp></dt>
<dd><p>the value of <var>timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl compact="compact">
<dt><samp>a_weighting(f)</samp></dt>
<dd><p>A-weighting of equal loudness
</p></dd>
<dt><samp>b_weighting(f)</samp></dt>
<dd><p>B-weighting of equal loudness
</p></dd>
<dt><samp>c_weighting(f)</samp></dt>
<dd><p>C-weighting of equal loudness.
</p></dd>
</dl>
<p>Default value is <code>sono_v</code>.
</p>
</dd>
<dt><samp>sono_g, gamma</samp></dt>
<dd><p>Specify the sonogram gamma. Lower gamma makes the spectrum more contrast,
higher gamma makes the spectrum having more range. Default value is <code>3</code>.
Acceptable range is <code>[1, 7]</code>.
</p>
</dd>
<dt><samp>bar_g, gamma2</samp></dt>
<dd><p>Specify the bargraph gamma. Default value is <code>1</code>. Acceptable range is
<code>[1, 7]</code>.
</p>
</dd>
<dt><samp>timeclamp, tc</samp></dt>
<dd><p>Specify the transform timeclamp. At low frequency, there is trade-off between
accuracy in time domain and frequency domain. If timeclamp is lower,
event in time domain is represented more accurately (such as fast bass drum),
otherwise event in frequency domain is represented more accurately
(such as bass guitar). Acceptable range is <code>[0.1, 1]</code>. Default value is <code>0.17</code>.
</p>
</dd>
<dt><samp>basefreq</samp></dt>
<dd><p>Specify the transform base frequency. Default value is <code>20.01523126408007475</code>,
which is frequency 50 cents below E0. Acceptable range is <code>[10, 100000]</code>.
</p>
</dd>
<dt><samp>endfreq</samp></dt>
<dd><p>Specify the transform end frequency. Default value is <code>20495.59681441799654</code>,
which is frequency 50 cents above D#10. Acceptable range is <code>[10, 100000]</code>.
</p>
</dd>
<dt><samp>coeffclamp</samp></dt>
<dd><p>This option is deprecated and ignored.
</p>
</dd>
<dt><samp>tlength</samp></dt>
<dd><p>Specify the transform length in time domain. Use this option to control accuracy
trade-off between time domain and frequency domain at every frequency sample.
It can contain variables:
</p><dl compact="compact">
<dt><samp>frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp>timeclamp, tc</samp></dt>
<dd><p>the value of <var>timeclamp</var> option.
</p></dd>
</dl>
<p>Default value is <code>384*tc/(384+tc*f)</code>.
</p>
</dd>
<dt><samp>count</samp></dt>
<dd><p>Specify the transform count for every video frame. Default value is <code>6</code>.
Acceptable range is <code>[1, 30]</code>.
</p>
</dd>
<dt><samp>fcount</samp></dt>
<dd><p>Specify the transform count for every single pixel. Default value is <code>0</code>,
which makes it computed automatically. Acceptable range is <code>[0, 10]</code>.
</p>
</dd>
<dt><samp>fontfile</samp></dt>
<dd><p>Specify font file for use with freetype to draw the axis. If not specified,
use embedded font. Note that drawing with font file or embedded font is not
implemented with custom <var>basefreq</var> and <var>endfreq</var>, use <var>axisfile</var>
option instead.
</p>
</dd>
<dt><samp>fontcolor</samp></dt>
<dd><p>Specify font color expression. This is arithmetic expression that should return
integer value 0xRRGGBB. It can contain variables:
</p><dl compact="compact">
<dt><samp>frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp>timeclamp, tc</samp></dt>
<dd><p>the value of <var>timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl compact="compact">
<dt><samp>midi(f)</samp></dt>
<dd><p>midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69)
</p></dd>
<dt><samp>r(x), g(x), b(x)</samp></dt>
<dd><p>red, green, and blue value of intensity x.
</p></dd>
</dl>
<p>Default value is <code>st(0, (midi(f)-59.5)/12);
st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0));
r(1-ld(1)) + b(ld(1))</code>.
</p>
</dd>
<dt><samp>axisfile</samp></dt>
<dd><p>Specify image file to draw the axis. This option override <var>fontfile</var> and
<var>fontcolor</var> option.
</p>
</dd>
<dt><samp>axis, text</samp></dt>
<dd><p>Enable/disable drawing text to the axis. If it is set to <code>0</code>, drawing to
the axis is disabled, ignoring <var>fontfile</var> and <var>axisfile</var> option.
Default value is <code>1</code>.
</p>
</dd>
</dl>
<a name="Examples-120"></a>
<h4 class="subsection">34.16.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-120" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-120" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Playing audio while showing the spectrum:
<div class="example">
<pre class="example">ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt [out0]'
</pre></div>
</li><li> Same as above, but with frame rate 30 fps:
<div class="example">
<pre class="example">ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=fps=30:count=5 [out0]'
</pre></div>
</li><li> Playing at 1280x720:
<div class="example">
<pre class="example">ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=s=1280x720:count=4 [out0]'
</pre></div>
</li><li> Disable sonogram display:
<div class="example">
<pre class="example">sono_h=0
</pre></div>
</li><li> A1 and its harmonics: A1, A2, (near)E3, A3:
<div class="example">
<pre class="example">ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
asplit[a][out1]; [a] showcqt [out0]'
</pre></div>
</li><li> Same as above, but with more accuracy in frequency domain:
<div class="example">
<pre class="example">ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
asplit[a][out1]; [a] showcqt=timeclamp=0.5 [out0]'
</pre></div>
</li><li> Custom volume:
<div class="example">
<pre class="example">bar_v=10:sono_v=bar_v*a_weighting(f)
</pre></div>
</li><li> Custom gamma, now spectrum is linear to the amplitude.
<div class="example">
<pre class="example">bar_g=2:sono_g=2
</pre></div>
</li><li> Custom tlength equation:
<div class="example">
<pre class="example">tc=0.33:tlength='st(0,0.17); 384*tc / (384 / ld(0) + tc*f /(1-ld(0))) + 384*tc / (tc*f / ld(0) + 384 /(1-ld(0)))'
</pre></div>
</li><li> Custom fontcolor and fontfile, C-note is colored green, others are colored blue:
<div class="example">
<pre class="example">fontcolor='if(mod(floor(midi(f)+0.5),12), 0x0000FF, g(1))':fontfile=myfont.ttf
</pre></div>
</li><li> Custom frequency range with custom axis using image file:
<div class="example">
<pre class="example">axisfile=myaxis.png:basefreq=40:endfreq=10000
</pre></div>
</li></ul>
<a name="showfreqs"></a>
<h3 class="section">34.17 showfreqs<span class="pull-right"><a class="anchor hidden-xs" href="#showfreqs" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showfreqs" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to video output representing the audio power spectrum.
Audio amplitude is on Y-axis while frequency is on X-axis.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify size of video. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default is <code>1024x512</code>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set display mode.
This set how each frequency bin will be represented.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>line</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bar</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dot</samp>&rsquo;</dt>
</dl>
<p>Default is <code>bar</code>.
</p>
</dd>
<dt><samp>ascale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>Linear scale.
</p>
</dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>Square root scale.
</p>
</dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>Cubic root scale.
</p>
</dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>Logarithmic scale.
</p></dd>
</dl>
<p>Default is <code>log</code>.
</p>
</dd>
<dt><samp>fscale</samp></dt>
<dd><p>Set frequency scale.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>Linear scale.
</p>
</dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>Logarithmic scale.
</p>
</dd>
<dt>&lsquo;<samp>rlog</samp>&rsquo;</dt>
<dd><p>Reverse logarithmic scale.
</p></dd>
</dl>
<p>Default is <code>lin</code>.
</p>
</dd>
<dt><samp>win_size</samp></dt>
<dd><p>Set window size.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>w16</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w32</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w64</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w128</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w256</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w512</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w1024</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w2048</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w4096</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w8192</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w16384</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w32768</samp>&rsquo;</dt>
<dt>&lsquo;<samp>w65536</samp>&rsquo;</dt>
</dl>
<p>Default is <code>w2048</code>
</p>
</dd>
<dt><samp>win_func</samp></dt>
<dd><p>Set windowing function.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>rect</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bartlett</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hanning</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hamming</samp>&rsquo;</dt>
<dt>&lsquo;<samp>blackman</samp>&rsquo;</dt>
<dt>&lsquo;<samp>welch</samp>&rsquo;</dt>
<dt>&lsquo;<samp>flattop</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bharris</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bnuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bhann</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sine</samp>&rsquo;</dt>
<dt>&lsquo;<samp>nuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>lanczos</samp>&rsquo;</dt>
<dt>&lsquo;<samp>gauss</samp>&rsquo;</dt>
<dt>&lsquo;<samp>tukey</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dolph</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cauchy</samp>&rsquo;</dt>
<dt>&lsquo;<samp>parzen</samp>&rsquo;</dt>
<dt>&lsquo;<samp>poisson</samp>&rsquo;</dt>
</dl>
<p>Default is <code>hanning</code>.
</p>
</dd>
<dt><samp>overlap</samp></dt>
<dd><p>Set window overlap. In range <code>[0, 1]</code>. Default is <code>1</code>,
which means optimal overlap for selected window function will be picked.
</p>
</dd>
<dt><samp>averaging</samp></dt>
<dd><p>Set time averaging. Setting this to 0 will display current maximal peaks.
Default is <code>1</code>, which means time averaging is disabled.
</p>
</dd>
<dt><samp>colors</samp></dt>
<dd><p>Specify list of colors separated by space or by &rsquo;|&rsquo; which will be used to
draw channel frequencies. Unrecognized or missing colors will be replaced
by white color.
</p>
</dd>
<dt><samp>cmode</samp></dt>
<dd><p>Set channel display mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>combined</samp>&rsquo;</dt>
<dt>&lsquo;<samp>separate</samp>&rsquo;</dt>
</dl>
<p>Default is <code>combined</code>.
</p>
</dd>
<dt><samp>minamp</samp></dt>
<dd><p>Set minimum amplitude used in <code>log</code> amplitude scaler.
</p>
</dd>
</dl>
<a name="showspectrum"></a><a name="showspectrum-1"></a>
<h3 class="section">34.18 showspectrum<span class="pull-right"><a class="anchor hidden-xs" href="#showspectrum-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showspectrum-1" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output, representing the audio frequency
spectrum.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>640x512</code>.
</p>
</dd>
<dt><samp>slide</samp></dt>
<dd><p>Specify how the spectrum should slide along the window.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>replace</samp>&rsquo;</dt>
<dd><p>the samples start again on the left when they reach the right
</p></dd>
<dt>&lsquo;<samp>scroll</samp>&rsquo;</dt>
<dd><p>the samples scroll from right to left
</p></dd>
<dt>&lsquo;<samp>fullframe</samp>&rsquo;</dt>
<dd><p>frames are only produced when the samples reach the right
</p></dd>
<dt>&lsquo;<samp>rscroll</samp>&rsquo;</dt>
<dd><p>the samples scroll from left to right
</p></dd>
</dl>
<p>Default value is <code>replace</code>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Specify display mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>combined</samp>&rsquo;</dt>
<dd><p>all channels are displayed in the same row
</p></dd>
<dt>&lsquo;<samp>separate</samp>&rsquo;</dt>
<dd><p>all channels are displayed in separate rows
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>combined</samp>&rsquo;.
</p>
</dd>
<dt><samp>color</samp></dt>
<dd><p>Specify display color mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>channel</samp>&rsquo;</dt>
<dd><p>each channel is displayed in a separate color
</p></dd>
<dt>&lsquo;<samp>intensity</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the same color scheme
</p></dd>
<dt>&lsquo;<samp>rainbow</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the rainbow color scheme
</p></dd>
<dt>&lsquo;<samp>moreland</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the moreland color scheme
</p></dd>
<dt>&lsquo;<samp>nebulae</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the nebulae color scheme
</p></dd>
<dt>&lsquo;<samp>fire</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fire color scheme
</p></dd>
<dt>&lsquo;<samp>fiery</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fiery color scheme
</p></dd>
<dt>&lsquo;<samp>fruit</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fruit color scheme
</p></dd>
<dt>&lsquo;<samp>cool</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the cool color scheme
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>channel</samp>&rsquo;.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Specify scale used for calculating intensity color values.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>linear
</p></dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>square root, default
</p></dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>cubic root
</p></dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>logarithmic
</p></dd>
<dt>&lsquo;<samp>4thrt</samp>&rsquo;</dt>
<dd><p>4th root
</p></dd>
<dt>&lsquo;<samp>5thrt</samp>&rsquo;</dt>
<dd><p>5th root
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>sqrt</samp>&rsquo;.
</p>
</dd>
<dt><samp>saturation</samp></dt>
<dd><p>Set saturation modifier for displayed colors. Negative values provide
alternative color scheme. <code>0</code> is no saturation at all.
Saturation must be in [-10.0, 10.0] range.
Default value is <code>1</code>.
</p>
</dd>
<dt><samp>win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>rect</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bartlett</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hann</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hanning</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hamming</samp>&rsquo;</dt>
<dt>&lsquo;<samp>blackman</samp>&rsquo;</dt>
<dt>&lsquo;<samp>welch</samp>&rsquo;</dt>
<dt>&lsquo;<samp>flattop</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bharris</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bnuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bhann</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sine</samp>&rsquo;</dt>
<dt>&lsquo;<samp>nuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>lanczos</samp>&rsquo;</dt>
<dt>&lsquo;<samp>gauss</samp>&rsquo;</dt>
<dt>&lsquo;<samp>tukey</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dolph</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cauchy</samp>&rsquo;</dt>
<dt>&lsquo;<samp>parzen</samp>&rsquo;</dt>
<dt>&lsquo;<samp>poisson</samp>&rsquo;</dt>
</dl>
<p>Default value is <code>hann</code>.
</p>
</dd>
<dt><samp>orientation</samp></dt>
<dd><p>Set orientation of time vs frequency axis. Can be <code>vertical</code> or
<code>horizontal</code>. Default is <code>vertical</code>.
</p>
</dd>
<dt><samp>overlap</samp></dt>
<dd><p>Set ratio of overlap window. Default value is <code>0</code>.
When value is <code>1</code> overlap is set to recommended size for specific
window function currently used.
</p>
</dd>
<dt><samp>gain</samp></dt>
<dd><p>Set scale gain for calculating intensity color values.
Default value is <code>1</code>.
</p>
</dd>
<dt><samp>data</samp></dt>
<dd><p>Set which data to display. Can be <code>magnitude</code>, default or <code>phase</code>.
</p>
</dd>
<dt><samp>rotation</samp></dt>
<dd><p>Set color rotation, must be in [-1.0, 1.0] range.
Default value is <code>0</code>.
</p></dd>
</dl>
<p>The usage is very similar to the showwaves filter; see the examples in that
section.
</p>
<a name="Examples-121"></a>
<h4 class="subsection">34.18.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-121" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-121" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Large window with logarithmic color scaling:
<div class="example">
<pre class="example">showspectrum=s=1280x480:scale=log
</pre></div>
</li><li> Complete example for a colored and sliding spectrum per channel using <code>ffplay</code>:
<div class="example">
<pre class="example">ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
[a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
</pre></div>
</li></ul>
<a name="showspectrumpic"></a>
<h3 class="section">34.19 showspectrumpic<span class="pull-right"><a class="anchor hidden-xs" href="#showspectrumpic" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showspectrumpic" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a single video frame, representing the audio frequency
spectrum.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>4096x2048</code>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Specify display mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>combined</samp>&rsquo;</dt>
<dd><p>all channels are displayed in the same row
</p></dd>
<dt>&lsquo;<samp>separate</samp>&rsquo;</dt>
<dd><p>all channels are displayed in separate rows
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>combined</samp>&rsquo;.
</p>
</dd>
<dt><samp>color</samp></dt>
<dd><p>Specify display color mode.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>channel</samp>&rsquo;</dt>
<dd><p>each channel is displayed in a separate color
</p></dd>
<dt>&lsquo;<samp>intensity</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the same color scheme
</p></dd>
<dt>&lsquo;<samp>rainbow</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the rainbow color scheme
</p></dd>
<dt>&lsquo;<samp>moreland</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the moreland color scheme
</p></dd>
<dt>&lsquo;<samp>nebulae</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the nebulae color scheme
</p></dd>
<dt>&lsquo;<samp>fire</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fire color scheme
</p></dd>
<dt>&lsquo;<samp>fiery</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fiery color scheme
</p></dd>
<dt>&lsquo;<samp>fruit</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the fruit color scheme
</p></dd>
<dt>&lsquo;<samp>cool</samp>&rsquo;</dt>
<dd><p>each channel is displayed using the cool color scheme
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>intensity</samp>&rsquo;.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Specify scale used for calculating intensity color values.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>linear
</p></dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>square root, default
</p></dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>cubic root
</p></dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>logarithmic
</p></dd>
<dt>&lsquo;<samp>4thrt</samp>&rsquo;</dt>
<dd><p>4th root
</p></dd>
<dt>&lsquo;<samp>5thrt</samp>&rsquo;</dt>
<dd><p>5th root
</p></dd>
</dl>
<p>Default value is &lsquo;<samp>log</samp>&rsquo;.
</p>
</dd>
<dt><samp>saturation</samp></dt>
<dd><p>Set saturation modifier for displayed colors. Negative values provide
alternative color scheme. <code>0</code> is no saturation at all.
Saturation must be in [-10.0, 10.0] range.
Default value is <code>1</code>.
</p>
</dd>
<dt><samp>win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl compact="compact">
<dt>&lsquo;<samp>rect</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bartlett</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hann</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hanning</samp>&rsquo;</dt>
<dt>&lsquo;<samp>hamming</samp>&rsquo;</dt>
<dt>&lsquo;<samp>blackman</samp>&rsquo;</dt>
<dt>&lsquo;<samp>welch</samp>&rsquo;</dt>
<dt>&lsquo;<samp>flattop</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bharris</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bnuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>bhann</samp>&rsquo;</dt>
<dt>&lsquo;<samp>sine</samp>&rsquo;</dt>
<dt>&lsquo;<samp>nuttall</samp>&rsquo;</dt>
<dt>&lsquo;<samp>lanczos</samp>&rsquo;</dt>
<dt>&lsquo;<samp>gauss</samp>&rsquo;</dt>
<dt>&lsquo;<samp>tukey</samp>&rsquo;</dt>
<dt>&lsquo;<samp>dolph</samp>&rsquo;</dt>
<dt>&lsquo;<samp>cauchy</samp>&rsquo;</dt>
<dt>&lsquo;<samp>parzen</samp>&rsquo;</dt>
<dt>&lsquo;<samp>poisson</samp>&rsquo;</dt>
</dl>
<p>Default value is <code>hann</code>.
</p>
</dd>
<dt><samp>orientation</samp></dt>
<dd><p>Set orientation of time vs frequency axis. Can be <code>vertical</code> or
<code>horizontal</code>. Default is <code>vertical</code>.
</p>
</dd>
<dt><samp>gain</samp></dt>
<dd><p>Set scale gain for calculating intensity color values.
Default value is <code>1</code>.
</p>
</dd>
<dt><samp>legend</samp></dt>
<dd><p>Draw time and frequency axes and legends. Default is enabled.
</p>
</dd>
<dt><samp>rotation</samp></dt>
<dd><p>Set color rotation, must be in [-1.0, 1.0] range.
Default value is <code>0</code>.
</p></dd>
</dl>
<a name="Examples-122"></a>
<h4 class="subsection">34.19.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-122" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-122" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Extract an audio spectrogram of a whole audio track
in a 1024x1024 picture using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
</pre></div>
</li></ul>
<a name="showvolume"></a>
<h3 class="section">34.20 showvolume<span class="pull-right"><a class="anchor hidden-xs" href="#showvolume" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showvolume" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio volume to a video output.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>rate, r</samp></dt>
<dd><p>Set video rate.
</p>
</dd>
<dt><samp>b</samp></dt>
<dd><p>Set border width, allowed range is [0, 5]. Default is 1.
</p>
</dd>
<dt><samp>w</samp></dt>
<dd><p>Set channel width, allowed range is [80, 8192]. Default is 400.
</p>
</dd>
<dt><samp>h</samp></dt>
<dd><p>Set channel height, allowed range is [1, 900]. Default is 20.
</p>
</dd>
<dt><samp>f</samp></dt>
<dd><p>Set fade, allowed range is [0.001, 1]. Default is 0.95.
</p>
</dd>
<dt><samp>c</samp></dt>
<dd><p>Set volume color expression.
</p>
<p>The expression can use the following variables:
</p>
<dl compact="compact">
<dt><samp>VOLUME</samp></dt>
<dd><p>Current max volume of channel in dB.
</p>
</dd>
<dt><samp>PEAK</samp></dt>
<dd><p>Current peak.
</p>
</dd>
<dt><samp>CHANNEL</samp></dt>
<dd><p>Current channel number, starting from 0.
</p></dd>
</dl>
</dd>
<dt><samp>t</samp></dt>
<dd><p>If set, displays channel names. Default is enabled.
</p>
</dd>
<dt><samp>v</samp></dt>
<dd><p>If set, displays volume values. Default is enabled.
</p>
</dd>
<dt><samp>o</samp></dt>
<dd><p>Set orientation, can be <code>horizontal</code> or <code>vertical</code>,
default is <code>horizontal</code>.
</p>
</dd>
<dt><samp>s</samp></dt>
<dd><p>Set step size, allowed range s [0, 5]. Default is 0, which means
step is disabled.
</p></dd>
</dl>
<a name="showwaves"></a>
<h3 class="section">34.21 showwaves<span class="pull-right"><a class="anchor hidden-xs" href="#showwaves" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showwaves" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a video output, representing the samples waves.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>600x240</code>.
</p>
</dd>
<dt><samp>mode</samp></dt>
<dd><p>Set display mode.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>point</samp>&rsquo;</dt>
<dd><p>Draw a point for each sample.
</p>
</dd>
<dt>&lsquo;<samp>line</samp>&rsquo;</dt>
<dd><p>Draw a vertical line for each sample.
</p>
</dd>
<dt>&lsquo;<samp>p2p</samp>&rsquo;</dt>
<dd><p>Draw a point for each sample and a line between them.
</p>
</dd>
<dt>&lsquo;<samp>cline</samp>&rsquo;</dt>
<dd><p>Draw a centered vertical line for each sample.
</p></dd>
</dl>
<p>Default value is <code>point</code>.
</p>
</dd>
<dt><samp>n</samp></dt>
<dd><p>Set the number of samples which are printed on the same column. A
larger value will decrease the frame rate. Must be a positive
integer. This option can be set only if the value for <var>rate</var>
is not explicitly specified.
</p>
</dd>
<dt><samp>rate, r</samp></dt>
<dd><p>Set the (approximate) output frame rate. This is done by setting the
option <var>n</var>. Default value is &quot;25&quot;.
</p>
</dd>
<dt><samp>split_channels</samp></dt>
<dd><p>Set if channels should be drawn separately or overlap. Default value is 0.
</p>
</dd>
<dt><samp>colors</samp></dt>
<dd><p>Set colors separated by &rsquo;|&rsquo; which are going to be used for drawing of each channel.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>Available values are:
</p><dl compact="compact">
<dt>&lsquo;<samp>lin</samp>&rsquo;</dt>
<dd><p>Linear.
</p>
</dd>
<dt>&lsquo;<samp>log</samp>&rsquo;</dt>
<dd><p>Logarithmic.
</p>
</dd>
<dt>&lsquo;<samp>sqrt</samp>&rsquo;</dt>
<dd><p>Square root.
</p>
</dd>
<dt>&lsquo;<samp>cbrt</samp>&rsquo;</dt>
<dd><p>Cubic root.
</p></dd>
</dl>
<p>Default is linear.
</p></dd>
</dl>
<a name="Examples-123"></a>
<h4 class="subsection">34.21.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-123" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-123" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Output the input file audio and the corresponding video representation
at the same time:
<div class="example">
<pre class="example">amovie=a.mp3,asplit[out0],showwaves[out1]
</pre></div>
</li><li> Create a synthetic signal and show it with showwaves, forcing a
frame rate of 30 frames per second:
<div class="example">
<pre class="example">aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
</pre></div>
</li></ul>
<a name="showwavespic"></a>
<h3 class="section">34.22 showwavespic<span class="pull-right"><a class="anchor hidden-xs" href="#showwavespic" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showwavespic" aria-hidden="true">TOC</a></span></h3>
<p>Convert input audio to a single video frame, representing the samples waves.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>size, s</samp></dt>
<dd><p>Specify the video size for the output. For the syntax of this option, check the
<a href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)&quot;Video size&quot; section in the ffmpeg-utils manual</a>.
Default value is <code>600x240</code>.
</p>
</dd>
<dt><samp>split_channels</samp></dt>
<dd><p>Set if channels should be drawn separately or overlap. Default value is 0.
</p>
</dd>
<dt><samp>colors</samp></dt>
<dd><p>Set colors separated by &rsquo;|&rsquo; which are going to be used for drawing of each channel.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set amplitude scale. Can be linear <code>lin</code> or logarithmic <code>log</code>.
Default is linear.
</p></dd>
</dl>
<a name="Examples-124"></a>
<h4 class="subsection">34.22.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-124" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-124" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Extract a channel split representation of the wave form of a whole audio track
in a 1024x800 picture using <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
</pre></div>
</li></ul>
<a name="spectrumsynth"></a>
<h3 class="section">34.23 spectrumsynth<span class="pull-right"><a class="anchor hidden-xs" href="#spectrumsynth" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-spectrumsynth" aria-hidden="true">TOC</a></span></h3>
<p>Sythesize audio from 2 input video spectrums, first input stream represents
magnitude across time and second represents phase across time.
The filter will transform from frequency domain as displayed in videos back
to time domain as presented in audio output.
</p>
<p>This filter is primarly created for reversing processed <a href="#showspectrum">showspectrum</a>
filter outputs, but can synthesize sound from other spectrograms too.
But in such case results are going to be poor if the phase data is not
available, because in such cases phase data need to be recreated, usually
its just recreated from random noise.
For best results use gray only output (<code>channel</code> color mode in
<a href="#showspectrum">showspectrum</a> filter) and <code>log</code> scale for magnitude video and
<code>lin</code> scale for phase video. To produce phase, for 2nd video, use
<code>data</code> option. Inputs videos should generally use <code>fullframe</code>
slide mode as that saves resources needed for decoding video.
</p>
<p>The filter accepts the following options:
</p>
<dl compact="compact">
<dt><samp>sample_rate</samp></dt>
<dd><p>Specify sample rate of output audio, the sample rate of audio from which
spectrum was generated may differ.
</p>
</dd>
<dt><samp>channels</samp></dt>
<dd><p>Set number of channels represented in input video spectrums.
</p>
</dd>
<dt><samp>scale</samp></dt>
<dd><p>Set scale which was used when generating magnitude input spectrum.
Can be <code>lin</code> or <code>log</code>. Default is <code>log</code>.
</p>
</dd>
<dt><samp>slide</samp></dt>
<dd><p>Set slide which was used when generating inputs spectrums.
Can be <code>replace</code>, <code>scroll</code>, <code>fullframe</code> or <code>rscroll</code>.
Default is <code>fullframe</code>.
</p>
</dd>
<dt><samp>win_func</samp></dt>
<dd><p>Set window function used for resynthesis.
</p>
</dd>
<dt><samp>overlap</samp></dt>
<dd><p>Set window overlap. In range <code>[0, 1]</code>. Default is <code>1</code>,
which means optimal overlap for selected window function will be picked.
</p>
</dd>
<dt><samp>orientation</samp></dt>
<dd><p>Set orientation of input videos. Can be <code>vertical</code> or <code>horizontal</code>.
Default is <code>vertical</code>.
</p></dd>
</dl>
<a name="Examples-125"></a>
<h4 class="subsection">34.23.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-125" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-125" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> First create magnitude and phase videos from audio, assuming audio is stereo with 44100 sample rate,
then resynthesize videos back to audio with spectrumsynth:
<div class="example">
<pre class="example">ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=log:overlap=0.875:color=channel:slide=fullframe:data=magnitude -an -c:v rawvideo magnitude.nut
ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=lin:overlap=0.875:color=channel:slide=fullframe:data=phase -an -c:v rawvideo phase.nut
ffmpeg -i magnitude.nut -i phase.nut -lavfi spectrumsynth=channels=2:sample_rate=44100:win_func=hann:overlap=0.875:slide=fullframe output.flac
</pre></div>
</li></ul>
<a name="split_002c-asplit"></a>
<h3 class="section">34.24 split, asplit<span class="pull-right"><a class="anchor hidden-xs" href="#split_002c-asplit" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-split_002c-asplit" aria-hidden="true">TOC</a></span></h3>
<p>Split input into several identical outputs.
</p>
<p><code>asplit</code> works with audio input, <code>split</code> with video.
</p>
<p>The filter accepts a single parameter which specifies the number of outputs. If
unspecified, it defaults to 2.
</p>
<a name="Examples-126"></a>
<h4 class="subsection">34.24.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-126" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-126" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Create two separate outputs from the same input:
<div class="example">
<pre class="example">[in] split [out0][out1]
</pre></div>
</li><li> To create 3 or more outputs, you need to specify the number of
outputs, like in:
<div class="example">
<pre class="example">[in] asplit=3 [out0][out1][out2]
</pre></div>
</li><li> Create two separate outputs from the same input, one cropped and
one padded:
<div class="example">
<pre class="example">[in] split [splitout1][splitout2];
[splitout1] crop=100:100:0:0 [cropout];
[splitout2] pad=200:200:100:100 [padout];
</pre></div>
</li><li> Create 5 copies of the input audio with <code>ffmpeg</code>:
<div class="example">
<pre class="example">ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
</pre></div>
</li></ul>
<a name="zmq_002c-azmq"></a>
<h3 class="section">34.25 zmq, azmq<span class="pull-right"><a class="anchor hidden-xs" href="#zmq_002c-azmq" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-zmq_002c-azmq" aria-hidden="true">TOC</a></span></h3>
<p>Receive commands sent through a libzmq client, and forward them to
filters in the filtergraph.
</p>
<p><code>zmq</code> and <code>azmq</code> work as a pass-through filters. <code>zmq</code>
must be inserted between two video filters, <code>azmq</code> between two
audio filters.
</p>
<p>To enable these filters you need to install the libzmq library and
headers and configure FFmpeg with <code>--enable-libzmq</code>.
</p>
<p>For more information about libzmq see:
<a href="http://www.zeromq.org/">http://www.zeromq.org/</a>
</p>
<p>The <code>zmq</code> and <code>azmq</code> filters work as a libzmq server, which
receives messages sent through a network interface defined by the
<samp>bind_address</samp> option.
</p>
<p>The received message must be in the form:
</p><div class="example">
<pre class="example"><var>TARGET</var> <var>COMMAND</var> [<var>ARG</var>]
</pre></div>
<p><var>TARGET</var> specifies the target of the command, usually the name of
the filter class or a specific filter instance name.
</p>
<p><var>COMMAND</var> specifies the name of the command for the target filter.
</p>
<p><var>ARG</var> is optional and specifies the optional argument list for the
given <var>COMMAND</var>.
</p>
<p>Upon reception, the message is processed and the corresponding command
is injected into the filtergraph. Depending on the result, the filter
will send a reply to the client, adopting the format:
</p><div class="example">
<pre class="example"><var>ERROR_CODE</var> <var>ERROR_REASON</var>
<var>MESSAGE</var>
</pre></div>
<p><var>MESSAGE</var> is optional.
</p>
<a name="Examples-127"></a>
<h4 class="subsection">34.25.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-127" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-127" aria-hidden="true">TOC</a></span></h4>
<p>Look at <samp>tools/zmqsend</samp> for an example of a zmq client which can
be used to send commands processed by these filters.
</p>
<p>Consider the following filtergraph generated by <code>ffplay</code>
</p><div class="example">
<pre class="example">ffplay -dumpgraph 1 -f lavfi &quot;
color=s=100x100:c=red [l];
color=s=100x100:c=blue [r];
nullsrc=s=200x100, zmq [bg];
[bg][l] overlay [bg+l];
[bg+l][r] overlay=x=100 &quot;
</pre></div>
<p>To change the color of the left side of the video, the following
command can be used:
</p><div class="example">
<pre class="example">echo Parsed_color_0 c yellow | tools/zmqsend
</pre></div>
<p>To change the right side:
</p><div class="example">
<pre class="example">echo Parsed_color_1 c pink | tools/zmqsend
</pre></div>
<a name="Multimedia-Sources"></a>
<h2 class="chapter">35 Multimedia Sources<span class="pull-right"><a class="anchor hidden-xs" href="#Multimedia-Sources" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Multimedia-Sources" aria-hidden="true">TOC</a></span></h2>
<p>Below is a description of the currently available multimedia sources.
</p>
<a name="amovie"></a>
<h3 class="section">35.1 amovie<span class="pull-right"><a class="anchor hidden-xs" href="#amovie" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amovie" aria-hidden="true">TOC</a></span></h3>
<p>This is the same as <a href="#movie">movie</a> source, except it selects an audio
stream by default.
</p>
<a name="movie"></a><a name="movie-1"></a>
<h3 class="section">35.2 movie<span class="pull-right"><a class="anchor hidden-xs" href="#movie-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-movie-1" aria-hidden="true">TOC</a></span></h3>
<p>Read audio and/or video stream(s) from a movie container.
</p>
<p>It accepts the following parameters:
</p>
<dl compact="compact">
<dt><samp>filename</samp></dt>
<dd><p>The name of the resource to read (not necessarily a file; it can also be a
device or a stream accessed through some protocol).
</p>
</dd>
<dt><samp>format_name, f</samp></dt>
<dd><p>Specifies the format assumed for the movie to read, and can be either
the name of a container or an input device. If not specified, the
format is guessed from <var>movie_name</var> or by probing.
</p>
</dd>
<dt><samp>seek_point, sp</samp></dt>
<dd><p>Specifies the seek point in seconds. The frames will be output
starting from this seek point. The parameter is evaluated with
<code>av_strtod</code>, so the numerical value may be suffixed by an IS
postfix. The default value is &quot;0&quot;.
</p>
</dd>
<dt><samp>streams, s</samp></dt>
<dd><p>Specifies the streams to read. Several streams can be specified,
separated by &quot;+&quot;. The source will then have as many outputs, in the
same order. The syntax is explained in the &ldquo;Stream specifiers&rdquo;
section in the ffmpeg manual. Two special names, &quot;dv&quot; and &quot;da&quot; specify
respectively the default (best suited) video and audio stream. Default
is &quot;dv&quot;, or &quot;da&quot; if the filter is called as &quot;amovie&quot;.
</p>
</dd>
<dt><samp>stream_index, si</samp></dt>
<dd><p>Specifies the index of the video stream to read. If the value is -1,
the most suitable video stream will be automatically selected. The default
value is &quot;-1&quot;. Deprecated. If the filter is called &quot;amovie&quot;, it will select
audio instead of video.
</p>
</dd>
<dt><samp>loop</samp></dt>
<dd><p>Specifies how many times to read the stream in sequence.
If the value is less than 1, the stream will be read again and again.
Default value is &quot;1&quot;.
</p>
<p>Note that when the movie is looped the source timestamps are not
changed, so it will generate non monotonically increasing timestamps.
</p>
</dd>
<dt><samp>discontinuity</samp></dt>
<dd><p>Specifies the time difference between frames above which the point is
considered a timestamp discontinuity which is removed by adjusting the later
timestamps.
</p></dd>
</dl>
<p>It allows overlaying a second video on top of the main input of
a filtergraph, as shown in this graph:
</p><div class="example">
<pre class="example">input -----------&gt; deltapts0 --&gt; overlay --&gt; output
^
|
movie --&gt; scale--&gt; deltapts1 -------+
</pre></div>
<a name="Examples-128"></a>
<h4 class="subsection">35.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-128" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-128" aria-hidden="true">TOC</a></span></h4>
<ul>
<li> Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it
on top of the input labelled &quot;in&quot;:
<div class="example">
<pre class="example">movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [over];
[in] setpts=PTS-STARTPTS [main];
[main][over] overlay=16:16 [out]
</pre></div>
</li><li> Read from a video4linux2 device, and overlay it on top of the input
labelled &quot;in&quot;:
<div class="example">
<pre class="example">movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [over];
[in] setpts=PTS-STARTPTS [main];
[main][over] overlay=16:16 [out]
</pre></div>
</li><li> Read the first video stream and the audio stream with id 0x81 from
dvd.vob; the video is connected to the pad named &quot;video&quot; and the audio is
connected to the pad named &quot;audio&quot;:
<div class="example">
<pre class="example">movie=dvd.vob:s=v:0+#0x81 [video] [audio]
</pre></div>
</li></ul>
<a name="Commands-11"></a>
<h4 class="subsection">35.2.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-11" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-11" aria-hidden="true">TOC</a></span></h4>
<p>Both movie and amovie support the following commands:
</p><dl compact="compact">
<dt><samp>seek</samp></dt>
<dd><p>Perform seek using &quot;av_seek_frame&quot;.
The syntax is: seek <var>stream_index</var>|<var>timestamp</var>|<var>flags</var>
</p><ul>
<li> <var>stream_index</var>: If stream_index is -1, a default
stream is selected, and <var>timestamp</var> is automatically converted
from AV_TIME_BASE units to the stream specific time_base.
</li><li> <var>timestamp</var>: Timestamp in AVStream.time_base units
or, if no stream is specified, in AV_TIME_BASE units.
</li><li> <var>flags</var>: Flags which select direction and seeking mode.
</li></ul>
</dd>
<dt><samp>get_duration</samp></dt>
<dd><p>Get movie duration in AV_TIME_BASE units.
</p>
</dd>
</dl>
<a name="See-Also"></a>
<h2 class="chapter">36 See Also<span class="pull-right"><a class="anchor hidden-xs" href="#See-Also" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-See-Also" aria-hidden="true">TOC</a></span></h2>
<p><a href="ffprobe.html">ffprobe</a>,
<a href="ffmpeg.html">ffmpeg</a>, <a href="ffplay.html">ffplay</a>, <a href="ffserver.html">ffserver</a>,
<a href="ffmpeg-utils.html">ffmpeg-utils</a>,
<a href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
<a href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
<a href="ffmpeg-codecs.html">ffmpeg-codecs</a>,
<a href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>,
<a href="ffmpeg-formats.html">ffmpeg-formats</a>,
<a href="ffmpeg-devices.html">ffmpeg-devices</a>,
<a href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
<a href="ffmpeg-filters.html">ffmpeg-filters</a>
</p>
<a name="Authors"></a>
<h2 class="chapter">37 Authors<span class="pull-right"><a class="anchor hidden-xs" href="#Authors" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Authors" aria-hidden="true">TOC</a></span></h2>
<p>The FFmpeg developers.
</p>
<p>For details about the authorship, see the Git history of the project
(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command
<code>git log</code> in the FFmpeg source directory, or browsing the
online repository at <a href="http://source.ffmpeg.org">http://source.ffmpeg.org</a>.
</p>
<p>Maintainers for the specific components are listed in the file
<samp>MAINTAINERS</samp> in the source code tree.
</p>
<p style="font-size: small;">
This document was generated using <a href="http://www.gnu.org/software/texinfo/"><em>makeinfo</em></a>.
</p>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink