diff options
Diffstat (limited to 'ffmpeg/doc/ffmpeg-filters.html')
| -rw-r--r-- | ffmpeg/doc/ffmpeg-filters.html | 36228 |
1 files changed, 36228 insertions, 0 deletions
diff --git a/ffmpeg/doc/ffmpeg-filters.html b/ffmpeg/doc/ffmpeg-filters.html new file mode 100644 index 0000000..ea04e7d --- /dev/null +++ b/ffmpeg/doc/ffmpeg-filters.html @@ -0,0 +1,36228 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> + <head> + <meta charset="utf-8"> + <title> + FFmpeg Filters 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> + FFmpeg Filters Documentation + </h1> +<div align="center"> +</div> + + +<a name="SEC_Top"></a> + +<div class="Contents_element" id="SEC_Contents"> +<h2 class="contents-heading">Table of Contents</h2> + +<div class="contents"> + +<ul class="no-bullet"> + <li><a id="toc-Description" href="#Description">1 Description</a></li> + <li><a id="toc-Filtering-Introduction" href="#Filtering-Introduction">2 Filtering Introduction</a></li> + <li><a id="toc-graph2dot" href="#graph2dot">3 graph2dot</a></li> + <li><a id="toc-Filtergraph-description" href="#Filtergraph-description">4 Filtergraph description</a> + <ul class="no-bullet"> + <li><a id="toc-Filtergraph-syntax-1" href="#Filtergraph-syntax-1">4.1 Filtergraph syntax</a></li> + <li><a id="toc-Notes-on-filtergraph-escaping" href="#Notes-on-filtergraph-escaping">4.2 Notes on filtergraph escaping</a></li> + </ul></li> + <li><a id="toc-Timeline-editing" href="#Timeline-editing">5 Timeline editing</a></li> + <li><a id="toc-Changing-options-at-runtime-with-a-command" href="#Changing-options-at-runtime-with-a-command">6 Changing options at runtime with a command</a></li> + <li><a id="toc-Options-for-filters-with-several-inputs-_0028framesync_0029" href="#Options-for-filters-with-several-inputs-_0028framesync_0029">7 Options for filters with several inputs (framesync)</a></li> + <li><a id="toc-Audio-Filters" href="#Audio-Filters">8 Audio Filters</a> + <ul class="no-bullet"> + <li><a id="toc-acompressor" href="#acompressor">8.1 acompressor</a> + <ul class="no-bullet"> + <li><a id="toc-Commands" href="#Commands">8.1.1 Commands</a></li> + </ul></li> + <li><a id="toc-acontrast" href="#acontrast">8.2 acontrast</a></li> + <li><a id="toc-acopy" href="#acopy">8.3 acopy</a></li> + <li><a id="toc-acrossfade" href="#acrossfade">8.4 acrossfade</a> + <ul class="no-bullet"> + <li><a id="toc-Examples" href="#Examples">8.4.1 Examples</a></li> + </ul></li> + <li><a id="toc-acrossover" href="#acrossover">8.5 acrossover</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-1" href="#Examples-1">8.5.1 Examples</a></li> + </ul></li> + <li><a id="toc-acrusher" href="#acrusher">8.6 acrusher</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-1" href="#Commands-1">8.6.1 Commands</a></li> + </ul></li> + <li><a id="toc-acue" href="#acue">8.7 acue</a></li> + <li><a id="toc-adeclick" href="#adeclick">8.8 adeclick</a></li> + <li><a id="toc-adeclip" href="#adeclip">8.9 adeclip</a></li> + <li><a id="toc-adecorrelate" href="#adecorrelate">8.10 adecorrelate</a></li> + <li><a id="toc-adelay" href="#adelay">8.11 adelay</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-2" href="#Examples-2">8.11.1 Examples</a></li> + </ul></li> + <li><a id="toc-adenorm" href="#adenorm">8.12 adenorm</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-2" href="#Commands-2">8.12.1 Commands</a></li> + </ul></li> + <li><a id="toc-aderivative_002c-aintegral" href="#aderivative_002c-aintegral">8.13 aderivative, aintegral</a></li> + <li><a id="toc-adynamicequalizer" href="#adynamicequalizer">8.14 adynamicequalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-3" href="#Commands-3">8.14.1 Commands</a></li> + </ul></li> + <li><a id="toc-adynamicsmooth" href="#adynamicsmooth">8.15 adynamicsmooth</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-4" href="#Commands-4">8.15.1 Commands</a></li> + </ul></li> + <li><a id="toc-aecho" href="#aecho">8.16 aecho</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-3" href="#Examples-3">8.16.1 Examples</a></li> + </ul></li> + <li><a id="toc-aemphasis" href="#aemphasis">8.17 aemphasis</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-5" href="#Commands-5">8.17.1 Commands</a></li> + </ul></li> + <li><a id="toc-aeval" href="#aeval">8.18 aeval</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-4" href="#Examples-4">8.18.1 Examples</a></li> + </ul></li> + <li><a id="toc-aexciter" href="#aexciter">8.19 aexciter</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-6" href="#Commands-6">8.19.1 Commands</a></li> + </ul></li> + <li><a id="toc-afade-1" href="#afade-1">8.20 afade</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-7" href="#Commands-7">8.20.1 Commands</a></li> + <li><a id="toc-Examples-5" href="#Examples-5">8.20.2 Examples</a></li> + </ul></li> + <li><a id="toc-afftdn" href="#afftdn">8.21 afftdn</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-8" href="#Commands-8">8.21.1 Commands</a></li> + <li><a id="toc-Examples-6" href="#Examples-6">8.21.2 Examples</a></li> + </ul></li> + <li><a id="toc-afftfilt" href="#afftfilt">8.22 afftfilt</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-7" href="#Examples-7">8.22.1 Examples</a></li> + </ul></li> + <li><a id="toc-afir-1" href="#afir-1">8.23 afir</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-8" href="#Examples-8">8.23.1 Examples</a></li> + </ul></li> + <li><a id="toc-aformat-1" href="#aformat-1">8.24 aformat</a></li> + <li><a id="toc-afreqshift" href="#afreqshift">8.25 afreqshift</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-9" href="#Commands-9">8.25.1 Commands</a></li> + </ul></li> + <li><a id="toc-afwtdn" href="#afwtdn">8.26 afwtdn</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-10" href="#Commands-10">8.26.1 Commands</a></li> + </ul></li> + <li><a id="toc-agate" href="#agate">8.27 agate</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-11" href="#Commands-11">8.27.1 Commands</a></li> + </ul></li> + <li><a id="toc-aiir" href="#aiir">8.28 aiir</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-9" href="#Examples-9">8.28.1 Examples</a></li> + </ul></li> + <li><a id="toc-alimiter" href="#alimiter">8.29 alimiter</a></li> + <li><a id="toc-allpass" href="#allpass">8.30 allpass</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-12" href="#Commands-12">8.30.1 Commands</a></li> + </ul></li> + <li><a id="toc-aloop" href="#aloop">8.31 aloop</a></li> + <li><a id="toc-amerge-1" href="#amerge-1">8.32 amerge</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-10" href="#Examples-10">8.32.1 Examples</a></li> + </ul></li> + <li><a id="toc-amix" href="#amix">8.33 amix</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-11" href="#Examples-11">8.33.1 Examples</a></li> + <li><a id="toc-Commands-13" href="#Commands-13">8.33.2 Commands</a></li> + </ul></li> + <li><a id="toc-amultiply" href="#amultiply">8.34 amultiply</a></li> + <li><a id="toc-anequalizer" href="#anequalizer">8.35 anequalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-12" href="#Examples-12">8.35.1 Examples</a></li> + <li><a id="toc-Commands-14" href="#Commands-14">8.35.2 Commands</a></li> + </ul></li> + <li><a id="toc-anlmdn" href="#anlmdn">8.36 anlmdn</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-15" href="#Commands-15">8.36.1 Commands</a></li> + </ul></li> + <li><a id="toc-anlmf_002c-anlms" href="#anlmf_002c-anlms">8.37 anlmf, anlms</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-13" href="#Examples-13">8.37.1 Examples</a></li> + <li><a id="toc-Commands-16" href="#Commands-16">8.37.2 Commands</a></li> + </ul></li> + <li><a id="toc-anull" href="#anull">8.38 anull</a></li> + <li><a id="toc-apad" href="#apad">8.39 apad</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-14" href="#Examples-14">8.39.1 Examples</a></li> + </ul></li> + <li><a id="toc-aphaser" href="#aphaser">8.40 aphaser</a></li> + <li><a id="toc-aphaseshift" href="#aphaseshift">8.41 aphaseshift</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-17" href="#Commands-17">8.41.1 Commands</a></li> + </ul></li> + <li><a id="toc-apsyclip" href="#apsyclip">8.42 apsyclip</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-18" href="#Commands-18">8.42.1 Commands</a></li> + </ul></li> + <li><a id="toc-apulsator" href="#apulsator">8.43 apulsator</a></li> + <li><a id="toc-aresample-1" href="#aresample-1">8.44 aresample</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-15" href="#Examples-15">8.44.1 Examples</a></li> + </ul></li> + <li><a id="toc-areverse" href="#areverse">8.45 areverse</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-16" href="#Examples-16">8.45.1 Examples</a></li> + </ul></li> + <li><a id="toc-arnndn" href="#arnndn">8.46 arnndn</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-19" href="#Commands-19">8.46.1 Commands</a></li> + </ul></li> + <li><a id="toc-asdr" href="#asdr">8.47 asdr</a></li> + <li><a id="toc-asetnsamples" href="#asetnsamples">8.48 asetnsamples</a></li> + <li><a id="toc-asetrate" href="#asetrate">8.49 asetrate</a></li> + <li><a id="toc-ashowinfo" href="#ashowinfo">8.50 ashowinfo</a></li> + <li><a id="toc-asoftclip" href="#asoftclip">8.51 asoftclip</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-20" href="#Commands-20">8.51.1 Commands</a></li> + </ul></li> + <li><a id="toc-aspectralstats" href="#aspectralstats">8.52 aspectralstats</a></li> + <li><a id="toc-asr" href="#asr">8.53 asr</a></li> + <li><a id="toc-astats-1" href="#astats-1">8.54 astats</a></li> + <li><a id="toc-asubboost" href="#asubboost">8.55 asubboost</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-21" href="#Commands-21">8.55.1 Commands</a></li> + </ul></li> + <li><a id="toc-asubcut" href="#asubcut">8.56 asubcut</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-22" href="#Commands-22">8.56.1 Commands</a></li> + </ul></li> + <li><a id="toc-asupercut" href="#asupercut">8.57 asupercut</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-23" href="#Commands-23">8.57.1 Commands</a></li> + </ul></li> + <li><a id="toc-asuperpass" href="#asuperpass">8.58 asuperpass</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-24" href="#Commands-24">8.58.1 Commands</a></li> + </ul></li> + <li><a id="toc-asuperstop" href="#asuperstop">8.59 asuperstop</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-25" href="#Commands-25">8.59.1 Commands</a></li> + </ul></li> + <li><a id="toc-atempo" href="#atempo">8.60 atempo</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-17" href="#Examples-17">8.60.1 Examples</a></li> + <li><a id="toc-Commands-26" href="#Commands-26">8.60.2 Commands</a></li> + </ul></li> + <li><a id="toc-atilt" href="#atilt">8.61 atilt</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-27" href="#Commands-27">8.61.1 Commands</a></li> + </ul></li> + <li><a id="toc-atrim" href="#atrim">8.62 atrim</a></li> + <li><a id="toc-axcorrelate" href="#axcorrelate">8.63 axcorrelate</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-18" href="#Examples-18">8.63.1 Examples</a></li> + </ul></li> + <li><a id="toc-bandpass" href="#bandpass">8.64 bandpass</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-28" href="#Commands-28">8.64.1 Commands</a></li> + </ul></li> + <li><a id="toc-bandreject" href="#bandreject">8.65 bandreject</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-29" href="#Commands-29">8.65.1 Commands</a></li> + </ul></li> + <li><a id="toc-bass_002c-lowshelf" href="#bass_002c-lowshelf">8.66 bass, lowshelf</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-30" href="#Commands-30">8.66.1 Commands</a></li> + </ul></li> + <li><a id="toc-biquad" href="#biquad">8.67 biquad</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-31" href="#Commands-31">8.67.1 Commands</a></li> + </ul></li> + <li><a id="toc-bs2b" href="#bs2b">8.68 bs2b</a></li> + <li><a id="toc-channelmap" href="#channelmap">8.69 channelmap</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-19" href="#Examples-19">8.69.1 Examples</a></li> + </ul></li> + <li><a id="toc-channelsplit" href="#channelsplit">8.70 channelsplit</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-20" href="#Examples-20">8.70.1 Examples</a></li> + </ul></li> + <li><a id="toc-chorus" href="#chorus">8.71 chorus</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-21" href="#Examples-21">8.71.1 Examples</a></li> + </ul></li> + <li><a id="toc-compand" href="#compand">8.72 compand</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-22" href="#Examples-22">8.72.1 Examples</a></li> + </ul></li> + <li><a id="toc-compensationdelay" href="#compensationdelay">8.73 compensationdelay</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-32" href="#Commands-32">8.73.1 Commands</a></li> + </ul></li> + <li><a id="toc-crossfeed" href="#crossfeed">8.74 crossfeed</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-33" href="#Commands-33">8.74.1 Commands</a></li> + </ul></li> + <li><a id="toc-crystalizer" href="#crystalizer">8.75 crystalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-34" href="#Commands-34">8.75.1 Commands</a></li> + </ul></li> + <li><a id="toc-dcshift" href="#dcshift">8.76 dcshift</a></li> + <li><a id="toc-deesser" href="#deesser">8.77 deesser</a></li> + <li><a id="toc-dialoguenhance" href="#dialoguenhance">8.78 dialoguenhance</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-35" href="#Commands-35">8.78.1 Commands</a></li> + </ul></li> + <li><a id="toc-drmeter" href="#drmeter">8.79 drmeter</a></li> + <li><a id="toc-dynaudnorm" href="#dynaudnorm">8.80 dynaudnorm</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-36" href="#Commands-36">8.80.1 Commands</a></li> + </ul></li> + <li><a id="toc-earwax" href="#earwax">8.81 earwax</a></li> + <li><a id="toc-equalizer" href="#equalizer">8.82 equalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-23" href="#Examples-23">8.82.1 Examples</a></li> + <li><a id="toc-Commands-37" href="#Commands-37">8.82.2 Commands</a></li> + </ul></li> + <li><a id="toc-extrastereo" href="#extrastereo">8.83 extrastereo</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-38" href="#Commands-38">8.83.1 Commands</a></li> + </ul></li> + <li><a id="toc-firequalizer" href="#firequalizer">8.84 firequalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-24" href="#Examples-24">8.84.1 Examples</a></li> + </ul></li> + <li><a id="toc-flanger" href="#flanger">8.85 flanger</a></li> + <li><a id="toc-haas" href="#haas">8.86 haas</a></li> + <li><a id="toc-hdcd" href="#hdcd">8.87 hdcd</a></li> + <li><a id="toc-headphone" href="#headphone">8.88 headphone</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-25" href="#Examples-25">8.88.1 Examples</a></li> + </ul></li> + <li><a id="toc-highpass" href="#highpass">8.89 highpass</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-39" href="#Commands-39">8.89.1 Commands</a></li> + </ul></li> + <li><a id="toc-join" href="#join">8.90 join</a></li> + <li><a id="toc-ladspa" href="#ladspa">8.91 ladspa</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-26" href="#Examples-26">8.91.1 Examples</a></li> + <li><a id="toc-Commands-40" href="#Commands-40">8.91.2 Commands</a></li> + </ul></li> + <li><a id="toc-loudnorm" href="#loudnorm">8.92 loudnorm</a></li> + <li><a id="toc-lowpass" href="#lowpass">8.93 lowpass</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-27" href="#Examples-27">8.93.1 Examples</a></li> + <li><a id="toc-Commands-41" href="#Commands-41">8.93.2 Commands</a></li> + </ul></li> + <li><a id="toc-lv2" href="#lv2">8.94 lv2</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-28" href="#Examples-28">8.94.1 Examples</a></li> + <li><a id="toc-Commands-42" href="#Commands-42">8.94.2 Commands</a></li> + </ul></li> + <li><a id="toc-mcompand" href="#mcompand">8.95 mcompand</a></li> + <li><a id="toc-pan-1" href="#pan-1">8.96 pan</a> + <ul class="no-bullet"> + <li><a id="toc-Mixing-examples" href="#Mixing-examples">8.96.1 Mixing examples</a></li> + <li><a id="toc-Remapping-examples" href="#Remapping-examples">8.96.2 Remapping examples</a></li> + </ul></li> + <li><a id="toc-replaygain" href="#replaygain">8.97 replaygain</a></li> + <li><a id="toc-resample" href="#resample">8.98 resample</a></li> + <li><a id="toc-rubberband" href="#rubberband">8.99 rubberband</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-43" href="#Commands-43">8.99.1 Commands</a></li> + </ul></li> + <li><a id="toc-sidechaincompress" href="#sidechaincompress">8.100 sidechaincompress</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-44" href="#Commands-44">8.100.1 Commands</a></li> + <li><a id="toc-Examples-29" href="#Examples-29">8.100.2 Examples</a></li> + </ul></li> + <li><a id="toc-sidechaingate" href="#sidechaingate">8.101 sidechaingate</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-45" href="#Commands-45">8.101.1 Commands</a></li> + </ul></li> + <li><a id="toc-silencedetect" href="#silencedetect">8.102 silencedetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-30" href="#Examples-30">8.102.1 Examples</a></li> + </ul></li> + <li><a id="toc-silenceremove" href="#silenceremove">8.103 silenceremove</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-31" href="#Examples-31">8.103.1 Examples</a></li> + </ul></li> + <li><a id="toc-sofalizer" href="#sofalizer">8.104 sofalizer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-32" href="#Examples-32">8.104.1 Examples</a></li> + </ul></li> + <li><a id="toc-speechnorm" href="#speechnorm">8.105 speechnorm</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-46" href="#Commands-46">8.105.1 Commands</a></li> + <li><a id="toc-Examples-33" href="#Examples-33">8.105.2 Examples</a></li> + </ul></li> + <li><a id="toc-stereotools" href="#stereotools">8.106 stereotools</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-47" href="#Commands-47">8.106.1 Commands</a></li> + <li><a id="toc-Examples-34" href="#Examples-34">8.106.2 Examples</a></li> + </ul></li> + <li><a id="toc-stereowiden" href="#stereowiden">8.107 stereowiden</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-48" href="#Commands-48">8.107.1 Commands</a></li> + </ul></li> + <li><a id="toc-superequalizer" href="#superequalizer">8.108 superequalizer</a></li> + <li><a id="toc-surround" href="#surround">8.109 surround</a></li> + <li><a id="toc-tiltshelf" href="#tiltshelf">8.110 tiltshelf</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-49" href="#Commands-49">8.110.1 Commands</a></li> + </ul></li> + <li><a id="toc-treble_002c-highshelf" href="#treble_002c-highshelf">8.111 treble, highshelf</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-50" href="#Commands-50">8.111.1 Commands</a></li> + </ul></li> + <li><a id="toc-tremolo" href="#tremolo">8.112 tremolo</a></li> + <li><a id="toc-vibrato" href="#vibrato">8.113 vibrato</a></li> + <li><a id="toc-virtualbass" href="#virtualbass">8.114 virtualbass</a></li> + <li><a id="toc-volume" href="#volume">8.115 volume</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-51" href="#Commands-51">8.115.1 Commands</a></li> + <li><a id="toc-Examples-35" href="#Examples-35">8.115.2 Examples</a></li> + </ul></li> + <li><a id="toc-volumedetect" href="#volumedetect">8.116 volumedetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-36" href="#Examples-36">8.116.1 Examples</a></li> + </ul></li> + </ul></li> + <li><a id="toc-Audio-Sources" href="#Audio-Sources">9 Audio Sources</a> + <ul class="no-bullet"> + <li><a id="toc-abuffer" href="#abuffer">9.1 abuffer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-37" href="#Examples-37">9.1.1 Examples</a></li> + </ul></li> + <li><a id="toc-aevalsrc" href="#aevalsrc">9.2 aevalsrc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-38" href="#Examples-38">9.2.1 Examples</a></li> + </ul></li> + <li><a id="toc-afirsrc" href="#afirsrc">9.3 afirsrc</a></li> + <li><a id="toc-anullsrc" href="#anullsrc">9.4 anullsrc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-39" href="#Examples-39">9.4.1 Examples</a></li> + </ul></li> + <li><a id="toc-flite" href="#flite">9.5 flite</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-40" href="#Examples-40">9.5.1 Examples</a></li> + </ul></li> + <li><a id="toc-anoisesrc" href="#anoisesrc">9.6 anoisesrc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-41" href="#Examples-41">9.6.1 Examples</a></li> + </ul></li> + <li><a id="toc-hilbert" href="#hilbert">9.7 hilbert</a></li> + <li><a id="toc-sinc" href="#sinc">9.8 sinc</a></li> + <li><a id="toc-sine" href="#sine">9.9 sine</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-42" href="#Examples-42">9.9.1 Examples</a></li> + </ul></li> + </ul></li> + <li><a id="toc-Audio-Sinks" href="#Audio-Sinks">10 Audio Sinks</a> + <ul class="no-bullet"> + <li><a id="toc-abuffersink" href="#abuffersink">10.1 abuffersink</a></li> + <li><a id="toc-anullsink" href="#anullsink">10.2 anullsink</a></li> + </ul></li> + <li><a id="toc-Video-Filters" href="#Video-Filters">11 Video Filters</a> + <ul class="no-bullet"> + <li><a id="toc-addroi" href="#addroi">11.1 addroi</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-43" href="#Examples-43">11.1.1 Examples</a></li> + </ul></li> + <li><a id="toc-alphaextract" href="#alphaextract">11.2 alphaextract</a></li> + <li><a id="toc-alphamerge" href="#alphamerge">11.3 alphamerge</a></li> + <li><a id="toc-amplify" href="#amplify">11.4 amplify</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-52" href="#Commands-52">11.4.1 Commands</a></li> + </ul></li> + <li><a id="toc-ass" href="#ass">11.5 ass</a></li> + <li><a id="toc-atadenoise" href="#atadenoise">11.6 atadenoise</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-53" href="#Commands-53">11.6.1 Commands</a></li> + </ul></li> + <li><a id="toc-avgblur" href="#avgblur">11.7 avgblur</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-54" href="#Commands-54">11.7.1 Commands</a></li> + </ul></li> + <li><a id="toc-backgroundkey" href="#backgroundkey">11.8 backgroundkey</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-55" href="#Commands-55">11.8.1 Commands</a></li> + </ul></li> + <li><a id="toc-bbox" href="#bbox">11.9 bbox</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-56" href="#Commands-56">11.9.1 Commands</a></li> + </ul></li> + <li><a id="toc-bilateral" href="#bilateral">11.10 bilateral</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-57" href="#Commands-57">11.10.1 Commands</a></li> + </ul></li> + <li><a id="toc-bilateral_005fcuda" href="#bilateral_005fcuda">11.11 bilateral_cuda</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-44" href="#Examples-44">11.11.1 Examples</a></li> + </ul></li> + <li><a id="toc-bitplanenoise" href="#bitplanenoise">11.12 bitplanenoise</a></li> + <li><a id="toc-blackdetect" href="#blackdetect">11.13 blackdetect</a></li> + <li><a id="toc-blackframe" href="#blackframe">11.14 blackframe</a></li> + <li><a id="toc-blend-1" href="#blend-1">11.15 blend</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-45" href="#Examples-45">11.15.1 Examples</a></li> + <li><a id="toc-Commands-58" href="#Commands-58">11.15.2 Commands</a></li> + </ul></li> + <li><a id="toc-blockdetect-1" href="#blockdetect-1">11.16 blockdetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-46" href="#Examples-46">11.16.1 Examples</a></li> + </ul></li> + <li><a id="toc-blurdetect-1" href="#blurdetect-1">11.17 blurdetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-47" href="#Examples-47">11.17.1 Examples</a></li> + </ul></li> + <li><a id="toc-bm3d" href="#bm3d">11.18 bm3d</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-48" href="#Examples-48">11.18.1 Examples</a></li> + </ul></li> + <li><a id="toc-boxblur" href="#boxblur">11.19 boxblur</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-49" href="#Examples-49">11.19.1 Examples</a></li> + </ul></li> + <li><a id="toc-bwdif" href="#bwdif">11.20 bwdif</a></li> + <li><a id="toc-cas" href="#cas">11.21 cas</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-59" href="#Commands-59">11.21.1 Commands</a></li> + </ul></li> + <li><a id="toc-chromahold" href="#chromahold">11.22 chromahold</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-60" href="#Commands-60">11.22.1 Commands</a></li> + </ul></li> + <li><a id="toc-chromakey-1" href="#chromakey-1">11.23 chromakey</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-61" href="#Commands-61">11.23.1 Commands</a></li> + <li><a id="toc-Examples-50" href="#Examples-50">11.23.2 Examples</a></li> + </ul></li> + <li><a id="toc-chromakey_005fcuda" href="#chromakey_005fcuda">11.24 chromakey_cuda</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-51" href="#Examples-51">11.24.1 Examples</a></li> + </ul></li> + <li><a id="toc-chromanr" href="#chromanr">11.25 chromanr</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-62" href="#Commands-62">11.25.1 Commands</a></li> + </ul></li> + <li><a id="toc-chromashift" href="#chromashift">11.26 chromashift</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-63" href="#Commands-63">11.26.1 Commands</a></li> + </ul></li> + <li><a id="toc-ciescope" href="#ciescope">11.27 ciescope</a></li> + <li><a id="toc-codecview" href="#codecview">11.28 codecview</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-52" href="#Examples-52">11.28.1 Examples</a></li> + </ul></li> + <li><a id="toc-colorbalance" href="#colorbalance">11.29 colorbalance</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-53" href="#Examples-53">11.29.1 Examples</a></li> + <li><a id="toc-Commands-64" href="#Commands-64">11.29.2 Commands</a></li> + </ul></li> + <li><a id="toc-colorcontrast" href="#colorcontrast">11.30 colorcontrast</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-65" href="#Commands-65">11.30.1 Commands</a></li> + </ul></li> + <li><a id="toc-colorcorrect" href="#colorcorrect">11.31 colorcorrect</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-66" href="#Commands-66">11.31.1 Commands</a></li> + </ul></li> + <li><a id="toc-colorchannelmixer" href="#colorchannelmixer">11.32 colorchannelmixer</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-54" href="#Examples-54">11.32.1 Examples</a></li> + <li><a id="toc-Commands-67" href="#Commands-67">11.32.2 Commands</a></li> + </ul></li> + <li><a id="toc-colorize" href="#colorize">11.33 colorize</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-68" href="#Commands-68">11.33.1 Commands</a></li> + </ul></li> + <li><a id="toc-colorkey" href="#colorkey">11.34 colorkey</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-55" href="#Examples-55">11.34.1 Examples</a></li> + <li><a id="toc-Commands-69" href="#Commands-69">11.34.2 Commands</a></li> + </ul></li> + <li><a id="toc-colorhold" href="#colorhold">11.35 colorhold</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-70" href="#Commands-70">11.35.1 Commands</a></li> + </ul></li> + <li><a id="toc-colorlevels" href="#colorlevels">11.36 colorlevels</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-56" href="#Examples-56">11.36.1 Examples</a></li> + <li><a id="toc-Commands-71" href="#Commands-71">11.36.2 Commands</a></li> + </ul></li> + <li><a id="toc-colormap" href="#colormap">11.37 colormap</a></li> + <li><a id="toc-colormatrix" href="#colormatrix">11.38 colormatrix</a></li> + <li><a id="toc-colorspace" href="#colorspace">11.39 colorspace</a></li> + <li><a id="toc-colorspace_005fcuda" href="#colorspace_005fcuda">11.40 colorspace_cuda</a></li> + <li><a id="toc-colortemperature" href="#colortemperature">11.41 colortemperature</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-72" href="#Commands-72">11.41.1 Commands</a></li> + </ul></li> + <li><a id="toc-convolution" href="#convolution">11.42 convolution</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-73" href="#Commands-73">11.42.1 Commands</a></li> + <li><a id="toc-Examples-57" href="#Examples-57">11.42.2 Examples</a></li> + </ul></li> + <li><a id="toc-convolve" href="#convolve">11.43 convolve</a></li> + <li><a id="toc-copy" href="#copy">11.44 copy</a></li> + <li><a id="toc-coreimage-1" href="#coreimage-1">11.45 coreimage</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-58" href="#Examples-58">11.45.1 Examples</a></li> + </ul></li> + <li><a id="toc-cover_005frect" href="#cover_005frect">11.46 cover_rect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-59" href="#Examples-59">11.46.1 Examples</a></li> + </ul></li> + <li><a id="toc-crop" href="#crop">11.47 crop</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-60" href="#Examples-60">11.47.1 Examples</a></li> + <li><a id="toc-Commands-74" href="#Commands-74">11.47.2 Commands</a></li> + </ul></li> + <li><a id="toc-cropdetect" href="#cropdetect">11.48 cropdetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-61" href="#Examples-61">11.48.1 Examples</a></li> + </ul></li> + <li><a id="toc-cue-1" href="#cue-1">11.49 cue</a></li> + <li><a id="toc-curves-1" href="#curves-1">11.50 curves</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-75" href="#Commands-75">11.50.1 Commands</a></li> + <li><a id="toc-Examples-62" href="#Examples-62">11.50.2 Examples</a></li> + </ul></li> + <li><a id="toc-datascope" href="#datascope">11.51 datascope</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-76" href="#Commands-76">11.51.1 Commands</a></li> + </ul></li> + <li><a id="toc-dblur" href="#dblur">11.52 dblur</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-77" href="#Commands-77">11.52.1 Commands</a></li> + </ul></li> + <li><a id="toc-dctdnoiz" href="#dctdnoiz">11.53 dctdnoiz</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-63" href="#Examples-63">11.53.1 Examples</a></li> + </ul></li> + <li><a id="toc-deband" href="#deband">11.54 deband</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-78" href="#Commands-78">11.54.1 Commands</a></li> + </ul></li> + <li><a id="toc-deblock" href="#deblock">11.55 deblock</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-64" href="#Examples-64">11.55.1 Examples</a></li> + <li><a id="toc-Commands-79" href="#Commands-79">11.55.2 Commands</a></li> + </ul></li> + <li><a id="toc-decimate-1" href="#decimate-1">11.56 decimate</a></li> + <li><a id="toc-deconvolve" href="#deconvolve">11.57 deconvolve</a></li> + <li><a id="toc-dedot" href="#dedot">11.58 dedot</a></li> + <li><a id="toc-deflate" href="#deflate">11.59 deflate</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-80" href="#Commands-80">11.59.1 Commands</a></li> + </ul></li> + <li><a id="toc-deflicker" href="#deflicker">11.60 deflicker</a></li> + <li><a id="toc-dejudder" href="#dejudder">11.61 dejudder</a></li> + <li><a id="toc-delogo" href="#delogo">11.62 delogo</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-65" href="#Examples-65">11.62.1 Examples</a></li> + </ul></li> + <li><a id="toc-derain-1" href="#derain-1">11.63 derain</a></li> + <li><a id="toc-deshake" href="#deshake">11.64 deshake</a></li> + <li><a id="toc-despill" href="#despill">11.65 despill</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-81" href="#Commands-81">11.65.1 Commands</a></li> + </ul></li> + <li><a id="toc-detelecine" href="#detelecine">11.66 detelecine</a></li> + <li><a id="toc-dilation-1" href="#dilation-1">11.67 dilation</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-82" href="#Commands-82">11.67.1 Commands</a></li> + </ul></li> + <li><a id="toc-displace" href="#displace">11.68 displace</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-66" href="#Examples-66">11.68.1 Examples</a></li> + </ul></li> + <li><a id="toc-dnn_005fclassify" href="#dnn_005fclassify">11.69 dnn_classify</a></li> + <li><a id="toc-dnn_005fdetect" href="#dnn_005fdetect">11.70 dnn_detect</a></li> + <li><a id="toc-dnn_005fprocessing-1" href="#dnn_005fprocessing-1">11.71 dnn_processing</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-67" href="#Examples-67">11.71.1 Examples</a></li> + </ul></li> + <li><a id="toc-drawbox" href="#drawbox">11.72 drawbox</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-68" href="#Examples-68">11.72.1 Examples</a></li> + <li><a id="toc-Commands-83" href="#Commands-83">11.72.2 Commands</a></li> + </ul></li> + <li><a id="toc-drawgraph-1" href="#drawgraph-1">11.73 drawgraph</a></li> + <li><a id="toc-drawgrid" href="#drawgrid">11.74 drawgrid</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-69" href="#Examples-69">11.74.1 Examples</a></li> + <li><a id="toc-Commands-84" href="#Commands-84">11.74.2 Commands</a></li> + </ul></li> + <li><a id="toc-drawtext-1" href="#drawtext-1">11.75 drawtext</a> + <ul class="no-bullet"> + <li><a id="toc-Syntax" href="#Syntax">11.75.1 Syntax</a></li> + <li><a id="toc-Text-expansion" href="#Text-expansion">11.75.2 Text expansion</a></li> + <li><a id="toc-Commands-85" href="#Commands-85">11.75.3 Commands</a></li> + <li><a id="toc-Examples-70" href="#Examples-70">11.75.4 Examples</a></li> + </ul></li> + <li><a id="toc-edgedetect" href="#edgedetect">11.76 edgedetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-71" href="#Examples-71">11.76.1 Examples</a></li> + </ul></li> + <li><a id="toc-elbg" href="#elbg">11.77 elbg</a></li> + <li><a id="toc-entropy" href="#entropy">11.78 entropy</a></li> + <li><a id="toc-epx" href="#epx">11.79 epx</a></li> + <li><a id="toc-eq" href="#eq">11.80 eq</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-86" href="#Commands-86">11.80.1 Commands</a></li> + </ul></li> + <li><a id="toc-erosion-1" href="#erosion-1">11.81 erosion</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-87" href="#Commands-87">11.81.1 Commands</a></li> + </ul></li> + <li><a id="toc-estdif" href="#estdif">11.82 estdif</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-88" href="#Commands-88">11.82.1 Commands</a></li> + </ul></li> + <li><a id="toc-exposure" href="#exposure">11.83 exposure</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-89" href="#Commands-89">11.83.1 Commands</a></li> + </ul></li> + <li><a id="toc-extractplanes" href="#extractplanes">11.84 extractplanes</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-72" href="#Examples-72">11.84.1 Examples</a></li> + </ul></li> + <li><a id="toc-fade" href="#fade">11.85 fade</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-73" href="#Examples-73">11.85.1 Examples</a></li> + </ul></li> + <li><a id="toc-feedback" href="#feedback">11.86 feedback</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-74" href="#Examples-74">11.86.1 Examples</a></li> + </ul></li> + <li><a id="toc-fftdnoiz" href="#fftdnoiz">11.87 fftdnoiz</a></li> + <li><a id="toc-fftfilt" href="#fftfilt">11.88 fftfilt</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-75" href="#Examples-75">11.88.1 Examples</a></li> + </ul></li> + <li><a id="toc-field" href="#field">11.89 field</a></li> + <li><a id="toc-fieldhint" href="#fieldhint">11.90 fieldhint</a></li> + <li><a id="toc-fieldmatch" href="#fieldmatch">11.91 fieldmatch</a> + <ul class="no-bullet"> + <li><a id="toc-p_002fc_002fn_002fu_002fb-meaning-1" href="#p_002fc_002fn_002fu_002fb-meaning-1">11.91.1 p/c/n/u/b meaning</a> + <ul class="no-bullet"> + <li><a id="toc-p_002fc_002fn" href="#p_002fc_002fn">11.91.1.1 p/c/n</a></li> + <li><a id="toc-u_002fb" href="#u_002fb">11.91.1.2 u/b</a></li> + </ul></li> + <li><a id="toc-Examples-76" href="#Examples-76">11.91.2 Examples</a></li> + </ul></li> + <li><a id="toc-fieldorder" href="#fieldorder">11.92 fieldorder</a></li> + <li><a id="toc-fifo_002c-afifo" href="#fifo_002c-afifo">11.93 fifo, afifo</a></li> + <li><a id="toc-fillborders" href="#fillborders">11.94 fillborders</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-90" href="#Commands-90">11.94.1 Commands</a></li> + </ul></li> + <li><a id="toc-find_005frect" href="#find_005frect">11.95 find_rect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-77" href="#Examples-77">11.95.1 Examples</a></li> + </ul></li> + <li><a id="toc-floodfill" href="#floodfill">11.96 floodfill</a></li> + <li><a id="toc-format-1" href="#format-1">11.97 format</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-78" href="#Examples-78">11.97.1 Examples</a></li> + </ul></li> + <li><a id="toc-fps-1" href="#fps-1">11.98 fps</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-79" href="#Examples-79">11.98.1 Examples</a></li> + </ul></li> + <li><a id="toc-framepack" href="#framepack">11.99 framepack</a></li> + <li><a id="toc-framerate" href="#framerate">11.100 framerate</a></li> + <li><a id="toc-framestep" href="#framestep">11.101 framestep</a></li> + <li><a id="toc-freezedetect" href="#freezedetect">11.102 freezedetect</a></li> + <li><a id="toc-freezeframes" href="#freezeframes">11.103 freezeframes</a></li> + <li><a id="toc-frei0r-1" href="#frei0r-1">11.104 frei0r</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-80" href="#Examples-80">11.104.1 Examples</a></li> + <li><a id="toc-Commands-91" href="#Commands-91">11.104.2 Commands</a></li> + </ul></li> + <li><a id="toc-fspp" href="#fspp">11.105 fspp</a></li> + <li><a id="toc-gblur" href="#gblur">11.106 gblur</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-92" href="#Commands-92">11.106.1 Commands</a></li> + </ul></li> + <li><a id="toc-geq" href="#geq">11.107 geq</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-81" href="#Examples-81">11.107.1 Examples</a></li> + </ul></li> + <li><a id="toc-gradfun" href="#gradfun">11.108 gradfun</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-82" href="#Examples-82">11.108.1 Examples</a></li> + </ul></li> + <li><a id="toc-graphmonitor-1" href="#graphmonitor-1">11.109 graphmonitor</a></li> + <li><a id="toc-grayworld" href="#grayworld">11.110 grayworld</a></li> + <li><a id="toc-greyedge" href="#greyedge">11.111 greyedge</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-83" href="#Examples-83">11.111.1 Examples</a></li> + </ul></li> + <li><a id="toc-guided" href="#guided">11.112 guided</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-93" href="#Commands-93">11.112.1 Commands</a></li> + <li><a id="toc-Examples-84" href="#Examples-84">11.112.2 Examples</a></li> + </ul></li> + <li><a id="toc-haldclut-1" href="#haldclut-1">11.113 haldclut</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-94" href="#Commands-94">11.113.1 Commands</a></li> + <li><a id="toc-Workflow-examples" href="#Workflow-examples">11.113.2 Workflow examples</a> + <ul class="no-bullet"> + <li><a id="toc-Hald-CLUT-video-stream" href="#Hald-CLUT-video-stream">11.113.2.1 Hald CLUT video stream</a></li> + <li><a id="toc-Hald-CLUT-with-preview" href="#Hald-CLUT-with-preview">11.113.2.2 Hald CLUT with preview</a></li> + </ul></li> + </ul></li> + <li><a id="toc-hflip" href="#hflip">11.114 hflip</a></li> + <li><a id="toc-histeq" href="#histeq">11.115 histeq</a></li> + <li><a id="toc-histogram-1" href="#histogram-1">11.116 histogram</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-85" href="#Examples-85">11.116.1 Examples</a></li> + </ul></li> + <li><a id="toc-hqdn3d-1" href="#hqdn3d-1">11.117 hqdn3d</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-95" href="#Commands-95">11.117.1 Commands</a></li> + </ul></li> + <li><a id="toc-hwdownload-1" href="#hwdownload-1">11.118 hwdownload</a></li> + <li><a id="toc-hwmap" href="#hwmap">11.119 hwmap</a></li> + <li><a id="toc-hwupload-1" href="#hwupload-1">11.120 hwupload</a></li> + <li><a id="toc-hwupload_005fcuda-1" href="#hwupload_005fcuda-1">11.121 hwupload_cuda</a></li> + <li><a id="toc-hqx" href="#hqx">11.122 hqx</a></li> + <li><a id="toc-hstack" href="#hstack">11.123 hstack</a></li> + <li><a id="toc-hsvhold" href="#hsvhold">11.124 hsvhold</a></li> + <li><a id="toc-hsvkey" href="#hsvkey">11.125 hsvkey</a></li> + <li><a id="toc-hue" href="#hue">11.126 hue</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-86" href="#Examples-86">11.126.1 Examples</a></li> + <li><a id="toc-Commands-96" href="#Commands-96">11.126.2 Commands</a></li> + </ul></li> + <li><a id="toc-huesaturation" href="#huesaturation">11.127 huesaturation</a></li> + <li><a id="toc-hysteresis" href="#hysteresis">11.128 hysteresis</a></li> + <li><a id="toc-iccdetect" href="#iccdetect">11.129 iccdetect</a></li> + <li><a id="toc-iccgen" href="#iccgen">11.130 iccgen</a></li> + <li><a id="toc-identity" href="#identity">11.131 identity</a></li> + <li><a id="toc-idet" href="#idet">11.132 idet</a></li> + <li><a id="toc-il" href="#il">11.133 il</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-97" href="#Commands-97">11.133.1 Commands</a></li> + </ul></li> + <li><a id="toc-inflate" href="#inflate">11.134 inflate</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-98" href="#Commands-98">11.134.1 Commands</a></li> + </ul></li> + <li><a id="toc-interlace" href="#interlace">11.135 interlace</a></li> + <li><a id="toc-kerndeint" href="#kerndeint">11.136 kerndeint</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-87" href="#Examples-87">11.136.1 Examples</a></li> + </ul></li> + <li><a id="toc-kirsch" href="#kirsch">11.137 kirsch</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-99" href="#Commands-99">11.137.1 Commands</a></li> + </ul></li> + <li><a id="toc-lagfun" href="#lagfun">11.138 lagfun</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-100" href="#Commands-100">11.138.1 Commands</a></li> + </ul></li> + <li><a id="toc-lenscorrection" href="#lenscorrection">11.139 lenscorrection</a> + <ul class="no-bullet"> + <li><a id="toc-Options" href="#Options">11.139.1 Options</a></li> + <li><a id="toc-Commands-101" href="#Commands-101">11.139.2 Commands</a></li> + </ul></li> + <li><a id="toc-lensfun" href="#lensfun">11.140 lensfun</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-88" href="#Examples-88">11.140.1 Examples</a></li> + </ul></li> + <li><a id="toc-libplacebo" href="#libplacebo">11.141 libplacebo</a> + <ul class="no-bullet"> + <li><a id="toc-Options-1" href="#Options-1">11.141.1 Options</a> + <ul class="no-bullet"> + <li><a id="toc-Output-mode" href="#Output-mode">11.141.1.1 Output mode</a></li> + <li><a id="toc-Scaling" href="#Scaling">11.141.1.2 Scaling</a></li> + <li><a id="toc-Debanding" href="#Debanding">11.141.1.3 Debanding</a></li> + <li><a id="toc-Color-adjustment" href="#Color-adjustment">11.141.1.4 Color adjustment</a></li> + <li><a id="toc-Peak-detection" href="#Peak-detection">11.141.1.5 Peak detection</a></li> + <li><a id="toc-Tone-mapping" href="#Tone-mapping">11.141.1.6 Tone mapping</a></li> + <li><a id="toc-Dithering" href="#Dithering">11.141.1.7 Dithering</a></li> + <li><a id="toc-Custom-shaders" href="#Custom-shaders">11.141.1.8 Custom shaders</a></li> + <li><a id="toc-Debugging-_002f-performance" href="#Debugging-_002f-performance">11.141.1.9 Debugging / performance</a></li> + </ul></li> + <li><a id="toc-Commands-102" href="#Commands-102">11.141.2 Commands</a></li> + <li><a id="toc-Examples-89" href="#Examples-89">11.141.3 Examples</a></li> + </ul></li> + <li><a id="toc-libvmaf" href="#libvmaf">11.142 libvmaf</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-90" href="#Examples-90">11.142.1 Examples</a></li> + </ul></li> + <li><a id="toc-limitdiff" href="#limitdiff">11.143 limitdiff</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-103" href="#Commands-103">11.143.1 Commands</a></li> + </ul></li> + <li><a id="toc-limiter" href="#limiter">11.144 limiter</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-104" href="#Commands-104">11.144.1 Commands</a></li> + </ul></li> + <li><a id="toc-loop" href="#loop">11.145 loop</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-91" href="#Examples-91">11.145.1 Examples</a></li> + </ul></li> + <li><a id="toc-lut1d" href="#lut1d">11.146 lut1d</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-105" href="#Commands-105">11.146.1 Commands</a></li> + </ul></li> + <li><a id="toc-lut3d-1" href="#lut3d-1">11.147 lut3d</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-106" href="#Commands-106">11.147.1 Commands</a></li> + </ul></li> + <li><a id="toc-lumakey" href="#lumakey">11.148 lumakey</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-107" href="#Commands-107">11.148.1 Commands</a></li> + </ul></li> + <li><a id="toc-lut_002c-lutrgb_002c-lutyuv" href="#lut_002c-lutrgb_002c-lutyuv">11.149 lut, lutrgb, lutyuv</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-108" href="#Commands-108">11.149.1 Commands</a></li> + <li><a id="toc-Examples-92" href="#Examples-92">11.149.2 Examples</a></li> + </ul></li> + <li><a id="toc-lut2_002c-tlut2" href="#lut2_002c-tlut2">11.150 lut2, tlut2</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-109" href="#Commands-109">11.150.1 Commands</a></li> + <li><a id="toc-Examples-93" href="#Examples-93">11.150.2 Examples</a></li> + </ul></li> + <li><a id="toc-maskedclamp" href="#maskedclamp">11.151 maskedclamp</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-110" href="#Commands-110">11.151.1 Commands</a></li> + </ul></li> + <li><a id="toc-maskedmax" href="#maskedmax">11.152 maskedmax</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-111" href="#Commands-111">11.152.1 Commands</a></li> + </ul></li> + <li><a id="toc-maskedmerge" href="#maskedmerge">11.153 maskedmerge</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-112" href="#Commands-112">11.153.1 Commands</a></li> + </ul></li> + <li><a id="toc-maskedmin" href="#maskedmin">11.154 maskedmin</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-113" href="#Commands-113">11.154.1 Commands</a></li> + </ul></li> + <li><a id="toc-maskedthreshold" href="#maskedthreshold">11.155 maskedthreshold</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-114" href="#Commands-114">11.155.1 Commands</a></li> + </ul></li> + <li><a id="toc-maskfun" href="#maskfun">11.156 maskfun</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-115" href="#Commands-115">11.156.1 Commands</a></li> + </ul></li> + <li><a id="toc-mcdeint" href="#mcdeint">11.157 mcdeint</a></li> + <li><a id="toc-median" href="#median">11.158 median</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-116" href="#Commands-116">11.158.1 Commands</a></li> + </ul></li> + <li><a id="toc-mergeplanes" href="#mergeplanes">11.159 mergeplanes</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-94" href="#Examples-94">11.159.1 Examples</a></li> + </ul></li> + <li><a id="toc-mestimate" href="#mestimate">11.160 mestimate</a></li> + <li><a id="toc-midequalizer" href="#midequalizer">11.161 midequalizer</a></li> + <li><a id="toc-minterpolate" href="#minterpolate">11.162 minterpolate</a></li> + <li><a id="toc-mix" href="#mix">11.163 mix</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-117" href="#Commands-117">11.163.1 Commands</a></li> + </ul></li> + <li><a id="toc-monochrome" href="#monochrome">11.164 monochrome</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-118" href="#Commands-118">11.164.1 Commands</a></li> + </ul></li> + <li><a id="toc-morpho" href="#morpho">11.165 morpho</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-119" href="#Commands-119">11.165.1 Commands</a></li> + </ul></li> + <li><a id="toc-mpdecimate" href="#mpdecimate">11.166 mpdecimate</a></li> + <li><a id="toc-msad" href="#msad">11.167 msad</a></li> + <li><a id="toc-multiply" href="#multiply">11.168 multiply</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-120" href="#Commands-120">11.168.1 Commands</a></li> + </ul></li> + <li><a id="toc-negate" href="#negate">11.169 negate</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-121" href="#Commands-121">11.169.1 Commands</a></li> + </ul></li> + <li><a id="toc-nlmeans-1" href="#nlmeans-1">11.170 nlmeans</a></li> + <li><a id="toc-nnedi" href="#nnedi">11.171 nnedi</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-122" href="#Commands-122">11.171.1 Commands</a></li> + </ul></li> + <li><a id="toc-noformat" href="#noformat">11.172 noformat</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-95" href="#Examples-95">11.172.1 Examples</a></li> + </ul></li> + <li><a id="toc-noise" href="#noise">11.173 noise</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-96" href="#Examples-96">11.173.1 Examples</a></li> + </ul></li> + <li><a id="toc-normalize" href="#normalize">11.174 normalize</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-123" href="#Commands-123">11.174.1 Commands</a></li> + <li><a id="toc-Examples-97" href="#Examples-97">11.174.2 Examples</a></li> + </ul></li> + <li><a id="toc-null" href="#null">11.175 null</a></li> + <li><a id="toc-ocr" href="#ocr">11.176 ocr</a></li> + <li><a id="toc-ocv" href="#ocv">11.177 ocv</a> + <ul class="no-bullet"> + <li><a id="toc-dilate-1" href="#dilate-1">11.177.1 dilate</a></li> + <li><a id="toc-erode" href="#erode">11.177.2 erode</a></li> + <li><a id="toc-smooth" href="#smooth">11.177.3 smooth</a></li> + </ul></li> + <li><a id="toc-oscilloscope" href="#oscilloscope">11.178 oscilloscope</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-124" href="#Commands-124">11.178.1 Commands</a></li> + <li><a id="toc-Examples-98" href="#Examples-98">11.178.2 Examples</a></li> + </ul></li> + <li><a id="toc-overlay-1" href="#overlay-1">11.179 overlay</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-125" href="#Commands-125">11.179.1 Commands</a></li> + <li><a id="toc-Examples-99" href="#Examples-99">11.179.2 Examples</a></li> + </ul></li> + <li><a id="toc-overlay_005fcuda-1" href="#overlay_005fcuda-1">11.180 overlay_cuda</a></li> + <li><a id="toc-owdenoise" href="#owdenoise">11.181 owdenoise</a></li> + <li><a id="toc-pad-1" href="#pad-1">11.182 pad</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-100" href="#Examples-100">11.182.1 Examples</a></li> + </ul></li> + <li><a id="toc-palettegen-1" href="#palettegen-1">11.183 palettegen</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-101" href="#Examples-101">11.183.1 Examples</a></li> + </ul></li> + <li><a id="toc-paletteuse" href="#paletteuse">11.184 paletteuse</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-102" href="#Examples-102">11.184.1 Examples</a></li> + </ul></li> + <li><a id="toc-perspective" href="#perspective">11.185 perspective</a></li> + <li><a id="toc-phase" href="#phase">11.186 phase</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-126" href="#Commands-126">11.186.1 Commands</a></li> + </ul></li> + <li><a id="toc-photosensitivity" href="#photosensitivity">11.187 photosensitivity</a></li> + <li><a id="toc-pixdesctest" href="#pixdesctest">11.188 pixdesctest</a></li> + <li><a id="toc-pixelize" href="#pixelize">11.189 pixelize</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-127" href="#Commands-127">11.189.1 Commands</a></li> + </ul></li> + <li><a id="toc-pixscope" href="#pixscope">11.190 pixscope</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-128" href="#Commands-128">11.190.1 Commands</a></li> + </ul></li> + <li><a id="toc-pp" href="#pp">11.191 pp</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-103" href="#Examples-103">11.191.1 Examples</a></li> + </ul></li> + <li><a id="toc-pp7" href="#pp7">11.192 pp7</a></li> + <li><a id="toc-premultiply" href="#premultiply">11.193 premultiply</a></li> + <li><a id="toc-prewitt" href="#prewitt">11.194 prewitt</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-129" href="#Commands-129">11.194.1 Commands</a></li> + </ul></li> + <li><a id="toc-pseudocolor" href="#pseudocolor">11.195 pseudocolor</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-130" href="#Commands-130">11.195.1 Commands</a></li> + <li><a id="toc-Examples-104" href="#Examples-104">11.195.2 Examples</a></li> + </ul></li> + <li><a id="toc-psnr" href="#psnr">11.196 psnr</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-105" href="#Examples-105">11.196.1 Examples</a></li> + </ul></li> + <li><a id="toc-pullup-1" href="#pullup-1">11.197 pullup</a></li> + <li><a id="toc-qp" href="#qp">11.198 qp</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-106" href="#Examples-106">11.198.1 Examples</a></li> + </ul></li> + <li><a id="toc-random" href="#random">11.199 random</a></li> + <li><a id="toc-readeia608" href="#readeia608">11.200 readeia608</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-131" href="#Commands-131">11.200.1 Commands</a></li> + <li><a id="toc-Examples-107" href="#Examples-107">11.200.2 Examples</a></li> + </ul></li> + <li><a id="toc-readvitc" href="#readvitc">11.201 readvitc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-108" href="#Examples-108">11.201.1 Examples</a></li> + </ul></li> + <li><a id="toc-remap" href="#remap">11.202 remap</a></li> + <li><a id="toc-removegrain" href="#removegrain">11.203 removegrain</a></li> + <li><a id="toc-removelogo" href="#removelogo">11.204 removelogo</a></li> + <li><a id="toc-repeatfields" href="#repeatfields">11.205 repeatfields</a></li> + <li><a id="toc-reverse" href="#reverse">11.206 reverse</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-109" href="#Examples-109">11.206.1 Examples</a></li> + </ul></li> + <li><a id="toc-rgbashift" href="#rgbashift">11.207 rgbashift</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-132" href="#Commands-132">11.207.1 Commands</a></li> + </ul></li> + <li><a id="toc-roberts" href="#roberts">11.208 roberts</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-133" href="#Commands-133">11.208.1 Commands</a></li> + </ul></li> + <li><a id="toc-rotate" href="#rotate">11.209 rotate</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-110" href="#Examples-110">11.209.1 Examples</a></li> + <li><a id="toc-Commands-134" href="#Commands-134">11.209.2 Commands</a></li> + </ul></li> + <li><a id="toc-sab" href="#sab">11.210 sab</a></li> + <li><a id="toc-scale-1" href="#scale-1">11.211 scale</a> + <ul class="no-bullet"> + <li><a id="toc-Options-2" href="#Options-2">11.211.1 Options</a></li> + <li><a id="toc-Examples-111" href="#Examples-111">11.211.2 Examples</a></li> + <li><a id="toc-Commands-135" href="#Commands-135">11.211.3 Commands</a></li> + </ul></li> + <li><a id="toc-scale_005fcuda" href="#scale_005fcuda">11.212 scale_cuda</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-112" href="#Examples-112">11.212.1 Examples</a></li> + </ul></li> + <li><a id="toc-scale_005fnpp-1" href="#scale_005fnpp-1">11.213 scale_npp</a></li> + <li><a id="toc-scale2ref" href="#scale2ref">11.214 scale2ref</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-113" href="#Examples-113">11.214.1 Examples</a></li> + <li><a id="toc-Commands-136" href="#Commands-136">11.214.2 Commands</a></li> + </ul></li> + <li><a id="toc-scale2ref_005fnpp" href="#scale2ref_005fnpp">11.215 scale2ref_npp</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-114" href="#Examples-114">11.215.1 Examples</a></li> + </ul></li> + <li><a id="toc-scharr" href="#scharr">11.216 scharr</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-137" href="#Commands-137">11.216.1 Commands</a></li> + </ul></li> + <li><a id="toc-scroll" href="#scroll">11.217 scroll</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-138" href="#Commands-138">11.217.1 Commands</a></li> + </ul></li> + <li><a id="toc-scdet-1" href="#scdet-1">11.218 scdet</a></li> + <li><a id="toc-selectivecolor-1" href="#selectivecolor-1">11.219 selectivecolor</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-115" href="#Examples-115">11.219.1 Examples</a></li> + </ul></li> + <li><a id="toc-separatefields-1" href="#separatefields-1">11.220 separatefields</a></li> + <li><a id="toc-setdar_002c-setsar" href="#setdar_002c-setsar">11.221 setdar, setsar</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-116" href="#Examples-116">11.221.1 Examples</a></li> + </ul></li> + <li><a id="toc-setfield-1" href="#setfield-1">11.222 setfield</a></li> + <li><a id="toc-setparams-1" href="#setparams-1">11.223 setparams</a></li> + <li><a id="toc-sharpen_005fnpp" href="#sharpen_005fnpp">11.224 sharpen_npp</a></li> + <li><a id="toc-shear" href="#shear">11.225 shear</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-139" href="#Commands-139">11.225.1 Commands</a></li> + </ul></li> + <li><a id="toc-showinfo" href="#showinfo">11.226 showinfo</a></li> + <li><a id="toc-showpalette" href="#showpalette">11.227 showpalette</a></li> + <li><a id="toc-shuffleframes" href="#shuffleframes">11.228 shuffleframes</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-117" href="#Examples-117">11.228.1 Examples</a></li> + </ul></li> + <li><a id="toc-shufflepixels" href="#shufflepixels">11.229 shufflepixels</a></li> + <li><a id="toc-shuffleplanes" href="#shuffleplanes">11.230 shuffleplanes</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-118" href="#Examples-118">11.230.1 Examples</a></li> + </ul></li> + <li><a id="toc-signalstats-1" href="#signalstats-1">11.231 signalstats</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-119" href="#Examples-119">11.231.1 Examples</a></li> + </ul></li> + <li><a id="toc-signature-1" href="#signature-1">11.232 signature</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-120" href="#Examples-120">11.232.1 Examples</a></li> + </ul></li> + <li><a id="toc-siti-1" href="#siti-1">11.233 siti</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-121" href="#Examples-121">11.233.1 Examples</a></li> + </ul></li> + <li><a id="toc-smartblur-1" href="#smartblur-1">11.234 smartblur</a></li> + <li><a id="toc-sobel" href="#sobel">11.235 sobel</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-140" href="#Commands-140">11.235.1 Commands</a></li> + </ul></li> + <li><a id="toc-spp-1" href="#spp-1">11.236 spp</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-141" href="#Commands-141">11.236.1 Commands</a></li> + </ul></li> + <li><a id="toc-sr-1" href="#sr-1">11.237 sr</a></li> + <li><a id="toc-ssim" href="#ssim">11.238 ssim</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-122" href="#Examples-122">11.238.1 Examples</a></li> + </ul></li> + <li><a id="toc-stereo3d" href="#stereo3d">11.239 stereo3d</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-123" href="#Examples-123">11.239.1 Examples</a></li> + </ul></li> + <li><a id="toc-streamselect_002c-astreamselect" href="#streamselect_002c-astreamselect">11.240 streamselect, astreamselect</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-142" href="#Commands-142">11.240.1 Commands</a></li> + <li><a id="toc-Examples-124" href="#Examples-124">11.240.2 Examples</a></li> + </ul></li> + <li><a id="toc-subtitles-1" href="#subtitles-1">11.241 subtitles</a></li> + <li><a id="toc-super2xsai" href="#super2xsai">11.242 super2xsai</a></li> + <li><a id="toc-swaprect" href="#swaprect">11.243 swaprect</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-143" href="#Commands-143">11.243.1 Commands</a></li> + </ul></li> + <li><a id="toc-swapuv" href="#swapuv">11.244 swapuv</a></li> + <li><a id="toc-tblend" href="#tblend">11.245 tblend</a></li> + <li><a id="toc-telecine" href="#telecine">11.246 telecine</a></li> + <li><a id="toc-thistogram" href="#thistogram">11.247 thistogram</a></li> + <li><a id="toc-threshold" href="#threshold">11.248 threshold</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-144" href="#Commands-144">11.248.1 Commands</a></li> + <li><a id="toc-Examples-125" href="#Examples-125">11.248.2 Examples</a></li> + </ul></li> + <li><a id="toc-thumbnail" href="#thumbnail">11.249 thumbnail</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-126" href="#Examples-126">11.249.1 Examples</a></li> + </ul></li> + <li><a id="toc-tile-1" href="#tile-1">11.250 tile</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-127" href="#Examples-127">11.250.1 Examples</a></li> + </ul></li> + <li><a id="toc-tinterlace" href="#tinterlace">11.251 tinterlace</a></li> + <li><a id="toc-tmedian" href="#tmedian">11.252 tmedian</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-145" href="#Commands-145">11.252.1 Commands</a></li> + </ul></li> + <li><a id="toc-tmidequalizer" href="#tmidequalizer">11.253 tmidequalizer</a></li> + <li><a id="toc-tmix" href="#tmix">11.254 tmix</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-128" href="#Examples-128">11.254.1 Examples</a></li> + <li><a id="toc-Commands-146" href="#Commands-146">11.254.2 Commands</a></li> + </ul></li> + <li><a id="toc-tonemap-1" href="#tonemap-1">11.255 tonemap</a> + <ul class="no-bullet"> + <li><a id="toc-Options-3" href="#Options-3">11.255.1 Options</a></li> + </ul></li> + <li><a id="toc-tpad" href="#tpad">11.256 tpad</a></li> + <li><a id="toc-transpose-1" href="#transpose-1">11.257 transpose</a></li> + <li><a id="toc-transpose_005fnpp" href="#transpose_005fnpp">11.258 transpose_npp</a></li> + <li><a id="toc-trim" href="#trim">11.259 trim</a></li> + <li><a id="toc-unpremultiply" href="#unpremultiply">11.260 unpremultiply</a></li> + <li><a id="toc-unsharp-1" href="#unsharp-1">11.261 unsharp</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-129" href="#Examples-129">11.261.1 Examples</a></li> + </ul></li> + <li><a id="toc-untile-1" href="#untile-1">11.262 untile</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-130" href="#Examples-130">11.262.1 Examples</a></li> + </ul></li> + <li><a id="toc-uspp" href="#uspp">11.263 uspp</a></li> + <li><a id="toc-v360" href="#v360">11.264 v360</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-131" href="#Examples-131">11.264.1 Examples</a></li> + <li><a id="toc-Commands-147" href="#Commands-147">11.264.2 Commands</a></li> + </ul></li> + <li><a id="toc-vaguedenoiser" href="#vaguedenoiser">11.265 vaguedenoiser</a></li> + <li><a id="toc-varblur" href="#varblur">11.266 varblur</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-148" href="#Commands-148">11.266.1 Commands</a></li> + </ul></li> + <li><a id="toc-vectorscope" href="#vectorscope">11.267 vectorscope</a></li> + <li><a id="toc-vidstabdetect-1" href="#vidstabdetect-1">11.268 vidstabdetect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-132" href="#Examples-132">11.268.1 Examples</a></li> + </ul></li> + <li><a id="toc-vidstabtransform-1" href="#vidstabtransform-1">11.269 vidstabtransform</a> + <ul class="no-bullet"> + <li><a id="toc-Options-4" href="#Options-4">11.269.1 Options</a></li> + <li><a id="toc-Examples-133" href="#Examples-133">11.269.2 Examples</a></li> + </ul></li> + <li><a id="toc-vflip" href="#vflip">11.270 vflip</a></li> + <li><a id="toc-vfrdet" href="#vfrdet">11.271 vfrdet</a></li> + <li><a id="toc-vibrance" href="#vibrance">11.272 vibrance</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-149" href="#Commands-149">11.272.1 Commands</a></li> + </ul></li> + <li><a id="toc-vif" href="#vif">11.273 vif</a></li> + <li><a id="toc-vignette-1" href="#vignette-1">11.274 vignette</a> + <ul class="no-bullet"> + <li><a id="toc-Expressions" href="#Expressions">11.274.1 Expressions</a></li> + <li><a id="toc-Examples-134" href="#Examples-134">11.274.2 Examples</a></li> + </ul></li> + <li><a id="toc-vmafmotion" href="#vmafmotion">11.275 vmafmotion</a></li> + <li><a id="toc-vstack" href="#vstack">11.276 vstack</a></li> + <li><a id="toc-w3fdif" href="#w3fdif">11.277 w3fdif</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-150" href="#Commands-150">11.277.1 Commands</a></li> + </ul></li> + <li><a id="toc-waveform" href="#waveform">11.278 waveform</a></li> + <li><a id="toc-weave_002c-doubleweave" href="#weave_002c-doubleweave">11.279 weave, doubleweave</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-135" href="#Examples-135">11.279.1 Examples</a></li> + </ul></li> + <li><a id="toc-xbr" href="#xbr">11.280 xbr</a></li> + <li><a id="toc-xcorrelate" href="#xcorrelate">11.281 xcorrelate</a></li> + <li><a id="toc-xfade" href="#xfade">11.282 xfade</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-136" href="#Examples-136">11.282.1 Examples</a></li> + </ul></li> + <li><a id="toc-xmedian" href="#xmedian">11.283 xmedian</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-151" href="#Commands-151">11.283.1 Commands</a></li> + </ul></li> + <li><a id="toc-xstack" href="#xstack">11.284 xstack</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-137" href="#Examples-137">11.284.1 Examples</a></li> + </ul></li> + <li><a id="toc-yadif-1" href="#yadif-1">11.285 yadif</a></li> + <li><a id="toc-yadif_005fcuda" href="#yadif_005fcuda">11.286 yadif_cuda</a></li> + <li><a id="toc-yaepblur" href="#yaepblur">11.287 yaepblur</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-152" href="#Commands-152">11.287.1 Commands</a></li> + </ul></li> + <li><a id="toc-zoompan" href="#zoompan">11.288 zoompan</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-138" href="#Examples-138">11.288.1 Examples</a></li> + </ul></li> + <li><a id="toc-zscale-1" href="#zscale-1">11.289 zscale</a> + <ul class="no-bullet"> + <li><a id="toc-Options-5" href="#Options-5">11.289.1 Options</a></li> + <li><a id="toc-Commands-153" href="#Commands-153">11.289.2 Commands</a></li> + </ul></li> + </ul></li> + <li><a id="toc-OpenCL-Video-Filters" href="#OpenCL-Video-Filters">12 OpenCL Video Filters</a> + <ul class="no-bullet"> + <li><a id="toc-avgblur_005fopencl" href="#avgblur_005fopencl">12.1 avgblur_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example" href="#Example">12.1.1 Example</a></li> + </ul></li> + <li><a id="toc-boxblur_005fopencl" href="#boxblur_005fopencl">12.2 boxblur_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-139" href="#Examples-139">12.2.1 Examples</a></li> + </ul></li> + <li><a id="toc-colorkey_005fopencl" href="#colorkey_005fopencl">12.3 colorkey_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-140" href="#Examples-140">12.3.1 Examples</a></li> + </ul></li> + <li><a id="toc-convolution_005fopencl" href="#convolution_005fopencl">12.4 convolution_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-141" href="#Examples-141">12.4.1 Examples</a></li> + </ul></li> + <li><a id="toc-erosion_005fopencl" href="#erosion_005fopencl">12.5 erosion_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-1" href="#Example-1">12.5.1 Example</a></li> + </ul></li> + <li><a id="toc-deshake_005fopencl" href="#deshake_005fopencl">12.6 deshake_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-142" href="#Examples-142">12.6.1 Examples</a></li> + </ul></li> + <li><a id="toc-dilation_005fopencl" href="#dilation_005fopencl">12.7 dilation_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-2" href="#Example-2">12.7.1 Example</a></li> + </ul></li> + <li><a id="toc-nlmeans_005fopencl" href="#nlmeans_005fopencl">12.8 nlmeans_opencl</a></li> + <li><a id="toc-overlay_005fopencl" href="#overlay_005fopencl">12.9 overlay_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-143" href="#Examples-143">12.9.1 Examples</a></li> + </ul></li> + <li><a id="toc-pad_005fopencl" href="#pad_005fopencl">12.10 pad_opencl</a></li> + <li><a id="toc-prewitt_005fopencl" href="#prewitt_005fopencl">12.11 prewitt_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-3" href="#Example-3">12.11.1 Example</a></li> + </ul></li> + <li><a id="toc-program_005fopencl-1" href="#program_005fopencl-1">12.12 program_opencl</a></li> + <li><a id="toc-remap_005fopencl" href="#remap_005fopencl">12.13 remap_opencl</a></li> + <li><a id="toc-roberts_005fopencl" href="#roberts_005fopencl">12.14 roberts_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-4" href="#Example-4">12.14.1 Example</a></li> + </ul></li> + <li><a id="toc-sobel_005fopencl" href="#sobel_005fopencl">12.15 sobel_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-5" href="#Example-5">12.15.1 Example</a></li> + </ul></li> + <li><a id="toc-tonemap_005fopencl" href="#tonemap_005fopencl">12.16 tonemap_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Example-6" href="#Example-6">12.16.1 Example</a></li> + </ul></li> + <li><a id="toc-unsharp_005fopencl" href="#unsharp_005fopencl">12.17 unsharp_opencl</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-144" href="#Examples-144">12.17.1 Examples</a></li> + </ul></li> + <li><a id="toc-xfade_005fopencl" href="#xfade_005fopencl">12.18 xfade_opencl</a></li> + </ul></li> + <li><a id="toc-VAAPI-Video-Filters" href="#VAAPI-Video-Filters">13 VAAPI Video Filters</a> + <ul class="no-bullet"> + <li><a id="toc-overlay_005fvaapi" href="#overlay_005fvaapi">13.1 overlay_vaapi</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-145" href="#Examples-145">13.1.1 Examples</a></li> + </ul></li> + <li><a id="toc-tonemap_005fvaapi" href="#tonemap_005fvaapi">13.2 tonemap_vaapi</a> + <ul class="no-bullet"> + <li><a id="toc-Example-7" href="#Example-7">13.2.1 Example</a></li> + </ul></li> + </ul></li> + <li><a id="toc-Video-Sources" href="#Video-Sources">14 Video Sources</a> + <ul class="no-bullet"> + <li><a id="toc-buffer" href="#buffer">14.1 buffer</a></li> + <li><a id="toc-cellauto" href="#cellauto">14.2 cellauto</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-146" href="#Examples-146">14.2.1 Examples</a></li> + </ul></li> + <li><a id="toc-coreimagesrc-1" href="#coreimagesrc-1">14.3 coreimagesrc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-147" href="#Examples-147">14.3.1 Examples</a></li> + </ul></li> + <li><a id="toc-ddagrab" href="#ddagrab">14.4 ddagrab</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-148" href="#Examples-148">14.4.1 Examples</a></li> + </ul></li> + <li><a id="toc-gradients" href="#gradients">14.5 gradients</a></li> + <li><a id="toc-mandelbrot" href="#mandelbrot">14.6 mandelbrot</a></li> + <li><a id="toc-mptestsrc" href="#mptestsrc">14.7 mptestsrc</a></li> + <li><a id="toc-frei0r_005fsrc" href="#frei0r_005fsrc">14.8 frei0r_src</a></li> + <li><a id="toc-life" href="#life">14.9 life</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-149" href="#Examples-149">14.9.1 Examples</a></li> + </ul></li> + <li><a id="toc-allrgb_002c-allyuv_002c-color_002c-colorchart_002c-colorspectrum_002c-haldclutsrc_002c-nullsrc_002c-pal75bars_002c-pal100bars_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc" href="#allrgb_002c-allyuv_002c-color_002c-colorchart_002c-colorspectrum_002c-haldclutsrc_002c-nullsrc_002c-pal75bars_002c-pal100bars_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc">14.10 allrgb, allyuv, color, colorchart, colorspectrum, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-150" href="#Examples-150">14.10.1 Examples</a></li> + <li><a id="toc-Commands-154" href="#Commands-154">14.10.2 Commands</a></li> + </ul></li> + <li><a id="toc-openclsrc" href="#openclsrc">14.11 openclsrc</a></li> + <li><a id="toc-sierpinski" href="#sierpinski">14.12 sierpinski</a></li> + </ul></li> + <li><a id="toc-Video-Sinks" href="#Video-Sinks">15 Video Sinks</a> + <ul class="no-bullet"> + <li><a id="toc-buffersink" href="#buffersink">15.1 buffersink</a></li> + <li><a id="toc-nullsink" href="#nullsink">15.2 nullsink</a></li> + </ul></li> + <li><a id="toc-Multimedia-Filters" href="#Multimedia-Filters">16 Multimedia Filters</a> + <ul class="no-bullet"> + <li><a id="toc-a3dscope" href="#a3dscope">16.1 a3dscope</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-155" href="#Commands-155">16.1.1 Commands</a></li> + </ul></li> + <li><a id="toc-abitscope" href="#abitscope">16.2 abitscope</a></li> + <li><a id="toc-adrawgraph" href="#adrawgraph">16.3 adrawgraph</a></li> + <li><a id="toc-agraphmonitor" href="#agraphmonitor">16.4 agraphmonitor</a></li> + <li><a id="toc-ahistogram" href="#ahistogram">16.5 ahistogram</a></li> + <li><a id="toc-aphasemeter" href="#aphasemeter">16.6 aphasemeter</a> + <ul class="no-bullet"> + <li><a id="toc-phasing-detection" href="#phasing-detection">16.6.1 phasing detection</a></li> + <li><a id="toc-Examples-151" href="#Examples-151">16.6.2 Examples</a></li> + </ul></li> + <li><a id="toc-avectorscope" href="#avectorscope">16.7 avectorscope</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-152" href="#Examples-152">16.7.1 Examples</a></li> + <li><a id="toc-Commands-156" href="#Commands-156">16.7.2 Commands</a></li> + </ul></li> + <li><a id="toc-bench_002c-abench" href="#bench_002c-abench">16.8 bench, abench</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-153" href="#Examples-153">16.8.1 Examples</a></li> + </ul></li> + <li><a id="toc-concat" href="#concat">16.9 concat</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-154" href="#Examples-154">16.9.1 Examples</a></li> + <li><a id="toc-Commands-157" href="#Commands-157">16.9.2 Commands</a></li> + </ul></li> + <li><a id="toc-ebur128-1" href="#ebur128-1">16.10 ebur128</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-155" href="#Examples-155">16.10.1 Examples</a></li> + </ul></li> + <li><a id="toc-interleave_002c-ainterleave" href="#interleave_002c-ainterleave">16.11 interleave, ainterleave</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-156" href="#Examples-156">16.11.1 Examples</a></li> + </ul></li> + <li><a id="toc-latency_002c-alatency" href="#latency_002c-alatency">16.12 latency, alatency</a></li> + <li><a id="toc-metadata_002c-ametadata" href="#metadata_002c-ametadata">16.13 metadata, ametadata</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-157" href="#Examples-157">16.13.1 Examples</a></li> + </ul></li> + <li><a id="toc-perms_002c-aperms" href="#perms_002c-aperms">16.14 perms, aperms</a></li> + <li><a id="toc-realtime_002c-arealtime" href="#realtime_002c-arealtime">16.15 realtime, arealtime</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-158" href="#Commands-158">16.15.1 Commands</a></li> + </ul></li> + <li><a id="toc-segment_002c-asegment" href="#segment_002c-asegment">16.16 segment, asegment</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-158" href="#Examples-158">16.16.1 Examples</a></li> + </ul></li> + <li><a id="toc-select_002c-aselect" href="#select_002c-aselect">16.17 select, aselect</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-159" href="#Examples-159">16.17.1 Examples</a></li> + </ul></li> + <li><a id="toc-sendcmd_002c-asendcmd" href="#sendcmd_002c-asendcmd">16.18 sendcmd, asendcmd</a> + <ul class="no-bullet"> + <li><a id="toc-Commands-syntax" href="#Commands-syntax">16.18.1 Commands syntax</a></li> + <li><a id="toc-Examples-160" href="#Examples-160">16.18.2 Examples</a></li> + </ul></li> + <li><a id="toc-setpts_002c-asetpts" href="#setpts_002c-asetpts">16.19 setpts, asetpts</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-161" href="#Examples-161">16.19.1 Examples</a></li> + </ul></li> + <li><a id="toc-setrange" href="#setrange">16.20 setrange</a></li> + <li><a id="toc-settb_002c-asettb" href="#settb_002c-asettb">16.21 settb, asettb</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-162" href="#Examples-162">16.21.1 Examples</a></li> + </ul></li> + <li><a id="toc-showcqt" href="#showcqt">16.22 showcqt</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-163" href="#Examples-163">16.22.1 Examples</a></li> + </ul></li> + <li><a id="toc-showfreqs" href="#showfreqs">16.23 showfreqs</a></li> + <li><a id="toc-showspatial" href="#showspatial">16.24 showspatial</a></li> + <li><a id="toc-showspectrum-1" href="#showspectrum-1">16.25 showspectrum</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-164" href="#Examples-164">16.25.1 Examples</a></li> + </ul></li> + <li><a id="toc-showspectrumpic" href="#showspectrumpic">16.26 showspectrumpic</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-165" href="#Examples-165">16.26.1 Examples</a></li> + </ul></li> + <li><a id="toc-showvolume" href="#showvolume">16.27 showvolume</a></li> + <li><a id="toc-showwaves" href="#showwaves">16.28 showwaves</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-166" href="#Examples-166">16.28.1 Examples</a></li> + </ul></li> + <li><a id="toc-showwavespic" href="#showwavespic">16.29 showwavespic</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-167" href="#Examples-167">16.29.1 Examples</a></li> + </ul></li> + <li><a id="toc-sidedata_002c-asidedata" href="#sidedata_002c-asidedata">16.30 sidedata, asidedata</a></li> + <li><a id="toc-spectrumsynth" href="#spectrumsynth">16.31 spectrumsynth</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-168" href="#Examples-168">16.31.1 Examples</a></li> + </ul></li> + <li><a id="toc-split_002c-asplit" href="#split_002c-asplit">16.32 split, asplit</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-169" href="#Examples-169">16.32.1 Examples</a></li> + </ul></li> + <li><a id="toc-zmq_002c-azmq" href="#zmq_002c-azmq">16.33 zmq, azmq</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-170" href="#Examples-170">16.33.1 Examples</a></li> + </ul></li> + </ul></li> + <li><a id="toc-Multimedia-Sources" href="#Multimedia-Sources">17 Multimedia Sources</a> + <ul class="no-bullet"> + <li><a id="toc-amovie" href="#amovie">17.1 amovie</a></li> + <li><a id="toc-avsynctest" href="#avsynctest">17.2 avsynctest</a></li> + <li><a id="toc-movie-1" href="#movie-1">17.3 movie</a> + <ul class="no-bullet"> + <li><a id="toc-Examples-171" href="#Examples-171">17.3.1 Examples</a></li> + <li><a id="toc-Commands-159" href="#Commands-159">17.3.2 Commands</a></li> + </ul></li> + </ul></li> + <li><a id="toc-See-Also" href="#See-Also">18 See Also</a></li> + <li><a id="toc-Authors" href="#Authors">19 Authors</a></li> +</ul> +</div> +</div> + +<a name="Description"></a> +<h2 class="chapter">1 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>This document describes filters, sources, and sinks provided by the +libavfilter library. +</p> + +<a name="Filtering-Introduction"></a> +<h2 class="chapter">2 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 --> split ---------------------> overlay --> output + | ^ + |[tmp] [flip]| + +-----> crop --> 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 "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" 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">3 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 && \ +dot -Tpng graph.tmp -o graph.png && \ +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">4 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 "source", and a filter with no +output pads is called a "sink". +</p> +<span id="Filtergraph-syntax"></span><a name="Filtergraph-syntax-1"></a> +<h3 class="section">4.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 ","-separated filter descriptions. +</p> +<p>A filtergraph consists of a sequence of filterchains. A sequence of +filterchains is represented by a list of ";"-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>id</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 optionally followed by "@<var>id</var>". +The name of the filter class is optionally followed by a string +"=<var>arguments</var>". +</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 ’:’-separated list of <var>key=value</var> pairs. + +</li><li> A ’:’-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 – <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 ’:’-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 +‘<samp>|</samp>’. +</p> +<p>The list of arguments can be quoted using the character ‘<samp>'</samp>’ as initial +and ending mark, and the character ‘<samp>\</samp>’ for escaping the characters +within the quoted text; otherwise the argument string is considered +terminated when the next special character (belonging to the set +‘<samp>[]=;,</samp>’) 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 +"L1", the first input pad of overlay is labelled "L2", 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, "in" is assumed; if the output label of the last filter is not +specified, "out" 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>FILTER_NAME</var> ::= <var>NAME</var>["@"<var>NAME</var>] +<var>LINKLABEL</var> ::= "[" <var>NAME</var> "]" +<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>FILTER_NAME</var> ["=" <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> + +<span id="filtergraph-escaping"></span><a name="Notes-on-filtergraph-escaping"></a> +<h3 class="section">4.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 data-manual="ffmpeg-utils" href="ffmpeg-utils.html#quoting_005fand_005fescaping">(ffmpeg-utils)the "Quoting and escaping" +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 "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters" +</pre></div> + +<a name="Timeline-editing"></a> +<h2 class="chapter">5 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><span>‘<samp>t</samp>’</span></dt> +<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown +</p> +</dd> +<dt><span>‘<samp>n</samp>’</span></dt> +<dd><p>sequential number of the input frame, starting from 0 +</p> +</dd> +<dt><span>‘<samp>pos</samp>’</span></dt> +<dd><p>the position in the file of the input frame, NAN if unknown +</p> +</dd> +<dt><span>‘<samp>w</samp>’</span></dt> +<dt><span>‘<samp>h</samp>’</span></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> + +<p>See <code>ffmpeg -filters</code> to view which filters have timeline support. +</p> + +<span id="commands"></span><a name="Changing-options-at-runtime-with-a-command"></a> +<h2 class="chapter">6 Changing options at runtime with a command<span class="pull-right"><a class="anchor hidden-xs" href="#Changing-options-at-runtime-with-a-command" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Changing-options-at-runtime-with-a-command" aria-hidden="true">TOC</a></span></h2> + +<p>Some options can be changed during the operation of the filter using +a command. These options are marked ’T’ on the output of +<code>ffmpeg</code> <samp>-h filter=<name of filter></samp>. +The name of the command is the name of the option and the argument is +the new value. +</p> +<span id="framesync"></span><a name="Options-for-filters-with-several-inputs-_0028framesync_0029"></a> +<h2 class="chapter">7 Options for filters with several inputs (framesync)<span class="pull-right"><a class="anchor hidden-xs" href="#Options-for-filters-with-several-inputs-_0028framesync_0029" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-for-filters-with-several-inputs-_0028framesync_0029" aria-hidden="true">TOC</a></span></h2> + +<p>Some filters with several inputs support a common set of options. +These options can only be set by name, not with the short notation. +</p> +<dl compact="compact"> +<dt><span><samp>eof_action</samp></span></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><span><samp>repeat</samp></span></dt> +<dd><p>Repeat the last frame (the default). +</p></dd> +<dt><span><samp>endall</samp></span></dt> +<dd><p>End both streams. +</p></dd> +<dt><span><samp>pass</samp></span></dt> +<dd><p>Pass the main input through. +</p></dd> +</dl> + +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +</p> +</dd> +<dt><span><samp>repeatlast</samp></span></dt> +<dd><p>If set to 1, force the filter to extend the last frame of secondary streams +until the end of the primary stream. A value of 0 disables this behavior. +Default value is 1. +</p></dd> +</dl> + + +<a name="Audio-Filters"></a> +<h2 class="chapter">8 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">8.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’s done to get the highest attention +of a listener, "fatten" the sound and bring more "power" to the track. +If a signal is compressed too much it may sound dull or "dead" +afterwards or it may start to "pump" (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 "Attack" and "Release". +<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><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set mode of compressor operation. Can be <code>upward</code> or <code>downward</code>. +Default is <code>downward</code>. +</p> +</dd> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>If a signal of stream rises above this level it will affect the gain +reduction. +By default it is 0.125. Range is between 0.00097563 and 1. +</p> +</dd> +<dt><span><samp>ratio</samp></span></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><span><samp>attack</samp></span></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><span><samp>release</samp></span></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><span><samp>makeup</samp></span></dt> +<dd><p>Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +</p> +</dd> +<dt><span><samp>knee</samp></span></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><span><samp>link</samp></span></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><span><samp>detection</samp></span></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><span><samp>mix</samp></span></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="Commands"></a> +<h4 class="subsection">8.1.1 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 all above options as <a href="#commands">commands</a>. +</p> +<a name="acontrast"></a> +<h3 class="section">8.2 acontrast<span class="pull-right"><a class="anchor hidden-xs" href="#acontrast" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acontrast" aria-hidden="true">TOC</a></span></h3> +<p>Simple audio dynamic range compression/expansion filter. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>contrast</samp></span></dt> +<dd><p>Set contrast. Default is 33. Allowed range is between 0 and 100. +</p></dd> +</dl> + +<a name="acopy"></a> +<h3 class="section">8.3 acopy<span class="pull-right"><a class="anchor hidden-xs" href="#acopy" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acopy" aria-hidden="true">TOC</a></span></h3> + +<p>Copy the input audio source unchanged to the output. This is mainly useful for +testing purposes. +</p> +<a name="acrossfade"></a> +<h3 class="section">8.4 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><span><samp>nb_samples, ns</samp></span></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><span><samp>duration, d</samp></span></dt> +<dd><p>Specify the duration of the cross fade effect. See +<a data-manual="ffmpeg-utils" 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><span><samp>overlap, o</samp></span></dt> +<dd><p>Should first stream end overlap with second stream start. Default is enabled. +</p> +</dd> +<dt><span><samp>curve1</samp></span></dt> +<dd><p>Set curve for cross fade transition for first stream. +</p> +</dd> +<dt><span><samp>curve2</samp></span></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"></a> +<h4 class="subsection">8.4.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> 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="acrossover"></a> +<h3 class="section">8.5 acrossover<span class="pull-right"><a class="anchor hidden-xs" href="#acrossover" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acrossover" aria-hidden="true">TOC</a></span></h3> +<p>Split audio stream into several bands. +</p> +<p>This filter splits audio stream into two or more frequency ranges. +Summing all streams back will give flat output. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>split</samp></span></dt> +<dd><p>Set split frequencies. Those must be positive and increasing. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order for each band split. This controls filter roll-off or steepness +of filter transfer function. +Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>2nd</samp>’</span></dt> +<dd><p>12 dB per octave. +</p></dd> +<dt><span>‘<samp>4th</samp>’</span></dt> +<dd><p>24 dB per octave. +</p></dd> +<dt><span>‘<samp>6th</samp>’</span></dt> +<dd><p>36 dB per octave. +</p></dd> +<dt><span>‘<samp>8th</samp>’</span></dt> +<dd><p>48 dB per octave. +</p></dd> +<dt><span>‘<samp>10th</samp>’</span></dt> +<dd><p>60 dB per octave. +</p></dd> +<dt><span>‘<samp>12th</samp>’</span></dt> +<dd><p>72 dB per octave. +</p></dd> +<dt><span>‘<samp>14th</samp>’</span></dt> +<dd><p>84 dB per octave. +</p></dd> +<dt><span>‘<samp>16th</samp>’</span></dt> +<dd><p>96 dB per octave. +</p></dd> +<dt><span>‘<samp>18th</samp>’</span></dt> +<dd><p>108 dB per octave. +</p></dd> +<dt><span>‘<samp>20th</samp>’</span></dt> +<dd><p>120 dB per octave. +</p></dd> +</dl> + +<p>Default is <var>4th</var>. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1. +</p> +</dd> +<dt><span><samp>gains</samp></span></dt> +<dd><p>Set output gain for each band. Default value is 1 for all bands. +</p> +</dd> +<dt><span><samp>precision</samp></span></dt> +<dd><p>Set which precision to use when processing samples. +</p> +<dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Auto pick internal sample format depending on other filters. +</p> +</dd> +<dt><span><samp>float</samp></span></dt> +<dd><p>Always use single-floating point precision sample format. +</p> +</dd> +<dt><span><samp>double</samp></span></dt> +<dd><p>Always use double-floating point precision sample format. +</p></dd> +</dl> + +<p>Default value is <code>auto</code>. +</p></dd> +</dl> + +<a name="Examples-1"></a> +<h4 class="subsection">8.5.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> + +<ul> +<li> Split input audio stream into two bands (low and high) with split frequency of 1500 Hz, +each band will be in separate stream: +<div class="example"> +<pre class="example">ffmpeg -i in.flac -filter_complex 'acrossover=split=1500[LOW][HIGH]' -map '[LOW]' low.wav -map '[HIGH]' high.wav +</pre></div> + +</li><li> Same as above, but with higher filter order: +<div class="example"> +<pre class="example">ffmpeg -i in.flac -filter_complex 'acrossover=split=1500:order=8th[LOW][HIGH]' -map '[LOW]' low.wav -map '[HIGH]' high.wav +</pre></div> + +</li><li> Same as above, but also with additional middle band (frequencies between 1500 and 8000): +<div class="example"> +<pre class="example">ffmpeg -i in.flac -filter_complex 'acrossover=split=1500 8000:order=8th[LOW][MID][HIGH]' -map '[LOW]' low.wav -map '[MID]' mid.wav -map '[HIGH]' high.wav +</pre></div> +</li></ul> + +<a name="acrusher"></a> +<h3 class="section">8.6 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’t change the bit depth at all, it just produces the +effect. Material reduced in bit depth sounds more harsh and "digital". +This filter is able to even round to continuous 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 "softer" 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 "natural" sounding crusher which doesn’t gate low +signals for example. The human ear has a logarithmic perception, +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><span><samp>level_in</samp></span></dt> +<dd><p>Set level in. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set level out. +</p> +</dd> +<dt><span><samp>bits</samp></span></dt> +<dd><p>Set bit reduction. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>Set mixing amount. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Can be linear: <code>lin</code> or logarithmic: <code>log</code>. +</p> +</dd> +<dt><span><samp>dc</samp></span></dt> +<dd><p>Set DC. +</p> +</dd> +<dt><span><samp>aa</samp></span></dt> +<dd><p>Set anti-aliasing. +</p> +</dd> +<dt><span><samp>samples</samp></span></dt> +<dd><p>Set sample reduction. +</p> +</dd> +<dt><span><samp>lfo</samp></span></dt> +<dd><p>Enable LFO. By default disabled. +</p> +</dd> +<dt><span><samp>lforange</samp></span></dt> +<dd><p>Set LFO range. +</p> +</dd> +<dt><span><samp>lforate</samp></span></dt> +<dd><p>Set LFO rate. +</p></dd> +</dl> + +<a name="Commands-1"></a> +<h4 class="subsection">8.6.1 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 all above options as <a href="#commands">commands</a>. +</p> +<a name="acue"></a> +<h3 class="section">8.7 acue<span class="pull-right"><a class="anchor hidden-xs" href="#acue" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-acue" aria-hidden="true">TOC</a></span></h3> + +<p>Delay audio filtering until a given wallclock timestamp. See the <a href="#cue">cue</a> +filter. +</p> +<a name="adeclick"></a> +<h3 class="section">8.8 adeclick<span class="pull-right"><a class="anchor hidden-xs" href="#adeclick" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adeclick" aria-hidden="true">TOC</a></span></h3> +<p>Remove impulsive noise from input audio. +</p> +<p>Samples detected as impulsive noise are replaced by interpolated samples using +autoregressive modelling. +</p> +<dl compact="compact"> +<dt><span><samp>window, w</samp></span></dt> +<dd><p>Set window size, in milliseconds. Allowed range is from <code>10</code> to +<code>100</code>. Default value is <code>55</code> milliseconds. +This sets size of window which will be processed at once. +</p> +</dd> +<dt><span><samp>overlap, o</samp></span></dt> +<dd><p>Set window overlap, in percentage of window size. Allowed range is from +<code>50</code> to <code>95</code>. Default value is <code>75</code> percent. +Setting this to a very high value increases impulsive noise removal but makes +whole process much slower. +</p> +</dd> +<dt><span><samp>arorder, a</samp></span></dt> +<dd><p>Set autoregression order, in percentage of window size. Allowed range is from +<code>0</code> to <code>25</code>. Default value is <code>2</code> percent. This option also +controls quality of interpolated samples using neighbour good samples. +</p> +</dd> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set threshold value. Allowed range is from <code>1</code> to <code>100</code>. +Default value is <code>2</code>. +This controls the strength of impulsive noise which is going to be removed. +The lower value, the more samples will be detected as impulsive noise. +</p> +</dd> +<dt><span><samp>burst, b</samp></span></dt> +<dd><p>Set burst fusion, in percentage of window size. Allowed range is <code>0</code> to +<code>10</code>. Default value is <code>2</code>. +If any two samples detected as noise are spaced less than this value then any +sample between those two samples will be also detected as noise. +</p> +</dd> +<dt><span><samp>method, m</samp></span></dt> +<dd><p>Set overlap method. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>add, a</samp></span></dt> +<dd><p>Select overlap-add method. Even not interpolated samples are slightly +changed with this method. +</p> +</dd> +<dt><span><samp>save, s</samp></span></dt> +<dd><p>Select overlap-save method. Not interpolated samples remain unchanged. +</p></dd> +</dl> + +<p>Default value is <code>a</code>. +</p></dd> +</dl> + +<a name="adeclip"></a> +<h3 class="section">8.9 adeclip<span class="pull-right"><a class="anchor hidden-xs" href="#adeclip" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adeclip" aria-hidden="true">TOC</a></span></h3> +<p>Remove clipped samples from input audio. +</p> +<p>Samples detected as clipped are replaced by interpolated samples using +autoregressive modelling. +</p> +<dl compact="compact"> +<dt><span><samp>window, w</samp></span></dt> +<dd><p>Set window size, in milliseconds. Allowed range is from <code>10</code> to <code>100</code>. +Default value is <code>55</code> milliseconds. +This sets size of window which will be processed at once. +</p> +</dd> +<dt><span><samp>overlap, o</samp></span></dt> +<dd><p>Set window overlap, in percentage of window size. Allowed range is from <code>50</code> +to <code>95</code>. Default value is <code>75</code> percent. +</p> +</dd> +<dt><span><samp>arorder, a</samp></span></dt> +<dd><p>Set autoregression order, in percentage of window size. Allowed range is from +<code>0</code> to <code>25</code>. Default value is <code>8</code> percent. This option also controls +quality of interpolated samples using neighbour good samples. +</p> +</dd> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set threshold value. Allowed range is from <code>1</code> to <code>100</code>. +Default value is <code>10</code>. Higher values make clip detection less aggressive. +</p> +</dd> +<dt><span><samp>hsize, n</samp></span></dt> +<dd><p>Set size of histogram used to detect clips. Allowed range is from <code>100</code> to <code>9999</code>. +Default value is <code>1000</code>. Higher values make clip detection less aggressive. +</p> +</dd> +<dt><span><samp>method, m</samp></span></dt> +<dd><p>Set overlap method. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>add, a</samp></span></dt> +<dd><p>Select overlap-add method. Even not interpolated samples are slightly changed +with this method. +</p> +</dd> +<dt><span><samp>save, s</samp></span></dt> +<dd><p>Select overlap-save method. Not interpolated samples remain unchanged. +</p></dd> +</dl> + +<p>Default value is <code>a</code>. +</p></dd> +</dl> + +<a name="adecorrelate"></a> +<h3 class="section">8.10 adecorrelate<span class="pull-right"><a class="anchor hidden-xs" href="#adecorrelate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adecorrelate" aria-hidden="true">TOC</a></span></h3> +<p>Apply decorrelation to input audio stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>stages</samp></span></dt> +<dd><p>Set decorrelation stages of filtering. Allowed +range is from 1 to 16. Default value is 6. +</p> +</dd> +<dt><span><samp>seed</samp></span></dt> +<dd><p>Set random seed used for setting delay in samples across channels. +</p></dd> +</dl> + +<a name="adelay"></a> +<h3 class="section">8.11 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><span><samp>delays</samp></span></dt> +<dd><p>Set list of delays in milliseconds for each channel separated by ’|’. +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 ’S’ to number. +If you want instead to delay in seconds, append ’s’ to number. +</p> +</dd> +<dt><span><samp>all</samp></span></dt> +<dd><p>Use last set delay for all remaining channels. By default is disabled. +This option if enabled changes how option <code>delays</code> is interpreted. +</p></dd> +</dl> + +<a name="Examples-2"></a> +<h4 class="subsection">8.11.1 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> 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><li> Delay all channels by same number of samples: +<div class="example"> +<pre class="example">adelay=delays=64S:all=1 +</pre></div> +</li></ul> + +<a name="adenorm"></a> +<h3 class="section">8.12 adenorm<span class="pull-right"><a class="anchor hidden-xs" href="#adenorm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adenorm" aria-hidden="true">TOC</a></span></h3> +<p>Remedy denormals in audio by adding extremely low-level noise. +</p> +<p>This filter shall be placed before any filter that can produce denormals. +</p> +<p>A description of the accepted parameters follows. +</p> +<dl compact="compact"> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set level of added noise in dB. Default is <code>-351</code>. +Allowed range is from -451 to -90. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set type of added noise. +</p> +<dl compact="compact"> +<dt><span><samp>dc</samp></span></dt> +<dd><p>Add DC signal. +</p></dd> +<dt><span><samp>ac</samp></span></dt> +<dd><p>Add AC signal. +</p></dd> +<dt><span><samp>square</samp></span></dt> +<dd><p>Add square signal. +</p></dd> +<dt><span><samp>pulse</samp></span></dt> +<dd><p>Add pulse signal. +</p></dd> +</dl> + +<p>Default is <code>dc</code>. +</p></dd> +</dl> + +<a name="Commands-2"></a> +<h4 class="subsection">8.12.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 all above options as <a href="#commands">commands</a>. +</p> +<a name="aderivative_002c-aintegral"></a> +<h3 class="section">8.13 aderivative, aintegral<span class="pull-right"><a class="anchor hidden-xs" href="#aderivative_002c-aintegral" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aderivative_002c-aintegral" aria-hidden="true">TOC</a></span></h3> + +<p>Compute derivative/integral of audio stream. +</p> +<p>Applying both filters one after another produces original audio. +</p> +<a name="adynamicequalizer"></a> +<h3 class="section">8.14 adynamicequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#adynamicequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adynamicequalizer" aria-hidden="true">TOC</a></span></h3> + +<p>Apply dynamic equalization to input audio stream. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set the detection threshold used to trigger equalization. +Threshold detection is using bandpass filter. +Default value is 0. Allowed range is from 0 to 100. +</p> +</dd> +<dt><span><samp>dfrequency</samp></span></dt> +<dd><p>Set the detection frequency in Hz used for bandpass filter used to trigger equalization. +Default value is 1000 Hz. Allowed range is between 2 and 1000000 Hz. +</p> +</dd> +<dt><span><samp>dqfactor</samp></span></dt> +<dd><p>Set the detection resonance factor for bandpass filter used to trigger equalization. +Default value is 1. Allowed range is from 0.001 to 1000. +</p> +</dd> +<dt><span><samp>tfrequency</samp></span></dt> +<dd><p>Set the target frequency of equalization filter. +Default value is 1000 Hz. Allowed range is between 2 and 1000000 Hz. +</p> +</dd> +<dt><span><samp>tqfactor</samp></span></dt> +<dd><p>Set the target resonance factor for target equalization filter. +Default value is 1. Allowed range is from 0.001 to 1000. +</p> +</dd> +<dt><span><samp>attack</samp></span></dt> +<dd><p>Set the amount of milliseconds the signal from detection has to rise above +the detection threshold before equalization starts. +Default is 20. Allowed range is between 1 and 2000. +</p> +</dd> +<dt><span><samp>release</samp></span></dt> +<dd><p>Set the amount of milliseconds the signal from detection has to fall below the +detection threshold before equalization ends. +Default is 200. Allowed range is between 1 and 2000. +</p> +</dd> +<dt><span><samp>ratio</samp></span></dt> +<dd><p>Set the ratio by which the equalization gain is raised. +Default is 1. Allowed range is between 0 and 30. +</p> +</dd> +<dt><span><samp>makeup</samp></span></dt> +<dd><p>Set the makeup offset by which the equalization gain is raised. +Default is 0. Allowed range is between 0 and 100. +</p> +</dd> +<dt><span><samp>range</samp></span></dt> +<dd><p>Set the max allowed cut/boost amount. Default is 50. +Allowed range is from 1 to 200. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set the mode of filter operation, can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>listen</samp>’</span></dt> +<dd><p>Output only isolated bandpass signal. +</p></dd> +<dt><span>‘<samp>cut</samp>’</span></dt> +<dd><p>Cut frequencies above detection threshold. +</p></dd> +<dt><span>‘<samp>boost</samp>’</span></dt> +<dd><p>Boost frequencies bellow detection threshold. +</p></dd> +</dl> +<p>Default mode is ‘<samp>cut</samp>’. +</p> +</dd> +<dt><span><samp>tftype</samp></span></dt> +<dd><p>Set the type of target filter, can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>bell</samp>’</span></dt> +<dt><span>‘<samp>lowshelf</samp>’</span></dt> +<dt><span>‘<samp>highshelf</samp>’</span></dt> +</dl> +<p>Default type is ‘<samp>bell</samp>’. +</p> +</dd> +<dt><span><samp>direction</samp></span></dt> +<dd><p>Set processing direction relative to threshold. +</p><dl compact="compact"> +<dt><span>‘<samp>downward</samp>’</span></dt> +<dd><p>Boost or cut if threshhold is higher than detected volume. +</p></dd> +<dt><span>‘<samp>upward</samp>’</span></dt> +<dd><p>Boost or cut if threshhold is lower than detected volume. +</p></dd> +</dl> +<p>Default direction is ‘<samp>downward</samp>’. +</p></dd> +</dl> + +<a name="Commands-3"></a> +<h4 class="subsection">8.14.1 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 all above options as <a href="#commands">commands</a>. +</p> +<a name="adynamicsmooth"></a> +<h3 class="section">8.15 adynamicsmooth<span class="pull-right"><a class="anchor hidden-xs" href="#adynamicsmooth" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adynamicsmooth" aria-hidden="true">TOC</a></span></h3> + +<p>Apply dynamic smoothing to input audio stream. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>sensitivity</samp></span></dt> +<dd><p>Set an amount of sensitivity to frequency fluctations. Default is 2. +Allowed range is from 0 to 1e+06. +</p> +</dd> +<dt><span><samp>basefreq</samp></span></dt> +<dd><p>Set a base frequency for smoothing. Default value is 22050. +Allowed range is from 2 to 1e+06. +</p></dd> +</dl> + +<a name="Commands-4"></a> +<h4 class="subsection">8.15.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>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="aecho"></a> +<h3 class="section">8.16 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><span><samp>in_gain</samp></span></dt> +<dd><p>Set input gain of reflected signal. Default is <code>0.6</code>. +</p> +</dd> +<dt><span><samp>out_gain</samp></span></dt> +<dd><p>Set output gain of reflected signal. Default is <code>0.3</code>. +</p> +</dd> +<dt><span><samp>delays</samp></span></dt> +<dd><p>Set list of time intervals in milliseconds between original signal and reflections +separated by ’|’. Allowed range for each <code>delay</code> is <code>(0 - 90000.0]</code>. +Default is <code>1000</code>. +</p> +</dd> +<dt><span><samp>decays</samp></span></dt> +<dd><p>Set list of loudness of reflected signals separated by ’|’. +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-3"></a> +<h4 class="subsection">8.16.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> 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 sounds 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">8.17 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output gain. +</p> +</dd> +<dt><span><samp>mode</samp></span></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><span><samp>type</samp></span></dt> +<dd><p>Set filter type. Selects medium. Can be one of the following: +</p> +<dl compact="compact"> +<dt><span><samp>col</samp></span></dt> +<dd><p>select Columbia. +</p></dd> +<dt><span><samp>emi</samp></span></dt> +<dd><p>select EMI. +</p></dd> +<dt><span><samp>bsi</samp></span></dt> +<dd><p>select BSI (78RPM). +</p></dd> +<dt><span><samp>riaa</samp></span></dt> +<dd><p>select RIAA. +</p></dd> +<dt><span><samp>cd</samp></span></dt> +<dd><p>select Compact Disc (CD). +</p></dd> +<dt><span><samp>50fm</samp></span></dt> +<dd><p>select 50µs (FM). +</p></dd> +<dt><span><samp>75fm</samp></span></dt> +<dd><p>select 75µs (FM). +</p></dd> +<dt><span><samp>50kf</samp></span></dt> +<dd><p>select 50µs (FM-KF). +</p></dd> +<dt><span><samp>75kf</samp></span></dt> +<dd><p>select 75µs (FM-KF). +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-5"></a> +<h4 class="subsection">8.17.1 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 all above options as <a href="#commands">commands</a>. +</p> +<a name="aeval"></a> +<h3 class="section">8.18 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><span><samp>exprs</samp></span></dt> +<dd><p>Set the ’|’-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><span><samp>channel_layout, c</samp></span></dt> +<dd><p>Set output channel layout. If not specified, the channel layout is +specified by the number of expressions. If set to ‘<samp>same</samp>’, 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><span><samp>ch</samp></span></dt> +<dd><p>channel number of the current expression +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>number of the evaluated sample, starting from 0 +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>sample rate +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>time of the evaluated sample expressed in seconds +</p> +</dd> +<dt><span><samp>nb_in_channels</samp></span></dt> +<dt><span><samp>nb_out_channels</samp></span></dt> +<dd><p>input and output number of channels +</p> +</dd> +<dt><span><samp>val(CH)</samp></span></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-4"></a> +<h4 class="subsection">8.18.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> + +<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="aexciter"></a> +<h3 class="section">8.19 aexciter<span class="pull-right"><a class="anchor hidden-xs" href="#aexciter" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aexciter" aria-hidden="true">TOC</a></span></h3> + +<p>An exciter is used to produce high sound that is not present in the +original signal. This is done by creating harmonic distortions of the +signal which are restricted in range and added to the original signal. +An Exciter raises the upper end of an audio signal without simply raising +the higher frequencies like an equalizer would do to create a more +"crisp" or "brilliant" sound. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>level_in</samp></span></dt> +<dd><p>Set input level prior processing of signal. +Allowed range is from 0 to 64. +Default value is 1. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output level after processing of signal. +Allowed range is from 0 to 64. +Default value is 1. +</p> +</dd> +<dt><span><samp>amount</samp></span></dt> +<dd><p>Set the amount of harmonics added to original signal. +Allowed range is from 0 to 64. +Default value is 1. +</p> +</dd> +<dt><span><samp>drive</samp></span></dt> +<dd><p>Set the amount of newly created harmonics. +Allowed range is from 0.1 to 10. +Default value is 8.5. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Set the octave of newly created harmonics. +Allowed range is from -10 to 10. +Default value is 0. +</p> +</dd> +<dt><span><samp>freq</samp></span></dt> +<dd><p>Set the lower frequency limit of producing harmonics in Hz. +Allowed range is from 2000 to 12000 Hz. +Default is 7500 Hz. +</p> +</dd> +<dt><span><samp>ceil</samp></span></dt> +<dd><p>Set the upper frequency limit of producing harmonics. +Allowed range is from 9999 to 20000 Hz. +If value is lower than 10000 Hz no limit is applied. +</p> +</dd> +<dt><span><samp>listen</samp></span></dt> +<dd><p>Mute the original signal and output only added harmonics. +By default is disabled. +</p></dd> +</dl> + +<a name="Commands-6"></a> +<h4 class="subsection">8.19.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 all above options as <a href="#commands">commands</a>. +</p> +<span id="afade"></span><a name="afade-1"></a> +<h3 class="section">8.20 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><span><samp>type, t</samp></span></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><span><samp>start_sample, ss</samp></span></dt> +<dd><p>Specify the number of the start sample for starting to apply the fade +effect. Default is 0. +</p> +</dd> +<dt><span><samp>nb_samples, ns</samp></span></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><span><samp>start_time, st</samp></span></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 data-manual="ffmpeg-utils" 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><span><samp>duration, d</samp></span></dt> +<dd><p>Specify the duration of the fade effect. See +<a data-manual="ffmpeg-utils" 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><span><samp>curve</samp></span></dt> +<dd><p>Set curve for fade transition. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>tri</samp></span></dt> +<dd><p>select triangular, linear slope (default) +</p></dd> +<dt><span><samp>qsin</samp></span></dt> +<dd><p>select quarter of sine wave +</p></dd> +<dt><span><samp>hsin</samp></span></dt> +<dd><p>select half of sine wave +</p></dd> +<dt><span><samp>esin</samp></span></dt> +<dd><p>select exponential sine wave +</p></dd> +<dt><span><samp>log</samp></span></dt> +<dd><p>select logarithmic +</p></dd> +<dt><span><samp>ipar</samp></span></dt> +<dd><p>select inverted parabola +</p></dd> +<dt><span><samp>qua</samp></span></dt> +<dd><p>select quadratic +</p></dd> +<dt><span><samp>cub</samp></span></dt> +<dd><p>select cubic +</p></dd> +<dt><span><samp>squ</samp></span></dt> +<dd><p>select square root +</p></dd> +<dt><span><samp>cbr</samp></span></dt> +<dd><p>select cubic root +</p></dd> +<dt><span><samp>par</samp></span></dt> +<dd><p>select parabola +</p></dd> +<dt><span><samp>exp</samp></span></dt> +<dd><p>select exponential +</p></dd> +<dt><span><samp>iqsin</samp></span></dt> +<dd><p>select inverted quarter of sine wave +</p></dd> +<dt><span><samp>ihsin</samp></span></dt> +<dd><p>select inverted half of sine wave +</p></dd> +<dt><span><samp>dese</samp></span></dt> +<dd><p>select double-exponential seat +</p></dd> +<dt><span><samp>desi</samp></span></dt> +<dd><p>select double-exponential sigmoid +</p></dd> +<dt><span><samp>losi</samp></span></dt> +<dd><p>select logistic sigmoid +</p></dd> +<dt><span><samp>sinc</samp></span></dt> +<dd><p>select sine cardinal function +</p></dd> +<dt><span><samp>isinc</samp></span></dt> +<dd><p>select inverted sine cardinal function +</p></dd> +<dt><span><samp>nofade</samp></span></dt> +<dd><p>no fade applied +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-7"></a> +<h4 class="subsection">8.20.1 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>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-5"></a> +<h4 class="subsection">8.20.2 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> 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="afftdn"></a> +<h3 class="section">8.21 afftdn<span class="pull-right"><a class="anchor hidden-xs" href="#afftdn" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afftdn" aria-hidden="true">TOC</a></span></h3> +<p>Denoise audio samples with FFT. +</p> +<p>A description of the accepted parameters follows. +</p> +<dl compact="compact"> +<dt><span><samp>noise_reduction, nr</samp></span></dt> +<dd><p>Set the noise reduction in dB, allowed range is 0.01 to 97. +Default value is 12 dB. +</p> +</dd> +<dt><span><samp>noise_floor, nf</samp></span></dt> +<dd><p>Set the noise floor in dB, allowed range is -80 to -20. +Default value is -50 dB. +</p> +</dd> +<dt><span><samp>noise_type, nt</samp></span></dt> +<dd><p>Set the noise type. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>white, w</samp></span></dt> +<dd><p>Select white noise. +</p> +</dd> +<dt><span><samp>vinyl, v</samp></span></dt> +<dd><p>Select vinyl noise. +</p> +</dd> +<dt><span><samp>shellac, s</samp></span></dt> +<dd><p>Select shellac noise. +</p> +</dd> +<dt><span><samp>custom, c</samp></span></dt> +<dd><p>Select custom noise, defined in <code>bn</code> option. +</p> +<p>Default value is white noise. +</p></dd> +</dl> + +</dd> +<dt><span><samp>band_noise, bn</samp></span></dt> +<dd><p>Set custom band noise profile for every one of 15 bands. +Bands are separated by ’ ’ or ’|’. +</p> +</dd> +<dt><span><samp>residual_floor, rf</samp></span></dt> +<dd><p>Set the residual floor in dB, allowed range is -80 to -20. +Default value is -38 dB. +</p> +</dd> +<dt><span><samp>track_noise, tn</samp></span></dt> +<dd><p>Enable noise floor tracking. By default is disabled. +With this enabled, noise floor is automatically adjusted. +</p> +</dd> +<dt><span><samp>track_residual, tr</samp></span></dt> +<dd><p>Enable residual tracking. By default is disabled. +</p> +</dd> +<dt><span><samp>output_mode, om</samp></span></dt> +<dd><p>Set the output mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>input, i</samp></span></dt> +<dd><p>Pass input unchanged. +</p> +</dd> +<dt><span><samp>output, o</samp></span></dt> +<dd><p>Pass noise filtered out. +</p> +</dd> +<dt><span><samp>noise, n</samp></span></dt> +<dd><p>Pass only noise. +</p> +<p>Default value is <var>output</var>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>adaptivity, ad</samp></span></dt> +<dd><p>Set the adaptivity factor, used how fast to adapt gains adjustments per +each frequency bin. Value <var>0</var> enables instant adaptation, while higher values +react much slower. +Allowed range is from <var>0</var> to <var>1</var>. Default value is <var>0.5</var>. +</p> +</dd> +<dt><span><samp>floor_offset, fo</samp></span></dt> +<dd><p>Set the noise floor offset factor. This option is used to adjust offset applied to measured +noise floor. It is only effective when noise floor tracking is enabled. +Allowed range is from <var>-2.0</var> to <var>2.0</var>. Default value is <var>1.0</var>. +</p> +</dd> +<dt><span><samp>noise_link, nl</samp></span></dt> +<dd><p>Set the noise link used for multichannel audio. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>none</samp></span></dt> +<dd><p>Use unchanged channel’s noise floor. +</p> +</dd> +<dt><span><samp>min</samp></span></dt> +<dd><p>Use measured min noise floor of all channels. +</p> +</dd> +<dt><span><samp>max</samp></span></dt> +<dd><p>Use measured max noise floor of all channels. +</p> +</dd> +<dt><span><samp>average</samp></span></dt> +<dd><p>Use measured average noise floor of all channels. +</p> +<p>Default value is <var>min</var>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>band_multiplier, bm</samp></span></dt> +<dd><p>Set the band multiplier factor, used how much to spread bands across frequency bins. +Allowed range is from <var>0.2</var> to <var>5</var>. Default value is <var>1.25</var>. +</p> +</dd> +<dt><span><samp>sample_noise, sn</samp></span></dt> +<dd><p>Toggle capturing and measurement of noise profile from input audio. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>start, begin</samp></span></dt> +<dd><p>Start sample noise capture. +</p> +</dd> +<dt><span><samp>stop, end</samp></span></dt> +<dd><p>Stop sample noise capture and measure new noise band profile. +</p> +<p>Default value is <code>none</code>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>gain_smooth, gs</samp></span></dt> +<dd><p>Set gain smooth spatial radius, used to smooth gains applied to each frequency bin. +Useful to reduce random music noise artefacts. +Higher values increases smoothing of gains. +Allowed range is from <code>0</code> to <code>50</code>. +Default value is <code>0</code>. +</p></dd> +</dl> + +<a name="Commands-8"></a> +<h4 class="subsection">8.21.1 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 some above mentioned options as <a href="#commands">commands</a>. +</p> +<a name="Examples-6"></a> +<h4 class="subsection">8.21.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> Reduce white noise by 10dB, and use previously measured noise floor of -40dB: +<div class="example"> +<pre class="example">afftdn=nr=10:nf=-40 +</pre></div> + +</li><li> Reduce white noise by 10dB, also set initial noise floor to -80dB and enable automatic +tracking of noise floor so noise floor will gradually change during processing: +<div class="example"> +<pre class="example">afftdn=nr=10:nf=-80:tn=1 +</pre></div> + +</li><li> Reduce noise by 20dB, using noise floor of -40dB and using commands to take noise profile +of first 0.4 seconds of input audio: +<div class="example"> +<pre class="example">asendcmd=0.0 afftdn sn start,asendcmd=0.4 afftdn sn stop,afftdn=nr=20:nf=-40 +</pre></div> +</li></ul> + +<a name="afftfilt"></a> +<h3 class="section">8.22 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><span><samp>real</samp></span></dt> +<dd><p>Set frequency domain real expression for each separate channel separated +by ’|’. Default is "re". +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><span><samp>imag</samp></span></dt> +<dd><p>Set frequency domain imaginary expression for each separate channel +separated by ’|’. Default is "im". +</p> +<p>Each expression in <var>real</var> and <var>imag</var> can contain the following +constants and functions: +</p> +<dl compact="compact"> +<dt><span><samp>sr</samp></span></dt> +<dd><p>sample rate +</p> +</dd> +<dt><span><samp>b</samp></span></dt> +<dd><p>current frequency bin number +</p> +</dd> +<dt><span><samp>nb</samp></span></dt> +<dd><p>number of available bins +</p> +</dd> +<dt><span><samp>ch</samp></span></dt> +<dd><p>channel number of the current expression +</p> +</dd> +<dt><span><samp>chs</samp></span></dt> +<dd><p>number of channels +</p> +</dd> +<dt><span><samp>pts</samp></span></dt> +<dd><p>current frame pts +</p> +</dd> +<dt><span><samp>re</samp></span></dt> +<dd><p>current real part of frequency bin of current channel +</p> +</dd> +<dt><span><samp>im</samp></span></dt> +<dd><p>current imaginary part of frequency bin of current channel +</p> +</dd> +<dt><span><samp>real(b, ch)</samp></span></dt> +<dd><p>Return the value of real part of frequency bin at location (<var>bin</var>,<var>channel</var>) +</p> +</dd> +<dt><span><samp>imag(b, ch)</samp></span></dt> +<dd><p>Return the value of imaginary part of frequency bin at location (<var>bin</var>,<var>channel</var>) +</p></dd> +</dl> + +</dd> +<dt><span><samp>win_size</samp></span></dt> +<dd><p>Set window size. Allowed range is from 16 to 131072. +Default is <code>4096</code> +</p> +</dd> +<dt><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann, hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> +<p>Default is <code>hann</code>. +</p> +</dd> +<dt><span><samp>overlap</samp></span></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-7"></a> +<h4 class="subsection">8.22.1 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> Leave almost only low frequencies in audio: +<div class="example"> +<pre class="example">afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'" +</pre></div> + +</li><li> Apply robotize effect: +<div class="example"> +<pre class="example">afftfilt="real='hypot(re,im)*sin(0)':imag='hypot(re,im)*cos(0)':win_size=512:overlap=0.75" +</pre></div> + +</li><li> Apply whisper effect: +<div class="example"> +<pre class="example">afftfilt="real='hypot(re,im)*cos((random(0)*2-1)*2*3.14)':imag='hypot(re,im)*sin((random(1)*2-1)*2*3.14)':win_size=128:overlap=0.8" +</pre></div> + +</li><li> Apply phase shift: +<div class="example"> +<pre class="example">afftfilt="real=re*cos(1)-im*sin(1):imag=re*sin(1)+im*cos(1)" +</pre></div> +</li></ul> + +<span id="afir"></span><a name="afir-1"></a> +<h3 class="section">8.23 afir<span class="pull-right"><a class="anchor hidden-xs" href="#afir-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afir-1" aria-hidden="true">TOC</a></span></h3> + +<p>Apply an arbitrary Finite Impulse Response filter. +</p> +<p>This filter is designed for applying long FIR filters, +up to 60 seconds long. +</p> +<p>It can be used as component for digital crossover filters, +room equalization, cross talk cancellation, wavefield synthesis, +auralization, ambiophonics, ambisonics and spatialization. +</p> +<p>This filter uses the streams higher than first one as FIR coefficients. +If the non-first stream holds a single channel, it will be used +for all input channels in the first stream, otherwise +the number of channels in the non-first stream must be same as +the number of channels in the first stream. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>dry</samp></span></dt> +<dd><p>Set dry gain. This sets input gain. +</p> +</dd> +<dt><span><samp>wet</samp></span></dt> +<dd><p>Set wet gain. This sets final output gain. +</p> +</dd> +<dt><span><samp>length</samp></span></dt> +<dd><p>Set Impulse Response filter length. Default is 1, which means whole IR is processed. +</p> +</dd> +<dt><span><samp>gtype</samp></span></dt> +<dd><p>Enable applying gain measured from power of IR. +</p> +<p>Set which approach to use for auto gain measurement. +</p> +<dl compact="compact"> +<dt><span><samp>none</samp></span></dt> +<dd><p>Do not apply any gain. +</p> +</dd> +<dt><span><samp>peak</samp></span></dt> +<dd><p>select peak gain, very conservative approach. This is default value. +</p> +</dd> +<dt><span><samp>dc</samp></span></dt> +<dd><p>select DC gain, limited application. +</p> +</dd> +<dt><span><samp>gn</samp></span></dt> +<dd><p>select gain to noise approach, this is most popular one. +</p></dd> +</dl> + +</dd> +<dt><span><samp>irgain</samp></span></dt> +<dd><p>Set gain to be applied to IR coefficients before filtering. +Allowed range is 0 to 1. This gain is applied after any gain applied with <var>gtype</var> option. +</p> +</dd> +<dt><span><samp>irfmt</samp></span></dt> +<dd><p>Set format of IR stream. Can be <code>mono</code> or <code>input</code>. +Default is <code>input</code>. +</p> +</dd> +<dt><span><samp>maxir</samp></span></dt> +<dd><p>Set max allowed Impulse Response filter duration in seconds. Default is 30 seconds. +Allowed range is 0.1 to 60 seconds. +</p> +</dd> +<dt><span><samp>response</samp></span></dt> +<dd><p>Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +</p> +</dd> +<dt><span><samp>channel</samp></span></dt> +<dd><p>Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when <var>response</var> is enabled. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set video stream size. This option is used only when <var>response</var> is enabled. +</p> +</dd> +<dt><span><samp>rate</samp></span></dt> +<dd><p>Set video stream frame rate. This option is used only when <var>response</var> is enabled. +</p> +</dd> +<dt><span><samp>minp</samp></span></dt> +<dd><p>Set minimal partition size used for convolution. Default is <var>8192</var>. +Allowed range is from <var>1</var> to <var>32768</var>. +Lower values decreases latency at cost of higher CPU usage. +</p> +</dd> +<dt><span><samp>maxp</samp></span></dt> +<dd><p>Set maximal partition size used for convolution. Default is <var>8192</var>. +Allowed range is from <var>8</var> to <var>32768</var>. +Lower values may increase CPU usage. +</p> +</dd> +<dt><span><samp>nbirs</samp></span></dt> +<dd><p>Set number of input impulse responses streams which will be switchable at runtime. +Allowed range is from <var>1</var> to <var>32</var>. Default is <var>1</var>. +</p> +</dd> +<dt><span><samp>ir</samp></span></dt> +<dd><p>Set IR stream which will be used for convolution, starting from <var>0</var>, should always be +lower than supplied value by <code>nbirs</code> option. Default is <var>0</var>. +This option can be changed at runtime via <a href="#commands">commands</a>. +</p> +</dd> +<dt><span><samp>precision</samp></span></dt> +<dd><p>Set which precision to use when processing samples. +</p> +<dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Auto pick internal sample format depending on other filters. +</p> +</dd> +<dt><span><samp>float</samp></span></dt> +<dd><p>Always use single-floating point precision sample format. +</p> +</dd> +<dt><span><samp>double</samp></span></dt> +<dd><p>Always use double-floating point precision sample format. +</p></dd> +</dl> + +<p>Default value is auto. +</p></dd> +</dl> + +<a name="Examples-8"></a> +<h4 class="subsection">8.23.1 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> Apply reverb to stream using mono IR file as second input, complete command using ffmpeg: +<div class="example"> +<pre class="example">ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav +</pre></div> +</li></ul> + +<span id="aformat"></span><a name="aformat-1"></a> +<h3 class="section">8.24 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><span><samp>sample_fmts, f</samp></span></dt> +<dd><p>A ’|’-separated list of requested sample formats. +</p> +</dd> +<dt><span><samp>sample_rates, r</samp></span></dt> +<dd><p>A ’|’-separated list of requested sample rates. +</p> +</dd> +<dt><span><samp>channel_layouts, cl</samp></span></dt> +<dd><p>A ’|’-separated list of requested channel layouts. +</p> +<p>See <a data-manual="ffmpeg-utils" 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="afreqshift"></a> +<h3 class="section">8.25 afreqshift<span class="pull-right"><a class="anchor hidden-xs" href="#afreqshift" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afreqshift" aria-hidden="true">TOC</a></span></h3> +<p>Apply frequency shift to input audio samples. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>shift</samp></span></dt> +<dd><p>Specify frequency shift. Allowed range is -INT_MAX to INT_MAX. +Default value is 0.0. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set output gain applied to final output. Allowed range is from 0.0 to 1.0. +Default value is 1.0. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order used for filtering. Allowed range is from 1 to 16. +Default value is 8. +</p></dd> +</dl> + +<a name="Commands-9"></a> +<h4 class="subsection">8.25.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>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="afwtdn"></a> +<h3 class="section">8.26 afwtdn<span class="pull-right"><a class="anchor hidden-xs" href="#afwtdn" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afwtdn" aria-hidden="true">TOC</a></span></h3> +<p>Reduce broadband noise from input samples using Wavelets. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>sigma</samp></span></dt> +<dd><p>Set the noise sigma, allowed range is from 0 to 1. +Default value is 0. +This option controls strength of denoising applied to input samples. +Most useful way to set this option is via decibels, eg. -45dB. +</p> +</dd> +<dt><span><samp>levels</samp></span></dt> +<dd><p>Set the number of wavelet levels of decomposition. +Allowed range is from 1 to 12. +Default value is 10. +Setting this too low make denoising performance very poor. +</p> +</dd> +<dt><span><samp>wavet</samp></span></dt> +<dd><p>Set wavelet type for decomposition of input frame. +They are sorted by number of coefficients, from lowest to highest. +More coefficients means worse filtering speed, but overall better quality. +Available wavelets are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>sym2</samp>’</span></dt> +<dt><span>‘<samp>sym4</samp>’</span></dt> +<dt><span>‘<samp>rbior68</samp>’</span></dt> +<dt><span>‘<samp>deb10</samp>’</span></dt> +<dt><span>‘<samp>sym10</samp>’</span></dt> +<dt><span>‘<samp>coif5</samp>’</span></dt> +<dt><span>‘<samp>bl3</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>percent</samp></span></dt> +<dd><p>Set percent of full denoising. Allowed range is from 0 to 100 percent. +Default value is 85 percent or partial denoising. +</p> +</dd> +<dt><span><samp>profile</samp></span></dt> +<dd><p>If enabled, first input frame will be used as noise profile. +If first frame samples contain non-noise performance will be very poor. +</p> +</dd> +<dt><span><samp>adaptive</samp></span></dt> +<dd><p>If enabled, input frames are analyzed for presence of noise. +If noise is detected with high possibility then input frame profile will be +used for processing following frames, until new noise frame is detected. +</p> +</dd> +<dt><span><samp>samples</samp></span></dt> +<dd><p>Set size of single frame in number of samples. Allowed range is from 512 to +65536. Default frame size is 8192 samples. +</p> +</dd> +<dt><span><samp>softness</samp></span></dt> +<dd><p>Set softness applied inside thresholding function. Allowed range is from 0 to +10. Default softness is 1. +</p></dd> +</dl> + +<a name="Commands-10"></a> +<h4 class="subsection">8.26.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>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="agate"></a> +<h3 class="section">8.27 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set the mode of operation. Can be <code>upward</code> or <code>downward</code>. +Default is <code>downward</code>. If set to <code>upward</code> mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of <code>downward</code> lower parts of signal will be reduced. +</p> +</dd> +<dt><span><samp>range</samp></span></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. +Setting this to 0 disables reduction and then filter behaves like expander. +</p> +</dd> +<dt><span><samp>threshold</samp></span></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><span><samp>ratio</samp></span></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><span><samp>attack</samp></span></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><span><samp>release</samp></span></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><span><samp>makeup</samp></span></dt> +<dd><p>Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +</p> +</dd> +<dt><span><samp>knee</samp></span></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><span><samp>detection</samp></span></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><span><samp>link</samp></span></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="Commands-11"></a> +<h4 class="subsection">8.27.1 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>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="aiir"></a> +<h3 class="section">8.28 aiir<span class="pull-right"><a class="anchor hidden-xs" href="#aiir" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aiir" aria-hidden="true">TOC</a></span></h3> + +<p>Apply an arbitrary Infinite Impulse Response filter. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>zeros, z</samp></span></dt> +<dd><p>Set B/numerator/zeros/reflection coefficients. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set A/denominator/poles/ladder coefficients. +</p> +</dd> +<dt><span><samp>gains, k</samp></span></dt> +<dd><p>Set channels gains. +</p> +</dd> +<dt><span><samp>dry_gain</samp></span></dt> +<dd><p>Set input gain. +</p> +</dd> +<dt><span><samp>wet_gain</samp></span></dt> +<dd><p>Set output gain. +</p> +</dd> +<dt><span><samp>format, f</samp></span></dt> +<dd><p>Set coefficients format. +</p> +<dl compact="compact"> +<dt><span>‘<samp>ll</samp>’</span></dt> +<dd><p>lattice-ladder function +</p></dd> +<dt><span>‘<samp>sf</samp>’</span></dt> +<dd><p>analog transfer function +</p></dd> +<dt><span>‘<samp>tf</samp>’</span></dt> +<dd><p>digital transfer function +</p></dd> +<dt><span>‘<samp>zp</samp>’</span></dt> +<dd><p>Z-plane zeros/poles, cartesian (default) +</p></dd> +<dt><span>‘<samp>pr</samp>’</span></dt> +<dd><p>Z-plane zeros/poles, polar radians +</p></dd> +<dt><span>‘<samp>pd</samp>’</span></dt> +<dd><p>Z-plane zeros/poles, polar degrees +</p></dd> +<dt><span>‘<samp>sp</samp>’</span></dt> +<dd><p>S-plane zeros/poles +</p></dd> +</dl> + +</dd> +<dt><span><samp>process, r</samp></span></dt> +<dd><p>Set type of processing. +</p> +<dl compact="compact"> +<dt><span>‘<samp>d</samp>’</span></dt> +<dd><p>direct processing +</p></dd> +<dt><span>‘<samp>s</samp>’</span></dt> +<dd><p>serial processing +</p></dd> +<dt><span>‘<samp>p</samp>’</span></dt> +<dd><p>parallel processing +</p></dd> +</dl> + +</dd> +<dt><span><samp>precision, e</samp></span></dt> +<dd><p>Set filtering precision. +</p> +<dl compact="compact"> +<dt><span>‘<samp>dbl</samp>’</span></dt> +<dd><p>double-precision floating-point (default) +</p></dd> +<dt><span>‘<samp>flt</samp>’</span></dt> +<dd><p>single-precision floating-point +</p></dd> +<dt><span>‘<samp>i32</samp>’</span></dt> +<dd><p>32-bit integers +</p></dd> +<dt><span>‘<samp>i16</samp>’</span></dt> +<dd><p>16-bit integers +</p></dd> +</dl> + +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize filter coefficients, by default is enabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>response</samp></span></dt> +<dd><p>Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +</p> +</dd> +<dt><span><samp>channel</samp></span></dt> +<dd><p>Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when <var>response</var> is enabled. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set video stream size. This option is used only when <var>response</var> is enabled. +</p></dd> +</dl> + +<p>Coefficients in <code>tf</code> and <code>sf</code> format are separated by spaces and are in ascending +order. +</p> +<p>Coefficients in <code>zp</code> format are separated by spaces and order of coefficients +doesn’t matter. Coefficients in <code>zp</code> format are complex numbers with <var>i</var> +imaginary unit. +</p> +<p>Different coefficients and gains can be provided for every channel, in such case +use ’|’ to separate coefficients or gains. Last provided coefficients will be +used for all remaining channels. +</p> +<a name="Examples-9"></a> +<h4 class="subsection">8.28.1 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> Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate: +<div class="example"> +<pre class="example">aiir=k=1:z=7.957584807809675810E-1 -2.575128568908332300 3.674839853930788710 -2.57512875289799137 7.957586296317130880E-1:p=1 -2.86950072432325953 3.63022088054647218 -2.28075678147272232 6.361362326477423500E-1:f=tf:r=d +</pre></div> + +</li><li> Same as above but in <code>zp</code> format: +<div class="example"> +<pre class="example">aiir=k=0.79575848078096756:z=0.80918701+0.58773007i 0.80918701-0.58773007i 0.80884700+0.58784055i 0.80884700-0.58784055i:p=0.63892345+0.59951235i 0.63892345-0.59951235i 0.79582691+0.44198673i 0.79582691-0.44198673i:f=zp:r=s +</pre></div> + +</li><li> Apply 3-rd order analog normalized Butterworth low-pass filter, using analog transfer function format: +<div class="example"> +<pre class="example">aiir=z=1.3057 0 0 0:p=1.3057 2.3892 2.1860 1:f=sf:r=d +</pre></div> +</li></ul> + +<a name="alimiter"></a> +<h3 class="section">8.29 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. Default is 1. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output gain. Default is 1. +</p> +</dd> +<dt><span><samp>limit</samp></span></dt> +<dd><p>Don’t let signals above this level pass the limiter. Default is 1. +</p> +</dd> +<dt><span><samp>attack</samp></span></dt> +<dd><p>The limiter will reach its attenuation level in this amount of time in +milliseconds. Default is 5 milliseconds. +</p> +</dd> +<dt><span><samp>release</samp></span></dt> +<dd><p>Come back from limiting to attenuation 1.0 in this amount of milliseconds. +Default is 50 milliseconds. +</p> +</dd> +<dt><span><samp>asc</samp></span></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><span><samp>asc_level</samp></span></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><span><samp>level</samp></span></dt> +<dd><p>Auto level output signal. Default is enabled. +This normalizes audio back to 0dB if enabled. +</p> +</dd> +<dt><span><samp>latency</samp></span></dt> +<dd><p>Compensate the delay introduced by using the lookahead buffer set with attack +parameter. Also flush the valid audio data in the lookahead buffer when the +stream hits EOF. +</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">8.30 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’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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set frequency in Hz. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Specify the band-width of a filter in width_type units. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>order, o</samp></span></dt> +<dd><p>Set the filter order, can be 1 or 2. Default is 2. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-12"></a> +<h4 class="subsection">8.30.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-12" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-12" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change allpass frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change allpass width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change allpass width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change allpass mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="aloop"></a> +<h3 class="section">8.31 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><span><samp>loop</samp></span></dt> +<dd><p>Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set maximal number of samples. Default is 0. +</p> +</dd> +<dt><span><samp>start</samp></span></dt> +<dd><p>Set first sample of loop. Default is 0. +</p></dd> +</dl> + +<span id="amerge"></span><a name="amerge-1"></a> +<h3 class="section">8.32 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><span><samp>inputs</samp></span></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-10"></a> +<h4 class="subsection">8.32.1 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> 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 "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv +</pre></div> +</li></ul> + +<a name="amix"></a> +<h3 class="section">8.33 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>It accepts the following parameters: +</p><dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>The number of inputs. If unspecified, it defaults to 2. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>How to determine the end-of-stream. +</p><dl compact="compact"> +<dt><span><samp>longest</samp></span></dt> +<dd><p>The duration of the longest input. (default) +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>The duration of the shortest input. +</p> +</dd> +<dt><span><samp>first</samp></span></dt> +<dd><p>The duration of the first input. +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>dropout_transition</samp></span></dt> +<dd><p>The transition time, in seconds, for volume renormalization when an input +stream ends. The default value is 2 seconds. +</p> +</dd> +<dt><span><samp>weights</samp></span></dt> +<dd><p>Specify weight of each input audio stream as a sequence of numbers separated +by a space. If fewer weights are specified compared to number of inputs, the +last weight is assigned to the remaining inputs. +Default weight for each input is 1. +</p> +</dd> +<dt><span><samp>normalize</samp></span></dt> +<dd><p>Always scale inputs instead of only doing summation of samples. +Beware of heavy clipping if inputs are not normalized prior or after filtering +by this filter if this option is disabled. By default is enabled. +</p></dd> +</dl> + +<a name="Examples-11"></a> +<h4 class="subsection">8.33.1 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> + +<ul> +<li> This 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: +<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> + +</li><li> This will mix one vocal and one music input audio stream to a single output with the same duration as the +longest input. The music will have quarter the weight as the vocals, and the inputs are not normalized: +<div class="example"> +<pre class="example">ffmpeg -i VOCALS -i MUSIC -filter_complex amix=inputs=2:duration=longest:dropout_transition=0:weights="1 0.25":normalize=0 OUTPUT +</pre></div> + +</li></ul> + +<a name="Commands-13"></a> +<h4 class="subsection">8.33.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-13" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-13" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>weights</samp></span></dt> +<dt><span><samp>normalize</samp></span></dt> +<dd><p>Syntax is same as option with same name. +</p></dd> +</dl> + +<a name="amultiply"></a> +<h3 class="section">8.34 amultiply<span class="pull-right"><a class="anchor hidden-xs" href="#amultiply" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amultiply" aria-hidden="true">TOC</a></span></h3> + +<p>Multiply first audio stream with second audio stream and store result +in output audio stream. Multiplication is done by multiplying each +sample from first stream with sample at same position from second stream. +</p> +<p>With this element-wise multiplication one can create amplitude fades and +amplitude modulations. +</p> +<a name="anequalizer"></a> +<h3 class="section">8.35 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><span><samp>params</samp></span></dt> +<dd> +<p>This option string is in format: +"c<var>chn</var> f=<var>cf</var> w=<var>w</var> g=<var>g</var> t=<var>f</var> | ..." +Each equalizer band is separated by ’|’. +</p> +<dl compact="compact"> +<dt><span><samp>chn</samp></span></dt> +<dd><p>Set channel number to which equalization will be applied. +If input doesn’t have that channel the entry is ignored. +</p> +</dd> +<dt><span><samp>f</samp></span></dt> +<dd><p>Set central frequency for band. +If input doesn’t have that frequency the entry is ignored. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dd><p>Set band width in Hertz. +</p> +</dd> +<dt><span><samp>g</samp></span></dt> +<dd><p>Set band gain in dB. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>Set filter type for band, optional, can be: +</p> +<dl compact="compact"> +<dt><span>‘<samp>0</samp>’</span></dt> +<dd><p>Butterworth, this is default. +</p> +</dd> +<dt><span>‘<samp>1</samp>’</span></dt> +<dd><p>Chebyshev type 1. +</p> +</dd> +<dt><span>‘<samp>2</samp>’</span></dt> +<dd><p>Chebyshev type 2. +</p></dd> +</dl> +</dd> +</dl> + +</dd> +<dt><span><samp>curves</samp></span></dt> +<dd><p>With this option activated frequency response of anequalizer is displayed +in video stream. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set video stream size. Only useful if curves option is activated. +</p> +</dd> +<dt><span><samp>mgain</samp></span></dt> +<dd><p>Set max gain that will be displayed. Only useful if curves option is activated. +Setting this to a reasonable value makes it possible 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><span><samp>fscale</samp></span></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><span><samp>colors</samp></span></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 ’|’. +Unrecognised or missing colors will be replaced by white color. +</p></dd> +</dl> + +<a name="Examples-12"></a> +<h4 class="subsection">8.35.1 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> + +<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-14"></a> +<h4 class="subsection">8.35.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-14" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-14" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>change</samp></span></dt> +<dd><p>Alter existing filter parameters. +Syntax for the commands is : "<var>fN</var>|f=<var>freq</var>|w=<var>width</var>|g=<var>gain</var>" +</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 Hertz. +<var>gain</var> set new gain parameter in dB. +</p> +<p>Full filter invocation with asendcmd may look like this: +asendcmd=c=’4.0 anequalizer change 0|f=200|w=50|g=1’,anequalizer=... +</p></dd> +</dl> + +<a name="anlmdn"></a> +<h3 class="section">8.36 anlmdn<span class="pull-right"><a class="anchor hidden-xs" href="#anlmdn" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anlmdn" aria-hidden="true">TOC</a></span></h3> + +<p>Reduce broadband noise in audio samples using Non-Local Means algorithm. +</p> +<p>Each sample is adjusted by looking for other samples with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +<samp>p</samp>. Patches are searched in an area of <samp>r</samp> around the sample. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>strength, s</samp></span></dt> +<dd><p>Set denoising strength. Allowed range is from 0.00001 to 10000. Default value is 0.00001. +</p> +</dd> +<dt><span><samp>patch, p</samp></span></dt> +<dd><p>Set patch radius duration. Allowed range is from 1 to 100 milliseconds. +Default value is 2 milliseconds. +</p> +</dd> +<dt><span><samp>research, r</samp></span></dt> +<dd><p>Set research radius duration. Allowed range is from 2 to 300 milliseconds. +Default value is 6 milliseconds. +</p> +</dd> +<dt><span><samp>output, o</samp></span></dt> +<dd><p>Set the output mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>i</samp></span></dt> +<dd><p>Pass input unchanged. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Pass noise filtered out. +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>Pass only noise. +</p> +<p>Default value is <var>o</var>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>smooth, m</samp></span></dt> +<dd><p>Set smooth factor. Default value is <var>11</var>. Allowed range is from <var>1</var> to <var>1000</var>. +</p></dd> +</dl> + +<a name="Commands-15"></a> +<h4 class="subsection">8.36.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-15" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-15" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="anlmf_002c-anlms"></a> +<h3 class="section">8.37 anlmf, anlms<span class="pull-right"><a class="anchor hidden-xs" href="#anlmf_002c-anlms" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-anlmf_002c-anlms" aria-hidden="true">TOC</a></span></h3> +<p>Apply Normalized Least-Mean-(Squares|Fourth) algorithm to the first audio stream using the second audio stream. +</p> +<p>This adaptive filter is used to mimic a desired filter by finding the filter coefficients that +relate to producing the least mean square of the error signal (difference between the desired, +2nd input audio stream and the actual signal, the 1st input audio stream). +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order. +</p> +</dd> +<dt><span><samp>mu</samp></span></dt> +<dd><p>Set filter mu. +</p> +</dd> +<dt><span><samp>eps</samp></span></dt> +<dd><p>Set the filter eps. +</p> +</dd> +<dt><span><samp>leakage</samp></span></dt> +<dd><p>Set the filter leakage. +</p> +</dd> +<dt><span><samp>out_mode</samp></span></dt> +<dd><p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>i</samp></span></dt> +<dd><p>Pass the 1st input. +</p> +</dd> +<dt><span><samp>d</samp></span></dt> +<dd><p>Pass the 2nd input. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Pass filtered samples. +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>Pass difference between desired and filtered samples. +</p> +<p>Default value is <var>o</var>. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-13"></a> +<h4 class="subsection">8.37.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> One of many usages of this filter is noise reduction, input audio is filtered +with same samples that are delayed by fixed amount, one such example for stereo audio is: +<div class="example"> +<pre class="example">asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o +</pre></div> +</li></ul> + +<a name="Commands-16"></a> +<h4 class="subsection">8.37.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-16" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-16" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the same commands as options, excluding option <code>order</code>. +</p> +<a name="anull"></a> +<h3 class="section">8.38 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">8.39 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><span><samp>packet_size</samp></span></dt> +<dd><p>Set silence packet size. Default value is 4096. +</p> +</dd> +<dt><span><samp>pad_len</samp></span></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><span><samp>whole_len</samp></span></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> +<dt><span><samp>pad_dur</samp></span></dt> +<dd><p>Specify the duration of samples of silence to add. See +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a> +for the accepted syntax. Used only if set to non-negative value. +</p> +</dd> +<dt><span><samp>whole_dur</samp></span></dt> +<dd><p>Specify the minimum total duration in the output audio stream. See +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a> +for the accepted syntax. Used only if set to non-negative value. 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_dur</samp> +</p></dd> +</dl> + +<p>If neither the <samp>pad_len</samp> nor the <samp>whole_len</samp> nor <samp>pad_dur</samp> +nor <samp>whole_dur</samp> option is set, the filter will add silence to the end of +the input stream indefinitely. +</p> +<p>Note that for ffmpeg 4.4 and earlier a zero <samp>pad_dur</samp> or +<samp>whole_dur</samp> also caused the filter to add silence indefinitely. +</p> +<a name="Examples-14"></a> +<h4 class="subsection">8.39.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> 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 "[1:0]apad" -shortest OUTPUT +</pre></div> +</li></ul> + +<a name="aphaser"></a> +<h3 class="section">8.40 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><span><samp>in_gain</samp></span></dt> +<dd><p>Set input gain. Default is 0.4. +</p> +</dd> +<dt><span><samp>out_gain</samp></span></dt> +<dd><p>Set output gain. Default is 0.74 +</p> +</dd> +<dt><span><samp>delay</samp></span></dt> +<dd><p>Set delay in milliseconds. Default is 3.0. +</p> +</dd> +<dt><span><samp>decay</samp></span></dt> +<dd><p>Set decay. Default is 0.4. +</p> +</dd> +<dt><span><samp>speed</samp></span></dt> +<dd><p>Set modulation speed in Hz. Default is 0.5. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set modulation type. Default is triangular. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>triangular, t</samp>’</span></dt> +<dt><span>‘<samp>sinusoidal, s</samp>’</span></dt> +</dl> +</dd> +</dl> + +<a name="aphaseshift"></a> +<h3 class="section">8.41 aphaseshift<span class="pull-right"><a class="anchor hidden-xs" href="#aphaseshift" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aphaseshift" aria-hidden="true">TOC</a></span></h3> +<p>Apply phase shift to input audio samples. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>shift</samp></span></dt> +<dd><p>Specify phase shift. Allowed range is from -1.0 to 1.0. +Default value is 0.0. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set output gain applied to final output. Allowed range is from 0.0 to 1.0. +Default value is 1.0. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order used for filtering. Allowed range is from 1 to 16. +Default value is 8. +</p></dd> +</dl> + +<a name="Commands-17"></a> +<h4 class="subsection">8.41.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-17" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-17" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="apsyclip"></a> +<h3 class="section">8.42 apsyclip<span class="pull-right"><a class="anchor hidden-xs" href="#apsyclip" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-apsyclip" aria-hidden="true">TOC</a></span></h3> +<p>Apply Psychoacoustic clipper to input audio stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. By default it is 1. Range is [0.015625 - 64]. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output gain. By default it is 1. Range is [0.015625 - 64]. +</p> +</dd> +<dt><span><samp>clip</samp></span></dt> +<dd><p>Set the clipping start value. Default value is 0dBFS or 1. +</p> +</dd> +<dt><span><samp>diff</samp></span></dt> +<dd><p>Output only difference samples, useful to hear introduced distortions. +By default is disabled. +</p> +</dd> +<dt><span><samp>adaptive</samp></span></dt> +<dd><p>Set strength of adaptive distortion applied. Default value is 0.5. +Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>iterations</samp></span></dt> +<dd><p>Set number of iterations of psychoacoustic clipper. +Allowed range is from 1 to 20. Default value is 10. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Auto level output signal. Default is disabled. +This normalizes audio back to 0dBFS if enabled. +</p></dd> +</dl> + +<a name="Commands-18"></a> +<h4 class="subsection">8.42.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-18" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-18" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="apulsator"></a> +<h3 class="section">8.43 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 "bypassing" 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. By default it is 1. Range is [0.015625 - 64]. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output gain. By default it is 1. Range is [0.015625 - 64]. +</p> +</dd> +<dt><span><samp>mode</samp></span></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><span><samp>amount</samp></span></dt> +<dd><p>Set modulation. Define how much of original signal is affected by the LFO. +</p> +</dd> +<dt><span><samp>offset_l</samp></span></dt> +<dd><p>Set left channel offset. Default is 0. Allowed range is [0 - 1]. +</p> +</dd> +<dt><span><samp>offset_r</samp></span></dt> +<dd><p>Set right channel offset. Default is 0.5. Allowed range is [0 - 1]. +</p> +</dd> +<dt><span><samp>width</samp></span></dt> +<dd><p>Set pulse width. Default is 1. Allowed range is [0 - 2]. +</p> +</dd> +<dt><span><samp>timing</samp></span></dt> +<dd><p>Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz. +</p> +</dd> +<dt><span><samp>bpm</samp></span></dt> +<dd><p>Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing +is set to bpm. +</p> +</dd> +<dt><span><samp>ms</samp></span></dt> +<dd><p>Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing +is set to ms. +</p> +</dd> +<dt><span><samp>hz</samp></span></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> + +<span id="aresample"></span><a name="aresample-1"></a> +<h3 class="section">8.44 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 ":". See the +<a data-manual="ffmpeg-resampler" href="ffmpeg-resampler.html#Resampler-Options">(ffmpeg-resampler)"Resampler Options" section in the +ffmpeg-resampler(1) manual</a> +for the complete list of supported options. +</p> +<a name="Examples-15"></a> +<h4 class="subsection">8.44.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> 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">8.45 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-16"></a> +<h4 class="subsection">8.45.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> 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="arnndn"></a> +<h3 class="section">8.46 arnndn<span class="pull-right"><a class="anchor hidden-xs" href="#arnndn" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-arnndn" aria-hidden="true">TOC</a></span></h3> + +<p>Reduce noise from speech using Recurrent Neural Networks. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>model, m</samp></span></dt> +<dd><p>Set train model file to load. This option is always required. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>Set how much to mix filtered samples into final output. +Allowed range is from -1 to 1. Default value is 1. +Negative values are special, they set how much to keep filtered noise +in the final filter output. Set this option to -1 to hear actual +noise removed from input signal. +</p></dd> +</dl> + +<a name="Commands-19"></a> +<h4 class="subsection">8.46.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-19" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-19" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="asdr"></a> +<h3 class="section">8.47 asdr<span class="pull-right"><a class="anchor hidden-xs" href="#asdr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asdr" aria-hidden="true">TOC</a></span></h3> +<p>Measure Audio Signal-to-Distortion Ratio. +</p> +<p>This filter takes two audio streams for input, and outputs first +audio stream. +Results are in dB per channel at end of either input. +</p> +<a name="asetnsamples"></a> +<h3 class="section">8.48 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><span><samp>nb_out_samples, n</samp></span></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><span><samp>pad, p</samp></span></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">8.49 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><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Set the output sample rate. Default is 44100 Hz. +</p></dd> +</dl> + +<a name="ashowinfo"></a> +<h3 class="section">8.50 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><span><samp>n</samp></span></dt> +<dd><p>The (sequential) number of the input frame, starting from 0. +</p> +</dd> +<dt><span><samp>pts</samp></span></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><span><samp>pts_time</samp></span></dt> +<dd><p>The presentation timestamp of the input frame in seconds. +</p> +</dd> +<dt><span><samp>pos</samp></span></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><span><samp>fmt</samp></span></dt> +<dd><p>The sample format. +</p> +</dd> +<dt><span><samp>chlayout</samp></span></dt> +<dd><p>The channel layout. +</p> +</dd> +<dt><span><samp>rate</samp></span></dt> +<dd><p>The sample rate for the audio frame. +</p> +</dd> +<dt><span><samp>nb_samples</samp></span></dt> +<dd><p>The number of samples (per channel) in the frame. +</p> +</dd> +<dt><span><samp>checksum</samp></span></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><span><samp>plane_checksums</samp></span></dt> +<dd><p>A list of Adler-32 checksums for each data plane. +</p></dd> +</dl> + +<a name="asoftclip"></a> +<h3 class="section">8.51 asoftclip<span class="pull-right"><a class="anchor hidden-xs" href="#asoftclip" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asoftclip" aria-hidden="true">TOC</a></span></h3> +<p>Apply audio soft clipping. +</p> +<p>Soft clipping is a type of distortion effect where the amplitude of a signal is saturated +along a smooth curve, rather than the abrupt shape of hard-clipping. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set type of soft-clipping. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>hard</samp></span></dt> +<dt><span><samp>tanh</samp></span></dt> +<dt><span><samp>atan</samp></span></dt> +<dt><span><samp>cubic</samp></span></dt> +<dt><span><samp>exp</samp></span></dt> +<dt><span><samp>alg</samp></span></dt> +<dt><span><samp>quintic</samp></span></dt> +<dt><span><samp>sin</samp></span></dt> +<dt><span><samp>erf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set threshold from where to start clipping. Default value is 0dB or 1. +</p> +</dd> +<dt><span><samp>output</samp></span></dt> +<dd><p>Set gain applied to output. Default value is 0dB or 1. +</p> +</dd> +<dt><span><samp>param</samp></span></dt> +<dd><p>Set additional parameter which controls sigmoid function. +</p> +</dd> +<dt><span><samp>oversample</samp></span></dt> +<dd><p>Set oversampling factor. +</p></dd> +</dl> + +<a name="Commands-20"></a> +<h4 class="subsection">8.51.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-20" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-20" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="aspectralstats"></a> +<h3 class="section">8.52 aspectralstats<span class="pull-right"><a class="anchor hidden-xs" href="#aspectralstats" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aspectralstats" aria-hidden="true">TOC</a></span></h3> + +<p>Display frequency domain statistical information about the audio channels. +Statistics are calculated and stored as metadata for each audio channel and for each audio frame. +</p> +<p>It accepts the following option: +</p><dl compact="compact"> +<dt><span><samp>win_size</samp></span></dt> +<dd><p>Set the window length in samples. Default value is 2048. +Allowed range is from 32 to 65536. +</p> +</dd> +<dt><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann, hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> +<p>Default is <code>hann</code>. +</p> +</dd> +<dt><span><samp>overlap</samp></span></dt> +<dd><p>Set window overlap. Allowed range is from <code>0</code> +to <code>1</code>. Default value is <code>0.5</code>. +</p> +</dd> +<dt><span><samp>measure</samp></span></dt> +<dd><p>Select the parameters which are measured. The metadata keys can +be used as flags, default is <samp>all</samp> which measures everything. +<samp>none</samp> disables all measurement. +</p></dd> +</dl> + +<p>A list of each metadata key follows: +</p> +<dl compact="compact"> +<dt><span><samp>mean</samp></span></dt> +<dt><span><samp>variance</samp></span></dt> +<dt><span><samp>centroid</samp></span></dt> +<dt><span><samp>spread</samp></span></dt> +<dt><span><samp>skewness</samp></span></dt> +<dt><span><samp>kurtosis</samp></span></dt> +<dt><span><samp>entropy</samp></span></dt> +<dt><span><samp>flatness</samp></span></dt> +<dt><span><samp>crest</samp></span></dt> +<dt><span><samp>flux</samp></span></dt> +<dt><span><samp>slope</samp></span></dt> +<dt><span><samp>decrease</samp></span></dt> +<dt><span><samp>rolloff</samp></span></dt> +</dl> + +<a name="asr"></a> +<h3 class="section">8.53 asr<span class="pull-right"><a class="anchor hidden-xs" href="#asr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asr" aria-hidden="true">TOC</a></span></h3> +<p>Automatic Speech Recognition +</p> +<p>This filter uses PocketSphinx for speech recognition. To enable +compilation of this filter, you need to configure FFmpeg with +<code>--enable-pocketsphinx</code>. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>rate</samp></span></dt> +<dd><p>Set sampling rate of input audio. Defaults is <code>16000</code>. +This need to match speech models, otherwise one will get poor results. +</p> +</dd> +<dt><span><samp>hmm</samp></span></dt> +<dd><p>Set dictionary containing acoustic model files. +</p> +</dd> +<dt><span><samp>dict</samp></span></dt> +<dd><p>Set pronunciation dictionary. +</p> +</dd> +<dt><span><samp>lm</samp></span></dt> +<dd><p>Set language model file. +</p> +</dd> +<dt><span><samp>lmctl</samp></span></dt> +<dd><p>Set language model set. +</p> +</dd> +<dt><span><samp>lmname</samp></span></dt> +<dd><p>Set which language model to use. +</p> +</dd> +<dt><span><samp>logfn</samp></span></dt> +<dd><p>Set output for log messages. +</p></dd> +</dl> + +<p>The filter exports recognized speech as the frame metadata <code>lavfi.asr.text</code>. +</p> +<span id="astats"></span><a name="astats-1"></a> +<h3 class="section">8.54 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><span><samp>length</samp></span></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 - 10]</code>. +</p> +</dd> +<dt><span><samp>metadata</samp></span></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 +RMS_difference +Peak_level +RMS_peak +RMS_trough +Crest_factor +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Entropy +Bit_depth +Dynamic_range +Zero_crossings +Zero_crossings_rate +Number_of_NaNs +Number_of_Infs +Number_of_denormals +</p> +<p>and for Overall: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_level +RMS_peak +RMS_trough +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Entropy +Bit_depth +Number_of_samples +Number_of_NaNs +Number_of_Infs +Number_of_denormals +</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><span><samp>reset</samp></span></dt> +<dd><p>Set the number of frames over which cumulative stats are calculated before +being reset +Default is disabled. +</p> +</dd> +<dt><span><samp>measure_perchannel</samp></span></dt> +<dd><p>Select the parameters which are measured per channel. The metadata keys can +be used as flags, default is <samp>all</samp> which measures everything. +<samp>none</samp> disables all per channel measurement. +</p> +</dd> +<dt><span><samp>measure_overall</samp></span></dt> +<dd><p>Select the parameters which are measured overall. The metadata keys can +be used as flags, default is <samp>all</samp> which measures everything. +<samp>none</samp> disables all overall measurement. +</p> +</dd> +</dl> + +<p>A description of each shown parameter follows: +</p> +<dl compact="compact"> +<dt><span><samp>DC offset</samp></span></dt> +<dd><p>Mean amplitude displacement from zero. +</p> +</dd> +<dt><span><samp>Min level</samp></span></dt> +<dd><p>Minimal sample level. +</p> +</dd> +<dt><span><samp>Max level</samp></span></dt> +<dd><p>Maximal sample level. +</p> +</dd> +<dt><span><samp>Min difference</samp></span></dt> +<dd><p>Minimal difference between two consecutive samples. +</p> +</dd> +<dt><span><samp>Max difference</samp></span></dt> +<dd><p>Maximal difference between two consecutive samples. +</p> +</dd> +<dt><span><samp>Mean difference</samp></span></dt> +<dd><p>Mean difference between two consecutive samples. +The average of each difference between two consecutive samples. +</p> +</dd> +<dt><span><samp>RMS difference</samp></span></dt> +<dd><p>Root Mean Square difference between two consecutive samples. +</p> +</dd> +<dt><span><samp>Peak level dB</samp></span></dt> +<dt><span><samp>RMS level dB</samp></span></dt> +<dd><p>Standard peak and RMS level measured in dBFS. +</p> +</dd> +<dt><span><samp>RMS peak dB</samp></span></dt> +<dt><span><samp>RMS trough dB</samp></span></dt> +<dd><p>Peak and trough values for RMS level measured over a short window. +</p> +</dd> +<dt><span><samp>Crest factor</samp></span></dt> +<dd><p>Standard ratio of peak to RMS level (note: not in dB). +</p> +</dd> +<dt><span><samp>Flat factor</samp></span></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><span><samp>Peak count</samp></span></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><span><samp>Noise floor dB</samp></span></dt> +<dd><p>Minimum local peak measured in dBFS over a short window. +</p> +</dd> +<dt><span><samp>Noise floor count</samp></span></dt> +<dd><p>Number of occasions (not the number of samples) that the signal attained +<var>Noise floor</var>. +</p> +</dd> +<dt><span><samp>Entropy</samp></span></dt> +<dd><p>Entropy measured across whole audio. Entropy of value near 1.0 is typically measured for white noise. +</p> +</dd> +<dt><span><samp>Bit depth</samp></span></dt> +<dd><p>Overall bit depth of audio. Number of bits used for each sample. +</p> +</dd> +<dt><span><samp>Dynamic range</samp></span></dt> +<dd><p>Measured dynamic range of audio in dB. +</p> +</dd> +<dt><span><samp>Zero crossings</samp></span></dt> +<dd><p>Number of points where the waveform crosses the zero level axis. +</p> +</dd> +<dt><span><samp>Zero crossings rate</samp></span></dt> +<dd><p>Rate of Zero crossings and number of audio samples. +</p></dd> +</dl> + +<a name="asubboost"></a> +<h3 class="section">8.55 asubboost<span class="pull-right"><a class="anchor hidden-xs" href="#asubboost" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asubboost" aria-hidden="true">TOC</a></span></h3> +<p>Boost subwoofer frequencies. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>dry</samp></span></dt> +<dd><p>Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1. +Default value is 1.0. +</p> +</dd> +<dt><span><samp>wet</samp></span></dt> +<dd><p>Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1. +Default value is 1.0. +</p> +</dd> +<dt><span><samp>boost</samp></span></dt> +<dd><p>Set max boost factor. Allowed range is from 1 to 12. Default value is 2. +</p> +</dd> +<dt><span><samp>decay</samp></span></dt> +<dd><p>Set delay line decay gain value. Allowed range is from 0 to 1. +Default value is 0.0. +</p> +</dd> +<dt><span><samp>feedback</samp></span></dt> +<dd><p>Set delay line feedback gain value. Allowed range is from 0 to 1. +Default value is 0.9. +</p> +</dd> +<dt><span><samp>cutoff</samp></span></dt> +<dd><p>Set cutoff frequency in Hertz. Allowed range is 50 to 900. +Default value is 100. +</p> +</dd> +<dt><span><samp>slope</samp></span></dt> +<dd><p>Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1. +Default value is 0.5. +</p> +</dd> +<dt><span><samp>delay</samp></span></dt> +<dd><p>Set delay. Allowed range is from 1 to 100. +Default value is 20. +</p> +</dd> +<dt><span><samp>channels</samp></span></dt> +<dd><p>Set the channels to process. Default value is all available. +</p></dd> +</dl> + +<a name="Commands-21"></a> +<h4 class="subsection">8.55.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-21" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-21" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="asubcut"></a> +<h3 class="section">8.56 asubcut<span class="pull-right"><a class="anchor hidden-xs" href="#asubcut" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asubcut" aria-hidden="true">TOC</a></span></h3> +<p>Cut subwoofer frequencies. +</p> +<p>This filter allows to set custom, steeper +roll off than highpass filter, and thus is able to more attenuate +frequency content in stop-band. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>cutoff</samp></span></dt> +<dd><p>Set cutoff frequency in Hertz. Allowed range is 2 to 200. +Default value is 20. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order. Available values are from 3 to 20. +Default value is 10. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1. +</p></dd> +</dl> + +<a name="Commands-22"></a> +<h4 class="subsection">8.56.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-22" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-22" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="asupercut"></a> +<h3 class="section">8.57 asupercut<span class="pull-right"><a class="anchor hidden-xs" href="#asupercut" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asupercut" aria-hidden="true">TOC</a></span></h3> +<p>Cut super frequencies. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>cutoff</samp></span></dt> +<dd><p>Set cutoff frequency in Hertz. Allowed range is 20000 to 192000. +Default value is 20000. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order. Available values are from 3 to 20. +Default value is 10. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1. +</p></dd> +</dl> + +<a name="Commands-23"></a> +<h4 class="subsection">8.57.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-23" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-23" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="asuperpass"></a> +<h3 class="section">8.58 asuperpass<span class="pull-right"><a class="anchor hidden-xs" href="#asuperpass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asuperpass" aria-hidden="true">TOC</a></span></h3> +<p>Apply high order Butterworth band-pass filter. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>centerf</samp></span></dt> +<dd><p>Set center frequency in Hertz. Allowed range is 2 to 999999. +Default value is 1000. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order. Available values are from 4 to 20. +Default value is 4. +</p> +</dd> +<dt><span><samp>qfactor</samp></span></dt> +<dd><p>Set Q-factor. Allowed range is from 0.01 to 100. Default value is 1. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input gain level. Allowed range is from 0 to 2. Default value is 1. +</p></dd> +</dl> + +<a name="Commands-24"></a> +<h4 class="subsection">8.58.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-24" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-24" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="asuperstop"></a> +<h3 class="section">8.59 asuperstop<span class="pull-right"><a class="anchor hidden-xs" href="#asuperstop" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-asuperstop" aria-hidden="true">TOC</a></span></h3> +<p>Apply high order Butterworth band-stop filter. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>centerf</samp></span></dt> +<dd><p>Set center frequency in Hertz. Allowed range is 2 to 999999. +Default value is 1000. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set filter order. Available values are from 4 to 20. +Default value is 4. +</p> +</dd> +<dt><span><samp>qfactor</samp></span></dt> +<dd><p>Set Q-factor. Allowed range is from 0.01 to 100. Default value is 1. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input gain level. Allowed range is from 0 to 2. Default value is 1. +</p></dd> +</dl> + +<a name="Commands-25"></a> +<h4 class="subsection">8.59.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-25" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-25" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="atempo"></a> +<h3 class="section">8.60 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, 100.0] range. +</p> +<p>Note that tempo greater than 2 will skip some samples rather than +blend them in. If for any reason this is a concern it is always +possible to daisy-chain several instances of atempo to achieve the +desired product tempo. +</p> +<a name="Examples-17"></a> +<h4 class="subsection">8.60.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> Slow down audio to 80% tempo: +<div class="example"> +<pre class="example">atempo=0.8 +</pre></div> + +</li><li> To speed up audio to 300% tempo: +<div class="example"> +<pre class="example">atempo=3 +</pre></div> + +</li><li> To speed up audio to 300% tempo by daisy-chaining two atempo instances: +<div class="example"> +<pre class="example">atempo=sqrt(3),atempo=sqrt(3) +</pre></div> +</li></ul> + +<a name="Commands-26"></a> +<h4 class="subsection">8.60.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-26" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-26" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>tempo</samp></span></dt> +<dd><p>Change filter tempo scale factor. +Syntax for the command is : "<var>tempo</var>" +</p></dd> +</dl> + +<a name="atilt"></a> +<h3 class="section">8.61 atilt<span class="pull-right"><a class="anchor hidden-xs" href="#atilt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-atilt" aria-hidden="true">TOC</a></span></h3> +<p>Apply spectral tilt filter to audio stream. +</p> +<p>This filter apply any spectral roll-off slope over any specified frequency band. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>freq</samp></span></dt> +<dd><p>Set central frequency of tilt in Hz. Default is 10000 Hz. +</p> +</dd> +<dt><span><samp>slope</samp></span></dt> +<dd><p>Set slope direction of tilt. Default is 0. Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>width</samp></span></dt> +<dd><p>Set width of tilt. Default is 1000. Allowed range is from 100 to 10000. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set order of tilt filter. +</p> +</dd> +<dt><span><samp>level</samp></span></dt> +<dd><p>Set input volume level. Allowed range is from 0 to 4. +Defalt is 1. +</p></dd> +</dl> + +<a name="Commands-27"></a> +<h4 class="subsection">8.61.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-27" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-27" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="atrim"></a> +<h3 class="section">8.62 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><span><samp>start</samp></span></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><span><samp>end</samp></span></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><span><samp>start_pts</samp></span></dt> +<dd><p>Same as <var>start</var>, except this option sets the start timestamp in samples +instead of seconds. +</p> +</dd> +<dt><span><samp>end_pts</samp></span></dt> +<dd><p>Same as <var>end</var>, except this option sets the end timestamp in samples instead +of seconds. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>The maximum duration of the output in seconds. +</p> +</dd> +<dt><span><samp>start_sample</samp></span></dt> +<dd><p>The number of the first sample that should be output. +</p> +</dd> +<dt><span><samp>end_sample</samp></span></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 data-manual="ffmpeg-utils" 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="axcorrelate"></a> +<h3 class="section">8.63 axcorrelate<span class="pull-right"><a class="anchor hidden-xs" href="#axcorrelate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-axcorrelate" aria-hidden="true">TOC</a></span></h3> +<p>Calculate normalized windowed cross-correlation between two input audio streams. +</p> +<p>Resulted samples are always between -1 and 1 inclusive. +If result is 1 it means two input samples are highly correlated in that selected segment. +Result 0 means they are not correlated at all. +If result is -1 it means two input samples are out of phase, which means they cancel each +other. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set size of segment over which cross-correlation is calculated. +Default is 256. Allowed range is from 2 to 131072. +</p> +</dd> +<dt><span><samp>algo</samp></span></dt> +<dd><p>Set algorithm for cross-correlation. Can be <code>slow</code> or <code>fast</code>. +Default is <code>slow</code>. Fast algorithm assumes mean values over any given segment +are always zero and thus need much less calculations to make. +This is generally not true, but is valid for typical audio streams. +</p></dd> +</dl> + +<a name="Examples-18"></a> +<h4 class="subsection">8.63.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> Calculate correlation between channels in stereo audio stream: +<div class="example"> +<pre class="example">ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav +</pre></div> +</li></ul> + +<a name="bandpass"></a> +<h3 class="section">8.64 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’s central frequency. Default is <code>3000</code>. +</p> +</dd> +<dt><span><samp>csg</samp></span></dt> +<dd><p>Constant skirt gain if set to 1. Defaults to 0. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Specify the band-width of a filter in width_type units. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-28"></a> +<h4 class="subsection">8.64.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-28" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-28" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change bandpass frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change bandpass width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change bandpass width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change bandpass mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="bandreject"></a> +<h3 class="section">8.65 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’s central frequency. Default is <code>3000</code>. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Specify the band-width of a filter in width_type units. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-29"></a> +<h4 class="subsection">8.65.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-29" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-29" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change bandreject frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change bandreject width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change bandreject width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change bandreject mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="bass_002c-lowshelf"></a> +<h3 class="section">8.66 bass, lowshelf<span class="pull-right"><a class="anchor hidden-xs" href="#bass_002c-lowshelf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bass_002c-lowshelf" 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’s tone-controls. This is also known as shelving equalisation (EQ). +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>gain, g</samp></span></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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’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><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Determine how steep is the filter’s shelf transition. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set number of poles. Default is 2. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-30"></a> +<h4 class="subsection">8.66.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-30" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-30" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change bass frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change bass width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change bass width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>gain, g</samp></span></dt> +<dd><p>Change bass gain. +Syntax for the command is : "<var>gain</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change bass mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="biquad"></a> +<h3 class="section">8.67 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. +and <var>channels</var>, <var>c</var> specify which channels to filter, by default all +available are filtered. +</p> +<a name="Commands-31"></a> +<h4 class="subsection">8.67.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-31" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-31" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>a0</samp></span></dt> +<dt><span><samp>a1</samp></span></dt> +<dt><span><samp>a2</samp></span></dt> +<dt><span><samp>b0</samp></span></dt> +<dt><span><samp>b1</samp></span></dt> +<dt><span><samp>b2</samp></span></dt> +<dd><p>Change biquad parameter. +Syntax for the command is : "<var>value</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="bs2b"></a> +<h3 class="section">8.68 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>To enable compilation of this filter you need to configure FFmpeg with +<code>--enable-libbs2b</code>. +</p> +<p>It accepts the following parameters: +</p><dl compact="compact"> +<dt><span><samp>profile</samp></span></dt> +<dd><p>Pre-defined crossfeed level. +</p><dl compact="compact"> +<dt><span><samp>default</samp></span></dt> +<dd><p>Default level (fcut=700, feed=50). +</p> +</dd> +<dt><span><samp>cmoy</samp></span></dt> +<dd><p>Chu Moy circuit (fcut=700, feed=60). +</p> +</dd> +<dt><span><samp>jmeier</samp></span></dt> +<dd><p>Jan Meier circuit (fcut=650, feed=95). +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>fcut</samp></span></dt> +<dd><p>Cut frequency (in Hz). +</p> +</dd> +<dt><span><samp>feed</samp></span></dt> +<dd><p>Feed level (in Hz). +</p> +</dd> +</dl> + +<a name="channelmap"></a> +<h3 class="section">8.69 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><span><samp>map</samp></span></dt> +<dd><p>Map channels from input to output. The argument is a ’|’-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> +<dt><span><samp>channel_layout</samp></span></dt> +<dd><p>The channel layout of the output stream. +</p></dd> +</dl> + +<p>If no mapping is present, the filter will implicitly map input channels to +output channels, preserving indices. +</p> +<a name="Examples-19"></a> +<h4 class="subsection">8.69.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> For example, assuming a 5.1+downmix input MOV file, +<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> +</li><li> To fix a 5.1 WAV improperly encoded in AAC’s native channel order +<div class="example"> +<pre class="example">ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav +</pre></div> +</li></ul> + +<a name="channelsplit"></a> +<h3 class="section">8.70 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><span><samp>channel_layout</samp></span></dt> +<dd><p>The channel layout of the input stream. The default is "stereo". +</p></dd> +<dt><span><samp>channels</samp></span></dt> +<dd><p>A channel layout describing the channels to be extracted as separate output streams +or "all" to extract each input channel as a separate stream. The default is "all". +</p> +<p>Choosing channels not present in channel layout in the input will result in an error. +</p></dd> +</dl> + +<a name="Examples-20"></a> +<h4 class="subsection">8.70.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> For example, assuming a stereo input MP3 file, +<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> +</li><li> Split a 5.1 WAV file into per-channel files: +<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> + +</li><li> Extract only LFE from a 5.1 WAV file: +<div class="example"> +<pre class="example">ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]' +-map '[LFE]' lfe.wav +</pre></div> +</li></ul> + +<a name="chorus"></a> +<h3 class="section">8.71 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><span><samp>in_gain</samp></span></dt> +<dd><p>Set input gain. Default is 0.4. +</p> +</dd> +<dt><span><samp>out_gain</samp></span></dt> +<dd><p>Set output gain. Default is 0.4. +</p> +</dd> +<dt><span><samp>delays</samp></span></dt> +<dd><p>Set delays. A typical delay is around 40ms to 60ms. +</p> +</dd> +<dt><span><samp>decays</samp></span></dt> +<dd><p>Set decays. +</p> +</dd> +<dt><span><samp>speeds</samp></span></dt> +<dd><p>Set speeds. +</p> +</dd> +<dt><span><samp>depths</samp></span></dt> +<dd><p>Set depths. +</p></dd> +</dl> + +<a name="Examples-21"></a> +<h4 class="subsection">8.71.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> 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">8.72 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’s dynamic range. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>attacks</samp></span></dt> +<dt><span><samp>decays</samp></span></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 & decays is lower than number of channels, the last +set attack/decay will be used for all remaining channels. +</p> +</dd> +<dt><span><samp>points</samp></span></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|1/0</code>. +</p> +</dd> +<dt><span><samp>soft-knee</samp></span></dt> +<dd><p>Set the curve radius in dB for all joints. It defaults to 0.01. +</p> +</dd> +<dt><span><samp>gain</samp></span></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><span><samp>volume</samp></span></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><span><samp>delay</samp></span></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-22"></a> +<h4 class="subsection">8.72.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> 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">8.73 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 locations. 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 a distance of +~30 cm between microphones makes one microphone capture the signal in +antiphase to the other microphone. That makes the final mix sound 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>The filter accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>mm</samp></span></dt> +<dd><p>Set millimeters distance. This is compensation distance for fine tuning. +Default is 0. +</p> +</dd> +<dt><span><samp>cm</samp></span></dt> +<dd><p>Set cm distance. This is compensation distance for tightening distance setup. +Default is 0. +</p> +</dd> +<dt><span><samp>m</samp></span></dt> +<dd><p>Set meters distance. This is compensation distance for hard distance setup. +Default is 0. +</p> +</dd> +<dt><span><samp>dry</samp></span></dt> +<dd><p>Set dry amount. Amount of unprocessed (dry) signal. +Default is 0. +</p> +</dd> +<dt><span><samp>wet</samp></span></dt> +<dd><p>Set wet amount. Amount of processed (wet) signal. +Default is 1. +</p> +</dd> +<dt><span><samp>temp</samp></span></dt> +<dd><p>Set temperature in degrees Celsius. This is the temperature of the environment. +Default is 20. +</p></dd> +</dl> + +<a name="Commands-32"></a> +<h4 class="subsection">8.73.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-32" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-32" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="crossfeed"></a> +<h3 class="section">8.74 crossfeed<span class="pull-right"><a class="anchor hidden-xs" href="#crossfeed" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-crossfeed" aria-hidden="true">TOC</a></span></h3> +<p>Apply headphone crossfeed filter. +</p> +<p>Crossfeed is the process of blending the left and right channels of stereo +audio recording. +It is mainly used to reduce extreme stereo separation of low frequencies. +</p> +<p>The intent is to produce more speaker like sound to the listener. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>strength</samp></span></dt> +<dd><p>Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1. +This sets gain of low shelf filter for side part of stereo image. +Default is -6dB. Max allowed is -30db when strength is set to 1. +</p> +</dd> +<dt><span><samp>range</samp></span></dt> +<dd><p>Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1. +This sets cut off frequency of low shelf filter. Default is cut off near +1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz. +</p> +</dd> +<dt><span><samp>slope</samp></span></dt> +<dd><p>Set curve slope of low shelf filter. Default is 0.5. +Allowed range is from 0.01 to 1. +</p> +</dd> +<dt><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. Default is 0.9. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output gain. Default is 1. +</p> +</dd> +<dt><span><samp>block_size</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-33"></a> +<h4 class="subsection">8.74.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-33" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-33" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="crystalizer"></a> +<h3 class="section">8.75 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 for audio noise sharpening. +</p> +<p>This filter linearly increases differences betweeen each audio sample. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>i</samp></span></dt> +<dd><p>Sets the intensity of effect (default: 2.0). Must be in range between -10.0 to 0 +(unchanged sound) to 10.0 (maximum effect). +To inverse filtering use negative value. +</p> +</dd> +<dt><span><samp>c</samp></span></dt> +<dd><p>Enable clipping. By default is enabled. +</p></dd> +</dl> + +<a name="Commands-34"></a> +<h4 class="subsection">8.75.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-34" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-34" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="dcshift"></a> +<h3 class="section">8.76 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><span><samp>shift</samp></span></dt> +<dd><p>Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift +the audio. +</p> +</dd> +<dt><span><samp>limitergain</samp></span></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="deesser"></a> +<h3 class="section">8.77 deesser<span class="pull-right"><a class="anchor hidden-xs" href="#deesser" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deesser" aria-hidden="true">TOC</a></span></h3> + +<p>Apply de-essing to the audio samples. +</p> +<dl compact="compact"> +<dt><span><samp>i</samp></span></dt> +<dd><p>Set intensity for triggering de-essing. Allowed range is from 0 to 1. +Default is 0. +</p> +</dd> +<dt><span><samp>m</samp></span></dt> +<dd><p>Set amount of ducking on treble part of sound. Allowed range is from 0 to 1. +Default is 0.5. +</p> +</dd> +<dt><span><samp>f</samp></span></dt> +<dd><p>How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1. +Default is 0.5. +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>Set the output mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span><samp>i</samp></span></dt> +<dd><p>Pass input unchanged. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Pass ess filtered out. +</p> +</dd> +<dt><span><samp>e</samp></span></dt> +<dd><p>Pass only ess. +</p> +<p>Default value is <var>o</var>. +</p></dd> +</dl> + +</dd> +</dl> + +<a name="dialoguenhance"></a> +<h3 class="section">8.78 dialoguenhance<span class="pull-right"><a class="anchor hidden-xs" href="#dialoguenhance" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dialoguenhance" aria-hidden="true">TOC</a></span></h3> +<p>Enhance dialogue in stereo audio. +</p> +<p>This filter accepts stereo input and produce surround (3.0) channels output. +The newly produced front center channel have enhanced speech dialogue originally +available in both stereo channels. +This filter outputs front left and front right channels same as available in stereo input. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>original</samp></span></dt> +<dd><p>Set the original center factor to keep in front center channel output. +Allowed range is from 0 to 1. Default value is 1. +</p> +</dd> +<dt><span><samp>enhance</samp></span></dt> +<dd><p>Set the dialogue enhance factor to put in front center channel output. +Allowed range is from 0 to 3. Default value is 1. +</p> +</dd> +<dt><span><samp>voice</samp></span></dt> +<dd><p>Set the voice detection factor. +Allowed range is from 2 to 32. Default value is 2. +</p></dd> +</dl> + +<a name="Commands-35"></a> +<h4 class="subsection">8.78.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-35" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-35" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="drmeter"></a> +<h3 class="section">8.79 drmeter<span class="pull-right"><a class="anchor hidden-xs" href="#drmeter" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drmeter" aria-hidden="true">TOC</a></span></h3> +<p>Measure audio dynamic range. +</p> +<p>DR values of 14 and higher is found in very dynamic material. DR of 8 to 13 +is found in transition material. And anything less that 8 have very poor dynamics +and is very compressed. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>length</samp></span></dt> +<dd><p>Set window length in seconds used to split audio into segments of equal length. +Default is 3 seconds. +</p></dd> +</dl> + +<a name="dynaudnorm"></a> +<h3 class="section">8.80 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 "simple" normalization algorithms, the Dynamic Audio +Normalizer *dynamically* re-adjusts the gain factor to the input audio. +This allows for applying extra gain to the "quiet" sections of the audio +while avoiding distortions or clipping the "loud" sections. In other words: +The Dynamic Audio Normalizer will "even out" 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 "dynamic range compressing". It will retain 100% +of the dynamic range *within* each section of the audio file. +</p> +<dl compact="compact"> +<dt><span><samp>framelen, f</samp></span></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 "standard" +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><span><samp>gausssize, g</samp></span></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’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 "traditional" 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><span><samp>peak, p</samp></span></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’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><span><samp>maxgain, m</samp></span></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’s highest magnitude sample. However, the Dynamic Audio Normalizer +additionally bounds the frame’s maximum gain factor by a predetermined +(global) maximum gain factor. This is done in order to avoid excessive gain +factors in "silent" 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 "hard" threshold (i.e. cut off values above the threshold). +Instead, a "sigmoid" threshold function will be applied. This way, the +gain factors will smoothly approach the threshold value, but never exceed that +value. +</p> +</dd> +<dt><span><samp>targetrms, r</samp></span></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 "peak" normalization. +This means that the maximum local gain factor for each frame is defined +(only) by the frame’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’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 "perceived loudness" than +just looking at the signal’s peak magnitude. Consequently, by adjusting all +frames to a constant RMS value, a uniform "perceived loudness" can be +established. If a target RMS value has been specified, a frame’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’s highest magnitude sample, in order to prevent clipping. +</p> +</dd> +<dt><span><samp>coupling, n</samp></span></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 "loudest" channel. +However, in some recordings, it may happen that the volume of the different +channels is uneven, e.g. one channel may be "quieter" 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’s highest magnitude sample. This allows for +harmonizing the volume of the different channels. +</p> +</dd> +<dt><span><samp>correctdc, c</samp></span></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 "waveform", 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 "DC correction" offset, of each input frame and subtract +that value from all of the frame’s sample values which ensures those samples +are centered around 0.0 again. Also, in order to avoid "gaps" at the frame +boundaries, the DC correction offset values will be interpolated smoothly +between neighbouring frames. +</p> +</dd> +<dt><span><samp>altboundary, b</samp></span></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 "boundary" 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 "boundary" 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 "fade in" and +"fade out" at the beginning and at the end of the input, respectively. +</p> +</dd> +<dt><span><samp>compress, s</samp></span></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 "traditional" +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’s +normalization algorithm with a more "traditional" 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> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set the target threshold value. This specifies the lowest permissible +magnitude level for the audio input which will be normalized. +If input frame volume is above this value frame will be normalized. +Otherwise frame may not be normalized at all. The default value is set +to 0, which means all input frames will be normalized. +This option is mostly useful if digital noise is not wanted to be amplified. +</p> +</dd> +<dt><span><samp>channels, h</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available channels are filtered. +</p> +</dd> +<dt><span><samp>overlap, o</samp></span></dt> +<dd><p>Specify overlap for frames. If set to 0 (default) no frame overlapping is done. +Using >0 and <1 values will make less conservative gain adjustments, like +when framelen option is set to smaller value, if framelen option value is +compensated for non-zero overlap then gain adjustments will be smoother across time +compared to zero overlap case. +</p> +</dd> +<dt><span><samp>curve, v</samp></span></dt> +<dd><p>Specify the peak mapping curve expression which is going to be used when calculating +gain applied to frames. The max output frame gain will still be limited by other +options mentioned previously for this filter. +</p> +<p>The expression can contain the following constants: +</p> +<dl compact="compact"> +<dt><span><samp>ch</samp></span></dt> +<dd><p>current channel number +</p> +</dd> +<dt><span><samp>sn</samp></span></dt> +<dd><p>current sample number +</p> +</dd> +<dt><span><samp>nb_channels</samp></span></dt> +<dd><p>number of channels +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>timestamp expressed in seconds +</p> +</dd> +<dt><span><samp>sr</samp></span></dt> +<dd><p>sample rate +</p> +</dd> +<dt><span><samp>p</samp></span></dt> +<dd><p>current frame peak value +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-36"></a> +<h4 class="subsection">8.80.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-36" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-36" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="earwax"></a> +<h3 class="section">8.81 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 ‘cues’ 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">8.82 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’s central frequency in Hz. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Specify the band-width of a filter in width_type units. +</p> +</dd> +<dt><span><samp>gain, g</samp></span></dt> +<dd><p>Set the required gain or attenuation in dB. +Beware of clipping when using a positive gain. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Examples-23"></a> +<h4 class="subsection">8.82.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> Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz: +<div class="example"> +<pre class="example">equalizer=f=1000:t=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:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5 +</pre></div> +</li></ul> + +<a name="Commands-37"></a> +<h4 class="subsection">8.82.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-37" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-37" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change equalizer frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change equalizer width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change equalizer width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>gain, g</samp></span></dt> +<dd><p>Change equalizer gain. +Syntax for the command is : "<var>gain</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change equalizer mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="extrastereo"></a> +<h3 class="section">8.83 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 "live" effect to playback. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>m</samp></span></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><span><samp>c</samp></span></dt> +<dd><p>Enable clipping. By default is enabled. +</p></dd> +</dl> + +<a name="Commands-38"></a> +<h4 class="subsection">8.83.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-38" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-38" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="firequalizer"></a> +<h3 class="section">8.84 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><span><samp>gain</samp></span></dt> +<dd><p>Set gain curve equation (in dB). The expression can contain variables: +</p><dl compact="compact"> +<dt><span><samp>f</samp></span></dt> +<dd><p>the evaluated frequency +</p></dd> +<dt><span><samp>sr</samp></span></dt> +<dd><p>sample rate +</p></dd> +<dt><span><samp>ch</samp></span></dt> +<dd><p>channel number, set to 0 when multichannels evaluation is disabled +</p></dd> +<dt><span><samp>chid</samp></span></dt> +<dd><p>channel id, see libavutil/channel_layout.h, set to the first channel id when +multichannels evaluation is disabled +</p></dd> +<dt><span><samp>chs</samp></span></dt> +<dd><p>number of channels +</p></dd> +<dt><span><samp>chlayout</samp></span></dt> +<dd><p>channel_layout, see libavutil/channel_layout.h +</p> +</dd> +</dl> +<p>and functions: +</p><dl compact="compact"> +<dt><span><samp>gain_interpolate(f)</samp></span></dt> +<dd><p>interpolate gain on frequency f based on gain_entry +</p></dd> +<dt><span><samp>cubic_interpolate(f)</samp></span></dt> +<dd><p>same as gain_interpolate, but smoother +</p></dd> +</dl> +<p>This option is also available as command. Default is <code>gain_interpolate(f)</code>. +</p> +</dd> +<dt><span><samp>gain_entry</samp></span></dt> +<dd><p>Set gain entry for gain_interpolate function. The expression can +contain functions: +</p><dl compact="compact"> +<dt><span><samp>entry(f, g)</samp></span></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><span><samp>delay</samp></span></dt> +<dd><p>Set filter delay in seconds. Higher value means more accurate. +Default is <code>0.01</code>. +</p> +</dd> +<dt><span><samp>accuracy</samp></span></dt> +<dd><p>Set filter accuracy in Hz. Lower value means more accurate. +Default is <code>5</code>. +</p> +</dd> +<dt><span><samp>wfunc</samp></span></dt> +<dd><p>Set window function. Acceptable values are: +</p><dl compact="compact"> +<dt><span><samp>rectangular</samp></span></dt> +<dd><p>rectangular window, useful when gain curve is already smooth +</p></dd> +<dt><span><samp>hann</samp></span></dt> +<dd><p>hann window (default) +</p></dd> +<dt><span><samp>hamming</samp></span></dt> +<dd><p>hamming window +</p></dd> +<dt><span><samp>blackman</samp></span></dt> +<dd><p>blackman window +</p></dd> +<dt><span><samp>nuttall3</samp></span></dt> +<dd><p>3-terms continuous 1st derivative nuttall window +</p></dd> +<dt><span><samp>mnuttall3</samp></span></dt> +<dd><p>minimum 3-terms discontinuous nuttall window +</p></dd> +<dt><span><samp>nuttall</samp></span></dt> +<dd><p>4-terms continuous 1st derivative nuttall window +</p></dd> +<dt><span><samp>bnuttall</samp></span></dt> +<dd><p>minimum 4-terms discontinuous nuttall (blackman-nuttall) window +</p></dd> +<dt><span><samp>bharris</samp></span></dt> +<dd><p>blackman-harris window +</p></dd> +<dt><span><samp>tukey</samp></span></dt> +<dd><p>tukey window +</p></dd> +</dl> + +</dd> +<dt><span><samp>fixed</samp></span></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><span><samp>multi</samp></span></dt> +<dd><p>Enable multichannels evaluation on gain. Default is disabled. +</p> +</dd> +<dt><span><samp>zero_phase</samp></span></dt> +<dd><p>Enable zero phase mode by subtracting timestamp to compensate delay. +Default is disabled. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set scale used by gain. Acceptable values are: +</p><dl compact="compact"> +<dt><span><samp>linlin</samp></span></dt> +<dd><p>linear frequency, linear gain +</p></dd> +<dt><span><samp>linlog</samp></span></dt> +<dd><p>linear frequency, logarithmic (in dB) gain (default) +</p></dd> +<dt><span><samp>loglin</samp></span></dt> +<dd><p>logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain +</p></dd> +<dt><span><samp>loglog</samp></span></dt> +<dd><p>logarithmic frequency, logarithmic gain +</p></dd> +</dl> + +</dd> +<dt><span><samp>dumpfile</samp></span></dt> +<dd><p>Set file for dumping, suitable for gnuplot. +</p> +</dd> +<dt><span><samp>dumpscale</samp></span></dt> +<dd><p>Set scale for dumpfile. Acceptable values are same with scale option. +Default is linlog. +</p> +</dd> +<dt><span><samp>fft2</samp></span></dt> +<dd><p>Enable 2-channel convolution using complex FFT. This improves speed significantly. +Default is disabled. +</p> +</dd> +<dt><span><samp>min_phase</samp></span></dt> +<dd><p>Enable minimum phase impulse response. Default is disabled. +</p></dd> +</dl> + +<a name="Examples-24"></a> +<h4 class="subsection">8.84.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> 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">8.85 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><span><samp>delay</samp></span></dt> +<dd><p>Set base delay in milliseconds. Range from 0 to 30. Default value is 0. +</p> +</dd> +<dt><span><samp>depth</samp></span></dt> +<dd><p>Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2. +</p> +</dd> +<dt><span><samp>regen</samp></span></dt> +<dd><p>Set percentage regeneration (delayed signal feedback). Range from -95 to 95. +Default value is 0. +</p> +</dd> +<dt><span><samp>width</samp></span></dt> +<dd><p>Set percentage of delayed signal mixed with original. Range from 0 to 100. +Default value is 71. +</p> +</dd> +<dt><span><samp>speed</samp></span></dt> +<dd><p>Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5. +</p> +</dd> +<dt><span><samp>shape</samp></span></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><span><samp>phase</samp></span></dt> +<dd><p>Set swept wave percentage-shift for multi channel. Range from 0 to 100. +Default value is 25. +</p> +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Set delay-line interpolation, <var>linear</var> or <var>quadratic</var>. +Default is <var>linear</var>. +</p></dd> +</dl> + +<a name="haas"></a> +<h3 class="section">8.86 haas<span class="pull-right"><a class="anchor hidden-xs" href="#haas" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-haas" aria-hidden="true">TOC</a></span></h3> +<p>Apply Haas effect to audio. +</p> +<p>Note that this makes most sense to apply on mono signals. +With this filter applied to mono signals it give some directionality and +stretches its stereo image. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>level_in</samp></span></dt> +<dd><p>Set input level. By default is <var>1</var>, or 0dB +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output level. By default is <var>1</var>, or 0dB. +</p> +</dd> +<dt><span><samp>side_gain</samp></span></dt> +<dd><p>Set gain applied to side part of signal. By default is <var>1</var>. +</p> +</dd> +<dt><span><samp>middle_source</samp></span></dt> +<dd><p>Set kind of middle source. Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>left</samp>’</span></dt> +<dd><p>Pick left channel. +</p> +</dd> +<dt><span>‘<samp>right</samp>’</span></dt> +<dd><p>Pick right channel. +</p> +</dd> +<dt><span>‘<samp>mid</samp>’</span></dt> +<dd><p>Pick middle part signal of stereo image. +</p> +</dd> +<dt><span>‘<samp>side</samp>’</span></dt> +<dd><p>Pick side part signal of stereo image. +</p></dd> +</dl> + +</dd> +<dt><span><samp>middle_phase</samp></span></dt> +<dd><p>Change middle phase. By default is disabled. +</p> +</dd> +<dt><span><samp>left_delay</samp></span></dt> +<dd><p>Set left channel delay. By default is <var>2.05</var> milliseconds. +</p> +</dd> +<dt><span><samp>left_balance</samp></span></dt> +<dd><p>Set left channel balance. By default is <var>-1</var>. +</p> +</dd> +<dt><span><samp>left_gain</samp></span></dt> +<dd><p>Set left channel gain. By default is <var>1</var>. +</p> +</dd> +<dt><span><samp>left_phase</samp></span></dt> +<dd><p>Change left phase. By default is disabled. +</p> +</dd> +<dt><span><samp>right_delay</samp></span></dt> +<dd><p>Set right channel delay. By defaults is <var>2.12</var> milliseconds. +</p> +</dd> +<dt><span><samp>right_balance</samp></span></dt> +<dd><p>Set right channel balance. By default is <var>1</var>. +</p> +</dd> +<dt><span><samp>right_gain</samp></span></dt> +<dd><p>Set right channel gain. By default is <var>1</var>. +</p> +</dd> +<dt><span><samp>right_phase</samp></span></dt> +<dd><p>Change right phase. By default is enabled. +</p></dd> +</dl> + +<a name="hdcd"></a> +<h3 class="section">8.87 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 -c:a pcm_s24le OUT24.wav +</pre></div> + +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>disable_autoconvert</samp></span></dt> +<dd><p>Disable any automatic format conversion or resampling in the filter graph. +</p> +</dd> +<dt><span><samp>process_stereo</samp></span></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><span><samp>cdt_ms</samp></span></dt> +<dd><p>Set the code detect timer period in ms. +</p> +</dd> +<dt><span><samp>force_pe</samp></span></dt> +<dd><p>Always extend peaks above -3dBFS even if PE isn’t signaled. +</p> +</dd> +<dt><span><samp>analyze_mode</samp></span></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><span>‘<samp>0, off</samp>’</span></dt> +<dd><p>Disabled +</p></dd> +<dt><span>‘<samp>1, lle</samp>’</span></dt> +<dd><p>Gain adjustment level at each sample +</p></dd> +<dt><span>‘<samp>2, pe</samp>’</span></dt> +<dd><p>Samples where peak extend occurs +</p></dd> +<dt><span>‘<samp>3, cdt</samp>’</span></dt> +<dd><p>Samples where the code detect timer is active +</p></dd> +<dt><span>‘<samp>4, tgm</samp>’</span></dt> +<dd><p>Samples where the target gain does not match between channels +</p></dd> +</dl> +</dd> +</dl> + +<a name="headphone"></a> +<h3 class="section">8.88 headphone<span class="pull-right"><a class="anchor hidden-xs" href="#headphone" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-headphone" aria-hidden="true">TOC</a></span></h3> + +<p>Apply head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones. +The HRIRs are provided via additional streams, for each channel +one stereo input stream is needed. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>map</samp></span></dt> +<dd><p>Set mapping of input streams for convolution. +The argument is a ’|’-separated list of channel names in order as they +are given as additional stream inputs for filter. +This also specify number of input streams. Number of input streams +must be not less than number of channels in first stream plus one. +</p> +</dd> +<dt><span><samp>gain</samp></span></dt> +<dd><p>Set gain applied to audio. Value is in dB. Default is 0. +</p> +</dd> +<dt><span><samp>type</samp></span></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><span><samp>lfe</samp></span></dt> +<dd><p>Set custom gain for LFE channels. Value is in dB. Default is 0. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set size of frame in number of samples which will be processed at once. +Default value is <var>1024</var>. Allowed range is from 1024 to 96000. +</p> +</dd> +<dt><span><samp>hrir</samp></span></dt> +<dd><p>Set format of hrir stream. +Default value is <var>stereo</var>. Alternative value is <var>multich</var>. +If value is set to <var>stereo</var>, number of additional streams should +be greater or equal to number of input channels in first input stream. +Also each additional stream should have stereo number of channels. +If value is set to <var>multich</var>, number of additional streams should +be exactly one. Also number of input channels of additional stream +should be equal or greater than twice number of channels of first input +stream. +</p></dd> +</dl> + +<a name="Examples-25"></a> +<h4 class="subsection">8.88.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> Full example using wav files as coefficients with amovie filters for 7.1 downmix, +each amovie filter use stereo file with IR coefficients as input. +The files give coefficients for each position of virtual loudspeaker: +<div class="example"> +<pre class="example">ffmpeg -i input.wav +-filter_complex "amovie=azi_270_ele_0_DFC.wav[sr];amovie=azi_90_ele_0_DFC.wav[sl];amovie=azi_225_ele_0_DFC.wav[br];amovie=azi_135_ele_0_DFC.wav[bl];amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe];amovie=azi_35_ele_0_DFC.wav[fl];amovie=azi_325_ele_0_DFC.wav[fr];[0:a][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR" +output.wav +</pre></div> + +</li><li> Full example using wav files as coefficients with amovie filters for 7.1 downmix, +but now in <var>multich</var> <var>hrir</var> format. +<div class="example"> +<pre class="example">ffmpeg -i input.wav -filter_complex "amovie=minp.wav[hrirs];[0:a][hrirs]headphone=map=FL|FR|FC|LFE|BL|BR|SL|SR:hrir=multich" +output.wav +</pre></div> +</li></ul> + +<a name="highpass"></a> +<h3 class="section">8.89 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set frequency in Hz. Default is 3000. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set number of poles. Default is 2. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></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> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-39"></a> +<h4 class="subsection">8.89.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-39" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-39" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change highpass frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change highpass width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change highpass width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change highpass mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="join"></a> +<h3 class="section">8.90 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><span><samp>inputs</samp></span></dt> +<dd><p>The number of input streams. It defaults to 2. +</p> +</dd> +<dt><span><samp>channel_layout</samp></span></dt> +<dd><p>The desired output channel layout. It defaults to stereo. +</p> +</dd> +<dt><span><samp>map</samp></span></dt> +<dd><p>Map channels from inputs to output. The argument is a ’|’-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">8.91 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’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><span><samp>file, f</samp></span></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><span><samp>plugin, p</samp></span></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><span><samp>controls, c</samp></span></dt> +<dd><p>Set the ’|’ 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><span><samp>sample_rate, s</samp></span></dt> +<dd><p>Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></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><span><samp>duration, d</samp></span></dt> +<dd><p>Set the minimum duration of the sourced audio. See +<a data-manual="ffmpeg-utils" 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> +<dt><span><samp>latency, l</samp></span></dt> +<dd><p>Enable latency compensation, by default is disabled. +Only used if plugin have inputs. +</p></dd> +</dl> + +<a name="Examples-26"></a> +<h4 class="subsection">8.91.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> 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’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><li> Reduce stereo image using <code>Narrower</code> from the <code>C* Audio Plugin Suite</code> +(CAPS) library: +<div class="example"> +<pre class="example">ladspa=caps:Narrower +</pre></div> + +</li><li> Another white noise, now using <code>C* Audio Plugin Suite</code> (CAPS) library: +<div class="example"> +<pre class="example">ladspa=caps:White:.2 +</pre></div> + +</li><li> Some fractal noise, using <code>C* Audio Plugin Suite</code> (CAPS) library: +<div class="example"> +<pre class="example">ladspa=caps:Fractal:c=c1=1 +</pre></div> + +</li><li> Dynamic volume normalization using <code>VLevel</code> plugin: +<div class="example"> +<pre class="example">ladspa=vlevel-ladspa:vlevel_mono +</pre></div> +</li></ul> + +<a name="Commands-40"></a> +<h4 class="subsection">8.91.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-40" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-40" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>cN</samp></span></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">8.92 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. In dynamic mode, to accurately +detect true peaks, the audio stream will be upsampled to 192 kHz. +Use the <code>-ar</code> option or <code>aresample</code> filter to explicitly set an output sample rate. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>I, i</samp></span></dt> +<dd><p>Set integrated loudness target. +Range is -70.0 - -5.0. Default value is -24.0. +</p> +</dd> +<dt><span><samp>LRA, lra</samp></span></dt> +<dd><p>Set loudness range target. +Range is 1.0 - 50.0. Default value is 7.0. +</p> +</dd> +<dt><span><samp>TP, tp</samp></span></dt> +<dd><p>Set maximum true peak. +Range is -9.0 - +0.0. Default value is -2.0. +</p> +</dd> +<dt><span><samp>measured_I, measured_i</samp></span></dt> +<dd><p>Measured IL of input file. +Range is -99.0 - +0.0. +</p> +</dd> +<dt><span><samp>measured_LRA, measured_lra</samp></span></dt> +<dd><p>Measured LRA of input file. +Range is 0.0 - 99.0. +</p> +</dd> +<dt><span><samp>measured_TP, measured_tp</samp></span></dt> +<dd><p>Measured true peak of input file. +Range is -99.0 - +99.0. +</p> +</dd> +<dt><span><samp>measured_thresh</samp></span></dt> +<dd><p>Measured threshold of input file. +Range is -99.0 - +0.0. +</p> +</dd> +<dt><span><samp>offset</samp></span></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><span><samp>linear</samp></span></dt> +<dd><p>Normalize by linearly scaling the source audio. +<code>measured_I</code>, <code>measured_LRA</code>, <code>measured_TP</code>, +and <code>measured_thresh</code> must all be specified. Target LRA shouldn’t +be lower than source LRA and the change in integrated loudness shouldn’t +result in a true peak which exceeds the target TP. If any of these +conditions aren’t met, normalization mode will revert to <var>dynamic</var>. +Options are <code>true</code> or <code>false</code>. Default is <code>true</code>. +</p> +</dd> +<dt><span><samp>dual_mono</samp></span></dt> +<dd><p>Treat mono input files as "dual-mono". 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><span><samp>print_format</samp></span></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">8.93 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set frequency in Hz. Default is 500. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set number of poles. Default is 2. +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></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> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Examples-27"></a> +<h4 class="subsection">8.93.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> Lowpass only LFE channel, it LFE is not present it does nothing: +<div class="example"> +<pre class="example">lowpass=c=LFE +</pre></div> +</li></ul> + +<a name="Commands-41"></a> +<h4 class="subsection">8.93.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-41" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-41" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change lowpass frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change lowpass width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change lowpass width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change lowpass mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="lv2"></a> +<h3 class="section">8.94 lv2<span class="pull-right"><a class="anchor hidden-xs" href="#lv2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lv2" aria-hidden="true">TOC</a></span></h3> + +<p>Load a LV2 (LADSPA Version 2) plugin. +</p> +<p>To enable compilation of this filter you need to configure FFmpeg with +<code>--enable-lv2</code>. +</p> +<dl compact="compact"> +<dt><span><samp>plugin, p</samp></span></dt> +<dd><p>Specifies the plugin URI. You may need to escape ’:’. +</p> +</dd> +<dt><span><samp>controls, c</samp></span></dt> +<dd><p>Set the ’|’ 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). +If <samp>controls</samp> is set to <code>help</code>, all available controls and +their valid ranges are printed. +</p> +</dd> +<dt><span><samp>sample_rate, s</samp></span></dt> +<dd><p>Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></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><span><samp>duration, d</samp></span></dt> +<dd><p>Set the minimum duration of the sourced audio. See +<a data-manual="ffmpeg-utils" 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-28"></a> +<h4 class="subsection">8.94.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> Apply bass enhancer plugin from Calf: +<div class="example"> +<pre class="example">lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2 +</pre></div> + +</li><li> Apply vinyl plugin from Calf: +<div class="example"> +<pre class="example">lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5 +</pre></div> + +</li><li> Apply bit crusher plugin from ArtyFX: +<div class="example"> +<pre class="example">lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3 +</pre></div> +</li></ul> + +<a name="Commands-42"></a> +<h4 class="subsection">8.94.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-42" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-42" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports all options that are exported by plugin as commands. +</p> +<a name="mcompand"></a> +<h3 class="section">8.95 mcompand<span class="pull-right"><a class="anchor hidden-xs" href="#mcompand" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mcompand" aria-hidden="true">TOC</a></span></h3> +<p>Multiband Compress or expand the audio’s dynamic range. +</p> +<p>The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. +This is akin to the crossover of a loudspeaker, and results in flat frequency +response when absent compander action. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>args</samp></span></dt> +<dd><p>This option syntax is: +attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... +For explanation of each item refer to compand filter documentation. +</p></dd> +</dl> + +<span id="pan"></span><a name="pan-1"></a> +<h3 class="section">8.96 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: +"<var>l</var>|<var>outdef</var>|<var>outdef</var>|..." +</p> +<dl compact="compact"> +<dt><span><samp>l</samp></span></dt> +<dd><p>output channel layout or number of channels +</p> +</dd> +<dt><span><samp>outdef</samp></span></dt> +<dd><p>output channel specification, of the form: +"<var>out_name</var>=[<var>gain</var>*]<var>in_name</var>[(+-)[<var>gain</var>*]<var>in_name</var>...]" +</p> +</dd> +<dt><span><samp>out_name</samp></span></dt> +<dd><p>output channel to define, either a channel name (FL, FR, etc.) or a channel +number (c0, c1, etc.) +</p> +</dd> +<dt><span><samp>gain</samp></span></dt> +<dd><p>multiplicative coefficient for the channel, 1 leaving the volume unchanged +</p> +</dd> +<dt><span><samp>in_name</samp></span></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 ‘=’ in a channel specification is replaced by ‘<’, 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">8.96.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 < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < 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 "-ac" option) unless you have very specific +needs. +</p> +<a name="Remapping-examples"></a> +<h4 class="subsection">8.96.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 ("Pure +channel mapping detected"), 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="stereo| c0=FL | c1=FR" +</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="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5" +</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="stereo|c1=c1" +</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="stereo| c0=FR | c1=FR" +</pre></div> + +<a name="replaygain"></a> +<h3 class="section">8.97 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">8.98 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">8.99 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>To enable compilation of this filter, you need to configure FFmpeg with +<code>--enable-librubberband</code>. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>tempo</samp></span></dt> +<dd><p>Set tempo scale factor. +</p> +</dd> +<dt><span><samp>pitch</samp></span></dt> +<dd><p>Set pitch scale factor. +</p> +</dd> +<dt><span><samp>transients</samp></span></dt> +<dd><p>Set transients detector. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>crisp</var></span></dt> +<dt><span><var>mixed</var></span></dt> +<dt><span><var>smooth</var></span></dt> +</dl> + +</dd> +<dt><span><samp>detector</samp></span></dt> +<dd><p>Set detector. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>compound</var></span></dt> +<dt><span><var>percussive</var></span></dt> +<dt><span><var>soft</var></span></dt> +</dl> + +</dd> +<dt><span><samp>phase</samp></span></dt> +<dd><p>Set phase. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>laminar</var></span></dt> +<dt><span><var>independent</var></span></dt> +</dl> + +</dd> +<dt><span><samp>window</samp></span></dt> +<dd><p>Set processing window size. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>standard</var></span></dt> +<dt><span><var>short</var></span></dt> +<dt><span><var>long</var></span></dt> +</dl> + +</dd> +<dt><span><samp>smoothing</samp></span></dt> +<dd><p>Set smoothing. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>off</var></span></dt> +<dt><span><var>on</var></span></dt> +</dl> + +</dd> +<dt><span><samp>formant</samp></span></dt> +<dd><p>Enable formant preservation when shift pitching. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>shifted</var></span></dt> +<dt><span><var>preserved</var></span></dt> +</dl> + +</dd> +<dt><span><samp>pitchq</samp></span></dt> +<dd><p>Set pitch quality. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>quality</var></span></dt> +<dt><span><var>speed</var></span></dt> +<dt><span><var>consistency</var></span></dt> +</dl> + +</dd> +<dt><span><samp>channels</samp></span></dt> +<dd><p>Set channels. +Possible values are: +</p><dl compact="compact"> +<dt><span><var>apart</var></span></dt> +<dt><span><var>together</var></span></dt> +</dl> +</dd> +</dl> + +<a name="Commands-43"></a> +<h4 class="subsection">8.99.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-43" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-43" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>tempo</samp></span></dt> +<dd><p>Change filter tempo scale factor. +Syntax for the command is : "<var>tempo</var>" +</p> +</dd> +<dt><span><samp>pitch</samp></span></dt> +<dd><p>Change filter pitch scale factor. +Syntax for the command is : "<var>pitch</var>" +</p></dd> +</dl> + +<a name="sidechaincompress"></a> +<h3 class="section">8.100 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set mode of compressor operation. Can be <code>upward</code> or <code>downward</code>. +Default is <code>downward</code>. +</p> +</dd> +<dt><span><samp>threshold</samp></span></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><span><samp>ratio</samp></span></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><span><samp>attack</samp></span></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><span><samp>release</samp></span></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><span><samp>makeup</samp></span></dt> +<dd><p>Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +</p> +</dd> +<dt><span><samp>knee</samp></span></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><span><samp>link</samp></span></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><span><samp>detection</samp></span></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><span><samp>level_sc</samp></span></dt> +<dd><p>Set sidechain gain. Default is 1. Range is between 0.015625 and 64. +</p> +</dd> +<dt><span><samp>mix</samp></span></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="Commands-44"></a> +<h4 class="subsection">8.100.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-44" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-44" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-29"></a> +<h4 class="subsection">8.100.2 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> 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 "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge" +</pre></div> +</li></ul> + +<a name="sidechaingate"></a> +<h3 class="section">8.101 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 "rumbling" 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set the mode of operation. Can be <code>upward</code> or <code>downward</code>. +Default is <code>downward</code>. If set to <code>upward</code> mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of <code>downward</code> lower parts of signal will be reduced. +</p> +</dd> +<dt><span><samp>range</samp></span></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. +Setting this to 0 disables reduction and then filter behaves like expander. +</p> +</dd> +<dt><span><samp>threshold</samp></span></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><span><samp>ratio</samp></span></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><span><samp>attack</samp></span></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><span><samp>release</samp></span></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><span><samp>makeup</samp></span></dt> +<dd><p>Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +</p> +</dd> +<dt><span><samp>knee</samp></span></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><span><samp>detection</samp></span></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><span><samp>link</samp></span></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><span><samp>level_sc</samp></span></dt> +<dd><p>Set sidechain gain. Default is 1. Range is from 0.015625 to 64. +</p></dd> +</dl> + +<a name="Commands-45"></a> +<h4 class="subsection">8.101.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-45" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-45" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="silencedetect"></a> +<h3 class="section">8.102 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. The +<code>lavfi.silence_start</code> or <code>lavfi.silence_start.X</code> metadata key +is set on the first frame whose timestamp equals or exceeds the detection +duration and it contains the timestamp of the first frame of the silence. +</p> +<p>The <code>lavfi.silence_duration</code> or <code>lavfi.silence_duration.X</code> +and <code>lavfi.silence_end</code> or <code>lavfi.silence_end.X</code> metadata +keys are set on the first frame after the silence. If <samp>mono</samp> is +enabled, and each channel is evaluated separately, the <code>.X</code> +suffixed keys are used, and <code>X</code> corresponds to the channel number. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>noise, n</samp></span></dt> +<dd><p>Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or amplitude ratio. Default is -60dB, or 0.001. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set silence duration until notification (default is 2 seconds). See +<a data-manual="ffmpeg-utils" 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> +</dd> +<dt><span><samp>mono, m</samp></span></dt> +<dd><p>Process each channel separately, instead of combined. By default is disabled. +</p></dd> +</dl> + +<a name="Examples-30"></a> +<h4 class="subsection">8.102.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> 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">8.103 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><span><samp>start_periods</samp></span></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><span><samp>start_duration</samp></span></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><span><samp>start_threshold</samp></span></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 "dB" is appended to the specified value) +or amplitude ratio. Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>start_silence</samp></span></dt> +<dd><p>Specify max duration of silence at beginning that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +</p> +</dd> +<dt><span><samp>start_mode</samp></span></dt> +<dd><p>Specify mode of detection of silence end in start of multi-channel audio. +Can be <var>any</var> or <var>all</var>. Default is <var>any</var>. +With <var>any</var>, any sample that is detected as non-silence will cause +stopped trimming of silence. +With <var>all</var>, only if all channels are detected as non-silence will cause +stopped trimming of silence. +</p> +</dd> +<dt><span><samp>stop_periods</samp></span></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><span><samp>stop_duration</samp></span></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><span><samp>stop_threshold</samp></span></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 "dB" is appended to the specified value) +or amplitude ratio. Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>stop_silence</samp></span></dt> +<dd><p>Specify max duration of silence at end that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +</p> +</dd> +<dt><span><samp>stop_mode</samp></span></dt> +<dd><p>Specify mode of detection of silence start in end of multi-channel audio. +Can be <var>any</var> or <var>all</var>. Default is <var>any</var>. +With <var>any</var>, any sample that is detected as non-silence will cause +stopped trimming of silence. +With <var>all</var>, only if all channels are detected as non-silence will cause +stopped trimming of silence. +</p> +</dd> +<dt><span><samp>detection</samp></span></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><span><samp>window</samp></span></dt> +<dd><p>Set duration in number of seconds used to calculate size of window in number +of samples 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-31"></a> +<h4 class="subsection">8.103.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> 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=start_periods=1:start_duration=5:start_threshold=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=stop_periods=-1:stop_duration=1:stop_threshold=-90dB +</pre></div> + +</li><li> Trim all digital silence samples, using peak detection, from beginning to end +where there is more than 0 samples of digital silence in audio and digital +silence is detected in all channels at same positions in stream: +<div class="example"> +<pre class="example">silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0 +</pre></div> +</li></ul> + +<a name="sofalizer"></a> +<h3 class="section">8.104 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-libmysofa</code>. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>sofa</samp></span></dt> +<dd><p>Set the SOFA file used for rendering. +</p> +</dd> +<dt><span><samp>gain</samp></span></dt> +<dd><p>Set gain applied to audio. Value is in dB. Default is 0. +</p> +</dd> +<dt><span><samp>rotation</samp></span></dt> +<dd><p>Set rotation of virtual loudspeakers in deg. Default is 0. +</p> +</dd> +<dt><span><samp>elevation</samp></span></dt> +<dd><p>Set elevation of virtual speakers in deg. Default is 0. +</p> +</dd> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set distance in meters between loudspeakers and the listener with near-field +HRTFs. Default is 1. +</p> +</dd> +<dt><span><samp>type</samp></span></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><span><samp>speakers</samp></span></dt> +<dd><p>Set custom positions of virtual loudspeakers. Syntax for this option is: +<CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...]. +Each virtual loudspeaker is described with short channel name following with +azimuth and elevation in degrees. +Each virtual loudspeaker description is separated by ’|’. +For example to override front left and front right channel positions use: +’speakers=FL 45 15|FR 345 15’. +Descriptions with unrecognised channel names are ignored. +</p> +</dd> +<dt><span><samp>lfegain</samp></span></dt> +<dd><p>Set custom gain for LFE channels. Value is in dB. Default is 0. +</p> +</dd> +<dt><span><samp>framesize</samp></span></dt> +<dd><p>Set custom frame size in number of samples. Default is 1024. +Allowed range is from 1024 to 96000. Only used if option ‘<samp>type</samp>’ +is set to <var>freq</var>. +</p> +</dd> +<dt><span><samp>normalize</samp></span></dt> +<dd><p>Should all IRs be normalized upon importing SOFA file. +By default is enabled. +</p> +</dd> +<dt><span><samp>interpolate</samp></span></dt> +<dd><p>Should nearest IRs be interpolated with neighbor IRs if exact position +does not match. By default is disabled. +</p> +</dd> +<dt><span><samp>minphase</samp></span></dt> +<dd><p>Minphase all IRs upon loading of SOFA file. By default is disabled. +</p> +</dd> +<dt><span><samp>anglestep</samp></span></dt> +<dd><p>Set neighbor search angle step. Only used if option <var>interpolate</var> is enabled. +</p> +</dd> +<dt><span><samp>radstep</samp></span></dt> +<dd><p>Set neighbor search radius step. Only used if option <var>interpolate</var> is enabled. +</p></dd> +</dl> + +<a name="Examples-32"></a> +<h4 class="subsection">8.104.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> 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, back left and back right +and also with custom gain: +<div class="example"> +<pre class="example">"sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28" +</pre></div> +</li></ul> + +<a name="speechnorm"></a> +<h3 class="section">8.105 speechnorm<span class="pull-right"><a class="anchor hidden-xs" href="#speechnorm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-speechnorm" aria-hidden="true">TOC</a></span></h3> +<p>Speech Normalizer. +</p> +<p>This filter expands or compresses each half-cycle of audio samples +(local set of samples all above or all below zero and between two nearest zero crossings) depending +on threshold value, so audio reaches target peak value under conditions controlled by below options. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>peak, p</samp></span></dt> +<dd><p>Set the expansion target peak value. This specifies the highest allowed absolute amplitude +level for the normalized audio input. Default value is 0.95. Allowed range is from 0.0 to 1.0. +</p> +</dd> +<dt><span><samp>expansion, e</samp></span></dt> +<dd><p>Set the maximum expansion factor. Allowed range is from 1.0 to 50.0. Default value is 2.0. +This option controls maximum local half-cycle of samples expansion. The maximum expansion +would be such that local peak value reaches target peak value but never to surpass it and that +ratio between new and previous peak value does not surpass this option value. +</p> +</dd> +<dt><span><samp>compression, c</samp></span></dt> +<dd><p>Set the maximum compression factor. Allowed range is from 1.0 to 50.0. Default value is 2.0. +This option controls maximum local half-cycle of samples compression. This option is used +only if <samp>threshold</samp> option is set to value greater than 0.0, then in such cases +when local peak is lower or same as value set by <samp>threshold</samp> all samples belonging to +that peak’s half-cycle will be compressed by current compression factor. +</p> +</dd> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set the threshold value. Default value is 0.0. Allowed range is from 0.0 to 1.0. +This option specifies which half-cycles of samples will be compressed and which will be expanded. +Any half-cycle samples with their local peak value below or same as this option value will be +compressed by current compression factor, otherwise, if greater than threshold value they will be +expanded with expansion factor so that it could reach peak target value but never surpass it. +</p> +</dd> +<dt><span><samp>raise, r</samp></span></dt> +<dd><p>Set the expansion raising amount per each half-cycle of samples. Default value is 0.001. +Allowed range is from 0.0 to 1.0. This controls how fast expansion factor is raised per +each new half-cycle until it reaches <samp>expansion</samp> value. +Setting this options too high may lead to distortions. +</p> +</dd> +<dt><span><samp>fall, f</samp></span></dt> +<dd><p>Set the compression raising amount per each half-cycle of samples. Default value is 0.001. +Allowed range is from 0.0 to 1.0. This controls how fast compression factor is raised per +each new half-cycle until it reaches <samp>compression</samp> value. +</p> +</dd> +<dt><span><samp>channels, h</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available channels are filtered. +</p> +</dd> +<dt><span><samp>invert, i</samp></span></dt> +<dd><p>Enable inverted filtering, by default is disabled. This inverts interpretation of <samp>threshold</samp> +option. When enabled any half-cycle of samples with their local peak value below or same as +<samp>threshold</samp> option will be expanded otherwise it will be compressed. +</p> +</dd> +<dt><span><samp>link, l</samp></span></dt> +<dd><p>Link channels when calculating gain applied to each filtered channel sample, by default is disabled. +When disabled each filtered channel gain calculation is independent, otherwise when this option +is enabled the minimum of all possible gains for each filtered channel is used. +</p> +</dd> +<dt><span><samp>rms, m</samp></span></dt> +<dd><p>Set the expansion target RMS value. This specifies the highest allowed RMS level for the normalized +audio input. Default value is 0.0, thus disabled. Allowed range is from 0.0 to 1.0. +</p></dd> +</dl> + +<a name="Commands-46"></a> +<h4 class="subsection">8.105.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-46" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-46" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-33"></a> +<h4 class="subsection">8.105.2 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> Weak and slow amplification: +<div class="example"> +<pre class="example">speechnorm=e=3:r=0.00001:l=1 +</pre></div> + +</li><li> Moderate and slow amplification: +<div class="example"> +<pre class="example">speechnorm=e=6.25:r=0.00001:l=1 +</pre></div> + +</li><li> Strong and fast amplification: +<div class="example"> +<pre class="example">speechnorm=e=12.5:r=0.0001:l=1 +</pre></div> + +</li><li> Very strong and fast amplification: +<div class="example"> +<pre class="example">speechnorm=e=25:r=0.0001:l=1 +</pre></div> + +</li><li> Extreme and fast amplification: +<div class="example"> +<pre class="example">speechnorm=e=50:r=0.0001:l=1 +</pre></div> +</li></ul> + +<a name="stereotools"></a> +<h3 class="section">8.106 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><span><samp>level_in</samp></span></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><span><samp>level_out</samp></span></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><span><samp>balance_in</samp></span></dt> +<dd><p>Set input balance between both channels. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>balance_out</samp></span></dt> +<dd><p>Set output balance between both channels. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>softclip</samp></span></dt> +<dd><p>Enable softclipping. Results in analog distortion instead of harsh digital 0dB +clipping. Disabled by default. +</p> +</dd> +<dt><span><samp>mutel</samp></span></dt> +<dd><p>Mute the left channel. Disabled by default. +</p> +</dd> +<dt><span><samp>muter</samp></span></dt> +<dd><p>Mute the right channel. Disabled by default. +</p> +</dd> +<dt><span><samp>phasel</samp></span></dt> +<dd><p>Change the phase of the left channel. Disabled by default. +</p> +</dd> +<dt><span><samp>phaser</samp></span></dt> +<dd><p>Change the phase of the right channel. Disabled by default. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set stereo mode. Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>lr>lr</samp>’</span></dt> +<dd><p>Left/Right to Left/Right, this is default. +</p> +</dd> +<dt><span>‘<samp>lr>ms</samp>’</span></dt> +<dd><p>Left/Right to Mid/Side. +</p> +</dd> +<dt><span>‘<samp>ms>lr</samp>’</span></dt> +<dd><p>Mid/Side to Left/Right. +</p> +</dd> +<dt><span>‘<samp>lr>ll</samp>’</span></dt> +<dd><p>Left/Right to Left/Left. +</p> +</dd> +<dt><span>‘<samp>lr>rr</samp>’</span></dt> +<dd><p>Left/Right to Right/Right. +</p> +</dd> +<dt><span>‘<samp>lr>l+r</samp>’</span></dt> +<dd><p>Left/Right to Left + Right. +</p> +</dd> +<dt><span>‘<samp>lr>rl</samp>’</span></dt> +<dd><p>Left/Right to Right/Left. +</p> +</dd> +<dt><span>‘<samp>ms>ll</samp>’</span></dt> +<dd><p>Mid/Side to Left/Left. +</p> +</dd> +<dt><span>‘<samp>ms>rr</samp>’</span></dt> +<dd><p>Mid/Side to Right/Right. +</p> +</dd> +<dt><span>‘<samp>ms>rl</samp>’</span></dt> +<dd><p>Mid/Side to Right/Left. +</p> +</dd> +<dt><span>‘<samp>lr>l-r</samp>’</span></dt> +<dd><p>Left/Right to Left - Right. +</p></dd> +</dl> + +</dd> +<dt><span><samp>slev</samp></span></dt> +<dd><p>Set level of side signal. Default is 1. +Allowed range is from 0.015625 to 64. +</p> +</dd> +<dt><span><samp>sbal</samp></span></dt> +<dd><p>Set balance of side signal. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>mlev</samp></span></dt> +<dd><p>Set level of the middle signal. Default is 1. +Allowed range is from 0.015625 to 64. +</p> +</dd> +<dt><span><samp>mpan</samp></span></dt> +<dd><p>Set middle signal pan. Default is 0. Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>base</samp></span></dt> +<dd><p>Set stereo base between mono and inversed channels. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>delay</samp></span></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><span><samp>sclevel</samp></span></dt> +<dd><p>Set S/C level. Default is 1. Allowed range is from 1 to 100. +</p> +</dd> +<dt><span><samp>phase</samp></span></dt> +<dd><p>Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360. +</p> +</dd> +<dt><span><samp>bmode_in, bmode_out</samp></span></dt> +<dd><p>Set balance mode for balance_in/balance_out option. +</p> +<p>Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>balance</samp>’</span></dt> +<dd><p>Classic balance mode. Attenuate one channel at time. +Gain is raised up to 1. +</p> +</dd> +<dt><span>‘<samp>amplitude</samp>’</span></dt> +<dd><p>Similar as classic mode above but gain is raised up to 2. +</p> +</dd> +<dt><span>‘<samp>power</samp>’</span></dt> +<dd><p>Equal power distribution, from -6dB to +6dB range. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-47"></a> +<h4 class="subsection">8.106.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-47" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-47" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-34"></a> +<h4 class="subsection">8.106.2 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">"stereotools=mode=ms>lr" +</pre></div> +</li></ul> + +<a name="stereowiden"></a> +<h3 class="section">8.107 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><span><samp>delay</samp></span></dt> +<dd><p>Time in milliseconds of the delay of left signal into right and vice versa. +Default is 20 milliseconds. +</p> +</dd> +<dt><span><samp>feedback</samp></span></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><span><samp>crossfeed</samp></span></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><span><samp>drymix</samp></span></dt> +<dd><p>Set level of input signal of original channel. Default is 0.8. +</p></dd> +</dl> + +<a name="Commands-48"></a> +<h4 class="subsection">8.107.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-48" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-48" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options except <code>delay</code> as <a href="#commands">commands</a>. +</p> +<a name="superequalizer"></a> +<h3 class="section">8.108 superequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#superequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-superequalizer" aria-hidden="true">TOC</a></span></h3> +<p>Apply 18 band equalizer. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>1b</samp></span></dt> +<dd><p>Set 65Hz band gain. +</p></dd> +<dt><span><samp>2b</samp></span></dt> +<dd><p>Set 92Hz band gain. +</p></dd> +<dt><span><samp>3b</samp></span></dt> +<dd><p>Set 131Hz band gain. +</p></dd> +<dt><span><samp>4b</samp></span></dt> +<dd><p>Set 185Hz band gain. +</p></dd> +<dt><span><samp>5b</samp></span></dt> +<dd><p>Set 262Hz band gain. +</p></dd> +<dt><span><samp>6b</samp></span></dt> +<dd><p>Set 370Hz band gain. +</p></dd> +<dt><span><samp>7b</samp></span></dt> +<dd><p>Set 523Hz band gain. +</p></dd> +<dt><span><samp>8b</samp></span></dt> +<dd><p>Set 740Hz band gain. +</p></dd> +<dt><span><samp>9b</samp></span></dt> +<dd><p>Set 1047Hz band gain. +</p></dd> +<dt><span><samp>10b</samp></span></dt> +<dd><p>Set 1480Hz band gain. +</p></dd> +<dt><span><samp>11b</samp></span></dt> +<dd><p>Set 2093Hz band gain. +</p></dd> +<dt><span><samp>12b</samp></span></dt> +<dd><p>Set 2960Hz band gain. +</p></dd> +<dt><span><samp>13b</samp></span></dt> +<dd><p>Set 4186Hz band gain. +</p></dd> +<dt><span><samp>14b</samp></span></dt> +<dd><p>Set 5920Hz band gain. +</p></dd> +<dt><span><samp>15b</samp></span></dt> +<dd><p>Set 8372Hz band gain. +</p></dd> +<dt><span><samp>16b</samp></span></dt> +<dd><p>Set 11840Hz band gain. +</p></dd> +<dt><span><samp>17b</samp></span></dt> +<dd><p>Set 16744Hz band gain. +</p></dd> +<dt><span><samp>18b</samp></span></dt> +<dd><p>Set 20000Hz band gain. +</p></dd> +</dl> + +<a name="surround"></a> +<h3 class="section">8.109 surround<span class="pull-right"><a class="anchor hidden-xs" href="#surround" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-surround" aria-hidden="true">TOC</a></span></h3> +<p>Apply audio surround upmix filter. +</p> +<p>This filter allows to produce multichannel output from audio stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>chl_out</samp></span></dt> +<dd><p>Set output channel layout. By default, this is <var>5.1</var>. +</p> +<p>See <a data-manual="ffmpeg-utils" 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><span><samp>chl_in</samp></span></dt> +<dd><p>Set input channel layout. By default, this is <var>stereo</var>. +</p> +<p>See <a data-manual="ffmpeg-utils" 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><span><samp>level_in</samp></span></dt> +<dd><p>Set input volume level. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>level_out</samp></span></dt> +<dd><p>Set output volume level. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>lfe</samp></span></dt> +<dd><p>Enable LFE channel output if output channel layout has it. By default, this is enabled. +</p> +</dd> +<dt><span><samp>lfe_low</samp></span></dt> +<dd><p>Set LFE low cut off frequency. By default, this is <var>128</var> Hz. +</p> +</dd> +<dt><span><samp>lfe_high</samp></span></dt> +<dd><p>Set LFE high cut off frequency. By default, this is <var>256</var> Hz. +</p> +</dd> +<dt><span><samp>lfe_mode</samp></span></dt> +<dd><p>Set LFE mode, can be <var>add</var> or <var>sub</var>. Default is <var>add</var>. +In <var>add</var> mode, LFE channel is created from input audio and added to output. +In <var>sub</var> mode, LFE channel is created from input audio and added to output but +also all non-LFE output channels are subtracted with output LFE channel. +</p> +</dd> +<dt><span><samp>smooth</samp></span></dt> +<dd><p>Set temporal smoothness strength, used to gradually change factors when transforming +stereo sound in time. Allowed range is from <var>0.0</var> to <var>1.0</var>. +Useful to improve output quality with <var>focus</var> option values greater than <var>0.0</var>. +Default is <var>0.0</var>. Only values inside this range and without edges are effective. +</p> +</dd> +<dt><span><samp>angle</samp></span></dt> +<dd><p>Set angle of stereo surround transform, Allowed range is from <var>0</var> to <var>360</var>. +Default is <var>90</var>. +</p> +</dd> +<dt><span><samp>focus</samp></span></dt> +<dd><p>Set focus of stereo surround transform, Allowed range is from <var>-1</var> to <var>1</var>. +Default is <var>0</var>. +</p> +</dd> +<dt><span><samp>fc_in</samp></span></dt> +<dd><p>Set front center input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>fc_out</samp></span></dt> +<dd><p>Set front center output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>fl_in</samp></span></dt> +<dd><p>Set front left input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>fl_out</samp></span></dt> +<dd><p>Set front left output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>fr_in</samp></span></dt> +<dd><p>Set front right input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>fr_out</samp></span></dt> +<dd><p>Set front right output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>sl_in</samp></span></dt> +<dd><p>Set side left input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>sl_out</samp></span></dt> +<dd><p>Set side left output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>sr_in</samp></span></dt> +<dd><p>Set side right input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>sr_out</samp></span></dt> +<dd><p>Set side right output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>bl_in</samp></span></dt> +<dd><p>Set back left input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>bl_out</samp></span></dt> +<dd><p>Set back left output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>br_in</samp></span></dt> +<dd><p>Set back right input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>br_out</samp></span></dt> +<dd><p>Set back right output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>bc_in</samp></span></dt> +<dd><p>Set back center input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>bc_out</samp></span></dt> +<dd><p>Set back center output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>lfe_in</samp></span></dt> +<dd><p>Set LFE input volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>lfe_out</samp></span></dt> +<dd><p>Set LFE output volume. By default, this is <var>1</var>. +</p> +</dd> +<dt><span><samp>allx</samp></span></dt> +<dd><p>Set spread usage of stereo image across X axis for all channels. +Allowed range is from <var>-1</var> to <var>15</var>. +By default this value is negative <var>-1</var>, and thus unused. +</p> +</dd> +<dt><span><samp>ally</samp></span></dt> +<dd><p>Set spread usage of stereo image across Y axis for all channels. +Allowed range is from <var>-1</var> to <var>15</var>. +By default this value is negative <var>-1</var>, and thus unused. +</p> +</dd> +<dt><span><samp>fcx, flx, frx, blx, brx, slx, srx, bcx</samp></span></dt> +<dd><p>Set spread usage of stereo image across X axis for each channel. +Allowed range is from <var>0.06</var> to <var>15</var>. +By default this value is <var>0.5</var>. +</p> +</dd> +<dt><span><samp>fcy, fly, fry, bly, bry, sly, sry, bcy</samp></span></dt> +<dd><p>Set spread usage of stereo image across Y axis for each channel. +Allowed range is from <var>0.06</var> to <var>15</var>. +By default this value is <var>0.5</var>. +</p> +</dd> +<dt><span><samp>win_size</samp></span></dt> +<dd><p>Set window size. Allowed range is from <var>1024</var> to <var>65536</var>. Default size is <var>4096</var>. +</p> +</dd> +<dt><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann, hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> +<p>Default is <code>hann</code>. +</p> +</dd> +<dt><span><samp>overlap</samp></span></dt> +<dd><p>Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is <code>0.5</code>. +</p></dd> +</dl> + +<a name="tiltshelf"></a> +<h3 class="section">8.110 tiltshelf<span class="pull-right"><a class="anchor hidden-xs" href="#tiltshelf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tiltshelf" aria-hidden="true">TOC</a></span></h3> + +<p>Boost or cut the lower frequencies and cut or boost higher frequencies +of the audio using a two-pole shelving filter with a response similar to +that of a standard hi-fi’s tone-controls. +This is also known as shelving equalisation (EQ). +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>gain, g</samp></span></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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’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><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Determine how steep is the filter’s shelf transition. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set number of poles. Default is 2. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-49"></a> +<h4 class="subsection">8.110.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-49" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-49" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports some options as <a href="#commands">commands</a>. +</p> +<a name="treble_002c-highshelf"></a> +<h3 class="section">8.111 treble, highshelf<span class="pull-right"><a class="anchor hidden-xs" href="#treble_002c-highshelf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-treble_002c-highshelf" 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’s tone-controls. This is also known as shelving equalisation (EQ). +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>gain, g</samp></span></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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the filter’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><span><samp>width_type, t</samp></span></dt> +<dd><p>Set method to specify band-width of filter. +</p><dl compact="compact"> +<dt><span><samp>h</samp></span></dt> +<dd><p>Hz +</p></dd> +<dt><span><samp>q</samp></span></dt> +<dd><p>Q-Factor +</p></dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>octave +</p></dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>slope +</p></dd> +<dt><span><samp>k</samp></span></dt> +<dd><p>kHz +</p></dd> +</dl> + +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Determine how steep is the filter’s shelf transition. +</p> +</dd> +<dt><span><samp>poles, p</samp></span></dt> +<dd><p>Set number of poles. Default is 2. +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +</p> +</dd> +<dt><span><samp>channels, c</samp></span></dt> +<dd><p>Specify which channels to filter, by default all available are filtered. +</p> +</dd> +<dt><span><samp>normalize, n</samp></span></dt> +<dd><p>Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +</p> +</dd> +<dt><span><samp>transform, a</samp></span></dt> +<dd><p>Set transform type of IIR filter. +</p><dl compact="compact"> +<dt><span><samp>di</samp></span></dt> +<dt><span><samp>dii</samp></span></dt> +<dt><span><samp>tdi</samp></span></dt> +<dt><span><samp>tdii</samp></span></dt> +<dt><span><samp>latt</samp></span></dt> +<dt><span><samp>svf</samp></span></dt> +<dt><span><samp>zdf</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>precision, r</samp></span></dt> +<dd><p>Set precison of filtering. +</p><dl compact="compact"> +<dt><span><samp>auto</samp></span></dt> +<dd><p>Pick automatic sample format depending on surround filters. +</p></dd> +<dt><span><samp>s16</samp></span></dt> +<dd><p>Always use signed 16-bit. +</p></dd> +<dt><span><samp>s32</samp></span></dt> +<dd><p>Always use signed 32-bit. +</p></dd> +<dt><span><samp>f32</samp></span></dt> +<dd><p>Always use float 32-bit. +</p></dd> +<dt><span><samp>f64</samp></span></dt> +<dd><p>Always use float 64-bit. +</p></dd> +</dl> + +</dd> +<dt><span><samp>block_size, b</samp></span></dt> +<dd><p>Set block size used for reverse IIR processing. If this value is set to high enough +value (higher than impulse response length truncated when reaches near zero values) filtering +will become linear phase otherwise if not big enough it will just produce nasty artifacts. +</p> +<p>Note that filter delay will be exactly this many samples when set to non-zero value. +</p></dd> +</dl> + +<a name="Commands-50"></a> +<h4 class="subsection">8.111.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-50" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-50" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Change treble frequency. +Syntax for the command is : "<var>frequency</var>" +</p> +</dd> +<dt><span><samp>width_type, t</samp></span></dt> +<dd><p>Change treble width_type. +Syntax for the command is : "<var>width_type</var>" +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Change treble width. +Syntax for the command is : "<var>width</var>" +</p> +</dd> +<dt><span><samp>gain, g</samp></span></dt> +<dd><p>Change treble gain. +Syntax for the command is : "<var>gain</var>" +</p> +</dd> +<dt><span><samp>mix, m</samp></span></dt> +<dd><p>Change treble mix. +Syntax for the command is : "<var>mix</var>" +</p></dd> +</dl> + +<a name="tremolo"></a> +<h3 class="section">8.112 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><span><samp>f</samp></span></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><span><samp>d</samp></span></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">8.113 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><span><samp>f</samp></span></dt> +<dd><p>Modulation frequency in Hertz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +</p> +</dd> +<dt><span><samp>d</samp></span></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="virtualbass"></a> +<h3 class="section">8.114 virtualbass<span class="pull-right"><a class="anchor hidden-xs" href="#virtualbass" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-virtualbass" aria-hidden="true">TOC</a></span></h3> + +<p>Apply audio Virtual Bass filter. +</p> +<p>This filter accepts stereo input and produce stereo with LFE (2.1) channels output. +The newly produced LFE channel have enhanced virtual bass originally obtained from both stereo channels. +This filter outputs front left and front right channels unchanged as available in stereo input. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>cutoff</samp></span></dt> +<dd><p>Set the virtual bass cutoff frequency. Default value is 250 Hz. +Allowed range is from 100 to 500 Hz. +</p> +</dd> +<dt><span><samp>strength</samp></span></dt> +<dd><p>Set the virtual bass strength. Allowed range is from 0.5 to 3. +Default value is 3. +</p></dd> +</dl> + +<a name="volume"></a> +<h3 class="section">8.115 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><span><samp>volume</samp></span></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 "1.0". +</p> +</dd> +<dt><span><samp>precision</samp></span></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><span><samp>fixed</samp></span></dt> +<dd><p>8-bit fixed-point; this limits input sample format to U8, S16, and S32. +</p></dd> +<dt><span><samp>float</samp></span></dt> +<dd><p>32-bit floating-point; this limits input sample format to FLT. (default) +</p></dd> +<dt><span><samp>double</samp></span></dt> +<dd><p>64-bit floating-point; this limits input sample format to DBL. +</p></dd> +</dl> + +</dd> +<dt><span><samp>replaygain</samp></span></dt> +<dd><p>Choose the behaviour on encountering ReplayGain side data in input frames. +</p> +<dl compact="compact"> +<dt><span><samp>drop</samp></span></dt> +<dd><p>Remove ReplayGain side data, ignoring its contents (the default). +</p> +</dd> +<dt><span><samp>ignore</samp></span></dt> +<dd><p>Ignore ReplayGain side data, but leave it in the frame. +</p> +</dd> +<dt><span><samp>track</samp></span></dt> +<dd><p>Prefer the track gain, if present. +</p> +</dd> +<dt><span><samp>album</samp></span></dt> +<dd><p>Prefer the album gain, if present. +</p></dd> +</dl> + +</dd> +<dt><span><samp>replaygain_preamp</samp></span></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><span><samp>replaygain_noclip</samp></span></dt> +<dd><p>Prevent clipping by limiting the gain applied. +</p> +<p>Default value for <var>replaygain_noclip</var> is 1. +</p> +</dd> +<dt><span><samp>eval</samp></span></dt> +<dd><p>Set when the volume expression is evaluated. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>once</samp>’</span></dt> +<dd><p>only evaluate expression once during the filter initialization, or +when the ‘<samp>volume</samp>’ command is sent +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>evaluate expression for each incoming frame +</p></dd> +</dl> + +<p>Default value is ‘<samp>once</samp>’. +</p></dd> +</dl> + +<p>The volume expression can contain the following parameters. +</p> +<dl compact="compact"> +<dt><span><samp>n</samp></span></dt> +<dd><p>frame number (starting at zero) +</p></dd> +<dt><span><samp>nb_channels</samp></span></dt> +<dd><p>number of channels +</p></dd> +<dt><span><samp>nb_consumed_samples</samp></span></dt> +<dd><p>number of samples consumed by the filter +</p></dd> +<dt><span><samp>nb_samples</samp></span></dt> +<dd><p>number of samples in the current frame +</p></dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>original frame position in the file +</p></dd> +<dt><span><samp>pts</samp></span></dt> +<dd><p>frame PTS +</p></dd> +<dt><span><samp>sample_rate</samp></span></dt> +<dd><p>sample rate +</p></dd> +<dt><span><samp>startpts</samp></span></dt> +<dd><p>PTS at start of stream +</p></dd> +<dt><span><samp>startt</samp></span></dt> +<dd><p>time at start of stream +</p></dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>frame time +</p></dd> +<dt><span><samp>tb</samp></span></dt> +<dd><p>timestamp timebase +</p></dd> +<dt><span><samp>volume</samp></span></dt> +<dd><p>last set volume value +</p></dd> +</dl> + +<p>Note that when <samp>eval</samp> is set to ‘<samp>once</samp>’ only the +<var>sample_rate</var> and <var>tb</var> variables are available, all other +variables will evaluate to NAN. +</p> +<a name="Commands-51"></a> +<h4 class="subsection">8.115.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-51" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-51" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>volume</samp></span></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> +</dl> + +<a name="Examples-35"></a> +<h4 class="subsection">8.115.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">8.116 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. It supports only 16-bit signed integer samples, +so the input will be converted when needed. 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">8.116.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 0xa23120] mean_volume: -27 dB +[Parsed_volumedetect_0 0xa23120] max_volume: -4 dB +[Parsed_volumedetect_0 0xa23120] histogram_4db: 6 +[Parsed_volumedetect_0 0xa23120] histogram_5db: 62 +[Parsed_volumedetect_0 0xa23120] histogram_6db: 286 +[Parsed_volumedetect_0 0xa23120] histogram_7db: 1042 +[Parsed_volumedetect_0 0xa23120] histogram_8db: 2551 +[Parsed_volumedetect_0 0xa23120] histogram_9db: 4609 +[Parsed_volumedetect_0 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">9 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">9.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/buffersrc.h</samp>. +</p> +<p>It accepts the following parameters: +</p><dl compact="compact"> +<dt><span><samp>time_base</samp></span></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><span><samp>sample_rate</samp></span></dt> +<dd><p>The sample rate of the incoming audio buffers. +</p> +</dd> +<dt><span><samp>sample_fmt</samp></span></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><span><samp>channel_layout</samp></span></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><span><samp>channels</samp></span></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">9.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 "s16p" corresponds to the number +6 and the "stereo" 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">9.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><span><samp>exprs</samp></span></dt> +<dd><p>Set the ’|’-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><span><samp>channel_layout, c</samp></span></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><span><samp>duration, d</samp></span></dt> +<dd><p>Set the minimum duration of the sourced audio. See +<a data-manual="ffmpeg-utils" 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><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set the number of samples per channel per each output frame, +default to 1024. +</p> +</dd> +<dt><span><samp>sample_rate, s</samp></span></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><span><samp>n</samp></span></dt> +<dd><p>number of the evaluated sample, starting from 0 +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>time of the evaluated sample expressed in seconds, starting from 0 +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>sample rate +</p> +</dd> +</dl> + +<a name="Examples-38"></a> +<h4 class="subsection">9.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="sin(440*2*PI*t):s=8000" +</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="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC" +</pre></div> + +</li><li> Generate white noise: +<div class="example"> +<pre class="example">aevalsrc="-2+random(0)" +</pre></div> + +</li><li> Generate an amplitude modulated signal: +<div class="example"> +<pre class="example">aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)" +</pre></div> + +</li><li> Generate 2.5 Hz binaural beats on a 360 Hz carrier: +<div class="example"> +<pre class="example">aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)" +</pre></div> + +</li></ul> + +<a name="afirsrc"></a> +<h3 class="section">9.3 afirsrc<span class="pull-right"><a class="anchor hidden-xs" href="#afirsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-afirsrc" aria-hidden="true">TOC</a></span></h3> + +<p>Generate a FIR coefficients using frequency sampling method. +</p> +<p>The resulting stream can be used with <a href="#afir">afir</a> filter for filtering the audio signal. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>taps, t</samp></span></dt> +<dd><p>Set number of filter coefficents in output audio stream. +Default value is 1025. +</p> +</dd> +<dt><span><samp>frequency, f</samp></span></dt> +<dd><p>Set frequency points from where magnitude and phase are set. +This must be in non decreasing order, and first element must be 0, while last element +must be 1. Elements are separated by white spaces. +</p> +</dd> +<dt><span><samp>magnitude, m</samp></span></dt> +<dd><p>Set magnitude value for every frequency point set by <samp>frequency</samp>. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +</p> +</dd> +<dt><span><samp>phase, p</samp></span></dt> +<dd><p>Set phase value for every frequency point set by <samp>frequency</samp>. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +</p> +</dd> +<dt><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Set sample rate, default is 44100. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set number of samples per each frame. Default is 1024. +</p> +</dd> +<dt><span><samp>win_func, w</samp></span></dt> +<dd><p>Set window function. Default is blackman. +</p></dd> +</dl> + +<a name="anullsrc"></a> +<h3 class="section">9.4 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><span><samp>channel_layout, cl</samp></span></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 "stereo". +</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><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Specifies the sample rate, and defaults to 44100. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set the number of samples per requested frames. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set the duration of the sourced audio. See +<a data-manual="ffmpeg-utils" 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 audio is +supposed to be generated forever. +</p></dd> +</dl> + +<a name="Examples-39"></a> +<h4 class="subsection">9.4.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">9.5 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 versions of the flite library prior to 2.0 are not thread-safe. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>list_voices</samp></span></dt> +<dd><p>If set to 1, list the names of the available voices and exit +immediately. Default value is 0. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set the maximum number of samples per frame. Default value is 512. +</p> +</dd> +<dt><span><samp>textfile</samp></span></dt> +<dd><p>Set the filename containing the text to speak. +</p> +</dd> +<dt><span><samp>text</samp></span></dt> +<dd><p>Set the text to speak. +</p> +</dd> +<dt><span><samp>voice, v</samp></span></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">9.5.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.festvox.org/flite/">http://www.festvox.org/flite/</a> +</p> +<a name="anoisesrc"></a> +<h3 class="section">9.6 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><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Specify the sample rate. Default value is 48000 Hz. +</p> +</dd> +<dt><span><samp>amplitude, a</samp></span></dt> +<dd><p>Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value +is 1.0. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></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><span><samp>color, colour, c</samp></span></dt> +<dd><p>Specify the color of noise. Available noise colors are white, pink, brown, +blue, violet and velvet. Default color is white. +</p> +</dd> +<dt><span><samp>seed, s</samp></span></dt> +<dd><p>Specify a value used to seed the PRNG. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></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">9.6.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="hilbert"></a> +<h3 class="section">9.7 hilbert<span class="pull-right"><a class="anchor hidden-xs" href="#hilbert" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hilbert" aria-hidden="true">TOC</a></span></h3> + +<p>Generate odd-tap Hilbert transform FIR coefficients. +</p> +<p>The resulting stream can be used with <a href="#afir">afir</a> filter for phase-shifting +the signal by 90 degrees. +</p> +<p>This is used in many matrix coding schemes and for analytic signal generation. +The process is often written as a multiplication by i (or j), the imaginary unit. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>sample_rate, s</samp></span></dt> +<dd><p>Set sample rate, default is 44100. +</p> +</dd> +<dt><span><samp>taps, t</samp></span></dt> +<dd><p>Set length of FIR filter, default is 22051. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set number of samples per each frame. +</p> +</dd> +<dt><span><samp>win_func, w</samp></span></dt> +<dd><p>Set window function to be used when generating FIR coefficients. +</p></dd> +</dl> + +<a name="sinc"></a> +<h3 class="section">9.8 sinc<span class="pull-right"><a class="anchor hidden-xs" href="#sinc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sinc" aria-hidden="true">TOC</a></span></h3> + +<p>Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. +</p> +<p>The resulting stream can be used with <a href="#afir">afir</a> filter for filtering the audio signal. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Set sample rate, default is 44100. +</p> +</dd> +<dt><span><samp>nb_samples, n</samp></span></dt> +<dd><p>Set number of samples per each frame. Default is 1024. +</p> +</dd> +<dt><span><samp>hp</samp></span></dt> +<dd><p>Set high-pass frequency. Default is 0. +</p> +</dd> +<dt><span><samp>lp</samp></span></dt> +<dd><p>Set low-pass frequency. Default is 0. +If high-pass frequency is lower than low-pass frequency and low-pass frequency +is higher than 0 then filter will create band-pass filter coefficients, +otherwise band-reject filter coefficients. +</p> +</dd> +<dt><span><samp>phase</samp></span></dt> +<dd><p>Set filter phase response. Default is 50. Allowed range is from 0 to 100. +</p> +</dd> +<dt><span><samp>beta</samp></span></dt> +<dd><p>Set Kaiser window beta. +</p> +</dd> +<dt><span><samp>att</samp></span></dt> +<dd><p>Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB. +</p> +</dd> +<dt><span><samp>round</samp></span></dt> +<dd><p>Enable rounding, by default is disabled. +</p> +</dd> +<dt><span><samp>hptaps</samp></span></dt> +<dd><p>Set number of taps for high-pass filter. +</p> +</dd> +<dt><span><samp>lptaps</samp></span></dt> +<dd><p>Set number of taps for low-pass filter. +</p></dd> +</dl> + +<a name="sine"></a> +<h3 class="section">9.9 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><span><samp>frequency, f</samp></span></dt> +<dd><p>Set the carrier frequency. Default is 440 Hz. +</p> +</dd> +<dt><span><samp>beep_factor, b</samp></span></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><span><samp>sample_rate, r</samp></span></dt> +<dd><p>Specify the sample rate, default is 44100. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Specify the duration of the generated audio stream. +</p> +</dd> +<dt><span><samp>samples_per_frame</samp></span></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><span><samp>n</samp></span></dt> +<dd><p>The (sequential) number of the output audio frame, starting from 0. +</p> +</dd> +<dt><span><samp>pts</samp></span></dt> +<dd><p>The PTS (Presentation TimeStamp) of the output audio frame, +expressed in <var>TB</var> units. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The PTS of the output audio frame, expressed in seconds. +</p> +</dd> +<dt><span><samp>TB</samp></span></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">9.9.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">10 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">10.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’ formats, to be passed as the opaque +parameter to <code>avfilter_init_filter</code> for initialization. +</p><a name="anullsink"></a> +<h3 class="section">10.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">11 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="addroi"></a> +<h3 class="section">11.1 addroi<span class="pull-right"><a class="anchor hidden-xs" href="#addroi" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-addroi" aria-hidden="true">TOC</a></span></h3> + +<p>Mark a region of interest in a video frame. +</p> +<p>The frame data is passed through unchanged, but metadata is attached +to the frame indicating regions of interest which can affect the +behaviour of later encoding. Multiple regions can be marked by +applying the filter multiple times. +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dd><p>Region distance in pixels from the left edge of the frame. +</p></dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Region distance in pixels from the top edge of the frame. +</p></dd> +<dt><span><samp>w</samp></span></dt> +<dd><p>Region width in pixels. +</p></dd> +<dt><span><samp>h</samp></span></dt> +<dd><p>Region height in pixels. +</p> +<p>The parameters <var>x</var>, <var>y</var>, <var>w</var> and <var>h</var> are expressions, +and may contain the following variables: +</p><dl compact="compact"> +<dt><span><samp>iw</samp></span></dt> +<dd><p>Width of the input frame. +</p></dd> +<dt><span><samp>ih</samp></span></dt> +<dd><p>Height of the input frame. +</p></dd> +</dl> + +</dd> +<dt><span><samp>qoffset</samp></span></dt> +<dd><p>Quantisation offset to apply within the region. +</p> +<p>This must be a real value in the range -1 to +1. A value of zero +indicates no quality change. A negative value asks for better quality +(less quantisation), while a positive value asks for worse quality +(greater quantisation). +</p> +<p>The range is calibrated so that the extreme values indicate the +largest possible offset - if the rest of the frame is encoded with the +worst possible quality, an offset of -1 indicates that this region +should be encoded with the best possible quality anyway. Intermediate +values are then interpolated in some codec-dependent way. +</p> +<p>For example, in 10-bit H.264 the quantisation parameter varies between +-12 and 51. A typical qoffset value of -1/10 therefore indicates that +this region should be encoded with a QP around one-tenth of the full +range better than the rest of the frame. So, if most of the frame +were to be encoded with a QP of around 30, this region would get a QP +of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). +An extreme value of -1 would indicate that this region should be +encoded with the best possible quality regardless of the treatment of +the rest of the frame - that is, should be encoded at a QP of -12. +</p></dd> +<dt><span><samp>clear</samp></span></dt> +<dd><p>If set to true, remove any existing regions of interest marked on the +frame before adding the new one. +</p></dd> +</dl> + +<a name="Examples-43"></a> +<h4 class="subsection">11.1.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> Mark the centre quarter of the frame as interesting. +<div class="example"> +<pre class="example">addroi=iw/4:ih/4:iw/2:ih/2:-1/10 +</pre></div> +</li><li> Mark the 100-pixel-wide region on the left edge of the frame as very +uninteresting (to be encoded at much lower quality than the rest of +the frame). +<div class="example"> +<pre class="example">addroi=0:0:100:ih:+1/5 +</pre></div> +</li></ul> + +<a name="alphaextract"></a> +<h3 class="section">11.2 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">11.3 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’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> + +<a name="amplify"></a> +<h3 class="section">11.4 amplify<span class="pull-right"><a class="anchor hidden-xs" href="#amplify" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amplify" aria-hidden="true">TOC</a></span></h3> + +<p>Amplify differences between current pixel and pixels of adjacent frames in +same pixel location. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set frame radius. Default is 2. Allowed range is from 1 to 63. +For example radius of 3 will instruct filter to calculate average of 7 frames. +</p> +</dd> +<dt><span><samp>factor</samp></span></dt> +<dd><p>Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535. +</p> +</dd> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set threshold for difference amplification. Any difference greater or equal to +this value will not alter source pixel. Default is 10. +Allowed range is from 0 to 65535. +</p> +</dd> +<dt><span><samp>tolerance</samp></span></dt> +<dd><p>Set tolerance for difference amplification. Any difference lower to +this value will not alter source pixel. Default is 0. +Allowed range is from 0 to 65535. +</p> +</dd> +<dt><span><samp>low</samp></span></dt> +<dd><p>Set lower limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will decrease source pixel value. +</p> +</dd> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set high limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will increase source pixel value. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15. +</p></dd> +</dl> + +<a name="Commands-52"></a> +<h4 class="subsection">11.4.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-52" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-52" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following <a href="#commands">commands</a> that corresponds to option of same name: +</p><dl compact="compact"> +<dt><span><samp>factor</samp></span></dt> +<dt><span><samp>threshold</samp></span></dt> +<dt><span><samp>tolerance</samp></span></dt> +<dt><span><samp>low</samp></span></dt> +<dt><span><samp>high</samp></span></dt> +<dt><span><samp>planes</samp></span></dt> +</dl> + +<a name="ass"></a> +<h3 class="section">11.5 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’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><span><samp>shaping</samp></span></dt> +<dd><p>Set the shaping engine +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>The default libass shaping engine, which is the best available. +</p></dd> +<dt><span>‘<samp>simple</samp>’</span></dt> +<dd><p>Fast, font-agnostic shaper that can do only substitutions +</p></dd> +<dt><span>‘<samp>complex</samp>’</span></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">11.6 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><span><samp>0a</samp></span></dt> +<dd><p>Set threshold A for 1st plane. Default is 0.02. +Valid range is 0 to 0.3. +</p> +</dd> +<dt><span><samp>0b</samp></span></dt> +<dd><p>Set threshold B for 1st plane. Default is 0.04. +Valid range is 0 to 5. +</p> +</dd> +<dt><span><samp>1a</samp></span></dt> +<dd><p>Set threshold A for 2nd plane. Default is 0.02. +Valid range is 0 to 0.3. +</p> +</dd> +<dt><span><samp>1b</samp></span></dt> +<dd><p>Set threshold B for 2nd plane. Default is 0.04. +Valid range is 0 to 5. +</p> +</dd> +<dt><span><samp>2a</samp></span></dt> +<dd><p>Set threshold A for 3rd plane. Default is 0.02. +Valid range is 0 to 0.3. +</p> +</dd> +<dt><span><samp>2b</samp></span></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><span><samp>s</samp></span></dt> +<dd><p>Set number of frames filter will use for averaging. Default is 9. Must be odd +number in range [5, 129]. +</p> +</dd> +<dt><span><samp>p</samp></span></dt> +<dd><p>Set what planes of frame filter will use for averaging. Default is all. +</p> +</dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>Set what variant of algorithm filter will use for averaging. Default is <code>p</code> parallel. +Alternatively can be set to <code>s</code> serial. +</p> +<p>Parallel can be faster then serial, while other way around is never true. +Parallel will abort early on first change being greater then thresholds, while serial +will continue processing other side of frames if they are equal or below thresholds. +</p> +</dd> +<dt><span><samp>0s</samp></span></dt> +<dt><span><samp>1s</samp></span></dt> +<dt><span><samp>2s</samp></span></dt> +<dd><p>Set sigma for 1st plane, 2nd plane or 3rd plane. Default is 32767. +Valid range is from 0 to 32767. +This options controls weight for each pixel in radius defined by size. +Default value means every pixel have same weight. +Setting this option to 0 effectively disables filtering. +</p></dd> +</dl> + +<a name="Commands-53"></a> +<h4 class="subsection">11.6.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-53" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-53" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options except option <code>s</code>. +The command accepts the same syntax of the corresponding option. +</p> +<a name="avgblur"></a> +<h3 class="section">11.7 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><span><samp>sizeX</samp></span></dt> +<dd><p>Set horizontal radius size. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. By default all planes are filtered. +</p> +</dd> +<dt><span><samp>sizeY</samp></span></dt> +<dd><p>Set vertical radius size, if zero it will be same as <code>sizeX</code>. +Default is <code>0</code>. +</p></dd> +</dl> + +<a name="Commands-54"></a> +<h4 class="subsection">11.7.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-54" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-54" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same commands as options. +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> +<a name="backgroundkey"></a> +<h3 class="section">11.8 backgroundkey<span class="pull-right"><a class="anchor hidden-xs" href="#backgroundkey" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-backgroundkey" aria-hidden="true">TOC</a></span></h3> + +<p>Turns a static background into transparency. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Threshold for scene change detection. +</p></dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Similarity percentage with the background. +</p></dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Set the blend amount for pixels that are not similar. +</p></dd> +</dl> + +<a name="Commands-55"></a> +<h4 class="subsection">11.8.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-55" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-55" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="bbox"></a> +<h3 class="section">11.9 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><span><samp>min_val</samp></span></dt> +<dd><p>Set the minimal luminance value. Default is <code>16</code>. +</p></dd> +</dl> + +<a name="Commands-56"></a> +<h4 class="subsection">11.9.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-56" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-56" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="bilateral"></a> +<h3 class="section">11.10 bilateral<span class="pull-right"><a class="anchor hidden-xs" href="#bilateral" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bilateral" aria-hidden="true">TOC</a></span></h3> +<p>Apply bilateral filter, spatial smoothing while preserving edges. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>sigmaS</samp></span></dt> +<dd><p>Set sigma of gaussian function to calculate spatial weight. +Allowed range is 0 to 512. Default is 0.1. +</p> +</dd> +<dt><span><samp>sigmaR</samp></span></dt> +<dd><p>Set sigma of gaussian function to calculate range weight. +Allowed range is 0 to 1. Default is 0.1. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is first only. +</p></dd> +</dl> + +<a name="Commands-57"></a> +<h4 class="subsection">11.10.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-57" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-57" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="bilateral_005fcuda"></a> +<h3 class="section">11.11 bilateral_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#bilateral_005fcuda" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bilateral_005fcuda" aria-hidden="true">TOC</a></span></h3> +<p>CUDA accelerated bilateral filter, an edge preserving filter. +This filter is mathematically accurate thanks to the use of GPU acceleration. +For best output quality, use one to one chroma subsampling, i.e. yuv444p format. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>sigmaS</samp></span></dt> +<dd><p>Set sigma of gaussian function to calculate spatial weight, also called sigma space. +Allowed range is 0.1 to 512. Default is 0.1. +</p> +</dd> +<dt><span><samp>sigmaR</samp></span></dt> +<dd><p>Set sigma of gaussian function to calculate color range weight, also called sigma color. +Allowed range is 0.1 to 512. Default is 0.1. +</p> +</dd> +<dt><span><samp>window_size</samp></span></dt> +<dd><p>Set window size of the bilateral function to determine the number of neighbours to loop on. +If the number entered is even, one will be added automatically. +Allowed range is 1 to 255. Default is 1. +</p></dd> +</dl> +<a name="Examples-44"></a> +<h4 class="subsection">11.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 the bilateral filter on a video. + +<div class="example"> +<pre class="example">./ffmpeg -v verbose \ +-hwaccel cuda -hwaccel_output_format cuda -i input.mp4 \ +-init_hw_device cuda \ +-filter_complex \ +" \ +[0:v]scale_cuda=format=yuv444p[scaled_video]; +[scaled_video]bilateral_cuda=window_size=9:sigmaS=3.0:sigmaR=50.0" \ +-an -sn -c:v h264_nvenc -cq 20 out.mp4 +</pre></div> + +</li></ul> + +<a name="bitplanenoise"></a> +<h3 class="section">11.12 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><span><samp>bitplane</samp></span></dt> +<dd><p>Set which plane to analyze. Default is <code>1</code>. +</p> +</dd> +<dt><span><samp>filter</samp></span></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">11.13 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. +</p> +<p>The filter outputs its detection analysis to both the log as well as +frame metadata. If a black segment of at least the specified minimum +duration is found, a line with the start and end timestamps as well +as duration is printed to the log with level <code>info</code>. In addition, +a log line with level <code>debug</code> is printed per frame showing the +black amount detected for that frame. +</p> +<p>The filter also attaches metadata to the first frame of a black +segment with key <code>lavfi.black_start</code> and to the first frame +after the black segment ends with key <code>lavfi.black_end</code>. The +value is the frame’s timestamp. This metadata is added regardless +of the minimum duration specified. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>black_min_duration, d</samp></span></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><span><samp>picture_black_ratio_th, pic_th</samp></span></dt> +<dd><p>Set the threshold for considering a picture "black". +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><span><samp>pixel_black_th, pix_th</samp></span></dt> +<dd><p>Set the threshold for considering a pixel "black". +</p> +<p>The threshold expresses the maximum pixel luminance value for which a +pixel is considered "black". 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">11.14 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>This filter exports frame metadata <code>lavfi.blackframe.pblack</code>. +The value represents the percentage of pixels in the picture that +are below the threshold value. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>amount</samp></span></dt> +<dd><p>The percentage of the pixels that have to be below the threshold; it defaults to +<code>98</code>. +</p> +</dd> +<dt><span><samp>threshold, thresh</samp></span></dt> +<dd><p>The threshold below which a pixel value is considered black; it defaults to +<code>32</code>. +</p> +</dd> +</dl> + +<span id="blend"></span><a name="blend-1"></a> +<h3 class="section">11.15 blend<span class="pull-right"><a class="anchor hidden-xs" href="#blend-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blend-1" 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 "top" layer and second input is +"bottom" 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><span><samp>c0_mode</samp></span></dt> +<dt><span><samp>c1_mode</samp></span></dt> +<dt><span><samp>c2_mode</samp></span></dt> +<dt><span><samp>c3_mode</samp></span></dt> +<dt><span><samp>all_mode</samp></span></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><span>‘<samp>addition</samp>’</span></dt> +<dt><span>‘<samp>and</samp>’</span></dt> +<dt><span>‘<samp>average</samp>’</span></dt> +<dt><span>‘<samp>bleach</samp>’</span></dt> +<dt><span>‘<samp>burn</samp>’</span></dt> +<dt><span>‘<samp>darken</samp>’</span></dt> +<dt><span>‘<samp>difference</samp>’</span></dt> +<dt><span>‘<samp>divide</samp>’</span></dt> +<dt><span>‘<samp>dodge</samp>’</span></dt> +<dt><span>‘<samp>exclusion</samp>’</span></dt> +<dt><span>‘<samp>extremity</samp>’</span></dt> +<dt><span>‘<samp>freeze</samp>’</span></dt> +<dt><span>‘<samp>geometric</samp>’</span></dt> +<dt><span>‘<samp>glow</samp>’</span></dt> +<dt><span>‘<samp>grainextract</samp>’</span></dt> +<dt><span>‘<samp>grainmerge</samp>’</span></dt> +<dt><span>‘<samp>hardlight</samp>’</span></dt> +<dt><span>‘<samp>hardmix</samp>’</span></dt> +<dt><span>‘<samp>hardoverlay</samp>’</span></dt> +<dt><span>‘<samp>harmonic</samp>’</span></dt> +<dt><span>‘<samp>heat</samp>’</span></dt> +<dt><span>‘<samp>interpolate</samp>’</span></dt> +<dt><span>‘<samp>lighten</samp>’</span></dt> +<dt><span>‘<samp>linearlight</samp>’</span></dt> +<dt><span>‘<samp>multiply</samp>’</span></dt> +<dt><span>‘<samp>multiply128</samp>’</span></dt> +<dt><span>‘<samp>negation</samp>’</span></dt> +<dt><span>‘<samp>normal</samp>’</span></dt> +<dt><span>‘<samp>or</samp>’</span></dt> +<dt><span>‘<samp>overlay</samp>’</span></dt> +<dt><span>‘<samp>phoenix</samp>’</span></dt> +<dt><span>‘<samp>pinlight</samp>’</span></dt> +<dt><span>‘<samp>reflect</samp>’</span></dt> +<dt><span>‘<samp>screen</samp>’</span></dt> +<dt><span>‘<samp>softdifference</samp>’</span></dt> +<dt><span>‘<samp>softlight</samp>’</span></dt> +<dt><span>‘<samp>stain</samp>’</span></dt> +<dt><span>‘<samp>subtract</samp>’</span></dt> +<dt><span>‘<samp>vividlight</samp>’</span></dt> +<dt><span>‘<samp>xor</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>c0_opacity</samp></span></dt> +<dt><span><samp>c1_opacity</samp></span></dt> +<dt><span><samp>c2_opacity</samp></span></dt> +<dt><span><samp>c3_opacity</samp></span></dt> +<dt><span><samp>all_opacity</samp></span></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><span><samp>c0_expr</samp></span></dt> +<dt><span><samp>c1_expr</samp></span></dt> +<dt><span><samp>c2_expr</samp></span></dt> +<dt><span><samp>c3_expr</samp></span></dt> +<dt><span><samp>all_expr</samp></span></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><span><samp>N</samp></span></dt> +<dd><p>The sequential number of the filtered frame, starting from <code>0</code>. +</p> +</dd> +<dt><span><samp>X</samp></span></dt> +<dt><span><samp>Y</samp></span></dt> +<dd><p>the coordinates of the current sample +</p> +</dd> +<dt><span><samp>W</samp></span></dt> +<dt><span><samp>H</samp></span></dt> +<dd><p>the width and height of currently filtered plane +</p> +</dd> +<dt><span><samp>SW</samp></span></dt> +<dt><span><samp>SH</samp></span></dt> +<dd><p>Width and height scale for the plane being filtered. It is the +ratio between the dimensions of the current plane to the luma plane, +e.g. for a <code>yuv420p</code> frame, the values are <code>1,1</code> for +the luma plane and <code>0.5,0.5</code> for the chroma planes. +</p> +</dd> +<dt><span><samp>T</samp></span></dt> +<dd><p>Time of the current frame, expressed in seconds. +</p> +</dd> +<dt><span><samp>TOP, A</samp></span></dt> +<dd><p>Value of pixel component at current location for first video frame (top layer). +</p> +</dd> +<dt><span><samp>BOTTOM, B</samp></span></dt> +<dd><p>Value of pixel component at current location for second video frame (bottom layer). +</p></dd> +</dl> +</dd> +</dl> + +<p>The <code>blend</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="Examples-45"></a> +<h4 class="subsection">11.15.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> 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 linear horizontal transition from top layer to bottom layer: +<div class="example"> +<pre class="example">blend=all_expr='A*(X/W)+B*(1-X/W)' +</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=grainextract +</pre></div> +</li></ul> + +<a name="Commands-58"></a> +<h4 class="subsection">11.15.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-58" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-58" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<span id="blockdetect"></span><a name="blockdetect-1"></a> +<h3 class="section">11.16 blockdetect<span class="pull-right"><a class="anchor hidden-xs" href="#blockdetect-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blockdetect-1" aria-hidden="true">TOC</a></span></h3> + +<p>Determines blockiness of frames without altering the input frames. +</p> +<p>Based on Remco Muijs and Ihor Kirenko: "A no-reference blocking artifact measure for adaptive video processing." 2005 13th European signal processing conference. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>period_min</samp></span></dt> +<dt><span><samp>period_max</samp></span></dt> +<dd><p>Set minimum and maximum values for determining pixel grids (periods). +Default values are [3,24]. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is first only. +</p></dd> +</dl> + +<a name="Examples-46"></a> +<h4 class="subsection">11.16.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> Determine blockiness for the first plane and search for periods within [8,32]: +<div class="example"> +<pre class="example">blockdetect=period_min=8:period_max=32:planes=1 +</pre></div> +</li></ul> + +<span id="blurdetect"></span><a name="blurdetect-1"></a> +<h3 class="section">11.17 blurdetect<span class="pull-right"><a class="anchor hidden-xs" href="#blurdetect-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-blurdetect-1" aria-hidden="true">TOC</a></span></h3> + +<p>Determines blurriness of frames without altering the input frames. +</p> +<p>Based on Marziliano, Pina, et al. "A no-reference perceptual blur metric." +Allows for a block-based abbreviation. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>low</samp></span></dt> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set low and high threshold values used by the Canny thresholding +algorithm. +</p> +<p>The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" 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><span><samp>radius</samp></span></dt> +<dd><p>Define the radius to search around an edge pixel for local maxima. +</p> +</dd> +<dt><span><samp>block_pct</samp></span></dt> +<dd><p>Determine blurriness only for the most significant blocks, given in percentage. +</p> +</dd> +<dt><span><samp>block_width</samp></span></dt> +<dd><p>Determine blurriness for blocks of width <var>block_width</var>. If set to any value smaller 1, no blocks are used and the whole image is processed as one no matter of <var>block_height</var>. +</p> +</dd> +<dt><span><samp>block_height</samp></span></dt> +<dd><p>Determine blurriness for blocks of height <var>block_height</var>. If set to any value smaller 1, no blocks are used and the whole image is processed as one no matter of <var>block_width</var>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is first only. +</p></dd> +</dl> + +<a name="Examples-47"></a> +<h4 class="subsection">11.17.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> Determine blur for 80% of most significant 32x32 blocks: +<div class="example"> +<pre class="example">blurdetect=block_width=32:block_height=32:block_pct=80 +</pre></div> +</li></ul> + +<a name="bm3d"></a> +<h3 class="section">11.18 bm3d<span class="pull-right"><a class="anchor hidden-xs" href="#bm3d" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bm3d" aria-hidden="true">TOC</a></span></h3> + +<p>Denoise frames using Block-Matching 3D algorithm. +</p> +<p>The filter accepts the following options. +</p> +<dl compact="compact"> +<dt><span><samp>sigma</samp></span></dt> +<dd><p>Set denoising strength. Default value is 1. +Allowed range is from 0 to 999.9. +The denoising algorithm is very sensitive to sigma, so adjust it +according to the source. +</p> +</dd> +<dt><span><samp>block</samp></span></dt> +<dd><p>Set local patch size. This sets dimensions in 2D. +</p> +</dd> +<dt><span><samp>bstep</samp></span></dt> +<dd><p>Set sliding step for processing blocks. Default value is 4. +Allowed range is from 1 to 64. +Smaller values allows processing more reference blocks and is slower. +</p> +</dd> +<dt><span><samp>group</samp></span></dt> +<dd><p>Set maximal number of similar blocks for 3rd dimension. Default value is 1. +When set to 1, no block matching is done. Larger values allows more blocks +in single group. +Allowed range is from 1 to 256. +</p> +</dd> +<dt><span><samp>range</samp></span></dt> +<dd><p>Set radius for search block matching. Default is 9. +Allowed range is from 1 to INT32_MAX. +</p> +</dd> +<dt><span><samp>mstep</samp></span></dt> +<dd><p>Set step between two search locations for block matching. Default is 1. +Allowed range is from 1 to 64. Smaller is slower. +</p> +</dd> +<dt><span><samp>thmse</samp></span></dt> +<dd><p>Set threshold of mean square error for block matching. Valid range is 0 to +INT32_MAX. +</p> +</dd> +<dt><span><samp>hdthr</samp></span></dt> +<dd><p>Set thresholding parameter for hard thresholding in 3D transformed domain. +Larger values results in stronger hard-thresholding filtering in frequency +domain. +</p> +</dd> +<dt><span><samp>estim</samp></span></dt> +<dd><p>Set filtering estimation mode. Can be <code>basic</code> or <code>final</code>. +Default is <code>basic</code>. +</p> +</dd> +<dt><span><samp>ref</samp></span></dt> +<dd><p>If enabled, filter will use 2nd stream for block matching. +Default is disabled for <code>basic</code> value of <var>estim</var> option, +and always enabled if value of <var>estim</var> is <code>final</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is all available except alpha. +</p></dd> +</dl> + +<a name="Examples-48"></a> +<h4 class="subsection">11.18.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> Basic filtering with bm3d: +<div class="example"> +<pre class="example">bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic +</pre></div> + +</li><li> Same as above, but filtering only luma: +<div class="example"> +<pre class="example">bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic:planes=1 +</pre></div> + +</li><li> Same as above, but with both estimation modes: +<div class="example"> +<pre class="example">split[a][b],[a]bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1 +</pre></div> + +</li><li> Same as above, but prefilter with <a href="#nlmeans">nlmeans</a> filter instead: +<div class="example"> +<pre class="example">split[a][b],[a]nlmeans=s=3:r=7:p=3[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1 +</pre></div> +</li></ul> + +<a name="boxblur"></a> +<h3 class="section">11.19 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><span><samp>luma_radius, lr</samp></span></dt> +<dt><span><samp>luma_power, lp</samp></span></dt> +<dt><span><samp>chroma_radius, cr</samp></span></dt> +<dt><span><samp>chroma_power, cp</samp></span></dt> +<dt><span><samp>alpha_radius, ar</samp></span></dt> +<dt><span><samp>alpha_power, ap</samp></span></dt> +</dl> + +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>luma_radius, lr</samp></span></dt> +<dt><span><samp>chroma_radius, cr</samp></span></dt> +<dt><span><samp>alpha_radius, ar</samp></span></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 "2". 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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height in pixels. +</p> +</dd> +<dt><span><samp>cw</samp></span></dt> +<dt><span><samp>ch</samp></span></dt> +<dd><p>The input chroma image width and height in pixels. +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p></dd> +</dl> + +</dd> +<dt><span><samp>luma_power, lp</samp></span></dt> +<dt><span><samp>chroma_power, cp</samp></span></dt> +<dt><span><samp>alpha_power, ap</samp></span></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-49"></a> +<h4 class="subsection">11.19.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> 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">11.20 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 ("bwdif" stands for "Bob Weaver +Deinterlacing Filter"). +</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><span><samp>mode</samp></span></dt> +<dd><p>The interlacing mode to adopt. It accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>0, send_frame</samp></span></dt> +<dd><p>Output one frame for each frame. +</p></dd> +<dt><span><samp>1, send_field</samp></span></dt> +<dd><p>Output one frame for each field. +</p></dd> +</dl> + +<p>The default value is <code>send_field</code>. +</p> +</dd> +<dt><span><samp>parity</samp></span></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><span><samp>0, tff</samp></span></dt> +<dd><p>Assume the top field is first. +</p></dd> +<dt><span><samp>1, bff</samp></span></dt> +<dd><p>Assume the bottom field is first. +</p></dd> +<dt><span><samp>-1, auto</samp></span></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><span><samp>deint</samp></span></dt> +<dd><p>Specify which frames to deinterlace. Accepts one of the following +values: +</p> +<dl compact="compact"> +<dt><span><samp>0, all</samp></span></dt> +<dd><p>Deinterlace all frames. +</p></dd> +<dt><span><samp>1, interlaced</samp></span></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="cas"></a> +<h3 class="section">11.21 cas<span class="pull-right"><a class="anchor hidden-xs" href="#cas" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cas" aria-hidden="true">TOC</a></span></h3> + +<p>Apply Contrast Adaptive Sharpen filter to video stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>strength</samp></span></dt> +<dd><p>Set the sharpening strength. Default value is 0. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default value is to filter all +planes except alpha plane. +</p></dd> +</dl> + +<a name="Commands-59"></a> +<h4 class="subsection">11.21.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-59" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-59" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="chromahold"></a> +<h3 class="section">11.22 chromahold<span class="pull-right"><a class="anchor hidden-xs" href="#chromahold" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromahold" aria-hidden="true">TOC</a></span></h3> +<p>Remove all color information for all colors except for certain one. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>color</samp></span></dt> +<dd><p>The color which will not be replaced with neutral chroma. +</p> +</dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Blend percentage. +0.0 makes pixels either fully gray, or not gray at all. +Higher values result in more preserved color. +</p> +</dd> +<dt><span><samp>yuv</samp></span></dt> +<dd><p>Signals that the color passed is already in YUV instead of RGB. +</p> +<p>Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +</p></dd> +</dl> + +<a name="Commands-60"></a> +<h4 class="subsection">11.22.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-60" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-60" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<span id="chromakey"></span><a name="chromakey-1"></a> +<h3 class="section">11.23 chromakey<span class="pull-right"><a class="anchor hidden-xs" href="#chromakey-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromakey-1" 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><span><samp>color</samp></span></dt> +<dd><p>The color which will be replaced with transparency. +</p> +</dd> +<dt><span><samp>similarity</samp></span></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><span><samp>blend</samp></span></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><span><samp>yuv</samp></span></dt> +<dd><p>Signals that the color passed is already in YUV instead of RGB. +</p> +<p>Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +</p></dd> +</dl> + +<a name="Commands-61"></a> +<h4 class="subsection">11.23.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-61" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-61" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="Examples-50"></a> +<h4 class="subsection">11.23.2 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> 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 "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv +</pre></div> +</li></ul> + +<a name="chromakey_005fcuda"></a> +<h3 class="section">11.24 chromakey_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#chromakey_005fcuda" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromakey_005fcuda" aria-hidden="true">TOC</a></span></h3> +<p>CUDA accelerated YUV colorspace color/chroma keying. +</p> +<p>This filter works like normal chromakey filter but operates on CUDA frames. +for more details and parameters see <a href="#chromakey">chromakey</a>. +</p> +<a name="Examples-51"></a> +<h4 class="subsection">11.24.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> Make all the green pixels in the input video transparent and use it as an overlay for another video: + +<div class="example"> +<pre class="example">./ffmpeg \ + -hwaccel cuda -hwaccel_output_format cuda -i input_green.mp4 \ + -hwaccel cuda -hwaccel_output_format cuda -i base_video.mp4 \ + -init_hw_device cuda \ + -filter_complex \ + " \ + [0:v]chromakey_cuda=0x25302D:0.1:0.12:1[overlay_video]; \ + [1:v]scale_cuda=format=yuv420p[base]; \ + [base][overlay_video]overlay_cuda" \ + -an -sn -c:v h264_nvenc -cq 20 output.mp4 +</pre></div> + +</li><li> Process two software sources, explicitly uploading the frames: + +<div class="example"> +<pre class="example">./ffmpeg -init_hw_device cuda=cuda -filter_hw_device cuda \ + -f lavfi -i color=size=800x600:color=white,format=yuv420p \ + -f lavfi -i yuvtestsrc=size=200x200,format=yuv420p \ + -filter_complex \ + " \ + [0]hwupload[under]; \ + [1]hwupload,chromakey_cuda=green:0.1:0.12[over]; \ + [under][over]overlay_cuda" \ + -c:v hevc_nvenc -cq 18 -preset slow output.mp4 +</pre></div> + +</li></ul> + +<a name="chromanr"></a> +<h3 class="section">11.25 chromanr<span class="pull-right"><a class="anchor hidden-xs" href="#chromanr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromanr" aria-hidden="true">TOC</a></span></h3> +<p>Reduce chrominance noise. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>thres</samp></span></dt> +<dd><p>Set threshold for averaging chrominance values. +Sum of absolute difference of Y, U and V pixel components of current +pixel and neighbour pixels lower than this threshold will be used in +averaging. Luma component is left unchanged and is copied to output. +Default value is 30. Allowed range is from 1 to 200. +</p> +</dd> +<dt><span><samp>sizew</samp></span></dt> +<dd><p>Set horizontal radius of rectangle used for averaging. +Allowed range is from 1 to 100. Default value is 5. +</p> +</dd> +<dt><span><samp>sizeh</samp></span></dt> +<dd><p>Set vertical radius of rectangle used for averaging. +Allowed range is from 1 to 100. Default value is 5. +</p> +</dd> +<dt><span><samp>stepw</samp></span></dt> +<dd><p>Set horizontal step when averaging. Default value is 1. +Allowed range is from 1 to 50. +Mostly useful to speed-up filtering. +</p> +</dd> +<dt><span><samp>steph</samp></span></dt> +<dd><p>Set vertical step when averaging. Default value is 1. +Allowed range is from 1 to 50. +Mostly useful to speed-up filtering. +</p> +</dd> +<dt><span><samp>threy</samp></span></dt> +<dd><p>Set Y threshold for averaging chrominance values. +Set finer control for max allowed difference between Y components +of current pixel and neigbour pixels. +Default value is 200. Allowed range is from 1 to 200. +</p> +</dd> +<dt><span><samp>threu</samp></span></dt> +<dd><p>Set U threshold for averaging chrominance values. +Set finer control for max allowed difference between U components +of current pixel and neigbour pixels. +Default value is 200. Allowed range is from 1 to 200. +</p> +</dd> +<dt><span><samp>threv</samp></span></dt> +<dd><p>Set V threshold for averaging chrominance values. +Set finer control for max allowed difference between V components +of current pixel and neigbour pixels. +Default value is 200. Allowed range is from 1 to 200. +</p> +</dd> +<dt><span><samp>distance</samp></span></dt> +<dd><p>Set distance type used in calculations. +</p> +<dl compact="compact"> +<dt><span>‘<samp>manhattan</samp>’</span></dt> +<dd><p>Absolute difference. +</p></dd> +<dt><span>‘<samp>euclidean</samp>’</span></dt> +<dd><p>Difference squared. +</p></dd> +</dl> + +<p>Default distance type is manhattan. +</p></dd> +</dl> + +<a name="Commands-62"></a> +<h4 class="subsection">11.25.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-62" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-62" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +The command accepts the same syntax of the corresponding option. +</p> +<a name="chromashift"></a> +<h3 class="section">11.26 chromashift<span class="pull-right"><a class="anchor hidden-xs" href="#chromashift" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-chromashift" aria-hidden="true">TOC</a></span></h3> +<p>Shift chroma pixels horizontally and/or vertically. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>cbh</samp></span></dt> +<dd><p>Set amount to shift chroma-blue horizontally. +</p></dd> +<dt><span><samp>cbv</samp></span></dt> +<dd><p>Set amount to shift chroma-blue vertically. +</p></dd> +<dt><span><samp>crh</samp></span></dt> +<dd><p>Set amount to shift chroma-red horizontally. +</p></dd> +<dt><span><samp>crv</samp></span></dt> +<dd><p>Set amount to shift chroma-red vertically. +</p></dd> +<dt><span><samp>edge</samp></span></dt> +<dd><p>Set edge mode, can be <var>smear</var>, default, or <var>warp</var>. +</p></dd> +</dl> + +<a name="Commands-63"></a> +<h4 class="subsection">11.26.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-63" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-63" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="ciescope"></a> +<h3 class="section">11.27 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><span><samp>system</samp></span></dt> +<dd><p>Set color system. +</p> +<dl compact="compact"> +<dt><span>‘<samp>ntsc, 470m</samp>’</span></dt> +<dt><span>‘<samp>ebu, 470bg</samp>’</span></dt> +<dt><span>‘<samp>smpte</samp>’</span></dt> +<dt><span>‘<samp>240m</samp>’</span></dt> +<dt><span>‘<samp>apple</samp>’</span></dt> +<dt><span>‘<samp>widergb</samp>’</span></dt> +<dt><span>‘<samp>cie1931</samp>’</span></dt> +<dt><span>‘<samp>rec709, hdtv</samp>’</span></dt> +<dt><span>‘<samp>uhdtv, rec2020</samp>’</span></dt> +<dt><span>‘<samp>dcip3</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>cie</samp></span></dt> +<dd><p>Set CIE system. +</p> +<dl compact="compact"> +<dt><span>‘<samp>xyy</samp>’</span></dt> +<dt><span>‘<samp>ucs</samp>’</span></dt> +<dt><span>‘<samp>luv</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>gamuts</samp></span></dt> +<dd><p>Set what gamuts to draw. +</p> +<p>See <code>system</code> option for available values. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set ciescope size, by default set to 512. +</p> +</dd> +<dt><span><samp>intensity, i</samp></span></dt> +<dd><p>Set intensity used to map input pixel values to CIE diagram. +</p> +</dd> +<dt><span><samp>contrast</samp></span></dt> +<dd><p>Set contrast used to draw tongue colors that are out of active color system gamut. +</p> +</dd> +<dt><span><samp>corrgamma</samp></span></dt> +<dd><p>Correct gamma displayed on scope, by default enabled. +</p> +</dd> +<dt><span><samp>showwhite</samp></span></dt> +<dd><p>Show white point on CIE diagram, by default disabled. +</p> +</dd> +<dt><span><samp>gamma</samp></span></dt> +<dd><p>Set input gamma. Used only with XYZ input color space. +</p> +</dd> +<dt><span><samp>fill</samp></span></dt> +<dd><p>Fill with CIE colors. By default is enabled. +</p></dd> +</dl> + +<a name="codecview"></a> +<h3 class="section">11.28 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><span><samp>block</samp></span></dt> +<dd><p>Display block partition structure using the luma plane. +</p> +</dd> +<dt><span><samp>mv</samp></span></dt> +<dd><p>Set motion vectors to visualize. +</p> +<p>Available flags for <var>mv</var> are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>pf</samp>’</span></dt> +<dd><p>forward predicted MVs of P-frames +</p></dd> +<dt><span>‘<samp>bf</samp>’</span></dt> +<dd><p>forward predicted MVs of B-frames +</p></dd> +<dt><span>‘<samp>bb</samp>’</span></dt> +<dd><p>backward predicted MVs of B-frames +</p></dd> +</dl> + +</dd> +<dt><span><samp>qp</samp></span></dt> +<dd><p>Display quantization parameters using the chroma planes. +</p> +</dd> +<dt><span><samp>mv_type, mvt</samp></span></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><span>‘<samp>fp</samp>’</span></dt> +<dd><p>forward predicted MVs +</p></dd> +<dt><span>‘<samp>bp</samp>’</span></dt> +<dd><p>backward predicted MVs +</p></dd> +</dl> + +</dd> +<dt><span><samp>frame_type, ft</samp></span></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><span>‘<samp>if</samp>’</span></dt> +<dd><p>intra-coded frames (I-frames) +</p></dd> +<dt><span>‘<samp>pf</samp>’</span></dt> +<dd><p>predicted frames (P-frames) +</p></dd> +<dt><span>‘<samp>bf</samp>’</span></dt> +<dd><p>bi-directionally predicted frames (B-frames) +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-52"></a> +<h4 class="subsection">11.28.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> 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">11.29 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><span><samp>rs</samp></span></dt> +<dt><span><samp>gs</samp></span></dt> +<dt><span><samp>bs</samp></span></dt> +<dd><p>Adjust red, green and blue shadows (darkest pixels). +</p> +</dd> +<dt><span><samp>rm</samp></span></dt> +<dt><span><samp>gm</samp></span></dt> +<dt><span><samp>bm</samp></span></dt> +<dd><p>Adjust red, green and blue midtones (medium pixels). +</p> +</dd> +<dt><span><samp>rh</samp></span></dt> +<dt><span><samp>gh</samp></span></dt> +<dt><span><samp>bh</samp></span></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> +<dt><span><samp>pl</samp></span></dt> +<dd><p>Preserve lightness when changing color balance. Default is disabled. +</p></dd> +</dl> + +<a name="Examples-53"></a> +<h4 class="subsection">11.29.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> Add red color cast to shadows: +<div class="example"> +<pre class="example">colorbalance=rs=.3 +</pre></div> +</li></ul> + +<a name="Commands-64"></a> +<h4 class="subsection">11.29.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-64" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-64" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colorcontrast"></a> +<h3 class="section">11.30 colorcontrast<span class="pull-right"><a class="anchor hidden-xs" href="#colorcontrast" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorcontrast" aria-hidden="true">TOC</a></span></h3> + +<p>Adjust color contrast between RGB components. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>rc</samp></span></dt> +<dd><p>Set the red-cyan contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0. +</p> +</dd> +<dt><span><samp>gm</samp></span></dt> +<dd><p>Set the green-magenta contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0. +</p> +</dd> +<dt><span><samp>by</samp></span></dt> +<dd><p>Set the blue-yellow contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0. +</p> +</dd> +<dt><span><samp>rcw</samp></span></dt> +<dt><span><samp>gmw</samp></span></dt> +<dt><span><samp>byw</samp></span></dt> +<dd><p>Set the weight of each <code>rc</code>, <code>gm</code>, <code>by</code> option value. Default value is 0.0. +Allowed range is from 0.0 to 1.0. If all weights are 0.0 filtering is disabled. +</p> +</dd> +<dt><span><samp>pl</samp></span></dt> +<dd><p>Set the amount of preserving lightness. Default value is 0.0. Allowed range is from 0.0 to 1.0. +</p></dd> +</dl> + +<a name="Commands-65"></a> +<h4 class="subsection">11.30.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-65" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-65" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colorcorrect"></a> +<h3 class="section">11.31 colorcorrect<span class="pull-right"><a class="anchor hidden-xs" href="#colorcorrect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorcorrect" aria-hidden="true">TOC</a></span></h3> + +<p>Adjust color white balance selectively for blacks and whites. +This filter operates in YUV colorspace. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>rl</samp></span></dt> +<dd><p>Set the red shadow spot. Allowed range is from -1.0 to 1.0. +Default value is 0. +</p> +</dd> +<dt><span><samp>bl</samp></span></dt> +<dd><p>Set the blue shadow spot. Allowed range is from -1.0 to 1.0. +Default value is 0. +</p> +</dd> +<dt><span><samp>rh</samp></span></dt> +<dd><p>Set the red highlight spot. Allowed range is from -1.0 to 1.0. +Default value is 0. +</p> +</dd> +<dt><span><samp>bh</samp></span></dt> +<dd><p>Set the red highlight spot. Allowed range is from -1.0 to 1.0. +Default value is 0. +</p> +</dd> +<dt><span><samp>saturation</samp></span></dt> +<dd><p>Set the amount of saturation. Allowed range is from -3.0 to 3.0. +Default value is 1. +</p> +</dd> +<dt><span><samp>analyze</samp></span></dt> +<dd><p>If set to anything other than <code>manual</code> it will analyze every frame and use derived +parameters for filtering output frame. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span>‘<samp>manual</samp>’</span></dt> +<dt><span>‘<samp>average</samp>’</span></dt> +<dt><span>‘<samp>minmax</samp>’</span></dt> +<dt><span>‘<samp>median</samp>’</span></dt> +</dl> +<p>Default value is <code>manual</code>. +</p></dd> +</dl> + +<a name="Commands-66"></a> +<h4 class="subsection">11.31.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-66" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-66" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colorchannelmixer"></a> +<h3 class="section">11.32 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><span><samp>rr</samp></span></dt> +<dt><span><samp>rg</samp></span></dt> +<dt><span><samp>rb</samp></span></dt> +<dt><span><samp>ra</samp></span></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><span><samp>gr</samp></span></dt> +<dt><span><samp>gg</samp></span></dt> +<dt><span><samp>gb</samp></span></dt> +<dt><span><samp>ga</samp></span></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><span><samp>br</samp></span></dt> +<dt><span><samp>bg</samp></span></dt> +<dt><span><samp>bb</samp></span></dt> +<dt><span><samp>ba</samp></span></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><span><samp>ar</samp></span></dt> +<dt><span><samp>ag</samp></span></dt> +<dt><span><samp>ab</samp></span></dt> +<dt><span><samp>aa</samp></span></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> +<dt><span><samp>pc</samp></span></dt> +<dd><p>Set preserve color mode. The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Disable color preserving, this is default. +</p></dd> +<dt><span>‘<samp>lum</samp>’</span></dt> +<dd><p>Preserve luminance. +</p></dd> +<dt><span>‘<samp>max</samp>’</span></dt> +<dd><p>Preserve max value of RGB triplet. +</p></dd> +<dt><span>‘<samp>avg</samp>’</span></dt> +<dd><p>Preserve average value of RGB triplet. +</p></dd> +<dt><span>‘<samp>sum</samp>’</span></dt> +<dd><p>Preserve sum value of RGB triplet. +</p></dd> +<dt><span>‘<samp>nrm</samp>’</span></dt> +<dd><p>Preserve normalized value of RGB triplet. +</p></dd> +<dt><span>‘<samp>pwr</samp>’</span></dt> +<dd><p>Preserve power value of RGB triplet. +</p></dd> +</dl> + +</dd> +<dt><span><samp>pa</samp></span></dt> +<dd><p>Set the preserve color amount when changing colors. Allowed range is from <code>[0.0, 1.0]</code>. +Default is <code>0.0</code>, thus disabled. +</p></dd> +</dl> + +<a name="Examples-54"></a> +<h4 class="subsection">11.32.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> 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="Commands-67"></a> +<h4 class="subsection">11.32.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-67" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-67" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colorize"></a> +<h3 class="section">11.33 colorize<span class="pull-right"><a class="anchor hidden-xs" href="#colorize" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorize" aria-hidden="true">TOC</a></span></h3> +<p>Overlay a solid color on the video stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>hue</samp></span></dt> +<dd><p>Set the color hue. Allowed range is from 0 to 360. +Default value is 0. +</p> +</dd> +<dt><span><samp>saturation</samp></span></dt> +<dd><p>Set the color saturation. Allowed range is from 0 to 1. +Default value is 0.5. +</p> +</dd> +<dt><span><samp>lightness</samp></span></dt> +<dd><p>Set the color lightness. Allowed range is from 0 to 1. +Default value is 0.5. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>Set the mix of source lightness. By default is set to 1.0. +Allowed range is from 0.0 to 1.0. +</p></dd> +</dl> + +<a name="Commands-68"></a> +<h4 class="subsection">11.33.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-68" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-68" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colorkey"></a> +<h3 class="section">11.34 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. +This filter operates on 8-bit RGB format frames by setting the alpha component of each pixel +which falls within the similarity radius of the key color to 0. The alpha value for pixels outside +the similarity radius depends on the value of the blend option. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>color</samp></span></dt> +<dd><p>Set the color for which alpha will be set to 0 (full transparency). +See <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +Default is <code>black</code>. +</p> +</dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Set the radius from the key color within which other colors also have full transparency. +The computed distance is related to the unit fractional distance in 3D space between the RGB values +of the key color and the pixel’s color. Range is 0.01 to 1.0. 0.01 matches within a very small radius +around the exact key color, while 1.0 matches everything. +Default is <code>0.01</code>. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Set how the alpha value for pixels that fall outside the similarity radius is computed. +0.0 makes pixels either fully transparent or fully opaque. +Higher values result in semi-transparent pixels, with greater transparency +the more similar the pixel color is to the key color. +Range is 0.0 to 1.0. Default is <code>0.0</code>. +</p></dd> +</dl> + +<a name="Examples-55"></a> +<h4 class="subsection">11.34.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> + +<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 "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv +</pre></div> +</li></ul> + +<a name="Commands-69"></a> +<h4 class="subsection">11.34.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-69" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-69" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="colorhold"></a> +<h3 class="section">11.35 colorhold<span class="pull-right"><a class="anchor hidden-xs" href="#colorhold" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorhold" aria-hidden="true">TOC</a></span></h3> +<p>Remove all color information for all RGB colors except for certain one. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>color</samp></span></dt> +<dd><p>The color which will not be replaced with neutral gray. +</p> +</dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Blend percentage. 0.0 makes pixels fully gray. +Higher values result in more preserved color. +</p></dd> +</dl> + +<a name="Commands-70"></a> +<h4 class="subsection">11.35.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-70" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-70" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="colorlevels"></a> +<h3 class="section">11.36 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><span><samp>rimin</samp></span></dt> +<dt><span><samp>gimin</samp></span></dt> +<dt><span><samp>bimin</samp></span></dt> +<dt><span><samp>aimin</samp></span></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><span><samp>rimax</samp></span></dt> +<dt><span><samp>gimax</samp></span></dt> +<dt><span><samp>bimax</samp></span></dt> +<dt><span><samp>aimax</samp></span></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><span><samp>romin</samp></span></dt> +<dt><span><samp>gomin</samp></span></dt> +<dt><span><samp>bomin</samp></span></dt> +<dt><span><samp>aomin</samp></span></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><span><samp>romax</samp></span></dt> +<dt><span><samp>gomax</samp></span></dt> +<dt><span><samp>bomax</samp></span></dt> +<dt><span><samp>aomax</samp></span></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> +<dt><span><samp>preserve</samp></span></dt> +<dd><p>Set preserve color mode. The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Disable color preserving, this is default. +</p></dd> +<dt><span>‘<samp>lum</samp>’</span></dt> +<dd><p>Preserve luminance. +</p></dd> +<dt><span>‘<samp>max</samp>’</span></dt> +<dd><p>Preserve max value of RGB triplet. +</p></dd> +<dt><span>‘<samp>avg</samp>’</span></dt> +<dd><p>Preserve average value of RGB triplet. +</p></dd> +<dt><span>‘<samp>sum</samp>’</span></dt> +<dd><p>Preserve sum value of RGB triplet. +</p></dd> +<dt><span>‘<samp>nrm</samp>’</span></dt> +<dd><p>Preserve normalized value of RGB triplet. +</p></dd> +<dt><span>‘<samp>pwr</samp>’</span></dt> +<dd><p>Preserve power value of RGB triplet. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-56"></a> +<h4 class="subsection">11.36.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> 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="Commands-71"></a> +<h4 class="subsection">11.36.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-71" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-71" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="colormap"></a> +<h3 class="section">11.37 colormap<span class="pull-right"><a class="anchor hidden-xs" href="#colormap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colormap" aria-hidden="true">TOC</a></span></h3> +<p>Apply custom color maps to video stream. +</p> +<p>This filter needs three input video streams. +First stream is video stream that is going to be filtered out. +Second and third video stream specify color patches for source +color to target color mapping. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>patch_size</samp></span></dt> +<dd><p>Set the source and target video stream patch size in pixels. +</p> +</dd> +<dt><span><samp>nb_patches</samp></span></dt> +<dd><p>Set the max number of used patches from source and target video stream. +Default value is number of patches available in additional video streams. +Max allowed number of patches is <code>64</code>. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set the adjustments used for target colors. Can be <code>relative</code> or <code>absolute</code>. +Defaults is <code>absolute</code>. +</p> +</dd> +<dt><span><samp>kernel</samp></span></dt> +<dd><p>Set the kernel used to measure color differences between mapped colors. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>euclidean</samp>’</span></dt> +<dt><span>‘<samp>weuclidean</samp>’</span></dt> +</dl> + +<p>Default is <code>euclidean</code>. +</p></dd> +</dl> + +<a name="colormatrix"></a> +<h3 class="section">11.38 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><span><samp>src</samp></span></dt> +<dt><span><samp>dst</samp></span></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><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>fcc</samp>’</span></dt> +<dd><p>FCC +</p> +</dd> +<dt><span>‘<samp>bt601</samp>’</span></dt> +<dd><p>BT.601 +</p> +</dd> +<dt><span>‘<samp>bt470</samp>’</span></dt> +<dd><p>BT.470 +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>bt2020</samp>’</span></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">11.39 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. +Input video needs to have an even size. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dd><span id="all"></span></dd> +<dt><span><samp>all</samp></span></dt> +<dd><p>Specify all color properties at once. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>bt470m</samp>’</span></dt> +<dd><p>BT.470M +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG +</p> +</dd> +<dt><span>‘<samp>bt601-6-525</samp>’</span></dt> +<dd><p>BT.601-6 525 +</p> +</dd> +<dt><span>‘<samp>bt601-6-625</samp>’</span></dt> +<dd><p>BT.601-6 625 +</p> +</dd> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>bt2020</samp>’</span></dt> +<dd><p>BT.2020 +</p> +</dd> +</dl> + +<span id="space"></span></dd> +<dt><span><samp>space</samp></span></dt> +<dd><p>Specify output colorspace. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>fcc</samp>’</span></dt> +<dd><p>FCC +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG or BT.601-6 625 +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M or BT.601-6 525 +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>ycgco</samp>’</span></dt> +<dd><p>YCgCo +</p> +</dd> +<dt><span>‘<samp>bt2020ncl</samp>’</span></dt> +<dd><p>BT.2020 with non-constant luminance +</p> +</dd> +</dl> + +<span id="trc"></span></dd> +<dt><span><samp>trc</samp></span></dt> +<dd><p>Specify output transfer characteristics. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>bt470m</samp>’</span></dt> +<dd><p>BT.470M +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG +</p> +</dd> +<dt><span>‘<samp>gamma22</samp>’</span></dt> +<dd><p>Constant gamma of 2.2 +</p> +</dd> +<dt><span>‘<samp>gamma28</samp>’</span></dt> +<dd><p>Constant gamma of 2.8 +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M, BT.601-6 625 or BT.601-6 525 +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>srgb</samp>’</span></dt> +<dd><p>SRGB +</p> +</dd> +<dt><span>‘<samp>iec61966-2-1</samp>’</span></dt> +<dd><p>iec61966-2-1 +</p> +</dd> +<dt><span>‘<samp>iec61966-2-4</samp>’</span></dt> +<dd><p>iec61966-2-4 +</p> +</dd> +<dt><span>‘<samp>xvycc</samp>’</span></dt> +<dd><p>xvycc +</p> +</dd> +<dt><span>‘<samp>bt2020-10</samp>’</span></dt> +<dd><p>BT.2020 for 10-bits content +</p> +</dd> +<dt><span>‘<samp>bt2020-12</samp>’</span></dt> +<dd><p>BT.2020 for 12-bits content +</p> +</dd> +</dl> + +<span id="primaries"></span></dd> +<dt><span><samp>primaries</samp></span></dt> +<dd><p>Specify output color primaries. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>bt470m</samp>’</span></dt> +<dd><p>BT.470M +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG or BT.601-6 625 +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M or BT.601-6 525 +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>film</samp>’</span></dt> +<dd><p>film +</p> +</dd> +<dt><span>‘<samp>smpte431</samp>’</span></dt> +<dd><p>SMPTE-431 +</p> +</dd> +<dt><span>‘<samp>smpte432</samp>’</span></dt> +<dd><p>SMPTE-432 +</p> +</dd> +<dt><span>‘<samp>bt2020</samp>’</span></dt> +<dd><p>BT.2020 +</p> +</dd> +<dt><span>‘<samp>jedec-p22</samp>’</span></dt> +<dd><p>JEDEC P22 phosphors +</p> +</dd> +</dl> + +<span id="range"></span></dd> +<dt><span><samp>range</samp></span></dt> +<dd><p>Specify output color range. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>tv</samp>’</span></dt> +<dd><p>TV (restricted) range +</p> +</dd> +<dt><span>‘<samp>mpeg</samp>’</span></dt> +<dd><p>MPEG (restricted) range +</p> +</dd> +<dt><span>‘<samp>pc</samp>’</span></dt> +<dd><p>PC (full) range +</p> +</dd> +<dt><span>‘<samp>jpeg</samp>’</span></dt> +<dd><p>JPEG (full) range +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Specify output color format. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>yuv420p</samp>’</span></dt> +<dd><p>YUV 4:2:0 planar 8-bits +</p> +</dd> +<dt><span>‘<samp>yuv420p10</samp>’</span></dt> +<dd><p>YUV 4:2:0 planar 10-bits +</p> +</dd> +<dt><span>‘<samp>yuv420p12</samp>’</span></dt> +<dd><p>YUV 4:2:0 planar 12-bits +</p> +</dd> +<dt><span>‘<samp>yuv422p</samp>’</span></dt> +<dd><p>YUV 4:2:2 planar 8-bits +</p> +</dd> +<dt><span>‘<samp>yuv422p10</samp>’</span></dt> +<dd><p>YUV 4:2:2 planar 10-bits +</p> +</dd> +<dt><span>‘<samp>yuv422p12</samp>’</span></dt> +<dd><p>YUV 4:2:2 planar 12-bits +</p> +</dd> +<dt><span>‘<samp>yuv444p</samp>’</span></dt> +<dd><p>YUV 4:4:4 planar 8-bits +</p> +</dd> +<dt><span>‘<samp>yuv444p10</samp>’</span></dt> +<dd><p>YUV 4:4:4 planar 10-bits +</p> +</dd> +<dt><span>‘<samp>yuv444p12</samp>’</span></dt> +<dd><p>YUV 4:4:4 planar 12-bits +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>fast</samp></span></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><span><samp>dither</samp></span></dt> +<dd><p>Specify dithering mode. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>No dithering +</p> +</dd> +<dt><span>‘<samp>fsb</samp>’</span></dt> +<dd><p>Floyd-Steinberg dithering +</p></dd> +</dl> + +</dd> +<dt><span><samp>wpadapt</samp></span></dt> +<dd><p>Whitepoint adaptation mode. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>bradford</samp>’</span></dt> +<dd><p>Bradford whitepoint adaptation +</p> +</dd> +<dt><span>‘<samp>vonkries</samp>’</span></dt> +<dd><p>von Kries whitepoint adaptation +</p> +</dd> +<dt><span>‘<samp>identity</samp>’</span></dt> +<dd><p>identity whitepoint adaptation (i.e. no whitepoint adaptation) +</p></dd> +</dl> + +</dd> +<dt><span><samp>iall</samp></span></dt> +<dd><p>Override all input properties at once. Same accepted values as <a href="#all">all</a>. +</p> +</dd> +<dt><span><samp>ispace</samp></span></dt> +<dd><p>Override input colorspace. Same accepted values as <a href="#space">space</a>. +</p> +</dd> +<dt><span><samp>iprimaries</samp></span></dt> +<dd><p>Override input color primaries. Same accepted values as <a href="#primaries">primaries</a>. +</p> +</dd> +<dt><span><samp>itrc</samp></span></dt> +<dd><p>Override input transfer characteristics. Same accepted values as <a href="#trc">trc</a>. +</p> +</dd> +<dt><span><samp>irange</samp></span></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 "all" 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="colorspace_005fcuda"></a> +<h3 class="section">11.40 colorspace_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#colorspace_005fcuda" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorspace_005fcuda" aria-hidden="true">TOC</a></span></h3> + +<p>CUDA accelerated implementation of the colorspace filter. +</p> +<p>It is by no means feature complete compared to the software colorspace filter, +and at the current time only supports color range conversion between jpeg/full +and mpeg/limited range. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>range</samp></span></dt> +<dd><p>Specify output color range. +</p> +<p>The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>tv</samp>’</span></dt> +<dd><p>TV (restricted) range +</p> +</dd> +<dt><span>‘<samp>mpeg</samp>’</span></dt> +<dd><p>MPEG (restricted) range +</p> +</dd> +<dt><span>‘<samp>pc</samp>’</span></dt> +<dd><p>PC (full) range +</p> +</dd> +<dt><span>‘<samp>jpeg</samp>’</span></dt> +<dd><p>JPEG (full) range +</p> +</dd> +</dl> + +</dd> +</dl> + +<a name="colortemperature"></a> +<h3 class="section">11.41 colortemperature<span class="pull-right"><a class="anchor hidden-xs" href="#colortemperature" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colortemperature" aria-hidden="true">TOC</a></span></h3> +<p>Adjust color temperature in video to simulate variations in ambient color temperature. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>temperature</samp></span></dt> +<dd><p>Set the temperature in Kelvin. Allowed range is from 1000 to 40000. +Default value is 6500 K. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>Set mixing with filtered output. Allowed range is from 0 to 1. +Default value is 1. +</p> +</dd> +<dt><span><samp>pl</samp></span></dt> +<dd><p>Set the amount of preserving lightness. Allowed range is from 0 to 1. +Default value is 0. +</p></dd> +</dl> + +<a name="Commands-72"></a> +<h4 class="subsection">11.41.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-72" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-72" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="convolution"></a> +<h3 class="section">11.42 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 of 3x3, 5x5, 7x7 or horizontal/vertical up to 49 elements. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>0m</samp></span></dt> +<dt><span><samp>1m</samp></span></dt> +<dt><span><samp>2m</samp></span></dt> +<dt><span><samp>3m</samp></span></dt> +<dd><p>Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed integers in <var>square</var> mode, +and from 1 to 49 odd number of signed integers in <var>row</var> mode. +</p> +</dd> +<dt><span><samp>0rdiv</samp></span></dt> +<dt><span><samp>1rdiv</samp></span></dt> +<dt><span><samp>2rdiv</samp></span></dt> +<dt><span><samp>3rdiv</samp></span></dt> +<dd><p>Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +</p> +</dd> +<dt><span><samp>0bias</samp></span></dt> +<dt><span><samp>1bias</samp></span></dt> +<dt><span><samp>2bias</samp></span></dt> +<dt><span><samp>3bias</samp></span></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> +<dt><span><samp>0mode</samp></span></dt> +<dt><span><samp>1mode</samp></span></dt> +<dt><span><samp>2mode</samp></span></dt> +<dt><span><samp>3mode</samp></span></dt> +<dd><p>Set matrix mode for each plane. Can be <var>square</var>, <var>row</var> or <var>column</var>. +Default is <var>square</var>. +</p></dd> +</dl> + +<a name="Commands-73"></a> +<h4 class="subsection">11.42.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-73" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-73" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-57"></a> +<h4 class="subsection">11.42.2 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> Apply sharpen: +<div class="example"> +<pre class="example">convolution="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" +</pre></div> + +</li><li> Apply blur: +<div class="example"> +<pre class="example">convolution="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" +</pre></div> + +</li><li> Apply edge enhance: +<div class="example"> +<pre class="example">convolution="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" +</pre></div> + +</li><li> Apply edge detect: +<div class="example"> +<pre class="example">convolution="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" +</pre></div> + +</li><li> Apply laplacian edge detector which includes diagonals: +<div class="example"> +<pre class="example">convolution="1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0" +</pre></div> + +</li><li> Apply emboss: +<div class="example"> +<pre class="example">convolution="-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" +</pre></div> +</li></ul> + +<a name="convolve"></a> +<h3 class="section">11.43 convolve<span class="pull-right"><a class="anchor hidden-xs" href="#convolve" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-convolve" aria-hidden="true">TOC</a></span></h3> + +<p>Apply 2D convolution of video stream in frequency domain using second stream +as impulse. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. +</p> +</dd> +<dt><span><samp>impulse</samp></span></dt> +<dd><p>Set which impulse video frames will be processed, can be <var>first</var> +or <var>all</var>. Default is <var>all</var>. +</p></dd> +</dl> + +<p>The <code>convolve</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="copy"></a> +<h3 class="section">11.44 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 video source unchanged to the output. This is mainly useful for +testing purposes. +</p> +<span id="coreimage"></span><a name="coreimage-1"></a> +<h3 class="section">11.45 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’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><span><samp>list_filters</samp></span></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><span><samp>filter</samp></span></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=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...] +</pre></div> + +</dd> +<dt><span><samp>output_rect</samp></span></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-58"></a> +<h4 class="subsection">11.45.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> 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’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="cover_005frect"></a> +<h3 class="section">11.46 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><span><samp>cover</samp></span></dt> +<dd><p>Filepath of the optional cover image, needs to be in yuv420. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set covering mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>cover</samp>’</span></dt> +<dd><p>cover it by the supplied image +</p></dd> +<dt><span>‘<samp>blur</samp>’</span></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-59"></a> +<h4 class="subsection">11.46.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> Cover a rectangular object by the supplied image 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="crop"></a> +<h3 class="section">11.47 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><span><samp>w, out_w</samp></span></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 ‘<samp>w</samp>’ or ‘<samp>out_w</samp>’ command is sent. +</p> +</dd> +<dt><span><samp>h, out_h</samp></span></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 ‘<samp>h</samp>’ or ‘<samp>out_h</samp>’ command is sent. +</p> +</dd> +<dt><span><samp>x</samp></span></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><span><samp>y</samp></span></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><span><samp>keep_aspect</samp></span></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><span><samp>exact</samp></span></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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The computed values for <var>x</var> and <var>y</var>. They are evaluated for +each new frame. +</p> +</dd> +<dt><span><samp>in_w</samp></span></dt> +<dt><span><samp>in_h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>iw</samp></span></dt> +<dt><span><samp>ih</samp></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><samp>out_w</samp></span></dt> +<dt><span><samp>out_h</samp></span></dt> +<dd><p>The output (cropped) width and height. +</p> +</dd> +<dt><span><samp>ow</samp></span></dt> +<dt><span><samp>oh</samp></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>. +</p> +</dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><samp>dar</samp></span></dt> +<dd><p>input display aspect ratio, it is the same as (<var>iw</var> / <var>ih</var>) * <var>sar</var> +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>The number of the input frame, starting from 0. +</p> +</dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>the position in the file of the input frame, NAN if unknown +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The timestamp expressed in seconds. It’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-60"></a> +<h4 class="subsection">11.47.1 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> 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)" +</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-74"></a> +<h4 class="subsection">11.47.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-74" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-74" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>w, out_w</samp></span></dt> +<dt><span><samp>h, out_h</samp></span></dt> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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">11.48 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 or video area of the input video according to <var>mode</var>. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Depending on <var>mode</var> crop detection is based on either the mere black value of surrounding pixels or a combination of motion vectors and edge pixels. +</p> +<dl compact="compact"> +<dt><span>‘<samp>black</samp>’</span></dt> +<dd><p>Detect black pixels surrounding the playing video. For fine control use option <var>limit</var>. +</p> +</dd> +<dt><span>‘<samp>mvedges</samp>’</span></dt> +<dd><p>Detect the playing video by the motion vectors inside the video and scanning for edge pixels typically forming the border of a playing video. +</p></dd> +</dl> + +</dd> +<dt><span><samp>limit</samp></span></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><span><samp>round</samp></span></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><span><samp>skip</samp></span></dt> +<dd><p>Set the number of initial frames for which evaluation is skipped. +Default is 2. Range is 0 to INT_MAX. +</p> +</dd> +<dt><span><samp>reset_count, reset</samp></span></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 ’never reset’, and returns the largest area encountered during +playback. +</p> +</dd> +<dt><span><samp>mv_threshold</samp></span></dt> +<dd><p>Set motion in pixel units as threshold for motion detection. It defaults to 8. +</p> +</dd> +<dt><span><samp>low</samp></span></dt> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set low and high threshold values used by the Canny thresholding +algorithm. +</p> +<p>The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" 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>5/255</code>, and default value for <var>high</var> +is <code>15/255</code>. +</p></dd> +</dl> + +<a name="Examples-61"></a> +<h4 class="subsection">11.48.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> Find video area surrounded by black borders: +<div class="example"> +<pre class="example">ffmpeg -i file.mp4 -vf cropdetect,metadata=mode=print -f null - +</pre></div> + +</li><li> Find an embedded video area, generate motion vectors beforehand: +<div class="example"> +<pre class="example">ffmpeg -i file.mp4 -vf mestimate,cropdetect=mode=mvedges,metadata=mode=print -f null - +</pre></div> + +</li><li> Find an embedded video area, use motion vectors from decoder: +<div class="example"> +<pre class="example">ffmpeg -flags2 +export_mvs -i file.mp4 -vf cropdetect=mode=mvedges,metadata=mode=print -f null - +</pre></div> +</li></ul> + +<span id="cue"></span><a name="cue-1"></a> +<h3 class="section">11.49 cue<span class="pull-right"><a class="anchor hidden-xs" href="#cue-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cue-1" aria-hidden="true">TOC</a></span></h3> + +<p>Delay video filtering until a given wallclock timestamp. The filter first +passes on <samp>preroll</samp> amount of frames, then it buffers at most +<samp>buffer</samp> amount of frames and waits for the cue. After reaching the cue +it forwards the buffered frames and also any subsequent frames coming in its +input. +</p> +<p>The filter can be used synchronize the output of multiple ffmpeg processes for +realtime output devices like decklink. By putting the delay in the filtering +chain and pre-buffering frames the process can pass on data to output almost +immediately after the target wallclock timestamp is reached. +</p> +<p>Perfect frame accuracy cannot be guaranteed, but the result is good enough for +some use cases. +</p> +<dl compact="compact"> +<dt><span><samp>cue</samp></span></dt> +<dd><p>The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0. +</p> +</dd> +<dt><span><samp>preroll</samp></span></dt> +<dd><p>The duration of content to pass on as preroll expressed in seconds. Default is 0. +</p> +</dd> +<dt><span><samp>buffer</samp></span></dt> +<dd><p>The maximum duration of content to buffer before waiting for the cue expressed +in seconds. Default is 0. +</p> +</dd> +</dl> + +<span id="curves"></span><a name="curves-1"></a> +<h3 class="section">11.50 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 +"adjusted" 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 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. The curve is +formed by using a natural or monotonic cubic spline interpolation, depending +on the <var>interp</var> option (default: <code>natural</code>). The <code>natural</code> +spline produces a smoother curve in general while the monotonic (<code>pchip</code>) +spline guarantees the transitions between the specified points to be +monotonic. 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><span><samp>preset</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dt><span>‘<samp>color_negative</samp>’</span></dt> +<dt><span>‘<samp>cross_process</samp>’</span></dt> +<dt><span>‘<samp>darker</samp>’</span></dt> +<dt><span>‘<samp>increase_contrast</samp>’</span></dt> +<dt><span>‘<samp>lighter</samp>’</span></dt> +<dt><span>‘<samp>linear_contrast</samp>’</span></dt> +<dt><span>‘<samp>medium_contrast</samp>’</span></dt> +<dt><span>‘<samp>negative</samp>’</span></dt> +<dt><span>‘<samp>strong_contrast</samp>’</span></dt> +<dt><span>‘<samp>vintage</samp>’</span></dt> +</dl> +<p>Default is <code>none</code>. +</p></dd> +<dt><span><samp>master, m</samp></span></dt> +<dd><p>Set the master key points. These points will define a second pass mapping. It +is sometimes called a "luminance" or "value" 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><span><samp>red, r</samp></span></dt> +<dd><p>Set the key points for the red component. +</p></dd> +<dt><span><samp>green, g</samp></span></dt> +<dd><p>Set the key points for the green component. +</p></dd> +<dt><span><samp>blue, b</samp></span></dt> +<dd><p>Set the key points for the blue component. +</p></dd> +<dt><span><samp>all</samp></span></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><span><samp>psfile</samp></span></dt> +<dd><p>Specify a Photoshop curves file (<code>.acv</code>) to import the settings from. +</p></dd> +<dt><span><samp>plot</samp></span></dt> +<dd><p>Save Gnuplot script of the curves in specified file. +</p></dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Specify the kind of interpolation. Available algorithms are: +</p><dl compact="compact"> +<dt><span>‘<samp>natural</samp>’</span></dt> +<dd><p>Natural cubic spline using a piece-wise cubic polynomial that is twice continuously differentiable. +</p></dd> +<dt><span>‘<samp>pchip</samp>’</span></dt> +<dd><p>Monotonic cubic spline using a piecewise cubic Hermite interpolating polynomial (PCHIP). +</p></dd> +</dl> + +</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="Commands-75"></a> +<h4 class="subsection">11.50.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-75" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-75" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="Examples-62"></a> +<h4 class="subsection">11.50.2 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> 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><span><var>red</var></span></dt> +<dd><p><code>(0;0.11) (0.42;0.51) (1;0.95)</code> +</p></dd> +<dt><span><var>green</var></span></dt> +<dd><p><code>(0;0) (0.50;0.48) (1;1)</code> +</p></dd> +<dt><span><var>blue</var></span></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">11.51 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><span><samp>size, s</samp></span></dt> +<dd><p>Set output video size. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dd><p>Set x offset from where to pick pixels. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set y offset from where to pick pixels. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set scope mode, can be one of the following: +</p><dl compact="compact"> +<dt><span>‘<samp>mono</samp>’</span></dt> +<dd><p>Draw hexadecimal pixel values with white color on black background. +</p> +</dd> +<dt><span>‘<samp>color</samp>’</span></dt> +<dd><p>Draw hexadecimal pixel values with input video pixel color on black +background. +</p> +</dd> +<dt><span>‘<samp>color2</samp>’</span></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><span><samp>axis</samp></span></dt> +<dd><p>Draw rows and columns numbers on left and top of video. +</p> +</dd> +<dt><span><samp>opacity</samp></span></dt> +<dd><p>Set background opacity. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Set display number format. Can be <code>hex</code>, or <code>dec</code>. Default is <code>hex</code>. +</p> +</dd> +<dt><span><samp>components</samp></span></dt> +<dd><p>Set pixel components to display. By default all pixel components are displayed. +</p></dd> +</dl> + +<a name="Commands-76"></a> +<h4 class="subsection">11.51.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-76" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-76" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options excluding <code>size</code> option. +</p> +<a name="dblur"></a> +<h3 class="section">11.52 dblur<span class="pull-right"><a class="anchor hidden-xs" href="#dblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dblur" aria-hidden="true">TOC</a></span></h3> +<p>Apply Directional blur filter. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>angle</samp></span></dt> +<dd><p>Set angle of directional blur. Default is <code>45</code>. +</p> +</dd> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set radius of directional blur. Default is <code>5</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. By default all planes are filtered. +</p></dd> +</dl> + +<a name="Commands-77"></a> +<h4 class="subsection">11.52.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-77" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-77" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="dctdnoiz"></a> +<h3 class="section">11.53 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><span><samp>sigma, s</samp></span></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><span><samp>overlap</samp></span></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’t permit processing the whole input width or +height, a warning will be displayed and according borders won’t be denoised. +</p> +<p>Default value is <var>blocksize</var>-1, which is the best possible setting. +</p> +</dd> +<dt><span><samp>expr, e</samp></span></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><span><samp>n</samp></span></dt> +<dd><p>Set the <var>blocksize</var> using the number of bits. <code>1<<<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-63"></a> +<h4 class="subsection">11.53.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> + +<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">11.54 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><span><samp>1thr</samp></span></dt> +<dt><span><samp>2thr</samp></span></dt> +<dt><span><samp>3thr</samp></span></dt> +<dt><span><samp>4thr</samp></span></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><span><samp>range, r</samp></span></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><span><samp>direction, d</samp></span></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><span><samp>blur, b</samp></span></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> +<dt><span><samp>coupling, c</samp></span></dt> +<dd><p>If enabled, current pixel is changed if and only if all pixel components are banded, +e.g. banding detection threshold is triggered for all color components. +The default is disabled. +</p></dd> +</dl> + +<a name="Commands-78"></a> +<h4 class="subsection">11.54.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-78" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-78" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="deblock"></a> +<h3 class="section">11.55 deblock<span class="pull-right"><a class="anchor hidden-xs" href="#deblock" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deblock" aria-hidden="true">TOC</a></span></h3> + +<p>Remove blocking artifacts from input video. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>filter</samp></span></dt> +<dd><p>Set filter type, can be <var>weak</var> or <var>strong</var>. Default is <var>strong</var>. +This controls what kind of deblocking is applied. +</p> +</dd> +<dt><span><samp>block</samp></span></dt> +<dd><p>Set size of block, allowed range is from 4 to 512. Default is <var>8</var>. +</p> +</dd> +<dt><span><samp>alpha</samp></span></dt> +<dt><span><samp>beta</samp></span></dt> +<dt><span><samp>gamma</samp></span></dt> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set blocking detection thresholds. Allowed range is 0 to 1. +Defaults are: <var>0.098</var> for <var>alpha</var> and <var>0.05</var> for the rest. +Using higher threshold gives more deblocking strength. +Setting <var>alpha</var> controls threshold detection at exact edge of block. +Remaining options controls threshold detection near the edge. Each one for +below/above or left/right. Setting any of those to <var>0</var> disables +deblocking. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is to filter all available planes. +</p></dd> +</dl> + +<a name="Examples-64"></a> +<h4 class="subsection">11.55.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> Deblock using weak filter and block size of 4 pixels. +<div class="example"> +<pre class="example">deblock=filter=weak:block=4 +</pre></div> + +</li><li> Deblock using strong filter, block size of 4 pixels and custom thresholds for +deblocking more edges. +<div class="example"> +<pre class="example">deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05 +</pre></div> + +</li><li> Similar as above, but filter only first plane. +<div class="example"> +<pre class="example">deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=1 +</pre></div> + +</li><li> Similar as above, but filter only second and third plane. +<div class="example"> +<pre class="example">deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6 +</pre></div> +</li></ul> + +<a name="Commands-79"></a> +<h4 class="subsection">11.55.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-79" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-79" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<span id="decimate"></span><a name="decimate-1"></a> +<h3 class="section">11.56 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><span><samp>cycle</samp></span></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><span><samp>dupthresh</samp></span></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><span><samp>scthresh</samp></span></dt> +<dd><p>Set scene change threshold. Default is <code>15</code>. +</p> +</dd> +<dt><span><samp>blockx</samp></span></dt> +<dt><span><samp>blocky</samp></span></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><span><samp>ppsrc</samp></span></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><span><samp>chroma</samp></span></dt> +<dd><p>Set whether or not chroma is considered in the metric calculations. Default is +<code>1</code>. +</p></dd> +</dl> + +<a name="deconvolve"></a> +<h3 class="section">11.57 deconvolve<span class="pull-right"><a class="anchor hidden-xs" href="#deconvolve" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deconvolve" aria-hidden="true">TOC</a></span></h3> + +<p>Apply 2D deconvolution of video stream in frequency domain using second stream +as impulse. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. +</p> +</dd> +<dt><span><samp>impulse</samp></span></dt> +<dd><p>Set which impulse video frames will be processed, can be <var>first</var> +or <var>all</var>. Default is <var>all</var>. +</p> +</dd> +<dt><span><samp>noise</samp></span></dt> +<dd><p>Set noise when doing divisions. Default is <var>0.0000001</var>. Useful when width +and height are not same and not power of 2 or if stream prior to convolving +had noise. +</p></dd> +</dl> + +<p>The <code>deconvolve</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="dedot"></a> +<h3 class="section">11.58 dedot<span class="pull-right"><a class="anchor hidden-xs" href="#dedot" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dedot" aria-hidden="true">TOC</a></span></h3> + +<p>Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>m</samp></span></dt> +<dd><p>Set mode of operation. Can be combination of <var>dotcrawl</var> for cross-luminance reduction and/or +<var>rainbows</var> for cross-color reduction. +</p> +</dd> +<dt><span><samp>lt</samp></span></dt> +<dd><p>Set spatial luma threshold. Lower values increases reduction of cross-luminance. +</p> +</dd> +<dt><span><samp>tl</samp></span></dt> +<dd><p>Set tolerance for temporal luma. Higher values increases reduction of cross-luminance. +</p> +</dd> +<dt><span><samp>tc</samp></span></dt> +<dd><p>Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color. +</p> +</dd> +<dt><span><samp>ct</samp></span></dt> +<dd><p>Set temporal chroma threshold. Lower values increases reduction of cross-color. +</p></dd> +</dl> + +<a name="deflate"></a> +<h3 class="section">11.59 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +</p></dd> +</dl> + +<a name="Commands-80"></a> +<h4 class="subsection">11.59.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-80" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-80" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="deflicker"></a> +<h3 class="section">11.60 deflicker<span class="pull-right"><a class="anchor hidden-xs" href="#deflicker" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deflicker" aria-hidden="true">TOC</a></span></h3> + +<p>Remove temporal frame luminance variations. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129. +</p> +</dd> +<dt><span><samp>mode, m</samp></span></dt> +<dd><p>Set averaging mode to smooth temporal luminance variations. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>am</samp>’</span></dt> +<dd><p>Arithmetic mean +</p> +</dd> +<dt><span>‘<samp>gm</samp>’</span></dt> +<dd><p>Geometric mean +</p> +</dd> +<dt><span>‘<samp>hm</samp>’</span></dt> +<dd><p>Harmonic mean +</p> +</dd> +<dt><span>‘<samp>qm</samp>’</span></dt> +<dd><p>Quadratic mean +</p> +</dd> +<dt><span>‘<samp>cm</samp>’</span></dt> +<dd><p>Cubic mean +</p> +</dd> +<dt><span>‘<samp>pm</samp>’</span></dt> +<dd><p>Power mean +</p> +</dd> +<dt><span>‘<samp>median</samp>’</span></dt> +<dd><p>Median +</p></dd> +</dl> + +</dd> +<dt><span><samp>bypass</samp></span></dt> +<dd><p>Do not actually modify frame. Useful when one only wants metadata. +</p></dd> +</dl> + +<a name="dejudder"></a> +<h3 class="section">11.61 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><span><samp>cycle</samp></span></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><span>‘<samp>4</samp>’</span></dt> +<dd><p>If the original was telecined from 24 to 30 fps (Film to NTSC). +</p> +</dd> +<dt><span>‘<samp>5</samp>’</span></dt> +<dd><p>If the original was telecined from 25 to 30 fps (PAL to NTSC). +</p> +</dd> +<dt><span>‘<samp>20</samp>’</span></dt> +<dd><p>If a mixture of the two. +</p></dd> +</dl> + +<p>The default is ‘<samp>4</samp>’. +</p></dd> +</dl> + +<a name="delogo"></a> +<h3 class="section">11.62 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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Specify the top left corner coordinates of the logo. They must be +specified. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Specify the width and height of the logo to clear. They must be +specified. +</p> +</dd> +<dt><span><samp>show</samp></span></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-65"></a> +<h4 class="subsection">11.62.1 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> + +<ul> +<li> Set a rectangle covering the area with top left corner coordinates 0,0 +and size 100x77: +<div class="example"> +<pre class="example">delogo=x=0:y=0:w=100:h=77 +</pre></div> + +</li></ul> + +<span id="derain"></span><a name="derain-1"></a> +<h3 class="section">11.63 derain<span class="pull-right"><a class="anchor hidden-xs" href="#derain-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-derain-1" aria-hidden="true">TOC</a></span></h3> + +<p>Remove the rain in the input image/video by applying the derain methods based on +convolutional neural networks. Supported models: +</p> +<ul> +<li> Recurrent Squeeze-and-Excitation Context Aggregation Net (RESCAN). +See <a href="http://openaccess.thecvf.com/content_ECCV_2018/papers/Xia_Li_Recurrent_Squeeze-and-Excitation_Context_ECCV_2018_paper.pdf">http://openaccess.thecvf.com/content_ECCV_2018/papers/Xia_Li_Recurrent_Squeeze-and-Excitation_Context_ECCV_2018_paper.pdf</a>. +</li></ul> + +<p>Training as well as model generation scripts are provided in +the repository at <a href="https://github.com/XueweiMeng/derain_filter.git">https://github.com/XueweiMeng/derain_filter.git</a>. +</p> +<p>Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>filter_type</samp></span></dt> +<dd><p>Specify which filter to use. This option accepts the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>derain</samp>’</span></dt> +<dd><p>Derain filter. To conduct derain filter, you need to use a derain model. +</p> +</dd> +<dt><span>‘<samp>dehaze</samp>’</span></dt> +<dd><p>Dehaze filter. To conduct dehaze filter, you need to use a dehaze model. +</p></dd> +</dl> +<p>Default value is ‘<samp>derain</samp>’. +</p> +</dd> +<dt><span><samp>dnn_backend</samp></span></dt> +<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>native</samp>’</span></dt> +<dd><p>Native implementation of DNN loading and execution. +</p> +</dd> +<dt><span>‘<samp>tensorflow</samp>’</span></dt> +<dd><p>TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +<a href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with +<code>--enable-libtensorflow</code> +</p></dd> +</dl> +<p>Default value is ‘<samp>native</samp>’. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +</p></dd> +</dl> + +<p>To get full functionality (such as async execution), please use the <a href="#dnn_005fprocessing">dnn_processing</a> filter. +</p> +<a name="deshake"></a> +<h3 class="section">11.64 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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></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><span><samp>rx</samp></span></dt> +<dt><span><samp>ry</samp></span></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><span><samp>edge</samp></span></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><span>‘<samp>blank, 0</samp>’</span></dt> +<dd><p>Fill zeroes at blank locations +</p></dd> +<dt><span>‘<samp>original, 1</samp>’</span></dt> +<dd><p>Original image at blank locations +</p></dd> +<dt><span>‘<samp>clamp, 2</samp>’</span></dt> +<dd><p>Extruded edge value at blank locations +</p></dd> +<dt><span>‘<samp>mirror, 3</samp>’</span></dt> +<dd><p>Mirrored edge at blank locations +</p></dd> +</dl> +<p>Default value is ‘<samp>mirror</samp>’. +</p> +</dd> +<dt><span><samp>blocksize</samp></span></dt> +<dd><p>Specify the blocksize to use for motion search. Range 4-128 pixels, +default 8. +</p> +</dd> +<dt><span><samp>contrast</samp></span></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><span><samp>search</samp></span></dt> +<dd><p>Specify the search strategy. Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>exhaustive, 0</samp>’</span></dt> +<dd><p>Set exhaustive search +</p></dd> +<dt><span>‘<samp>less, 1</samp>’</span></dt> +<dd><p>Set less exhaustive search. +</p></dd> +</dl> +<p>Default value is ‘<samp>exhaustive</samp>’. +</p> +</dd> +<dt><span><samp>filename</samp></span></dt> +<dd><p>If set then a detailed log of the motion search is written to the +specified file. +</p> +</dd> +</dl> + +<a name="despill"></a> +<h3 class="section">11.65 despill<span class="pull-right"><a class="anchor hidden-xs" href="#despill" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-despill" aria-hidden="true">TOC</a></span></h3> + +<p>Remove unwanted contamination of foreground colors, caused by reflected color of +greenscreen or bluescreen. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set what type of despill to use. +</p> +</dd> +<dt><span><samp>mix</samp></span></dt> +<dd><p>Set how spillmap will be generated. +</p> +</dd> +<dt><span><samp>expand</samp></span></dt> +<dd><p>Set how much to get rid of still remaining spill. +</p> +</dd> +<dt><span><samp>red</samp></span></dt> +<dd><p>Controls amount of red in spill area. +</p> +</dd> +<dt><span><samp>green</samp></span></dt> +<dd><p>Controls amount of green in spill area. +Should be -1 for greenscreen. +</p> +</dd> +<dt><span><samp>blue</samp></span></dt> +<dd><p>Controls amount of blue in spill area. +Should be -1 for bluescreen. +</p> +</dd> +<dt><span><samp>brightness</samp></span></dt> +<dd><p>Controls brightness of spill area, preserving colors. +</p> +</dd> +<dt><span><samp>alpha</samp></span></dt> +<dd><p>Modify alpha from generated spillmap. +</p></dd> +</dl> + +<a name="Commands-81"></a> +<h4 class="subsection">11.65.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-81" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-81" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="detelecine"></a> +<h3 class="section">11.66 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><span><samp>first_field</samp></span></dt> +<dd><dl compact="compact"> +<dt><span>‘<samp>top, t</samp>’</span></dt> +<dd><p>top field first +</p></dd> +<dt><span>‘<samp>bottom, b</samp>’</span></dt> +<dd><p>bottom field first +The default value is <code>top</code>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>pattern</samp></span></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><span><samp>start_frame</samp></span></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> + +<span id="dilation"></span><a name="dilation-1"></a> +<h3 class="section">11.67 dilation<span class="pull-right"><a class="anchor hidden-xs" href="#dilation-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dilation-1" 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +</p> +</dd> +<dt><span><samp>coordinates</samp></span></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="Commands-82"></a> +<h4 class="subsection">11.67.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-82" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-82" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="displace"></a> +<h3 class="section">11.68 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><span><samp>edge</samp></span></dt> +<dd><p>Set displace behavior for pixels that are out of range. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>blank</samp>’</span></dt> +<dd><p>Missing pixels are replaced by black pixels. +</p> +</dd> +<dt><span>‘<samp>smear</samp>’</span></dt> +<dd><p>Adjacent pixels will spread out to replace missing pixels. +</p> +</dd> +<dt><span>‘<samp>wrap</samp>’</span></dt> +<dd><p>Out of range pixels are wrapped so they point to pixels of other side. +</p> +</dd> +<dt><span>‘<samp>mirror</samp>’</span></dt> +<dd><p>Out of range pixels will be replaced with mirrored pixels. +</p></dd> +</dl> +<p>Default is ‘<samp>smear</samp>’. +</p> +</dd> +</dl> + +<a name="Examples-66"></a> +<h4 class="subsection">11.68.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> 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="dnn_005fclassify"></a> +<h3 class="section">11.69 dnn_classify<span class="pull-right"><a class="anchor hidden-xs" href="#dnn_005fclassify" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dnn_005fclassify" aria-hidden="true">TOC</a></span></h3> + +<p>Do classification with deep neural networks based on bounding boxes. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>dnn_backend</samp></span></dt> +<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts +only openvino now, tensorflow backends will be added. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. +</p> +</dd> +<dt><span><samp>input</samp></span></dt> +<dd><p>Set the input name of the dnn network. +</p> +</dd> +<dt><span><samp>output</samp></span></dt> +<dd><p>Set the output name of the dnn network. +</p> +</dd> +<dt><span><samp>confidence</samp></span></dt> +<dd><p>Set the confidence threshold (default: 0.5). +</p> +</dd> +<dt><span><samp>labels</samp></span></dt> +<dd><p>Set path to label file specifying the mapping between label id and name. +Each label name is written in one line, tailing spaces and empty lines are skipped. +The first line is the name of label id 0, +and the second line is the name of label id 1, etc. +The label id is considered as name if the label file is not provided. +</p> +</dd> +<dt><span><samp>backend_configs</samp></span></dt> +<dd><p>Set the configs to be passed into backend +</p> +<p>For tensorflow backend, you can set its configs with <samp>sess_config</samp> options, +please use tools/python/tf_sess_config.py to get the configs for your system. +</p> +</dd> +</dl> + +<a name="dnn_005fdetect"></a> +<h3 class="section">11.70 dnn_detect<span class="pull-right"><a class="anchor hidden-xs" href="#dnn_005fdetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dnn_005fdetect" aria-hidden="true">TOC</a></span></h3> + +<p>Do object detection with deep neural networks. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>dnn_backend</samp></span></dt> +<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts +only openvino now, tensorflow backends will be added. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. +</p> +</dd> +<dt><span><samp>input</samp></span></dt> +<dd><p>Set the input name of the dnn network. +</p> +</dd> +<dt><span><samp>output</samp></span></dt> +<dd><p>Set the output name of the dnn network. +</p> +</dd> +<dt><span><samp>confidence</samp></span></dt> +<dd><p>Set the confidence threshold (default: 0.5). +</p> +</dd> +<dt><span><samp>labels</samp></span></dt> +<dd><p>Set path to label file specifying the mapping between label id and name. +Each label name is written in one line, tailing spaces and empty lines are skipped. +The first line is the name of label id 0 (usually it is ’background’), +and the second line is the name of label id 1, etc. +The label id is considered as name if the label file is not provided. +</p> +</dd> +<dt><span><samp>backend_configs</samp></span></dt> +<dd><p>Set the configs to be passed into backend. To use async execution, set async (default: set). +Roll back to sync execution if the backend does not support async. +</p> +</dd> +</dl> + +<span id="dnn_005fprocessing"></span><a name="dnn_005fprocessing-1"></a> +<h3 class="section">11.71 dnn_processing<span class="pull-right"><a class="anchor hidden-xs" href="#dnn_005fprocessing-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dnn_005fprocessing-1" aria-hidden="true">TOC</a></span></h3> + +<p>Do image processing with deep neural networks. It works together with another filter +which converts the pixel format of the Frame to what the dnn network requires. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>dnn_backend</samp></span></dt> +<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>native</samp>’</span></dt> +<dd><p>Native implementation of DNN loading and execution. +</p> +</dd> +<dt><span>‘<samp>tensorflow</samp>’</span></dt> +<dd><p>TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +<a href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with +<code>--enable-libtensorflow</code> +</p> +</dd> +<dt><span>‘<samp>openvino</samp>’</span></dt> +<dd><p>OpenVINO backend. To enable this backend you +need to build and install the OpenVINO for C library (see +<a href="https://github.com/openvinotoolkit/openvino/blob/master/build-instruction.md">https://github.com/openvinotoolkit/openvino/blob/master/build-instruction.md</a>) and configure FFmpeg with +<code>--enable-libopenvino</code> (–extra-cflags=-I... –extra-ldflags=-L... might +be needed if the header files and libraries are not installed into system path) +</p> +</dd> +</dl> + +<p>Default value is ‘<samp>native</samp>’. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow, OpenVINO and native +backend can load files for only its format. +</p> +<p>Native model file (.model) can be generated from TensorFlow model file (.pb) by using tools/python/convert.py +</p> +</dd> +<dt><span><samp>input</samp></span></dt> +<dd><p>Set the input name of the dnn network. +</p> +</dd> +<dt><span><samp>output</samp></span></dt> +<dd><p>Set the output name of the dnn network. +</p> +</dd> +<dt><span><samp>backend_configs</samp></span></dt> +<dd><p>Set the configs to be passed into backend. To use async execution, set async (default: set). +Roll back to sync execution if the backend does not support async. +</p> +<p>For tensorflow backend, you can set its configs with <samp>sess_config</samp> options, +please use tools/python/tf_sess_config.py to get the configs of TensorFlow backend for your system. +</p> +</dd> +</dl> + +<a name="Examples-67"></a> +<h4 class="subsection">11.71.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> Remove rain in rgb24 frame with can.pb (see <a href="#derain">derain</a> filter): +<div class="example"> +<pre class="example">./ffmpeg -i rain.jpg -vf format=rgb24,dnn_processing=dnn_backend=tensorflow:model=can.pb:input=x:output=y derain.jpg +</pre></div> + +</li><li> Halve the pixel value of the frame with format gray32f: +<div class="example"> +<pre class="example">ffmpeg -i input.jpg -vf format=grayf32,dnn_processing=model=halve_gray_float.model:input=dnn_in:output=dnn_out:dnn_backend=native -y out.native.png +</pre></div> + +</li><li> Handle the Y channel with srcnn.pb (see <a href="#sr">sr</a> filter) for frame with yuv420p (planar YUV formats supported): +<div class="example"> +<pre class="example">./ffmpeg -i 480p.jpg -vf format=yuv420p,scale=w=iw*2:h=ih*2,dnn_processing=dnn_backend=tensorflow:model=srcnn.pb:input=x:output=y -y srcnn.jpg +</pre></div> + +</li><li> Handle the Y channel with espcn.pb (see <a href="#sr">sr</a> filter), which changes frame size, for format yuv420p (planar YUV formats supported), +please use tools/python/tf_sess_config.py to get the configs of TensorFlow backend for your system. +<div class="example"> +<pre class="example">./ffmpeg -i 480p.jpg -vf format=yuv420p,dnn_processing=dnn_backend=tensorflow:model=espcn.pb:input=x:output=y:backend_configs=sess_config=0x10022805320e09cdccccccccccec3f20012a01303801 -y tmp.espcn.jpg +</pre></div> + +</li></ul> + +<a name="drawbox"></a> +<h3 class="section">11.72 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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The expressions which specify the top left corner coordinates of the box. It defaults to 0. +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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><span><samp>color, c</samp></span></dt> +<dd><p>Specify the color of the box to write. For the general syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. 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><span><samp>thickness, t</samp></span></dt> +<dd><p>The expression which sets the thickness of the box edge. +A value of <code>fill</code> will create a filled box. Default value is <code>3</code>. +</p> +<p>See below for the list of accepted constants. +</p> +</dd> +<dt><span><samp>replace</samp></span></dt> +<dd><p>Applicable if the input has alpha. With value <code>1</code>, the pixels of the painted box +will overwrite the video’s color and alpha pixels. +Default is <code>0</code>, which composites the box onto the input, leaving the video’s alpha intact. +</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><span><samp>dar</samp></span></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><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>in_h, ih</samp></span></dt> +<dt><span><samp>in_w, iw</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>The input sample aspect ratio. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The x and y offset coordinates where the box is drawn. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The width and height of the drawn box. +</p> +</dd> +<dt><span><samp>box_source</samp></span></dt> +<dd><p>Box source can be set as side_data_detection_bboxes if you want to use box data in +detection bboxes of side data. +</p> +<p>If <var>box_source</var> is set, the <var>x</var>, <var>y</var>, <var>width</var> and <var>height</var> will be ignored and +still use box data in detection bboxes of side data. So please do not use this parameter if you were +not sure about the box source. +</p> +</dd> +<dt><span><samp>t</samp></span></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-68"></a> +<h4 class="subsection">11.72.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> 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=fill +</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="Commands-83"></a> +<h4 class="subsection">11.72.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-83" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-83" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same commands as options. +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> +<span id="drawgraph"></span><a name="drawgraph-1"></a> +<h3 class="section">11.73 drawgraph<span class="pull-right"><a class="anchor hidden-xs" href="#drawgraph-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-drawgraph-1" aria-hidden="true">TOC</a></span></h3> +<p>Draw a graph using input video metadata. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>m1</samp></span></dt> +<dd><p>Set 1st frame metadata key from which metadata values will be used to draw a graph. +</p> +</dd> +<dt><span><samp>fg1</samp></span></dt> +<dd><p>Set 1st foreground color expression. +</p> +</dd> +<dt><span><samp>m2</samp></span></dt> +<dd><p>Set 2nd frame metadata key from which metadata values will be used to draw a graph. +</p> +</dd> +<dt><span><samp>fg2</samp></span></dt> +<dd><p>Set 2nd foreground color expression. +</p> +</dd> +<dt><span><samp>m3</samp></span></dt> +<dd><p>Set 3rd frame metadata key from which metadata values will be used to draw a graph. +</p> +</dd> +<dt><span><samp>fg3</samp></span></dt> +<dd><p>Set 3rd foreground color expression. +</p> +</dd> +<dt><span><samp>m4</samp></span></dt> +<dd><p>Set 4th frame metadata key from which metadata values will be used to draw a graph. +</p> +</dd> +<dt><span><samp>fg4</samp></span></dt> +<dd><p>Set 4th foreground color expression. +</p> +</dd> +<dt><span><samp>min</samp></span></dt> +<dd><p>Set minimal value of metadata value. +</p> +</dd> +<dt><span><samp>max</samp></span></dt> +<dd><p>Set maximal value of metadata value. +</p> +</dd> +<dt><span><samp>bg</samp></span></dt> +<dd><p>Set graph background color. Default is white. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set graph mode. +</p> +<p>Available values for mode is: +</p><dl compact="compact"> +<dt><span>‘<samp>bar</samp>’</span></dt> +<dt><span>‘<samp>dot</samp>’</span></dt> +<dt><span>‘<samp>line</samp>’</span></dt> +</dl> + +<p>Default is <code>line</code>. +</p> +</dd> +<dt><span><samp>slide</samp></span></dt> +<dd><p>Set slide mode. +</p> +<p>Available values for slide is: +</p><dl compact="compact"> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Draw new frame when right border is reached. +</p> +</dd> +<dt><span>‘<samp>replace</samp>’</span></dt> +<dd><p>Replace old columns with new ones. +</p> +</dd> +<dt><span>‘<samp>scroll</samp>’</span></dt> +<dd><p>Scroll from right to left. +</p> +</dd> +<dt><span>‘<samp>rscroll</samp>’</span></dt> +<dd><p>Scroll from left to right. +</p> +</dd> +<dt><span>‘<samp>picture</samp>’</span></dt> +<dd><p>Draw single picture. +</p></dd> +</dl> + +<p>Default is <code>frame</code>. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set size of graph video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +The default value is <code>900x256</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set the output frame rate. Default value is <code>25</code>. +</p> +<p>The foreground color expressions can use the following variables: +</p><dl compact="compact"> +<dt><span><samp>MIN</samp></span></dt> +<dd><p>Minimal value of metadata value. +</p> +</dd> +<dt><span><samp>MAX</samp></span></dt> +<dd><p>Maximal value of metadata value. +</p> +</dd> +<dt><span><samp>VAL</samp></span></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="drawgrid"></a> +<h3 class="section">11.74 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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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><span><samp>color, c</samp></span></dt> +<dd><p>Specify the color of the grid. For the general syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. If the special +value <code>invert</code> is used, the grid color is the same as the +video with inverted luma. +</p> +</dd> +<dt><span><samp>thickness, t</samp></span></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> +<dt><span><samp>replace</samp></span></dt> +<dd><p>Applicable if the input has alpha. With <code>1</code> the pixels of the painted grid +will overwrite the video’s color and alpha pixels. +Default is <code>0</code>, which composites the grid onto the input, leaving the video’s alpha intact. +</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><span><samp>dar</samp></span></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><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>in_h, ih</samp></span></dt> +<dt><span><samp>in_w, iw</samp></span></dt> +<dd><p>The input grid cell width and height. +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>The input sample aspect ratio. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The x and y coordinates of some point of grid intersection (meant to configure offset). +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The width and height of the drawn cell. +</p> +</dd> +<dt><span><samp>t</samp></span></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-69"></a> +<h4 class="subsection">11.74.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> 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="Commands-84"></a> +<h4 class="subsection">11.74.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-84" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-84" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same commands as options. +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> +<span id="drawtext"></span><a name="drawtext-1"></a> +<h3 class="section">11.75 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"></a> +<h4 class="subsection">11.75.1 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></h4> + +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>box</samp></span></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><span><samp>boxborderw</samp></span></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><span><samp>boxcolor</samp></span></dt> +<dd><p>The color to be used for drawing box around text. For the syntax of this +option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +</p> +<p>The default value of <var>boxcolor</var> is "white". +</p> +</dd> +<dt><span><samp>line_spacing</samp></span></dt> +<dd><p>Set the line spacing in pixels of the border to be drawn around the box using <var>box</var>. +The default value of <var>line_spacing</var> is 0. +</p> +</dd> +<dt><span><samp>borderw</samp></span></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><span><samp>bordercolor</samp></span></dt> +<dd><p>Set the color to be used for drawing border around text. For the syntax of this +option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +</p> +<p>The default value of <var>bordercolor</var> is "black". +</p> +</dd> +<dt><span><samp>expansion</samp></span></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><span><samp>basetime</samp></span></dt> +<dd><p>Set a start time for the count. Value is in microseconds. Only applied +in the deprecated strftime expansion mode. To emulate in normal expansion +mode use the <code>pts</code> function, supplying the start time (in seconds) +as the second argument. +</p> +</dd> +<dt><span><samp>fix_bounds</samp></span></dt> +<dd><p>If true, check and fix text coords to avoid clipping. +</p> +</dd> +<dt><span><samp>fontcolor</samp></span></dt> +<dd><p>The color to be used for drawing fonts. For the syntax of this option, check +the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +</p> +<p>The default value of <var>fontcolor</var> is "black". +</p> +</dd> +<dt><span><samp>fontcolor_expr</samp></span></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><span><samp>font</samp></span></dt> +<dd><p>The font family to be used for drawing text. By default Sans. +</p> +</dd> +<dt><span><samp>fontfile</samp></span></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><span><samp>alpha</samp></span></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><span><samp>fontsize</samp></span></dt> +<dd><p>The font size to be used for drawing text. +The default value of <var>fontsize</var> is 16. +</p> +</dd> +<dt><span><samp>text_shaping</samp></span></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><span><samp>ft_load_flags</samp></span></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><span><var>default</var></span></dt> +<dt><span><var>no_scale</var></span></dt> +<dt><span><var>no_hinting</var></span></dt> +<dt><span><var>render</var></span></dt> +<dt><span><var>no_bitmap</var></span></dt> +<dt><span><var>vertical_layout</var></span></dt> +<dt><span><var>force_autohint</var></span></dt> +<dt><span><var>crop_bitmap</var></span></dt> +<dt><span><var>pedantic</var></span></dt> +<dt><span><var>ignore_global_advance_width</var></span></dt> +<dt><span><var>no_recurse</var></span></dt> +<dt><span><var>ignore_transform</var></span></dt> +<dt><span><var>monochrome</var></span></dt> +<dt><span><var>linear_design</var></span></dt> +<dt><span><var>no_autohint</var></span></dt> +</dl> + +<p>Default value is "default". +</p> +<p>For more information consult the documentation for the FT_LOAD_* +libfreetype flags. +</p> +</dd> +<dt><span><samp>shadowcolor</samp></span></dt> +<dd><p>The color to be used for drawing a shadow behind the drawn text. For the +syntax of this option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the +ffmpeg-utils manual</a>. +</p> +<p>The default value of <var>shadowcolor</var> is "black". +</p> +</dd> +<dt><span><samp>shadowx</samp></span></dt> +<dt><span><samp>shadowy</samp></span></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 "0". +</p> +</dd> +<dt><span><samp>start_number</samp></span></dt> +<dd><p>The starting frame number for the n/frame_num variable. The default value +is "0". +</p> +</dd> +<dt><span><samp>tabsize</samp></span></dt> +<dd><p>The size in number of spaces to use for rendering the tab. +Default value is 4. +</p> +</dd> +<dt><span><samp>timecode</samp></span></dt> +<dd><p>Set the initial timecode representation in "hh:mm:ss[:;.]ff" +format. It can be used with or without text parameter. <var>timecode_rate</var> +option must be specified. +</p> +</dd> +<dt><span><samp>timecode_rate, rate, r</samp></span></dt> +<dd><p>Set the timecode frame rate (timecode only). Value will be rounded to nearest +integer. Minimum value is "1". +Drop-frame timecode is supported for frame rates 30 & 60. +</p> +</dd> +<dt><span><samp>tc24hmax</samp></span></dt> +<dd><p>If set to 1, the output of the timecode option will wrap around at 24 hours. +Default is 0 (disabled). +</p> +</dd> +<dt><span><samp>text</samp></span></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><span><samp>textfile</samp></span></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><span><samp>text_source</samp></span></dt> +<dd><p>Text source should be set as side_data_detection_bboxes if you want to use text data in +detection bboxes of side data. +</p> +<p>If text source is set, <var>text</var> and <var>textfile</var> will be ignored and still use +text data in detection bboxes of side data. So please do not use this parameter +if you are not sure about the text source. +</p> +</dd> +<dt><span><samp>reload</samp></span></dt> +<dd><p>The <var>textfile</var> will be reloaded at specified frame interval. +Be sure to update <var>textfile</var> atomically, or it may be read partially, +or even fail. +Range is 0 to INT_MAX. Default is 0. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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 "0". +</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><span><samp>dar</samp></span></dt> +<dd><p>input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var> +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>line_h, lh</samp></span></dt> +<dd><p>the height of each text line +</p> +</dd> +<dt><span><samp>main_h, h, H</samp></span></dt> +<dd><p>the input height +</p> +</dd> +<dt><span><samp>main_w, w, W</samp></span></dt> +<dd><p>the input width +</p> +</dd> +<dt><span><samp>max_glyph_a, ascent</samp></span></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’s orientation with the Y axis +upwards. +</p> +</dd> +<dt><span><samp>max_glyph_d, descent</samp></span></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’s orientation, with the Y axis +upwards. +</p> +</dd> +<dt><span><samp>max_glyph_h</samp></span></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><span><samp>max_glyph_w</samp></span></dt> +<dd><p>maximum glyph width, that is the maximum width for all the glyphs +contained in the rendered text +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>the number of input frame, starting from 0 +</p> +</dd> +<dt><span><samp>rand(min, max)</samp></span></dt> +<dd><p>return a random number included between <var>min</var> and <var>max</var> +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>The input sample aspect ratio. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown +</p> +</dd> +<dt><span><samp>text_h, th</samp></span></dt> +<dd><p>the height of the rendered text +</p> +</dd> +<dt><span><samp>text_w, tw</samp></span></dt> +<dd><p>the width of the rendered text +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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 +to each other, so you can for example specify <code>y=x/dar</code>. +</p> +</dd> +<dt><span><samp>pict_type</samp></span></dt> +<dd><p>A one character description of the current frame’s picture type. +</p> +</dd> +<dt><span><samp>pkt_pos</samp></span></dt> +<dd><p>The current packet’s position in the input file or stream +(in bytes, from the start of the input). A value of -1 indicates +this info is not available. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>The current packet’s duration, in seconds. +</p> +</dd> +<dt><span><samp>pkt_size</samp></span></dt> +<dd><p>The current packet’s size (in bytes). +</p></dd> +</dl> + +<span id="drawtext_005fexpansion"></span><a name="Text-expansion"></a> +<h4 class="subsection">11.75.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 ‘<samp>\</samp>’, 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 ’:’. +If the arguments contain special characters or delimiters (’:’ or ’}’), +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><span><code>expr, e</code></span></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><span><code>expr_int_format, eif</code></span></dt> +<dd><p>Evaluate the expression’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 ‘<samp>x</samp>’, +‘<samp>X</samp>’, ‘<samp>d</samp>’ and ‘<samp>u</samp>’. 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><span><code>gmtime</code></span></dt> +<dd><p>The time at which the filter is running, expressed in UTC. +It can accept an argument: a strftime() format string. +The format string is extended to support the variable <var>%[1-6]N</var> +which prints fractions of the second with optionally specified number of digits. +</p> +</dd> +<dt><span><code>localtime</code></span></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. +The format string is extended to support the variable <var>%[1-6]N</var> +which prints fractions of the second with optionally specified number of digits. +</p> +</dd> +<dt><span><code>metadata</code></span></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> +<p>Available metadata can be identified by inspecting entries +starting with TAG included within each frame section +printed by running <code>ffprobe -show_frames</code>. +</p> +<p>String metadata generated in filters leading to +the drawtext filter are also available. +</p> +</dd> +<dt><span><code>n, frame_num</code></span></dt> +<dd><p>The frame number, starting from 0. +</p> +</dd> +<dt><span><code>pict_type</code></span></dt> +<dd><p>A one character description of the current picture type. +</p> +</dd> +<dt><span><code>pts</code></span></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>hms</code>, a third argument <code>24HH</code> may be +supplied to present the hour part of the formatted timestamp in 24h format +(00-23). +</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="Commands-85"></a> +<h4 class="subsection">11.75.3 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-85" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-85" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports altering parameters via commands: +</p><dl compact="compact"> +<dt><span><samp>reinit</samp></span></dt> +<dd><p>Alter existing filter parameters. +</p> +<p>Syntax for the argument is the same as for filter invocation, e.g. +</p> +<div class="example"> +<pre class="example">fontsize=56:fontcolor=green:text='Hello World' +</pre></div> + +<p>Full filter invocation with sendcmd would look like this: +</p> +<div class="example"> +<pre class="example">sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World' +</pre></div> +</dd> +</dl> + +<p>If the entire argument can’t be parsed or applied as valid values then the filter will +continue with its existing parameters. +</p> +<a name="Examples-70"></a> +<h4 class="subsection">11.75.4 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> Draw "Test Text" with font FreeSerif, using the default values for the +optional parameters. + +<div class="example"> +<pre class="example">drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'" +</pre></div> + +</li><li> Draw ’Test Text’ 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="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" +</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="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2" +</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="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)" +</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="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t" +</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="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t" +</pre></div> + +</li><li> Draw a single green letter "g", at the center of the input video. +The glyph baseline is placed at half screen height. +<div class="example"> +<pre class="example">drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent" +</pre></div> + +</li><li> Show text for 1 second every 3 seconds: +<div class="example"> +<pre class="example">drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'" +</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> Draw "Test Text" with font size dependent on height of the video. +<div class="example"> +<pre class="example">drawtext="text='Test Text': fontsize=h/30: x=(w-text_w)/2: y=(h-text_h*2)" +</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 "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 }" +</pre></div> + +</li><li> Horizontally align multiple separate texts. Note that <samp>max_glyph_a</samp> +and the <samp>fontsize</samp> value are included in the <samp>y</samp> offset. +<div class="example"> +<pre class="example">drawtext=fontfile=FreeSans.ttf:text=DOG:fontsize=24:x=10:y=20+24-max_glyph_a, +drawtext=fontfile=FreeSans.ttf:text=cow:fontsize=24:x=80:y=20+24-max_glyph_a +</pre></div> + +</li><li> Plot special <var>lavf.image2dec.source_basename</var> metadata onto each frame if +such metadata exists. Otherwise, plot the string "NA". Note that image2 demuxer +must have option <samp>-export_path_metadata 1</samp> for the special metadata fields +to be available for filters. +<div class="example"> +<pre class="example">drawtext="fontsize=20:fontcolor=white:fontfile=FreeSans.ttf:text='%{metadata\:lavf.image2dec.source_basename\:NA}':x=10:y=10" +</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">11.76 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><span><samp>low</samp></span></dt> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set low and high threshold values used by the Canny thresholding +algorithm. +</p> +<p>The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" 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><span><samp>mode</samp></span></dt> +<dd><p>Define the drawing mode. +</p> +<dl compact="compact"> +<dt><span>‘<samp>wires</samp>’</span></dt> +<dd><p>Draw white/gray wires on black background. +</p> +</dd> +<dt><span>‘<samp>colormix</samp>’</span></dt> +<dd><p>Mix the colors to create a paint/cartoon effect. +</p> +</dd> +<dt><span>‘<samp>canny</samp>’</span></dt> +<dd><p>Apply Canny edge detector on all selected planes. +</p></dd> +</dl> +<p>Default value is <var>wires</var>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Select planes for filtering. By default all available planes are filtered. +</p></dd> +</dl> + +<a name="Examples-71"></a> +<h4 class="subsection">11.76.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> 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="elbg"></a> +<h3 class="section">11.77 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><span><samp>codebook_length, l</samp></span></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><span><samp>nb_steps, n</samp></span></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><span><samp>seed, s</samp></span></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><span><samp>pal8</samp></span></dt> +<dd><p>Set pal8 output pixel format. This option does not work with codebook +length greater than 256. Default is disabled. +</p> +</dd> +<dt><span><samp>use_alpha</samp></span></dt> +<dd><p>Include alpha values in the quantization calculation. Allows creating +palettized output images (e.g. PNG8) with multiple alpha smooth blending. +</p></dd> +</dl> + +<a name="entropy"></a> +<h3 class="section">11.78 entropy<span class="pull-right"><a class="anchor hidden-xs" href="#entropy" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-entropy" aria-hidden="true">TOC</a></span></h3> + +<p>Measure graylevel entropy in histogram of color channels of video frames. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Can be either <var>normal</var> or <var>diff</var>. Default is <var>normal</var>. +</p> +<p><var>diff</var> mode measures entropy of histogram delta values, absolute differences +between neighbour histogram values. +</p></dd> +</dl> + +<a name="epx"></a> +<h3 class="section">11.79 epx<span class="pull-right"><a class="anchor hidden-xs" href="#epx" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-epx" aria-hidden="true">TOC</a></span></h3> +<p>Apply the EPX magnification filter which is designed for pixel art. +</p> +<p>It accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>n</samp></span></dt> +<dd><p>Set the scaling dimension: <code>2</code> for <code>2xEPX</code>, <code>3</code> for +<code>3xEPX</code>. +Default is <code>3</code>. +</p></dd> +</dl> + +<a name="eq"></a> +<h3 class="section">11.80 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><span><samp>contrast</samp></span></dt> +<dd><p>Set the contrast expression. The value must be a float value in range +<code>-1000.0</code> to <code>1000.0</code>. The default value is "1". +</p> +</dd> +<dt><span><samp>brightness</samp></span></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 "0". +</p> +</dd> +<dt><span><samp>saturation</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>gamma</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>gamma_r</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>gamma_g</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>gamma_b</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>gamma_weight</samp></span></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 "1". +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>only evaluate expressions once during the filter initialization or +when a command is processed +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>evaluate expressions for each incoming frame +</p></dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p></dd> +</dl> + +<p>The expressions accept the following parameters: +</p><dl compact="compact"> +<dt><span><samp>n</samp></span></dt> +<dd><p>frame count of the input frame starting from 0 +</p> +</dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>byte position of the corresponding packet in the input file, NAN if +unspecified +</p> +</dd> +<dt><span><samp>r</samp></span></dt> +<dd><p>frame rate of the input video, NAN if the input frame rate is unknown +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown +</p></dd> +</dl> + +<a name="Commands-86"></a> +<h4 class="subsection">11.80.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-86" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-86" aria-hidden="true">TOC</a></span></h4> +<p>The filter supports the following commands: +</p> +<dl compact="compact"> +<dt><span><samp>contrast</samp></span></dt> +<dd><p>Set the contrast expression. +</p> +</dd> +<dt><span><samp>brightness</samp></span></dt> +<dd><p>Set the brightness expression. +</p> +</dd> +<dt><span><samp>saturation</samp></span></dt> +<dd><p>Set the saturation expression. +</p> +</dd> +<dt><span><samp>gamma</samp></span></dt> +<dd><p>Set the gamma expression. +</p> +</dd> +<dt><span><samp>gamma_r</samp></span></dt> +<dd><p>Set the gamma_r expression. +</p> +</dd> +<dt><span><samp>gamma_g</samp></span></dt> +<dd><p>Set gamma_g expression. +</p> +</dd> +<dt><span><samp>gamma_b</samp></span></dt> +<dd><p>Set gamma_b expression. +</p> +</dd> +<dt><span><samp>gamma_weight</samp></span></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> + +<span id="erosion"></span><a name="erosion-1"></a> +<h3 class="section">11.81 erosion<span class="pull-right"><a class="anchor hidden-xs" href="#erosion-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-erosion-1" 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +</p> +</dd> +<dt><span><samp>coordinates</samp></span></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="Commands-87"></a> +<h4 class="subsection">11.81.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-87" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-87" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="estdif"></a> +<h3 class="section">11.82 estdif<span class="pull-right"><a class="anchor hidden-xs" href="#estdif" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-estdif" aria-hidden="true">TOC</a></span></h3> + +<p>Deinterlace the input video ("estdif" stands for "Edge Slope +Tracing Deinterlacing Filter"). +</p> +<p>Spatial only filter that uses edge slope tracing algorithm +to interpolate missing lines. +It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>The interlacing mode to adopt. It accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>frame</samp></span></dt> +<dd><p>Output one frame for each frame. +</p></dd> +<dt><span><samp>field</samp></span></dt> +<dd><p>Output one frame for each field. +</p></dd> +</dl> + +<p>The default value is <code>field</code>. +</p> +</dd> +<dt><span><samp>parity</samp></span></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><span><samp>tff</samp></span></dt> +<dd><p>Assume the top field is first. +</p></dd> +<dt><span><samp>bff</samp></span></dt> +<dd><p>Assume the bottom field is first. +</p></dd> +<dt><span><samp>auto</samp></span></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><span><samp>deint</samp></span></dt> +<dd><p>Specify which frames to deinterlace. Accepts one of the following +values: +</p> +<dl compact="compact"> +<dt><span><samp>all</samp></span></dt> +<dd><p>Deinterlace all frames. +</p></dd> +<dt><span><samp>interlaced</samp></span></dt> +<dd><p>Only deinterlace frames marked as interlaced. +</p></dd> +</dl> + +<p>The default value is <code>all</code>. +</p> +</dd> +<dt><span><samp>rslope</samp></span></dt> +<dd><p>Specify the search radius for edge slope tracing. Default value is 1. +Allowed range is from 1 to 15. +</p> +</dd> +<dt><span><samp>redge</samp></span></dt> +<dd><p>Specify the search radius for best edge matching. Default value is 2. +Allowed range is from 0 to 15. +</p> +</dd> +<dt><span><samp>ecost</samp></span></dt> +<dd><p>Specify the edge cost for edge matching. Default value is 1.0. +Allowed range is from 0 to 9. +</p> +</dd> +<dt><span><samp>mcost</samp></span></dt> +<dd><p>Specify the middle cost for edge matching. Default value is 0.5. +Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>dcost</samp></span></dt> +<dd><p>Specify the distance cost for edge matching. Default value is 0.5. +Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Specify the interpolation used. Default is 4-point interpolation. It accepts one +of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>2p</samp></span></dt> +<dd><p>Two-point interpolation. +</p></dd> +<dt><span><samp>4p</samp></span></dt> +<dd><p>Four-point interpolation. +</p></dd> +<dt><span><samp>6p</samp></span></dt> +<dd><p>Six-point interpolation. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-88"></a> +<h4 class="subsection">11.82.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-88" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-88" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="exposure"></a> +<h3 class="section">11.83 exposure<span class="pull-right"><a class="anchor hidden-xs" href="#exposure" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-exposure" aria-hidden="true">TOC</a></span></h3> +<p>Adjust exposure of the video stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>exposure</samp></span></dt> +<dd><p>Set the exposure correction in EV. Allowed range is from -3.0 to 3.0 EV +Default value is 0 EV. +</p> +</dd> +<dt><span><samp>black</samp></span></dt> +<dd><p>Set the black level correction. Allowed range is from -1.0 to 1.0. +Default value is 0. +</p></dd> +</dl> + +<a name="Commands-89"></a> +<h4 class="subsection">11.83.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-89" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-89" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="extractplanes"></a> +<h3 class="section">11.84 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><span><samp>planes</samp></span></dt> +<dd><p>Set plane(s) to extract. +</p> +<p>Available values for planes are: +</p><dl compact="compact"> +<dt><span>‘<samp>y</samp>’</span></dt> +<dt><span>‘<samp>u</samp>’</span></dt> +<dt><span>‘<samp>v</samp>’</span></dt> +<dt><span>‘<samp>a</samp>’</span></dt> +<dt><span>‘<samp>r</samp>’</span></dt> +<dt><span>‘<samp>g</samp>’</span></dt> +<dt><span>‘<samp>b</samp>’</span></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-72"></a> +<h4 class="subsection">11.84.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> 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="fade"></a> +<h3 class="section">11.85 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><span><samp>type, t</samp></span></dt> +<dd><p>The effect type can be either "in" for a fade-in, or "out" for a fade-out +effect. +Default is <code>in</code>. +</p> +</dd> +<dt><span><samp>start_frame, s</samp></span></dt> +<dd><p>Specify the number of the frame to start applying the fade +effect at. Default is 0. +</p> +</dd> +<dt><span><samp>nb_frames, n</samp></span></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><span><samp>alpha</samp></span></dt> +<dd><p>If set to 1, fade only alpha channel, if one exists on the input. +Default value is 0. +</p> +</dd> +<dt><span><samp>start_time, st</samp></span></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><span><samp>duration, d</samp></span></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><span><samp>color, c</samp></span></dt> +<dd><p>Specify the color of the fade. Default is "black". +</p></dd> +</dl> + +<a name="Examples-73"></a> +<h4 class="subsection">11.85.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> 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="feedback"></a> +<h3 class="section">11.86 feedback<span class="pull-right"><a class="anchor hidden-xs" href="#feedback" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-feedback" aria-hidden="true">TOC</a></span></h3> +<p>Apply feedback video filter. +</p> +<p>This filter pass cropped input frames to 2nd output. +From there it can be filtered with other video filters. +After filter receives frame from 2nd input, that frame +is combined on top of original frame from 1st input and passed +to 1st output. +</p> +<p>The typical usage is filter only part of frame. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set the top left crop position. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set the crop size. +</p></dd> +</dl> + +<a name="Examples-74"></a> +<h4 class="subsection">11.86.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> Blur only top left rectangular part of video frame size 100x100 with gblur filter. +<div class="example"> +<pre class="example">[in][blurin]feedback=x=0:y=0:w=100:h=100[out][blurout];[blurout]gblur=8[blurin] +</pre></div> + +</li><li> Draw black box on top left part of video frame of size 100x100 with drawbox filter. +<div class="example"> +<pre class="example">[in][blurin]feedback=x=0:y=0:w=100:h=100[out][blurout];[blurout]drawbox=x=0:y=0:w=100:h=100:t=100[blurin] +</pre></div> +</li></ul> + +<a name="fftdnoiz"></a> +<h3 class="section">11.87 fftdnoiz<span class="pull-right"><a class="anchor hidden-xs" href="#fftdnoiz" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fftdnoiz" aria-hidden="true">TOC</a></span></h3> +<p>Denoise frames using 3D FFT (frequency domain filtering). +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>sigma</samp></span></dt> +<dd><p>Set the noise sigma constant. This sets denoising strength. +Default value is 1. Allowed range is from 0 to 30. +Using very high sigma with low overlap may give blocking artifacts. +</p> +</dd> +<dt><span><samp>amount</samp></span></dt> +<dd><p>Set amount of denoising. By default all detected noise is reduced. +Default value is 1. Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>block</samp></span></dt> +<dd><p>Set size of block in pixels, Default is 32, can be 8 to 256. +</p> +</dd> +<dt><span><samp>overlap</samp></span></dt> +<dd><p>Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8. +</p> +</dd> +<dt><span><samp>method</samp></span></dt> +<dd><p>Set denoising method. Default is <code>wiener</code>, can also be <code>hard</code>. +</p> +</dd> +<dt><span><samp>prev</samp></span></dt> +<dd><p>Set number of previous frames to use for denoising. By default is set to 0. +</p> +</dd> +<dt><span><samp>next</samp></span></dt> +<dd><p>Set number of next frames to to use for denoising. By default is set to 0. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes which will be filtered, by default are all available filtered +except alpha. +</p></dd> +</dl> + +<a name="fftfilt"></a> +<h3 class="section">11.88 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><span><samp>dc_Y</samp></span></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><span><samp>dc_U</samp></span></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><span><samp>dc_V</samp></span></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><span><samp>weight_Y</samp></span></dt> +<dd><p>Set the frequency domain weight expression for the luma plane. +</p> +</dd> +<dt><span><samp>weight_U</samp></span></dt> +<dd><p>Set the frequency domain weight expression for the 1st chroma plane. +</p> +</dd> +<dt><span><samp>weight_V</samp></span></dt> +<dd><p>Set the frequency domain weight expression for the 2nd chroma plane. +</p> +</dd> +<dt><span><samp>eval</samp></span></dt> +<dd><p>Set when the expressions are evaluated. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>init</samp>’</span></dt> +<dd><p>Only evaluate expressions once during the filter initialization. +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Evaluate expressions for each incoming frame. +</p></dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p> +<p>The filter accepts the following variables: +</p></dd> +<dt><span><samp>X</samp></span></dt> +<dt><span><samp>Y</samp></span></dt> +<dd><p>The coordinates of the current sample. +</p> +</dd> +<dt><span><samp>W</samp></span></dt> +<dt><span><samp>H</samp></span></dt> +<dd><p>The width and height of the image. +</p> +</dd> +<dt><span><samp>N</samp></span></dt> +<dd><p>The number of input frame, starting from 0. +</p> +</dd> +<dt><span><samp>WS</samp></span></dt> +<dt><span><samp>HS</samp></span></dt> +<dd><p>The size of FFT array for horizontal and vertical processing. +</p></dd> +</dl> + +<a name="Examples-75"></a> +<h4 class="subsection">11.88.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> 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">11.89 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><span><samp>type</samp></span></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">11.90 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><span><samp>hint</samp></span></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 optionally followed by <code>t</code> output frame will use only top field, or in +case of <code>b</code> it will use only bottom field. +If line starts with <code>#</code> or <code>;</code> that line is skipped. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Can be item <code>absolute</code> or <code>relative</code> or <code>pattern</code>. Default is <code>absolute</code>. +The <code>pattern</code> mode is same as <code>relative</code> mode, except at last entry of file if there +are more frames to process than <code>hint</code> file is seek back to start. +</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">11.91 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><span><samp>order</samp></span></dt> +<dd><p>Specify the assumed field order of the input stream. Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Auto detect parity (use FFmpeg’s internal parity value). +</p></dd> +<dt><span>‘<samp>bff</samp>’</span></dt> +<dd><p>Assume bottom field first. +</p></dd> +<dt><span>‘<samp>tff</samp>’</span></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><span><samp>mode</samp></span></dt> +<dd><p>Set the matching mode or strategy to use. <samp>pc</samp> mode is the safest in the +sense that it won’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><span>‘<samp>pc</samp>’</span></dt> +<dd><p>2-way matching (p/c) +</p></dd> +<dt><span>‘<samp>pc_n</samp>’</span></dt> +<dd><p>2-way matching, and trying 3rd match if still combed (p/c + n) +</p></dd> +<dt><span>‘<samp>pc_u</samp>’</span></dt> +<dd><p>2-way matching, and trying 3rd match (same order) if still combed (p/c + u) +</p></dd> +<dt><span>‘<samp>pc_n_ub</samp>’</span></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><span>‘<samp>pcn</samp>’</span></dt> +<dd><p>3-way matching (p/c/n) +</p></dd> +<dt><span>‘<samp>pcn_ub</samp>’</span></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><span><samp>ppsrc</samp></span></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><span><samp>field</samp></span></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><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Automatic (same value as <samp>order</samp>). +</p></dd> +<dt><span>‘<samp>bottom</samp>’</span></dt> +<dd><p>Match from the bottom field. +</p></dd> +<dt><span>‘<samp>top</samp>’</span></dt> +<dd><p>Match from the top field. +</p></dd> +</dl> + +<p>Default value is <var>auto</var>. +</p> +</dd> +<dt><span><samp>mchroma</samp></span></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><span><samp>y0</samp></span></dt> +<dt><span><samp>y1</samp></span></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><span><samp>scthresh</samp></span></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><span><samp>combmatch</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>No final matching based on combed scores. +</p></dd> +<dt><span>‘<samp>sc</samp>’</span></dt> +<dd><p>Combed scores are only used when a scene change is detected. +</p></dd> +<dt><span>‘<samp>full</samp>’</span></dt> +<dd><p>Use combed scores all the time. +</p></dd> +</dl> + +<p>Default is <var>sc</var>. +</p> +</dd> +<dt><span><samp>combdbg</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>No forced calculation. +</p></dd> +<dt><span>‘<samp>pcn</samp>’</span></dt> +<dd><p>Force p/c/n calculations. +</p></dd> +<dt><span>‘<samp>pcnub</samp>’</span></dt> +<dd><p>Force p/c/n/u/b calculations. +</p></dd> +</dl> + +<p>Default value is <var>none</var>. +</p> +</dd> +<dt><span><samp>cthresh</samp></span></dt> +<dd><p>This is the area combing threshold used for combed frame detection. This +essentially controls how "strong" or "visible" 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><span><samp>chroma</samp></span></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><span><samp>blockx</samp></span></dt> +<dt><span><samp>blocky</samp></span></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><span><samp>combpel</samp></span></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 "visible" the combing must be, this +setting controls "how much" 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> + +<span id="p_002fc_002fn_002fu_002fb-meaning"></span><a name="p_002fc_002fn_002fu_002fb-meaning-1"></a> +<h4 class="subsection">11.91.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">11.91.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 <-- 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 <-- 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">11.91.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 +’x’ 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-76"></a> +<h4 class="subsection">11.91.2 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> + +<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">11.92 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><span><samp>order</samp></span></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 ‘<samp>tff</samp>’. +</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 "fieldorder=bff" out.dv +</pre></div> + +<a name="fifo_002c-afifo"></a> +<h3 class="section">11.93 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="fillborders"></a> +<h3 class="section">11.94 fillborders<span class="pull-right"><a class="anchor hidden-xs" href="#fillborders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fillborders" aria-hidden="true">TOC</a></span></h3> + +<p>Fill borders of the input video, without changing video stream dimensions. +Sometimes video can have garbage at the four edges and you may not want to +crop video input to keep size multiple of some number. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>left</samp></span></dt> +<dd><p>Number of pixels to fill from left border. +</p> +</dd> +<dt><span><samp>right</samp></span></dt> +<dd><p>Number of pixels to fill from right border. +</p> +</dd> +<dt><span><samp>top</samp></span></dt> +<dd><p>Number of pixels to fill from top border. +</p> +</dd> +<dt><span><samp>bottom</samp></span></dt> +<dd><p>Number of pixels to fill from bottom border. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set fill mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>smear</samp>’</span></dt> +<dd><p>fill pixels using outermost pixels +</p> +</dd> +<dt><span>‘<samp>mirror</samp>’</span></dt> +<dd><p>fill pixels using mirroring (half sample symmetric) +</p> +</dd> +<dt><span>‘<samp>fixed</samp>’</span></dt> +<dd><p>fill pixels with constant value +</p> +</dd> +<dt><span>‘<samp>reflect</samp>’</span></dt> +<dd><p>fill pixels using reflecting (whole sample symmetric) +</p> +</dd> +<dt><span>‘<samp>wrap</samp>’</span></dt> +<dd><p>fill pixels using wrapping +</p> +</dd> +<dt><span>‘<samp>fade</samp>’</span></dt> +<dd><p>fade pixels to constant value +</p> +</dd> +<dt><span>‘<samp>margins</samp>’</span></dt> +<dd><p>fill pixels at top and bottom with weighted averages pixels near borders +</p></dd> +</dl> + +<p>Default is <var>smear</var>. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Set color for pixels in fixed or fade mode. Default is <var>black</var>. +</p></dd> +</dl> + +<a name="Commands-90"></a> +<h4 class="subsection">11.94.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-90" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-90" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="find_005frect"></a> +<h3 class="section">11.95 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><span><samp>object</samp></span></dt> +<dd><p>Filepath of the object image, needs to be in gray8. +</p> +</dd> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Detection threshold, default is 0.5. +</p> +</dd> +<dt><span><samp>mipmaps</samp></span></dt> +<dd><p>Number of mipmaps, default is 3. +</p> +</dd> +<dt><span><samp>xmin, ymin, xmax, ymax</samp></span></dt> +<dd><p>Specifies the rectangle in which to search. +</p> +</dd> +<dt><span><samp>discard</samp></span></dt> +<dd><p>Discard frames where object is not detected. Default is disabled. +</p></dd> +</dl> + +<a name="Examples-77"></a> +<h4 class="subsection">11.95.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> Cover a rectangular object by the supplied image 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="floodfill"></a> +<h3 class="section">11.96 floodfill<span class="pull-right"><a class="anchor hidden-xs" href="#floodfill" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-floodfill" aria-hidden="true">TOC</a></span></h3> + +<p>Flood area with values of same pixel components with another values. +</p> +<p>It accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dd><p>Set pixel x coordinate. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set pixel y coordinate. +</p> +</dd> +<dt><span><samp>s0</samp></span></dt> +<dd><p>Set source #0 component value. +</p> +</dd> +<dt><span><samp>s1</samp></span></dt> +<dd><p>Set source #1 component value. +</p> +</dd> +<dt><span><samp>s2</samp></span></dt> +<dd><p>Set source #2 component value. +</p> +</dd> +<dt><span><samp>s3</samp></span></dt> +<dd><p>Set source #3 component value. +</p> +</dd> +<dt><span><samp>d0</samp></span></dt> +<dd><p>Set destination #0 component value. +</p> +</dd> +<dt><span><samp>d1</samp></span></dt> +<dd><p>Set destination #1 component value. +</p> +</dd> +<dt><span><samp>d2</samp></span></dt> +<dd><p>Set destination #2 component value. +</p> +</dd> +<dt><span><samp>d3</samp></span></dt> +<dd><p>Set destination #3 component value. +</p></dd> +</dl> + +<span id="format"></span><a name="format-1"></a> +<h3 class="section">11.97 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><span><samp>pix_fmts</samp></span></dt> +<dd><p>A ’|’-separated list of pixel format names, such as +"pix_fmts=yuv420p|monow|rgb24". +</p> +</dd> +</dl> + +<a name="Examples-78"></a> +<h4 class="subsection">11.97.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> 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> + +<span id="fps"></span><a name="fps-1"></a> +<h3 class="section">11.98 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><span><samp>fps</samp></span></dt> +<dd><p>The desired output frame rate. It accepts expressions containing the following +constants: +</p> +<dl compact="compact"> +<dt><span>‘<samp>source_fps</samp>’</span></dt> +<dd><p>The input’s frame rate +</p> +</dd> +<dt><span>‘<samp>ntsc</samp>’</span></dt> +<dd><p>NTSC frame rate of <code>30000/1001</code> +</p> +</dd> +<dt><span>‘<samp>pal</samp>’</span></dt> +<dd><p>PAL frame rate of <code>25.0</code> +</p> +</dd> +<dt><span>‘<samp>film</samp>’</span></dt> +<dd><p>Film frame rate of <code>24.0</code> +</p> +</dd> +<dt><span>‘<samp>ntsc_film</samp>’</span></dt> +<dd><p>NTSC-film frame rate of <code>24000/1001</code> +</p></dd> +</dl> + +<p>The default is <code>25</code>. +</p> +</dd> +<dt><span><samp>start_time</samp></span></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’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> +<dt><span><samp>round</samp></span></dt> +<dd><p>Timestamp (PTS) rounding method. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><samp>zero</samp></span></dt> +<dd><p>round towards 0 +</p></dd> +<dt><span><samp>inf</samp></span></dt> +<dd><p>round away from 0 +</p></dd> +<dt><span><samp>down</samp></span></dt> +<dd><p>round towards -infinity +</p></dd> +<dt><span><samp>up</samp></span></dt> +<dd><p>round towards +infinity +</p></dd> +<dt><span><samp>near</samp></span></dt> +<dd><p>round to nearest +</p></dd> +</dl> +<p>The default is <code>near</code>. +</p> +</dd> +<dt><span><samp>eof_action</samp></span></dt> +<dd><p>Action performed when reading the last frame. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><samp>round</samp></span></dt> +<dd><p>Use same timestamp rounding method as used for other frames. +</p></dd> +<dt><span><samp>pass</samp></span></dt> +<dd><p>Pass through last frame if input duration has not been reached yet. +</p></dd> +</dl> +<p>The default is <code>round</code>. +</p> +</dd> +</dl> + +<p>Alternatively, the options can be specified as a flat string: +<var>fps</var>[:<var>start_time</var>[:<var>round</var>]]. +</p> +<p>See also the <a href="#setpts">setpts</a> filter. +</p> +<a name="Examples-79"></a> +<h4 class="subsection">11.98.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> 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">11.99 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><span><samp>format</samp></span></dt> +<dd><p>The desired packing format. Supported values are: +</p> +<dl compact="compact"> +<dt><span><samp>sbs</samp></span></dt> +<dd><p>The views are next to each other (default). +</p> +</dd> +<dt><span><samp>tab</samp></span></dt> +<dd><p>The views are on top of each other. +</p> +</dd> +<dt><span><samp>lines</samp></span></dt> +<dd><p>The views are packed by line. +</p> +</dd> +<dt><span><samp>columns</samp></span></dt> +<dd><p>The views are packed by column. +</p> +</dd> +<dt><span><samp>frameseq</samp></span></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">11.100 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><span><samp>fps</samp></span></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><span><samp>interp_start</samp></span></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><span><samp>interp_end</samp></span></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><span><samp>scene</samp></span></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>8.2</code>. +</p> +</dd> +<dt><span><samp>flags</samp></span></dt> +<dd><p>Specify flags influencing the filter process. +</p> +<p>Available value for <var>flags</var> is: +</p> +<dl compact="compact"> +<dt><span><samp>scene_change_detect, scd</samp></span></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">11.101 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><span><samp>step</samp></span></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="freezedetect"></a> +<h3 class="section">11.102 freezedetect<span class="pull-right"><a class="anchor hidden-xs" href="#freezedetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-freezedetect" aria-hidden="true">TOC</a></span></h3> + +<p>Detect frozen video. +</p> +<p>This filter logs a message and sets frame metadata when it detects that the +input video has no significant change in content during a specified duration. +Video freeze detection calculates the mean average absolute difference of all +the components of video frames and compares it to a noise floor. +</p> +<p>The printed times and duration are expressed in seconds. The +<code>lavfi.freezedetect.freeze_start</code> metadata key is set on the first frame +whose timestamp equals or exceeds the detection duration and it contains the +timestamp of the first frame of the freeze. The +<code>lavfi.freezedetect.freeze_duration</code> and +<code>lavfi.freezedetect.freeze_end</code> metadata keys are set on the first frame +after the freeze. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>noise, n</samp></span></dt> +<dd><p>Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or as a difference ratio between 0 and 1. Default is -60dB, or +0.001. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set freeze duration until notification (default is 2 seconds). +</p></dd> +</dl> + +<a name="freezeframes"></a> +<h3 class="section">11.103 freezeframes<span class="pull-right"><a class="anchor hidden-xs" href="#freezeframes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-freezeframes" aria-hidden="true">TOC</a></span></h3> + +<p>Freeze video frames. +</p> +<p>This filter freezes video frames using frame from 2nd input. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>first</samp></span></dt> +<dd><p>Set number of first frame from which to start freeze. +</p> +</dd> +<dt><span><samp>last</samp></span></dt> +<dd><p>Set number of last frame from which to end freeze. +</p> +</dd> +<dt><span><samp>replace</samp></span></dt> +<dd><p>Set number of frame from 2nd input which will be used instead of replaced frames. +</p></dd> +</dl> + +<span id="frei0r"></span><a name="frei0r-1"></a> +<h3 class="section">11.104 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><span><samp>filter_name</samp></span></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>FREI0R_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><span><samp>filter_params</samp></span></dt> +<dd><p>A ’|’-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 +"y" or "n"), 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 a color description as specified in the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>, +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-80"></a> +<h4 class="subsection">11.104.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> + +<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="Commands-91"></a> +<h4 class="subsection">11.104.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-91" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-91" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the <samp>filter_params</samp> option as <a href="#commands">commands</a>. +</p> +<a name="fspp"></a> +<h3 class="section">11.105 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><span><samp>quality</samp></span></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><span><samp>qp</samp></span></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><span><samp>strength</samp></span></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><span><samp>use_bframe_qp</samp></span></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">11.106 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><span><samp>sigma</samp></span></dt> +<dd><p>Set horizontal sigma, standard deviation of Gaussian blur. Default is <code>0.5</code>. +</p> +</dd> +<dt><span><samp>steps</samp></span></dt> +<dd><p>Set number of steps for Gaussian approximation. Default is <code>1</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. By default all planes are filtered. +</p> +</dd> +<dt><span><samp>sigmaV</samp></span></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="Commands-92"></a> +<h4 class="subsection">11.106.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-92" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-92" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same commands as options. +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> +<a name="geq"></a> +<h3 class="section">11.107 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>Apply generic equation to each pixel. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>lum_expr, lum</samp></span></dt> +<dd><p>Set the luminance expression. +</p></dd> +<dt><span><samp>cb_expr, cb</samp></span></dt> +<dd><p>Set the chrominance blue expression. +</p></dd> +<dt><span><samp>cr_expr, cr</samp></span></dt> +<dd><p>Set the chrominance red expression. +</p></dd> +<dt><span><samp>alpha_expr, a</samp></span></dt> +<dd><p>Set the alpha expression. +</p></dd> +<dt><span><samp>red_expr, r</samp></span></dt> +<dd><p>Set the red expression. +</p></dd> +<dt><span><samp>green_expr, g</samp></span></dt> +<dd><p>Set the green expression. +</p></dd> +<dt><span><samp>blue_expr, b</samp></span></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><span><samp>N</samp></span></dt> +<dd><p>The sequential number of the filtered frame, starting from <code>0</code>. +</p> +</dd> +<dt><span><samp>X</samp></span></dt> +<dt><span><samp>Y</samp></span></dt> +<dd><p>The coordinates of the current sample. +</p> +</dd> +<dt><span><samp>W</samp></span></dt> +<dt><span><samp>H</samp></span></dt> +<dd><p>The width and height of the image. +</p> +</dd> +<dt><span><samp>SW</samp></span></dt> +<dt><span><samp>SH</samp></span></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><span><samp>T</samp></span></dt> +<dd><p>Time of the current frame, expressed in seconds. +</p> +</dd> +<dt><span><samp>p(x, y)</samp></span></dt> +<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the current +plane. +</p> +</dd> +<dt><span><samp>lum(x, y)</samp></span></dt> +<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the luminance +plane. +</p> +</dd> +<dt><span><samp>cb(x, y)</samp></span></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><span><samp>cr(x, y)</samp></span></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><span><samp>r(x, y)</samp></span></dt> +<dt><span><samp>g(x, y)</samp></span></dt> +<dt><span><samp>b(x, y)</samp></span></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><span><samp>alpha(x, y)</samp></span></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> +<dt><span><samp>psum(x,y), lumsum(x, y), cbsum(x,y), crsum(x,y), rsum(x,y), gsum(x,y), bsum(x,y), alphasum(x,y)</samp></span></dt> +<dd><p>Sum of sample values in the rectangle from (0,0) to (x,y), this allows obtaining +sums of samples within a rectangle. See the functions without the sum postfix. +</p> +</dd> +<dt><span><samp>interpolation</samp></span></dt> +<dd><p>Set one of interpolation methods: +</p><dl compact="compact"> +<dt><span><samp>nearest, n</samp></span></dt> +<dt><span><samp>bilinear, b</samp></span></dt> +</dl> +<p>Default is bilinear. +</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> +<p>Please note that this filter can use multiple threads in which case each slice +will have its own expression state. If you want to use only a single expression +state because your expressions depend on previous state then you should limit +the number of filter threads to 1. +</p> +<a name="Examples-81"></a> +<h4 class="subsection">11.107.1 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> 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">11.108 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><span><samp>strength</samp></span></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><span><samp>radius</samp></span></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-82"></a> +<h4 class="subsection">11.108.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> 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> + +<span id="graphmonitor"></span><a name="graphmonitor-1"></a> +<h3 class="section">11.109 graphmonitor<span class="pull-right"><a class="anchor hidden-xs" href="#graphmonitor-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-graphmonitor-1" aria-hidden="true">TOC</a></span></h3> +<p>Show various filtergraph stats. +</p> +<p>With this filter one can debug complete filtergraph. +Especially issues with links filling with queued frames. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set video output size. Default is <var>hd720</var>. +</p> +</dd> +<dt><span><samp>opacity, o</samp></span></dt> +<dd><p>Set video opacity. Default is <var>0.9</var>. Allowed range is from <var>0</var> to <var>1</var>. +</p> +</dd> +<dt><span><samp>mode, m</samp></span></dt> +<dd><p>Set output mode, can be <var>fulll</var> or <var>compact</var>. +In <var>compact</var> mode only filters with some queued frames have displayed stats. +</p> +</dd> +<dt><span><samp>flags, f</samp></span></dt> +<dd><p>Set flags which enable which stats are shown in video. +</p> +<p>Available values for flags are: +</p><dl compact="compact"> +<dt><span>‘<samp>queue</samp>’</span></dt> +<dd><p>Display number of queued frames in each link. +</p> +</dd> +<dt><span>‘<samp>frame_count_in</samp>’</span></dt> +<dd><p>Display number of frames taken from filter. +</p> +</dd> +<dt><span>‘<samp>frame_count_out</samp>’</span></dt> +<dd><p>Display number of frames given out from filter. +</p> +</dd> +<dt><span>‘<samp>frame_count_delta</samp>’</span></dt> +<dd><p>Display delta number of frames between above two values. +</p> +</dd> +<dt><span>‘<samp>pts</samp>’</span></dt> +<dd><p>Display current filtered frame pts. +</p> +</dd> +<dt><span>‘<samp>pts_delta</samp>’</span></dt> +<dd><p>Display pts delta between current and previous frame. +</p> +</dd> +<dt><span>‘<samp>time</samp>’</span></dt> +<dd><p>Display current filtered frame time. +</p> +</dd> +<dt><span>‘<samp>time_delta</samp>’</span></dt> +<dd><p>Display time delta between current and previous frame. +</p> +</dd> +<dt><span>‘<samp>timebase</samp>’</span></dt> +<dd><p>Display time base for filter link. +</p> +</dd> +<dt><span>‘<samp>format</samp>’</span></dt> +<dd><p>Display used format for filter link. +</p> +</dd> +<dt><span>‘<samp>size</samp>’</span></dt> +<dd><p>Display video size or number of audio channels in case of audio used by filter link. +</p> +</dd> +<dt><span>‘<samp>rate</samp>’</span></dt> +<dd><p>Display video frame rate or sample rate in case of audio used by filter link. +</p> +</dd> +<dt><span>‘<samp>eof</samp>’</span></dt> +<dd><p>Display link output status. +</p> +</dd> +<dt><span>‘<samp>sample_count_in</samp>’</span></dt> +<dd><p>Display number of samples taken from filter. +</p> +</dd> +<dt><span>‘<samp>sample_count_out</samp>’</span></dt> +<dd><p>Display number of samples given out from filter. +</p> +</dd> +<dt><span>‘<samp>sample_count_delta</samp>’</span></dt> +<dd><p>Display delta number of samples between above two values. +</p></dd> +</dl> + +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set upper limit for video rate of output stream, Default value is <var>25</var>. +This guarantee that output video frame rate will not be higher than this value. +</p></dd> +</dl> + +<a name="grayworld"></a> +<h3 class="section">11.110 grayworld<span class="pull-right"><a class="anchor hidden-xs" href="#grayworld" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-grayworld" aria-hidden="true">TOC</a></span></h3> +<p>A color constancy filter that applies color correction based on the grayworld assumption +</p> +<p>See: <a href="https://www.researchgate.net/publication/275213614_A_New_Color_Correction_Method_for_Underwater_Imaging">https://www.researchgate.net/publication/275213614_A_New_Color_Correction_Method_for_Underwater_Imaging</a> +</p> +<p>The algorithm uses linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +</p> +<div class="example"> +<pre class="example">ffmpeg -i INPUT -vf zscale=transfer=linear,grayworld,zscale=transfer=bt709,format=yuv420p OUTPUT +</pre></div> + +<a name="greyedge"></a> +<h3 class="section">11.111 greyedge<span class="pull-right"><a class="anchor hidden-xs" href="#greyedge" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-greyedge" aria-hidden="true">TOC</a></span></h3> +<p>A color constancy variation filter which estimates scene illumination via grey edge algorithm +and corrects the scene colors accordingly. +</p> +<p>See: <a href="https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf">https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf</a> +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>difford</samp></span></dt> +<dd><p>The order of differentiation to be applied on the scene. Must be chosen in the range +[0,2] and default value is 1. +</p> +</dd> +<dt><span><samp>minknorm</samp></span></dt> +<dd><p>The Minkowski parameter to be used for calculating the Minkowski distance. Must +be chosen in the range [0,20] and default value is 1. Set to 0 for getting +max value instead of calculating Minkowski distance. +</p> +</dd> +<dt><span><samp>sigma</samp></span></dt> +<dd><p>The standard deviation of Gaussian blur to be applied on the scene. Must be +chosen in the range [0,1024.0] and default value = 1. floor( <var>sigma</var> * break_off_sigma(3) ) +can’t be equal to 0 if <var>difford</var> is greater than 0. +</p></dd> +</dl> + +<a name="Examples-83"></a> +<h4 class="subsection">11.111.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> Grey Edge: +<div class="example"> +<pre class="example">greyedge=difford=1:minknorm=5:sigma=2 +</pre></div> + +</li><li> Max Edge: +<div class="example"> +<pre class="example">greyedge=difford=1:minknorm=0:sigma=2 +</pre></div> + +</li></ul> + +<a name="guided"></a> +<h3 class="section">11.112 guided<span class="pull-right"><a class="anchor hidden-xs" href="#guided" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-guided" aria-hidden="true">TOC</a></span></h3> +<p>Apply guided filter for edge-preserving smoothing, dehazing and so on. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set the box radius in pixels. +Allowed range is 1 to 20. Default is 3. +</p> +</dd> +<dt><span><samp>eps</samp></span></dt> +<dd><p>Set regularization parameter (with square). +Allowed range is 0 to 1. Default is 0.01. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set filter mode. Can be <code>basic</code> or <code>fast</code>. +Default is <code>basic</code>. +</p> +</dd> +<dt><span><samp>sub</samp></span></dt> +<dd><p>Set subsampling ratio for <code>fast</code> mode. +Range is 2 to 64. Default is 4. +No subsampling occurs in <code>basic</code> mode. +</p> +</dd> +<dt><span><samp>guidance</samp></span></dt> +<dd><p>Set guidance mode. Can be <code>off</code> or <code>on</code>. Default is <code>off</code>. +If <code>off</code>, single input is required. +If <code>on</code>, two inputs of the same resolution and pixel format are required. +The second input serves as the guidance. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter. Default is first only. +</p></dd> +</dl> + +<a name="Commands-93"></a> +<h4 class="subsection">11.112.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-93" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-93" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-84"></a> +<h4 class="subsection">11.112.2 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> Edge-preserving smoothing with guided filter: +<div class="example"> +<pre class="example">ffmpeg -i in.png -vf guided out.png +</pre></div> + +</li><li> Dehazing, structure-transferring filtering, detail enhancement with guided filter. +For the generation of guidance image, refer to paper "Guided Image Filtering". +See: <a href="http://kaiminghe.com/publications/pami12guidedfilter.pdf">http://kaiminghe.com/publications/pami12guidedfilter.pdf</a>. +<div class="example"> +<pre class="example">ffmpeg -i in.png -i guidance.png -filter_complex guided=guidance=on out.png +</pre></div> + +</li></ul> + +<span id="haldclut"></span><a name="haldclut-1"></a> +<h3 class="section">11.113 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><span><samp>clut</samp></span></dt> +<dd><p>Set which CLUT video frames will be processed from second input stream, +can be <var>first</var> or <var>all</var>. Default is <var>all</var>. +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>Force termination when the shortest input terminates. Default is <code>0</code>. +</p></dd> +<dt><span><samp>repeatlast</samp></span></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>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<p>More information about the Hald CLUT can be found on Eskil Steenberg’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="Commands-94"></a> +<h4 class="subsection">11.113.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-94" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-94" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the <code>interp</code> option as <a href="#commands">commands</a>. +</p> +<a name="Workflow-examples"></a> +<h4 class="subsection">11.113.2 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">11.113.2.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 "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -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">11.113.2.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 " + 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" -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 "movie=clut.png, [in] haldclut" +</pre></div> + +<a name="hflip"></a> +<h3 class="section">11.114 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 "hflip" out.avi +</pre></div> + +<a name="histeq"></a> +<h3 class="section">11.115 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 "automatically adjusting contrast filter". 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><span><samp>strength</samp></span></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><span><samp>intensity</samp></span></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><span><samp>antibanding</samp></span></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> + +<span id="histogram"></span><a name="histogram-1"></a> +<h3 class="section">11.116 histogram<span class="pull-right"><a class="anchor hidden-xs" href="#histogram-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-histogram-1" 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><span><samp>level_height</samp></span></dt> +<dd><p>Set height of level. Default value is <code>200</code>. +Allowed range is [50, 2048]. +</p> +</dd> +<dt><span><samp>scale_height</samp></span></dt> +<dd><p>Set height of color scale. Default value is <code>12</code>. +Allowed range is [0, 40]. +</p> +</dd> +<dt><span><samp>display_mode</samp></span></dt> +<dd><p>Set display mode. +It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>stack</samp>’</span></dt> +<dd><p>Per color component graphs are placed below each other. +</p> +</dd> +<dt><span>‘<samp>parade</samp>’</span></dt> +<dd><p>Per color component graphs are placed side by side. +</p> +</dd> +<dt><span>‘<samp>overlay</samp>’</span></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>stack</code>. +</p> +</dd> +<dt><span><samp>levels_mode</samp></span></dt> +<dd><p>Set mode. Can be either <code>linear</code>, or <code>logarithmic</code>. +Default is <code>linear</code>. +</p> +</dd> +<dt><span><samp>components</samp></span></dt> +<dd><p>Set what color components to display. +Default is <code>7</code>. +</p> +</dd> +<dt><span><samp>fgopacity</samp></span></dt> +<dd><p>Set foreground opacity. Default is <code>0.7</code>. +</p> +</dd> +<dt><span><samp>bgopacity</samp></span></dt> +<dd><p>Set background opacity. Default is <code>0.5</code>. +</p> +</dd> +<dt><span><samp>colors_mode</samp></span></dt> +<dd><p>Set colors mode. +It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>whiteonblack</samp>’</span></dt> +<dt><span>‘<samp>blackonwhite</samp>’</span></dt> +<dt><span>‘<samp>whiteongray</samp>’</span></dt> +<dt><span>‘<samp>blackongray</samp>’</span></dt> +<dt><span>‘<samp>coloronblack</samp>’</span></dt> +<dt><span>‘<samp>coloronwhite</samp>’</span></dt> +<dt><span>‘<samp>colorongray</samp>’</span></dt> +<dt><span>‘<samp>blackoncolor</samp>’</span></dt> +<dt><span>‘<samp>whiteoncolor</samp>’</span></dt> +<dt><span>‘<samp>grayoncolor</samp>’</span></dt> +</dl> +<p>Default is <code>whiteonblack</code>. +</p></dd> +</dl> + +<a name="Examples-85"></a> +<h4 class="subsection">11.116.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> Calculate and draw histogram: +<div class="example"> +<pre class="example">ffplay -i input -vf histogram +</pre></div> + +</li></ul> + +<span id="hqdn3d"></span><a name="hqdn3d-1"></a> +<h3 class="section">11.117 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><span><samp>luma_spatial</samp></span></dt> +<dd><p>A non-negative floating point number which specifies spatial luma strength. +It defaults to 4.0. +</p> +</dd> +<dt><span><samp>chroma_spatial</samp></span></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><span><samp>luma_tmp</samp></span></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><span><samp>chroma_tmp</samp></span></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="Commands-95"></a> +<h4 class="subsection">11.117.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-95" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-95" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<span id="hwdownload"></span><a name="hwdownload-1"></a> +<h3 class="section">11.118 hwdownload<span class="pull-right"><a class="anchor hidden-xs" href="#hwdownload-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hwdownload-1" aria-hidden="true">TOC</a></span></h3> + +<p>Download hardware frames to system memory. +</p> +<p>The input must be in hardware frames, and the output a non-hardware format. +Not all formats will be supported on the output - it may be necessary to insert +an additional <samp>format</samp> filter immediately following in the graph to get +the output in a supported format. +</p> +<a name="hwmap"></a> +<h3 class="section">11.119 hwmap<span class="pull-right"><a class="anchor hidden-xs" href="#hwmap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hwmap" aria-hidden="true">TOC</a></span></h3> + +<p>Map hardware frames to system memory or to another device. +</p> +<p>This filter has several different modes of operation; which one is used depends +on the input and output formats: +</p><ul> +<li> Hardware frame input, normal frame output + +<p>Map the input frames to system memory and pass them to the output. If the +original hardware frame is later required (for example, after overlaying +something else on part of it), the <samp>hwmap</samp> filter can be used again +in the next mode to retrieve it. +</p></li><li> Normal frame input, hardware frame output + +<p>If the input is actually a software-mapped hardware frame, then unmap it - +that is, return the original hardware frame. +</p> +<p>Otherwise, a device must be provided. Create new hardware surfaces on that +device for the output, then map them back to the software format at the input +and give those frames to the preceding filter. This will then act like the +<samp>hwupload</samp> filter, but may be able to avoid an additional copy when +the input is already in a compatible format. +</p></li><li> Hardware frame input and output + +<p>A device must be supplied for the output, either directly or with the +<samp>derive_device</samp> option. The input and output devices must be of +different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +</p> +<p>If the input frames were originally created on the output device, then unmap +to retrieve the original frames. +</p> +<p>Otherwise, map the frames to the output device - create new hardware frames +on the output corresponding to the frames on the input. +</p></li></ul> + +<p>The following additional parameters are accepted: +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set the frame mapping mode. Some combination of: +</p><dl compact="compact"> +<dt><span><var>read</var></span></dt> +<dd><p>The mapped frame should be readable. +</p></dd> +<dt><span><var>write</var></span></dt> +<dd><p>The mapped frame should be writeable. +</p></dd> +<dt><span><var>overwrite</var></span></dt> +<dd><p>The mapping will always overwrite the entire frame. +</p> +<p>This may improve performance in some cases, as the original contents of the +frame need not be loaded. +</p></dd> +<dt><span><var>direct</var></span></dt> +<dd><p>The mapping must not involve any copying. +</p> +<p>Indirect mappings to copies of frames are created in some cases where either +direct mapping is not possible or it would have unexpected properties. +Setting this flag ensures that the mapping is direct and will fail if that is +not possible. +</p></dd> +</dl> +<p>Defaults to <var>read+write</var> if not specified. +</p> +</dd> +<dt><span><samp>derive_device <var>type</var></samp></span></dt> +<dd><p>Rather than using the device supplied at initialisation, instead derive a new +device of type <var>type</var> from the device the input frames exist on. +</p> +</dd> +<dt><span><samp>reverse</samp></span></dt> +<dd><p>In a hardware to hardware mapping, map in reverse - create frames in the sink +and map them back to the source. This may be necessary in some cases where +a mapping in one direction is required but only the opposite direction is +supported by the devices being used. +</p> +<p>This option is dangerous - it may break the preceding filter in undefined +ways if there are any additional constraints on that filter’s output. +Do not use it without fully understanding the implications of its use. +</p></dd> +</dl> + +<span id="hwupload"></span><a name="hwupload-1"></a> +<h3 class="section">11.120 hwupload<span class="pull-right"><a class="anchor hidden-xs" href="#hwupload-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hwupload-1" aria-hidden="true">TOC</a></span></h3> + +<p>Upload system memory frames to hardware surfaces. +</p> +<p>The device to upload to must be supplied when the filter is initialised. If +using ffmpeg, select the appropriate device with the <samp>-filter_hw_device</samp> +option or with the <samp>derive_device</samp> option. The input and output devices +must be of different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +</p> +<p>The following additional parameters are accepted: +</p> +<dl compact="compact"> +<dt><span><samp>derive_device <var>type</var></samp></span></dt> +<dd><p>Rather than using the device supplied at initialisation, instead derive a new +device of type <var>type</var> from the device the input frames exist on. +</p></dd> +</dl> + +<span id="hwupload_005fcuda"></span><a name="hwupload_005fcuda-1"></a> +<h3 class="section">11.121 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><span><samp>device</samp></span></dt> +<dd><p>The number of the CUDA device to use +</p></dd> +</dl> + +<a name="hqx"></a> +<h3 class="section">11.122 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><span><samp>n</samp></span></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">11.123 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 accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>Set number of input streams. Default is 2. +</p> +</dd> +<dt><span><samp>shortest</samp></span></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="hsvhold"></a> +<h3 class="section">11.124 hsvhold<span class="pull-right"><a class="anchor hidden-xs" href="#hsvhold" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hsvhold" aria-hidden="true">TOC</a></span></h3> +<p>Turns a certain HSV range into gray values. +</p> +<p>This filter measures color difference between set HSV color in options +and ones measured in video stream. Depending on options, output +colors can be changed to be gray or not. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>hue</samp></span></dt> +<dd><p>Set the hue value which will be used in color difference calculation. +Allowed range is from -360 to 360. Default value is 0. +</p> +</dd> +<dt><span><samp>sat</samp></span></dt> +<dd><p>Set the saturation value which will be used in color difference calculation. +Allowed range is from -1 to 1. Default value is 0. +</p> +</dd> +<dt><span><samp>val</samp></span></dt> +<dd><p>Set the value which will be used in color difference calculation. +Allowed range is from -1 to 1. Default value is 0. +</p> +</dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Set similarity percentage with the key color. +Allowed range is from 0 to 1. Default value is 0.01. +</p> +<p>0.00001 matches only the exact key color, while 1.0 matches everything. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Blend percentage. +Allowed range is from 0 to 1. Default value is 0. +</p> +<p>0.0 makes pixels either fully gray, or not gray at all. +</p> +<p>Higher values result in more gray pixels, with a higher gray pixel +the more similar the pixels color is to the key color. +</p></dd> +</dl> + +<a name="hsvkey"></a> +<h3 class="section">11.125 hsvkey<span class="pull-right"><a class="anchor hidden-xs" href="#hsvkey" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hsvkey" aria-hidden="true">TOC</a></span></h3> +<p>Turns a certain HSV range into transparency. +</p> +<p>This filter measures color difference between set HSV color in options +and ones measured in video stream. Depending on options, output +colors can be changed to transparent by adding alpha channel. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>hue</samp></span></dt> +<dd><p>Set the hue value which will be used in color difference calculation. +Allowed range is from -360 to 360. Default value is 0. +</p> +</dd> +<dt><span><samp>sat</samp></span></dt> +<dd><p>Set the saturation value which will be used in color difference calculation. +Allowed range is from -1 to 1. Default value is 0. +</p> +</dd> +<dt><span><samp>val</samp></span></dt> +<dd><p>Set the value which will be used in color difference calculation. +Allowed range is from -1 to 1. Default value is 0. +</p> +</dd> +<dt><span><samp>similarity</samp></span></dt> +<dd><p>Set similarity percentage with the key color. +Allowed range is from 0 to 1. Default value is 0.01. +</p> +<p>0.00001 matches only the exact key color, while 1.0 matches everything. +</p> +</dd> +<dt><span><samp>blend</samp></span></dt> +<dd><p>Blend percentage. +Allowed range is from 0 to 1. Default value is 0. +</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="hue"></a> +<h3 class="section">11.126 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><span><samp>h</samp></span></dt> +<dd><p>Specify the hue angle as a number of degrees. It accepts an expression, +and defaults to "0". +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>Specify the saturation in the [-10,10] range. It accepts an expression and +defaults to "1". +</p> +</dd> +<dt><span><samp>H</samp></span></dt> +<dd><p>Specify the hue angle as a number of radians. It accepts an +expression, and defaults to "0". +</p> +</dd> +<dt><span><samp>b</samp></span></dt> +<dd><p>Specify the brightness in the [-10,10] range. It accepts an expression and +defaults to "0". +</p></dd> +</dl> + +<p><samp>h</samp> and <samp>H</samp> are mutually exclusive, and can’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><span><samp>n</samp></span></dt> +<dd><p>frame count of the input frame starting from 0 +</p> +</dd> +<dt><span><samp>pts</samp></span></dt> +<dd><p>presentation timestamp of the input frame expressed in time base units +</p> +</dd> +<dt><span><samp>r</samp></span></dt> +<dd><p>frame rate of the input video, NAN if the input frame rate is unknown +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown +</p> +</dd> +<dt><span><samp>tb</samp></span></dt> +<dd><p>time base of the input video +</p></dd> +</dl> + +<a name="Examples-86"></a> +<h4 class="subsection">11.126.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> 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="H=2*PI*t: s=sin(2*PI*t)+1" +</pre></div> + +</li><li> Apply a 3 seconds saturation fade-in effect starting at 0: +<div class="example"> +<pre class="example">hue="s=min(t/3\,1)" +</pre></div> + +<p>The general fade-in expression can be written as: +</p><div class="example"> +<pre class="example">hue="s=min(0\, max((t-START)/DURATION\, 1))" +</pre></div> + +</li><li> Apply a 3 seconds saturation fade-out effect starting at 5 seconds: +<div class="example"> +<pre class="example">hue="s=max(0\, min(1\, (8-t)/3))" +</pre></div> + +<p>The general fade-out expression can be written as: +</p><div class="example"> +<pre class="example">hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))" +</pre></div> + +</li></ul> + +<a name="Commands-96"></a> +<h4 class="subsection">11.126.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-96" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-96" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>b</samp></span></dt> +<dt><span><samp>s</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dt><span><samp>H</samp></span></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="huesaturation"></a> +<h3 class="section">11.127 huesaturation<span class="pull-right"><a class="anchor hidden-xs" href="#huesaturation" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-huesaturation" aria-hidden="true">TOC</a></span></h3> +<p>Apply hue-saturation-intensity adjustments to input video stream. +</p> +<p>This filter operates in RGB colorspace. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>hue</samp></span></dt> +<dd><p>Set the hue shift in degrees to apply. Default is 0. +Allowed range is from -180 to 180. +</p> +</dd> +<dt><span><samp>saturation</samp></span></dt> +<dd><p>Set the saturation shift. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>intensity</samp></span></dt> +<dd><p>Set the intensity shift. Default is 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>colors</samp></span></dt> +<dd><p>Set which primary and complementary colors are going to be adjusted. +This options is set by providing one or multiple values. +This can select multiple colors at once. By default all colors are selected. +</p><dl compact="compact"> +<dt><span>‘<samp>r</samp>’</span></dt> +<dd><p>Adjust reds. +</p></dd> +<dt><span>‘<samp>y</samp>’</span></dt> +<dd><p>Adjust yellows. +</p></dd> +<dt><span>‘<samp>g</samp>’</span></dt> +<dd><p>Adjust greens. +</p></dd> +<dt><span>‘<samp>c</samp>’</span></dt> +<dd><p>Adjust cyans. +</p></dd> +<dt><span>‘<samp>b</samp>’</span></dt> +<dd><p>Adjust blues. +</p></dd> +<dt><span>‘<samp>m</samp>’</span></dt> +<dd><p>Adjust magentas. +</p></dd> +<dt><span>‘<samp>a</samp>’</span></dt> +<dd><p>Adjust all colors. +</p></dd> +</dl> + +</dd> +<dt><span><samp>strength</samp></span></dt> +<dd><p>Set strength of filtering. Allowed range is from 0 to 100. +Default value is 1. +</p> +</dd> +<dt><span><samp>rw, gw, bw</samp></span></dt> +<dd><p>Set weight for each RGB component. Allowed range is from 0 to 1. +By default is set to 0.333, 0.334, 0.333. +Those options are used in saturation and lightess processing. +</p> +</dd> +<dt><span><samp>lightness</samp></span></dt> +<dd><p>Set preserving lightness, by default is disabled. +Adjusting hues can change lightness from original RGB triplet, +with this option enabled lightness is kept at same value. +</p></dd> +</dl> + +<a name="hysteresis"></a> +<h3 class="section">11.128 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 makes it possible to build more robust edge masks. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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><span><samp>threshold</samp></span></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> + +<p>The <code>hysteresis</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="iccdetect"></a> +<h3 class="section">11.129 iccdetect<span class="pull-right"><a class="anchor hidden-xs" href="#iccdetect" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-iccdetect" aria-hidden="true">TOC</a></span></h3> + +<p>Detect the colorspace from an embedded ICC profile (if present), and update +the frame’s tags accordingly. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>force</samp></span></dt> +<dd><p>If true, the frame’s existing colorspace tags will always be overridden by +values detected from an ICC profile. Otherwise, they will only be assigned if +they contain <code>unknown</code>. Enabled by default. +</p></dd> +</dl> + +<a name="iccgen"></a> +<h3 class="section">11.130 iccgen<span class="pull-right"><a class="anchor hidden-xs" href="#iccgen" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-iccgen" aria-hidden="true">TOC</a></span></h3> + +<p>Generate ICC profiles and attach them to frames. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>color_primaries</samp></span></dt> +<dt><span><samp>color_trc</samp></span></dt> +<dd><p>Configure the colorspace that the ICC profile will be generated for. The +default value of <code>auto</code> infers the value from the input frame’s metadata, +defaulting to BT.709/sRGB as appropriate. +</p> +<p>See the <a href="#setparams">setparams</a> filter for a list of possible values, but note that +<code>unknown</code> are not valid values for this filter. +</p> +</dd> +<dt><span><samp>force</samp></span></dt> +<dd><p>If true, an ICC profile will be generated even if it would overwrite an +already existing ICC profile. Disabled by default. +</p></dd> +</dl> + +<a name="identity"></a> +<h3 class="section">11.131 identity<span class="pull-right"><a class="anchor hidden-xs" href="#identity" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-identity" aria-hidden="true">TOC</a></span></h3> + +<p>Obtain the identity score between two input videos. +</p> +<p>This filter takes two input videos. +</p> +<p>Both input videos 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 per component, average, min and max identity score is printed through +the logging system. +</p> +<p>The filter stores the calculated identity scores of each frame in frame metadata. +</p> +<p>In the below example the input file <samp>main.mpg</samp> being processed is compared +with the reference file <samp>ref.mpg</samp>. +</p> +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mpg -lavfi identity -f null - +</pre></div> + +<a name="idet"></a> +<h3 class="section">11.132 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><span><samp>single.current_frame</samp></span></dt> +<dd><p>Detected type of current frame using single-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +</p> +</dd> +<dt><span><samp>single.tff</samp></span></dt> +<dd><p>Cumulative number of frames detected as top field first using single-frame detection. +</p> +</dd> +<dt><span><samp>multiple.tff</samp></span></dt> +<dd><p>Cumulative number of frames detected as top field first using multiple-frame detection. +</p> +</dd> +<dt><span><samp>single.bff</samp></span></dt> +<dd><p>Cumulative number of frames detected as bottom field first using single-frame detection. +</p> +</dd> +<dt><span><samp>multiple.current_frame</samp></span></dt> +<dd><p>Detected type of current frame using multiple-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +</p> +</dd> +<dt><span><samp>multiple.bff</samp></span></dt> +<dd><p>Cumulative number of frames detected as bottom field first using multiple-frame detection. +</p> +</dd> +<dt><span><samp>single.progressive</samp></span></dt> +<dd><p>Cumulative number of frames detected as progressive using single-frame detection. +</p> +</dd> +<dt><span><samp>multiple.progressive</samp></span></dt> +<dd><p>Cumulative number of frames detected as progressive using multiple-frame detection. +</p> +</dd> +<dt><span><samp>single.undetermined</samp></span></dt> +<dd><p>Cumulative number of frames that could not be classified using single-frame detection. +</p> +</dd> +<dt><span><samp>multiple.undetermined</samp></span></dt> +<dd><p>Cumulative number of frames that could not be classified using multiple-frame detection. +</p> +</dd> +<dt><span><samp>repeated.current_frame</samp></span></dt> +<dd><p>Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”. +</p> +</dd> +<dt><span><samp>repeated.neither</samp></span></dt> +<dd><p>Cumulative number of frames with no repeated field. +</p> +</dd> +<dt><span><samp>repeated.top</samp></span></dt> +<dd><p>Cumulative number of frames with the top field repeated from the previous frame’s top field. +</p> +</dd> +<dt><span><samp>repeated.bottom</samp></span></dt> +<dd><p>Cumulative number of frames with the bottom field repeated from the previous frame’s bottom field. +</p></dd> +</dl> + +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>intl_thres</samp></span></dt> +<dd><p>Set interlacing threshold. +</p></dd> +<dt><span><samp>prog_thres</samp></span></dt> +<dd><p>Set progressive threshold. +</p></dd> +<dt><span><samp>rep_thres</samp></span></dt> +<dd><p>Threshold for repeated field detection. +</p></dd> +<dt><span><samp>half_life</samp></span></dt> +<dd><p>Number of frames after which a given frame’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><span><samp>analyze_interlaced_flag</samp></span></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">11.133 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><span><samp>luma_mode, l</samp></span></dt> +<dt><span><samp>chroma_mode, c</samp></span></dt> +<dt><span><samp>alpha_mode, a</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>Do nothing. +</p> +</dd> +<dt><span>‘<samp>deinterleave, d</samp>’</span></dt> +<dd><p>Deinterleave fields, placing one above the other. +</p> +</dd> +<dt><span>‘<samp>interleave, i</samp>’</span></dt> +<dd><p>Interleave fields. Reverse the effect of deinterleaving. +</p></dd> +</dl> +<p>Default value is <code>none</code>. +</p> +</dd> +<dt><span><samp>luma_swap, ls</samp></span></dt> +<dt><span><samp>chroma_swap, cs</samp></span></dt> +<dt><span><samp>alpha_swap, as</samp></span></dt> +<dd><p>Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is <code>0</code>. +</p></dd> +</dl> + +<a name="Commands-97"></a> +<h4 class="subsection">11.133.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-97" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-97" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="inflate"></a> +<h3 class="section">11.134 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +</p></dd> +</dl> + +<a name="Commands-98"></a> +<h4 class="subsection">11.134.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-98" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-98" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="interlace"></a> +<h3 class="section">11.135 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 --------------------> Frame 'j' Line 0 + Line 1 Line 1 ----> Frame 'j+1' Line 1 + Line 2 ---------------------> Frame 'j' Line 2 + Line 3 Line 3 ----> 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><span><samp>scan</samp></span></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><span><samp>lowpass</samp></span></dt> +<dd><p>Vertical lowpass filter to avoid twitter interlacing and +reduce moire patterns. +</p> +<dl compact="compact"> +<dt><span>‘<samp>0, off</samp>’</span></dt> +<dd><p>Disable vertical lowpass filter +</p> +</dd> +<dt><span>‘<samp>1, linear</samp>’</span></dt> +<dd><p>Enable linear filter (default) +</p> +</dd> +<dt><span>‘<samp>2, complex</samp>’</span></dt> +<dd><p>Enable complex filter. This will slightly less reduce twitter and moire +but better retain detail and subjective sharpness impression. +</p> +</dd> +</dl> +</dd> +</dl> + +<a name="kerndeint"></a> +<h3 class="section">11.136 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’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><span><samp>thresh</samp></span></dt> +<dd><p>Set the threshold which affects the filter’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><span><samp>map</samp></span></dt> +<dd><p>Paint pixels exceeding the threshold value to white if set to 1. +Default is 0. +</p> +</dd> +<dt><span><samp>order</samp></span></dt> +<dd><p>Set the fields order. Swap fields if set to 1, leave fields alone if +0. Default is 0. +</p> +</dd> +<dt><span><samp>sharp</samp></span></dt> +<dd><p>Enable additional sharpening if set to 1. Default is 0. +</p> +</dd> +<dt><span><samp>twoway</samp></span></dt> +<dd><p>Enable twoway sharpening if set to 1. Default is 0. +</p></dd> +</dl> + +<a name="Examples-87"></a> +<h4 class="subsection">11.136.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> 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="kirsch"></a> +<h3 class="section">11.137 kirsch<span class="pull-right"><a class="anchor hidden-xs" href="#kirsch" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-kirsch" aria-hidden="true">TOC</a></span></h3> +<p>Apply kirsch operator to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +</p></dd> +</dl> + +<a name="Commands-99"></a> +<h4 class="subsection">11.137.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-99" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-99" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="lagfun"></a> +<h3 class="section">11.138 lagfun<span class="pull-right"><a class="anchor hidden-xs" href="#lagfun" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lagfun" aria-hidden="true">TOC</a></span></h3> + +<p>Slowly update darker pixels. +</p> +<p>This filter makes short flashes of light appear longer. +This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>decay</samp></span></dt> +<dd><p>Set factor for decaying. Default is .95. Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15. +</p></dd> +</dl> + +<a name="Commands-100"></a> +<h4 class="subsection">11.138.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-100" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-100" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="lenscorrection"></a> +<h3 class="section">11.139 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"></a> +<h4 class="subsection">11.139.1 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></h4> + +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>cx</samp></span></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. Default is 0.5. +</p></dd> +<dt><span><samp>cy</samp></span></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. Default is 0.5. +</p></dd> +<dt><span><samp>k1</samp></span></dt> +<dd><p>Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means +no correction. Default is 0. +</p></dd> +<dt><span><samp>k2</samp></span></dt> +<dd><p>Coefficient of the double quadratic correction term. This value has a range [-1,1]. +0 means no correction. Default is 0. +</p></dd> +<dt><span><samp>i</samp></span></dt> +<dd><p>Set interpolation type. Can be <code>nearest</code> or <code>bilinear</code>. +Default is <code>nearest</code>. +</p></dd> +<dt><span><samp>fc</samp></span></dt> +<dd><p>Specify the color of the unmapped pixels. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. Default color is <code>black@0</code>. +</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="Commands-101"></a> +<h4 class="subsection">11.139.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-101" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-101" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="lensfun"></a> +<h3 class="section">11.140 lensfun<span class="pull-right"><a class="anchor hidden-xs" href="#lensfun" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lensfun" aria-hidden="true">TOC</a></span></h3> + +<p>Apply lens correction via the lensfun library (<a href="http://lensfun.sourceforge.net/">http://lensfun.sourceforge.net/</a>). +</p> +<p>The <code>lensfun</code> filter requires the camera make, camera model, and lens model +to apply the lens correction. The filter will load the lensfun database and +query it to find the corresponding camera and lens entries in the database. As +long as these entries can be found with the given options, the filter can +perform corrections on frames. Note that incomplete strings will result in the +filter choosing the best match with the given options, and the filter will +output the chosen camera and lens models (logged with level "info"). You must +provide the make, camera model, and lens model as they are required. +</p> +<p>To obtain a list of available makes and models, leave out one or both of <code>make</code> and +<code>model</code> options. The filter will send the full list to the log with level <code>INFO</code>. +The first column is the make and the second column is the model. +To obtain a list of available lenses, set any values for make and model and leave out the +<code>lens_model</code> option. The filter will send the full list of lenses in the log with level +<code>INFO</code>. The ffmpeg tool will exit after the list is printed. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>make</samp></span></dt> +<dd><p>The make of the camera (for example, "Canon"). This option is required. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>The model of the camera (for example, "Canon EOS 100D"). This option is +required. +</p> +</dd> +<dt><span><samp>lens_model</samp></span></dt> +<dd><p>The model of the lens (for example, "Canon EF-S 18-55mm f/3.5-5.6 IS STM"). This +option is required. +</p> +</dd> +<dt><span><samp>db_path</samp></span></dt> +<dd><p>The full path to the lens database folder. If not set, the filter will attempt to +load the database from the install path when the library was built. Default is unset. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>The type of correction to apply. The following values are valid options: +</p> +<dl compact="compact"> +<dt><span>‘<samp>vignetting</samp>’</span></dt> +<dd><p>Enables fixing lens vignetting. +</p> +</dd> +<dt><span>‘<samp>geometry</samp>’</span></dt> +<dd><p>Enables fixing lens geometry. This is the default. +</p> +</dd> +<dt><span>‘<samp>subpixel</samp>’</span></dt> +<dd><p>Enables fixing chromatic aberrations. +</p> +</dd> +<dt><span>‘<samp>vig_geo</samp>’</span></dt> +<dd><p>Enables fixing lens vignetting and lens geometry. +</p> +</dd> +<dt><span>‘<samp>vig_subpixel</samp>’</span></dt> +<dd><p>Enables fixing lens vignetting and chromatic aberrations. +</p> +</dd> +<dt><span>‘<samp>distortion</samp>’</span></dt> +<dd><p>Enables fixing both lens geometry and chromatic aberrations. +</p> +</dd> +<dt><span>‘<samp>all</samp>’</span></dt> +<dd><p>Enables all possible corrections. +</p> +</dd> +</dl> +</dd> +<dt><span><samp>focal_length</samp></span></dt> +<dd><p>The focal length of the image/video (zoom; expected constant for video). For +example, a 18–55mm lens has focal length range of [18–55], so a value in that +range should be chosen when using that lens. Default 18. +</p> +</dd> +<dt><span><samp>aperture</samp></span></dt> +<dd><p>The aperture of the image/video (expected constant for video). Note that +aperture is only used for vignetting correction. Default 3.5. +</p> +</dd> +<dt><span><samp>focus_distance</samp></span></dt> +<dd><p>The focus distance of the image/video (expected constant for video). Note that +focus distance is only used for vignetting and only slightly affects the +vignetting correction process. If unknown, leave it at the default value (which +is 1000). +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>The scale factor which is applied after transformation. After correction the +video is no longer necessarily rectangular. This parameter controls how much of +the resulting image is visible. The value 0 means that a value will be chosen +automatically such that there is little or no unmapped area in the output +image. 1.0 means that no additional scaling is done. Lower values may result +in more of the corrected image being visible, while higher values may avoid +unmapped areas in the output. +</p> +</dd> +<dt><span><samp>target_geometry</samp></span></dt> +<dd><p>The target geometry of the output image/video. The following values are valid +options: +</p> +<dl compact="compact"> +<dt><span>‘<samp>rectilinear (default)</samp>’</span></dt> +<dt><span>‘<samp>fisheye</samp>’</span></dt> +<dt><span>‘<samp>panoramic</samp>’</span></dt> +<dt><span>‘<samp>equirectangular</samp>’</span></dt> +<dt><span>‘<samp>fisheye_orthographic</samp>’</span></dt> +<dt><span>‘<samp>fisheye_stereographic</samp>’</span></dt> +<dt><span>‘<samp>fisheye_equisolid</samp>’</span></dt> +<dt><span>‘<samp>fisheye_thoby</samp>’</span></dt> +</dl> +</dd> +<dt><span><samp>reverse</samp></span></dt> +<dd><p>Apply the reverse of image correction (instead of correcting distortion, apply +it). +</p> +</dd> +<dt><span><samp>interpolation</samp></span></dt> +<dd><p>The type of interpolation used when correcting distortion. The following values +are valid options: +</p> +<dl compact="compact"> +<dt><span>‘<samp>nearest</samp>’</span></dt> +<dt><span>‘<samp>linear (default)</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +</dl> +</dd> +</dl> + +<a name="Examples-88"></a> +<h4 class="subsection">11.140.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> Apply lens correction with make "Canon", camera model "Canon EOS 100D", and lens +model "Canon EF-S 18-55mm f/3.5-5.6 IS STM" with focal length of "18" and +aperture of "8.0". + +<div class="example"> +<pre class="example">ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8 -c:v h264 -b:v 8000k output.mov +</pre></div> + +</li><li> Apply the same as before, but only for the first 5 seconds of video. + +<div class="example"> +<pre class="example">ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8:enable='lte(t\,5)' -c:v h264 -b:v 8000k output.mov +</pre></div> + +</li></ul> + +<a name="libplacebo"></a> +<h3 class="section">11.141 libplacebo<span class="pull-right"><a class="anchor hidden-xs" href="#libplacebo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libplacebo" aria-hidden="true">TOC</a></span></h3> + +<p>Flexible GPU-accelerated processing filter based on libplacebo +(<a href="https://code.videolan.org/videolan/libplacebo">https://code.videolan.org/videolan/libplacebo</a>). Note that this filter +currently only accepts Vulkan input frames. +</p> +<a name="Options-1"></a> +<h4 class="subsection">11.141.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> + +<p>The options for this filter are divided into the following sections: +</p> +<a name="Output-mode"></a> +<h4 class="subsubsection">11.141.1.1 Output mode<span class="pull-right"><a class="anchor hidden-xs" href="#Output-mode" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Output-mode" aria-hidden="true">TOC</a></span></h4> +<p>These options control the overall output mode. By default, libplacebo will try +to preserve the source colorimetry and size as best as it can, but it will +apply any embedded film grain, dolby vision metadata or anamorphic SAR present +in source frames. +</p><dl compact="compact"> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set the output video dimension expression. Default value is the input dimension. +</p> +<p>Allows for the same expressions as the <a href="#scale">scale</a> filter. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Set the output format override. If unset (the default), frames will be output +in the same format as the respective input frames. Otherwise, format conversion +will be performed. +</p> +</dd> +<dt><span><samp>force_original_aspect_ratio</samp></span></dt> +<dt><span><samp>force_divisible_by</samp></span></dt> +<dd><p>Work the same as the identical <a href="#scale">scale</a> filter options. +</p> +</dd> +<dt><span><samp>normalize_sar</samp></span></dt> +<dd><p>If enabled, output frames will always have a pixel aspect ratio of 1:1. This +will introduce padding/cropping as necessary. If disabled (the default), any +aspect ratio mismatches, including those from e.g. anamorphic video sources, +are forwarded to the output pixel aspect ratio. +</p> +</dd> +<dt><span><samp>pad_crop_ratio</samp></span></dt> +<dd><p>Specifies a ratio (between <code>0.0</code> and <code>1.0</code>) between padding and +cropping when the input aspect ratio does not match the output aspect ratio and +<samp>normalize_sar</samp> is in effect. The default of <code>0.0</code> always pads the +content with black borders, while a value of <code>1.0</code> always crops off parts +of the content. Intermediate values are possible, leading to a mix of the two +approaches. +</p> +</dd> +<dt><span><samp>colorspace</samp></span></dt> +<dt><span><samp>color_primaries</samp></span></dt> +<dt><span><samp>color_trc</samp></span></dt> +<dt><span><samp>range</samp></span></dt> +<dd><p>Configure the colorspace that output frames will be delivered in. The default +value of <code>auto</code> outputs frames in the same format as the input frames, +leading to no change. For any other value, conversion will be performed. +</p> +<p>See the <a href="#setparams">setparams</a> filter for a list of possible values. +</p> +</dd> +<dt><span><samp>apply_filmgrain</samp></span></dt> +<dd><p>Apply film grain (e.g. AV1 or H.274) if present in source frames, and strip +it from the output. Enabled by default. +</p> +</dd> +<dt><span><samp>apply_dolbyvision</samp></span></dt> +<dd><p>Apply Dolby Vision RPU metadata if present in source frames, and strip it from +the output. Enabled by default. Note that Dolby Vision will always output +BT.2020+PQ, overriding the usual input frame metadata. These will also be +picked as the values of <code>auto</code> for the respective frame output options. +</p></dd> +</dl> + +<a name="Scaling"></a> +<h4 class="subsubsection">11.141.1.2 Scaling<span class="pull-right"><a class="anchor hidden-xs" href="#Scaling" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Scaling" aria-hidden="true">TOC</a></span></h4> +<p>The options in this section control how libplacebo performs upscaling and (if +necessary) downscaling. Note that libplacebo will always internally operate on +4:4:4 content, so any sub-sampled chroma formats such as <code>yuv420p</code> will +necessarily be upsampled and downsampled as part of the rendering process. That +means scaling might be in effect even if the source and destination resolution +are the same. +</p><dl compact="compact"> +<dt><span><samp>upscaler</samp></span></dt> +<dt><span><samp>downscaler</samp></span></dt> +<dd><p>Configure the filter kernel used for upscaling and downscaling. The respective +defaults are <code>spline36</code> and <code>mitchell</code>. For a full list of possible +values, pass <code>help</code> to these options. The most important values are: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Forces the use of built-in GPU texture sampling (typically bilinear). Extremely +fast but poor quality, especially when downscaling. +</p> +</dd> +<dt><span>‘<samp>bilinear</samp>’</span></dt> +<dd><p>Bilinear interpolation. Can generally be done for free on GPUs, except when +doing so would lead to aliasing. Fast and low quality. +</p> +</dd> +<dt><span>‘<samp>nearest</samp>’</span></dt> +<dd><p>Nearest-neighbour interpolation. Sharp but highly aliasing. +</p> +</dd> +<dt><span>‘<samp>oversample</samp>’</span></dt> +<dd><p>Algorithm that looks visually similar to nearest-neighbour interpolation but +tries to preserve pixel aspect ratio. Good for pixel art, since it results in +minimal distortion of the artistic appearance. +</p> +</dd> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dd><p>Standard sinc-sinc interpolation kernel. +</p> +</dd> +<dt><span>‘<samp>spline36</samp>’</span></dt> +<dd><p>Cubic spline approximation of lanczos. No difference in performance, but has +very slightly less ringing. +</p> +</dd> +<dt><span>‘<samp>ewa_lanczos</samp>’</span></dt> +<dd><p>Elliptically weighted average version of lanczos, based on a jinc-sinc kernel. +This is also popularly referred to as just "Jinc scaling". Slow but very high +quality. +</p> +</dd> +<dt><span>‘<samp>gaussian</samp>’</span></dt> +<dd><p>Gaussian kernel. Has certain ideal mathematical properties, but subjectively +very blurry. +</p> +</dd> +<dt><span>‘<samp>mitchell</samp>’</span></dt> +<dd><p>Cubic BC spline with parameters recommended by Mitchell and Netravali. Very +little ringing. +</p></dd> +</dl> + +</dd> +<dt><span><samp>lut_entries</samp></span></dt> +<dd><p>Configures the size of scaler LUTs, ranging from <code>1</code> to <code>256</code>. The +default of <code>0</code> will pick libplacebo’s internal default, typically +<code>64</code>. +</p> +</dd> +<dt><span><samp>antiringing</samp></span></dt> +<dd><p>Enables anti-ringing (for non-EWA filters). The value (between <code>0.0</code> and +<code>1.0</code>) configures the strength of the anti-ringing algorithm. May increase +aliasing if set too high. Disabled by default. +</p> +</dd> +<dt><span><samp>sigmoid</samp></span></dt> +<dd><p>Enable sigmoidal compression during upscaling. Reduces ringing slightly. +Enabled by default. +</p></dd> +</dl> + +<a name="Debanding"></a> +<h4 class="subsubsection">11.141.1.3 Debanding<span class="pull-right"><a class="anchor hidden-xs" href="#Debanding" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Debanding" aria-hidden="true">TOC</a></span></h4> +<p>Libplacebo comes with a built-in debanding filter that is good at counteracting +many common sources of banding and blocking. Turning this on is highly +recommended whenever quality is desired. +</p><dl compact="compact"> +<dt><span><samp>deband</samp></span></dt> +<dd><p>Enable (fast) debanding algorithm. Disabled by default. +</p> +</dd> +<dt><span><samp>deband_iterations</samp></span></dt> +<dd><p>Number of deband iterations of the debanding algorithm. Each iteration is +performed with progressively increased radius (and diminished threshold). +Recommended values are in the range <code>1</code> to <code>4</code>. Defaults to <code>1</code>. +</p> +</dd> +<dt><span><samp>deband_threshold</samp></span></dt> +<dd><p>Debanding filter strength. Higher numbers lead to more aggressive debanding. +Defaults to <code>4.0</code>. +</p> +</dd> +<dt><span><samp>deband_radius</samp></span></dt> +<dd><p>Debanding filter radius. A higher radius is better for slow gradients, while +a lower radius is better for steep gradients. Defaults to <code>16.0</code>. +</p> +</dd> +<dt><span><samp>deband_grain</samp></span></dt> +<dd><p>Amount of extra output grain to add. Helps hide imperfections. Defaults to +<code>6.0</code>. +</p></dd> +</dl> + +<a name="Color-adjustment"></a> +<h4 class="subsubsection">11.141.1.4 Color adjustment<span class="pull-right"><a class="anchor hidden-xs" href="#Color-adjustment" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Color-adjustment" aria-hidden="true">TOC</a></span></h4> +<p>A collection of subjective color controls. Not very rigorous, so the exact +effect will vary somewhat depending on the input primaries and colorspace. +</p><dl compact="compact"> +<dt><span><samp>brightness</samp></span></dt> +<dd><p>Brightness boost, between <code>-1.0</code> and <code>1.0</code>. Defaults to <code>0.0</code>. +</p> +</dd> +<dt><span><samp>contrast</samp></span></dt> +<dd><p>Contrast gain, between <code>0.0</code> and <code>16.0</code>. Defaults to <code>1.0</code>. +</p> +</dd> +<dt><span><samp>saturation</samp></span></dt> +<dd><p>Saturation gain, between <code>0.0</code> and <code>16.0</code>. Defaults to <code>1.0</code>. +</p> +</dd> +<dt><span><samp>hue</samp></span></dt> +<dd><p>Hue shift in radians, between <code>-3.14</code> and <code>3.14</code>. Defaults to +<code>0.0</code>. This will rotate the UV subvector, defaulting to BT.709 +coefficients for RGB inputs. +</p> +</dd> +<dt><span><samp>gamma</samp></span></dt> +<dd><p>Gamma adjustment, between <code>0.0</code> and <code>16.0</code>. Defaults to <code>1.0</code>. +</p> +</dd> +<dt><span><samp>cones</samp></span></dt> +<dd><p>Cone model to use for color blindness simulation. Accepts any combination of +<code>l</code>, <code>m</code> and <code>s</code>. Here are some examples: +</p><dl compact="compact"> +<dt><span>‘<samp>m</samp>’</span></dt> +<dd><p>Deuteranomaly / deuteranopia (affecting 3%-4% of the population) +</p></dd> +<dt><span>‘<samp>l</samp>’</span></dt> +<dd><p>Protanomaly / protanopia (affecting 1%-2% of the population) +</p></dd> +<dt><span>‘<samp>l+m</samp>’</span></dt> +<dd><p>Monochromacy (very rare) +</p></dd> +<dt><span>‘<samp>l+m+s</samp>’</span></dt> +<dd><p>Achromatopsy (complete loss of daytime vision, extremely rare) +</p></dd> +</dl> + +</dd> +<dt><span><samp>cone-strength</samp></span></dt> +<dd><p>Gain factor for the cones specified by <code>cones</code>, between <code>0.0</code> and +<code>10.0</code>. A value of <code>1.0</code> results in no change to color vision. A +value of <code>0.0</code> (the default) simulates complete loss of those cones. Values +above <code>1.0</code> result in exaggerating the differences between cones, which +may help compensate for reduced color vision. +</p></dd> +</dl> + +<a name="Peak-detection"></a> +<h4 class="subsubsection">11.141.1.5 Peak detection<span class="pull-right"><a class="anchor hidden-xs" href="#Peak-detection" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Peak-detection" aria-hidden="true">TOC</a></span></h4> +<p>To help deal with sources that only have static HDR10 metadata (or no tagging +whatsoever), libplacebo uses its own internal frame analysis compute shader to +analyze source frames and adapt the tone mapping function in realtime. If this +is too slow, or if exactly reproducible frame-perfect results are needed, it’s +recommended to turn this feature off. +</p><dl compact="compact"> +<dt><span><samp>peak_detect</samp></span></dt> +<dd><p>Enable HDR peak detection. Ignores static MaxCLL/MaxFALL values in favor of +dynamic detection from the input. Note that the detected values do not get +written back to the output frames, they merely guide the internal tone mapping +process. Enabled by default. +</p> +</dd> +<dt><span><samp>smoothing_period</samp></span></dt> +<dd><p>Peak detection smoothing period, between <code>0.0</code> and <code>1000.0</code>. Higher +values result in peak detection becoming less responsive to changes in the +input. Defaults to <code>100.0</code>. +</p> +</dd> +<dt><span><samp>minimum_peak</samp></span></dt> +<dd><p>Lower bound on the detected peak (relative to SDR white), between <code>0.0</code> +and <code>100.0</code>. Defaults to <code>1.0</code>. +</p> +</dd> +<dt><span><samp>scene_threshold_low</samp></span></dt> +<dt><span><samp>scene_threshold_high</samp></span></dt> +<dd><p>Lower and upper thresholds for scene change detection. Expressed in a +logarithmic scale between <code>0.0</code> and <code>100.0</code>. Default to <code>5.5</code> +and <code>10.0</code>, respectively. Setting either to a negative value disables +this functionality. +</p> +</dd> +<dt><span><samp>overshoot</samp></span></dt> +<dd><p>Peak smoothing overshoot margin, between <code>0.0</code> and <code>1.0</code>. Provides a +safety margin to prevent clipping as a result of peak smoothing. Defaults to +<code>0.05</code>, corresponding to a margin of 5%. +</p></dd> +</dl> + +<a name="Tone-mapping"></a> +<h4 class="subsubsection">11.141.1.6 Tone mapping<span class="pull-right"><a class="anchor hidden-xs" href="#Tone-mapping" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Tone-mapping" aria-hidden="true">TOC</a></span></h4> +<p>The options in this section control how libplacebo performs tone-mapping and +gamut-mapping when dealing with mismatches between wide-gamut or HDR content. +In general, libplacebo relies on accurate source tagging and mastering display +gamut information to produce the best results. +</p><dl compact="compact"> +<dt><span><samp>intent</samp></span></dt> +<dd><p>Rendering intent to use when adapting between different primary color gamuts +(after tone-mapping). +</p><dl compact="compact"> +<dt><span>‘<samp>perceptual</samp>’</span></dt> +<dd><p>Perceptual gamut mapping. Currently equivalent to relative colorimetric. +</p></dd> +<dt><span>‘<samp>relative</samp>’</span></dt> +<dd><p>Relative colorimetric. This is the default. +</p></dd> +<dt><span>‘<samp>absolute</samp>’</span></dt> +<dd><p>Absolute colorimetric. +</p></dd> +<dt><span>‘<samp>saturation</samp>’</span></dt> +<dd><p>Saturation mapping. Forcibly stretches the source gamut to the target gamut. +</p></dd> +</dl> + +</dd> +<dt><span><samp>gamut_mode</samp></span></dt> +<dd><p>How to handle out-of-gamut colors that can occur as a result of colorimetric +gamut mapping. +</p><dl compact="compact"> +<dt><span>‘<samp>clip</samp>’</span></dt> +<dd><p>Do nothing, simply clip out-of-range colors to the RGB volume. This is the +default. +</p></dd> +<dt><span>‘<samp>warn</samp>’</span></dt> +<dd><p>Highlight out-of-gamut pixels (by coloring them pink). +</p></dd> +<dt><span>‘<samp>darken</samp>’</span></dt> +<dd><p>Linearly reduces content brightness to preserves saturated details, followed by +clipping the remaining out-of-gamut colors. As the name implies, this makes +everything darker, but provides a good balance between preserving details and +colors. +</p></dd> +<dt><span>‘<samp>desaturate</samp>’</span></dt> +<dd><p>Hard-desaturates out-of-gamut colors towards white, while preserving the +luminance. Has a tendency to shift colors. +</p></dd> +</dl> + +</dd> +<dt><span><samp>tonemapping</samp></span></dt> +<dd><p>Tone-mapping algorithm to use. Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Automatic selection based on internal heuristics. This is the default. +</p></dd> +<dt><span>‘<samp>clip</samp>’</span></dt> +<dd><p>Performs no tone-mapping, just clips out-of-range colors. Retains perfect color +accuracy for in-range colors but completely destroys out-of-range information. +Does not perform any black point adaptation. Not configurable. +</p></dd> +<dt><span>‘<samp>bt.2390</samp>’</span></dt> +<dd><p>EETF from the ITU-R Report BT.2390, a hermite spline roll-off with linear +segment. The knee point offset is configurable. Note that this parameter +defaults to <code>1.0</code>, rather than the value of <code>0.5</code> from the ITU-R +spec. +</p></dd> +<dt><span>‘<samp>bt.2446a</samp>’</span></dt> +<dd><p>EETF from ITU-R Report BT.2446, method A. Designed for well-mastered HDR +sources. Can be used for both forward and inverse tone mapping. Not +configurable. +</p></dd> +<dt><span>‘<samp>spline</samp>’</span></dt> +<dd><p>Simple spline consisting of two polynomials, joined by a single pivot point. +The parameter gives the pivot point (in PQ space), defaulting to <code>0.30</code>. +Can be used for both forward and inverse tone mapping. +</p></dd> +<dt><span>‘<samp>reinhard</samp>’</span></dt> +<dd><p>Simple non-linear, global tone mapping algorithm. The parameter specifies the +local contrast coefficient at the display peak. Essentially, a parameter of +<code>0.5</code> implies that the reference white will be about half as bright as +when clipping. Defaults to <code>0.5</code>, which results in the simplest +formulation of this function. +</p></dd> +<dt><span>‘<samp>mobius</samp>’</span></dt> +<dd><p>Generalization of the reinhard tone mapping algorithm to support an additional +linear slope near black. The tone mapping parameter indicates the trade-off +between the linear section and the non-linear section. Essentially, for a given +parameter <var>x</var>, every color value below <var>x</var> will be mapped linearly, +while higher values get non-linearly tone-mapped. Values near <code>1.0</code> make +this curve behave like <code>clip</code>, while values near <code>0.0</code> make this +curve behave like <code>reinhard</code>. The default value is <code>0.3</code>, which +provides a good balance between colorimetric accuracy and preserving +out-of-gamut details. +</p></dd> +<dt><span>‘<samp>hable</samp>’</span></dt> +<dd><p>Piece-wise, filmic tone-mapping algorithm developed by John Hable for use in +Uncharted 2, inspired by a similar tone-mapping algorithm used by Kodak. +Popularized by its use in video games with HDR rendering. Preserves both dark +and bright details very well, but comes with the drawback of changing the +average brightness quite significantly. This is sort of similar to +<code>reinhard</code> with parameter <code>0.24</code>. +</p></dd> +<dt><span>‘<samp>gamma</samp>’</span></dt> +<dd><p>Fits a gamma (power) function to transfer between the source and target color +spaces, effectively resulting in a perceptual hard-knee joining two roughly +linear sections. This preserves details at all scales fairly accurately, but +can result in an image with a muted or dull appearance. The parameter is used +as the cutoff point, defaulting to <code>0.5</code>. +</p></dd> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dd><p>Linearly stretches the input range to the output range, in PQ space. This will +preserve all details accurately, but results in a significantly different +average brightness. Can be used for inverse tone-mapping in addition to regular +tone-mapping. The parameter can be used as an additional linear gain +coefficient (defaulting to <code>1.0</code>). +</p></dd> +</dl> + +</dd> +<dt><span><samp>tonemapping_param</samp></span></dt> +<dd><p>For tunable tone mapping functions, this parameter can be used to fine-tune the +curve behavior. Refer to the documentation of <code>tonemapping</code>. The default +value of <code>0.0</code> is replaced by the curve’s preferred default setting. +</p> +</dd> +<dt><span><samp>tonemapping_mode</samp></span></dt> +<dd><p>This option determines how the tone mapping function specified by +<code>tonemapping</code> is applied to the colors in a scene. Possible values are: +</p><dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Automatic selection based on internal heuristics. This is the default. +</p></dd> +<dt><span>‘<samp>rgb</samp>’</span></dt> +<dd><p>Apply the function per-channel in the RGB colorspace. +Per-channel tone-mapping in RGB. Guarantees no clipping and heavily desaturates +the output, but distorts the colors quite significantly. Very similar to the +"Hollywood" look and feel. +</p></dd> +<dt><span>‘<samp>max</samp>’</span></dt> +<dd><p>Tone-mapping is performed on the brightest component found in the signal. Good +at preserving details in highlights, but has a tendency to crush blacks. +</p></dd> +<dt><span>‘<samp>hybrid</samp>’</span></dt> +<dd><p>Tone-map per-channel for highlights and linearly (luma-based) for +midtones/shadows, based on a fixed gamma <code>2.4</code> coefficient curve. +</p></dd> +<dt><span>‘<samp>luma</samp>’</span></dt> +<dd><p>Tone-map linearly on the luma component (CIE Y), and adjust (desaturate) the +chromaticities to compensate using a simple constant factor. This is +essentially the mode used in ITU-R BT.2446 method A. +</p></dd> +</dl> + +</dd> +<dt><span><samp>inverse_tonemapping</samp></span></dt> +<dd><p>If enabled, this filter will also attempt stretching SDR signals to fill HDR +output color volumes. Disabled by default. +</p> +</dd> +<dt><span><samp>tonemapping_crosstalk</samp></span></dt> +<dd><p>Extra tone-mapping crosstalk factor, between <code>0.0</code> and <code>0.3</code>. This +can help reduce issues tone-mapping certain bright spectral colors. Defaults to +<code>0.04</code>. +</p> +</dd> +<dt><span><samp>tonemapping_lut_size</samp></span></dt> +<dd><p>Size of the tone-mapping LUT, between <code>2</code> and <code>1024</code>. Defaults to +<code>256</code>. Note that this figure is squared when combined with +<code>peak_detect</code>. +</p></dd> +</dl> + +<a name="Dithering"></a> +<h4 class="subsubsection">11.141.1.7 Dithering<span class="pull-right"><a class="anchor hidden-xs" href="#Dithering" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Dithering" aria-hidden="true">TOC</a></span></h4> +<p>By default, libplacebo will dither whenever necessary, which includes rendering +to any integer format below 16-bit precision. It’s recommended to always leave +this on, since not doing so may result in visible banding in the output, even +if the <code>debanding</code> filter is enabled. If maximum performance is needed, +use <code>ordered_fixed</code> instead of disabling dithering. +</p><dl compact="compact"> +<dt><span><samp>dithering</samp></span></dt> +<dd><p>Dithering method to use. Accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Disables dithering completely. May result in visible banding. +</p></dd> +<dt><span>‘<samp>blue</samp>’</span></dt> +<dd><p>Dither with pseudo-blue noise. This is the default. +</p></dd> +<dt><span>‘<samp>ordered</samp>’</span></dt> +<dd><p>Tunable ordered dither pattern. +</p></dd> +<dt><span>‘<samp>ordered_fixed</samp>’</span></dt> +<dd><p>Faster ordered dither with a fixed size of <code>6</code>. Texture-less. +</p></dd> +<dt><span>‘<samp>white</samp>’</span></dt> +<dd><p>Dither with white noise. Texture-less. +</p></dd> +</dl> + +</dd> +<dt><span><samp>dither_lut_size</samp></span></dt> +<dd><p>Dither LUT size, as log base2 between <code>1</code> and <code>8</code>. Defaults to +<code>6</code>, corresponding to a LUT size of <code>64x64</code>. +</p> +</dd> +<dt><span><samp>dither_temporal</samp></span></dt> +<dd><p>Enables temporal dithering. Disabled by default. +</p></dd> +</dl> + +<a name="Custom-shaders"></a> +<h4 class="subsubsection">11.141.1.8 Custom shaders<span class="pull-right"><a class="anchor hidden-xs" href="#Custom-shaders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Custom-shaders" aria-hidden="true">TOC</a></span></h4> +<p>libplacebo supports a number of custom shaders based on the mpv .hook GLSL +syntax. A collection of such shaders can be found here: +<a href="https://github.com/mpv-player/mpv/wiki/User-Scripts#user-shaders">https://github.com/mpv-player/mpv/wiki/User-Scripts#user-shaders</a> +</p> +<p>A full description of the mpv shader format is beyond the scope of this +section, but a summary can be found here: +<a href="https://mpv.io/manual/master/#options-glsl-shader">https://mpv.io/manual/master/#options-glsl-shader</a> +</p><dl compact="compact"> +<dt><span><samp>custom_shader_path</samp></span></dt> +<dd><p>Specifies a path to a custom shader file to load at runtime. +</p> +</dd> +<dt><span><samp>custom_shader_bin</samp></span></dt> +<dd><p>Specifies a complete custom shader as a raw string. +</p></dd> +</dl> + +<a name="Debugging-_002f-performance"></a> +<h4 class="subsubsection">11.141.1.9 Debugging / performance<span class="pull-right"><a class="anchor hidden-xs" href="#Debugging-_002f-performance" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Debugging-_002f-performance" aria-hidden="true">TOC</a></span></h4> +<p>All of the options in this section default off. They may be of assistance when +attempting to squeeze the maximum performance at the cost of quality. +</p><dl compact="compact"> +<dt><span><samp>skip_aa</samp></span></dt> +<dd><p>Disable anti-aliasing when downscaling. +</p> +</dd> +<dt><span><samp>polar_cutoff</samp></span></dt> +<dd><p>Truncate polar (EWA) scaler kernels below this absolute magnitude, between +<code>0.0</code> and <code>1.0</code>. +</p> +</dd> +<dt><span><samp>disable_linear</samp></span></dt> +<dd><p>Disable linear light scaling. +</p> +</dd> +<dt><span><samp>disable_builtin</samp></span></dt> +<dd><p>Disable built-in GPU sampling (forces LUT). +</p> +</dd> +<dt><span><samp>force_icc_lut</samp></span></dt> +<dd><p>Force the use of a full ICC 3DLUT for gamut mapping. +</p> +</dd> +<dt><span><samp>disable_fbos</samp></span></dt> +<dd><p>Forcibly disable FBOs, resulting in loss of almost all functionality, but +offering the maximum possible speed. +</p></dd> +</dl> + +<a name="Commands-102"></a> +<h4 class="subsection">11.141.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-102" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-102" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports almost all of the above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-89"></a> +<h4 class="subsection">11.141.3 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> Complete example for how to initialize the Vulkan device, upload frames to the +GPU, perform filter conversion to yuv420p, and download frames back to the CPU +for output. Note that in specific cases you can get around the need to perform +format conversion by specifying the correct <code>format</code> filter option +corresponding to the input frames. +<div class="example"> +<pre class="example">ffmpeg -i $INPUT -init_hw_device vulkan -vf hwupload,libplacebo=format=yuv420p,hwdownload,format=yuv420p $OUTPUT +</pre></div> + +</li><li> Tone-map input to standard gamut BT.709 output: +<div class="example"> +<pre class="example">libplacebo=colorspace=bt709:color_primaries=bt709:color_trc=bt709:range=tv +</pre></div> + +</li><li> Rescale input to fit into standard 1080p, with high quality scaling: +<div class="example"> +<pre class="example">libplacebo=w=1920:h=1080:force_original_aspect_ratio=decrease:normalize_sar=true:upscaler=ewa_lanczos:downscaler=ewa_lanczos +</pre></div> + +</li><li> Convert input to standard sRGB JPEG: +<div class="example"> +<pre class="example">libplacebo=format=yuv420p:colorspace=bt470bg:color_primaries=bt709:color_trc=iec61966-2-1:range=pc +</pre></div> + +</li><li> Use higher quality debanding settings: +<div class="example"> +<pre class="example">libplacebo=deband=true:deband_iterations=3:deband_radius=8:deband_threshold=6 +</pre></div> + +</li><li> Run this filter on the CPU, on systems with Mesa installed (and with the most +expensive options disabled): +<div class="example"> +<pre class="example">ffmpeg ... -init_hw_device vulkan:llvmpipe ... -vf libplacebo=upscaler=none:downscaler=none:peak_detect=false +</pre></div> + +</li><li> Suppress CPU-based AV1/H.274 film grain application in the decoder, in favor of +doing it with this filter. Note that this is only a gain if the frames are +either already on the GPU, or if you’re using libplacebo for other purposes, +since otherwise the VRAM roundtrip will more than offset any expected speedup. +<div class="example"> +<pre class="example">ffmpeg -export_side_data +film_grain ... -vf libplacebo=apply_filmgrain=true +</pre></div> +</li></ul> + +<a name="libvmaf"></a> +<h3 class="section">11.142 libvmaf<span class="pull-right"><a class="anchor hidden-xs" href="#libvmaf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libvmaf" aria-hidden="true">TOC</a></span></h3> + +<p>Calulate the VMAF (Video Multi-Method Assessment Fusion) score for a +reference/distorted pair of input videos. +</p> +<p>The first input is the distorted video, and the second input is the reference video. +</p> +<p>The obtained VMAF score is printed through the logging system. +</p> +<p>It requires Netflix’s vmaf library (libvmaf) as a pre-requisite. +After installing the library it can be enabled using: +<code>./configure --enable-libvmaf</code>. +</p> +<p>The filter has following options: +</p> +<dl compact="compact"> +<dt><span><samp>model</samp></span></dt> +<dd><p>A ‘|‘ delimited list of vmaf models. Each model can be configured with a number of parameters. +Default value: <code>"version=vmaf_v0.6.1"</code> +</p> +</dd> +<dt><span><samp>model_path</samp></span></dt> +<dd><p>Deprecated, use model=’path=...’. +</p> +</dd> +<dt><span><samp>enable_transform</samp></span></dt> +<dd><p>Deprecated, use model=’enable_transform=true’. +</p> +</dd> +<dt><span><samp>phone_model</samp></span></dt> +<dd><p>Deprecated, use model=’enable_transform=true’. +</p> +</dd> +<dt><span><samp>enable_conf_interval</samp></span></dt> +<dd><p>Deprecated, use model=’enable_conf_interval=true’. +</p> +</dd> +<dt><span><samp>feature</samp></span></dt> +<dd><p>A ‘|‘ delimited list of features. Each feature can be configured with a number of parameters. +</p> +</dd> +<dt><span><samp>psnr</samp></span></dt> +<dd><p>Deprecated, use feature=’name=psnr’. +</p> +</dd> +<dt><span><samp>ssim</samp></span></dt> +<dd><p>Deprecated, use feature=’name=ssim’. +</p> +</dd> +<dt><span><samp>ms_ssim</samp></span></dt> +<dd><p>Deprecated, use feature=’name=ms_ssim’. +</p> +</dd> +<dt><span><samp>log_path</samp></span></dt> +<dd><p>Set the file path to be used to store log files. +</p> +</dd> +<dt><span><samp>log_fmt</samp></span></dt> +<dd><p>Set the format of the log file (xml, json, csv, or sub). +</p> +</dd> +<dt><span><samp>n_threads</samp></span></dt> +<dd><p>Set number of threads to be used when initializing libvmaf. +Default value: <code>0</code>, no threads. +</p> +</dd> +<dt><span><samp>n_subsample</samp></span></dt> +<dd><p>Set frame subsampling interval to be used. +</p></dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="Examples-90"></a> +<h4 class="subsection">11.142.1 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> In the examples below, a distorted video <samp>distorted.mpg</samp> is +compared with a reference file <samp>reference.mpg</samp>. + +</li><li> Basic usage: +<div class="example"> +<pre class="example">ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf=log_path=output.xml -f null - +</pre></div> + +</li><li> Example with multiple models: +<div class="example"> +<pre class="example">ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf='model=version=vmaf_v0.6.1\\:name=vmaf|version=vmaf_v0.6.1neg\\:name=vmaf_neg' -f null - +</pre></div> + +</li><li> Example with multiple addtional features: +<div class="example"> +<pre class="example">ffmpeg -i distorted.mpg -i reference.mpg -lavfi libvmaf='feature=name=psnr|name=ciede' -f null - +</pre></div> + +</li><li> Example with options and different containers: +<div class="example"> +<pre class="example">ffmpeg -i distorted.mpg -i reference.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]libvmaf=log_fmt=json:log_path=output.json" -f null - +</pre></div> +</li></ul> + +<a name="limitdiff"></a> +<h3 class="section">11.143 limitdiff<span class="pull-right"><a class="anchor hidden-xs" href="#limitdiff" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-limitdiff" aria-hidden="true">TOC</a></span></h3> +<p>Apply limited difference filter using second and optionally third video stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set the threshold to use when allowing certain differences between video streams. +Any absolute difference value lower or exact than this threshold will pick pixel components from +first video stream. +</p> +</dd> +<dt><span><samp>elasticity</samp></span></dt> +<dd><p>Set the elasticity of soft thresholding when processing video streams. +This value multiplied with first one sets second threshold. +Any absolute difference value greater or exact than second threshold will pick pixel components +from second video stream. For values between those two threshold +linear interpolation between first and second video stream will be used. +</p> +</dd> +<dt><span><samp>reference</samp></span></dt> +<dd><p>Enable the reference (third) video stream processing. By default is disabled. +If set, this video stream will be used for calculating absolute difference with first video +stream. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Specify which planes will be processed. Defaults to all available. +</p></dd> +</dl> + +<a name="Commands-103"></a> +<h4 class="subsection">11.143.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-103" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-103" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a> except option ‘<samp>reference</samp>’. +</p> +<a name="limiter"></a> +<h3 class="section">11.144 limiter<span class="pull-right"><a class="anchor hidden-xs" href="#limiter" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-limiter" aria-hidden="true">TOC</a></span></h3> + +<p>Limits the pixel components values to the specified range [min, max]. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>min</samp></span></dt> +<dd><p>Lower bound. Defaults to the lowest allowed value for the input. +</p> +</dd> +<dt><span><samp>max</samp></span></dt> +<dd><p>Upper bound. Defaults to the highest allowed value for the input. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Specify which planes will be processed. Defaults to all available. +</p></dd> +</dl> + +<a name="Commands-104"></a> +<h4 class="subsection">11.144.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-104" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-104" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="loop"></a> +<h3 class="section">11.145 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><span><samp>loop</samp></span></dt> +<dd><p>Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set maximal size in number of frames. Default is 0. +</p> +</dd> +<dt><span><samp>start</samp></span></dt> +<dd><p>Set first frame of loop. Default is 0. +</p></dd> +</dl> + +<a name="Examples-91"></a> +<h4 class="subsection">11.145.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> Loop single first frame infinitely: +<div class="example"> +<pre class="example">loop=loop=-1:size=1:start=0 +</pre></div> + +</li><li> Loop single first frame 10 times: +<div class="example"> +<pre class="example">loop=loop=10:size=1:start=0 +</pre></div> + +</li><li> Loop 10 first frames 5 times: +<div class="example"> +<pre class="example">loop=loop=5:size=10:start=0 +</pre></div> +</li></ul> + +<a name="lut1d"></a> +<h3 class="section">11.146 lut1d<span class="pull-right"><a class="anchor hidden-xs" href="#lut1d" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lut1d" aria-hidden="true">TOC</a></span></h3> + +<p>Apply a 1D LUT to an input video. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>file</samp></span></dt> +<dd><p>Set the 1D LUT file name. +</p> +<p>Currently supported formats: +</p><dl compact="compact"> +<dt><span>‘<samp>cube</samp>’</span></dt> +<dd><p>Iridas +</p></dd> +<dt><span>‘<samp>csp</samp>’</span></dt> +<dd><p>cineSpace +</p></dd> +</dl> + +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Select interpolation mode. +</p> +<p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>nearest</samp>’</span></dt> +<dd><p>Use values from the nearest defined point. +</p></dd> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dd><p>Interpolate values using the linear interpolation. +</p></dd> +<dt><span>‘<samp>cosine</samp>’</span></dt> +<dd><p>Interpolate values using the cosine interpolation. +</p></dd> +<dt><span>‘<samp>cubic</samp>’</span></dt> +<dd><p>Interpolate values using the cubic interpolation. +</p></dd> +<dt><span>‘<samp>spline</samp>’</span></dt> +<dd><p>Interpolate values using the spline interpolation. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-105"></a> +<h4 class="subsection">11.146.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-105" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-105" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<span id="lut3d"></span><a name="lut3d-1"></a> +<h3 class="section">11.147 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><span><samp>file</samp></span></dt> +<dd><p>Set the 3D LUT file name. +</p> +<p>Currently supported formats: +</p><dl compact="compact"> +<dt><span>‘<samp>3dl</samp>’</span></dt> +<dd><p>AfterEffects +</p></dd> +<dt><span>‘<samp>cube</samp>’</span></dt> +<dd><p>Iridas +</p></dd> +<dt><span>‘<samp>dat</samp>’</span></dt> +<dd><p>DaVinci +</p></dd> +<dt><span>‘<samp>m3d</samp>’</span></dt> +<dd><p>Pandora +</p></dd> +<dt><span>‘<samp>csp</samp>’</span></dt> +<dd><p>cineSpace +</p></dd> +</dl> +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Select interpolation mode. +</p> +<p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>nearest</samp>’</span></dt> +<dd><p>Use values from the nearest defined point. +</p></dd> +<dt><span>‘<samp>trilinear</samp>’</span></dt> +<dd><p>Interpolate values using the 8 points defining a cube. +</p></dd> +<dt><span>‘<samp>tetrahedral</samp>’</span></dt> +<dd><p>Interpolate values using a tetrahedron. +</p></dd> +<dt><span>‘<samp>pyramid</samp>’</span></dt> +<dd><p>Interpolate values using a pyramid. +</p></dd> +<dt><span>‘<samp>prism</samp>’</span></dt> +<dd><p>Interpolate values using a prism. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-106"></a> +<h4 class="subsection">11.147.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-106" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-106" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the <code>interp</code> option as <a href="#commands">commands</a>. +</p> +<a name="lumakey"></a> +<h3 class="section">11.148 lumakey<span class="pull-right"><a class="anchor hidden-xs" href="#lumakey" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lumakey" aria-hidden="true">TOC</a></span></h3> + +<p>Turn certain luma values into transparency. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set the luma which will be used as base for transparency. +Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>tolerance</samp></span></dt> +<dd><p>Set the range of luma values to be keyed out. +Default value is <code>0.01</code>. +</p> +</dd> +<dt><span><samp>softness</samp></span></dt> +<dd><p>Set the range of softness. Default value is <code>0</code>. +Use this to control gradual transition from zero to full transparency. +</p></dd> +</dl> + +<a name="Commands-107"></a> +<h4 class="subsection">11.148.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-107" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-107" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="lut_002c-lutrgb_002c-lutyuv"></a> +<h3 class="section">11.149 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><span><samp>c0</samp></span></dt> +<dd><p>set first pixel component expression +</p></dd> +<dt><span><samp>c1</samp></span></dt> +<dd><p>set second pixel component expression +</p></dd> +<dt><span><samp>c2</samp></span></dt> +<dd><p>set third pixel component expression +</p></dd> +<dt><span><samp>c3</samp></span></dt> +<dd><p>set fourth pixel component expression, corresponds to the alpha component +</p> +</dd> +<dt><span><samp>r</samp></span></dt> +<dd><p>set red component expression +</p></dd> +<dt><span><samp>g</samp></span></dt> +<dd><p>set green component expression +</p></dd> +<dt><span><samp>b</samp></span></dt> +<dd><p>set blue component expression +</p></dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>alpha component expression +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>set Y/luminance component expression +</p></dd> +<dt><span><samp>u</samp></span></dt> +<dd><p>set U/Cb component expression +</p></dd> +<dt><span><samp>v</samp></span></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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>val</samp></span></dt> +<dd><p>The input value for the pixel component. +</p> +</dd> +<dt><span><samp>clipval</samp></span></dt> +<dd><p>The input value, clipped to the <var>minval</var>-<var>maxval</var> range. +</p> +</dd> +<dt><span><samp>maxval</samp></span></dt> +<dd><p>The maximum value for the pixel component. +</p> +</dd> +<dt><span><samp>minval</samp></span></dt> +<dd><p>The minimum value for the pixel component. +</p> +</dd> +<dt><span><samp>negval</samp></span></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 +"maxval-clipval+minval". +</p> +</dd> +<dt><span><samp>clip(val)</samp></span></dt> +<dd><p>The computed value in <var>val</var>, clipped to the +<var>minval</var>-<var>maxval</var> range. +</p> +</dd> +<dt><span><samp>gammaval(gamma)</samp></span></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 +"pow((clipval-minval)/(maxval-minval)\,<var>gamma</var>)*(maxval-minval)+minval" +</p> +</dd> +</dl> + +<p>All expressions default to "clipval". +</p> +<a name="Commands-108"></a> +<h4 class="subsection">11.149.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-108" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-108" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="Examples-92"></a> +<h4 class="subsection">11.149.2 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> Negate input video: +<div class="example"> +<pre class="example">lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val" +lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val" +</pre></div> + +<p>The above is the same as: +</p><div class="example"> +<pre class="example">lutrgb="r=negval:g=negval:b=negval" +lutyuv="y=negval:u=negval:v=negval" +</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="u=128:v=128" +</pre></div> + +</li><li> Apply a luma burning effect: +<div class="example"> +<pre class="example">lutyuv="y=2*val" +</pre></div> + +</li><li> Remove green and blue components: +<div class="example"> +<pre class="example">lutrgb="g=0:b=0" +</pre></div> + +</li><li> Set a constant alpha channel value on input: +<div class="example"> +<pre class="example">format=rgba,lutrgb=a="maxval-minval/2" +</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_002c-tlut2"></a> +<h3 class="section">11.150 lut2, tlut2<span class="pull-right"><a class="anchor hidden-xs" href="#lut2_002c-tlut2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-lut2_002c-tlut2" aria-hidden="true">TOC</a></span></h3> + +<p>The <code>lut2</code> filter takes two input streams and outputs one +stream. +</p> +<p>The <code>tlut2</code> (time lut2) filter takes two consecutive frames +from one single stream. +</p> +<p>This filter accepts the following parameters: +</p><dl compact="compact"> +<dt><span><samp>c0</samp></span></dt> +<dd><p>set first pixel component expression +</p></dd> +<dt><span><samp>c1</samp></span></dt> +<dd><p>set second pixel component expression +</p></dd> +<dt><span><samp>c2</samp></span></dt> +<dd><p>set third pixel component expression +</p></dd> +<dt><span><samp>c3</samp></span></dt> +<dd><p>set fourth pixel component expression, corresponds to the alpha component +</p> +</dd> +<dt><span><samp>d</samp></span></dt> +<dd><p>set output bit depth, only available for <code>lut2</code> filter. By default is 0, +which means bit depth is automatically picked from first input format. +</p></dd> +</dl> + +<p>The <code>lut2</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dd><p>The first input value for the pixel component. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>The second input value for the pixel component. +</p> +</dd> +<dt><span><samp>bdx</samp></span></dt> +<dd><p>The first input video bit depth. +</p> +</dd> +<dt><span><samp>bdy</samp></span></dt> +<dd><p>The second input video bit depth. +</p></dd> +</dl> + +<p>All expressions default to "x". +</p> +<a name="Commands-109"></a> +<h4 class="subsection">11.150.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-109" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-109" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a> except option <code>d</code>. +</p> +<a name="Examples-93"></a> +<h4 class="subsection">11.150.2 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> 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><li> Show max difference between two video streams: +<div class="example"> +<pre class="example">lut2='if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1)))' +</pre></div> +</li></ul> + +<a name="maskedclamp"></a> +<h3 class="section">11.151 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><span><samp>undershoot</samp></span></dt> +<dd><p>Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>overshoot</samp></span></dt> +<dd><p>Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></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="Commands-110"></a> +<h4 class="subsection">11.151.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-110" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-110" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="maskedmax"></a> +<h3 class="section">11.152 maskedmax<span class="pull-right"><a class="anchor hidden-xs" href="#maskedmax" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskedmax" aria-hidden="true">TOC</a></span></h3> + +<p>Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is greater than first one or from third input stream +otherwise. +</p> +<p>This filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>planes</samp></span></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="Commands-111"></a> +<h4 class="subsection">11.152.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-111" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-111" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="maskedmerge"></a> +<h3 class="section">11.153 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’s pixel components. +</p> +<p>This filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>planes</samp></span></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="Commands-112"></a> +<h4 class="subsection">11.153.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-112" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-112" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="maskedmin"></a> +<h3 class="section">11.154 maskedmin<span class="pull-right"><a class="anchor hidden-xs" href="#maskedmin" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskedmin" aria-hidden="true">TOC</a></span></h3> + +<p>Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is less than first one or from third input stream +otherwise. +</p> +<p>This filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>planes</samp></span></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="Commands-113"></a> +<h4 class="subsection">11.154.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-113" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-113" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="maskedthreshold"></a> +<h3 class="section">11.155 maskedthreshold<span class="pull-right"><a class="anchor hidden-xs" href="#maskedthreshold" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskedthreshold" aria-hidden="true">TOC</a></span></h3> +<p>Pick pixels comparing absolute difference of two video streams with fixed +threshold. +</p> +<p>If absolute difference between pixel component of first and second video +stream is equal or lower than user supplied threshold than pixel component +from first video stream is picked, otherwise pixel component from second +video stream is picked. +</p> +<p>This filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>Set threshold used when picking pixels from absolute difference from two input +video streams. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be +copied from second stream. +By default value 0xf, all planes will be processed. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set mode of filter operation. Can be <code>abs</code> or <code>diff</code>. +Default is <code>abs</code>. +</p></dd> +</dl> + +<a name="Commands-114"></a> +<h4 class="subsection">11.155.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-114" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-114" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="maskfun"></a> +<h3 class="section">11.156 maskfun<span class="pull-right"><a class="anchor hidden-xs" href="#maskfun" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-maskfun" aria-hidden="true">TOC</a></span></h3> +<p>Create mask from input video. +</p> +<p>For example it is useful to create motion masks after <code>tblend</code> filter. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>low</samp></span></dt> +<dd><p>Set low threshold. Any pixel component lower or exact than this value will be set to 0. +</p> +</dd> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set high threshold. Any pixel component higher than this value will be set to max value +allowed for current pixel format. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter, by default all available planes are filtered. +</p> +</dd> +<dt><span><samp>fill</samp></span></dt> +<dd><p>Fill all frame pixels with this value. +</p> +</dd> +<dt><span><samp>sum</samp></span></dt> +<dd><p>Set max average pixel value for frame. If sum of all pixel components is higher that this +average, output frame will be completely filled with value set by <var>fill</var> option. +Typically useful for scene changes when used in combination with <code>tblend</code> filter. +</p></dd> +</dl> + +<a name="Commands-115"></a> +<h4 class="subsection">11.156.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-115" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-115" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="mcdeint"></a> +<h3 class="section">11.157 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 is only available in ffmpeg version 4.4 or earlier. +</p> +<p>This filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set the deinterlacing mode. +</p> +<p>It accepts one of the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>fast</samp>’</span></dt> +<dt><span>‘<samp>medium</samp>’</span></dt> +<dt><span>‘<samp>slow</samp>’</span></dt> +<dd><p>use iterative motion estimation +</p></dd> +<dt><span>‘<samp>extra_slow</samp>’</span></dt> +<dd><p>like ‘<samp>slow</samp>’, but use multiple reference frames. +</p></dd> +</dl> +<p>Default value is ‘<samp>fast</samp>’. +</p> +</dd> +<dt><span><samp>parity</samp></span></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><span>‘<samp>0, tff</samp>’</span></dt> +<dd><p>assume top field first +</p></dd> +<dt><span>‘<samp>1, bff</samp>’</span></dt> +<dd><p>assume bottom field first +</p></dd> +</dl> + +<p>Default value is ‘<samp>bff</samp>’. +</p> +</dd> +<dt><span><samp>qp</samp></span></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="median"></a> +<h3 class="section">11.158 median<span class="pull-right"><a class="anchor hidden-xs" href="#median" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-median" aria-hidden="true">TOC</a></span></h3> + +<p>Pick median pixel from certain rectangle defined by radius. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set horizontal radius size. Default value is <code>1</code>. +Allowed range is integer from 1 to 127. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. Default is <code>15</code>, which is all available planes. +</p> +</dd> +<dt><span><samp>radiusV</samp></span></dt> +<dd><p>Set vertical radius size. Default value is <code>0</code>. +Allowed range is integer from 0 to 127. +If it is 0, value will be picked from horizontal <code>radius</code> option. +</p> +</dd> +<dt><span><samp>percentile</samp></span></dt> +<dd><p>Set median percentile. Default value is <code>0.5</code>. +Default value of <code>0.5</code> will pick always median values, while <code>0</code> will pick +minimum values, and <code>1</code> maximum values. +</p></dd> +</dl> + +<a name="Commands-116"></a> +<h4 class="subsection">11.158.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-116" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-116" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="mergeplanes"></a> +<h3 class="section">11.159 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><span><samp>mapping</samp></span></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]]]. ’Aa’ describes the +mapping for the first plane of the output stream. ’A’ sets the number of +the input stream to use (from 0 to 3), and ’a’ the plane number of the +corresponding input to use (from 0 to 3). The rest of the mappings is +similar, ’Bb’ describes the mapping for the output stream second +plane, ’Cc’ describes the mapping for the output stream third plane and +’Dd’ describes the mapping for the output stream fourth plane. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Set output pixel format. Default is <code>yuva444p</code>. +</p> +</dd> +<dt><span><samp>map0s</samp></span></dt> +<dt><span><samp>map1s</samp></span></dt> +<dt><span><samp>map2s</samp></span></dt> +<dt><span><samp>map3s</samp></span></dt> +<dd><p>Set input to output stream mapping for output Nth plane. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>map0p</samp></span></dt> +<dt><span><samp>map1p</samp></span></dt> +<dt><span><samp>map2p</samp></span></dt> +<dt><span><samp>map3p</samp></span></dt> +<dd><p>Set input to output plane mapping for output Nth plane. Default is <code>0</code>. +</p></dd> +</dl> + +<a name="Examples-94"></a> +<h4 class="subsection">11.159.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> 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">11.160 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><span><samp>method</samp></span></dt> +<dd><p>Specify the motion estimation method. Accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>esa</samp>’</span></dt> +<dd><p>Exhaustive search algorithm. +</p></dd> +<dt><span>‘<samp>tss</samp>’</span></dt> +<dd><p>Three step search algorithm. +</p></dd> +<dt><span>‘<samp>tdls</samp>’</span></dt> +<dd><p>Two dimensional logarithmic search algorithm. +</p></dd> +<dt><span>‘<samp>ntss</samp>’</span></dt> +<dd><p>New three step search algorithm. +</p></dd> +<dt><span>‘<samp>fss</samp>’</span></dt> +<dd><p>Four step search algorithm. +</p></dd> +<dt><span>‘<samp>ds</samp>’</span></dt> +<dd><p>Diamond search algorithm. +</p></dd> +<dt><span>‘<samp>hexbs</samp>’</span></dt> +<dd><p>Hexagon-based search algorithm. +</p></dd> +<dt><span>‘<samp>epzs</samp>’</span></dt> +<dd><p>Enhanced predictive zonal search algorithm. +</p></dd> +<dt><span>‘<samp>umh</samp>’</span></dt> +<dd><p>Uneven multi-hexagon search algorithm. +</p></dd> +</dl> +<p>Default value is ‘<samp>esa</samp>’. +</p> +</dd> +<dt><span><samp>mb_size</samp></span></dt> +<dd><p>Macroblock size. Default <code>16</code>. +</p> +</dd> +<dt><span><samp>search_param</samp></span></dt> +<dd><p>Search parameter. Default <code>7</code>. +</p></dd> +</dl> + +<a name="midequalizer"></a> +<h3 class="section">11.161 midequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#midequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-midequalizer" aria-hidden="true">TOC</a></span></h3> + +<p>Apply Midway Image Equalization effect using two video streams. +</p> +<p>Midway Image Equalization adjusts a pair of images to have the same +histogram, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a pair of stereo cameras. +</p> +<p>This filter has two inputs and one output, which must be of same pixel format, but +may be of different sizes. The output of filter is first input adjusted with +midway histogram of both inputs. +</p> +<p>This filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. Default is <code>15</code>, which is all available planes. +</p></dd> +</dl> + +<a name="minterpolate"></a> +<h3 class="section">11.162 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><span><samp>fps</samp></span></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><span><samp>mi_mode</samp></span></dt> +<dd><p>Motion interpolation mode. Following values are accepted: +</p><dl compact="compact"> +<dt><span>‘<samp>dup</samp>’</span></dt> +<dd><p>Duplicate previous or next frame for interpolating new ones. +</p></dd> +<dt><span>‘<samp>blend</samp>’</span></dt> +<dd><p>Blend source frames. Interpolated frame is mean of previous and next frames. +</p></dd> +<dt><span>‘<samp>mci</samp>’</span></dt> +<dd><p>Motion compensated interpolation. Following options are effective when this mode is selected: +</p> +<dl compact="compact"> +<dt><span>‘<samp>mc_mode</samp>’</span></dt> +<dd><p>Motion compensation mode. Following values are accepted: +</p><dl compact="compact"> +<dt><span>‘<samp>obmc</samp>’</span></dt> +<dd><p>Overlapped block motion compensation. +</p></dd> +<dt><span>‘<samp>aobmc</samp>’</span></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 ‘<samp>obmc</samp>’. +</p> +</dd> +<dt><span>‘<samp>me_mode</samp>’</span></dt> +<dd><p>Motion estimation mode. Following values are accepted: +</p><dl compact="compact"> +<dt><span>‘<samp>bidir</samp>’</span></dt> +<dd><p>Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions. +</p></dd> +<dt><span>‘<samp>bilat</samp>’</span></dt> +<dd><p>Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame. +</p></dd> +</dl> +<p>Default mode is ‘<samp>bilat</samp>’. +</p> +</dd> +<dt><span>‘<samp>me</samp>’</span></dt> +<dd><p>The algorithm to be used for motion estimation. Following values are accepted: +</p><dl compact="compact"> +<dt><span>‘<samp>esa</samp>’</span></dt> +<dd><p>Exhaustive search algorithm. +</p></dd> +<dt><span>‘<samp>tss</samp>’</span></dt> +<dd><p>Three step search algorithm. +</p></dd> +<dt><span>‘<samp>tdls</samp>’</span></dt> +<dd><p>Two dimensional logarithmic search algorithm. +</p></dd> +<dt><span>‘<samp>ntss</samp>’</span></dt> +<dd><p>New three step search algorithm. +</p></dd> +<dt><span>‘<samp>fss</samp>’</span></dt> +<dd><p>Four step search algorithm. +</p></dd> +<dt><span>‘<samp>ds</samp>’</span></dt> +<dd><p>Diamond search algorithm. +</p></dd> +<dt><span>‘<samp>hexbs</samp>’</span></dt> +<dd><p>Hexagon-based search algorithm. +</p></dd> +<dt><span>‘<samp>epzs</samp>’</span></dt> +<dd><p>Enhanced predictive zonal search algorithm. +</p></dd> +<dt><span>‘<samp>umh</samp>’</span></dt> +<dd><p>Uneven multi-hexagon search algorithm. +</p></dd> +</dl> +<p>Default algorithm is ‘<samp>epzs</samp>’. +</p> +</dd> +<dt><span>‘<samp>mb_size</samp>’</span></dt> +<dd><p>Macroblock size. Default <code>16</code>. +</p> +</dd> +<dt><span>‘<samp>search_param</samp>’</span></dt> +<dd><p>Motion estimation search parameter. Default <code>32</code>. +</p> +</dd> +<dt><span>‘<samp>vsbmc</samp>’</span></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><span><samp>scd</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>Disable scene change detection. +</p></dd> +<dt><span>‘<samp>fdiff</samp>’</span></dt> +<dd><p>Frame difference. Corresponding pixel values are compared and if it satisfies <var>scd_threshold</var> scene change is detected. +</p></dd> +</dl> +<p>Default method is ‘<samp>fdiff</samp>’. +</p> +</dd> +<dt><span><samp>scd_threshold</samp></span></dt> +<dd><p>Scene change detection threshold. Default is <code>10.</code>. +</p></dd> +</dl> + +<a name="mix"></a> +<h3 class="section">11.163 mix<span class="pull-right"><a class="anchor hidden-xs" href="#mix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mix" aria-hidden="true">TOC</a></span></h3> + +<p>Mix several video input streams into one video stream. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>The number of inputs. If unspecified, it defaults to 2. +</p> +</dd> +<dt><span><samp>weights</samp></span></dt> +<dd><p>Specify weight of each input video stream as sequence. +Each weight is separated by space. If number of weights +is smaller than number of <var>frames</var> last specified +weight will be used for all remaining unset weights. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default <var>scale</var> is auto scaled to sum of weights. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>Specify how end of stream is determined. +</p><dl compact="compact"> +<dt><span>‘<samp>longest</samp>’</span></dt> +<dd><p>The duration of the longest input. (default) +</p> +</dd> +<dt><span>‘<samp>shortest</samp>’</span></dt> +<dd><p>The duration of the shortest input. +</p> +</dd> +<dt><span>‘<samp>first</samp>’</span></dt> +<dd><p>The duration of the first input. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-117"></a> +<h4 class="subsection">11.163.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-117" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-117" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>weights</samp></span></dt> +<dt><span><samp>scale</samp></span></dt> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Syntax is same as option with same name. +</p></dd> +</dl> + +<a name="monochrome"></a> +<h3 class="section">11.164 monochrome<span class="pull-right"><a class="anchor hidden-xs" href="#monochrome" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-monochrome" aria-hidden="true">TOC</a></span></h3> +<p>Convert video to gray using custom color filter. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>cb</samp></span></dt> +<dd><p>Set the chroma blue spot. Allowed range is from -1 to 1. +Default value is 0. +</p> +</dd> +<dt><span><samp>cr</samp></span></dt> +<dd><p>Set the chroma red spot. Allowed range is from -1 to 1. +Default value is 0. +</p> +</dd> +<dt><span><samp>size</samp></span></dt> +<dd><p>Set the color filter size. Allowed range is from .1 to 10. +Default value is 1. +</p> +</dd> +<dt><span><samp>high</samp></span></dt> +<dd><p>Set the highlights strength. Allowed range is from 0 to 1. +Default value is 0. +</p></dd> +</dl> + +<a name="Commands-118"></a> +<h4 class="subsection">11.164.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-118" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-118" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="morpho"></a> +<h3 class="section">11.165 morpho<span class="pull-right"><a class="anchor hidden-xs" href="#morpho" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-morpho" aria-hidden="true">TOC</a></span></h3> + +<p>This filter allows to apply main morphological grayscale transforms, +erode and dilate with arbitrary structures set in second input stream. +</p> +<p>Unlike naive implementation and much slower performance in <a href="#erosion">erosion</a> +and <a href="#dilation">dilation</a> filters, when speed is critical <code>morpho</code> filter +should be used instead. +</p> +<p>A description of accepted options follows, +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set morphological transform to apply, can be: +</p> +<dl compact="compact"> +<dt><span>‘<samp>erode</samp>’</span></dt> +<dt><span>‘<samp>dilate</samp>’</span></dt> +<dt><span>‘<samp>open</samp>’</span></dt> +<dt><span>‘<samp>close</samp>’</span></dt> +<dt><span>‘<samp>gradient</samp>’</span></dt> +<dt><span>‘<samp>tophat</samp>’</span></dt> +<dt><span>‘<samp>blackhat</samp>’</span></dt> +</dl> +<p>Default is <code>erode</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set planes to filter, by default all planes except alpha are filtered. +</p> +</dd> +<dt><span><samp>structure</samp></span></dt> +<dd><p>Set which structure video frames will be processed from second input stream, +can be <var>first</var> or <var>all</var>. Default is <var>all</var>. +</p></dd> +</dl> + +<p>The <code>morpho</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="Commands-119"></a> +<h4 class="subsection">11.165.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-119" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-119" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="mpdecimate"></a> +<h3 class="section">11.166 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><span><samp>max</samp></span></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 disregarding the +number of previous sequentially dropped frames. +</p> +<p>Default value is 0. +</p> +</dd> +<dt><span><samp>hi</samp></span></dt> +<dt><span><samp>lo</samp></span></dt> +<dt><span><samp>frac</samp></span></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="msad"></a> +<h3 class="section">11.167 msad<span class="pull-right"><a class="anchor hidden-xs" href="#msad" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-msad" aria-hidden="true">TOC</a></span></h3> + +<p>Obtain the MSAD (Mean Sum of Absolute Differences) between two input videos. +</p> +<p>This filter takes two input videos. +</p> +<p>Both input videos 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 per component, average, min and max MSAD is printed through +the logging system. +</p> +<p>The filter stores the calculated MSAD of each frame in frame metadata. +</p> +<p>In the below example the input file <samp>main.mpg</samp> being processed is compared +with the reference file <samp>ref.mpg</samp>. +</p> +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mpg -lavfi msad -f null - +</pre></div> + +<a name="multiply"></a> +<h3 class="section">11.168 multiply<span class="pull-right"><a class="anchor hidden-xs" href="#multiply" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-multiply" aria-hidden="true">TOC</a></span></h3> +<p>Multiply first video stream pixels values with second video stream pixels values. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set the scale applied to second video stream. By default is <code>1</code>. +Allowed range is from <code>0</code> to <code>9</code>. +</p> +</dd> +<dt><span><samp>offset</samp></span></dt> +<dd><p>Set the offset applied to second video stream. By default is <code>0.5</code>. +Allowed range is from <code>-1</code> to <code>1</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Specify planes from input video stream that will be processed. +By default all planes are processed. +</p></dd> +</dl> + +<a name="Commands-120"></a> +<h4 class="subsection">11.168.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-120" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-120" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="negate"></a> +<h3 class="section">11.169 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 (invert) the input video. +</p> +<p>It accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>components</samp></span></dt> +<dd><p>Set components to negate. +</p> +<p>Available values for components are: +</p><dl compact="compact"> +<dt><span>‘<samp>y</samp>’</span></dt> +<dt><span>‘<samp>u</samp>’</span></dt> +<dt><span>‘<samp>v</samp>’</span></dt> +<dt><span>‘<samp>a</samp>’</span></dt> +<dt><span>‘<samp>r</samp>’</span></dt> +<dt><span>‘<samp>g</samp>’</span></dt> +<dt><span>‘<samp>b</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>negate_alpha</samp></span></dt> +<dd><p>With value 1, it negates the alpha component, if present. Default value is 0. +</p></dd> +</dl> + +<a name="Commands-121"></a> +<h4 class="subsection">11.169.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-121" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-121" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<span id="nlmeans"></span><a name="nlmeans-1"></a> +<h3 class="section">11.170 nlmeans<span class="pull-right"><a class="anchor hidden-xs" href="#nlmeans-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-nlmeans-1" 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><span><samp>s</samp></span></dt> +<dd><p>Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0]. +</p> +</dd> +<dt><span><samp>p</samp></span></dt> +<dd><p>Set patch size. Default is 7. Must be odd number in range [0, 99]. +</p> +</dd> +<dt><span><samp>pc</samp></span></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><span><samp>r</samp></span></dt> +<dd><p>Set research size. Default is 15. Must be odd number in range [0, 99]. +</p> +</dd> +<dt><span><samp>rc</samp></span></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">11.171 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><span><samp>weights</samp></span></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><span><samp>deint</samp></span></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><span><samp>field</samp></span></dt> +<dd><p>Set mode of operation. +</p> +<p>Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>af</samp>’</span></dt> +<dd><p>Use frame flags, both fields. +</p></dd> +<dt><span>‘<samp>a</samp>’</span></dt> +<dd><p>Use frame flags, single field. +</p></dd> +<dt><span>‘<samp>t</samp>’</span></dt> +<dd><p>Use top field only. +</p></dd> +<dt><span>‘<samp>b</samp>’</span></dt> +<dd><p>Use bottom field only. +</p></dd> +<dt><span>‘<samp>tf</samp>’</span></dt> +<dd><p>Use both fields, top first. +</p></dd> +<dt><span>‘<samp>bf</samp>’</span></dt> +<dd><p>Use both fields, bottom first. +</p></dd> +</dl> + +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process, by default filter process all frames. +</p> +</dd> +<dt><span><samp>nsize</samp></span></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><span>‘<samp>s8x6</samp>’</span></dt> +<dt><span>‘<samp>s16x6</samp>’</span></dt> +<dt><span>‘<samp>s32x6</samp>’</span></dt> +<dt><span>‘<samp>s48x6</samp>’</span></dt> +<dt><span>‘<samp>s8x4</samp>’</span></dt> +<dt><span>‘<samp>s16x4</samp>’</span></dt> +<dt><span>‘<samp>s32x4</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>nns</samp></span></dt> +<dd><p>Set the number of neurons in predictor neural network. +Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>n16</samp>’</span></dt> +<dt><span>‘<samp>n32</samp>’</span></dt> +<dt><span>‘<samp>n64</samp>’</span></dt> +<dt><span>‘<samp>n128</samp>’</span></dt> +<dt><span>‘<samp>n256</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>qual</samp></span></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><span><samp>etype</samp></span></dt> +<dd><p>Set which set of weights to use in the predictor. +Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>a, abs</samp>’</span></dt> +<dd><p>weights trained to minimize absolute error +</p></dd> +<dt><span>‘<samp>s, mse</samp>’</span></dt> +<dd><p>weights trained to minimize squared error +</p></dd> +</dl> + +</dd> +<dt><span><samp>pscrn</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dt><span>‘<samp>original</samp>’</span></dt> +<dt><span>‘<samp>new</samp>’</span></dt> +<dt><span>‘<samp>new2</samp>’</span></dt> +<dt><span>‘<samp>new3</samp>’</span></dt> +</dl> + +<p>Default is <code>new</code>. +</p></dd> +</dl> + +<a name="Commands-122"></a> +<h4 class="subsection">11.171.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-122" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-122" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options, excluding <var>weights</var> option. +</p> +<a name="noformat"></a> +<h3 class="section">11.172 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><span><samp>pix_fmts</samp></span></dt> +<dd><p>A ’|’-separated list of pixel format names, such as +pix_fmts=yuv420p|monow|rgb24". +</p> +</dd> +</dl> + +<a name="Examples-95"></a> +<h4 class="subsection">11.172.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> 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"></a> +<h3 class="section">11.173 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>Add noise on video input frame. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>all_seed</samp></span></dt> +<dt><span><samp>c0_seed</samp></span></dt> +<dt><span><samp>c1_seed</samp></span></dt> +<dt><span><samp>c2_seed</samp></span></dt> +<dt><span><samp>c3_seed</samp></span></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><span><samp>all_strength, alls</samp></span></dt> +<dt><span><samp>c0_strength, c0s</samp></span></dt> +<dt><span><samp>c1_strength, c1s</samp></span></dt> +<dt><span><samp>c2_strength, c2s</samp></span></dt> +<dt><span><samp>c3_strength, c3s</samp></span></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><span><samp>all_flags, allf</samp></span></dt> +<dt><span><samp>c0_flags, c0f</samp></span></dt> +<dt><span><samp>c1_flags, c1f</samp></span></dt> +<dt><span><samp>c2_flags, c2f</samp></span></dt> +<dt><span><samp>c3_flags, c3f</samp></span></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><span>‘<samp>a</samp>’</span></dt> +<dd><p>averaged temporal noise (smoother) +</p></dd> +<dt><span>‘<samp>p</samp>’</span></dt> +<dd><p>mix random noise with a (semi)regular pattern +</p></dd> +<dt><span>‘<samp>t</samp>’</span></dt> +<dd><p>temporal noise (noise pattern changes between frames) +</p></dd> +<dt><span>‘<samp>u</samp>’</span></dt> +<dd><p>uniform noise (gaussian otherwise) +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-96"></a> +<h4 class="subsection">11.173.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> + +<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="normalize"></a> +<h3 class="section">11.174 normalize<span class="pull-right"><a class="anchor hidden-xs" href="#normalize" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-normalize" aria-hidden="true">TOC</a></span></h3> + +<p>Normalize RGB video (aka histogram stretching, contrast stretching). +See: https://en.wikipedia.org/wiki/Normalization_(image_processing) +</p> +<p>For each channel of each frame, the filter computes the input range and maps +it linearly to the user-specified output range. The output range defaults +to the full dynamic range from pure black to pure white. +</p> +<p>Temporal smoothing can be used on the input range to reduce flickering (rapid +changes in brightness) caused when small dark or bright objects enter or leave +the scene. This is similar to the auto-exposure (automatic gain control) on a +video camera, and, like a video camera, it may cause a period of over- or +under-exposure of the video. +</p> +<p>The R,G,B channels can be normalized independently, which may cause some +color shifting, or linked together as a single channel, which prevents +color shifting. Linked normalization preserves hue. Independent normalization +does not, so it can be used to remove some color casts. Independent and linked +normalization can be combined in any ratio. +</p> +<p>The normalize filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>blackpt</samp></span></dt> +<dt><span><samp>whitept</samp></span></dt> +<dd><p>Colors which define the output range. The minimum input value is mapped to +the <var>blackpt</var>. The maximum input value is mapped to the <var>whitept</var>. +The defaults are black and white respectively. Specifying white for +<var>blackpt</var> and black for <var>whitept</var> will give color-inverted, +normalized video. Shades of grey can be used to reduce the dynamic range +(contrast). Specifying saturated colors here can create some interesting +effects. +</p> +</dd> +<dt><span><samp>smoothing</samp></span></dt> +<dd><p>The number of previous frames to use for temporal smoothing. The input range +of each channel is smoothed using a rolling average over the current frame +and the <var>smoothing</var> previous frames. The default is 0 (no temporal +smoothing). +</p> +</dd> +<dt><span><samp>independence</samp></span></dt> +<dd><p>Controls the ratio of independent (color shifting) channel normalization to +linked (color preserving) normalization. 0.0 is fully linked, 1.0 is fully +independent. Defaults to 1.0 (fully independent). +</p> +</dd> +<dt><span><samp>strength</samp></span></dt> +<dd><p>Overall strength of the filter. 1.0 is full strength. 0.0 is a rather +expensive no-op. Defaults to 1.0 (full strength). +</p> +</dd> +</dl> + +<a name="Commands-123"></a> +<h4 class="subsection">11.174.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-123" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-123" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options, excluding <var>smoothing</var> option. +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> +<a name="Examples-97"></a> +<h4 class="subsection">11.174.2 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> + +<p>Stretch video contrast to use the full dynamic range, with no temporal +smoothing; may flicker depending on the source content: +</p><div class="example"> +<pre class="example">normalize=blackpt=black:whitept=white:smoothing=0 +</pre></div> + +<p>As above, but with 50 frames of temporal smoothing; flicker should be +reduced, depending on the source content: +</p><div class="example"> +<pre class="example">normalize=blackpt=black:whitept=white:smoothing=50 +</pre></div> + +<p>As above, but with hue-preserving linked channel normalization: +</p><div class="example"> +<pre class="example">normalize=blackpt=black:whitept=white:smoothing=50:independence=0 +</pre></div> + +<p>As above, but with half strength: +</p><div class="example"> +<pre class="example">normalize=blackpt=black:whitept=white:smoothing=50:independence=0:strength=0.5 +</pre></div> + +<p>Map the darkest input color to red, the brightest input color to cyan: +</p><div class="example"> +<pre class="example">normalize=blackpt=red:whitept=cyan +</pre></div> + +<a name="null"></a> +<h3 class="section">11.175 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">11.176 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. To enable +compilation of this filter, you need to configure FFmpeg with +<code>--enable-libtesseract</code>. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>datapath</samp></span></dt> +<dd><p>Set datapath to tesseract data. Default is to use whatever was +set at installation. +</p> +</dd> +<dt><span><samp>language</samp></span></dt> +<dd><p>Set language, default is "eng". +</p> +</dd> +<dt><span><samp>whitelist</samp></span></dt> +<dd><p>Set character whitelist. +</p> +</dd> +<dt><span><samp>blacklist</samp></span></dt> +<dd><p>Set character blacklist. +</p></dd> +</dl> + +<p>The filter exports recognized text as the frame metadata <code>lavfi.ocr.text</code>. +The filter exports confidence of recognized words as the frame metadata <code>lavfi.ocr.confidence</code>. +</p> +<a name="ocv"></a> +<h3 class="section">11.177 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><span><samp>filter_name</samp></span></dt> +<dd><p>The name of the libopencv filter to apply. +</p> +</dd> +<dt><span><samp>filter_params</samp></span></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> +<span id="dilate"></span><a name="dilate-1"></a> +<h4 class="subsection">11.177.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 "rect", "cross", "ellipse", or "custom". +</p> +<p>If the value for <var>shape</var> is "custom", it must be followed by a +string of the form "=<var>filename</var>". 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 "3x3+0x0/rect". +</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">11.177.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">11.177.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: "blur", "blur_no_scale", "median", "gaussian", +or "bilateral". The default value is "gaussian". +</p> +<p>The meaning of <var>param1</var>, <var>param2</var>, <var>param3</var>, and <var>param4</var> +depends 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="oscilloscope"></a> +<h3 class="section">11.178 oscilloscope<span class="pull-right"><a class="anchor hidden-xs" href="#oscilloscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-oscilloscope" aria-hidden="true">TOC</a></span></h3> + +<p>2D Video Oscilloscope. +</p> +<p>Useful to measure spatial impulse, step responses, chroma delays, etc. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dd><p>Set scope center x position. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set scope center y position. +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>Set scope size, relative to frame diagonal. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>Set scope tilt/rotation. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Set trace opacity. +</p> +</dd> +<dt><span><samp>tx</samp></span></dt> +<dd><p>Set trace center x position. +</p> +</dd> +<dt><span><samp>ty</samp></span></dt> +<dd><p>Set trace center y position. +</p> +</dd> +<dt><span><samp>tw</samp></span></dt> +<dd><p>Set trace width, relative to width of frame. +</p> +</dd> +<dt><span><samp>th</samp></span></dt> +<dd><p>Set trace height, relative to height of frame. +</p> +</dd> +<dt><span><samp>c</samp></span></dt> +<dd><p>Set which components to trace. By default it traces first three components. +</p> +</dd> +<dt><span><samp>g</samp></span></dt> +<dd><p>Draw trace grid. By default is enabled. +</p> +</dd> +<dt><span><samp>st</samp></span></dt> +<dd><p>Draw some statistics. By default is enabled. +</p> +</dd> +<dt><span><samp>sc</samp></span></dt> +<dd><p>Draw scope. By default is enabled. +</p></dd> +</dl> + +<a name="Commands-124"></a> +<h4 class="subsection">11.178.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-124" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-124" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +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> +<a name="Examples-98"></a> +<h4 class="subsection">11.178.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> Inspect full first row of video frame. +<div class="example"> +<pre class="example">oscilloscope=x=0.5:y=0:s=1 +</pre></div> + +</li><li> Inspect full last row of video frame. +<div class="example"> +<pre class="example">oscilloscope=x=0.5:y=1:s=1 +</pre></div> + +</li><li> Inspect full 5th line of video frame of height 1080. +<div class="example"> +<pre class="example">oscilloscope=x=0.5:y=5/1080:s=1 +</pre></div> + +</li><li> Inspect full last column of video frame. +<div class="example"> +<pre class="example">oscilloscope=x=1:y=0.5:s=1:t=1 +</pre></div> + +</li></ul> + +<span id="overlay"></span><a name="overlay-1"></a> +<h3 class="section">11.179 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 "main" +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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set the expression for the x and y coordinates of the overlaid video +on the main video. Default value is "0" 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><span><samp>eof_action</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>only evaluate expressions once during the filter initialization or +when a command is processed +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>evaluate expressions for each incoming frame +</p></dd> +</dl> + +<p>Default value is ‘<samp>frame</samp>’. +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Set the format for the output video. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>yuv420</samp>’</span></dt> +<dd><p>force YUV420 output +</p> +</dd> +<dt><span>‘<samp>yuv420p10</samp>’</span></dt> +<dd><p>force YUV420p10 output +</p> +</dd> +<dt><span>‘<samp>yuv422</samp>’</span></dt> +<dd><p>force YUV422 output +</p> +</dd> +<dt><span>‘<samp>yuv422p10</samp>’</span></dt> +<dd><p>force YUV422p10 output +</p> +</dd> +<dt><span>‘<samp>yuv444</samp>’</span></dt> +<dd><p>force YUV444 output +</p> +</dd> +<dt><span>‘<samp>rgb</samp>’</span></dt> +<dd><p>force packed RGB output +</p> +</dd> +<dt><span>‘<samp>gbrp</samp>’</span></dt> +<dd><p>force planar RGB output +</p> +</dd> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>automatically pick format +</p></dd> +</dl> + +<p>Default value is ‘<samp>yuv420</samp>’. +</p> +</dd> +<dt><span><samp>repeatlast</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>alpha</samp></span></dt> +<dd><p>Set format of alpha of the overlaid video, it can be <var>straight</var> or +<var>premultiplied</var>. Default is <var>straight</var>. +</p></dd> +</dl> + +<p>The <samp>x</samp>, and <samp>y</samp> expressions can contain the following +parameters. +</p> +<dl compact="compact"> +<dt><span><samp>main_w, W</samp></span></dt> +<dt><span><samp>main_h, H</samp></span></dt> +<dd><p>The main input width and height. +</p> +</dd> +<dt><span><samp>overlay_w, w</samp></span></dt> +<dt><span><samp>overlay_h, h</samp></span></dt> +<dd><p>The overlay input width and height. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The computed values for <var>x</var> and <var>y</var>. They are evaluated for +each new frame. +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values of the output +format. For example for the pixel format "yuv422p" <var>hsub</var> is 2 and +<var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>the number of input frame, starting from 0 +</p> +</dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>the position in the file of the input frame, NAN if unknown +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The timestamp, expressed in seconds. It’s NAN if the input timestamp is unknown. +</p> +</dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<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 ‘<samp>init</samp>’. +</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-125"></a> +<h4 class="subsection">11.179.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-125" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-125" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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-99"></a> +<h4 class="subsection">11.179.2 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> 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 " +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] +" +</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> + +<span id="overlay_005fcuda"></span><a name="overlay_005fcuda-1"></a> +<h3 class="section">11.180 overlay_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#overlay_005fcuda-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-overlay_005fcuda-1" aria-hidden="true">TOC</a></span></h3> + +<p>Overlay one video on top of another. +</p> +<p>This is the CUDA variant of the <a href="#overlay">overlay</a> filter. +It only accepts CUDA frames. The underlying input pixel formats have to match. +</p> +<p>It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set expressions for the x and y coordinates of the overlaid video +on the main video. +</p> +<p>They can contain the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>main_w, W</samp></span></dt> +<dt><span><samp>main_h, H</samp></span></dt> +<dd><p>The main input width and height. +</p> +</dd> +<dt><span><samp>overlay_w, w</samp></span></dt> +<dt><span><samp>overlay_h, h</samp></span></dt> +<dd><p>The overlay input width and height. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>The computed values for <var>x</var> and <var>y</var>. They are evaluated for +each new frame. +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>The ordinal index of the main input frame, starting from 0. +</p> +</dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>The byte offset position in the file of the main input frame, NAN if unknown. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The timestamp of the main input frame, expressed in seconds, NAN if unknown. +</p> +</dd> +</dl> + +<p>Default value is "0" for both expressions. +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span><samp>init</samp></span></dt> +<dd><p>Evaluate expressions once during filter initialization or +when a command is processed. +</p> +</dd> +<dt><span><samp>frame</samp></span></dt> +<dd><p>Evaluate expressions for each incoming frame +</p></dd> +</dl> + +<p>Default value is <samp>frame</samp>. +</p> +</dd> +<dt><span><samp>eof_action</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>repeatlast</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="owdenoise"></a> +<h3 class="section">11.181 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><span><samp>depth</samp></span></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><span><samp>luma_strength, ls</samp></span></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><span><samp>chroma_strength, cs</samp></span></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> + +<span id="pad"></span><a name="pad-1"></a> +<h3 class="section">11.182 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><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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> +<p>If <var>x</var> or <var>y</var> evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify the color of the padded area. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. +</p> +<p>The default value of <var>color</var> is "black". +</p> +</dd> +<dt><span><samp>eval</samp></span></dt> +<dd><p>Specify when to evaluate <var>width</var>, <var>height</var>, <var>x</var> and <var>y</var> expression. +</p> +<p>It accepts the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>init</samp>’</span></dt> +<dd><p>Only evaluate expressions once during the filter initialization or when +a command is processed. +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Evaluate expressions for each incoming frame. +</p> +</dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p> +</dd> +<dt><span><samp>aspect</samp></span></dt> +<dd><p>Pad to aspect instead to a resolution. +</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><span><samp>in_w</samp></span></dt> +<dt><span><samp>in_h</samp></span></dt> +<dd><p>The input video width and height. +</p> +</dd> +<dt><span><samp>iw</samp></span></dt> +<dt><span><samp>ih</samp></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><samp>out_w</samp></span></dt> +<dt><span><samp>out_h</samp></span></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><span><samp>ow</samp></span></dt> +<dt><span><samp>oh</samp></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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><span><samp>a</samp></span></dt> +<dd><p>same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><samp>dar</samp></span></dt> +<dd><p>input display aspect ratio, it is the same as (<var>iw</var> / <var>ih</var>) * <var>sar</var> +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>The horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p></dd> +</dl> + +<a name="Examples-100"></a> +<h4 class="subsection">11.182.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> Add paddings with the color "violet" 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="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2" +</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="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2" +</pre></div> + +</li><li> Pad the input to get a final w/h ratio of 16:9: +<div class="example"> +<pre class="example">pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2" +</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="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2" +</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="2*iw:2*ih:ow-iw:oh-ih" +</pre></div> +</li></ul> + +<span id="palettegen"></span><a name="palettegen-1"></a> +<h3 class="section">11.183 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><span><samp>max_colors</samp></span></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><span><samp>reserve_transparent</samp></span></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><span><samp>transparency_color</samp></span></dt> +<dd><p>Set the color that will be used as background for transparency. +</p> +</dd> +<dt><span><samp>stats_mode</samp></span></dt> +<dd><p>Set statistics mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>full</samp>’</span></dt> +<dd><p>Compute full frame histograms. +</p></dd> +<dt><span>‘<samp>diff</samp>’</span></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><span>‘<samp>single</samp>’</span></dt> +<dd><p>Compute new histogram for each frame. +</p></dd> +</dl> + +<p>Default value is <var>full</var>. +</p></dd> +<dt><span><samp>use_alpha</samp></span></dt> +<dd><p>Create a palette of colors with alpha components. +Setting this, will automatically disable ’reserve_transparent’. +</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-101"></a> +<h4 class="subsection">11.183.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> 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">11.184 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><span><samp>dither</samp></span></dt> +<dd><p>Select dithering mode. Available algorithms are: +</p><dl compact="compact"> +<dt><span>‘<samp>bayer</samp>’</span></dt> +<dd><p>Ordered 8x8 bayer dithering (deterministic) +</p></dd> +<dt><span>‘<samp>heckbert</samp>’</span></dt> +<dd><p>Dithering as defined by Paul Heckbert in 1982 (simple error diffusion). +Note: this dithering is sometimes considered "wrong" and is included as a +reference. +</p></dd> +<dt><span>‘<samp>floyd_steinberg</samp>’</span></dt> +<dd><p>Floyd and Steingberg dithering (error diffusion) +</p></dd> +<dt><span>‘<samp>sierra2</samp>’</span></dt> +<dd><p>Frankie Sierra dithering v2 (error diffusion) +</p></dd> +<dt><span>‘<samp>sierra2_4a</samp>’</span></dt> +<dd><p>Frankie Sierra dithering v2 "Lite" (error diffusion) +</p></dd> +</dl> + +<p>Default is <var>sierra2_4a</var>. +</p> +</dd> +<dt><span><samp>bayer_scale</samp></span></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><span><samp>diff_mode</samp></span></dt> +<dd><p>If set, define the zone to process +</p> +<dl compact="compact"> +<dt><span>‘<samp>rectangle</samp>’</span></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’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><span><samp>new</samp></span></dt> +<dd><p>Take new palette for each output frame. +</p> +</dd> +<dt><span><samp>alpha_threshold</samp></span></dt> +<dd><p>Sets the alpha threshold for transparency. Alpha values above this threshold +will be treated as completely opaque, and values below this threshold will be +treated as completely transparent. +</p> +<p>The option must be an integer value in the range [0,255]. Default is <var>128</var>. +</p> +</dd> +<dt><span><samp>use_alpha</samp></span></dt> +<dd><p>Apply the palette by taking alpha values into account. Only useful with +palettes that are containing multiple colors with alpha components. +Setting this will automatically disable ’alpha_treshold’. +</p></dd> +</dl> + +<a name="Examples-102"></a> +<h4 class="subsection">11.184.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 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">11.185 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><span><samp>x0</samp></span></dt> +<dt><span><samp>y0</samp></span></dt> +<dt><span><samp>x1</samp></span></dt> +<dt><span><samp>y1</samp></span></dt> +<dt><span><samp>x2</samp></span></dt> +<dt><span><samp>y2</samp></span></dt> +<dt><span><samp>x3</samp></span></dt> +<dt><span><samp>y3</samp></span></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><span><samp>W</samp></span></dt> +<dt><span><samp>H</samp></span></dt> +<dd><p>the width and height of video frame. +</p></dd> +<dt><span><samp>in</samp></span></dt> +<dd><p>Input frame count. +</p></dd> +<dt><span><samp>on</samp></span></dt> +<dd><p>Output frame count. +</p></dd> +</dl> + +</dd> +<dt><span><samp>interpolation</samp></span></dt> +<dd><p>Set interpolation for perspective correction. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dt><span>‘<samp>cubic</samp>’</span></dt> +</dl> + +<p>Default value is ‘<samp>linear</samp>’. +</p> +</dd> +<dt><span><samp>sense</samp></span></dt> +<dd><p>Set interpretation of coordinate options. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>0, source</samp>’</span></dt> +<dd> +<p>Send point in the source specified by the given coordinates to +the corners of the destination. +</p> +</dd> +<dt><span>‘<samp>1, destination</samp>’</span></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 ‘<samp>source</samp>’. +</p></dd> +</dl> + +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>only evaluate expressions once during the filter initialization or +when a command is processed +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>evaluate expressions for each incoming frame +</p></dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p></dd> +</dl> + +<a name="phase"></a> +<h3 class="section">11.186 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><span><samp>mode</samp></span></dt> +<dd><p>Set phase mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>t</samp>’</span></dt> +<dd><p>Capture field order top-first, transfer bottom-first. +Filter will delay the bottom field. +</p> +</dd> +<dt><span>‘<samp>b</samp>’</span></dt> +<dd><p>Capture field order bottom-first, transfer top-first. +Filter will delay the top field. +</p> +</dd> +<dt><span>‘<samp>p</samp>’</span></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><span>‘<samp>a</samp>’</span></dt> +<dd><p>Capture field order determined automatically by field flags, transfer +opposite. +Filter selects among ‘<samp>t</samp>’ and ‘<samp>b</samp>’ modes on a frame by frame +basis using field flags. If no field information is available, +then this works just like ‘<samp>u</samp>’. +</p> +</dd> +<dt><span>‘<samp>u</samp>’</span></dt> +<dd><p>Capture unknown or varying, transfer opposite. +Filter selects among ‘<samp>t</samp>’ and ‘<samp>b</samp>’ on a frame by frame basis by +analyzing the images and selecting the alternative that produces best +match between the fields. +</p> +</dd> +<dt><span>‘<samp>T</samp>’</span></dt> +<dd><p>Capture top-first, transfer unknown or varying. +Filter selects among ‘<samp>t</samp>’ and ‘<samp>p</samp>’ using image analysis. +</p> +</dd> +<dt><span>‘<samp>B</samp>’</span></dt> +<dd><p>Capture bottom-first, transfer unknown or varying. +Filter selects among ‘<samp>b</samp>’ and ‘<samp>p</samp>’ using image analysis. +</p> +</dd> +<dt><span>‘<samp>A</samp>’</span></dt> +<dd><p>Capture determined by field flags, transfer unknown or varying. +Filter selects among ‘<samp>t</samp>’, ‘<samp>b</samp>’ and ‘<samp>p</samp>’ using field flags and +image analysis. If no field information is available, then this works just +like ‘<samp>U</samp>’. This is the default mode. +</p> +</dd> +<dt><span>‘<samp>U</samp>’</span></dt> +<dd><p>Both capture and transfer unknown or varying. +Filter selects among ‘<samp>t</samp>’, ‘<samp>b</samp>’ and ‘<samp>p</samp>’ using image analysis only. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Commands-126"></a> +<h4 class="subsection">11.186.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-126" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-126" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="photosensitivity"></a> +<h3 class="section">11.187 photosensitivity<span class="pull-right"><a class="anchor hidden-xs" href="#photosensitivity" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-photosensitivity" aria-hidden="true">TOC</a></span></h3> +<p>Reduce various flashes in video, so to help users with epilepsy. +</p> +<p>It accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>frames, f</samp></span></dt> +<dd><p>Set how many frames to use when filtering. Default is 30. +</p> +</dd> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set detection threshold factor. Default is 1. +Lower is stricter. +</p> +</dd> +<dt><span><samp>skip</samp></span></dt> +<dd><p>Set how many pixels to skip when sampling frames. Default is 1. +Allowed range is from 1 to 1024. +</p> +</dd> +<dt><span><samp>bypass</samp></span></dt> +<dd><p>Leave frames unchanged. Default is disabled. +</p></dd> +</dl> + +<a name="pixdesctest"></a> +<h3 class="section">11.188 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="pixelize"></a> +<h3 class="section">11.189 pixelize<span class="pull-right"><a class="anchor hidden-xs" href="#pixelize" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pixelize" aria-hidden="true">TOC</a></span></h3> +<p>Apply pixelization to video stream. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></dt> +<dd><p>Set block dimensions that will be used for pixelization. +Default value is <code>16</code>. +</p> +</dd> +<dt><span><samp>mode, m</samp></span></dt> +<dd><p>Set the mode of pixelization used. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span>‘<samp>avg</samp>’</span></dt> +<dt><span>‘<samp>min</samp>’</span></dt> +<dt><span>‘<samp>max</samp>’</span></dt> +</dl> +<p>Default value is <code>avg</code>. +</p> +</dd> +<dt><span><samp>planes, p</samp></span></dt> +<dd><p>Set what planes to filter. Default is to filter all planes. +</p></dd> +</dl> + +<a name="Commands-127"></a> +<h4 class="subsection">11.189.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-127" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-127" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports all options as <a href="#commands">commands</a>. +</p> +<a name="pixscope"></a> +<h3 class="section">11.190 pixscope<span class="pull-right"><a class="anchor hidden-xs" href="#pixscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pixscope" aria-hidden="true">TOC</a></span></h3> + +<p>Display sample values of color channels. Mainly useful for checking color +and levels. Minimum supported resolution is 640x480. +</p> +<p>The filters accept the following options: +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dd><p>Set scope X position, relative offset on X axis. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set scope Y position, relative offset on Y axis. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dd><p>Set scope width. +</p> +</dd> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set scope height. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Set window opacity. This window also holds statistics about pixel area. +</p> +</dd> +<dt><span><samp>wx</samp></span></dt> +<dd><p>Set window X position, relative offset on X axis. +</p> +</dd> +<dt><span><samp>wy</samp></span></dt> +<dd><p>Set window Y position, relative offset on Y axis. +</p></dd> +</dl> + +<a name="Commands-128"></a> +<h4 class="subsection">11.190.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-128" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-128" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="pp"></a> +<h3 class="section">11.191 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 ’/’ and can be disabled by prepending a ’-’. +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><span><samp>subfilters</samp></span></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><span><samp>a/autoq</samp></span></dt> +<dd><p>Honor the quality commands for this subfilter. +</p> +</dd> +<dt><span><samp>c/chrom</samp></span></dt> +<dd><p>Do chrominance filtering, too (default). +</p> +</dd> +<dt><span><samp>y/nochrom</samp></span></dt> +<dd><p>Do luminance filtering only (no chrominance). +</p> +</dd> +<dt><span><samp>n/noluma</samp></span></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 ’|’. +</p> +<p>Available subfilters are: +</p> +<dl compact="compact"> +<dt><span><samp>hb/hdeblock[|difference[|flatness]]</samp></span></dt> +<dd><p>Horizontal deblocking filter +</p><dl compact="compact"> +<dt><span><samp>difference</samp></span></dt> +<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>). +</p></dd> +<dt><span><samp>flatness</samp></span></dt> +<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>). +</p></dd> +</dl> + +</dd> +<dt><span><samp>vb/vdeblock[|difference[|flatness]]</samp></span></dt> +<dd><p>Vertical deblocking filter +</p><dl compact="compact"> +<dt><span><samp>difference</samp></span></dt> +<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>). +</p></dd> +<dt><span><samp>flatness</samp></span></dt> +<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>). +</p></dd> +</dl> + +</dd> +<dt><span><samp>ha/hadeblock[|difference[|flatness]]</samp></span></dt> +<dd><p>Accurate horizontal deblocking filter +</p><dl compact="compact"> +<dt><span><samp>difference</samp></span></dt> +<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>). +</p></dd> +<dt><span><samp>flatness</samp></span></dt> +<dd><p>Flatness threshold where lower values mean more deblocking (default: <code>39</code>). +</p></dd> +</dl> + +</dd> +<dt><span><samp>va/vadeblock[|difference[|flatness]]</samp></span></dt> +<dd><p>Accurate vertical deblocking filter +</p><dl compact="compact"> +<dt><span><samp>difference</samp></span></dt> +<dd><p>Difference factor where higher values mean more deblocking (default: <code>32</code>). +</p></dd> +<dt><span><samp>flatness</samp></span></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><span><samp>h1/x1hdeblock</samp></span></dt> +<dd><p>Experimental horizontal deblocking filter +</p> +</dd> +<dt><span><samp>v1/x1vdeblock</samp></span></dt> +<dd><p>Experimental vertical deblocking filter +</p> +</dd> +<dt><span><samp>dr/dering</samp></span></dt> +<dd><p>Deringing filter +</p> +</dd> +<dt><span><samp>tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer</samp></span></dt> +<dd><dl compact="compact"> +<dt><span><samp>threshold1</samp></span></dt> +<dd><p>larger -> stronger filtering +</p></dd> +<dt><span><samp>threshold2</samp></span></dt> +<dd><p>larger -> stronger filtering +</p></dd> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>larger -> stronger filtering +</p></dd> +</dl> + +</dd> +<dt><span><samp>al/autolevels[:f/fullyrange], automatic brightness / contrast correction</samp></span></dt> +<dd><dl compact="compact"> +<dt><span><samp>f/fullyrange</samp></span></dt> +<dd><p>Stretch luminance to <code>0-255</code>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>lb/linblenddeint</samp></span></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><span><samp>li/linipoldeint</samp></span></dt> +<dd><p>Linear interpolating deinterlacing filter that deinterlaces the given block by +linearly interpolating every second line. +</p> +</dd> +<dt><span><samp>ci/cubicipoldeint</samp></span></dt> +<dd><p>Cubic interpolating deinterlacing filter deinterlaces the given block by +cubically interpolating every second line. +</p> +</dd> +<dt><span><samp>md/mediandeint</samp></span></dt> +<dd><p>Median deinterlacing filter that deinterlaces the given block by applying a +median filter to every second line. +</p> +</dd> +<dt><span><samp>fd/ffmpegdeint</samp></span></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><span><samp>l5/lowpass5</samp></span></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><span><samp>fq/forceQuant[|quantizer]</samp></span></dt> +<dd><p>Overrides the quantizer table from the input with the constant quantizer you +specify. +</p><dl compact="compact"> +<dt><span><samp>quantizer</samp></span></dt> +<dd><p>Quantizer to use +</p></dd> +</dl> + +</dd> +<dt><span><samp>de/default</samp></span></dt> +<dd><p>Default pp filter combination (<code>hb|a,vb|a,dr|a</code>) +</p> +</dd> +<dt><span><samp>fa/fast</samp></span></dt> +<dd><p>Fast pp filter combination (<code>h1|a,v1|a,dr|a</code>) +</p> +</dd> +<dt><span><samp>ac</samp></span></dt> +<dd><p>High quality pp filter combination (<code>ha|a|128|7,va|a,dr|a</code>) +</p></dd> +</dl> + +<a name="Examples-103"></a> +<h4 class="subsection">11.191.1 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> 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">11.192 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><span><samp>qp</samp></span></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><span><samp>mode</samp></span></dt> +<dd><p>Set thresholding mode. Available modes are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>hard</samp>’</span></dt> +<dd><p>Set hard thresholding. +</p></dd> +<dt><span>‘<samp>soft</samp>’</span></dt> +<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier). +</p></dd> +<dt><span>‘<samp>medium</samp>’</span></dt> +<dd><p>Set medium thresholding (good results, default). +</p></dd> +</dl> +</dd> +</dl> + +<a name="premultiply"></a> +<h3 class="section">11.193 premultiply<span class="pull-right"><a class="anchor hidden-xs" href="#premultiply" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-premultiply" aria-hidden="true">TOC</a></span></h3> +<p>Apply alpha premultiply effect to input video stream using first plane +of second stream as alpha. +</p> +<p>Both streams must have same dimensions and same pixel format. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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><span><samp>inplace</samp></span></dt> +<dd><p>Do not require 2nd input for processing, instead use alpha plane from input stream. +</p></dd> +</dl> + +<a name="prewitt"></a> +<h3 class="section">11.194 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><span><samp>planes</samp></span></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><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +</p></dd> +</dl> + +<a name="Commands-129"></a> +<h4 class="subsection">11.194.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-129" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-129" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="pseudocolor"></a> +<h3 class="section">11.195 pseudocolor<span class="pull-right"><a class="anchor hidden-xs" href="#pseudocolor" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pseudocolor" aria-hidden="true">TOC</a></span></h3> + +<p>Alter frame colors in video with pseudocolors. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>c0</samp></span></dt> +<dd><p>set pixel first component expression +</p> +</dd> +<dt><span><samp>c1</samp></span></dt> +<dd><p>set pixel second component expression +</p> +</dd> +<dt><span><samp>c2</samp></span></dt> +<dd><p>set pixel third component expression +</p> +</dd> +<dt><span><samp>c3</samp></span></dt> +<dd><p>set pixel fourth component expression, corresponds to the alpha component +</p> +</dd> +<dt><span><samp>index, i</samp></span></dt> +<dd><p>set component to use as base for altering colors +</p> +</dd> +<dt><span><samp>preset, p</samp></span></dt> +<dd><p>Pick one of built-in LUTs. By default is set to none. +</p> +<p>Available LUTs: +</p><dl compact="compact"> +<dt><span>‘<samp>magma</samp>’</span></dt> +<dt><span>‘<samp>inferno</samp>’</span></dt> +<dt><span>‘<samp>plasma</samp>’</span></dt> +<dt><span>‘<samp>viridis</samp>’</span></dt> +<dt><span>‘<samp>turbo</samp>’</span></dt> +<dt><span>‘<samp>cividis</samp>’</span></dt> +<dt><span>‘<samp>range1</samp>’</span></dt> +<dt><span>‘<samp>range2</samp>’</span></dt> +<dt><span>‘<samp>shadows</samp>’</span></dt> +<dt><span>‘<samp>highlights</samp>’</span></dt> +<dt><span>‘<samp>solar</samp>’</span></dt> +<dt><span>‘<samp>nominal</samp>’</span></dt> +<dt><span>‘<samp>preferred</samp>’</span></dt> +<dt><span>‘<samp>total</samp>’</span></dt> +<dt><span>‘<samp>spectral</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>opacity</samp></span></dt> +<dd><p>Set opacity of output colors. Allowed range is from 0 to 1. +Default value is set to 1. +</p></dd> +</dl> + +<p>Each of the expression options specifies the expression to use for computing +the lookup table for the corresponding pixel component values. +</p> +<p>The expressions can contain the following constants and functions: +</p> +<dl compact="compact"> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>val</samp></span></dt> +<dd><p>The input value for the pixel component. +</p> +</dd> +<dt><span><samp>ymin, umin, vmin, amin</samp></span></dt> +<dd><p>The minimum allowed component value. +</p> +</dd> +<dt><span><samp>ymax, umax, vmax, amax</samp></span></dt> +<dd><p>The maximum allowed component value. +</p></dd> +</dl> + +<p>All expressions default to "val". +</p> +<a name="Commands-130"></a> +<h4 class="subsection">11.195.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-130" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-130" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-104"></a> +<h4 class="subsection">11.195.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> Change too high luma values to gradient: +<div class="example"> +<pre class="example">pseudocolor="'if(between(val,ymax,amax),lerp(ymin,ymax,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(umax,umin,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(vmin,vmax,(val-ymax)/(amax-ymax)),-1):-1'" +</pre></div> +</li></ul> + +<a name="psnr"></a> +<h3 class="section">11.196 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 "main" source and is passed unchanged to the +output. The second input is used as a "reference" 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><span><samp>stats_file, f</samp></span></dt> +<dd><p>If specified the filter will use the named file to save the PSNR of +each individual frame. When filename equals "-" the data is sent to +standard output. +</p> +</dd> +<dt><span><samp>stats_version</samp></span></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><span><samp>stats_add_max</samp></span></dt> +<dd><p>Determines whether the max value is output to the stats log. +Default value is 0. +Requires stats_version >= 2. If this is set and stats_version < 2, +the filter will return an error. +</p></dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<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><span><samp>psnr_log_version</samp></span></dt> +<dd><p>The version of the log file format. Will match <var>stats_version</var>. +</p> +</dd> +<dt><span><samp>fields</samp></span></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><span><samp>n</samp></span></dt> +<dd><p>sequential number of the input frame, starting from 1 +</p> +</dd> +<dt><span><samp>mse_avg</samp></span></dt> +<dd><p>Mean Square Error pixel-by-pixel average difference of the compared +frames, averaged over all the image components. +</p> +</dd> +<dt><span><samp>mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a</samp></span></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><span><samp>psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a</samp></span></dt> +<dd><p>Peak Signal to Noise ratio of the compared frames for the component +specified by the suffix. +</p> +</dd> +<dt><span><samp>max_avg, max_y, max_u, max_v</samp></span></dt> +<dd><p>Maximum allowed value for each channel, and average over all +channels. +</p></dd> +</dl> + +<a name="Examples-105"></a> +<h4 class="subsection">11.196.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> For example: +<div class="example"> +<pre class="example">movie=ref_movie.mpg, setpts=PTS-STARTPTS [main]; +[main][ref] psnr="stats_file=stats.log" [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> +</li><li> Another example with different containers: +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]psnr" -f null - +</pre></div> +</li></ul> + +<span id="pullup"></span><a name="pullup-1"></a> +<h3 class="section">11.197 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><span><samp>jl</samp></span></dt> +<dt><span><samp>jr</samp></span></dt> +<dt><span><samp>jt</samp></span></dt> +<dt><span><samp>jb</samp></span></dt> +<dd><p>These options set the amount of "junk" 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><span><samp>sb</samp></span></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><span><samp>mp</samp></span></dt> +<dd><p>Set the metric plane to use. It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>l</samp>’</span></dt> +<dd><p>Use luma plane. +</p> +</dd> +<dt><span>‘<samp>u</samp>’</span></dt> +<dd><p>Use chroma blue plane. +</p> +</dd> +<dt><span>‘<samp>v</samp>’</span></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’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">11.198 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><span><samp>qp</samp></span></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><span><var>known</var></span></dt> +<dd><p>1 if index is not 129, 0 otherwise. +</p> +</dd> +<dt><span><var>qp</var></span></dt> +<dd><p>Sequential index starting from -129 to 128. +</p></dd> +</dl> + +<a name="Examples-106"></a> +<h4 class="subsection">11.198.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> 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">11.199 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><span><samp>frames</samp></span></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><span><samp>seed</samp></span></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="readeia608"></a> +<h3 class="section">11.200 readeia608<span class="pull-right"><a class="anchor hidden-xs" href="#readeia608" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-readeia608" aria-hidden="true">TOC</a></span></h3> + +<p>Read closed captioning (EIA-608) information from the top lines of a video frame. +</p> +<p>This filter adds frame metadata for <code>lavfi.readeia608.X.cc</code> and +<code>lavfi.readeia608.X.line</code>, where <code>X</code> is the number of the identified line +with EIA-608 data (starting from 0). A description of each metadata value follows: +</p> +<dl compact="compact"> +<dt><span><samp>lavfi.readeia608.X.cc</samp></span></dt> +<dd><p>The two bytes stored as EIA-608 data (printed in hexadecimal). +</p> +</dd> +<dt><span><samp>lavfi.readeia608.X.line</samp></span></dt> +<dd><p>The number of the line on which the EIA-608 data was identified and read. +</p></dd> +</dl> + +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>scan_min</samp></span></dt> +<dd><p>Set the line to start scanning for EIA-608 data. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>scan_max</samp></span></dt> +<dd><p>Set the line to end scanning for EIA-608 data. Default is <code>29</code>. +</p> +</dd> +<dt><span><samp>spw</samp></span></dt> +<dd><p>Set the ratio of width reserved for sync code detection. +Default is <code>0.27</code>. Allowed range is <code>[0.1 - 0.7]</code>. +</p> +</dd> +<dt><span><samp>chp</samp></span></dt> +<dd><p>Enable checking the parity bit. In the event of a parity error, the filter will output +<code>0x00</code> for that character. Default is false. +</p> +</dd> +<dt><span><samp>lp</samp></span></dt> +<dd><p>Lowpass lines prior to further processing. Default is enabled. +</p></dd> +</dl> + +<a name="Commands-131"></a> +<h4 class="subsection">11.200.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-131" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-131" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="Examples-107"></a> +<h4 class="subsection">11.200.2 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> Output a csv with presentation time and the first two lines of identified EIA-608 captioning data. +<div class="example"> +<pre class="example">ffprobe -f lavfi -i movie=captioned_video.mov,readeia608 -show_entries frame=pts_time:frame_tags=lavfi.readeia608.0.cc,lavfi.readeia608.1.cc -of csv +</pre></div> +</li></ul> + +<a name="readvitc"></a> +<h3 class="section">11.201 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><span><samp>scan_max</samp></span></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><span><samp>thr_b</samp></span></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><span><samp>thr_w</samp></span></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-108"></a> +<h4 class="subsection">11.201.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> 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">11.202 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> +<dl compact="compact"> +<dt><span><samp>format</samp></span></dt> +<dd><p>Specify pixel format of output from this filter. Can be <code>color</code> or <code>gray</code>. +Default is <code>color</code>. +</p> +</dd> +<dt><span><samp>fill</samp></span></dt> +<dd><p>Specify the color of the unmapped pixels. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. Default color is <code>black</code>. +</p></dd> +</dl> + +<a name="removegrain"></a> +<h3 class="section">11.203 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><span><samp>m0</samp></span></dt> +<dd><p>Set mode for the first plane. +</p> +</dd> +<dt><span><samp>m1</samp></span></dt> +<dd><p>Set mode for the second plane. +</p> +</dd> +<dt><span><samp>m2</samp></span></dt> +<dd><p>Set mode for the third plane. +</p> +</dd> +<dt><span><samp>m3</samp></span></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><span><var>0</var></span></dt> +<dd><p>Leave input plane unchanged. Default. +</p> +</dd> +<dt><span><var>1</var></span></dt> +<dd><p>Clips the pixel with the minimum and maximum of the 8 neighbour pixels. +</p> +</dd> +<dt><span><var>2</var></span></dt> +<dd><p>Clips the pixel with the second minimum and maximum of the 8 neighbour pixels. +</p> +</dd> +<dt><span><var>3</var></span></dt> +<dd><p>Clips the pixel with the third minimum and maximum of the 8 neighbour pixels. +</p> +</dd> +<dt><span><var>4</var></span></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><span><var>5</var></span></dt> +<dd><p>Line-sensitive clipping giving the minimal change. +</p> +</dd> +<dt><span><var>6</var></span></dt> +<dd><p>Line-sensitive clipping, intermediate. +</p> +</dd> +<dt><span><var>7</var></span></dt> +<dd><p>Line-sensitive clipping, intermediate. +</p> +</dd> +<dt><span><var>8</var></span></dt> +<dd><p>Line-sensitive clipping, intermediate. +</p> +</dd> +<dt><span><var>9</var></span></dt> +<dd><p>Line-sensitive clipping on a line where the neighbours pixels are the closest. +</p> +</dd> +<dt><span><var>10</var></span></dt> +<dd><p>Replaces the target pixel with the closest neighbour. +</p> +</dd> +<dt><span><var>11</var></span></dt> +<dd><p>[1 2 1] horizontal and vertical kernel blur. +</p> +</dd> +<dt><span><var>12</var></span></dt> +<dd><p>Same as mode 11. +</p> +</dd> +<dt><span><var>13</var></span></dt> +<dd><p>Bob mode, interpolates top field from the line where the neighbours +pixels are the closest. +</p> +</dd> +<dt><span><var>14</var></span></dt> +<dd><p>Bob mode, interpolates bottom field from the line where the neighbours +pixels are the closest. +</p> +</dd> +<dt><span><var>15</var></span></dt> +<dd><p>Bob mode, interpolates top field. Same as 13 but with a more complicated +interpolation formula. +</p> +</dd> +<dt><span><var>16</var></span></dt> +<dd><p>Bob mode, interpolates bottom field. Same as 14 but with a more complicated +interpolation formula. +</p> +</dd> +<dt><span><var>17</var></span></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><span><var>18</var></span></dt> +<dd><p>Line-sensitive clipping using opposite neighbours whose greatest distance from +the current pixel is minimal. +</p> +</dd> +<dt><span><var>19</var></span></dt> +<dd><p>Replaces the pixel with the average of its 8 neighbours. +</p> +</dd> +<dt><span><var>20</var></span></dt> +<dd><p>Averages the 9 pixels ([1 1 1] horizontal and vertical blur). +</p> +</dd> +<dt><span><var>21</var></span></dt> +<dd><p>Clips pixels using the averages of opposite neighbour. +</p> +</dd> +<dt><span><var>22</var></span></dt> +<dd><p>Same as mode 21 but simpler and faster. +</p> +</dd> +<dt><span><var>23</var></span></dt> +<dd><p>Small edge and halo removal, but reputed useless. +</p> +</dd> +<dt><span><var>24</var></span></dt> +<dd><p>Similar as 23. +</p></dd> +</dl> + +<a name="removelogo"></a> +<h3 class="section">11.204 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><span><samp>filename, f</samp></span></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">11.205 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">11.206 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-109"></a> +<h4 class="subsection">11.206.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> 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="rgbashift"></a> +<h3 class="section">11.207 rgbashift<span class="pull-right"><a class="anchor hidden-xs" href="#rgbashift" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rgbashift" aria-hidden="true">TOC</a></span></h3> +<p>Shift R/G/B/A pixels horizontally and/or vertically. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>rh</samp></span></dt> +<dd><p>Set amount to shift red horizontally. +</p></dd> +<dt><span><samp>rv</samp></span></dt> +<dd><p>Set amount to shift red vertically. +</p></dd> +<dt><span><samp>gh</samp></span></dt> +<dd><p>Set amount to shift green horizontally. +</p></dd> +<dt><span><samp>gv</samp></span></dt> +<dd><p>Set amount to shift green vertically. +</p></dd> +<dt><span><samp>bh</samp></span></dt> +<dd><p>Set amount to shift blue horizontally. +</p></dd> +<dt><span><samp>bv</samp></span></dt> +<dd><p>Set amount to shift blue vertically. +</p></dd> +<dt><span><samp>ah</samp></span></dt> +<dd><p>Set amount to shift alpha horizontally. +</p></dd> +<dt><span><samp>av</samp></span></dt> +<dd><p>Set amount to shift alpha vertically. +</p></dd> +<dt><span><samp>edge</samp></span></dt> +<dd><p>Set edge mode, can be <var>smear</var>, default, or <var>warp</var>. +</p></dd> +</dl> + +<a name="Commands-132"></a> +<h4 class="subsection">11.207.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-132" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-132" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="roberts"></a> +<h3 class="section">11.208 roberts<span class="pull-right"><a class="anchor hidden-xs" href="#roberts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-roberts" aria-hidden="true">TOC</a></span></h3> +<p>Apply roberts cross operator to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +</p></dd> +</dl> + +<a name="Commands-133"></a> +<h4 class="subsection">11.208.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-133" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-133" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="rotate"></a> +<h3 class="section">11.209 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><span><samp>angle, a</samp></span></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 "0". +</p> +<p>This expression is evaluated for each frame. +</p> +</dd> +<dt><span><samp>out_w, ow</samp></span></dt> +<dd><p>Set the output width expression, default value is "iw". +This expression is evaluated just once during configuration. +</p> +</dd> +<dt><span><samp>out_h, oh</samp></span></dt> +<dd><p>Set the output height expression, default value is "ih". +This expression is evaluated just once during configuration. +</p> +</dd> +<dt><span><samp>bilinear</samp></span></dt> +<dd><p>Enable bilinear interpolation if set to 1, a value of 0 disables +it. Default value is 1. +</p> +</dd> +<dt><span><samp>fillcolor, c</samp></span></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 +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +</p> +<p>Default value is "black". +</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><span><samp>n</samp></span></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><span><samp>t</samp></span></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><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><samp>in_w, iw</samp></span></dt> +<dt><span><samp>in_h, ih</samp></span></dt> +<dd><p>the input video width and height +</p> +</dd> +<dt><span><samp>out_w, ow</samp></span></dt> +<dt><span><samp>out_h, oh</samp></span></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><span><samp>rotw(a)</samp></span></dt> +<dt><span><samp>roth(a)</samp></span></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-110"></a> +<h4 class="subsection">11.209.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> 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-134"></a> +<h4 class="subsection">11.209.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-134" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-134" aria-hidden="true">TOC</a></span></h4> + +<p>The filter supports the following commands: +</p> +<dl compact="compact"> +<dt><span><samp>a, angle</samp></span></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">11.210 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><span><samp>luma_radius, lr</samp></span></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><span><samp>luma_pre_filter_radius, lpfr</samp></span></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><span><samp>luma_strength, ls</samp></span></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><span><samp>chroma_radius, cr</samp></span></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><span><samp>chroma_pre_filter_radius, cpfr</samp></span></dt> +<dd><p>Set chroma pre-filter radius, must be a value in the -0.9-2.0 range. +</p> +</dd> +<dt><span><samp>chroma_strength, cs</samp></span></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> +<span id="scale"></span><a name="scale-1"></a> +<h3 class="section">11.211 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-2"></a> +<h4 class="subsection">11.211.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 filter accepts the following options, or any of the options +supported by the libswscale scaler. +</p> +<p>See <a data-manual="ffmpeg-scaler" 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><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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> value is 0, the input width is used for +the output. If the <var>height</var> or <var>h</var> value is 0, the input height +is used for the output. +</p> +<p>If one and only one of the values is -n with n >= 1, the scale filter +will 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>If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +</p> +<p>See below for the list of accepted constants for use in the dimension +expression. +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>Only evaluate expressions once during the filter initialization or when a command is processed. +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Evaluate expressions for each incoming frame. +</p> +</dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p> + +</dd> +<dt><span><samp>interl</samp></span></dt> +<dd><p>Set the interlacing mode. It accepts the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>1</samp>’</span></dt> +<dd><p>Force interlaced aware scaling. +</p> +</dd> +<dt><span>‘<samp>0</samp>’</span></dt> +<dd><p>Do not apply interlaced scaling. +</p> +</dd> +<dt><span>‘<samp>-1</samp>’</span></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 ‘<samp>0</samp>’. +</p> +</dd> +<dt><span><samp>flags</samp></span></dt> +<dd><p>Set libswscale scaling flags. See +<a data-manual="ffmpeg-scaler" 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><span><samp>param0, param1</samp></span></dt> +<dd><p>Set libswscale input parameters for scaling algorithms that need them. See +<a data-manual="ffmpeg-scaler" 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><span><samp>size, s</samp></span></dt> +<dd><p>Set the video size. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>in_color_matrix</samp></span></dt> +<dt><span><samp>out_color_matrix</samp></span></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><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Choose automatically. +</p> +</dd> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>Format conforming to International Telecommunication Union (ITU) +Recommendation BT.709. +</p> +</dd> +<dt><span>‘<samp>fcc</samp>’</span></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><span>‘<samp>bt601</samp>’</span></dt> +<dt><span>‘<samp>bt470</samp>’</span></dt> +<dt><span>‘<samp>smpte170m</samp>’</span></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><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>Set color space conforming to SMPTE ST 240:1999. +</p> +</dd> +<dt><span>‘<samp>bt2020</samp>’</span></dt> +<dd><p>Set color space conforming to ITU-R BT.2020 non-constant luminance system. +</p></dd> +</dl> + +</dd> +<dt><span><samp>in_range</samp></span></dt> +<dt><span><samp>out_range</samp></span></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><span>‘<samp>auto/unknown</samp>’</span></dt> +<dd><p>Choose automatically. +</p> +</dd> +<dt><span>‘<samp>jpeg/full/pc</samp>’</span></dt> +<dd><p>Set full range (0-255 in case of 8-bit luma). +</p> +</dd> +<dt><span>‘<samp>mpeg/limited/tv</samp>’</span></dt> +<dd><p>Set "MPEG" range (16-235 in case of 8-bit luma). +</p></dd> +</dl> + +</dd> +<dt><span><samp>force_original_aspect_ratio</samp></span></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><span>‘<samp>disable</samp>’</span></dt> +<dd><p>Scale the video as specified and disable this feature. +</p> +</dd> +<dt><span>‘<samp>decrease</samp>’</span></dt> +<dd><p>The output video dimensions will automatically be decreased if needed. +</p> +</dd> +<dt><span>‘<samp>increase</samp>’</span></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’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> +<dt><span><samp>force_divisible_by</samp></span></dt> +<dd><p>Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with <samp>force_original_aspect_ratio</samp>. This +works similar to using <code>-n</code> in the <samp>w</samp> and <samp>h</samp> options. +</p> +<p>This option respects the value set for <samp>force_original_aspect_ratio</samp>, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +</p> +<p>This option can be handy if you need to have a video fit within or exceed +a defined resolution using <samp>force_original_aspect_ratio</samp> but also have +encoder restrictions on width or height divisibility. +</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><span><var>in_w</var></span></dt> +<dt><span><var>in_h</var></span></dt> +<dd><p>The input width and height +</p> +</dd> +<dt><span><var>iw</var></span></dt> +<dt><span><var>ih</var></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><var>out_w</var></span></dt> +<dt><span><var>out_h</var></span></dt> +<dd><p>The output (scaled) width and height +</p> +</dd> +<dt><span><var>ow</var></span></dt> +<dt><span><var>oh</var></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var> +</p> +</dd> +<dt><span><var>a</var></span></dt> +<dd><p>The same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><var>sar</var></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><var>dar</var></span></dt> +<dd><p>The input display aspect ratio. Calculated from <code>(iw / ih) * sar</code>. +</p> +</dd> +<dt><span><var>hsub</var></span></dt> +<dt><span><var>vsub</var></span></dt> +<dd><p>horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><var>ohsub</var></span></dt> +<dt><span><var>ovsub</var></span></dt> +<dd><p>horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><var>n</var></span></dt> +<dd><p>The (sequential) number of the input frame, starting from 0. +Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>t</var></span></dt> +<dd><p>The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>pos</var></span></dt> +<dd><p>The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with <code>eval=frame</code>. +</p></dd> +</dl> + +<a name="Examples-111"></a> +<h4 class="subsection">11.211.2 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> 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="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub" +</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><li> Make pixels square by combining scale and setsar: +<div class="example"> +<pre class="example">scale='trunc(ih*dar):ih',setsar=1/1 +</pre></div> + +</li><li> Make pixels square by combining scale and setsar, +making sure the resulting resolution is even (required by some codecs): +<div class="example"> +<pre class="example">scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1 +</pre></div> +</li></ul> + +<a name="Commands-135"></a> +<h4 class="subsection">11.211.3 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-135" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-135" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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_005fcuda"></a> +<h3 class="section">11.212 scale_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#scale_005fcuda" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale_005fcuda" aria-hidden="true">TOC</a></span></h3> + +<p>Scale (resize) and convert (pixel format) the input video, using accelerated CUDA kernels. +Setting the output width and height works in the same way as for the <a href="#scale">scale</a> filter. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set the output video dimension expression. Default value is the input dimension. +</p> +<p>Allows for the same expressions as the <a href="#scale">scale</a> filter. +</p> +</dd> +<dt><span><samp>interp_algo</samp></span></dt> +<dd><p>Sets the algorithm used for scaling: +</p> +<dl compact="compact"> +<dt><span><var>nearest</var></span></dt> +<dd><p>Nearest neighbour +</p> +<p>Used by default if input parameters match the desired output. +</p> +</dd> +<dt><span><var>bilinear</var></span></dt> +<dd><p>Bilinear +</p> +</dd> +<dt><span><var>bicubic</var></span></dt> +<dd><p>Bicubic +</p> +<p>This is the default. +</p> +</dd> +<dt><span><var>lanczos</var></span></dt> +<dd><p>Lanczos +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Controls the output pixel format. By default, or if none is specified, the input +pixel format is used. +</p> +<p>The filter does not support converting between YUV and RGB pixel formats. +</p> +</dd> +<dt><span><samp>passthrough</samp></span></dt> +<dd><p>If set to 0, every frame is processed, even if no conversion is neccesary. +This mode can be useful to use the filter as a buffer for a downstream +frame-consumer that exhausts the limited decoder frame pool. +</p> +<p>If set to 1, frames are passed through as-is if they match the desired output +parameters. This is the default behaviour. +</p> +</dd> +<dt><span><samp>param</samp></span></dt> +<dd><p>Algorithm-Specific parameter. +</p> +<p>Affects the curves of the bicubic algorithm. +</p> +</dd> +<dt><span><samp>force_original_aspect_ratio</samp></span></dt> +<dt><span><samp>force_divisible_by</samp></span></dt> +<dd><p>Work the same as the identical <a href="#scale">scale</a> filter options. +</p> +</dd> +</dl> + +<a name="Examples-112"></a> +<h4 class="subsection">11.212.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> Scale input to 720p, keeping aspect ratio and ensuring the output is yuv420p. +<div class="example"> +<pre class="example">scale_cuda=-2:720:format=yuv420p +</pre></div> + +</li><li> Upscale to 4K using nearest neighbour algorithm. +<div class="example"> +<pre class="example">scale_cuda=4096:2160:interp_algo=nearest +</pre></div> + +</li><li> Don’t do any conversion or scaling, but copy all input frames into newly allocated ones. +This can be useful to deal with a filter and encode chain that otherwise exhausts the +decoders frame pool. +<div class="example"> +<pre class="example">scale_cuda=passthrough=0 +</pre></div> +</li></ul> + +<span id="scale_005fnpp"></span><a name="scale_005fnpp-1"></a> +<h3 class="section">11.213 scale_npp<span class="pull-right"><a class="anchor hidden-xs" href="#scale_005fnpp-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale_005fnpp-1" 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><span><samp>format</samp></span></dt> +<dd><p>The pixel format of the output CUDA frames. If set to the string "same" (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><span><samp>interp_algo</samp></span></dt> +<dd><p>The interpolation algorithm used for resizing. One of the following: +</p><dl compact="compact"> +<dt><span><samp>nn</samp></span></dt> +<dd><p>Nearest neighbour. +</p> +</dd> +<dt><span><samp>linear</samp></span></dt> +<dt><span><samp>cubic</samp></span></dt> +<dt><span><samp>cubic2p_bspline</samp></span></dt> +<dd><p>2-parameter cubic (B=1, C=0) +</p> +</dd> +<dt><span><samp>cubic2p_catmullrom</samp></span></dt> +<dd><p>2-parameter cubic (B=0, C=1/2) +</p> +</dd> +<dt><span><samp>cubic2p_b05c03</samp></span></dt> +<dd><p>2-parameter cubic (B=1/2, C=3/10) +</p> +</dd> +<dt><span><samp>super</samp></span></dt> +<dd><p>Supersampling +</p> +</dd> +<dt><span><samp>lanczos</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>force_original_aspect_ratio</samp></span></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><span>‘<samp>disable</samp>’</span></dt> +<dd><p>Scale the video as specified and disable this feature. +</p> +</dd> +<dt><span>‘<samp>decrease</samp>’</span></dt> +<dd><p>The output video dimensions will automatically be decreased if needed. +</p> +</dd> +<dt><span>‘<samp>increase</samp>’</span></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’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> +<dt><span><samp>force_divisible_by</samp></span></dt> +<dd><p>Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with <samp>force_original_aspect_ratio</samp>. This +works similar to using <code>-n</code> in the <samp>w</samp> and <samp>h</samp> options. +</p> +<p>This option respects the value set for <samp>force_original_aspect_ratio</samp>, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +</p> +<p>This option can be handy if you need to have a video fit within or exceed +a defined resolution using <samp>force_original_aspect_ratio</samp> but also have +encoder restrictions on width or height divisibility. +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>Only evaluate expressions once during the filter initialization or when a command is processed. +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Evaluate expressions for each incoming frame. +</p> +</dd> +</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><span><var>in_w</var></span></dt> +<dt><span><var>in_h</var></span></dt> +<dd><p>The input width and height +</p> +</dd> +<dt><span><var>iw</var></span></dt> +<dt><span><var>ih</var></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><var>out_w</var></span></dt> +<dt><span><var>out_h</var></span></dt> +<dd><p>The output (scaled) width and height +</p> +</dd> +<dt><span><var>ow</var></span></dt> +<dt><span><var>oh</var></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var> +</p> +</dd> +<dt><span><var>a</var></span></dt> +<dd><p>The same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><var>sar</var></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><var>dar</var></span></dt> +<dd><p>The input display aspect ratio. Calculated from <code>(iw / ih) * sar</code>. +</p> +</dd> +<dt><span><var>n</var></span></dt> +<dd><p>The (sequential) number of the input frame, starting from 0. +Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>t</var></span></dt> +<dd><p>The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>pos</var></span></dt> +<dd><p>The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with <code>eval=frame</code>. +</p></dd> +</dl> + +<a name="scale2ref"></a> +<h3 class="section">11.214 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. scale2ref also +supports the following additional constants for the <samp>w</samp> and +<samp>h</samp> options: +</p> +<dl compact="compact"> +<dt><span><var>main_w</var></span></dt> +<dt><span><var>main_h</var></span></dt> +<dd><p>The main input video’s width and height +</p> +</dd> +<dt><span><var>main_a</var></span></dt> +<dd><p>The same as <var>main_w</var> / <var>main_h</var> +</p> +</dd> +<dt><span><var>main_sar</var></span></dt> +<dd><p>The main input video’s sample aspect ratio +</p> +</dd> +<dt><span><var>main_dar, mdar</var></span></dt> +<dd><p>The main input video’s display aspect ratio. Calculated from +<code>(main_w / main_h) * main_sar</code>. +</p> +</dd> +<dt><span><var>main_hsub</var></span></dt> +<dt><span><var>main_vsub</var></span></dt> +<dd><p>The main input video’s horizontal and vertical chroma subsample values. +For example for the pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> +is 1. +</p> +</dd> +<dt><span><var>main_n</var></span></dt> +<dd><p>The (sequential) number of the main input frame, starting from 0. +Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>main_t</var></span></dt> +<dd><p>The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>main_pos</var></span></dt> +<dd><p>The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with <code>eval=frame</code>. +</p></dd> +</dl> + +<a name="Examples-113"></a> +<h4 class="subsection">11.214.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> Scale a subtitle stream (b) to match the main video (a) in size before overlaying +<div class="example"> +<pre class="example">'scale2ref[b][a];[a][b]overlay' +</pre></div> + +</li><li> Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +<div class="example"> +<pre class="example">[logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out] +</pre></div> +</li></ul> + +<a name="Commands-136"></a> +<h4 class="subsection">11.214.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-136" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-136" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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="scale2ref_005fnpp"></a> +<h3 class="section">11.215 scale2ref_npp<span class="pull-right"><a class="anchor hidden-xs" href="#scale2ref_005fnpp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scale2ref_005fnpp" aria-hidden="true">TOC</a></span></h3> + +<p>Use the NVIDIA Performance Primitives (libnpp) to scale (resize) the input +video, based on a reference video. +</p> +<p>See the <a href="#scale_005fnpp">scale_npp</a> filter for available options, scale2ref_npp supports the same +but uses the reference video instead of the main input as basis. scale2ref_npp +also supports the following additional constants for the <samp>w</samp> and +<samp>h</samp> options: +</p> +<dl compact="compact"> +<dt><span><var>main_w</var></span></dt> +<dt><span><var>main_h</var></span></dt> +<dd><p>The main input video’s width and height +</p> +</dd> +<dt><span><var>main_a</var></span></dt> +<dd><p>The same as <var>main_w</var> / <var>main_h</var> +</p> +</dd> +<dt><span><var>main_sar</var></span></dt> +<dd><p>The main input video’s sample aspect ratio +</p> +</dd> +<dt><span><var>main_dar, mdar</var></span></dt> +<dd><p>The main input video’s display aspect ratio. Calculated from +<code>(main_w / main_h) * main_sar</code>. +</p> +</dd> +<dt><span><var>main_n</var></span></dt> +<dd><p>The (sequential) number of the main input frame, starting from 0. +Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>main_t</var></span></dt> +<dd><p>The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with <code>eval=frame</code>. +</p> +</dd> +<dt><span><var>main_pos</var></span></dt> +<dd><p>The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with <code>eval=frame</code>. +</p></dd> +</dl> + +<a name="Examples-114"></a> +<h4 class="subsection">11.215.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> Scale a subtitle stream (b) to match the main video (a) in size before overlaying +<div class="example"> +<pre class="example">'scale2ref_npp[b][a];[a][b]overlay_cuda' +</pre></div> + +</li><li> Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +<div class="example"> +<pre class="example">[logo-in][video-in]scale2ref_npp=w=oh*mdar:h=ih/10[logo-out][video-out] +</pre></div> +</li></ul> + +<a name="scharr"></a> +<h3 class="section">11.216 scharr<span class="pull-right"><a class="anchor hidden-xs" href="#scharr" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scharr" aria-hidden="true">TOC</a></span></h3> +<p>Apply scharr operator to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +</p></dd> +</dl> + +<a name="Commands-137"></a> +<h4 class="subsection">11.216.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-137" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-137" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="scroll"></a> +<h3 class="section">11.217 scroll<span class="pull-right"><a class="anchor hidden-xs" href="#scroll" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scroll" aria-hidden="true">TOC</a></span></h3> +<p>Scroll input video horizontally and/or vertically by constant speed. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>horizontal, h</samp></span></dt> +<dd><p>Set the horizontal scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +</p> +</dd> +<dt><span><samp>vertical, v</samp></span></dt> +<dd><p>Set the vertical scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +</p> +</dd> +<dt><span><samp>hpos</samp></span></dt> +<dd><p>Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1. +</p> +</dd> +<dt><span><samp>vpos</samp></span></dt> +<dd><p>Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1. +</p></dd> +</dl> + +<a name="Commands-138"></a> +<h4 class="subsection">11.217.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-138" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-138" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following <a href="#commands">commands</a>: +</p><dl compact="compact"> +<dt><span><samp>horizontal, h</samp></span></dt> +<dd><p>Set the horizontal scrolling speed. +</p></dd> +<dt><span><samp>vertical, v</samp></span></dt> +<dd><p>Set the vertical scrolling speed. +</p></dd> +</dl> + +<span id="scdet"></span><a name="scdet-1"></a> +<h3 class="section">11.218 scdet<span class="pull-right"><a class="anchor hidden-xs" href="#scdet-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-scdet-1" aria-hidden="true">TOC</a></span></h3> + +<p>Detect video scene change. +</p> +<p>This filter sets frame metadata with mafd between frame, the scene score, and +forward the frame to the next filter, so they can use these metadata to detect +scene change or others. +</p> +<p>In addition, this filter logs a message and sets frame metadata when it detects +a scene change by <samp>threshold</samp>. +</p> +<p><code>lavfi.scd.mafd</code> metadata keys are set with mafd for every frame. +</p> +<p><code>lavfi.scd.score</code> metadata keys are set with scene change score for every frame +to detect scene change. +</p> +<p><code>lavfi.scd.time</code> metadata keys are set with current filtered frame time which +detect scene change with <samp>threshold</samp>. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>threshold, t</samp></span></dt> +<dd><p>Set the scene change detection threshold as a percentage of maximum change. Good +values are in the <code>[8.0, 14.0]</code> range. The range for <samp>threshold</samp> is +<code>[0., 100.]</code>. +</p> +<p>Default value is <code>10.</code>. +</p> +</dd> +<dt><span><samp>sc_pass, s</samp></span></dt> +<dd><p>Set the flag to pass scene change frames to the next filter. Default value is <code>0</code> +You can enable it if you want to get snapshot of scene change frames only. +</p></dd> +</dl> + +<span id="selectivecolor"></span><a name="selectivecolor-1"></a> +<h3 class="section">11.219 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 "reds", "yellows", "greens", "cyans", ...). The adjustment range is defined +by the "purity" 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><span><samp>correction_method</samp></span></dt> +<dd><p>Select color correction method. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>absolute</samp>’</span></dt> +<dd><p>Specified adjustments are applied "as-is" (added/subtracted to original pixel +component value). +</p></dd> +<dt><span>‘<samp>relative</samp>’</span></dt> +<dd><p>Specified adjustments are relative to the original component value. +</p></dd> +</dl> +<p>Default is <code>absolute</code>. +</p></dd> +<dt><span><samp>reds</samp></span></dt> +<dd><p>Adjustments for red pixels (pixels where the red component is the maximum) +</p></dd> +<dt><span><samp>yellows</samp></span></dt> +<dd><p>Adjustments for yellow pixels (pixels where the blue component is the minimum) +</p></dd> +<dt><span><samp>greens</samp></span></dt> +<dd><p>Adjustments for green pixels (pixels where the green component is the maximum) +</p></dd> +<dt><span><samp>cyans</samp></span></dt> +<dd><p>Adjustments for cyan pixels (pixels where the red component is the minimum) +</p></dd> +<dt><span><samp>blues</samp></span></dt> +<dd><p>Adjustments for blue pixels (pixels where the blue component is the maximum) +</p></dd> +<dt><span><samp>magentas</samp></span></dt> +<dd><p>Adjustments for magenta pixels (pixels where the green component is the minimum) +</p></dd> +<dt><span><samp>whites</samp></span></dt> +<dd><p>Adjustments for white pixels (pixels where all components are greater than 128) +</p></dd> +<dt><span><samp>neutrals</samp></span></dt> +<dd><p>Adjustments for all pixels except pure black and pure white +</p></dd> +<dt><span><samp>blacks</samp></span></dt> +<dd><p>Adjustments for black pixels (pixels where all components are lesser than 128) +</p></dd> +<dt><span><samp>psfile</samp></span></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-115"></a> +<h4 class="subsection">11.219.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> 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> + +<span id="separatefields"></span><a name="separatefields-1"></a> +<h3 class="section">11.220 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">11.221 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 "setdar" or a "setsar" 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 "setsar" or a "setdar" filter is applied. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>r, ratio, dar (<code>setdar</code> only), sar (<code>setsar</code> only)</samp></span></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 "0". +In case the form "<var>num</var>:<var>den</var>" is used, the <code>:</code> character +should be escaped. +</p> +</dd> +<dt><span><samp>max</samp></span></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><span><samp>E, PI, PHI</samp></span></dt> +<dd><p>These are approximated values for the mathematical constants e +(Euler’s number), pi (Greek pi), and phi (the golden ratio). +</p> +</dd> +<dt><span><samp>w, h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>These are the same as <var>w</var> / <var>h</var>. +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>The input sample aspect ratio. +</p> +</dd> +<dt><span><samp>dar</samp></span></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><span><samp>hsub, vsub</samp></span></dt> +<dd><p>Horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p></dd> +</dl> + +<a name="Examples-116"></a> +<h4 class="subsection">11.221.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> 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> + +<span id="setfield"></span><a name="setfield-1"></a> +<h3 class="section">11.222 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><span><samp>mode</samp></span></dt> +<dd><p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same field property. +</p> +</dd> +<dt><span>‘<samp>bff</samp>’</span></dt> +<dd><p>Mark the frame as bottom-field-first. +</p> +</dd> +<dt><span>‘<samp>tff</samp>’</span></dt> +<dd><p>Mark the frame as top-field-first. +</p> +</dd> +<dt><span>‘<samp>prog</samp>’</span></dt> +<dd><p>Mark the frame as progressive. +</p></dd> +</dl> +</dd> +</dl> + +<span id="setparams"></span><a name="setparams-1"></a> +<h3 class="section">11.223 setparams<span class="pull-right"><a class="anchor hidden-xs" href="#setparams-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-setparams-1" aria-hidden="true">TOC</a></span></h3> + +<p>Force frame parameter for the output video frame. +</p> +<p>The <code>setparams</code> filter marks interlace and color range 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 +filters/encoders. +</p> +<dl compact="compact"> +<dt><span><samp>field_mode</samp></span></dt> +<dd><p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same field property (default). +</p> +</dd> +<dt><span>‘<samp>bff</samp>’</span></dt> +<dd><p>Mark the frame as bottom-field-first. +</p> +</dd> +<dt><span>‘<samp>tff</samp>’</span></dt> +<dd><p>Mark the frame as top-field-first. +</p> +</dd> +<dt><span>‘<samp>prog</samp>’</span></dt> +<dd><p>Mark the frame as progressive. +</p></dd> +</dl> + +</dd> +<dt><span><samp>range</samp></span></dt> +<dd><p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same color range property (default). +</p> +</dd> +<dt><span>‘<samp>unspecified, unknown</samp>’</span></dt> +<dd><p>Mark the frame as unspecified color range. +</p> +</dd> +<dt><span>‘<samp>limited, tv, mpeg</samp>’</span></dt> +<dd><p>Mark the frame as limited range. +</p> +</dd> +<dt><span>‘<samp>full, pc, jpeg</samp>’</span></dt> +<dd><p>Mark the frame as full range. +</p></dd> +</dl> + +</dd> +<dt><span><samp>color_primaries</samp></span></dt> +<dd><p>Set the color primaries. +Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same color primaries property (default). +</p> +</dd> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dt><span>‘<samp>unknown</samp>’</span></dt> +<dt><span>‘<samp>bt470m</samp>’</span></dt> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dt><span>‘<samp>film</samp>’</span></dt> +<dt><span>‘<samp>bt2020</samp>’</span></dt> +<dt><span>‘<samp>smpte428</samp>’</span></dt> +<dt><span>‘<samp>smpte431</samp>’</span></dt> +<dt><span>‘<samp>smpte432</samp>’</span></dt> +<dt><span>‘<samp>jedec-p22</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>color_trc</samp></span></dt> +<dd><p>Set the color transfer. +Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same color trc property (default). +</p> +</dd> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dt><span>‘<samp>unknown</samp>’</span></dt> +<dt><span>‘<samp>bt470m</samp>’</span></dt> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dt><span>‘<samp>log100</samp>’</span></dt> +<dt><span>‘<samp>log316</samp>’</span></dt> +<dt><span>‘<samp>iec61966-2-4</samp>’</span></dt> +<dt><span>‘<samp>bt1361e</samp>’</span></dt> +<dt><span>‘<samp>iec61966-2-1</samp>’</span></dt> +<dt><span>‘<samp>bt2020-10</samp>’</span></dt> +<dt><span>‘<samp>bt2020-12</samp>’</span></dt> +<dt><span>‘<samp>smpte2084</samp>’</span></dt> +<dt><span>‘<samp>smpte428</samp>’</span></dt> +<dt><span>‘<samp>arib-std-b67</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>colorspace</samp></span></dt> +<dd><p>Set the colorspace. +Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same colorspace property (default). +</p> +</dd> +<dt><span>‘<samp>gbr</samp>’</span></dt> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dt><span>‘<samp>unknown</samp>’</span></dt> +<dt><span>‘<samp>fcc</samp>’</span></dt> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dt><span>‘<samp>ycgco</samp>’</span></dt> +<dt><span>‘<samp>bt2020nc</samp>’</span></dt> +<dt><span>‘<samp>bt2020c</samp>’</span></dt> +<dt><span>‘<samp>smpte2085</samp>’</span></dt> +<dt><span>‘<samp>chroma-derived-nc</samp>’</span></dt> +<dt><span>‘<samp>chroma-derived-c</samp>’</span></dt> +<dt><span>‘<samp>ictcp</samp>’</span></dt> +</dl> +</dd> +</dl> + +<a name="sharpen_005fnpp"></a> +<h3 class="section">11.224 sharpen_npp<span class="pull-right"><a class="anchor hidden-xs" href="#sharpen_005fnpp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sharpen_005fnpp" aria-hidden="true">TOC</a></span></h3> +<p>Use the NVIDIA Performance Primitives (libnpp) to perform image sharpening with +border control. +</p> +<p>The following additional options are accepted: +</p><dl compact="compact"> +<dt><span><samp>border_type</samp></span></dt> +<dd><p>Type of sampling to be used ad frame borders. One of the following: +</p><dl compact="compact"> +<dt><span><samp>replicate</samp></span></dt> +<dd><p>Replicate pixel values. +</p> +</dd> +</dl> +</dd> +</dl> + +<a name="shear"></a> +<h3 class="section">11.225 shear<span class="pull-right"><a class="anchor hidden-xs" href="#shear" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-shear" aria-hidden="true">TOC</a></span></h3> +<p>Apply shear transform to input video. +</p> +<p>This filter supports the following options: +</p> +<dl compact="compact"> +<dt><span><samp>shx</samp></span></dt> +<dd><p>Shear factor in X-direction. Default value is 0. +Allowed range is from -2 to 2. +</p> +</dd> +<dt><span><samp>shy</samp></span></dt> +<dd><p>Shear factor in Y-direction. Default value is 0. +Allowed range is from -2 to 2. +</p> +</dd> +<dt><span><samp>fillcolor, c</samp></span></dt> +<dd><p>Set the color used to fill the output area not covered by the transformed +video. For the general syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +</p> +<p>Default value is "black". +</p> +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Set interpolation type. Can be <code>bilinear</code> or <code>nearest</code>. Default is <code>bilinear</code>. +</p></dd> +</dl> + +<a name="Commands-139"></a> +<h4 class="subsection">11.225.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-139" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-139" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="showinfo"></a> +<h3 class="section">11.226 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>This filter supports the following options: +</p> +<dl compact="compact"> +<dt><span><samp>checksum</samp></span></dt> +<dd><p>Calculate checksums of each plane. By default enabled. +</p></dd> +</dl> + +<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><span><samp>n</samp></span></dt> +<dd><p>The (sequential) number of the input frame, starting from 0. +</p> +</dd> +<dt><span><samp>pts</samp></span></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><span><samp>pts_time</samp></span></dt> +<dd><p>The Presentation TimeStamp of the input frame, expressed as a number of +seconds. +</p> +</dd> +<dt><span><samp>pos</samp></span></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><span><samp>fmt</samp></span></dt> +<dd><p>The pixel format name. +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>The sample aspect ratio of the input frame, expressed in the form +<var>num</var>/<var>den</var>. +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>The size of the input frame. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>i</samp></span></dt> +<dd><p>The type of interlaced mode ("P" for "progressive", "T" for top field first, "B" +for bottom field first). +</p> +</dd> +<dt><span><samp>iskey</samp></span></dt> +<dd><p>This is 1 if the frame is a key frame, 0 otherwise. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>The picture type of the input frame ("I" for an I-frame, "P" for a +P-frame, "B" for a B-frame, or "?" 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><span><samp>checksum</samp></span></dt> +<dd><p>The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame. +</p> +</dd> +<dt><span><samp>plane_checksum</samp></span></dt> +<dd><p>The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, +expressed in the form "[<var>c0</var> <var>c1</var> <var>c2</var> <var>c3</var>]". +</p> +</dd> +<dt><span><samp>mean</samp></span></dt> +<dd><p>The mean value of pixels in each plane of the input frame, expressed in the form +"[<var>mean0</var> <var>mean1</var> <var>mean2</var> <var>mean3</var>]". +</p> +</dd> +<dt><span><samp>stdev</samp></span></dt> +<dd><p>The standard deviation of pixel values in each plane of the input frame, expressed +in the form "[<var>stdev0</var> <var>stdev1</var> <var>stdev2</var> <var>stdev3</var>]". +</p> +</dd> +</dl> + +<a name="showpalette"></a> +<h3 class="section">11.227 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><span><samp>s</samp></span></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">11.228 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 and/or drop video frames. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>mapping</samp></span></dt> +<dd><p>Set the destination indexes of input frames. +This is space or ’|’ separated list of indexes that maps input frames to output +frames. Number of indexes also sets maximal value that each index may have. +’-1’ index have special meaning and that is to drop frame. +</p></dd> +</dl> + +<p>The first frame has the index 0. The default is to keep the input unchanged. +</p> +<a name="Examples-117"></a> +<h4 class="subsection">11.228.1 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> Swap second and third frame of every three frames of the input: +<div class="example"> +<pre class="example">ffmpeg -i INPUT -vf "shuffleframes=0 2 1" 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 "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT +</pre></div> +</li></ul> + +<a name="shufflepixels"></a> +<h3 class="section">11.229 shufflepixels<span class="pull-right"><a class="anchor hidden-xs" href="#shufflepixels" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-shufflepixels" aria-hidden="true">TOC</a></span></h3> + +<p>Reorder pixels in video frames. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>direction, d</samp></span></dt> +<dd><p>Set shuffle direction. Can be forward or inverse direction. +Default direction is forward. +</p> +</dd> +<dt><span><samp>mode, m</samp></span></dt> +<dd><p>Set shuffle mode. Can be horizontal, vertical or block mode. +</p> +</dd> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></dt> +<dd><p>Set shuffle block_size. In case of horizontal shuffle mode only width +part of size is used, and in case of vertical shuffle mode only height +part of size is used. +</p> +</dd> +<dt><span><samp>seed, s</samp></span></dt> +<dd><p>Set random seed used with shuffling pixels. Mainly useful to set to be able +to reverse filtering process to get original input. +For example, to reverse forward shuffle you need to use same parameters +and exact same seed and to set direction to inverse. +</p></dd> +</dl> + +<a name="shuffleplanes"></a> +<h3 class="section">11.230 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><span><samp>map0</samp></span></dt> +<dd><p>The index of the input plane to be used as the first output plane. +</p> +</dd> +<dt><span><samp>map1</samp></span></dt> +<dd><p>The index of the input plane to be used as the second output plane. +</p> +</dd> +<dt><span><samp>map2</samp></span></dt> +<dd><p>The index of the input plane to be used as the third output plane. +</p> +</dd> +<dt><span><samp>map3</samp></span></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-118"></a> +<h4 class="subsection">11.230.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> 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> + +<span id="signalstats"></span><a name="signalstats-1"></a> +<h3 class="section">11.231 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><span><samp>YMIN</samp></span></dt> +<dd><p>Display the minimal Y value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>YLOW</samp></span></dt> +<dd><p>Display the Y value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>YAVG</samp></span></dt> +<dd><p>Display the average Y value within the input frame. Expressed in range of +[0-255]. +</p> +</dd> +<dt><span><samp>YHIGH</samp></span></dt> +<dd><p>Display the Y value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>YMAX</samp></span></dt> +<dd><p>Display the maximum Y value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>UMIN</samp></span></dt> +<dd><p>Display the minimal U value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>ULOW</samp></span></dt> +<dd><p>Display the U value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>UAVG</samp></span></dt> +<dd><p>Display the average U value within the input frame. Expressed in range of +[0-255]. +</p> +</dd> +<dt><span><samp>UHIGH</samp></span></dt> +<dd><p>Display the U value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>UMAX</samp></span></dt> +<dd><p>Display the maximum U value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>VMIN</samp></span></dt> +<dd><p>Display the minimal V value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>VLOW</samp></span></dt> +<dd><p>Display the V value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>VAVG</samp></span></dt> +<dd><p>Display the average V value within the input frame. Expressed in range of +[0-255]. +</p> +</dd> +<dt><span><samp>VHIGH</samp></span></dt> +<dd><p>Display the V value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>VMAX</samp></span></dt> +<dd><p>Display the maximum V value contained within the input frame. Expressed in +range of [0-255]. +</p> +</dd> +<dt><span><samp>SATMIN</samp></span></dt> +<dd><p>Display the minimal saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +</p> +</dd> +<dt><span><samp>SATLOW</samp></span></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><span><samp>SATAVG</samp></span></dt> +<dd><p>Display the average saturation value within the input frame. Expressed in range +of [0-~181.02]. +</p> +</dd> +<dt><span><samp>SATHIGH</samp></span></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><span><samp>SATMAX</samp></span></dt> +<dd><p>Display the maximum saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +</p> +</dd> +<dt><span><samp>HUEMED</samp></span></dt> +<dd><p>Display the median value for hue within the input frame. Expressed in range of +[0-360]. +</p> +</dd> +<dt><span><samp>HUEAVG</samp></span></dt> +<dd><p>Display the average value for hue within the input frame. Expressed in range of +[0-360]. +</p> +</dd> +<dt><span><samp>YDIF</samp></span></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><span><samp>UDIF</samp></span></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><span><samp>VDIF</samp></span></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><span><samp>YBITDEPTH</samp></span></dt> +<dd><p>Display bit depth of Y plane in current frame. +Expressed in range of [0-16]. +</p> +</dd> +<dt><span><samp>UBITDEPTH</samp></span></dt> +<dd><p>Display bit depth of U plane in current frame. +Expressed in range of [0-16]. +</p> +</dd> +<dt><span><samp>VBITDEPTH</samp></span></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><span><samp>stat</samp></span></dt> +<dt><span><samp>out</samp></span></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><span>‘<samp>tout</samp>’</span></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><span>‘<samp>vrep</samp>’</span></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><span>‘<samp>brng</samp>’</span></dt> +<dd><p>Identify pixels that fall outside of legal broadcast range. +</p></dd> +</dl> + +</dd> +<dt><span><samp>color, c</samp></span></dt> +<dd><p>Set the highlight color for the <samp>out</samp> option. The default color is +yellow. +</p></dd> +</dl> + +<a name="Examples-119"></a> +<h4 class="subsection">11.231.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> Output data of various video metrics: +<div class="example"> +<pre class="example">ffprobe -f lavfi movie=example.mov,signalstats="stat=tout+vrep+brng" -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="out=brng:color=red" +</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> + +<span id="signature"></span><a name="signature-1"></a> +<h3 class="section">11.232 signature<span class="pull-right"><a class="anchor hidden-xs" href="#signature-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-signature-1" aria-hidden="true">TOC</a></span></h3> + +<p>Calculates the MPEG-7 Video Signature. The filter can handle more than one +input. In this case the matching between the inputs can be calculated additionally. +The filter always passes through the first input. The signature of each stream can +be written into a file. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>detectmode</samp></span></dt> +<dd><p>Enable or disable the matching process. +</p> +<p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>off</samp>’</span></dt> +<dd><p>Disable the calculation of a matching (default). +</p></dd> +<dt><span>‘<samp>full</samp>’</span></dt> +<dd><p>Calculate the matching for the whole video and output whether the whole video +matches or only parts. +</p></dd> +<dt><span>‘<samp>fast</samp>’</span></dt> +<dd><p>Calculate only until a matching is found or the video ends. Should be faster in +some cases. +</p></dd> +</dl> + +</dd> +<dt><span><samp>nb_inputs</samp></span></dt> +<dd><p>Set the number of inputs. The option value must be a non negative integer. +Default value is 1. +</p> +</dd> +<dt><span><samp>filename</samp></span></dt> +<dd><p>Set the path to which the output is written. If there is more than one input, +the path must be a prototype, i.e. must contain %d or %0nd (where n is a positive +integer), that will be replaced with the input number. If no filename is +specified, no output will be written. This is the default. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Choose the output format. +</p> +<p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>binary</samp>’</span></dt> +<dd><p>Use the specified binary representation (default). +</p></dd> +<dt><span>‘<samp>xml</samp>’</span></dt> +<dd><p>Use the specified xml representation. +</p></dd> +</dl> + +</dd> +<dt><span><samp>th_d</samp></span></dt> +<dd><p>Set threshold to detect one word as similar. The option value must be an integer +greater than zero. The default value is 9000. +</p> +</dd> +<dt><span><samp>th_dc</samp></span></dt> +<dd><p>Set threshold to detect all words as similar. The option value must be an integer +greater than zero. The default value is 60000. +</p> +</dd> +<dt><span><samp>th_xh</samp></span></dt> +<dd><p>Set threshold to detect frames as similar. The option value must be an integer +greater than zero. The default value is 116. +</p> +</dd> +<dt><span><samp>th_di</samp></span></dt> +<dd><p>Set the minimum length of a sequence in frames to recognize it as matching +sequence. The option value must be a non negative integer value. +The default value is 0. +</p> +</dd> +<dt><span><samp>th_it</samp></span></dt> +<dd><p>Set the minimum relation, that matching frames to all frames must have. +The option value must be a double value between 0 and 1. The default value is 0.5. +</p></dd> +</dl> + +<a name="Examples-120"></a> +<h4 class="subsection">11.232.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> To calculate the signature of an input video and store it in signature.bin: +<div class="example"> +<pre class="example">ffmpeg -i input.mkv -vf signature=filename=signature.bin -map 0:v -f null - +</pre></div> + +</li><li> To detect whether two videos match and store the signatures in XML format in +signature0.xml and signature1.xml: +<div class="example"> +<pre class="example">ffmpeg -i input1.mkv -i input2.mkv -filter_complex "[0:v][1:v] signature=nb_inputs=2:detectmode=full:format=xml:filename=signature%d.xml" -map :v -f null - +</pre></div> + +</li></ul> + +<span id="siti"></span><a name="siti-1"></a> +<h3 class="section">11.233 siti<span class="pull-right"><a class="anchor hidden-xs" href="#siti-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-siti-1" aria-hidden="true">TOC</a></span></h3> + +<p>Calculate Spatial Info (SI) and Temporal Info (TI) scores for a video, as defined +in ITU-T P.910: Subjective video quality assessment methods for multimedia +applications. Available PDF at <a href="https://www.itu.int/rec/T-REC-P.910-199909-S/en">https://www.itu.int/rec/T-REC-P.910-199909-S/en</a>. +</p> +<p>It accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>print_summary</samp></span></dt> +<dd><p>If set to 1, Summary statistics will be printed to the console. Default 0. +</p></dd> +</dl> + +<a name="Examples-121"></a> +<h4 class="subsection">11.233.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> To calculate SI/TI metrics and print summary: +<div class="example"> +<pre class="example">ffmpeg -i input.mp4 -vf siti=print_summary=1 -f null - +</pre></div> +</li></ul> + +<span id="smartblur"></span><a name="smartblur-1"></a> +<h3 class="section">11.234 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><span><samp>luma_radius, lr</samp></span></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><span><samp>luma_strength, ls</samp></span></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><span><samp>luma_threshold, lt</samp></span></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><span><samp>chroma_radius, cr</samp></span></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 <samp>luma_radius</samp>. +</p> +</dd> +<dt><span><samp>chroma_strength, cs</samp></span></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 <samp>luma_strength</samp>. +</p> +</dd> +<dt><span><samp>chroma_threshold, ct</samp></span></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 <samp>luma_threshold</samp>. +</p></dd> +</dl> + +<p>If a chroma option is not explicitly set, the corresponding luma value +is set. +</p> +<a name="sobel"></a> +<h3 class="section">11.235 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><span><samp>planes</samp></span></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><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +</p></dd> +</dl> + +<a name="Commands-140"></a> +<h4 class="subsection">11.235.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-140" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-140" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<span id="spp"></span><a name="spp-1"></a> +<h3 class="section">11.236 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><span><samp>quality</samp></span></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><span><samp>qp</samp></span></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><span><samp>mode</samp></span></dt> +<dd><p>Set thresholding mode. Available modes are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>hard</samp>’</span></dt> +<dd><p>Set hard thresholding (default). +</p></dd> +<dt><span>‘<samp>soft</samp>’</span></dt> +<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier). +</p></dd> +</dl> + +</dd> +<dt><span><samp>use_bframe_qp</samp></span></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="Commands-141"></a> +<h4 class="subsection">11.236.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-141" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-141" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>quality, level</samp></span></dt> +<dd><p>Set quality level. The value <code>max</code> can be used to set the maximum level, +currently <code>6</code>. +</p></dd> +</dl> + +<span id="sr"></span><a name="sr-1"></a> +<h3 class="section">11.237 sr<span class="pull-right"><a class="anchor hidden-xs" href="#sr-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sr-1" aria-hidden="true">TOC</a></span></h3> + +<p>Scale the input by applying one of the super-resolution methods based on +convolutional neural networks. Supported models: +</p> +<ul> +<li> Super-Resolution Convolutional Neural Network model (SRCNN). +See <a href="https://arxiv.org/abs/1501.00092">https://arxiv.org/abs/1501.00092</a>. + +</li><li> Efficient Sub-Pixel Convolutional Neural Network model (ESPCN). +See <a href="https://arxiv.org/abs/1609.05158">https://arxiv.org/abs/1609.05158</a>. +</li></ul> + +<p>Training scripts as well as scripts for model file (.pb) saving can be found at +<a href="https://github.com/XueweiMeng/sr/tree/sr_dnn_native">https://github.com/XueweiMeng/sr/tree/sr_dnn_native</a>. Original repository +is at <a href="https://github.com/HighVoltageRocknRoll/sr.git">https://github.com/HighVoltageRocknRoll/sr.git</a>. +</p> +<p>Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>dnn_backend</samp></span></dt> +<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>native</samp>’</span></dt> +<dd><p>Native implementation of DNN loading and execution. +</p> +</dd> +<dt><span>‘<samp>tensorflow</samp>’</span></dt> +<dd><p>TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +<a href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with +<code>--enable-libtensorflow</code> +</p></dd> +</dl> + +<p>Default value is ‘<samp>native</samp>’. +</p> +</dd> +<dt><span><samp>model</samp></span></dt> +<dd><p>Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow backend +can load files for both formats, while native backend can load files for only +its format. +</p> +</dd> +<dt><span><samp>scale_factor</samp></span></dt> +<dd><p>Set scale factor for SRCNN model. Allowed values are <code>2</code>, <code>3</code> and <code>4</code>. +Default value is <code>2</code>. Scale factor is necessary for SRCNN model, because it accepts +input upscaled using bicubic upscaling with proper scale factor. +</p></dd> +</dl> + +<p>To get full functionality (such as async execution), please use the <a href="#dnn_005fprocessing">dnn_processing</a> filter. +</p> +<a name="ssim"></a> +<h3 class="section">11.238 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 "main" source and is passed unchanged to the +output. The second input is used as a "reference" 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><span><samp>stats_file, f</samp></span></dt> +<dd><p>If specified the filter will use the named file to save the SSIM of +each individual frame. When filename equals "-" 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><span><samp>n</samp></span></dt> +<dd><p>sequential number of the input frame, starting from 1 +</p> +</dd> +<dt><span><samp>Y, U, V, R, G, B</samp></span></dt> +<dd><p>SSIM of the compared frames for the component specified by the suffix. +</p> +</dd> +<dt><span><samp>All</samp></span></dt> +<dd><p>SSIM of the compared frames for the whole frame. +</p> +</dd> +<dt><span><samp>dB</samp></span></dt> +<dd><p>Same as above but in dB representation. +</p></dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="Examples-122"></a> +<h4 class="subsection">11.238.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> For example: +<div class="example"> +<pre class="example">movie=ref_movie.mpg, setpts=PTS-STARTPTS [main]; +[main][ref] ssim="stats_file=stats.log" [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> +</li><li> Another example with both psnr and ssim at same time: +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mpg -lavfi "ssim;[0:v][1:v]psnr" -f null - +</pre></div> + +</li><li> Another example with different containers: +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]ssim" -f null - +</pre></div> +</li></ul> + +<a name="stereo3d"></a> +<h3 class="section">11.239 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><span><samp>in</samp></span></dt> +<dd><p>Set stereoscopic image format of input. +</p> +<p>Available values for input image formats are: +</p><dl compact="compact"> +<dt><span>‘<samp>sbsl</samp>’</span></dt> +<dd><p>side by side parallel (left eye left, right eye right) +</p> +</dd> +<dt><span>‘<samp>sbsr</samp>’</span></dt> +<dd><p>side by side crosseye (right eye left, left eye right) +</p> +</dd> +<dt><span>‘<samp>sbs2l</samp>’</span></dt> +<dd><p>side by side parallel with half width resolution +(left eye left, right eye right) +</p> +</dd> +<dt><span>‘<samp>sbs2r</samp>’</span></dt> +<dd><p>side by side crosseye with half width resolution +(right eye left, left eye right) +</p> +</dd> +<dt><span>‘<samp>abl</samp>’</span></dt> +<dt><span>‘<samp>tbl</samp>’</span></dt> +<dd><p>above-below (left eye above, right eye below) +</p> +</dd> +<dt><span>‘<samp>abr</samp>’</span></dt> +<dt><span>‘<samp>tbr</samp>’</span></dt> +<dd><p>above-below (right eye above, left eye below) +</p> +</dd> +<dt><span>‘<samp>ab2l</samp>’</span></dt> +<dt><span>‘<samp>tb2l</samp>’</span></dt> +<dd><p>above-below with half height resolution +(left eye above, right eye below) +</p> +</dd> +<dt><span>‘<samp>ab2r</samp>’</span></dt> +<dt><span>‘<samp>tb2r</samp>’</span></dt> +<dd><p>above-below with half height resolution +(right eye above, left eye below) +</p> +</dd> +<dt><span>‘<samp>al</samp>’</span></dt> +<dd><p>alternating frames (left eye first, right eye second) +</p> +</dd> +<dt><span>‘<samp>ar</samp>’</span></dt> +<dd><p>alternating frames (right eye first, left eye second) +</p> +</dd> +<dt><span>‘<samp>irl</samp>’</span></dt> +<dd><p>interleaved rows (left eye has top row, right eye starts on next row) +</p> +</dd> +<dt><span>‘<samp>irr</samp>’</span></dt> +<dd><p>interleaved rows (right eye has top row, left eye starts on next row) +</p> +</dd> +<dt><span>‘<samp>icl</samp>’</span></dt> +<dd><p>interleaved columns, left eye first +</p> +</dd> +<dt><span>‘<samp>icr</samp>’</span></dt> +<dd><p>interleaved columns, right eye first +</p> +<p>Default value is ‘<samp>sbsl</samp>’. +</p></dd> +</dl> + +</dd> +<dt><span><samp>out</samp></span></dt> +<dd><p>Set stereoscopic image format of output. +</p> +<dl compact="compact"> +<dt><span>‘<samp>sbsl</samp>’</span></dt> +<dd><p>side by side parallel (left eye left, right eye right) +</p> +</dd> +<dt><span>‘<samp>sbsr</samp>’</span></dt> +<dd><p>side by side crosseye (right eye left, left eye right) +</p> +</dd> +<dt><span>‘<samp>sbs2l</samp>’</span></dt> +<dd><p>side by side parallel with half width resolution +(left eye left, right eye right) +</p> +</dd> +<dt><span>‘<samp>sbs2r</samp>’</span></dt> +<dd><p>side by side crosseye with half width resolution +(right eye left, left eye right) +</p> +</dd> +<dt><span>‘<samp>abl</samp>’</span></dt> +<dt><span>‘<samp>tbl</samp>’</span></dt> +<dd><p>above-below (left eye above, right eye below) +</p> +</dd> +<dt><span>‘<samp>abr</samp>’</span></dt> +<dt><span>‘<samp>tbr</samp>’</span></dt> +<dd><p>above-below (right eye above, left eye below) +</p> +</dd> +<dt><span>‘<samp>ab2l</samp>’</span></dt> +<dt><span>‘<samp>tb2l</samp>’</span></dt> +<dd><p>above-below with half height resolution +(left eye above, right eye below) +</p> +</dd> +<dt><span>‘<samp>ab2r</samp>’</span></dt> +<dt><span>‘<samp>tb2r</samp>’</span></dt> +<dd><p>above-below with half height resolution +(right eye above, left eye below) +</p> +</dd> +<dt><span>‘<samp>al</samp>’</span></dt> +<dd><p>alternating frames (left eye first, right eye second) +</p> +</dd> +<dt><span>‘<samp>ar</samp>’</span></dt> +<dd><p>alternating frames (right eye first, left eye second) +</p> +</dd> +<dt><span>‘<samp>irl</samp>’</span></dt> +<dd><p>interleaved rows (left eye has top row, right eye starts on next row) +</p> +</dd> +<dt><span>‘<samp>irr</samp>’</span></dt> +<dd><p>interleaved rows (right eye has top row, left eye starts on next row) +</p> +</dd> +<dt><span>‘<samp>arbg</samp>’</span></dt> +<dd><p>anaglyph red/blue gray +(red filter on left eye, blue filter on right eye) +</p> +</dd> +<dt><span>‘<samp>argg</samp>’</span></dt> +<dd><p>anaglyph red/green gray +(red filter on left eye, green filter on right eye) +</p> +</dd> +<dt><span>‘<samp>arcg</samp>’</span></dt> +<dd><p>anaglyph red/cyan gray +(red filter on left eye, cyan filter on right eye) +</p> +</dd> +<dt><span>‘<samp>arch</samp>’</span></dt> +<dd><p>anaglyph red/cyan half colored +(red filter on left eye, cyan filter on right eye) +</p> +</dd> +<dt><span>‘<samp>arcc</samp>’</span></dt> +<dd><p>anaglyph red/cyan color +(red filter on left eye, cyan filter on right eye) +</p> +</dd> +<dt><span>‘<samp>arcd</samp>’</span></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><span>‘<samp>agmg</samp>’</span></dt> +<dd><p>anaglyph green/magenta gray +(green filter on left eye, magenta filter on right eye) +</p> +</dd> +<dt><span>‘<samp>agmh</samp>’</span></dt> +<dd><p>anaglyph green/magenta half colored +(green filter on left eye, magenta filter on right eye) +</p> +</dd> +<dt><span>‘<samp>agmc</samp>’</span></dt> +<dd><p>anaglyph green/magenta colored +(green filter on left eye, magenta filter on right eye) +</p> +</dd> +<dt><span>‘<samp>agmd</samp>’</span></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><span>‘<samp>aybg</samp>’</span></dt> +<dd><p>anaglyph yellow/blue gray +(yellow filter on left eye, blue filter on right eye) +</p> +</dd> +<dt><span>‘<samp>aybh</samp>’</span></dt> +<dd><p>anaglyph yellow/blue half colored +(yellow filter on left eye, blue filter on right eye) +</p> +</dd> +<dt><span>‘<samp>aybc</samp>’</span></dt> +<dd><p>anaglyph yellow/blue colored +(yellow filter on left eye, blue filter on right eye) +</p> +</dd> +<dt><span>‘<samp>aybd</samp>’</span></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><span>‘<samp>ml</samp>’</span></dt> +<dd><p>mono output (left eye only) +</p> +</dd> +<dt><span>‘<samp>mr</samp>’</span></dt> +<dd><p>mono output (right eye only) +</p> +</dd> +<dt><span>‘<samp>chl</samp>’</span></dt> +<dd><p>checkerboard, left eye first +</p> +</dd> +<dt><span>‘<samp>chr</samp>’</span></dt> +<dd><p>checkerboard, right eye first +</p> +</dd> +<dt><span>‘<samp>icl</samp>’</span></dt> +<dd><p>interleaved columns, left eye first +</p> +</dd> +<dt><span>‘<samp>icr</samp>’</span></dt> +<dd><p>interleaved columns, right eye first +</p> +</dd> +<dt><span>‘<samp>hdmi</samp>’</span></dt> +<dd><p>HDMI frame pack +</p></dd> +</dl> + +<p>Default value is ‘<samp>arcd</samp>’. +</p></dd> +</dl> + +<a name="Examples-123"></a> +<h4 class="subsection">11.239.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> 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">11.240 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><span><samp>inputs</samp></span></dt> +<dd><p>Set number of inputs. Default is 2. +</p> +</dd> +<dt><span><samp>map</samp></span></dt> +<dd><p>Set input indexes to remap to outputs. +</p></dd> +</dl> + +<a name="Commands-142"></a> +<h4 class="subsection">11.240.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-142" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-142" 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><span><samp>map</samp></span></dt> +<dd><p>Set input indexes to remap to outputs. +</p></dd> +</dl> + +<a name="Examples-124"></a> +<h4 class="subsection">11.240.2 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> 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> + +<span id="subtitles"></span><a name="subtitles-1"></a> +<h3 class="section">11.241 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><span><samp>filename, f</samp></span></dt> +<dd><p>Set the filename of the subtitle file to read. It must be specified. +</p> +</dd> +<dt><span><samp>original_size</samp></span></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 data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" 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><span><samp>fontsdir</samp></span></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><span><samp>alpha</samp></span></dt> +<dd><p>Process alpha channel, by default alpha channel is untouched. +</p> +</dd> +<dt><span><samp>charenc</samp></span></dt> +<dd><p>Set subtitles input character encoding. <code>subtitles</code> filter only. Only +useful if not UTF-8. +</p> +</dd> +<dt><span><samp>stream_index, si</samp></span></dt> +<dd><p>Set subtitles stream index. <code>subtitles</code> filter only. +</p> +</dd> +<dt><span><samp>force_style</samp></span></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 ",". +</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 80% transparent blue +<code>DejaVu Serif</code>, use: +</p><div class="example"> +<pre class="example">subtitles=sub.srt:force_style='Fontname=DejaVu Serif,PrimaryColour=&HCCFF0000' +</pre></div> + +<a name="super2xsai"></a> +<h3 class="section">11.242 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">11.243 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><span><samp>w</samp></span></dt> +<dd><p>Set object width. +</p> +</dd> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set object height. +</p> +</dd> +<dt><span><samp>x1</samp></span></dt> +<dd><p>Set 1st rect x coordinate. +</p> +</dd> +<dt><span><samp>y1</samp></span></dt> +<dd><p>Set 1st rect y coordinate. +</p> +</dd> +<dt><span><samp>x2</samp></span></dt> +<dd><p>Set 2nd rect x coordinate. +</p> +</dd> +<dt><span><samp>y2</samp></span></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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height. +</p> +</dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>same as <var>w</var> / <var>h</var> +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><samp>dar</samp></span></dt> +<dd><p>input display aspect ratio, it is the same as (<var>w</var> / <var>h</var>) * <var>sar</var> +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>The number of the input frame, starting from 0. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +</p> +</dd> +<dt><span><samp>pos</samp></span></dt> +<dd><p>the position in the file of the input frame, NAN if unknown +</p></dd> +</dl> + +<a name="Commands-143"></a> +<h4 class="subsection">11.243.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-143" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-143" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="swapuv"></a> +<h3 class="section">11.244 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 & V plane. +</p> +<a name="tblend"></a> +<h3 class="section">11.245 tblend<span class="pull-right"><a class="anchor hidden-xs" href="#tblend" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tblend" aria-hidden="true">TOC</a></span></h3> +<p>Blend successive video frames. +</p> +<p>See <a href="#blend">blend</a> +</p> +<a name="telecine"></a> +<h3 class="section">11.246 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><span><samp>first_field</samp></span></dt> +<dd><dl compact="compact"> +<dt><span>‘<samp>top, t</samp>’</span></dt> +<dd><p>top field first +</p></dd> +<dt><span>‘<samp>bottom, b</samp>’</span></dt> +<dd><p>bottom field first +The default value is <code>top</code>. +</p></dd> +</dl> + +</dd> +<dt><span><samp>pattern</samp></span></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 ("Euro pulldown") +16.67p: 33 +16p: 33333334 +</pre></div> + +<a name="thistogram"></a> +<h3 class="section">11.247 thistogram<span class="pull-right"><a class="anchor hidden-xs" href="#thistogram" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-thistogram" aria-hidden="true">TOC</a></span></h3> + +<p>Compute and draw a color distribution histogram for the input video across time. +</p> +<p>Unlike <a href="#histogram">histogram</a> video filter which only shows histogram of single input frame +at certain time, this filter shows also past histograms of number of frames defined +by <code>width</code> option. +</p> +<p>The computed histogram is a representation of the color component +distribution in an image. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dd><p>Set width of single color component output. Default value is <code>0</code>. +Value of <code>0</code> means width will be picked from input video. +This also set number of passed histograms to keep. +Allowed range is [0, 8192]. +</p> +</dd> +<dt><span><samp>display_mode, d</samp></span></dt> +<dd><p>Set display mode. +It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>stack</samp>’</span></dt> +<dd><p>Per color component graphs are placed below each other. +</p> +</dd> +<dt><span>‘<samp>parade</samp>’</span></dt> +<dd><p>Per color component graphs are placed side by side. +</p> +</dd> +<dt><span>‘<samp>overlay</samp>’</span></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>stack</code>. +</p> +</dd> +<dt><span><samp>levels_mode, m</samp></span></dt> +<dd><p>Set mode. Can be either <code>linear</code>, or <code>logarithmic</code>. +Default is <code>linear</code>. +</p> +</dd> +<dt><span><samp>components, c</samp></span></dt> +<dd><p>Set what color components to display. +Default is <code>7</code>. +</p> +</dd> +<dt><span><samp>bgopacity, b</samp></span></dt> +<dd><p>Set background opacity. Default is <code>0.9</code>. +</p> +</dd> +<dt><span><samp>envelope, e</samp></span></dt> +<dd><p>Show envelope. Default is disabled. +</p> +</dd> +<dt><span><samp>ecolor, ec</samp></span></dt> +<dd><p>Set envelope color. Default is <code>gold</code>. +</p> +</dd> +<dt><span><samp>slide</samp></span></dt> +<dd><p>Set slide mode. +</p> +<p>Available values for slide is: +</p><dl compact="compact"> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Draw new frame when right border is reached. +</p> +</dd> +<dt><span>‘<samp>replace</samp>’</span></dt> +<dd><p>Replace old columns with new ones. +</p> +</dd> +<dt><span>‘<samp>scroll</samp>’</span></dt> +<dd><p>Scroll from right to left. +</p> +</dd> +<dt><span>‘<samp>rscroll</samp>’</span></dt> +<dd><p>Scroll from left to right. +</p> +</dd> +<dt><span>‘<samp>picture</samp>’</span></dt> +<dd><p>Draw single picture. +</p></dd> +</dl> + +<p>Default is <code>replace</code>. +</p></dd> +</dl> + +<a name="threshold"></a> +<h3 class="section">11.248 threshold<span class="pull-right"><a class="anchor hidden-xs" href="#threshold" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-threshold" aria-hidden="true">TOC</a></span></h3> + +<p>Apply threshold effect to video stream. +</p> +<p>This filter needs four video streams to perform thresholding. +First stream is stream we are filtering. +Second stream is holding threshold values, third stream is holding min values, +and last, fourth stream is holding max values. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></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> +</dl> + +<p>For example if first stream pixel’s component value is less then threshold value +of pixel component from 2nd threshold stream, third stream value will picked, +otherwise fourth stream pixel component value will be picked. +</p> +<p>Using color source filter one can perform various types of thresholding: +</p> +<a name="Commands-144"></a> +<h4 class="subsection">11.248.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-144" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-144" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all options as <a href="#commands">commands</a>. +</p> +<a name="Examples-125"></a> +<h4 class="subsection">11.248.2 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> Binary threshold, using gray color as threshold: +<div class="example"> +<pre class="example">ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=black -f lavfi -i color=white -lavfi threshold output.avi +</pre></div> + +</li><li> Inverted binary threshold, using gray color as threshold: +<div class="example"> +<pre class="example">ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -f lavfi -i color=black -lavfi threshold output.avi +</pre></div> + +</li><li> Truncate binary threshold, using gray color as threshold: +<div class="example"> +<pre class="example">ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=gray -lavfi threshold output.avi +</pre></div> + +</li><li> Threshold to zero, using gray color as threshold: +<div class="example"> +<pre class="example">ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -i 320x240.avi -lavfi threshold output.avi +</pre></div> + +</li><li> Inverted threshold to zero, using gray color as threshold: +<div class="example"> +<pre class="example">ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=white -lavfi threshold output.avi +</pre></div> +</li></ul> + +<a name="thumbnail"></a> +<h3 class="section">11.249 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><span><samp>n</samp></span></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-126"></a> +<h4 class="subsection">11.249.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> 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> + +<span id="tile"></span><a name="tile-1"></a> +<h3 class="section">11.250 tile<span class="pull-right"><a class="anchor hidden-xs" href="#tile-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tile-1" aria-hidden="true">TOC</a></span></h3> + +<p>Tile several successive frames together. +</p> +<p>The <a href="#untile">untile</a> filter can do the reverse. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>layout</samp></span></dt> +<dd><p>Set the grid size in the form <code>COLUMNSxROWS</code>. Range is upto UINT_MAX cells. +Default is <code>6x5</code>. +</p> +</dd> +<dt><span><samp>nb_frames</samp></span></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><span><samp>margin</samp></span></dt> +<dd><p>Set the outer border margin in pixels. Range is 0 to 1024. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>padding</samp></span></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. Range is 0 to 1024. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify the color of the unused area. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +The default value of <var>color</var> is "black". +</p> +</dd> +<dt><span><samp>overlap</samp></span></dt> +<dd><p>Set the number of frames to overlap when tiling several successive frames together. +The value must be between <code>0</code> and <var>nb_frames - 1</var>. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>init_padding</samp></span></dt> +<dd><p>Set the number of frames to initially be empty before displaying first output frame. +This controls how soon will one get first output frame. +The value must be between <code>0</code> and <var>nb_frames - 1</var>. Default is <code>0</code>. +</p></dd> +</dl> + +<a name="Examples-127"></a> +<h4 class="subsection">11.250.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> + +<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">11.251 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><span><samp>mode</samp></span></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><span>‘<samp>merge, 0</samp>’</span></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"> ------> 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><span>‘<samp>drop_even, 1</samp>’</span></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"> ------> 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><span>‘<samp>drop_odd, 2</samp>’</span></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"> ------> 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><span>‘<samp>pad, 3</samp>’</span></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"> ------> 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><span>‘<samp>interleave_top, 4</samp>’</span></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"> ------> 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 +</pre></div> + + +</dd> +<dt><span>‘<samp>interleave_bottom, 5</samp>’</span></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"> ------> 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 +11111 33333 +22222 44444 +11111 33333 +</pre></div> + + +</dd> +<dt><span>‘<samp>interlacex2, 6</samp>’</span></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"> ------> 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><span>‘<samp>mergex2, 7</samp>’</span></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"> ------> 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><span><samp>flags</samp></span></dt> +<dd><p>Specify flags influencing the filter process. +</p> +<p>Available value for <var>flags</var> is: +</p> +<dl compact="compact"> +<dt><span><samp>low_pass_filter, vlpf</samp></span></dt> +<dd><p>Enable linear 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 ’twitter’ and Moire +patterning. +</p> +</dd> +<dt><span><samp>complex_filter, cvlpf</samp></span></dt> +<dd><p>Enable complex vertical low-pass filtering. +This will slightly less reduce interlace ’twitter’ and Moire +patterning but better retain detail and subjective sharpness impression. +</p> +</dd> +<dt><span><samp>bypass_il</samp></span></dt> +<dd><p>Bypass already interlaced frames, only adjust the frame rate. +</p></dd> +</dl> + +<p>Vertical low-pass filtering and bypassing already interlaced frames can only be +enabled for <samp>mode</samp> <var>interleave_top</var> and <var>interleave_bottom</var>. +</p> +</dd> +</dl> + +<a name="tmedian"></a> +<h3 class="section">11.252 tmedian<span class="pull-right"><a class="anchor hidden-xs" href="#tmedian" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tmedian" aria-hidden="true">TOC</a></span></h3> +<p>Pick median pixels from several successive input video frames. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set radius of median filter. +Default is 1. Allowed range is from 1 to 127. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>15</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>percentile</samp></span></dt> +<dd><p>Set median percentile. Default value is <code>0.5</code>. +Default value of <code>0.5</code> will pick always median values, while <code>0</code> will pick +minimum values, and <code>1</code> maximum values. +</p></dd> +</dl> + +<a name="Commands-145"></a> +<h4 class="subsection">11.252.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-145" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-145" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports all above options as <a href="#commands">commands</a>, excluding option <code>radius</code>. +</p> +<a name="tmidequalizer"></a> +<h3 class="section">11.253 tmidequalizer<span class="pull-right"><a class="anchor hidden-xs" href="#tmidequalizer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tmidequalizer" aria-hidden="true">TOC</a></span></h3> + +<p>Apply Temporal Midway Video Equalization effect. +</p> +<p>Midway Video Equalization adjusts a sequence of video frames to have the same +histograms, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a video frames sequence. +</p> +<p>This filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>radius</samp></span></dt> +<dd><p>Set filtering radius. Default is <code>5</code>. Allowed range is from 1 to 127. +</p> +</dd> +<dt><span><samp>sigma</samp></span></dt> +<dd><p>Set filtering sigma. Default is <code>0.5</code>. This controls strength of filtering. +Setting this option to 0 effectively does nothing. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. Default is <code>15</code>, which is all available planes. +</p></dd> +</dl> + +<a name="tmix"></a> +<h3 class="section">11.254 tmix<span class="pull-right"><a class="anchor hidden-xs" href="#tmix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tmix" aria-hidden="true">TOC</a></span></h3> + +<p>Mix successive video frames. +</p> +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>frames</samp></span></dt> +<dd><p>The number of successive frames to mix. If unspecified, it defaults to 3. +</p> +</dd> +<dt><span><samp>weights</samp></span></dt> +<dd><p>Specify weight of each input video frame. +Each weight is separated by space. If number of weights is smaller than +number of <var>frames</var> last specified weight will be used for all remaining +unset weights. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default <var>scale</var> is auto scaled to sum of weights. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15. +</p></dd> +</dl> + +<a name="Examples-128"></a> +<h4 class="subsection">11.254.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> Average 7 successive frames: +<div class="example"> +<pre class="example">tmix=frames=7:weights="1 1 1 1 1 1 1" +</pre></div> + +</li><li> Apply simple temporal convolution: +<div class="example"> +<pre class="example">tmix=frames=3:weights="-1 3 -1" +</pre></div> + +</li><li> Similar as above but only showing temporal differences: +<div class="example"> +<pre class="example">tmix=frames=3:weights="-1 2 -1":scale=1 +</pre></div> +</li></ul> + +<a name="Commands-146"></a> +<h4 class="subsection">11.254.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-146" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-146" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>weights</samp></span></dt> +<dt><span><samp>scale</samp></span></dt> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Syntax is same as option with same name. +</p></dd> +</dl> + +<span id="tonemap"></span><a name="tonemap-1"></a> +<h3 class="section">11.255 tonemap<span class="pull-right"><a class="anchor hidden-xs" href="#tonemap-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tonemap-1" aria-hidden="true">TOC</a></span></h3> +<p>Tone map colors from different dynamic ranges. +</p> +<p>This filter expects data in single precision floating point, as it needs to +operate on (and can output) out-of-range values. Another filter, such as +<a href="#zscale">zscale</a>, is needed to convert the resulting frame to a usable format. +</p> +<p>The tonemapping algorithms implemented only work on linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +</p> +<div class="example"> +<pre class="example">ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT +</pre></div> + +<a name="Options-3"></a> +<h4 class="subsection">11.255.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> +<p>The filter accepts the following options. +</p> +<dl compact="compact"> +<dt><span><samp>tonemap</samp></span></dt> +<dd><p>Set the tone map algorithm to use. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>none</var></span></dt> +<dd><p>Do not apply any tone map, only desaturate overbright pixels. +</p> +</dd> +<dt><span><var>clip</var></span></dt> +<dd><p>Hard-clip any out-of-range values. Use it for perfect color accuracy for +in-range values, while distorting out-of-range values. +</p> +</dd> +<dt><span><var>linear</var></span></dt> +<dd><p>Stretch the entire reference gamut to a linear multiple of the display. +</p> +</dd> +<dt><span><var>gamma</var></span></dt> +<dd><p>Fit a logarithmic transfer between the tone curves. +</p> +</dd> +<dt><span><var>reinhard</var></span></dt> +<dd><p>Preserve overall image brightness with a simple curve, using nonlinear +contrast, which results in flattening details and degrading color accuracy. +</p> +</dd> +<dt><span><var>hable</var></span></dt> +<dd><p>Preserve both dark and bright details better than <var>reinhard</var>, at the cost +of slightly darkening everything. Use it when detail preservation is more +important than color and brightness accuracy. +</p> +</dd> +<dt><span><var>mobius</var></span></dt> +<dd><p>Smoothly map out-of-range values, while retaining contrast and colors for +in-range material as much as possible. Use it when color accuracy is more +important than detail preservation. +</p></dd> +</dl> + +<p>Default is none. +</p> +</dd> +<dt><span><samp>param</samp></span></dt> +<dd><p>Tune the tone mapping algorithm. +</p> +<p>This affects the following algorithms: +</p><dl compact="compact"> +<dt><span><var>none</var></span></dt> +<dd><p>Ignored. +</p> +</dd> +<dt><span><var>linear</var></span></dt> +<dd><p>Specifies the scale factor to use while stretching. +Default to 1.0. +</p> +</dd> +<dt><span><var>gamma</var></span></dt> +<dd><p>Specifies the exponent of the function. +Default to 1.8. +</p> +</dd> +<dt><span><var>clip</var></span></dt> +<dd><p>Specify an extra linear coefficient to multiply into the signal before clipping. +Default to 1.0. +</p> +</dd> +<dt><span><var>reinhard</var></span></dt> +<dd><p>Specify the local contrast coefficient at the display peak. +Default to 0.5, which means that in-gamut values will be about half as bright +as when clipping. +</p> +</dd> +<dt><span><var>hable</var></span></dt> +<dd><p>Ignored. +</p> +</dd> +<dt><span><var>mobius</var></span></dt> +<dd><p>Specify the transition point from linear to mobius transform. Every value +below this point is guaranteed to be mapped 1:1. The higher the value, the +more accurate the result will be, at the cost of losing bright details. +Default to 0.3, which due to the steep initial slope still preserves in-range +colors fairly accurately. +</p></dd> +</dl> + +</dd> +<dt><span><samp>desat</samp></span></dt> +<dd><p>Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +</p> +<p>The default of 2.0 is somewhat conservative and will mostly just apply to +skies or directly sunlit surfaces. A setting of 0.0 disables this option. +</p> +<p>This option works only if the input frame has a supported color tag. +</p> +</dd> +<dt><span><samp>peak</samp></span></dt> +<dd><p>Override signal/nominal/reference peak with this value. Useful when the +embedded peak information in display metadata is not reliable or when tone +mapping from a lower range to a higher range. +</p></dd> +</dl> + +<a name="tpad"></a> +<h3 class="section">11.256 tpad<span class="pull-right"><a class="anchor hidden-xs" href="#tpad" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tpad" aria-hidden="true">TOC</a></span></h3> + +<p>Temporarily pad video frames. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>start</samp></span></dt> +<dd><p>Specify number of delay frames before input video stream. Default is 0. +</p> +</dd> +<dt><span><samp>stop</samp></span></dt> +<dd><p>Specify number of padding frames after input video stream. +Set to -1 to pad indefinitely. Default is 0. +</p> +</dd> +<dt><span><samp>start_mode</samp></span></dt> +<dd><p>Set kind of frames added to beginning of stream. +Can be either <var>add</var> or <var>clone</var>. +With <var>add</var> frames of solid-color are added. +With <var>clone</var> frames are clones of first frame. +Default is <var>add</var>. +</p> +</dd> +<dt><span><samp>stop_mode</samp></span></dt> +<dd><p>Set kind of frames added to end of stream. +Can be either <var>add</var> or <var>clone</var>. +With <var>add</var> frames of solid-color are added. +With <var>clone</var> frames are clones of last frame. +Default is <var>add</var>. +</p> +</dd> +<dt><span><samp>start_duration, stop_duration</samp></span></dt> +<dd><p>Specify the duration of the start/stop delay. See +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#time-duration-syntax">(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual</a> +for the accepted syntax. +These options override <var>start</var> and <var>stop</var>. Default is 0. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify the color of the padded area. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. +</p> +<p>The default value of <var>color</var> is "black". +</p></dd> +</dl> + +<span id="transpose"></span><a name="transpose-1"></a> +<h3 class="section">11.257 transpose<span class="pull-right"><a class="anchor hidden-xs" href="#transpose-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-transpose-1" 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><span><samp>dir</samp></span></dt> +<dd><p>Specify the transposition direction. +</p> +<p>Can assume the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>0, 4, cclock_flip</samp>’</span></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 +. . -> . . +l.r R.r +</pre></div> + +</dd> +<dt><span>‘<samp>1, 5, clock</samp>’</span></dt> +<dd><p>Rotate by 90 degrees clockwise, that is: +</p><div class="example"> +<pre class="example">L.R l.L +. . -> . . +l.r r.R +</pre></div> + +</dd> +<dt><span>‘<samp>2, 6, cclock</samp>’</span></dt> +<dd><p>Rotate by 90 degrees counterclockwise, that is: +</p><div class="example"> +<pre class="example">L.R R.r +. . -> . . +l.r L.l +</pre></div> + +</dd> +<dt><span>‘<samp>3, 7, clock_flip</samp>’</span></dt> +<dd><p>Rotate by 90 degrees clockwise and vertically flip, that is: +</p><div class="example"> +<pre class="example">L.R r.R +. . -> . . +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><span><samp>passthrough</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>Always apply transposition. +</p></dd> +<dt><span>‘<samp>portrait</samp>’</span></dt> +<dd><p>Preserve portrait geometry (when <var>height</var> >= <var>width</var>). +</p></dd> +<dt><span>‘<samp>landscape</samp>’</span></dt> +<dd><p>Preserve landscape geometry (when <var>width</var> >= <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="transpose_005fnpp"></a> +<h3 class="section">11.258 transpose_npp<span class="pull-right"><a class="anchor hidden-xs" href="#transpose_005fnpp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-transpose_005fnpp" aria-hidden="true">TOC</a></span></h3> + +<p>Transpose rows with columns in the input video and optionally flip it. +For more in depth examples see the <a href="#transpose">transpose</a> video filter, which shares mostly the same options. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>dir</samp></span></dt> +<dd><p>Specify the transposition direction. +</p> +<p>Can assume the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>cclock_flip</samp>’</span></dt> +<dd><p>Rotate by 90 degrees counterclockwise and vertically flip. (default) +</p> +</dd> +<dt><span>‘<samp>clock</samp>’</span></dt> +<dd><p>Rotate by 90 degrees clockwise. +</p> +</dd> +<dt><span>‘<samp>cclock</samp>’</span></dt> +<dd><p>Rotate by 90 degrees counterclockwise. +</p> +</dd> +<dt><span>‘<samp>clock_flip</samp>’</span></dt> +<dd><p>Rotate by 90 degrees clockwise and vertically flip. +</p></dd> +</dl> + +</dd> +<dt><span><samp>passthrough</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>Always apply transposition. (default) +</p></dd> +<dt><span>‘<samp>portrait</samp>’</span></dt> +<dd><p>Preserve portrait geometry (when <var>height</var> >= <var>width</var>). +</p></dd> +<dt><span>‘<samp>landscape</samp>’</span></dt> +<dd><p>Preserve landscape geometry (when <var>width</var> >= <var>height</var>). +</p></dd> +</dl> + +</dd> +</dl> + +<a name="trim"></a> +<h3 class="section">11.259 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><span><samp>start</samp></span></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><span><samp>end</samp></span></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><span><samp>start_pts</samp></span></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><span><samp>end_pts</samp></span></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><span><samp>duration</samp></span></dt> +<dd><p>The maximum duration of the output in seconds. +</p> +</dd> +<dt><span><samp>start_frame</samp></span></dt> +<dd><p>The number of the first frame that should be passed to the output. +</p> +</dd> +<dt><span><samp>end_frame</samp></span></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 data-manual="ffmpeg-utils" 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="unpremultiply"></a> +<h3 class="section">11.260 unpremultiply<span class="pull-right"><a class="anchor hidden-xs" href="#unpremultiply" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-unpremultiply" aria-hidden="true">TOC</a></span></h3> +<p>Apply alpha unpremultiply effect to input video stream using first plane +of second stream as alpha. +</p> +<p>Both streams must have same dimensions and same pixel format. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +</p> +<p>If the format has 1 or 2 components, then luma is bit 0. +If the format has 3 or 4 components: +for RGB formats bit 0 is green, bit 1 is blue and bit 2 is red; +for YUV formats bit 0 is luma, bit 1 is chroma-U and bit 2 is chroma-V. +If present, the alpha channel is always the last bit. +</p> +</dd> +<dt><span><samp>inplace</samp></span></dt> +<dd><p>Do not require 2nd input for processing, instead use alpha plane from input stream. +</p></dd> +</dl> + +<span id="unsharp"></span><a name="unsharp-1"></a> +<h3 class="section">11.261 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><span><samp>luma_msize_x, lx</samp></span></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><span><samp>luma_msize_y, ly</samp></span></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><span><samp>luma_amount, la</samp></span></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><span><samp>chroma_msize_x, cx</samp></span></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><span><samp>chroma_msize_y, cy</samp></span></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><span><samp>chroma_amount, ca</samp></span></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><span><samp>alpha_msize_x, ax</samp></span></dt> +<dd><p>Set the alpha matrix horizontal size. It must be an odd integer +between 3 and 23. The default value is 5. +</p> +</dd> +<dt><span><samp>alpha_msize_y, ay</samp></span></dt> +<dd><p>Set the alpha matrix vertical size. It must be an odd integer +between 3 and 23. The default value is 5. +</p> +</dd> +<dt><span><samp>alpha_amount, aa</samp></span></dt> +<dd><p>Set the alpha 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> +</dl> + +<p>All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +</p> +<a name="Examples-129"></a> +<h4 class="subsection">11.261.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-129" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-129" 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> + +<span id="untile"></span><a name="untile-1"></a> +<h3 class="section">11.262 untile<span class="pull-right"><a class="anchor hidden-xs" href="#untile-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-untile-1" aria-hidden="true">TOC</a></span></h3> + +<p>Decompose a video made of tiled images into the individual images. +</p> +<p>The frame rate of the output video is the frame rate of the input video +multiplied by the number of tiles. +</p> +<p>This filter does the reverse of <a href="#tile">tile</a>. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>layout</samp></span></dt> +<dd><p>Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p></dd> +</dl> + +<a name="Examples-130"></a> +<h4 class="subsection">11.262.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-130" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-130" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Produce a 1-second video from a still image file made of 25 frames stacked +vertically, like an analogic film reel: +<div class="example"> +<pre class="example">ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv +</pre></div> +</li></ul> + +<a name="uspp"></a> +<h3 class="section">11.263 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 & +decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8 +DCT similar to MJPEG. +</p> +<p>This filter is only available in ffmpeg version 4.4 or earlier. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>quality</samp></span></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><span><samp>qp</samp></span></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="v360"></a> +<h3 class="section">11.264 v360<span class="pull-right"><a class="anchor hidden-xs" href="#v360" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-v360" aria-hidden="true">TOC</a></span></h3> + +<p>Convert 360 videos between various formats. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>input</samp></span></dt> +<dt><span><samp>output</samp></span></dt> +<dd><p>Set format of the input/output video. +</p> +<p>Available formats: +</p> +<dl compact="compact"> +<dt><span>‘<samp>e</samp>’</span></dt> +<dt><span>‘<samp>equirect</samp>’</span></dt> +<dd><p>Equirectangular projection. +</p> +</dd> +<dt><span>‘<samp>c3x2</samp>’</span></dt> +<dt><span>‘<samp>c6x1</samp>’</span></dt> +<dt><span>‘<samp>c1x6</samp>’</span></dt> +<dd><p>Cubemap with 3x2/6x1/1x6 layout. +</p> +<p>Format specific options: +</p> +<dl compact="compact"> +<dt><span><samp>in_pad</samp></span></dt> +<dt><span><samp>out_pad</samp></span></dt> +<dd><p>Set padding proportion for the input/output cubemap. Values in decimals. +</p> +<p>Example values: +</p><dl compact="compact"> +<dt><span>‘<samp>0</samp>’</span></dt> +<dd><p>No padding. +</p></dd> +<dt><span>‘<samp>0.01</samp>’</span></dt> +<dd><p>1% of face is padding. For example, with 1920x1280 resolution face size would be 640x640 and padding would be 3 pixels from each side. (640 * 0.01 = 6 pixels) +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>0</samp>’</b>. +Maximum value is <b>‘<samp>0.1</samp>’</b>. +</p> +</dd> +<dt><span><samp>fin_pad</samp></span></dt> +<dt><span><samp>fout_pad</samp></span></dt> +<dd><p>Set fixed padding for the input/output cubemap. Values in pixels. +</p> +<p>Default value is <b>‘<samp>0</samp>’</b>. If greater than zero it overrides other padding options. +</p> +</dd> +<dt><span><samp>in_forder</samp></span></dt> +<dt><span><samp>out_forder</samp></span></dt> +<dd><p>Set order of faces for the input/output cubemap. Choose one direction for each position. +</p> +<p>Designation of directions: +</p><dl compact="compact"> +<dt><span>‘<samp>r</samp>’</span></dt> +<dd><p>right +</p></dd> +<dt><span>‘<samp>l</samp>’</span></dt> +<dd><p>left +</p></dd> +<dt><span>‘<samp>u</samp>’</span></dt> +<dd><p>up +</p></dd> +<dt><span>‘<samp>d</samp>’</span></dt> +<dd><p>down +</p></dd> +<dt><span>‘<samp>f</samp>’</span></dt> +<dd><p>forward +</p></dd> +<dt><span>‘<samp>b</samp>’</span></dt> +<dd><p>back +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>rludfb</samp>’</b>. +</p> +</dd> +<dt><span><samp>in_frot</samp></span></dt> +<dt><span><samp>out_frot</samp></span></dt> +<dd><p>Set rotation of faces for the input/output cubemap. Choose one angle for each position. +</p> +<p>Designation of angles: +</p><dl compact="compact"> +<dt><span>‘<samp>0</samp>’</span></dt> +<dd><p>0 degrees clockwise +</p></dd> +<dt><span>‘<samp>1</samp>’</span></dt> +<dd><p>90 degrees clockwise +</p></dd> +<dt><span>‘<samp>2</samp>’</span></dt> +<dd><p>180 degrees clockwise +</p></dd> +<dt><span>‘<samp>3</samp>’</span></dt> +<dd><p>270 degrees clockwise +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>000000</samp>’</b>. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>eac</samp>’</span></dt> +<dd><p>Equi-Angular Cubemap. +</p> +</dd> +<dt><span>‘<samp>flat</samp>’</span></dt> +<dt><span>‘<samp>gnomonic</samp>’</span></dt> +<dt><span>‘<samp>rectilinear</samp>’</span></dt> +<dd><p>Regular video. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>dfisheye</samp>’</span></dt> +<dd><p>Dual fisheye. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>barrel</samp>’</span></dt> +<dt><span>‘<samp>fb</samp>’</span></dt> +<dt><span>‘<samp>barrelsplit</samp>’</span></dt> +<dd><p>Facebook’s 360 formats. +</p> +</dd> +<dt><span>‘<samp>sg</samp>’</span></dt> +<dd><p>Stereographic format. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>mercator</samp>’</span></dt> +<dd><p>Mercator format. +</p> +</dd> +<dt><span>‘<samp>ball</samp>’</span></dt> +<dd><p>Ball format, gives significant distortion toward the back. +</p> +</dd> +<dt><span>‘<samp>hammer</samp>’</span></dt> +<dd><p>Hammer-Aitoff map projection format. +</p> +</dd> +<dt><span>‘<samp>sinusoidal</samp>’</span></dt> +<dd><p>Sinusoidal map projection format. +</p> +</dd> +<dt><span>‘<samp>fisheye</samp>’</span></dt> +<dd><p>Fisheye projection. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>pannini</samp>’</span></dt> +<dd><p>Pannini projection. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dd><p>Set output pannini parameter. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dd><p>Set input pannini parameter. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>cylindrical</samp>’</span></dt> +<dd><p>Cylindrical projection. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>perspective</samp>’</span></dt> +<dd><p>Perspective projection. <i>(output only)</i> +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>v_fov</samp></span></dt> +<dd><p>Set perspective parameter. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>tetrahedron</samp>’</span></dt> +<dd><p>Tetrahedron projection. +</p> +</dd> +<dt><span>‘<samp>tsp</samp>’</span></dt> +<dd><p>Truncated square pyramid projection. +</p> +</dd> +<dt><span>‘<samp>he</samp>’</span></dt> +<dt><span>‘<samp>hequirect</samp>’</span></dt> +<dd><p>Half equirectangular projection. +</p> +</dd> +<dt><span>‘<samp>equisolid</samp>’</span></dt> +<dd><p>Equisolid format. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>og</samp>’</span></dt> +<dd><p>Orthographic format. +</p> +<p>Format specific options: +</p><dl compact="compact"> +<dt><span><samp>h_fov</samp></span></dt> +<dt><span><samp>v_fov</samp></span></dt> +<dt><span><samp>d_fov</samp></span></dt> +<dd><p>Set output horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p> +</dd> +<dt><span><samp>ih_fov</samp></span></dt> +<dt><span><samp>iv_fov</samp></span></dt> +<dt><span><samp>id_fov</samp></span></dt> +<dd><p>Set input horizontal/vertical/diagonal field of view. Values in degrees. +</p> +<p>If diagonal field of view is set it overrides horizontal and vertical field of view. +</p></dd> +</dl> + +</dd> +<dt><span>‘<samp>octahedron</samp>’</span></dt> +<dd><p>Octahedron projection. +</p> +</dd> +<dt><span>‘<samp>cylindricalea</samp>’</span></dt> +<dd><p>Cylindrical Equal Area projection. +</p></dd> +</dl> + +</dd> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Set interpolation method.<br> +<i>Note: more complex interpolation methods require much more memory to run.</i> +</p> +<p>Available methods: +</p> +<dl compact="compact"> +<dt><span>‘<samp>near</samp>’</span></dt> +<dt><span>‘<samp>nearest</samp>’</span></dt> +<dd><p>Nearest neighbour. +</p></dd> +<dt><span>‘<samp>line</samp>’</span></dt> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dd><p>Bilinear interpolation. +</p></dd> +<dt><span>‘<samp>lagrange9</samp>’</span></dt> +<dd><p>Lagrange9 interpolation. +</p></dd> +<dt><span>‘<samp>cube</samp>’</span></dt> +<dt><span>‘<samp>cubic</samp>’</span></dt> +<dd><p>Bicubic interpolation. +</p></dd> +<dt><span>‘<samp>lanc</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dd><p>Lanczos interpolation. +</p></dd> +<dt><span>‘<samp>sp16</samp>’</span></dt> +<dt><span>‘<samp>spline16</samp>’</span></dt> +<dd><p>Spline16 interpolation. +</p></dd> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>gaussian</samp>’</span></dt> +<dd><p>Gaussian interpolation. +</p></dd> +<dt><span>‘<samp>mitchell</samp>’</span></dt> +<dd><p>Mitchell interpolation. +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>line</samp>’</b>. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set the output video resolution. +</p> +<p>Default resolution depends on formats. +</p> +</dd> +<dt><span><samp>in_stereo</samp></span></dt> +<dt><span><samp>out_stereo</samp></span></dt> +<dd><p>Set the input/output stereo format. +</p> +<dl compact="compact"> +<dt><span>‘<samp>2d</samp>’</span></dt> +<dd><p>2D mono +</p></dd> +<dt><span>‘<samp>sbs</samp>’</span></dt> +<dd><p>Side by side +</p></dd> +<dt><span>‘<samp>tb</samp>’</span></dt> +<dd><p>Top bottom +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>2d</samp>’</b> for input and output format. +</p> +</dd> +<dt><span><samp>yaw</samp></span></dt> +<dt><span><samp>pitch</samp></span></dt> +<dt><span><samp>roll</samp></span></dt> +<dd><p>Set rotation for the output video. Values in degrees. +</p> +</dd> +<dt><span><samp>rorder</samp></span></dt> +<dd><p>Set rotation order for the output video. Choose one item for each position. +</p> +<dl compact="compact"> +<dt><span>‘<samp>y, Y</samp>’</span></dt> +<dd><p>yaw +</p></dd> +<dt><span>‘<samp>p, P</samp>’</span></dt> +<dd><p>pitch +</p></dd> +<dt><span>‘<samp>r, R</samp>’</span></dt> +<dd><p>roll +</p></dd> +</dl> + +<p>Default value is <b>‘<samp>ypr</samp>’</b>. +</p> +</dd> +<dt><span><samp>h_flip</samp></span></dt> +<dt><span><samp>v_flip</samp></span></dt> +<dt><span><samp>d_flip</samp></span></dt> +<dd><p>Flip the output video horizontally(swaps left-right)/vertically(swaps up-down)/in-depth(swaps back-forward). Boolean values. +</p> +</dd> +<dt><span><samp>ih_flip</samp></span></dt> +<dt><span><samp>iv_flip</samp></span></dt> +<dd><p>Set if input video is flipped horizontally/vertically. Boolean values. +</p> +</dd> +<dt><span><samp>in_trans</samp></span></dt> +<dd><p>Set if input video is transposed. Boolean value, by default disabled. +</p> +</dd> +<dt><span><samp>out_trans</samp></span></dt> +<dd><p>Set if output video needs to be transposed. Boolean value, by default disabled. +</p> +</dd> +<dt><span><samp>h_offset</samp></span></dt> +<dt><span><samp>v_offset</samp></span></dt> +<dd><p>Set output horizontal/vertical off-axis offset. Default is set to 0. +Allowed range is from -1 to 1. +</p> +</dd> +<dt><span><samp>alpha_mask</samp></span></dt> +<dd><p>Build mask in alpha plane for all unmapped pixels by marking them fully transparent. Boolean value, by default disabled. +</p> +</dd> +<dt><span><samp>reset_rot</samp></span></dt> +<dd><p>Reset rotation of output video. Boolean value, by default disabled. +</p></dd> +</dl> + +<a name="Examples-131"></a> +<h4 class="subsection">11.264.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-131" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-131" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation: +<div class="example"> +<pre class="example">ffmpeg -i input.mkv -vf v360=e:c3x2:cubic:out_pad=0.01 output.mkv +</pre></div> +</li><li> Extract back view of Equi-Angular Cubemap: +<div class="example"> +<pre class="example">ffmpeg -i input.mkv -vf v360=eac:flat:yaw=180 output.mkv +</pre></div> +</li><li> Convert transposed and horizontally flipped Equi-Angular Cubemap in side-by-side stereo format to equirectangular top-bottom stereo format: +<div class="example"> +<pre class="example">v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb +</pre></div> +</li></ul> + +<a name="Commands-147"></a> +<h4 class="subsection">11.264.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-147" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-147" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports subset of above options as <a href="#commands">commands</a>. +</p> +<a name="vaguedenoiser"></a> +<h3 class="section">11.265 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><span><samp>threshold</samp></span></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. Default value is 2. +</p> +</dd> +<dt><span><samp>method</samp></span></dt> +<dd><p>The filtering method the filter will use. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>hard</samp>’</span></dt> +<dd><p>All values under the threshold will be zeroed. +</p> +</dd> +<dt><span>‘<samp>soft</samp>’</span></dt> +<dd><p>All values under the threshold will be zeroed. All values above will be +reduced by the threshold. +</p> +</dd> +<dt><span>‘<samp>garrote</samp>’</span></dt> +<dd><p>Scales or nullifies coefficients - intermediary between (more) soft and +(less) hard thresholding. +</p></dd> +</dl> + +<p>Default is garrote. +</p> +</dd> +<dt><span><samp>nsteps</samp></span></dt> +<dd><p>Number of times, the wavelet will decompose the picture. Picture can’t +be decomposed beyond a particular point (typically, 8 for a 640x480 +frame - as 2^9 = 512 > 480). Valid values are integers between 1 and 32. Default value is 6. +</p> +</dd> +<dt><span><samp>percent</samp></span></dt> +<dd><p>Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>A list of the planes to process. By default all planes are processed. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>The threshold type the filter will use. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>universal</samp>’</span></dt> +<dd><p>Threshold used is same for all decompositions. +</p> +</dd> +<dt><span>‘<samp>bayes</samp>’</span></dt> +<dd><p>Threshold used depends also on each decomposition coefficients. +</p></dd> +</dl> + +<p>Default is universal. +</p></dd> +</dl> + +<a name="varblur"></a> +<h3 class="section">11.266 varblur<span class="pull-right"><a class="anchor hidden-xs" href="#varblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-varblur" aria-hidden="true">TOC</a></span></h3> +<p>Apply variable blur filter by using 2nd video stream to set blur radius. +The 2nd stream must have the same dimensions. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>min_r</samp></span></dt> +<dd><p>Set min allowed radius. Allowed range is from 0 to 254. Default is 0. +</p></dd> +<dt><span><samp>max_r</samp></span></dt> +<dd><p>Set max allowed radius. Allowed range is from 1 to 255. Default is 8. +</p></dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. By default, all are used. +</p></dd> +</dl> + +<p>The <code>varblur</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="Commands-148"></a> +<h4 class="subsection">11.266.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-148" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-148" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports all the above options as <a href="#commands">commands</a>. +</p> +<a name="vectorscope"></a> +<h3 class="section">11.267 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><span><samp>mode, m</samp></span></dt> +<dd><p>Set vectorscope mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>gray</samp>’</span></dt> +<dt><span>‘<samp>tint</samp>’</span></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><span>‘<samp>color</samp>’</span></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><span>‘<samp>color2</samp>’</span></dt> +<dd><p>Actual color components values present in video frame are displayed on graph. +</p> +</dd> +<dt><span>‘<samp>color3</samp>’</span></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><span>‘<samp>color4</samp>’</span></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><span>‘<samp>color5</samp>’</span></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><span><samp>x</samp></span></dt> +<dd><p>Set which color component will be represented on X-axis. Default is <code>1</code>. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set which color component will be represented on Y-axis. Default is <code>2</code>. +</p> +</dd> +<dt><span><samp>intensity, i</samp></span></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><span><samp>envelope, e</samp></span></dt> +<dd><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>No envelope, this is default. +</p> +</dd> +<dt><span>‘<samp>instant</samp>’</span></dt> +<dd><p>Instant envelope, even darkest single pixel will be clearly highlighted. +</p> +</dd> +<dt><span>‘<samp>peak</samp>’</span></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><span>‘<samp>peak+instant</samp>’</span></dt> +<dd><p>Peak and instant envelope combined together. +</p></dd> +</dl> + +</dd> +<dt><span><samp>graticule, g</samp></span></dt> +<dd><p>Set what kind of graticule to draw. +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dt><span>‘<samp>green</samp>’</span></dt> +<dt><span>‘<samp>color</samp>’</span></dt> +<dt><span>‘<samp>invert</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>opacity, o</samp></span></dt> +<dd><p>Set graticule opacity. +</p> +</dd> +<dt><span><samp>flags, f</samp></span></dt> +<dd><p>Set graticule flags. +</p> +<dl compact="compact"> +<dt><span>‘<samp>white</samp>’</span></dt> +<dd><p>Draw graticule for white point. +</p> +</dd> +<dt><span>‘<samp>black</samp>’</span></dt> +<dd><p>Draw graticule for black point. +</p> +</dd> +<dt><span>‘<samp>name</samp>’</span></dt> +<dd><p>Draw color points short names. +</p></dd> +</dl> + +</dd> +<dt><span><samp>bgopacity, b</samp></span></dt> +<dd><p>Set background opacity. +</p> +</dd> +<dt><span><samp>lthreshold, l</samp></span></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><span><samp>hthreshold, h</samp></span></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><span><samp>colorspace, c</samp></span></dt> +<dd><p>Set what kind of colorspace to use when drawing graticule. +</p><dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dt><span>‘<samp>601</samp>’</span></dt> +<dt><span>‘<samp>709</samp>’</span></dt> +</dl> +<p>Default is auto. +</p> +</dd> +<dt><span><samp>tint0, t0</samp></span></dt> +<dt><span><samp>tint1, t1</samp></span></dt> +<dd><p>Set color tint for gray/tint vectorscope mode. By default both options are zero. +This means no tint, and output will remain gray. +</p></dd> +</dl> + +<span id="vidstabdetect"></span><a name="vidstabdetect-1"></a> +<h3 class="section">11.268 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><span><samp>result</samp></span></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><span><samp>shakiness</samp></span></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><span><samp>accuracy</samp></span></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><span><samp>stepsize</samp></span></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><span><samp>mincontrast</samp></span></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><span><samp>tripod</samp></span></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><span><samp>show</samp></span></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-132"></a> +<h4 class="subsection">11.268.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-132" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-132" 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="mytransforms.trf" +</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> + +<span id="vidstabtransform"></span><a name="vidstabtransform-1"></a> +<h3 class="section">11.269 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-4"></a> +<h4 class="subsection">11.269.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><span><samp>input</samp></span></dt> +<dd><p>Set path to the file used to read the transforms. Default value is +<samp>transforms.trf</samp>. +</p> +</dd> +<dt><span><samp>smoothing</samp></span></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><span><samp>optalgo</samp></span></dt> +<dd><p>Set the camera path optimization algorithm. +</p> +<p>Accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dd><p>gaussian kernel low-pass filter on camera motion (default) +</p></dd> +<dt><span>‘<samp>avg</samp>’</span></dt> +<dd><p>averaging on transformations +</p></dd> +</dl> + +</dd> +<dt><span><samp>maxshift</samp></span></dt> +<dd><p>Set maximal number of pixels to translate frames. Default value is -1, +meaning no limit. +</p> +</dd> +<dt><span><samp>maxangle</samp></span></dt> +<dd><p>Set maximal angle in radians (degree*PI/180) to rotate frames. Default +value is -1, meaning no limit. +</p> +</dd> +<dt><span><samp>crop</samp></span></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><span>‘<samp>keep</samp>’</span></dt> +<dd><p>keep image information from previous frame (default) +</p></dd> +<dt><span>‘<samp>black</samp>’</span></dt> +<dd><p>fill the border black +</p></dd> +</dl> + +</dd> +<dt><span><samp>invert</samp></span></dt> +<dd><p>Invert transforms if set to 1. Default value is 0. +</p> +</dd> +<dt><span><samp>relative</samp></span></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><span><samp>zoom</samp></span></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><span><samp>optzoom</samp></span></dt> +<dd><p>Set optimal zooming to avoid borders. +</p> +<p>Accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>0</samp>’</span></dt> +<dd><p>disabled +</p></dd> +<dt><span>‘<samp>1</samp>’</span></dt> +<dd><p>optimal static zoom value is determined (only very strong movements +will lead to visible borders) (default) +</p></dd> +<dt><span>‘<samp>2</samp>’</span></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><span><samp>zoomspeed</samp></span></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><span><samp>interpol</samp></span></dt> +<dd><p>Specify type of interpolation. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>no</samp>’</span></dt> +<dd><p>no interpolation +</p></dd> +<dt><span>‘<samp>linear</samp>’</span></dt> +<dd><p>linear only horizontal +</p></dd> +<dt><span>‘<samp>bilinear</samp>’</span></dt> +<dd><p>linear in both directions (default) +</p></dd> +<dt><span>‘<samp>bicubic</samp>’</span></dt> +<dd><p>cubic in both directions (slow) +</p></dd> +</dl> + +</dd> +<dt><span><samp>tripod</samp></span></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><span><samp>debug</samp></span></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-133"></a> +<h4 class="subsection">11.269.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-133" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-133" 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="mytransforms.trf" +</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">11.270 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 "vflip" out.avi +</pre></div> + +<a name="vfrdet"></a> +<h3 class="section">11.271 vfrdet<span class="pull-right"><a class="anchor hidden-xs" href="#vfrdet" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vfrdet" aria-hidden="true">TOC</a></span></h3> + +<p>Detect variable frame rate video. +</p> +<p>This filter tries to detect if the input is variable or constant frame rate. +</p> +<p>At end it will output number of frames detected as having variable delta pts, +and ones with constant delta pts. +If there was frames with variable delta, than it will also show min, max and +average delta encountered. +</p> +<a name="vibrance"></a> +<h3 class="section">11.272 vibrance<span class="pull-right"><a class="anchor hidden-xs" href="#vibrance" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vibrance" aria-hidden="true">TOC</a></span></h3> + +<p>Boost or alter saturation. +</p> +<p>The filter accepts the following options: +</p><dl compact="compact"> +<dt><span><samp>intensity</samp></span></dt> +<dd><p>Set strength of boost if positive value or strength of alter if negative value. +Default is 0. Allowed range is from -2 to 2. +</p> +</dd> +<dt><span><samp>rbal</samp></span></dt> +<dd><p>Set the red balance. Default is 1. Allowed range is from -10 to 10. +</p> +</dd> +<dt><span><samp>gbal</samp></span></dt> +<dd><p>Set the green balance. Default is 1. Allowed range is from -10 to 10. +</p> +</dd> +<dt><span><samp>bbal</samp></span></dt> +<dd><p>Set the blue balance. Default is 1. Allowed range is from -10 to 10. +</p> +</dd> +<dt><span><samp>rlum</samp></span></dt> +<dd><p>Set the red luma coefficient. +</p> +</dd> +<dt><span><samp>glum</samp></span></dt> +<dd><p>Set the green luma coefficient. +</p> +</dd> +<dt><span><samp>blum</samp></span></dt> +<dd><p>Set the blue luma coefficient. +</p> +</dd> +<dt><span><samp>alternate</samp></span></dt> +<dd><p>If <code>intensity</code> is negative and this is set to 1, colors will change, +otherwise colors will be less saturated, more towards gray. +</p></dd> +</dl> + +<a name="Commands-149"></a> +<h4 class="subsection">11.272.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-149" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-149" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="vif"></a> +<h3 class="section">11.273 vif<span class="pull-right"><a class="anchor hidden-xs" href="#vif" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vif" aria-hidden="true">TOC</a></span></h3> + +<p>Obtain the average VIF (Visual Information Fidelity) between two input videos. +</p> +<p>This filter takes two input videos. +</p> +<p>Both input videos 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 VIF score is printed through the logging system. +</p> +<p>The filter stores the calculated VIF score of each frame. +</p> +<p>In the below example the input file <samp>main.mpg</samp> being processed is compared +with the reference file <samp>ref.mpg</samp>. +</p> +<div class="example"> +<pre class="example">ffmpeg -i main.mpg -i ref.mpg -lavfi vif -f null - +</pre></div> + +<span id="vignette"></span><a name="vignette-1"></a> +<h3 class="section">11.274 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><span><samp>angle, a</samp></span></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>"PI/5"</code> +</p> +</dd> +<dt><span><samp>x0</samp></span></dt> +<dt><span><samp>y0</samp></span></dt> +<dd><p>Set center coordinates expressions. Respectively <code>"w/2"</code> and <code>"h/2"</code> +by default. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set forward/backward mode. +</p> +<p>Available modes are: +</p><dl compact="compact"> +<dt><span>‘<samp>forward</samp>’</span></dt> +<dd><p>The larger the distance from the central point, the darker the image becomes. +</p> +</dd> +<dt><span>‘<samp>backward</samp>’</span></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 ‘<samp>forward</samp>’. +</p> +</dd> +<dt><span><samp>eval</samp></span></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><span>‘<samp>init</samp>’</span></dt> +<dd><p>Evaluate expressions only once during the filter initialization. +</p> +</dd> +<dt><span>‘<samp>frame</samp>’</span></dt> +<dd><p>Evaluate expressions for each incoming frame. This is way slower than the +‘<samp>init</samp>’ mode since it requires all the scalers to be re-computed, but it +allows advanced dynamic expressions. +</p></dd> +</dl> + +<p>Default value is ‘<samp>init</samp>’. +</p> +</dd> +<dt><span><samp>dither</samp></span></dt> +<dd><p>Set dithering to reduce the circular banding effects. Default is <code>1</code> +(enabled). +</p> +</dd> +<dt><span><samp>aspect</samp></span></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">11.274.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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>input width and height +</p> +</dd> +<dt><span><samp>n</samp></span></dt> +<dd><p>the number of input frame, starting from 0 +</p> +</dd> +<dt><span><samp>pts</samp></span></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><span><samp>r</samp></span></dt> +<dd><p>frame rate of the input video, NAN if the input frame rate is unknown +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>the PTS (Presentation TimeStamp) of the filtered video frame, +expressed in seconds, NAN if undefined +</p> +</dd> +<dt><span><samp>tb</samp></span></dt> +<dd><p>time base of the input video +</p></dd> +</dl> + + +<a name="Examples-134"></a> +<h4 class="subsection">11.274.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-134" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-134" 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="vmafmotion"></a> +<h3 class="section">11.275 vmafmotion<span class="pull-right"><a class="anchor hidden-xs" href="#vmafmotion" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vmafmotion" aria-hidden="true">TOC</a></span></h3> + +<p>Obtain the average VMAF motion score of a video. +It is one of the component metrics of VMAF. +</p> +<p>The obtained average motion score is printed through the logging system. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>stats_file</samp></span></dt> +<dd><p>If specified, the filter will use the named file to save the motion score of +each frame with respect to the previous frame. +When filename equals "-" the data is sent to standard output. +</p></dd> +</dl> + +<p>Example: +</p><div class="example"> +<pre class="example">ffmpeg -i ref.mpg -vf vmafmotion -f null - +</pre></div> + +<a name="vstack"></a> +<h3 class="section">11.276 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 accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>Set number of input streams. Default is 2. +</p> +</dd> +<dt><span><samp>shortest</samp></span></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">11.277 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 ("w3fdif" stands for "Weston 3 Field +Deinterlacing Filter"). +</p> +<p>Based on the process described by Martin Weston for BBC R&D, and +implemented based on the de-interlace algorithm written by Jim +Easterbrook for BBC R&D, the Weston 3 field deinterlacing filter +uses filter coefficients calculated by BBC R&D. +</p> +<p>This filter uses 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>w3fdif</code> filter. +</p> +<p>There are two sets of filter coefficients, so called "simple" +and "complex". Which set of filter coefficients is used can +be set by passing an optional parameter: +</p> +<dl compact="compact"> +<dt><span><samp>filter</samp></span></dt> +<dd><p>Set the interlacing filter coefficients. Accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>simple</samp>’</span></dt> +<dd><p>Simple filter coefficient set. +</p></dd> +<dt><span>‘<samp>complex</samp>’</span></dt> +<dd><p>More-complex filter coefficient set. +</p></dd> +</dl> +<p>Default value is ‘<samp>complex</samp>’. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>The interlacing mode to adopt. It accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>frame</samp></span></dt> +<dd><p>Output one frame for each frame. +</p></dd> +<dt><span><samp>field</samp></span></dt> +<dd><p>Output one frame for each field. +</p></dd> +</dl> + +<p>The default value is <code>field</code>. +</p> +</dd> +<dt><span><samp>parity</samp></span></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><span><samp>tff</samp></span></dt> +<dd><p>Assume the top field is first. +</p></dd> +<dt><span><samp>bff</samp></span></dt> +<dd><p>Assume the bottom field is first. +</p></dd> +<dt><span><samp>auto</samp></span></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><span><samp>deint</samp></span></dt> +<dd><p>Specify which frames to deinterlace. Accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span>‘<samp>all</samp>’</span></dt> +<dd><p>Deinterlace all frames, +</p></dd> +<dt><span>‘<samp>interlaced</samp>’</span></dt> +<dd><p>Only deinterlace frames marked as interlaced. +</p></dd> +</dl> + +<p>Default value is ‘<samp>all</samp>’. +</p></dd> +</dl> + +<a name="Commands-150"></a> +<h4 class="subsection">11.277.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-150" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-150" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="waveform"></a> +<h3 class="section">11.278 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><span><samp>mode, m</samp></span></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><span><samp>intensity, i</samp></span></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><span><samp>mirror, r</samp></span></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><span><samp>display, d</samp></span></dt> +<dd><p>Set display mode. +It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>overlay</samp>’</span></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><span>‘<samp>stack</samp>’</span></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><span>‘<samp>parade</samp>’</span></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><span><samp>components, c</samp></span></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><span><samp>envelope, e</samp></span></dt> +<dd><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>No envelope, this is default. +</p> +</dd> +<dt><span>‘<samp>instant</samp>’</span></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><span>‘<samp>peak</samp>’</span></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><span>‘<samp>peak+instant</samp>’</span></dt> +<dd><p>Peak and instant envelope combined together. +</p></dd> +</dl> + +</dd> +<dt><span><samp>filter, f</samp></span></dt> +<dd><dl compact="compact"> +<dt><span>‘<samp>lowpass</samp>’</span></dt> +<dd><p>No filtering, this is default. +</p> +</dd> +<dt><span>‘<samp>flat</samp>’</span></dt> +<dd><p>Luma and chroma combined together. +</p> +</dd> +<dt><span>‘<samp>aflat</samp>’</span></dt> +<dd><p>Similar as above, but shows difference between blue and red chroma. +</p> +</dd> +<dt><span>‘<samp>xflat</samp>’</span></dt> +<dd><p>Similar as above, but use different colors. +</p> +</dd> +<dt><span>‘<samp>yflat</samp>’</span></dt> +<dd><p>Similar as above, but again with different colors. +</p> +</dd> +<dt><span>‘<samp>chroma</samp>’</span></dt> +<dd><p>Displays only chroma. +</p> +</dd> +<dt><span>‘<samp>color</samp>’</span></dt> +<dd><p>Displays actual color value on waveform. +</p> +</dd> +<dt><span>‘<samp>acolor</samp>’</span></dt> +<dd><p>Similar as above, but with luma showing frequency of chroma values. +</p></dd> +</dl> + +</dd> +<dt><span><samp>graticule, g</samp></span></dt> +<dd><p>Set which graticule to display. +</p> +<dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Do not display graticule. +</p> +</dd> +<dt><span>‘<samp>green</samp>’</span></dt> +<dd><p>Display green graticule showing legal broadcast ranges. +</p> +</dd> +<dt><span>‘<samp>orange</samp>’</span></dt> +<dd><p>Display orange graticule showing legal broadcast ranges. +</p> +</dd> +<dt><span>‘<samp>invert</samp>’</span></dt> +<dd><p>Display invert graticule showing legal broadcast ranges. +</p></dd> +</dl> + +</dd> +<dt><span><samp>opacity, o</samp></span></dt> +<dd><p>Set graticule opacity. +</p> +</dd> +<dt><span><samp>flags, fl</samp></span></dt> +<dd><p>Set graticule flags. +</p> +<dl compact="compact"> +<dt><span>‘<samp>numbers</samp>’</span></dt> +<dd><p>Draw numbers above lines. By default enabled. +</p> +</dd> +<dt><span>‘<samp>dots</samp>’</span></dt> +<dd><p>Draw dots instead of lines. +</p></dd> +</dl> + +</dd> +<dt><span><samp>scale, s</samp></span></dt> +<dd><p>Set scale used for displaying graticule. +</p> +<dl compact="compact"> +<dt><span>‘<samp>digital</samp>’</span></dt> +<dt><span>‘<samp>millivolts</samp>’</span></dt> +<dt><span>‘<samp>ire</samp>’</span></dt> +</dl> +<p>Default is digital. +</p> +</dd> +<dt><span><samp>bgopacity, b</samp></span></dt> +<dd><p>Set background opacity. +</p> +</dd> +<dt><span><samp>tint0, t0</samp></span></dt> +<dt><span><samp>tint1, t1</samp></span></dt> +<dd><p>Set tint for output. +Only used with lowpass filter and when display is not overlay and input +pixel formats are not RGB. +</p> +</dd> +<dt><span><samp>fitmode, fm</samp></span></dt> +<dd><p>Set sample aspect ratio of video output frames. +Can be used to configure waveform so it is not +streched too much in one of directions. +</p> +<dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Set sample aspect ration to 1/1. +</p></dd> +<dt><span>‘<samp>size</samp>’</span></dt> +<dd><p>Set sample aspect ratio to match input size of video +</p></dd> +</dl> +<p>Default is ‘<samp>none</samp>’. +</p></dd> +</dl> + +<a name="weave_002c-doubleweave"></a> +<h3 class="section">11.279 weave, doubleweave<span class="pull-right"><a class="anchor hidden-xs" href="#weave_002c-doubleweave" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-weave_002c-doubleweave" 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>The <code>doubleweave</code> works same as <code>weave</code> but without +halving frame rate and frame count. +</p> +<p>It accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>first_field</samp></span></dt> +<dd><p>Set first field. Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>top, t</samp>’</span></dt> +<dd><p>Set the frame as top-field-first. +</p> +</dd> +<dt><span>‘<samp>bottom, b</samp>’</span></dt> +<dd><p>Set the frame as bottom-field-first. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-135"></a> +<h4 class="subsection">11.279.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-135" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-135" 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">11.280 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="https://forums.libretro.com/t/xbr-algorithm-tutorial/123">https://forums.libretro.com/t/xbr-algorithm-tutorial/123</a>. +</p> +<p>It accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>n</samp></span></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="xcorrelate"></a> +<h3 class="section">11.281 xcorrelate<span class="pull-right"><a class="anchor hidden-xs" href="#xcorrelate" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xcorrelate" aria-hidden="true">TOC</a></span></h3> +<p>Apply normalized cross-correlation between first and second input video stream. +</p> +<p>Second input video stream dimensions must be lower than first input video stream. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to process. +</p> +</dd> +<dt><span><samp>secondary</samp></span></dt> +<dd><p>Set which secondary video frames will be processed from second input video stream, +can be <var>first</var> or <var>all</var>. Default is <var>all</var>. +</p></dd> +</dl> + +<p>The <code>xcorrelate</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<a name="xfade"></a> +<h3 class="section">11.282 xfade<span class="pull-right"><a class="anchor hidden-xs" href="#xfade" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xfade" aria-hidden="true">TOC</a></span></h3> + +<p>Apply cross fade from one input video stream to another input video stream. +The cross fade is applied for specified duration. +</p> +<p>Both inputs must be constant frame-rate and have the same resolution, pixel format, +frame rate and timebase. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>transition</samp></span></dt> +<dd><p>Set one of available transition effects: +</p> +<dl compact="compact"> +<dt><span>‘<samp>custom</samp>’</span></dt> +<dt><span>‘<samp>fade</samp>’</span></dt> +<dt><span>‘<samp>wipeleft</samp>’</span></dt> +<dt><span>‘<samp>wiperight</samp>’</span></dt> +<dt><span>‘<samp>wipeup</samp>’</span></dt> +<dt><span>‘<samp>wipedown</samp>’</span></dt> +<dt><span>‘<samp>slideleft</samp>’</span></dt> +<dt><span>‘<samp>slideright</samp>’</span></dt> +<dt><span>‘<samp>slideup</samp>’</span></dt> +<dt><span>‘<samp>slidedown</samp>’</span></dt> +<dt><span>‘<samp>circlecrop</samp>’</span></dt> +<dt><span>‘<samp>rectcrop</samp>’</span></dt> +<dt><span>‘<samp>distance</samp>’</span></dt> +<dt><span>‘<samp>fadeblack</samp>’</span></dt> +<dt><span>‘<samp>fadewhite</samp>’</span></dt> +<dt><span>‘<samp>radial</samp>’</span></dt> +<dt><span>‘<samp>smoothleft</samp>’</span></dt> +<dt><span>‘<samp>smoothright</samp>’</span></dt> +<dt><span>‘<samp>smoothup</samp>’</span></dt> +<dt><span>‘<samp>smoothdown</samp>’</span></dt> +<dt><span>‘<samp>circleopen</samp>’</span></dt> +<dt><span>‘<samp>circleclose</samp>’</span></dt> +<dt><span>‘<samp>vertopen</samp>’</span></dt> +<dt><span>‘<samp>vertclose</samp>’</span></dt> +<dt><span>‘<samp>horzopen</samp>’</span></dt> +<dt><span>‘<samp>horzclose</samp>’</span></dt> +<dt><span>‘<samp>dissolve</samp>’</span></dt> +<dt><span>‘<samp>pixelize</samp>’</span></dt> +<dt><span>‘<samp>diagtl</samp>’</span></dt> +<dt><span>‘<samp>diagtr</samp>’</span></dt> +<dt><span>‘<samp>diagbl</samp>’</span></dt> +<dt><span>‘<samp>diagbr</samp>’</span></dt> +<dt><span>‘<samp>hlslice</samp>’</span></dt> +<dt><span>‘<samp>hrslice</samp>’</span></dt> +<dt><span>‘<samp>vuslice</samp>’</span></dt> +<dt><span>‘<samp>vdslice</samp>’</span></dt> +<dt><span>‘<samp>hblur</samp>’</span></dt> +<dt><span>‘<samp>fadegrays</samp>’</span></dt> +<dt><span>‘<samp>wipetl</samp>’</span></dt> +<dt><span>‘<samp>wipetr</samp>’</span></dt> +<dt><span>‘<samp>wipebl</samp>’</span></dt> +<dt><span>‘<samp>wipebr</samp>’</span></dt> +<dt><span>‘<samp>squeezeh</samp>’</span></dt> +<dt><span>‘<samp>squeezev</samp>’</span></dt> +<dt><span>‘<samp>zoomin</samp>’</span></dt> +<dt><span>‘<samp>fadefast</samp>’</span></dt> +<dt><span>‘<samp>fadeslow</samp>’</span></dt> +</dl> +<p>Default transition effect is fade. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>Set cross fade duration in seconds. +Range is 0 to 60 seconds. +Default duration is 1 second. +</p> +</dd> +<dt><span><samp>offset</samp></span></dt> +<dd><p>Set cross fade start relative to first input stream in seconds. +Default offset is 0. +</p> +</dd> +<dt><span><samp>expr</samp></span></dt> +<dd><p>Set expression for custom transition effect. +</p> +<p>The expressions can use the following variables and functions: +</p> +<dl compact="compact"> +<dt><span><samp>X</samp></span></dt> +<dt><span><samp>Y</samp></span></dt> +<dd><p>The coordinates of the current sample. +</p> +</dd> +<dt><span><samp>W</samp></span></dt> +<dt><span><samp>H</samp></span></dt> +<dd><p>The width and height of the image. +</p> +</dd> +<dt><span><samp>P</samp></span></dt> +<dd><p>Progress of transition effect. +</p> +</dd> +<dt><span><samp>PLANE</samp></span></dt> +<dd><p>Currently processed plane. +</p> +</dd> +<dt><span><samp>A</samp></span></dt> +<dd><p>Return value of first input at current location and plane. +</p> +</dd> +<dt><span><samp>B</samp></span></dt> +<dd><p>Return value of second input at current location and plane. +</p> +</dd> +<dt><span><samp>a0(x, y)</samp></span></dt> +<dt><span><samp>a1(x, y)</samp></span></dt> +<dt><span><samp>a2(x, y)</samp></span></dt> +<dt><span><samp>a3(x, y)</samp></span></dt> +<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the +first/second/third/fourth component of first input. +</p> +</dd> +<dt><span><samp>b0(x, y)</samp></span></dt> +<dt><span><samp>b1(x, y)</samp></span></dt> +<dt><span><samp>b2(x, y)</samp></span></dt> +<dt><span><samp>b3(x, y)</samp></span></dt> +<dd><p>Return the value of the pixel at location (<var>x</var>,<var>y</var>) of the +first/second/third/fourth component of second input. +</p></dd> +</dl> +</dd> +</dl> + +<a name="Examples-136"></a> +<h4 class="subsection">11.282.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-136" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-136" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Cross fade from one input video to another input video, with fade transition and duration of transition +of 2 seconds starting at offset of 5 seconds: +<div class="example"> +<pre class="example">ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4 +</pre></div> +</li></ul> + +<a name="xmedian"></a> +<h3 class="section">11.283 xmedian<span class="pull-right"><a class="anchor hidden-xs" href="#xmedian" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xmedian" aria-hidden="true">TOC</a></span></h3> +<p>Pick median pixels from several input videos. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>Set number of inputs. +Default is 3. Allowed range is from 3 to 255. +If number of inputs is even number, than result will be mean value between two median values. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>15</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>percentile</samp></span></dt> +<dd><p>Set median percentile. Default value is <code>0.5</code>. +Default value of <code>0.5</code> will pick always median values, while <code>0</code> will pick +minimum values, and <code>1</code> maximum values. +</p></dd> +</dl> + +<a name="Commands-151"></a> +<h4 class="subsection">11.283.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-151" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-151" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports all above options as <a href="#commands">commands</a>, excluding option <code>inputs</code>. +</p> +<a name="xstack"></a> +<h3 class="section">11.284 xstack<span class="pull-right"><a class="anchor hidden-xs" href="#xstack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xstack" aria-hidden="true">TOC</a></span></h3> +<p>Stack video inputs into custom layout. +</p> +<p>All streams must be of same pixel format. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>Set number of input streams. Default is 2. +</p> +</dd> +<dt><span><samp>layout</samp></span></dt> +<dd><p>Specify layout of inputs. +This option requires the desired layout configuration to be explicitly set by the user. +This sets position of each video input in output. Each input +is separated by ’|’. +The first number represents the column, and the second number represents the row. +Numbers start at 0 and are separated by ’_’. Optionally one can use wX and hX, +where X is video input from which to take width or height. +Multiple values can be used when separated by ’+’. In such +case values are summed together. +</p> +<p>Note that if inputs are of different sizes gaps may appear, as not all of +the output video frame will be filled. Similarly, videos can overlap each +other if their position doesn’t leave enough space for the full frame of +adjoining videos. +</p> +<p>For 2 inputs, a default layout of <code>0_0|w0_0</code> (equivalent to +<code>grid=2x1</code>) is set. In all other cases, a layout or a grid must be set by +the user. Either <code>grid</code> or <code>layout</code> can be specified at a time. +Specifying both will result in an error. +</p> +</dd> +<dt><span><samp>grid</samp></span></dt> +<dd><p>Specify a fixed size grid of inputs. +This option is used to create a fixed size grid of the input streams. Set the +grid size in the form <code>COLUMNSxROWS</code>. There must be <code>ROWS * COLUMNS</code> +input streams and they will be arranged as a grid with <code>ROWS</code> rows and +<code>COLUMNS</code> columns. When using this option, each input stream within a row +must have the same height and all the rows must have the same width. +</p> +<p>If <code>grid</code> is set, then <code>inputs</code> option is ignored and is implicitly +set to <code>ROWS * COLUMNS</code>. +</p> +<p>For 2 inputs, a default grid of <code>2x1</code> (equivalent to +<code>layout=0_0|w0_0</code>) is set. In all other cases, a layout or a grid must be +set by the user. Either <code>grid</code> or <code>layout</code> can be specified at a time. +Specifying both will result in an error. +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +</p> +</dd> +<dt><span><samp>fill</samp></span></dt> +<dd><p>If set to valid color, all unused pixels will be filled with that color. +By default fill is set to none, so it is disabled. +</p></dd> +</dl> + +<a name="Examples-137"></a> +<h4 class="subsection">11.284.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-137" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-137" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Display 4 inputs into 2x2 grid. + +<p>Layout: +</p><div class="example"> +<pre class="example">input1(0, 0) | input3(w0, 0) +input2(0, h0) | input4(w0, h0) +</pre></div> + +<div class="example"> +<pre class="example">xstack=inputs=4:layout=0_0|0_h0|w0_0|w0_h0 +</pre></div> + +<p>Note that if inputs are of different sizes, gaps or overlaps may occur. +</p> +</li><li> Display 4 inputs into 1x4 grid. + +<p>Layout: +</p><div class="example"> +<pre class="example">input1(0, 0) +input2(0, h0) +input3(0, h0+h1) +input4(0, h0+h1+h2) +</pre></div> + +<div class="example"> +<pre class="example">xstack=inputs=4:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2 +</pre></div> + +<p>Note that if inputs are of different widths, unused space will appear. +</p> +</li><li> Display 9 inputs into 3x3 grid. + +<p>Layout: +</p><div class="example"> +<pre class="example">input1(0, 0) | input4(w0, 0) | input7(w0+w3, 0) +input2(0, h0) | input5(w0, h0) | input8(w0+w3, h0) +input3(0, h0+h1) | input6(w0, h0+h1) | input9(w0+w3, h0+h1) +</pre></div> + +<div class="example"> +<pre class="example">xstack=inputs=9:layout=0_0|0_h0|0_h0+h1|w0_0|w0_h0|w0_h0+h1|w0+w3_0|w0+w3_h0|w0+w3_h0+h1 +</pre></div> + +<p>Note that if inputs are of different sizes, gaps or overlaps may occur. +</p> +</li><li> Display 16 inputs into 4x4 grid. + +<p>Layout: +</p><div class="example"> +<pre class="example">input1(0, 0) | input5(w0, 0) | input9 (w0+w4, 0) | input13(w0+w4+w8, 0) +input2(0, h0) | input6(w0, h0) | input10(w0+w4, h0) | input14(w0+w4+w8, h0) +input3(0, h0+h1) | input7(w0, h0+h1) | input11(w0+w4, h0+h1) | input15(w0+w4+w8, h0+h1) +input4(0, h0+h1+h2)| input8(w0, h0+h1+h2)| input12(w0+w4, h0+h1+h2)| input16(w0+w4+w8, h0+h1+h2) +</pre></div> + +<div class="example"> +<pre class="example">xstack=inputs=16:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2|w0_0|w0_h0|w0_h0+h1|w0_h0+h1+h2|w0+w4_0| +w0+w4_h0|w0+w4_h0+h1|w0+w4_h0+h1+h2|w0+w4+w8_0|w0+w4+w8_h0|w0+w4+w8_h0+h1|w0+w4+w8_h0+h1+h2 +</pre></div> + +<p>Note that if inputs are of different sizes, gaps or overlaps may occur. +</p> +</li></ul> + +<span id="yadif"></span><a name="yadif-1"></a> +<h3 class="section">11.285 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 ("yadif" means "yet another deinterlacing +filter"). +</p> +<p>It accepts the following parameters: +</p> + +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>The interlacing mode to adopt. It accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>0, send_frame</samp></span></dt> +<dd><p>Output one frame for each frame. +</p></dd> +<dt><span><samp>1, send_field</samp></span></dt> +<dd><p>Output one frame for each field. +</p></dd> +<dt><span><samp>2, send_frame_nospatial</samp></span></dt> +<dd><p>Like <code>send_frame</code>, but it skips the spatial interlacing check. +</p></dd> +<dt><span><samp>3, send_field_nospatial</samp></span></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><span><samp>parity</samp></span></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><span><samp>0, tff</samp></span></dt> +<dd><p>Assume the top field is first. +</p></dd> +<dt><span><samp>1, bff</samp></span></dt> +<dd><p>Assume the bottom field is first. +</p></dd> +<dt><span><samp>-1, auto</samp></span></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><span><samp>deint</samp></span></dt> +<dd><p>Specify which frames to deinterlace. Accepts one of the following +values: +</p> +<dl compact="compact"> +<dt><span><samp>0, all</samp></span></dt> +<dd><p>Deinterlace all frames. +</p></dd> +<dt><span><samp>1, interlaced</samp></span></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="yadif_005fcuda"></a> +<h3 class="section">11.286 yadif_cuda<span class="pull-right"><a class="anchor hidden-xs" href="#yadif_005fcuda" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-yadif_005fcuda" aria-hidden="true">TOC</a></span></h3> + +<p>Deinterlace the input video using the <a href="#yadif">yadif</a> algorithm, but implemented +in CUDA so that it can work as part of a GPU accelerated pipeline with nvdec +and/or nvenc. +</p> +<p>It accepts the following parameters: +</p> + +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>The interlacing mode to adopt. It accepts one of the following values: +</p> +<dl compact="compact"> +<dt><span><samp>0, send_frame</samp></span></dt> +<dd><p>Output one frame for each frame. +</p></dd> +<dt><span><samp>1, send_field</samp></span></dt> +<dd><p>Output one frame for each field. +</p></dd> +<dt><span><samp>2, send_frame_nospatial</samp></span></dt> +<dd><p>Like <code>send_frame</code>, but it skips the spatial interlacing check. +</p></dd> +<dt><span><samp>3, send_field_nospatial</samp></span></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><span><samp>parity</samp></span></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><span><samp>0, tff</samp></span></dt> +<dd><p>Assume the top field is first. +</p></dd> +<dt><span><samp>1, bff</samp></span></dt> +<dd><p>Assume the bottom field is first. +</p></dd> +<dt><span><samp>-1, auto</samp></span></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><span><samp>deint</samp></span></dt> +<dd><p>Specify which frames to deinterlace. Accepts one of the following +values: +</p> +<dl compact="compact"> +<dt><span><samp>0, all</samp></span></dt> +<dd><p>Deinterlace all frames. +</p></dd> +<dt><span><samp>1, interlaced</samp></span></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="yaepblur"></a> +<h3 class="section">11.287 yaepblur<span class="pull-right"><a class="anchor hidden-xs" href="#yaepblur" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-yaepblur" aria-hidden="true">TOC</a></span></h3> + +<p>Apply blur filter while preserving edges ("yaepblur" means "yet another edge preserving blur filter"). +The algorithm is described in +"J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern Anal. Mach. Intell. PAMI-2, 1980." +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>radius, r</samp></span></dt> +<dd><p>Set the window radius. Default value is 3. +</p> +</dd> +<dt><span><samp>planes, p</samp></span></dt> +<dd><p>Set which planes to filter. Default is only the first plane. +</p> +</dd> +<dt><span><samp>sigma, s</samp></span></dt> +<dd><p>Set blur strength. Default value is 128. +</p></dd> +</dl> + +<a name="Commands-152"></a> +<h4 class="subsection">11.287.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-152" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-152" aria-hidden="true">TOC</a></span></h4> +<p>This filter supports same <a href="#commands">commands</a> as options. +</p> +<a name="zoompan"></a> +<h3 class="section">11.288 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 & Pan effect. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>zoom, z</samp></span></dt> +<dd><p>Set the zoom expression. Range is 1-10. Default is 1. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set the x and y expression. Default is 0. +</p> +</dd> +<dt><span><samp>d</samp></span></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. Default is 90. +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>Set the output image size, default is ’hd720’. +</p> +</dd> +<dt><span><samp>fps</samp></span></dt> +<dd><p>Set the output frame rate, default is ’25’. +</p></dd> +</dl> + +<p>Each expression can contain the following constants: +</p> +<dl compact="compact"> +<dt><span><samp>in_w, iw</samp></span></dt> +<dd><p>Input width. +</p> +</dd> +<dt><span><samp>in_h, ih</samp></span></dt> +<dd><p>Input height. +</p> +</dd> +<dt><span><samp>out_w, ow</samp></span></dt> +<dd><p>Output width. +</p> +</dd> +<dt><span><samp>out_h, oh</samp></span></dt> +<dd><p>Output height. +</p> +</dd> +<dt><span><samp>in</samp></span></dt> +<dd><p>Input frame count. +</p> +</dd> +<dt><span><samp>on</samp></span></dt> +<dd><p>Output frame count. +</p> +</dd> +<dt><span><samp>in_time, it</samp></span></dt> +<dd><p>The input timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +</p> +</dd> +<dt><span><samp>out_time, time, ot</samp></span></dt> +<dd><p>The output timestamp expressed in seconds. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression +for current input frame. +</p> +</dd> +<dt><span><samp>px</samp></span></dt> +<dt><span><samp>py</samp></span></dt> +<dd><p>’x’ and ’y’ of last output frame of previous input frame or 0 when there was +not yet such frame (first input frame). +</p> +</dd> +<dt><span><samp>zoom</samp></span></dt> +<dd><p>Last calculated zoom from ’z’ expression for current input frame. +</p> +</dd> +<dt><span><samp>pzoom</samp></span></dt> +<dd><p>Last calculated zoom of last output frame of previous input frame. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>Number of output frames for current input frame. Calculated from ’d’ expression +for each input frame. +</p> +</dd> +<dt><span><samp>pduration</samp></span></dt> +<dd><p>number of output frames created for previous input frame +</p> +</dd> +<dt><span><samp>a</samp></span></dt> +<dd><p>Rational number: input width / input height +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>sample aspect ratio +</p> +</dd> +<dt><span><samp>dar</samp></span></dt> +<dd><p>display aspect ratio +</p> +</dd> +</dl> + +<a name="Examples-138"></a> +<h4 class="subsection">11.288.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-138" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-138" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Zoom in up to 1.5x 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.5x 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><li> Zoom in 2x into center of picture only for the first second of the input video: +<div class="example"> +<pre class="example">zoompan=z='if(between(in_time,0,1),2,1)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)' +</pre></div> + +</li></ul> + +<span id="zscale"></span><a name="zscale-1"></a> +<h3 class="section">11.289 zscale<span class="pull-right"><a class="anchor hidden-xs" href="#zscale-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-zscale-1" aria-hidden="true">TOC</a></span></h3> +<p>Scale (resize) the input video, using the z.lib library: +<a href="https://github.com/sekrit-twc/zimg">https://github.com/sekrit-twc/zimg</a>. To enable compilation of this +filter, you need to configure FFmpeg with <code>--enable-libzimg</code>. +</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-5"></a> +<h4 class="subsection">11.289.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> +<p>The filter accepts the following options. +</p> +<dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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> value is 0, the input width is used for +the output. If the <var>height</var> or <var>h</var> value is 0, the input height +is used for the output. +</p> +<p>If one and only one of the values is -n with n >= 1, the zscale filter +will 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>If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +</p> +<p>See below for the list of accepted constants for use in the dimension +expression. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set the video size. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>dither, d</samp></span></dt> +<dd><p>Set the dither type. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>none</var></span></dt> +<dt><span><var>ordered</var></span></dt> +<dt><span><var>random</var></span></dt> +<dt><span><var>error_diffusion</var></span></dt> +</dl> + +<p>Default is none. +</p> +</dd> +<dt><span><samp>filter, f</samp></span></dt> +<dd><p>Set the resize filter type. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>point</var></span></dt> +<dt><span><var>bilinear</var></span></dt> +<dt><span><var>bicubic</var></span></dt> +<dt><span><var>spline16</var></span></dt> +<dt><span><var>spline36</var></span></dt> +<dt><span><var>lanczos</var></span></dt> +</dl> + +<p>Default is bilinear. +</p> +</dd> +<dt><span><samp>range, r</samp></span></dt> +<dd><p>Set the color range. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>limited</var></span></dt> +<dt><span><var>full</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>primaries, p</samp></span></dt> +<dd><p>Set the color primaries. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>170m</var></span></dt> +<dt><span><var>240m</var></span></dt> +<dt><span><var>2020</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>transfer, t</samp></span></dt> +<dd><p>Set the transfer characteristics. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>601</var></span></dt> +<dt><span><var>linear</var></span></dt> +<dt><span><var>2020_10</var></span></dt> +<dt><span><var>2020_12</var></span></dt> +<dt><span><var>smpte2084</var></span></dt> +<dt><span><var>iec61966-2-1</var></span></dt> +<dt><span><var>arib-std-b67</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>matrix, m</samp></span></dt> +<dd><p>Set the colorspace matrix. +</p> +<p>Possible value are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>470bg</var></span></dt> +<dt><span><var>170m</var></span></dt> +<dt><span><var>2020_ncl</var></span></dt> +<dt><span><var>2020_cl</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>rangein, rin</samp></span></dt> +<dd><p>Set the input color range. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>limited</var></span></dt> +<dt><span><var>full</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>primariesin, pin</samp></span></dt> +<dd><p>Set the input color primaries. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>170m</var></span></dt> +<dt><span><var>240m</var></span></dt> +<dt><span><var>2020</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>transferin, tin</samp></span></dt> +<dd><p>Set the input transfer characteristics. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>601</var></span></dt> +<dt><span><var>linear</var></span></dt> +<dt><span><var>2020_10</var></span></dt> +<dt><span><var>2020_12</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>matrixin, min</samp></span></dt> +<dd><p>Set the input colorspace matrix. +</p> +<p>Possible value are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>709</var></span></dt> +<dt><span><var>unspecified</var></span></dt> +<dt><span><var>470bg</var></span></dt> +<dt><span><var>170m</var></span></dt> +<dt><span><var>2020_ncl</var></span></dt> +<dt><span><var>2020_cl</var></span></dt> +</dl> + +</dd> +<dt><span><samp>chromal, c</samp></span></dt> +<dd><p>Set the output chroma location. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>left</var></span></dt> +<dt><span><var>center</var></span></dt> +<dt><span><var>topleft</var></span></dt> +<dt><span><var>top</var></span></dt> +<dt><span><var>bottomleft</var></span></dt> +<dt><span><var>bottom</var></span></dt> +</dl> + +</dd> +<dt><span><samp>chromalin, cin</samp></span></dt> +<dd><p>Set the input chroma location. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>input</var></span></dt> +<dt><span><var>left</var></span></dt> +<dt><span><var>center</var></span></dt> +<dt><span><var>topleft</var></span></dt> +<dt><span><var>top</var></span></dt> +<dt><span><var>bottomleft</var></span></dt> +<dt><span><var>bottom</var></span></dt> +</dl> + +</dd> +<dt><span><samp>npl</samp></span></dt> +<dd><p>Set the nominal peak luminance. +</p> +</dd> +<dt><span><samp>param_a</samp></span></dt> +<dd><p>Parameter A for scaling filters. Parameter "b" for bicubic, and the number of +filter taps for lanczos. +</p> +</dd> +<dt><span><samp>param_b</samp></span></dt> +<dd><p>Parameter B for scaling filters. Parameter "c" for bicubic. +</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><span><var>in_w</var></span></dt> +<dt><span><var>in_h</var></span></dt> +<dd><p>The input width and height +</p> +</dd> +<dt><span><var>iw</var></span></dt> +<dt><span><var>ih</var></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><var>out_w</var></span></dt> +<dt><span><var>out_h</var></span></dt> +<dd><p>The output (scaled) width and height +</p> +</dd> +<dt><span><var>ow</var></span></dt> +<dt><span><var>oh</var></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var> +</p> +</dd> +<dt><span><var>a</var></span></dt> +<dd><p>The same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><var>sar</var></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><var>dar</var></span></dt> +<dd><p>The input display aspect ratio. Calculated from <code>(iw / ih) * sar</code>. +</p> +</dd> +<dt><span><var>hsub</var></span></dt> +<dt><span><var>vsub</var></span></dt> +<dd><p>horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p> +</dd> +<dt><span><var>ohsub</var></span></dt> +<dt><span><var>ovsub</var></span></dt> +<dd><p>horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p></dd> +</dl> + +<a name="Commands-153"></a> +<h4 class="subsection">11.289.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-153" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-153" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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="OpenCL-Video-Filters"></a> +<h2 class="chapter">12 OpenCL Video Filters<span class="pull-right"><a class="anchor hidden-xs" href="#OpenCL-Video-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-OpenCL-Video-Filters" aria-hidden="true">TOC</a></span></h2> + +<p>Below is a description of the currently available OpenCL video filters. +</p> +<p>To enable compilation of these filters you need to configure FFmpeg with +<code>--enable-opencl</code>. +</p> +<p>Running OpenCL filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph. +</p><dl compact="compact"> +<dt><span><samp>-init_hw_device opencl[=<var>name</var>][:<var>device</var>[,<var>key=value</var>...]]</samp></span></dt> +<dd><p>Initialise a new hardware device of type <var>opencl</var> called <var>name</var>, using the +given device parameters. +</p> +</dd> +<dt><span><samp>-filter_hw_device <var>name</var></samp></span></dt> +<dd><p>Pass the hardware device called <var>name</var> to all filters in any filter graph. +</p> +</dd> +</dl> + +<p>For more detailed information see <a href="https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options">https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options</a> +</p> +<ul> +<li> Example of choosing the first device on the second platform and running avgblur_opencl filter with default parameters on it. +<div class="example"> +<pre class="example">-init_hw_device opencl=gpu:1.0 -filter_hw_device gpu -i INPUT -vf "hwupload, avgblur_opencl, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<p>Since OpenCL filters are not able to access frame data in normal memory, all frame data needs to be uploaded(<a href="#hwupload">hwupload</a>) to hardware surfaces connected to the appropriate device before being used and then downloaded(<a href="#hwdownload">hwdownload</a>) back to normal memory. Note that <a href="#hwupload">hwupload</a> will upload to a surface with the same layout as the software frame, so it may be necessary to add a <a href="#format">format</a> filter immediately before to get the input into the right format and <a href="#hwdownload">hwdownload</a> does not support all formats on the output - it may be necessary to insert an additional <a href="#format">format</a> filter immediately following in the graph to get the output in a supported format. +</p> +<a name="avgblur_005fopencl"></a> +<h3 class="section">12.1 avgblur_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#avgblur_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-avgblur_005fopencl" 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><span><samp>sizeX</samp></span></dt> +<dd><p>Set horizontal radius size. +Range is <code>[1, 1024]</code> and default value is <code>1</code>. +</p> +</dd> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>0xf</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>sizeY</samp></span></dt> +<dd><p>Set vertical radius size. Range is <code>[1, 1024]</code> and default value is <code>0</code>. If zero, <code>sizeX</code> value will be used. +</p></dd> +</dl> + +<a name="Example"></a> +<h4 class="subsection">12.1.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply average blur filter with horizontal and vertical size of 3, setting each pixel of the output to the average value of the 7x7 region centered on it in the input. For pixels on the edges of the image, the region does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="boxblur_005fopencl"></a> +<h3 class="section">12.2 boxblur_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#boxblur_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-boxblur_005fopencl" 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><span><samp>luma_radius, lr</samp></span></dt> +<dt><span><samp>luma_power, lp</samp></span></dt> +<dt><span><samp>chroma_radius, cr</samp></span></dt> +<dt><span><samp>chroma_power, cp</samp></span></dt> +<dt><span><samp>alpha_radius, ar</samp></span></dt> +<dt><span><samp>alpha_power, ap</samp></span></dt> +</dl> + +<p>A description of the accepted options follows. +</p> +<dl compact="compact"> +<dt><span><samp>luma_radius, lr</samp></span></dt> +<dt><span><samp>chroma_radius, cr</samp></span></dt> +<dt><span><samp>alpha_radius, ar</samp></span></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 "2". 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><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>The input width and height in pixels. +</p> +</dd> +<dt><span><samp>cw</samp></span></dt> +<dt><span><samp>ch</samp></span></dt> +<dd><p>The input chroma image width and height in pixels. +</p> +</dd> +<dt><span><samp>hsub</samp></span></dt> +<dt><span><samp>vsub</samp></span></dt> +<dd><p>The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", <var>hsub</var> is 2 and <var>vsub</var> is 1. +</p></dd> +</dl> + +</dd> +<dt><span><samp>luma_power, lp</samp></span></dt> +<dt><span><samp>chroma_power, cp</samp></span></dt> +<dt><span><samp>alpha_power, ap</samp></span></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-139"></a> +<h4 class="subsection">12.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-139" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-139" aria-hidden="true">TOC</a></span></h4> + +<p>Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses <var>luma_radius</var>, <var>chroma_radius</var>, <var>alpha_radius</var> for each plane respectively. The filter will apply <var>luma_power</var>, <var>chroma_power</var>, <var>alpha_power</var> times onto the corresponding plane. For pixels on the edges of the image, the radius does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +</p> +<ul> +<li> Apply a boxblur filter with the luma, chroma, and alpha radius +set to 2 and luma, chroma, and alpha power set to 3. The filter will run 3 times with box-radius set to 2 for every plane of the image. +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, boxblur_opencl=luma_radius=2:luma_power=3, hwdownload" OUTPUT +-i INPUT -vf "hwupload, boxblur_opencl=2:3, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply a boxblur filter with luma radius set to 2, luma_power to 1, chroma_radius to 4, chroma_power to 5, alpha_radius to 3 and alpha_power to 7. + +<p>For the luma plane, a 2x2 box radius will be run once. +</p> +<p>For the chroma plane, a 4x4 box radius will be run 5 times. +</p> +<p>For the alpha plane, a 3x3 box radius will be run 7 times. +</p><div class="example"> +<pre class="example">-i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="colorkey_005fopencl"></a> +<h3 class="section">12.3 colorkey_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#colorkey_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-colorkey_005fopencl" 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><span><samp>color</samp></span></dt> +<dd><p>The color which will be replaced with transparency. +</p> +</dd> +<dt><span><samp>similarity</samp></span></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><span><samp>blend</samp></span></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-140"></a> +<h4 class="subsection">12.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-140" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-140" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Make every semi-green pixel in the input transparent with some slight blending: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="convolution_005fopencl"></a> +<h3 class="section">12.4 convolution_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#convolution_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-convolution_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Apply convolution of 3x3, 5x5, 7x7 matrix. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>0m</samp></span></dt> +<dt><span><samp>1m</samp></span></dt> +<dt><span><samp>2m</samp></span></dt> +<dt><span><samp>3m</samp></span></dt> +<dd><p>Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed numbers. +Default value for each plane is <code>0 0 0 0 1 0 0 0 0</code>. +</p> +</dd> +<dt><span><samp>0rdiv</samp></span></dt> +<dt><span><samp>1rdiv</samp></span></dt> +<dt><span><samp>2rdiv</samp></span></dt> +<dt><span><samp>3rdiv</samp></span></dt> +<dd><p>Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +The option value must be a float number greater or equal to <code>0.0</code>. Default value is <code>1.0</code>. +</p> +</dd> +<dt><span><samp>0bias</samp></span></dt> +<dt><span><samp>1bias</samp></span></dt> +<dt><span><samp>2bias</samp></span></dt> +<dt><span><samp>3bias</samp></span></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. +The option value must be a float number greater or equal to <code>0.0</code>. Default value is <code>0.0</code>. +</p> +</dd> +</dl> + +<a name="Examples-141"></a> +<h4 class="subsection">12.4.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-141" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-141" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply sharpen: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=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, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply blur: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=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, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply edge enhance: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=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, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply edge detect: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=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, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply laplacian edge detector which includes diagonals: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply emboss: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, convolution_opencl=-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, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="erosion_005fopencl"></a> +<h3 class="section">12.5 erosion_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#erosion_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-erosion_005fopencl" 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane. Range is <code>[0, 65535]</code> and default value is <code>65535</code>. +If <code>0</code>, plane will remain unchanged. +</p> +</dd> +<dt><span><samp>coordinates</samp></span></dt> +<dd><p>Flag which specifies the pixel to refer to. +Range is <code>[0, 255]</code> and default value is <code>255</code>, i.e. all eight pixels are used. +</p> +<p>Flags to local 3x3 coordinates region centered on <code>x</code>: +</p> +<p>1 2 3 +</p> +<p>4 x 5 +</p> +<p>6 7 8 +</p></dd> +</dl> + +<a name="Example-1"></a> +<h4 class="subsection">12.5.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-1" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply erosion filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local minimum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local minimum is more then threshold of the corresponding plane, output pixel will be set to input pixel - threshold of corresponding plane. +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="deshake_005fopencl"></a> +<h3 class="section">12.6 deshake_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#deshake_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-deshake_005fopencl" aria-hidden="true">TOC</a></span></h3> +<p>Feature-point based video stabilization filter. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>tripod</samp></span></dt> +<dd><p>Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to <code>0</code>. +</p> +</dd> +<dt><span><samp>debug</samp></span></dt> +<dd><p>Whether or not additional debug info should be displayed, both in the processed output and in the console. +</p> +<p>Note that in order to see console debug output you will also need to pass <code>-v verbose</code> to ffmpeg. +</p> +<p>Viewing point matches in the output video is only supported for RGB input. +</p> +<p>Defaults to <code>0</code>. +</p> +</dd> +<dt><span><samp>adaptive_crop</samp></span></dt> +<dd><p>Whether or not to do a tiny bit of cropping at the borders to cut down on the amount of mirrored pixels. +</p> +<p>Defaults to <code>1</code>. +</p> +</dd> +<dt><span><samp>refine_features</samp></span></dt> +<dd><p>Whether or not feature points should be refined at a sub-pixel level. +</p> +<p>This can be turned off for a slight performance gain at the cost of precision. +</p> +<p>Defaults to <code>1</code>. +</p> +</dd> +<dt><span><samp>smooth_strength</samp></span></dt> +<dd><p>The strength of the smoothing applied to the camera path from <code>0.0</code> to <code>1.0</code>. +</p> +<p><code>1.0</code> is the maximum smoothing strength while values less than that result in less smoothing. +</p> +<p><code>0.0</code> causes the filter to adaptively choose a smoothing strength on a per-frame basis. +</p> +<p>Defaults to <code>0.0</code>. +</p> +</dd> +<dt><span><samp>smooth_window_multiplier</samp></span></dt> +<dd><p>Controls the size of the smoothing window (the number of frames buffered to determine motion information from). +</p> +<p>The size of the smoothing window is determined by multiplying the framerate of the video by this number. +</p> +<p>Acceptable values range from <code>0.1</code> to <code>10.0</code>. +</p> +<p>Larger values increase the amount of motion data available for determining how to smooth the camera path, +potentially improving smoothness, but also increase latency and memory usage. +</p> +<p>Defaults to <code>2.0</code>. +</p> +</dd> +</dl> + +<a name="Examples-142"></a> +<h4 class="subsection">12.6.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-142" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-142" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Stabilize a video with a fixed, medium smoothing strength: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, deshake_opencl=smooth_strength=0.5, hwdownload" OUTPUT +</pre></div> + +</li><li> Stabilize a video with debugging (both in console and in rendered video): +<div class="example"> +<pre class="example">-i INPUT -filter_complex "[0:v]format=rgba, hwupload, deshake_opencl=debug=1, hwdownload, format=rgba, format=yuv420p" -v verbose OUTPUT +</pre></div> +</li></ul> + +<a name="dilation_005fopencl"></a> +<h3 class="section">12.7 dilation_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#dilation_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dilation_005fopencl" 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><span><samp>threshold0</samp></span></dt> +<dt><span><samp>threshold1</samp></span></dt> +<dt><span><samp>threshold2</samp></span></dt> +<dt><span><samp>threshold3</samp></span></dt> +<dd><p>Limit the maximum change for each plane. Range is <code>[0, 65535]</code> and default value is <code>65535</code>. +If <code>0</code>, plane will remain unchanged. +</p> +</dd> +<dt><span><samp>coordinates</samp></span></dt> +<dd><p>Flag which specifies the pixel to refer to. +Range is <code>[0, 255]</code> and default value is <code>255</code>, i.e. all eight pixels are used. +</p> +<p>Flags to local 3x3 coordinates region centered on <code>x</code>: +</p> +<p>1 2 3 +</p> +<p>4 x 5 +</p> +<p>6 7 8 +</p></dd> +</dl> + +<a name="Example-2"></a> +<h4 class="subsection">12.7.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-2" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply dilation filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local maximum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local maximum is more then threshold of the corresponding plane, output pixel will be set to input pixel + threshold of corresponding plane. +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="nlmeans_005fopencl"></a> +<h3 class="section">12.8 nlmeans_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#nlmeans_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-nlmeans_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Non-local Means denoise filter through OpenCL, this filter accepts same options as <a href="#nlmeans">nlmeans</a>. +</p> +<a name="overlay_005fopencl"></a> +<h3 class="section">12.9 overlay_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#overlay_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-overlay_005fopencl" 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 "main" video on which the second input is overlaid. +This filter requires same memory layout for all the inputs. So, format conversion may be needed. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dd><p>Set the x coordinate of the overlaid video on the main video. +Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set the y coordinate of the overlaid video on the main video. +Default value is <code>0</code>. +</p> +</dd> +</dl> + +<a name="Examples-143"></a> +<h4 class="subsection">12.9.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-143" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-143" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs are yuv420p format. +<div class="example"> +<pre class="example">-i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT +</pre></div> +</li><li> The inputs have same memory layout for color channels , the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +<div class="example"> +<pre class="example">-i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT +</pre></div> + +</li></ul> + +<a name="pad_005fopencl"></a> +<h3 class="section">12.10 pad_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#pad_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pad_005fopencl" 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 options: +</p> +<dl compact="compact"> +<dt><span><samp>width, w</samp></span></dt> +<dt><span><samp>height, h</samp></span></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><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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> +<p>If <var>x</var> or <var>y</var> evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify the color of the padded area. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. +</p> +</dd> +<dt><span><samp>aspect</samp></span></dt> +<dd><p>Pad to an aspect instead to a resolution. +</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><span><samp>in_w</samp></span></dt> +<dt><span><samp>in_h</samp></span></dt> +<dd><p>The input video width and height. +</p> +</dd> +<dt><span><samp>iw</samp></span></dt> +<dt><span><samp>ih</samp></span></dt> +<dd><p>These are the same as <var>in_w</var> and <var>in_h</var>. +</p> +</dd> +<dt><span><samp>out_w</samp></span></dt> +<dt><span><samp>out_h</samp></span></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><span><samp>ow</samp></span></dt> +<dt><span><samp>oh</samp></span></dt> +<dd><p>These are the same as <var>out_w</var> and <var>out_h</var>. +</p> +</dd> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></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><span><samp>a</samp></span></dt> +<dd><p>same as <var>iw</var> / <var>ih</var> +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>input sample aspect ratio +</p> +</dd> +<dt><span><samp>dar</samp></span></dt> +<dd><p>input display aspect ratio, it is the same as (<var>iw</var> / <var>ih</var>) * <var>sar</var> +</p></dd> +</dl> + +<a name="prewitt_005fopencl"></a> +<h3 class="section">12.11 prewitt_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#prewitt_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-prewitt_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Apply the Prewitt operator (<a href="https://en.wikipedia.org/wiki/Prewitt_operator">https://en.wikipedia.org/wiki/Prewitt_operator</a>) to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>0xf</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +Range is <code>[0.0, 65535]</code> and default value is <code>1.0</code>. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +Range is <code>[-65535, 65535]</code> and default value is <code>0.0</code>. +</p></dd> +</dl> + +<a name="Example-3"></a> +<h4 class="subsection">12.11.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-3" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply the Prewitt operator with scale set to 2 and delta set to 10. +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<span id="program_005fopencl"></span><a name="program_005fopencl-1"></a> +<h3 class="section">12.12 program_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#program_005fopencl-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-program_005fopencl-1" aria-hidden="true">TOC</a></span></h3> + +<p>Filter video using an OpenCL program. +</p> +<dl compact="compact"> +<dt><span><samp>source</samp></span></dt> +<dd><p>OpenCL program source file. +</p> +</dd> +<dt><span><samp>kernel</samp></span></dt> +<dd><p>Kernel name in program. +</p> +</dd> +<dt><span><samp>inputs</samp></span></dt> +<dd><p>Number of inputs to the filter. Defaults to 1. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Size of output frames. Defaults to the same as the first input. +</p> +</dd> +</dl> + +<p>The <code>program_opencl</code> filter also supports the <a href="#framesync">framesync</a> options. +</p> +<p>The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +</p> +<p>The kernel function needs to take the following arguments: +</p><ul> +<li> Destination image, <var>__write_only image2d_t</var>. + +<p>This image will become the output; the kernel should write all of it. +</p></li><li> Frame index, <var>unsigned int</var>. + +<p>This is a counter starting from zero and increasing by one for each frame. +</p></li><li> Source images, <var>__read_only image2d_t</var>. + +<p>These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +</p></li></ul> + +<p>Example programs: +</p> +<ul> +<li> Copy the input to the output (output must be the same size as the input). +<pre class="verbatim">__kernel void copy(__write_only image2d_t destination, + unsigned int index, + __read_only image2d_t source) +{ + const sampler_t sampler = CLK_NORMALIZED_COORDS_FALSE; + + int2 location = (int2)(get_global_id(0), get_global_id(1)); + + float4 value = read_imagef(source, sampler, location); + + write_imagef(destination, location, value); +} +</pre> +</li><li> Apply a simple transformation, rotating the input by an amount increasing +with the index counter. Pixel values are linearly interpolated by the +sampler, and the output need not have the same dimensions as the input. +<pre class="verbatim">__kernel void rotate_image(__write_only image2d_t dst, + unsigned int index, + __read_only image2d_t src) +{ + const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE | + CLK_FILTER_LINEAR); + + float angle = (float)index / 100.0f; + + float2 dst_dim = convert_float2(get_image_dim(dst)); + float2 src_dim = convert_float2(get_image_dim(src)); + + float2 dst_cen = dst_dim / 2.0f; + float2 src_cen = src_dim / 2.0f; + + int2 dst_loc = (int2)(get_global_id(0), get_global_id(1)); + + float2 dst_pos = convert_float2(dst_loc) - dst_cen; + float2 src_pos = { + cos(angle) * dst_pos.x - sin(angle) * dst_pos.y, + sin(angle) * dst_pos.x + cos(angle) * dst_pos.y + }; + src_pos = src_pos * src_dim / dst_dim; + + float2 src_loc = src_pos + src_cen; + + if (src_loc.x < 0.0f || src_loc.y < 0.0f || + src_loc.x > src_dim.x || src_loc.y > src_dim.y) + write_imagef(dst, dst_loc, 0.5f); + else + write_imagef(dst, dst_loc, read_imagef(src, sampler, src_loc)); +} +</pre> +</li><li> Blend two inputs together, with the amount of each input used varying +with the index counter. +<pre class="verbatim">__kernel void blend_images(__write_only image2d_t dst, + unsigned int index, + __read_only image2d_t src1, + __read_only image2d_t src2) +{ + const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE | + CLK_FILTER_LINEAR); + + float blend = (cos((float)index / 50.0f) + 1.0f) / 2.0f; + + int2 dst_loc = (int2)(get_global_id(0), get_global_id(1)); + int2 src1_loc = dst_loc * get_image_dim(src1) / get_image_dim(dst); + int2 src2_loc = dst_loc * get_image_dim(src2) / get_image_dim(dst); + + float4 val1 = read_imagef(src1, sampler, src1_loc); + float4 val2 = read_imagef(src2, sampler, src2_loc); + + write_imagef(dst, dst_loc, val1 * blend + val2 * (1.0f - blend)); +} +</pre> +</li></ul> + +<a name="remap_005fopencl"></a> +<h3 class="section">12.13 remap_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#remap_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-remap_005fopencl" 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 32bit float pixel format, single channel. +</p> +<dl compact="compact"> +<dt><span><samp>interp</samp></span></dt> +<dd><p>Specify interpolation used for remapping of pixels. +Allowed values are <code>near</code> and <code>linear</code>. +Default value is <code>linear</code>. +</p> +</dd> +<dt><span><samp>fill</samp></span></dt> +<dd><p>Specify the color of the unmapped pixels. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils +manual</a>. Default color is <code>black</code>. +</p></dd> +</dl> + +<a name="roberts_005fopencl"></a> +<h3 class="section">12.14 roberts_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#roberts_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-roberts_005fopencl" aria-hidden="true">TOC</a></span></h3> +<p>Apply the Roberts cross operator (<a href="https://en.wikipedia.org/wiki/Roberts_cross">https://en.wikipedia.org/wiki/Roberts_cross</a>) to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>0xf</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +Range is <code>[0.0, 65535]</code> and default value is <code>1.0</code>. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +Range is <code>[-65535, 65535]</code> and default value is <code>0.0</code>. +</p></dd> +</dl> + +<a name="Example-4"></a> +<h4 class="subsection">12.14.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-4" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-4" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply the Roberts cross operator with scale set to 2 and delta set to 10 +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="sobel_005fopencl"></a> +<h3 class="section">12.15 sobel_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#sobel_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sobel_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Apply the Sobel operator (<a href="https://en.wikipedia.org/wiki/Sobel_operator">https://en.wikipedia.org/wiki/Sobel_operator</a>) to input video stream. +</p> +<p>The filter accepts the following option: +</p> +<dl compact="compact"> +<dt><span><samp>planes</samp></span></dt> +<dd><p>Set which planes to filter. Default value is <code>0xf</code>, by which all planes are processed. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set value which will be multiplied with filtered result. +Range is <code>[0.0, 65535]</code> and default value is <code>1.0</code>. +</p> +</dd> +<dt><span><samp>delta</samp></span></dt> +<dd><p>Set value which will be added to filtered result. +Range is <code>[-65535, 65535]</code> and default value is <code>0.0</code>. +</p></dd> +</dl> + +<a name="Example-5"></a> +<h4 class="subsection">12.15.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-5" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply sobel operator with scale set to 2 and delta set to 10 +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="tonemap_005fopencl"></a> +<h3 class="section">12.16 tonemap_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#tonemap_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tonemap_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Perform HDR(PQ/HLG) to SDR conversion with tone-mapping. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>tonemap</samp></span></dt> +<dd><p>Specify the tone-mapping operator to be used. Same as tonemap option in <a href="#tonemap">tonemap</a>. +</p> +</dd> +<dt><span><samp>param</samp></span></dt> +<dd><p>Tune the tone mapping algorithm. same as param option in <a href="#tonemap">tonemap</a>. +</p> +</dd> +<dt><span><samp>desat</samp></span></dt> +<dd><p>Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +</p> +<p>The default value is 0.5, and the algorithm here is a little different from +the cpu version tonemap currently. A setting of 0.0 disables this option. +</p> +</dd> +<dt><span><samp>threshold</samp></span></dt> +<dd><p>The tonemapping algorithm parameters is fine-tuned per each scene. And a threshold +is used to detect whether the scene has changed or not. If the distance between +the current frame average brightness and the current running average exceeds +a threshold value, we would re-calculate scene average and peak brightness. +The default value is 0.2. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Specify the output pixel format. +</p> +<p>Currently supported formats are: +</p><dl compact="compact"> +<dt><span><var>p010</var></span></dt> +<dt><span><var>nv12</var></span></dt> +</dl> + +</dd> +<dt><span><samp>range, r</samp></span></dt> +<dd><p>Set the output color range. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>tv/mpeg</var></span></dt> +<dt><span><var>pc/jpeg</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>primaries, p</samp></span></dt> +<dd><p>Set the output color primaries. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>bt709</var></span></dt> +<dt><span><var>bt2020</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>transfer, t</samp></span></dt> +<dd><p>Set the output transfer characteristics. +</p> +<p>Possible values are: +</p><dl compact="compact"> +<dt><span><var>bt709</var></span></dt> +<dt><span><var>bt2020</var></span></dt> +</dl> + +<p>Default is bt709. +</p> +</dd> +<dt><span><samp>matrix, m</samp></span></dt> +<dd><p>Set the output colorspace matrix. +</p> +<p>Possible value are: +</p><dl compact="compact"> +<dt><span><var>bt709</var></span></dt> +<dt><span><var>bt2020</var></span></dt> +</dl> + +<p>Default is same as input. +</p> +</dd> +</dl> + +<a name="Example-6"></a> +<h4 class="subsection">12.16.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-6" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-6" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator. +<div class="example"> +<pre class="example">-i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT +</pre></div> +</li></ul> + +<a name="unsharp_005fopencl"></a> +<h3 class="section">12.17 unsharp_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#unsharp_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-unsharp_005fopencl" 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><span><samp>luma_msize_x, lx</samp></span></dt> +<dd><p>Set the luma matrix horizontal size. +Range is <code>[1, 23]</code> and default value is <code>5</code>. +</p> +</dd> +<dt><span><samp>luma_msize_y, ly</samp></span></dt> +<dd><p>Set the luma matrix vertical size. +Range is <code>[1, 23]</code> and default value is <code>5</code>. +</p> +</dd> +<dt><span><samp>luma_amount, la</samp></span></dt> +<dd><p>Set the luma effect strength. +Range is <code>[-10, 10]</code> and default value is <code>1.0</code>. +</p> +<p>Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +</p> +</dd> +<dt><span><samp>chroma_msize_x, cx</samp></span></dt> +<dd><p>Set the chroma matrix horizontal size. +Range is <code>[1, 23]</code> and default value is <code>5</code>. +</p> +</dd> +<dt><span><samp>chroma_msize_y, cy</samp></span></dt> +<dd><p>Set the chroma matrix vertical size. +Range is <code>[1, 23]</code> and default value is <code>5</code>. +</p> +</dd> +<dt><span><samp>chroma_amount, ca</samp></span></dt> +<dd><p>Set the chroma effect strength. +Range is <code>[-10, 10]</code> and default value is <code>0.0</code>. +</p> +<p>Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +</p> +</dd> +</dl> + +<p>All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +</p> +<a name="Examples-144"></a> +<h4 class="subsection">12.17.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-144" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-144" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Apply strong luma sharpen effect: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, unsharp_opencl=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5, hwdownload" OUTPUT +</pre></div> + +</li><li> Apply a strong blur of both luma and chroma parameters: +<div class="example"> +<pre class="example">-i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT +</pre></div> +</li></ul> + +<a name="xfade_005fopencl"></a> +<h3 class="section">12.18 xfade_opencl<span class="pull-right"><a class="anchor hidden-xs" href="#xfade_005fopencl" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-xfade_005fopencl" aria-hidden="true">TOC</a></span></h3> + +<p>Cross fade two videos with custom transition effect by using OpenCL. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>transition</samp></span></dt> +<dd><p>Set one of possible transition effects. +</p> +<dl compact="compact"> +<dt><span><samp>custom</samp></span></dt> +<dd><p>Select custom transition effect, the actual transition description +will be picked from source and kernel options. +</p> +</dd> +<dt><span><samp>fade</samp></span></dt> +<dt><span><samp>wipeleft</samp></span></dt> +<dt><span><samp>wiperight</samp></span></dt> +<dt><span><samp>wipeup</samp></span></dt> +<dt><span><samp>wipedown</samp></span></dt> +<dt><span><samp>slideleft</samp></span></dt> +<dt><span><samp>slideright</samp></span></dt> +<dt><span><samp>slideup</samp></span></dt> +<dt><span><samp>slidedown</samp></span></dt> +<dd> +<p>Default transition is fade. +</p></dd> +</dl> + +</dd> +<dt><span><samp>source</samp></span></dt> +<dd><p>OpenCL program source file for custom transition. +</p> +</dd> +<dt><span><samp>kernel</samp></span></dt> +<dd><p>Set name of kernel to use for custom transition from program source file. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>Set duration of video transition. +</p> +</dd> +<dt><span><samp>offset</samp></span></dt> +<dd><p>Set time of start of transition relative to first video. +</p></dd> +</dl> + +<p>The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +</p> +<p>The kernel function needs to take the following arguments: +</p><ul> +<li> Destination image, <var>__write_only image2d_t</var>. + +<p>This image will become the output; the kernel should write all of it. +</p> +</li><li> First Source image, <var>__read_only image2d_t</var>. +Second Source image, <var>__read_only image2d_t</var>. + +<p>These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +</p> +</li><li> Transition progress, <var>float</var>. This value is always between 0 and 1 inclusive. +</li></ul> + +<p>Example programs: +</p> +<ul> +<li> Apply dots curtain transition effect: +<pre class="verbatim">__kernel void blend_images(__write_only image2d_t dst, + __read_only image2d_t src1, + __read_only image2d_t src2, + float progress) +{ + const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE | + CLK_FILTER_LINEAR); + int2 p = (int2)(get_global_id(0), get_global_id(1)); + float2 rp = (float2)(get_global_id(0), get_global_id(1)); + float2 dim = (float2)(get_image_dim(src1).x, get_image_dim(src1).y); + rp = rp / dim; + + float2 dots = (float2)(20.0, 20.0); + float2 center = (float2)(0,0); + float2 unused; + + float4 val1 = read_imagef(src1, sampler, p); + float4 val2 = read_imagef(src2, sampler, p); + bool next = distance(fract(rp * dots, &unused), (float2)(0.5, 0.5)) < (progress / distance(rp, center)); + + write_imagef(dst, p, next ? val1 : val2); +} +</pre> +</li></ul> + + +<a name="VAAPI-Video-Filters"></a> +<h2 class="chapter">13 VAAPI Video Filters<span class="pull-right"><a class="anchor hidden-xs" href="#VAAPI-Video-Filters" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-VAAPI-Video-Filters" aria-hidden="true">TOC</a></span></h2> + +<p>VAAPI Video filters are usually used with VAAPI decoder and VAAPI encoder. Below is a description of VAAPI video filters. +</p> +<p>To enable compilation of these filters you need to configure FFmpeg with +<code>--enable-vaapi</code>. +</p> +<p>To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read <a href="https://trac.ffmpeg.org/wiki/Hardware/VAAPI">https://trac.ffmpeg.org/wiki/Hardware/VAAPI</a> +</p> +<a name="overlay_005fvaapi"></a> +<h3 class="section">13.1 overlay_vaapi<span class="pull-right"><a class="anchor hidden-xs" href="#overlay_005fvaapi" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-overlay_005fvaapi" aria-hidden="true">TOC</a></span></h3> + +<p>Overlay one video on the top of another. +</p> +<p>It takes two inputs and has one output. The first input is the "main" video on which the second input is overlaid. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>x</samp></span></dt> +<dt><span><samp>y</samp></span></dt> +<dd><p>Set expressions for the x and y coordinates of the overlaid video +on the main video. +</p> +<p>Default value is "0" for both expressions. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set expressions for the width and height the overlaid video +on the main video. +</p> +<p>Default values are ’overlay_iw’ for ’w’ and ’overlay_ih*w/overlay_iw’ for ’h’. +</p> +<p>The expressions can contain the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>main_w, W</samp></span></dt> +<dt><span><samp>main_h, H</samp></span></dt> +<dd><p>The main input width and height. +</p> +</dd> +<dt><span><samp>overlay_iw</samp></span></dt> +<dt><span><samp>overlay_ih</samp></span></dt> +<dd><p>The overlay input width and height. +</p> +</dd> +<dt><span><samp>overlay_w, w</samp></span></dt> +<dt><span><samp>overlay_h, h</samp></span></dt> +<dd><p>The overlay output width and height. +</p> +</dd> +<dt><span><samp>overlay_x, x</samp></span></dt> +<dt><span><samp>overlay_y, y</samp></span></dt> +<dd><p>Position of the overlay layer inside of main +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>alpha</samp></span></dt> +<dd><p>Set transparency of overlaid video. Allowed range is 0.0 to 1.0. +Higher value means lower transparency. +Default value is <code>1.0</code>. +</p> +</dd> +<dt><span><samp>eof_action</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +<dt><span><samp>repeatlast</samp></span></dt> +<dd><p>See <a href="#framesync">framesync</a>. +</p> +</dd> +</dl> + +<p>This filter also supports the <a href="#framesync">framesync</a> options. +</p><a name="Examples-145"></a> +<h4 class="subsection">13.1.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-145" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-145" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs for this filter are yuv420p format. +<div class="example"> +<pre class="example">-i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_vaapi" OUTPUT +</pre></div> +</li><li> Overlay an image LOGO at the offset (200, 100) from the top-left corner of the INPUT video. +The inputs have same memory layout for color channels, the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +<div class="example"> +<pre class="example">-i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_vaapi=x=200:y=100:w=400:h=300:alpha=1.0, hwdownload, format=nv12" OUTPUT +</pre></div> + +</li></ul> + +<a name="tonemap_005fvaapi"></a> +<h3 class="section">13.2 tonemap_vaapi<span class="pull-right"><a class="anchor hidden-xs" href="#tonemap_005fvaapi" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tonemap_005fvaapi" aria-hidden="true">TOC</a></span></h3> + +<p>Perform HDR(High Dynamic Range) to SDR(Standard Dynamic Range) conversion with tone-mapping. +It maps the dynamic range of HDR10 content to the SDR content. +It currently only accepts HDR10 as input. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>format</samp></span></dt> +<dd><p>Specify the output pixel format. +</p> +<p>Currently supported formats are: +</p><dl compact="compact"> +<dt><span><var>p010</var></span></dt> +<dt><span><var>nv12</var></span></dt> +</dl> + +<p>Default is nv12. +</p> +</dd> +<dt><span><samp>primaries, p</samp></span></dt> +<dd><p>Set the output color primaries. +</p> +<p>Default is same as input. +</p> +</dd> +<dt><span><samp>transfer, t</samp></span></dt> +<dd><p>Set the output transfer characteristics. +</p> +<p>Default is bt709. +</p> +</dd> +<dt><span><samp>matrix, m</samp></span></dt> +<dd><p>Set the output colorspace matrix. +</p> +<p>Default is same as input. +</p> +</dd> +</dl> + +<a name="Example-7"></a> +<h4 class="subsection">13.2.1 Example<span class="pull-right"><a class="anchor hidden-xs" href="#Example-7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Example-7" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format +<div class="example"> +<pre class="example">tonemap_vaapi=format=p010:t=bt2020-10 +</pre></div> +</li></ul> + + +<a name="Video-Sources"></a> +<h2 class="chapter">14 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">14.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/buffersrc.h</samp>. +</p> +<p>It accepts the following parameters: +</p> +<dl compact="compact"> +<dt><span><samp>video_size</samp></span></dt> +<dd><p>Specify the size (width and height) of the buffered video frames. For the +syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>width</samp></span></dt> +<dd><p>The input video width. +</p> +</dd> +<dt><span><samp>height</samp></span></dt> +<dd><p>The input video height. +</p> +</dd> +<dt><span><samp>pix_fmt</samp></span></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><span><samp>time_base</samp></span></dt> +<dd><p>Specify the timebase assumed by the timestamps of the buffered frames. +</p> +</dd> +<dt><span><samp>frame_rate</samp></span></dt> +<dd><p>Specify the frame rate expected for the video stream. +</p> +</dd> +<dt><span><samp>pixel_aspect, sar</samp></span></dt> +<dd><p>The sample (pixel) aspect ratio of the input video. +</p> +</dd> +<dt><span><samp>sws_param</samp></span></dt> +<dd><p>This option is deprecated and ignored. Prepend <code>sws_flags=<var>flags</var>;</code> +to the filtergraph description to specify swscale flags for automatically +inserted scalers. See <a href="#Filtergraph-syntax">Filtergraph syntax</a>. +</p> +</dd> +<dt><span><samp>hw_frames_ctx</samp></span></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 "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). +Since the pixel format with name "yuv410p" 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> +</p> +<a name="cellauto"></a> +<h3 class="section">14.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><span><samp>filename, f</samp></span></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><span><samp>pattern, p</samp></span></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><span><samp>rate, r</samp></span></dt> +<dd><p>Set the video rate, that is the number of frames generated per second. +Default is 25. +</p> +</dd> +<dt><span><samp>random_fill_ratio, ratio</samp></span></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><span><samp>random_seed, seed</samp></span></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><span><samp>rule</samp></span></dt> +<dd><p>Set the cellular automaton rule, it is a number ranging from 0 to 255. +Default value is 110. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set the size of the output video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" 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 "320x518" (used for a randomly generated initial state). +</p> +</dd> +<dt><span><samp>scroll</samp></span></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><span><samp>start_full, full</samp></span></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><span><samp>stitch</samp></span></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-146"></a> +<h4 class="subsection">14.2.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-146" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-146" 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> + +<span id="coreimagesrc"></span><a name="coreimagesrc-1"></a> +<h3 class="section">14.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’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><span><samp>list_generators</samp></span></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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the size of the sourced video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +The default value is <code>320x240</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></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 +"25". +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>Set the sample aspect ratio of the sourced video. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set the duration of the sourced video. See +<a data-manual="ffmpeg-utils" 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-147"></a> +<h4 class="subsection">14.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-147" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-147" 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’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="ddagrab"></a> +<h3 class="section">14.4 ddagrab<span class="pull-right"><a class="anchor hidden-xs" href="#ddagrab" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ddagrab" aria-hidden="true">TOC</a></span></h3> + +<p>Captures the Windows Desktop via Desktop Duplication API. +</p> +<p>The filter exclusively returns D3D11 Hardware Frames, for on-gpu encoding +or processing. So an explicit <a href="#hwdownload">hwdownload</a> is needed for any kind of +software processing. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>output_idx</samp></span></dt> +<dd><p>DXGI Output Index to capture. +</p> +<p>Usually corresponds to the index Windows has given the screen minus one, +so it’s starting at 0. +</p> +<p>Defaults to output 0. +</p> +</dd> +<dt><span><samp>draw_mouse</samp></span></dt> +<dd><p>Whether to draw the mouse cursor. +</p> +<p>Defaults to true. +</p> +<p>Only affects hardware cursors. If a game or application renders its own cursor, +it’ll always be captured. +</p> +</dd> +<dt><span><samp>framerate</samp></span></dt> +<dd><p>Framerate at which the desktop will be captured. +</p> +<p>Defaults to 30 FPS. +</p> +</dd> +<dt><span><samp>video_size</samp></span></dt> +<dd><p>Specify the size of the captured video. +</p> +<p>Defaults to the full size of the screen. +</p> +<p>Cropped from the bottom/right if smaller than screen size. +</p> +</dd> +<dt><span><samp>offset_x</samp></span></dt> +<dd><p>Horizontal offset of the captured video. +</p> +</dd> +<dt><span><samp>offset_y</samp></span></dt> +<dd><p>Vertical offset of the captured video. +</p> +</dd> +<dt><span><samp>output_fmt</samp></span></dt> +<dd><p>Desired filter output format. +Defaults to 8 Bit BGRA. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Passes all supported output formats to DDA and returns what DDA decides to use. +</p></dd> +<dt><span>‘<samp>8bit</samp>’</span></dt> +<dt><span>‘<samp>bgra</samp>’</span></dt> +<dd><p>8 Bit formats always work, and DDA will convert to them if neccesary. +</p></dd> +<dt><span>‘<samp>10bit</samp>’</span></dt> +<dt><span>‘<samp>x2bgr10</samp>’</span></dt> +<dd><p>Filter initialization will fail if 10 bit format is requested but unavailable. +</p></dd> +</dl> + +</dd> +</dl> + +<a name="Examples-148"></a> +<h4 class="subsection">14.4.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-148" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-148" aria-hidden="true">TOC</a></span></h4> + +<p>Capture primary screen and encode using nvenc: +</p><div class="example"> +<pre class="example">ffmpeg -f lavfi -i ddagrab -c:v h264_nvenc -cq 18 output.mp4 +</pre></div> + +<p>You can also skip the lavfi device and directly use the filter. +Also demonstrates downloading the frame and encoding with libx264. +Explicit output format specification is required in this case: +</p><div class="example"> +<pre class="example">ffmpeg -filter_complex ddagrab=output_idx=1:framerate=60,hwdownload,format=bgra -c:v libx264 -crf 18 output.mp4 +</pre></div> + +<p>If you want to capture only a subsection of the desktop, this can be achieved +by specifying a smaller size and its offsets into the screen: +</p><div class="example"> +<pre class="example">ddagrab=video_size=800x600:offset_x=100:offset_y=100 +</pre></div> + + +<a name="gradients"></a> +<h3 class="section">14.5 gradients<span class="pull-right"><a class="anchor hidden-xs" href="#gradients" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gradients" aria-hidden="true">TOC</a></span></h3> +<p>Generate several gradients. +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set frame size. For the syntax of this option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual</a>. Default value is "640x480". +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>c0, c1, c2, c3, c4, c5, c6, c7</samp></span></dt> +<dd><p>Set 8 colors. Default values for colors is to pick random one. +</p> +</dd> +<dt><span><samp>x0, y0, y0, y1</samp></span></dt> +<dd><p>Set gradient line source and destination points. If negative or out of range, random ones +are picked. +</p> +</dd> +<dt><span><samp>nb_colors, n</samp></span></dt> +<dd><p>Set number of colors to use at once. Allowed range is from 2 to 8. Default value is 2. +</p> +</dd> +<dt><span><samp>seed</samp></span></dt> +<dd><p>Set seed for picking gradient line points. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set the duration of the sourced video. See +<a data-manual="ffmpeg-utils" 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><span><samp>speed</samp></span></dt> +<dd><p>Set speed of gradients rotation. +</p> +</dd> +<dt><span><samp>type, t</samp></span></dt> +<dd><p>Set type of gradients, can be <code>linear</code> or <code>radial</code> or <code>circular</code> or <code>spiral</code>. +</p></dd> +</dl> + + +<a name="mandelbrot"></a> +<h3 class="section">14.6 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><span><samp>end_pts</samp></span></dt> +<dd><p>Set the terminal pts value. Default value is 400. +</p> +</dd> +<dt><span><samp>end_scale</samp></span></dt> +<dd><p>Set the terminal scale value. +Must be a floating point value. Default value is 0.3. +</p> +</dd> +<dt><span><samp>inner</samp></span></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><span><samp>black</samp></span></dt> +<dd><p>Set black mode. +</p></dd> +<dt><span><samp>convergence</samp></span></dt> +<dd><p>Show time until convergence. +</p></dd> +<dt><span><samp>mincol</samp></span></dt> +<dd><p>Set color based on point closest to the origin of the iterations. +</p></dd> +<dt><span><samp>period</samp></span></dt> +<dd><p>Set period mode. +</p></dd> +</dl> + +<p>Default value is <var>mincol</var>. +</p> +</dd> +<dt><span><samp>bailout</samp></span></dt> +<dd><p>Set the bailout value. Default value is 10.0. +</p> +</dd> +<dt><span><samp>maxiter</samp></span></dt> +<dd><p>Set the maximum of iterations performed by the rendering +algorithm. Default value is 7189. +</p> +</dd> +<dt><span><samp>outer</samp></span></dt> +<dd><p>Set outer coloring mode. +It shall assume one of following values: +</p><dl compact="compact"> +<dt><span><samp>iteration_count</samp></span></dt> +<dd><p>Set iteration count mode. +</p></dd> +<dt><span><samp>normalized_iteration_count</samp></span></dt> +<dd><p>set normalized iteration count mode. +</p></dd> +</dl> +<p>Default value is <var>normalized_iteration_count</var>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set frame size. For the syntax of this option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual</a>. Default value is "640x480". +</p> +</dd> +<dt><span><samp>start_scale</samp></span></dt> +<dd><p>Set the initial scale value. Default value is 3.0. +</p> +</dd> +<dt><span><samp>start_x</samp></span></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><span><samp>start_y</samp></span></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">14.7 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><span><samp>rate, r</samp></span></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 +"25". +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set the duration of the sourced video. See +<a data-manual="ffmpeg-utils" 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><span><samp>test, t</samp></span></dt> +<dd> +<p>Set the number or the name of the test to perform. Supported tests are: +</p><dl compact="compact"> +<dt><span><samp>dc_luma</samp></span></dt> +<dt><span><samp>dc_chroma</samp></span></dt> +<dt><span><samp>freq_luma</samp></span></dt> +<dt><span><samp>freq_chroma</samp></span></dt> +<dt><span><samp>amp_luma</samp></span></dt> +<dt><span><samp>amp_chroma</samp></span></dt> +<dt><span><samp>cbp</samp></span></dt> +<dt><span><samp>mv</samp></span></dt> +<dt><span><samp>ring1</samp></span></dt> +<dt><span><samp>ring2</samp></span></dt> +<dt><span><samp>all</samp></span></dt> +<dt><span><samp>max_frames, m</samp></span></dt> +<dd><p>Set the maximum number of frames generated for each test, default value is 30. +</p> +</dd> +</dl> + +<p>Default value is "all", 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 "dc_luma" test pattern. +</p> +<a name="frei0r_005fsrc"></a> +<h3 class="section">14.8 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><span><samp>size</samp></span></dt> +<dd><p>The size of the video to generate. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>framerate</samp></span></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><span><samp>filter_name</samp></span></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><span><samp>filter_params</samp></span></dt> +<dd><p>A ’|’-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">14.9 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’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><span><samp>filename, f</samp></span></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><span><samp>rate, r</samp></span></dt> +<dd><p>Set the video rate, that is the number of frames generated per second. +Default is 25. +</p> +</dd> +<dt><span><samp>random_fill_ratio, ratio</samp></span></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><span><samp>random_seed, seed</samp></span></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><span><samp>rule</samp></span></dt> +<dd><p>Set the life rule. +</p> +<p>A rule can be specified with a code of the kind "S<var>NS</var>/B<var>NB</var>", +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 "born"). +"s" and "b" can be used in place of "S" and "B", 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 "borning" new cells. Higher order bits encode for an +higher number of neighbor cells. +For example the number 6153 = <code>(12<<9)+9</code> specifies a stay alive +rule of 12 and a born rule of 9, which corresponds to "S23/B03". +</p> +<p>Default value is "S23/B3", which is the original Conway’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><span><samp>size, s</samp></span></dt> +<dd><p>Set the size of the output video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" 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 "320x240" +(used for a randomly generated initial grid). +</p> +</dd> +<dt><span><samp>stitch</samp></span></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><span><samp>mold</samp></span></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><span><samp>life_color</samp></span></dt> +<dd><p>Set the color of living (or new born) cells. +</p> +</dd> +<dt><span><samp>death_color</samp></span></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><span><samp>mold_color</samp></span></dt> +<dd><p>Set mold color, for definitely dead and moldy cells. +</p> +<p>For the syntax of these 3 color options, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the +ffmpeg-utils manual</a>. +</p></dd> +</dl> + +<a name="Examples-149"></a> +<h4 class="subsection">14.9.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-149" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-149" 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> + +<span id="allrgb"></span><span id="allyuv"></span><span id="color"></span><span id="colorchart"></span><span id="colorspectrum"></span><span id="haldclutsrc"></span><span id="nullsrc"></span><span id="pal75bars"></span><span id="pal100bars"></span><span id="rgbtestsrc"></span><span id="smptebars"></span><span id="smptehdbars"></span><span id="testsrc"></span><span id="testsrc2"></span><span id="yuvtestsrc"></span><a name="allrgb_002c-allyuv_002c-color_002c-colorchart_002c-colorspectrum_002c-haldclutsrc_002c-nullsrc_002c-pal75bars_002c-pal100bars_002c-rgbtestsrc_002c-smptebars_002c-smptehdbars_002c-testsrc_002c-testsrc2_002c-yuvtestsrc"></a> +<h3 class="section">14.10 allrgb, allyuv, color, colorchart, colorspectrum, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc<span class="pull-right"><a class="anchor hidden-xs" href="#allrgb_002c-allyuv_002c-color_002c-colorchart_002c-colorspectrum_002c-haldclutsrc_002c-nullsrc_002c-pal75bars_002c-pal100bars_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-colorchart_002c-colorspectrum_002c-haldclutsrc_002c-nullsrc_002c-pal75bars_002c-pal100bars_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>colorchart</code> source provides a colors checker chart. +</p> +<p>The <code>colorspectrum</code> source provides a color spectrum 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>pal75bars</code> source generates a color bars pattern, based on +EBU PAL recommendations with 75% color levels. +</p> +<p>The <code>pal100bars</code> source generates a color bars pattern, based on +EBU PAL recommendations with 100% color levels. +</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><span><samp>level</samp></span></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><span><samp>color, c</samp></span></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 +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the ffmpeg-utils manual</a>. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Specify the size of the sourced video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +The default value is <code>320x240</code>. +</p> +<p>This option is not available with the <code>allrgb</code>, <code>allyuv</code>, and +<code>haldclutsrc</code> filters. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></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 +"25". +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set the duration of the sourced video. See +<a data-manual="ffmpeg-utils" 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> +<p>Since the frame rate is used as time base, all frames including the last one +will have their full duration. If the specified duration is not a multiple +of the frame duration, it will be rounded up. +</p> +</dd> +<dt><span><samp>sar</samp></span></dt> +<dd><p>Set the sample aspect ratio of the sourced video. +</p> +</dd> +<dt><span><samp>alpha</samp></span></dt> +<dd><p>Specify the alpha (opacity) of the background, only available in the +<code>testsrc2</code> source. The value must be between 0 (fully transparent) and +255 (fully opaque, the default). +</p> +</dd> +<dt><span><samp>decimals, n</samp></span></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> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set the type of the color spectrum, only available in the +<code>colorspectrum</code> source. Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>black</samp>’</span></dt> +<dt><span>‘<samp>white</samp>’</span></dt> +<dt><span>‘<samp>all</samp>’</span></dt> +</dl> + +</dd> +<dt><span><samp>patch_size</samp></span></dt> +<dd><p>Set patch size of single color patch, only available in the +<code>colorchart</code> source. Default is <code>64x64</code>. +</p> +</dd> +<dt><span><samp>preset</samp></span></dt> +<dd><p>Set colorchecker colors preset, only available in the +<code>colorchart</code> source. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>reference</samp>’</span></dt> +<dt><span>‘<samp>skintones</samp>’</span></dt> +</dl> + +<p>Default value is <code>reference</code>. +</p></dd> +</dl> + +<a name="Examples-150"></a> +<h4 class="subsection">14.10.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-150" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-150" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Generate a video with a duration of 5.3 seconds, with size +176x144 and a frame rate of 10 frames per second: +<div class="example"> +<pre class="example">testsrc=duration=5.3:size=qcif:rate=10 +</pre></div> + +</li><li> The following graph description will generate a red source +with an opacity of 0.2, with size "qcif" and a frame rate of 10 +frames per second: +<div class="example"> +<pre class="example">color=c=red@0.2:s=qcif:r=10 +</pre></div> + +</li><li> 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: +<div class="example"> +<pre class="example">nullsrc=s=256x256, geq=random(1)*255:128:128 +</pre></div> +</li></ul> + +<a name="Commands-154"></a> +<h4 class="subsection">14.10.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-154" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-154" aria-hidden="true">TOC</a></span></h4> + +<p>The <code>color</code> source supports the following commands: +</p> +<dl compact="compact"> +<dt><span><samp>c, color</samp></span></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="openclsrc"></a> +<h3 class="section">14.11 openclsrc<span class="pull-right"><a class="anchor hidden-xs" href="#openclsrc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-openclsrc" aria-hidden="true">TOC</a></span></h3> + +<p>Generate video using an OpenCL program. +</p> +<dl compact="compact"> +<dt><span><samp>source</samp></span></dt> +<dd><p>OpenCL program source file. +</p> +</dd> +<dt><span><samp>kernel</samp></span></dt> +<dd><p>Kernel name in program. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Size of frames to generate. This must be set. +</p> +</dd> +<dt><span><samp>format</samp></span></dt> +<dd><p>Pixel format to use for the generated frames. This must be set. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Number of frames generated every second. Default value is ’25’. +</p> +</dd> +</dl> + +<p>For details of how the program loading works, see the <a href="#program_005fopencl">program_opencl</a> +filter. +</p> +<p>Example programs: +</p> +<ul> +<li> Generate a colour ramp by setting pixel values from the position of the pixel +in the output image. (Note that this will work with all pixel formats, but +the generated output will not be the same.) +<pre class="verbatim">__kernel void ramp(__write_only image2d_t dst, + unsigned int index) +{ + int2 loc = (int2)(get_global_id(0), get_global_id(1)); + + float4 val; + val.xy = val.zw = convert_float2(loc) / convert_float2(get_image_dim(dst)); + + write_imagef(dst, loc, val); +} +</pre> +</li><li> Generate a Sierpinski carpet pattern, panning by a single pixel each frame. +<pre class="verbatim">__kernel void sierpinski_carpet(__write_only image2d_t dst, + unsigned int index) +{ + int2 loc = (int2)(get_global_id(0), get_global_id(1)); + + float4 value = 0.0f; + int x = loc.x + index; + int y = loc.y + index; + while (x > 0 || y > 0) { + if (x % 3 == 1 && y % 3 == 1) { + value = 1.0f; + break; + } + x /= 3; + y /= 3; + } + + write_imagef(dst, loc, value); +} +</pre> +</li></ul> + +<a name="sierpinski"></a> +<h3 class="section">14.12 sierpinski<span class="pull-right"><a class="anchor hidden-xs" href="#sierpinski" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sierpinski" aria-hidden="true">TOC</a></span></h3> + +<p>Generate a Sierpinski carpet/triangle fractal, and randomly pan around. +</p> +<p>This source accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set frame size. For the syntax of this option, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual</a>. Default value is "640x480". +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>seed</samp></span></dt> +<dd><p>Set seed which is used for random panning. +</p> +</dd> +<dt><span><samp>jump</samp></span></dt> +<dd><p>Set max jump for single pan destination. Allowed range is from 1 to 10000. +</p> +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set fractal type, can be default <code>carpet</code> or <code>triangle</code>. +</p></dd> +</dl> + + +<a name="Video-Sinks"></a> +<h2 class="chapter">15 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">15.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’ formats, to be passed as the opaque +parameter to <code>avfilter_init_filter</code> for initialization. +</p> +<a name="nullsink"></a> +<h3 class="section">15.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">16 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="a3dscope"></a> +<h3 class="section">16.1 a3dscope<span class="pull-right"><a class="anchor hidden-xs" href="#a3dscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-a3dscope" aria-hidden="true">TOC</a></span></h3> + +<p>Convert input audio to 3d scope video output. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>hd720</code>. +</p> +</dd> +<dt><span><samp>fov</samp></span></dt> +<dd><p>Set the camera field of view. Default is 90 degrees. +Allowed range is from 40 to 150. +</p> +</dd> +<dt><span><samp>roll</samp></span></dt> +<dd><p>Set the camera roll. +</p> +</dd> +<dt><span><samp>pitch</samp></span></dt> +<dd><p>Set the camera pitch. +</p> +</dd> +<dt><span><samp>yaw</samp></span></dt> +<dd><p>Set the camera yaw. +</p> +</dd> +<dt><span><samp>xzoom</samp></span></dt> +<dd><p>Set the camera zoom on X-axis. +</p> +</dd> +<dt><span><samp>yzoom</samp></span></dt> +<dd><p>Set the camera zoom on Y-axis. +</p> +</dd> +<dt><span><samp>zzoom</samp></span></dt> +<dd><p>Set the camera zoom on Z-axis. +</p> +</dd> +<dt><span><samp>xpos</samp></span></dt> +<dd><p>Set the camera position on X-axis. +</p> +</dd> +<dt><span><samp>ypos</samp></span></dt> +<dd><p>Set the camera position on Y-axis. +</p> +</dd> +<dt><span><samp>zpos</samp></span></dt> +<dd><p>Set the camera position on Z-axis. +</p> +</dd> +<dt><span><samp>length</samp></span></dt> +<dd><p>Set the length of displayed audio waves in number of frames. +</p></dd> +</dl> + +<a name="Commands-155"></a> +<h4 class="subsection">16.1.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-155" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-155" aria-hidden="true">TOC</a></span></h4> + +<p>Filter supports the some above options as <a href="#commands">commands</a>. +</p> +<a name="abitscope"></a> +<h3 class="section">16.2 abitscope<span class="pull-right"><a class="anchor hidden-xs" href="#abitscope" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-abitscope" aria-hidden="true">TOC</a></span></h3> + +<p>Convert input audio to a video output, displaying the audio bit scope. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>1024x256</code>. +</p> +</dd> +<dt><span><samp>colors</samp></span></dt> +<dd><p>Specify list of colors separated by space or by ’|’ which will be used to +draw channels. Unrecognized or missing colors will be replaced +by white color. +</p> +</dd> +<dt><span><samp>mode, m</samp></span></dt> +<dd><p>Set output mode. Can be <code>bars</code> or <code>trace</code>. Default is <code>bars</code>. +</p></dd> +</dl> + +<a name="adrawgraph"></a> +<h3 class="section">16.3 adrawgraph<span class="pull-right"><a class="anchor hidden-xs" href="#adrawgraph" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-adrawgraph" aria-hidden="true">TOC</a></span></h3> +<p>Draw a graph using input audio metadata. +</p> +<p>See <a href="#drawgraph">drawgraph</a> +</p> +<a name="agraphmonitor"></a> +<h3 class="section">16.4 agraphmonitor<span class="pull-right"><a class="anchor hidden-xs" href="#agraphmonitor" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-agraphmonitor" aria-hidden="true">TOC</a></span></h3> + +<p>See <a href="#graphmonitor">graphmonitor</a>. +</p> +<a name="ahistogram"></a> +<h3 class="section">16.5 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><span><samp>dmode</samp></span></dt> +<dd><p>Specify how histogram is calculated. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>single</samp>’</span></dt> +<dd><p>Use single histogram for all channels. +</p></dd> +<dt><span>‘<samp>separate</samp>’</span></dt> +<dd><p>Use separate histogram for each channel. +</p></dd> +</dl> +<p>Default is <code>single</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set frame rate, expressed as number of frames per second. Default +value is "25". +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>hd720</code>. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set display scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>square root +</p></dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>cubic root +</p></dd> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +<dt><span>‘<samp>rlog</samp>’</span></dt> +<dd><p>reverse logarithmic +</p></dd> +</dl> +<p>Default is <code>log</code>. +</p> +</dd> +<dt><span><samp>ascale</samp></span></dt> +<dd><p>Set amplitude scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +</dl> +<p>Default is <code>log</code>. +</p> +</dd> +<dt><span><samp>acount</samp></span></dt> +<dd><p>Set how much frames to accumulate in histogram. +Default is 1. Setting this to -1 accumulates all frames. +</p> +</dd> +<dt><span><samp>rheight</samp></span></dt> +<dd><p>Set histogram ratio of window height. +</p> +</dd> +<dt><span><samp>slide</samp></span></dt> +<dd><p>Set sonogram sliding. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>replace</samp>’</span></dt> +<dd><p>replace old rows with new ones. +</p></dd> +<dt><span>‘<samp>scroll</samp>’</span></dt> +<dd><p>scroll from top to bottom. +</p></dd> +</dl> +<p>Default is <code>replace</code>. +</p> +</dd> +<dt><span><samp>hmode</samp></span></dt> +<dd><p>Set histogram mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>abs</samp>’</span></dt> +<dd><p>Use absolute values of samples. +</p></dd> +<dt><span>‘<samp>sign</samp>’</span></dt> +<dd><p>Use untouched values of samples. +</p></dd> +</dl> +<p>Default is <code>abs</code>. +</p></dd> +</dl> + +<a name="aphasemeter"></a> +<h3 class="section">16.6 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>Measures phase of input audio, which is exported as metadata <code>lavfi.aphasemeter.phase</code>, +representing mean phase of current audio frame. A video output can also be produced and is +enabled by default. The audio is passed through as first output. +</p> +<p>Audio will be rematrixed to stereo if it has a different channel layout. Phase value is in +range <code>[-1, 1]</code> where <code>-1</code> means left and right channels are completely out of phase +and <code>1</code> means channels are in phase. +</p> +<p>The filter accepts the following options, all related to its video output: +</p> +<dl compact="compact"> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set the output frame rate. Default value is <code>25</code>. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>800x400</code>. +</p> +</dd> +<dt><span><samp>rc</samp></span></dt> +<dt><span><samp>gc</samp></span></dt> +<dt><span><samp>bc</samp></span></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><span><samp>mpc</samp></span></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> +<dt><span><samp>video</samp></span></dt> +<dd><p>Enable video output. Default is enabled. +</p></dd> +</dl> + +<a name="phasing-detection"></a> +<h4 class="subsection">16.6.1 phasing detection<span class="pull-right"><a class="anchor hidden-xs" href="#phasing-detection" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-phasing-detection" aria-hidden="true">TOC</a></span></h4> + +<p>The filter also detects out of phase and mono sequences in stereo streams. +It logs the sequence start, end and duration when it lasts longer or as long as the minimum set. +</p> +<p>The filter accepts the following options for this detection: +</p> +<dl compact="compact"> +<dt><span><samp>phasing</samp></span></dt> +<dd><p>Enable mono and out of phase detection. Default is disabled. +</p> +</dd> +<dt><span><samp>tolerance, t</samp></span></dt> +<dd><p>Set phase tolerance for mono detection, in amplitude ratio. Default is <code>0</code>. +Allowed range is <code>[0, 1]</code>. +</p> +</dd> +<dt><span><samp>angle, a</samp></span></dt> +<dd><p>Set angle threshold for out of phase detection, in degree. Default is <code>170</code>. +Allowed range is <code>[90, 180]</code>. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set mono or out of phase duration until notification, expressed in seconds. Default is <code>2</code>. +</p></dd> +</dl> + +<a name="Examples-151"></a> +<h4 class="subsection">16.6.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-151" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-151" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Complete example with <code>ffmpeg</code> to detect 1 second of mono with 0.001 phase tolerance: +<div class="example"> +<pre class="example">ffmpeg -i stereo.wav -af aphasemeter=video=0:phasing=1:duration=1:tolerance=0.001 -f null - +</pre></div> +</li></ul> + +<a name="avectorscope"></a> +<h3 class="section">16.7 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 monaural 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><span><samp>mode, m</samp></span></dt> +<dd><p>Set the vectorscope mode. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>lissajous</samp>’</span></dt> +<dd><p>Lissajous rotated by 45 degrees. +</p> +</dd> +<dt><span>‘<samp>lissajous_xy</samp>’</span></dt> +<dd><p>Same as above but not rotated. +</p> +</dd> +<dt><span>‘<samp>polar</samp>’</span></dt> +<dd><p>Shape resembling half of circle. +</p></dd> +</dl> + +<p>Default value is ‘<samp>lissajous</samp>’. +</p> +</dd> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>400x400</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set the output frame rate. Default value is <code>25</code>. +</p> +</dd> +<dt><span><samp>rc</samp></span></dt> +<dt><span><samp>gc</samp></span></dt> +<dt><span><samp>bc</samp></span></dt> +<dt><span><samp>ac</samp></span></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><span><samp>rf</samp></span></dt> +<dt><span><samp>gf</samp></span></dt> +<dt><span><samp>bf</samp></span></dt> +<dt><span><samp>af</samp></span></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><span><samp>zoom</samp></span></dt> +<dd><p>Set the zoom factor. Default value is <code>1</code>. Allowed range is <code>[0, 10]</code>. +Values lower than <var>1</var> will auto adjust zoom factor to maximal possible value. +</p> +</dd> +<dt><span><samp>draw</samp></span></dt> +<dd><p>Set the vectorscope drawing mode. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>dot</samp>’</span></dt> +<dd><p>Draw dot for each sample. +</p> +</dd> +<dt><span>‘<samp>line</samp>’</span></dt> +<dd><p>Draw line between previous and current sample. +</p></dd> +</dl> + +<p>Default value is ‘<samp>dot</samp>’. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Specify amplitude scale of audio samples. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>Linear. +</p> +</dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>Square root. +</p> +</dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>Cubic root. +</p> +</dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>Logarithmic. +</p></dd> +</dl> + +</dd> +<dt><span><samp>swap</samp></span></dt> +<dd><p>Swap left channel axis with right channel axis. +</p> +</dd> +<dt><span><samp>mirror</samp></span></dt> +<dd><p>Mirror axis. +</p> +<dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>No mirror. +</p> +</dd> +<dt><span>‘<samp>x</samp>’</span></dt> +<dd><p>Mirror only x axis. +</p> +</dd> +<dt><span>‘<samp>y</samp>’</span></dt> +<dd><p>Mirror only y axis. +</p> +</dd> +<dt><span>‘<samp>xy</samp>’</span></dt> +<dd><p>Mirror both axis. +</p></dd> +</dl> + +</dd> +</dl> + +<a name="Examples-152"></a> +<h4 class="subsection">16.7.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-152" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-152" 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="Commands-156"></a> +<h4 class="subsection">16.7.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-156" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-156" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the all above options as commands except options <code>size</code> and <code>rate</code>. +</p> +<a name="bench_002c-abench"></a> +<h3 class="section">16.8 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><span><samp>action</samp></span></dt> +<dd><p>Start or stop a timer. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>start</samp>’</span></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><span>‘<samp>stop</samp>’</span></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-153"></a> +<h4 class="subsection">16.8.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-153" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-153" 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"></a> +<h3 class="section">16.9 concat<span class="pull-right"><a class="anchor hidden-xs" href="#concat" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concat" 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><span><samp>n</samp></span></dt> +<dd><p>Set the number of segments. Default is 2. +</p> +</dd> +<dt><span><samp>v</samp></span></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><span><samp>a</samp></span></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><span><samp>unsafe</samp></span></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-154"></a> +<h4 class="subsection">16.9.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-154" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-154" 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="Commands-157"></a> +<h4 class="subsection">16.9.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-157" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-157" aria-hidden="true">TOC</a></span></h4> + +<p>This filter supports the following commands: +</p><dl compact="compact"> +<dt><span><samp>next</samp></span></dt> +<dd><p>Close the current segment and step to the next one +</p></dd> +</dl> + +<span id="ebur128"></span><a name="ebur128-1"></a> +<h3 class="section">16.10 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 and analyzes its loudness +level. 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 can only analyze streams which have +sample format is double-precision floating point. The input stream will be converted to +this specification, if needed. Users may need to insert aformat and/or aresample filters +after this filter to obtain the original parameters. +</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), but can optionally be configured +to instead display short-term loudness (see <var>gauge</var>). +</p> +<p>The green area marks a +/- 1LU target range around the target loudness +(-23LUFS by default, unless modified through <var>target</var>). +</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><span><samp>video</samp></span></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><span><samp>size</samp></span></dt> +<dd><p>Set the video size. This option is for video only. For the syntax of this +option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default and minimum resolution is <code>640x480</code>. +</p> +</dd> +<dt><span><samp>meter</samp></span></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><span><samp>metadata</samp></span></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><span><samp>framelog</samp></span></dt> +<dd><p>Force the frame logging level. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>quiet</samp>’</span></dt> +<dd><p>logging disabled +</p></dd> +<dt><span>‘<samp>info</samp>’</span></dt> +<dd><p>information logging level +</p></dd> +<dt><span>‘<samp>verbose</samp>’</span></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><span><samp>peak</samp></span></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><span>‘<samp>none</samp>’</span></dt> +<dd><p>Disable any peak mode (default). +</p></dd> +<dt><span>‘<samp>sample</samp>’</span></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><span>‘<samp>true</samp>’</span></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><span><samp>dualmono</samp></span></dt> +<dd><p>Treat mono input files as "dual mono". 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><span><samp>panlaw</samp></span></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> +<dt><span><samp>target</samp></span></dt> +<dd><p>Set a specific target level (in LUFS) used as relative zero in the visualization. +This parameter is optional and has a default value of -23LUFS as specified +by EBU R128. However, material published online may prefer a level of -16LUFS +(e.g. for use with podcasts or video platforms). +</p> +</dd> +<dt><span><samp>gauge</samp></span></dt> +<dd><p>Set the value displayed by the gauge. Valid values are <code>momentary</code> and s +<code>shortterm</code>. By default the momentary value will be used, but in certain +scenarios it may be more useful to observe the short term value instead (e.g. +live mixing). +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Sets the display scale for the loudness. Valid parameters are <code>absolute</code> +(in LUFS) or <code>relative</code> (LU) relative to the target. This only affects the +video output, not the summary or continuous log output. +</p></dd> +</dl> + +<a name="Examples-155"></a> +<h4 class="subsection">16.10.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-155" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-155" 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 "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]" +</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">16.11 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><span><samp>nb_inputs, n</samp></span></dt> +<dd><p>Set the number of different inputs, it is 2 by default. +</p> +</dd> +<dt><span><samp>duration</samp></span></dt> +<dd><p>How to determine the end-of-stream. +</p> +<dl compact="compact"> +<dt><span><samp>longest</samp></span></dt> +<dd><p>The duration of the longest input. (default) +</p> +</dd> +<dt><span><samp>shortest</samp></span></dt> +<dd><p>The duration of the shortest input. +</p> +</dd> +<dt><span><samp>first</samp></span></dt> +<dd><p>The duration of the first input. +</p></dd> +</dl> + +</dd> +</dl> + +<a name="Examples-156"></a> +<h4 class="subsection">16.11.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-156" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-156" 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 "[0:v][1:v] interleave" 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="latency_002c-alatency"></a> +<h3 class="section">16.12 latency, alatency<span class="pull-right"><a class="anchor hidden-xs" href="#latency_002c-alatency" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-latency_002c-alatency" aria-hidden="true">TOC</a></span></h3> +<p>Measure filtering latency. +</p> +<p>Report previous filter filtering latency, delay in number of audio samples for audio filters +or number of video frames for video filters. +</p> +<p>On end of input stream, filter will report min and max measured latency for previous running filter +in filtergraph. +</p> +<a name="metadata_002c-ametadata"></a> +<h3 class="section">16.13 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><span><samp>mode</samp></span></dt> +<dd><p>Set mode of operation of the filter. +</p> +<p>Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>select</samp>’</span></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><span>‘<samp>add</samp>’</span></dt> +<dd><p>Add new metadata <code>key</code> and <code>value</code>. If key is already available +do nothing. +</p> +</dd> +<dt><span>‘<samp>modify</samp>’</span></dt> +<dd><p>Modify value of already present key. +</p> +</dd> +<dt><span>‘<samp>delete</samp>’</span></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><span>‘<samp>print</samp>’</span></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><span><samp>key</samp></span></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><span><samp>value</samp></span></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><span><samp>function</samp></span></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><span>‘<samp>same_str</samp>’</span></dt> +<dd><p>Values are interpreted as strings, returns true if metadata value is same as <code>value</code>. +</p> +</dd> +<dt><span>‘<samp>starts_with</samp>’</span></dt> +<dd><p>Values are interpreted as strings, returns true if metadata value starts with +the <code>value</code> option string. +</p> +</dd> +<dt><span>‘<samp>less</samp>’</span></dt> +<dd><p>Values are interpreted as floats, returns true if metadata value is less than <code>value</code>. +</p> +</dd> +<dt><span>‘<samp>equal</samp>’</span></dt> +<dd><p>Values are interpreted as floats, returns true if <code>value</code> is equal with metadata value. +</p> +</dd> +<dt><span>‘<samp>greater</samp>’</span></dt> +<dd><p>Values are interpreted as floats, returns true if metadata value is greater than <code>value</code>. +</p> +</dd> +<dt><span>‘<samp>expr</samp>’</span></dt> +<dd><p>Values are interpreted as floats, returns true if expression from option <code>expr</code> +evaluates to true. +</p> +</dd> +<dt><span>‘<samp>ends_with</samp>’</span></dt> +<dd><p>Values are interpreted as strings, returns true if metadata value ends with +the <code>value</code> option string. +</p></dd> +</dl> + +</dd> +<dt><span><samp>expr</samp></span></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><span><samp>VALUE1, FRAMEVAL</samp></span></dt> +<dd><p>Float representation of <code>value</code> from metadata key. +</p> +</dd> +<dt><span><samp>VALUE2, USERVAL</samp></span></dt> +<dd><p>Float representation of <code>value</code> as supplied by user in <code>value</code> option. +</p></dd> +</dl> + +</dd> +<dt><span><samp>file</samp></span></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 “-” 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> +<dt><span><samp>direct</samp></span></dt> +<dd><p>Reduces buffering in print mode when output is written to a URL set using <var>file</var>. +</p> +</dd> +</dl> + +<a name="Examples-157"></a> +<h4 class="subsection">16.13.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-157" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-157" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Print all metadata values for frames with key <code>lavfi.signalstats.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">16.14 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><span><samp>mode</samp></span></dt> +<dd><p>Select the permissions mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>none</samp>’</span></dt> +<dd><p>Do nothing. This is the default. +</p></dd> +<dt><span>‘<samp>ro</samp>’</span></dt> +<dd><p>Set all the output frames read-only. +</p></dd> +<dt><span>‘<samp>rw</samp>’</span></dt> +<dd><p>Set all the output frames directly writable. +</p></dd> +<dt><span>‘<samp>toggle</samp>’</span></dt> +<dd><p>Make the frame read-only if writable, and writable if read-only. +</p></dd> +<dt><span>‘<samp>random</samp>’</span></dt> +<dd><p>Set each output frame read-only or writable randomly. +</p></dd> +</dl> + +</dd> +<dt><span><samp>seed</samp></span></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">16.15 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 approximately. +</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><span><samp>limit</samp></span></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> +<dt><span><samp>speed</samp></span></dt> +<dd><p>Speed factor for processing. The value must be a float larger than zero. +Values larger than 1.0 will result in faster than realtime processing, +smaller will slow processing down. The <var>limit</var> is automatically adapted +accordingly. Default is 1.0. +</p> +<p>A processing speed faster than what is possible without these filters cannot +be achieved. +</p></dd> +</dl> + +<a name="Commands-158"></a> +<h4 class="subsection">16.15.1 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-158" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-158" aria-hidden="true">TOC</a></span></h4> + +<p>Both filters supports the all above options as <a href="#commands">commands</a>. +</p> +<a name="segment_002c-asegment"></a> +<h3 class="section">16.16 segment, asegment<span class="pull-right"><a class="anchor hidden-xs" href="#segment_002c-asegment" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-segment_002c-asegment" aria-hidden="true">TOC</a></span></h3> + +<p>Split single input stream into multiple streams. +</p> +<p>This filter does opposite of concat filters. +</p> +<p><code>segment</code> works on video frames, <code>asegment</code> on audio samples. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>timestamps</samp></span></dt> +<dd><p>Timestamps of output segments separated by ’|’. The first segment will run +from the beginning of the input stream. The last segment will run until +the end of the input stream +</p> +</dd> +<dt><span><samp>frames, samples</samp></span></dt> +<dd><p>Exact frame/sample count to split the segments. +</p></dd> +</dl> + +<p>In all cases, prefixing an each segment with ’+’ will make it relative to the +previous segment. +</p> +<a name="Examples-158"></a> +<h4 class="subsection">16.16.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-158" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-158" aria-hidden="true">TOC</a></span></h4> + +<ul> +<li> Split input audio stream into three output audio streams, starting at start of input audio stream +and storing that in 1st output audio stream, then following at 60th second and storing than in 2nd +output audio stream, and last after 150th second of input audio stream store in 3rd output audio stream: +<div class="example"> +<pre class="example">asegment=timestamps="60|150" +</pre></div> + +</li></ul> + +<span id="select"></span><a name="select_002c-aselect"></a> +<h3 class="section">16.17 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><span><samp>expr, e</samp></span></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><span><samp>outputs, n</samp></span></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><span><samp>n</samp></span></dt> +<dd><p>The (sequential) number of the filtered frame, starting from 0. +</p> +</dd> +<dt><span><samp>selected_n</samp></span></dt> +<dd><p>The (sequential) number of the selected frame, starting from 0. +</p> +</dd> +<dt><span><samp>prev_selected_n</samp></span></dt> +<dd><p>The sequential number of the last selected frame. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>TB</samp></span></dt> +<dd><p>The timebase of the input timestamps. +</p> +</dd> +<dt><span><samp>pts</samp></span></dt> +<dd><p>The PTS (Presentation TimeStamp) of the filtered frame, +expressed in <var>TB</var> units. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>The PTS of the filtered frame, +expressed in seconds. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>prev_pts</samp></span></dt> +<dd><p>The PTS of the previously filtered frame. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>prev_selected_pts</samp></span></dt> +<dd><p>The PTS of the last previously filtered frame. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>prev_selected_t</samp></span></dt> +<dd><p>The PTS of the last previously selected frame, expressed in seconds. It’s NAN if undefined. +</p> +</dd> +<dt><span><samp>start_pts</samp></span></dt> +<dd><p>The first PTS in the stream which is not NAN. It remains NAN if not found. +</p> +</dd> +<dt><span><samp>start_t</samp></span></dt> +<dd><p>The first PTS, in seconds, in the stream which is not NAN. It remains NAN if not found. +</p> +</dd> +<dt><span><samp>pict_type <em>(video only)</em></samp></span></dt> +<dd><p>The type of the filtered frame. It can assume one of the following +values: +</p><dl compact="compact"> +<dt><span><samp>I</samp></span></dt> +<dt><span><samp>P</samp></span></dt> +<dt><span><samp>B</samp></span></dt> +<dt><span><samp>S</samp></span></dt> +<dt><span><samp>SI</samp></span></dt> +<dt><span><samp>SP</samp></span></dt> +<dt><span><samp>BI</samp></span></dt> +</dl> + +</dd> +<dt><span><samp>interlace_type <em>(video only)</em></samp></span></dt> +<dd><p>The frame interlace type. It can assume one of the following values: +</p><dl compact="compact"> +<dt><span><samp>PROGRESSIVE</samp></span></dt> +<dd><p>The frame is progressive (not interlaced). +</p></dd> +<dt><span><samp>TOPFIRST</samp></span></dt> +<dd><p>The frame is top-field-first. +</p></dd> +<dt><span><samp>BOTTOMFIRST</samp></span></dt> +<dd><p>The frame is bottom-field-first. +</p></dd> +</dl> + +</dd> +<dt><span><samp>consumed_sample_n <em>(audio only)</em></samp></span></dt> +<dd><p>the number of selected samples before the current frame +</p> +</dd> +<dt><span><samp>samples_n <em>(audio only)</em></samp></span></dt> +<dd><p>the number of samples in the current frame +</p> +</dd> +<dt><span><samp>sample_rate <em>(audio only)</em></samp></span></dt> +<dd><p>the input sample rate +</p> +</dd> +<dt><span><samp>key</samp></span></dt> +<dd><p>This is 1 if the filtered frame is a key-frame, 0 otherwise. +</p> +</dd> +<dt><span><samp>pos</samp></span></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><span><samp>scene <em>(video only)</em></samp></span></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><span><samp>concatdec_select</samp></span></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 "1". +</p> +<a name="Examples-159"></a> +<h4 class="subsection">16.17.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-159" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-159" 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 > 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">16.18 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><span><samp>commands, c</samp></span></dt> +<dd><p>Set the commands to be read and sent to the other filters. +</p></dd> +<dt><span><samp>filename, f</samp></span></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">16.18.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 ",", 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 "+" or "|" and +enclosed between "[" and "]". +</p> +<p>The following flags are recognized: +</p><dl compact="compact"> +<dt><span><samp>enter</samp></span></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><span><samp>leave</samp></span></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> +<dt><span><samp>expr</samp></span></dt> +<dd><p>The command <var>ARG</var> is interpreted as expression and result of +expression is passed as <var>ARG</var>. +</p> +<p>The expression is evaluated through the eval API and can contain the following +constants: +</p> +<dl compact="compact"> +<dt><span><samp>POS</samp></span></dt> +<dd><p>Original position in the file of the frame, or undefined if undefined +for the current frame. +</p> +</dd> +<dt><span><samp>PTS</samp></span></dt> +<dd><p>The presentation timestamp in input. +</p> +</dd> +<dt><span><samp>N</samp></span></dt> +<dd><p>The count of the input frame for video or audio, starting from 0. +</p> +</dd> +<dt><span><samp>T</samp></span></dt> +<dd><p>The time in seconds of the current frame. +</p> +</dd> +<dt><span><samp>TS</samp></span></dt> +<dd><p>The start time in seconds of the current command interval. +</p> +</dd> +<dt><span><samp>TE</samp></span></dt> +<dd><p>The end time in seconds of the current command interval. +</p> +</dd> +<dt><span><samp>TI</samp></span></dt> +<dd><p>The interpolated time of the current command interval, TI = (T - TS) / (TE - TS). +</p> +</dd> +<dt><span><samp>W</samp></span></dt> +<dd><p>The video frame width. +</p> +</dd> +<dt><span><samp>H</samp></span></dt> +<dd><p>The video frame height. +</p></dd> +</dl> + +</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> ::= "enter" | "leave" +<var>COMMAND_FLAGS</var> ::= <var>COMMAND_FLAG</var> [(+|"|")<var>COMMAND_FLAG</var>] +<var>COMMAND</var> ::= ["[" <var>COMMAND_FLAGS</var> "]"] <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-160"></a> +<h4 class="subsection">16.18.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-160" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-160" 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> Target a specific filter instance: +<div class="example"> +<pre class="example">asendcmd=c='4.0 atempo@my tempo 1.5',atempo@my +</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> + +<span id="setpts"></span><a name="setpts_002c-asetpts"></a> +<h3 class="section">16.19 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><span><samp>expr</samp></span></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><span><samp>FRAME_RATE, FR</samp></span></dt> +<dd><p>frame rate, only defined for constant frame-rate video +</p> +</dd> +<dt><span><samp>PTS</samp></span></dt> +<dd><p>The presentation timestamp in input +</p> +</dd> +<dt><span><samp>N</samp></span></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><span><samp>NB_CONSUMED_SAMPLES</samp></span></dt> +<dd><p>The number of consumed samples, not including the current frame (only +audio) +</p> +</dd> +<dt><span><samp>NB_SAMPLES, S</samp></span></dt> +<dd><p>The number of samples in the current frame (only audio) +</p> +</dd> +<dt><span><samp>SAMPLE_RATE, SR</samp></span></dt> +<dd><p>The audio sample rate. +</p> +</dd> +<dt><span><samp>STARTPTS</samp></span></dt> +<dd><p>The PTS of the first frame. +</p> +</dd> +<dt><span><samp>STARTT</samp></span></dt> +<dd><p>the time in seconds of the first frame +</p> +</dd> +<dt><span><samp>INTERLACED</samp></span></dt> +<dd><p>State whether the current frame is interlaced. +</p> +</dd> +<dt><span><samp>T</samp></span></dt> +<dd><p>the time in seconds of the current frame +</p> +</dd> +<dt><span><samp>POS</samp></span></dt> +<dd><p>original position in the file of the frame, or undefined if undefined +for the current frame +</p> +</dd> +<dt><span><samp>PREV_INPTS</samp></span></dt> +<dd><p>The previous input PTS. +</p> +</dd> +<dt><span><samp>PREV_INT</samp></span></dt> +<dd><p>previous input time in seconds +</p> +</dd> +<dt><span><samp>PREV_OUTPTS</samp></span></dt> +<dd><p>The previous output PTS. +</p> +</dd> +<dt><span><samp>PREV_OUTT</samp></span></dt> +<dd><p>previous output time in seconds +</p> +</dd> +<dt><span><samp>RTCTIME</samp></span></dt> +<dd><p>The wallclock (RTC) time in microseconds. This is deprecated, use time(0) +instead. +</p> +</dd> +<dt><span><samp>RTCSTART</samp></span></dt> +<dd><p>The wallclock (RTC) time at the start of the movie in microseconds. +</p> +</dd> +<dt><span><samp>TB</samp></span></dt> +<dd><p>The timebase of the input timestamps. +</p> +</dd> +</dl> + +<a name="Examples-161"></a> +<h4 class="subsection">16.19.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-161" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-161" 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 "live source" 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="setrange"></a> +<h3 class="section">16.20 setrange<span class="pull-right"><a class="anchor hidden-xs" href="#setrange" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-setrange" aria-hidden="true">TOC</a></span></h3> + +<p>Force color range for the output video frame. +</p> +<p>The <code>setrange</code> filter marks the color range property 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. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>range</samp></span></dt> +<dd><p>Available values are: +</p> +<dl compact="compact"> +<dt><span>‘<samp>auto</samp>’</span></dt> +<dd><p>Keep the same color range property. +</p> +</dd> +<dt><span>‘<samp>unspecified, unknown</samp>’</span></dt> +<dd><p>Set the color range as unspecified. +</p> +</dd> +<dt><span>‘<samp>limited, tv, mpeg</samp>’</span></dt> +<dd><p>Set the color range as limited. +</p> +</dd> +<dt><span>‘<samp>full, pc, jpeg</samp>’</span></dt> +<dd><p>Set the color range as full. +</p></dd> +</dl> +</dd> +</dl> + +<a name="settb_002c-asettb"></a> +<h3 class="section">16.21 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><span><samp>expr, tb</samp></span></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 "AVTB" (the default +timebase), "intb" (the input timebase) and "sr" (the sample rate, +audio only). Default value is "intb". +</p> +<a name="Examples-162"></a> +<h4 class="subsection">16.21.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-162" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-162" 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">16.22 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. It must be even. For the syntax of this option, +check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>1920x1080</code>. +</p> +</dd> +<dt><span><samp>fps, rate, r</samp></span></dt> +<dd><p>Set the output frame rate. Default value is <code>25</code>. +</p> +</dd> +<dt><span><samp>bar_h</samp></span></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><span><samp>axis_h</samp></span></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><span><samp>sono_h</samp></span></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><span><samp>fullhd</samp></span></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><span><samp>sono_v, volume</samp></span></dt> +<dd><p>Specify the sonogram volume expression. It can contain variables: +</p><dl compact="compact"> +<dt><span><samp>bar_v</samp></span></dt> +<dd><p>the <var>bar_v</var> evaluated expression +</p></dd> +<dt><span><samp>frequency, freq, f</samp></span></dt> +<dd><p>the frequency where it is evaluated +</p></dd> +<dt><span><samp>timeclamp, tc</samp></span></dt> +<dd><p>the value of <var>timeclamp</var> option +</p></dd> +</dl> +<p>and functions: +</p><dl compact="compact"> +<dt><span><samp>a_weighting(f)</samp></span></dt> +<dd><p>A-weighting of equal loudness +</p></dd> +<dt><span><samp>b_weighting(f)</samp></span></dt> +<dd><p>B-weighting of equal loudness +</p></dd> +<dt><span><samp>c_weighting(f)</samp></span></dt> +<dd><p>C-weighting of equal loudness. +</p></dd> +</dl> +<p>Default value is <code>16</code>. +</p> +</dd> +<dt><span><samp>bar_v, volume2</samp></span></dt> +<dd><p>Specify the bargraph volume expression. It can contain variables: +</p><dl compact="compact"> +<dt><span><samp>sono_v</samp></span></dt> +<dd><p>the <var>sono_v</var> evaluated expression +</p></dd> +<dt><span><samp>frequency, freq, f</samp></span></dt> +<dd><p>the frequency where it is evaluated +</p></dd> +<dt><span><samp>timeclamp, tc</samp></span></dt> +<dd><p>the value of <var>timeclamp</var> option +</p></dd> +</dl> +<p>and functions: +</p><dl compact="compact"> +<dt><span><samp>a_weighting(f)</samp></span></dt> +<dd><p>A-weighting of equal loudness +</p></dd> +<dt><span><samp>b_weighting(f)</samp></span></dt> +<dd><p>B-weighting of equal loudness +</p></dd> +<dt><span><samp>c_weighting(f)</samp></span></dt> +<dd><p>C-weighting of equal loudness. +</p></dd> +</dl> +<p>Default value is <code>sono_v</code>. +</p> +</dd> +<dt><span><samp>sono_g, gamma</samp></span></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><span><samp>bar_g, gamma2</samp></span></dt> +<dd><p>Specify the bargraph gamma. Default value is <code>1</code>. Acceptable range is +<code>[1, 7]</code>. +</p> +</dd> +<dt><span><samp>bar_t</samp></span></dt> +<dd><p>Specify the bargraph transparency level. Lower value makes the bargraph sharper. +Default value is <code>1</code>. Acceptable range is <code>[0, 1]</code>. +</p> +</dd> +<dt><span><samp>timeclamp, tc</samp></span></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.002, 1]</code>. Default value is <code>0.17</code>. +</p> +</dd> +<dt><span><samp>attack</samp></span></dt> +<dd><p>Set attack time in seconds. The default is <code>0</code> (disabled). Otherwise, it +limits future samples by applying asymmetric windowing in time domain, useful +when low latency is required. Accepted range is <code>[0, 1]</code>. +</p> +</dd> +<dt><span><samp>basefreq</samp></span></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><span><samp>endfreq</samp></span></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><span><samp>coeffclamp</samp></span></dt> +<dd><p>This option is deprecated and ignored. +</p> +</dd> +<dt><span><samp>tlength</samp></span></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><span><samp>frequency, freq, f</samp></span></dt> +<dd><p>the frequency where it is evaluated +</p></dd> +<dt><span><samp>timeclamp, tc</samp></span></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><span><samp>count</samp></span></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><span><samp>fcount</samp></span></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><span><samp>fontfile</samp></span></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><span><samp>font</samp></span></dt> +<dd><p>Specify fontconfig pattern. This has lower priority than <var>fontfile</var>. The +<code>:</code> in the pattern may be replaced by <code>|</code> to avoid unnecessary +escaping. +</p> +</dd> +<dt><span><samp>fontcolor</samp></span></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><span><samp>frequency, freq, f</samp></span></dt> +<dd><p>the frequency where it is evaluated +</p></dd> +<dt><span><samp>timeclamp, tc</samp></span></dt> +<dd><p>the value of <var>timeclamp</var> option +</p></dd> +</dl> +<p>and functions: +</p><dl compact="compact"> +<dt><span><samp>midi(f)</samp></span></dt> +<dd><p>midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69) +</p></dd> +<dt><span><samp>r(x), g(x), b(x)</samp></span></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><span><samp>axisfile</samp></span></dt> +<dd><p>Specify image file to draw the axis. This option override <var>fontfile</var> and +<var>fontcolor</var> option. +</p> +</dd> +<dt><span><samp>axis, text</samp></span></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> +<dt><span><samp>csp</samp></span></dt> +<dd><p>Set colorspace. The accepted values are: +</p><dl compact="compact"> +<dt><span>‘<samp>unspecified</samp>’</span></dt> +<dd><p>Unspecified (default) +</p> +</dd> +<dt><span>‘<samp>bt709</samp>’</span></dt> +<dd><p>BT.709 +</p> +</dd> +<dt><span>‘<samp>fcc</samp>’</span></dt> +<dd><p>FCC +</p> +</dd> +<dt><span>‘<samp>bt470bg</samp>’</span></dt> +<dd><p>BT.470BG or BT.601-6 625 +</p> +</dd> +<dt><span>‘<samp>smpte170m</samp>’</span></dt> +<dd><p>SMPTE-170M or BT.601-6 525 +</p> +</dd> +<dt><span>‘<samp>smpte240m</samp>’</span></dt> +<dd><p>SMPTE-240M +</p> +</dd> +<dt><span>‘<samp>bt2020ncl</samp>’</span></dt> +<dd><p>BT.2020 with non-constant luminance +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>cscheme</samp></span></dt> +<dd><p>Set spectrogram color scheme. This is list of floating point values with format +<code>left_r|left_g|left_b|right_r|right_g|right_b</code>. +The default is <code>1|0.5|0|0|0.5|1</code>. +</p> +</dd> +</dl> + +<a name="Examples-163"></a> +<h4 class="subsection">16.22.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-163" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-163" 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 font using fontconfig: +<div class="example"> +<pre class="example">font='Courier New,Monospace,mono|bold' +</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">16.23 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify size of video. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default is <code>1024x512</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set video rate. Default is <code>25</code>. +</p> +</dd> +<dt><span><samp>mode</samp></span></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><span>‘<samp>line</samp>’</span></dt> +<dt><span>‘<samp>bar</samp>’</span></dt> +<dt><span>‘<samp>dot</samp>’</span></dt> +</dl> +<p>Default is <code>bar</code>. +</p> +</dd> +<dt><span><samp>ascale</samp></span></dt> +<dd><p>Set amplitude scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>Linear scale. +</p> +</dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>Square root scale. +</p> +</dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>Cubic root scale. +</p> +</dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>Logarithmic scale. +</p></dd> +</dl> +<p>Default is <code>log</code>. +</p> +</dd> +<dt><span><samp>fscale</samp></span></dt> +<dd><p>Set frequency scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>Linear scale. +</p> +</dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>Logarithmic scale. +</p> +</dd> +<dt><span>‘<samp>rlog</samp>’</span></dt> +<dd><p>Reverse logarithmic scale. +</p></dd> +</dl> +<p>Default is <code>lin</code>. +</p> +</dd> +<dt><span><samp>win_size</samp></span></dt> +<dd><p>Set window size. Allowed range is from 16 to 65536. +</p> +<p>Default is <code>2048</code> +</p> +</dd> +<dt><span><samp>win_func</samp></span></dt> +<dd><p>Set windowing function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> +<p>Default is <code>hanning</code>. +</p> +</dd> +<dt><span><samp>overlap</samp></span></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><span><samp>averaging</samp></span></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><span><samp>colors</samp></span></dt> +<dd><p>Specify list of colors separated by space or by ’|’ which will be used to +draw channel frequencies. Unrecognized or missing colors will be replaced +by white color. +</p> +</dd> +<dt><span><samp>cmode</samp></span></dt> +<dd><p>Set channel display mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>combined</samp>’</span></dt> +<dt><span>‘<samp>separate</samp>’</span></dt> +</dl> +<p>Default is <code>combined</code>. +</p> +</dd> +<dt><span><samp>minamp</samp></span></dt> +<dd><p>Set minimum amplitude used in <code>log</code> amplitude scaler. +</p> +</dd> +<dt><span><samp>data</samp></span></dt> +<dd><p>Set data display mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>magnitude</samp>’</span></dt> +<dt><span>‘<samp>phase</samp>’</span></dt> +<dt><span>‘<samp>delay</samp>’</span></dt> +</dl> +<p>Default is <code>magnitude</code>. +</p> +</dd> +<dt><span><samp>channels</samp></span></dt> +<dd><p>Set channels to use when processing audio. By default all are processed. +</p></dd> +</dl> + +<a name="showspatial"></a> +<h3 class="section">16.24 showspatial<span class="pull-right"><a class="anchor hidden-xs" href="#showspatial" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-showspatial" aria-hidden="true">TOC</a></span></h3> + +<p>Convert stereo input audio to a video output, representing the spatial relationship +between two channels. +</p> +<p>The filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>512x512</code>. +</p> +</dd> +<dt><span><samp>win_size</samp></span></dt> +<dd><p>Set window size. Allowed range is from <var>1024</var> to <var>65536</var>. Default size is <var>4096</var>. +</p> +</dd> +<dt><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann</samp>’</span></dt> +<dt><span>‘<samp>hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> + +<p>Default value is <code>hann</code>. +</p> +</dd> +<dt><span><samp>rate, r</samp></span></dt> +<dd><p>Set output framerate. +</p></dd> +</dl> + +<span id="showspectrum"></span><a name="showspectrum-1"></a> +<h3 class="section">16.25 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>640x512</code>. +</p> +</dd> +<dt><span><samp>slide</samp></span></dt> +<dd><p>Specify how the spectrum should slide along the window. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>replace</samp>’</span></dt> +<dd><p>the samples start again on the left when they reach the right +</p></dd> +<dt><span>‘<samp>scroll</samp>’</span></dt> +<dd><p>the samples scroll from right to left +</p></dd> +<dt><span>‘<samp>fullframe</samp>’</span></dt> +<dd><p>frames are only produced when the samples reach the right +</p></dd> +<dt><span>‘<samp>rscroll</samp>’</span></dt> +<dd><p>the samples scroll from left to right +</p></dd> +<dt><span>‘<samp>lreplace</samp>’</span></dt> +<dd><p>the samples start again on the right when they reach the left +</p></dd> +</dl> + +<p>Default value is <code>replace</code>. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Specify display mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>combined</samp>’</span></dt> +<dd><p>all channels are displayed in the same row +</p></dd> +<dt><span>‘<samp>separate</samp>’</span></dt> +<dd><p>all channels are displayed in separate rows +</p></dd> +</dl> + +<p>Default value is ‘<samp>combined</samp>’. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify display color mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>channel</samp>’</span></dt> +<dd><p>each channel is displayed in a separate color +</p></dd> +<dt><span>‘<samp>intensity</samp>’</span></dt> +<dd><p>each channel is displayed using the same color scheme +</p></dd> +<dt><span>‘<samp>rainbow</samp>’</span></dt> +<dd><p>each channel is displayed using the rainbow color scheme +</p></dd> +<dt><span>‘<samp>moreland</samp>’</span></dt> +<dd><p>each channel is displayed using the moreland color scheme +</p></dd> +<dt><span>‘<samp>nebulae</samp>’</span></dt> +<dd><p>each channel is displayed using the nebulae color scheme +</p></dd> +<dt><span>‘<samp>fire</samp>’</span></dt> +<dd><p>each channel is displayed using the fire color scheme +</p></dd> +<dt><span>‘<samp>fiery</samp>’</span></dt> +<dd><p>each channel is displayed using the fiery color scheme +</p></dd> +<dt><span>‘<samp>fruit</samp>’</span></dt> +<dd><p>each channel is displayed using the fruit color scheme +</p></dd> +<dt><span>‘<samp>cool</samp>’</span></dt> +<dd><p>each channel is displayed using the cool color scheme +</p></dd> +<dt><span>‘<samp>magma</samp>’</span></dt> +<dd><p>each channel is displayed using the magma color scheme +</p></dd> +<dt><span>‘<samp>green</samp>’</span></dt> +<dd><p>each channel is displayed using the green color scheme +</p></dd> +<dt><span>‘<samp>viridis</samp>’</span></dt> +<dd><p>each channel is displayed using the viridis color scheme +</p></dd> +<dt><span>‘<samp>plasma</samp>’</span></dt> +<dd><p>each channel is displayed using the plasma color scheme +</p></dd> +<dt><span>‘<samp>cividis</samp>’</span></dt> +<dd><p>each channel is displayed using the cividis color scheme +</p></dd> +<dt><span>‘<samp>terrain</samp>’</span></dt> +<dd><p>each channel is displayed using the terrain color scheme +</p></dd> +</dl> + +<p>Default value is ‘<samp>channel</samp>’. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Specify scale used for calculating intensity color values. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>square root, default +</p></dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>cubic root +</p></dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +<dt><span>‘<samp>4thrt</samp>’</span></dt> +<dd><p>4th root +</p></dd> +<dt><span>‘<samp>5thrt</samp>’</span></dt> +<dd><p>5th root +</p></dd> +</dl> + +<p>Default value is ‘<samp>sqrt</samp>’. +</p> +</dd> +<dt><span><samp>fscale</samp></span></dt> +<dd><p>Specify frequency scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +</dl> + +<p>Default value is ‘<samp>lin</samp>’. +</p> +</dd> +<dt><span><samp>saturation</samp></span></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><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann</samp>’</span></dt> +<dt><span>‘<samp>hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> + +<p>Default value is <code>hann</code>. +</p> +</dd> +<dt><span><samp>orientation</samp></span></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><span><samp>overlap</samp></span></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><span><samp>gain</samp></span></dt> +<dd><p>Set scale gain for calculating intensity color values. +Default value is <code>1</code>. +</p> +</dd> +<dt><span><samp>data</samp></span></dt> +<dd><p>Set which data to display. Can be <code>magnitude</code>, default or <code>phase</code>, +or unwrapped phase: <code>uphase</code>. +</p> +</dd> +<dt><span><samp>rotation</samp></span></dt> +<dd><p>Set color rotation, must be in [-1.0, 1.0] range. +Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>start</samp></span></dt> +<dd><p>Set start frequency from which to display spectrogram. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>stop</samp></span></dt> +<dd><p>Set stop frequency to which to display spectrogram. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>fps</samp></span></dt> +<dd><p>Set upper frame rate limit. Default is <code>auto</code>, unlimited. +</p> +</dd> +<dt><span><samp>legend</samp></span></dt> +<dd><p>Draw time and frequency axes and legends. Default is disabled. +</p> +</dd> +<dt><span><samp>drange</samp></span></dt> +<dd><p>Set dynamic range used to calculate intensity color values. Default is 120 dBFS. +Allowed range is from 10 to 200. +</p> +</dd> +<dt><span><samp>limit</samp></span></dt> +<dd><p>Set upper limit of input audio samples volume in dBFS. Default is 0 dBFS. +Allowed range is from -100 to 100. +</p> +</dd> +<dt><span><samp>opacity</samp></span></dt> +<dd><p>Set opacity strength when using pixel format output with alpha component. +</p></dd> +</dl> + +<p>The usage is very similar to the showwaves filter; see the examples in that +section. +</p> +<a name="Examples-164"></a> +<h4 class="subsection">16.25.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-164" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-164" 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">16.26 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>4096x2048</code>. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Specify display mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>combined</samp>’</span></dt> +<dd><p>all channels are displayed in the same row +</p></dd> +<dt><span>‘<samp>separate</samp>’</span></dt> +<dd><p>all channels are displayed in separate rows +</p></dd> +</dl> +<p>Default value is ‘<samp>combined</samp>’. +</p> +</dd> +<dt><span><samp>color</samp></span></dt> +<dd><p>Specify display color mode. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>channel</samp>’</span></dt> +<dd><p>each channel is displayed in a separate color +</p></dd> +<dt><span>‘<samp>intensity</samp>’</span></dt> +<dd><p>each channel is displayed using the same color scheme +</p></dd> +<dt><span>‘<samp>rainbow</samp>’</span></dt> +<dd><p>each channel is displayed using the rainbow color scheme +</p></dd> +<dt><span>‘<samp>moreland</samp>’</span></dt> +<dd><p>each channel is displayed using the moreland color scheme +</p></dd> +<dt><span>‘<samp>nebulae</samp>’</span></dt> +<dd><p>each channel is displayed using the nebulae color scheme +</p></dd> +<dt><span>‘<samp>fire</samp>’</span></dt> +<dd><p>each channel is displayed using the fire color scheme +</p></dd> +<dt><span>‘<samp>fiery</samp>’</span></dt> +<dd><p>each channel is displayed using the fiery color scheme +</p></dd> +<dt><span>‘<samp>fruit</samp>’</span></dt> +<dd><p>each channel is displayed using the fruit color scheme +</p></dd> +<dt><span>‘<samp>cool</samp>’</span></dt> +<dd><p>each channel is displayed using the cool color scheme +</p></dd> +<dt><span>‘<samp>magma</samp>’</span></dt> +<dd><p>each channel is displayed using the magma color scheme +</p></dd> +<dt><span>‘<samp>green</samp>’</span></dt> +<dd><p>each channel is displayed using the green color scheme +</p></dd> +<dt><span>‘<samp>viridis</samp>’</span></dt> +<dd><p>each channel is displayed using the viridis color scheme +</p></dd> +<dt><span>‘<samp>plasma</samp>’</span></dt> +<dd><p>each channel is displayed using the plasma color scheme +</p></dd> +<dt><span>‘<samp>cividis</samp>’</span></dt> +<dd><p>each channel is displayed using the cividis color scheme +</p></dd> +<dt><span>‘<samp>terrain</samp>’</span></dt> +<dd><p>each channel is displayed using the terrain color scheme +</p></dd> +</dl> +<p>Default value is ‘<samp>intensity</samp>’. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Specify scale used for calculating intensity color values. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>square root, default +</p></dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>cubic root +</p></dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +<dt><span>‘<samp>4thrt</samp>’</span></dt> +<dd><p>4th root +</p></dd> +<dt><span>‘<samp>5thrt</samp>’</span></dt> +<dd><p>5th root +</p></dd> +</dl> +<p>Default value is ‘<samp>log</samp>’. +</p> +</dd> +<dt><span><samp>fscale</samp></span></dt> +<dd><p>Specify frequency scale. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>linear +</p></dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>logarithmic +</p></dd> +</dl> + +<p>Default value is ‘<samp>lin</samp>’. +</p> +</dd> +<dt><span><samp>saturation</samp></span></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><span><samp>win_func</samp></span></dt> +<dd><p>Set window function. +</p> +<p>It accepts the following values: +</p><dl compact="compact"> +<dt><span>‘<samp>rect</samp>’</span></dt> +<dt><span>‘<samp>bartlett</samp>’</span></dt> +<dt><span>‘<samp>hann</samp>’</span></dt> +<dt><span>‘<samp>hanning</samp>’</span></dt> +<dt><span>‘<samp>hamming</samp>’</span></dt> +<dt><span>‘<samp>blackman</samp>’</span></dt> +<dt><span>‘<samp>welch</samp>’</span></dt> +<dt><span>‘<samp>flattop</samp>’</span></dt> +<dt><span>‘<samp>bharris</samp>’</span></dt> +<dt><span>‘<samp>bnuttall</samp>’</span></dt> +<dt><span>‘<samp>bhann</samp>’</span></dt> +<dt><span>‘<samp>sine</samp>’</span></dt> +<dt><span>‘<samp>nuttall</samp>’</span></dt> +<dt><span>‘<samp>lanczos</samp>’</span></dt> +<dt><span>‘<samp>gauss</samp>’</span></dt> +<dt><span>‘<samp>tukey</samp>’</span></dt> +<dt><span>‘<samp>dolph</samp>’</span></dt> +<dt><span>‘<samp>cauchy</samp>’</span></dt> +<dt><span>‘<samp>parzen</samp>’</span></dt> +<dt><span>‘<samp>poisson</samp>’</span></dt> +<dt><span>‘<samp>bohman</samp>’</span></dt> +<dt><span>‘<samp>kaiser</samp>’</span></dt> +</dl> +<p>Default value is <code>hann</code>. +</p> +</dd> +<dt><span><samp>orientation</samp></span></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><span><samp>gain</samp></span></dt> +<dd><p>Set scale gain for calculating intensity color values. +Default value is <code>1</code>. +</p> +</dd> +<dt><span><samp>legend</samp></span></dt> +<dd><p>Draw time and frequency axes and legends. Default is enabled. +</p> +</dd> +<dt><span><samp>rotation</samp></span></dt> +<dd><p>Set color rotation, must be in [-1.0, 1.0] range. +Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>start</samp></span></dt> +<dd><p>Set start frequency from which to display spectrogram. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>stop</samp></span></dt> +<dd><p>Set stop frequency to which to display spectrogram. Default is <code>0</code>. +</p> +</dd> +<dt><span><samp>drange</samp></span></dt> +<dd><p>Set dynamic range used to calculate intensity color values. Default is 120 dBFS. +Allowed range is from 10 to 200. +</p> +</dd> +<dt><span><samp>limit</samp></span></dt> +<dd><p>Set upper limit of input audio samples volume in dBFS. Default is 0 dBFS. +Allowed range is from -100 to 100. +</p> +</dd> +<dt><span><samp>opacity</samp></span></dt> +<dd><p>Set opacity strength when using pixel format output with alpha component. +</p></dd> +</dl> + +<a name="Examples-165"></a> +<h4 class="subsection">16.26.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-165" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-165" 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">16.27 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><span><samp>rate, r</samp></span></dt> +<dd><p>Set video rate. +</p> +</dd> +<dt><span><samp>b</samp></span></dt> +<dd><p>Set border width, allowed range is [0, 5]. Default is 1. +</p> +</dd> +<dt><span><samp>w</samp></span></dt> +<dd><p>Set channel width, allowed range is [80, 8192]. Default is 400. +</p> +</dd> +<dt><span><samp>h</samp></span></dt> +<dd><p>Set channel height, allowed range is [1, 900]. Default is 20. +</p> +</dd> +<dt><span><samp>f</samp></span></dt> +<dd><p>Set fade, allowed range is [0, 1]. Default is 0.95. +</p> +</dd> +<dt><span><samp>c</samp></span></dt> +<dd><p>Set volume color expression. +</p> +<p>The expression can use the following variables: +</p> +<dl compact="compact"> +<dt><span><samp>VOLUME</samp></span></dt> +<dd><p>Current max volume of channel in dB. +</p> +</dd> +<dt><span><samp>PEAK</samp></span></dt> +<dd><p>Current peak. +</p> +</dd> +<dt><span><samp>CHANNEL</samp></span></dt> +<dd><p>Current channel number, starting from 0. +</p></dd> +</dl> + +</dd> +<dt><span><samp>t</samp></span></dt> +<dd><p>If set, displays channel names. Default is enabled. +</p> +</dd> +<dt><span><samp>v</samp></span></dt> +<dd><p>If set, displays volume values. Default is enabled. +</p> +</dd> +<dt><span><samp>o</samp></span></dt> +<dd><p>Set orientation, can be horizontal: <code>h</code> or vertical: <code>v</code>, +default is <code>h</code>. +</p> +</dd> +<dt><span><samp>s</samp></span></dt> +<dd><p>Set step size, allowed range is [0, 5]. Default is 0, which means +step is disabled. +</p> +</dd> +<dt><span><samp>p</samp></span></dt> +<dd><p>Set background opacity, allowed range is [0, 1]. Default is 0. +</p> +</dd> +<dt><span><samp>m</samp></span></dt> +<dd><p>Set metering mode, can be peak: <code>p</code> or rms: <code>r</code>, +default is <code>p</code>. +</p> +</dd> +<dt><span><samp>ds</samp></span></dt> +<dd><p>Set display scale, can be linear: <code>lin</code> or log: <code>log</code>, +default is <code>lin</code>. +</p> +</dd> +<dt><span><samp>dm</samp></span></dt> +<dd><p>In second. +If set to > 0., display a line for the max level +in the previous seconds. +default is disabled: <code>0.</code> +</p> +</dd> +<dt><span><samp>dmc</samp></span></dt> +<dd><p>The color of the max line. Use when <code>dm</code> option is set to > 0. +default is: <code>orange</code> +</p></dd> +</dl> + +<a name="showwaves"></a> +<h3 class="section">16.28 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>600x240</code>. +</p> +</dd> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set display mode. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>point</samp>’</span></dt> +<dd><p>Draw a point for each sample. +</p> +</dd> +<dt><span>‘<samp>line</samp>’</span></dt> +<dd><p>Draw a vertical line for each sample. +</p> +</dd> +<dt><span>‘<samp>p2p</samp>’</span></dt> +<dd><p>Draw a point for each sample and a line between them. +</p> +</dd> +<dt><span>‘<samp>cline</samp>’</span></dt> +<dd><p>Draw a centered vertical line for each sample. +</p></dd> +</dl> + +<p>Default value is <code>point</code>. +</p> +</dd> +<dt><span><samp>n</samp></span></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><span><samp>rate, r</samp></span></dt> +<dd><p>Set the (approximate) output frame rate. This is done by setting the +option <var>n</var>. Default value is "25". +</p> +</dd> +<dt><span><samp>split_channels</samp></span></dt> +<dd><p>Set if channels should be drawn separately or overlap. Default value is 0. +</p> +</dd> +<dt><span><samp>colors</samp></span></dt> +<dd><p>Set colors separated by ’|’ which are going to be used for drawing of each channel. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set amplitude scale. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>Linear. +</p> +</dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>Logarithmic. +</p> +</dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>Square root. +</p> +</dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>Cubic root. +</p></dd> +</dl> + +<p>Default is linear. +</p> +</dd> +<dt><span><samp>draw</samp></span></dt> +<dd><p>Set the draw mode. This is mostly useful to set for high <var>n</var>. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>scale</samp>’</span></dt> +<dd><p>Scale pixel values for each drawn sample. +</p> +</dd> +<dt><span>‘<samp>full</samp>’</span></dt> +<dd><p>Draw every sample directly. +</p></dd> +</dl> + +<p>Default value is <code>scale</code>. +</p></dd> +</dl> + +<a name="Examples-166"></a> +<h4 class="subsection">16.28.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-166" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-166" 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">16.29 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><span><samp>size, s</samp></span></dt> +<dd><p>Specify the video size for the output. For the syntax of this option, check the +<a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#video-size-syntax">(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual</a>. +Default value is <code>600x240</code>. +</p> +</dd> +<dt><span><samp>split_channels</samp></span></dt> +<dd><p>Set if channels should be drawn separately or overlap. Default value is 0. +</p> +</dd> +<dt><span><samp>colors</samp></span></dt> +<dd><p>Set colors separated by ’|’ which are going to be used for drawing of each channel. +</p> +</dd> +<dt><span><samp>scale</samp></span></dt> +<dd><p>Set amplitude scale. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>lin</samp>’</span></dt> +<dd><p>Linear. +</p> +</dd> +<dt><span>‘<samp>log</samp>’</span></dt> +<dd><p>Logarithmic. +</p> +</dd> +<dt><span>‘<samp>sqrt</samp>’</span></dt> +<dd><p>Square root. +</p> +</dd> +<dt><span>‘<samp>cbrt</samp>’</span></dt> +<dd><p>Cubic root. +</p></dd> +</dl> + +<p>Default is linear. +</p> +</dd> +<dt><span><samp>draw</samp></span></dt> +<dd><p>Set the draw mode. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>scale</samp>’</span></dt> +<dd><p>Scale pixel values for each drawn sample. +</p> +</dd> +<dt><span>‘<samp>full</samp>’</span></dt> +<dd><p>Draw every sample directly. +</p></dd> +</dl> + +<p>Default value is <code>scale</code>. +</p> +</dd> +<dt><span><samp>filter</samp></span></dt> +<dd><p>Set the filter mode. +</p> +<p>Available values are: +</p><dl compact="compact"> +<dt><span>‘<samp>average</samp>’</span></dt> +<dd><p>Use average samples values for each drawn sample. +</p> +</dd> +<dt><span>‘<samp>peak</samp>’</span></dt> +<dd><p>Use peak samples values for each drawn sample. +</p></dd> +</dl> + +<p>Default value is <code>average</code>. +</p></dd> +</dl> + +<a name="Examples-167"></a> +<h4 class="subsection">16.29.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-167" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-167" 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="sidedata_002c-asidedata"></a> +<h3 class="section">16.30 sidedata, asidedata<span class="pull-right"><a class="anchor hidden-xs" href="#sidedata_002c-asidedata" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sidedata_002c-asidedata" aria-hidden="true">TOC</a></span></h3> + +<p>Delete frame side data, or select frames based on it. +</p> +<p>This filter accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>mode</samp></span></dt> +<dd><p>Set mode of operation of the filter. +</p> +<p>Can be one of the following: +</p> +<dl compact="compact"> +<dt><span>‘<samp>select</samp>’</span></dt> +<dd><p>Select every frame with side data of <code>type</code>. +</p> +</dd> +<dt><span>‘<samp>delete</samp>’</span></dt> +<dd><p>Delete side data of <code>type</code>. If <code>type</code> is not set, delete all side +data in the frame. +</p> +</dd> +</dl> + +</dd> +<dt><span><samp>type</samp></span></dt> +<dd><p>Set side data type used with all modes. Must be set for <code>select</code> mode. For +the list of frame side data types, refer to the <code>AVFrameSideDataType</code> enum +in <samp>libavutil/frame.h</samp>. For example, to choose +<code>AV_FRAME_DATA_PANSCAN</code> side data, you must specify <code>PANSCAN</code>. +</p> +</dd> +</dl> + +<a name="spectrumsynth"></a> +<h3 class="section">16.31 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>Synthesize 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 primarily 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 +it’s 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><span><samp>sample_rate</samp></span></dt> +<dd><p>Specify sample rate of output audio, the sample rate of audio from which +spectrum was generated may differ. +</p> +</dd> +<dt><span><samp>channels</samp></span></dt> +<dd><p>Set number of channels represented in input video spectrums. +</p> +</dd> +<dt><span><samp>scale</samp></span></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><span><samp>slide</samp></span></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><span><samp>win_func</samp></span></dt> +<dd><p>Set window function used for resynthesis. +</p> +</dd> +<dt><span><samp>overlap</samp></span></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><span><samp>orientation</samp></span></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-168"></a> +<h4 class="subsection">16.31.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-168" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-168" 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">16.32 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-169"></a> +<h4 class="subsection">16.32.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-169" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-169" 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">16.33 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. Both are capable to send messages to any filter type. +</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> (or the abbreviation "<samp>b</samp>") option. +Default value of this option is <samp>tcp://localhost:5555</samp>. You may +want to alter this value to your needs, but do not forget to escape any +’:’ signs (see <a href="#filtergraph-escaping">filtergraph escaping</a>). +</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. The default +filter instance name uses the pattern ‘<samp>Parsed_<filter_name>_<index></samp>’, +but you can override this by using the ‘<samp>filter_name@id</samp>’ syntax +(see <a href="#Filtergraph-syntax">Filtergraph syntax</a>). +</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-170"></a> +<h4 class="subsection">16.33.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-170" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-170" 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>. +In this example the last overlay filter has an instance name. All other +filters will have default instance names. +</p> +<div class="example"> +<pre class="example">ffplay -dumpgraph 1 -f lavfi " +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@my=x=100 " +</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> + +<p>To change the position of the right side: +</p><div class="example"> +<pre class="example">echo overlay@my x 150 | tools/zmqsend +</pre></div> + + + +<a name="Multimedia-Sources"></a> +<h2 class="chapter">17 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">17.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="avsynctest"></a> +<h3 class="section">17.2 avsynctest<span class="pull-right"><a class="anchor hidden-xs" href="#avsynctest" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-avsynctest" aria-hidden="true">TOC</a></span></h3> +<p>Generate an Audio/Video Sync Test. +</p> +<p>Generated stream periodically shows flash video frame and emits beep in audio. +Useful to inspect A/V sync issues. +</p> +<p>It accepts the following options: +</p> +<dl compact="compact"> +<dt><span><samp>size, s</samp></span></dt> +<dd><p>Set output video size. Default value is <code>hd720</code>. +</p> +</dd> +<dt><span><samp>framerate, fr</samp></span></dt> +<dd><p>Set output video frame rate. Default value is <code>30</code>. +</p> +</dd> +<dt><span><samp>samplerate, sr</samp></span></dt> +<dd><p>Set output audio sample rate. Default value is <code>44100</code>. +</p> +</dd> +<dt><span><samp>amplitude, a</samp></span></dt> +<dd><p>Set output audio beep amplitude. Default value is <code>0.7</code>. +</p> +</dd> +<dt><span><samp>period, p</samp></span></dt> +<dd><p>Set output audio beep period in seconds. Default value is <code>3</code>. +</p> +</dd> +<dt><span><samp>delay, dl</samp></span></dt> +<dd><p>Set output video flash delay in number of frames. Default value is <code>0</code>. +</p> +</dd> +<dt><span><samp>cycle, c</samp></span></dt> +<dd><p>Enable cycling of video delays, by default is disabled. +</p> +</dd> +<dt><span><samp>duration, d</samp></span></dt> +<dd><p>Set stream output duration. By default duration is unlimited. +</p> +</dd> +<dt><span><samp>fg, bg, ag</samp></span></dt> +<dd><p>Set foreground/background/additional color. +</p></dd> +</dl> + +<span id="movie"></span><a name="movie-1"></a> +<h3 class="section">17.3 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><span><samp>filename</samp></span></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><span><samp>format_name, f</samp></span></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><span><samp>seek_point, sp</samp></span></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 "0". +</p> +</dd> +<dt><span><samp>streams, s</samp></span></dt> +<dd><p>Specifies the streams to read. Several streams can be specified, +separated by "+". The source will then have as many outputs, in the +same order. The syntax is explained in the <a data-manual="ffmpeg" href="ffmpeg.html#Stream-specifiers">(ffmpeg)"Stream specifiers" +section in the ffmpeg manual</a>. Two special names, "dv" and "da" specify +respectively the default (best suited) video and audio stream. Default +is "dv", or "da" if the filter is called as "amovie". +</p> +</dd> +<dt><span><samp>stream_index, si</samp></span></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 "-1". Deprecated. If the filter is called "amovie", it will select +audio instead of video. +</p> +</dd> +<dt><span><samp>loop</samp></span></dt> +<dd><p>Specifies how many times to read the stream in sequence. +If the value is 0, the stream will be looped infinitely. +Default value is "1". +</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><span><samp>discontinuity</samp></span></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> +<dt><span><samp>dec_threads</samp></span></dt> +<dd><p>Specifies the number of threads for decoding +</p> +</dd> +<dt><span><samp>format_opts</samp></span></dt> +<dd><p>Specify format options for the opened file. Format options can be specified +as a list of <var>key</var>=<var>value</var> pairs separated by ’:’. The following example +shows how to add protocol_whitelist and protocol_blacklist options: +</p><div class="example"> +<pre class="example">ffplay -f lavfi +"movie=filename='1.sdp':format_opts='protocol_whitelist=file,rtp,udp\:protocol_blacklist=http'" +</pre></div> +</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 -----------> deltapts0 --> overlay --> output + ^ + | +movie --> scale--> deltapts1 -------+ +</pre></div> +<a name="Examples-171"></a> +<h4 class="subsection">17.3.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-171" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-171" 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 "in": +<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 "in": +<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 "video" and the audio is +connected to the pad named "audio": +<div class="example"> +<pre class="example">movie=dvd.vob:s=v:0+#0x81 [video] [audio] +</pre></div> +</li></ul> + +<a name="Commands-159"></a> +<h4 class="subsection">17.3.2 Commands<span class="pull-right"><a class="anchor hidden-xs" href="#Commands-159" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Commands-159" aria-hidden="true">TOC</a></span></h4> + +<p>Both movie and amovie support the following commands: +</p><dl compact="compact"> +<dt><span><samp>seek</samp></span></dt> +<dd><p>Perform seek using "av_seek_frame". +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><span><samp>get_duration</samp></span></dt> +<dd><p>Get movie duration in AV_TIME_BASE units. +</p> +</dd> +</dl> + + +<a name="See-Also"></a> +<h2 class="chapter">18 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="ffmpeg.html">ffmpeg</a>, <a href="ffplay.html">ffplay</a>, <a href="ffprobe.html">ffprobe</a>, +<a href="libavfilter.html">libavfilter</a> +</p> + +<a name="Authors"></a> +<h2 class="chapter">19 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="https://www.gnu.org/software/texinfo/"><em>makeinfo</em></a>. + </p> + </div> + </body> +</html> |