<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by , GNU Texinfo 7.0.1 -->
<head>
<meta charset="utf-8">
<title>
ffplay 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>
ffplay Documentation
</h1>
<div class="top-level-extent" id="SEC_Top">
<div class="element-contents" id="SEC_Contents">
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="toc-numbered-mark">
<li><a id="toc-Synopsis" href="#Synopsis">1 Synopsis</a></li>
<li><a id="toc-Description" href="#Description">2 Description</a></li>
<li><a id="toc-Options" href="#Options">3 Options</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Stream-specifiers-1" href="#Stream-specifiers-1">3.1 Stream specifiers</a></li>
<li><a id="toc-Generic-options" href="#Generic-options">3.2 Generic options</a></li>
<li><a id="toc-AVOptions" href="#AVOptions">3.3 AVOptions</a></li>
<li><a id="toc-Main-options" href="#Main-options">3.4 Main options</a></li>
<li><a id="toc-Advanced-options" href="#Advanced-options">3.5 Advanced options</a></li>
<li><a id="toc-While-playing" href="#While-playing">3.6 While playing</a></li>
</ul></li>
<li><a id="toc-Syntax" href="#Syntax">4 Syntax</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Quoting-and-escaping" href="#Quoting-and-escaping">4.1 Quoting and escaping</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples" href="#Examples">4.1.1 Examples</a></li>
</ul></li>
<li><a id="toc-Date" href="#Date">4.2 Date</a></li>
<li><a id="toc-Time-duration" href="#Time-duration">4.3 Time duration</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-1" href="#Examples-1">4.3.1 Examples</a></li>
</ul></li>
<li><a id="toc-Video-size" href="#Video-size">4.4 Video size</a></li>
<li><a id="toc-Video-rate" href="#Video-rate">4.5 Video rate</a></li>
<li><a id="toc-Ratio" href="#Ratio">4.6 Ratio</a></li>
<li><a id="toc-Color" href="#Color">4.7 Color</a></li>
<li><a id="toc-Channel-Layout" href="#Channel-Layout">4.8 Channel Layout</a></li>
</ul></li>
<li><a id="toc-Expression-Evaluation" href="#Expression-Evaluation">5 Expression Evaluation</a></li>
<li><a id="toc-Codec-Options" href="#Codec-Options">6 Codec Options</a></li>
<li><a id="toc-Decoders" href="#Decoders">7 Decoders</a></li>
<li><a id="toc-Video-Decoders" href="#Video-Decoders">8 Video Decoders</a>
<ul class="toc-numbered-mark">
<li><a id="toc-av1" href="#av1">8.1 av1</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-1" href="#Options-1">8.1.1 Options</a></li>
</ul></li>
<li><a id="toc-rawvideo" href="#rawvideo">8.2 rawvideo</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-2" href="#Options-2">8.2.1 Options</a></li>
</ul></li>
<li><a id="toc-libdav1d" href="#libdav1d">8.3 libdav1d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-3" href="#Options-3">8.3.1 Options</a></li>
</ul></li>
<li><a id="toc-libdavs2" href="#libdavs2">8.4 libdavs2</a></li>
<li><a id="toc-libuavs3d" href="#libuavs3d">8.5 libuavs3d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-4" href="#Options-4">8.5.1 Options</a></li>
</ul></li>
<li><a id="toc-QSV-Decoders" href="#QSV-Decoders">8.6 QSV Decoders</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Common-Options" href="#Common-Options">8.6.1 Common Options</a></li>
<li><a id="toc-HEVC-Options" href="#HEVC-Options">8.6.2 HEVC Options</a></li>
</ul></li>
<li><a id="toc-v210" href="#v210">8.7 v210</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-5" href="#Options-5">8.7.1 Options</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Audio-Decoders" href="#Audio-Decoders">9 Audio Decoders</a>
<ul class="toc-numbered-mark">
<li><a id="toc-ac3" href="#ac3">9.1 ac3</a>
<ul class="toc-numbered-mark">
<li><a id="toc-AC_002d3-Decoder-Options" href="#AC_002d3-Decoder-Options">9.1.1 AC-3 Decoder Options</a></li>
</ul></li>
<li><a id="toc-flac" href="#flac">9.2 flac</a>
<ul class="toc-numbered-mark">
<li><a id="toc-FLAC-Decoder-options" href="#FLAC-Decoder-options">9.2.1 FLAC Decoder options</a></li>
</ul></li>
<li><a id="toc-ffwavesynth" href="#ffwavesynth">9.3 ffwavesynth</a></li>
<li><a id="toc-libcelt" href="#libcelt">9.4 libcelt</a></li>
<li><a id="toc-libgsm" href="#libgsm">9.5 libgsm</a></li>
<li><a id="toc-libilbc" href="#libilbc">9.6 libilbc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-6" href="#Options-6">9.6.1 Options</a></li>
</ul></li>
<li><a id="toc-libopencore_002damrnb" href="#libopencore_002damrnb">9.7 libopencore-amrnb</a></li>
<li><a id="toc-libopencore_002damrwb" href="#libopencore_002damrwb">9.8 libopencore-amrwb</a></li>
<li><a id="toc-libopus" href="#libopus">9.9 libopus</a></li>
</ul></li>
<li><a id="toc-Subtitles-Decoders" href="#Subtitles-Decoders">10 Subtitles Decoders</a>
<ul class="toc-numbered-mark">
<li><a id="toc-libaribb24" href="#libaribb24">10.1 libaribb24</a>
<ul class="toc-numbered-mark">
<li><a id="toc-libaribb24-Decoder-Options" href="#libaribb24-Decoder-Options">10.1.1 libaribb24 Decoder Options</a></li>
</ul></li>
<li><a id="toc-libaribcaption" href="#libaribcaption">10.2 libaribcaption</a>
<ul class="toc-numbered-mark">
<li><a id="toc-libaribcaption-Decoder-Options" href="#libaribcaption-Decoder-Options">10.2.1 libaribcaption Decoder Options</a></li>
<li><a id="toc-libaribcaption-decoder-usage-examples" href="#libaribcaption-decoder-usage-examples">10.2.2 libaribcaption decoder usage examples</a></li>
</ul></li>
<li><a id="toc-dvbsub" href="#dvbsub">10.3 dvbsub</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-7" href="#Options-7">10.3.1 Options</a></li>
</ul></li>
<li><a id="toc-dvdsub" href="#dvdsub">10.4 dvdsub</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-8" href="#Options-8">10.4.1 Options</a></li>
</ul></li>
<li><a id="toc-libzvbi_002dteletext" href="#libzvbi_002dteletext">10.5 libzvbi-teletext</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-9" href="#Options-9">10.5.1 Options</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Bitstream-Filters" href="#Bitstream-Filters">11 Bitstream Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-aac_005fadtstoasc" href="#aac_005fadtstoasc">11.1 aac_adtstoasc</a></li>
<li><a id="toc-av1_005fmetadata" href="#av1_005fmetadata">11.2 av1_metadata</a></li>
<li><a id="toc-chomp" href="#chomp">11.3 chomp</a></li>
<li><a id="toc-dca_005fcore" href="#dca_005fcore">11.4 dca_core</a></li>
<li><a id="toc-dump_005fextra" href="#dump_005fextra">11.5 dump_extra</a></li>
<li><a id="toc-dv_005ferror_005fmarker" href="#dv_005ferror_005fmarker">11.6 dv_error_marker</a></li>
<li><a id="toc-eac3_005fcore" href="#eac3_005fcore">11.7 eac3_core</a></li>
<li><a id="toc-extract_005fextradata" href="#extract_005fextradata">11.8 extract_extradata</a></li>
<li><a id="toc-filter_005funits" href="#filter_005funits">11.9 filter_units</a></li>
<li><a id="toc-hapqa_005fextract" href="#hapqa_005fextract">11.10 hapqa_extract</a></li>
<li><a id="toc-h264_005fmetadata" href="#h264_005fmetadata">11.11 h264_metadata</a></li>
<li><a id="toc-h264_005fmp4toannexb" href="#h264_005fmp4toannexb">11.12 h264_mp4toannexb</a></li>
<li><a id="toc-h264_005fredundant_005fpps" href="#h264_005fredundant_005fpps">11.13 h264_redundant_pps</a></li>
<li><a id="toc-hevc_005fmetadata" href="#hevc_005fmetadata">11.14 hevc_metadata</a></li>
<li><a id="toc-hevc_005fmp4toannexb" href="#hevc_005fmp4toannexb">11.15 hevc_mp4toannexb</a></li>
<li><a id="toc-imxdump" href="#imxdump">11.16 imxdump</a></li>
<li><a id="toc-mjpeg2jpeg" href="#mjpeg2jpeg">11.17 mjpeg2jpeg</a></li>
<li><a id="toc-mjpegadump" href="#mjpegadump">11.18 mjpegadump</a></li>
<li><a id="toc-mov2textsub-1" href="#mov2textsub-1">11.19 mov2textsub</a></li>
<li><a id="toc-mp3decomp" href="#mp3decomp">11.20 mp3decomp</a></li>
<li><a id="toc-mpeg2_005fmetadata" href="#mpeg2_005fmetadata">11.21 mpeg2_metadata</a></li>
<li><a id="toc-mpeg4_005funpack_005fbframes" href="#mpeg4_005funpack_005fbframes">11.22 mpeg4_unpack_bframes</a></li>
<li><a id="toc-noise" href="#noise">11.23 noise</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-2" href="#Examples-2">11.23.1 Examples</a></li>
</ul></li>
<li><a id="toc-null" href="#null">11.24 null</a></li>
<li><a id="toc-pcm_005frechunk" href="#pcm_005frechunk">11.25 pcm_rechunk</a></li>
<li><a id="toc-pgs_005fframe_005fmerge" href="#pgs_005fframe_005fmerge">11.26 pgs_frame_merge</a></li>
<li><a id="toc-prores_005fmetadata" href="#prores_005fmetadata">11.27 prores_metadata</a></li>
<li><a id="toc-remove_005fextra" href="#remove_005fextra">11.28 remove_extra</a></li>
<li><a id="toc-setts" href="#setts">11.29 setts</a></li>
<li><a id="toc-text2movsub-1" href="#text2movsub-1">11.30 text2movsub</a></li>
<li><a id="toc-trace_005fheaders" href="#trace_005fheaders">11.31 trace_headers</a></li>
<li><a id="toc-truehd_005fcore" href="#truehd_005fcore">11.32 truehd_core</a></li>
<li><a id="toc-vp9_005fmetadata" href="#vp9_005fmetadata">11.33 vp9_metadata</a></li>
<li><a id="toc-vp9_005fsuperframe" href="#vp9_005fsuperframe">11.34 vp9_superframe</a></li>
<li><a id="toc-vp9_005fsuperframe_005fsplit" href="#vp9_005fsuperframe_005fsplit">11.35 vp9_superframe_split</a></li>
<li><a id="toc-vp9_005fraw_005freorder" href="#vp9_005fraw_005freorder">11.36 vp9_raw_reorder</a></li>
</ul></li>
<li><a id="toc-Format-Options" href="#Format-Options">12 Format Options</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Format-stream-specifiers-1" href="#Format-stream-specifiers-1">12.1 Format stream specifiers</a></li>
</ul></li>
<li><a id="toc-Demuxers" href="#Demuxers">13 Demuxers</a>
<ul class="toc-numbered-mark">
<li><a id="toc-aa" href="#aa">13.1 aa</a></li>
<li><a id="toc-aac" href="#aac">13.2 aac</a></li>
<li><a id="toc-apng" href="#apng">13.3 apng</a></li>
<li><a id="toc-asf" href="#asf">13.4 asf</a></li>
<li><a id="toc-concat-1" href="#concat-1">13.5 concat</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Syntax-1" href="#Syntax-1">13.5.1 Syntax</a></li>
<li><a id="toc-Options-10" href="#Options-10">13.5.2 Options</a></li>
<li><a id="toc-Examples-3" href="#Examples-3">13.5.3 Examples</a></li>
</ul></li>
<li><a id="toc-dash" href="#dash">13.6 dash</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-11" href="#Options-11">13.6.1 Options</a></li>
</ul></li>
<li><a id="toc-ea" href="#ea">13.7 ea</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-12" href="#Options-12">13.7.1 Options</a></li>
</ul></li>
<li><a id="toc-imf" href="#imf">13.8 imf</a></li>
<li><a id="toc-flv_002c-live_005fflv_002c-kux" href="#flv_002c-live_005fflv_002c-kux">13.9 flv, live_flv, kux</a></li>
<li><a id="toc-gif" href="#gif">13.10 gif</a></li>
<li><a id="toc-hls" href="#hls">13.11 hls</a></li>
<li><a id="toc-image2" href="#image2">13.12 image2</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-4" href="#Examples-4">13.12.1 Examples</a></li>
</ul></li>
<li><a id="toc-libgme" href="#libgme">13.13 libgme</a></li>
<li><a id="toc-libmodplug" href="#libmodplug">13.14 libmodplug</a></li>
<li><a id="toc-libopenmpt" href="#libopenmpt">13.15 libopenmpt</a></li>
<li><a id="toc-mov_002fmp4_002f3gp" href="#mov_002fmp4_002f3gp">13.16 mov/mp4/3gp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-13" href="#Options-13">13.16.1 Options</a></li>
<li><a id="toc-Audible-AAX" href="#Audible-AAX">13.16.2 Audible AAX</a></li>
</ul></li>
<li><a id="toc-mpegts" href="#mpegts">13.17 mpegts</a></li>
<li><a id="toc-mpjpeg" href="#mpjpeg">13.18 mpjpeg</a></li>
<li><a id="toc-rawvideo-1" href="#rawvideo-1">13.19 rawvideo</a></li>
<li><a id="toc-sbg" href="#sbg">13.20 sbg</a></li>
<li><a id="toc-tedcaptions" href="#tedcaptions">13.21 tedcaptions</a></li>
<li><a id="toc-vapoursynth" href="#vapoursynth">13.22 vapoursynth</a></li>
</ul></li>
<li><a id="toc-Metadata" href="#Metadata">14 Metadata</a></li>
<li><a id="toc-Protocol-Options" href="#Protocol-Options">15 Protocol Options</a></li>
<li><a id="toc-Protocols" href="#Protocols">16 Protocols</a>
<ul class="toc-numbered-mark">
<li><a id="toc-amqp" href="#amqp">16.1 amqp</a></li>
<li><a id="toc-async" href="#async">16.2 async</a></li>
<li><a id="toc-bluray" href="#bluray">16.3 bluray</a></li>
<li><a id="toc-cache" href="#cache">16.4 cache</a></li>
<li><a id="toc-concat-2" href="#concat-2">16.5 concat</a></li>
<li><a id="toc-concatf" href="#concatf">16.6 concatf</a></li>
<li><a id="toc-crypto" href="#crypto">16.7 crypto</a></li>
<li><a id="toc-data" href="#data">16.8 data</a></li>
<li><a id="toc-fd" href="#fd">16.9 fd</a></li>
<li><a id="toc-file" href="#file">16.10 file</a></li>
<li><a id="toc-ftp" href="#ftp">16.11 ftp</a></li>
<li><a id="toc-gopher" href="#gopher">16.12 gopher</a></li>
<li><a id="toc-gophers" href="#gophers">16.13 gophers</a></li>
<li><a id="toc-hls-1" href="#hls-1">16.14 hls</a></li>
<li><a id="toc-http" href="#http">16.15 http</a>
<ul class="toc-numbered-mark">
<li><a id="toc-HTTP-Cookies" href="#HTTP-Cookies">16.15.1 HTTP Cookies</a></li>
</ul></li>
<li><a id="toc-Icecast" href="#Icecast">16.16 Icecast</a></li>
<li><a id="toc-ipfs" href="#ipfs">16.17 ipfs</a></li>
<li><a id="toc-mmst" href="#mmst">16.18 mmst</a></li>
<li><a id="toc-mmsh" href="#mmsh">16.19 mmsh</a></li>
<li><a id="toc-md5" href="#md5">16.20 md5</a></li>
<li><a id="toc-pipe" href="#pipe">16.21 pipe</a></li>
<li><a id="toc-prompeg" href="#prompeg">16.22 prompeg</a></li>
<li><a id="toc-rist" href="#rist">16.23 rist</a></li>
<li><a id="toc-rtmp" href="#rtmp">16.24 rtmp</a></li>
<li><a id="toc-rtmpe" href="#rtmpe">16.25 rtmpe</a></li>
<li><a id="toc-rtmps" href="#rtmps">16.26 rtmps</a></li>
<li><a id="toc-rtmpt" href="#rtmpt">16.27 rtmpt</a></li>
<li><a id="toc-rtmpte" href="#rtmpte">16.28 rtmpte</a></li>
<li><a id="toc-rtmpts" href="#rtmpts">16.29 rtmpts</a></li>
<li><a id="toc-libsmbclient" href="#libsmbclient">16.30 libsmbclient</a></li>
<li><a id="toc-libssh" href="#libssh">16.31 libssh</a></li>
<li><a id="toc-librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte">16.32 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte</a></li>
<li><a id="toc-rtp" href="#rtp">16.33 rtp</a></li>
<li><a id="toc-rtsp" href="#rtsp">16.34 rtsp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Muxer" href="#Muxer">16.34.1 Muxer</a></li>
<li><a id="toc-Demuxer" href="#Demuxer">16.34.2 Demuxer</a></li>
<li><a id="toc-Examples-5" href="#Examples-5">16.34.3 Examples</a></li>
</ul></li>
<li><a id="toc-sap" href="#sap">16.35 sap</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Muxer-1" href="#Muxer-1">16.35.1 Muxer</a></li>
<li><a id="toc-Demuxer-1" href="#Demuxer-1">16.35.2 Demuxer</a></li>
</ul></li>
<li><a id="toc-sctp" href="#sctp">16.36 sctp</a></li>
<li><a id="toc-srt" href="#srt">16.37 srt</a></li>
<li><a id="toc-srtp" href="#srtp">16.38 srtp</a></li>
<li><a id="toc-subfile" href="#subfile">16.39 subfile</a></li>
<li><a id="toc-tee" href="#tee">16.40 tee</a></li>
<li><a id="toc-tcp" href="#tcp">16.41 tcp</a></li>
<li><a id="toc-tls" href="#tls">16.42 tls</a></li>
<li><a id="toc-udp" href="#udp">16.43 udp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-6" href="#Examples-6">16.43.1 Examples</a></li>
</ul></li>
<li><a id="toc-unix" href="#unix">16.44 unix</a></li>
<li><a id="toc-zmq" href="#zmq">16.45 zmq</a></li>
</ul></li>
<li><a id="toc-Device-Options" href="#Device-Options">17 Device Options</a></li>
<li><a id="toc-Input-Devices" href="#Input-Devices">18 Input Devices</a>
<ul class="toc-numbered-mark">
<li><a id="toc-alsa" href="#alsa">18.1 alsa</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-14" href="#Options-14">18.1.1 Options</a></li>
</ul></li>
<li><a id="toc-android_005fcamera" href="#android_005fcamera">18.2 android_camera</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-15" href="#Options-15">18.2.1 Options</a></li>
</ul></li>
<li><a id="toc-avfoundation" href="#avfoundation">18.3 avfoundation</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-16" href="#Options-16">18.3.1 Options</a></li>
<li><a id="toc-Examples-7" href="#Examples-7">18.3.2 Examples</a></li>
</ul></li>
<li><a id="toc-bktr" href="#bktr">18.4 bktr</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-17" href="#Options-17">18.4.1 Options</a></li>
</ul></li>
<li><a id="toc-decklink" href="#decklink">18.5 decklink</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-18" href="#Options-18">18.5.1 Options</a></li>
<li><a id="toc-Examples-8" href="#Examples-8">18.5.2 Examples</a></li>
</ul></li>
<li><a id="toc-dshow" href="#dshow">18.6 dshow</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-19" href="#Options-19">18.6.1 Options</a></li>
<li><a id="toc-Examples-9" href="#Examples-9">18.6.2 Examples</a></li>
</ul></li>
<li><a id="toc-fbdev" href="#fbdev">18.7 fbdev</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-20" href="#Options-20">18.7.1 Options</a></li>
</ul></li>
<li><a id="toc-gdigrab" href="#gdigrab">18.8 gdigrab</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-21" href="#Options-21">18.8.1 Options</a></li>
</ul></li>
<li><a id="toc-iec61883" href="#iec61883">18.9 iec61883</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-22" href="#Options-22">18.9.1 Options</a></li>
<li><a id="toc-Examples-10" href="#Examples-10">18.9.2 Examples</a></li>
</ul></li>
<li><a id="toc-jack" href="#jack">18.10 jack</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-23" href="#Options-23">18.10.1 Options</a></li>
</ul></li>
<li><a id="toc-kmsgrab" href="#kmsgrab">18.11 kmsgrab</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-24" href="#Options-24">18.11.1 Options</a></li>
<li><a id="toc-Examples-11" href="#Examples-11">18.11.2 Examples</a></li>
</ul></li>
<li><a id="toc-lavfi" href="#lavfi">18.12 lavfi</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-25" href="#Options-25">18.12.1 Options</a></li>
<li><a id="toc-Examples-12" href="#Examples-12">18.12.2 Examples</a></li>
</ul></li>
<li><a id="toc-libcdio" href="#libcdio">18.13 libcdio</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-26" href="#Options-26">18.13.1 Options</a></li>
</ul></li>
<li><a id="toc-libdc1394" href="#libdc1394">18.14 libdc1394</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-27" href="#Options-27">18.14.1 Options</a></li>
</ul></li>
<li><a id="toc-openal" href="#openal">18.15 openal</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-28" href="#Options-28">18.15.1 Options</a></li>
<li><a id="toc-Examples-13" href="#Examples-13">18.15.2 Examples</a></li>
</ul></li>
<li><a id="toc-oss" href="#oss">18.16 oss</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-29" href="#Options-29">18.16.1 Options</a></li>
</ul></li>
<li><a id="toc-pulse" href="#pulse">18.17 pulse</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-30" href="#Options-30">18.17.1 Options</a></li>
<li><a id="toc-Examples-14" href="#Examples-14">18.17.2 Examples</a></li>
</ul></li>
<li><a id="toc-sndio" href="#sndio">18.18 sndio</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-31" href="#Options-31">18.18.1 Options</a></li>
</ul></li>
<li><a id="toc-video4linux2_002c-v4l2" href="#video4linux2_002c-v4l2">18.19 video4linux2, v4l2</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-32" href="#Options-32">18.19.1 Options</a></li>
</ul></li>
<li><a id="toc-vfwcap" href="#vfwcap">18.20 vfwcap</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-33" href="#Options-33">18.20.1 Options</a></li>
</ul></li>
<li><a id="toc-x11grab" href="#x11grab">18.21 x11grab</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-34" href="#Options-34">18.21.1 Options</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Resampler-Options" href="#Resampler-Options">19 Resampler Options</a></li>
<li><a id="toc-Scaler-Options" href="#Scaler-Options">20 Scaler Options</a></li>
<li><a id="toc-Filtering-Introduction" href="#Filtering-Introduction">21 Filtering Introduction</a></li>
<li><a id="toc-graph2dot" href="#graph2dot">22 graph2dot</a></li>
<li><a id="toc-Filtergraph-description" href="#Filtergraph-description">23 Filtergraph description</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Filtergraph-syntax-1" href="#Filtergraph-syntax-1">23.1 Filtergraph syntax</a></li>
<li><a id="toc-Notes-on-filtergraph-escaping" href="#Notes-on-filtergraph-escaping">23.2 Notes on filtergraph escaping</a></li>
</ul></li>
<li><a id="toc-Timeline-editing" href="#Timeline-editing">24 Timeline editing</a></li>
<li><a id="toc-Changing-options-at-runtime-with-a-command" href="#Changing-options-at-runtime-with-a-command">25 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">26 Options for filters with several inputs (framesync)</a></li>
<li><a id="toc-Audio-Filters" href="#Audio-Filters">27 Audio Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-acompressor" href="#acompressor">27.1 acompressor</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands" href="#Commands">27.1.1 Commands</a></li>
</ul></li>
<li><a id="toc-acontrast" href="#acontrast">27.2 acontrast</a></li>
<li><a id="toc-acopy" href="#acopy">27.3 acopy</a></li>
<li><a id="toc-acrossfade" href="#acrossfade">27.4 acrossfade</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-15" href="#Examples-15">27.4.1 Examples</a></li>
</ul></li>
<li><a id="toc-acrossover" href="#acrossover">27.5 acrossover</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-16" href="#Examples-16">27.5.1 Examples</a></li>
</ul></li>
<li><a id="toc-acrusher" href="#acrusher">27.6 acrusher</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-1" href="#Commands-1">27.6.1 Commands</a></li>
</ul></li>
<li><a id="toc-acue" href="#acue">27.7 acue</a></li>
<li><a id="toc-adeclick" href="#adeclick">27.8 adeclick</a></li>
<li><a id="toc-adeclip" href="#adeclip">27.9 adeclip</a></li>
<li><a id="toc-adecorrelate" href="#adecorrelate">27.10 adecorrelate</a></li>
<li><a id="toc-adelay" href="#adelay">27.11 adelay</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-17" href="#Examples-17">27.11.1 Examples</a></li>
</ul></li>
<li><a id="toc-adenorm" href="#adenorm">27.12 adenorm</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-2" href="#Commands-2">27.12.1 Commands</a></li>
</ul></li>
<li><a id="toc-aderivative_002c-aintegral" href="#aderivative_002c-aintegral">27.13 aderivative, aintegral</a></li>
<li><a id="toc-adrc" href="#adrc">27.14 adrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-3" href="#Commands-3">27.14.1 Commands</a></li>
<li><a id="toc-Examples-18" href="#Examples-18">27.14.2 Examples</a></li>
</ul></li>
<li><a id="toc-adynamicequalizer" href="#adynamicequalizer">27.15 adynamicequalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-4" href="#Commands-4">27.15.1 Commands</a></li>
</ul></li>
<li><a id="toc-adynamicsmooth" href="#adynamicsmooth">27.16 adynamicsmooth</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-5" href="#Commands-5">27.16.1 Commands</a></li>
</ul></li>
<li><a id="toc-aecho" href="#aecho">27.17 aecho</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-19" href="#Examples-19">27.17.1 Examples</a></li>
</ul></li>
<li><a id="toc-aemphasis" href="#aemphasis">27.18 aemphasis</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-6" href="#Commands-6">27.18.1 Commands</a></li>
</ul></li>
<li><a id="toc-aeval" href="#aeval">27.19 aeval</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-20" href="#Examples-20">27.19.1 Examples</a></li>
</ul></li>
<li><a id="toc-aexciter" href="#aexciter">27.20 aexciter</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-7" href="#Commands-7">27.20.1 Commands</a></li>
</ul></li>
<li><a id="toc-afade-1" href="#afade-1">27.21 afade</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-8" href="#Commands-8">27.21.1 Commands</a></li>
<li><a id="toc-Examples-21" href="#Examples-21">27.21.2 Examples</a></li>
</ul></li>
<li><a id="toc-afftdn" href="#afftdn">27.22 afftdn</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-9" href="#Commands-9">27.22.1 Commands</a></li>
<li><a id="toc-Examples-22" href="#Examples-22">27.22.2 Examples</a></li>
</ul></li>
<li><a id="toc-afftfilt" href="#afftfilt">27.23 afftfilt</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-23" href="#Examples-23">27.23.1 Examples</a></li>
</ul></li>
<li><a id="toc-afir-1" href="#afir-1">27.24 afir</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-24" href="#Examples-24">27.24.1 Examples</a></li>
</ul></li>
<li><a id="toc-aformat-1" href="#aformat-1">27.25 aformat</a></li>
<li><a id="toc-afreqshift" href="#afreqshift">27.26 afreqshift</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-10" href="#Commands-10">27.26.1 Commands</a></li>
</ul></li>
<li><a id="toc-afwtdn" href="#afwtdn">27.27 afwtdn</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-11" href="#Commands-11">27.27.1 Commands</a></li>
</ul></li>
<li><a id="toc-agate" href="#agate">27.28 agate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-12" href="#Commands-12">27.28.1 Commands</a></li>
</ul></li>
<li><a id="toc-aiir" href="#aiir">27.29 aiir</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-25" href="#Examples-25">27.29.1 Examples</a></li>
</ul></li>
<li><a id="toc-alimiter" href="#alimiter">27.30 alimiter</a></li>
<li><a id="toc-allpass" href="#allpass">27.31 allpass</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-13" href="#Commands-13">27.31.1 Commands</a></li>
</ul></li>
<li><a id="toc-aloop" href="#aloop">27.32 aloop</a></li>
<li><a id="toc-amerge-1" href="#amerge-1">27.33 amerge</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-26" href="#Examples-26">27.33.1 Examples</a></li>
</ul></li>
<li><a id="toc-amix" href="#amix">27.34 amix</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-27" href="#Examples-27">27.34.1 Examples</a></li>
<li><a id="toc-Commands-14" href="#Commands-14">27.34.2 Commands</a></li>
</ul></li>
<li><a id="toc-amultiply" href="#amultiply">27.35 amultiply</a></li>
<li><a id="toc-anequalizer" href="#anequalizer">27.36 anequalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-28" href="#Examples-28">27.36.1 Examples</a></li>
<li><a id="toc-Commands-15" href="#Commands-15">27.36.2 Commands</a></li>
</ul></li>
<li><a id="toc-anlmdn" href="#anlmdn">27.37 anlmdn</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-16" href="#Commands-16">27.37.1 Commands</a></li>
</ul></li>
<li><a id="toc-anlmf_002c-anlms" href="#anlmf_002c-anlms">27.38 anlmf, anlms</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-29" href="#Examples-29">27.38.1 Examples</a></li>
<li><a id="toc-Commands-17" href="#Commands-17">27.38.2 Commands</a></li>
</ul></li>
<li><a id="toc-anull" href="#anull">27.39 anull</a></li>
<li><a id="toc-apad" href="#apad">27.40 apad</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-30" href="#Examples-30">27.40.1 Examples</a></li>
</ul></li>
<li><a id="toc-aphaser" href="#aphaser">27.41 aphaser</a></li>
<li><a id="toc-aphaseshift" href="#aphaseshift">27.42 aphaseshift</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-18" href="#Commands-18">27.42.1 Commands</a></li>
</ul></li>
<li><a id="toc-apsnr" href="#apsnr">27.43 apsnr</a></li>
<li><a id="toc-apsyclip" href="#apsyclip">27.44 apsyclip</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-19" href="#Commands-19">27.44.1 Commands</a></li>
</ul></li>
<li><a id="toc-apulsator" href="#apulsator">27.45 apulsator</a></li>
<li><a id="toc-aresample-1" href="#aresample-1">27.46 aresample</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-31" href="#Examples-31">27.46.1 Examples</a></li>
</ul></li>
<li><a id="toc-areverse" href="#areverse">27.47 areverse</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-32" href="#Examples-32">27.47.1 Examples</a></li>
</ul></li>
<li><a id="toc-arls" href="#arls">27.48 arls</a></li>
<li><a id="toc-arnndn" href="#arnndn">27.49 arnndn</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-20" href="#Commands-20">27.49.1 Commands</a></li>
</ul></li>
<li><a id="toc-asdr" href="#asdr">27.50 asdr</a></li>
<li><a id="toc-asetnsamples" href="#asetnsamples">27.51 asetnsamples</a></li>
<li><a id="toc-asetrate" href="#asetrate">27.52 asetrate</a></li>
<li><a id="toc-ashowinfo" href="#ashowinfo">27.53 ashowinfo</a></li>
<li><a id="toc-asisdr" href="#asisdr">27.54 asisdr</a></li>
<li><a id="toc-asoftclip" href="#asoftclip">27.55 asoftclip</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-21" href="#Commands-21">27.55.1 Commands</a></li>
</ul></li>
<li><a id="toc-aspectralstats" href="#aspectralstats">27.56 aspectralstats</a></li>
<li><a id="toc-asr" href="#asr">27.57 asr</a></li>
<li><a id="toc-astats-1" href="#astats-1">27.58 astats</a></li>
<li><a id="toc-asubboost" href="#asubboost">27.59 asubboost</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-22" href="#Commands-22">27.59.1 Commands</a></li>
</ul></li>
<li><a id="toc-asubcut" href="#asubcut">27.60 asubcut</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-23" href="#Commands-23">27.60.1 Commands</a></li>
</ul></li>
<li><a id="toc-asupercut" href="#asupercut">27.61 asupercut</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-24" href="#Commands-24">27.61.1 Commands</a></li>
</ul></li>
<li><a id="toc-asuperpass" href="#asuperpass">27.62 asuperpass</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-25" href="#Commands-25">27.62.1 Commands</a></li>
</ul></li>
<li><a id="toc-asuperstop" href="#asuperstop">27.63 asuperstop</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-26" href="#Commands-26">27.63.1 Commands</a></li>
</ul></li>
<li><a id="toc-atempo" href="#atempo">27.64 atempo</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-33" href="#Examples-33">27.64.1 Examples</a></li>
<li><a id="toc-Commands-27" href="#Commands-27">27.64.2 Commands</a></li>
</ul></li>
<li><a id="toc-atilt" href="#atilt">27.65 atilt</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-28" href="#Commands-28">27.65.1 Commands</a></li>
</ul></li>
<li><a id="toc-atrim" href="#atrim">27.66 atrim</a></li>
<li><a id="toc-axcorrelate" href="#axcorrelate">27.67 axcorrelate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-34" href="#Examples-34">27.67.1 Examples</a></li>
</ul></li>
<li><a id="toc-bandpass" href="#bandpass">27.68 bandpass</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-29" href="#Commands-29">27.68.1 Commands</a></li>
</ul></li>
<li><a id="toc-bandreject" href="#bandreject">27.69 bandreject</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-30" href="#Commands-30">27.69.1 Commands</a></li>
</ul></li>
<li><a id="toc-bass_002c-lowshelf" href="#bass_002c-lowshelf">27.70 bass, lowshelf</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-31" href="#Commands-31">27.70.1 Commands</a></li>
</ul></li>
<li><a id="toc-biquad" href="#biquad">27.71 biquad</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-32" href="#Commands-32">27.71.1 Commands</a></li>
</ul></li>
<li><a id="toc-bs2b" href="#bs2b">27.72 bs2b</a></li>
<li><a id="toc-channelmap" href="#channelmap">27.73 channelmap</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-35" href="#Examples-35">27.73.1 Examples</a></li>
</ul></li>
<li><a id="toc-channelsplit" href="#channelsplit">27.74 channelsplit</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-36" href="#Examples-36">27.74.1 Examples</a></li>
</ul></li>
<li><a id="toc-chorus" href="#chorus">27.75 chorus</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-37" href="#Examples-37">27.75.1 Examples</a></li>
</ul></li>
<li><a id="toc-compand" href="#compand">27.76 compand</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-38" href="#Examples-38">27.76.1 Examples</a></li>
</ul></li>
<li><a id="toc-compensationdelay" href="#compensationdelay">27.77 compensationdelay</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-33" href="#Commands-33">27.77.1 Commands</a></li>
</ul></li>
<li><a id="toc-crossfeed" href="#crossfeed">27.78 crossfeed</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-34" href="#Commands-34">27.78.1 Commands</a></li>
</ul></li>
<li><a id="toc-crystalizer" href="#crystalizer">27.79 crystalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-35" href="#Commands-35">27.79.1 Commands</a></li>
</ul></li>
<li><a id="toc-dcshift" href="#dcshift">27.80 dcshift</a></li>
<li><a id="toc-deesser" href="#deesser">27.81 deesser</a></li>
<li><a id="toc-dialoguenhance" href="#dialoguenhance">27.82 dialoguenhance</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-36" href="#Commands-36">27.82.1 Commands</a></li>
</ul></li>
<li><a id="toc-drmeter" href="#drmeter">27.83 drmeter</a></li>
<li><a id="toc-dynaudnorm" href="#dynaudnorm">27.84 dynaudnorm</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-37" href="#Commands-37">27.84.1 Commands</a></li>
</ul></li>
<li><a id="toc-earwax" href="#earwax">27.85 earwax</a></li>
<li><a id="toc-equalizer" href="#equalizer">27.86 equalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-39" href="#Examples-39">27.86.1 Examples</a></li>
<li><a id="toc-Commands-38" href="#Commands-38">27.86.2 Commands</a></li>
</ul></li>
<li><a id="toc-extrastereo" href="#extrastereo">27.87 extrastereo</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-39" href="#Commands-39">27.87.1 Commands</a></li>
</ul></li>
<li><a id="toc-firequalizer" href="#firequalizer">27.88 firequalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-40" href="#Examples-40">27.88.1 Examples</a></li>
</ul></li>
<li><a id="toc-flanger" href="#flanger">27.89 flanger</a></li>
<li><a id="toc-haas" href="#haas">27.90 haas</a></li>
<li><a id="toc-hdcd" href="#hdcd">27.91 hdcd</a></li>
<li><a id="toc-headphone" href="#headphone">27.92 headphone</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-41" href="#Examples-41">27.92.1 Examples</a></li>
</ul></li>
<li><a id="toc-highpass" href="#highpass">27.93 highpass</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-40" href="#Commands-40">27.93.1 Commands</a></li>
</ul></li>
<li><a id="toc-join" href="#join">27.94 join</a></li>
<li><a id="toc-ladspa" href="#ladspa">27.95 ladspa</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-42" href="#Examples-42">27.95.1 Examples</a></li>
<li><a id="toc-Commands-41" href="#Commands-41">27.95.2 Commands</a></li>
</ul></li>
<li><a id="toc-loudnorm" href="#loudnorm">27.96 loudnorm</a></li>
<li><a id="toc-lowpass" href="#lowpass">27.97 lowpass</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-43" href="#Examples-43">27.97.1 Examples</a></li>
<li><a id="toc-Commands-42" href="#Commands-42">27.97.2 Commands</a></li>
</ul></li>
<li><a id="toc-lv2" href="#lv2">27.98 lv2</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-44" href="#Examples-44">27.98.1 Examples</a></li>
<li><a id="toc-Commands-43" href="#Commands-43">27.98.2 Commands</a></li>
</ul></li>
<li><a id="toc-mcompand" href="#mcompand">27.99 mcompand</a></li>
<li><a id="toc-pan-1" href="#pan-1">27.100 pan</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Mixing-examples" href="#Mixing-examples">27.100.1 Mixing examples</a></li>
<li><a id="toc-Remapping-examples" href="#Remapping-examples">27.100.2 Remapping examples</a></li>
</ul></li>
<li><a id="toc-replaygain" href="#replaygain">27.101 replaygain</a></li>
<li><a id="toc-resample" href="#resample">27.102 resample</a></li>
<li><a id="toc-rubberband" href="#rubberband">27.103 rubberband</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-44" href="#Commands-44">27.103.1 Commands</a></li>
</ul></li>
<li><a id="toc-sidechaincompress" href="#sidechaincompress">27.104 sidechaincompress</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-45" href="#Commands-45">27.104.1 Commands</a></li>
<li><a id="toc-Examples-45" href="#Examples-45">27.104.2 Examples</a></li>
</ul></li>
<li><a id="toc-sidechaingate" href="#sidechaingate">27.105 sidechaingate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-46" href="#Commands-46">27.105.1 Commands</a></li>
</ul></li>
<li><a id="toc-silencedetect" href="#silencedetect">27.106 silencedetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-46" href="#Examples-46">27.106.1 Examples</a></li>
</ul></li>
<li><a id="toc-silenceremove" href="#silenceremove">27.107 silenceremove</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-47" href="#Examples-47">27.107.1 Examples</a></li>
<li><a id="toc-Commands-47" href="#Commands-47">27.107.2 Commands</a></li>
</ul></li>
<li><a id="toc-sofalizer" href="#sofalizer">27.108 sofalizer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-48" href="#Examples-48">27.108.1 Examples</a></li>
</ul></li>
<li><a id="toc-speechnorm" href="#speechnorm">27.109 speechnorm</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-48" href="#Commands-48">27.109.1 Commands</a></li>
<li><a id="toc-Examples-49" href="#Examples-49">27.109.2 Examples</a></li>
</ul></li>
<li><a id="toc-stereotools" href="#stereotools">27.110 stereotools</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-49" href="#Commands-49">27.110.1 Commands</a></li>
<li><a id="toc-Examples-50" href="#Examples-50">27.110.2 Examples</a></li>
</ul></li>
<li><a id="toc-stereowiden" href="#stereowiden">27.111 stereowiden</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-50" href="#Commands-50">27.111.1 Commands</a></li>
</ul></li>
<li><a id="toc-superequalizer" href="#superequalizer">27.112 superequalizer</a></li>
<li><a id="toc-surround" href="#surround">27.113 surround</a></li>
<li><a id="toc-tiltshelf" href="#tiltshelf">27.114 tiltshelf</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-51" href="#Commands-51">27.114.1 Commands</a></li>
</ul></li>
<li><a id="toc-treble_002c-highshelf" href="#treble_002c-highshelf">27.115 treble, highshelf</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-52" href="#Commands-52">27.115.1 Commands</a></li>
</ul></li>
<li><a id="toc-tremolo" href="#tremolo">27.116 tremolo</a></li>
<li><a id="toc-vibrato" href="#vibrato">27.117 vibrato</a></li>
<li><a id="toc-virtualbass" href="#virtualbass">27.118 virtualbass</a></li>
<li><a id="toc-volume" href="#volume">27.119 volume</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-53" href="#Commands-53">27.119.1 Commands</a></li>
<li><a id="toc-Examples-51" href="#Examples-51">27.119.2 Examples</a></li>
</ul></li>
<li><a id="toc-volumedetect" href="#volumedetect">27.120 volumedetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-52" href="#Examples-52">27.120.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Audio-Sources" href="#Audio-Sources">28 Audio Sources</a>
<ul class="toc-numbered-mark">
<li><a id="toc-abuffer" href="#abuffer">28.1 abuffer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-53" href="#Examples-53">28.1.1 Examples</a></li>
</ul></li>
<li><a id="toc-aevalsrc" href="#aevalsrc">28.2 aevalsrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-54" href="#Examples-54">28.2.1 Examples</a></li>
</ul></li>
<li><a id="toc-afdelaysrc" href="#afdelaysrc">28.3 afdelaysrc</a></li>
<li><a id="toc-afireqsrc" href="#afireqsrc">28.4 afireqsrc</a></li>
<li><a id="toc-afirsrc" href="#afirsrc">28.5 afirsrc</a></li>
<li><a id="toc-anullsrc" href="#anullsrc">28.6 anullsrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-55" href="#Examples-55">28.6.1 Examples</a></li>
</ul></li>
<li><a id="toc-flite" href="#flite">28.7 flite</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-56" href="#Examples-56">28.7.1 Examples</a></li>
</ul></li>
<li><a id="toc-anoisesrc" href="#anoisesrc">28.8 anoisesrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-57" href="#Examples-57">28.8.1 Examples</a></li>
</ul></li>
<li><a id="toc-hilbert" href="#hilbert">28.9 hilbert</a></li>
<li><a id="toc-sinc" href="#sinc">28.10 sinc</a></li>
<li><a id="toc-sine" href="#sine">28.11 sine</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-58" href="#Examples-58">28.11.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Audio-Sinks" href="#Audio-Sinks">29 Audio Sinks</a>
<ul class="toc-numbered-mark">
<li><a id="toc-abuffersink" href="#abuffersink">29.1 abuffersink</a></li>
<li><a id="toc-anullsink" href="#anullsink">29.2 anullsink</a></li>
</ul></li>
<li><a id="toc-Video-Filters" href="#Video-Filters">30 Video Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-addroi" href="#addroi">30.1 addroi</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-59" href="#Examples-59">30.1.1 Examples</a></li>
</ul></li>
<li><a id="toc-alphaextract" href="#alphaextract">30.2 alphaextract</a></li>
<li><a id="toc-alphamerge" href="#alphamerge">30.3 alphamerge</a></li>
<li><a id="toc-amplify" href="#amplify">30.4 amplify</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-54" href="#Commands-54">30.4.1 Commands</a></li>
</ul></li>
<li><a id="toc-ass" href="#ass">30.5 ass</a></li>
<li><a id="toc-atadenoise" href="#atadenoise">30.6 atadenoise</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-55" href="#Commands-55">30.6.1 Commands</a></li>
</ul></li>
<li><a id="toc-avgblur" href="#avgblur">30.7 avgblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-56" href="#Commands-56">30.7.1 Commands</a></li>
</ul></li>
<li><a id="toc-backgroundkey" href="#backgroundkey">30.8 backgroundkey</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-57" href="#Commands-57">30.8.1 Commands</a></li>
</ul></li>
<li><a id="toc-bbox" href="#bbox">30.9 bbox</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-58" href="#Commands-58">30.9.1 Commands</a></li>
</ul></li>
<li><a id="toc-bilateral" href="#bilateral">30.10 bilateral</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-59" href="#Commands-59">30.10.1 Commands</a></li>
</ul></li>
<li><a id="toc-bilateral_005fcuda" href="#bilateral_005fcuda">30.11 bilateral_cuda</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-60" href="#Examples-60">30.11.1 Examples</a></li>
</ul></li>
<li><a id="toc-bitplanenoise" href="#bitplanenoise">30.12 bitplanenoise</a></li>
<li><a id="toc-blackdetect" href="#blackdetect">30.13 blackdetect</a></li>
<li><a id="toc-blackframe" href="#blackframe">30.14 blackframe</a></li>
<li><a id="toc-blend-1" href="#blend-1">30.15 blend</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-61" href="#Examples-61">30.15.1 Examples</a></li>
<li><a id="toc-Commands-60" href="#Commands-60">30.15.2 Commands</a></li>
</ul></li>
<li><a id="toc-blockdetect-1" href="#blockdetect-1">30.16 blockdetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-62" href="#Examples-62">30.16.1 Examples</a></li>
</ul></li>
<li><a id="toc-blurdetect-1" href="#blurdetect-1">30.17 blurdetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-63" href="#Examples-63">30.17.1 Examples</a></li>
</ul></li>
<li><a id="toc-bm3d" href="#bm3d">30.18 bm3d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-64" href="#Examples-64">30.18.1 Examples</a></li>
</ul></li>
<li><a id="toc-boxblur" href="#boxblur">30.19 boxblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-65" href="#Examples-65">30.19.1 Examples</a></li>
</ul></li>
<li><a id="toc-bwdif-1" href="#bwdif-1">30.20 bwdif</a></li>
<li><a id="toc-bwdif_005fcuda" href="#bwdif_005fcuda">30.21 bwdif_cuda</a></li>
<li><a id="toc-ccrepack" href="#ccrepack">30.22 ccrepack</a></li>
<li><a id="toc-cas" href="#cas">30.23 cas</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-61" href="#Commands-61">30.23.1 Commands</a></li>
</ul></li>
<li><a id="toc-chromahold" href="#chromahold">30.24 chromahold</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-62" href="#Commands-62">30.24.1 Commands</a></li>
</ul></li>
<li><a id="toc-chromakey-1" href="#chromakey-1">30.25 chromakey</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-63" href="#Commands-63">30.25.1 Commands</a></li>
<li><a id="toc-Examples-66" href="#Examples-66">30.25.2 Examples</a></li>
</ul></li>
<li><a id="toc-chromakey_005fcuda" href="#chromakey_005fcuda">30.26 chromakey_cuda</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-67" href="#Examples-67">30.26.1 Examples</a></li>
</ul></li>
<li><a id="toc-chromanr" href="#chromanr">30.27 chromanr</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-64" href="#Commands-64">30.27.1 Commands</a></li>
</ul></li>
<li><a id="toc-chromashift" href="#chromashift">30.28 chromashift</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-65" href="#Commands-65">30.28.1 Commands</a></li>
</ul></li>
<li><a id="toc-ciescope" href="#ciescope">30.29 ciescope</a></li>
<li><a id="toc-codecview" href="#codecview">30.30 codecview</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-68" href="#Examples-68">30.30.1 Examples</a></li>
</ul></li>
<li><a id="toc-colorbalance" href="#colorbalance">30.31 colorbalance</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-69" href="#Examples-69">30.31.1 Examples</a></li>
<li><a id="toc-Commands-66" href="#Commands-66">30.31.2 Commands</a></li>
</ul></li>
<li><a id="toc-colorcontrast" href="#colorcontrast">30.32 colorcontrast</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-67" href="#Commands-67">30.32.1 Commands</a></li>
</ul></li>
<li><a id="toc-colorcorrect" href="#colorcorrect">30.33 colorcorrect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-68" href="#Commands-68">30.33.1 Commands</a></li>
</ul></li>
<li><a id="toc-colorchannelmixer" href="#colorchannelmixer">30.34 colorchannelmixer</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-70" href="#Examples-70">30.34.1 Examples</a></li>
<li><a id="toc-Commands-69" href="#Commands-69">30.34.2 Commands</a></li>
</ul></li>
<li><a id="toc-colorize" href="#colorize">30.35 colorize</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-70" href="#Commands-70">30.35.1 Commands</a></li>
</ul></li>
<li><a id="toc-colorkey" href="#colorkey">30.36 colorkey</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-71" href="#Examples-71">30.36.1 Examples</a></li>
<li><a id="toc-Commands-71" href="#Commands-71">30.36.2 Commands</a></li>
</ul></li>
<li><a id="toc-colorhold" href="#colorhold">30.37 colorhold</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-72" href="#Commands-72">30.37.1 Commands</a></li>
</ul></li>
<li><a id="toc-colorlevels" href="#colorlevels">30.38 colorlevels</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-72" href="#Examples-72">30.38.1 Examples</a></li>
<li><a id="toc-Commands-73" href="#Commands-73">30.38.2 Commands</a></li>
</ul></li>
<li><a id="toc-colormap" href="#colormap">30.39 colormap</a></li>
<li><a id="toc-colormatrix" href="#colormatrix">30.40 colormatrix</a></li>
<li><a id="toc-colorspace" href="#colorspace">30.41 colorspace</a></li>
<li><a id="toc-colorspace_005fcuda" href="#colorspace_005fcuda">30.42 colorspace_cuda</a></li>
<li><a id="toc-colortemperature" href="#colortemperature">30.43 colortemperature</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-74" href="#Commands-74">30.43.1 Commands</a></li>
</ul></li>
<li><a id="toc-convolution" href="#convolution">30.44 convolution</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-75" href="#Commands-75">30.44.1 Commands</a></li>
<li><a id="toc-Examples-73" href="#Examples-73">30.44.2 Examples</a></li>
</ul></li>
<li><a id="toc-convolve" href="#convolve">30.45 convolve</a></li>
<li><a id="toc-copy" href="#copy">30.46 copy</a></li>
<li><a id="toc-coreimage-1" href="#coreimage-1">30.47 coreimage</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-74" href="#Examples-74">30.47.1 Examples</a></li>
</ul></li>
<li><a id="toc-corr" href="#corr">30.48 corr</a></li>
<li><a id="toc-cover_005frect" href="#cover_005frect">30.49 cover_rect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-75" href="#Examples-75">30.49.1 Examples</a></li>
</ul></li>
<li><a id="toc-crop" href="#crop">30.50 crop</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-76" href="#Examples-76">30.50.1 Examples</a></li>
<li><a id="toc-Commands-76" href="#Commands-76">30.50.2 Commands</a></li>
</ul></li>
<li><a id="toc-cropdetect" href="#cropdetect">30.51 cropdetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-77" href="#Examples-77">30.51.1 Examples</a></li>
<li><a id="toc-Commands-77" href="#Commands-77">30.51.2 Commands</a></li>
</ul></li>
<li><a id="toc-cue-1" href="#cue-1">30.52 cue</a></li>
<li><a id="toc-curves-1" href="#curves-1">30.53 curves</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-78" href="#Commands-78">30.53.1 Commands</a></li>
<li><a id="toc-Examples-78" href="#Examples-78">30.53.2 Examples</a></li>
</ul></li>
<li><a id="toc-datascope" href="#datascope">30.54 datascope</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-79" href="#Commands-79">30.54.1 Commands</a></li>
</ul></li>
<li><a id="toc-dblur" href="#dblur">30.55 dblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-80" href="#Commands-80">30.55.1 Commands</a></li>
</ul></li>
<li><a id="toc-dctdnoiz" href="#dctdnoiz">30.56 dctdnoiz</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-79" href="#Examples-79">30.56.1 Examples</a></li>
</ul></li>
<li><a id="toc-deband" href="#deband">30.57 deband</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-81" href="#Commands-81">30.57.1 Commands</a></li>
</ul></li>
<li><a id="toc-deblock" href="#deblock">30.58 deblock</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-80" href="#Examples-80">30.58.1 Examples</a></li>
<li><a id="toc-Commands-82" href="#Commands-82">30.58.2 Commands</a></li>
</ul></li>
<li><a id="toc-decimate-1" href="#decimate-1">30.59 decimate</a></li>
<li><a id="toc-deconvolve" href="#deconvolve">30.60 deconvolve</a></li>
<li><a id="toc-dedot" href="#dedot">30.61 dedot</a></li>
<li><a id="toc-deflate" href="#deflate">30.62 deflate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-83" href="#Commands-83">30.62.1 Commands</a></li>
</ul></li>
<li><a id="toc-deflicker" href="#deflicker">30.63 deflicker</a></li>
<li><a id="toc-dejudder" href="#dejudder">30.64 dejudder</a></li>
<li><a id="toc-delogo" href="#delogo">30.65 delogo</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-81" href="#Examples-81">30.65.1 Examples</a></li>
</ul></li>
<li><a id="toc-derain-1" href="#derain-1">30.66 derain</a></li>
<li><a id="toc-deshake" href="#deshake">30.67 deshake</a></li>
<li><a id="toc-despill" href="#despill">30.68 despill</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-84" href="#Commands-84">30.68.1 Commands</a></li>
</ul></li>
<li><a id="toc-detelecine" href="#detelecine">30.69 detelecine</a></li>
<li><a id="toc-dilation-1" href="#dilation-1">30.70 dilation</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-85" href="#Commands-85">30.70.1 Commands</a></li>
</ul></li>
<li><a id="toc-displace" href="#displace">30.71 displace</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-82" href="#Examples-82">30.71.1 Examples</a></li>
</ul></li>
<li><a id="toc-dnn_005fclassify" href="#dnn_005fclassify">30.72 dnn_classify</a></li>
<li><a id="toc-dnn_005fdetect" href="#dnn_005fdetect">30.73 dnn_detect</a></li>
<li><a id="toc-dnn_005fprocessing-1" href="#dnn_005fprocessing-1">30.74 dnn_processing</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-83" href="#Examples-83">30.74.1 Examples</a></li>
</ul></li>
<li><a id="toc-drawbox" href="#drawbox">30.75 drawbox</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-84" href="#Examples-84">30.75.1 Examples</a></li>
<li><a id="toc-Commands-86" href="#Commands-86">30.75.2 Commands</a></li>
</ul></li>
<li><a id="toc-drawgraph-1" href="#drawgraph-1">30.76 drawgraph</a></li>
<li><a id="toc-drawgrid" href="#drawgrid">30.77 drawgrid</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-85" href="#Examples-85">30.77.1 Examples</a></li>
<li><a id="toc-Commands-87" href="#Commands-87">30.77.2 Commands</a></li>
</ul></li>
<li><a id="toc-drawtext-1" href="#drawtext-1">30.78 drawtext</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Syntax-2" href="#Syntax-2">30.78.1 Syntax</a></li>
<li><a id="toc-Text-expansion" href="#Text-expansion">30.78.2 Text expansion</a></li>
<li><a id="toc-Commands-88" href="#Commands-88">30.78.3 Commands</a></li>
<li><a id="toc-Examples-86" href="#Examples-86">30.78.4 Examples</a></li>
</ul></li>
<li><a id="toc-edgedetect" href="#edgedetect">30.79 edgedetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-87" href="#Examples-87">30.79.1 Examples</a></li>
</ul></li>
<li><a id="toc-elbg" href="#elbg">30.80 elbg</a></li>
<li><a id="toc-entropy" href="#entropy">30.81 entropy</a></li>
<li><a id="toc-epx" href="#epx">30.82 epx</a></li>
<li><a id="toc-eq" href="#eq">30.83 eq</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-89" href="#Commands-89">30.83.1 Commands</a></li>
</ul></li>
<li><a id="toc-erosion-1" href="#erosion-1">30.84 erosion</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-90" href="#Commands-90">30.84.1 Commands</a></li>
</ul></li>
<li><a id="toc-estdif" href="#estdif">30.85 estdif</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-91" href="#Commands-91">30.85.1 Commands</a></li>
</ul></li>
<li><a id="toc-exposure" href="#exposure">30.86 exposure</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-92" href="#Commands-92">30.86.1 Commands</a></li>
</ul></li>
<li><a id="toc-extractplanes" href="#extractplanes">30.87 extractplanes</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-88" href="#Examples-88">30.87.1 Examples</a></li>
</ul></li>
<li><a id="toc-fade" href="#fade">30.88 fade</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-89" href="#Examples-89">30.88.1 Examples</a></li>
</ul></li>
<li><a id="toc-feedback" href="#feedback">30.89 feedback</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-90" href="#Examples-90">30.89.1 Examples</a></li>
</ul></li>
<li><a id="toc-fftdnoiz" href="#fftdnoiz">30.90 fftdnoiz</a></li>
<li><a id="toc-fftfilt" href="#fftfilt">30.91 fftfilt</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-91" href="#Examples-91">30.91.1 Examples</a></li>
</ul></li>
<li><a id="toc-field" href="#field">30.92 field</a></li>
<li><a id="toc-fieldhint" href="#fieldhint">30.93 fieldhint</a></li>
<li><a id="toc-fieldmatch" href="#fieldmatch">30.94 fieldmatch</a>
<ul class="toc-numbered-mark">
<li><a id="toc-p_002fc_002fn_002fu_002fb-meaning-1" href="#p_002fc_002fn_002fu_002fb-meaning-1">30.94.1 p/c/n/u/b meaning</a>
<ul class="toc-numbered-mark">
<li><a id="toc-p_002fc_002fn" href="#p_002fc_002fn">30.94.1.1 p/c/n</a></li>
<li><a id="toc-u_002fb" href="#u_002fb">30.94.1.2 u/b</a></li>
</ul></li>
<li><a id="toc-Examples-92" href="#Examples-92">30.94.2 Examples</a></li>
</ul></li>
<li><a id="toc-fieldorder" href="#fieldorder">30.95 fieldorder</a></li>
<li><a id="toc-fifo_002c-afifo" href="#fifo_002c-afifo">30.96 fifo, afifo</a></li>
<li><a id="toc-fillborders" href="#fillborders">30.97 fillborders</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-93" href="#Commands-93">30.97.1 Commands</a></li>
</ul></li>
<li><a id="toc-find_005frect" href="#find_005frect">30.98 find_rect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-93" href="#Examples-93">30.98.1 Examples</a></li>
</ul></li>
<li><a id="toc-floodfill" href="#floodfill">30.99 floodfill</a></li>
<li><a id="toc-format-1" href="#format-1">30.100 format</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-94" href="#Examples-94">30.100.1 Examples</a></li>
</ul></li>
<li><a id="toc-fps-1" href="#fps-1">30.101 fps</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-95" href="#Examples-95">30.101.1 Examples</a></li>
</ul></li>
<li><a id="toc-framepack" href="#framepack">30.102 framepack</a></li>
<li><a id="toc-framerate" href="#framerate">30.103 framerate</a></li>
<li><a id="toc-framestep" href="#framestep">30.104 framestep</a></li>
<li><a id="toc-freezedetect" href="#freezedetect">30.105 freezedetect</a></li>
<li><a id="toc-freezeframes" href="#freezeframes">30.106 freezeframes</a></li>
<li><a id="toc-frei0r-1" href="#frei0r-1">30.107 frei0r</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-96" href="#Examples-96">30.107.1 Examples</a></li>
<li><a id="toc-Commands-94" href="#Commands-94">30.107.2 Commands</a></li>
</ul></li>
<li><a id="toc-fspp" href="#fspp">30.108 fspp</a></li>
<li><a id="toc-gblur" href="#gblur">30.109 gblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-95" href="#Commands-95">30.109.1 Commands</a></li>
</ul></li>
<li><a id="toc-geq" href="#geq">30.110 geq</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-97" href="#Examples-97">30.110.1 Examples</a></li>
</ul></li>
<li><a id="toc-gradfun" href="#gradfun">30.111 gradfun</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-98" href="#Examples-98">30.111.1 Examples</a></li>
</ul></li>
<li><a id="toc-graphmonitor-1" href="#graphmonitor-1">30.112 graphmonitor</a></li>
<li><a id="toc-grayworld" href="#grayworld">30.113 grayworld</a></li>
<li><a id="toc-greyedge" href="#greyedge">30.114 greyedge</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-99" href="#Examples-99">30.114.1 Examples</a></li>
</ul></li>
<li><a id="toc-guided" href="#guided">30.115 guided</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-96" href="#Commands-96">30.115.1 Commands</a></li>
<li><a id="toc-Examples-100" href="#Examples-100">30.115.2 Examples</a></li>
</ul></li>
<li><a id="toc-haldclut-1" href="#haldclut-1">30.116 haldclut</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-97" href="#Commands-97">30.116.1 Commands</a></li>
<li><a id="toc-Workflow-examples" href="#Workflow-examples">30.116.2 Workflow examples</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Hald-CLUT-video-stream" href="#Hald-CLUT-video-stream">30.116.2.1 Hald CLUT video stream</a></li>
<li><a id="toc-Hald-CLUT-with-preview" href="#Hald-CLUT-with-preview">30.116.2.2 Hald CLUT with preview</a></li>
</ul></li>
</ul></li>
<li><a id="toc-hflip" href="#hflip">30.117 hflip</a></li>
<li><a id="toc-histeq" href="#histeq">30.118 histeq</a></li>
<li><a id="toc-histogram-1" href="#histogram-1">30.119 histogram</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-101" href="#Examples-101">30.119.1 Examples</a></li>
</ul></li>
<li><a id="toc-hqdn3d-1" href="#hqdn3d-1">30.120 hqdn3d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-98" href="#Commands-98">30.120.1 Commands</a></li>
</ul></li>
<li><a id="toc-hwdownload-1" href="#hwdownload-1">30.121 hwdownload</a></li>
<li><a id="toc-hwmap" href="#hwmap">30.122 hwmap</a></li>
<li><a id="toc-hwupload-1" href="#hwupload-1">30.123 hwupload</a></li>
<li><a id="toc-hwupload_005fcuda-1" href="#hwupload_005fcuda-1">30.124 hwupload_cuda</a></li>
<li><a id="toc-hqx" href="#hqx">30.125 hqx</a></li>
<li><a id="toc-hstack-1" href="#hstack-1">30.126 hstack</a></li>
<li><a id="toc-hsvhold" href="#hsvhold">30.127 hsvhold</a></li>
<li><a id="toc-hsvkey" href="#hsvkey">30.128 hsvkey</a></li>
<li><a id="toc-hue" href="#hue">30.129 hue</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-102" href="#Examples-102">30.129.1 Examples</a></li>
<li><a id="toc-Commands-99" href="#Commands-99">30.129.2 Commands</a></li>
</ul></li>
<li><a id="toc-huesaturation" href="#huesaturation">30.130 huesaturation</a></li>
<li><a id="toc-hysteresis" href="#hysteresis">30.131 hysteresis</a></li>
<li><a id="toc-iccdetect" href="#iccdetect">30.132 iccdetect</a></li>
<li><a id="toc-iccgen" href="#iccgen">30.133 iccgen</a></li>
<li><a id="toc-identity" href="#identity">30.134 identity</a></li>
<li><a id="toc-idet" href="#idet">30.135 idet</a></li>
<li><a id="toc-il" href="#il">30.136 il</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-100" href="#Commands-100">30.136.1 Commands</a></li>
</ul></li>
<li><a id="toc-inflate" href="#inflate">30.137 inflate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-101" href="#Commands-101">30.137.1 Commands</a></li>
</ul></li>
<li><a id="toc-interlace" href="#interlace">30.138 interlace</a></li>
<li><a id="toc-kerndeint" href="#kerndeint">30.139 kerndeint</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-103" href="#Examples-103">30.139.1 Examples</a></li>
</ul></li>
<li><a id="toc-kirsch" href="#kirsch">30.140 kirsch</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-102" href="#Commands-102">30.140.1 Commands</a></li>
</ul></li>
<li><a id="toc-lagfun" href="#lagfun">30.141 lagfun</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-103" href="#Commands-103">30.141.1 Commands</a></li>
</ul></li>
<li><a id="toc-lenscorrection" href="#lenscorrection">30.142 lenscorrection</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-35" href="#Options-35">30.142.1 Options</a></li>
<li><a id="toc-Commands-104" href="#Commands-104">30.142.2 Commands</a></li>
</ul></li>
<li><a id="toc-lensfun" href="#lensfun">30.143 lensfun</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-104" href="#Examples-104">30.143.1 Examples</a></li>
</ul></li>
<li><a id="toc-libplacebo" href="#libplacebo">30.144 libplacebo</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-36" href="#Options-36">30.144.1 Options</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Output-mode" href="#Output-mode">30.144.1.1 Output mode</a></li>
<li><a id="toc-Scaling" href="#Scaling">30.144.1.2 Scaling</a></li>
<li><a id="toc-Debanding" href="#Debanding">30.144.1.3 Debanding</a></li>
<li><a id="toc-Color-adjustment" href="#Color-adjustment">30.144.1.4 Color adjustment</a></li>
<li><a id="toc-Peak-detection" href="#Peak-detection">30.144.1.5 Peak detection</a></li>
<li><a id="toc-Tone-mapping" href="#Tone-mapping">30.144.1.6 Tone mapping</a></li>
<li><a id="toc-Dithering" href="#Dithering">30.144.1.7 Dithering</a></li>
<li><a id="toc-Custom-shaders" href="#Custom-shaders">30.144.1.8 Custom shaders</a></li>
<li><a id="toc-Debugging-_002f-performance" href="#Debugging-_002f-performance">30.144.1.9 Debugging / performance</a></li>
</ul></li>
<li><a id="toc-Commands-105" href="#Commands-105">30.144.2 Commands</a></li>
<li><a id="toc-Examples-105" href="#Examples-105">30.144.3 Examples</a></li>
</ul></li>
<li><a id="toc-libvmaf-1" href="#libvmaf-1">30.145 libvmaf</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-106" href="#Examples-106">30.145.1 Examples</a></li>
</ul></li>
<li><a id="toc-libvmaf_005fcuda" href="#libvmaf_005fcuda">30.146 libvmaf_cuda</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-107" href="#Examples-107">30.146.1 Examples</a></li>
</ul></li>
<li><a id="toc-limitdiff" href="#limitdiff">30.147 limitdiff</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-106" href="#Commands-106">30.147.1 Commands</a></li>
</ul></li>
<li><a id="toc-limiter" href="#limiter">30.148 limiter</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-107" href="#Commands-107">30.148.1 Commands</a></li>
</ul></li>
<li><a id="toc-loop" href="#loop">30.149 loop</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-108" href="#Examples-108">30.149.1 Examples</a></li>
</ul></li>
<li><a id="toc-lut1d" href="#lut1d">30.150 lut1d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-108" href="#Commands-108">30.150.1 Commands</a></li>
</ul></li>
<li><a id="toc-lut3d-1" href="#lut3d-1">30.151 lut3d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-109" href="#Commands-109">30.151.1 Commands</a></li>
</ul></li>
<li><a id="toc-lumakey" href="#lumakey">30.152 lumakey</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-110" href="#Commands-110">30.152.1 Commands</a></li>
</ul></li>
<li><a id="toc-lut_002c-lutrgb_002c-lutyuv" href="#lut_002c-lutrgb_002c-lutyuv">30.153 lut, lutrgb, lutyuv</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-111" href="#Commands-111">30.153.1 Commands</a></li>
<li><a id="toc-Examples-109" href="#Examples-109">30.153.2 Examples</a></li>
</ul></li>
<li><a id="toc-lut2_002c-tlut2" href="#lut2_002c-tlut2">30.154 lut2, tlut2</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-112" href="#Commands-112">30.154.1 Commands</a></li>
<li><a id="toc-Examples-110" href="#Examples-110">30.154.2 Examples</a></li>
</ul></li>
<li><a id="toc-maskedclamp" href="#maskedclamp">30.155 maskedclamp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-113" href="#Commands-113">30.155.1 Commands</a></li>
</ul></li>
<li><a id="toc-maskedmax" href="#maskedmax">30.156 maskedmax</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-114" href="#Commands-114">30.156.1 Commands</a></li>
</ul></li>
<li><a id="toc-maskedmerge" href="#maskedmerge">30.157 maskedmerge</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-115" href="#Commands-115">30.157.1 Commands</a></li>
</ul></li>
<li><a id="toc-maskedmin" href="#maskedmin">30.158 maskedmin</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-116" href="#Commands-116">30.158.1 Commands</a></li>
</ul></li>
<li><a id="toc-maskedthreshold" href="#maskedthreshold">30.159 maskedthreshold</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-117" href="#Commands-117">30.159.1 Commands</a></li>
</ul></li>
<li><a id="toc-maskfun" href="#maskfun">30.160 maskfun</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-118" href="#Commands-118">30.160.1 Commands</a></li>
</ul></li>
<li><a id="toc-mcdeint" href="#mcdeint">30.161 mcdeint</a></li>
<li><a id="toc-median" href="#median">30.162 median</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-119" href="#Commands-119">30.162.1 Commands</a></li>
</ul></li>
<li><a id="toc-mergeplanes" href="#mergeplanes">30.163 mergeplanes</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-111" href="#Examples-111">30.163.1 Examples</a></li>
</ul></li>
<li><a id="toc-mestimate" href="#mestimate">30.164 mestimate</a></li>
<li><a id="toc-midequalizer" href="#midequalizer">30.165 midequalizer</a></li>
<li><a id="toc-minterpolate" href="#minterpolate">30.166 minterpolate</a></li>
<li><a id="toc-mix" href="#mix">30.167 mix</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-120" href="#Commands-120">30.167.1 Commands</a></li>
</ul></li>
<li><a id="toc-monochrome" href="#monochrome">30.168 monochrome</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-121" href="#Commands-121">30.168.1 Commands</a></li>
</ul></li>
<li><a id="toc-morpho" href="#morpho">30.169 morpho</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-122" href="#Commands-122">30.169.1 Commands</a></li>
</ul></li>
<li><a id="toc-mpdecimate" href="#mpdecimate">30.170 mpdecimate</a></li>
<li><a id="toc-msad" href="#msad">30.171 msad</a></li>
<li><a id="toc-multiply" href="#multiply">30.172 multiply</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-123" href="#Commands-123">30.172.1 Commands</a></li>
</ul></li>
<li><a id="toc-negate" href="#negate">30.173 negate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-124" href="#Commands-124">30.173.1 Commands</a></li>
</ul></li>
<li><a id="toc-nlmeans-1" href="#nlmeans-1">30.174 nlmeans</a></li>
<li><a id="toc-nnedi" href="#nnedi">30.175 nnedi</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-125" href="#Commands-125">30.175.1 Commands</a></li>
</ul></li>
<li><a id="toc-noformat" href="#noformat">30.176 noformat</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-112" href="#Examples-112">30.176.1 Examples</a></li>
</ul></li>
<li><a id="toc-noise-1" href="#noise-1">30.177 noise</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-113" href="#Examples-113">30.177.1 Examples</a></li>
</ul></li>
<li><a id="toc-normalize" href="#normalize">30.178 normalize</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-126" href="#Commands-126">30.178.1 Commands</a></li>
<li><a id="toc-Examples-114" href="#Examples-114">30.178.2 Examples</a></li>
</ul></li>
<li><a id="toc-null-1" href="#null-1">30.179 null</a></li>
<li><a id="toc-ocr" href="#ocr">30.180 ocr</a></li>
<li><a id="toc-ocv" href="#ocv">30.181 ocv</a>
<ul class="toc-numbered-mark">
<li><a id="toc-dilate-1" href="#dilate-1">30.181.1 dilate</a></li>
<li><a id="toc-erode" href="#erode">30.181.2 erode</a></li>
<li><a id="toc-smooth" href="#smooth">30.181.3 smooth</a></li>
</ul></li>
<li><a id="toc-oscilloscope" href="#oscilloscope">30.182 oscilloscope</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-127" href="#Commands-127">30.182.1 Commands</a></li>
<li><a id="toc-Examples-115" href="#Examples-115">30.182.2 Examples</a></li>
</ul></li>
<li><a id="toc-overlay-1" href="#overlay-1">30.183 overlay</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-128" href="#Commands-128">30.183.1 Commands</a></li>
<li><a id="toc-Examples-116" href="#Examples-116">30.183.2 Examples</a></li>
</ul></li>
<li><a id="toc-overlay_005fcuda-1" href="#overlay_005fcuda-1">30.184 overlay_cuda</a></li>
<li><a id="toc-owdenoise" href="#owdenoise">30.185 owdenoise</a></li>
<li><a id="toc-pad-1" href="#pad-1">30.186 pad</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-117" href="#Examples-117">30.186.1 Examples</a></li>
</ul></li>
<li><a id="toc-palettegen-1" href="#palettegen-1">30.187 palettegen</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-118" href="#Examples-118">30.187.1 Examples</a></li>
</ul></li>
<li><a id="toc-paletteuse" href="#paletteuse">30.188 paletteuse</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-119" href="#Examples-119">30.188.1 Examples</a></li>
</ul></li>
<li><a id="toc-perspective" href="#perspective">30.189 perspective</a></li>
<li><a id="toc-phase" href="#phase">30.190 phase</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-129" href="#Commands-129">30.190.1 Commands</a></li>
</ul></li>
<li><a id="toc-photosensitivity" href="#photosensitivity">30.191 photosensitivity</a></li>
<li><a id="toc-pixdesctest" href="#pixdesctest">30.192 pixdesctest</a></li>
<li><a id="toc-pixelize" href="#pixelize">30.193 pixelize</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-130" href="#Commands-130">30.193.1 Commands</a></li>
</ul></li>
<li><a id="toc-pixscope" href="#pixscope">30.194 pixscope</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-131" href="#Commands-131">30.194.1 Commands</a></li>
</ul></li>
<li><a id="toc-pp" href="#pp">30.195 pp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-120" href="#Examples-120">30.195.1 Examples</a></li>
</ul></li>
<li><a id="toc-pp7" href="#pp7">30.196 pp7</a></li>
<li><a id="toc-premultiply" href="#premultiply">30.197 premultiply</a></li>
<li><a id="toc-prewitt" href="#prewitt">30.198 prewitt</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-132" href="#Commands-132">30.198.1 Commands</a></li>
</ul></li>
<li><a id="toc-pseudocolor" href="#pseudocolor">30.199 pseudocolor</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-133" href="#Commands-133">30.199.1 Commands</a></li>
<li><a id="toc-Examples-121" href="#Examples-121">30.199.2 Examples</a></li>
</ul></li>
<li><a id="toc-psnr" href="#psnr">30.200 psnr</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-122" href="#Examples-122">30.200.1 Examples</a></li>
</ul></li>
<li><a id="toc-pullup-1" href="#pullup-1">30.201 pullup</a></li>
<li><a id="toc-qp" href="#qp">30.202 qp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-123" href="#Examples-123">30.202.1 Examples</a></li>
</ul></li>
<li><a id="toc-random" href="#random">30.203 random</a></li>
<li><a id="toc-readeia608" href="#readeia608">30.204 readeia608</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-134" href="#Commands-134">30.204.1 Commands</a></li>
<li><a id="toc-Examples-124" href="#Examples-124">30.204.2 Examples</a></li>
</ul></li>
<li><a id="toc-readvitc" href="#readvitc">30.205 readvitc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-125" href="#Examples-125">30.205.1 Examples</a></li>
</ul></li>
<li><a id="toc-remap" href="#remap">30.206 remap</a></li>
<li><a id="toc-removegrain" href="#removegrain">30.207 removegrain</a></li>
<li><a id="toc-removelogo" href="#removelogo">30.208 removelogo</a></li>
<li><a id="toc-repeatfields" href="#repeatfields">30.209 repeatfields</a></li>
<li><a id="toc-reverse" href="#reverse">30.210 reverse</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-126" href="#Examples-126">30.210.1 Examples</a></li>
</ul></li>
<li><a id="toc-rgbashift" href="#rgbashift">30.211 rgbashift</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-135" href="#Commands-135">30.211.1 Commands</a></li>
</ul></li>
<li><a id="toc-roberts" href="#roberts">30.212 roberts</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-136" href="#Commands-136">30.212.1 Commands</a></li>
</ul></li>
<li><a id="toc-rotate" href="#rotate">30.213 rotate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-127" href="#Examples-127">30.213.1 Examples</a></li>
<li><a id="toc-Commands-137" href="#Commands-137">30.213.2 Commands</a></li>
</ul></li>
<li><a id="toc-sab" href="#sab">30.214 sab</a></li>
<li><a id="toc-scale-1" href="#scale-1">30.215 scale</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-37" href="#Options-37">30.215.1 Options</a></li>
<li><a id="toc-Examples-128" href="#Examples-128">30.215.2 Examples</a></li>
<li><a id="toc-Commands-138" href="#Commands-138">30.215.3 Commands</a></li>
</ul></li>
<li><a id="toc-scale_005fcuda-1" href="#scale_005fcuda-1">30.216 scale_cuda</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-129" href="#Examples-129">30.216.1 Examples</a></li>
</ul></li>
<li><a id="toc-scale_005fnpp-1" href="#scale_005fnpp-1">30.217 scale_npp</a></li>
<li><a id="toc-scale2ref" href="#scale2ref">30.218 scale2ref</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-130" href="#Examples-130">30.218.1 Examples</a></li>
<li><a id="toc-Commands-139" href="#Commands-139">30.218.2 Commands</a></li>
</ul></li>
<li><a id="toc-scale2ref_005fnpp" href="#scale2ref_005fnpp">30.219 scale2ref_npp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-131" href="#Examples-131">30.219.1 Examples</a></li>
</ul></li>
<li><a id="toc-scale_005fvt" href="#scale_005fvt">30.220 scale_vt</a></li>
<li><a id="toc-scharr" href="#scharr">30.221 scharr</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-140" href="#Commands-140">30.221.1 Commands</a></li>
</ul></li>
<li><a id="toc-scroll" href="#scroll">30.222 scroll</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-141" href="#Commands-141">30.222.1 Commands</a></li>
</ul></li>
<li><a id="toc-scdet-1" href="#scdet-1">30.223 scdet</a></li>
<li><a id="toc-selectivecolor-1" href="#selectivecolor-1">30.224 selectivecolor</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-132" href="#Examples-132">30.224.1 Examples</a></li>
</ul></li>
<li><a id="toc-separatefields-1" href="#separatefields-1">30.225 separatefields</a></li>
<li><a id="toc-setdar_002c-setsar" href="#setdar_002c-setsar">30.226 setdar, setsar</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-133" href="#Examples-133">30.226.1 Examples</a></li>
</ul></li>
<li><a id="toc-setfield-1" href="#setfield-1">30.227 setfield</a></li>
<li><a id="toc-setparams-1" href="#setparams-1">30.228 setparams</a></li>
<li><a id="toc-sharpen_005fnpp" href="#sharpen_005fnpp">30.229 sharpen_npp</a></li>
<li><a id="toc-shear" href="#shear">30.230 shear</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-142" href="#Commands-142">30.230.1 Commands</a></li>
</ul></li>
<li><a id="toc-showinfo" href="#showinfo">30.231 showinfo</a></li>
<li><a id="toc-showpalette" href="#showpalette">30.232 showpalette</a></li>
<li><a id="toc-shuffleframes" href="#shuffleframes">30.233 shuffleframes</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-134" href="#Examples-134">30.233.1 Examples</a></li>
</ul></li>
<li><a id="toc-shufflepixels" href="#shufflepixels">30.234 shufflepixels</a></li>
<li><a id="toc-shuffleplanes" href="#shuffleplanes">30.235 shuffleplanes</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-135" href="#Examples-135">30.235.1 Examples</a></li>
</ul></li>
<li><a id="toc-signalstats-1" href="#signalstats-1">30.236 signalstats</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-136" href="#Examples-136">30.236.1 Examples</a></li>
</ul></li>
<li><a id="toc-signature-1" href="#signature-1">30.237 signature</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-137" href="#Examples-137">30.237.1 Examples</a></li>
</ul></li>
<li><a id="toc-siti-1" href="#siti-1">30.238 siti</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-138" href="#Examples-138">30.238.1 Examples</a></li>
</ul></li>
<li><a id="toc-smartblur-1" href="#smartblur-1">30.239 smartblur</a></li>
<li><a id="toc-sobel" href="#sobel">30.240 sobel</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-143" href="#Commands-143">30.240.1 Commands</a></li>
</ul></li>
<li><a id="toc-spp-1" href="#spp-1">30.241 spp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-144" href="#Commands-144">30.241.1 Commands</a></li>
</ul></li>
<li><a id="toc-sr-1" href="#sr-1">30.242 sr</a></li>
<li><a id="toc-ssim" href="#ssim">30.243 ssim</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-139" href="#Examples-139">30.243.1 Examples</a></li>
</ul></li>
<li><a id="toc-stereo3d" href="#stereo3d">30.244 stereo3d</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-140" href="#Examples-140">30.244.1 Examples</a></li>
</ul></li>
<li><a id="toc-streamselect_002c-astreamselect" href="#streamselect_002c-astreamselect">30.245 streamselect, astreamselect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-145" href="#Commands-145">30.245.1 Commands</a></li>
<li><a id="toc-Examples-141" href="#Examples-141">30.245.2 Examples</a></li>
</ul></li>
<li><a id="toc-subtitles-1" href="#subtitles-1">30.246 subtitles</a></li>
<li><a id="toc-super2xsai" href="#super2xsai">30.247 super2xsai</a></li>
<li><a id="toc-swaprect" href="#swaprect">30.248 swaprect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-146" href="#Commands-146">30.248.1 Commands</a></li>
</ul></li>
<li><a id="toc-swapuv" href="#swapuv">30.249 swapuv</a></li>
<li><a id="toc-tblend" href="#tblend">30.250 tblend</a></li>
<li><a id="toc-telecine" href="#telecine">30.251 telecine</a></li>
<li><a id="toc-thistogram" href="#thistogram">30.252 thistogram</a></li>
<li><a id="toc-threshold" href="#threshold">30.253 threshold</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-147" href="#Commands-147">30.253.1 Commands</a></li>
<li><a id="toc-Examples-142" href="#Examples-142">30.253.2 Examples</a></li>
</ul></li>
<li><a id="toc-thumbnail" href="#thumbnail">30.254 thumbnail</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-143" href="#Examples-143">30.254.1 Examples</a></li>
</ul></li>
<li><a id="toc-tile-1" href="#tile-1">30.255 tile</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-144" href="#Examples-144">30.255.1 Examples</a></li>
</ul></li>
<li><a id="toc-tinterlace" href="#tinterlace">30.256 tinterlace</a></li>
<li><a id="toc-tmedian" href="#tmedian">30.257 tmedian</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-148" href="#Commands-148">30.257.1 Commands</a></li>
</ul></li>
<li><a id="toc-tmidequalizer" href="#tmidequalizer">30.258 tmidequalizer</a></li>
<li><a id="toc-tmix" href="#tmix">30.259 tmix</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-145" href="#Examples-145">30.259.1 Examples</a></li>
<li><a id="toc-Commands-149" href="#Commands-149">30.259.2 Commands</a></li>
</ul></li>
<li><a id="toc-tonemap-1" href="#tonemap-1">30.260 tonemap</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-38" href="#Options-38">30.260.1 Options</a></li>
</ul></li>
<li><a id="toc-tpad" href="#tpad">30.261 tpad</a></li>
<li><a id="toc-transpose-1" href="#transpose-1">30.262 transpose</a></li>
<li><a id="toc-transpose_005fnpp" href="#transpose_005fnpp">30.263 transpose_npp</a></li>
<li><a id="toc-trim" href="#trim">30.264 trim</a></li>
<li><a id="toc-unpremultiply" href="#unpremultiply">30.265 unpremultiply</a></li>
<li><a id="toc-unsharp-1" href="#unsharp-1">30.266 unsharp</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-146" href="#Examples-146">30.266.1 Examples</a></li>
</ul></li>
<li><a id="toc-untile-1" href="#untile-1">30.267 untile</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-147" href="#Examples-147">30.267.1 Examples</a></li>
</ul></li>
<li><a id="toc-uspp" href="#uspp">30.268 uspp</a></li>
<li><a id="toc-v360" href="#v360">30.269 v360</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-148" href="#Examples-148">30.269.1 Examples</a></li>
<li><a id="toc-Commands-150" href="#Commands-150">30.269.2 Commands</a></li>
</ul></li>
<li><a id="toc-vaguedenoiser" href="#vaguedenoiser">30.270 vaguedenoiser</a></li>
<li><a id="toc-varblur" href="#varblur">30.271 varblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-151" href="#Commands-151">30.271.1 Commands</a></li>
</ul></li>
<li><a id="toc-vectorscope" href="#vectorscope">30.272 vectorscope</a></li>
<li><a id="toc-vidstabdetect-1" href="#vidstabdetect-1">30.273 vidstabdetect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-149" href="#Examples-149">30.273.1 Examples</a></li>
</ul></li>
<li><a id="toc-vidstabtransform-1" href="#vidstabtransform-1">30.274 vidstabtransform</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-39" href="#Options-39">30.274.1 Options</a></li>
<li><a id="toc-Examples-150" href="#Examples-150">30.274.2 Examples</a></li>
</ul></li>
<li><a id="toc-vflip" href="#vflip">30.275 vflip</a></li>
<li><a id="toc-vfrdet" href="#vfrdet">30.276 vfrdet</a></li>
<li><a id="toc-vibrance" href="#vibrance">30.277 vibrance</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-152" href="#Commands-152">30.277.1 Commands</a></li>
</ul></li>
<li><a id="toc-vif" href="#vif">30.278 vif</a></li>
<li><a id="toc-vignette-1" href="#vignette-1">30.279 vignette</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Expressions" href="#Expressions">30.279.1 Expressions</a></li>
<li><a id="toc-Examples-151" href="#Examples-151">30.279.2 Examples</a></li>
</ul></li>
<li><a id="toc-vmafmotion" href="#vmafmotion">30.280 vmafmotion</a></li>
<li><a id="toc-vstack-1" href="#vstack-1">30.281 vstack</a></li>
<li><a id="toc-w3fdif" href="#w3fdif">30.282 w3fdif</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-153" href="#Commands-153">30.282.1 Commands</a></li>
</ul></li>
<li><a id="toc-waveform" href="#waveform">30.283 waveform</a></li>
<li><a id="toc-weave_002c-doubleweave" href="#weave_002c-doubleweave">30.284 weave, doubleweave</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-152" href="#Examples-152">30.284.1 Examples</a></li>
</ul></li>
<li><a id="toc-xbr" href="#xbr">30.285 xbr</a></li>
<li><a id="toc-xcorrelate" href="#xcorrelate">30.286 xcorrelate</a></li>
<li><a id="toc-xfade" href="#xfade">30.287 xfade</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-153" href="#Examples-153">30.287.1 Examples</a></li>
</ul></li>
<li><a id="toc-xmedian" href="#xmedian">30.288 xmedian</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-154" href="#Commands-154">30.288.1 Commands</a></li>
</ul></li>
<li><a id="toc-xstack-1" href="#xstack-1">30.289 xstack</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-154" href="#Examples-154">30.289.1 Examples</a></li>
</ul></li>
<li><a id="toc-yadif-1" href="#yadif-1">30.290 yadif</a></li>
<li><a id="toc-yadif_005fcuda" href="#yadif_005fcuda">30.291 yadif_cuda</a></li>
<li><a id="toc-yaepblur" href="#yaepblur">30.292 yaepblur</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-155" href="#Commands-155">30.292.1 Commands</a></li>
</ul></li>
<li><a id="toc-zoompan" href="#zoompan">30.293 zoompan</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-155" href="#Examples-155">30.293.1 Examples</a></li>
</ul></li>
<li><a id="toc-zscale-1" href="#zscale-1">30.294 zscale</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Options-40" href="#Options-40">30.294.1 Options</a></li>
<li><a id="toc-Commands-156" href="#Commands-156">30.294.2 Commands</a></li>
</ul></li>
</ul></li>
<li><a id="toc-OpenCL-Video-Filters" href="#OpenCL-Video-Filters">31 OpenCL Video Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-avgblur_005fopencl" href="#avgblur_005fopencl">31.1 avgblur_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example" href="#Example">31.1.1 Example</a></li>
</ul></li>
<li><a id="toc-boxblur_005fopencl" href="#boxblur_005fopencl">31.2 boxblur_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-156" href="#Examples-156">31.2.1 Examples</a></li>
</ul></li>
<li><a id="toc-colorkey_005fopencl" href="#colorkey_005fopencl">31.3 colorkey_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-157" href="#Examples-157">31.3.1 Examples</a></li>
</ul></li>
<li><a id="toc-convolution_005fopencl" href="#convolution_005fopencl">31.4 convolution_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-158" href="#Examples-158">31.4.1 Examples</a></li>
</ul></li>
<li><a id="toc-erosion_005fopencl" href="#erosion_005fopencl">31.5 erosion_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-1" href="#Example-1">31.5.1 Example</a></li>
</ul></li>
<li><a id="toc-deshake_005fopencl" href="#deshake_005fopencl">31.6 deshake_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-159" href="#Examples-159">31.6.1 Examples</a></li>
</ul></li>
<li><a id="toc-dilation_005fopencl" href="#dilation_005fopencl">31.7 dilation_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-2" href="#Example-2">31.7.1 Example</a></li>
</ul></li>
<li><a id="toc-nlmeans_005fopencl-1" href="#nlmeans_005fopencl-1">31.8 nlmeans_opencl</a></li>
<li><a id="toc-overlay_005fopencl" href="#overlay_005fopencl">31.9 overlay_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-160" href="#Examples-160">31.9.1 Examples</a></li>
</ul></li>
<li><a id="toc-pad_005fopencl" href="#pad_005fopencl">31.10 pad_opencl</a></li>
<li><a id="toc-prewitt_005fopencl" href="#prewitt_005fopencl">31.11 prewitt_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-3" href="#Example-3">31.11.1 Example</a></li>
</ul></li>
<li><a id="toc-program_005fopencl-1" href="#program_005fopencl-1">31.12 program_opencl</a></li>
<li><a id="toc-remap_005fopencl" href="#remap_005fopencl">31.13 remap_opencl</a></li>
<li><a id="toc-roberts_005fopencl" href="#roberts_005fopencl">31.14 roberts_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-4" href="#Example-4">31.14.1 Example</a></li>
</ul></li>
<li><a id="toc-sobel_005fopencl" href="#sobel_005fopencl">31.15 sobel_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-5" href="#Example-5">31.15.1 Example</a></li>
</ul></li>
<li><a id="toc-tonemap_005fopencl" href="#tonemap_005fopencl">31.16 tonemap_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-6" href="#Example-6">31.16.1 Example</a></li>
</ul></li>
<li><a id="toc-unsharp_005fopencl" href="#unsharp_005fopencl">31.17 unsharp_opencl</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-161" href="#Examples-161">31.17.1 Examples</a></li>
</ul></li>
<li><a id="toc-xfade_005fopencl" href="#xfade_005fopencl">31.18 xfade_opencl</a></li>
</ul></li>
<li><a id="toc-VAAPI-Video-Filters" href="#VAAPI-Video-Filters">32 VAAPI Video Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-overlay_005fvaapi" href="#overlay_005fvaapi">32.1 overlay_vaapi</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-162" href="#Examples-162">32.1.1 Examples</a></li>
</ul></li>
<li><a id="toc-tonemap_005fvaapi" href="#tonemap_005fvaapi">32.2 tonemap_vaapi</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Example-7" href="#Example-7">32.2.1 Example</a></li>
</ul></li>
<li><a id="toc-hstack_005fvaapi" href="#hstack_005fvaapi">32.3 hstack_vaapi</a></li>
<li><a id="toc-vstack_005fvaapi" href="#vstack_005fvaapi">32.4 vstack_vaapi</a></li>
<li><a id="toc-xstack_005fvaapi" href="#xstack_005fvaapi">32.5 xstack_vaapi</a></li>
</ul></li>
<li><a id="toc-Vulkan-Video-Filters" href="#Vulkan-Video-Filters">33 Vulkan Video Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-avgblur_005fvulkan" href="#avgblur_005fvulkan">33.1 avgblur_vulkan</a></li>
<li><a id="toc-blend_005fvulkan" href="#blend_005fvulkan">33.2 blend_vulkan</a></li>
<li><a id="toc-bwdif_005fvulkan" href="#bwdif_005fvulkan">33.3 bwdif_vulkan</a></li>
<li><a id="toc-chromaber_005fvulkan" href="#chromaber_005fvulkan">33.4 chromaber_vulkan</a></li>
<li><a id="toc-color_005fvulkan" href="#color_005fvulkan">33.5 color_vulkan</a></li>
<li><a id="toc-vflip_005fvulkan" href="#vflip_005fvulkan">33.6 vflip_vulkan</a></li>
<li><a id="toc-hflip_005fvulkan" href="#hflip_005fvulkan">33.7 hflip_vulkan</a></li>
<li><a id="toc-flip_005fvulkan" href="#flip_005fvulkan">33.8 flip_vulkan</a></li>
<li><a id="toc-gblur_005fvulkan" href="#gblur_005fvulkan">33.9 gblur_vulkan</a></li>
<li><a id="toc-nlmeans_005fvulkan" href="#nlmeans_005fvulkan">33.10 nlmeans_vulkan</a></li>
<li><a id="toc-overlay_005fvulkan" href="#overlay_005fvulkan">33.11 overlay_vulkan</a></li>
<li><a id="toc-transpose_005fvt" href="#transpose_005fvt">33.12 transpose_vt</a></li>
<li><a id="toc-transpose_005fvulkan" href="#transpose_005fvulkan">33.13 transpose_vulkan</a></li>
</ul></li>
<li><a id="toc-QSV-Video-Filters" href="#QSV-Video-Filters">34 QSV Video Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-hstack_005fqsv" href="#hstack_005fqsv">34.1 hstack_qsv</a></li>
<li><a id="toc-vstack_005fqsv" href="#vstack_005fqsv">34.2 vstack_qsv</a></li>
<li><a id="toc-xstack_005fqsv" href="#xstack_005fqsv">34.3 xstack_qsv</a></li>
</ul></li>
<li><a id="toc-Video-Sources" href="#Video-Sources">35 Video Sources</a>
<ul class="toc-numbered-mark">
<li><a id="toc-buffer" href="#buffer">35.1 buffer</a></li>
<li><a id="toc-cellauto" href="#cellauto">35.2 cellauto</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-163" href="#Examples-163">35.2.1 Examples</a></li>
</ul></li>
<li><a id="toc-coreimagesrc-1" href="#coreimagesrc-1">35.3 coreimagesrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-164" href="#Examples-164">35.3.1 Examples</a></li>
</ul></li>
<li><a id="toc-ddagrab" href="#ddagrab">35.4 ddagrab</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-165" href="#Examples-165">35.4.1 Examples</a></li>
</ul></li>
<li><a id="toc-gradients" href="#gradients">35.5 gradients</a></li>
<li><a id="toc-mandelbrot" href="#mandelbrot">35.6 mandelbrot</a></li>
<li><a id="toc-mptestsrc" href="#mptestsrc">35.7 mptestsrc</a></li>
<li><a id="toc-frei0r_005fsrc" href="#frei0r_005fsrc">35.8 frei0r_src</a></li>
<li><a id="toc-life" href="#life">35.9 life</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-166" href="#Examples-166">35.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">35.10 allrgb, allyuv, color, colorchart, colorspectrum, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-167" href="#Examples-167">35.10.1 Examples</a></li>
<li><a id="toc-Commands-157" href="#Commands-157">35.10.2 Commands</a></li>
</ul></li>
<li><a id="toc-openclsrc" href="#openclsrc">35.11 openclsrc</a></li>
<li><a id="toc-sierpinski" href="#sierpinski">35.12 sierpinski</a></li>
<li><a id="toc-zoneplate" href="#zoneplate">35.13 zoneplate</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-158" href="#Commands-158">35.13.1 Commands</a></li>
<li><a id="toc-Examples-168" href="#Examples-168">35.13.2 Examples</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Video-Sinks" href="#Video-Sinks">36 Video Sinks</a>
<ul class="toc-numbered-mark">
<li><a id="toc-buffersink" href="#buffersink">36.1 buffersink</a></li>
<li><a id="toc-nullsink" href="#nullsink">36.2 nullsink</a></li>
</ul></li>
<li><a id="toc-Multimedia-Filters" href="#Multimedia-Filters">37 Multimedia Filters</a>
<ul class="toc-numbered-mark">
<li><a id="toc-a3dscope" href="#a3dscope">37.1 a3dscope</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-159" href="#Commands-159">37.1.1 Commands</a></li>
</ul></li>
<li><a id="toc-abitscope" href="#abitscope">37.2 abitscope</a></li>
<li><a id="toc-adrawgraph" href="#adrawgraph">37.3 adrawgraph</a></li>
<li><a id="toc-agraphmonitor" href="#agraphmonitor">37.4 agraphmonitor</a></li>
<li><a id="toc-ahistogram" href="#ahistogram">37.5 ahistogram</a></li>
<li><a id="toc-aphasemeter" href="#aphasemeter">37.6 aphasemeter</a>
<ul class="toc-numbered-mark">
<li><a id="toc-phasing-detection" href="#phasing-detection">37.6.1 phasing detection</a></li>
<li><a id="toc-Examples-169" href="#Examples-169">37.6.2 Examples</a></li>
</ul></li>
<li><a id="toc-avectorscope" href="#avectorscope">37.7 avectorscope</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-170" href="#Examples-170">37.7.1 Examples</a></li>
<li><a id="toc-Commands-160" href="#Commands-160">37.7.2 Commands</a></li>
</ul></li>
<li><a id="toc-bench_002c-abench" href="#bench_002c-abench">37.8 bench, abench</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-171" href="#Examples-171">37.8.1 Examples</a></li>
</ul></li>
<li><a id="toc-concat-3" href="#concat-3">37.9 concat</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-172" href="#Examples-172">37.9.1 Examples</a></li>
<li><a id="toc-Commands-161" href="#Commands-161">37.9.2 Commands</a></li>
</ul></li>
<li><a id="toc-ebur128-1" href="#ebur128-1">37.10 ebur128</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-173" href="#Examples-173">37.10.1 Examples</a></li>
</ul></li>
<li><a id="toc-interleave_002c-ainterleave" href="#interleave_002c-ainterleave">37.11 interleave, ainterleave</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-174" href="#Examples-174">37.11.1 Examples</a></li>
</ul></li>
<li><a id="toc-latency_002c-alatency" href="#latency_002c-alatency">37.12 latency, alatency</a></li>
<li><a id="toc-metadata_002c-ametadata" href="#metadata_002c-ametadata">37.13 metadata, ametadata</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-175" href="#Examples-175">37.13.1 Examples</a></li>
</ul></li>
<li><a id="toc-perms_002c-aperms" href="#perms_002c-aperms">37.14 perms, aperms</a></li>
<li><a id="toc-realtime_002c-arealtime" href="#realtime_002c-arealtime">37.15 realtime, arealtime</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-162" href="#Commands-162">37.15.1 Commands</a></li>
</ul></li>
<li><a id="toc-segment_002c-asegment" href="#segment_002c-asegment">37.16 segment, asegment</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-176" href="#Examples-176">37.16.1 Examples</a></li>
</ul></li>
<li><a id="toc-select_002c-aselect" href="#select_002c-aselect">37.17 select, aselect</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-177" href="#Examples-177">37.17.1 Examples</a></li>
</ul></li>
<li><a id="toc-sendcmd_002c-asendcmd" href="#sendcmd_002c-asendcmd">37.18 sendcmd, asendcmd</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-syntax" href="#Commands-syntax">37.18.1 Commands syntax</a></li>
<li><a id="toc-Examples-178" href="#Examples-178">37.18.2 Examples</a></li>
</ul></li>
<li><a id="toc-setpts_002c-asetpts" href="#setpts_002c-asetpts">37.19 setpts, asetpts</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-179" href="#Examples-179">37.19.1 Examples</a></li>
<li><a id="toc-Commands-163" href="#Commands-163">37.19.2 Commands</a></li>
</ul></li>
<li><a id="toc-setrange" href="#setrange">37.20 setrange</a></li>
<li><a id="toc-settb_002c-asettb" href="#settb_002c-asettb">37.21 settb, asettb</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-180" href="#Examples-180">37.21.1 Examples</a></li>
</ul></li>
<li><a id="toc-showcqt" href="#showcqt">37.22 showcqt</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-181" href="#Examples-181">37.22.1 Examples</a></li>
</ul></li>
<li><a id="toc-showcwt" href="#showcwt">37.23 showcwt</a></li>
<li><a id="toc-showfreqs" href="#showfreqs">37.24 showfreqs</a></li>
<li><a id="toc-showspatial" href="#showspatial">37.25 showspatial</a></li>
<li><a id="toc-showspectrum-1" href="#showspectrum-1">37.26 showspectrum</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-182" href="#Examples-182">37.26.1 Examples</a></li>
</ul></li>
<li><a id="toc-showspectrumpic" href="#showspectrumpic">37.27 showspectrumpic</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-183" href="#Examples-183">37.27.1 Examples</a></li>
</ul></li>
<li><a id="toc-showvolume" href="#showvolume">37.28 showvolume</a></li>
<li><a id="toc-showwaves" href="#showwaves">37.29 showwaves</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-184" href="#Examples-184">37.29.1 Examples</a></li>
</ul></li>
<li><a id="toc-showwavespic" href="#showwavespic">37.30 showwavespic</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-185" href="#Examples-185">37.30.1 Examples</a></li>
</ul></li>
<li><a id="toc-sidedata_002c-asidedata" href="#sidedata_002c-asidedata">37.31 sidedata, asidedata</a></li>
<li><a id="toc-spectrumsynth" href="#spectrumsynth">37.32 spectrumsynth</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-186" href="#Examples-186">37.32.1 Examples</a></li>
</ul></li>
<li><a id="toc-split_002c-asplit" href="#split_002c-asplit">37.33 split, asplit</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-187" href="#Examples-187">37.33.1 Examples</a></li>
</ul></li>
<li><a id="toc-zmq_002c-azmq" href="#zmq_002c-azmq">37.34 zmq, azmq</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-188" href="#Examples-188">37.34.1 Examples</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Multimedia-Sources" href="#Multimedia-Sources">38 Multimedia Sources</a>
<ul class="toc-numbered-mark">
<li><a id="toc-amovie" href="#amovie">38.1 amovie</a></li>
<li><a id="toc-avsynctest" href="#avsynctest">38.2 avsynctest</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Commands-164" href="#Commands-164">38.2.1 Commands</a></li>
</ul></li>
<li><a id="toc-movie-1" href="#movie-1">38.3 movie</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Examples-189" href="#Examples-189">38.3.1 Examples</a></li>
<li><a id="toc-Commands-165" href="#Commands-165">38.3.2 Commands</a></li>
</ul></li>
</ul></li>
<li><a id="toc-External-libraries" href="#External-libraries">39 External libraries</a>
<ul class="toc-numbered-mark">
<li><a id="toc-Alliance-for-Open-Media-_0028AOM_0029" href="#Alliance-for-Open-Media-_0028AOM_0029">39.1 Alliance for Open Media (AOM)</a></li>
<li><a id="toc-AMD-AMF_002fVCE" href="#AMD-AMF_002fVCE">39.2 AMD AMF/VCE</a></li>
<li><a id="toc-AviSynth" href="#AviSynth">39.3 AviSynth</a></li>
<li><a id="toc-Chromaprint" href="#Chromaprint">39.4 Chromaprint</a></li>
<li><a id="toc-codec2" href="#codec2">39.5 codec2</a></li>
<li><a id="toc-dav1d" href="#dav1d">39.6 dav1d</a></li>
<li><a id="toc-davs2" href="#davs2">39.7 davs2</a></li>
<li><a id="toc-uavs3d" href="#uavs3d">39.8 uavs3d</a></li>
<li><a id="toc-Game-Music-Emu" href="#Game-Music-Emu">39.9 Game Music Emu</a></li>
<li><a id="toc-Intel-QuickSync-Video" href="#Intel-QuickSync-Video">39.10 Intel QuickSync Video</a></li>
<li><a id="toc-Kvazaar" href="#Kvazaar">39.11 Kvazaar</a></li>
<li><a id="toc-LAME" href="#LAME">39.12 LAME</a></li>
<li><a id="toc-libilbc-1" href="#libilbc-1">39.13 libilbc</a></li>
<li><a id="toc-libjxl" href="#libjxl">39.14 libjxl</a></li>
<li><a id="toc-libvpx" href="#libvpx">39.15 libvpx</a></li>
<li><a id="toc-ModPlug" href="#ModPlug">39.16 ModPlug</a></li>
<li><a id="toc-OpenCORE_002c-VisualOn_002c-and-Fraunhofer-libraries" href="#OpenCORE_002c-VisualOn_002c-and-Fraunhofer-libraries">39.17 OpenCORE, VisualOn, and Fraunhofer libraries</a>
<ul class="toc-numbered-mark">
<li><a id="toc-OpenCORE-AMR" href="#OpenCORE-AMR">39.17.1 OpenCORE AMR</a></li>
<li><a id="toc-VisualOn-AMR_002dWB-encoder-library" href="#VisualOn-AMR_002dWB-encoder-library">39.17.2 VisualOn AMR-WB encoder library</a></li>
<li><a id="toc-Fraunhofer-AAC-library" href="#Fraunhofer-AAC-library">39.17.3 Fraunhofer AAC library</a></li>
</ul></li>
<li><a id="toc-OpenH264" href="#OpenH264">39.18 OpenH264</a></li>
<li><a id="toc-OpenJPEG" href="#OpenJPEG">39.19 OpenJPEG</a></li>
<li><a id="toc-rav1e" href="#rav1e">39.20 rav1e</a></li>
<li><a id="toc-SVT_002dAV1" href="#SVT_002dAV1">39.21 SVT-AV1</a></li>
<li><a id="toc-TwoLAME" href="#TwoLAME">39.22 TwoLAME</a></li>
<li><a id="toc-VapourSynth" href="#VapourSynth">39.23 VapourSynth</a></li>
<li><a id="toc-x264" href="#x264">39.24 x264</a></li>
<li><a id="toc-x265" href="#x265">39.25 x265</a></li>
<li><a id="toc-xavs" href="#xavs">39.26 xavs</a></li>
<li><a id="toc-xavs2" href="#xavs2">39.27 xavs2</a></li>
<li><a id="toc-ZVBI" href="#ZVBI">39.28 ZVBI</a></li>
</ul></li>
<li><a id="toc-Supported-File-Formats_002c-Codecs-or-Features" href="#Supported-File-Formats_002c-Codecs-or-Features">40 Supported File Formats, Codecs or Features</a>
<ul class="toc-numbered-mark">
<li><a id="toc-File-Formats" href="#File-Formats">40.1 File Formats</a></li>
<li><a id="toc-Image-Formats" href="#Image-Formats">40.2 Image Formats</a></li>
<li><a id="toc-Video-Codecs" href="#Video-Codecs">40.3 Video Codecs</a></li>
<li><a id="toc-Audio-Codecs" href="#Audio-Codecs">40.4 Audio Codecs</a></li>
<li><a id="toc-Subtitle-Formats" href="#Subtitle-Formats">40.5 Subtitle Formats</a></li>
<li><a id="toc-Network-Protocols" href="#Network-Protocols">40.6 Network Protocols</a></li>
<li><a id="toc-Input_002fOutput-Devices" href="#Input_002fOutput-Devices">40.7 Input/Output Devices</a></li>
<li><a id="toc-Timecode" href="#Timecode">40.8 Timecode</a></li>
</ul></li>
<li><a id="toc-See-Also" href="#See-Also">41 See Also</a></li>
<li><a id="toc-Authors" href="#Authors">42 Authors</a></li>
</ul>
</div>
</div>
<ul class="mini-toc">
<li><a href="#Synopsis" accesskey="1">Synopsis</a></li>
<li><a href="#Description" accesskey="2">Description</a></li>
<li><a href="#Options" accesskey="3">Options</a></li>
<li><a href="#Syntax" accesskey="4">Syntax</a></li>
<li><a href="#Expression-Evaluation" accesskey="5">Expression Evaluation</a></li>
<li><a href="#Codec-Options" accesskey="6">Codec Options</a></li>
<li><a href="#Decoders" accesskey="7">Decoders</a></li>
<li><a href="#Video-Decoders" accesskey="8">Video Decoders</a></li>
<li><a href="#Audio-Decoders" accesskey="9">Audio Decoders</a></li>
<li><a href="#Subtitles-Decoders">Subtitles Decoders</a></li>
<li><a href="#Bitstream-Filters">Bitstream Filters</a></li>
<li><a href="#Format-Options">Format Options</a></li>
<li><a href="#Demuxers">Demuxers</a></li>
<li><a href="#Metadata">Metadata</a></li>
<li><a href="#Protocol-Options">Protocol Options</a></li>
<li><a href="#Protocols">Protocols</a></li>
<li><a href="#Device-Options">Device Options</a></li>
<li><a href="#Input-Devices">Input Devices</a></li>
<li><a href="#Resampler-Options">Resampler Options</a></li>
<li><a href="#Scaler-Options">Scaler Options</a></li>
<li><a href="#Filtering-Introduction">Filtering Introduction</a></li>
<li><a href="#graph2dot">graph2dot</a></li>
<li><a href="#Filtergraph-description">Filtergraph description</a></li>
<li><a href="#Timeline-editing">Timeline editing</a></li>
<li><a href="#Changing-options-at-runtime-with-a-command">Changing options at runtime with a command</a></li>
<li><a href="#Options-for-filters-with-several-inputs-_0028framesync_0029">Options for filters with several inputs (framesync)</a></li>
<li><a href="#Audio-Filters">Audio Filters</a></li>
<li><a href="#Audio-Sources">Audio Sources</a></li>
<li><a href="#Audio-Sinks">Audio Sinks</a></li>
<li><a href="#Video-Filters">Video Filters</a></li>
<li><a href="#OpenCL-Video-Filters">OpenCL Video Filters</a></li>
<li><a href="#VAAPI-Video-Filters">VAAPI Video Filters</a></li>
<li><a href="#Vulkan-Video-Filters">Vulkan Video Filters</a></li>
<li><a href="#QSV-Video-Filters">QSV Video Filters</a></li>
<li><a href="#Video-Sources">Video Sources</a></li>
<li><a href="#Video-Sinks">Video Sinks</a></li>
<li><a href="#Multimedia-Filters">Multimedia Filters</a></li>
<li><a href="#Multimedia-Sources">Multimedia Sources</a></li>
<li><a href="#External-libraries">External libraries</a></li>
<li><a href="#Supported-File-Formats_002c-Codecs-or-Features">Supported File Formats, Codecs or Features</a></li>
<li><a href="#See-Also">See Also</a></li>
<li><a href="#Authors">Authors</a></li>
</ul>
<div class="chapter-level-extent" id="Synopsis">
<h2 class="chapter">1 Synopsis</h2>
<p>ffplay [<var class="var">options</var>] [<samp class="file">input_url</samp>]
</p>
</div>
<div class="chapter-level-extent" id="Description">
<h2 class="chapter">2 Description</h2>
<p>FFplay is a very simple and portable media player using the FFmpeg
libraries and the SDL library. It is mostly used as a testbed for the
various FFmpeg APIs.
</p>
</div>
<div class="chapter-level-extent" id="Options">
<h2 class="chapter">3 Options</h2>
<p>All the numerical options, if not specified otherwise, accept a string
representing a number as input, which may be followed by one of the SI
unit prefixes, for example: ’K’, ’M’, or ’G’.
</p>
<p>If ’i’ is appended to the SI unit prefix, the complete prefix will be
interpreted as a unit prefix for binary multiples, which are based on
powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit
prefix multiplies the value by 8. This allows using, for example:
’KB’, ’MiB’, ’G’ and ’B’ as number suffixes.
</p>
<p>Options which do not take arguments are boolean options, and set the
corresponding value to true. They can be set to false by prefixing
the option name with "no". For example using "-nofoo"
will set the boolean option with name "foo" to false.
</p>
<a class="anchor" id="Stream-specifiers"></a><ul class="mini-toc">
<li><a href="#Stream-specifiers-1" accesskey="1">Stream specifiers</a></li>
<li><a href="#Generic-options" accesskey="2">Generic options</a></li>
<li><a href="#AVOptions" accesskey="3">AVOptions</a></li>
<li><a href="#Main-options" accesskey="4">Main options</a></li>
<li><a href="#Advanced-options" accesskey="5">Advanced options</a></li>
<li><a href="#While-playing" accesskey="6">While playing</a></li>
</ul>
<div class="section-level-extent" id="Stream-specifiers-1">
<h3 class="section">3.1 Stream specifiers</h3>
<p>Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
are used to precisely specify which stream(s) a given option belongs to.
</p>
<p>A stream specifier is a string generally appended to the option name and
separated from it by a colon. E.g. <code class="code">-codec:a:1 ac3</code> contains the
<code class="code">a:1</code> stream specifier, which matches the second audio stream. Therefore, it
would select the ac3 codec for the second audio stream.
</p>
<p>A stream specifier can match several streams, so that the option is applied to all
of them. E.g. the stream specifier in <code class="code">-b:a 128k</code> matches all audio
streams.
</p>
<p>An empty stream specifier matches all streams. For example, <code class="code">-codec copy</code>
or <code class="code">-codec: copy</code> would copy all the streams without reencoding.
</p>
<p>Possible forms of stream specifiers are:
</p><dl class="table">
<dt><samp class="option"><var class="var">stream_index</var></samp></dt>
<dd><p>Matches the stream with this index. E.g. <code class="code">-threads:1 4</code> would set the
thread count for the second stream to 4. If <var class="var">stream_index</var> is used as an
additional stream specifier (see below), then it selects stream number
<var class="var">stream_index</var> from the matching streams. Stream numbering is based on the
order of the streams as detected by libavformat except when a program ID is
also specified. In this case it is based on the ordering of the streams in the
program.
</p></dd>
<dt><samp class="option"><var class="var">stream_type</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
<dd><p><var class="var">stream_type</var> is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’
for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video
streams, ’V’ only matches video streams which are not attached pictures, video
thumbnails or cover arts. If <var class="var">additional_stream_specifier</var> is used, then
it matches streams which both have this type and match the
<var class="var">additional_stream_specifier</var>. Otherwise, it matches all streams of the
specified type.
</p></dd>
<dt><samp class="option">p:<var class="var">program_id</var>[:<var class="var">additional_stream_specifier</var>]</samp></dt>
<dd><p>Matches streams which are in the program with the id <var class="var">program_id</var>. If
<var class="var">additional_stream_specifier</var> is used, then it matches streams which both
are part of the program and match the <var class="var">additional_stream_specifier</var>.
</p>
</dd>
<dt><samp class="option">#<var class="var">stream_id</var> or i:<var class="var">stream_id</var></samp></dt>
<dd><p>Match the stream by stream id (e.g. PID in MPEG-TS container).
</p></dd>
<dt><samp class="option">m:<var class="var">key</var>[:<var class="var">value</var>]</samp></dt>
<dd><p>Matches streams with the metadata tag <var class="var">key</var> having the specified value. If
<var class="var">value</var> is not given, matches streams that contain the given tag with any
value.
</p></dd>
<dt><samp class="option">u</samp></dt>
<dd><p>Matches streams with usable configuration, the codec must be defined and the
essential information such as video dimension or audio sample rate must be present.
</p>
<p>Note that in <code class="command">ffmpeg</code>, matching by metadata will only work properly for
input files.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="Generic-options">
<h3 class="section">3.2 Generic options</h3>
<p>These options are shared amongst the ff* tools.
</p>
<dl class="table">
<dt><samp class="option">-L</samp></dt>
<dd><p>Show license.
</p>
</dd>
<dt><samp class="option">-h, -?, -help, --help [<var class="var">arg</var>]</samp></dt>
<dd><p>Show help. An optional parameter may be specified to print help about a specific
item. If no argument is specified, only basic (non advanced) tool
options are shown.
</p>
<p>Possible values of <var class="var">arg</var> are:
</p><dl class="table">
<dt><samp class="option">long</samp></dt>
<dd><p>Print advanced tool options in addition to the basic tool options.
</p>
</dd>
<dt><samp class="option">full</samp></dt>
<dd><p>Print complete list of options, including shared and private options
for encoders, decoders, demuxers, muxers, filters, etc.
</p>
</dd>
<dt><samp class="option">decoder=<var class="var">decoder_name</var></samp></dt>
<dd><p>Print detailed information about the decoder named <var class="var">decoder_name</var>. Use the
<samp class="option">-decoders</samp> option to get a list of all decoders.
</p>
</dd>
<dt><samp class="option">encoder=<var class="var">encoder_name</var></samp></dt>
<dd><p>Print detailed information about the encoder named <var class="var">encoder_name</var>. Use the
<samp class="option">-encoders</samp> option to get a list of all encoders.
</p>
</dd>
<dt><samp class="option">demuxer=<var class="var">demuxer_name</var></samp></dt>
<dd><p>Print detailed information about the demuxer named <var class="var">demuxer_name</var>. Use the
<samp class="option">-formats</samp> option to get a list of all demuxers and muxers.
</p>
</dd>
<dt><samp class="option">muxer=<var class="var">muxer_name</var></samp></dt>
<dd><p>Print detailed information about the muxer named <var class="var">muxer_name</var>. Use the
<samp class="option">-formats</samp> option to get a list of all muxers and demuxers.
</p>
</dd>
<dt><samp class="option">filter=<var class="var">filter_name</var></samp></dt>
<dd><p>Print detailed information about the filter named <var class="var">filter_name</var>. Use the
<samp class="option">-filters</samp> option to get a list of all filters.
</p>
</dd>
<dt><samp class="option">bsf=<var class="var">bitstream_filter_name</var></samp></dt>
<dd><p>Print detailed information about the bitstream filter named <var class="var">bitstream_filter_name</var>.
Use the <samp class="option">-bsfs</samp> option to get a list of all bitstream filters.
</p>
</dd>
<dt><samp class="option">protocol=<var class="var">protocol_name</var></samp></dt>
<dd><p>Print detailed information about the protocol named <var class="var">protocol_name</var>.
Use the <samp class="option">-protocols</samp> option to get a list of all protocols.
</p></dd>
</dl>
</dd>
<dt><samp class="option">-version</samp></dt>
<dd><p>Show version.
</p>
</dd>
<dt><samp class="option">-buildconf</samp></dt>
<dd><p>Show the build configuration, one option per line.
</p>
</dd>
<dt><samp class="option">-formats</samp></dt>
<dd><p>Show available formats (including devices).
</p>
</dd>
<dt><samp class="option">-demuxers</samp></dt>
<dd><p>Show available demuxers.
</p>
</dd>
<dt><samp class="option">-muxers</samp></dt>
<dd><p>Show available muxers.
</p>
</dd>
<dt><samp class="option">-devices</samp></dt>
<dd><p>Show available devices.
</p>
</dd>
<dt><samp class="option">-codecs</samp></dt>
<dd><p>Show all codecs known to libavcodec.
</p>
<p>Note that the term ’codec’ is used throughout this documentation as a shortcut
for what is more correctly called a media bitstream format.
</p>
</dd>
<dt><samp class="option">-decoders</samp></dt>
<dd><p>Show available decoders.
</p>
</dd>
<dt><samp class="option">-encoders</samp></dt>
<dd><p>Show all available encoders.
</p>
</dd>
<dt><samp class="option">-bsfs</samp></dt>
<dd><p>Show available bitstream filters.
</p>
</dd>
<dt><samp class="option">-protocols</samp></dt>
<dd><p>Show available protocols.
</p>
</dd>
<dt><samp class="option">-filters</samp></dt>
<dd><p>Show available libavfilter filters.
</p>
</dd>
<dt><samp class="option">-pix_fmts</samp></dt>
<dd><p>Show available pixel formats.
</p>
</dd>
<dt><samp class="option">-sample_fmts</samp></dt>
<dd><p>Show available sample formats.
</p>
</dd>
<dt><samp class="option">-layouts</samp></dt>
<dd><p>Show channel names and standard channel layouts.
</p>
</dd>
<dt><samp class="option">-dispositions</samp></dt>
<dd><p>Show stream dispositions.
</p>
</dd>
<dt><samp class="option">-colors</samp></dt>
<dd><p>Show recognized color names.
</p>
</dd>
<dt><samp class="option">-sources <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
<dd><p>Show autodetected sources of the input device.
Some devices may provide system-dependent source names that cannot be autodetected.
The returned list cannot be assumed to be always complete.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -sources pulse,server=192.168.0.4
</pre></div>
</dd>
<dt><samp class="option">-sinks <var class="var">device</var>[,<var class="var">opt1</var>=<var class="var">val1</var>[,<var class="var">opt2</var>=<var class="var">val2</var>]...]</samp></dt>
<dd><p>Show autodetected sinks of the output device.
Some devices may provide system-dependent sink names that cannot be autodetected.
The returned list cannot be assumed to be always complete.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -sinks pulse,server=192.168.0.4
</pre></div>
</dd>
<dt><samp class="option">-loglevel [<var class="var">flags</var>+]<var class="var">loglevel</var> | -v [<var class="var">flags</var>+]<var class="var">loglevel</var></samp></dt>
<dd><p>Set logging level and flags used by the library.
</p>
<p>The optional <var class="var">flags</var> prefix can consist of the following values:
</p><dl class="table">
<dt>‘<samp class="samp">repeat</samp>’</dt>
<dd><p>Indicates that repeated log output should not be compressed to the first line
and the "Last message repeated n times" line will be omitted.
</p></dd>
<dt>‘<samp class="samp">level</samp>’</dt>
<dd><p>Indicates that log output should add a <code class="code">[level]</code> prefix to each message
line. This can be used as an alternative to log coloring, e.g. when dumping the
log to file.
</p></dd>
</dl>
<p>Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single
flag without affecting other <var class="var">flags</var> or changing <var class="var">loglevel</var>. When
setting both <var class="var">flags</var> and <var class="var">loglevel</var>, a ’+’ separator is expected
between the last <var class="var">flags</var> value and before <var class="var">loglevel</var>.
</p>
<p><var class="var">loglevel</var> is a string or a number containing one of the following values:
</p><dl class="table">
<dt>‘<samp class="samp">quiet, -8</samp>’</dt>
<dd><p>Show nothing at all; be silent.
</p></dd>
<dt>‘<samp class="samp">panic, 0</samp>’</dt>
<dd><p>Only show fatal errors which could lead the process to crash, such as
an assertion failure. This is not currently used for anything.
</p></dd>
<dt>‘<samp class="samp">fatal, 8</samp>’</dt>
<dd><p>Only show fatal errors. These are errors after which the process absolutely
cannot continue.
</p></dd>
<dt>‘<samp class="samp">error, 16</samp>’</dt>
<dd><p>Show all errors, including ones which can be recovered from.
</p></dd>
<dt>‘<samp class="samp">warning, 24</samp>’</dt>
<dd><p>Show all warnings and errors. Any message related to possibly
incorrect or unexpected events will be shown.
</p></dd>
<dt>‘<samp class="samp">info, 32</samp>’</dt>
<dd><p>Show informative messages during processing. This is in addition to
warnings and errors. This is the default value.
</p></dd>
<dt>‘<samp class="samp">verbose, 40</samp>’</dt>
<dd><p>Same as <code class="code">info</code>, except more verbose.
</p></dd>
<dt>‘<samp class="samp">debug, 48</samp>’</dt>
<dd><p>Show everything, including debugging information.
</p></dd>
<dt>‘<samp class="samp">trace, 56</samp>’</dt>
</dl>
<p>For example to enable repeated log output, add the <code class="code">level</code> prefix, and set
<var class="var">loglevel</var> to <code class="code">verbose</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -loglevel repeat+level+verbose -i input output
</pre></div>
<p>Another example that enables repeated log output without affecting current
state of <code class="code">level</code> prefix flag or <var class="var">loglevel</var>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg [...] -loglevel +repeat
</pre></div>
<p>By default the program logs to stderr. If coloring is supported by the
terminal, colors are used to mark errors and warnings. Log coloring
can be disabled setting the environment variable
<code class="env">AV_LOG_FORCE_NOCOLOR</code>, or can be forced setting
the environment variable <code class="env">AV_LOG_FORCE_COLOR</code>.
</p>
</dd>
<dt><samp class="option">-report</samp></dt>
<dd><p>Dump full command line and log output to a file named
<code class="code"><var class="var">program</var>-<var class="var">YYYYMMDD</var>-<var class="var">HHMMSS</var>.log</code> in the current
directory.
This file can be useful for bug reports.
It also implies <code class="code">-loglevel debug</code>.
</p>
<p>Setting the environment variable <code class="env">FFREPORT</code> to any value has the
same effect. If the value is a ’:’-separated key=value sequence, these
options will affect the report; option values must be escaped if they
contain special characters or the options delimiter ’:’ (see the
“Quoting and escaping” section in the ffmpeg-utils manual).
</p>
<p>The following options are recognized:
</p><dl class="table">
<dt><samp class="option">file</samp></dt>
<dd><p>set the file name to use for the report; <code class="code">%p</code> is expanded to the name
of the program, <code class="code">%t</code> is expanded to a timestamp, <code class="code">%%</code> is expanded
to a plain <code class="code">%</code>
</p></dd>
<dt><samp class="option">level</samp></dt>
<dd><p>set the log verbosity level using a numerical value (see <code class="code">-loglevel</code>).
</p></dd>
</dl>
<p>For example, to output a report to a file named <samp class="file">ffreport.log</samp>
using a log level of <code class="code">32</code> (alias for log level <code class="code">info</code>):
</p>
<div class="example">
<pre class="example-preformatted">FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
</pre></div>
<p>Errors in parsing the environment variable are not fatal, and will not
appear in the report.
</p>
</dd>
<dt><samp class="option">-hide_banner</samp></dt>
<dd><p>Suppress printing banner.
</p>
<p>All FFmpeg tools will normally show a copyright notice, build options
and library versions. This option can be used to suppress printing
this information.
</p>
</dd>
<dt><samp class="option">-cpuflags flags (<em class="emph">global</em>)</samp></dt>
<dd><p>Allows setting and clearing cpu flags. This option is intended
for testing. Do not use it unless you know what you’re doing.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -cpuflags -sse+mmx ...
ffmpeg -cpuflags mmx ...
ffmpeg -cpuflags 0 ...
</pre></div>
<p>Possible flags for this option are:
</p><dl class="table">
<dt>‘<samp class="samp">x86</samp>’</dt>
<dd><dl class="table">
<dt>‘<samp class="samp">mmx</samp>’</dt>
<dt>‘<samp class="samp">mmxext</samp>’</dt>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dt>‘<samp class="samp">sse2</samp>’</dt>
<dt>‘<samp class="samp">sse2slow</samp>’</dt>
<dt>‘<samp class="samp">sse3</samp>’</dt>
<dt>‘<samp class="samp">sse3slow</samp>’</dt>
<dt>‘<samp class="samp">ssse3</samp>’</dt>
<dt>‘<samp class="samp">atom</samp>’</dt>
<dt>‘<samp class="samp">sse4.1</samp>’</dt>
<dt>‘<samp class="samp">sse4.2</samp>’</dt>
<dt>‘<samp class="samp">avx</samp>’</dt>
<dt>‘<samp class="samp">avx2</samp>’</dt>
<dt>‘<samp class="samp">xop</samp>’</dt>
<dt>‘<samp class="samp">fma3</samp>’</dt>
<dt>‘<samp class="samp">fma4</samp>’</dt>
<dt>‘<samp class="samp">3dnow</samp>’</dt>
<dt>‘<samp class="samp">3dnowext</samp>’</dt>
<dt>‘<samp class="samp">bmi1</samp>’</dt>
<dt>‘<samp class="samp">bmi2</samp>’</dt>
<dt>‘<samp class="samp">cmov</samp>’</dt>
</dl>
</dd>
<dt>‘<samp class="samp">ARM</samp>’</dt>
<dd><dl class="table">
<dt>‘<samp class="samp">armv5te</samp>’</dt>
<dt>‘<samp class="samp">armv6</samp>’</dt>
<dt>‘<samp class="samp">armv6t2</samp>’</dt>
<dt>‘<samp class="samp">vfp</samp>’</dt>
<dt>‘<samp class="samp">vfpv3</samp>’</dt>
<dt>‘<samp class="samp">neon</samp>’</dt>
<dt>‘<samp class="samp">setend</samp>’</dt>
</dl>
</dd>
<dt>‘<samp class="samp">AArch64</samp>’</dt>
<dd><dl class="table">
<dt>‘<samp class="samp">armv8</samp>’</dt>
<dt>‘<samp class="samp">vfp</samp>’</dt>
<dt>‘<samp class="samp">neon</samp>’</dt>
</dl>
</dd>
<dt>‘<samp class="samp">PowerPC</samp>’</dt>
<dd><dl class="table">
<dt>‘<samp class="samp">altivec</samp>’</dt>
</dl>
</dd>
<dt>‘<samp class="samp">Specific Processors</samp>’</dt>
<dd><dl class="table">
<dt>‘<samp class="samp">pentium2</samp>’</dt>
<dt>‘<samp class="samp">pentium3</samp>’</dt>
<dt>‘<samp class="samp">pentium4</samp>’</dt>
<dt>‘<samp class="samp">k6</samp>’</dt>
<dt>‘<samp class="samp">k62</samp>’</dt>
<dt>‘<samp class="samp">athlon</samp>’</dt>
<dt>‘<samp class="samp">athlonxp</samp>’</dt>
<dt>‘<samp class="samp">k8</samp>’</dt>
</dl>
</dd>
</dl>
</dd>
<dt><samp class="option">-cpucount <var class="var">count</var> (<em class="emph">global</em>)</samp></dt>
<dd><p>Override detection of CPU count. This option is intended
for testing. Do not use it unless you know what you’re doing.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -cpucount 2
</pre></div>
</dd>
<dt><samp class="option">-max_alloc <var class="var">bytes</var></samp></dt>
<dd><p>Set the maximum size limit for allocating a block on the heap by ffmpeg’s
family of malloc functions. Exercise <strong class="strong">extreme caution</strong> when using
this option. Don’t use if you do not understand the full consequence of doing so.
Default is INT_MAX.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="AVOptions">
<h3 class="section">3.3 AVOptions</h3>
<p>These options are provided directly by the libavformat, libavdevice and
libavcodec libraries. To see the list of available AVOptions, use the
<samp class="option">-help</samp> option. They are separated into two categories:
</p><dl class="table">
<dt><samp class="option">generic</samp></dt>
<dd><p>These options can be set for any container, codec or device. Generic options
are listed under AVFormatContext options for containers/devices and under
AVCodecContext options for codecs.
</p></dd>
<dt><samp class="option">private</samp></dt>
<dd><p>These options are specific to the given container, device or codec. Private
options are listed under their corresponding containers/devices/codecs.
</p></dd>
</dl>
<p>For example to write an ID3v2.3 header instead of a default ID3v2.4 to
an MP3 file, use the <samp class="option">id3v2_version</samp> private option of the MP3
muxer:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i input.flac -id3v2_version 3 out.mp3
</pre></div>
<p>All codec AVOptions are per-stream, and thus a stream specifier
should be attached to them:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
</pre></div>
<p>In the above example, a multichannel audio stream is mapped twice for output.
The first instance is encoded with codec ac3 and bitrate 640k.
The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using
absolute index of the output stream.
</p>
<p>Note: the <samp class="option">-nooption</samp> syntax cannot be used for boolean
AVOptions, use <samp class="option">-option 0</samp>/<samp class="option">-option 1</samp>.
</p>
<p>Note: the old undocumented way of specifying per-stream AVOptions by
prepending v/a/s to the options name is now obsolete and will be
removed soon.
</p>
</div>
<div class="section-level-extent" id="Main-options">
<h3 class="section">3.4 Main options</h3>
<dl class="table">
<dt><samp class="option">-x <var class="var">width</var></samp></dt>
<dd><p>Force displayed width.
</p></dd>
<dt><samp class="option">-y <var class="var">height</var></samp></dt>
<dd><p>Force displayed height.
</p></dd>
<dt><samp class="option">-fs</samp></dt>
<dd><p>Start in fullscreen mode.
</p></dd>
<dt><samp class="option">-an</samp></dt>
<dd><p>Disable audio.
</p></dd>
<dt><samp class="option">-vn</samp></dt>
<dd><p>Disable video.
</p></dd>
<dt><samp class="option">-sn</samp></dt>
<dd><p>Disable subtitles.
</p></dd>
<dt><samp class="option">-ss <var class="var">pos</var></samp></dt>
<dd><p>Seek to <var class="var">pos</var>. Note that in most formats it is not possible to seek
exactly, so <code class="command">ffplay</code> will seek to the nearest seek point to
<var class="var">pos</var>.
</p>
<p><var class="var">pos</var> must be a time duration specification,
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></dd>
<dt><samp class="option">-t <var class="var">duration</var></samp></dt>
<dd><p>Play <var class="var">duration</var> seconds of audio/video.
</p>
<p><var class="var">duration</var> must be a time duration specification,
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></dd>
<dt><samp class="option">-bytes</samp></dt>
<dd><p>Seek by bytes.
</p></dd>
<dt><samp class="option">-seek_interval</samp></dt>
<dd><p>Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds.
</p></dd>
<dt><samp class="option">-nodisp</samp></dt>
<dd><p>Disable graphical display.
</p></dd>
<dt><samp class="option">-noborder</samp></dt>
<dd><p>Borderless window.
</p></dd>
<dt><samp class="option">-alwaysontop</samp></dt>
<dd><p>Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6.
</p></dd>
<dt><samp class="option">-volume</samp></dt>
<dd><p>Set the startup volume. 0 means silence, 100 means no volume reduction or
amplification. Negative values are treated as 0, values above 100 are treated
as 100.
</p></dd>
<dt><samp class="option">-f <var class="var">fmt</var></samp></dt>
<dd><p>Force format.
</p></dd>
<dt><samp class="option">-window_title <var class="var">title</var></samp></dt>
<dd><p>Set window title (default is the input filename).
</p></dd>
<dt><samp class="option">-left <var class="var">title</var></samp></dt>
<dd><p>Set the x position for the left of the window (default is a centered window).
</p></dd>
<dt><samp class="option">-top <var class="var">title</var></samp></dt>
<dd><p>Set the y position for the top of the window (default is a centered window).
</p></dd>
<dt><samp class="option">-loop <var class="var">number</var></samp></dt>
<dd><p>Loops movie playback <number> times. 0 means forever.
</p></dd>
<dt><samp class="option">-showmode <var class="var">mode</var></samp></dt>
<dd><p>Set the show mode to use.
Available values for <var class="var">mode</var> are:
</p><dl class="table">
<dt>‘<samp class="samp">0, video</samp>’</dt>
<dd><p>show video
</p></dd>
<dt>‘<samp class="samp">1, waves</samp>’</dt>
<dd><p>show audio waves
</p></dd>
<dt>‘<samp class="samp">2, rdft</samp>’</dt>
<dd><p>show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
</p></dd>
</dl>
<p>Default value is "video", if video is not present or cannot be played
"rdft" is automatically selected.
</p>
<p>You can interactively cycle through the available show modes by
pressing the key <kbd class="key">w</kbd>.
</p>
</dd>
<dt><samp class="option">-vf <var class="var">filtergraph</var></samp></dt>
<dd><p>Create the filtergraph specified by <var class="var">filtergraph</var> and use it to
filter the video stream.
</p>
<p><var class="var">filtergraph</var> is a description of the filtergraph to apply to
the stream, and must have a single video input and a single video
output. In the filtergraph, the input is associated to the label
<code class="code">in</code>, and the output to the label <code class="code">out</code>. See the
ffmpeg-filters manual for more information about the filtergraph
syntax.
</p>
<p>You can specify this parameter multiple times and cycle through the specified
filtergraphs along with the show modes by pressing the key <kbd class="key">w</kbd>.
</p>
</dd>
<dt><samp class="option">-af <var class="var">filtergraph</var></samp></dt>
<dd><p><var class="var">filtergraph</var> is a description of the filtergraph to apply to
the input audio.
Use the option "-filters" to show all the available filters (including
sources and sinks).
</p>
</dd>
<dt><samp class="option">-i <var class="var">input_url</var></samp></dt>
<dd><p>Read <var class="var">input_url</var>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="Advanced-options">
<h3 class="section">3.5 Advanced options</h3>
<dl class="table">
<dt><samp class="option">-stats</samp></dt>
<dd><p>Print several playback statistics, in particular show the stream
duration, the codec parameters, the current position in the stream and
the audio/video synchronisation drift. It is shown by default, unless the
log level is lower than <code class="code">info</code>. Its display can be forced by manually
specifying this option. To disable it, you need to specify <code class="code">-nostats</code>.
</p>
</dd>
<dt><samp class="option">-fast</samp></dt>
<dd><p>Non-spec-compliant optimizations.
</p></dd>
<dt><samp class="option">-genpts</samp></dt>
<dd><p>Generate pts.
</p></dd>
<dt><samp class="option">-sync <var class="var">type</var></samp></dt>
<dd><p>Set the master clock to audio (<code class="code">type=audio</code>), video
(<code class="code">type=video</code>) or external (<code class="code">type=ext</code>). Default is audio. The
master clock is used to control audio-video synchronization. Most media
players use audio as master clock, but in some cases (streaming or high
quality broadcast) it is necessary to change that. This option is mainly
used for debugging purposes.
</p></dd>
<dt><samp class="option">-ast <var class="var">audio_stream_specifier</var></samp></dt>
<dd><p>Select the desired audio stream using the given stream specifier. The stream
specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
is not specified, the "best" audio stream is selected in the program of the
already selected video stream.
</p></dd>
<dt><samp class="option">-vst <var class="var">video_stream_specifier</var></samp></dt>
<dd><p>Select the desired video stream using the given stream specifier. The stream
specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
is not specified, the "best" video stream is selected.
</p></dd>
<dt><samp class="option">-sst <var class="var">subtitle_stream_specifier</var></samp></dt>
<dd><p>Select the desired subtitle stream using the given stream specifier. The stream
specifiers are described in the <a class="ref" href="#Stream-specifiers">Stream specifiers</a> chapter. If this option
is not specified, the "best" subtitle stream is selected in the program of the
already selected video or audio stream.
</p></dd>
<dt><samp class="option">-autoexit</samp></dt>
<dd><p>Exit when video is done playing.
</p></dd>
<dt><samp class="option">-exitonkeydown</samp></dt>
<dd><p>Exit if any key is pressed.
</p></dd>
<dt><samp class="option">-exitonmousedown</samp></dt>
<dd><p>Exit if any mouse button is pressed.
</p>
</dd>
<dt><samp class="option">-codec:<var class="var">media_specifier</var> <var class="var">codec_name</var></samp></dt>
<dd><p>Force a specific decoder implementation for the stream identified by
<var class="var">media_specifier</var>, which can assume the values <code class="code">a</code> (audio),
<code class="code">v</code> (video), and <code class="code">s</code> subtitle.
</p>
</dd>
<dt><samp class="option">-acodec <var class="var">codec_name</var></samp></dt>
<dd><p>Force a specific audio decoder.
</p>
</dd>
<dt><samp class="option">-vcodec <var class="var">codec_name</var></samp></dt>
<dd><p>Force a specific video decoder.
</p>
</dd>
<dt><samp class="option">-scodec <var class="var">codec_name</var></samp></dt>
<dd><p>Force a specific subtitle decoder.
</p>
</dd>
<dt><samp class="option">-autorotate</samp></dt>
<dd><p>Automatically rotate the video according to file metadata. Enabled by
default, use <samp class="option">-noautorotate</samp> to disable it.
</p>
</dd>
<dt><samp class="option">-framedrop</samp></dt>
<dd><p>Drop video frames if video is out of sync. Enabled by default if the master
clock is not set to video. Use this option to enable frame dropping for all
master clock sources, use <samp class="option">-noframedrop</samp> to disable it.
</p>
</dd>
<dt><samp class="option">-infbuf</samp></dt>
<dd><p>Do not limit the input buffer size, read as much data as possible from the
input as soon as possible. Enabled by default for realtime streams, where data
may be dropped if not read in time. Use this option to enable infinite buffers
for all inputs, use <samp class="option">-noinfbuf</samp> to disable it.
</p>
</dd>
<dt><samp class="option">-filter_threads <var class="var">nb_threads</var></samp></dt>
<dd><p>Defines how many threads are used to process a filter pipeline. Each pipeline
will produce a thread pool with this many threads available for parallel
processing. The default is 0 which means that the thread count will be
determined by the number of available CPUs.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="While-playing">
<h3 class="section">3.6 While playing</h3>
<dl class="table">
<dt><kbd class="key">q, ESC</kbd></dt>
<dd><p>Quit.
</p>
</dd>
<dt><kbd class="key">f</kbd></dt>
<dd><p>Toggle full screen.
</p>
</dd>
<dt><kbd class="key">p, SPC</kbd></dt>
<dd><p>Pause.
</p>
</dd>
<dt><kbd class="key">m</kbd></dt>
<dd><p>Toggle mute.
</p>
</dd>
<dt><kbd class="key">9, 0</kbd></dt>
<dt><kbd class="key">/, *</kbd></dt>
<dd><p>Decrease and increase volume respectively.
</p>
</dd>
<dt><kbd class="key">a</kbd></dt>
<dd><p>Cycle audio channel in the current program.
</p>
</dd>
<dt><kbd class="key">v</kbd></dt>
<dd><p>Cycle video channel.
</p>
</dd>
<dt><kbd class="key">t</kbd></dt>
<dd><p>Cycle subtitle channel in the current program.
</p>
</dd>
<dt><kbd class="key">c</kbd></dt>
<dd><p>Cycle program.
</p>
</dd>
<dt><kbd class="key">w</kbd></dt>
<dd><p>Cycle video filters or show modes.
</p>
</dd>
<dt><kbd class="key">s</kbd></dt>
<dd><p>Step to the next frame.
</p>
<p>Pause if the stream is not already paused, step to the next video
frame, and pause.
</p>
</dd>
<dt><kbd class="key">left/right</kbd></dt>
<dd><p>Seek backward/forward 10 seconds.
</p>
</dd>
<dt><kbd class="key">down/up</kbd></dt>
<dd><p>Seek backward/forward 1 minute.
</p>
</dd>
<dt><kbd class="key">page down/page up</kbd></dt>
<dd><p>Seek to the previous/next chapter.
or if there are no chapters
Seek backward/forward 10 minutes.
</p>
</dd>
<dt><kbd class="key">right mouse click</kbd></dt>
<dd><p>Seek to percentage in file corresponding to fraction of width.
</p>
</dd>
<dt><kbd class="key">left mouse double-click</kbd></dt>
<dd><p>Toggle full screen.
</p>
</dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="Syntax">
<h2 class="chapter">4 Syntax</h2>
<p>This section documents the syntax and formats employed by the FFmpeg
libraries and tools.
</p>
<a class="anchor" id="quoting_005fand_005fescaping"></a><ul class="mini-toc">
<li><a href="#Quoting-and-escaping" accesskey="1">Quoting and escaping</a></li>
<li><a href="#Date" accesskey="2">Date</a></li>
<li><a href="#Time-duration" accesskey="3">Time duration</a></li>
<li><a href="#Video-size" accesskey="4">Video size</a></li>
<li><a href="#Video-rate" accesskey="5">Video rate</a></li>
<li><a href="#Ratio" accesskey="6">Ratio</a></li>
<li><a href="#Color" accesskey="7">Color</a></li>
<li><a href="#Channel-Layout" accesskey="8">Channel Layout</a></li>
</ul>
<div class="section-level-extent" id="Quoting-and-escaping">
<h3 class="section">4.1 Quoting and escaping</h3>
<p>FFmpeg adopts the following quoting and escaping mechanism, unless
explicitly specified. The following rules are applied:
</p>
<ul class="itemize mark-bullet">
<li>‘<samp class="samp">'</samp>’ and ‘<samp class="samp">\</samp>’ are special characters (respectively used for
quoting and escaping). In addition to them, there might be other
special characters depending on the specific syntax where the escaping
and quoting are employed.
</li><li>A special character is escaped by prefixing it with a ‘<samp class="samp">\</samp>’.
</li><li>All characters enclosed between ‘<samp class="samp">''</samp>’ are included literally in the
parsed string. The quote character ‘<samp class="samp">'</samp>’ itself cannot be quoted,
so you may need to close the quote and escape it.
</li><li>Leading and trailing whitespaces, unless escaped or quoted, are
removed from the parsed string.
</li></ul>
<p>Note that you may need to add a second level of escaping when using
the command line or a script, which depends on the syntax of the
adopted shell language.
</p>
<p>The function <code class="code">av_get_token</code> defined in
<samp class="file">libavutil/avstring.h</samp> can be used to parse a token quoted or
escaped according to the rules defined above.
</p>
<p>The tool <samp class="file">tools/ffescape</samp> in the FFmpeg source tree can be used
to automatically quote or escape a string in a script.
</p>
<ul class="mini-toc">
<li><a href="#Examples" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples">
<h4 class="subsection">4.1.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Escape the string <code class="code">Crime d'Amour</code> containing the <code class="code">'</code> special
character:
<div class="example">
<pre class="example-preformatted">Crime d\'Amour
</pre></div>
</li><li>The string above contains a quote, so the <code class="code">'</code> needs to be escaped
when quoting it:
<div class="example">
<pre class="example-preformatted">'Crime d'\''Amour'
</pre></div>
</li><li>Include leading or trailing whitespaces using quoting:
<div class="example">
<pre class="example-preformatted">' this string starts and ends with whitespaces '
</pre></div>
</li><li>Escaping and quoting can be mixed together:
<div class="example">
<pre class="example-preformatted">' The string '\'string\'' is a string '
</pre></div>
</li><li>To include a literal ‘<samp class="samp">\</samp>’ you can use either escaping or quoting:
<div class="example">
<pre class="example-preformatted">'c:\foo' can be written as c:\\foo
</pre></div>
</li></ul>
<a class="anchor" id="date-syntax"></a></div>
</div>
<div class="section-level-extent" id="Date">
<h3 class="section">4.2 Date</h3>
<p>The accepted syntax is:
</p><div class="example">
<pre class="example-preformatted">[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
now
</pre></div>
<p>If the value is "now" it takes the current time.
</p>
<p>Time is local time unless Z is appended, in which case it is
interpreted as UTC.
If the year-month-day part is not specified it takes the current
year-month-day.
</p>
<a class="anchor" id="time-duration-syntax"></a></div>
<div class="section-level-extent" id="Time-duration">
<h3 class="section">4.3 Time duration</h3>
<p>There are two accepted syntaxes for expressing time duration.
</p>
<div class="example">
<pre class="example-preformatted">[-][<var class="var">HH</var>:]<var class="var">MM</var>:<var class="var">SS</var>[.<var class="var">m</var>...]
</pre></div>
<p><var class="var">HH</var> expresses the number of hours, <var class="var">MM</var> the number of minutes
for a maximum of 2 digits, and <var class="var">SS</var> the number of seconds for a
maximum of 2 digits. The <var class="var">m</var> at the end expresses decimal value for
<var class="var">SS</var>.
</p>
<p><em class="emph">or</em>
</p>
<div class="example">
<pre class="example-preformatted">[-]<var class="var">S</var>+[.<var class="var">m</var>...][s|ms|us]
</pre></div>
<p><var class="var">S</var> expresses the number of seconds, with the optional decimal part
<var class="var">m</var>. The optional literal suffixes ‘<samp class="samp">s</samp>’, ‘<samp class="samp">ms</samp>’ or ‘<samp class="samp">us</samp>’
indicate to interpret the value as seconds, milliseconds or microseconds,
respectively.
</p>
<p>In both expressions, the optional ‘<samp class="samp">-</samp>’ indicates negative duration.
</p>
<ul class="mini-toc">
<li><a href="#Examples-1" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-1">
<h4 class="subsection">4.3.1 Examples</h4>
<p>The following examples are all valid time duration:
</p>
<dl class="table">
<dt>‘<samp class="samp">55</samp>’</dt>
<dd><p>55 seconds
</p>
</dd>
<dt>‘<samp class="samp">0.2</samp>’</dt>
<dd><p>0.2 seconds
</p>
</dd>
<dt>‘<samp class="samp">200ms</samp>’</dt>
<dd><p>200 milliseconds, that’s 0.2s
</p>
</dd>
<dt>‘<samp class="samp">200000us</samp>’</dt>
<dd><p>200000 microseconds, that’s 0.2s
</p>
</dd>
<dt>‘<samp class="samp">12:03:45</samp>’</dt>
<dd><p>12 hours, 03 minutes and 45 seconds
</p>
</dd>
<dt>‘<samp class="samp">23.189</samp>’</dt>
<dd><p>23.189 seconds
</p></dd>
</dl>
<a class="anchor" id="video-size-syntax"></a></div>
</div>
<div class="section-level-extent" id="Video-size">
<h3 class="section">4.4 Video size</h3>
<p>Specify the size of the sourced video, it may be a string of the form
<var class="var">width</var>x<var class="var">height</var>, or the name of a size abbreviation.
</p>
<p>The following abbreviations are recognized:
</p><dl class="table">
<dt>‘<samp class="samp">ntsc</samp>’</dt>
<dd><p>720x480
</p></dd>
<dt>‘<samp class="samp">pal</samp>’</dt>
<dd><p>720x576
</p></dd>
<dt>‘<samp class="samp">qntsc</samp>’</dt>
<dd><p>352x240
</p></dd>
<dt>‘<samp class="samp">qpal</samp>’</dt>
<dd><p>352x288
</p></dd>
<dt>‘<samp class="samp">sntsc</samp>’</dt>
<dd><p>640x480
</p></dd>
<dt>‘<samp class="samp">spal</samp>’</dt>
<dd><p>768x576
</p></dd>
<dt>‘<samp class="samp">film</samp>’</dt>
<dd><p>352x240
</p></dd>
<dt>‘<samp class="samp">ntsc-film</samp>’</dt>
<dd><p>352x240
</p></dd>
<dt>‘<samp class="samp">sqcif</samp>’</dt>
<dd><p>128x96
</p></dd>
<dt>‘<samp class="samp">qcif</samp>’</dt>
<dd><p>176x144
</p></dd>
<dt>‘<samp class="samp">cif</samp>’</dt>
<dd><p>352x288
</p></dd>
<dt>‘<samp class="samp">4cif</samp>’</dt>
<dd><p>704x576
</p></dd>
<dt>‘<samp class="samp">16cif</samp>’</dt>
<dd><p>1408x1152
</p></dd>
<dt>‘<samp class="samp">qqvga</samp>’</dt>
<dd><p>160x120
</p></dd>
<dt>‘<samp class="samp">qvga</samp>’</dt>
<dd><p>320x240
</p></dd>
<dt>‘<samp class="samp">vga</samp>’</dt>
<dd><p>640x480
</p></dd>
<dt>‘<samp class="samp">svga</samp>’</dt>
<dd><p>800x600
</p></dd>
<dt>‘<samp class="samp">xga</samp>’</dt>
<dd><p>1024x768
</p></dd>
<dt>‘<samp class="samp">uxga</samp>’</dt>
<dd><p>1600x1200
</p></dd>
<dt>‘<samp class="samp">qxga</samp>’</dt>
<dd><p>2048x1536
</p></dd>
<dt>‘<samp class="samp">sxga</samp>’</dt>
<dd><p>1280x1024
</p></dd>
<dt>‘<samp class="samp">qsxga</samp>’</dt>
<dd><p>2560x2048
</p></dd>
<dt>‘<samp class="samp">hsxga</samp>’</dt>
<dd><p>5120x4096
</p></dd>
<dt>‘<samp class="samp">wvga</samp>’</dt>
<dd><p>852x480
</p></dd>
<dt>‘<samp class="samp">wxga</samp>’</dt>
<dd><p>1366x768
</p></dd>
<dt>‘<samp class="samp">wsxga</samp>’</dt>
<dd><p>1600x1024
</p></dd>
<dt>‘<samp class="samp">wuxga</samp>’</dt>
<dd><p>1920x1200
</p></dd>
<dt>‘<samp class="samp">woxga</samp>’</dt>
<dd><p>2560x1600
</p></dd>
<dt>‘<samp class="samp">wqsxga</samp>’</dt>
<dd><p>3200x2048
</p></dd>
<dt>‘<samp class="samp">wquxga</samp>’</dt>
<dd><p>3840x2400
</p></dd>
<dt>‘<samp class="samp">whsxga</samp>’</dt>
<dd><p>6400x4096
</p></dd>
<dt>‘<samp class="samp">whuxga</samp>’</dt>
<dd><p>7680x4800
</p></dd>
<dt>‘<samp class="samp">cga</samp>’</dt>
<dd><p>320x200
</p></dd>
<dt>‘<samp class="samp">ega</samp>’</dt>
<dd><p>640x350
</p></dd>
<dt>‘<samp class="samp">hd480</samp>’</dt>
<dd><p>852x480
</p></dd>
<dt>‘<samp class="samp">hd720</samp>’</dt>
<dd><p>1280x720
</p></dd>
<dt>‘<samp class="samp">hd1080</samp>’</dt>
<dd><p>1920x1080
</p></dd>
<dt>‘<samp class="samp">2k</samp>’</dt>
<dd><p>2048x1080
</p></dd>
<dt>‘<samp class="samp">2kflat</samp>’</dt>
<dd><p>1998x1080
</p></dd>
<dt>‘<samp class="samp">2kscope</samp>’</dt>
<dd><p>2048x858
</p></dd>
<dt>‘<samp class="samp">4k</samp>’</dt>
<dd><p>4096x2160
</p></dd>
<dt>‘<samp class="samp">4kflat</samp>’</dt>
<dd><p>3996x2160
</p></dd>
<dt>‘<samp class="samp">4kscope</samp>’</dt>
<dd><p>4096x1716
</p></dd>
<dt>‘<samp class="samp">nhd</samp>’</dt>
<dd><p>640x360
</p></dd>
<dt>‘<samp class="samp">hqvga</samp>’</dt>
<dd><p>240x160
</p></dd>
<dt>‘<samp class="samp">wqvga</samp>’</dt>
<dd><p>400x240
</p></dd>
<dt>‘<samp class="samp">fwqvga</samp>’</dt>
<dd><p>432x240
</p></dd>
<dt>‘<samp class="samp">hvga</samp>’</dt>
<dd><p>480x320
</p></dd>
<dt>‘<samp class="samp">qhd</samp>’</dt>
<dd><p>960x540
</p></dd>
<dt>‘<samp class="samp">2kdci</samp>’</dt>
<dd><p>2048x1080
</p></dd>
<dt>‘<samp class="samp">4kdci</samp>’</dt>
<dd><p>4096x2160
</p></dd>
<dt>‘<samp class="samp">uhd2160</samp>’</dt>
<dd><p>3840x2160
</p></dd>
<dt>‘<samp class="samp">uhd4320</samp>’</dt>
<dd><p>7680x4320
</p></dd>
</dl>
<a class="anchor" id="video-rate-syntax"></a></div>
<div class="section-level-extent" id="Video-rate">
<h3 class="section">4.5 Video rate</h3>
<p>Specify the frame rate of a video, expressed as the number of frames
generated per second. It has to be a string in the format
<var class="var">frame_rate_num</var>/<var class="var">frame_rate_den</var>, an integer number, a float
number or a valid video frame rate abbreviation.
</p>
<p>The following abbreviations are recognized:
</p><dl class="table">
<dt>‘<samp class="samp">ntsc</samp>’</dt>
<dd><p>30000/1001
</p></dd>
<dt>‘<samp class="samp">pal</samp>’</dt>
<dd><p>25/1
</p></dd>
<dt>‘<samp class="samp">qntsc</samp>’</dt>
<dd><p>30000/1001
</p></dd>
<dt>‘<samp class="samp">qpal</samp>’</dt>
<dd><p>25/1
</p></dd>
<dt>‘<samp class="samp">sntsc</samp>’</dt>
<dd><p>30000/1001
</p></dd>
<dt>‘<samp class="samp">spal</samp>’</dt>
<dd><p>25/1
</p></dd>
<dt>‘<samp class="samp">film</samp>’</dt>
<dd><p>24/1
</p></dd>
<dt>‘<samp class="samp">ntsc-film</samp>’</dt>
<dd><p>24000/1001
</p></dd>
</dl>
<a class="anchor" id="ratio-syntax"></a></div>
<div class="section-level-extent" id="Ratio">
<h3 class="section">4.6 Ratio</h3>
<p>A ratio can be expressed as an expression, or in the form
<var class="var">numerator</var>:<var class="var">denominator</var>.
</p>
<p>Note that a ratio with infinite (1/0) or negative value is
considered valid, so you should check on the returned value if you
want to exclude those values.
</p>
<p>The undefined value can be expressed using the "0:0" string.
</p>
<a class="anchor" id="color-syntax"></a></div>
<div class="section-level-extent" id="Color">
<h3 class="section">4.7 Color</h3>
<p>It can be the name of a color as defined below (case insensitive match) or a
<code class="code">[0x|#]RRGGBB[AA]</code> sequence, possibly followed by @ and a string
representing the alpha component.
</p>
<p>The alpha component may be a string composed by "0x" followed by an
hexadecimal number or a decimal number between 0.0 and 1.0, which
represents the opacity value (‘<samp class="samp">0x00</samp>’ or ‘<samp class="samp">0.0</samp>’ means completely
transparent, ‘<samp class="samp">0xff</samp>’ or ‘<samp class="samp">1.0</samp>’ completely opaque). If the alpha
component is not specified then ‘<samp class="samp">0xff</samp>’ is assumed.
</p>
<p>The string ‘<samp class="samp">random</samp>’ will result in a random color.
</p>
<p>The following names of colors are recognized:
</p><dl class="table">
<dt>‘<samp class="samp">AliceBlue</samp>’</dt>
<dd><p>0xF0F8FF
</p></dd>
<dt>‘<samp class="samp">AntiqueWhite</samp>’</dt>
<dd><p>0xFAEBD7
</p></dd>
<dt>‘<samp class="samp">Aqua</samp>’</dt>
<dd><p>0x00FFFF
</p></dd>
<dt>‘<samp class="samp">Aquamarine</samp>’</dt>
<dd><p>0x7FFFD4
</p></dd>
<dt>‘<samp class="samp">Azure</samp>’</dt>
<dd><p>0xF0FFFF
</p></dd>
<dt>‘<samp class="samp">Beige</samp>’</dt>
<dd><p>0xF5F5DC
</p></dd>
<dt>‘<samp class="samp">Bisque</samp>’</dt>
<dd><p>0xFFE4C4
</p></dd>
<dt>‘<samp class="samp">Black</samp>’</dt>
<dd><p>0x000000
</p></dd>
<dt>‘<samp class="samp">BlanchedAlmond</samp>’</dt>
<dd><p>0xFFEBCD
</p></dd>
<dt>‘<samp class="samp">Blue</samp>’</dt>
<dd><p>0x0000FF
</p></dd>
<dt>‘<samp class="samp">BlueViolet</samp>’</dt>
<dd><p>0x8A2BE2
</p></dd>
<dt>‘<samp class="samp">Brown</samp>’</dt>
<dd><p>0xA52A2A
</p></dd>
<dt>‘<samp class="samp">BurlyWood</samp>’</dt>
<dd><p>0xDEB887
</p></dd>
<dt>‘<samp class="samp">CadetBlue</samp>’</dt>
<dd><p>0x5F9EA0
</p></dd>
<dt>‘<samp class="samp">Chartreuse</samp>’</dt>
<dd><p>0x7FFF00
</p></dd>
<dt>‘<samp class="samp">Chocolate</samp>’</dt>
<dd><p>0xD2691E
</p></dd>
<dt>‘<samp class="samp">Coral</samp>’</dt>
<dd><p>0xFF7F50
</p></dd>
<dt>‘<samp class="samp">CornflowerBlue</samp>’</dt>
<dd><p>0x6495ED
</p></dd>
<dt>‘<samp class="samp">Cornsilk</samp>’</dt>
<dd><p>0xFFF8DC
</p></dd>
<dt>‘<samp class="samp">Crimson</samp>’</dt>
<dd><p>0xDC143C
</p></dd>
<dt>‘<samp class="samp">Cyan</samp>’</dt>
<dd><p>0x00FFFF
</p></dd>
<dt>‘<samp class="samp">DarkBlue</samp>’</dt>
<dd><p>0x00008B
</p></dd>
<dt>‘<samp class="samp">DarkCyan</samp>’</dt>
<dd><p>0x008B8B
</p></dd>
<dt>‘<samp class="samp">DarkGoldenRod</samp>’</dt>
<dd><p>0xB8860B
</p></dd>
<dt>‘<samp class="samp">DarkGray</samp>’</dt>
<dd><p>0xA9A9A9
</p></dd>
<dt>‘<samp class="samp">DarkGreen</samp>’</dt>
<dd><p>0x006400
</p></dd>
<dt>‘<samp class="samp">DarkKhaki</samp>’</dt>
<dd><p>0xBDB76B
</p></dd>
<dt>‘<samp class="samp">DarkMagenta</samp>’</dt>
<dd><p>0x8B008B
</p></dd>
<dt>‘<samp class="samp">DarkOliveGreen</samp>’</dt>
<dd><p>0x556B2F
</p></dd>
<dt>‘<samp class="samp">Darkorange</samp>’</dt>
<dd><p>0xFF8C00
</p></dd>
<dt>‘<samp class="samp">DarkOrchid</samp>’</dt>
<dd><p>0x9932CC
</p></dd>
<dt>‘<samp class="samp">DarkRed</samp>’</dt>
<dd><p>0x8B0000
</p></dd>
<dt>‘<samp class="samp">DarkSalmon</samp>’</dt>
<dd><p>0xE9967A
</p></dd>
<dt>‘<samp class="samp">DarkSeaGreen</samp>’</dt>
<dd><p>0x8FBC8F
</p></dd>
<dt>‘<samp class="samp">DarkSlateBlue</samp>’</dt>
<dd><p>0x483D8B
</p></dd>
<dt>‘<samp class="samp">DarkSlateGray</samp>’</dt>
<dd><p>0x2F4F4F
</p></dd>
<dt>‘<samp class="samp">DarkTurquoise</samp>’</dt>
<dd><p>0x00CED1
</p></dd>
<dt>‘<samp class="samp">DarkViolet</samp>’</dt>
<dd><p>0x9400D3
</p></dd>
<dt>‘<samp class="samp">DeepPink</samp>’</dt>
<dd><p>0xFF1493
</p></dd>
<dt>‘<samp class="samp">DeepSkyBlue</samp>’</dt>
<dd><p>0x00BFFF
</p></dd>
<dt>‘<samp class="samp">DimGray</samp>’</dt>
<dd><p>0x696969
</p></dd>
<dt>‘<samp class="samp">DodgerBlue</samp>’</dt>
<dd><p>0x1E90FF
</p></dd>
<dt>‘<samp class="samp">FireBrick</samp>’</dt>
<dd><p>0xB22222
</p></dd>
<dt>‘<samp class="samp">FloralWhite</samp>’</dt>
<dd><p>0xFFFAF0
</p></dd>
<dt>‘<samp class="samp">ForestGreen</samp>’</dt>
<dd><p>0x228B22
</p></dd>
<dt>‘<samp class="samp">Fuchsia</samp>’</dt>
<dd><p>0xFF00FF
</p></dd>
<dt>‘<samp class="samp">Gainsboro</samp>’</dt>
<dd><p>0xDCDCDC
</p></dd>
<dt>‘<samp class="samp">GhostWhite</samp>’</dt>
<dd><p>0xF8F8FF
</p></dd>
<dt>‘<samp class="samp">Gold</samp>’</dt>
<dd><p>0xFFD700
</p></dd>
<dt>‘<samp class="samp">GoldenRod</samp>’</dt>
<dd><p>0xDAA520
</p></dd>
<dt>‘<samp class="samp">Gray</samp>’</dt>
<dd><p>0x808080
</p></dd>
<dt>‘<samp class="samp">Green</samp>’</dt>
<dd><p>0x008000
</p></dd>
<dt>‘<samp class="samp">GreenYellow</samp>’</dt>
<dd><p>0xADFF2F
</p></dd>
<dt>‘<samp class="samp">HoneyDew</samp>’</dt>
<dd><p>0xF0FFF0
</p></dd>
<dt>‘<samp class="samp">HotPink</samp>’</dt>
<dd><p>0xFF69B4
</p></dd>
<dt>‘<samp class="samp">IndianRed</samp>’</dt>
<dd><p>0xCD5C5C
</p></dd>
<dt>‘<samp class="samp">Indigo</samp>’</dt>
<dd><p>0x4B0082
</p></dd>
<dt>‘<samp class="samp">Ivory</samp>’</dt>
<dd><p>0xFFFFF0
</p></dd>
<dt>‘<samp class="samp">Khaki</samp>’</dt>
<dd><p>0xF0E68C
</p></dd>
<dt>‘<samp class="samp">Lavender</samp>’</dt>
<dd><p>0xE6E6FA
</p></dd>
<dt>‘<samp class="samp">LavenderBlush</samp>’</dt>
<dd><p>0xFFF0F5
</p></dd>
<dt>‘<samp class="samp">LawnGreen</samp>’</dt>
<dd><p>0x7CFC00
</p></dd>
<dt>‘<samp class="samp">LemonChiffon</samp>’</dt>
<dd><p>0xFFFACD
</p></dd>
<dt>‘<samp class="samp">LightBlue</samp>’</dt>
<dd><p>0xADD8E6
</p></dd>
<dt>‘<samp class="samp">LightCoral</samp>’</dt>
<dd><p>0xF08080
</p></dd>
<dt>‘<samp class="samp">LightCyan</samp>’</dt>
<dd><p>0xE0FFFF
</p></dd>
<dt>‘<samp class="samp">LightGoldenRodYellow</samp>’</dt>
<dd><p>0xFAFAD2
</p></dd>
<dt>‘<samp class="samp">LightGreen</samp>’</dt>
<dd><p>0x90EE90
</p></dd>
<dt>‘<samp class="samp">LightGrey</samp>’</dt>
<dd><p>0xD3D3D3
</p></dd>
<dt>‘<samp class="samp">LightPink</samp>’</dt>
<dd><p>0xFFB6C1
</p></dd>
<dt>‘<samp class="samp">LightSalmon</samp>’</dt>
<dd><p>0xFFA07A
</p></dd>
<dt>‘<samp class="samp">LightSeaGreen</samp>’</dt>
<dd><p>0x20B2AA
</p></dd>
<dt>‘<samp class="samp">LightSkyBlue</samp>’</dt>
<dd><p>0x87CEFA
</p></dd>
<dt>‘<samp class="samp">LightSlateGray</samp>’</dt>
<dd><p>0x778899
</p></dd>
<dt>‘<samp class="samp">LightSteelBlue</samp>’</dt>
<dd><p>0xB0C4DE
</p></dd>
<dt>‘<samp class="samp">LightYellow</samp>’</dt>
<dd><p>0xFFFFE0
</p></dd>
<dt>‘<samp class="samp">Lime</samp>’</dt>
<dd><p>0x00FF00
</p></dd>
<dt>‘<samp class="samp">LimeGreen</samp>’</dt>
<dd><p>0x32CD32
</p></dd>
<dt>‘<samp class="samp">Linen</samp>’</dt>
<dd><p>0xFAF0E6
</p></dd>
<dt>‘<samp class="samp">Magenta</samp>’</dt>
<dd><p>0xFF00FF
</p></dd>
<dt>‘<samp class="samp">Maroon</samp>’</dt>
<dd><p>0x800000
</p></dd>
<dt>‘<samp class="samp">MediumAquaMarine</samp>’</dt>
<dd><p>0x66CDAA
</p></dd>
<dt>‘<samp class="samp">MediumBlue</samp>’</dt>
<dd><p>0x0000CD
</p></dd>
<dt>‘<samp class="samp">MediumOrchid</samp>’</dt>
<dd><p>0xBA55D3
</p></dd>
<dt>‘<samp class="samp">MediumPurple</samp>’</dt>
<dd><p>0x9370D8
</p></dd>
<dt>‘<samp class="samp">MediumSeaGreen</samp>’</dt>
<dd><p>0x3CB371
</p></dd>
<dt>‘<samp class="samp">MediumSlateBlue</samp>’</dt>
<dd><p>0x7B68EE
</p></dd>
<dt>‘<samp class="samp">MediumSpringGreen</samp>’</dt>
<dd><p>0x00FA9A
</p></dd>
<dt>‘<samp class="samp">MediumTurquoise</samp>’</dt>
<dd><p>0x48D1CC
</p></dd>
<dt>‘<samp class="samp">MediumVioletRed</samp>’</dt>
<dd><p>0xC71585
</p></dd>
<dt>‘<samp class="samp">MidnightBlue</samp>’</dt>
<dd><p>0x191970
</p></dd>
<dt>‘<samp class="samp">MintCream</samp>’</dt>
<dd><p>0xF5FFFA
</p></dd>
<dt>‘<samp class="samp">MistyRose</samp>’</dt>
<dd><p>0xFFE4E1
</p></dd>
<dt>‘<samp class="samp">Moccasin</samp>’</dt>
<dd><p>0xFFE4B5
</p></dd>
<dt>‘<samp class="samp">NavajoWhite</samp>’</dt>
<dd><p>0xFFDEAD
</p></dd>
<dt>‘<samp class="samp">Navy</samp>’</dt>
<dd><p>0x000080
</p></dd>
<dt>‘<samp class="samp">OldLace</samp>’</dt>
<dd><p>0xFDF5E6
</p></dd>
<dt>‘<samp class="samp">Olive</samp>’</dt>
<dd><p>0x808000
</p></dd>
<dt>‘<samp class="samp">OliveDrab</samp>’</dt>
<dd><p>0x6B8E23
</p></dd>
<dt>‘<samp class="samp">Orange</samp>’</dt>
<dd><p>0xFFA500
</p></dd>
<dt>‘<samp class="samp">OrangeRed</samp>’</dt>
<dd><p>0xFF4500
</p></dd>
<dt>‘<samp class="samp">Orchid</samp>’</dt>
<dd><p>0xDA70D6
</p></dd>
<dt>‘<samp class="samp">PaleGoldenRod</samp>’</dt>
<dd><p>0xEEE8AA
</p></dd>
<dt>‘<samp class="samp">PaleGreen</samp>’</dt>
<dd><p>0x98FB98
</p></dd>
<dt>‘<samp class="samp">PaleTurquoise</samp>’</dt>
<dd><p>0xAFEEEE
</p></dd>
<dt>‘<samp class="samp">PaleVioletRed</samp>’</dt>
<dd><p>0xD87093
</p></dd>
<dt>‘<samp class="samp">PapayaWhip</samp>’</dt>
<dd><p>0xFFEFD5
</p></dd>
<dt>‘<samp class="samp">PeachPuff</samp>’</dt>
<dd><p>0xFFDAB9
</p></dd>
<dt>‘<samp class="samp">Peru</samp>’</dt>
<dd><p>0xCD853F
</p></dd>
<dt>‘<samp class="samp">Pink</samp>’</dt>
<dd><p>0xFFC0CB
</p></dd>
<dt>‘<samp class="samp">Plum</samp>’</dt>
<dd><p>0xDDA0DD
</p></dd>
<dt>‘<samp class="samp">PowderBlue</samp>’</dt>
<dd><p>0xB0E0E6
</p></dd>
<dt>‘<samp class="samp">Purple</samp>’</dt>
<dd><p>0x800080
</p></dd>
<dt>‘<samp class="samp">Red</samp>’</dt>
<dd><p>0xFF0000
</p></dd>
<dt>‘<samp class="samp">RosyBrown</samp>’</dt>
<dd><p>0xBC8F8F
</p></dd>
<dt>‘<samp class="samp">RoyalBlue</samp>’</dt>
<dd><p>0x4169E1
</p></dd>
<dt>‘<samp class="samp">SaddleBrown</samp>’</dt>
<dd><p>0x8B4513
</p></dd>
<dt>‘<samp class="samp">Salmon</samp>’</dt>
<dd><p>0xFA8072
</p></dd>
<dt>‘<samp class="samp">SandyBrown</samp>’</dt>
<dd><p>0xF4A460
</p></dd>
<dt>‘<samp class="samp">SeaGreen</samp>’</dt>
<dd><p>0x2E8B57
</p></dd>
<dt>‘<samp class="samp">SeaShell</samp>’</dt>
<dd><p>0xFFF5EE
</p></dd>
<dt>‘<samp class="samp">Sienna</samp>’</dt>
<dd><p>0xA0522D
</p></dd>
<dt>‘<samp class="samp">Silver</samp>’</dt>
<dd><p>0xC0C0C0
</p></dd>
<dt>‘<samp class="samp">SkyBlue</samp>’</dt>
<dd><p>0x87CEEB
</p></dd>
<dt>‘<samp class="samp">SlateBlue</samp>’</dt>
<dd><p>0x6A5ACD
</p></dd>
<dt>‘<samp class="samp">SlateGray</samp>’</dt>
<dd><p>0x708090
</p></dd>
<dt>‘<samp class="samp">Snow</samp>’</dt>
<dd><p>0xFFFAFA
</p></dd>
<dt>‘<samp class="samp">SpringGreen</samp>’</dt>
<dd><p>0x00FF7F
</p></dd>
<dt>‘<samp class="samp">SteelBlue</samp>’</dt>
<dd><p>0x4682B4
</p></dd>
<dt>‘<samp class="samp">Tan</samp>’</dt>
<dd><p>0xD2B48C
</p></dd>
<dt>‘<samp class="samp">Teal</samp>’</dt>
<dd><p>0x008080
</p></dd>
<dt>‘<samp class="samp">Thistle</samp>’</dt>
<dd><p>0xD8BFD8
</p></dd>
<dt>‘<samp class="samp">Tomato</samp>’</dt>
<dd><p>0xFF6347
</p></dd>
<dt>‘<samp class="samp">Turquoise</samp>’</dt>
<dd><p>0x40E0D0
</p></dd>
<dt>‘<samp class="samp">Violet</samp>’</dt>
<dd><p>0xEE82EE
</p></dd>
<dt>‘<samp class="samp">Wheat</samp>’</dt>
<dd><p>0xF5DEB3
</p></dd>
<dt>‘<samp class="samp">White</samp>’</dt>
<dd><p>0xFFFFFF
</p></dd>
<dt>‘<samp class="samp">WhiteSmoke</samp>’</dt>
<dd><p>0xF5F5F5
</p></dd>
<dt>‘<samp class="samp">Yellow</samp>’</dt>
<dd><p>0xFFFF00
</p></dd>
<dt>‘<samp class="samp">YellowGreen</samp>’</dt>
<dd><p>0x9ACD32
</p></dd>
</dl>
<a class="anchor" id="channel-layout-syntax"></a></div>
<div class="section-level-extent" id="Channel-Layout">
<h3 class="section">4.8 Channel Layout</h3>
<p>A channel layout specifies the spatial disposition of the channels in
a multi-channel audio stream. To specify a channel layout, FFmpeg
makes use of a special syntax.
</p>
<p>Individual channels are identified by an id, as given by the table
below:
</p><dl class="table">
<dt>‘<samp class="samp">FL</samp>’</dt>
<dd><p>front left
</p></dd>
<dt>‘<samp class="samp">FR</samp>’</dt>
<dd><p>front right
</p></dd>
<dt>‘<samp class="samp">FC</samp>’</dt>
<dd><p>front center
</p></dd>
<dt>‘<samp class="samp">LFE</samp>’</dt>
<dd><p>low frequency
</p></dd>
<dt>‘<samp class="samp">BL</samp>’</dt>
<dd><p>back left
</p></dd>
<dt>‘<samp class="samp">BR</samp>’</dt>
<dd><p>back right
</p></dd>
<dt>‘<samp class="samp">FLC</samp>’</dt>
<dd><p>front left-of-center
</p></dd>
<dt>‘<samp class="samp">FRC</samp>’</dt>
<dd><p>front right-of-center
</p></dd>
<dt>‘<samp class="samp">BC</samp>’</dt>
<dd><p>back center
</p></dd>
<dt>‘<samp class="samp">SL</samp>’</dt>
<dd><p>side left
</p></dd>
<dt>‘<samp class="samp">SR</samp>’</dt>
<dd><p>side right
</p></dd>
<dt>‘<samp class="samp">TC</samp>’</dt>
<dd><p>top center
</p></dd>
<dt>‘<samp class="samp">TFL</samp>’</dt>
<dd><p>top front left
</p></dd>
<dt>‘<samp class="samp">TFC</samp>’</dt>
<dd><p>top front center
</p></dd>
<dt>‘<samp class="samp">TFR</samp>’</dt>
<dd><p>top front right
</p></dd>
<dt>‘<samp class="samp">TBL</samp>’</dt>
<dd><p>top back left
</p></dd>
<dt>‘<samp class="samp">TBC</samp>’</dt>
<dd><p>top back center
</p></dd>
<dt>‘<samp class="samp">TBR</samp>’</dt>
<dd><p>top back right
</p></dd>
<dt>‘<samp class="samp">DL</samp>’</dt>
<dd><p>downmix left
</p></dd>
<dt>‘<samp class="samp">DR</samp>’</dt>
<dd><p>downmix right
</p></dd>
<dt>‘<samp class="samp">WL</samp>’</dt>
<dd><p>wide left
</p></dd>
<dt>‘<samp class="samp">WR</samp>’</dt>
<dd><p>wide right
</p></dd>
<dt>‘<samp class="samp">SDL</samp>’</dt>
<dd><p>surround direct left
</p></dd>
<dt>‘<samp class="samp">SDR</samp>’</dt>
<dd><p>surround direct right
</p></dd>
<dt>‘<samp class="samp">LFE2</samp>’</dt>
<dd><p>low frequency 2
</p></dd>
</dl>
<p>Standard channel layout compositions can be specified by using the
following identifiers:
</p><dl class="table">
<dt>‘<samp class="samp">mono</samp>’</dt>
<dd><p>FC
</p></dd>
<dt>‘<samp class="samp">stereo</samp>’</dt>
<dd><p>FL+FR
</p></dd>
<dt>‘<samp class="samp">2.1</samp>’</dt>
<dd><p>FL+FR+LFE
</p></dd>
<dt>‘<samp class="samp">3.0</samp>’</dt>
<dd><p>FL+FR+FC
</p></dd>
<dt>‘<samp class="samp">3.0(back)</samp>’</dt>
<dd><p>FL+FR+BC
</p></dd>
<dt>‘<samp class="samp">4.0</samp>’</dt>
<dd><p>FL+FR+FC+BC
</p></dd>
<dt>‘<samp class="samp">quad</samp>’</dt>
<dd><p>FL+FR+BL+BR
</p></dd>
<dt>‘<samp class="samp">quad(side)</samp>’</dt>
<dd><p>FL+FR+SL+SR
</p></dd>
<dt>‘<samp class="samp">3.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE
</p></dd>
<dt>‘<samp class="samp">5.0</samp>’</dt>
<dd><p>FL+FR+FC+BL+BR
</p></dd>
<dt>‘<samp class="samp">5.0(side)</samp>’</dt>
<dd><p>FL+FR+FC+SL+SR
</p></dd>
<dt>‘<samp class="samp">4.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BC
</p></dd>
<dt>‘<samp class="samp">5.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR
</p></dd>
<dt>‘<samp class="samp">5.1(side)</samp>’</dt>
<dd><p>FL+FR+FC+LFE+SL+SR
</p></dd>
<dt>‘<samp class="samp">6.0</samp>’</dt>
<dd><p>FL+FR+FC+BC+SL+SR
</p></dd>
<dt>‘<samp class="samp">6.0(front)</samp>’</dt>
<dd><p>FL+FR+FLC+FRC+SL+SR
</p></dd>
<dt>‘<samp class="samp">3.1.2</samp>’</dt>
<dd><p>FL+FR+FC+LFE+TFL+TFR
</p></dd>
<dt>‘<samp class="samp">hexagonal</samp>’</dt>
<dd><p>FL+FR+FC+BL+BR+BC
</p></dd>
<dt>‘<samp class="samp">6.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BC+SL+SR
</p></dd>
<dt>‘<samp class="samp">6.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+BC
</p></dd>
<dt>‘<samp class="samp">6.1(front)</samp>’</dt>
<dd><p>FL+FR+LFE+FLC+FRC+SL+SR
</p></dd>
<dt>‘<samp class="samp">7.0</samp>’</dt>
<dd><p>FL+FR+FC+BL+BR+SL+SR
</p></dd>
<dt>‘<samp class="samp">7.0(front)</samp>’</dt>
<dd><p>FL+FR+FC+FLC+FRC+SL+SR
</p></dd>
<dt>‘<samp class="samp">7.1</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+SL+SR
</p></dd>
<dt>‘<samp class="samp">7.1(wide)</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC
</p></dd>
<dt>‘<samp class="samp">7.1(wide-side)</samp>’</dt>
<dd><p>FL+FR+FC+LFE+FLC+FRC+SL+SR
</p></dd>
<dt>‘<samp class="samp">5.1.2</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+TFL+TFR
</p></dd>
<dt>‘<samp class="samp">octagonal</samp>’</dt>
<dd><p>FL+FR+FC+BL+BR+BC+SL+SR
</p></dd>
<dt>‘<samp class="samp">cube</samp>’</dt>
<dd><p>FL+FR+BL+BR+TFL+TFR+TBL+TBR
</p></dd>
<dt>‘<samp class="samp">5.1.4</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+TFL+TFR+TBL+TBR
</p></dd>
<dt>‘<samp class="samp">7.1.2</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR
</p></dd>
<dt>‘<samp class="samp">7.1.4</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR+TBL+TBR
</p></dd>
<dt>‘<samp class="samp">hexadecagonal</samp>’</dt>
<dd><p>FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR
</p></dd>
<dt>‘<samp class="samp">downmix</samp>’</dt>
<dd><p>DL+DR
</p></dd>
<dt>‘<samp class="samp">22.2</samp>’</dt>
<dd><p>FL+FR+FC+LFE+BL+BR+FLC+FRC+BC+SL+SR+TC+TFL+TFC+TFR+TBL+TBC+TBR+LFE2+TSL+TSR+BFC+BFL+BFR
</p></dd>
</dl>
<p>A custom channel layout can be specified as a sequence of terms, separated by ’+’.
Each term can be:
</p><ul class="itemize mark-bullet">
<li>the name of a single channel (e.g. ‘<samp class="samp">FL</samp>’, ‘<samp class="samp">FR</samp>’, ‘<samp class="samp">FC</samp>’, ‘<samp class="samp">LFE</samp>’, etc.),
each optionally containing a custom name after a ’@’, (e.g. ‘<samp class="samp">FL@Left</samp>’,
‘<samp class="samp">FR@Right</samp>’, ‘<samp class="samp">FC@Center</samp>’, ‘<samp class="samp">LFE@Low_Frequency</samp>’, etc.)
</li></ul>
<p>A standard channel layout can be specified by the following:
</p><ul class="itemize mark-bullet">
<li>the name of a single channel (e.g. ‘<samp class="samp">FL</samp>’, ‘<samp class="samp">FR</samp>’, ‘<samp class="samp">FC</samp>’, ‘<samp class="samp">LFE</samp>’, etc.)
</li><li>the name of a standard channel layout (e.g. ‘<samp class="samp">mono</samp>’,
‘<samp class="samp">stereo</samp>’, ‘<samp class="samp">4.0</samp>’, ‘<samp class="samp">quad</samp>’, ‘<samp class="samp">5.0</samp>’, etc.)
</li><li>a number of channels, in decimal, followed by ’c’, yielding the default channel
layout for that number of channels (see the function
<code class="code">av_channel_layout_default</code>). Note that not all channel counts have a
default layout.
</li><li>a number of channels, in decimal, followed by ’C’, yielding an unknown channel
layout with the specified number of channels. Note that not all channel layout
specification strings support unknown channel layouts.
</li><li>a channel layout mask, in hexadecimal starting with "0x" (see the
<code class="code">AV_CH_*</code> macros in <samp class="file">libavutil/channel_layout.h</samp>.
</li></ul>
<p>Before libavutil version 53 the trailing character "c" to specify a number of
channels was optional, but now it is required, while a channel layout mask can
also be specified as a decimal number (if and only if not followed by "c" or "C").
</p>
<p>See also the function <code class="code">av_channel_layout_from_string</code> defined in
<samp class="file">libavutil/channel_layout.h</samp>.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Expression-Evaluation">
<h2 class="chapter">5 Expression Evaluation</h2>
<p>When evaluating an arithmetic expression, FFmpeg uses an internal
formula evaluator, implemented through the <samp class="file">libavutil/eval.h</samp>
interface.
</p>
<p>An expression may contain unary, binary operators, constants, and
functions.
</p>
<p>Two expressions <var class="var">expr1</var> and <var class="var">expr2</var> can be combined to form
another expression "<var class="var">expr1</var>;<var class="var">expr2</var>".
<var class="var">expr1</var> and <var class="var">expr2</var> are evaluated in turn, and the new
expression evaluates to the value of <var class="var">expr2</var>.
</p>
<p>The following binary operators are available: <code class="code">+</code>, <code class="code">-</code>,
<code class="code">*</code>, <code class="code">/</code>, <code class="code">^</code>.
</p>
<p>The following unary operators are available: <code class="code">+</code>, <code class="code">-</code>.
</p>
<p>The following functions are available:
</p><dl class="table">
<dt><samp class="option">abs(x)</samp></dt>
<dd><p>Compute absolute value of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">acos(x)</samp></dt>
<dd><p>Compute arccosine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">asin(x)</samp></dt>
<dd><p>Compute arcsine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">atan(x)</samp></dt>
<dd><p>Compute arctangent of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">atan2(x, y)</samp></dt>
<dd><p>Compute principal value of the arc tangent of <var class="var">y</var>/<var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">between(x, min, max)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> is greater than or equal to <var class="var">min</var> and lesser than or
equal to <var class="var">max</var>, 0 otherwise.
</p>
</dd>
<dt><samp class="option">bitand(x, y)</samp></dt>
<dt><samp class="option">bitor(x, y)</samp></dt>
<dd><p>Compute bitwise and/or operation on <var class="var">x</var> and <var class="var">y</var>.
</p>
<p>The results of the evaluation of <var class="var">x</var> and <var class="var">y</var> are converted to
integers before executing the bitwise operation.
</p>
<p>Note that both the conversion to integer and the conversion back to
floating point can lose precision. Beware of unexpected results for
large numbers (usually 2^53 and larger).
</p>
</dd>
<dt><samp class="option">ceil(expr)</samp></dt>
<dd><p>Round the value of expression <var class="var">expr</var> upwards to the nearest
integer. For example, "ceil(1.5)" is "2.0".
</p>
</dd>
<dt><samp class="option">clip(x, min, max)</samp></dt>
<dd><p>Return the value of <var class="var">x</var> clipped between <var class="var">min</var> and <var class="var">max</var>.
</p>
</dd>
<dt><samp class="option">cos(x)</samp></dt>
<dd><p>Compute cosine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">cosh(x)</samp></dt>
<dd><p>Compute hyperbolic cosine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">eq(x, y)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> and <var class="var">y</var> are equivalent, 0 otherwise.
</p>
</dd>
<dt><samp class="option">exp(x)</samp></dt>
<dd><p>Compute exponential of <var class="var">x</var> (with base <code class="code">e</code>, the Euler’s number).
</p>
</dd>
<dt><samp class="option">floor(expr)</samp></dt>
<dd><p>Round the value of expression <var class="var">expr</var> downwards to the nearest
integer. For example, "floor(-1.5)" is "-2.0".
</p>
</dd>
<dt><samp class="option">gauss(x)</samp></dt>
<dd><p>Compute Gauss function of <var class="var">x</var>, corresponding to
<code class="code">exp(-x*x/2) / sqrt(2*PI)</code>.
</p>
</dd>
<dt><samp class="option">gcd(x, y)</samp></dt>
<dd><p>Return the greatest common divisor of <var class="var">x</var> and <var class="var">y</var>. If both <var class="var">x</var> and
<var class="var">y</var> are 0 or either or both are less than zero then behavior is undefined.
</p>
</dd>
<dt><samp class="option">gt(x, y)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> is greater than <var class="var">y</var>, 0 otherwise.
</p>
</dd>
<dt><samp class="option">gte(x, y)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> is greater than or equal to <var class="var">y</var>, 0 otherwise.
</p>
</dd>
<dt><samp class="option">hypot(x, y)</samp></dt>
<dd><p>This function is similar to the C function with the same name; it returns
"sqrt(<var class="var">x</var>*<var class="var">x</var> + <var class="var">y</var>*<var class="var">y</var>)", the length of the hypotenuse of a
right triangle with sides of length <var class="var">x</var> and <var class="var">y</var>, or the distance of the
point (<var class="var">x</var>, <var class="var">y</var>) from the origin.
</p>
</dd>
<dt><samp class="option">if(x, y)</samp></dt>
<dd><p>Evaluate <var class="var">x</var>, and if the result is non-zero return the result of
the evaluation of <var class="var">y</var>, return 0 otherwise.
</p>
</dd>
<dt><samp class="option">if(x, y, z)</samp></dt>
<dd><p>Evaluate <var class="var">x</var>, and if the result is non-zero return the evaluation
result of <var class="var">y</var>, otherwise the evaluation result of <var class="var">z</var>.
</p>
</dd>
<dt><samp class="option">ifnot(x, y)</samp></dt>
<dd><p>Evaluate <var class="var">x</var>, and if the result is zero return the result of the
evaluation of <var class="var">y</var>, return 0 otherwise.
</p>
</dd>
<dt><samp class="option">ifnot(x, y, z)</samp></dt>
<dd><p>Evaluate <var class="var">x</var>, and if the result is zero return the evaluation
result of <var class="var">y</var>, otherwise the evaluation result of <var class="var">z</var>.
</p>
</dd>
<dt><samp class="option">isinf(x)</samp></dt>
<dd><p>Return 1.0 if <var class="var">x</var> is +/-INFINITY, 0.0 otherwise.
</p>
</dd>
<dt><samp class="option">isnan(x)</samp></dt>
<dd><p>Return 1.0 if <var class="var">x</var> is NAN, 0.0 otherwise.
</p>
</dd>
<dt><samp class="option">ld(var)</samp></dt>
<dd><p>Load the value of the internal variable with number
<var class="var">var</var>, which was previously stored with st(<var class="var">var</var>, <var class="var">expr</var>).
The function returns the loaded value.
</p>
</dd>
<dt><samp class="option">lerp(x, y, z)</samp></dt>
<dd><p>Return linear interpolation between <var class="var">x</var> and <var class="var">y</var> by amount of <var class="var">z</var>.
</p>
</dd>
<dt><samp class="option">log(x)</samp></dt>
<dd><p>Compute natural logarithm of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">lt(x, y)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> is lesser than <var class="var">y</var>, 0 otherwise.
</p>
</dd>
<dt><samp class="option">lte(x, y)</samp></dt>
<dd><p>Return 1 if <var class="var">x</var> is lesser than or equal to <var class="var">y</var>, 0 otherwise.
</p>
</dd>
<dt><samp class="option">max(x, y)</samp></dt>
<dd><p>Return the maximum between <var class="var">x</var> and <var class="var">y</var>.
</p>
</dd>
<dt><samp class="option">min(x, y)</samp></dt>
<dd><p>Return the minimum between <var class="var">x</var> and <var class="var">y</var>.
</p>
</dd>
<dt><samp class="option">mod(x, y)</samp></dt>
<dd><p>Compute the remainder of division of <var class="var">x</var> by <var class="var">y</var>.
</p>
</dd>
<dt><samp class="option">not(expr)</samp></dt>
<dd><p>Return 1.0 if <var class="var">expr</var> is zero, 0.0 otherwise.
</p>
</dd>
<dt><samp class="option">pow(x, y)</samp></dt>
<dd><p>Compute the power of <var class="var">x</var> elevated <var class="var">y</var>, it is equivalent to
"(<var class="var">x</var>)^(<var class="var">y</var>)".
</p>
</dd>
<dt><samp class="option">print(t)</samp></dt>
<dt><samp class="option">print(t, l)</samp></dt>
<dd><p>Print the value of expression <var class="var">t</var> with loglevel <var class="var">l</var>. If
<var class="var">l</var> is not specified then a default log level is used.
Returns the value of the expression printed.
</p>
<p>Prints t with loglevel l
</p>
</dd>
<dt><samp class="option">random(x)</samp></dt>
<dd><p>Return a pseudo random value between 0.0 and 1.0. <var class="var">x</var> is the index of the
internal variable which will be used to save the seed/state.
</p>
</dd>
<dt><samp class="option">root(expr, max)</samp></dt>
<dd><p>Find an input value for which the function represented by <var class="var">expr</var>
with argument <var class="var">ld(0)</var> is 0 in the interval 0..<var class="var">max</var>.
</p>
<p>The expression in <var class="var">expr</var> must denote a continuous function or the
result is undefined.
</p>
<p><var class="var">ld(0)</var> is used to represent the function input value, which means
that the given expression will be evaluated multiple times with
various input values that the expression can access through
<code class="code">ld(0)</code>. When the expression evaluates to 0 then the
corresponding input value will be returned.
</p>
</dd>
<dt><samp class="option">round(expr)</samp></dt>
<dd><p>Round the value of expression <var class="var">expr</var> to the nearest integer. For example, "round(1.5)" is "2.0".
</p>
</dd>
<dt><samp class="option">sgn(x)</samp></dt>
<dd><p>Compute sign of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">sin(x)</samp></dt>
<dd><p>Compute sine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">sinh(x)</samp></dt>
<dd><p>Compute hyperbolic sine of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">sqrt(expr)</samp></dt>
<dd><p>Compute the square root of <var class="var">expr</var>. This is equivalent to
"(<var class="var">expr</var>)^.5".
</p>
</dd>
<dt><samp class="option">squish(x)</samp></dt>
<dd><p>Compute expression <code class="code">1/(1 + exp(4*x))</code>.
</p>
</dd>
<dt><samp class="option">st(var, expr)</samp></dt>
<dd><p>Store the value of the expression <var class="var">expr</var> in an internal
variable. <var class="var">var</var> specifies the number of the variable where to
store the value, and it is a value ranging from 0 to 9. The function
returns the value stored in the internal variable.
Note, Variables are currently not shared between expressions.
</p>
</dd>
<dt><samp class="option">tan(x)</samp></dt>
<dd><p>Compute tangent of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">tanh(x)</samp></dt>
<dd><p>Compute hyperbolic tangent of <var class="var">x</var>.
</p>
</dd>
<dt><samp class="option">taylor(expr, x)</samp></dt>
<dt><samp class="option">taylor(expr, x, id)</samp></dt>
<dd><p>Evaluate a Taylor series at <var class="var">x</var>, given an expression representing
the <code class="code">ld(id)</code>-th derivative of a function at 0.
</p>
<p>When the series does not converge the result is undefined.
</p>
<p><var class="var">ld(id)</var> is used to represent the derivative order in <var class="var">expr</var>,
which means that the given expression will be evaluated multiple times
with various input values that the expression can access through
<code class="code">ld(id)</code>. If <var class="var">id</var> is not specified then 0 is assumed.
</p>
<p>Note, when you have the derivatives at y instead of 0,
<code class="code">taylor(expr, x-y)</code> can be used.
</p>
</dd>
<dt><samp class="option">time(0)</samp></dt>
<dd><p>Return the current (wallclock) time in seconds.
</p>
</dd>
<dt><samp class="option">trunc(expr)</samp></dt>
<dd><p>Round the value of expression <var class="var">expr</var> towards zero to the nearest
integer. For example, "trunc(-1.5)" is "-1.0".
</p>
</dd>
<dt><samp class="option">while(cond, expr)</samp></dt>
<dd><p>Evaluate expression <var class="var">expr</var> while the expression <var class="var">cond</var> is
non-zero, and returns the value of the last <var class="var">expr</var> evaluation, or
NAN if <var class="var">cond</var> was always false.
</p></dd>
</dl>
<p>The following constants are available:
</p><dl class="table">
<dt><samp class="option">PI</samp></dt>
<dd><p>area of the unit disc, approximately 3.14
</p></dd>
<dt><samp class="option">E</samp></dt>
<dd><p>exp(1) (Euler’s number), approximately 2.718
</p></dd>
<dt><samp class="option">PHI</samp></dt>
<dd><p>golden ratio (1+sqrt(5))/2, approximately 1.618
</p></dd>
</dl>
<p>Assuming that an expression is considered "true" if it has a non-zero
value, note that:
</p>
<p><code class="code">*</code> works like AND
</p>
<p><code class="code">+</code> works like OR
</p>
<p>For example the construct:
</p><div class="example">
<pre class="example-preformatted">if (A AND B) then C
</pre></div>
<p>is equivalent to:
</p><div class="example">
<pre class="example-preformatted">if(A*B, C)
</pre></div>
<p>In your C code, you can extend the list of unary and binary functions,
and define recognized constants, so that they are available for your
expressions.
</p>
<p>The evaluator also recognizes the International System unit prefixes.
If ’i’ is appended after the prefix, binary prefixes are used, which
are based on powers of 1024 instead of powers of 1000.
The ’B’ postfix multiplies the value by 8, and can be appended after a
unit prefix or used alone. This allows using for example ’KB’, ’MiB’,
’G’ and ’B’ as number postfix.
</p>
<p>The list of available International System prefixes follows, with
indication of the corresponding powers of 10 and of 2.
</p><dl class="table">
<dt><samp class="option">y</samp></dt>
<dd><p>10^-24 / 2^-80
</p></dd>
<dt><samp class="option">z</samp></dt>
<dd><p>10^-21 / 2^-70
</p></dd>
<dt><samp class="option">a</samp></dt>
<dd><p>10^-18 / 2^-60
</p></dd>
<dt><samp class="option">f</samp></dt>
<dd><p>10^-15 / 2^-50
</p></dd>
<dt><samp class="option">p</samp></dt>
<dd><p>10^-12 / 2^-40
</p></dd>
<dt><samp class="option">n</samp></dt>
<dd><p>10^-9 / 2^-30
</p></dd>
<dt><samp class="option">u</samp></dt>
<dd><p>10^-6 / 2^-20
</p></dd>
<dt><samp class="option">m</samp></dt>
<dd><p>10^-3 / 2^-10
</p></dd>
<dt><samp class="option">c</samp></dt>
<dd><p>10^-2
</p></dd>
<dt><samp class="option">d</samp></dt>
<dd><p>10^-1
</p></dd>
<dt><samp class="option">h</samp></dt>
<dd><p>10^2
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>10^3 / 2^10
</p></dd>
<dt><samp class="option">K</samp></dt>
<dd><p>10^3 / 2^10
</p></dd>
<dt><samp class="option">M</samp></dt>
<dd><p>10^6 / 2^20
</p></dd>
<dt><samp class="option">G</samp></dt>
<dd><p>10^9 / 2^30
</p></dd>
<dt><samp class="option">T</samp></dt>
<dd><p>10^12 / 2^40
</p></dd>
<dt><samp class="option">P</samp></dt>
<dd><p>10^15 / 2^50
</p></dd>
<dt><samp class="option">E</samp></dt>
<dd><p>10^18 / 2^60
</p></dd>
<dt><samp class="option">Z</samp></dt>
<dd><p>10^21 / 2^70
</p></dd>
<dt><samp class="option">Y</samp></dt>
<dd><p>10^24 / 2^80
</p></dd>
</dl>
<a class="anchor" id="codec_002doptions"></a></div>
<div class="chapter-level-extent" id="Codec-Options">
<h2 class="chapter">6 Codec Options</h2>
<p>libavcodec provides some generic global options, which can be set on
all the encoders and decoders. In addition each codec may support
so-called private options, which are specific for a given codec.
</p>
<p>Sometimes, a global option may only affect a specific kind of codec,
and may be nonsensical or ignored by another, so you need to be aware
of the meaning of the specified options. Also some options are
meant only for decoding or encoding.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, or by setting the value explicitly in the
<code class="code">AVCodecContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API
for programmatic use.
</p>
<p>The list of supported options follow:
</p>
<dl class="table">
<dt><samp class="option">b <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd><p>Set bitrate in bits/s. Default value is 200K.
</p>
</dd>
<dt><samp class="option">ab <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
<dd><p>Set audio bitrate (in bits/s). Default value is 128K.
</p>
</dd>
<dt><samp class="option">bt <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate
tolerance specifies how far ratecontrol is willing to deviate from the
target average bitrate value. This is not related to min/max
bitrate. Lowering tolerance too much has an adverse effect on quality.
</p>
</dd>
<dt><samp class="option">flags <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd><p>Set generic flags.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">mv4</samp>’</dt>
<dd><p>Use four motion vector by macroblock (mpeg4).
</p></dd>
<dt>‘<samp class="samp">qpel</samp>’</dt>
<dd><p>Use 1/4 pel motion compensation.
</p></dd>
<dt>‘<samp class="samp">loop</samp>’</dt>
<dd><p>Use loop filter.
</p></dd>
<dt>‘<samp class="samp">qscale</samp>’</dt>
<dd><p>Use fixed qscale.
</p></dd>
<dt>‘<samp class="samp">pass1</samp>’</dt>
<dd><p>Use internal 2pass ratecontrol in first pass mode.
</p></dd>
<dt>‘<samp class="samp">pass2</samp>’</dt>
<dd><p>Use internal 2pass ratecontrol in second pass mode.
</p></dd>
<dt>‘<samp class="samp">gray</samp>’</dt>
<dd><p>Only decode/encode grayscale.
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>Set error[?] variables during encoding.
</p></dd>
<dt>‘<samp class="samp">truncated</samp>’</dt>
<dd><p>Input bitstream might be randomly truncated.
</p></dd>
<dt>‘<samp class="samp">drop_changed</samp>’</dt>
<dd><p>Don’t output frames whose parameters differ from first decoded frame in stream.
Error AVERROR_INPUT_CHANGED is returned when a frame is dropped.
</p>
</dd>
<dt>‘<samp class="samp">ildct</samp>’</dt>
<dd><p>Use interlaced DCT.
</p></dd>
<dt>‘<samp class="samp">low_delay</samp>’</dt>
<dd><p>Force low delay.
</p></dd>
<dt>‘<samp class="samp">global_header</samp>’</dt>
<dd><p>Place global headers in extradata instead of every keyframe.
</p></dd>
<dt>‘<samp class="samp">bitexact</samp>’</dt>
<dd><p>Only write platform-, build- and time-independent data. (except (I)DCT).
This ensures that file and data checksums are reproducible and match between
platforms. Its primary use is for regression testing.
</p></dd>
<dt>‘<samp class="samp">aic</samp>’</dt>
<dd><p>Apply H263 advanced intra coding / mpeg4 ac prediction.
</p></dd>
<dt>‘<samp class="samp">ilme</samp>’</dt>
<dd><p>Apply interlaced motion estimation.
</p></dd>
<dt>‘<samp class="samp">cgop</samp>’</dt>
<dd><p>Use closed gop.
</p></dd>
<dt>‘<samp class="samp">output_corrupt</samp>’</dt>
<dd><p>Output even potentially corrupted frames.
</p></dd>
</dl>
</dd>
<dt><samp class="option">time_base <var class="var">rational number</var></samp></dt>
<dd><p>Set codec time base.
</p>
<p>It is the fundamental unit of time (in seconds) in terms of which
frame timestamps are represented. For fixed-fps content, timebase
should be <code class="code">1 / frame_rate</code> and timestamp increments should be
identically 1.
</p>
</dd>
<dt><samp class="option">g <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set the group of picture (GOP) size. Default value is 12.
</p>
</dd>
<dt><samp class="option">ar <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
<dd><p>Set audio sampling rate (in Hz).
</p>
</dd>
<dt><samp class="option">ac <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
<dd><p>Set number of audio channels.
</p>
</dd>
<dt><samp class="option">cutoff <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
<dd><p>Set cutoff bandwidth. (Supported only by selected encoders, see
their respective documentation sections.)
</p>
</dd>
<dt><samp class="option">frame_size <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
<dd><p>Set audio frame size.
</p>
<p>Each submitted frame except the last must contain exactly frame_size
samples per channel. May be 0 when the codec has
CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not
restricted. It is set by some decoders to indicate constant frame
size.
</p>
</dd>
<dt><samp class="option">frame_number <var class="var">integer</var></samp></dt>
<dd><p>Set the frame number.
</p>
</dd>
<dt><samp class="option">delay <var class="var">integer</var></samp></dt>
<dt><samp class="option">qcomp <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set video quantizer scale compression (VBR). It is used as a constant
in the ratecontrol equation. Recommended range for default rc_eq:
0.0-1.0.
</p>
</dd>
<dt><samp class="option">qblur <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set video quantizer scale blur (VBR).
</p>
</dd>
<dt><samp class="option">qmin <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set min video quantizer scale (VBR). Must be included between -1 and
69, default value is 2.
</p>
</dd>
<dt><samp class="option">qmax <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set max video quantizer scale (VBR). Must be included between -1 and
1024, default value is 31.
</p>
</dd>
<dt><samp class="option">qdiff <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set max difference between the quantizer scale (VBR).
</p>
</dd>
<dt><samp class="option">bf <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set max number of B frames between non-B-frames.
</p>
<p>Must be an integer between -1 and 16. 0 means that B-frames are
disabled. If a value of -1 is used, it will choose an automatic value
depending on the encoder.
</p>
<p>Default value is 0.
</p>
</dd>
<dt><samp class="option">b_qfactor <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set qp factor between P and B frames.
</p>
</dd>
<dt><samp class="option">codec_tag <var class="var">integer</var></samp></dt>
<dt><samp class="option">bug <var class="var">flags</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Workaround not auto detected encoder bugs.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">autodetect</samp>’</dt>
<dt>‘<samp class="samp">xvid_ilace</samp>’</dt>
<dd><p>Xvid interlacing bug (autodetected if fourcc==XVIX)
</p></dd>
<dt>‘<samp class="samp">ump4</samp>’</dt>
<dd><p>(autodetected if fourcc==UMP4)
</p></dd>
<dt>‘<samp class="samp">no_padding</samp>’</dt>
<dd><p>padding bug (autodetected)
</p></dd>
<dt>‘<samp class="samp">amv</samp>’</dt>
<dt>‘<samp class="samp">qpel_chroma</samp>’</dt>
<dt>‘<samp class="samp">std_qpel</samp>’</dt>
<dd><p>old standard qpel (autodetected per fourcc/version)
</p></dd>
<dt>‘<samp class="samp">qpel_chroma2</samp>’</dt>
<dt>‘<samp class="samp">direct_blocksize</samp>’</dt>
<dd><p>direct-qpel-blocksize bug (autodetected per fourcc/version)
</p></dd>
<dt>‘<samp class="samp">edge</samp>’</dt>
<dd><p>edge padding bug (autodetected per fourcc/version)
</p></dd>
<dt>‘<samp class="samp">hpel_chroma</samp>’</dt>
<dt>‘<samp class="samp">dc_clip</samp>’</dt>
<dt>‘<samp class="samp">ms</samp>’</dt>
<dd><p>Workaround various bugs in microsoft broken decoders.
</p></dd>
<dt>‘<samp class="samp">trunc</samp>’</dt>
<dd><p>trancated frames
</p></dd>
</dl>
</dd>
<dt><samp class="option">strict <var class="var">integer</var> (<em class="emph">decoding/encoding,audio,video</em>)</samp></dt>
<dd><p>Specify how strictly to follow the standards.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">very</samp>’</dt>
<dd><p>strictly conform to an older more strict version of the spec or reference software
</p></dd>
<dt>‘<samp class="samp">strict</samp>’</dt>
<dd><p>strictly conform to all the things in the spec no matter what consequences
</p></dd>
<dt>‘<samp class="samp">normal</samp>’</dt>
<dt>‘<samp class="samp">unofficial</samp>’</dt>
<dd><p>allow unofficial extensions
</p></dd>
<dt>‘<samp class="samp">experimental</samp>’</dt>
<dd><p>allow non standardized experimental things, experimental
(unfinished/work in progress/not well tested) decoders and encoders.
Note: experimental decoders can pose a security risk, do not use this for
decoding untrusted input.
</p></dd>
</dl>
</dd>
<dt><samp class="option">b_qoffset <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set QP offset between P and B frames.
</p>
</dd>
<dt><samp class="option">err_detect <var class="var">flags</var> (<em class="emph">decoding,audio,video</em>)</samp></dt>
<dd><p>Set error detection flags.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">crccheck</samp>’</dt>
<dd><p>verify embedded CRCs
</p></dd>
<dt>‘<samp class="samp">bitstream</samp>’</dt>
<dd><p>detect bitstream specification deviations
</p></dd>
<dt>‘<samp class="samp">buffer</samp>’</dt>
<dd><p>detect improper bitstream length
</p></dd>
<dt>‘<samp class="samp">explode</samp>’</dt>
<dd><p>abort decoding on minor error detection
</p></dd>
<dt>‘<samp class="samp">ignore_err</samp>’</dt>
<dd><p>ignore decoding errors, and continue decoding.
This is useful if you want to analyze the content of a video and thus want
everything to be decoded no matter what. This option will not result in a video
that is pleasing to watch in case of errors.
</p></dd>
<dt>‘<samp class="samp">careful</samp>’</dt>
<dd><p>consider things that violate the spec and have not been seen in the wild as errors
</p></dd>
<dt>‘<samp class="samp">compliant</samp>’</dt>
<dd><p>consider all spec non compliancies as errors
</p></dd>
<dt>‘<samp class="samp">aggressive</samp>’</dt>
<dd><p>consider things that a sane encoder should not do as an error
</p></dd>
</dl>
</dd>
<dt><samp class="option">has_b_frames <var class="var">integer</var></samp></dt>
<dt><samp class="option">block_align <var class="var">integer</var></samp></dt>
<dt><samp class="option">rc_override_count <var class="var">integer</var></samp></dt>
<dt><samp class="option">maxrate <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd><p>Set max bitrate tolerance (in bits/s). Requires bufsize to be set.
</p>
</dd>
<dt><samp class="option">minrate <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd><p>Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR
encode. It is of little use elsewise.
</p>
</dd>
<dt><samp class="option">bufsize <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd><p>Set ratecontrol buffer size (in bits).
</p>
</dd>
<dt><samp class="option">i_qfactor <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set QP factor between P and I frames.
</p>
</dd>
<dt><samp class="option">i_qoffset <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set QP offset between P and I frames.
</p>
</dd>
<dt><samp class="option">dct <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set DCT algorithm.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>autoselect a good one (default)
</p></dd>
<dt>‘<samp class="samp">fastint</samp>’</dt>
<dd><p>fast integer
</p></dd>
<dt>‘<samp class="samp">int</samp>’</dt>
<dd><p>accurate integer
</p></dd>
<dt>‘<samp class="samp">mmx</samp>’</dt>
<dt>‘<samp class="samp">altivec</samp>’</dt>
<dt>‘<samp class="samp">faan</samp>’</dt>
<dd><p>floating point AAN DCT
</p></dd>
</dl>
</dd>
<dt><samp class="option">lumi_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Compress bright areas stronger than medium ones.
</p>
</dd>
<dt><samp class="option">tcplx_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set temporal complexity masking.
</p>
</dd>
<dt><samp class="option">scplx_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set spatial complexity masking.
</p>
</dd>
<dt><samp class="option">p_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set inter masking.
</p>
</dd>
<dt><samp class="option">dark_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Compress dark areas stronger than medium ones.
</p>
</dd>
<dt><samp class="option">idct <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Select IDCT implementation.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dt>‘<samp class="samp">int</samp>’</dt>
<dt>‘<samp class="samp">simple</samp>’</dt>
<dt>‘<samp class="samp">simplemmx</samp>’</dt>
<dt>‘<samp class="samp">simpleauto</samp>’</dt>
<dd><p>Automatically pick a IDCT compatible with the simple one
</p>
</dd>
<dt>‘<samp class="samp">arm</samp>’</dt>
<dt>‘<samp class="samp">altivec</samp>’</dt>
<dt>‘<samp class="samp">sh4</samp>’</dt>
<dt>‘<samp class="samp">simplearm</samp>’</dt>
<dt>‘<samp class="samp">simplearmv5te</samp>’</dt>
<dt>‘<samp class="samp">simplearmv6</samp>’</dt>
<dt>‘<samp class="samp">simpleneon</samp>’</dt>
<dt>‘<samp class="samp">xvid</samp>’</dt>
<dt>‘<samp class="samp">faani</samp>’</dt>
<dd><p>floating point AAN IDCT
</p></dd>
</dl>
</dd>
<dt><samp class="option">slice_count <var class="var">integer</var></samp></dt>
<dt><samp class="option">ec <var class="var">flags</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Set error concealment strategy.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">guess_mvs</samp>’</dt>
<dd><p>iterative motion vector (MV) search (slow)
</p></dd>
<dt>‘<samp class="samp">deblock</samp>’</dt>
<dd><p>use strong deblock filter for damaged MBs
</p></dd>
<dt>‘<samp class="samp">favor_inter</samp>’</dt>
<dd><p>favor predicting from the previous frame instead of the current
</p></dd>
</dl>
</dd>
<dt><samp class="option">bits_per_coded_sample <var class="var">integer</var></samp></dt>
<dt><samp class="option">aspect <var class="var">rational number</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set sample aspect ratio.
</p>
</dd>
<dt><samp class="option">sar <var class="var">rational number</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set sample aspect ratio. Alias to <var class="var">aspect</var>.
</p>
</dd>
<dt><samp class="option">debug <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd><p>Print specific debug info.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">pict</samp>’</dt>
<dd><p>picture info
</p></dd>
<dt>‘<samp class="samp">rc</samp>’</dt>
<dd><p>rate control
</p></dd>
<dt>‘<samp class="samp">bitstream</samp>’</dt>
<dt>‘<samp class="samp">mb_type</samp>’</dt>
<dd><p>macroblock (MB) type
</p></dd>
<dt>‘<samp class="samp">qp</samp>’</dt>
<dd><p>per-block quantization parameter (QP)
</p></dd>
<dt>‘<samp class="samp">dct_coeff</samp>’</dt>
<dt>‘<samp class="samp">green_metadata</samp>’</dt>
<dd><p>display complexity metadata for the upcoming frame, GoP or for a given duration.
</p>
</dd>
<dt>‘<samp class="samp">skip</samp>’</dt>
<dt>‘<samp class="samp">startcode</samp>’</dt>
<dt>‘<samp class="samp">er</samp>’</dt>
<dd><p>error recognition
</p></dd>
<dt>‘<samp class="samp">mmco</samp>’</dt>
<dd><p>memory management control operations (H.264)
</p></dd>
<dt>‘<samp class="samp">bugs</samp>’</dt>
<dt>‘<samp class="samp">buffers</samp>’</dt>
<dd><p>picture buffer allocations
</p></dd>
<dt>‘<samp class="samp">thread_ops</samp>’</dt>
<dd><p>threading operations
</p></dd>
<dt>‘<samp class="samp">nomc</samp>’</dt>
<dd><p>skip motion compensation
</p></dd>
</dl>
</dd>
<dt><samp class="option">cmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set full pel me compare function.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">sad</samp>’</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>‘<samp class="samp">satd</samp>’</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>‘<samp class="samp">dct</samp>’</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>‘<samp class="samp">bit</samp>’</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>‘<samp class="samp">zero</samp>’</dt>
<dd><p>0
</p></dd>
<dt>‘<samp class="samp">vsad</samp>’</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>‘<samp class="samp">vsse</samp>’</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>‘<samp class="samp">nsse</samp>’</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>‘<samp class="samp">w53</samp>’</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">w97</samp>’</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">dctmax</samp>’</dt>
<dt>‘<samp class="samp">chroma</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">subcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set sub pel me compare function.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">sad</samp>’</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>‘<samp class="samp">satd</samp>’</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>‘<samp class="samp">dct</samp>’</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>‘<samp class="samp">bit</samp>’</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>‘<samp class="samp">zero</samp>’</dt>
<dd><p>0
</p></dd>
<dt>‘<samp class="samp">vsad</samp>’</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>‘<samp class="samp">vsse</samp>’</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>‘<samp class="samp">nsse</samp>’</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>‘<samp class="samp">w53</samp>’</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">w97</samp>’</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">dctmax</samp>’</dt>
<dt>‘<samp class="samp">chroma</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">mbcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set macroblock compare function.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">sad</samp>’</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>‘<samp class="samp">satd</samp>’</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>‘<samp class="samp">dct</samp>’</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>‘<samp class="samp">bit</samp>’</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>‘<samp class="samp">zero</samp>’</dt>
<dd><p>0
</p></dd>
<dt>‘<samp class="samp">vsad</samp>’</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>‘<samp class="samp">vsse</samp>’</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>‘<samp class="samp">nsse</samp>’</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>‘<samp class="samp">w53</samp>’</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">w97</samp>’</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">dctmax</samp>’</dt>
<dt>‘<samp class="samp">chroma</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">ildctcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set interlaced dct compare function.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">sad</samp>’</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>‘<samp class="samp">satd</samp>’</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>‘<samp class="samp">dct</samp>’</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>‘<samp class="samp">bit</samp>’</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>‘<samp class="samp">zero</samp>’</dt>
<dd><p>0
</p></dd>
<dt>‘<samp class="samp">vsad</samp>’</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>‘<samp class="samp">vsse</samp>’</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>‘<samp class="samp">nsse</samp>’</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>‘<samp class="samp">w53</samp>’</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">w97</samp>’</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">dctmax</samp>’</dt>
<dt>‘<samp class="samp">chroma</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">dia_size <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set diamond type & size for motion estimation.
</p><dl class="table">
<dt>‘<samp class="samp">(1024, INT_MAX)</samp>’</dt>
<dd><p>full motion estimation(slowest)
</p></dd>
<dt>‘<samp class="samp">(768, 1024]</samp>’</dt>
<dd><p>umh motion estimation
</p></dd>
<dt>‘<samp class="samp">(512, 768]</samp>’</dt>
<dd><p>hex motion estimation
</p></dd>
<dt>‘<samp class="samp">(256, 512]</samp>’</dt>
<dd><p>l2s diamond motion estimation
</p></dd>
<dt>‘<samp class="samp">[2,256]</samp>’</dt>
<dd><p>var diamond motion estimation
</p></dd>
<dt>‘<samp class="samp">(-1, 2)</samp>’</dt>
<dd><p>small diamond motion estimation
</p></dd>
<dt>‘<samp class="samp">-1</samp>’</dt>
<dd><p>funny diamond motion estimation
</p></dd>
<dt>‘<samp class="samp">(INT_MIN, -1)</samp>’</dt>
<dd><p>sab diamond motion estimation
</p></dd>
</dl>
</dd>
<dt><samp class="option">last_pred <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set amount of motion predictors from the previous frame.
</p>
</dd>
<dt><samp class="option">precmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set pre motion estimation compare function.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">sad</samp>’</dt>
<dd><p>sum of absolute differences, fast (default)
</p></dd>
<dt>‘<samp class="samp">sse</samp>’</dt>
<dd><p>sum of squared errors
</p></dd>
<dt>‘<samp class="samp">satd</samp>’</dt>
<dd><p>sum of absolute Hadamard transformed differences
</p></dd>
<dt>‘<samp class="samp">dct</samp>’</dt>
<dd><p>sum of absolute DCT transformed differences
</p></dd>
<dt>‘<samp class="samp">psnr</samp>’</dt>
<dd><p>sum of squared quantization errors (avoid, low quality)
</p></dd>
<dt>‘<samp class="samp">bit</samp>’</dt>
<dd><p>number of bits needed for the block
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>rate distortion optimal, slow
</p></dd>
<dt>‘<samp class="samp">zero</samp>’</dt>
<dd><p>0
</p></dd>
<dt>‘<samp class="samp">vsad</samp>’</dt>
<dd><p>sum of absolute vertical differences
</p></dd>
<dt>‘<samp class="samp">vsse</samp>’</dt>
<dd><p>sum of squared vertical differences
</p></dd>
<dt>‘<samp class="samp">nsse</samp>’</dt>
<dd><p>noise preserving sum of squared differences
</p></dd>
<dt>‘<samp class="samp">w53</samp>’</dt>
<dd><p>5/3 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">w97</samp>’</dt>
<dd><p>9/7 wavelet, only used in snow
</p></dd>
<dt>‘<samp class="samp">dctmax</samp>’</dt>
<dt>‘<samp class="samp">chroma</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">pre_dia_size <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set diamond type & size for motion estimation pre-pass.
</p>
</dd>
<dt><samp class="option">subq <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set sub pel motion estimation quality.
</p>
</dd>
<dt><samp class="option">me_range <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set limit motion vectors range (1023 for DivX player).
</p>
</dd>
<dt><samp class="option">global_quality <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dt><samp class="option">slice_flags <var class="var">integer</var></samp></dt>
<dt><samp class="option">mbd <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set macroblock decision algorithm (high quality mode).
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">simple</samp>’</dt>
<dd><p>use mbcmp (default)
</p></dd>
<dt>‘<samp class="samp">bits</samp>’</dt>
<dd><p>use fewest bits
</p></dd>
<dt>‘<samp class="samp">rd</samp>’</dt>
<dd><p>use best rate distortion
</p></dd>
</dl>
</dd>
<dt><samp class="option">rc_init_occupancy <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set number of bits which should be loaded into the rc buffer before
decoding starts.
</p>
</dd>
<dt><samp class="option">flags2 <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">fast</samp>’</dt>
<dd><p>Allow non spec compliant speedup tricks.
</p></dd>
<dt>‘<samp class="samp">noout</samp>’</dt>
<dd><p>Skip bitstream encoding.
</p></dd>
<dt>‘<samp class="samp">ignorecrop</samp>’</dt>
<dd><p>Ignore cropping information from sps.
</p></dd>
<dt>‘<samp class="samp">local_header</samp>’</dt>
<dd><p>Place global headers at every keyframe instead of in extradata.
</p></dd>
<dt>‘<samp class="samp">chunks</samp>’</dt>
<dd><p>Frame data might be split into multiple chunks.
</p></dd>
<dt>‘<samp class="samp">showall</samp>’</dt>
<dd><p>Show all frames before the first keyframe.
</p></dd>
<dt>‘<samp class="samp">export_mvs</samp>’</dt>
<dd><p>Export motion vectors into frame side-data (see <code class="code">AV_FRAME_DATA_MOTION_VECTORS</code>)
for codecs that support it. See also <samp class="file">doc/examples/export_mvs.c</samp>.
</p></dd>
<dt>‘<samp class="samp">skip_manual</samp>’</dt>
<dd><p>Do not skip samples and export skip information as frame side data.
</p></dd>
<dt>‘<samp class="samp">ass_ro_flush_noop</samp>’</dt>
<dd><p>Do not reset ASS ReadOrder field on flush.
</p></dd>
<dt>‘<samp class="samp">icc_profiles</samp>’</dt>
<dd><p>Generate/parse embedded ICC profiles from/to colorimetry tags.
</p></dd>
</dl>
</dd>
<dt><samp class="option">export_side_data <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">mvs</samp>’</dt>
<dd><p>Export motion vectors into frame side-data (see <code class="code">AV_FRAME_DATA_MOTION_VECTORS</code>)
for codecs that support it. See also <samp class="file">doc/examples/export_mvs.c</samp>.
</p></dd>
<dt>‘<samp class="samp">prft</samp>’</dt>
<dd><p>Export encoder Producer Reference Time into packet side-data (see <code class="code">AV_PKT_DATA_PRFT</code>)
for codecs that support it.
</p></dd>
<dt>‘<samp class="samp">venc_params</samp>’</dt>
<dd><p>Export video encoding parameters through frame side data (see <code class="code">AV_FRAME_DATA_VIDEO_ENC_PARAMS</code>)
for codecs that support it. At present, those are H.264 and VP9.
</p></dd>
<dt>‘<samp class="samp">film_grain</samp>’</dt>
<dd><p>Export film grain parameters through frame side data (see <code class="code">AV_FRAME_DATA_FILM_GRAIN_PARAMS</code>).
Supported at present by AV1 decoders.
</p></dd>
</dl>
</dd>
<dt><samp class="option">threads <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Set the number of threads to be used, in case the selected codec
implementation supports multi-threading.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">auto, 0</samp>’</dt>
<dd><p>automatically select the number of threads to set
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">auto</samp>’.
</p>
</dd>
<dt><samp class="option">dc <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set intra_dc_precision.
</p>
</dd>
<dt><samp class="option">nssew <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set nsse weight.
</p>
</dd>
<dt><samp class="option">skip_top <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Set number of macroblock rows at the top which are skipped.
</p>
</dd>
<dt><samp class="option">skip_bottom <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Set number of macroblock rows at the bottom which are skipped.
</p>
</dd>
<dt><samp class="option">profile <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd>
<p>Set encoder codec profile. Default value is ‘<samp class="samp">unknown</samp>’. Encoder specific
profiles are documented in the relevant encoder documentation.
</p>
</dd>
<dt><samp class="option">level <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd>
<p>Set the encoder level. This level depends on the specific codec, and
might correspond to the profile level. It is set by default to
‘<samp class="samp">unknown</samp>’.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">unknown</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">lowres <var class="var">integer</var> (<em class="emph">decoding,audio,video</em>)</samp></dt>
<dd><p>Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions.
</p>
</dd>
<dt><samp class="option">mblmin <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set min macroblock lagrange factor (VBR).
</p>
</dd>
<dt><samp class="option">mblmax <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set max macroblock lagrange factor (VBR).
</p>
</dd>
<dt><samp class="option">skip_loop_filter <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dt><samp class="option">skip_idct <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dt><samp class="option">skip_frame <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd>
<p>Make decoder discard processing depending on the frame type selected
by the option value.
</p>
<p><samp class="option">skip_loop_filter</samp> skips frame loop filtering, <samp class="option">skip_idct</samp>
skips frame IDCT/dequantization, <samp class="option">skip_frame</samp> skips decoding.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Discard no frame.
</p>
</dd>
<dt>‘<samp class="samp">default</samp>’</dt>
<dd><p>Discard useless frames like 0-sized frames.
</p>
</dd>
<dt>‘<samp class="samp">noref</samp>’</dt>
<dd><p>Discard all non-reference frames.
</p>
</dd>
<dt>‘<samp class="samp">bidir</samp>’</dt>
<dd><p>Discard all bidirectional frames.
</p>
</dd>
<dt>‘<samp class="samp">nokey</samp>’</dt>
<dd><p>Discard all frames excepts keyframes.
</p>
</dd>
<dt>‘<samp class="samp">nointra</samp>’</dt>
<dd><p>Discard all frames except I frames.
</p>
</dd>
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>Discard all frames.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">default</samp>’.
</p>
</dd>
<dt><samp class="option">bidir_refine <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Refine the two motion vectors used in bidirectional macroblocks.
</p>
</dd>
<dt><samp class="option">keyint_min <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set minimum interval between IDR-frames.
</p>
</dd>
<dt><samp class="option">refs <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Set reference frames to consider for motion compensation.
</p>
</dd>
<dt><samp class="option">trellis <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dd><p>Set rate-distortion optimal quantization.
</p>
</dd>
<dt><samp class="option">mv0_threshold <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dt><samp class="option">compression_level <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
<dt><samp class="option">bits_per_raw_sample <var class="var">integer</var></samp></dt>
<dt><samp class="option">channel_layout <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
<dd>
<p>Possible values:
</p></dd>
<dt><samp class="option">request_channel_layout <var class="var">integer</var> (<em class="emph">decoding,audio</em>)</samp></dt>
<dd>
<p>Possible values:
</p></dd>
<dt><samp class="option">rc_max_vbv_use <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dt><samp class="option">rc_min_vbv_use <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dt><samp class="option">color_primaries <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p></dd>
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dd><p>BT.470 M
</p></dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>‘<samp class="samp">film</samp>’</dt>
<dd><p>Film
</p></dd>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dd><p>BT.2020
</p></dd>
<dt>‘<samp class="samp">smpte428</samp>’</dt>
<dt>‘<samp class="samp">smpte428_1</samp>’</dt>
<dd><p>SMPTE ST 428-1
</p></dd>
<dt>‘<samp class="samp">smpte431</samp>’</dt>
<dd><p>SMPTE 431-2
</p></dd>
<dt>‘<samp class="samp">smpte432</samp>’</dt>
<dd><p>SMPTE 432-1
</p></dd>
<dt>‘<samp class="samp">jedec-p22</samp>’</dt>
<dd><p>JEDEC P22
</p></dd>
</dl>
</dd>
<dt><samp class="option">color_trc <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p></dd>
<dt>‘<samp class="samp">gamma22</samp>’</dt>
<dd><p>BT.470 M
</p></dd>
<dt>‘<samp class="samp">gamma28</samp>’</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>Linear
</p></dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dt>‘<samp class="samp">log100</samp>’</dt>
<dd><p>Log
</p></dd>
<dt>‘<samp class="samp">log_sqrt</samp>’</dt>
<dt>‘<samp class="samp">log316</samp>’</dt>
<dd><p>Log square root
</p></dd>
<dt>‘<samp class="samp">iec61966_2_4</samp>’</dt>
<dt>‘<samp class="samp">iec61966-2-4</samp>’</dt>
<dd><p>IEC 61966-2-4
</p></dd>
<dt>‘<samp class="samp">bt1361</samp>’</dt>
<dt>‘<samp class="samp">bt1361e</samp>’</dt>
<dd><p>BT.1361
</p></dd>
<dt>‘<samp class="samp">iec61966_2_1</samp>’</dt>
<dt>‘<samp class="samp">iec61966-2-1</samp>’</dt>
<dd><p>IEC 61966-2-1
</p></dd>
<dt>‘<samp class="samp">bt2020_10</samp>’</dt>
<dt>‘<samp class="samp">bt2020_10bit</samp>’</dt>
<dd><p>BT.2020 - 10 bit
</p></dd>
<dt>‘<samp class="samp">bt2020_12</samp>’</dt>
<dt>‘<samp class="samp">bt2020_12bit</samp>’</dt>
<dd><p>BT.2020 - 12 bit
</p></dd>
<dt>‘<samp class="samp">smpte2084</samp>’</dt>
<dd><p>SMPTE ST 2084
</p></dd>
<dt>‘<samp class="samp">smpte428</samp>’</dt>
<dt>‘<samp class="samp">smpte428_1</samp>’</dt>
<dd><p>SMPTE ST 428-1
</p></dd>
<dt>‘<samp class="samp">arib-std-b67</samp>’</dt>
<dd><p>ARIB STD-B67
</p></dd>
</dl>
</dd>
<dt><samp class="option">colorspace <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">rgb</samp>’</dt>
<dd><p>RGB
</p></dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p></dd>
<dt>‘<samp class="samp">fcc</samp>’</dt>
<dd><p>FCC
</p></dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470 BG
</p></dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE 170 M
</p></dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE 240 M
</p></dd>
<dt>‘<samp class="samp">ycocg</samp>’</dt>
<dd><p>YCOCG
</p></dd>
<dt>‘<samp class="samp">bt2020nc</samp>’</dt>
<dt>‘<samp class="samp">bt2020_ncl</samp>’</dt>
<dd><p>BT.2020 NCL
</p></dd>
<dt>‘<samp class="samp">bt2020c</samp>’</dt>
<dt>‘<samp class="samp">bt2020_cl</samp>’</dt>
<dd><p>BT.2020 CL
</p></dd>
<dt>‘<samp class="samp">smpte2085</samp>’</dt>
<dd><p>SMPTE 2085
</p></dd>
<dt>‘<samp class="samp">chroma-derived-nc</samp>’</dt>
<dd><p>Chroma-derived NCL
</p></dd>
<dt>‘<samp class="samp">chroma-derived-c</samp>’</dt>
<dd><p>Chroma-derived CL
</p></dd>
<dt>‘<samp class="samp">ictcp</samp>’</dt>
<dd><p>ICtCp
</p></dd>
</dl>
</dd>
<dt><samp class="option">color_range <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>If used as input parameter, it serves as a hint to the decoder, which
color_range the input has.
Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">tv</samp>’</dt>
<dt>‘<samp class="samp">mpeg</samp>’</dt>
<dt>‘<samp class="samp">limited</samp>’</dt>
<dd><p>MPEG (219*2^(n-8))
</p></dd>
<dt>‘<samp class="samp">pc</samp>’</dt>
<dt>‘<samp class="samp">jpeg</samp>’</dt>
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>JPEG (2^n-1)
</p></dd>
</dl>
</dd>
<dt><samp class="option">chroma_sample_location <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">left</samp>’</dt>
<dt>‘<samp class="samp">center</samp>’</dt>
<dt>‘<samp class="samp">topleft</samp>’</dt>
<dt>‘<samp class="samp">top</samp>’</dt>
<dt>‘<samp class="samp">bottomleft</samp>’</dt>
<dt>‘<samp class="samp">bottom</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">log_level_offset <var class="var">integer</var></samp></dt>
<dd><p>Set the log level offset.
</p>
</dd>
<dt><samp class="option">slices <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
<dd><p>Number of slices, used in parallelized encoding.
</p>
</dd>
<dt><samp class="option">thread_type <var class="var">flags</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Select which multithreading methods to use.
</p>
<p>Use of ‘<samp class="samp">frame</samp>’ will increase decoding delay by one frame per
thread, so clients which cannot provide future frames should not use
it.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">slice</samp>’</dt>
<dd><p>Decode more than one part of a single frame at once.
</p>
<p>Multithreading using slices works only when the video was encoded with
slices.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Decode more than one frame at once.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">slice+frame</samp>’.
</p>
</dd>
<dt><samp class="option">audio_service_type <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
<dd><p>Set audio service type.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">ma</samp>’</dt>
<dd><p>Main Audio Service
</p></dd>
<dt>‘<samp class="samp">ef</samp>’</dt>
<dd><p>Effects
</p></dd>
<dt>‘<samp class="samp">vi</samp>’</dt>
<dd><p>Visually Impaired
</p></dd>
<dt>‘<samp class="samp">hi</samp>’</dt>
<dd><p>Hearing Impaired
</p></dd>
<dt>‘<samp class="samp">di</samp>’</dt>
<dd><p>Dialogue
</p></dd>
<dt>‘<samp class="samp">co</samp>’</dt>
<dd><p>Commentary
</p></dd>
<dt>‘<samp class="samp">em</samp>’</dt>
<dd><p>Emergency
</p></dd>
<dt>‘<samp class="samp">vo</samp>’</dt>
<dd><p>Voice Over
</p></dd>
<dt>‘<samp class="samp">ka</samp>’</dt>
<dd><p>Karaoke
</p></dd>
</dl>
</dd>
<dt><samp class="option">request_sample_fmt <var class="var">sample_fmt</var> (<em class="emph">decoding,audio</em>)</samp></dt>
<dd><p>Set sample format audio decoders should prefer. Default value is
<code class="code">none</code>.
</p>
</dd>
<dt><samp class="option">pkt_timebase <var class="var">rational number</var></samp></dt>
<dt><samp class="option">sub_charenc <var class="var">encoding</var> (<em class="emph">decoding,subtitles</em>)</samp></dt>
<dd><p>Set the input subtitles character encoding.
</p>
</dd>
<dt><samp class="option">field_order <var class="var">field_order</var> (<em class="emph">video</em>)</samp></dt>
<dd><p>Set/override the field order of the video.
Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">progressive</samp>’</dt>
<dd><p>Progressive video
</p></dd>
<dt>‘<samp class="samp">tt</samp>’</dt>
<dd><p>Interlaced video, top field coded and displayed first
</p></dd>
<dt>‘<samp class="samp">bb</samp>’</dt>
<dd><p>Interlaced video, bottom field coded and displayed first
</p></dd>
<dt>‘<samp class="samp">tb</samp>’</dt>
<dd><p>Interlaced video, top coded first, bottom displayed first
</p></dd>
<dt>‘<samp class="samp">bt</samp>’</dt>
<dd><p>Interlaced video, bottom coded first, top displayed first
</p></dd>
</dl>
</dd>
<dt><samp class="option">skip_alpha <var class="var">bool</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Set to 1 to disable processing alpha (transparency). This works like the
‘<samp class="samp">gray</samp>’ flag in the <samp class="option">flags</samp> option which skips chroma information
instead of alpha. Default is 0.
</p>
</dd>
<dt><samp class="option">codec_whitelist <var class="var">list</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>"," separated list of allowed decoders. By default all are allowed.
</p>
</dd>
<dt><samp class="option">dump_separator <var class="var">string</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Separator used to separate the fields printed on the command line about the
Stream parameters.
For example, to separate the fields with newlines and indentation:
</p><div class="example">
<pre class="example-preformatted">ffprobe -dump_separator "
" -i ~/videos/matrixbench_mpeg2.mpg
</pre></div>
</dd>
<dt><samp class="option">max_pixels <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
<dd><p>Maximum number of pixels per image. This value can be used to avoid out of
memory failures due to large images.
</p>
</dd>
<dt><samp class="option">apply_cropping <var class="var">bool</var> (<em class="emph">decoding,video</em>)</samp></dt>
<dd><p>Enable cropping if cropping parameters are multiples of the required
alignment for the left and top parameters. If the alignment is not met the
cropping will be partially applied to maintain alignment.
Default is 1 (enabled).
Note: The required alignment depends on if <code class="code">AV_CODEC_FLAG_UNALIGNED</code> is set and the
CPU. <code class="code">AV_CODEC_FLAG_UNALIGNED</code> cannot be changed from the command line. Also hardware
decoders will not apply left/top Cropping.
</p>
</dd>
</dl>
</div>
<div class="chapter-level-extent" id="Decoders">
<h2 class="chapter">7 Decoders</h2>
<p>Decoders are configured elements in FFmpeg which allow the decoding of
multimedia streams.
</p>
<p>When you configure your FFmpeg build, all the supported native decoders
are enabled by default. Decoders requiring an external library must be enabled
manually via the corresponding <code class="code">--enable-lib</code> option. You can list all
available decoders using the configure option <code class="code">--list-decoders</code>.
</p>
<p>You can disable all the decoders with the configure option
<code class="code">--disable-decoders</code> and selectively enable / disable single decoders
with the options <code class="code">--enable-decoder=<var class="var">DECODER</var></code> /
<code class="code">--disable-decoder=<var class="var">DECODER</var></code>.
</p>
<p>The option <code class="code">-decoders</code> of the ff* tools will display the list of
enabled decoders.
</p>
</div>
<div class="chapter-level-extent" id="Video-Decoders">
<h2 class="chapter">8 Video Decoders</h2>
<p>A description of some of the currently available video decoders
follows.
</p>
<ul class="mini-toc">
<li><a href="#av1" accesskey="1">av1</a></li>
<li><a href="#rawvideo" accesskey="2">rawvideo</a></li>
<li><a href="#libdav1d" accesskey="3">libdav1d</a></li>
<li><a href="#libdavs2" accesskey="4">libdavs2</a></li>
<li><a href="#libuavs3d" accesskey="5">libuavs3d</a></li>
<li><a href="#QSV-Decoders" accesskey="6">QSV Decoders</a></li>
<li><a href="#v210" accesskey="7">v210</a></li>
</ul>
<div class="section-level-extent" id="av1">
<h3 class="section">8.1 av1</h3>
<p>AOMedia Video 1 (AV1) decoder.
</p>
<ul class="mini-toc">
<li><a href="#Options-1" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-1">
<h4 class="subsection">8.1.1 Options</h4>
<dl class="table">
<dt><samp class="option">operating_point</samp></dt>
<dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Default is 0.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="rawvideo">
<h3 class="section">8.2 rawvideo</h3>
<p>Raw video decoder.
</p>
<p>This decoder decodes rawvideo streams.
</p>
<ul class="mini-toc">
<li><a href="#Options-2" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-2">
<h4 class="subsection">8.2.1 Options</h4>
<dl class="table">
<dt><samp class="option">top <var class="var">top_field_first</var></samp></dt>
<dd><p>Specify the assumed field type of the input video.
</p><dl class="table">
<dt><samp class="option">-1</samp></dt>
<dd><p>the video is assumed to be progressive (default)
</p></dd>
<dt><samp class="option">0</samp></dt>
<dd><p>bottom-field-first is assumed
</p></dd>
<dt><samp class="option">1</samp></dt>
<dd><p>top-field-first is assumed
</p></dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libdav1d">
<h3 class="section">8.3 libdav1d</h3>
<p>dav1d AV1 decoder.
</p>
<p>libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec.
Requires the presence of the libdav1d headers and library during configuration.
You need to explicitly configure the build with <code class="code">--enable-libdav1d</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-3" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-3">
<h4 class="subsection">8.3.1 Options</h4>
<p>The following options are supported by the libdav1d wrapper.
</p>
<dl class="table">
<dt><samp class="option">framethreads</samp></dt>
<dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
This option is deprecated for libdav1d >= 1.0 and will be removed in the future. Use the
option <code class="code">max_frame_delay</code> and the global option <code class="code">threads</code> instead.
</p>
</dd>
<dt><samp class="option">tilethreads</samp></dt>
<dd><p>Set amount of tile threads to use during decoding. The default value is 0 (autodetect).
This option is deprecated for libdav1d >= 1.0 and will be removed in the future. Use the
global option <code class="code">threads</code> instead.
</p>
</dd>
<dt><samp class="option">max_frame_delay</samp></dt>
<dd><p>Set max amount of frames the decoder may buffer internally. The default value is 0
(autodetect).
</p>
</dd>
<dt><samp class="option">filmgrain</samp></dt>
<dd><p>Apply film grain to the decoded video if present in the bitstream. Defaults to the
internal default of the library.
This option is deprecated and will be removed in the future. See the global option
<code class="code">export_side_data</code> to export Film Grain parameters instead of applying it.
</p>
</dd>
<dt><samp class="option">oppoint</samp></dt>
<dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the
internal default of the library.
</p>
</dd>
<dt><samp class="option">alllayers</samp></dt>
<dd><p>Output all spatial layers of a scalable AV1 bitstream. The default value is false.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libdavs2">
<h3 class="section">8.4 libdavs2</h3>
<p>AVS2-P2/IEEE1857.4 video decoder wrapper.
</p>
<p>This decoder allows libavcodec to decode AVS2 streams with davs2 library.
</p>
</div>
<div class="section-level-extent" id="libuavs3d">
<h3 class="section">8.5 libuavs3d</h3>
<p>AVS3-P2/IEEE1857.10 video decoder.
</p>
<p>libuavs3d allows libavcodec to decode AVS3 streams.
Requires the presence of the libuavs3d headers and library during configuration.
You need to explicitly configure the build with <code class="code">--enable-libuavs3d</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-4" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-4">
<h4 class="subsection">8.5.1 Options</h4>
<p>The following option is supported by the libuavs3d wrapper.
</p>
<dl class="table">
<dt><samp class="option">frame_threads</samp></dt>
<dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="QSV-Decoders">
<h3 class="section">8.6 QSV Decoders</h3>
<p>The family of Intel QuickSync Video decoders (VC1, MPEG-2, H.264, HEVC,
JPEG/MJPEG, VP8, VP9, AV1).
</p>
<ul class="mini-toc">
<li><a href="#Common-Options" accesskey="1">Common Options</a></li>
<li><a href="#HEVC-Options" accesskey="2">HEVC Options</a></li>
</ul>
<div class="subsection-level-extent" id="Common-Options">
<h4 class="subsection">8.6.1 Common Options</h4>
<p>The following options are supported by all qsv decoders.
</p>
<dl class="table">
<dt><samp class="option"><var class="var">async_depth</var></samp></dt>
<dd><p>Internal parallelization depth, the higher the value the higher the latency.
</p>
</dd>
<dt><samp class="option"><var class="var">gpu_copy</var></samp></dt>
<dd><p>A GPU-accelerated copy between video and system memory
</p><dl class="table">
<dt>‘<samp class="samp">default</samp>’</dt>
<dt>‘<samp class="samp">on</samp>’</dt>
<dt>‘<samp class="samp">off</samp>’</dt>
</dl>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="HEVC-Options">
<h4 class="subsection">8.6.2 HEVC Options</h4>
<p>Extra options for hevc_qsv.
</p>
<dl class="table">
<dt><samp class="option"><var class="var">load_plugin</var></samp></dt>
<dd><p>A user plugin to load in an internal session
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dt>‘<samp class="samp">hevc_sw</samp>’</dt>
<dt>‘<samp class="samp">hevc_hw</samp>’</dt>
</dl>
</dd>
<dt><samp class="option"><var class="var">load_plugins</var></samp></dt>
<dd><p>A :-separate list of hexadecimal plugin UIDs to load in an internal session
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="v210">
<h3 class="section">8.7 v210</h3>
<p>Uncompressed 4:2:2 10-bit decoder.
</p>
<ul class="mini-toc">
<li><a href="#Options-5" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-5">
<h4 class="subsection">8.7.1 Options</h4>
<dl class="table">
<dt><samp class="option">custom_stride</samp></dt>
<dd><p>Set the line size of the v210 data in bytes. The default value is 0
(autodetect). You can use the special -1 value for a strideless v210 as seen in
BOXX files.
</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Audio-Decoders">
<h2 class="chapter">9 Audio Decoders</h2>
<p>A description of some of the currently available audio decoders
follows.
</p>
<ul class="mini-toc">
<li><a href="#ac3" accesskey="1">ac3</a></li>
<li><a href="#flac" accesskey="2">flac</a></li>
<li><a href="#ffwavesynth" accesskey="3">ffwavesynth</a></li>
<li><a href="#libcelt" accesskey="4">libcelt</a></li>
<li><a href="#libgsm" accesskey="5">libgsm</a></li>
<li><a href="#libilbc" accesskey="6">libilbc</a></li>
<li><a href="#libopencore_002damrnb" accesskey="7">libopencore-amrnb</a></li>
<li><a href="#libopencore_002damrwb" accesskey="8">libopencore-amrwb</a></li>
<li><a href="#libopus" accesskey="9">libopus</a></li>
</ul>
<div class="section-level-extent" id="ac3">
<h3 class="section">9.1 ac3</h3>
<p>AC-3 audio decoder.
</p>
<p>This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
the undocumented RealAudio 3 (a.k.a. dnet).
</p>
<ul class="mini-toc">
<li><a href="#AC_002d3-Decoder-Options" accesskey="1">AC-3 Decoder Options</a></li>
</ul>
<div class="subsection-level-extent" id="AC_002d3-Decoder-Options">
<h4 class="subsection">9.1.1 AC-3 Decoder Options</h4>
<dl class="table">
<dt><samp class="option">-drc_scale <var class="var">value</var></samp></dt>
<dd><p>Dynamic Range Scale Factor. The factor to apply to dynamic range values
from the AC-3 stream. This factor is applied exponentially. The default value is 1.
There are 3 notable scale factor ranges:
</p><dl class="table">
<dt><samp class="option">drc_scale == 0</samp></dt>
<dd><p>DRC disabled. Produces full range audio.
</p></dd>
<dt><samp class="option">0 < drc_scale <= 1</samp></dt>
<dd><p>DRC enabled. Applies a fraction of the stream DRC value.
Audio reproduction is between full range and full compression.
</p></dd>
<dt><samp class="option">drc_scale > 1</samp></dt>
<dd><p>DRC enabled. Applies drc_scale asymmetrically.
Loud sounds are fully compressed. Soft sounds are enhanced.
</p></dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="flac">
<h3 class="section">9.2 flac</h3>
<p>FLAC audio decoder.
</p>
<p>This decoder aims to implement the complete FLAC specification from Xiph.
</p>
<ul class="mini-toc">
<li><a href="#FLAC-Decoder-options" accesskey="1">FLAC Decoder options</a></li>
</ul>
<div class="subsection-level-extent" id="FLAC-Decoder-options">
<h4 class="subsection">9.2.1 FLAC Decoder options</h4>
<dl class="table">
<dt><samp class="option">-use_buggy_lpc</samp></dt>
<dd><p>The lavc FLAC encoder used to produce buggy streams with high lpc values
(like the default value). This option makes it possible to decode such streams
correctly by using lavc’s old buggy lpc logic for decoding.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="ffwavesynth">
<h3 class="section">9.3 ffwavesynth</h3>
<p>Internal wave synthesizer.
</p>
<p>This decoder generates wave patterns according to predefined sequences. Its
use is purely internal and the format of the data it accepts is not publicly
documented.
</p>
</div>
<div class="section-level-extent" id="libcelt">
<h3 class="section">9.4 libcelt</h3>
<p>libcelt decoder wrapper.
</p>
<p>libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec.
Requires the presence of the libcelt headers and library during configuration.
You need to explicitly configure the build with <code class="code">--enable-libcelt</code>.
</p>
</div>
<div class="section-level-extent" id="libgsm">
<h3 class="section">9.5 libgsm</h3>
<p>libgsm decoder wrapper.
</p>
<p>libgsm allows libavcodec to decode the GSM full rate audio codec. Requires
the presence of the libgsm headers and library during configuration. You need
to explicitly configure the build with <code class="code">--enable-libgsm</code>.
</p>
<p>This decoder supports both the ordinary GSM and the Microsoft variant.
</p>
</div>
<div class="section-level-extent" id="libilbc">
<h3 class="section">9.6 libilbc</h3>
<p>libilbc decoder wrapper.
</p>
<p>libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC)
audio codec. Requires the presence of the libilbc headers and library during
configuration. You need to explicitly configure the build with
<code class="code">--enable-libilbc</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-6" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-6">
<h4 class="subsection">9.6.1 Options</h4>
<p>The following option is supported by the libilbc wrapper.
</p>
<dl class="table">
<dt><samp class="option">enhance</samp></dt>
<dd>
<p>Enable the enhancement of the decoded audio when set to 1. The default
value is 0 (disabled).
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libopencore_002damrnb">
<h3 class="section">9.7 libopencore-amrnb</h3>
<p>libopencore-amrnb decoder wrapper.
</p>
<p>libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate
Narrowband audio codec. Using it requires the presence of the
libopencore-amrnb headers and library during configuration. You need to
explicitly configure the build with <code class="code">--enable-libopencore-amrnb</code>.
</p>
<p>An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB
without this library.
</p>
</div>
<div class="section-level-extent" id="libopencore_002damrwb">
<h3 class="section">9.8 libopencore-amrwb</h3>
<p>libopencore-amrwb decoder wrapper.
</p>
<p>libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate
Wideband audio codec. Using it requires the presence of the
libopencore-amrwb headers and library during configuration. You need to
explicitly configure the build with <code class="code">--enable-libopencore-amrwb</code>.
</p>
<p>An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB
without this library.
</p>
</div>
<div class="section-level-extent" id="libopus">
<h3 class="section">9.9 libopus</h3>
<p>libopus decoder wrapper.
</p>
<p>libopus allows libavcodec to decode the Opus Interactive Audio Codec.
Requires the presence of the libopus headers and library during
configuration. You need to explicitly configure the build with
<code class="code">--enable-libopus</code>.
</p>
<p>An FFmpeg native decoder for Opus exists, so users can decode Opus
without this library.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Subtitles-Decoders">
<h2 class="chapter">10 Subtitles Decoders</h2>
<ul class="mini-toc">
<li><a href="#libaribb24" accesskey="1">libaribb24</a></li>
<li><a href="#libaribcaption" accesskey="2">libaribcaption</a></li>
<li><a href="#dvbsub" accesskey="3">dvbsub</a></li>
<li><a href="#dvdsub" accesskey="4">dvdsub</a></li>
<li><a href="#libzvbi_002dteletext" accesskey="5">libzvbi-teletext</a></li>
</ul>
<div class="section-level-extent" id="libaribb24">
<h3 class="section">10.1 libaribb24</h3>
<p>ARIB STD-B24 caption decoder.
</p>
<p>Implements profiles A and C of the ARIB STD-B24 standard.
</p>
<ul class="mini-toc">
<li><a href="#libaribb24-Decoder-Options" accesskey="1">libaribb24 Decoder Options</a></li>
</ul>
<div class="subsection-level-extent" id="libaribb24-Decoder-Options">
<h4 class="subsection">10.1.1 libaribb24 Decoder Options</h4>
<dl class="table">
<dt><samp class="option">-aribb24-base-path <var class="var">path</var></samp></dt>
<dd><p>Sets the base path for the libaribb24 library. This is utilized for reading of
configuration files (for custom unicode conversions), and for dumping of
non-text symbols as images under that location.
</p>
<p>Unset by default.
</p>
</dd>
<dt><samp class="option">-aribb24-skip-ruby-text <var class="var">boolean</var></samp></dt>
<dd><p>Tells the decoder wrapper to skip text blocks that contain half-height ruby
text.
</p>
<p>Enabled by default.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libaribcaption">
<h3 class="section">10.2 libaribcaption</h3>
<p>Yet another ARIB STD-B24 caption decoder using external <em class="dfn">libaribcaption</em>
library.
</p>
<p>Implements profiles A and C of the Japanse ARIB STD-B24 standard,
Brazilian ABNT NBR 15606-1, and Philippines version of ISDB-T.
</p>
<p>Requires the presence of the libaribcaption headers and library
(<a class="url" href="https://github.com/xqq/libaribcaption">https://github.com/xqq/libaribcaption</a>) during configuration.
You need to explicitly configure the build with <code class="code">--enable-libaribcaption</code>.
If both <em class="dfn">libaribb24</em> and <em class="dfn">libaribcaption</em> are enabled, <em class="dfn">libaribcaption</em>
decoder precedes.
</p>
<ul class="mini-toc">
<li><a href="#libaribcaption-Decoder-Options" accesskey="1">libaribcaption Decoder Options</a></li>
<li><a href="#libaribcaption-decoder-usage-examples" accesskey="2">libaribcaption decoder usage examples</a></li>
</ul>
<div class="subsection-level-extent" id="libaribcaption-Decoder-Options">
<h4 class="subsection">10.2.1 libaribcaption Decoder Options</h4>
<dl class="table">
<dt><samp class="option">-sub_type <var class="var">subtitle_type</var></samp></dt>
<dd><p>Specifies the format of the decoded subtitles.
</p>
<dl class="table">
<dt>‘<samp class="samp">bitmap</samp>’</dt>
<dd><p>Graphical image.
</p></dd>
<dt>‘<samp class="samp">ass</samp>’</dt>
<dd><p>ASS formatted text.
</p></dd>
<dt>‘<samp class="samp">text</samp>’</dt>
<dd><p>Simple text based output without formatting.
</p></dd>
</dl>
<p>The default is <em class="dfn">ass</em> as same as <em class="dfn">libaribb24</em> decoder.
Some present players (e.g., <em class="dfn">mpv</em>) expect ASS format for ARIB caption.
</p>
</dd>
<dt><samp class="option">-caption_encoding <var class="var">encoding_scheme</var></samp></dt>
<dd><p>Specifies the encoding scheme of input subtitle text.
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Automatically detect text encoding (default).
</p></dd>
<dt>‘<samp class="samp">jis</samp>’</dt>
<dd><p>8bit-char JIS encoding defined in ARIB STD B24.
This encoding used in Japan for ISDB captions.
</p></dd>
<dt>‘<samp class="samp">utf8</samp>’</dt>
<dd><p>UTF-8 encoding defined in ARIB STD B24.
This encoding is used in Philippines for ISDB-T captions.
</p></dd>
<dt>‘<samp class="samp">latin</samp>’</dt>
<dd><p>Latin character encoding defined in ABNT NBR 15606-1.
This encoding is used in South America for SBTVD / ISDB-Tb captions.
</p></dd>
</dl>
</dd>
<dt><samp class="option">-font <var class="var">font_name[,font_name2,...]</var></samp></dt>
<dd><p>Specify comma-separated list of font family names to be used for <em class="dfn">bitmap</em>
or <em class="dfn">ass</em> type subtitle rendering.
Only first font name is used for <em class="dfn">ass</em> type subtitle.
</p>
<p>If not specified, use internaly defined default font family.
</p>
</dd>
<dt><samp class="option">-ass_single_rect <var class="var">boolean</var></samp></dt>
<dd><p>ARIB STD-B24 specifies that some captions may be displayed at different
positions at a time (multi-rectangle subtitle).
Since some players (e.g., old <em class="dfn">mpv</em>) can’t handle multiple ASS rectangles
in a single AVSubtitle, or multiple ASS rectangles of indeterminate duration
with the same start timestamp, this option can change the behavior so that
all the texts are displayed in a single ASS rectangle.
</p>
<p>The default is <var class="var">false</var>.
</p>
<p>If your player cannot handle AVSubtitles with multiple ASS rectangles properly,
set this option to <var class="var">true</var> or define <code class="env">ASS_SINGLE_RECT=1</code> to change
default behavior at compilation.
</p>
</dd>
<dt><samp class="option">-force_outline_text <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether always render outline text for all characters regardless of
the indication by charactor style.
</p>
<p>The default is <var class="var">false</var>.
</p>
</dd>
<dt><samp class="option">-outline_width <var class="var">number</var> (0.0 - 3.0)</samp></dt>
<dd><p>Specify width for outline text, in dots (relative).
</p>
<p>The default is <var class="var">1.5</var>.
</p>
</dd>
<dt><samp class="option">-ignore_background <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to ignore background color rendering.
</p>
<p>The default is <var class="var">false</var>.
</p>
</dd>
<dt><samp class="option">-ignore_ruby <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to ignore rendering for ruby-like (furigana) characters.
</p>
<p>The default is <var class="var">false</var>.
</p>
</dd>
<dt><samp class="option">-replace_drcs <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to render replaced DRCS characters as Unicode characters.
</p>
<p>The default is <var class="var">true</var>.
</p>
</dd>
<dt><samp class="option">-replace_msz_ascii <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to replace MSZ (Middle Size; half width) fullwidth
alphanumerics with halfwidth alphanumerics.
</p>
<p>The default is <var class="var">true</var>.
</p>
</dd>
<dt><samp class="option">-replace_msz_japanese <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to replace some MSZ (Middle Size; half width) fullwidth
japanese special characters with halfwidth ones.
</p>
<p>The default is <var class="var">true</var>.
</p>
</dd>
<dt><samp class="option">-replace_msz_glyph <var class="var">boolean</var></samp></dt>
<dd><p>Specify whether to replace MSZ (Middle Size; half width) characters
with halfwidth glyphs if the fonts supports it.
This option works under FreeType or DirectWrite renderer
with Adobe-Japan1 compliant fonts.
e.g., IBM Plex Sans JP, Morisawa BIZ UDGothic, Morisawa BIZ UDMincho,
Yu Gothic, Yu Mincho, and Meiryo.
</p>
<p>The default is <var class="var">true</var>.
</p>
</dd>
<dt><samp class="option">-canvas_size <var class="var">image_size</var></samp></dt>
<dd><p>Specify the resolution of the canvas to render subtitles to; usually, this
should be frame size of input video.
This only applies when <code class="code">-subtitle_type</code> is set to <var class="var">bitmap</var>.
</p>
<p>The libaribcaption decoder assumes input frame size for bitmap rendering as below:
</p><ol class="enumerate">
<li> PROFILE_A : 1440 x 1080 with SAR (PAR) 4:3
</li><li> PROFILE_C : 320 x 180 with SAR (PAR) 1:1
</li></ol>
<p>If actual frame size of input video does not match above assumption,
the rendered captions may be distorted.
To make the captions undistorted, add <code class="code">-canvas_size</code> option to specify
actual input video size.
</p>
<p>Note that the <code class="code">-canvas_size</code> option is not required for video with
different size but same aspect ratio.
In such cases, the caption will be stretched or shrunk to actual video size
if <code class="code">-canvas_size</code> option is not specified.
If <code class="code">-canvas_size</code> option is specified with different size,
the caption will be stretched or shrunk as specified size with calculated SAR.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="libaribcaption-decoder-usage-examples">
<h4 class="subsection">10.2.2 libaribcaption decoder usage examples</h4>
<p>Display MPEG-TS file with ARIB subtitle by <code class="code">ffplay</code> tool:
</p><div class="example">
<pre class="example-preformatted">ffplay -sub_type bitmap MPEG.TS
</pre></div>
<p>Display MPEG-TS file with input frame size 1920x1080 by <code class="code">ffplay</code> tool:
</p><div class="example">
<pre class="example-preformatted">ffplay -sub_type bitmap -canvas_size 1920x1080 MPEG.TS
</pre></div>
<p>Embed ARIB subtitle in transcoded video:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -sub_type bitmap -i src.m2t -filter_complex "[0:v][0:s]overlay" -vcodec h264 dest.mp4
</pre></div>
</div>
</div>
<div class="section-level-extent" id="dvbsub">
<h3 class="section">10.3 dvbsub</h3>
<ul class="mini-toc">
<li><a href="#Options-7" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-7">
<h4 class="subsection">10.3.1 Options</h4>
<dl class="table">
<dt><samp class="option">compute_clut</samp></dt>
<dd><dl class="table">
<dt><samp class="option">-2</samp></dt>
<dd><p>Compute clut once if no matching CLUT is in the stream.
</p></dd>
<dt><samp class="option">-1</samp></dt>
<dd><p>Compute clut if no matching CLUT is in the stream.
</p></dd>
<dt><samp class="option">0</samp></dt>
<dd><p>Never compute CLUT
</p></dd>
<dt><samp class="option">1</samp></dt>
<dd><p>Always compute CLUT and override the one provided in the stream.
</p></dd>
</dl>
</dd>
<dt><samp class="option">dvb_substream</samp></dt>
<dd><p>Selects the dvb substream, or all substreams if -1 which is default.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="dvdsub">
<h3 class="section">10.4 dvdsub</h3>
<p>This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
also be found in VobSub file pairs and in some Matroska files.
</p>
<ul class="mini-toc">
<li><a href="#Options-8" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-8">
<h4 class="subsection">10.4.1 Options</h4>
<dl class="table">
<dt><samp class="option">palette</samp></dt>
<dd><p>Specify the global palette used by the bitmaps. When stored in VobSub, the
palette is normally specified in the index file; in Matroska, the palette is
stored in the codec extra-data in the same format as in VobSub. In DVDs, the
palette is stored in the IFO file, and therefore not available when reading
from dumped VOB files.
</p>
<p>The format for this option is a string containing 16 24-bits hexadecimal
numbers (without 0x prefix) separated by commas, for example <code class="code">0d00ee,
ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
</p>
</dd>
<dt><samp class="option">ifo_palette</samp></dt>
<dd><p>Specify the IFO file from which the global palette is obtained.
(experimental)
</p>
</dd>
<dt><samp class="option">forced_subs_only</samp></dt>
<dd><p>Only decode subtitle entries marked as forced. Some titles have forced
and non-forced subtitles in the same track. Setting this flag to <code class="code">1</code>
will only keep the forced subtitles. Default value is <code class="code">0</code>.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libzvbi_002dteletext">
<h3 class="section">10.5 libzvbi-teletext</h3>
<p>Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext
subtitles. Requires the presence of the libzvbi headers and library during
configuration. You need to explicitly configure the build with
<code class="code">--enable-libzvbi</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-9" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-9">
<h4 class="subsection">10.5.1 Options</h4>
<dl class="table">
<dt><samp class="option">txt_page</samp></dt>
<dd><p>List of teletext page numbers to decode. Pages that do not match the specified
list are dropped. You may use the special <code class="code">*</code> string to match all pages,
or <code class="code">subtitle</code> to match all subtitle pages.
Default value is *.
</p></dd>
<dt><samp class="option">txt_default_region</samp></dt>
<dd><p>Set default character set used for decoding, a value between 0 and 87 (see
ETS 300 706, Section 15, Table 32). Default value is -1, which does not
override the libzvbi default. This option is needed for some legacy level 1.0
transmissions which cannot signal the proper charset.
</p></dd>
<dt><samp class="option">txt_chop_top</samp></dt>
<dd><p>Discards the top teletext line. Default value is 1.
</p></dd>
<dt><samp class="option">txt_format</samp></dt>
<dd><p>Specifies the format of the decoded subtitles.
</p><dl class="table">
<dt><samp class="option">bitmap</samp></dt>
<dd><p>The default format, you should use this for teletext pages, because certain
graphics and colors cannot be expressed in simple text or even ASS.
</p></dd>
<dt><samp class="option">text</samp></dt>
<dd><p>Simple text based output without formatting.
</p></dd>
<dt><samp class="option">ass</samp></dt>
<dd><p>Formatted ASS output, subtitle pages and teletext pages are returned in
different styles, subtitle pages are stripped down to text, but an effort is
made to keep the text alignment and the formatting.
</p></dd>
</dl>
</dd>
<dt><samp class="option">txt_left</samp></dt>
<dd><p>X offset of generated bitmaps, default is 0.
</p></dd>
<dt><samp class="option">txt_top</samp></dt>
<dd><p>Y offset of generated bitmaps, default is 0.
</p></dd>
<dt><samp class="option">txt_chop_spaces</samp></dt>
<dd><p>Chops leading and trailing spaces and removes empty lines from the generated
text. This option is useful for teletext based subtitles where empty spaces may
be present at the start or at the end of the lines or empty lines may be
present between the subtitle lines because of double-sized teletext characters.
Default value is 1.
</p></dd>
<dt><samp class="option">txt_duration</samp></dt>
<dd><p>Sets the display duration of the decoded teletext pages or subtitles in
milliseconds. Default value is -1 which means infinity or until the next
subtitle event comes.
</p></dd>
<dt><samp class="option">txt_transparent</samp></dt>
<dd><p>Force transparent background of the generated teletext bitmaps. Default value
is 0 which means an opaque background.
</p></dd>
<dt><samp class="option">txt_opacity</samp></dt>
<dd><p>Sets the opacity (0-255) of the teletext background. If
<samp class="option">txt_transparent</samp> is not set, it only affects characters between a start
box and an end box, typically subtitles. Default value is 0 if
<samp class="option">txt_transparent</samp> is set, 255 otherwise.
</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Bitstream-Filters">
<h2 class="chapter">11 Bitstream Filters</h2>
<p>When you configure your FFmpeg build, all the supported bitstream
filters are enabled by default. You can list all available ones using
the configure option <code class="code">--list-bsfs</code>.
</p>
<p>You can disable all the bitstream filters using the configure option
<code class="code">--disable-bsfs</code>, and selectively enable any bitstream filter using
the option <code class="code">--enable-bsf=BSF</code>, or you can disable a particular
bitstream filter using the option <code class="code">--disable-bsf=BSF</code>.
</p>
<p>The option <code class="code">-bsfs</code> of the ff* tools will display the list of
all the supported bitstream filters included in your build.
</p>
<p>The ff* tools have a -bsf option applied per stream, taking a
comma-separated list of filters, whose parameters follow the filter
name after a ’=’.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
</pre></div>
<p>Below is a description of the currently available bitstream filters,
with their parameters, if any.
</p>
<ul class="mini-toc">
<li><a href="#aac_005fadtstoasc" accesskey="1">aac_adtstoasc</a></li>
<li><a href="#av1_005fmetadata" accesskey="2">av1_metadata</a></li>
<li><a href="#chomp" accesskey="3">chomp</a></li>
<li><a href="#dca_005fcore" accesskey="4">dca_core</a></li>
<li><a href="#dump_005fextra" accesskey="5">dump_extra</a></li>
<li><a href="#dv_005ferror_005fmarker" accesskey="6">dv_error_marker</a></li>
<li><a href="#eac3_005fcore" accesskey="7">eac3_core</a></li>
<li><a href="#extract_005fextradata" accesskey="8">extract_extradata</a></li>
<li><a href="#filter_005funits" accesskey="9">filter_units</a></li>
<li><a href="#hapqa_005fextract">hapqa_extract</a></li>
<li><a href="#h264_005fmetadata">h264_metadata</a></li>
<li><a href="#h264_005fmp4toannexb">h264_mp4toannexb</a></li>
<li><a href="#h264_005fredundant_005fpps">h264_redundant_pps</a></li>
<li><a href="#hevc_005fmetadata">hevc_metadata</a></li>
<li><a href="#hevc_005fmp4toannexb">hevc_mp4toannexb</a></li>
<li><a href="#imxdump">imxdump</a></li>
<li><a href="#mjpeg2jpeg">mjpeg2jpeg</a></li>
<li><a href="#mjpegadump">mjpegadump</a></li>
<li><a href="#mov2textsub-1">mov2textsub</a></li>
<li><a href="#mp3decomp">mp3decomp</a></li>
<li><a href="#mpeg2_005fmetadata">mpeg2_metadata</a></li>
<li><a href="#mpeg4_005funpack_005fbframes">mpeg4_unpack_bframes</a></li>
<li><a href="#noise">noise</a></li>
<li><a href="#null">null</a></li>
<li><a href="#pcm_005frechunk">pcm_rechunk</a></li>
<li><a href="#pgs_005fframe_005fmerge">pgs_frame_merge</a></li>
<li><a href="#prores_005fmetadata">prores_metadata</a></li>
<li><a href="#remove_005fextra">remove_extra</a></li>
<li><a href="#setts">setts</a></li>
<li><a href="#text2movsub-1">text2movsub</a></li>
<li><a href="#trace_005fheaders">trace_headers</a></li>
<li><a href="#truehd_005fcore">truehd_core</a></li>
<li><a href="#vp9_005fmetadata">vp9_metadata</a></li>
<li><a href="#vp9_005fsuperframe">vp9_superframe</a></li>
<li><a href="#vp9_005fsuperframe_005fsplit">vp9_superframe_split</a></li>
<li><a href="#vp9_005fraw_005freorder">vp9_raw_reorder</a></li>
</ul>
<div class="section-level-extent" id="aac_005fadtstoasc">
<h3 class="section">11.1 aac_adtstoasc</h3>
<p>Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration
bitstream.
</p>
<p>This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4
ADTS header and removes the ADTS header.
</p>
<p>This filter is required for example when copying an AAC stream from a
raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or
to MOV/MP4 files and related formats such as 3GP or M4A. Please note
that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats.
</p>
</div>
<div class="section-level-extent" id="av1_005fmetadata">
<h3 class="section">11.2 av1_metadata</h3>
<p>Modify metadata embedded in an AV1 stream.
</p>
<dl class="table">
<dt><samp class="option">td</samp></dt>
<dd><p>Insert or remove temporal delimiter OBUs in all temporal units of the
stream.
</p>
<dl class="table">
<dt>‘<samp class="samp">insert</samp>’</dt>
<dd><p>Insert a TD at the beginning of every TU which does not already have one.
</p></dd>
<dt>‘<samp class="samp">remove</samp>’</dt>
<dd><p>Remove the TD from the beginning of every TU which has one.
</p></dd>
</dl>
</dd>
<dt><samp class="option">color_primaries</samp></dt>
<dt><samp class="option">transfer_characteristics</samp></dt>
<dt><samp class="option">matrix_coefficients</samp></dt>
<dd><p>Set the color description fields in the stream (see AV1 section 6.4.2).
</p>
</dd>
<dt><samp class="option">color_range</samp></dt>
<dd><p>Set the color range in the stream (see AV1 section 6.4.2; note that
this cannot be set for streams using BT.709 primaries, sRGB transfer
characteristic and identity (RGB) matrix coefficients).
</p><dl class="table">
<dt>‘<samp class="samp">tv</samp>’</dt>
<dd><p>Limited range.
</p></dd>
<dt>‘<samp class="samp">pc</samp>’</dt>
<dd><p>Full range.
</p></dd>
</dl>
</dd>
<dt><samp class="option">chroma_sample_position</samp></dt>
<dd><p>Set the chroma sample location in the stream (see AV1 section 6.4.2).
This can only be set for 4:2:0 streams.
</p>
<dl class="table">
<dt>‘<samp class="samp">vertical</samp>’</dt>
<dd><p>Left position (matching the default in MPEG-2 and H.264).
</p></dd>
<dt>‘<samp class="samp">colocated</samp>’</dt>
<dd><p>Top-left position.
</p></dd>
</dl>
</dd>
<dt><samp class="option">tick_rate</samp></dt>
<dd><p>Set the tick rate (<em class="emph">time_scale / num_units_in_display_tick</em>) in
the timing info in the sequence header.
</p></dd>
<dt><samp class="option">num_ticks_per_picture</samp></dt>
<dd><p>Set the number of ticks in each picture, to indicate that the stream
has a fixed framerate. Ignored if <samp class="option">tick_rate</samp> is not also set.
</p>
</dd>
<dt><samp class="option">delete_padding</samp></dt>
<dd><p>Deletes Padding OBUs.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="chomp">
<h3 class="section">11.3 chomp</h3>
<p>Remove zero padding at the end of a packet.
</p>
</div>
<div class="section-level-extent" id="dca_005fcore">
<h3 class="section">11.4 dca_core</h3>
<p>Extract the core from a DCA/DTS stream, dropping extensions such as
DTS-HD.
</p>
</div>
<div class="section-level-extent" id="dump_005fextra">
<h3 class="section">11.5 dump_extra</h3>
<p>Add extradata to the beginning of the filtered packets except when
said packets already exactly begin with the extradata that is intended
to be added.
</p>
<dl class="table">
<dt><samp class="option">freq</samp></dt>
<dd><p>The additional argument specifies which packets should be filtered.
It accepts the values:
</p><dl class="table">
<dt>‘<samp class="samp">k</samp>’</dt>
<dt>‘<samp class="samp">keyframe</samp>’</dt>
<dd><p>add extradata to all key packets
</p>
</dd>
<dt>‘<samp class="samp">e</samp>’</dt>
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>add extradata to all packets
</p></dd>
</dl>
</dd>
</dl>
<p>If not specified it is assumed ‘<samp class="samp">k</samp>’.
</p>
<p>For example the following <code class="command">ffmpeg</code> command forces a global
header (thus disabling individual packet headers) in the H.264 packets
generated by the <code class="code">libx264</code> encoder, but corrects them by adding
the header stored in extradata to the key packets:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
</pre></div>
</div>
<div class="section-level-extent" id="dv_005ferror_005fmarker">
<h3 class="section">11.6 dv_error_marker</h3>
<p>Blocks in DV which are marked as damaged are replaced by blocks of the specified color.
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color to replace damaged blocks by
</p></dd>
<dt><samp class="option">sta</samp></dt>
<dd><p>A 16 bit mask which specifies which of the 16 possible error status values are
to be replaced by colored blocks. 0xFFFE is the default which replaces all non 0
error status values.
</p><dl class="table">
<dt>‘<samp class="samp">ok</samp>’</dt>
<dd><p>No error, no concealment
</p></dd>
<dt>‘<samp class="samp">err</samp>’</dt>
<dd><p>Error, No concealment
</p></dd>
<dt>‘<samp class="samp">res</samp>’</dt>
<dd><p>Reserved
</p></dd>
<dt>‘<samp class="samp">notok</samp>’</dt>
<dd><p>Error or concealment
</p></dd>
<dt>‘<samp class="samp">notres</samp>’</dt>
<dd><p>Not reserved
</p></dd>
<dt>‘<samp class="samp">Aa, Ba, Ca, Ab, Bb, Cb, A, B, C, a, b, erri, erru</samp>’</dt>
<dd><p>The specific error status code
</p></dd>
</dl>
<p>see page 44-46 or section 5.5 of
<a class="url" href="http://web.archive.org/web/20060927044735/http://www.smpte.org/smpte_store/standards/pdf/s314m.pdf">http://web.archive.org/web/20060927044735/http://www.smpte.org/smpte_store/standards/pdf/s314m.pdf</a>
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="eac3_005fcore">
<h3 class="section">11.7 eac3_core</h3>
<p>Extract the core from a E-AC-3 stream, dropping extra channels.
</p>
</div>
<div class="section-level-extent" id="extract_005fextradata">
<h3 class="section">11.8 extract_extradata</h3>
<p>Extract the in-band extradata.
</p>
<p>Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers,
or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part
of the bitstream containing the coded frames) or "out of band" (e.g. on the
container level). This latter form is called "extradata" in FFmpeg terminology.
</p>
<p>This bitstream filter detects the in-band headers and makes them available as
extradata.
</p>
<dl class="table">
<dt><samp class="option">remove</samp></dt>
<dd><p>When this option is enabled, the long-term headers are removed from the
bitstream after extraction.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="filter_005funits">
<h3 class="section">11.9 filter_units</h3>
<p>Remove units with types in or not in a given set from the stream.
</p>
<dl class="table">
<dt><samp class="option">pass_types</samp></dt>
<dd><p>List of unit types or ranges of unit types to pass through while removing
all others. This is specified as a ’|’-separated list of unit type values
or ranges of values with ’-’.
</p>
</dd>
<dt><samp class="option">remove_types</samp></dt>
<dd><p>Identical to <samp class="option">pass_types</samp>, except the units in the given set
removed and all others passed through.
</p></dd>
</dl>
<p>Extradata is unchanged by this transformation, but note that if the stream
contains inline parameter sets then the output may be unusable if they are
removed.
</p>
<p>For example, to remove all non-VCL NAL units from an H.264 stream:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
</pre></div>
<p>To remove all AUDs, SEI and filler from an H.265 stream:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
</pre></div>
</div>
<div class="section-level-extent" id="hapqa_005fextract">
<h3 class="section">11.10 hapqa_extract</h3>
<p>Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file.
</p>
<dl class="table">
<dt><samp class="option">texture</samp></dt>
<dd><p>Specifies the texture to keep.
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dt><samp class="option">alpha</samp></dt>
</dl>
</dd>
</dl>
<p>Convert HAPQA to HAPQ
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
</pre></div>
<p>Convert HAPQA to HAPAlphaOnly
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
</pre></div>
</div>
<div class="section-level-extent" id="h264_005fmetadata">
<h3 class="section">11.11 h264_metadata</h3>
<p>Modify metadata embedded in an H.264 stream.
</p>
<dl class="table">
<dt><samp class="option">aud</samp></dt>
<dd><p>Insert or remove AUD NAL units in all access units of the stream.
</p>
<dl class="table">
<dt>‘<samp class="samp">pass</samp>’</dt>
<dt>‘<samp class="samp">insert</samp>’</dt>
<dt>‘<samp class="samp">remove</samp>’</dt>
</dl>
<p>Default is pass.
</p>
</dd>
<dt><samp class="option">sample_aspect_ratio</samp></dt>
<dd><p>Set the sample aspect ratio of the stream in the VUI parameters.
See H.264 table E-1.
</p>
</dd>
<dt><samp class="option">overscan_appropriate_flag</samp></dt>
<dd><p>Set whether the stream is suitable for display using overscan
or not (see H.264 section E.2.1).
</p>
</dd>
<dt><samp class="option">video_format</samp></dt>
<dt><samp class="option">video_full_range_flag</samp></dt>
<dd><p>Set the video format in the stream (see H.264 section E.2.1 and
table E-2).
</p>
</dd>
<dt><samp class="option">colour_primaries</samp></dt>
<dt><samp class="option">transfer_characteristics</samp></dt>
<dt><samp class="option">matrix_coefficients</samp></dt>
<dd><p>Set the colour description in the stream (see H.264 section E.2.1
and tables E-3, E-4 and E-5).
</p>
</dd>
<dt><samp class="option">chroma_sample_loc_type</samp></dt>
<dd><p>Set the chroma sample location in the stream (see H.264 section
E.2.1 and figure E-1).
</p>
</dd>
<dt><samp class="option">tick_rate</samp></dt>
<dd><p>Set the tick rate (time_scale / num_units_in_tick) in the VUI
parameters. This is the smallest time unit representable in the
stream, and in many cases represents the field rate of the stream
(double the frame rate).
</p></dd>
<dt><samp class="option">fixed_frame_rate_flag</samp></dt>
<dd><p>Set whether the stream has fixed framerate - typically this indicates
that the framerate is exactly half the tick rate, but the exact
meaning is dependent on interlacing and the picture structure (see
H.264 section E.2.1 and table E-6).
</p></dd>
<dt><samp class="option">zero_new_constraint_set_flags</samp></dt>
<dd><p>Zero constraint_set4_flag and constraint_set5_flag in the SPS. These
bits were reserved in a previous version of the H.264 spec, and thus
some hardware decoders require these to be zero. The result of zeroing
this is still a valid bitstream.
</p>
</dd>
<dt><samp class="option">crop_left</samp></dt>
<dt><samp class="option">crop_right</samp></dt>
<dt><samp class="option">crop_top</samp></dt>
<dt><samp class="option">crop_bottom</samp></dt>
<dd><p>Set the frame cropping offsets in the SPS. These values will replace
the current ones if the stream is already cropped.
</p>
<p>These fields are set in pixels. Note that some sizes may not be
representable if the chroma is subsampled or the stream is interlaced
(see H.264 section 7.4.2.1.1).
</p>
</dd>
<dt><samp class="option">sei_user_data</samp></dt>
<dd><p>Insert a string as SEI unregistered user data. The argument must
be of the form <em class="emph">UUID+string</em>, where the UUID is as hex digits
possibly separated by hyphens, and the string can be anything.
</p>
<p>For example, ‘<samp class="samp">086f3693-b7b3-4f2c-9653-21492feee5b8+hello</samp>’ will
insert the string “hello” associated with the given UUID.
</p>
</dd>
<dt><samp class="option">delete_filler</samp></dt>
<dd><p>Deletes both filler NAL units and filler SEI messages.
</p>
</dd>
<dt><samp class="option">display_orientation</samp></dt>
<dd><p>Insert, extract or remove Display orientation SEI messages.
See H.264 section D.1.27 and D.2.27 for syntax and semantics.
</p>
<dl class="table">
<dt>‘<samp class="samp">pass</samp>’</dt>
<dt>‘<samp class="samp">insert</samp>’</dt>
<dt>‘<samp class="samp">remove</samp>’</dt>
<dt>‘<samp class="samp">extract</samp>’</dt>
</dl>
<p>Default is pass.
</p>
<p>Insert mode works in conjunction with <code class="code">rotate</code> and <code class="code">flip</code> options.
Any pre-existing Display orientation messages will be removed in insert or remove mode.
Extract mode attaches the display matrix to the packet as side data.
</p>
</dd>
<dt><samp class="option">rotate</samp></dt>
<dd><p>Set rotation in display orientation SEI (anticlockwise angle in degrees).
Range is -360 to +360. Default is NaN.
</p>
</dd>
<dt><samp class="option">flip</samp></dt>
<dd><p>Set flip in display orientation SEI.
</p>
<dl class="table">
<dt>‘<samp class="samp">horizontal</samp>’</dt>
<dt>‘<samp class="samp">vertical</samp>’</dt>
</dl>
<p>Default is unset.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set the level in the SPS. Refer to H.264 section A.3 and tables A-1
to A-5.
</p>
<p>The argument must be the name of a level (for example, ‘<samp class="samp">4.2</samp>’), a
level_idc value (for example, ‘<samp class="samp">42</samp>’), or the special name ‘<samp class="samp">auto</samp>’
indicating that the filter should attempt to guess the level from the
input stream properties.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="h264_005fmp4toannexb">
<h3 class="section">11.12 h264_mp4toannexb</h3>
<p>Convert an H.264 bitstream from length prefixed mode to start code
prefixed mode (as defined in the Annex B of the ITU-T H.264
specification).
</p>
<p>This is required by some streaming formats, typically the MPEG-2
transport stream format (muxer <code class="code">mpegts</code>).
</p>
<p>For example to remux an MP4 file containing an H.264 stream to mpegts
format with <code class="command">ffmpeg</code>, you can use the command:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
</pre></div>
<p>Please note that this filter is auto-inserted for MPEG-TS (muxer
<code class="code">mpegts</code>) and raw H.264 (muxer <code class="code">h264</code>) output formats.
</p>
</div>
<div class="section-level-extent" id="h264_005fredundant_005fpps">
<h3 class="section">11.13 h264_redundant_pps</h3>
<p>This applies a specific fixup to some Blu-ray streams which contain
redundant PPSs modifying irrelevant parameters of the stream which
confuse other transformations which require correct extradata.
</p>
</div>
<div class="section-level-extent" id="hevc_005fmetadata">
<h3 class="section">11.14 hevc_metadata</h3>
<p>Modify metadata embedded in an HEVC stream.
</p>
<dl class="table">
<dt><samp class="option">aud</samp></dt>
<dd><p>Insert or remove AUD NAL units in all access units of the stream.
</p>
<dl class="table">
<dt>‘<samp class="samp">insert</samp>’</dt>
<dt>‘<samp class="samp">remove</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">sample_aspect_ratio</samp></dt>
<dd><p>Set the sample aspect ratio in the stream in the VUI parameters.
</p>
</dd>
<dt><samp class="option">video_format</samp></dt>
<dt><samp class="option">video_full_range_flag</samp></dt>
<dd><p>Set the video format in the stream (see H.265 section E.3.1 and
table E.2).
</p>
</dd>
<dt><samp class="option">colour_primaries</samp></dt>
<dt><samp class="option">transfer_characteristics</samp></dt>
<dt><samp class="option">matrix_coefficients</samp></dt>
<dd><p>Set the colour description in the stream (see H.265 section E.3.1
and tables E.3, E.4 and E.5).
</p>
</dd>
<dt><samp class="option">chroma_sample_loc_type</samp></dt>
<dd><p>Set the chroma sample location in the stream (see H.265 section
E.3.1 and figure E.1).
</p>
</dd>
<dt><samp class="option">tick_rate</samp></dt>
<dd><p>Set the tick rate in the VPS and VUI parameters (time_scale /
num_units_in_tick). Combined with <samp class="option">num_ticks_poc_diff_one</samp>, this can
set a constant framerate in the stream. Note that it is likely to be
overridden by container parameters when the stream is in a container.
</p>
</dd>
<dt><samp class="option">num_ticks_poc_diff_one</samp></dt>
<dd><p>Set poc_proportional_to_timing_flag in VPS and VUI and use this value
to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and
E.3.1). Ignored if <samp class="option">tick_rate</samp> is not also set.
</p>
</dd>
<dt><samp class="option">crop_left</samp></dt>
<dt><samp class="option">crop_right</samp></dt>
<dt><samp class="option">crop_top</samp></dt>
<dt><samp class="option">crop_bottom</samp></dt>
<dd><p>Set the conformance window cropping offsets in the SPS. These values
will replace the current ones if the stream is already cropped.
</p>
<p>These fields are set in pixels. Note that some sizes may not be
representable if the chroma is subsampled (H.265 section 7.4.3.2.1).
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set the level in the VPS and SPS. See H.265 section A.4 and tables
A.6 and A.7.
</p>
<p>The argument must be the name of a level (for example, ‘<samp class="samp">5.1</samp>’), a
<em class="emph">general_level_idc</em> value (for example, ‘<samp class="samp">153</samp>’ for level 5.1),
or the special name ‘<samp class="samp">auto</samp>’ indicating that the filter should
attempt to guess the level from the input stream properties.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="hevc_005fmp4toannexb">
<h3 class="section">11.15 hevc_mp4toannexb</h3>
<p>Convert an HEVC/H.265 bitstream from length prefixed mode to start code
prefixed mode (as defined in the Annex B of the ITU-T H.265
specification).
</p>
<p>This is required by some streaming formats, typically the MPEG-2
transport stream format (muxer <code class="code">mpegts</code>).
</p>
<p>For example to remux an MP4 file containing an HEVC stream to mpegts
format with <code class="command">ffmpeg</code>, you can use the command:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
</pre></div>
<p>Please note that this filter is auto-inserted for MPEG-TS (muxer
<code class="code">mpegts</code>) and raw HEVC/H.265 (muxer <code class="code">h265</code> or
<code class="code">hevc</code>) output formats.
</p>
</div>
<div class="section-level-extent" id="imxdump">
<h3 class="section">11.16 imxdump</h3>
<p>Modifies the bitstream to fit in MOV and to be usable by the Final Cut
Pro decoder. This filter only applies to the mpeg2video codec, and is
likely not needed for Final Cut Pro 7 and newer with the appropriate
<samp class="option">-tag:v</samp>.
</p>
<p>For example, to remux 30 MB/sec NTSC IMX to MOV:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
</pre></div>
</div>
<div class="section-level-extent" id="mjpeg2jpeg">
<h3 class="section">11.17 mjpeg2jpeg</h3>
<p>Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.
</p>
<p>MJPEG is a video codec wherein each video frame is essentially a
JPEG image. The individual frames can be extracted without loss,
e.g. by
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
</pre></div>
<p>Unfortunately, these chunks are incomplete JPEG images, because
they lack the DHT segment required for decoding. Quoting from
<a class="url" href="http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml">http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml</a>:
</p>
<p>Avery Lee, writing in the rec.video.desktop newsgroup in 2001,
commented that "MJPEG, or at least the MJPEG in AVIs having the
MJPG fourcc, is restricted JPEG with a fixed – and *omitted* –
Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2,
and it must use basic Huffman encoding, not arithmetic or
progressive. . . . You can indeed extract the MJPEG frames and
decode them with a regular JPEG decoder, but you have to prepend
the DHT segment to them, or else the decoder won’t have any idea
how to decompress the data. The exact table necessary is given in
the OpenDML spec."
</p>
<p>This bitstream filter patches the header of frames extracted from an MJPEG
stream (carrying the AVI1 header ID and lacking a DHT segment) to
produce fully qualified JPEG images.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
exiftran -i -9 frame*.jpg
ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
</pre></div>
</div>
<div class="section-level-extent" id="mjpegadump">
<h3 class="section">11.18 mjpegadump</h3>
<p>Add an MJPEG A header to the bitstream, to enable decoding by
Quicktime.
</p>
<a class="anchor" id="mov2textsub"></a></div>
<div class="section-level-extent" id="mov2textsub-1">
<h3 class="section">11.19 mov2textsub</h3>
<p>Extract a representable text file from MOV subtitles, stripping the
metadata header from each subtitle packet.
</p>
<p>See also the <a class="ref" href="#text2movsub">text2movsub</a> filter.
</p>
</div>
<div class="section-level-extent" id="mp3decomp">
<h3 class="section">11.20 mp3decomp</h3>
<p>Decompress non-standard compressed MP3 audio headers.
</p>
</div>
<div class="section-level-extent" id="mpeg2_005fmetadata">
<h3 class="section">11.21 mpeg2_metadata</h3>
<p>Modify metadata embedded in an MPEG-2 stream.
</p>
<dl class="table">
<dt><samp class="option">display_aspect_ratio</samp></dt>
<dd><p>Set the display aspect ratio in the stream.
</p>
<p>The following fixed values are supported:
</p><dl class="table">
<dt><samp class="option">4/3</samp></dt>
<dt><samp class="option">16/9</samp></dt>
<dt><samp class="option">221/100</samp></dt>
</dl>
<p>Any other value will result in square pixels being signalled instead
(see H.262 section 6.3.3 and table 6-3).
</p>
</dd>
<dt><samp class="option">frame_rate</samp></dt>
<dd><p>Set the frame rate in the stream. This is constructed from a table
of known values combined with a small multiplier and divisor - if
the supplied value is not exactly representable, the nearest
representable value will be used instead (see H.262 section 6.3.3
and table 6-4).
</p>
</dd>
<dt><samp class="option">video_format</samp></dt>
<dd><p>Set the video format in the stream (see H.262 section 6.3.6 and
table 6-6).
</p>
</dd>
<dt><samp class="option">colour_primaries</samp></dt>
<dt><samp class="option">transfer_characteristics</samp></dt>
<dt><samp class="option">matrix_coefficients</samp></dt>
<dd><p>Set the colour description in the stream (see H.262 section 6.3.6
and tables 6-7, 6-8 and 6-9).
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="mpeg4_005funpack_005fbframes">
<h3 class="section">11.22 mpeg4_unpack_bframes</h3>
<p>Unpack DivX-style packed B-frames.
</p>
<p>DivX-style packed B-frames are not valid MPEG-4 and were only a
workaround for the broken Video for Windows subsystem.
They use more space, can cause minor AV sync issues, require more
CPU power to decode (unless the player has some decoded picture queue
to compensate the 2,0,2,0 frame per packet style) and cause
trouble if copied into a standard container like mp4 or mpeg-ps/ts,
because MPEG-4 decoders may not be able to decode them, since they are
not valid MPEG-4.
</p>
<p>For example to fix an AVI file containing an MPEG-4 stream with
DivX-style packed B-frames using <code class="command">ffmpeg</code>, you can use the command:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
</pre></div>
</div>
<div class="section-level-extent" id="noise">
<h3 class="section">11.23 noise</h3>
<p>Damages the contents of packets or simply drops them without damaging the
container. Can be used for fuzzing or testing error resilience/concealment.
</p>
<p>Parameters:
</p><dl class="table">
<dt><samp class="option">amount</samp></dt>
<dd><p>Accepts an expression whose evaluation per-packet determines how often bytes in that
packet will be modified. A value below 0 will result in a variable frequency.
Default is 0 which results in no modification. However, if neither amount nor drop is specified,
amount will be set to <var class="var">-1</var>. See below for accepted variables.
</p></dd>
<dt><samp class="option">drop</samp></dt>
<dd><p>Accepts an expression evaluated per-packet whose value determines whether that packet is dropped.
Evaluation to a positive value results in the packet being dropped. Evaluation to a negative
value results in a variable chance of it being dropped, roughly inverse in proportion to the magnitude
of the value. Default is 0 which results in no drops. See below for accepted variables.
</p></dd>
<dt><samp class="option">dropamount</samp></dt>
<dd><p>Accepts a non-negative integer, which assigns a variable chance of it being dropped, roughly inverse
in proportion to the value. Default is 0 which results in no drops. This option is kept for backwards
compatibility and is equivalent to setting drop to a negative value with the same magnitude
i.e. <code class="code">dropamount=4</code> is the same as <code class="code">drop=-4</code>. Ignored if drop is also specified.
</p></dd>
</dl>
<p>Both <code class="code">amount</code> and <code class="code">drop</code> accept expressions containing the following variables:
</p>
<dl class="table">
<dt>‘<samp class="samp">n</samp>’</dt>
<dd><p>The index of the packet, starting from zero.
</p></dd>
<dt>‘<samp class="samp">tb</samp>’</dt>
<dd><p>The timebase for packet timestamps.
</p></dd>
<dt>‘<samp class="samp">pts</samp>’</dt>
<dd><p>Packet presentation timestamp.
</p></dd>
<dt>‘<samp class="samp">dts</samp>’</dt>
<dd><p>Packet decoding timestamp.
</p></dd>
<dt>‘<samp class="samp">nopts</samp>’</dt>
<dd><p>Constant representing AV_NOPTS_VALUE.
</p></dd>
<dt>‘<samp class="samp">startpts</samp>’</dt>
<dd><p>First non-AV_NOPTS_VALUE PTS seen in the stream.
</p></dd>
<dt>‘<samp class="samp">startdts</samp>’</dt>
<dd><p>First non-AV_NOPTS_VALUE DTS seen in the stream.
</p></dd>
<dt>‘<samp class="samp">duration</samp>’</dt>
<dt>‘<samp class="samp">d</samp>’</dt>
<dd><p>Packet duration, in timebase units.
</p></dd>
<dt>‘<samp class="samp">pos</samp>’</dt>
<dd><p>Packet position in input; may be -1 when unknown or not set.
</p></dd>
<dt>‘<samp class="samp">size</samp>’</dt>
<dd><p>Packet size, in bytes.
</p></dd>
<dt>‘<samp class="samp">key</samp>’</dt>
<dd><p>Whether packet is marked as a keyframe.
</p></dd>
<dt>‘<samp class="samp">state</samp>’</dt>
<dd><p>A pseudo random integer, primarily derived from the content of packet payload.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-2" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-2">
<h4 class="subsection">11.23.1 Examples</h4>
<p>Apply modification to every byte but don’t drop any packets.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf noise=1 output.mkv
</pre></div>
<p>Drop every video packet not marked as a keyframe after timestamp 30s but do not
modify any of the remaining packets.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v noise=drop='gt(t\,30)*not(key)' output.mkv
</pre></div>
<p>Drop one second of audio every 10 seconds and add some random noise to the rest.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:a noise=amount=-1:drop='between(mod(t\,10)\,9\,10)' output.mkv
</pre></div>
</div>
</div>
<div class="section-level-extent" id="null">
<h3 class="section">11.24 null</h3>
<p>This bitstream filter passes the packets through unchanged.
</p>
</div>
<div class="section-level-extent" id="pcm_005frechunk">
<h3 class="section">11.25 pcm_rechunk</h3>
<p>Repacketize PCM audio to a fixed number of samples per packet or a fixed packet
rate per second. This is similar to the <a data-manual="ffmpeg-filters" href="ffmpeg-filters.html#asetnsamples">(ffmpeg-filters)asetnsamples audio
filter</a> but works on audio packets instead of audio frames.
</p>
<dl class="table">
<dt><samp class="option">nb_out_samples, n</samp></dt>
<dd><p>Set the number of samples per each output audio packet. The number is intended
as the number of samples <em class="emph">per each channel</em>. Default value is 1024.
</p>
</dd>
<dt><samp class="option">pad, p</samp></dt>
<dd><p>If set to 1, the filter will pad the last audio packet with silence, so that it
will contain the same number of samples (or roughly the same number of samples,
see <samp class="option">frame_rate</samp>) as the previous ones. Default value is 1.
</p>
</dd>
<dt><samp class="option">frame_rate, r</samp></dt>
<dd><p>This option makes the filter output a fixed number of packets per second instead
of a fixed number of samples per packet. If the audio sample rate is not
divisible by the frame rate then the number of samples will not be constant but
will vary slightly so that each packet will start as close to the frame
boundary as possible. Using this option has precedence over <samp class="option">nb_out_samples</samp>.
</p></dd>
</dl>
<p>You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio
for NTSC frame rate using the <samp class="option">frame_rate</samp> option.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
</pre></div>
</div>
<div class="section-level-extent" id="pgs_005fframe_005fmerge">
<h3 class="section">11.26 pgs_frame_merge</h3>
<p>Merge a sequence of PGS Subtitle segments ending with an "end of display set"
segment into a single packet.
</p>
<p>This is required by some containers that support PGS subtitles
(muxer <code class="code">matroska</code>).
</p>
</div>
<div class="section-level-extent" id="prores_005fmetadata">
<h3 class="section">11.27 prores_metadata</h3>
<p>Modify color property metadata embedded in prores stream.
</p>
<dl class="table">
<dt><samp class="option">color_primaries</samp></dt>
<dd><p>Set the color primaries.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same color primaries property (default).
</p>
</dd>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT601 625
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>BT601 525
</p>
</dd>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dt>‘<samp class="samp">smpte431</samp>’</dt>
<dd><p>DCI P3
</p>
</dd>
<dt>‘<samp class="samp">smpte432</samp>’</dt>
<dd><p>P3 D65
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">transfer_characteristics</samp></dt>
<dd><p>Set the color transfer.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same transfer characteristics property (default).
</p>
</dd>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT 601, BT 709, BT 2020
</p></dd>
<dt>‘<samp class="samp">smpte2084</samp>’</dt>
<dd><p>SMPTE ST 2084
</p></dd>
<dt>‘<samp class="samp">arib-std-b67</samp>’</dt>
<dd><p>ARIB STD-B67
</p></dd>
</dl>
</dd>
<dt><samp class="option">matrix_coefficients</samp></dt>
<dd><p>Set the matrix coefficient.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same colorspace property (default).
</p>
</dd>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>BT 601
</p>
</dd>
<dt>‘<samp class="samp">bt2020nc</samp>’</dt>
</dl>
</dd>
</dl>
<p>Set Rec709 colorspace for each frame of the file
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
</pre></div>
<p>Set Hybrid Log-Gamma parameters for each frame of the file
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
</pre></div>
</div>
<div class="section-level-extent" id="remove_005fextra">
<h3 class="section">11.28 remove_extra</h3>
<p>Remove extradata from packets.
</p>
<p>It accepts the following parameter:
</p><dl class="table">
<dt><samp class="option">freq</samp></dt>
<dd><p>Set which frame types to remove extradata from.
</p>
<dl class="table">
<dt>‘<samp class="samp">k</samp>’</dt>
<dd><p>Remove extradata from non-keyframes only.
</p>
</dd>
<dt>‘<samp class="samp">keyframe</samp>’</dt>
<dd><p>Remove extradata from keyframes only.
</p>
</dd>
<dt>‘<samp class="samp">e, all</samp>’</dt>
<dd><p>Remove extradata from all frames.
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="setts">
<h3 class="section">11.29 setts</h3>
<p>Set PTS and DTS in packets.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">ts</samp></dt>
<dt><samp class="option">pts</samp></dt>
<dt><samp class="option">dts</samp></dt>
<dd><p>Set expressions for PTS, DTS or both.
</p></dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>Set expression for duration.
</p></dd>
<dt><samp class="option">time_base</samp></dt>
<dd><p>Set output time base.
</p></dd>
</dl>
<p>The expressions are evaluated through the eval API and can contain the following
constants:
</p>
<dl class="table">
<dt><samp class="option">N</samp></dt>
<dd><p>The count of the input packet. Starting from 0.
</p>
</dd>
<dt><samp class="option">TS</samp></dt>
<dd><p>The demux timestamp in input in case of <code class="code">ts</code> or <code class="code">dts</code> option or presentation
timestamp in case of <code class="code">pts</code> option.
</p>
</dd>
<dt><samp class="option">POS</samp></dt>
<dd><p>The original position in the file of the packet, or undefined if undefined
for the current packet
</p>
</dd>
<dt><samp class="option">DTS</samp></dt>
<dd><p>The demux timestamp in input.
</p>
</dd>
<dt><samp class="option">PTS</samp></dt>
<dd><p>The presentation timestamp in input.
</p>
</dd>
<dt><samp class="option">DURATION</samp></dt>
<dd><p>The duration in input.
</p>
</dd>
<dt><samp class="option">STARTDTS</samp></dt>
<dd><p>The DTS of the first packet.
</p>
</dd>
<dt><samp class="option">STARTPTS</samp></dt>
<dd><p>The PTS of the first packet.
</p>
</dd>
<dt><samp class="option">PREV_INDTS</samp></dt>
<dd><p>The previous input DTS.
</p>
</dd>
<dt><samp class="option">PREV_INPTS</samp></dt>
<dd><p>The previous input PTS.
</p>
</dd>
<dt><samp class="option">PREV_INDURATION</samp></dt>
<dd><p>The previous input duration.
</p>
</dd>
<dt><samp class="option">PREV_OUTDTS</samp></dt>
<dd><p>The previous output DTS.
</p>
</dd>
<dt><samp class="option">PREV_OUTPTS</samp></dt>
<dd><p>The previous output PTS.
</p>
</dd>
<dt><samp class="option">PREV_OUTDURATION</samp></dt>
<dd><p>The previous output duration.
</p>
</dd>
<dt><samp class="option">NEXT_DTS</samp></dt>
<dd><p>The next input DTS.
</p>
</dd>
<dt><samp class="option">NEXT_PTS</samp></dt>
<dd><p>The next input PTS.
</p>
</dd>
<dt><samp class="option">NEXT_DURATION</samp></dt>
<dd><p>The next input duration.
</p>
</dd>
<dt><samp class="option">TB</samp></dt>
<dd><p>The timebase of stream packet belongs.
</p>
</dd>
<dt><samp class="option">TB_OUT</samp></dt>
<dd><p>The output timebase.
</p>
</dd>
<dt><samp class="option">SR</samp></dt>
<dd><p>The sample rate of stream packet belongs.
</p>
</dd>
<dt><samp class="option">NOPTS</samp></dt>
<dd><p>The AV_NOPTS_VALUE constant.
</p></dd>
</dl>
<a class="anchor" id="text2movsub"></a></div>
<div class="section-level-extent" id="text2movsub-1">
<h3 class="section">11.30 text2movsub</h3>
<p>Convert text subtitles to MOV subtitles (as used by the <code class="code">mov_text</code>
codec) with metadata headers.
</p>
<p>See also the <a class="ref" href="#mov2textsub">mov2textsub</a> filter.
</p>
</div>
<div class="section-level-extent" id="trace_005fheaders">
<h3 class="section">11.31 trace_headers</h3>
<p>Log trace output containing all syntax elements in the coded stream
headers (everything above the level of individual coded blocks).
This can be useful for debugging low-level stream issues.
</p>
<p>Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending
on the build only a subset of these may be available.
</p>
</div>
<div class="section-level-extent" id="truehd_005fcore">
<h3 class="section">11.32 truehd_core</h3>
<p>Extract the core from a TrueHD stream, dropping ATMOS data.
</p>
</div>
<div class="section-level-extent" id="vp9_005fmetadata">
<h3 class="section">11.33 vp9_metadata</h3>
<p>Modify metadata embedded in a VP9 stream.
</p>
<dl class="table">
<dt><samp class="option">color_space</samp></dt>
<dd><p>Set the color space value in the frame header. Note that any frame
set to RGB will be implicitly set to PC range and that RGB is
incompatible with profiles 0 and 2.
</p><dl class="table">
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt601</samp>’</dt>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">smpte170</samp>’</dt>
<dt>‘<samp class="samp">smpte240</samp>’</dt>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dt>‘<samp class="samp">rgb</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">color_range</samp></dt>
<dd><p>Set the color range value in the frame header. Note that any value
imposed by the color space will take precedence over this value.
</p><dl class="table">
<dt>‘<samp class="samp">tv</samp>’</dt>
<dt>‘<samp class="samp">pc</samp>’</dt>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="vp9_005fsuperframe">
<h3 class="section">11.34 vp9_superframe</h3>
<p>Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This
fixes merging of split/segmented VP9 streams where the alt-ref frame
was split from its visible counterpart.
</p>
</div>
<div class="section-level-extent" id="vp9_005fsuperframe_005fsplit">
<h3 class="section">11.35 vp9_superframe_split</h3>
<p>Split VP9 superframes into single frames.
</p>
</div>
<div class="section-level-extent" id="vp9_005fraw_005freorder">
<h3 class="section">11.36 vp9_raw_reorder</h3>
<p>Given a VP9 stream with correct timestamps but possibly out of order,
insert additional show-existing-frame packets to correct the ordering.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Format-Options">
<h2 class="chapter">12 Format Options</h2>
<p>The libavformat library provides some generic global options, which
can be set on all the muxers and demuxers. In addition each muxer or
demuxer may support so-called private options, which are specific for
that component.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, or by setting the value explicitly in the
<code class="code">AVFormatContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API
for programmatic use.
</p>
<p>The list of supported options follows:
</p>
<dl class="table">
<dt><samp class="option">avioflags <var class="var">flags</var> (<em class="emph">input/output</em>)</samp></dt>
<dd><p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">direct</samp>’</dt>
<dd><p>Reduce buffering.
</p></dd>
</dl>
</dd>
<dt><samp class="option">probesize <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set probing size in bytes, i.e. the size of the data to analyze to get
stream information. A higher value will enable detecting more
information in case it is dispersed into the stream, but will increase
latency. Must be an integer not lesser than 32. It is 5000000 by default.
</p>
</dd>
<dt><samp class="option">max_probe_packets <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set the maximum number of buffered packets when probing a codec.
Default is 2500 packets.
</p>
</dd>
<dt><samp class="option">packetsize <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set packet size.
</p>
</dd>
<dt><samp class="option">fflags <var class="var">flags</var></samp></dt>
<dd><p>Set format flags. Some are implemented for a limited number of formats.
</p>
<p>Possible values for input files:
</p><dl class="table">
<dt>‘<samp class="samp">discardcorrupt</samp>’</dt>
<dd><p>Discard corrupted packets.
</p></dd>
<dt>‘<samp class="samp">fastseek</samp>’</dt>
<dd><p>Enable fast, but inaccurate seeks for some formats.
</p></dd>
<dt>‘<samp class="samp">genpts</samp>’</dt>
<dd><p>Generate missing PTS if DTS is present.
</p></dd>
<dt>‘<samp class="samp">igndts</samp>’</dt>
<dd><p>Ignore DTS if PTS is set. Inert when nofillin is set.
</p></dd>
<dt>‘<samp class="samp">ignidx</samp>’</dt>
<dd><p>Ignore index.
</p></dd>
<dt>‘<samp class="samp">nobuffer</samp>’</dt>
<dd><p>Reduce the latency introduced by buffering during initial input streams analysis.
</p></dd>
<dt>‘<samp class="samp">nofillin</samp>’</dt>
<dd><p>Do not fill in missing values in packet fields that can be exactly calculated.
</p></dd>
<dt>‘<samp class="samp">noparse</samp>’</dt>
<dd><p>Disable AVParsers, this needs <code class="code">+nofillin</code> too.
</p></dd>
<dt>‘<samp class="samp">sortdts</samp>’</dt>
<dd><p>Try to interleave output packets by DTS. At present, available only for AVIs with an index.
</p></dd>
</dl>
<p>Possible values for output files:
</p><dl class="table">
<dt>‘<samp class="samp">autobsf</samp>’</dt>
<dd><p>Automatically apply bitstream filters as required by the output format. Enabled by default.
</p></dd>
<dt>‘<samp class="samp">bitexact</samp>’</dt>
<dd><p>Only write platform-, build- and time-independent data.
This ensures that file and data checksums are reproducible and match between
platforms. Its primary use is for regression testing.
</p></dd>
<dt>‘<samp class="samp">flush_packets</samp>’</dt>
<dd><p>Write out packets immediately.
</p></dd>
<dt>‘<samp class="samp">shortest</samp>’</dt>
<dd><p>Stop muxing at the end of the shortest stream.
It may be needed to increase max_interleave_delta to avoid flushing the longer
streams before EOF.
</p></dd>
</dl>
</dd>
<dt><samp class="option">seek2any <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Allow seeking to non-keyframes on demuxer level when supported if set to 1.
Default is 0.
</p>
</dd>
<dt><samp class="option">analyzeduration <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Specify how many microseconds are analyzed to probe the input. A
higher value will enable detecting more accurate information, but will
increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
</p>
</dd>
<dt><samp class="option">cryptokey <var class="var">hexadecimal string</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set decryption key.
</p>
</dd>
<dt><samp class="option">indexmem <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set max memory used for timestamp index (per stream).
</p>
</dd>
<dt><samp class="option">rtbufsize <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set max memory used for buffering real-time frames.
</p>
</dd>
<dt><samp class="option">fdebug <var class="var">flags</var> (<em class="emph">input/output</em>)</samp></dt>
<dd><p>Print specific debug info.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">ts</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">max_delay <var class="var">integer</var> (<em class="emph">input/output</em>)</samp></dt>
<dd><p>Set maximum muxing or demuxing delay in microseconds.
</p>
</dd>
<dt><samp class="option">fpsprobesize <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set number of frames used to probe fps.
</p>
</dd>
<dt><samp class="option">audio_preload <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set microseconds by which audio packets should be interleaved earlier.
</p>
</dd>
<dt><samp class="option">chunk_duration <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set microseconds for each chunk.
</p>
</dd>
<dt><samp class="option">chunk_size <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set size in bytes for each chunk.
</p>
</dd>
<dt><samp class="option">err_detect, f_err_detect <var class="var">flags</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set error detection flags. <code class="code">f_err_detect</code> is deprecated and
should be used only via the <code class="command">ffmpeg</code> tool.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">crccheck</samp>’</dt>
<dd><p>Verify embedded CRCs.
</p></dd>
<dt>‘<samp class="samp">bitstream</samp>’</dt>
<dd><p>Detect bitstream specification deviations.
</p></dd>
<dt>‘<samp class="samp">buffer</samp>’</dt>
<dd><p>Detect improper bitstream length.
</p></dd>
<dt>‘<samp class="samp">explode</samp>’</dt>
<dd><p>Abort decoding on minor error detection.
</p></dd>
<dt>‘<samp class="samp">careful</samp>’</dt>
<dd><p>Consider things that violate the spec and have not been seen in the
wild as errors.
</p></dd>
<dt>‘<samp class="samp">compliant</samp>’</dt>
<dd><p>Consider all spec non compliancies as errors.
</p></dd>
<dt>‘<samp class="samp">aggressive</samp>’</dt>
<dd><p>Consider things that a sane encoder should not do as an error.
</p></dd>
</dl>
</dd>
<dt><samp class="option">max_interleave_delta <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set maximum buffering duration for interleaving. The duration is
expressed in microseconds, and defaults to 10000000 (10 seconds).
</p>
<p>To ensure all the streams are interleaved correctly, libavformat will
wait until it has at least one packet for each stream before actually
writing any packets to the output file. When some streams are
"sparse" (i.e. there are large gaps between successive packets), this
can result in excessive buffering.
</p>
<p>This field specifies the maximum difference between the timestamps of the
first and the last packet in the muxing queue, above which libavformat
will output a packet regardless of whether it has queued a packet for all
the streams.
</p>
<p>If set to 0, libavformat will continue buffering packets until it has
a packet for each stream, regardless of the maximum timestamp
difference between the buffered packets.
</p>
</dd>
<dt><samp class="option">use_wallclock_as_timestamps <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Use wallclock as timestamps if set to 1. Default is 0.
</p>
</dd>
<dt><samp class="option">avoid_negative_ts <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">make_non_negative</samp>’</dt>
<dd><p>Shift timestamps to make them non-negative.
Also note that this affects only leading negative timestamps, and not
non-monotonic negative timestamps.
</p></dd>
<dt>‘<samp class="samp">make_zero</samp>’</dt>
<dd><p>Shift timestamps so that the first timestamp is 0.
</p></dd>
<dt>‘<samp class="samp">auto (default)</samp>’</dt>
<dd><p>Enables shifting when required by the target format.
</p></dd>
<dt>‘<samp class="samp">disabled</samp>’</dt>
<dd><p>Disables shifting of timestamp.
</p></dd>
</dl>
<p>When shifting is enabled, all output timestamps are shifted by the
same amount. Audio, video, and subtitles desynching and relative
timestamp differences are preserved compared to how they would have
been without shifting.
</p>
</dd>
<dt><samp class="option">skip_initial_bytes <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set number of bytes to skip before reading header and frames if set to 1.
Default is 0.
</p>
</dd>
<dt><samp class="option">correct_ts_overflow <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Correct single timestamp overflows if set to 1. Default is 1.
</p>
</dd>
<dt><samp class="option">flush_packets <var class="var">integer</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Flush the underlying I/O stream after each packet. Default is -1 (auto), which
means that the underlying protocol will decide, 1 enables it, and has the
effect of reducing the latency, 0 disables it and may increase IO throughput in
some cases.
</p>
</dd>
<dt><samp class="option">output_ts_offset <var class="var">offset</var> (<em class="emph">output</em>)</samp></dt>
<dd><p>Set the output time offset.
</p>
<p><var class="var">offset</var> must be a time duration specification,
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>The offset is added by the muxer to the output timestamps.
</p>
<p>Specifying a positive offset means that the corresponding streams are
delayed bt the time duration specified in <var class="var">offset</var>. Default value
is <code class="code">0</code> (meaning that no offset is applied).
</p>
</dd>
<dt><samp class="option">format_whitelist <var class="var">list</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>"," separated list of allowed demuxers. By default all are allowed.
</p>
</dd>
<dt><samp class="option">dump_separator <var class="var">string</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Separator used to separate the fields printed on the command line about the
Stream parameters.
For example, to separate the fields with newlines and indentation:
</p><div class="example">
<pre class="example-preformatted">ffprobe -dump_separator "
" -i ~/videos/matrixbench_mpeg2.mpg
</pre></div>
</dd>
<dt><samp class="option">max_streams <var class="var">integer</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Specifies the maximum number of streams. This can be used to reject files that
would require too many resources due to a large number of streams.
</p>
</dd>
<dt><samp class="option">skip_estimate_duration_from_pts <var class="var">bool</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Skip estimation of input duration when calculated using PTS.
At present, applicable for MPEG-PS and MPEG-TS.
</p>
</dd>
<dt><samp class="option">strict, f_strict <var class="var">integer</var> (<em class="emph">input/output</em>)</samp></dt>
<dd><p>Specify how strictly to follow the standards. <code class="code">f_strict</code> is deprecated and
should be used only via the <code class="command">ffmpeg</code> tool.
</p>
<p>Possible values:
</p><dl class="table">
<dt>‘<samp class="samp">very</samp>’</dt>
<dd><p>strictly conform to an older more strict version of the spec or reference software
</p></dd>
<dt>‘<samp class="samp">strict</samp>’</dt>
<dd><p>strictly conform to all the things in the spec no matter what consequences
</p></dd>
<dt>‘<samp class="samp">normal</samp>’</dt>
<dt>‘<samp class="samp">unofficial</samp>’</dt>
<dd><p>allow unofficial extensions
</p></dd>
<dt>‘<samp class="samp">experimental</samp>’</dt>
<dd><p>allow non standardized experimental things, experimental
(unfinished/work in progress/not well tested) decoders and encoders.
Note: experimental decoders can pose a security risk, do not use this for
decoding untrusted input.
</p></dd>
</dl>
</dd>
</dl>
<a class="anchor" id="Format-stream-specifiers"></a><ul class="mini-toc">
<li><a href="#Format-stream-specifiers-1" accesskey="1">Format stream specifiers</a></li>
</ul>
<div class="section-level-extent" id="Format-stream-specifiers-1">
<h3 class="section">12.1 Format stream specifiers</h3>
<p>Format stream specifiers allow selection of one or more streams that
match specific properties.
</p>
<p>The exact semantics of stream specifiers is defined by the
<code class="code">avformat_match_stream_specifier()</code> function declared in the
<samp class="file">libavformat/avformat.h</samp> header and documented in the
<a data-manual="ffmpeg" href="ffmpeg.html#Stream-specifiers">(ffmpeg)Stream specifiers section in the ffmpeg(1) manual</a>.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Demuxers">
<h2 class="chapter">13 Demuxers</h2>
<p>Demuxers are configured elements in FFmpeg that can read the
multimedia streams from a particular type of file.
</p>
<p>When you configure your FFmpeg build, all the supported demuxers
are enabled by default. You can list all available ones using the
configure option <code class="code">--list-demuxers</code>.
</p>
<p>You can disable all the demuxers using the configure option
<code class="code">--disable-demuxers</code>, and selectively enable a single demuxer with
the option <code class="code">--enable-demuxer=<var class="var">DEMUXER</var></code>, or disable it
with the option <code class="code">--disable-demuxer=<var class="var">DEMUXER</var></code>.
</p>
<p>The option <code class="code">-demuxers</code> of the ff* tools will display the list of
enabled demuxers. Use <code class="code">-formats</code> to view a combined list of
enabled demuxers and muxers.
</p>
<p>The description of some of the currently available demuxers follows.
</p>
<ul class="mini-toc">
<li><a href="#aa" accesskey="1">aa</a></li>
<li><a href="#aac" accesskey="2">aac</a></li>
<li><a href="#apng" accesskey="3">apng</a></li>
<li><a href="#asf" accesskey="4">asf</a></li>
<li><a href="#concat-1" accesskey="5">concat</a></li>
<li><a href="#dash" accesskey="6">dash</a></li>
<li><a href="#ea" accesskey="7">ea</a></li>
<li><a href="#imf" accesskey="8">imf</a></li>
<li><a href="#flv_002c-live_005fflv_002c-kux" accesskey="9">flv, live_flv, kux</a></li>
<li><a href="#gif">gif</a></li>
<li><a href="#hls">hls</a></li>
<li><a href="#image2">image2</a></li>
<li><a href="#libgme">libgme</a></li>
<li><a href="#libmodplug">libmodplug</a></li>
<li><a href="#libopenmpt">libopenmpt</a></li>
<li><a href="#mov_002fmp4_002f3gp">mov/mp4/3gp</a></li>
<li><a href="#mpegts">mpegts</a></li>
<li><a href="#mpjpeg">mpjpeg</a></li>
<li><a href="#rawvideo-1">rawvideo</a></li>
<li><a href="#sbg">sbg</a></li>
<li><a href="#tedcaptions">tedcaptions</a></li>
<li><a href="#vapoursynth">vapoursynth</a></li>
</ul>
<div class="section-level-extent" id="aa">
<h3 class="section">13.1 aa</h3>
<p>Audible Format 2, 3, and 4 demuxer.
</p>
<p>This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.
</p>
</div>
<div class="section-level-extent" id="aac">
<h3 class="section">13.2 aac</h3>
<p>Raw Audio Data Transport Stream AAC demuxer.
</p>
<p>This demuxer is used to demux an ADTS input containing a single AAC stream
alongwith any ID3v1/2 or APE tags in it.
</p>
</div>
<div class="section-level-extent" id="apng">
<h3 class="section">13.3 apng</h3>
<p>Animated Portable Network Graphics demuxer.
</p>
<p>This demuxer is used to demux APNG files.
All headers, but the PNG signature, up to (but not including) the first
fcTL chunk are transmitted as extradata.
Frames are then split as being all the chunks between two fcTL ones, or
between the last fcTL and IEND chunks.
</p>
<dl class="table">
<dt><samp class="option">-ignore_loop <var class="var">bool</var></samp></dt>
<dd><p>Ignore the loop variable in the file if set. Default is enabled.
</p>
</dd>
<dt><samp class="option">-max_fps <var class="var">int</var></samp></dt>
<dd><p>Maximum framerate in frames per second. Default of 0 imposes no limit.
</p>
</dd>
<dt><samp class="option">-default_fps <var class="var">int</var></samp></dt>
<dd><p>Default framerate in frames per second when none is specified in the file
(0 meaning as fast as possible). Default is 15.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="asf">
<h3 class="section">13.4 asf</h3>
<p>Advanced Systems Format demuxer.
</p>
<p>This demuxer is used to demux ASF files and MMS network streams.
</p>
<dl class="table">
<dt><samp class="option">-no_resync_search <var class="var">bool</var></samp></dt>
<dd><p>Do not try to resynchronize by looking for a certain optional start code.
</p></dd>
</dl>
<a class="anchor" id="concat"></a></div>
<div class="section-level-extent" id="concat-1">
<h3 class="section">13.5 concat</h3>
<p>Virtual concatenation script demuxer.
</p>
<p>This demuxer reads a list of files and other directives from a text file and
demuxes them one after the other, as if all their packets had been muxed
together.
</p>
<p>The timestamps in the files are adjusted so that the first file starts at 0
and each next file starts where the previous one finishes. Note that it is
done globally and may cause gaps if all streams do not have exactly the same
length.
</p>
<p>All files must have the same streams (same codecs, same time base, etc.).
</p>
<p>The duration of each file is used to adjust the timestamps of the next file:
if the duration is incorrect (because it was computed using the bit-rate or
because the file is truncated, for example), it can cause artifacts. The
<code class="code">duration</code> directive can be used to override the duration stored in
each file.
</p>
<ul class="mini-toc">
<li><a href="#Syntax-1" accesskey="1">Syntax</a></li>
<li><a href="#Options-10" accesskey="2">Options</a></li>
<li><a href="#Examples-3" accesskey="3">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Syntax-1">
<h4 class="subsection">13.5.1 Syntax</h4>
<p>The script is a text file in extended-ASCII, with one directive per line.
Empty lines, leading spaces and lines starting with ’#’ are ignored. The
following directive is recognized:
</p>
<dl class="table">
<dt><samp class="option"><code class="code">file <var class="var">path</var></code></samp></dt>
<dd><p>Path to a file to read; special characters and spaces must be escaped with
backslash or single quotes.
</p>
<p>All subsequent file-related directives apply to that file.
</p>
</dd>
<dt><samp class="option"><code class="code">ffconcat version 1.0</code></samp></dt>
<dd><p>Identify the script type and version.
</p>
<p>To make FFmpeg recognize the format automatically, this directive must
appear exactly as is (no extra space or byte-order-mark) on the very first
line of the script.
</p>
</dd>
<dt><samp class="option"><code class="code">duration <var class="var">dur</var></code></samp></dt>
<dd><p>Duration of the file. This information can be specified from the file;
specifying it here may be more efficient or help if the information from the
file is not available or accurate.
</p>
<p>If the duration is set for all files, then it is possible to seek in the
whole concatenated video.
</p>
</dd>
<dt><samp class="option"><code class="code">inpoint <var class="var">timestamp</var></code></samp></dt>
<dd><p>In point of the file. When the demuxer opens the file it instantly seeks to the
specified timestamp. Seeking is done so that all streams can be presented
successfully at In point.
</p>
<p>This directive works best with intra frame codecs, because for non-intra frame
ones you will usually get extra packets before the actual In point and the
decoded content will most likely contain frames before In point too.
</p>
<p>For each file, packets before the file In point will have timestamps less than
the calculated start timestamp of the file (negative in case of the first
file), and the duration of the files (if not specified by the <code class="code">duration</code>
directive) will be reduced based on their specified In point.
</p>
<p>Because of potential packets before the specified In point, packet timestamps
may overlap between two concatenated files.
</p>
</dd>
<dt><samp class="option"><code class="code">outpoint <var class="var">timestamp</var></code></samp></dt>
<dd><p>Out point of the file. When the demuxer reaches the specified decoding
timestamp in any of the streams, it handles it as an end of file condition and
skips the current and all the remaining packets from all streams.
</p>
<p>Out point is exclusive, which means that the demuxer will not output packets
with a decoding timestamp greater or equal to Out point.
</p>
<p>This directive works best with intra frame codecs and formats where all streams
are tightly interleaved. For non-intra frame codecs you will usually get
additional packets with presentation timestamp after Out point therefore the
decoded content will most likely contain frames after Out point too. If your
streams are not tightly interleaved you may not get all the packets from all
streams before Out point and you may only will be able to decode the earliest
stream until Out point.
</p>
<p>The duration of the files (if not specified by the <code class="code">duration</code>
directive) will be reduced based on their specified Out point.
</p>
</dd>
<dt><samp class="option"><code class="code">file_packet_metadata <var class="var">key=value</var></code></samp></dt>
<dd><p>Metadata of the packets of the file. The specified metadata will be set for
each file packet. You can specify this directive multiple times to add multiple
metadata entries.
This directive is deprecated, use <code class="code">file_packet_meta</code> instead.
</p>
</dd>
<dt><samp class="option"><code class="code">file_packet_meta <var class="var">key</var> <var class="var">value</var></code></samp></dt>
<dd><p>Metadata of the packets of the file. The specified metadata will be set for
each file packet. You can specify this directive multiple times to add multiple
metadata entries.
</p>
</dd>
<dt><samp class="option"><code class="code">option <var class="var">key</var> <var class="var">value</var></code></samp></dt>
<dd><p>Option to access, open and probe the file.
Can be present multiple times.
</p>
</dd>
<dt><samp class="option"><code class="code">stream</code></samp></dt>
<dd><p>Introduce a stream in the virtual file.
All subsequent stream-related directives apply to the last introduced
stream.
Some streams properties must be set in order to allow identifying the
matching streams in the subfiles.
If no streams are defined in the script, the streams from the first file are
copied.
</p>
</dd>
<dt><samp class="option"><code class="code">exact_stream_id <var class="var">id</var></code></samp></dt>
<dd><p>Set the id of the stream.
If this directive is given, the string with the corresponding id in the
subfiles will be used.
This is especially useful for MPEG-PS (VOB) files, where the order of the
streams is not reliable.
</p>
</dd>
<dt><samp class="option"><code class="code">stream_meta <var class="var">key</var> <var class="var">value</var></code></samp></dt>
<dd><p>Metadata for the stream.
Can be present multiple times.
</p>
</dd>
<dt><samp class="option"><code class="code">stream_codec <var class="var">value</var></code></samp></dt>
<dd><p>Codec for the stream.
</p>
</dd>
<dt><samp class="option"><code class="code">stream_extradata <var class="var">hex_string</var></code></samp></dt>
<dd><p>Extradata for the string, encoded in hexadecimal.
</p>
</dd>
<dt><samp class="option"><code class="code">chapter <var class="var">id</var> <var class="var">start</var> <var class="var">end</var></code></samp></dt>
<dd><p>Add a chapter. <var class="var">id</var> is an unique identifier, possibly small and
consecutive.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Options-10">
<h4 class="subsection">13.5.2 Options</h4>
<p>This demuxer accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">safe</samp></dt>
<dd><p>If set to 1, reject unsafe file paths and directives.
A file path is considered safe if it
does not contain a protocol specification and is relative and all components
only contain characters from the portable character set (letters, digits,
period, underscore and hyphen) and have no period at the beginning of a
component.
</p>
<p>If set to 0, any file name is accepted.
</p>
<p>The default is 1.
</p>
</dd>
<dt><samp class="option">auto_convert</samp></dt>
<dd><p>If set to 1, try to perform automatic conversions on packet data to make the
streams concatenable.
The default is 1.
</p>
<p>Currently, the only conversion is adding the h264_mp4toannexb bitstream
filter to H.264 streams in MP4 format. This is necessary in particular if
there are resolution changes.
</p>
</dd>
<dt><samp class="option">segment_time_metadata</samp></dt>
<dd><p>If set to 1, every packet will contain the <var class="var">lavf.concat.start_time</var> and the
<var class="var">lavf.concat.duration</var> packet metadata values which are the start_time and
the duration of the respective file segments in the concatenated output
expressed in microseconds. The duration metadata is only set if it is known
based on the concat file.
The default is 0.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-3">
<h4 class="subsection">13.5.3 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use absolute filenames and include some comments:
<div class="example">
<pre class="example-preformatted"># my first filename
file /mnt/share/file-1.wav
# my second filename including whitespace
file '/mnt/share/file 2.wav'
# my third filename including whitespace plus single quote
file '/mnt/share/file 3'\''.wav'
</pre></div>
</li><li>Allow for input format auto-probing, use safe filenames and set the duration of
the first file:
<div class="example">
<pre class="example-preformatted">ffconcat version 1.0
file file-1.wav
duration 20.0
file subdir/file-2.wav
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="dash">
<h3 class="section">13.6 dash</h3>
<p>Dynamic Adaptive Streaming over HTTP demuxer.
</p>
<p>This demuxer presents all AVStreams found in the manifest.
By setting the discard flags on AVStreams the caller can decide
which streams to actually receive.
Each stream mirrors the <code class="code">id</code> and <code class="code">bandwidth</code> properties from the
<code class="code"><Representation></code> as metadata keys named "id" and "variant_bitrate" respectively.
</p>
<ul class="mini-toc">
<li><a href="#Options-11" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-11">
<h4 class="subsection">13.6.1 Options</h4>
<p>This demuxer accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">cenc_decryption_key</samp></dt>
<dd><p>16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="ea">
<h3 class="section">13.7 ea</h3>
<p>Electronic Arts Multimedia format demuxer.
</p>
<p>This format is used by various Electronic Arts games.
</p>
<ul class="mini-toc">
<li><a href="#Options-12" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-12">
<h4 class="subsection">13.7.1 Options</h4>
<dl class="table">
<dt><samp class="option">merge_alpha <var class="var">bool</var></samp></dt>
<dd>
<p>Normally the VP6 alpha channel (if exists) is returned as a secondary video
stream, by setting this option you can make the demuxer return a single video
stream which contains the alpha channel in addition to the ordinary video.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="imf">
<h3 class="section">13.8 imf</h3>
<p>Interoperable Master Format demuxer.
</p>
<p>This demuxer presents audio and video streams found in an IMF Composition, as
specified in <a class="url" href="https://doi.org/10.5594/SMPTE.ST2067-2.2020">SMPTE ST 2067-2</a>.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg [-assetmaps <path of ASSETMAP1>,<path of ASSETMAP2>,...] -i <path of CPL> ...
</pre></div>
<p>If <code class="code">-assetmaps</code> is not specified, the demuxer looks for a file called
<samp class="file">ASSETMAP.xml</samp> in the same directory as the CPL.
</p>
</div>
<div class="section-level-extent" id="flv_002c-live_005fflv_002c-kux">
<h3 class="section">13.9 flv, live_flv, kux</h3>
<p>Adobe Flash Video Format demuxer.
</p>
<p>This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities.
KUX is a flv variant used on the Youku platform.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -f flv -i myfile.flv ...
ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
</pre></div>
<dl class="table">
<dt><samp class="option">-flv_metadata <var class="var">bool</var></samp></dt>
<dd><p>Allocate the streams according to the onMetaData array content.
</p>
</dd>
<dt><samp class="option">-flv_ignore_prevtag <var class="var">bool</var></samp></dt>
<dd><p>Ignore the size of previous tag value.
</p>
</dd>
<dt><samp class="option">-flv_full_metadata <var class="var">bool</var></samp></dt>
<dd><p>Output all context of the onMetadata.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="gif">
<h3 class="section">13.10 gif</h3>
<p>Animated GIF demuxer.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">min_delay</samp></dt>
<dd><p>Set the minimum valid delay between frames in hundredths of seconds.
Range is 0 to 6000. Default value is 2.
</p>
</dd>
<dt><samp class="option">max_gif_delay</samp></dt>
<dd><p>Set the maximum valid delay between frames in hundredth of seconds.
Range is 0 to 65535. Default value is 65535 (nearly eleven minutes),
the maximum value allowed by the specification.
</p>
</dd>
<dt><samp class="option">default_delay</samp></dt>
<dd><p>Set the default delay between frames in hundredths of seconds.
Range is 0 to 6000. Default value is 10.
</p>
</dd>
<dt><samp class="option">ignore_loop</samp></dt>
<dd><p>GIF files can contain information to loop a certain number of times (or
infinitely). If <samp class="option">ignore_loop</samp> is set to 1, then the loop setting
from the input will be ignored and looping will not occur. If set to 0,
then looping will occur and will cycle the number of times according to
the GIF. Default value is 1.
</p></dd>
</dl>
<p>For example, with the overlay filter, place an infinitely looping GIF
over another video:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
</pre></div>
<p>Note that in the above example the shortest option for overlay filter is
used to end the output video at the length of the shortest input file,
which in this case is <samp class="file">input.mp4</samp> as the GIF in this example loops
infinitely.
</p>
</div>
<div class="section-level-extent" id="hls">
<h3 class="section">13.11 hls</h3>
<p>HLS demuxer
</p>
<p>Apple HTTP Live Streaming demuxer.
</p>
<p>This demuxer presents all AVStreams from all variant streams.
The id field is set to the bitrate variant index number. By setting
the discard flags on AVStreams (by pressing ’a’ or ’v’ in ffplay),
the caller can decide which variant streams to actually receive.
The total bitrate of the variant that the stream belongs to is
available in a metadata key named "variant_bitrate".
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">live_start_index</samp></dt>
<dd><p>segment index to start live streams at (negative values are from the end).
</p>
</dd>
<dt><samp class="option">prefer_x_start</samp></dt>
<dd><p>prefer to use #EXT-X-START if it’s in playlist instead of live_start_index.
</p>
</dd>
<dt><samp class="option">allowed_extensions</samp></dt>
<dd><p>’,’ separated list of file extensions that hls is allowed to access.
</p>
</dd>
<dt><samp class="option">max_reload</samp></dt>
<dd><p>Maximum number of times a insufficient list is attempted to be reloaded.
Default value is 1000.
</p>
</dd>
<dt><samp class="option">m3u8_hold_counters</samp></dt>
<dd><p>The maximum number of times to load m3u8 when it refreshes without new segments.
Default value is 1000.
</p>
</dd>
<dt><samp class="option">http_persistent</samp></dt>
<dd><p>Use persistent HTTP connections. Applicable only for HTTP streams.
Enabled by default.
</p>
</dd>
<dt><samp class="option">http_multiple</samp></dt>
<dd><p>Use multiple HTTP connections for downloading HTTP segments.
Enabled by default for HTTP/1.1 servers.
</p>
</dd>
<dt><samp class="option">http_seekable</samp></dt>
<dd><p>Use HTTP partial requests for downloading HTTP segments.
0 = disable, 1 = enable, -1 = auto, Default is auto.
</p>
</dd>
<dt><samp class="option">seg_format_options</samp></dt>
<dd><p>Set options for the demuxer of media segments using a list of key=value pairs separated by <code class="code">:</code>.
</p>
</dd>
<dt><samp class="option">seg_max_retry</samp></dt>
<dd><p>Maximum number of times to reload a segment on error, useful when segment skip on network error is not desired.
Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="image2">
<h3 class="section">13.12 image2</h3>
<p>Image file demuxer.
</p>
<p>This demuxer reads from a list of image files specified by a pattern.
The syntax and meaning of the pattern is specified by the
option <var class="var">pattern_type</var>.
</p>
<p>The pattern may contain a suffix which is used to automatically
determine the format of the images contained in the files.
</p>
<p>The size, the pixel format, and the format of each image must be the
same for all the files in the sequence.
</p>
<p>This demuxer accepts the following options:
</p><dl class="table">
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the frame rate for the video stream. It defaults to 25.
</p></dd>
<dt><samp class="option">loop</samp></dt>
<dd><p>If set to 1, loop over the input. Default value is 0.
</p></dd>
<dt><samp class="option">pattern_type</samp></dt>
<dd><p>Select the pattern type used to interpret the provided filename.
</p>
<p><var class="var">pattern_type</var> accepts one of the following values.
</p><dl class="table">
<dt><samp class="option">none</samp></dt>
<dd><p>Disable pattern matching, therefore the video will only contain the specified
image. You should use this option if you do not want to create sequences from
multiple images and your filenames may contain special pattern characters.
</p></dd>
<dt><samp class="option">sequence</samp></dt>
<dd><p>Select a sequence pattern type, used to specify a sequence of files
indexed by sequential numbers.
</p>
<p>A sequence pattern may contain the string "%d" or "%0<var class="var">N</var>d", which
specifies the position of the characters representing a sequential
number in each filename matched by the pattern. If the form
"%d0<var class="var">N</var>d" is used, the string representing the number in each
filename is 0-padded and <var class="var">N</var> is the total number of 0-padded
digits representing the number. The literal character ’%’ can be
specified in the pattern with the string "%%".
</p>
<p>If the sequence pattern contains "%d" or "%0<var class="var">N</var>d", the first filename of
the file list specified by the pattern must contain a number
inclusively contained between <var class="var">start_number</var> and
<var class="var">start_number</var>+<var class="var">start_number_range</var>-1, and all the following
numbers must be sequential.
</p>
<p>For example the pattern "img-%03d.bmp" will match a sequence of
filenames of the form <samp class="file">img-001.bmp</samp>, <samp class="file">img-002.bmp</samp>, ...,
<samp class="file">img-010.bmp</samp>, etc.; the pattern "i%%m%%g-%d.jpg" will match a
sequence of filenames of the form <samp class="file">i%m%g-1.jpg</samp>,
<samp class="file">i%m%g-2.jpg</samp>, ..., <samp class="file">i%m%g-10.jpg</samp>, etc.
</p>
<p>Note that the pattern must not necessarily contain "%d" or
"%0<var class="var">N</var>d", for example to convert a single image file
<samp class="file">img.jpeg</samp> you can employ the command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i img.jpeg img.png
</pre></div>
</dd>
<dt><samp class="option">glob</samp></dt>
<dd><p>Select a glob wildcard pattern type.
</p>
<p>The pattern is interpreted like a <code class="code">glob()</code> pattern. This is only
selectable if libavformat was compiled with globbing support.
</p>
</dd>
<dt><samp class="option">glob_sequence <em class="emph">(deprecated, will be removed)</em></samp></dt>
<dd><p>Select a mixed glob wildcard/sequence pattern.
</p>
<p>If your version of libavformat was compiled with globbing support, and
the provided pattern contains at least one glob meta character among
<code class="code">%*?[]{}</code> that is preceded by an unescaped "%", the pattern is
interpreted like a <code class="code">glob()</code> pattern, otherwise it is interpreted
like a sequence pattern.
</p>
<p>All glob special characters <code class="code">%*?[]{}</code> must be prefixed
with "%". To escape a literal "%" you shall use "%%".
</p>
<p>For example the pattern <code class="code">foo-%*.jpeg</code> will match all the
filenames prefixed by "foo-" and terminating with ".jpeg", and
<code class="code">foo-%?%?%?.jpeg</code> will match all the filenames prefixed with
"foo-", followed by a sequence of three characters, and terminating
with ".jpeg".
</p>
<p>This pattern type is deprecated in favor of <var class="var">glob</var> and
<var class="var">sequence</var>.
</p></dd>
</dl>
<p>Default value is <var class="var">glob_sequence</var>.
</p></dd>
<dt><samp class="option">pixel_format</samp></dt>
<dd><p>Set the pixel format of the images to read. If not specified the pixel
format is guessed from the first image file in the sequence.
</p></dd>
<dt><samp class="option">start_number</samp></dt>
<dd><p>Set the index of the file matched by the image file pattern to start
to read from. Default value is 0.
</p></dd>
<dt><samp class="option">start_number_range</samp></dt>
<dd><p>Set the index interval range to check when looking for the first image
file in the sequence, starting from <var class="var">start_number</var>. Default value
is 5.
</p></dd>
<dt><samp class="option">ts_from_file</samp></dt>
<dd><p>If set to 1, will set frame timestamp to modification time of image file. Note
that monotonity of timestamps is not provided: images go in the same order as
without this option. Default value is 0.
If set to 2, will set frame timestamp to the modification time of the image file in
nanosecond precision.
</p></dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video size of the images to read. If not specified the video
size is guessed from the first image file in the sequence.
</p></dd>
<dt><samp class="option">export_path_metadata</samp></dt>
<dd><p>If set to 1, will add two extra fields to the metadata found in input, making them
also available for other filters (see <var class="var">drawtext</var> filter for examples). Default
value is 0. The extra fields are described below:
</p><dl class="table">
<dt><samp class="option">lavf.image2dec.source_path</samp></dt>
<dd><p>Corresponds to the full path to the input file being read.
</p></dd>
<dt><samp class="option">lavf.image2dec.source_basename</samp></dt>
<dd><p>Corresponds to the name of the file being read.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-4" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-4">
<h4 class="subsection">13.12.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use <code class="command">ffmpeg</code> for creating a video from the images in the file
sequence <samp class="file">img-001.jpeg</samp>, <samp class="file">img-002.jpeg</samp>, ..., assuming an
input frame rate of 10 frames per second:
<div class="example">
<pre class="example-preformatted">ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
</pre></div>
</li><li>As above, but start by reading from a file with index 100 in the sequence:
<div class="example">
<pre class="example-preformatted">ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
</pre></div>
</li><li>Read images matching the "*.png" glob pattern , that is all the files
terminating with the ".png" suffix:
<div class="example">
<pre class="example-preformatted">ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="libgme">
<h3 class="section">13.13 libgme</h3>
<p>The Game Music Emu library is a collection of video game music file emulators.
</p>
<p>See <a class="url" href="https://bitbucket.org/mpyne/game-music-emu/overview">https://bitbucket.org/mpyne/game-music-emu/overview</a> for more information.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">track_index</samp></dt>
<dd><p>Set the index of which track to demux. The demuxer can only export one track.
Track indexes start at 0. Default is to pick the first track. Number of tracks
is exported as <var class="var">tracks</var> metadata entry.
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100.
</p>
</dd>
<dt><samp class="option">max_size <em class="emph">(bytes)</em></samp></dt>
<dd><p>The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
which in turn, acts as a ceiling for the size of files that can be read.
Default is 50 MiB.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="libmodplug">
<h3 class="section">13.14 libmodplug</h3>
<p>ModPlug based module demuxer
</p>
<p>See <a class="url" href="https://github.com/Konstanty/libmodplug">https://github.com/Konstanty/libmodplug</a>
</p>
<p>It will export one 2-channel 16-bit 44.1 kHz audio stream.
Optionally, a <code class="code">pal8</code> 16-color video stream can be exported with or without printed metadata.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">noise_reduction</samp></dt>
<dd><p>Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0.
</p>
</dd>
<dt><samp class="option">reverb_depth</samp></dt>
<dd><p>Set amount of reverb. Range 0-100. Default is 0.
</p>
</dd>
<dt><samp class="option">reverb_delay</samp></dt>
<dd><p>Set delay in ms, clamped to 40-250 ms. Default is 0.
</p>
</dd>
<dt><samp class="option">bass_amount</samp></dt>
<dd><p>Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0.
</p>
</dd>
<dt><samp class="option">bass_range</samp></dt>
<dd><p>Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0.
</p>
</dd>
<dt><samp class="option">surround_depth</samp></dt>
<dd><p>Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0.
</p>
</dd>
<dt><samp class="option">surround_delay</samp></dt>
<dd><p>Set surround delay in ms, clamped to 5-40 ms. Default is 0.
</p>
</dd>
<dt><samp class="option">max_size</samp></dt>
<dd><p>The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size,
which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB.
0 removes buffer size limit (not recommended). Default is 5 MiB.
</p>
</dd>
<dt><samp class="option">video_stream_expr</samp></dt>
<dd><p>String which is evaluated using the eval API to assign colors to the generated video stream.
Variables which can be used are <code class="code">x</code>, <code class="code">y</code>, <code class="code">w</code>, <code class="code">h</code>, <code class="code">t</code>, <code class="code">speed</code>,
<code class="code">tempo</code>, <code class="code">order</code>, <code class="code">pattern</code> and <code class="code">row</code>.
</p>
</dd>
<dt><samp class="option">video_stream</samp></dt>
<dd><p>Generate video stream. Can be 1 (on) or 0 (off). Default is 0.
</p>
</dd>
<dt><samp class="option">video_stream_w</samp></dt>
<dd><p>Set video frame width in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30.
</p>
</dd>
<dt><samp class="option">video_stream_h</samp></dt>
<dd><p>Set video frame height in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30.
</p>
</dd>
<dt><samp class="option">video_stream_ptxt</samp></dt>
<dd><p>Print metadata on video stream. Includes <code class="code">speed</code>, <code class="code">tempo</code>, <code class="code">order</code>, <code class="code">pattern</code>,
<code class="code">row</code> and <code class="code">ts</code> (time in ms). Can be 1 (on) or 0 (off). Default is 1.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="libopenmpt">
<h3 class="section">13.15 libopenmpt</h3>
<p>libopenmpt based module demuxer
</p>
<p>See <a class="url" href="https://lib.openmpt.org/libopenmpt/">https://lib.openmpt.org/libopenmpt/</a> for more information.
</p>
<p>Some files have multiple subsongs (tracks) this can be set with the <samp class="option">subsong</samp>
option.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">subsong</samp></dt>
<dd><p>Set the subsong index. This can be either ’all’, ’auto’, or the index of the
subsong. Subsong indexes start at 0. The default is ’auto’.
</p>
<p>The default value is to let libopenmpt choose.
</p>
</dd>
<dt><samp class="option">layout</samp></dt>
<dd><p>Set the channel layout. Valid values are 1, 2, and 4 channel layouts.
The default value is STEREO.
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate for libopenmpt to output.
Range is from 1000 to INT_MAX. The value default is 48000.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="mov_002fmp4_002f3gp">
<h3 class="section">13.16 mov/mp4/3gp</h3>
<p>Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12).
</p>
<p>Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v
</p>
<ul class="mini-toc">
<li><a href="#Options-13" accesskey="1">Options</a></li>
<li><a href="#Audible-AAX" accesskey="2">Audible AAX</a></li>
</ul>
<div class="subsection-level-extent" id="Options-13">
<h4 class="subsection">13.16.1 Options</h4>
<p>This demuxer accepts the following options:
</p><dl class="table">
<dt><samp class="option">enable_drefs</samp></dt>
<dd><p>Enable loading of external tracks, disabled by default.
Enabling this can theoretically leak information in some use cases.
</p>
</dd>
<dt><samp class="option">use_absolute_path</samp></dt>
<dd><p>Allows loading of external tracks via absolute paths, disabled by default.
Enabling this poses a security risk. It should only be enabled if the source
is known to be non-malicious.
</p>
</dd>
<dt><samp class="option">seek_streams_individually</samp></dt>
<dd><p>When seeking, identify the closest point in each stream individually and demux packets in
that stream from identified point. This can lead to a different sequence of packets compared
to demuxing linearly from the beginning. Default is true.
</p>
</dd>
<dt><samp class="option">ignore_editlist</samp></dt>
<dd><p>Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the
timeline described by the edit list. Default is false.
</p>
</dd>
<dt><samp class="option">advanced_editlist</samp></dt>
<dd><p>Modify the stream index to reflect the timeline described by the edit list. <code class="code">ignore_editlist</code>
must be set to false for this option to be effective.
If both <code class="code">ignore_editlist</code> and this option are set to false, then only the
start of the stream index is modified to reflect initial dwell time or starting timestamp
described by the edit list. Default is true.
</p>
</dd>
<dt><samp class="option">ignore_chapters</samp></dt>
<dd><p>Don’t parse chapters. This includes GoPro ’HiLight’ tags/moments. Note that chapters are
only parsed when input is seekable. Default is false.
</p>
</dd>
<dt><samp class="option">use_mfra_for</samp></dt>
<dd><p>For seekable fragmented input, set fragment’s starting timestamp from media fragment random access box, if present.
</p>
<p>Following options are available:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Auto-detect whether to set mfra timestamps as PTS or DTS <em class="emph">(default)</em>
</p>
</dd>
<dt>‘<samp class="samp">dts</samp>’</dt>
<dd><p>Set mfra timestamps as DTS
</p>
</dd>
<dt>‘<samp class="samp">pts</samp>’</dt>
<dd><p>Set mfra timestamps as PTS
</p>
</dd>
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>Don’t use mfra box to set timestamps
</p></dd>
</dl>
</dd>
<dt><samp class="option">use_tfdt</samp></dt>
<dd><p>For fragmented input, set fragment’s starting timestamp to <code class="code">baseMediaDecodeTime</code> from the <code class="code">tfdt</code> box.
Default is enabled, which will prefer to use the <code class="code">tfdt</code> box to set DTS. Disable to use the <code class="code">earliest_presentation_time</code> from the <code class="code">sidx</code> box.
In either case, the timestamp from the <code class="code">mfra</code> box will be used if it’s available and <code class="code">use_mfra_for</code> is
set to pts or dts.
</p>
</dd>
<dt><samp class="option">export_all</samp></dt>
<dd><p>Export unrecognized boxes within the <var class="var">udta</var> box as metadata entries. The first four
characters of the box type are set as the key. Default is false.
</p>
</dd>
<dt><samp class="option">export_xmp</samp></dt>
<dd><p>Export entire contents of <var class="var">XMP_</var> box and <var class="var">uuid</var> box as a string with key <code class="code">xmp</code>. Note that
if <code class="code">export_all</code> is set and this option isn’t, the contents of <var class="var">XMP_</var> box are still exported
but with key <code class="code">XMP_</code>. Default is false.
</p>
</dd>
<dt><samp class="option">activation_bytes</samp></dt>
<dd><p>4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below.
</p>
</dd>
<dt><samp class="option">audible_fixed_key</samp></dt>
<dd><p>Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to
specify.
</p>
</dd>
<dt><samp class="option">decryption_key</samp></dt>
<dd><p>16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7).
</p>
</dd>
<dt><samp class="option">max_stts_delta</samp></dt>
<dd><p>Very high sample deltas written in a trak’s stts box may occasionally be intended but usually they are written in
error or used to store a negative value for dts correction when treated as signed 32-bit integers. This option lets
the user set an upper limit, beyond which the delta is clamped to 1. Values greater than the limit if negative when
cast to int32 are used to adjust onward dts.
</p>
<p>Unit is the track time scale. Range is 0 to UINT_MAX. Default is <code class="code">UINT_MAX - 48000*10</code> which allows upto
a 10 second dts correction for 48 kHz audio streams while accommodating 99.9% of <code class="code">uint32</code> range.
</p>
</dd>
<dt><samp class="option">interleaved_read</samp></dt>
<dd><p>Interleave packets from multiple tracks at demuxer level. For badly interleaved files, this prevents playback issues
caused by large gaps between packets in different tracks, as MOV/MP4 do not have packet placement requirements.
However, this can cause excessive seeking on very badly interleaved files, due to seeking between tracks, so disabling
it may prevent I/O issues, at the expense of playback.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Audible-AAX">
<h4 class="subsection">13.16.2 Audible AAX</h4>
<p>Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
</pre></div>
</div>
</div>
<div class="section-level-extent" id="mpegts">
<h3 class="section">13.17 mpegts</h3>
<p>MPEG-2 transport stream demuxer.
</p>
<p>This demuxer accepts the following options:
</p><dl class="table">
<dt><samp class="option">resync_size</samp></dt>
<dd><p>Set size limit for looking up a new synchronization. Default value is
65536.
</p>
</dd>
<dt><samp class="option">skip_unknown_pmt</samp></dt>
<dd><p>Skip PMTs for programs not defined in the PAT. Default value is 0.
</p>
</dd>
<dt><samp class="option">fix_teletext_pts</samp></dt>
<dd><p>Override teletext packet PTS and DTS values with the timestamps calculated
from the PCR of the first program which the teletext stream is part of and is
not discarded. Default value is 1, set this option to 0 if you want your
teletext packet PTS and DTS values untouched.
</p>
</dd>
<dt><samp class="option">ts_packetsize</samp></dt>
<dd><p>Output option carrying the raw packet size in bytes.
Show the detected raw packet size, cannot be set by the user.
</p>
</dd>
<dt><samp class="option">scan_all_pmts</samp></dt>
<dd><p>Scan and combine all PMTs. The value is an integer with value from -1
to 1 (-1 means automatic setting, 1 means enabled, 0 means
disabled). Default value is -1.
</p>
</dd>
<dt><samp class="option">merge_pmt_versions</samp></dt>
<dd><p>Re-use existing streams when a PMT’s version is updated and elementary
streams move to different PIDs. Default value is 0.
</p>
</dd>
<dt><samp class="option">max_packet_size</samp></dt>
<dd><p>Set maximum size, in bytes, of packet emitted by the demuxer. Payloads above this size
are split across multiple packets. Range is 1 to INT_MAX/2. Default is 204800 bytes.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="mpjpeg">
<h3 class="section">13.18 mpjpeg</h3>
<p>MJPEG encapsulated in multi-part MIME demuxer.
</p>
<p>This demuxer allows reading of MJPEG, where each frame is represented as a part of
multipart/x-mixed-replace stream.
</p><dl class="table">
<dt><samp class="option">strict_mime_boundary</samp></dt>
<dd><p>Default implementation applies a relaxed standard to multi-part MIME boundary detection,
to prevent regression with numerous existing endpoints not generating a proper MIME
MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check
of the boundary value.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="rawvideo-1">
<h3 class="section">13.19 rawvideo</h3>
<p>Raw video demuxer.
</p>
<p>This demuxer allows one to read raw video data. Since there is no header
specifying the assumed video parameters, the user must specify them
in order to be able to decode the data correctly.
</p>
<p>This demuxer accepts the following options:
</p><dl class="table">
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set input video frame rate. Default value is 25.
</p>
</dd>
<dt><samp class="option">pixel_format</samp></dt>
<dd><p>Set the input video pixel format. Default value is <code class="code">yuv420p</code>.
</p>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the input video size. This value must be specified explicitly.
</p></dd>
</dl>
<p>For example to read a rawvideo file <samp class="file">input.raw</samp> with
<code class="command">ffplay</code>, assuming a pixel format of <code class="code">rgb24</code>, a video
size of <code class="code">320x240</code>, and a frame rate of 10 images per second, use
the command:
</p><div class="example">
<pre class="example-preformatted">ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
</pre></div>
</div>
<div class="section-level-extent" id="sbg">
<h3 class="section">13.20 sbg</h3>
<p>SBaGen script demuxer.
</p>
<p>This demuxer reads the script language used by SBaGen
<a class="url" href="http://uazu.net/sbagen/">http://uazu.net/sbagen/</a> to generate binaural beats sessions. A SBG
script looks like that:
</p><div class="example">
<pre class="example-preformatted">-SE
a: 300-2.5/3 440+4.5/0
b: 300-2.5/0 440+4.5/3
off: -
NOW == a
+0:07:00 == b
+0:14:00 == a
+0:21:00 == b
+0:30:00 off
</pre></div>
<p>A SBG script can mix absolute and relative timestamps. If the script uses
either only absolute timestamps (including the script start time) or only
relative ones, then its layout is fixed, and the conversion is
straightforward. On the other hand, if the script mixes both kind of
timestamps, then the <var class="var">NOW</var> reference for relative timestamps will be
taken from the current time of day at the time the script is read, and the
script layout will be frozen according to that reference. That means that if
the script is directly played, the actual times will match the absolute
timestamps up to the sound controller’s clock accuracy, but if the user
somehow pauses the playback or seeks, all times will be shifted accordingly.
</p>
</div>
<div class="section-level-extent" id="tedcaptions">
<h3 class="section">13.21 tedcaptions</h3>
<p>JSON captions used for <a class="url" href="http://www.ted.com/">TED Talks</a>.
</p>
<p>TED does not provide links to the captions, but they can be guessed from the
page. The file <samp class="file">tools/bookmarklets.html</samp> from the FFmpeg source tree
contains a bookmarklet to expose them.
</p>
<p>This demuxer accepts the following option:
</p><dl class="table">
<dt><samp class="option">start_time</samp></dt>
<dd><p>Set the start time of the TED talk, in milliseconds. The default is 15000
(15s). It is used to sync the captions with the downloadable videos, because
they include a 15s intro.
</p></dd>
</dl>
<p>Example: convert the captions to a format most players understand:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
</pre></div>
</div>
<div class="section-level-extent" id="vapoursynth">
<h3 class="section">13.22 vapoursynth</h3>
<p>Vapoursynth wrapper.
</p>
<p>Due to security concerns, Vapoursynth scripts will not
be autodetected so the input format has to be forced. For ff* CLI tools,
add <code class="code">-f vapoursynth</code> before the input <code class="code">-i yourscript.vpy</code>.
</p>
<p>This demuxer accepts the following option:
</p><dl class="table">
<dt><samp class="option">max_script_size</samp></dt>
<dd><p>The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size,
which in turn, acts as a ceiling for the size of scripts that can be read.
Default is 1 MiB.
</p></dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="Metadata">
<h2 class="chapter">14 Metadata</h2>
<p>FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded
INI-like text file and then load it back using the metadata muxer/demuxer.
</p>
<p>The file format is as follows:
</p><ol class="enumerate">
<li> A file consists of a header and a number of metadata tags divided into sections,
each on its own line.
</li><li> The header is a ‘<samp class="samp">;FFMETADATA</samp>’ string, followed by a version number (now 1).
</li><li> Metadata tags are of the form ‘<samp class="samp">key=value</samp>’
</li><li> Immediately after header follows global metadata
</li><li> After global metadata there may be sections with per-stream/per-chapter
metadata.
</li><li> A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in
brackets (‘<samp class="samp">[</samp>’, ‘<samp class="samp">]</samp>’) and ends with next section or end of file.
</li><li> At the beginning of a chapter section there may be an optional timebase to be
used for start/end values. It must be in form
‘<samp class="samp">TIMEBASE=<var class="var">num</var>/<var class="var">den</var></samp>’, where <var class="var">num</var> and <var class="var">den</var> are
integers. If the timebase is missing then start/end times are assumed to
be in nanoseconds.
<p>Next a chapter section must contain chapter start and end times in form
‘<samp class="samp">START=<var class="var">num</var></samp>’, ‘<samp class="samp">END=<var class="var">num</var></samp>’, where <var class="var">num</var> is a positive
integer.
</p>
</li><li> Empty lines and lines starting with ‘<samp class="samp">;</samp>’ or ‘<samp class="samp">#</samp>’ are ignored.
</li><li> Metadata keys or values containing special characters (‘<samp class="samp">=</samp>’, ‘<samp class="samp">;</samp>’,
‘<samp class="samp">#</samp>’, ‘<samp class="samp">\</samp>’ and a newline) must be escaped with a backslash ‘<samp class="samp">\</samp>’.
</li><li> Note that whitespace in metadata (e.g. ‘<samp class="samp">foo = bar</samp>’) is considered to be
a part of the tag (in the example above key is ‘<samp class="samp">foo </samp>’, value is
‘<samp class="samp"> bar</samp>’).
</li></ol>
<p>A ffmetadata file might look like this:
</p><div class="example">
<pre class="example-preformatted">;FFMETADATA1
title=bike\\shed
;this is a comment
artist=FFmpeg troll team
[CHAPTER]
TIMEBASE=1/1000
START=0
#chapter ends at 0:01:00
END=60000
title=chapter \#1
[STREAM]
title=multi\
line
</pre></div>
<p>By using the ffmetadata muxer and demuxer it is possible to extract
metadata from an input file to an ffmetadata file, and then transcode
the file into an output file with the edited ffmetadata file.
</p>
<p>Extracting an ffmetadata file with <samp class="file">ffmpeg</samp> goes as follows:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
</pre></div>
<p>Reinserting edited metadata information from the FFMETADATAFILE file can
be done as:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
</pre></div>
</div>
<div class="chapter-level-extent" id="Protocol-Options">
<h2 class="chapter">15 Protocol Options</h2>
<p>The libavformat library provides some generic global options, which
can be set on all the protocols. In addition each protocol may support
so-called private options, which are specific for that component.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, or by setting the value explicitly in the
<code class="code">AVFormatContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API
for programmatic use.
</p>
<p>The list of supported options follows:
</p>
<dl class="table">
<dt><samp class="option">protocol_whitelist <var class="var">list</var> (<em class="emph">input</em>)</samp></dt>
<dd><p>Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols
prefixed by "-" are disabled.
All protocols are allowed by default but protocols used by an another
protocol (nested protocols) are restricted to a per protocol subset.
</p></dd>
</dl>
</div>
<div class="chapter-level-extent" id="Protocols">
<h2 class="chapter">16 Protocols</h2>
<p>Protocols are configured elements in FFmpeg that enable access to
resources that require specific protocols.
</p>
<p>When you configure your FFmpeg build, all the supported protocols are
enabled by default. You can list all available ones using the
configure option "–list-protocols".
</p>
<p>You can disable all the protocols using the configure option
"–disable-protocols", and selectively enable a protocol using the
option "–enable-protocol=<var class="var">PROTOCOL</var>", or you can disable a
particular protocol using the option
"–disable-protocol=<var class="var">PROTOCOL</var>".
</p>
<p>The option "-protocols" of the ff* tools will display the list of
supported protocols.
</p>
<p>All protocols accept the following options:
</p>
<dl class="table">
<dt><samp class="option">rw_timeout</samp></dt>
<dd><p>Maximum time to wait for (network) read/write operations to complete,
in microseconds.
</p></dd>
</dl>
<p>A description of the currently available protocols follows.
</p>
<ul class="mini-toc">
<li><a href="#amqp" accesskey="1">amqp</a></li>
<li><a href="#async" accesskey="2">async</a></li>
<li><a href="#bluray" accesskey="3">bluray</a></li>
<li><a href="#cache" accesskey="4">cache</a></li>
<li><a href="#concat-2" accesskey="5">concat</a></li>
<li><a href="#concatf" accesskey="6">concatf</a></li>
<li><a href="#crypto" accesskey="7">crypto</a></li>
<li><a href="#data" accesskey="8">data</a></li>
<li><a href="#fd" accesskey="9">fd</a></li>
<li><a href="#file">file</a></li>
<li><a href="#ftp">ftp</a></li>
<li><a href="#gopher">gopher</a></li>
<li><a href="#gophers">gophers</a></li>
<li><a href="#hls-1">hls</a></li>
<li><a href="#http">http</a></li>
<li><a href="#Icecast">Icecast</a></li>
<li><a href="#ipfs">ipfs</a></li>
<li><a href="#mmst">mmst</a></li>
<li><a href="#mmsh">mmsh</a></li>
<li><a href="#md5">md5</a></li>
<li><a href="#pipe">pipe</a></li>
<li><a href="#prompeg">prompeg</a></li>
<li><a href="#rist">rist</a></li>
<li><a href="#rtmp">rtmp</a></li>
<li><a href="#rtmpe">rtmpe</a></li>
<li><a href="#rtmps">rtmps</a></li>
<li><a href="#rtmpt">rtmpt</a></li>
<li><a href="#rtmpte">rtmpte</a></li>
<li><a href="#rtmpts">rtmpts</a></li>
<li><a href="#libsmbclient">libsmbclient</a></li>
<li><a href="#libssh">libssh</a></li>
<li><a href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte">librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte</a></li>
<li><a href="#rtp">rtp</a></li>
<li><a href="#rtsp">rtsp</a></li>
<li><a href="#sap">sap</a></li>
<li><a href="#sctp">sctp</a></li>
<li><a href="#srt">srt</a></li>
<li><a href="#srtp">srtp</a></li>
<li><a href="#subfile">subfile</a></li>
<li><a href="#tee">tee</a></li>
<li><a href="#tcp">tcp</a></li>
<li><a href="#tls">tls</a></li>
<li><a href="#udp">udp</a></li>
<li><a href="#unix">unix</a></li>
<li><a href="#zmq">zmq</a></li>
</ul>
<div class="section-level-extent" id="amqp">
<h3 class="section">16.1 amqp</h3>
<p>Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based
publish-subscribe communication protocol.
</p>
<p>FFmpeg must be compiled with –enable-librabbitmq to support AMQP. A separate
AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ.
</p>
<p>After starting the broker, an FFmpeg client may stream data to the broker using
the command:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port][/vhost]
</pre></div>
<p>Where hostname and port (default is 5672) is the address of the broker. The
client may also set a user/password for authentication. The default for both
fields is "guest". Name of virtual host on broker can be set with vhost. The
default value is "/".
</p>
<p>Muliple subscribers may stream from the broker using the command:
</p><div class="example">
<pre class="example-preformatted">ffplay amqp://[[user]:[password]@]hostname[:port][/vhost]
</pre></div>
<p>In RabbitMQ all data published to the broker flows through a specific exchange,
and each subscribing client has an assigned queue/buffer. When a packet arrives
at an exchange, it may be copied to a client’s queue depending on the exchange
and routing_key fields.
</p>
<p>The following options are supported:
</p>
<dl class="table">
<dt><samp class="option">exchange</samp></dt>
<dd><p>Sets the exchange to use on the broker. RabbitMQ has several predefined
exchanges: "amq.direct" is the default exchange, where the publisher and
subscriber must have a matching routing_key; "amq.fanout" is the same as a
broadcast operation (i.e. the data is forwarded to all queues on the fanout
exchange independent of the routing_key); and "amq.topic" is similar to
"amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ
documentation).
</p>
</dd>
<dt><samp class="option">routing_key</samp></dt>
<dd><p>Sets the routing key. The default value is "amqp". The routing key is used on
the "amq.direct" and "amq.topic" exchanges to decide whether packets are written
to the queue of a subscriber.
</p>
</dd>
<dt><samp class="option">pkt_size</samp></dt>
<dd><p>Maximum size of each packet sent/received to the broker. Default is 131072.
Minimum is 4096 and max is any large value (representable by an int). When
receiving packets, this sets an internal buffer size in FFmpeg. It should be
equal to or greater than the size of the published packets to the broker. Otherwise
the received message may be truncated causing decoding errors.
</p>
</dd>
<dt><samp class="option">connection_timeout</samp></dt>
<dd><p>The timeout in seconds during the initial connection to the broker. The
default value is rw_timeout, or 5 seconds if rw_timeout is not set.
</p>
</dd>
<dt><samp class="option">delivery_mode <var class="var">mode</var></samp></dt>
<dd><p>Sets the delivery mode of each message sent to broker.
The following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">persistent</samp>’</dt>
<dd><p>Delivery mode set to "persistent" (2). This is the default value.
Messages may be written to the broker’s disk depending on its setup.
</p>
</dd>
<dt>‘<samp class="samp">non-persistent</samp>’</dt>
<dd><p>Delivery mode set to "non-persistent" (1).
Messages will stay in broker’s memory unless the broker is under memory
pressure.
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="async">
<h3 class="section">16.2 async</h3>
<p>Asynchronous data filling wrapper for input stream.
</p>
<p>Fill data in a background thread, to decouple I/O operation from demux thread.
</p>
<div class="example">
<pre class="example-preformatted">async:<var class="var">URL</var>
async:http://host/resource
async:cache:http://host/resource
</pre></div>
</div>
<div class="section-level-extent" id="bluray">
<h3 class="section">16.3 bluray</h3>
<p>Read BluRay playlist.
</p>
<p>The accepted options are:
</p><dl class="table">
<dt><samp class="option">angle</samp></dt>
<dd><p>BluRay angle
</p>
</dd>
<dt><samp class="option">chapter</samp></dt>
<dd><p>Start chapter (1...N)
</p>
</dd>
<dt><samp class="option">playlist</samp></dt>
<dd><p>Playlist to read (BDMV/PLAYLIST/?????.mpls)
</p>
</dd>
</dl>
<p>Examples:
</p>
<p>Read longest playlist from BluRay mounted to /mnt/bluray:
</p><div class="example">
<pre class="example-preformatted">bluray:/mnt/bluray
</pre></div>
<p>Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
</p><div class="example">
<pre class="example-preformatted">-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
</pre></div>
</div>
<div class="section-level-extent" id="cache">
<h3 class="section">16.4 cache</h3>
<p>Caching wrapper for input stream.
</p>
<p>Cache the input stream to temporary file. It brings seeking capability to live streams.
</p>
<p>The accepted options are:
</p><dl class="table">
<dt><samp class="option">read_ahead_limit</samp></dt>
<dd><p>Amount in bytes that may be read ahead when seeking isn’t supported. Range is -1 to INT_MAX.
-1 for unlimited. Default is 65536.
</p>
</dd>
</dl>
<p>URL Syntax is
</p><div class="example">
<pre class="example-preformatted">cache:<var class="var">URL</var>
</pre></div>
</div>
<div class="section-level-extent" id="concat-2">
<h3 class="section">16.5 concat</h3>
<p>Physical concatenation protocol.
</p>
<p>Read and seek from many resources in sequence as if they were
a unique resource.
</p>
<p>A URL accepted by this protocol has the syntax:
</p><div class="example">
<pre class="example-preformatted">concat:<var class="var">URL1</var>|<var class="var">URL2</var>|...|<var class="var">URLN</var>
</pre></div>
<p>where <var class="var">URL1</var>, <var class="var">URL2</var>, ..., <var class="var">URLN</var> are the urls of the
resource to be concatenated, each one possibly specifying a distinct
protocol.
</p>
<p>For example to read a sequence of files <samp class="file">split1.mpeg</samp>,
<samp class="file">split2.mpeg</samp>, <samp class="file">split3.mpeg</samp> with <code class="command">ffplay</code> use the
command:
</p><div class="example">
<pre class="example-preformatted">ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
</pre></div>
<p>Note that you may need to escape the character "|" which is special for
many shells.
</p>
</div>
<div class="section-level-extent" id="concatf">
<h3 class="section">16.6 concatf</h3>
<p>Physical concatenation protocol using a line break delimited list of
resources.
</p>
<p>Read and seek from many resources in sequence as if they were
a unique resource.
</p>
<p>A URL accepted by this protocol has the syntax:
</p><div class="example">
<pre class="example-preformatted">concatf:<var class="var">URL</var>
</pre></div>
<p>where <var class="var">URL</var> is the url containing a line break delimited list of
resources to be concatenated, each one possibly specifying a distinct
protocol. Special characters must be escaped with backslash or single
quotes. 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>.
</p>
<p>For example to read a sequence of files <samp class="file">split1.mpeg</samp>,
<samp class="file">split2.mpeg</samp>, <samp class="file">split3.mpeg</samp> listed in separate lines within
a file <samp class="file">split.txt</samp> with <code class="command">ffplay</code> use the command:
</p><div class="example">
<pre class="example-preformatted">ffplay concatf:split.txt
</pre></div>
<p>Where <samp class="file">split.txt</samp> contains the lines:
</p><div class="example">
<pre class="example-preformatted">split1.mpeg
split2.mpeg
split3.mpeg
</pre></div>
</div>
<div class="section-level-extent" id="crypto">
<h3 class="section">16.7 crypto</h3>
<p>AES-encrypted stream reading protocol.
</p>
<p>The accepted options are:
</p><dl class="table">
<dt><samp class="option">key</samp></dt>
<dd><p>Set the AES decryption key binary block from given hexadecimal representation.
</p>
</dd>
<dt><samp class="option">iv</samp></dt>
<dd><p>Set the AES decryption initialization vector binary block from given hexadecimal representation.
</p></dd>
</dl>
<p>Accepted URL formats:
</p><div class="example">
<pre class="example-preformatted">crypto:<var class="var">URL</var>
crypto+<var class="var">URL</var>
</pre></div>
</div>
<div class="section-level-extent" id="data">
<h3 class="section">16.8 data</h3>
<p>Data in-line in the URI. See <a class="url" href="http://en.wikipedia.org/wiki/Data_URI_scheme">http://en.wikipedia.org/wiki/Data_URI_scheme</a>.
</p>
<p>For example, to convert a GIF file given inline with <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
</pre></div>
</div>
<div class="section-level-extent" id="fd">
<h3 class="section">16.9 fd</h3>
<p>File descriptor access protocol.
</p>
<p>The accepted syntax is:
</p><div class="example">
<pre class="example-preformatted">fd: -fd <var class="var">file_descriptor</var>
</pre></div>
<p>If <samp class="option">fd</samp> is not specified, by default the stdout file descriptor will be
used for writing, stdin for reading. Unlike the pipe protocol, fd protocol has
seek support if it corresponding to a regular file. fd protocol doesn’t support
pass file descriptor via URL for security.
</p>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">blocksize</samp></dt>
<dd><p>Set I/O operation maximum block size, in bytes. Default value is
<code class="code">INT_MAX</code>, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable if data transmission is slow.
</p>
</dd>
<dt><samp class="option">fd</samp></dt>
<dd><p>Set file descriptor.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="file">
<h3 class="section">16.10 file</h3>
<p>File access protocol.
</p>
<p>Read from or write to a file.
</p>
<p>A file URL can have the form:
</p><div class="example">
<pre class="example-preformatted">file:<var class="var">filename</var>
</pre></div>
<p>where <var class="var">filename</var> is the path of the file to read.
</p>
<p>An URL that does not have a protocol prefix will be assumed to be a
file URL. Depending on the build, an URL that looks like a Windows
path with the drive letter at the beginning will also be assumed to be
a file URL (usually not the case in builds for unix-like systems).
</p>
<p>For example to read from a file <samp class="file">input.mpeg</samp> with <code class="command">ffmpeg</code>
use the command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i file:input.mpeg output.mpeg
</pre></div>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp class="option">blocksize</samp></dt>
<dd><p>Set I/O operation maximum block size, in bytes. Default value is
<code class="code">INT_MAX</code>, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable for files on slow medium.
</p>
</dd>
<dt><samp class="option">follow</samp></dt>
<dd><p>If set to 1, the protocol will retry reading at the end of the file, allowing
reading files that still are being written. In order for this to terminate,
you either need to use the rw_timeout option, or use the interrupt callback
(for API users).
</p>
</dd>
<dt><samp class="option">seekable</samp></dt>
<dd><p>Controls if seekability is advertised on the file. 0 means non-seekable, -1
means auto (seekable for normal files, non-seekable for named pipes).
</p>
<p>Many demuxers handle seekable and non-seekable resources differently,
overriding this might speed up opening certain files at the cost of losing some
features (e.g. accurate seeking).
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="ftp">
<h3 class="section">16.11 ftp</h3>
<p>FTP (File Transfer Protocol).
</p>
<p>Read from or write to remote resources using FTP protocol.
</p>
<p>Following syntax is required.
</p><div class="example">
<pre class="example-preformatted">ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">timeout</samp></dt>
<dd><p>Set timeout in microseconds of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout is
not specified.
</p>
</dd>
<dt><samp class="option">ftp-user</samp></dt>
<dd><p>Set a user to be used for authenticating to the FTP server. This is overridden by the
user in the FTP URL.
</p>
</dd>
<dt><samp class="option">ftp-password</samp></dt>
<dd><p>Set a password to be used for authenticating to the FTP server. This is overridden by
the password in the FTP URL, or by <samp class="option">ftp-anonymous-password</samp> if no user is set.
</p>
</dd>
<dt><samp class="option">ftp-anonymous-password</samp></dt>
<dd><p>Password used when login as anonymous user. Typically an e-mail address
should be used.
</p>
</dd>
<dt><samp class="option">ftp-write-seekable</samp></dt>
<dd><p>Control seekability of connection during encoding. If set to 1 the
resource is supposed to be seekable, if set to 0 it is assumed not
to be seekable. Default value is 0.
</p></dd>
</dl>
<p>NOTE: Protocol can be used as output, but it is recommended to not do
it, unless special care is taken (tests, customized server configuration
etc.). Different FTP servers behave in different way during seek
operation. ff* tools may produce incomplete content due to server limitations.
</p>
</div>
<div class="section-level-extent" id="gopher">
<h3 class="section">16.12 gopher</h3>
<p>Gopher protocol.
</p>
</div>
<div class="section-level-extent" id="gophers">
<h3 class="section">16.13 gophers</h3>
<p>Gophers protocol.
</p>
<p>The Gopher protocol with TLS encapsulation.
</p>
</div>
<div class="section-level-extent" id="hls-1">
<h3 class="section">16.14 hls</h3>
<p>Read Apple HTTP Live Streaming compliant segmented stream as
a uniform one. The M3U8 playlists describing the segments can be
remote HTTP resources or local files, accessed using the standard
file protocol.
The nested protocol is declared by specifying
"+<var class="var">proto</var>" after the hls URI scheme name, where <var class="var">proto</var>
is either "file" or "http".
</p>
<div class="example">
<pre class="example-preformatted">hls+http://host/path/to/remote/resource.m3u8
hls+file://path/to/local/resource.m3u8
</pre></div>
<p>Using this protocol is discouraged - the hls demuxer should work
just as well (if not, please report the issues) and is more complete.
To use the hls demuxer instead, simply use the direct URLs to the
m3u8 files.
</p>
</div>
<div class="section-level-extent" id="http">
<h3 class="section">16.15 http</h3>
<p>HTTP (Hyper Text Transfer Protocol).
</p>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">seekable</samp></dt>
<dd><p>Control seekability of connection. If set to 1 the resource is
supposed to be seekable, if set to 0 it is assumed not to be seekable,
if set to -1 it will try to autodetect if it is seekable. Default
value is -1.
</p>
</dd>
<dt><samp class="option">chunked_post</samp></dt>
<dd><p>If set to 1 use chunked Transfer-Encoding for posts, default is 1.
</p>
</dd>
<dt><samp class="option">content_type</samp></dt>
<dd><p>Set a specific content type for the POST messages or for listen mode.
</p>
</dd>
<dt><samp class="option">http_proxy</samp></dt>
<dd><p>set HTTP proxy to tunnel through e.g. http://example.com:1234
</p>
</dd>
<dt><samp class="option">headers</samp></dt>
<dd><p>Set custom HTTP headers, can override built in default headers. The
value must be a string encoding the headers.
</p>
</dd>
<dt><samp class="option">multiple_requests</samp></dt>
<dd><p>Use persistent connections if set to 1, default is 0.
</p>
</dd>
<dt><samp class="option">post_data</samp></dt>
<dd><p>Set custom HTTP post data.
</p>
</dd>
<dt><samp class="option">referer</samp></dt>
<dd><p>Set the Referer header. Include ’Referer: URL’ header in HTTP request.
</p>
</dd>
<dt><samp class="option">user_agent</samp></dt>
<dd><p>Override the User-Agent header. If not specified the protocol will use a
string describing the libavformat build. ("Lavf/<version>")
</p>
</dd>
<dt><samp class="option">reconnect_at_eof</samp></dt>
<dd><p>If set then eof is treated like an error and causes reconnection, this is useful
for live / endless streams.
</p>
</dd>
<dt><samp class="option">reconnect_streamed</samp></dt>
<dd><p>If set then even streamed/non seekable streams will be reconnected on errors.
</p>
</dd>
<dt><samp class="option">reconnect_on_network_error</samp></dt>
<dd><p>Reconnect automatically in case of TCP/TLS errors during connect.
</p>
</dd>
<dt><samp class="option">reconnect_on_http_error</samp></dt>
<dd><p>A comma separated list of HTTP status codes to reconnect on. The list can
include specific status codes (e.g. ’503’) or the strings ’4xx’ / ’5xx’.
</p>
</dd>
<dt><samp class="option">reconnect_delay_max</samp></dt>
<dd><p>Sets the maximum delay in seconds after which to give up reconnecting
</p>
</dd>
<dt><samp class="option">mime_type</samp></dt>
<dd><p>Export the MIME type.
</p>
</dd>
<dt><samp class="option">http_version</samp></dt>
<dd><p>Exports the HTTP response version number. Usually "1.0" or "1.1".
</p>
</dd>
<dt><samp class="option">icy</samp></dt>
<dd><p>If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
supports this, the metadata has to be retrieved by the application by reading
the <samp class="option">icy_metadata_headers</samp> and <samp class="option">icy_metadata_packet</samp> options.
The default is 1.
</p>
</dd>
<dt><samp class="option">icy_metadata_headers</samp></dt>
<dd><p>If the server supports ICY metadata, this contains the ICY-specific HTTP reply
headers, separated by newline characters.
</p>
</dd>
<dt><samp class="option">icy_metadata_packet</samp></dt>
<dd><p>If the server supports ICY metadata, and <samp class="option">icy</samp> was set to 1, this
contains the last non-empty metadata packet sent by the server. It should be
polled in regular intervals by applications interested in mid-stream metadata
updates.
</p>
</dd>
<dt><samp class="option">cookies</samp></dt>
<dd><p>Set the cookies to be sent in future requests. The format of each cookie is the
same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
delimited by a newline character.
</p>
</dd>
<dt><samp class="option">offset</samp></dt>
<dd><p>Set initial byte offset.
</p>
</dd>
<dt><samp class="option">end_offset</samp></dt>
<dd><p>Try to limit the request to bytes preceding this offset.
</p>
</dd>
<dt><samp class="option">method</samp></dt>
<dd><p>When used as a client option it sets the HTTP method for the request.
</p>
<p>When used as a server option it sets the HTTP method that is going to be
expected from the client(s).
If the expected and the received HTTP method do not match the client will
be given a Bad Request response.
When unset the HTTP method is not checked for now. This will be replaced by
autodetection in the future.
</p>
</dd>
<dt><samp class="option">listen</samp></dt>
<dd><p>If set to 1 enables experimental HTTP server. This can be used to send data when
used as an output option, or read data from a client with HTTP POST when used as
an input option.
If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
in ffmpeg.c and thus must not be used as a command line option.
</p><div class="example">
<pre class="example-preformatted"># Server side (sending):
ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://<var class="var">server</var>:<var class="var">port</var>
# Client side (receiving):
ffmpeg -i http://<var class="var">server</var>:<var class="var">port</var> -c copy somefile.ogg
# Client can also be done with wget:
wget http://<var class="var">server</var>:<var class="var">port</var> -O somefile.ogg
# Server side (receiving):
ffmpeg -listen 1 -i http://<var class="var">server</var>:<var class="var">port</var> -c copy somefile.ogg
# Client side (sending):
ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://<var class="var">server</var>:<var class="var">port</var>
# Client can also be done with wget:
wget --post-file=somefile.ogg http://<var class="var">server</var>:<var class="var">port</var>
</pre></div>
</dd>
<dt><samp class="option">send_expect_100</samp></dt>
<dd><p>Send an Expect: 100-continue header for POST. If set to 1 it will send, if set
to 0 it won’t, if set to -1 it will try to send if it is applicable. Default
value is -1.
</p>
</dd>
<dt><samp class="option">auth_type</samp></dt>
<dd>
<p>Set HTTP authentication type. No option for Digest, since this method requires
getting nonce parameters from the server first and can’t be used straight away like
Basic.
</p>
<dl class="table">
<dt><samp class="option">none</samp></dt>
<dd><p>Choose the HTTP authentication type automatically. This is the default.
</p></dd>
<dt><samp class="option">basic</samp></dt>
<dd>
<p>Choose the HTTP basic authentication.
</p>
<p>Basic authentication sends a Base64-encoded string that contains a user name and password
for the client. Base64 is not a form of encryption and should be considered the same as
sending the user name and password in clear text (Base64 is a reversible encoding).
If a resource needs to be protected, strongly consider using an authentication scheme
other than basic authentication. HTTPS/TLS should be used with basic authentication.
Without these additional security enhancements, basic authentication should not be used
to protect sensitive or valuable information.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#HTTP-Cookies" accesskey="1">HTTP Cookies</a></li>
</ul>
<div class="subsection-level-extent" id="HTTP-Cookies">
<h4 class="subsection">16.15.1 HTTP Cookies</h4>
<p>Some HTTP requests will be denied unless cookie values are passed in with the
request. The <samp class="option">cookies</samp> option allows these cookies to be specified. At
the very least, each cookie must specify a value along with a path and domain.
HTTP requests that match both the domain and path will automatically include the
cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
by a newline.
</p>
<p>The required syntax to play a stream specifying a cookie is:
</p><div class="example">
<pre class="example-preformatted">ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
</pre></div>
</div>
</div>
<div class="section-level-extent" id="Icecast">
<h3 class="section">16.16 Icecast</h3>
<p>Icecast protocol (stream to Icecast servers)
</p>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">ice_genre</samp></dt>
<dd><p>Set the stream genre.
</p>
</dd>
<dt><samp class="option">ice_name</samp></dt>
<dd><p>Set the stream name.
</p>
</dd>
<dt><samp class="option">ice_description</samp></dt>
<dd><p>Set the stream description.
</p>
</dd>
<dt><samp class="option">ice_url</samp></dt>
<dd><p>Set the stream website URL.
</p>
</dd>
<dt><samp class="option">ice_public</samp></dt>
<dd><p>Set if the stream should be public.
The default is 0 (not public).
</p>
</dd>
<dt><samp class="option">user_agent</samp></dt>
<dd><p>Override the User-Agent header. If not specified a string of the form
"Lavf/<version>" will be used.
</p>
</dd>
<dt><samp class="option">password</samp></dt>
<dd><p>Set the Icecast mountpoint password.
</p>
</dd>
<dt><samp class="option">content_type</samp></dt>
<dd><p>Set the stream content type. This must be set if it is different from
audio/mpeg.
</p>
</dd>
<dt><samp class="option">legacy_icecast</samp></dt>
<dd><p>This enables support for Icecast versions < 2.4.0, that do not support the
HTTP PUT method but the SOURCE method.
</p>
</dd>
<dt><samp class="option">tls</samp></dt>
<dd><p>Establish a TLS (HTTPS) connection to Icecast.
</p>
</dd>
</dl>
<div class="example">
<pre class="example-preformatted">icecast://[<var class="var">username</var>[:<var class="var">password</var>]@]<var class="var">server</var>:<var class="var">port</var>/<var class="var">mountpoint</var>
</pre></div>
</div>
<div class="section-level-extent" id="ipfs">
<h3 class="section">16.17 ipfs</h3>
<p>InterPlanetary File System (IPFS) protocol support. One can access files stored
on the IPFS network through so-called gateways. These are http(s) endpoints.
This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be sent
to such a gateway. Users can (and should) host their own node which means this
protocol will use one’s local gateway to access files on the IPFS network.
</p>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">gateway</samp></dt>
<dd><p>Defines the gateway to use. When not set, the protocol will first try
locating the local gateway by looking at <code class="code">$IPFS_GATEWAY</code>, <code class="code">$IPFS_PATH</code>
and <code class="code">$HOME/.ipfs/</code>, in that order.
</p>
</dd>
</dl>
<p>One can use this protocol in 2 ways. Using IPFS:
</p><div class="example">
<pre class="example-preformatted">ffplay ipfs://<hash>
</pre></div>
<p>Or the IPNS protocol (IPNS is mutable IPFS):
</p><div class="example">
<pre class="example-preformatted">ffplay ipns://<hash>
</pre></div>
</div>
<div class="section-level-extent" id="mmst">
<h3 class="section">16.18 mmst</h3>
<p>MMS (Microsoft Media Server) protocol over TCP.
</p>
</div>
<div class="section-level-extent" id="mmsh">
<h3 class="section">16.19 mmsh</h3>
<p>MMS (Microsoft Media Server) protocol over HTTP.
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example-preformatted">mmsh://<var class="var">server</var>[:<var class="var">port</var>][/<var class="var">app</var>][/<var class="var">playpath</var>]
</pre></div>
</div>
<div class="section-level-extent" id="md5">
<h3 class="section">16.20 md5</h3>
<p>MD5 output protocol.
</p>
<p>Computes the MD5 hash of the data to be written, and on close writes
this to the designated output or stdout if none is specified. It can
be used to test muxers without writing an actual file.
</p>
<p>Some examples follow.
</p><div class="example">
<pre class="example-preformatted"># Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
ffmpeg -i input.flv -f avi -y md5:output.avi.md5
# Write the MD5 hash of the encoded AVI file to stdout.
ffmpeg -i input.flv -f avi -y md5:
</pre></div>
<p>Note that some formats (typically MOV) require the output protocol to
be seekable, so they will fail with the MD5 output protocol.
</p>
</div>
<div class="section-level-extent" id="pipe">
<h3 class="section">16.21 pipe</h3>
<p>UNIX pipe access protocol.
</p>
<p>Read and write from UNIX pipes.
</p>
<p>The accepted syntax is:
</p><div class="example">
<pre class="example-preformatted">pipe:[<var class="var">number</var>]
</pre></div>
<p>If <samp class="option">fd</samp> isn’t specified, <var class="var">number</var> is the number corresponding to the file descriptor of the
pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If <var class="var">number</var>
is not specified, by default the stdout file descriptor will be used
for writing, stdin for reading.
</p>
<p>For example to read from stdin with <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">cat test.wav | ffmpeg -i pipe:0
# ...this is the same as...
cat test.wav | ffmpeg -i pipe:
</pre></div>
<p>For writing to stdout with <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
# ...this is the same as...
ffmpeg -i test.wav -f avi pipe: | cat > test.avi
</pre></div>
<p>This protocol accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">blocksize</samp></dt>
<dd><p>Set I/O operation maximum block size, in bytes. Default value is
<code class="code">INT_MAX</code>, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable if data transmission is slow.
</p></dd>
<dt><samp class="option">fd</samp></dt>
<dd><p>Set file descriptor.
</p></dd>
</dl>
<p>Note that some formats (typically MOV), require the output protocol to
be seekable, so they will fail with the pipe output protocol.
</p>
</div>
<div class="section-level-extent" id="prompeg">
<h3 class="section">16.22 prompeg</h3>
<p>Pro-MPEG Code of Practice #3 Release 2 FEC protocol.
</p>
<p>The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism
for MPEG-2 Transport Streams sent over RTP.
</p>
<p>This protocol must be used in conjunction with the <code class="code">rtp_mpegts</code> muxer and
the <code class="code">rtp</code> protocol.
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example-preformatted">-f rtp_mpegts -fec prompeg=<var class="var">option</var>=<var class="var">val</var>... rtp://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
<p>The destination UDP ports are <code class="code">port + 2</code> for the column FEC stream
and <code class="code">port + 4</code> for the row FEC stream.
</p>
<p>This protocol accepts the following options:
</p><dl class="table">
<dt><samp class="option">l=<var class="var">n</var></samp></dt>
<dd><p>The number of columns (4-20, LxD <= 100)
</p>
</dd>
<dt><samp class="option">d=<var class="var">n</var></samp></dt>
<dd><p>The number of rows (4-20, LxD <= 100)
</p>
</dd>
</dl>
<p>Example usage:
</p>
<div class="example">
<pre class="example-preformatted">-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
</div>
<div class="section-level-extent" id="rist">
<h3 class="section">16.23 rist</h3>
<p>Reliable Internet Streaming Transport protocol
</p>
<p>The accepted options are:
</p><dl class="table">
<dt><samp class="option">rist_profile</samp></dt>
<dd><p>Supported values:
</p><dl class="table">
<dt>‘<samp class="samp">simple</samp>’</dt>
<dt>‘<samp class="samp">main</samp>’</dt>
<dd><p>This one is default.
</p></dd>
<dt>‘<samp class="samp">advanced</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">buffer_size</samp></dt>
<dd><p>Set internal RIST buffer size in milliseconds for retransmission of data.
Default value is 0 which means the librist default (1 sec). Maximum value is 30
seconds.
</p>
</dd>
<dt><samp class="option">fifo_size</samp></dt>
<dd><p>Size of the librist receiver output fifo in number of packets. This must be a
power of 2.
Defaults to 8192 (vs the librist default of 1024).
</p>
</dd>
<dt><samp class="option">overrun_nonfatal=<var class="var">1|0</var></samp></dt>
<dd><p>Survive in case of librist fifo buffer overrun. Default value is 0.
</p>
</dd>
<dt><samp class="option">pkt_size</samp></dt>
<dd><p>Set maximum packet size for sending data. 1316 by default.
</p>
</dd>
<dt><samp class="option">log_level</samp></dt>
<dd><p>Set loglevel for RIST logging messages. You only need to set this if you
explicitly want to enable debug level messages or packet loss simulation,
otherwise the regular loglevel is respected.
</p>
</dd>
<dt><samp class="option">secret</samp></dt>
<dd><p>Set override of encryption secret, by default is unset.
</p>
</dd>
<dt><samp class="option">encryption</samp></dt>
<dd><p>Set encryption type, by default is disabled.
Acceptable values are 128 and 256.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="rtmp">
<h3 class="section">16.24 rtmp</h3>
<p>Real-Time Messaging Protocol.
</p>
<p>The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
content across a TCP/IP network.
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example-preformatted">rtmp://[<var class="var">username</var>:<var class="var">password</var>@]<var class="var">server</var>[:<var class="var">port</var>][/<var class="var">app</var>][/<var class="var">instance</var>][/<var class="var">playpath</var>]
</pre></div>
<p>The accepted parameters are:
</p><dl class="table">
<dt><samp class="option">username</samp></dt>
<dd><p>An optional username (mostly for publishing).
</p>
</dd>
<dt><samp class="option">password</samp></dt>
<dd><p>An optional password (mostly for publishing).
</p>
</dd>
<dt><samp class="option">server</samp></dt>
<dd><p>The address of the RTMP server.
</p>
</dd>
<dt><samp class="option">port</samp></dt>
<dd><p>The number of the TCP port to use (by default is 1935).
</p>
</dd>
<dt><samp class="option">app</samp></dt>
<dd><p>It is the name of the application to access. It usually corresponds to
the path where the application is installed on the RTMP server
(e.g. <samp class="file">/ondemand/</samp>, <samp class="file">/flash/live/</samp>, etc.). You can override
the value parsed from the URI through the <code class="code">rtmp_app</code> option, too.
</p>
</dd>
<dt><samp class="option">playpath</samp></dt>
<dd><p>It is the path or name of the resource to play with reference to the
application specified in <var class="var">app</var>, may be prefixed by "mp4:". You
can override the value parsed from the URI through the <code class="code">rtmp_playpath</code>
option, too.
</p>
</dd>
<dt><samp class="option">listen</samp></dt>
<dd><p>Act as a server, listening for an incoming connection.
</p>
</dd>
<dt><samp class="option">timeout</samp></dt>
<dd><p>Maximum time to wait for the incoming connection. Implies listen.
</p></dd>
</dl>
<p>Additionally, the following parameters can be set via command line options
(or in code via <code class="code">AVOption</code>s):
</p><dl class="table">
<dt><samp class="option">rtmp_app</samp></dt>
<dd><p>Name of application to connect on the RTMP server. This option
overrides the parameter specified in the URI.
</p>
</dd>
<dt><samp class="option">rtmp_buffer</samp></dt>
<dd><p>Set the client buffer time in milliseconds. The default is 3000.
</p>
</dd>
<dt><samp class="option">rtmp_conn</samp></dt>
<dd><p>Extra arbitrary AMF connection parameters, parsed from a string,
e.g. like <code class="code">B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0</code>.
Each value is prefixed by a single character denoting the type,
B for Boolean, N for number, S for string, O for object, or Z for null,
followed by a colon. For Booleans the data must be either 0 or 1 for
FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or
1 to end or begin an object, respectively. Data items in subobjects may
be named, by prefixing the type with ’N’ and specifying the name before
the value (i.e. <code class="code">NB:myFlag:1</code>). This option may be used multiple
times to construct arbitrary AMF sequences.
</p>
</dd>
<dt><samp class="option">rtmp_enhanced_codecs</samp></dt>
<dd><p>Specify the list of codecs the client advertises to support in an
enhanced RTMP stream. This option should be set to a comma separated
list of fourcc values, like <code class="code">hvc1,av01,vp09</code> for multiple codecs
or <code class="code">hvc1</code> for only one codec. The specified list will be presented
in the "fourCcLive" property of the Connect Command Message.
</p>
</dd>
<dt><samp class="option">rtmp_flashver</samp></dt>
<dd><p>Version of the Flash plugin used to run the SWF player. The default
is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
<libavformat version>).)
</p>
</dd>
<dt><samp class="option">rtmp_flush_interval</samp></dt>
<dd><p>Number of packets flushed in the same request (RTMPT only). The default
is 10.
</p>
</dd>
<dt><samp class="option">rtmp_live</samp></dt>
<dd><p>Specify that the media is a live stream. No resuming or seeking in
live streams is possible. The default value is <code class="code">any</code>, which means the
subscriber first tries to play the live stream specified in the
playpath. If a live stream of that name is not found, it plays the
recorded stream. The other possible values are <code class="code">live</code> and
<code class="code">recorded</code>.
</p>
</dd>
<dt><samp class="option">rtmp_pageurl</samp></dt>
<dd><p>URL of the web page in which the media was embedded. By default no
value will be sent.
</p>
</dd>
<dt><samp class="option">rtmp_playpath</samp></dt>
<dd><p>Stream identifier to play or to publish. This option overrides the
parameter specified in the URI.
</p>
</dd>
<dt><samp class="option">rtmp_subscribe</samp></dt>
<dd><p>Name of live stream to subscribe to. By default no value will be sent.
It is only sent if the option is specified or if rtmp_live
is set to live.
</p>
</dd>
<dt><samp class="option">rtmp_swfhash</samp></dt>
<dd><p>SHA256 hash of the decompressed SWF file (32 bytes).
</p>
</dd>
<dt><samp class="option">rtmp_swfsize</samp></dt>
<dd><p>Size of the decompressed SWF file, required for SWFVerification.
</p>
</dd>
<dt><samp class="option">rtmp_swfurl</samp></dt>
<dd><p>URL of the SWF player for the media. By default no value will be sent.
</p>
</dd>
<dt><samp class="option">rtmp_swfverify</samp></dt>
<dd><p>URL to player swf file, compute hash/size automatically.
</p>
</dd>
<dt><samp class="option">rtmp_tcurl</samp></dt>
<dd><p>URL of the target stream. Defaults to proto://host[:port]/app.
</p>
</dd>
<dt><samp class="option">tcp_nodelay=<var class="var">1|0</var></samp></dt>
<dd><p>Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0.
</p>
<p><em class="emph">Remark: Writing to the socket is currently not optimized to minimize system calls and reduces the efficiency / effect of TCP_NODELAY.</em>
</p>
</dd>
</dl>
<p>For example to read with <code class="command">ffplay</code> a multimedia resource named
"sample" from the application "vod" from an RTMP server "myserver":
</p><div class="example">
<pre class="example-preformatted">ffplay rtmp://myserver/vod/sample
</pre></div>
<p>To publish to a password protected server, passing the playpath and
app names separately:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
</pre></div>
</div>
<div class="section-level-extent" id="rtmpe">
<h3 class="section">16.25 rtmpe</h3>
<p>Encrypted Real-Time Messaging Protocol.
</p>
<p>The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
streaming multimedia content within standard cryptographic primitives,
consisting of Diffie-Hellman key exchange and HMACSHA256, generating
a pair of RC4 keys.
</p>
</div>
<div class="section-level-extent" id="rtmps">
<h3 class="section">16.26 rtmps</h3>
<p>Real-Time Messaging Protocol over a secure SSL connection.
</p>
<p>The Real-Time Messaging Protocol (RTMPS) is used for streaming
multimedia content across an encrypted connection.
</p>
</div>
<div class="section-level-extent" id="rtmpt">
<h3 class="section">16.27 rtmpt</h3>
<p>Real-Time Messaging Protocol tunneled through HTTP.
</p>
<p>The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
for streaming multimedia content within HTTP requests to traverse
firewalls.
</p>
</div>
<div class="section-level-extent" id="rtmpte">
<h3 class="section">16.28 rtmpte</h3>
<p>Encrypted Real-Time Messaging Protocol tunneled through HTTP.
</p>
<p>The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
is used for streaming multimedia content within HTTP requests to traverse
firewalls.
</p>
</div>
<div class="section-level-extent" id="rtmpts">
<h3 class="section">16.29 rtmpts</h3>
<p>Real-Time Messaging Protocol tunneled through HTTPS.
</p>
<p>The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
for streaming multimedia content within HTTPS requests to traverse
firewalls.
</p>
</div>
<div class="section-level-extent" id="libsmbclient">
<h3 class="section">16.30 libsmbclient</h3>
<p>libsmbclient permits one to manipulate CIFS/SMB network resources.
</p>
<p>Following syntax is required.
</p>
<div class="example">
<pre class="example-preformatted">smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">timeout</samp></dt>
<dd><p>Set timeout in milliseconds of socket I/O operations used by the underlying
low level operation. By default it is set to -1, which means that the timeout
is not specified.
</p>
</dd>
<dt><samp class="option">truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp class="option">workgroup</samp></dt>
<dd><p>Set the workgroup used for making connections. By default workgroup is not specified.
</p>
</dd>
</dl>
<p>For more information see: <a class="url" href="http://www.samba.org/">http://www.samba.org/</a>.
</p>
</div>
<div class="section-level-extent" id="libssh">
<h3 class="section">16.31 libssh</h3>
<p>Secure File Transfer Protocol via libssh
</p>
<p>Read from or write to remote resources using SFTP protocol.
</p>
<p>Following syntax is required.
</p>
<div class="example">
<pre class="example-preformatted">sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
</pre></div>
<p>This protocol accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">timeout</samp></dt>
<dd><p>Set timeout of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout
is not specified.
</p>
</dd>
<dt><samp class="option">truncate</samp></dt>
<dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.
</p>
</dd>
<dt><samp class="option">private_key</samp></dt>
<dd><p>Specify the path of the file containing private key to use during authorization.
By default libssh searches for keys in the <samp class="file">~/.ssh/</samp> directory.
</p>
</dd>
</dl>
<p>Example: Play a file stored on remote server.
</p>
<div class="example">
<pre class="example-preformatted">ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
</pre></div>
</div>
<div class="section-level-extent" id="librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte">
<h3 class="section">16.32 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte</h3>
<p>Real-Time Messaging Protocol and its variants supported through
librtmp.
</p>
<p>Requires the presence of the librtmp headers and library during
configuration. You need to explicitly configure the build with
"–enable-librtmp". If enabled this will replace the native RTMP
protocol.
</p>
<p>This protocol provides most client functions and a few server
functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
variants of these encrypted types (RTMPTE, RTMPTS).
</p>
<p>The required syntax is:
</p><div class="example">
<pre class="example-preformatted"><var class="var">rtmp_proto</var>://<var class="var">server</var>[:<var class="var">port</var>][/<var class="var">app</var>][/<var class="var">playpath</var>] <var class="var">options</var>
</pre></div>
<p>where <var class="var">rtmp_proto</var> is one of the strings "rtmp", "rtmpt", "rtmpe",
"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
<var class="var">server</var>, <var class="var">port</var>, <var class="var">app</var> and <var class="var">playpath</var> have the same
meaning as specified for the RTMP native protocol.
<var class="var">options</var> contains a list of space-separated options of the form
<var class="var">key</var>=<var class="var">val</var>.
</p>
<p>See the librtmp manual page (man 3 librtmp) for more information.
</p>
<p>For example, to stream a file in real-time to an RTMP server using
<code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
</pre></div>
<p>To play the same stream using <code class="command">ffplay</code>:
</p><div class="example">
<pre class="example-preformatted">ffplay "rtmp://myserver/live/mystream live=1"
</pre></div>
</div>
<div class="section-level-extent" id="rtp">
<h3 class="section">16.33 rtp</h3>
<p>Real-time Transport Protocol.
</p>
<p>The required syntax for an RTP URL is:
rtp://<var class="var">hostname</var>[:<var class="var">port</var>][?<var class="var">option</var>=<var class="var">val</var>...]
</p>
<p><var class="var">port</var> specifies the RTP port to use.
</p>
<p>The following URL options are supported:
</p>
<dl class="table">
<dt><samp class="option">ttl=<var class="var">n</var></samp></dt>
<dd><p>Set the TTL (Time-To-Live) value (for multicast only).
</p>
</dd>
<dt><samp class="option">rtcpport=<var class="var">n</var></samp></dt>
<dd><p>Set the remote RTCP port to <var class="var">n</var>.
</p>
</dd>
<dt><samp class="option">localrtpport=<var class="var">n</var></samp></dt>
<dd><p>Set the local RTP port to <var class="var">n</var>.
</p>
</dd>
<dt><samp class="option">localrtcpport=<var class="var">n</var>'</samp></dt>
<dd><p>Set the local RTCP port to <var class="var">n</var>.
</p>
</dd>
<dt><samp class="option">pkt_size=<var class="var">n</var></samp></dt>
<dd><p>Set max packet size (in bytes) to <var class="var">n</var>.
</p>
</dd>
<dt><samp class="option">buffer_size=<var class="var">size</var></samp></dt>
<dd><p>Set the maximum UDP socket buffer size in bytes.
</p>
</dd>
<dt><samp class="option">connect=0|1</samp></dt>
<dd><p>Do a <code class="code">connect()</code> on the UDP socket (if set to 1) or not (if set
to 0).
</p>
</dd>
<dt><samp class="option">sources=<var class="var">ip</var>[,<var class="var">ip</var>]</samp></dt>
<dd><p>List allowed source IP addresses.
</p>
</dd>
<dt><samp class="option">block=<var class="var">ip</var>[,<var class="var">ip</var>]</samp></dt>
<dd><p>List disallowed (blocked) source IP addresses.
</p>
</dd>
<dt><samp class="option">write_to_source=0|1</samp></dt>
<dd><p>Send packets to the source address of the latest received packet (if
set to 1) or to a default remote address (if set to 0).
</p>
</dd>
<dt><samp class="option">localport=<var class="var">n</var></samp></dt>
<dd><p>Set the local RTP port to <var class="var">n</var>.
</p>
</dd>
<dt><samp class="option">localaddr=<var class="var">addr</var></samp></dt>
<dd><p>Local IP address of a network interface used for sending packets or joining
multicast groups.
</p>
</dd>
<dt><samp class="option">timeout=<var class="var">n</var></samp></dt>
<dd><p>Set timeout (in microseconds) of socket I/O operations to <var class="var">n</var>.
</p>
<p>This is a deprecated option. Instead, <samp class="option">localrtpport</samp> should be
used.
</p>
</dd>
</dl>
<p>Important notes:
</p>
<ol class="enumerate">
<li> If <samp class="option">rtcpport</samp> is not set the RTCP port will be set to the RTP
port value plus 1.
</li><li> If <samp class="option">localrtpport</samp> (the local RTP port) is not set any available
port will be used for the local RTP and RTCP ports.
</li><li> If <samp class="option">localrtcpport</samp> (the local RTCP port) is not set it will be
set to the local RTP port value plus 1.
</li></ol>
</div>
<div class="section-level-extent" id="rtsp">
<h3 class="section">16.34 rtsp</h3>
<p>Real-Time Streaming Protocol.
</p>
<p>RTSP is not technically a protocol handler in libavformat, it is a demuxer
and muxer. The demuxer supports both normal RTSP (with data transferred
over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
data transferred over RDT).
</p>
<p>The muxer can be used to send a stream using RTSP ANNOUNCE to a server
supporting it (currently Darwin Streaming Server and Mischa Spiegelmock’s
<a class="uref" href="https://github.com/revmischa/rtsp-server">RTSP server</a>).
</p>
<p>The required syntax for a RTSP url is:
</p><div class="example">
<pre class="example-preformatted">rtsp://<var class="var">hostname</var>[:<var class="var">port</var>]/<var class="var">path</var>
</pre></div>
<p>Options can be set on the <code class="command">ffmpeg</code>/<code class="command">ffplay</code> command
line, or set in code via <code class="code">AVOption</code>s or in
<code class="code">avformat_open_input</code>.
</p>
<ul class="mini-toc">
<li><a href="#Muxer" accesskey="1">Muxer</a></li>
<li><a href="#Demuxer" accesskey="2">Demuxer</a></li>
<li><a href="#Examples-5" accesskey="3">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Muxer">
<h4 class="subsection">16.34.1 Muxer</h4>
<p>The following options are supported.
</p>
<dl class="table">
<dt><samp class="option">rtsp_transport</samp></dt>
<dd><p>Set RTSP transport protocols.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">udp</samp>’</dt>
<dd><p>Use UDP as lower transport protocol.
</p>
</dd>
<dt>‘<samp class="samp">tcp</samp>’</dt>
<dd><p>Use TCP (interleaving within the RTSP control channel) as lower
transport protocol.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">0</samp>’.
</p>
</dd>
<dt><samp class="option">rtsp_flags</samp></dt>
<dd><p>Set RTSP flags.
</p>
<p>The following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">latm</samp>’</dt>
<dd><p>Use MP4A-LATM packetization instead of MPEG4-GENERIC for AAC.
</p></dd>
<dt>‘<samp class="samp">rfc2190</samp>’</dt>
<dd><p>Use RFC 2190 packetization instead of RFC 4629 for H.263.
</p></dd>
<dt>‘<samp class="samp">skip_rtcp</samp>’</dt>
<dd><p>Don’t send RTCP sender reports.
</p></dd>
<dt>‘<samp class="samp">h264_mode0</samp>’</dt>
<dd><p>Use mode 0 for H.264 in RTP.
</p></dd>
<dt>‘<samp class="samp">send_bye</samp>’</dt>
<dd><p>Send RTCP BYE packets when finishing.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">0</samp>’.
</p>
</dd>
<dt><samp class="option">min_port</samp></dt>
<dd><p>Set minimum local UDP port. Default value is 5000.
</p>
</dd>
<dt><samp class="option">max_port</samp></dt>
<dd><p>Set maximum local UDP port. Default value is 65000.
</p>
</dd>
<dt><samp class="option">buffer_size</samp></dt>
<dd><p>Set the maximum socket buffer size in bytes.
</p>
</dd>
<dt><samp class="option">pkt_size</samp></dt>
<dd><p>Set max send packet size (in bytes). Default value is 1472.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Demuxer">
<h4 class="subsection">16.34.2 Demuxer</h4>
<p>The following options are supported.
</p>
<dl class="table">
<dt><samp class="option">initial_pause</samp></dt>
<dd><p>Do not start playing the stream immediately if set to 1. Default value
is 0.
</p>
</dd>
<dt><samp class="option">rtsp_transport</samp></dt>
<dd><p>Set RTSP transport protocols.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">udp</samp>’</dt>
<dd><p>Use UDP as lower transport protocol.
</p>
</dd>
<dt>‘<samp class="samp">tcp</samp>’</dt>
<dd><p>Use TCP (interleaving within the RTSP control channel) as lower
transport protocol.
</p>
</dd>
<dt>‘<samp class="samp">udp_multicast</samp>’</dt>
<dd><p>Use UDP multicast as lower transport protocol.
</p>
</dd>
<dt>‘<samp class="samp">http</samp>’</dt>
<dd><p>Use HTTP tunneling as lower transport protocol, which is useful for
passing proxies.
</p>
</dd>
<dt>‘<samp class="samp">https</samp>’</dt>
<dd><p>Use HTTPs tunneling as lower transport protocol, which is useful for
passing proxies and widely used for security consideration.
</p></dd>
</dl>
<p>Multiple lower transport protocols may be specified, in that case they are
tried one at a time (if the setup of one fails, the next one is tried).
For the muxer, only the ‘<samp class="samp">tcp</samp>’ and ‘<samp class="samp">udp</samp>’ options are supported.
</p>
</dd>
<dt><samp class="option">rtsp_flags</samp></dt>
<dd><p>Set RTSP flags.
</p>
<p>The following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">filter_src</samp>’</dt>
<dd><p>Accept packets only from negotiated peer address and port.
</p></dd>
<dt>‘<samp class="samp">listen</samp>’</dt>
<dd><p>Act as a server, listening for an incoming connection.
</p></dd>
<dt>‘<samp class="samp">prefer_tcp</samp>’</dt>
<dd><p>Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
</p></dd>
<dt>‘<samp class="samp">satip_raw</samp>’</dt>
<dd><p>Export raw MPEG-TS stream instead of demuxing. The flag will simply write out
the raw stream, with the original PAT/PMT/PIDs intact.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">none</samp>’.
</p>
</dd>
<dt><samp class="option">allowed_media_types</samp></dt>
<dd><p>Set media types to accept from the server.
</p>
<p>The following flags are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">video</samp>’</dt>
<dt>‘<samp class="samp">audio</samp>’</dt>
<dt>‘<samp class="samp">data</samp>’</dt>
<dt>‘<samp class="samp">subtitle</samp>’</dt>
</dl>
<p>By default it accepts all media types.
</p>
</dd>
<dt><samp class="option">min_port</samp></dt>
<dd><p>Set minimum local UDP port. Default value is 5000.
</p>
</dd>
<dt><samp class="option">max_port</samp></dt>
<dd><p>Set maximum local UDP port. Default value is 65000.
</p>
</dd>
<dt><samp class="option">listen_timeout</samp></dt>
<dd><p>Set maximum timeout (in seconds) to establish an initial connection. Setting
<samp class="option">listen_timeout</samp> > 0 sets <samp class="option">rtsp_flags</samp> to ‘<samp class="samp">listen</samp>’. Default is -1
which means an infinite timeout when ‘<samp class="samp">listen</samp>’ mode is set.
</p>
</dd>
<dt><samp class="option">reorder_queue_size</samp></dt>
<dd><p>Set number of packets to buffer for handling of reordered packets.
</p>
</dd>
<dt><samp class="option">timeout</samp></dt>
<dd><p>Set socket TCP I/O timeout in microseconds.
</p>
</dd>
<dt><samp class="option">user_agent</samp></dt>
<dd><p>Override User-Agent header. If not specified, it defaults to the
libavformat identifier string.
</p>
</dd>
<dt><samp class="option">buffer_size</samp></dt>
<dd><p>Set the maximum socket buffer size in bytes.
</p></dd>
</dl>
<p>When receiving data over UDP, the demuxer tries to reorder received packets
(since they may arrive out of order, or packets may get lost totally). This
can be disabled by setting the maximum demuxing delay to zero (via
the <code class="code">max_delay</code> field of AVFormatContext).
</p>
<p>When watching multi-bitrate Real-RTSP streams with <code class="command">ffplay</code>, the
streams to display can be chosen with <code class="code">-vst</code> <var class="var">n</var> and
<code class="code">-ast</code> <var class="var">n</var> for video and audio respectively, and can be switched
on the fly by pressing <code class="code">v</code> and <code class="code">a</code>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-5">
<h4 class="subsection">16.34.3 Examples</h4>
<p>The following examples all make use of the <code class="command">ffplay</code> and
<code class="command">ffmpeg</code> tools.
</p>
<ul class="itemize mark-bullet">
<li>Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
<div class="example">
<pre class="example-preformatted">ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
</pre></div>
</li><li>Watch a stream tunneled over HTTP:
<div class="example">
<pre class="example-preformatted">ffplay -rtsp_transport http rtsp://server/video.mp4
</pre></div>
</li><li>Send a stream in realtime to a RTSP server, for others to watch:
<div class="example">
<pre class="example-preformatted">ffmpeg -re -i <var class="var">input</var> -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
</pre></div>
</li><li>Receive a stream in realtime:
<div class="example">
<pre class="example-preformatted">ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp <var class="var">output</var>
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="sap">
<h3 class="section">16.35 sap</h3>
<p>Session Announcement Protocol (RFC 2974). This is not technically a
protocol handler in libavformat, it is a muxer and demuxer.
It is used for signalling of RTP streams, by announcing the SDP for the
streams regularly on a separate port.
</p>
<ul class="mini-toc">
<li><a href="#Muxer-1" accesskey="1">Muxer</a></li>
<li><a href="#Demuxer-1" accesskey="2">Demuxer</a></li>
</ul>
<div class="subsection-level-extent" id="Muxer-1">
<h4 class="subsection">16.35.1 Muxer</h4>
<p>The syntax for a SAP url given to the muxer is:
</p><div class="example">
<pre class="example-preformatted">sap://<var class="var">destination</var>[:<var class="var">port</var>][?<var class="var">options</var>]
</pre></div>
<p>The RTP packets are sent to <var class="var">destination</var> on port <var class="var">port</var>,
or to port 5004 if no port is specified.
<var class="var">options</var> is a <code class="code">&</code>-separated list. The following options
are supported:
</p>
<dl class="table">
<dt><samp class="option">announce_addr=<var class="var">address</var></samp></dt>
<dd><p>Specify the destination IP address for sending the announcements to.
If omitted, the announcements are sent to the commonly used SAP
announcement multicast address 224.2.127.254 (sap.mcast.net), or
ff0e::2:7ffe if <var class="var">destination</var> is an IPv6 address.
</p>
</dd>
<dt><samp class="option">announce_port=<var class="var">port</var></samp></dt>
<dd><p>Specify the port to send the announcements on, defaults to
9875 if not specified.
</p>
</dd>
<dt><samp class="option">ttl=<var class="var">ttl</var></samp></dt>
<dd><p>Specify the time to live value for the announcements and RTP packets,
defaults to 255.
</p>
</dd>
<dt><samp class="option">same_port=<var class="var">0|1</var></samp></dt>
<dd><p>If set to 1, send all RTP streams on the same port pair. If zero (the
default), all streams are sent on unique ports, with each stream on a
port 2 numbers higher than the previous.
VLC/Live555 requires this to be set to 1, to be able to receive the stream.
The RTP stack in libavformat for receiving requires all streams to be sent
on unique ports.
</p></dd>
</dl>
<p>Example command lines follow.
</p>
<p>To broadcast a stream on the local subnet, for watching in VLC:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -re -i <var class="var">input</var> -f sap sap://224.0.0.255?same_port=1
</pre></div>
<p>Similarly, for watching in <code class="command">ffplay</code>:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -re -i <var class="var">input</var> -f sap sap://224.0.0.255
</pre></div>
<p>And for watching in <code class="command">ffplay</code>, over IPv6:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -re -i <var class="var">input</var> -f sap sap://[ff0e::1:2:3:4]
</pre></div>
</div>
<div class="subsection-level-extent" id="Demuxer-1">
<h4 class="subsection">16.35.2 Demuxer</h4>
<p>The syntax for a SAP url given to the demuxer is:
</p><div class="example">
<pre class="example-preformatted">sap://[<var class="var">address</var>][:<var class="var">port</var>]
</pre></div>
<p><var class="var">address</var> is the multicast address to listen for announcements on,
if omitted, the default 224.2.127.254 (sap.mcast.net) is used. <var class="var">port</var>
is the port that is listened on, 9875 if omitted.
</p>
<p>The demuxers listens for announcements on the given address and port.
Once an announcement is received, it tries to receive that particular stream.
</p>
<p>Example command lines follow.
</p>
<p>To play back the first stream announced on the normal SAP multicast address:
</p>
<div class="example">
<pre class="example-preformatted">ffplay sap://
</pre></div>
<p>To play back the first stream announced on one the default IPv6 SAP multicast address:
</p>
<div class="example">
<pre class="example-preformatted">ffplay sap://[ff0e::2:7ffe]
</pre></div>
</div>
</div>
<div class="section-level-extent" id="sctp">
<h3 class="section">16.36 sctp</h3>
<p>Stream Control Transmission Protocol.
</p>
<p>The accepted URL syntax is:
</p><div class="example">
<pre class="example-preformatted">sctp://<var class="var">host</var>:<var class="var">port</var>[?<var class="var">options</var>]
</pre></div>
<p>The protocol accepts the following options:
</p><dl class="table">
<dt><samp class="option">listen</samp></dt>
<dd><p>If set to any value, listen for an incoming connection. Outgoing connection is done by default.
</p>
</dd>
<dt><samp class="option">max_streams</samp></dt>
<dd><p>Set the maximum number of streams. By default no limit is set.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="srt">
<h3 class="section">16.37 srt</h3>
<p>Haivision Secure Reliable Transport Protocol via libsrt.
</p>
<p>The supported syntax for a SRT URL is:
</p><div class="example">
<pre class="example-preformatted">srt://<var class="var">hostname</var>:<var class="var">port</var>[?<var class="var">options</var>]
</pre></div>
<p><var class="var">options</var> contains a list of &-separated options of the form
<var class="var">key</var>=<var class="var">val</var>.
</p>
<p>or
</p>
<div class="example">
<pre class="example-preformatted"><var class="var">options</var> srt://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
<p><var class="var">options</var> contains a list of ’-<var class="var">key</var> <var class="var">val</var>’
options.
</p>
<p>This protocol accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">connect_timeout=<var class="var">milliseconds</var></samp></dt>
<dd><p>Connection timeout; SRT cannot connect for RTT > 1500 msec
(2 handshake exchanges) with the default connect timeout of
3 seconds. This option applies to the caller and rendezvous
connection modes. The connect timeout is 10 times the value
set for the rendezvous mode (which can be used as a
workaround for this connection problem with earlier versions).
</p>
</dd>
<dt><samp class="option">ffs=<var class="var">bytes</var></samp></dt>
<dd><p>Flight Flag Size (Window Size), in bytes. FFS is actually an
internal parameter and you should set it to not less than
<samp class="option">recv_buffer_size</samp> and <samp class="option">mss</samp>. The default value
is relatively large, therefore unless you set a very large receiver buffer,
you do not need to change this option. Default value is 25600.
</p>
</dd>
<dt><samp class="option">inputbw=<var class="var">bytes/seconds</var></samp></dt>
<dd><p>Sender nominal input rate, in bytes per seconds. Used along with
<samp class="option">oheadbw</samp>, when <samp class="option">maxbw</samp> is set to relative (0), to
calculate maximum sending rate when recovery packets are sent
along with the main media stream:
<samp class="option">inputbw</samp> * (100 + <samp class="option">oheadbw</samp>) / 100
if <samp class="option">inputbw</samp> is not set while <samp class="option">maxbw</samp> is set to
relative (0), the actual input rate is evaluated inside
the library. Default value is 0.
</p>
</dd>
<dt><samp class="option">iptos=<var class="var">tos</var></samp></dt>
<dd><p>IP Type of Service. Applies to sender only. Default value is 0xB8.
</p>
</dd>
<dt><samp class="option">ipttl=<var class="var">ttl</var></samp></dt>
<dd><p>IP Time To Live. Applies to sender only. Default value is 64.
</p>
</dd>
<dt><samp class="option">latency=<var class="var">microseconds</var></samp></dt>
<dd><p>Timestamp-based Packet Delivery Delay.
Used to absorb bursts of missed packet retransmissions.
This flag sets both <samp class="option">rcvlatency</samp> and <samp class="option">peerlatency</samp>
to the same value. Note that prior to version 1.3.0
this is the only flag to set the latency, however
this is effectively equivalent to setting <samp class="option">peerlatency</samp>,
when side is sender and <samp class="option">rcvlatency</samp>
when side is receiver, and the bidirectional stream
sending is not supported.
</p>
</dd>
<dt><samp class="option">listen_timeout=<var class="var">microseconds</var></samp></dt>
<dd><p>Set socket listen timeout.
</p>
</dd>
<dt><samp class="option">maxbw=<var class="var">bytes/seconds</var></samp></dt>
<dd><p>Maximum sending bandwidth, in bytes per seconds.
-1 infinite (CSRTCC limit is 30mbps)
0 relative to input rate (see <samp class="option">inputbw</samp>)
>0 absolute limit value
Default value is 0 (relative)
</p>
</dd>
<dt><samp class="option">mode=<var class="var">caller|listener|rendezvous</var></samp></dt>
<dd><p>Connection mode.
<samp class="option">caller</samp> opens client connection.
<samp class="option">listener</samp> starts server to listen for incoming connections.
<samp class="option">rendezvous</samp> use Rendez-Vous connection mode.
Default value is caller.
</p>
</dd>
<dt><samp class="option">mss=<var class="var">bytes</var></samp></dt>
<dd><p>Maximum Segment Size, in bytes. Used for buffer allocation
and rate calculation using a packet counter assuming fully
filled packets. The smallest MSS between the peers is
used. This is 1500 by default in the overall internet.
This is the maximum size of the UDP packet and can be
only decreased, unless you have some unusual dedicated
network settings. Default value is 1500.
</p>
</dd>
<dt><samp class="option">nakreport=<var class="var">1|0</var></samp></dt>
<dd><p>If set to 1, Receiver will send ‘UMSG_LOSSREPORT‘ messages
periodically until a lost packet is retransmitted or
intentionally dropped. Default value is 1.
</p>
</dd>
<dt><samp class="option">oheadbw=<var class="var">percents</var></samp></dt>
<dd><p>Recovery bandwidth overhead above input rate, in percents.
See <samp class="option">inputbw</samp>. Default value is 25%.
</p>
</dd>
<dt><samp class="option">passphrase=<var class="var">string</var></samp></dt>
<dd><p>HaiCrypt Encryption/Decryption Passphrase string, length
from 10 to 79 characters. The passphrase is the shared
secret between the sender and the receiver. It is used
to generate the Key Encrypting Key using PBKDF2
(Password-Based Key Derivation Function). It is used
only if <samp class="option">pbkeylen</samp> is non-zero. It is used on
the receiver only if the received data is encrypted.
The configured passphrase cannot be recovered (write-only).
</p>
</dd>
<dt><samp class="option">enforced_encryption=<var class="var">1|0</var></samp></dt>
<dd><p>If true, both connection parties must have the same password
set (including empty, that is, with no encryption). If the
password doesn’t match or only one side is unencrypted,
the connection is rejected. Default is true.
</p>
</dd>
<dt><samp class="option">kmrefreshrate=<var class="var">packets</var></samp></dt>
<dd><p>The number of packets to be transmitted after which the
encryption key is switched to a new key. Default is -1.
-1 means auto (0x1000000 in srt library). The range for
this option is integers in the 0 - <code class="code">INT_MAX</code>.
</p>
</dd>
<dt><samp class="option">kmpreannounce=<var class="var">packets</var></samp></dt>
<dd><p>The interval between when a new encryption key is sent and
when switchover occurs. This value also applies to the
subsequent interval between when switchover occurs and
when the old encryption key is decommissioned. Default is -1.
-1 means auto (0x1000 in srt library). The range for
this option is integers in the 0 - <code class="code">INT_MAX</code>.
</p>
</dd>
<dt><samp class="option">snddropdelay=<var class="var">microseconds</var></samp></dt>
<dd><p>The sender’s extra delay before dropping packets. This delay is
added to the default drop delay time interval value.
</p>
<p>Special value -1: Do not drop packets on the sender at all.
</p>
</dd>
<dt><samp class="option">payload_size=<var class="var">bytes</var></samp></dt>
<dd><p>Sets the maximum declared size of a packet transferred
during the single call to the sending function in Live
mode. Use 0 if this value isn’t used (which is default in
file mode).
Default is -1 (automatic), which typically means MPEG-TS;
if you are going to use SRT
to send any different kind of payload, such as, for example,
wrapping a live stream in very small frames, then you can
use a bigger maximum frame size, though not greater than
1456 bytes.
</p>
</dd>
<dt><samp class="option">pkt_size=<var class="var">bytes</var></samp></dt>
<dd><p>Alias for ‘<samp class="samp">payload_size</samp>’.
</p>
</dd>
<dt><samp class="option">peerlatency=<var class="var">microseconds</var></samp></dt>
<dd><p>The latency value (as described in <samp class="option">rcvlatency</samp>) that is
set by the sender side as a minimum value for the receiver.
</p>
</dd>
<dt><samp class="option">pbkeylen=<var class="var">bytes</var></samp></dt>
<dd><p>Sender encryption key length, in bytes.
Only can be set to 0, 16, 24 and 32.
Enable sender encryption if not 0.
Not required on receiver (set to 0),
key size obtained from sender in HaiCrypt handshake.
Default value is 0.
</p>
</dd>
<dt><samp class="option">rcvlatency=<var class="var">microseconds</var></samp></dt>
<dd><p>The time that should elapse since the moment when the
packet was sent and the moment when it’s delivered to
the receiver application in the receiving function.
This time should be a buffer time large enough to cover
the time spent for sending, unexpectedly extended RTT
time, and the time needed to retransmit the lost UDP
packet. The effective latency value will be the maximum
of this options’ value and the value of <samp class="option">peerlatency</samp>
set by the peer side. Before version 1.3.0 this option
is only available as <samp class="option">latency</samp>.
</p>
</dd>
<dt><samp class="option">recv_buffer_size=<var class="var">bytes</var></samp></dt>
<dd><p>Set UDP receive buffer size, expressed in bytes.
</p>
</dd>
<dt><samp class="option">send_buffer_size=<var class="var">bytes</var></samp></dt>
<dd><p>Set UDP send buffer size, expressed in bytes.
</p>
</dd>
<dt><samp class="option">timeout=<var class="var">microseconds</var></samp></dt>
<dd><p>Set raise error timeouts for read, write and connect operations. Note that the
SRT library has internal timeouts which can be controlled separately, the
value set here is only a cap on those.
</p>
</dd>
<dt><samp class="option">tlpktdrop=<var class="var">1|0</var></samp></dt>
<dd><p>Too-late Packet Drop. When enabled on receiver, it skips
missing packets that have not been delivered in time and
delivers the following packets to the application when
their time-to-play has come. It also sends a fake ACK to
the sender. When enabled on sender and enabled on the
receiving peer, the sender drops the older packets that
have no chance of being delivered in time. It was
automatically enabled in the sender if the receiver
supports it.
</p>
</dd>
<dt><samp class="option">sndbuf=<var class="var">bytes</var></samp></dt>
<dd><p>Set send buffer size, expressed in bytes.
</p>
</dd>
<dt><samp class="option">rcvbuf=<var class="var">bytes</var></samp></dt>
<dd><p>Set receive buffer size, expressed in bytes.
</p>
<p>Receive buffer must not be greater than <samp class="option">ffs</samp>.
</p>
</dd>
<dt><samp class="option">lossmaxttl=<var class="var">packets</var></samp></dt>
<dd><p>The value up to which the Reorder Tolerance may grow. When
Reorder Tolerance is > 0, then packet loss report is delayed
until that number of packets come in. Reorder Tolerance
increases every time a "belated" packet has come, but it
wasn’t due to retransmission (that is, when UDP packets tend
to come out of order), with the difference between the latest
sequence and this packet’s sequence, and not more than the
value of this option. By default it’s 0, which means that this
mechanism is turned off, and the loss report is always sent
immediately upon experiencing a "gap" in sequences.
</p>
</dd>
<dt><samp class="option">minversion</samp></dt>
<dd><p>The minimum SRT version that is required from the peer. A connection
to a peer that does not satisfy the minimum version requirement
will be rejected.
</p>
<p>The version format in hex is 0xXXYYZZ for x.y.z in human readable
form.
</p>
</dd>
<dt><samp class="option">streamid=<var class="var">string</var></samp></dt>
<dd><p>A string limited to 512 characters that can be set on the socket prior
to connecting. This stream ID will be able to be retrieved by the
listener side from the socket that is returned from srt_accept and
was connected by a socket with that set stream ID. SRT does not enforce
any special interpretation of the contents of this string.
This option doesn’t make sense in Rendezvous connection; the result
might be that simply one side will override the value from the other
side and it’s the matter of luck which one would win
</p>
</dd>
<dt><samp class="option">srt_streamid=<var class="var">string</var></samp></dt>
<dd><p>Alias for ‘<samp class="samp">streamid</samp>’ to avoid conflict with ffmpeg command line option.
</p>
</dd>
<dt><samp class="option">smoother=<var class="var">live|file</var></samp></dt>
<dd><p>The type of Smoother used for the transmission for that socket, which
is responsible for the transmission and congestion control. The Smoother
type must be exactly the same on both connecting parties, otherwise
the connection is rejected.
</p>
</dd>
<dt><samp class="option">messageapi=<var class="var">1|0</var></samp></dt>
<dd><p>When set, this socket uses the Message API, otherwise it uses Buffer
API. Note that in live mode (see <samp class="option">transtype</samp>) there’s only
message API available. In File mode you can chose to use one of two modes:
</p>
<p>Stream API (default, when this option is false). In this mode you may
send as many data as you wish with one sending instruction, or even use
dedicated functions that read directly from a file. The internal facility
will take care of any speed and congestion control. When receiving, you
can also receive as many data as desired, the data not extracted will be
waiting for the next call. There is no boundary between data portions in
the Stream mode.
</p>
<p>Message API. In this mode your single sending instruction passes exactly
one piece of data that has boundaries (a message). Contrary to Live mode,
this message may span across multiple UDP packets and the only size
limitation is that it shall fit as a whole in the sending buffer. The
receiver shall use as large buffer as necessary to receive the message,
otherwise the message will not be given up. When the message is not
complete (not all packets received or there was a packet loss) it will
not be given up.
</p>
</dd>
<dt><samp class="option">transtype=<var class="var">live|file</var></samp></dt>
<dd><p>Sets the transmission type for the socket, in particular, setting this
option sets multiple other parameters to their default values as required
for a particular transmission type.
</p>
<p>live: Set options as for live transmission. In this mode, you should
send by one sending instruction only so many data that fit in one UDP packet,
and limited to the value defined first in <samp class="option">payload_size</samp> (1316 is
default in this mode). There is no speed control in this mode, only the
bandwidth control, if configured, in order to not exceed the bandwidth with
the overhead transmission (retransmitted and control packets).
</p>
<p>file: Set options as for non-live transmission. See <samp class="option">messageapi</samp>
for further explanations
</p>
</dd>
<dt><samp class="option">linger=<var class="var">seconds</var></samp></dt>
<dd><p>The number of seconds that the socket waits for unsent data when closing.
Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180
seconds in file mode). The range for this option is integers in the
0 - <code class="code">INT_MAX</code>.
</p>
</dd>
<dt><samp class="option">tsbpd=<var class="var">1|0</var></samp></dt>
<dd><p>When true, use Timestamp-based Packet Delivery mode. The default behavior
depends on the transmission type: enabled in live mode, disabled in file
mode.
</p>
</dd>
</dl>
<p>For more information see: <a class="url" href="https://github.com/Haivision/srt">https://github.com/Haivision/srt</a>.
</p>
</div>
<div class="section-level-extent" id="srtp">
<h3 class="section">16.38 srtp</h3>
<p>Secure Real-time Transport Protocol.
</p>
<p>The accepted options are:
</p><dl class="table">
<dt><samp class="option">srtp_in_suite</samp></dt>
<dt><samp class="option">srtp_out_suite</samp></dt>
<dd><p>Select input and output encoding suites.
</p>
<p>Supported values:
</p><dl class="table">
<dt>‘<samp class="samp">AES_CM_128_HMAC_SHA1_80</samp>’</dt>
<dt>‘<samp class="samp">SRTP_AES128_CM_HMAC_SHA1_80</samp>’</dt>
<dt>‘<samp class="samp">AES_CM_128_HMAC_SHA1_32</samp>’</dt>
<dt>‘<samp class="samp">SRTP_AES128_CM_HMAC_SHA1_32</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">srtp_in_params</samp></dt>
<dt><samp class="option">srtp_out_params</samp></dt>
<dd><p>Set input and output encoding parameters, which are expressed by a
base64-encoded representation of a binary block. The first 16 bytes of
this binary block are used as master key, the following 14 bytes are
used as master salt.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="subfile">
<h3 class="section">16.39 subfile</h3>
<p>Virtually extract a segment of a file or another stream.
The underlying stream must be seekable.
</p>
<p>Accepted options:
</p><dl class="table">
<dt><samp class="option">start</samp></dt>
<dd><p>Start offset of the extracted segment, in bytes.
</p></dd>
<dt><samp class="option">end</samp></dt>
<dd><p>End offset of the extracted segment, in bytes.
If set to 0, extract till end of file.
</p></dd>
</dl>
<p>Examples:
</p>
<p>Extract a chapter from a DVD VOB file (start and end sectors obtained
externally and multiplied by 2048):
</p><div class="example">
<pre class="example-preformatted">subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
</pre></div>
<p>Play an AVI file directly from a TAR archive:
</p><div class="example">
<pre class="example-preformatted">subfile,,start,183241728,end,366490624,,:archive.tar
</pre></div>
<p>Play a MPEG-TS file from start offset till end:
</p><div class="example">
<pre class="example-preformatted">subfile,,start,32815239,end,0,,:video.ts
</pre></div>
</div>
<div class="section-level-extent" id="tee">
<h3 class="section">16.40 tee</h3>
<p>Writes the output to multiple protocols. The individual outputs are separated
by |
</p>
<div class="example">
<pre class="example-preformatted">tee:file://path/to/local/this.avi|file://path/to/local/that.avi
</pre></div>
</div>
<div class="section-level-extent" id="tcp">
<h3 class="section">16.41 tcp</h3>
<p>Transmission Control Protocol.
</p>
<p>The required syntax for a TCP url is:
</p><div class="example">
<pre class="example-preformatted">tcp://<var class="var">hostname</var>:<var class="var">port</var>[?<var class="var">options</var>]
</pre></div>
<p><var class="var">options</var> contains a list of &-separated options of the form
<var class="var">key</var>=<var class="var">val</var>.
</p>
<p>The list of supported options follows.
</p>
<dl class="table">
<dt><samp class="option">listen=<var class="var">2|1|0</var></samp></dt>
<dd><p>Listen for an incoming connection. 0 disables listen, 1 enables listen in
single client mode, 2 enables listen in multi-client mode. Default value is 0.
</p>
</dd>
<dt><samp class="option">local_addr=<var class="var">addr</var></samp></dt>
<dd><p>Local IP address of a network interface used for tcp socket connect.
</p>
</dd>
<dt><samp class="option">local_port=<var class="var">port</var></samp></dt>
<dd><p>Local port used for tcp socket connect.
</p>
</dd>
<dt><samp class="option">timeout=<var class="var">microseconds</var></samp></dt>
<dd><p>Set raise error timeout, expressed in microseconds.
</p>
<p>This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
</p>
</dd>
<dt><samp class="option">listen_timeout=<var class="var">milliseconds</var></samp></dt>
<dd><p>Set listen timeout, expressed in milliseconds.
</p>
</dd>
<dt><samp class="option">recv_buffer_size=<var class="var">bytes</var></samp></dt>
<dd><p>Set receive buffer size, expressed bytes.
</p>
</dd>
<dt><samp class="option">send_buffer_size=<var class="var">bytes</var></samp></dt>
<dd><p>Set send buffer size, expressed bytes.
</p>
</dd>
<dt><samp class="option">tcp_nodelay=<var class="var">1|0</var></samp></dt>
<dd><p>Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0.
</p>
<p><em class="emph">Remark: Writing to the socket is currently not optimized to minimize system calls and reduces the efficiency / effect of TCP_NODELAY.</em>
</p>
</dd>
<dt><samp class="option">tcp_mss=<var class="var">bytes</var></samp></dt>
<dd><p>Set maximum segment size for outgoing TCP packets, expressed in bytes.
</p></dd>
</dl>
<p>The following example shows how to setup a listening TCP connection
with <code class="command">ffmpeg</code>, which is then accessed with <code class="command">ffplay</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i <var class="var">input</var> -f <var class="var">format</var> tcp://<var class="var">hostname</var>:<var class="var">port</var>?listen
ffplay tcp://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
</div>
<div class="section-level-extent" id="tls">
<h3 class="section">16.42 tls</h3>
<p>Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
</p>
<p>The required syntax for a TLS/SSL url is:
</p><div class="example">
<pre class="example-preformatted">tls://<var class="var">hostname</var>:<var class="var">port</var>[?<var class="var">options</var>]
</pre></div>
<p>The following parameters can be set via command line options
(or in code via <code class="code">AVOption</code>s):
</p>
<dl class="table">
<dt><samp class="option">ca_file, cafile=<var class="var">filename</var></samp></dt>
<dd><p>A file containing certificate authority (CA) root certificates to treat
as trusted. If the linked TLS library contains a default this might not
need to be specified for verification to work, but not all libraries and
setups have defaults built in.
The file must be in OpenSSL PEM format.
</p>
</dd>
<dt><samp class="option">tls_verify=<var class="var">1|0</var></samp></dt>
<dd><p>If enabled, try to verify the peer that we are communicating with.
Note, if using OpenSSL, this currently only makes sure that the
peer certificate is signed by one of the root certificates in the CA
database, but it does not validate that the certificate actually
matches the host name we are trying to connect to. (With other backends,
the host name is validated as well.)
</p>
<p>This is disabled by default since it requires a CA database to be
provided by the caller in many cases.
</p>
</dd>
<dt><samp class="option">cert_file, cert=<var class="var">filename</var></samp></dt>
<dd><p>A file containing a certificate to use in the handshake with the peer.
(When operating as server, in listen mode, this is more often required
by the peer, while client certificates only are mandated in certain
setups.)
</p>
</dd>
<dt><samp class="option">key_file, key=<var class="var">filename</var></samp></dt>
<dd><p>A file containing the private key for the certificate.
</p>
</dd>
<dt><samp class="option">listen=<var class="var">1|0</var></samp></dt>
<dd><p>If enabled, listen for connections on the provided port, and assume
the server role in the handshake instead of the client role.
</p>
</dd>
<dt><samp class="option">http_proxy</samp></dt>
<dd><p>The HTTP proxy to tunnel through, e.g. <code class="code">http://example.com:1234</code>.
The proxy must support the CONNECT method.
</p>
</dd>
</dl>
<p>Example command lines:
</p>
<p>To create a TLS/SSL server that serves an input stream.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i <var class="var">input</var> -f <var class="var">format</var> tls://<var class="var">hostname</var>:<var class="var">port</var>?listen&cert=<var class="var">server.crt</var>&key=<var class="var">server.key</var>
</pre></div>
<p>To play back a stream from the TLS/SSL server using <code class="command">ffplay</code>:
</p>
<div class="example">
<pre class="example-preformatted">ffplay tls://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
</div>
<div class="section-level-extent" id="udp">
<h3 class="section">16.43 udp</h3>
<p>User Datagram Protocol.
</p>
<p>The required syntax for an UDP URL is:
</p><div class="example">
<pre class="example-preformatted">udp://<var class="var">hostname</var>:<var class="var">port</var>[?<var class="var">options</var>]
</pre></div>
<p><var class="var">options</var> contains a list of &-separated options of the form <var class="var">key</var>=<var class="var">val</var>.
</p>
<p>In case threading is enabled on the system, a circular buffer is used
to store the incoming data, which allows one to reduce loss of data due to
UDP socket buffer overruns. The <var class="var">fifo_size</var> and
<var class="var">overrun_nonfatal</var> options are related to this buffer.
</p>
<p>The list of supported options follows.
</p>
<dl class="table">
<dt><samp class="option">buffer_size=<var class="var">size</var></samp></dt>
<dd><p>Set the UDP maximum socket buffer size in bytes. This is used to set either
the receive or send buffer size, depending on what the socket is used for.
Default is 32 KB for output, 384 KB for input. See also <var class="var">fifo_size</var>.
</p>
</dd>
<dt><samp class="option">bitrate=<var class="var">bitrate</var></samp></dt>
<dd><p>If set to nonzero, the output will have the specified constant bitrate if the
input has enough packets to sustain it.
</p>
</dd>
<dt><samp class="option">burst_bits=<var class="var">bits</var></samp></dt>
<dd><p>When using <var class="var">bitrate</var> this specifies the maximum number of bits in
packet bursts.
</p>
</dd>
<dt><samp class="option">localport=<var class="var">port</var></samp></dt>
<dd><p>Override the local UDP port to bind with.
</p>
</dd>
<dt><samp class="option">localaddr=<var class="var">addr</var></samp></dt>
<dd><p>Local IP address of a network interface used for sending packets or joining
multicast groups.
</p>
</dd>
<dt><samp class="option">pkt_size=<var class="var">size</var></samp></dt>
<dd><p>Set the size in bytes of UDP packets.
</p>
</dd>
<dt><samp class="option">reuse=<var class="var">1|0</var></samp></dt>
<dd><p>Explicitly allow or disallow reusing UDP sockets.
</p>
</dd>
<dt><samp class="option">ttl=<var class="var">ttl</var></samp></dt>
<dd><p>Set the time to live value (for multicast only).
</p>
</dd>
<dt><samp class="option">connect=<var class="var">1|0</var></samp></dt>
<dd><p>Initialize the UDP socket with <code class="code">connect()</code>. In this case, the
destination address can’t be changed with ff_udp_set_remote_url later.
If the destination address isn’t known at the start, this option can
be specified in ff_udp_set_remote_url, too.
This allows finding out the source address for the packets with getsockname,
and makes writes return with AVERROR(ECONNREFUSED) if "destination
unreachable" is received.
For receiving, this gives the benefit of only receiving packets from
the specified peer address/port.
</p>
</dd>
<dt><samp class="option">sources=<var class="var">address</var>[,<var class="var">address</var>]</samp></dt>
<dd><p>Only receive packets sent from the specified addresses. In case of multicast,
also subscribe to multicast traffic coming from these addresses only.
</p>
</dd>
<dt><samp class="option">block=<var class="var">address</var>[,<var class="var">address</var>]</samp></dt>
<dd><p>Ignore packets sent from the specified addresses. In case of multicast, also
exclude the source addresses in the multicast subscription.
</p>
</dd>
<dt><samp class="option">fifo_size=<var class="var">units</var></samp></dt>
<dd><p>Set the UDP receiving circular buffer size, expressed as a number of
packets with size of 188 bytes. If not specified defaults to 7*4096.
</p>
</dd>
<dt><samp class="option">overrun_nonfatal=<var class="var">1|0</var></samp></dt>
<dd><p>Survive in case of UDP receiving circular buffer overrun. Default
value is 0.
</p>
</dd>
<dt><samp class="option">timeout=<var class="var">microseconds</var></samp></dt>
<dd><p>Set raise error timeout, expressed in microseconds.
</p>
<p>This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
</p>
</dd>
<dt><samp class="option">broadcast=<var class="var">1|0</var></samp></dt>
<dd><p>Explicitly allow or disallow UDP broadcasting.
</p>
<p>Note that broadcasting may not work properly on networks having
a broadcast storm protection.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-6" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-6">
<h4 class="subsection">16.43.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use <code class="command">ffmpeg</code> to stream over UDP to a remote endpoint:
<div class="example">
<pre class="example-preformatted">ffmpeg -i <var class="var">input</var> -f <var class="var">format</var> udp://<var class="var">hostname</var>:<var class="var">port</var>
</pre></div>
</li><li>Use <code class="command">ffmpeg</code> to stream in mpegts format over UDP using 188
sized UDP packets, using a large input buffer:
<div class="example">
<pre class="example-preformatted">ffmpeg -i <var class="var">input</var> -f mpegts udp://<var class="var">hostname</var>:<var class="var">port</var>?pkt_size=188&buffer_size=65535
</pre></div>
</li><li>Use <code class="command">ffmpeg</code> to receive over UDP from a remote endpoint:
<div class="example">
<pre class="example-preformatted">ffmpeg -i udp://[<var class="var">multicast-address</var>]:<var class="var">port</var> ...
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="unix">
<h3 class="section">16.44 unix</h3>
<p>Unix local socket
</p>
<p>The required syntax for a Unix socket URL is:
</p>
<div class="example">
<pre class="example-preformatted">unix://<var class="var">filepath</var>
</pre></div>
<p>The following parameters can be set via command line options
(or in code via <code class="code">AVOption</code>s):
</p>
<dl class="table">
<dt><samp class="option">timeout</samp></dt>
<dd><p>Timeout in ms.
</p></dd>
<dt><samp class="option">listen</samp></dt>
<dd><p>Create the Unix socket in listening mode.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="zmq">
<h3 class="section">16.45 zmq</h3>
<p>ZeroMQ asynchronous messaging using the libzmq library.
</p>
<p>This library supports unicast streaming to multiple clients without relying on
an external server.
</p>
<p>The required syntax for streaming or connecting to a stream is:
</p><div class="example">
<pre class="example-preformatted">zmq:tcp://ip-address:port
</pre></div>
<p>Example:
Create a localhost stream on port 5555:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
</pre></div>
<p>Multiple clients may connect to the stream using:
</p><div class="example">
<pre class="example-preformatted">ffplay zmq:tcp://127.0.0.1:5555
</pre></div>
<p>Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern.
The server side binds to a port and publishes data. Clients connect to the
server (via IP address/port) and subscribe to the stream. The order in which
the server and client start generally does not matter.
</p>
<p>ffmpeg must be compiled with the –enable-libzmq option to support
this protocol.
</p>
<p>Options can be set on the <code class="command">ffmpeg</code>/<code class="command">ffplay</code> command
line. The following options are supported:
</p>
<dl class="table">
<dt><samp class="option">pkt_size</samp></dt>
<dd><p>Forces the maximum packet size for sending/receiving data. The default value is
131,072 bytes. On the server side, this sets the maximum size of sent packets
via ZeroMQ. On the clients, it sets an internal buffer size for receiving
packets. Note that pkt_size on the clients should be equal to or greater than
pkt_size on the server. Otherwise the received message may be truncated causing
decoding errors.
</p>
</dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="Device-Options">
<h2 class="chapter">17 Device Options</h2>
<p>The libavdevice library provides the same interface as
libavformat. Namely, an input device is considered like a demuxer, and
an output device like a muxer, and the interface and generic device
options are the same provided by libavformat (see the ffmpeg-formats
manual).
</p>
<p>In addition each input or output device may support so-called private
options, which are specific for that component.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, or by setting the value explicitly in the device
<code class="code">AVFormatContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API
for programmatic use.
</p>
</div>
<div class="chapter-level-extent" id="Input-Devices">
<h2 class="chapter">18 Input Devices</h2>
<p>Input devices are configured elements in FFmpeg which enable accessing
the data coming from a multimedia device attached to your system.
</p>
<p>When you configure your FFmpeg build, all the supported input devices
are enabled by default. You can list all available ones using the
configure option "–list-indevs".
</p>
<p>You can disable all the input devices using the configure option
"–disable-indevs", and selectively enable an input device using the
option "–enable-indev=<var class="var">INDEV</var>", or you can disable a particular
input device using the option "–disable-indev=<var class="var">INDEV</var>".
</p>
<p>The option "-devices" of the ff* tools will display the list of
supported input devices.
</p>
<p>A description of the currently available input devices follows.
</p>
<ul class="mini-toc">
<li><a href="#alsa" accesskey="1">alsa</a></li>
<li><a href="#android_005fcamera" accesskey="2">android_camera</a></li>
<li><a href="#avfoundation" accesskey="3">avfoundation</a></li>
<li><a href="#bktr" accesskey="4">bktr</a></li>
<li><a href="#decklink" accesskey="5">decklink</a></li>
<li><a href="#dshow" accesskey="6">dshow</a></li>
<li><a href="#fbdev" accesskey="7">fbdev</a></li>
<li><a href="#gdigrab" accesskey="8">gdigrab</a></li>
<li><a href="#iec61883" accesskey="9">iec61883</a></li>
<li><a href="#jack">jack</a></li>
<li><a href="#kmsgrab">kmsgrab</a></li>
<li><a href="#lavfi">lavfi</a></li>
<li><a href="#libcdio">libcdio</a></li>
<li><a href="#libdc1394">libdc1394</a></li>
<li><a href="#openal">openal</a></li>
<li><a href="#oss">oss</a></li>
<li><a href="#pulse">pulse</a></li>
<li><a href="#sndio">sndio</a></li>
<li><a href="#video4linux2_002c-v4l2">video4linux2, v4l2</a></li>
<li><a href="#vfwcap">vfwcap</a></li>
<li><a href="#x11grab">x11grab</a></li>
</ul>
<div class="section-level-extent" id="alsa">
<h3 class="section">18.1 alsa</h3>
<p>ALSA (Advanced Linux Sound Architecture) input device.
</p>
<p>To enable this input device during configuration you need libasound
installed on your system.
</p>
<p>This device allows capturing from an ALSA device. The name of the
device to capture has to be an ALSA card identifier.
</p>
<p>An ALSA identifier has the syntax:
</p><div class="example">
<pre class="example-preformatted">hw:<var class="var">CARD</var>[,<var class="var">DEV</var>[,<var class="var">SUBDEV</var>]]
</pre></div>
<p>where the <var class="var">DEV</var> and <var class="var">SUBDEV</var> components are optional.
</p>
<p>The three arguments (in order: <var class="var">CARD</var>,<var class="var">DEV</var>,<var class="var">SUBDEV</var>)
specify card number or identifier, device number and subdevice number
(-1 means any).
</p>
<p>To see the list of cards currently recognized by your system check the
files <samp class="file">/proc/asound/cards</samp> and <samp class="file">/proc/asound/devices</samp>.
</p>
<p>For example to capture with <code class="command">ffmpeg</code> from an ALSA device with
card id 0, you may run the command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f alsa -i hw:0 alsaout.wav
</pre></div>
<p>For more information see:
<a class="url" href="http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html">http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html</a>
</p>
<ul class="mini-toc">
<li><a href="#Options-14" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-14">
<h4 class="subsection">18.1.1 Options</h4>
<dl class="table">
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="android_005fcamera">
<h3 class="section">18.2 android_camera</h3>
<p>Android camera input device.
</p>
<p>This input devices uses the Android Camera2 NDK API which is
available on devices with API level 24+. The availability of
android_camera is autodetected during configuration.
</p>
<p>This device allows capturing from all cameras on an Android device,
which are integrated into the Camera2 NDK API.
</p>
<p>The available cameras are enumerated internally and can be selected
with the <var class="var">camera_index</var> parameter. The input file string is
discarded.
</p>
<p>Generally the back facing camera has index 0 while the front facing
camera has index 1.
</p>
<ul class="mini-toc">
<li><a href="#Options-15" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-15">
<h4 class="subsection">18.2.1 Options</h4>
<dl class="table">
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video size given as a string such as 640x480 or hd720.
Falls back to the first available configuration reported by
Android if requested video size is not available or by default.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the video framerate.
Falls back to the first available configuration reported by
Android if requested framerate is not available or by default (-1).
</p>
</dd>
<dt><samp class="option">camera_index</samp></dt>
<dd><p>Set the index of the camera to use. Default is 0.
</p>
</dd>
<dt><samp class="option">input_queue_size</samp></dt>
<dd><p>Set the maximum number of frames to buffer. Default is 5.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="avfoundation">
<h3 class="section">18.3 avfoundation</h3>
<p>AVFoundation input device.
</p>
<p>AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
</p>
<p>The input filename has to be given in the following syntax:
</p><div class="example">
<pre class="example-preformatted">-i "[[VIDEO]:[AUDIO]]"
</pre></div>
<p>The first entry selects the video input while the latter selects the audio input.
The stream has to be specified by the device name or the device index as shown by the device list.
Alternatively, the video and/or audio input device can be chosen by index using the
<samp class="option">
-video_device_index <INDEX>
</samp>
and/or
<samp class="option">
-audio_device_index <INDEX>
</samp>
, overriding any
device name or index given in the input filename.
</p>
<p>All available devices can be enumerated by using <samp class="option">-list_devices true</samp>, listing
all device names and corresponding indices.
</p>
<p>There are two device name aliases:
</p><dl class="table">
<dt><code class="code">default</code></dt>
<dd><p>Select the AVFoundation default device of the corresponding type.
</p>
</dd>
<dt><code class="code">none</code></dt>
<dd><p>Do not record the corresponding media type.
This is equivalent to specifying an empty device name or index.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Options-16" accesskey="1">Options</a></li>
<li><a href="#Examples-7" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-16">
<h4 class="subsection">18.3.1 Options</h4>
<p>AVFoundation supports the following options:
</p>
<dl class="table">
<dt><samp class="option">-list_devices <TRUE|FALSE></samp></dt>
<dd><p>If set to true, a list of all available input devices is given showing all
device names and indices.
</p>
</dd>
<dt><samp class="option">-video_device_index <INDEX></samp></dt>
<dd><p>Specify the video device by its index. Overrides anything given in the input filename.
</p>
</dd>
<dt><samp class="option">-audio_device_index <INDEX></samp></dt>
<dd><p>Specify the audio device by its index. Overrides anything given in the input filename.
</p>
</dd>
<dt><samp class="option">-pixel_format <FORMAT></samp></dt>
<dd><p>Request the video device to use a specific pixel format.
If the specified format is not supported, a list of available formats is given
and the first one in this list is used instead. Available pixel formats are:
<code class="code">monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
yuv420p, nv12, yuyv422, gray</code>
</p>
</dd>
<dt><samp class="option">-framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default is <code class="code">ntsc</code>, corresponding to a
frame rate of <code class="code">30000/1001</code>.
</p>
</dd>
<dt><samp class="option">-video_size</samp></dt>
<dd><p>Set the video frame size.
</p>
</dd>
<dt><samp class="option">-capture_cursor</samp></dt>
<dd><p>Capture the mouse pointer. Default is 0.
</p>
</dd>
<dt><samp class="option">-capture_mouse_clicks</samp></dt>
<dd><p>Capture the screen mouse clicks. Default is 0.
</p>
</dd>
<dt><samp class="option">-capture_raw_data</samp></dt>
<dd><p>Capture the raw device data. Default is 0.
Using this option may result in receiving the underlying data delivered to the AVFoundation framework. E.g. for muxed devices that sends raw DV data to the framework (like tape-based camcorders), setting this option to false results in extracted video frames captured in the designated pixel format only. Setting this option to true results in receiving the raw DV stream untouched.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-7">
<h4 class="subsection">18.3.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Print the list of AVFoundation supported devices and exit:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f avfoundation -list_devices true -i ""
</pre></div>
</li><li>Record video from video device 0 and audio from audio device 0 into out.avi:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f avfoundation -i "0:0" out.avi
</pre></div>
</li><li>Record video from video device 2 and audio from audio device 1 into out.avi:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
</pre></div>
</li><li>Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
</pre></div>
</li><li>Record raw DV data from a suitable input device and write the output into out.dv:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f avfoundation -capture_raw_data true -i "zr100:none" out.dv
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="bktr">
<h3 class="section">18.4 bktr</h3>
<p>BSD video input device.
</p>
<ul class="mini-toc">
<li><a href="#Options-17" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-17">
<h4 class="subsection">18.4.1 Options</h4>
<dl class="table">
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the frame rate.
</p>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video frame size. Default is <code class="code">vga</code>.
</p>
</dd>
<dt><samp class="option">standard</samp></dt>
<dd>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">pal</samp>’</dt>
<dt>‘<samp class="samp">ntsc</samp>’</dt>
<dt>‘<samp class="samp">secam</samp>’</dt>
<dt>‘<samp class="samp">paln</samp>’</dt>
<dt>‘<samp class="samp">palm</samp>’</dt>
<dt>‘<samp class="samp">ntscj</samp>’</dt>
</dl>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="decklink">
<h3 class="section">18.5 decklink</h3>
<p>The decklink input device provides capture capabilities for Blackmagic
DeckLink devices.
</p>
<p>To enable this input device, you need the Blackmagic DeckLink SDK and you
need to configure with the appropriate <code class="code">--extra-cflags</code>
and <code class="code">--extra-ldflags</code>.
On Windows, you need to run the IDL files through <code class="command">widl</code>.
</p>
<p>DeckLink is very picky about the formats it supports. Pixel format of the
input can be set with <samp class="option">raw_format</samp>.
Framerate and video size must be determined for your device with
<code class="command">-list_formats 1</code>. Audio sample rate is always 48 kHz and the number
of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single
audio track.
</p>
<ul class="mini-toc">
<li><a href="#Options-18" accesskey="1">Options</a></li>
<li><a href="#Examples-8" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-18">
<h4 class="subsection">18.5.1 Options</h4>
<dl class="table">
<dt><samp class="option">list_devices</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, print a list of devices and exit.
Defaults to <samp class="option">false</samp>. This option is deprecated, please use the
<code class="code">-sources</code> option of ffmpeg to list the available input devices.
</p>
</dd>
<dt><samp class="option">list_formats</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, print a list of supported formats and exit.
Defaults to <samp class="option">false</samp>.
</p>
</dd>
<dt><samp class="option">format_code <FourCC></samp></dt>
<dd><p>This sets the input video format to the format given by the FourCC. To see
the supported values of your device(s) use <samp class="option">list_formats</samp>.
Note that there is a FourCC <samp class="option">'pal '</samp> that can also be used
as <samp class="option">pal</samp> (3 letters).
Default behavior is autodetection of the input video format, if the hardware
supports it.
</p>
</dd>
<dt><samp class="option">raw_format</samp></dt>
<dd><p>Set the pixel format of the captured video.
Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd>
<p>This is the default which means 8-bit YUV 422 or 8-bit ARGB if format
autodetection is used, 8-bit YUV 422 otherwise.
</p>
</dd>
<dt>‘<samp class="samp">uyvy422</samp>’</dt>
<dd>
<p>8-bit YUV 422.
</p>
</dd>
<dt>‘<samp class="samp">yuv422p10</samp>’</dt>
<dd>
<p>10-bit YUV 422.
</p>
</dd>
<dt>‘<samp class="samp">argb</samp>’</dt>
<dd>
<p>8-bit RGB.
</p>
</dd>
<dt>‘<samp class="samp">bgra</samp>’</dt>
<dd>
<p>8-bit RGB.
</p>
</dd>
<dt>‘<samp class="samp">rgb10</samp>’</dt>
<dd>
<p>10-bit RGB.
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">teletext_lines</samp></dt>
<dd><p>If set to nonzero, an additional teletext stream will be captured from the
vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p)
sources are supported. In case of HD sources, OP47 packets are decoded.
</p>
<p>This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6
to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines
which do not contain teletext information will be ignored. You can use the
special <samp class="option">all</samp> constant to select all possible lines, or
<samp class="option">standard</samp> to skip lines 6, 318 and 319, which are not compatible with
all receivers.
</p>
<p>For SD sources, ffmpeg needs to be compiled with <code class="code">--enable-libzvbi</code>. For
HD sources, on older (pre-4K) DeckLink card models you have to capture in 10
bit mode.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Defines number of audio channels to capture. Must be ‘<samp class="samp">2</samp>’, ‘<samp class="samp">8</samp>’ or ‘<samp class="samp">16</samp>’.
Defaults to ‘<samp class="samp">2</samp>’.
</p>
</dd>
<dt><samp class="option">duplex_mode</samp></dt>
<dd><p>Sets the decklink device duplex/profile mode. Must be ‘<samp class="samp">unset</samp>’, ‘<samp class="samp">half</samp>’, ‘<samp class="samp">full</samp>’,
‘<samp class="samp">one_sub_device_full</samp>’, ‘<samp class="samp">one_sub_device_half</samp>’, ‘<samp class="samp">two_sub_device_full</samp>’,
‘<samp class="samp">four_sub_device_half</samp>’
Defaults to ‘<samp class="samp">unset</samp>’.
</p>
<p>Note: DeckLink SDK 11.0 have replaced the duplex property by a profile property.
For the DeckLink Duo 2 and DeckLink Quad 2, a profile is shared between any 2
sub-devices that utilize the same connectors. For the DeckLink 8K Pro, a profile
is shared between all 4 sub-devices. So DeckLink 8K Pro support four profiles.
</p>
<p>Valid profile modes for DeckLink 8K Pro(with DeckLink SDK >= 11.0):
‘<samp class="samp">one_sub_device_full</samp>’, ‘<samp class="samp">one_sub_device_half</samp>’, ‘<samp class="samp">two_sub_device_full</samp>’,
‘<samp class="samp">four_sub_device_half</samp>’
</p>
<p>Valid profile modes for DeckLink Quad 2 and DeckLink Duo 2:
‘<samp class="samp">half</samp>’, ‘<samp class="samp">full</samp>’
</p>
</dd>
<dt><samp class="option">timecode_format</samp></dt>
<dd><p>Timecode type to include in the frame and video stream metadata. Must be
‘<samp class="samp">none</samp>’, ‘<samp class="samp">rp188vitc</samp>’, ‘<samp class="samp">rp188vitc2</samp>’, ‘<samp class="samp">rp188ltc</samp>’,
‘<samp class="samp">rp188hfr</samp>’, ‘<samp class="samp">rp188any</samp>’, ‘<samp class="samp">vitc</samp>’, ‘<samp class="samp">vitc2</samp>’, or ‘<samp class="samp">serial</samp>’.
Defaults to ‘<samp class="samp">none</samp>’ (not included).
</p>
<p>In order to properly support 50/60 fps timecodes, the ordering of the queried
timecode types for ‘<samp class="samp">rp188any</samp>’ is HFR, VITC1, VITC2 and LTC for >30 fps
content. Note that this is slightly different to the ordering used by the
DeckLink API, which is HFR, VITC1, LTC, VITC2.
</p>
</dd>
<dt><samp class="option">video_input</samp></dt>
<dd><p>Sets the video input source. Must be ‘<samp class="samp">unset</samp>’, ‘<samp class="samp">sdi</samp>’, ‘<samp class="samp">hdmi</samp>’,
‘<samp class="samp">optical_sdi</samp>’, ‘<samp class="samp">component</samp>’, ‘<samp class="samp">composite</samp>’ or ‘<samp class="samp">s_video</samp>’.
Defaults to ‘<samp class="samp">unset</samp>’.
</p>
</dd>
<dt><samp class="option">audio_input</samp></dt>
<dd><p>Sets the audio input source. Must be ‘<samp class="samp">unset</samp>’, ‘<samp class="samp">embedded</samp>’,
‘<samp class="samp">aes_ebu</samp>’, ‘<samp class="samp">analog</samp>’, ‘<samp class="samp">analog_xlr</samp>’, ‘<samp class="samp">analog_rca</samp>’ or
‘<samp class="samp">microphone</samp>’. Defaults to ‘<samp class="samp">unset</samp>’.
</p>
</dd>
<dt><samp class="option">video_pts</samp></dt>
<dd><p>Sets the video packet timestamp source. Must be ‘<samp class="samp">video</samp>’, ‘<samp class="samp">audio</samp>’,
‘<samp class="samp">reference</samp>’, ‘<samp class="samp">wallclock</samp>’ or ‘<samp class="samp">abs_wallclock</samp>’.
Defaults to ‘<samp class="samp">video</samp>’.
</p>
</dd>
<dt><samp class="option">audio_pts</samp></dt>
<dd><p>Sets the audio packet timestamp source. Must be ‘<samp class="samp">video</samp>’, ‘<samp class="samp">audio</samp>’,
‘<samp class="samp">reference</samp>’, ‘<samp class="samp">wallclock</samp>’ or ‘<samp class="samp">abs_wallclock</samp>’.
Defaults to ‘<samp class="samp">audio</samp>’.
</p>
</dd>
<dt><samp class="option">draw_bars</samp></dt>
<dd><p>If set to ‘<samp class="samp">true</samp>’, color bars are drawn in the event of a signal loss.
Defaults to ‘<samp class="samp">true</samp>’.
</p>
</dd>
<dt><samp class="option">queue_size</samp></dt>
<dd><p>Sets maximum input buffer size in bytes. If the buffering reaches this value,
incoming frames will be dropped.
Defaults to ‘<samp class="samp">1073741824</samp>’.
</p>
</dd>
<dt><samp class="option">audio_depth</samp></dt>
<dd><p>Sets the audio sample bit depth. Must be ‘<samp class="samp">16</samp>’ or ‘<samp class="samp">32</samp>’.
Defaults to ‘<samp class="samp">16</samp>’.
</p>
</dd>
<dt><samp class="option">decklink_copyts</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, timestamps are forwarded as they are without removing
the initial offset.
Defaults to <samp class="option">false</samp>.
</p>
</dd>
<dt><samp class="option">timestamp_align</samp></dt>
<dd><p>Capture start time alignment in seconds. If set to nonzero, input frames are
dropped till the system timestamp aligns with configured value.
Alignment difference of up to one frame duration is tolerated.
This is useful for maintaining input synchronization across N different
hardware devices deployed for ’N-way’ redundancy. The system time of different
hardware devices should be synchronized with protocols such as NTP or PTP,
before using this option.
Note that this method is not foolproof. In some border cases input
synchronization may not happen due to thread scheduling jitters in the OS.
Either sync could go wrong by 1 frame or in a rarer case
<samp class="option">timestamp_align</samp> seconds.
Defaults to ‘<samp class="samp">0</samp>’.
</p>
</dd>
<dt><samp class="option">wait_for_tc (<em class="emph">bool</em>)</samp></dt>
<dd><p>Drop frames till a frame with timecode is received. Sometimes serial timecode
isn’t received with the first input frame. If that happens, the stored stream
timecode will be inaccurate. If this option is set to <samp class="option">true</samp>, input frames
are dropped till a frame with timecode is received.
Option <var class="var">timecode_format</var> must be specified.
Defaults to <samp class="option">false</samp>.
</p>
</dd>
<dt><samp class="option">enable_klv(<em class="emph">bool</em>)</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, extracts KLV data from VANC and outputs KLV packets.
KLV VANC packets are joined based on MID and PSC fields and aggregated into
one KLV packet.
Defaults to <samp class="option">false</samp>.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-8">
<h4 class="subsection">18.5.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>List input devices:
<div class="example">
<pre class="example-preformatted">ffmpeg -sources decklink
</pre></div>
</li><li>List supported formats:
<div class="example">
<pre class="example-preformatted">ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
</pre></div>
</li><li>Capture video clip at 1080i50:
<div class="example">
<pre class="example-preformatted">ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
</pre></div>
</li><li>Capture video clip at 1080i50 10 bit:
<div class="example">
<pre class="example-preformatted">ffmpeg -raw_format yuv422p10 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
</pre></div>
</li><li>Capture video clip at 1080i50 with 16 audio channels:
<div class="example">
<pre class="example-preformatted">ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="dshow">
<h3 class="section">18.6 dshow</h3>
<p>Windows DirectShow input device.
</p>
<p>DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
Currently only audio and video devices are supported.
</p>
<p>Multiple devices may be opened as separate inputs, but they may also be
opened on the same input, which should improve synchronism between them.
</p>
<p>The input name should be in the format:
</p>
<div class="example">
<pre class="example-preformatted"><var class="var">TYPE</var>=<var class="var">NAME</var>[:<var class="var">TYPE</var>=<var class="var">NAME</var>]
</pre></div>
<p>where <var class="var">TYPE</var> can be either <var class="var">audio</var> or <var class="var">video</var>,
and <var class="var">NAME</var> is the device’s name or alternative name..
</p>
<ul class="mini-toc">
<li><a href="#Options-19" accesskey="1">Options</a></li>
<li><a href="#Examples-9" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-19">
<h4 class="subsection">18.6.1 Options</h4>
<p>If no options are specified, the device’s defaults are used.
If the device does not support the requested options, it will
fail to open.
</p>
<dl class="table">
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video size in the captured video.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the frame rate in the captured video.
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate (in Hz) of the captured audio.
</p>
</dd>
<dt><samp class="option">sample_size</samp></dt>
<dd><p>Set the sample size (in bits) of the captured audio.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels in the captured audio.
</p>
</dd>
<dt><samp class="option">list_devices</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, print a list of devices and exit.
</p>
</dd>
<dt><samp class="option">list_options</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, print a list of selected device’s options
and exit.
</p>
</dd>
<dt><samp class="option">video_device_number</samp></dt>
<dd><p>Set video device number for devices with the same name (starts at 0,
defaults to 0).
</p>
</dd>
<dt><samp class="option">audio_device_number</samp></dt>
<dd><p>Set audio device number for devices with the same name (starts at 0,
defaults to 0).
</p>
</dd>
<dt><samp class="option">pixel_format</samp></dt>
<dd><p>Select pixel format to be used by DirectShow. This may only be set when
the video codec is not set or set to rawvideo.
</p>
</dd>
<dt><samp class="option">audio_buffer_size</samp></dt>
<dd><p>Set audio device buffer size in milliseconds (which can directly
impact latency, depending on the device).
Defaults to using the audio device’s
default buffer size (typically some multiple of 500ms).
Setting this value too low can degrade performance.
See also
<a class="url" href="http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx">http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx</a>
</p>
</dd>
<dt><samp class="option">video_pin_name</samp></dt>
<dd><p>Select video capture pin to use by name or alternative name.
</p>
</dd>
<dt><samp class="option">audio_pin_name</samp></dt>
<dd><p>Select audio capture pin to use by name or alternative name.
</p>
</dd>
<dt><samp class="option">crossbar_video_input_pin_number</samp></dt>
<dd><p>Select video input pin number for crossbar device. This will be
routed to the crossbar device’s Video Decoder output pin.
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
</p>
</dd>
<dt><samp class="option">crossbar_audio_input_pin_number</samp></dt>
<dd><p>Select audio input pin number for crossbar device. This will be
routed to the crossbar device’s Audio Decoder output pin.
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
</p>
</dd>
<dt><samp class="option">show_video_device_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display dialog
to the end user, allowing them to change video filter properties
and configurations manually.
Note that for crossbar devices, adjusting values in this dialog
may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
input frame rates, sizes, interlacing, etc. Changing these values can
enable different scan rates/frame rates and avoiding green bars at
the bottom, flickering scan lines, etc.
Note that with some devices, changing these properties can also affect future
invocations (sets new defaults) until system reboot occurs.
</p>
</dd>
<dt><samp class="option">show_audio_device_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display dialog
to the end user, allowing them to change audio filter properties
and configurations manually.
</p>
</dd>
<dt><samp class="option">show_video_crossbar_connection_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify crossbar pin routings, when it opens a video device.
</p>
</dd>
<dt><samp class="option">show_audio_crossbar_connection_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify crossbar pin routings, when it opens an audio device.
</p>
</dd>
<dt><samp class="option">show_analog_tv_tuner_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV channels and frequencies.
</p>
</dd>
<dt><samp class="option">show_analog_tv_tuner_audio_dialog</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV audio (like mono vs. stereo, Language A,B or C).
</p>
</dd>
<dt><samp class="option">audio_device_load</samp></dt>
<dd><p>Load an audio capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this an audio capture source has to be specified, but it can
be anything even fake one.
</p>
</dd>
<dt><samp class="option">audio_device_save</samp></dt>
<dd><p>Save the currently used audio capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.
</p>
</dd>
<dt><samp class="option">video_device_load</samp></dt>
<dd><p>Load a video capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this a video capture source has to be specified, but it can
be anything even fake one.
</p>
</dd>
<dt><samp class="option">video_device_save</samp></dt>
<dd><p>Save the currently used video capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.
</p>
</dd>
<dt><samp class="option">use_video_device_timestamps</samp></dt>
<dd><p>If set to <samp class="option">false</samp>, the timestamp for video frames will be
derived from the wallclock instead of the timestamp provided by
the capture device. This allows working around devices that
provide unreliable timestamps.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-9">
<h4 class="subsection">18.6.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Print the list of DirectShow supported devices and exit:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -list_devices true -f dshow -i dummy
</pre></div>
</li><li>Open video device <var class="var">Camera</var>:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f dshow -i video="Camera"
</pre></div>
</li><li>Open second video device with name <var class="var">Camera</var>:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
</pre></div>
</li><li>Open video device <var class="var">Camera</var> and audio device <var class="var">Microphone</var>:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f dshow -i video="Camera":audio="Microphone"
</pre></div>
</li><li>Print the list of supported options in selected device and exit:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -list_options true -f dshow -i video="Camera"
</pre></div>
</li><li>Specify pin names to capture by name or alternative name, specify alternative device name:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
</pre></div>
</li><li>Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
<div class="example">
<pre class="example-preformatted">$ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
-crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="fbdev">
<h3 class="section">18.7 fbdev</h3>
<p>Linux framebuffer input device.
</p>
<p>The Linux framebuffer is a graphic hardware-independent abstraction
layer to show graphics on a computer monitor, typically on the
console. It is accessed through a file device node, usually
<samp class="file">/dev/fb0</samp>.
</p>
<p>For more detailed information read the file
Documentation/fb/framebuffer.txt included in the Linux source tree.
</p>
<p>See also <a class="url" href="http://linux-fbdev.sourceforge.net/">http://linux-fbdev.sourceforge.net/</a>, and fbset(1).
</p>
<p>To record from the framebuffer device <samp class="file">/dev/fb0</samp> with
<code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
</pre></div>
<p>You can take a single screenshot image with the command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-20" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-20">
<h4 class="subsection">18.7.1 Options</h4>
<dl class="table">
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the frame rate. Default is 25.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="gdigrab">
<h3 class="section">18.8 gdigrab</h3>
<p>Win32 GDI-based screen capture device.
</p>
<p>This device allows you to capture a region of the display on Windows.
</p>
<p>There are two options for the input filename:
</p><div class="example">
<pre class="example-preformatted">desktop
</pre></div>
<p>or
</p><div class="example">
<pre class="example-preformatted">title=<var class="var">window_title</var>
</pre></div>
<p>The first option will capture the entire desktop, or a fixed region of the
desktop. The second option will instead capture the contents of a single
window, regardless of its position on the screen.
</p>
<p>For example, to grab the entire desktop using <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
</pre></div>
<p>Grab a 640x480 region at position <code class="code">10,20</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
</pre></div>
<p>Grab the contents of the window named "Calculator"
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-21" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-21">
<h4 class="subsection">18.8.1 Options</h4>
<dl class="table">
<dt><samp class="option">draw_mouse</samp></dt>
<dd><p>Specify whether to draw the mouse pointer. Use the value <code class="code">0</code> to
not draw the pointer. Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code class="code">ntsc</code>,
corresponding to a frame rate of <code class="code">30000/1001</code>.
</p>
</dd>
<dt><samp class="option">show_region</samp></dt>
<dd><p>Show grabbed region on screen.
</p>
<p>If <var class="var">show_region</var> is specified with <code class="code">1</code>, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.
</p>
<p>Note that <var class="var">show_region</var> is incompatible with grabbing the contents
of a single window.
</p>
<p>For example:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
</pre></div>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video frame size. The default is to capture the full screen if <samp class="file">desktop</samp> is selected, or the full window size if <samp class="file">title=<var class="var">window_title</var></samp> is selected.
</p>
</dd>
<dt><samp class="option">offset_x</samp></dt>
<dd><p>When capturing a region with <var class="var">video_size</var>, set the distance from the left edge of the screen or desktop.
</p>
<p>Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative <var class="var">offset_x</var> value to move the region to that monitor.
</p>
</dd>
<dt><samp class="option">offset_y</samp></dt>
<dd><p>When capturing a region with <var class="var">video_size</var>, set the distance from the top edge of the screen or desktop.
</p>
<p>Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative <var class="var">offset_y</var> value to move the region to that monitor.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="iec61883">
<h3 class="section">18.9 iec61883</h3>
<p>FireWire DV/HDV input device using libiec61883.
</p>
<p>To enable this input device, you need libiec61883, libraw1394 and
libavc1394 installed on your system. Use the configure option
<code class="code">--enable-libiec61883</code> to compile with the device enabled.
</p>
<p>The iec61883 capture device supports capturing from a video device
connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
FireWire stack (juju). This is the default DV/HDV input method in Linux
Kernel 2.6.37 and later, since the old FireWire stack was removed.
</p>
<p>Specify the FireWire port to be used as input file, or "auto"
to choose the first port connected.
</p>
<ul class="mini-toc">
<li><a href="#Options-22" accesskey="1">Options</a></li>
<li><a href="#Examples-10" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-22">
<h4 class="subsection">18.9.1 Options</h4>
<dl class="table">
<dt><samp class="option">dvtype</samp></dt>
<dd><p>Override autodetection of DV/HDV. This should only be used if auto
detection does not work, or if usage of a different device type
should be prohibited. Treating a DV device as HDV (or vice versa) will
not work and result in undefined behavior.
The values <samp class="option">auto</samp>, <samp class="option">dv</samp> and <samp class="option">hdv</samp> are supported.
</p>
</dd>
<dt><samp class="option">dvbuffer</samp></dt>
<dd><p>Set maximum size of buffer for incoming data, in frames. For DV, this
is an exact value. For HDV, it is not frame exact, since HDV does
not have a fixed frame size.
</p>
</dd>
<dt><samp class="option">dvguid</samp></dt>
<dd><p>Select the capture device by specifying its GUID. Capturing will only
be performed from the specified device and fails if no device with the
given GUID is found. This is useful to select the input if multiple
devices are connected at the same time.
Look at /sys/bus/firewire/devices to find out the GUIDs.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-10">
<h4 class="subsection">18.9.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Grab and show the input of a FireWire DV/HDV device.
<div class="example">
<pre class="example-preformatted">ffplay -f iec61883 -i auto
</pre></div>
</li><li>Grab and record the input of a FireWire DV/HDV device,
using a packet buffer of 100000 packets if the source is HDV.
<div class="example">
<pre class="example-preformatted">ffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="jack">
<h3 class="section">18.10 jack</h3>
<p>JACK input device.
</p>
<p>To enable this input device during configuration you need libjack
installed on your system.
</p>
<p>A JACK input device creates one or more JACK writable clients, one for
each audio channel, with name <var class="var">client_name</var>:input_<var class="var">N</var>, where
<var class="var">client_name</var> is the name provided by the application, and <var class="var">N</var>
is a number which identifies the channel.
Each writable client will send the acquired data to the FFmpeg input
device.
</p>
<p>Once you have created one or more JACK readable clients, you need to
connect them to one or more JACK writable clients.
</p>
<p>To connect or disconnect JACK clients you can use the <code class="command">jack_connect</code>
and <code class="command">jack_disconnect</code> programs, or do it through a graphical interface,
for example with <code class="command">qjackctl</code>.
</p>
<p>To list the JACK clients and their properties you can invoke the command
<code class="command">jack_lsp</code>.
</p>
<p>Follows an example which shows how to capture a JACK readable client
with <code class="command">ffmpeg</code>.
</p><div class="example">
<pre class="example-preformatted"># Create a JACK writable client with name "ffmpeg".
$ ffmpeg -f jack -i ffmpeg -y out.wav
# Start the sample jack_metro readable client.
$ jack_metro -b 120 -d 0.2 -f 4000
# List the current JACK clients.
$ jack_lsp -c
system:capture_1
system:capture_2
system:playback_1
system:playback_2
ffmpeg:input_1
metro:120_bpm
# Connect metro to the ffmpeg writable client.
$ jack_connect metro:120_bpm ffmpeg:input_1
</pre></div>
<p>For more information read:
<a class="url" href="http://jackaudio.org/">http://jackaudio.org/</a>
</p>
<ul class="mini-toc">
<li><a href="#Options-23" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-23">
<h4 class="subsection">18.10.1 Options</h4>
<dl class="table">
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="kmsgrab">
<h3 class="section">18.11 kmsgrab</h3>
<p>KMS video input device.
</p>
<p>Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
DRM object that can be passed to other hardware functions.
</p>
<p>Requires either DRM master or CAP_SYS_ADMIN to run.
</p>
<p>If you don’t understand what all of that means, you probably don’t want this. Look at
<samp class="option">x11grab</samp> instead.
</p>
<ul class="mini-toc">
<li><a href="#Options-24" accesskey="1">Options</a></li>
<li><a href="#Examples-11" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-24">
<h4 class="subsection">18.11.1 Options</h4>
<dl class="table">
<dt><samp class="option">device</samp></dt>
<dd><p>DRM device to capture on. Defaults to <samp class="option">/dev/dri/card0</samp>.
</p>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>Pixel format of the framebuffer. This can be autodetected if you are running Linux 5.7
or later, but needs to be provided for earlier versions. Defaults to <samp class="option">bgr0</samp>,
which is the most common format used by the Linux console and Xorg X server.
</p>
</dd>
<dt><samp class="option">format_modifier</samp></dt>
<dd><p>Format modifier to signal on output frames. This is necessary to import correctly into
some APIs. It can be autodetected if you are running Linux 5.7 or later, but will need
to be provided explicitly when needed in earlier versions. See the libdrm documentation
for possible values.
</p>
</dd>
<dt><samp class="option">crtc_id</samp></dt>
<dd><p>KMS CRTC ID to define the capture source. The first active plane on the given CRTC
will be used.
</p>
</dd>
<dt><samp class="option">plane_id</samp></dt>
<dd><p>KMS plane ID to define the capture source. Defaults to the first active plane found if
neither <samp class="option">crtc_id</samp> nor <samp class="option">plane_id</samp> are specified.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Framerate to capture at. This is not synchronised to any page flipping or framebuffer
changes - it just defines the interval at which the framebuffer is sampled. Sampling
faster than the framebuffer update rate will generate independent frames with the same
content. Defaults to <code class="code">30</code>.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-11">
<h4 class="subsection">18.11.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Capture from the first active plane, download the result to normal frames and encode.
This will only work if the framebuffer is both linear and mappable - if not, the result
may be scrambled or fail to download.
<div class="example">
<pre class="example-preformatted">ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
</pre></div>
</li><li>Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
<div class="example">
<pre class="example-preformatted">ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
</pre></div>
</li><li>To capture only part of a plane the output can be cropped - this can be used to capture
a single window, as long as it has a known absolute position and size. For example, to
capture and encode the middle quarter of a 1920x1080 plane:
<div class="example">
<pre class="example-preformatted">ffmpeg -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,crop=960:540:480:270,scale_vaapi=960:540:nv12' -c:v h264_vaapi output.mp4
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="lavfi">
<h3 class="section">18.12 lavfi</h3>
<p>Libavfilter input virtual device.
</p>
<p>This input device reads data from the open output pads of a libavfilter
filtergraph.
</p>
<p>For each filtergraph open output, the input device will create a
corresponding stream which is mapped to the generated output.
The filtergraph is specified through the option <samp class="option">graph</samp>.
</p>
<ul class="mini-toc">
<li><a href="#Options-25" accesskey="1">Options</a></li>
<li><a href="#Examples-12" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-25">
<h4 class="subsection">18.12.1 Options</h4>
<dl class="table">
<dt><samp class="option">graph</samp></dt>
<dd><p>Specify the filtergraph to use as input. Each video open output must be
labelled by a unique string of the form "out<var class="var">N</var>", where <var class="var">N</var> is a
number starting from 0 corresponding to the mapped input stream
generated by the device.
The first unlabelled output is automatically assigned to the "out0"
label, but all the others need to be specified explicitly.
</p>
<p>The suffix "+subcc" can be appended to the output label to create an extra
stream with the closed captions packets attached to that output
(experimental; only for EIA-608 / CEA-708 for now).
The subcc streams are created after all the normal streams, in the order of
the corresponding stream.
For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
</p>
<p>If not specified defaults to the filename specified for the input
device.
</p>
</dd>
<dt><samp class="option">graph_file</samp></dt>
<dd><p>Set the filename of the filtergraph to be read and sent to the other
filters. Syntax of the filtergraph is the same as the one specified by
the option <var class="var">graph</var>.
</p>
</dd>
<dt><samp class="option">dumpgraph</samp></dt>
<dd><p>Dump graph to stderr.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-12">
<h4 class="subsection">18.12.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Create a color video stream and play it back with <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi -graph "color=c=pink [out0]" dummy
</pre></div>
</li><li>As the previous example, but use filename for specifying the graph
description, and omit the "out0" label:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi color=c=pink
</pre></div>
</li><li>Create three different video test filtered sources and play them:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
</pre></div>
</li><li>Read an audio stream from a file using the amovie source and play it
back with <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi "amovie=test.wav"
</pre></div>
</li><li>Read an audio stream and a video stream and play it back with
<code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
</pre></div>
</li><li>Dump decoded frames to images and closed captions to a file (experimental):
<div class="example">
<pre class="example-preformatted">ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="libcdio">
<h3 class="section">18.13 libcdio</h3>
<p>Audio-CD input device based on libcdio.
</p>
<p>To enable this input device during configuration you need libcdio
installed on your system. It requires the configure option
<code class="code">--enable-libcdio</code>.
</p>
<p>This device allows playing and grabbing from an Audio-CD.
</p>
<p>For example to copy with <code class="command">ffmpeg</code> the entire Audio-CD in <samp class="file">/dev/sr0</samp>,
you may run the command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f libcdio -i /dev/sr0 cd.wav
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-26" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-26">
<h4 class="subsection">18.13.1 Options</h4>
<dl class="table">
<dt><samp class="option">speed</samp></dt>
<dd><p>Set drive reading speed. Default value is 0.
</p>
<p>The speed is specified CD-ROM speed units. The speed is set through
the libcdio <code class="code">cdio_cddap_speed_set</code> function. On many CD-ROM
drives, specifying a value too large will result in using the fastest
speed.
</p>
</dd>
<dt><samp class="option">paranoia_mode</samp></dt>
<dd><p>Set paranoia recovery mode flags. It accepts one of the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">disable</samp>’</dt>
<dt>‘<samp class="samp">verify</samp>’</dt>
<dt>‘<samp class="samp">overlap</samp>’</dt>
<dt>‘<samp class="samp">neverskip</samp>’</dt>
<dt>‘<samp class="samp">full</samp>’</dt>
</dl>
<p>Default value is ‘<samp class="samp">disable</samp>’.
</p>
<p>For more information about the available recovery modes, consult the
paranoia project documentation.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="libdc1394">
<h3 class="section">18.14 libdc1394</h3>
<p>IIDC1394 input device, based on libdc1394 and libraw1394.
</p>
<p>Requires the configure option <code class="code">--enable-libdc1394</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-27" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-27">
<h4 class="subsection">18.14.1 Options</h4>
<dl class="table">
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the frame rate. Default is <code class="code">ntsc</code>, corresponding to a frame
rate of <code class="code">30000/1001</code>.
</p>
</dd>
<dt><samp class="option">pixel_format</samp></dt>
<dd><p>Select the pixel format. Default is <code class="code">uyvy422</code>.
</p>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video size given as a string such as <code class="code">640x480</code> or <code class="code">hd720</code>.
Default is <code class="code">qvga</code>.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="openal">
<h3 class="section">18.15 openal</h3>
<p>The OpenAL input device provides audio capture on all systems with a
working OpenAL 1.1 implementation.
</p>
<p>To enable this input device during configuration, you need OpenAL
headers and libraries installed on your system, and need to configure
FFmpeg with <code class="code">--enable-openal</code>.
</p>
<p>OpenAL headers and libraries should be provided as part of your OpenAL
implementation, or as an additional download (an SDK). Depending on your
installation you may need to specify additional flags via the
<code class="code">--extra-cflags</code> and <code class="code">--extra-ldflags</code> for allowing the build
system to locate the OpenAL headers and libraries.
</p>
<p>An incomplete list of OpenAL implementations follows:
</p>
<dl class="table">
<dt><strong class="strong">Creative</strong></dt>
<dd><p>The official Windows implementation, providing hardware acceleration
with supported devices and software fallback.
See <a class="url" href="http://openal.org/">http://openal.org/</a>.
</p></dd>
<dt><strong class="strong">OpenAL Soft</strong></dt>
<dd><p>Portable, open source (LGPL) software implementation. Includes
backends for the most common sound APIs on the Windows, Linux,
Solaris, and BSD operating systems.
See <a class="url" href="http://kcat.strangesoft.net/openal.html">http://kcat.strangesoft.net/openal.html</a>.
</p></dd>
<dt><strong class="strong">Apple</strong></dt>
<dd><p>OpenAL is part of Core Audio, the official Mac OS X Audio interface.
See <a class="url" href="http://developer.apple.com/technologies/mac/audio-and-video.html">http://developer.apple.com/technologies/mac/audio-and-video.html</a>
</p></dd>
</dl>
<p>This device allows one to capture from an audio input device handled
through OpenAL.
</p>
<p>You need to specify the name of the device to capture in the provided
filename. If the empty string is provided, the device will
automatically select the default device. You can get the list of the
supported devices by using the option <var class="var">list_devices</var>.
</p>
<ul class="mini-toc">
<li><a href="#Options-28" accesskey="1">Options</a></li>
<li><a href="#Examples-13" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-28">
<h4 class="subsection">18.15.1 Options</h4>
<dl class="table">
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels in the captured audio. Only the values
<samp class="option">1</samp> (monaural) and <samp class="option">2</samp> (stereo) are currently supported.
Defaults to <samp class="option">2</samp>.
</p>
</dd>
<dt><samp class="option">sample_size</samp></dt>
<dd><p>Set the sample size (in bits) of the captured audio. Only the values
<samp class="option">8</samp> and <samp class="option">16</samp> are currently supported. Defaults to
<samp class="option">16</samp>.
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate (in Hz) of the captured audio.
Defaults to <samp class="option">44.1k</samp>.
</p>
</dd>
<dt><samp class="option">list_devices</samp></dt>
<dd><p>If set to <samp class="option">true</samp>, print a list of devices and exit.
Defaults to <samp class="option">false</samp>.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-13">
<h4 class="subsection">18.15.2 Examples</h4>
<p>Print the list of OpenAL supported devices and exit:
</p><div class="example">
<pre class="example-preformatted">$ ffmpeg -list_devices true -f openal -i dummy out.ogg
</pre></div>
<p>Capture from the OpenAL device <samp class="file">DR-BT101 via PulseAudio</samp>:
</p><div class="example">
<pre class="example-preformatted">$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
</pre></div>
<p>Capture from the default device (note the empty string ” as filename):
</p><div class="example">
<pre class="example-preformatted">$ ffmpeg -f openal -i '' out.ogg
</pre></div>
<p>Capture from two devices simultaneously, writing to two different files,
within the same <code class="command">ffmpeg</code> command:
</p><div class="example">
<pre class="example-preformatted">$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
</pre></div>
<p>Note: not all OpenAL implementations support multiple simultaneous capture -
try the latest OpenAL Soft if the above does not work.
</p>
</div>
</div>
<div class="section-level-extent" id="oss">
<h3 class="section">18.16 oss</h3>
<p>Open Sound System input device.
</p>
<p>The filename to provide to the input device is the device node
representing the OSS input device, and is usually set to
<samp class="file">/dev/dsp</samp>.
</p>
<p>For example to grab from <samp class="file">/dev/dsp</samp> using <code class="command">ffmpeg</code> use the
command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
</pre></div>
<p>For more information about OSS see:
<a class="url" href="http://manuals.opensound.com/usersguide/dsp.html">http://manuals.opensound.com/usersguide/dsp.html</a>
</p>
<ul class="mini-toc">
<li><a href="#Options-29" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-29">
<h4 class="subsection">18.16.1 Options</h4>
<dl class="table">
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="pulse">
<h3 class="section">18.17 pulse</h3>
<p>PulseAudio input device.
</p>
<p>To enable this output device you need to configure FFmpeg with <code class="code">--enable-libpulse</code>.
</p>
<p>The filename to provide to the input device is a source device or the
string "default"
</p>
<p>To list the PulseAudio source devices and their properties you can invoke
the command <code class="command">pactl list sources</code>.
</p>
<p>More information about PulseAudio can be found on <a class="url" href="http://www.pulseaudio.org">http://www.pulseaudio.org</a>.
</p>
<ul class="mini-toc">
<li><a href="#Options-30" accesskey="1">Options</a></li>
<li><a href="#Examples-14" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-30">
<h4 class="subsection">18.17.1 Options</h4>
<dl class="table">
<dt><samp class="option">server</samp></dt>
<dd><p>Connect to a specific PulseAudio server, specified by an IP address.
Default server is used when not provided.
</p>
</dd>
<dt><samp class="option">name</samp></dt>
<dd><p>Specify the application name PulseAudio will use when showing active clients,
by default it is the <code class="code">LIBAVFORMAT_IDENT</code> string.
</p>
</dd>
<dt><samp class="option">stream_name</samp></dt>
<dd><p>Specify the stream name PulseAudio will use when showing active streams,
by default it is "record".
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Specify the samplerate in Hz, by default 48kHz is used.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Specify the channels in use, by default 2 (stereo) is set.
</p>
</dd>
<dt><samp class="option">frame_size</samp></dt>
<dd><p>This option does nothing and is deprecated.
</p>
</dd>
<dt><samp class="option">fragment_size</samp></dt>
<dd><p>Specify the size in bytes of the minimal buffering fragment in PulseAudio, it
will affect the audio latency. By default it is set to 50 ms amount of data.
</p>
</dd>
<dt><samp class="option">wallclock</samp></dt>
<dd><p>Set the initial PTS using the current time. Default is 1.
</p>
</dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-14">
<h4 class="subsection">18.17.2 Examples</h4>
<p>Record a stream from default device:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f pulse -i default /tmp/pulse.wav
</pre></div>
</div>
</div>
<div class="section-level-extent" id="sndio">
<h3 class="section">18.18 sndio</h3>
<p>sndio input device.
</p>
<p>To enable this input device during configuration you need libsndio
installed on your system.
</p>
<p>The filename to provide to the input device is the device node
representing the sndio input device, and is usually set to
<samp class="file">/dev/audio0</samp>.
</p>
<p>For example to grab from <samp class="file">/dev/audio0</samp> using <code class="command">ffmpeg</code> use the
command:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-31" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-31">
<h4 class="subsection">18.18.1 Options</h4>
<dl class="table">
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Set the sample rate in Hz. Default is 48000.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the number of channels. Default is 2.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="video4linux2_002c-v4l2">
<h3 class="section">18.19 video4linux2, v4l2</h3>
<p>Video4Linux2 input video device.
</p>
<p>"v4l2" can be used as alias for "video4linux2".
</p>
<p>If FFmpeg is built with v4l-utils support (by using the
<code class="code">--enable-libv4l2</code> configure option), it is possible to use it with the
<code class="code">-use_libv4l2</code> input device option.
</p>
<p>The name of the device to grab is a file device node, usually Linux
systems tend to automatically create such nodes when the device
(e.g. an USB webcam) is plugged into the system, and has a name of the
kind <samp class="file">/dev/video<var class="var">N</var></samp>, where <var class="var">N</var> is a number associated to
the device.
</p>
<p>Video4Linux2 devices usually support a limited set of
<var class="var">width</var>x<var class="var">height</var> sizes and frame rates. You can check which are
supported using <code class="command">-list_formats all</code> for Video4Linux2 devices.
Some devices, like TV cards, support one or more standards. It is possible
to list all the supported standards using <code class="command">-list_standards all</code>.
</p>
<p>The time base for the timestamps is 1 microsecond. Depending on the kernel
version and configuration, the timestamps may be derived from the real time
clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
boot time, unaffected by NTP or manual changes to the clock). The
<samp class="option">-timestamps abs</samp> or <samp class="option">-ts abs</samp> option can be used to force
conversion into the real time clock.
</p>
<p>Some usage examples of the video4linux2 device with <code class="command">ffmpeg</code>
and <code class="command">ffplay</code>:
</p><ul class="itemize mark-bullet">
<li>List supported formats for a video4linux2 device:
<div class="example">
<pre class="example-preformatted">ffplay -f video4linux2 -list_formats all /dev/video0
</pre></div>
</li><li>Grab and show the input of a video4linux2 device:
<div class="example">
<pre class="example-preformatted">ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
</pre></div>
</li><li>Grab and record the input of a video4linux2 device, leave the
frame rate and size as previously set:
<div class="example">
<pre class="example-preformatted">ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
</pre></div>
</li></ul>
<p>For more information about Video4Linux, check <a class="url" href="http://linuxtv.org/">http://linuxtv.org/</a>.
</p>
<ul class="mini-toc">
<li><a href="#Options-32" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-32">
<h4 class="subsection">18.19.1 Options</h4>
<dl class="table">
<dt><samp class="option">standard</samp></dt>
<dd><p>Set the standard. Must be the name of a supported standard. To get a
list of the supported standards, use the <samp class="option">list_standards</samp>
option.
</p>
</dd>
<dt><samp class="option">channel</samp></dt>
<dd><p>Set the input channel number. Default to -1, which means using the
previously selected channel.
</p>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video frame size. The argument must be a string in the form
<var class="var">WIDTH</var>x<var class="var">HEIGHT</var> or a valid size abbreviation.
</p>
</dd>
<dt><samp class="option">pixel_format</samp></dt>
<dd><p>Select the pixel format (only valid for raw video input).
</p>
</dd>
<dt><samp class="option">input_format</samp></dt>
<dd><p>Set the preferred pixel format (for raw video) or a codec name.
This option allows one to select the input format, when several are
available.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the preferred video frame rate.
</p>
</dd>
<dt><samp class="option">list_formats</samp></dt>
<dd><p>List available formats (supported pixel formats, codecs, and frame
sizes) and exit.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>Show all available (compressed and non-compressed) formats.
</p>
</dd>
<dt>‘<samp class="samp">raw</samp>’</dt>
<dd><p>Show only raw video (non-compressed) formats.
</p>
</dd>
<dt>‘<samp class="samp">compressed</samp>’</dt>
<dd><p>Show only compressed formats.
</p></dd>
</dl>
</dd>
<dt><samp class="option">list_standards</samp></dt>
<dd><p>List supported standards and exit.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>Show all supported standards.
</p></dd>
</dl>
</dd>
<dt><samp class="option">timestamps, ts</samp></dt>
<dd><p>Set type of timestamps for grabbed frames.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">default</samp>’</dt>
<dd><p>Use timestamps from the kernel.
</p>
</dd>
<dt>‘<samp class="samp">abs</samp>’</dt>
<dd><p>Use absolute timestamps (wall clock).
</p>
</dd>
<dt>‘<samp class="samp">mono2abs</samp>’</dt>
<dd><p>Force conversion from monotonic to absolute timestamps.
</p></dd>
</dl>
<p>Default value is <code class="code">default</code>.
</p>
</dd>
<dt><samp class="option">use_libv4l2</samp></dt>
<dd><p>Use libv4l2 (v4l-utils) conversion functions. Default is 0.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="vfwcap">
<h3 class="section">18.20 vfwcap</h3>
<p>VfW (Video for Windows) capture input device.
</p>
<p>The filename passed as input is the capture driver number, ranging from
0 to 9. You may use "list" as filename to print a list of drivers. Any
other filename will be interpreted as device number 0.
</p>
<ul class="mini-toc">
<li><a href="#Options-33" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-33">
<h4 class="subsection">18.20.1 Options</h4>
<dl class="table">
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video frame size.
</p>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code class="code">ntsc</code>,
corresponding to a frame rate of <code class="code">30000/1001</code>.
</p>
</dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="x11grab">
<h3 class="section">18.21 x11grab</h3>
<p>X11 video input device.
</p>
<p>To enable this input device during configuration you need libxcb
installed on your system. It will be automatically detected during
configuration.
</p>
<p>This device allows one to capture a region of an X11 display.
</p>
<p>The filename passed as input has the syntax:
</p><div class="example">
<pre class="example-preformatted">[<var class="var">hostname</var>]:<var class="var">display_number</var>.<var class="var">screen_number</var>[+<var class="var">x_offset</var>,<var class="var">y_offset</var>]
</pre></div>
<p><var class="var">hostname</var>:<var class="var">display_number</var>.<var class="var">screen_number</var> specifies the
X11 display name of the screen to grab from. <var class="var">hostname</var> can be
omitted, and defaults to "localhost". The environment variable
<code class="env">DISPLAY</code> contains the default display name.
</p>
<p><var class="var">x_offset</var> and <var class="var">y_offset</var> specify the offsets of the grabbed
area with respect to the top-left border of the X11 screen. They
default to 0.
</p>
<p>Check the X11 documentation (e.g. <code class="command">man X</code>) for more detailed
information.
</p>
<p>Use the <code class="command">xdpyinfo</code> program for getting basic information about
the properties of your X11 display (e.g. grep for "name" or
"dimensions").
</p>
<p>For example to grab from <samp class="file">:0.0</samp> using <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
<p>Grab at position <code class="code">10,20</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-34" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-34">
<h4 class="subsection">18.21.1 Options</h4>
<dl class="table">
<dt><samp class="option">select_region</samp></dt>
<dd><p>Specify whether to select the grabbing area graphically using the pointer.
A value of <code class="code">1</code> prompts the user to select the grabbing area graphically
by clicking and dragging. A single click with no dragging will select the
whole screen. A region with zero width or height will also select the whole
screen. This option overwrites the <var class="var">video_size</var>, <var class="var">grab_x</var>, and
<var class="var">grab_y</var> options. Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">draw_mouse</samp></dt>
<dd><p>Specify whether to draw the mouse pointer. A value of <code class="code">0</code> specifies
not to draw the pointer. Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">follow_mouse</samp></dt>
<dd><p>Make the grabbed area follow the mouse. The argument can be
<code class="code">centered</code> or a number of pixels <var class="var">PIXELS</var>.
</p>
<p>When it is specified with "centered", the grabbing region follows the mouse
pointer and keeps the pointer at the center of region; otherwise, the region
follows only when the mouse pointer reaches within <var class="var">PIXELS</var> (greater than
zero) to the edge of region.
</p>
<p>For example:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
<p>To follow only when the mouse pointer reaches within 100 pixels to edge:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
</dd>
<dt><samp class="option">framerate</samp></dt>
<dd><p>Set the grabbing frame rate. Default value is <code class="code">ntsc</code>,
corresponding to a frame rate of <code class="code">30000/1001</code>.
</p>
</dd>
<dt><samp class="option">show_region</samp></dt>
<dd><p>Show grabbed region on screen.
</p>
<p>If <var class="var">show_region</var> is specified with <code class="code">1</code>, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.
</p>
</dd>
<dt><samp class="option">region_border</samp></dt>
<dd><p>Set the region border thickness if <samp class="option">-show_region 1</samp> is used.
Range is 1 to 128 and default is 3 (XCB-based x11grab only).
</p>
<p>For example:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
</pre></div>
<p>With <var class="var">follow_mouse</var>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
</pre></div>
</dd>
<dt><samp class="option">window_id</samp></dt>
<dd><p>Grab this window, instead of the whole screen. Default value is 0, which maps to
the whole screen (root window).
</p>
<p>The id of a window can be found using the <code class="command">xwininfo</code> program, possibly with options -tree and
-root.
</p>
<p>If the window is later enlarged, the new area is not recorded. Video ends when
the window is closed, unmapped (i.e., iconified) or shrunk beyond the video
size (which defaults to the initial window size).
</p>
<p>This option disables options <samp class="option">follow_mouse</samp> and <samp class="option">select_region</samp>.
</p>
</dd>
<dt><samp class="option">video_size</samp></dt>
<dd><p>Set the video frame size. Default is the full desktop or window.
</p>
</dd>
<dt><samp class="option">grab_x</samp></dt>
<dt><samp class="option">grab_y</samp></dt>
<dd><p>Set the grabbing region coordinates. They are expressed as offset from
the top left corner of the X11 window and correspond to the
<var class="var">x_offset</var> and <var class="var">y_offset</var> parameters in the device name. The
default value for both options is 0.
</p></dd>
</dl>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Resampler-Options">
<h2 class="chapter">19 Resampler Options</h2>
<p>The audio resampler supports the following named options.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, <var class="var">option</var>=<var class="var">value</var> for the aresample filter,
by setting the value explicitly in the
<code class="code">SwrContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API for
programmatic use.
</p>
<dl class="table">
<dt><samp class="option">uchl, used_chlayout</samp></dt>
<dd><p>Set used input channel layout. Default is unset. This option is
only used for special remapping.
</p>
</dd>
<dt><samp class="option">isr, in_sample_rate</samp></dt>
<dd><p>Set the input sample rate. Default value is 0.
</p>
</dd>
<dt><samp class="option">osr, out_sample_rate</samp></dt>
<dd><p>Set the output sample rate. Default value is 0.
</p>
</dd>
<dt><samp class="option">isf, in_sample_fmt</samp></dt>
<dd><p>Specify the input sample format. It is set by default to <code class="code">none</code>.
</p>
</dd>
<dt><samp class="option">osf, out_sample_fmt</samp></dt>
<dd><p>Specify the output sample format. It is set by default to <code class="code">none</code>.
</p>
</dd>
<dt><samp class="option">tsf, internal_sample_fmt</samp></dt>
<dd><p>Set the internal sample format. Default value is <code class="code">none</code>.
This will automatically be chosen when it is not explicitly set.
</p>
</dd>
<dt><samp class="option">ichl, in_chlayout</samp></dt>
<dt><samp class="option">ochl, out_chlayout</samp></dt>
<dd><p>Set the input/output channel layout.
</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><samp class="option">clev, center_mix_level</samp></dt>
<dd><p>Set the center mix level. It is a value expressed in deciBel, and must be
in the interval [-32,32].
</p>
</dd>
<dt><samp class="option">slev, surround_mix_level</samp></dt>
<dd><p>Set the surround mix level. It is a value expressed in deciBel, and must
be in the interval [-32,32].
</p>
</dd>
<dt><samp class="option">lfe_mix_level</samp></dt>
<dd><p>Set LFE mix into non LFE level. It is used when there is a LFE input but no
LFE output. It is a value expressed in deciBel, and must
be in the interval [-32,32].
</p>
</dd>
<dt><samp class="option">rmvol, rematrix_volume</samp></dt>
<dd><p>Set rematrix volume. Default value is 1.0.
</p>
</dd>
<dt><samp class="option">rematrix_maxval</samp></dt>
<dd><p>Set maximum output value for rematrixing.
This can be used to prevent clipping vs. preventing volume reduction.
A value of 1.0 prevents clipping.
</p>
</dd>
<dt><samp class="option">flags, swr_flags</samp></dt>
<dd><p>Set flags used by the converter. Default value is 0.
</p>
<p>It supports the following individual flags:
</p><dl class="table">
<dt><samp class="option">res</samp></dt>
<dd><p>force resampling, this flag forces resampling to be used even when the
input and output sample rates match.
</p></dd>
</dl>
</dd>
<dt><samp class="option">dither_scale</samp></dt>
<dd><p>Set the dither scale. Default value is 1.
</p>
</dd>
<dt><samp class="option">dither_method</samp></dt>
<dd><p>Set dither method. Default value is 0.
</p>
<p>Supported values:
</p><dl class="table">
<dt>‘<samp class="samp">rectangular</samp>’</dt>
<dd><p>select rectangular dither
</p></dd>
<dt>‘<samp class="samp">triangular</samp>’</dt>
<dd><p>select triangular dither
</p></dd>
<dt>‘<samp class="samp">triangular_hp</samp>’</dt>
<dd><p>select triangular dither with high pass
</p></dd>
<dt>‘<samp class="samp">lipshitz</samp>’</dt>
<dd><p>select Lipshitz noise shaping dither.
</p></dd>
<dt>‘<samp class="samp">shibata</samp>’</dt>
<dd><p>select Shibata noise shaping dither.
</p></dd>
<dt>‘<samp class="samp">low_shibata</samp>’</dt>
<dd><p>select low Shibata noise shaping dither.
</p></dd>
<dt>‘<samp class="samp">high_shibata</samp>’</dt>
<dd><p>select high Shibata noise shaping dither.
</p></dd>
<dt>‘<samp class="samp">f_weighted</samp>’</dt>
<dd><p>select f-weighted noise shaping dither
</p></dd>
<dt>‘<samp class="samp">modified_e_weighted</samp>’</dt>
<dd><p>select modified-e-weighted noise shaping dither
</p></dd>
<dt>‘<samp class="samp">improved_e_weighted</samp>’</dt>
<dd><p>select improved-e-weighted noise shaping dither
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">resampler</samp></dt>
<dd><p>Set resampling engine. Default value is swr.
</p>
<p>Supported values:
</p><dl class="table">
<dt>‘<samp class="samp">swr</samp>’</dt>
<dd><p>select the native SW Resampler; filter options precision and cheby are not
applicable in this case.
</p></dd>
<dt>‘<samp class="samp">soxr</samp>’</dt>
<dd><p>select the SoX Resampler (where available); compensation, and filter options
filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not
applicable in this case.
</p></dd>
</dl>
</dd>
<dt><samp class="option">filter_size</samp></dt>
<dd><p>For swr only, set resampling filter size, default value is 32.
</p>
</dd>
<dt><samp class="option">phase_shift</samp></dt>
<dd><p>For swr only, set resampling phase shift, default value is 10, and must be in
the interval [0,30].
</p>
</dd>
<dt><samp class="option">linear_interp</samp></dt>
<dd><p>Use linear interpolation when enabled (the default). Disable it if you want
to preserve speed instead of quality when exact_rational fails.
</p>
</dd>
<dt><samp class="option">exact_rational</samp></dt>
<dd><p>For swr only, when enabled, try to use exact phase_count based on input and
output sample rate. However, if it is larger than <code class="code">1 << phase_shift</code>,
the phase_count will be <code class="code">1 << phase_shift</code> as fallback. Default is enabled.
</p>
</dd>
<dt><samp class="option">cutoff</samp></dt>
<dd><p>Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float
value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr
(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz).
</p>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>For soxr only, the precision in bits to which the resampled signal will be
calculated. The default value of 20 (which, with suitable dithering, is
appropriate for a destination bit-depth of 16) gives SoX’s ’High Quality’; a
value of 28 gives SoX’s ’Very High Quality’.
</p>
</dd>
<dt><samp class="option">cheby</samp></dt>
<dd><p>For soxr only, selects passband rolloff none (Chebyshev) & higher-precision
approximation for ’irrational’ ratios. Default value is 0.
</p>
</dd>
<dt><samp class="option">async</samp></dt>
<dd><p>For swr only, simple 1 parameter audio sync to timestamps using stretching,
squeezing, filling and trimming. Setting this to 1 will enable filling and
trimming, larger values represent the maximum amount in samples that the data
may be stretched or squeezed for each second.
Default value is 0, thus no compensation is applied to make the samples match
the audio timestamps.
</p>
</dd>
<dt><samp class="option">first_pts</samp></dt>
<dd><p>For swr only, assume the first pts should be this value. The time unit is 1 / sample rate.
This allows for padding/trimming at the start of stream. By default, no
assumption is made about the first frame’s expected pts, so no padding or
trimming is done. For example, this could be set to 0 to pad the beginning with
silence if an audio stream starts after the video stream or to trim any samples
with a negative pts due to encoder delay.
</p>
</dd>
<dt><samp class="option">min_comp</samp></dt>
<dd><p>For swr only, set the minimum difference between timestamps and audio data (in
seconds) to trigger stretching/squeezing/filling or trimming of the
data to make it match the timestamps. The default is that
stretching/squeezing/filling and trimming is disabled
(<samp class="option">min_comp</samp> = <code class="code">FLT_MAX</code>).
</p>
</dd>
<dt><samp class="option">min_hard_comp</samp></dt>
<dd><p>For swr only, set the minimum difference between timestamps and audio data (in
seconds) to trigger adding/dropping samples to make it match the
timestamps. This option effectively is a threshold to select between
hard (trim/fill) and soft (squeeze/stretch) compensation. Note that
all compensation is by default disabled through <samp class="option">min_comp</samp>.
The default is 0.1.
</p>
</dd>
<dt><samp class="option">comp_duration</samp></dt>
<dd><p>For swr only, set duration (in seconds) over which data is stretched/squeezed
to make it match the timestamps. Must be a non-negative double float value,
default value is 1.0.
</p>
</dd>
<dt><samp class="option">max_soft_comp</samp></dt>
<dd><p>For swr only, set maximum factor by which data is stretched/squeezed to make it
match the timestamps. Must be a non-negative double float value, default value
is 0.
</p>
</dd>
<dt><samp class="option">matrix_encoding</samp></dt>
<dd><p>Select matrixed stereo encoding.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>select none
</p></dd>
<dt>‘<samp class="samp">dolby</samp>’</dt>
<dd><p>select Dolby
</p></dd>
<dt>‘<samp class="samp">dplii</samp>’</dt>
<dd><p>select Dolby Pro Logic II
</p></dd>
</dl>
<p>Default value is <code class="code">none</code>.
</p>
</dd>
<dt><samp class="option">filter_type</samp></dt>
<dd><p>For swr only, select resampling filter type. This only affects resampling
operations.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">cubic</samp>’</dt>
<dd><p>select cubic
</p></dd>
<dt>‘<samp class="samp">blackman_nuttall</samp>’</dt>
<dd><p>select Blackman Nuttall windowed sinc
</p></dd>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
<dd><p>select Kaiser windowed sinc
</p></dd>
</dl>
</dd>
<dt><samp class="option">kaiser_beta</samp></dt>
<dd><p>For swr only, set Kaiser window beta value. Must be a double float value in the
interval [2,16], default value is 9.
</p>
</dd>
<dt><samp class="option">output_sample_bits</samp></dt>
<dd><p>For swr only, set number of used output sample bits for dithering. Must be an integer in the
interval [0,64], default value is 0, which means it’s not used.
</p>
</dd>
</dl>
<a class="anchor" id="scaler_005foptions"></a></div>
<div class="chapter-level-extent" id="Scaler-Options">
<h2 class="chapter">20 Scaler Options</h2>
<p>The video scaler supports the following named options.
</p>
<p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
FFmpeg tools, with a few API-only exceptions noted below.
For programmatic use, they can be set explicitly in the
<code class="code">SwsContext</code> options or through the <samp class="file">libavutil/opt.h</samp> API.
</p>
<dl class="table">
<dd>
<a class="anchor" id="sws_005fflags"></a></dd>
<dt><samp class="option">sws_flags</samp></dt>
<dd><p>Set the scaler flags. This is also used to set the scaling
algorithm. Only a single algorithm should be selected. Default
value is ‘<samp class="samp">bicubic</samp>’.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">fast_bilinear</samp>’</dt>
<dd><p>Select fast bilinear scaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">bilinear</samp>’</dt>
<dd><p>Select bilinear scaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">bicubic</samp>’</dt>
<dd><p>Select bicubic scaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">experimental</samp>’</dt>
<dd><p>Select experimental scaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">neighbor</samp>’</dt>
<dd><p>Select nearest neighbor rescaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">area</samp>’</dt>
<dd><p>Select averaging area rescaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">bicublin</samp>’</dt>
<dd><p>Select bicubic scaling algorithm for the luma component, bilinear for
chroma components.
</p>
</dd>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dd><p>Select Gaussian rescaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">sinc</samp>’</dt>
<dd><p>Select sinc rescaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dd><p>Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be
changed by setting <code class="code">param0</code>.
</p>
</dd>
<dt>‘<samp class="samp">spline</samp>’</dt>
<dd><p>Select natural bicubic spline rescaling algorithm.
</p>
</dd>
<dt>‘<samp class="samp">print_info</samp>’</dt>
<dd><p>Enable printing/debug logging.
</p>
</dd>
<dt>‘<samp class="samp">accurate_rnd</samp>’</dt>
<dd><p>Enable accurate rounding.
</p>
</dd>
<dt>‘<samp class="samp">full_chroma_int</samp>’</dt>
<dd><p>Enable full chroma interpolation.
</p>
</dd>
<dt>‘<samp class="samp">full_chroma_inp</samp>’</dt>
<dd><p>Select full chroma input.
</p>
</dd>
<dt>‘<samp class="samp">bitexact</samp>’</dt>
<dd><p>Enable bitexact output.
</p></dd>
</dl>
</dd>
<dt><samp class="option">srcw <var class="var">(API only)</var></samp></dt>
<dd><p>Set source width.
</p>
</dd>
<dt><samp class="option">srch <var class="var">(API only)</var></samp></dt>
<dd><p>Set source height.
</p>
</dd>
<dt><samp class="option">dstw <var class="var">(API only)</var></samp></dt>
<dd><p>Set destination width.
</p>
</dd>
<dt><samp class="option">dsth <var class="var">(API only)</var></samp></dt>
<dd><p>Set destination height.
</p>
</dd>
<dt><samp class="option">src_format <var class="var">(API only)</var></samp></dt>
<dd><p>Set source pixel format (must be expressed as an integer).
</p>
</dd>
<dt><samp class="option">dst_format <var class="var">(API only)</var></samp></dt>
<dd><p>Set destination pixel format (must be expressed as an integer).
</p>
</dd>
<dt><samp class="option">src_range <var class="var">(boolean)</var></samp></dt>
<dd><p>If value is set to <code class="code">1</code>, indicates source is full range. Default value is
<code class="code">0</code>, which indicates source is limited range.
</p>
</dd>
<dt><samp class="option">dst_range <var class="var">(boolean)</var></samp></dt>
<dd><p>If value is set to <code class="code">1</code>, enable full range for destination. Default value
is <code class="code">0</code>, which enables limited range.
</p>
<a class="anchor" id="sws_005fparams"></a></dd>
<dt><samp class="option">param0, param1</samp></dt>
<dd><p>Set scaling algorithm parameters. The specified values are specific of
some scaling algorithms and ignored by others. The specified values
are floating point number values.
</p>
</dd>
<dt><samp class="option">sws_dither</samp></dt>
<dd><p>Set the dithering algorithm. Accepts one of the following
values. Default value is ‘<samp class="samp">auto</samp>’.
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>automatic choice
</p>
</dd>
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>no dithering
</p>
</dd>
<dt>‘<samp class="samp">bayer</samp>’</dt>
<dd><p>bayer dither
</p>
</dd>
<dt>‘<samp class="samp">ed</samp>’</dt>
<dd><p>error diffusion dither
</p>
</dd>
<dt>‘<samp class="samp">a_dither</samp>’</dt>
<dd><p>arithmetic dither, based using addition
</p>
</dd>
<dt>‘<samp class="samp">x_dither</samp>’</dt>
<dd><p>arithmetic dither, based using xor (more random/less apparent patterning that
a_dither).
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">alphablend</samp></dt>
<dd><p>Set the alpha blending to use when the input has alpha but the output does not.
Default value is ‘<samp class="samp">none</samp>’.
</p>
<dl class="table">
<dt>‘<samp class="samp">uniform_color</samp>’</dt>
<dd><p>Blend onto a uniform background color
</p>
</dd>
<dt>‘<samp class="samp">checkerboard</samp>’</dt>
<dd><p>Blend onto a checkerboard
</p>
</dd>
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No blending
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="chapter-level-extent" id="Filtering-Introduction">
<h2 class="chapter">21 Filtering Introduction</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-preformatted">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 class="var">crop,vflip</var> are in one linear chain, <var class="var">split</var> and
<var class="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 class="var">[main]</var> and <var class="var">[tmp]</var>.
</p>
<p>The stream sent to the second output of <var class="var">split</var>, labelled as
<var class="var">[tmp]</var>, is processed through the <var class="var">crop</var> filter, which crops
away the lower half part of the video, and then vertically flipped. The
<var class="var">overlay</var> filter takes in input the first unchanged output of the
split filter (which was labelled as <var class="var">[main]</var>), and overlay on its
lower half the output generated by the <var class="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 class="var">source filters</var> that do not have an
audio/video input, and <var class="var">sink filters</var> that will not have audio/video
output.
</p>
</div>
<div class="chapter-level-extent" id="graph2dot">
<h2 class="chapter">22 graph2dot</h2>
<p>The <samp class="file">graph2dot</samp> program included in the FFmpeg <samp class="file">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-preformatted">graph2dot -h
</pre></div>
<p>to see how to use <samp class="file">graph2dot</samp>.
</p>
<p>You can then pass the dot description to the <samp class="file">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-preformatted">echo <var class="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 class="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-preformatted">ffmpeg -i infile -vf scale=640:360 outfile
</pre></div>
<p>your <var class="var">GRAPH_DESCRIPTION</var> string will need to be of the form:
</p><div class="example">
<pre class="example-preformatted">nullsrc,scale=640:360,nullsink
</pre></div>
<p>you may also need to set the <var class="var">nullsrc</var> parameters and add a <var class="var">format</var>
filter in order to simulate a specific input file.
</p>
</div>
<div class="chapter-level-extent" id="Filtergraph-description">
<h2 class="chapter">23 Filtergraph description</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>
<a class="anchor" id="Filtergraph-syntax"></a><ul class="mini-toc">
<li><a href="#Filtergraph-syntax-1" accesskey="1">Filtergraph syntax</a></li>
<li><a href="#Notes-on-filtergraph-escaping" accesskey="2">Notes on filtergraph escaping</a></li>
</ul>
<div class="section-level-extent" id="Filtergraph-syntax-1">
<h3 class="section">23.1 Filtergraph syntax</h3>
<p>A filtergraph has a textual representation, which is recognized by the
<samp class="option">-filter</samp>/<samp class="option">-vf</samp>/<samp class="option">-af</samp> and
<samp class="option">-filter_complex</samp> options in <code class="command">ffmpeg</code> and
<samp class="option">-vf</samp>/<samp class="option">-af</samp> in <code class="command">ffplay</code>, and by the
<code class="code">avfilter_graph_parse_ptr()</code> function defined in
<samp class="file">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 class="var">in_link_1</var>]...[<var class="var">in_link_N</var>]<var class="var">filter_name</var>@<var class="var">id</var>=<var class="var">arguments</var>[<var class="var">out_link_1</var>]...[<var class="var">out_link_M</var>]
</p>
<p><var class="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 class="var">id</var>".
The name of the filter class is optionally followed by a string
"=<var class="var">arguments</var>".
</p>
<p><var class="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 class="itemize mark-bullet">
<li>A ’:’-separated list of <var class="var">key=value</var> pairs.
</li><li>A ’:’-separated list of <var class="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 class="code">fade</code> filter
declares three options in this order – <samp class="option">type</samp>, <samp class="option">start_frame</samp> and
<samp class="option">nb_frames</samp>. Then the parameter list <var class="var">in:0:30</var> means that the value
<var class="var">in</var> is assigned to the option <samp class="option">type</samp>, <var class="var">0</var> to
<samp class="option">start_frame</samp> and <var class="var">30</var> to <samp class="option">nb_frames</samp>.
</li><li>A ’:’-separated list of mixed direct <var class="var">value</var> and long <var class="var">key=value</var>
pairs. The direct <var class="var">value</var> must precede the <var class="var">key=value</var> pairs, and
follow the same constraints order of the previous point. The following
<var class="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 class="code">format</code> filter
takes a list of pixel formats), the items in the list are usually separated by
‘<samp class="samp">|</samp>’.
</p>
<p>The list of arguments can be quoted using the character ‘<samp class="samp">'</samp>’ as initial
and ending mark, and the character ‘<samp class="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 class="samp">[]=;,</samp>’) is encountered.
</p>
<p>A special syntax implemented in the <code class="command">ffmpeg</code> CLI tool allows loading
option values from files. This is done be prepending a slash ’/’ to the option
name, then the supplied value is interpreted as a path from which the actual
value is loaded. E.g.
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i <INPUT> -vf drawtext=/text=/tmp/some_text <OUTPUT>
</pre></div>
<p>will load the text to be drawn from <samp class="file">/tmp/some_text</samp>. API users wishing to
implement a similar feature should use the <code class="code">avfilter_graph_segment_*()</code>
functions together with custom IO code.
</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 class="var">in_link_1</var>
... <var class="var">in_link_N</var>, are associated to the filter input pads,
the following labels <var class="var">out_link_1</var> ... <var class="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-preformatted">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>Leading and trailing whitespaces (space, tabs, or line feeds) separating tokens
in the filtergraph specification are ignored. This means that the filtergraph
can be expressed using empty lines and spaces to improve redability.
</p>
<p>For example, the filtergraph:
</p><div class="example">
<pre class="example-preformatted">testsrc,split[L1],hflip[L2];[L1][L2] hstack
</pre></div>
<p>can be represented as:
</p><div class="example">
<pre class="example-preformatted">testsrc,
split [L1], hflip [L2];
[L1][L2] hstack
</pre></div>
<p>Libavfilter will automatically insert <a class="ref" 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 class="code">sws_flags=<var class="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-preformatted"><var class="var">NAME</var> ::= sequence of alphanumeric characters and '_'
<var class="var">FILTER_NAME</var> ::= <var class="var">NAME</var>["@"<var class="var">NAME</var>]
<var class="var">LINKLABEL</var> ::= "[" <var class="var">NAME</var> "]"
<var class="var">LINKLABELS</var> ::= <var class="var">LINKLABEL</var> [<var class="var">LINKLABELS</var>]
<var class="var">FILTER_ARGUMENTS</var> ::= sequence of chars (possibly quoted)
<var class="var">FILTER</var> ::= [<var class="var">LINKLABELS</var>] <var class="var">FILTER_NAME</var> ["=" <var class="var">FILTER_ARGUMENTS</var>] [<var class="var">LINKLABELS</var>]
<var class="var">FILTERCHAIN</var> ::= <var class="var">FILTER</var> [,<var class="var">FILTERCHAIN</var>]
<var class="var">FILTERGRAPH</var> ::= [sws_flags=<var class="var">flags</var>;] <var class="var">FILTERCHAIN</var> [;<var class="var">FILTERGRAPH</var>]
</pre></div>
<a class="anchor" id="filtergraph-escaping"></a></div>
<div class="section-level-extent" id="Notes-on-filtergraph-escaping">
<h3 class="section">23.2 Notes on filtergraph escaping</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 class="code">:</code> used to
separate values, or one of the escaping characters <code class="code">\'</code>.
</p>
<p>A second level escaping affects the whole filter description, which
may contain the escaping characters <code class="code">\'</code> or the special
characters <code class="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 class="ref" href="#drawtext">drawtext</a> filter description <samp class="option">text</samp> value:
</p><div class="example">
<pre class="example-preformatted">this is a 'string': may contain one, or more, special characters
</pre></div>
<p>This string contains the <code class="code">'</code> special escaping character, and the
<code class="code">:</code> special character, so it needs to be escaped in this way:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
</pre></div>
<p>(note that in addition to the <code class="code">\'</code> escaping special characters,
also <code class="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 class="code">\</code> is special and needs to be escaped with another <code class="code">\</code>, the
previous string will finally result in:
</p><div class="example">
<pre class="example-preformatted">-vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
</pre></div>
<p>In order to avoid cumbersome escaping when using a commandline tool accepting a
filter specification as input, it is advisable to avoid direct inclusion of the
filter or options specification in the shell.
</p>
<p>For example, in case of the <a class="ref" href="#drawtext">drawtext filter</a>, you might prefer to
use the <samp class="option">textfile</samp> option in place of <samp class="option">text</samp> to specify the text
to render.
</p>
<p>When using the <code class="command">ffmpeg</code> tool, you might consider to use the
<a data-manual="ffmpeg" href="ffmpeg.html#filter_005fscript-option">(ffmpeg)-filter_script option</a> or
<a data-manual="ffmpeg" href="ffmpeg.html#filter_005fcomplex_005fscript-option">(ffmpeg)-filter_complex_script option</a>.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Timeline-editing">
<h2 class="chapter">24 Timeline editing</h2>
<p>Some filters support a generic <samp class="option">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 class="table">
<dt>‘<samp class="samp">t</samp>’</dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt>‘<samp class="samp">n</samp>’</dt>
<dd><p>sequential number of the input frame, starting from 0
</p>
</dd>
<dt>‘<samp class="samp">pos</samp>’</dt>
<dd><p>the position in the file of the input frame, NAN if unknown; deprecated, do
not use
</p>
</dd>
<dt>‘<samp class="samp">w</samp>’</dt>
<dt>‘<samp class="samp">h</samp>’</dt>
<dd><p>width and height of the input frame if video
</p></dd>
</dl>
<p>Additionally, these filters support an <samp class="option">enable</samp> command that can be used
to re-define the expression.
</p>
<p>Like any other filtering option, the <samp class="option">enable</samp> option follows the same
rules.
</p>
<p>For example, to enable a blur filter (<a class="ref" href="#smartblur">smartblur</a>) from 10 seconds to 3
minutes, and a <a class="ref" href="#curves">curves</a> filter starting at 3 seconds:
</p><div class="example">
<pre class="example-preformatted">smartblur = enable='between(t,10,3*60)',
curves = enable='gte(t,3)' : preset=cross_process
</pre></div>
<p>See <code class="code">ffmpeg -filters</code> to view which filters have timeline support.
</p>
<a class="anchor" id="commands"></a></div>
<div class="chapter-level-extent" id="Changing-options-at-runtime-with-a-command">
<h2 class="chapter">25 Changing options at runtime with a command</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 class="command">ffmpeg</code> <samp class="option">-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>
<a class="anchor" id="framesync"></a></div>
<div class="chapter-level-extent" id="Options-for-filters-with-several-inputs-_0028framesync_0029">
<h2 class="chapter">26 Options for filters with several inputs (framesync)</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 class="table">
<dt><samp class="option">eof_action</samp></dt>
<dd><p>The action to take when EOF is encountered on the secondary input; it accepts
one of the following values:
</p>
<dl class="table">
<dt><samp class="option">repeat</samp></dt>
<dd><p>Repeat the last frame (the default).
</p></dd>
<dt><samp class="option">endall</samp></dt>
<dd><p>End both streams.
</p></dd>
<dt><samp class="option">pass</samp></dt>
<dd><p>Pass the main input through.
</p></dd>
</dl>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p>
</dd>
<dt><samp class="option">repeatlast</samp></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>
<dt><samp class="option">ts_sync_mode</samp></dt>
<dd><p>How strictly to sync streams based on secondary input timestamps; it accepts
one of the following values:
</p>
<dl class="table">
<dt><samp class="option">default</samp></dt>
<dd><p>Frame from secondary input with the nearest lower or equal timestamp to the
primary input frame.
</p></dd>
<dt><samp class="option">nearest</samp></dt>
<dd><p>Frame from secondary input with the absolute nearest timestamp to the primary
input frame.
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="chapter-level-extent" id="Audio-Filters">
<h2 class="chapter">27 Audio Filters</h2>
<p>When you configure your FFmpeg build, you can disable any of the
existing filters using <code class="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>
<ul class="mini-toc">
<li><a href="#acompressor" accesskey="1">acompressor</a></li>
<li><a href="#acontrast" accesskey="2">acontrast</a></li>
<li><a href="#acopy" accesskey="3">acopy</a></li>
<li><a href="#acrossfade" accesskey="4">acrossfade</a></li>
<li><a href="#acrossover" accesskey="5">acrossover</a></li>
<li><a href="#acrusher" accesskey="6">acrusher</a></li>
<li><a href="#acue" accesskey="7">acue</a></li>
<li><a href="#adeclick" accesskey="8">adeclick</a></li>
<li><a href="#adeclip" accesskey="9">adeclip</a></li>
<li><a href="#adecorrelate">adecorrelate</a></li>
<li><a href="#adelay">adelay</a></li>
<li><a href="#adenorm">adenorm</a></li>
<li><a href="#aderivative_002c-aintegral">aderivative, aintegral</a></li>
<li><a href="#adrc">adrc</a></li>
<li><a href="#adynamicequalizer">adynamicequalizer</a></li>
<li><a href="#adynamicsmooth">adynamicsmooth</a></li>
<li><a href="#aecho">aecho</a></li>
<li><a href="#aemphasis">aemphasis</a></li>
<li><a href="#aeval">aeval</a></li>
<li><a href="#aexciter">aexciter</a></li>
<li><a href="#afade-1">afade</a></li>
<li><a href="#afftdn">afftdn</a></li>
<li><a href="#afftfilt">afftfilt</a></li>
<li><a href="#afir-1">afir</a></li>
<li><a href="#aformat-1">aformat</a></li>
<li><a href="#afreqshift">afreqshift</a></li>
<li><a href="#afwtdn">afwtdn</a></li>
<li><a href="#agate">agate</a></li>
<li><a href="#aiir">aiir</a></li>
<li><a href="#alimiter">alimiter</a></li>
<li><a href="#allpass">allpass</a></li>
<li><a href="#aloop">aloop</a></li>
<li><a href="#amerge-1">amerge</a></li>
<li><a href="#amix">amix</a></li>
<li><a href="#amultiply">amultiply</a></li>
<li><a href="#anequalizer">anequalizer</a></li>
<li><a href="#anlmdn">anlmdn</a></li>
<li><a href="#anlmf_002c-anlms">anlmf, anlms</a></li>
<li><a href="#anull">anull</a></li>
<li><a href="#apad">apad</a></li>
<li><a href="#aphaser">aphaser</a></li>
<li><a href="#aphaseshift">aphaseshift</a></li>
<li><a href="#apsnr">apsnr</a></li>
<li><a href="#apsyclip">apsyclip</a></li>
<li><a href="#apulsator">apulsator</a></li>
<li><a href="#aresample-1">aresample</a></li>
<li><a href="#areverse">areverse</a></li>
<li><a href="#arls">arls</a></li>
<li><a href="#arnndn">arnndn</a></li>
<li><a href="#asdr">asdr</a></li>
<li><a href="#asetnsamples">asetnsamples</a></li>
<li><a href="#asetrate">asetrate</a></li>
<li><a href="#ashowinfo">ashowinfo</a></li>
<li><a href="#asisdr">asisdr</a></li>
<li><a href="#asoftclip">asoftclip</a></li>
<li><a href="#aspectralstats">aspectralstats</a></li>
<li><a href="#asr">asr</a></li>
<li><a href="#astats-1">astats</a></li>
<li><a href="#asubboost">asubboost</a></li>
<li><a href="#asubcut">asubcut</a></li>
<li><a href="#asupercut">asupercut</a></li>
<li><a href="#asuperpass">asuperpass</a></li>
<li><a href="#asuperstop">asuperstop</a></li>
<li><a href="#atempo">atempo</a></li>
<li><a href="#atilt">atilt</a></li>
<li><a href="#atrim">atrim</a></li>
<li><a href="#axcorrelate">axcorrelate</a></li>
<li><a href="#bandpass">bandpass</a></li>
<li><a href="#bandreject">bandreject</a></li>
<li><a href="#bass_002c-lowshelf">bass, lowshelf</a></li>
<li><a href="#biquad">biquad</a></li>
<li><a href="#bs2b">bs2b</a></li>
<li><a href="#channelmap">channelmap</a></li>
<li><a href="#channelsplit">channelsplit</a></li>
<li><a href="#chorus">chorus</a></li>
<li><a href="#compand">compand</a></li>
<li><a href="#compensationdelay">compensationdelay</a></li>
<li><a href="#crossfeed">crossfeed</a></li>
<li><a href="#crystalizer">crystalizer</a></li>
<li><a href="#dcshift">dcshift</a></li>
<li><a href="#deesser">deesser</a></li>
<li><a href="#dialoguenhance">dialoguenhance</a></li>
<li><a href="#drmeter">drmeter</a></li>
<li><a href="#dynaudnorm">dynaudnorm</a></li>
<li><a href="#earwax">earwax</a></li>
<li><a href="#equalizer">equalizer</a></li>
<li><a href="#extrastereo">extrastereo</a></li>
<li><a href="#firequalizer">firequalizer</a></li>
<li><a href="#flanger">flanger</a></li>
<li><a href="#haas">haas</a></li>
<li><a href="#hdcd">hdcd</a></li>
<li><a href="#headphone">headphone</a></li>
<li><a href="#highpass">highpass</a></li>
<li><a href="#join">join</a></li>
<li><a href="#ladspa">ladspa</a></li>
<li><a href="#loudnorm">loudnorm</a></li>
<li><a href="#lowpass">lowpass</a></li>
<li><a href="#lv2">lv2</a></li>
<li><a href="#mcompand">mcompand</a></li>
<li><a href="#pan-1">pan</a></li>
<li><a href="#replaygain">replaygain</a></li>
<li><a href="#resample">resample</a></li>
<li><a href="#rubberband">rubberband</a></li>
<li><a href="#sidechaincompress">sidechaincompress</a></li>
<li><a href="#sidechaingate">sidechaingate</a></li>
<li><a href="#silencedetect">silencedetect</a></li>
<li><a href="#silenceremove">silenceremove</a></li>
<li><a href="#sofalizer">sofalizer</a></li>
<li><a href="#speechnorm">speechnorm</a></li>
<li><a href="#stereotools">stereotools</a></li>
<li><a href="#stereowiden">stereowiden</a></li>
<li><a href="#superequalizer">superequalizer</a></li>
<li><a href="#surround">surround</a></li>
<li><a href="#tiltshelf">tiltshelf</a></li>
<li><a href="#treble_002c-highshelf">treble, highshelf</a></li>
<li><a href="#tremolo">tremolo</a></li>
<li><a href="#vibrato">vibrato</a></li>
<li><a href="#virtualbass">virtualbass</a></li>
<li><a href="#volume">volume</a></li>
<li><a href="#volumedetect">volumedetect</a></li>
</ul>
<div class="section-level-extent" id="acompressor">
<h3 class="section">27.1 acompressor</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 class="code">threshold</code> and dividing it by the factor set with <code class="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 class="code">attack</code> determines how long the signal has to rise above the threshold
before any reduction will occur and <code class="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 class="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 class="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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set mode of compressor operation. Can be <code class="code">upward</code> or <code class="code">downward</code>.
Default is <code class="code">downward</code>.
</p>
</dd>
<dt><samp class="option">threshold</samp></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><samp class="option">ratio</samp></dt>
<dd><p>Set a ratio by which the signal is reduced. 1:2 means that if the level
rose 4dB above the threshold, it will be only 2dB above after the reduction.
Default is 2. Range is between 1 and 20.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction starts. Default is 20. Range is between 0.01 and 2000.
</p>
</dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before
reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
</p>
</dd>
<dt><samp class="option">makeup</samp></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><samp class="option">knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.82843. Range is between 1 and 8.
</p>
</dd>
<dt><samp class="option">link</samp></dt>
<dd><p>Choose if the <code class="code">average</code> level between all channels of input stream
or the louder(<code class="code">maximum</code>) channel of input stream affects the
reduction. Default is <code class="code">average</code>.
</p>
</dd>
<dt><samp class="option">detection</samp></dt>
<dd><p>Should the exact signal be taken in case of <code class="code">peak</code> or an RMS one in case
of <code class="code">rms</code>. Default is <code class="code">rms</code> which is mostly smoother.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>How much to use compressed signal in output. Default is 1.
Range is between 0 and 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands">
<h4 class="subsection">27.1.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="acontrast">
<h3 class="section">27.2 acontrast</h3>
<p>Simple audio dynamic range compression/expansion filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">contrast</samp></dt>
<dd><p>Set contrast. Default is 33. Allowed range is between 0 and 100.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="acopy">
<h3 class="section">27.3 acopy</h3>
<p>Copy the input audio source unchanged to the output. This is mainly useful for
testing purposes.
</p>
</div>
<div class="section-level-extent" id="acrossfade">
<h3 class="section">27.4 acrossfade</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 class="table">
<dt><samp class="option">nb_samples, ns</samp></dt>
<dd><p>Specify the number of samples for which the cross fade effect has to last.
At the end of the cross fade effect the first input audio will be completely
silent. Default is 44100.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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 class="var">nb_samples</var>.
If set this option is used instead of <var class="var">nb_samples</var>.
</p>
</dd>
<dt><samp class="option">overlap, o</samp></dt>
<dd><p>Should first stream end overlap with second stream start. Default is enabled.
</p>
</dd>
<dt><samp class="option">curve1</samp></dt>
<dd><p>Set curve for cross fade transition for first stream.
</p>
</dd>
<dt><samp class="option">curve2</samp></dt>
<dd><p>Set curve for cross fade transition for second stream.
</p>
<p>For description of available curve types see <a class="ref" href="#afade">afade</a> filter description.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-15" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-15">
<h4 class="subsection">27.4.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Cross fade from one input to another:
<div class="example">
<pre class="example-preformatted">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-preformatted">ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="acrossover">
<h3 class="section">27.5 acrossover</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 class="table">
<dt><samp class="option">split</samp></dt>
<dd><p>Set split frequencies. Those must be positive and increasing.
</p>
</dd>
<dt><samp class="option">order</samp></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 class="table">
<dt>‘<samp class="samp">2nd</samp>’</dt>
<dd><p>12 dB per octave.
</p></dd>
<dt>‘<samp class="samp">4th</samp>’</dt>
<dd><p>24 dB per octave.
</p></dd>
<dt>‘<samp class="samp">6th</samp>’</dt>
<dd><p>36 dB per octave.
</p></dd>
<dt>‘<samp class="samp">8th</samp>’</dt>
<dd><p>48 dB per octave.
</p></dd>
<dt>‘<samp class="samp">10th</samp>’</dt>
<dd><p>60 dB per octave.
</p></dd>
<dt>‘<samp class="samp">12th</samp>’</dt>
<dd><p>72 dB per octave.
</p></dd>
<dt>‘<samp class="samp">14th</samp>’</dt>
<dd><p>84 dB per octave.
</p></dd>
<dt>‘<samp class="samp">16th</samp>’</dt>
<dd><p>96 dB per octave.
</p></dd>
<dt>‘<samp class="samp">18th</samp>’</dt>
<dd><p>108 dB per octave.
</p></dd>
<dt>‘<samp class="samp">20th</samp>’</dt>
<dd><p>120 dB per octave.
</p></dd>
</dl>
<p>Default is <var class="var">4th</var>.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1.
</p>
</dd>
<dt><samp class="option">gains</samp></dt>
<dd><p>Set output gain for each band. Default value is 1 for all bands.
</p>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>Set which precision to use when processing samples.
</p>
<dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Auto pick internal sample format depending on other filters.
</p>
</dd>
<dt><samp class="option">float</samp></dt>
<dd><p>Always use single-floating point precision sample format.
</p>
</dd>
<dt><samp class="option">double</samp></dt>
<dd><p>Always use double-floating point precision sample format.
</p></dd>
</dl>
<p>Default value is <code class="code">auto</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-16" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-16">
<h4 class="subsection">27.5.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="acrusher">
<h3 class="section">27.6 acrusher</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set level in.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set level out.
</p>
</dd>
<dt><samp class="option">bits</samp></dt>
<dd><p>Set bit reduction.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>Set mixing amount.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Can be linear: <code class="code">lin</code> or logarithmic: <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">dc</samp></dt>
<dd><p>Set DC.
</p>
</dd>
<dt><samp class="option">aa</samp></dt>
<dd><p>Set anti-aliasing.
</p>
</dd>
<dt><samp class="option">samples</samp></dt>
<dd><p>Set sample reduction.
</p>
</dd>
<dt><samp class="option">lfo</samp></dt>
<dd><p>Enable LFO. By default disabled.
</p>
</dd>
<dt><samp class="option">lforange</samp></dt>
<dd><p>Set LFO range.
</p>
</dd>
<dt><samp class="option">lforate</samp></dt>
<dd><p>Set LFO rate.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-1" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-1">
<h4 class="subsection">27.6.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="acue">
<h3 class="section">27.7 acue</h3>
<p>Delay audio filtering until a given wallclock timestamp. See the <a class="ref" href="#cue">cue</a>
filter.
</p>
</div>
<div class="section-level-extent" id="adeclick">
<h3 class="section">27.8 adeclick</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 class="table">
<dt><samp class="option">window, w</samp></dt>
<dd><p>Set window size, in milliseconds. Allowed range is from <code class="code">10</code> to
<code class="code">100</code>. Default value is <code class="code">55</code> milliseconds.
This sets size of window which will be processed at once.
</p>
</dd>
<dt><samp class="option">overlap, o</samp></dt>
<dd><p>Set window overlap, in percentage of window size. Allowed range is from
<code class="code">50</code> to <code class="code">95</code>. Default value is <code class="code">75</code> percent.
Setting this to a very high value increases impulsive noise removal but makes
whole process much slower.
</p>
</dd>
<dt><samp class="option">arorder, a</samp></dt>
<dd><p>Set autoregression order, in percentage of window size. Allowed range is from
<code class="code">0</code> to <code class="code">25</code>. Default value is <code class="code">2</code> percent. This option also
controls quality of interpolated samples using neighbour good samples.
</p>
</dd>
<dt><samp class="option">threshold, t</samp></dt>
<dd><p>Set threshold value. Allowed range is from <code class="code">1</code> to <code class="code">100</code>.
Default value is <code class="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><samp class="option">burst, b</samp></dt>
<dd><p>Set burst fusion, in percentage of window size. Allowed range is <code class="code">0</code> to
<code class="code">10</code>. Default value is <code class="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><samp class="option">method, m</samp></dt>
<dd><p>Set overlap method.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">add, a</samp></dt>
<dd><p>Select overlap-add method. Even not interpolated samples are slightly
changed with this method.
</p>
</dd>
<dt><samp class="option">save, s</samp></dt>
<dd><p>Select overlap-save method. Not interpolated samples remain unchanged.
</p></dd>
</dl>
<p>Default value is <code class="code">a</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="adeclip">
<h3 class="section">27.9 adeclip</h3>
<p>Remove clipped samples from input audio.
</p>
<p>Samples detected as clipped are replaced by interpolated samples using
autoregressive modelling.
</p>
<dl class="table">
<dt><samp class="option">window, w</samp></dt>
<dd><p>Set window size, in milliseconds. Allowed range is from <code class="code">10</code> to <code class="code">100</code>.
Default value is <code class="code">55</code> milliseconds.
This sets size of window which will be processed at once.
</p>
</dd>
<dt><samp class="option">overlap, o</samp></dt>
<dd><p>Set window overlap, in percentage of window size. Allowed range is from <code class="code">50</code>
to <code class="code">95</code>. Default value is <code class="code">75</code> percent.
</p>
</dd>
<dt><samp class="option">arorder, a</samp></dt>
<dd><p>Set autoregression order, in percentage of window size. Allowed range is from
<code class="code">0</code> to <code class="code">25</code>. Default value is <code class="code">8</code> percent. This option also controls
quality of interpolated samples using neighbour good samples.
</p>
</dd>
<dt><samp class="option">threshold, t</samp></dt>
<dd><p>Set threshold value. Allowed range is from <code class="code">1</code> to <code class="code">100</code>.
Default value is <code class="code">10</code>. Higher values make clip detection less aggressive.
</p>
</dd>
<dt><samp class="option">hsize, n</samp></dt>
<dd><p>Set size of histogram used to detect clips. Allowed range is from <code class="code">100</code> to <code class="code">9999</code>.
Default value is <code class="code">1000</code>. Higher values make clip detection less aggressive.
</p>
</dd>
<dt><samp class="option">method, m</samp></dt>
<dd><p>Set overlap method.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">add, a</samp></dt>
<dd><p>Select overlap-add method. Even not interpolated samples are slightly changed
with this method.
</p>
</dd>
<dt><samp class="option">save, s</samp></dt>
<dd><p>Select overlap-save method. Not interpolated samples remain unchanged.
</p></dd>
</dl>
<p>Default value is <code class="code">a</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="adecorrelate">
<h3 class="section">27.10 adecorrelate</h3>
<p>Apply decorrelation to input audio stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">stages</samp></dt>
<dd><p>Set decorrelation stages of filtering. Allowed
range is from 1 to 16. Default value is 6.
</p>
</dd>
<dt><samp class="option">seed</samp></dt>
<dd><p>Set random seed used for setting delay in samples across channels.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="adelay">
<h3 class="section">27.11 adelay</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 class="table">
<dt><samp class="option">delays</samp></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><samp class="option">all</samp></dt>
<dd><p>Use last set delay for all remaining channels. By default is disabled.
This option if enabled changes how option <code class="code">delays</code> is interpreted.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-17" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-17">
<h4 class="subsection">27.11.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">adelay=0|500S|700S
</pre></div>
</li><li>Delay all channels by same number of samples:
<div class="example">
<pre class="example-preformatted">adelay=delays=64S:all=1
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="adenorm">
<h3 class="section">27.12 adenorm</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 class="table">
<dt><samp class="option">level</samp></dt>
<dd><p>Set level of added noise in dB. Default is <code class="code">-351</code>.
Allowed range is from -451 to -90.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set type of added noise.
</p>
<dl class="table">
<dt><samp class="option">dc</samp></dt>
<dd><p>Add DC signal.
</p></dd>
<dt><samp class="option">ac</samp></dt>
<dd><p>Add AC signal.
</p></dd>
<dt><samp class="option">square</samp></dt>
<dd><p>Add square signal.
</p></dd>
<dt><samp class="option">pulse</samp></dt>
<dd><p>Add pulse signal.
</p></dd>
</dl>
<p>Default is <code class="code">dc</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-2" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-2">
<h4 class="subsection">27.12.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="aderivative_002c-aintegral">
<h3 class="section">27.13 aderivative, aintegral</h3>
<p>Compute derivative/integral of audio stream.
</p>
<p>Applying both filters one after another produces original audio.
</p>
</div>
<div class="section-level-extent" id="adrc">
<h3 class="section">27.14 adrc</h3>
<p>Apply spectral dynamic range controller filter to input audio stream.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">transfer</samp></dt>
<dd><p>Set the transfer expression.
</p>
<p>The expression can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">ch</samp></dt>
<dd><p>current channel number
</p>
</dd>
<dt><samp class="option">sn</samp></dt>
<dd><p>current sample number
</p>
</dd>
<dt><samp class="option">nb_channels</samp></dt>
<dd><p>number of channels
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>timestamp expressed in seconds
</p>
</dd>
<dt><samp class="option">sr</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp class="option">p</samp></dt>
<dd><p>current frequency power value, in dB
</p>
</dd>
<dt><samp class="option">f</samp></dt>
<dd><p>current frequency in Hz
</p></dd>
</dl>
<p>Default value is <code class="code">p</code>.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Set the attack in milliseconds. Default is <code class="code">50</code> milliseconds.
Allowed range is from 1 to 1000 milliseconds.
</p></dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Set the release in milliseconds. Default is <code class="code">100</code> milliseconds.
Allowed range is from 5 to 2000 milliseconds.
</p></dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set which channels to filter, by default <code class="code">all</code> channels in audio stream are filtered.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-3" accesskey="1">Commands</a></li>
<li><a href="#Examples-18" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-3">
<h4 class="subsection">27.14.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-18">
<h4 class="subsection">27.14.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply spectral compression to all frequencies with threshold of -50 dB and 1:6 ratio:
<div class="example">
<pre class="example-preformatted">adrc=transfer='if(gt(p,-50),-50+(p-(-50))/6,p)':attack=50:release=100
</pre></div>
</li><li>Similar to above but with 1:2 ratio and filtering only front center channel:
<div class="example">
<pre class="example-preformatted">adrc=transfer='if(gt(p,-50),-50+(p-(-50))/2,p)':attack=50:release=100:channels=FC
</pre></div>
</li><li>Apply spectral noise gate to all frequencies with threshold of -85 dB and with short attack time and short release time:
<div class="example">
<pre class="example-preformatted">adrc=transfer='if(lte(p,-85),p-800,p)':attack=1:release=5
</pre></div>
</li><li>Apply spectral expansion to all frequencies with threshold of -10 dB and 1:2 ratio:
<div class="example">
<pre class="example-preformatted">adrc=transfer='if(lt(p,-10),-10+(p-(-10))*2,p)':attack=50:release=100
</pre></div>
</li><li>Apply limiter to max -60 dB to all frequencies, with attack of 2 ms and release of 10 ms:
<div class="example">
<pre class="example-preformatted">adrc=transfer='min(p,-60)':attack=2:release=10
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="adynamicequalizer">
<h3 class="section">27.15 adynamicequalizer</h3>
<p>Apply dynamic equalization to input audio stream.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">threshold</samp></dt>
<dd><p>Set the detection threshold used to trigger equalization.
Threshold detection is using detection filter.
Default value is 0. Allowed range is from 0 to 100.
</p>
</dd>
<dt><samp class="option">dfrequency</samp></dt>
<dd><p>Set the detection frequency in Hz used for detection filter used to trigger equalization.
Default value is 1000 Hz. Allowed range is between 2 and 1000000 Hz.
</p>
</dd>
<dt><samp class="option">dqfactor</samp></dt>
<dd><p>Set the detection resonance factor for detection filter used to trigger equalization.
Default value is 1. Allowed range is from 0.001 to 1000.
</p>
</dd>
<dt><samp class="option">tfrequency</samp></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><samp class="option">tqfactor</samp></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><samp class="option">attack</samp></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><samp class="option">release</samp></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><samp class="option">ratio</samp></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><samp class="option">makeup</samp></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><samp class="option">range</samp></dt>
<dd><p>Set the max allowed cut/boost amount. Default is 50.
Allowed range is from 1 to 200.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the mode of filter operation, can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">listen</samp>’</dt>
<dd><p>Output only isolated detection signal.
</p></dd>
<dt>‘<samp class="samp">cut</samp>’</dt>
<dd><p>Cut frequencies above detection threshold.
</p></dd>
<dt>‘<samp class="samp">boost</samp>’</dt>
<dd><p>Boost frequencies bellow detection threshold.
</p></dd>
</dl>
<p>Default mode is ‘<samp class="samp">cut</samp>’.
</p>
</dd>
<dt><samp class="option">dftype</samp></dt>
<dd><p>Set the type of detection filter, can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">bandpass</samp>’</dt>
<dt>‘<samp class="samp">lowpass</samp>’</dt>
<dt>‘<samp class="samp">highpass</samp>’</dt>
<dt>‘<samp class="samp">peak</samp>’</dt>
</dl>
<p>Default type is ‘<samp class="samp">bandpass</samp>’.
</p>
</dd>
<dt><samp class="option">tftype</samp></dt>
<dd><p>Set the type of target filter, can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">bell</samp>’</dt>
<dt>‘<samp class="samp">lowshelf</samp>’</dt>
<dt>‘<samp class="samp">highshelf</samp>’</dt>
</dl>
<p>Default type is ‘<samp class="samp">bell</samp>’.
</p>
</dd>
<dt><samp class="option">direction</samp></dt>
<dd><p>Set processing direction relative to threshold.
</p><dl class="table">
<dt>‘<samp class="samp">downward</samp>’</dt>
<dd><p>Boost/Cut if threshold is higher/lower than detected volume.
</p></dd>
<dt>‘<samp class="samp">upward</samp>’</dt>
<dd><p>Boost/Cut if threshold is lower/higher than detected volume.
</p></dd>
</dl>
<p>Default direction is ‘<samp class="samp">downward</samp>’.
</p>
</dd>
<dt><samp class="option">auto</samp></dt>
<dd><p>Automatically gather threshold from detection filter. By default
is ‘<samp class="samp">disabled</samp>’.
This option is useful to detect threshold in certain time frame of
input audio stream, in such case option value is changed at runtime.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">disabled</samp>’</dt>
<dd><p>Disable using automatically gathered threshold value.
</p></dd>
<dt>‘<samp class="samp">off</samp>’</dt>
<dd><p>Stop picking threshold value.
</p></dd>
<dt>‘<samp class="samp">on</samp>’</dt>
<dd><p>Start picking threshold value.
</p></dd>
</dl>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>Set which precision to use when processing samples.
</p>
<dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Auto pick internal sample format depending on other filters.
</p>
</dd>
<dt><samp class="option">float</samp></dt>
<dd><p>Always use single-floating point precision sample format.
</p>
</dd>
<dt><samp class="option">double</samp></dt>
<dd><p>Always use double-floating point precision sample format.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-4" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-4">
<h4 class="subsection">27.15.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="adynamicsmooth">
<h3 class="section">27.16 adynamicsmooth</h3>
<p>Apply dynamic smoothing to input audio stream.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">sensitivity</samp></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><samp class="option">basefreq</samp></dt>
<dd><p>Set a base frequency for smoothing. Default value is 22050.
Allowed range is from 2 to 1e+06.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-5" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-5">
<h4 class="subsection">27.16.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="aecho">
<h3 class="section">27.17 aecho</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 class="code">delay</code>, and the
loudness of the reflected signal is the <code class="code">decay</code>.
Multiple echoes can have different delays and decays.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl class="table">
<dt><samp class="option">in_gain</samp></dt>
<dd><p>Set input gain of reflected signal. Default is <code class="code">0.6</code>.
</p>
</dd>
<dt><samp class="option">out_gain</samp></dt>
<dd><p>Set output gain of reflected signal. Default is <code class="code">0.3</code>.
</p>
</dd>
<dt><samp class="option">delays</samp></dt>
<dd><p>Set list of time intervals in milliseconds between original signal and reflections
separated by ’|’. Allowed range for each <code class="code">delay</code> is <code class="code">(0 - 90000.0]</code>.
Default is <code class="code">1000</code>.
</p>
</dd>
<dt><samp class="option">decays</samp></dt>
<dd><p>Set list of loudness of reflected signals separated by ’|’.
Allowed range for each <code class="code">decay</code> is <code class="code">(0 - 1.0]</code>.
Default is <code class="code">0.5</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-19" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-19">
<h4 class="subsection">27.17.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make it sound as if there are twice as many instruments as are actually playing:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">aecho=0.8:0.9:1000|1800:0.3|0.25
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="aemphasis">
<h3 class="section">27.18 aemphasis</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output gain.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set filter mode. For restoring material use <code class="code">reproduction</code> mode, otherwise
use <code class="code">production</code> mode. Default is <code class="code">reproduction</code> mode.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set filter type. Selects medium. Can be one of the following:
</p>
<dl class="table">
<dt><samp class="option">col</samp></dt>
<dd><p>select Columbia.
</p></dd>
<dt><samp class="option">emi</samp></dt>
<dd><p>select EMI.
</p></dd>
<dt><samp class="option">bsi</samp></dt>
<dd><p>select BSI (78RPM).
</p></dd>
<dt><samp class="option">riaa</samp></dt>
<dd><p>select RIAA.
</p></dd>
<dt><samp class="option">cd</samp></dt>
<dd><p>select Compact Disc (CD).
</p></dd>
<dt><samp class="option">50fm</samp></dt>
<dd><p>select 50µs (FM).
</p></dd>
<dt><samp class="option">75fm</samp></dt>
<dd><p>select 75µs (FM).
</p></dd>
<dt><samp class="option">50kf</samp></dt>
<dd><p>select 50µs (FM-KF).
</p></dd>
<dt><samp class="option">75kf</samp></dt>
<dd><p>select 75µs (FM-KF).
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-6" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-6">
<h4 class="subsection">27.18.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="aeval">
<h3 class="section">27.19 aeval</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 class="table">
<dt><samp class="option">exprs</samp></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><samp class="option">channel_layout, c</samp></dt>
<dd><p>Set output channel layout. If not specified, the channel layout is
specified by the number of expressions. If set to ‘<samp class="samp">same</samp>’, it will
use by default the same input channel layout.
</p></dd>
</dl>
<p>Each expression in <var class="var">exprs</var> can contain the following constants and functions:
</p>
<dl class="table">
<dt><samp class="option">ch</samp></dt>
<dd><p>channel number of the current expression
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>number of the evaluated sample, starting from 0
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>time of the evaluated sample expressed in seconds
</p>
</dd>
<dt><samp class="option">nb_in_channels</samp></dt>
<dt><samp class="option">nb_out_channels</samp></dt>
<dd><p>input and output number of channels
</p>
</dd>
<dt><samp class="option">val(CH)</samp></dt>
<dd><p>the value of input channel with number <var class="var">CH</var>
</p></dd>
</dl>
<p>Note: this filter is slow. For faster processing you should use a
dedicated filter.
</p>
<ul class="mini-toc">
<li><a href="#Examples-20" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-20">
<h4 class="subsection">27.19.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Half volume:
<div class="example">
<pre class="example-preformatted">aeval=val(ch)/2:c=same
</pre></div>
</li><li>Invert phase of the second channel:
<div class="example">
<pre class="example-preformatted">aeval=val(0)|-val(1)
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="aexciter">
<h3 class="section">27.20 aexciter</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input level prior processing of signal.
Allowed range is from 0 to 64.
Default value is 1.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output level after processing of signal.
Allowed range is from 0 to 64.
Default value is 1.
</p>
</dd>
<dt><samp class="option">amount</samp></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><samp class="option">drive</samp></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><samp class="option">blend</samp></dt>
<dd><p>Set the octave of newly created harmonics.
Allowed range is from -10 to 10.
Default value is 0.
</p>
</dd>
<dt><samp class="option">freq</samp></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><samp class="option">ceil</samp></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><samp class="option">listen</samp></dt>
<dd><p>Mute the original signal and output only added harmonics.
By default is disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-7" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-7">
<h4 class="subsection">27.20.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
<a class="anchor" id="afade"></a></div>
</div>
<div class="section-level-extent" id="afade-1">
<h3 class="section">27.21 afade</h3>
<p>Apply fade-in/out effect to input audio.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl class="table">
<dt><samp class="option">type, t</samp></dt>
<dd><p>Specify the effect type, can be either <code class="code">in</code> for fade-in, or
<code class="code">out</code> for a fade-out effect. Default is <code class="code">in</code>.
</p>
</dd>
<dt><samp class="option">start_sample, ss</samp></dt>
<dd><p>Specify the number of the start sample for starting to apply the fade
effect. Default is 0.
</p>
</dd>
<dt><samp class="option">nb_samples, ns</samp></dt>
<dd><p>Specify the number of samples for which the fade effect has to last. At
the end of the fade-in effect the output audio will have the same
volume as the input audio, at the end of the fade-out transition
the output audio will be silence. Default is 44100.
</p>
</dd>
<dt><samp class="option">start_time, st</samp></dt>
<dd><p>Specify the start time of the fade effect. Default is 0.
The value must be specified as a time duration; see
<a 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 class="var">start_sample</var>.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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 class="var">nb_samples</var>.
If set this option is used instead of <var class="var">nb_samples</var>.
</p>
</dd>
<dt><samp class="option">curve</samp></dt>
<dd><p>Set curve for fade transition.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">tri</samp></dt>
<dd><p>select triangular, linear slope (default)
</p></dd>
<dt><samp class="option">qsin</samp></dt>
<dd><p>select quarter of sine wave
</p></dd>
<dt><samp class="option">hsin</samp></dt>
<dd><p>select half of sine wave
</p></dd>
<dt><samp class="option">esin</samp></dt>
<dd><p>select exponential sine wave
</p></dd>
<dt><samp class="option">log</samp></dt>
<dd><p>select logarithmic
</p></dd>
<dt><samp class="option">ipar</samp></dt>
<dd><p>select inverted parabola
</p></dd>
<dt><samp class="option">qua</samp></dt>
<dd><p>select quadratic
</p></dd>
<dt><samp class="option">cub</samp></dt>
<dd><p>select cubic
</p></dd>
<dt><samp class="option">squ</samp></dt>
<dd><p>select square root
</p></dd>
<dt><samp class="option">cbr</samp></dt>
<dd><p>select cubic root
</p></dd>
<dt><samp class="option">par</samp></dt>
<dd><p>select parabola
</p></dd>
<dt><samp class="option">exp</samp></dt>
<dd><p>select exponential
</p></dd>
<dt><samp class="option">iqsin</samp></dt>
<dd><p>select inverted quarter of sine wave
</p></dd>
<dt><samp class="option">ihsin</samp></dt>
<dd><p>select inverted half of sine wave
</p></dd>
<dt><samp class="option">dese</samp></dt>
<dd><p>select double-exponential seat
</p></dd>
<dt><samp class="option">desi</samp></dt>
<dd><p>select double-exponential sigmoid
</p></dd>
<dt><samp class="option">losi</samp></dt>
<dd><p>select logistic sigmoid
</p></dd>
<dt><samp class="option">sinc</samp></dt>
<dd><p>select sine cardinal function
</p></dd>
<dt><samp class="option">isinc</samp></dt>
<dd><p>select inverted sine cardinal function
</p></dd>
<dt><samp class="option">quat</samp></dt>
<dd><p>select quartic
</p></dd>
<dt><samp class="option">quatr</samp></dt>
<dd><p>select quartic root
</p></dd>
<dt><samp class="option">qsin2</samp></dt>
<dd><p>select squared quarter of sine wave
</p></dd>
<dt><samp class="option">hsin2</samp></dt>
<dd><p>select squared half of sine wave
</p></dd>
<dt><samp class="option">nofade</samp></dt>
<dd><p>no fade applied
</p></dd>
</dl>
</dd>
<dt><samp class="option">silence</samp></dt>
<dd><p>Set the initial gain for fade-in or final gain for fade-out.
Default value is <code class="code">0.0</code>.
</p>
</dd>
<dt><samp class="option">unity</samp></dt>
<dd><p>Set the initial gain for fade-out or final gain for fade-in.
Default value is <code class="code">1.0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-8" accesskey="1">Commands</a></li>
<li><a href="#Examples-21" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-8">
<h4 class="subsection">27.21.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-21">
<h4 class="subsection">27.21.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Fade in first 15 seconds of audio:
<div class="example">
<pre class="example-preformatted">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-preformatted">afade=t=out:st=875:d=25
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="afftdn">
<h3 class="section">27.22 afftdn</h3>
<p>Denoise audio samples with FFT.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl class="table">
<dt><samp class="option">noise_reduction, nr</samp></dt>
<dd><p>Set the noise reduction in dB, allowed range is 0.01 to 97.
Default value is 12 dB.
</p>
</dd>
<dt><samp class="option">noise_floor, nf</samp></dt>
<dd><p>Set the noise floor in dB, allowed range is -80 to -20.
Default value is -50 dB.
</p>
</dd>
<dt><samp class="option">noise_type, nt</samp></dt>
<dd><p>Set the noise type.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">white, w</samp></dt>
<dd><p>Select white noise.
</p>
</dd>
<dt><samp class="option">vinyl, v</samp></dt>
<dd><p>Select vinyl noise.
</p>
</dd>
<dt><samp class="option">shellac, s</samp></dt>
<dd><p>Select shellac noise.
</p>
</dd>
<dt><samp class="option">custom, c</samp></dt>
<dd><p>Select custom noise, defined in <code class="code">bn</code> option.
</p>
<p>Default value is white noise.
</p></dd>
</dl>
</dd>
<dt><samp class="option">band_noise, bn</samp></dt>
<dd><p>Set custom band noise profile for every one of 15 bands.
Bands are separated by ’ ’ or ’|’.
</p>
</dd>
<dt><samp class="option">residual_floor, rf</samp></dt>
<dd><p>Set the residual floor in dB, allowed range is -80 to -20.
Default value is -38 dB.
</p>
</dd>
<dt><samp class="option">track_noise, tn</samp></dt>
<dd><p>Enable noise floor tracking. By default is disabled.
With this enabled, noise floor is automatically adjusted.
</p>
</dd>
<dt><samp class="option">track_residual, tr</samp></dt>
<dd><p>Enable residual tracking. By default is disabled.
</p>
</dd>
<dt><samp class="option">output_mode, om</samp></dt>
<dd><p>Set the output mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">input, i</samp></dt>
<dd><p>Pass input unchanged.
</p>
</dd>
<dt><samp class="option">output, o</samp></dt>
<dd><p>Pass noise filtered out.
</p>
</dd>
<dt><samp class="option">noise, n</samp></dt>
<dd><p>Pass only noise.
</p>
<p>Default value is <var class="var">output</var>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">adaptivity, ad</samp></dt>
<dd><p>Set the adaptivity factor, used how fast to adapt gains adjustments per
each frequency bin. Value <var class="var">0</var> enables instant adaptation, while higher values
react much slower.
Allowed range is from <var class="var">0</var> to <var class="var">1</var>. Default value is <var class="var">0.5</var>.
</p>
</dd>
<dt><samp class="option">floor_offset, fo</samp></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 class="var">-2.0</var> to <var class="var">2.0</var>. Default value is <var class="var">1.0</var>.
</p>
</dd>
<dt><samp class="option">noise_link, nl</samp></dt>
<dd><p>Set the noise link used for multichannel audio.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">none</samp></dt>
<dd><p>Use unchanged channel’s noise floor.
</p>
</dd>
<dt><samp class="option">min</samp></dt>
<dd><p>Use measured min noise floor of all channels.
</p>
</dd>
<dt><samp class="option">max</samp></dt>
<dd><p>Use measured max noise floor of all channels.
</p>
</dd>
<dt><samp class="option">average</samp></dt>
<dd><p>Use measured average noise floor of all channels.
</p>
<p>Default value is <var class="var">min</var>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">band_multiplier, bm</samp></dt>
<dd><p>Set the band multiplier factor, used how much to spread bands across frequency bins.
Allowed range is from <var class="var">0.2</var> to <var class="var">5</var>. Default value is <var class="var">1.25</var>.
</p>
</dd>
<dt><samp class="option">sample_noise, sn</samp></dt>
<dd><p>Toggle capturing and measurement of noise profile from input audio.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">start, begin</samp></dt>
<dd><p>Start sample noise capture.
</p>
</dd>
<dt><samp class="option">stop, end</samp></dt>
<dd><p>Stop sample noise capture and measure new noise band profile.
</p>
<p>Default value is <code class="code">none</code>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">gain_smooth, gs</samp></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 class="code">0</code> to <code class="code">50</code>.
Default value is <code class="code">0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-9" accesskey="1">Commands</a></li>
<li><a href="#Examples-22" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-9">
<h4 class="subsection">27.22.1 Commands</h4>
<p>This filter supports the some above mentioned options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-22">
<h4 class="subsection">27.22.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Reduce white noise by 10dB, and use previously measured noise floor of -40dB:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">asendcmd=0.0 afftdn sn start,asendcmd=0.4 afftdn sn stop,afftdn=nr=20:nf=-40
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="afftfilt">
<h3 class="section">27.23 afftfilt</h3>
<p>Apply arbitrary expressions to samples in frequency domain.
</p>
<dl class="table">
<dt><samp class="option">real</samp></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><samp class="option">imag</samp></dt>
<dd><p>Set frequency domain imaginary expression for each separate channel
separated by ’|’. Default is "im".
</p>
<p>Each expression in <var class="var">real</var> and <var class="var">imag</var> can contain the following
constants and functions:
</p>
<dl class="table">
<dt><samp class="option">sr</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp class="option">b</samp></dt>
<dd><p>current frequency bin number
</p>
</dd>
<dt><samp class="option">nb</samp></dt>
<dd><p>number of available bins
</p>
</dd>
<dt><samp class="option">ch</samp></dt>
<dd><p>channel number of the current expression
</p>
</dd>
<dt><samp class="option">chs</samp></dt>
<dd><p>number of channels
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>current frame pts
</p>
</dd>
<dt><samp class="option">re</samp></dt>
<dd><p>current real part of frequency bin of current channel
</p>
</dd>
<dt><samp class="option">im</samp></dt>
<dd><p>current imaginary part of frequency bin of current channel
</p>
</dd>
<dt><samp class="option">real(b, ch)</samp></dt>
<dd><p>Return the value of real part of frequency bin at location (<var class="var">bin</var>,<var class="var">channel</var>)
</p>
</dd>
<dt><samp class="option">imag(b, ch)</samp></dt>
<dd><p>Return the value of imaginary part of frequency bin at location (<var class="var">bin</var>,<var class="var">channel</var>)
</p></dd>
</dl>
</dd>
<dt><samp class="option">win_size</samp></dt>
<dd><p>Set window size. Allowed range is from 16 to 131072.
Default is <code class="code">4096</code>
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann, hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set window overlap. If set to 1, the recommended overlap for selected
window function will be picked. Default is <code class="code">0.75</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-23" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-23">
<h4 class="subsection">27.23.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Leave almost only low frequencies in audio:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">afftfilt="real=re*cos(1)-im*sin(1):imag=re*sin(1)+im*cos(1)"
</pre></div>
</li></ul>
<a class="anchor" id="afir"></a></div>
</div>
<div class="section-level-extent" id="afir-1">
<h3 class="section">27.24 afir</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 class="table">
<dt><samp class="option">dry</samp></dt>
<dd><p>Set dry gain. This sets input gain.
</p>
</dd>
<dt><samp class="option">wet</samp></dt>
<dd><p>Set wet gain. This sets final output gain.
</p>
</dd>
<dt><samp class="option">length</samp></dt>
<dd><p>Set Impulse Response filter length. Default is 1, which means whole IR is processed.
</p>
</dd>
<dt><samp class="option">gtype</samp></dt>
<dd><p>Enable applying gain measured from power of IR.
</p>
<p>Set which approach to use for auto gain measurement.
</p>
<dl class="table">
<dt><samp class="option">none</samp></dt>
<dd><p>Do not apply any gain.
</p>
</dd>
<dt><samp class="option">peak</samp></dt>
<dd><p>select peak gain, very conservative approach. This is default value.
</p>
</dd>
<dt><samp class="option">dc</samp></dt>
<dd><p>select DC gain, limited application.
</p>
</dd>
<dt><samp class="option">gn</samp></dt>
<dd><p>select gain to noise approach, this is most popular one.
</p>
</dd>
<dt><samp class="option">ac</samp></dt>
<dd><p>select AC gain.
</p>
</dd>
<dt><samp class="option">rms</samp></dt>
<dd><p>select RMS gain.
</p></dd>
</dl>
</dd>
<dt><samp class="option">irgain</samp></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 class="var">gtype</var> option.
</p>
</dd>
<dt><samp class="option">irfmt</samp></dt>
<dd><p>Set format of IR stream. Can be <code class="code">mono</code> or <code class="code">input</code>.
Default is <code class="code">input</code>.
</p>
</dd>
<dt><samp class="option">maxir</samp></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><samp class="option">response</samp></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><samp class="option">channel</samp></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 class="var">response</var> is enabled.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set video stream size. This option is used only when <var class="var">response</var> is enabled.
</p>
</dd>
<dt><samp class="option">rate</samp></dt>
<dd><p>Set video stream frame rate. This option is used only when <var class="var">response</var> is enabled.
</p>
</dd>
<dt><samp class="option">minp</samp></dt>
<dd><p>Set minimal partition size used for convolution. Default is <var class="var">8192</var>.
Allowed range is from <var class="var">1</var> to <var class="var">65536</var>.
Lower values decreases latency at cost of higher CPU usage.
</p>
</dd>
<dt><samp class="option">maxp</samp></dt>
<dd><p>Set maximal partition size used for convolution. Default is <var class="var">8192</var>.
Allowed range is from <var class="var">8</var> to <var class="var">65536</var>.
Lower values may increase CPU usage.
</p>
</dd>
<dt><samp class="option">nbirs</samp></dt>
<dd><p>Set number of input impulse responses streams which will be switchable at runtime.
Allowed range is from <var class="var">1</var> to <var class="var">32</var>. Default is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">ir</samp></dt>
<dd><p>Set IR stream which will be used for convolution, starting from <var class="var">0</var>, should always be
lower than supplied value by <code class="code">nbirs</code> option. Default is <var class="var">0</var>.
This option can be changed at runtime via <a class="ref" href="#commands">commands</a>.
</p>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>Set which precision to use when processing samples.
</p>
<dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Auto pick internal sample format depending on other filters.
</p>
</dd>
<dt><samp class="option">float</samp></dt>
<dd><p>Always use single-floating point precision sample format.
</p>
</dd>
<dt><samp class="option">double</samp></dt>
<dd><p>Always use double-floating point precision sample format.
</p></dd>
</dl>
<p>Default value is auto.
</p>
</dd>
<dt><samp class="option">irload</samp></dt>
<dd><p>Set when to load IR stream. Can be <code class="code">init</code> or <code class="code">access</code>.
First one load and prepares all IRs on initialization, second one
once on first access of specific IR.
Default is <code class="code">init</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-24" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-24">
<h4 class="subsection">27.24.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply reverb to stream using mono IR file as second input, complete command using ffmpeg:
<div class="example">
<pre class="example-preformatted">ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
</pre></div>
</li><li>Apply true stereo processing given input stereo stream, and two stereo impulse responses for left and right channel,
the impulse response files are files with names l_ir.wav and r_ir.wav:
<div class="example">
<pre class="example-preformatted">"pan=4C|c0=FL|c1=FL|c2=FR|c3=FR[a];amovie=l_ir.wav[LIR];amovie=r_ir.wav[RIR];[LIR][RIR]amerge[ir];[a][ir]afir=irfmt=input:gtype=gn:irgain=-5dB,pan=stereo|FL<c0+c2|FR<c1+c3"
</pre></div>
</li></ul>
<a class="anchor" id="aformat"></a></div>
</div>
<div class="section-level-extent" id="aformat-1">
<h3 class="section">27.25 aformat</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 class="table">
<dt><samp class="option">sample_fmts, f</samp></dt>
<dd><p>A ’|’-separated list of requested sample formats.
</p>
</dd>
<dt><samp class="option">sample_rates, r</samp></dt>
<dd><p>A ’|’-separated list of requested sample rates.
</p>
</dd>
<dt><samp class="option">channel_layouts, cl</samp></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-preformatted">aformat=sample_fmts=u8|s16:channel_layouts=stereo
</pre></div>
</div>
<div class="section-level-extent" id="afreqshift">
<h3 class="section">27.26 afreqshift</h3>
<p>Apply frequency shift to input audio samples.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">shift</samp></dt>
<dd><p>Specify frequency shift. Allowed range is -INT_MAX to INT_MAX.
Default value is 0.0.
</p>
</dd>
<dt><samp class="option">level</samp></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><samp class="option">order</samp></dt>
<dd><p>Set filter order used for filtering. Allowed range is from 1 to 16.
Default value is 8.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-10" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-10">
<h4 class="subsection">27.26.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="afwtdn">
<h3 class="section">27.27 afwtdn</h3>
<p>Reduce broadband noise from input samples using Wavelets.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">sigma</samp></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><samp class="option">levels</samp></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><samp class="option">wavet</samp></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 class="table">
<dt>‘<samp class="samp">sym2</samp>’</dt>
<dt>‘<samp class="samp">sym4</samp>’</dt>
<dt>‘<samp class="samp">rbior68</samp>’</dt>
<dt>‘<samp class="samp">deb10</samp>’</dt>
<dt>‘<samp class="samp">sym10</samp>’</dt>
<dt>‘<samp class="samp">coif5</samp>’</dt>
<dt>‘<samp class="samp">bl3</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">percent</samp></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><samp class="option">profile</samp></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><samp class="option">adaptive</samp></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><samp class="option">samples</samp></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><samp class="option">softness</samp></dt>
<dd><p>Set softness applied inside thresholding function. Allowed range is from 0 to
10. Default softness is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-11" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-11">
<h4 class="subsection">27.27.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="agate">
<h3 class="section">27.28 agate</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 class="var">threshold</var>
and dividing it by the factor set with <var class="var">ratio</var>. The bottom of the noise
floor is set via <var class="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 class="var">attack</var> and <var class="var">release</var>.
</p>
<p><var class="var">attack</var> determines how long the signal has to fall below the threshold
before any reduction will occur and <var class="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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input level before filtering.
Default is 1. Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the mode of operation. Can be <code class="code">upward</code> or <code class="code">downward</code>.
Default is <code class="code">downward</code>. If set to <code class="code">upward</code> mode, higher parts of signal
will be amplified, expanding dynamic range in upward direction.
Otherwise, in case of <code class="code">downward</code> lower parts of signal will be reduced.
</p>
</dd>
<dt><samp class="option">range</samp></dt>
<dd><p>Set the level of gain reduction when the signal is below the threshold.
Default is 0.06125. Allowed range is from 0 to 1.
Setting this to 0 disables reduction and then filter behaves like expander.
</p>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>If a signal rises above this level the gain reduction is released.
Default is 0.125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp class="option">ratio</samp></dt>
<dd><p>Set a ratio by which the signal is reduced.
Default is 2. Allowed range is from 1 to 9000.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction stops.
Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before the
reduction is increased again. Default is 250 milliseconds.
Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp class="option">makeup</samp></dt>
<dd><p>Set amount of amplification of signal after processing.
Default is 1. Allowed range is from 1 to 64.
</p>
</dd>
<dt><samp class="option">knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.828427125. Allowed range is from 1 to 8.
</p>
</dd>
<dt><samp class="option">detection</samp></dt>
<dd><p>Choose if exact signal should be taken for detection or an RMS like one.
Default is <code class="code">rms</code>. Can be <code class="code">peak</code> or <code class="code">rms</code>.
</p>
</dd>
<dt><samp class="option">link</samp></dt>
<dd><p>Choose if the average level between all channels or the louder channel affects
the reduction.
Default is <code class="code">average</code>. Can be <code class="code">average</code> or <code class="code">maximum</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-12" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-12">
<h4 class="subsection">27.28.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="aiir">
<h3 class="section">27.29 aiir</h3>
<p>Apply an arbitrary Infinite Impulse Response filter.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">zeros, z</samp></dt>
<dd><p>Set B/numerator/zeros/reflection coefficients.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set A/denominator/poles/ladder coefficients.
</p>
</dd>
<dt><samp class="option">gains, k</samp></dt>
<dd><p>Set channels gains.
</p>
</dd>
<dt><samp class="option">dry_gain</samp></dt>
<dd><p>Set input gain.
</p>
</dd>
<dt><samp class="option">wet_gain</samp></dt>
<dd><p>Set output gain.
</p>
</dd>
<dt><samp class="option">format, f</samp></dt>
<dd><p>Set coefficients format.
</p>
<dl class="table">
<dt>‘<samp class="samp">ll</samp>’</dt>
<dd><p>lattice-ladder function
</p></dd>
<dt>‘<samp class="samp">sf</samp>’</dt>
<dd><p>analog transfer function
</p></dd>
<dt>‘<samp class="samp">tf</samp>’</dt>
<dd><p>digital transfer function
</p></dd>
<dt>‘<samp class="samp">zp</samp>’</dt>
<dd><p>Z-plane zeros/poles, cartesian (default)
</p></dd>
<dt>‘<samp class="samp">pr</samp>’</dt>
<dd><p>Z-plane zeros/poles, polar radians
</p></dd>
<dt>‘<samp class="samp">pd</samp>’</dt>
<dd><p>Z-plane zeros/poles, polar degrees
</p></dd>
<dt>‘<samp class="samp">sp</samp>’</dt>
<dd><p>S-plane zeros/poles
</p></dd>
</dl>
</dd>
<dt><samp class="option">process, r</samp></dt>
<dd><p>Set type of processing.
</p>
<dl class="table">
<dt>‘<samp class="samp">d</samp>’</dt>
<dd><p>direct processing
</p></dd>
<dt>‘<samp class="samp">s</samp>’</dt>
<dd><p>serial processing
</p></dd>
<dt>‘<samp class="samp">p</samp>’</dt>
<dd><p>parallel processing
</p></dd>
</dl>
</dd>
<dt><samp class="option">precision, e</samp></dt>
<dd><p>Set filtering precision.
</p>
<dl class="table">
<dt>‘<samp class="samp">dbl</samp>’</dt>
<dd><p>double-precision floating-point (default)
</p></dd>
<dt>‘<samp class="samp">flt</samp>’</dt>
<dd><p>single-precision floating-point
</p></dd>
<dt>‘<samp class="samp">i32</samp>’</dt>
<dd><p>32-bit integers
</p></dd>
<dt>‘<samp class="samp">i16</samp>’</dt>
<dd><p>16-bit integers
</p></dd>
</dl>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize filter coefficients, by default is enabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">response</samp></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><samp class="option">channel</samp></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 class="var">response</var> is enabled.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set video stream size. This option is used only when <var class="var">response</var> is enabled.
</p></dd>
</dl>
<p>Coefficients in <code class="code">tf</code> and <code class="code">sf</code> format are separated by spaces and are in ascending
order.
</p>
<p>Coefficients in <code class="code">zp</code> format are separated by spaces and order of coefficients
doesn’t matter. Coefficients in <code class="code">zp</code> format are complex numbers with <var class="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>
<ul class="mini-toc">
<li><a href="#Examples-25" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-25">
<h4 class="subsection">27.29.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate:
<div class="example">
<pre class="example-preformatted">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 class="code">zp</code> format:
<div class="example">
<pre class="example-preformatted">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-preformatted">aiir=z=1.3057 0 0 0:p=1.3057 2.3892 2.1860 1:f=sf:r=d
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="alimiter">
<h3 class="section">27.30 alimiter</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. Default is 1.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output gain. Default is 1.
</p>
</dd>
<dt><samp class="option">limit</samp></dt>
<dd><p>Don’t let signals above this level pass the limiter. Default is 1.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>The limiter will reach its attenuation level in this amount of time in
milliseconds. Default is 5 milliseconds.
</p>
</dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Come back from limiting to attenuation 1.0 in this amount of milliseconds.
Default is 50 milliseconds.
</p>
</dd>
<dt><samp class="option">asc</samp></dt>
<dd><p>When gain reduction is always needed ASC takes care of releasing to an
average reduction level rather than reaching a reduction of 0 in the release
time.
</p>
</dd>
<dt><samp class="option">asc_level</samp></dt>
<dd><p>Select how much the release time is affected by ASC, 0 means nearly no changes
in release time while 1 produces higher release times.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Auto level output signal. Default is enabled.
This normalizes audio back to 0dB if enabled.
</p>
</dd>
<dt><samp class="option">latency</samp></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 class="ref" href="#aresample">aresample</a> before applying this filter.
</p>
</div>
<div class="section-level-extent" id="allpass">
<h3 class="section">27.31 allpass</h3>
<p>Apply a two-pole all-pass filter with central frequency (in Hz)
<var class="var">frequency</var>, and filter-width <var class="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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set frequency in Hz.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">order, o</samp></dt>
<dd><p>Set the filter order, can be 1 or 2. Default is 2.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-13" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-13">
<h4 class="subsection">27.31.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change allpass frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change allpass width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change allpass width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change allpass mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="aloop">
<h3 class="section">27.32 aloop</h3>
<p>Loop audio samples.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">loop</samp></dt>
<dd><p>Set the number of loops. Setting this value to -1 will result in infinite loops.
Default is 0.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set maximal number of samples. Default is 0.
</p>
</dd>
<dt><samp class="option">start</samp></dt>
<dd><p>Set first sample of loop. Default is 0.
</p>
</dd>
<dt><samp class="option">time</samp></dt>
<dd><p>Set the time of loop start in seconds.
Only used if option named <var class="var">start</var> is set to <code class="code">-1</code>.
</p></dd>
</dl>
<a class="anchor" id="amerge"></a></div>
<div class="section-level-extent" id="amerge-1">
<h3 class="section">27.33 amerge</h3>
<p>Merge two or more audio streams into a single multi-channel stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set the number of inputs. Default is 2.
</p>
</dd>
</dl>
<p>If the channel layouts of the inputs are disjoint, and therefore compatible,
the channel layout of the output will be set accordingly and the channels
will be reordered as necessary. If the channel layouts of the inputs are not
disjoint, the output will have all the channels of the first input then all
the channels of the second input, in that order, and the channel layout of
the output will be the default value corresponding to the total number of
channels.
</p>
<p>For example, if the first input is in 2.1 (FL+FR+LF) and the second input
is FC+BL+BR, then the output will be in 5.1, with the channels in the
following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the
first input, b1 is the first channel of the second input).
</p>
<p>On the other hand, if both input are in stereo, the output channels will be
in the default order: a1, a2, b1, b2, and the channel layout will be
arbitrarily set to 4.0, which may or may not be the expected value.
</p>
<p>All inputs must have the same sample rate, and format.
</p>
<p>If inputs do not have the same duration, the output will stop with the
shortest.
</p>
<ul class="mini-toc">
<li><a href="#Examples-26" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-26">
<h4 class="subsection">27.33.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Merge two mono files into a stereo stream:
<div class="example">
<pre class="example-preformatted">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 class="file">input.mkv</samp>:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="amix">
<h3 class="section">27.34 amix</h3>
<p>Mixes multiple audio inputs into a single output.
</p>
<p>Note that this filter only supports float samples (the <var class="var">amerge</var>
and <var class="var">pan</var> audio filters support many formats). If the <var class="var">amix</var>
input has integer samples then <a class="ref" href="#aresample">aresample</a> will be automatically
inserted to perform the conversion to float samples.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>The number of inputs. If unspecified, it defaults to 2.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>How to determine the end-of-stream.
</p><dl class="table">
<dt><samp class="option">longest</samp></dt>
<dd><p>The duration of the longest input. (default)
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>The duration of the shortest input.
</p>
</dd>
<dt><samp class="option">first</samp></dt>
<dd><p>The duration of the first input.
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">dropout_transition</samp></dt>
<dd><p>The transition time, in seconds, for volume renormalization when an input
stream ends. The default value is 2 seconds.
</p>
</dd>
<dt><samp class="option">weights</samp></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><samp class="option">normalize</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-27" accesskey="1">Examples</a></li>
<li><a href="#Commands-14" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-27">
<h4 class="subsection">27.34.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-14">
<h4 class="subsection">27.34.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">weights</samp></dt>
<dt><samp class="option">normalize</samp></dt>
<dd><p>Syntax is same as option with same name.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="amultiply">
<h3 class="section">27.35 amultiply</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>
</div>
<div class="section-level-extent" id="anequalizer">
<h3 class="section">27.36 anequalizer</h3>
<p>High-order parametric multiband equalizer for each channel.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">params</samp></dt>
<dd>
<p>This option string is in format:
"c<var class="var">chn</var> f=<var class="var">cf</var> w=<var class="var">w</var> g=<var class="var">g</var> t=<var class="var">f</var> | ..."
Each equalizer band is separated by ’|’.
</p>
<dl class="table">
<dt><samp class="option">chn</samp></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><samp class="option">f</samp></dt>
<dd><p>Set central frequency for band.
If input doesn’t have that frequency the entry is ignored.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dd><p>Set band width in Hertz.
</p>
</dd>
<dt><samp class="option">g</samp></dt>
<dd><p>Set band gain in dB.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>Set filter type for band, optional, can be:
</p>
<dl class="table">
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>Butterworth, this is default.
</p>
</dd>
<dt>‘<samp class="samp">1</samp>’</dt>
<dd><p>Chebyshev type 1.
</p>
</dd>
<dt>‘<samp class="samp">2</samp>’</dt>
<dd><p>Chebyshev type 2.
</p></dd>
</dl>
</dd>
</dl>
</dd>
<dt><samp class="option">curves</samp></dt>
<dd><p>With this option activated frequency response of anequalizer is displayed
in video stream.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set video stream size. Only useful if curves option is activated.
</p>
</dd>
<dt><samp class="option">mgain</samp></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><samp class="option">fscale</samp></dt>
<dd><p>Set frequency scale used to draw frequency response in video output.
Can be linear or logarithmic. Default is logarithmic.
</p>
</dd>
<dt><samp class="option">colors</samp></dt>
<dd><p>Set color for each channel curve which is going to be displayed in video stream.
This is list of color names separated by space or by ’|’.
Unrecognised or missing colors will be replaced by white color.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-28" accesskey="1">Examples</a></li>
<li><a href="#Commands-15" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-28">
<h4 class="subsection">27.36.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-15">
<h4 class="subsection">27.36.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">change</samp></dt>
<dd><p>Alter existing filter parameters.
Syntax for the commands is : "<var class="var">fN</var>|f=<var class="var">freq</var>|w=<var class="var">width</var>|g=<var class="var">gain</var>"
</p>
<p><var class="var">fN</var> is existing filter number, starting from 0, if no such filter is available
error is returned.
<var class="var">freq</var> set new frequency parameter.
<var class="var">width</var> set new width parameter in Hertz.
<var class="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>
</div>
</div>
<div class="section-level-extent" id="anlmdn">
<h3 class="section">27.37 anlmdn</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 class="option">p</samp>. Patches are searched in an area of <samp class="option">r</samp> around the sample.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">strength, s</samp></dt>
<dd><p>Set denoising strength. Allowed range is from 0.00001 to 10000. Default value is 0.00001.
</p>
</dd>
<dt><samp class="option">patch, p</samp></dt>
<dd><p>Set patch radius duration. Allowed range is from 1 to 100 milliseconds.
Default value is 2 milliseconds.
</p>
</dd>
<dt><samp class="option">research, r</samp></dt>
<dd><p>Set research radius duration. Allowed range is from 2 to 300 milliseconds.
Default value is 6 milliseconds.
</p>
</dd>
<dt><samp class="option">output, o</samp></dt>
<dd><p>Set the output mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">i</samp></dt>
<dd><p>Pass input unchanged.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Pass noise filtered out.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>Pass only noise.
</p>
<p>Default value is <var class="var">o</var>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">smooth, m</samp></dt>
<dd><p>Set smooth factor. Default value is <var class="var">11</var>. Allowed range is from <var class="var">1</var> to <var class="var">1000</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-16" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-16">
<h4 class="subsection">27.37.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="anlmf_002c-anlms">
<h3 class="section">27.38 anlmf, anlms</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 class="table">
<dt><samp class="option">order</samp></dt>
<dd><p>Set filter order.
</p>
</dd>
<dt><samp class="option">mu</samp></dt>
<dd><p>Set filter mu.
</p>
</dd>
<dt><samp class="option">eps</samp></dt>
<dd><p>Set the filter eps.
</p>
</dd>
<dt><samp class="option">leakage</samp></dt>
<dd><p>Set the filter leakage.
</p>
</dd>
<dt><samp class="option">out_mode</samp></dt>
<dd><p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">i</samp></dt>
<dd><p>Pass the 1st input.
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>Pass the 2nd input.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Pass difference between desired, 2nd input and error signal estimate.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>Pass difference between input, 1st input and error signal estimate.
</p>
</dd>
<dt><samp class="option">e</samp></dt>
<dd><p>Pass error signal estimated samples.
</p>
<p>Default value is <var class="var">o</var>.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-29" accesskey="1">Examples</a></li>
<li><a href="#Commands-17" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-29">
<h4 class="subsection">27.38.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-17">
<h4 class="subsection">27.38.2 Commands</h4>
<p>This filter supports the same commands as options, excluding option <code class="code">order</code>.
</p>
</div>
</div>
<div class="section-level-extent" id="anull">
<h3 class="section">27.39 anull</h3>
<p>Pass the audio source unchanged to the output.
</p>
</div>
<div class="section-level-extent" id="apad">
<h3 class="section">27.40 apad</h3>
<p>Pad the end of an audio stream with silence.
</p>
<p>This can be used together with <code class="command">ffmpeg</code> <samp class="option">-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 class="table">
<dt><samp class="option">packet_size</samp></dt>
<dd><p>Set silence packet size. Default value is 4096.
</p>
</dd>
<dt><samp class="option">pad_len</samp></dt>
<dd><p>Set the number of samples of silence to add to the end. After the
value is reached, the stream is terminated. This option is mutually
exclusive with <samp class="option">whole_len</samp>.
</p>
</dd>
<dt><samp class="option">whole_len</samp></dt>
<dd><p>Set the minimum total number of samples in the output audio stream. If
the value is longer than the input audio length, silence is added to
the end, until the value is reached. This option is mutually exclusive
with <samp class="option">pad_len</samp>.
</p>
</dd>
<dt><samp class="option">pad_dur</samp></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><samp class="option">whole_dur</samp></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 class="option">pad_dur</samp>
</p></dd>
</dl>
<p>If neither the <samp class="option">pad_len</samp> nor the <samp class="option">whole_len</samp> nor <samp class="option">pad_dur</samp>
nor <samp class="option">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 class="option">pad_dur</samp> or
<samp class="option">whole_dur</samp> also caused the filter to add silence indefinitely.
</p>
<ul class="mini-toc">
<li><a href="#Examples-30" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-30">
<h4 class="subsection">27.40.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Add 1024 samples of silence to the end of the input:
<div class="example">
<pre class="example-preformatted">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-preformatted">apad=whole_len=10000
</pre></div>
</li><li>Use <code class="command">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 class="option">shortest</samp>
option:
<div class="example">
<pre class="example-preformatted">ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="aphaser">
<h3 class="section">27.41 aphaser</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 class="table">
<dt><samp class="option">in_gain</samp></dt>
<dd><p>Set input gain. Default is 0.4.
</p>
</dd>
<dt><samp class="option">out_gain</samp></dt>
<dd><p>Set output gain. Default is 0.74
</p>
</dd>
<dt><samp class="option">delay</samp></dt>
<dd><p>Set delay in milliseconds. Default is 3.0.
</p>
</dd>
<dt><samp class="option">decay</samp></dt>
<dd><p>Set decay. Default is 0.4.
</p>
</dd>
<dt><samp class="option">speed</samp></dt>
<dd><p>Set modulation speed in Hz. Default is 0.5.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set modulation type. Default is triangular.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">triangular, t</samp>’</dt>
<dt>‘<samp class="samp">sinusoidal, s</samp>’</dt>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="aphaseshift">
<h3 class="section">27.42 aphaseshift</h3>
<p>Apply phase shift to input audio samples.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">shift</samp></dt>
<dd><p>Specify phase shift. Allowed range is from -1.0 to 1.0.
Default value is 0.0.
</p>
</dd>
<dt><samp class="option">level</samp></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><samp class="option">order</samp></dt>
<dd><p>Set filter order used for filtering. Allowed range is from 1 to 16.
Default value is 8.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-18" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-18">
<h4 class="subsection">27.42.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="apsnr">
<h3 class="section">27.43 apsnr</h3>
<p>Measure Audio Peak Signal-to-Noise 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>
</div>
<div class="section-level-extent" id="apsyclip">
<h3 class="section">27.44 apsyclip</h3>
<p>Apply Psychoacoustic clipper to input audio stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp class="option">clip</samp></dt>
<dd><p>Set the clipping start value. Default value is 0dBFS or 1.
</p>
</dd>
<dt><samp class="option">diff</samp></dt>
<dd><p>Output only difference samples, useful to hear introduced distortions.
By default is disabled.
</p>
</dd>
<dt><samp class="option">adaptive</samp></dt>
<dd><p>Set strength of adaptive distortion applied. Default value is 0.5.
Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp class="option">iterations</samp></dt>
<dd><p>Set number of iterations of psychoacoustic clipper.
Allowed range is from 1 to 20. Default value is 10.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Auto level output signal. Default is disabled.
This normalizes audio back to 0dBFS if enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-19" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-19">
<h4 class="subsection">27.44.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="apulsator">
<h3 class="section">27.45 apulsator</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output gain. By default it is 1. Range is [0.015625 - 64].
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set waveform shape the LFO will use. Can be one of: sine, triangle, square,
sawup or sawdown. Default is sine.
</p>
</dd>
<dt><samp class="option">amount</samp></dt>
<dd><p>Set modulation. Define how much of original signal is affected by the LFO.
</p>
</dd>
<dt><samp class="option">offset_l</samp></dt>
<dd><p>Set left channel offset. Default is 0. Allowed range is [0 - 1].
</p>
</dd>
<dt><samp class="option">offset_r</samp></dt>
<dd><p>Set right channel offset. Default is 0.5. Allowed range is [0 - 1].
</p>
</dd>
<dt><samp class="option">width</samp></dt>
<dd><p>Set pulse width. Default is 1. Allowed range is [0 - 2].
</p>
</dd>
<dt><samp class="option">timing</samp></dt>
<dd><p>Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz.
</p>
</dd>
<dt><samp class="option">bpm</samp></dt>
<dd><p>Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing
is set to bpm.
</p>
</dd>
<dt><samp class="option">ms</samp></dt>
<dd><p>Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing
is set to ms.
</p>
</dd>
<dt><samp class="option">hz</samp></dt>
<dd><p>Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used
if timing is set to hz.
</p></dd>
</dl>
<a class="anchor" id="aresample"></a></div>
<div class="section-level-extent" id="aresample-1">
<h3 class="section">27.46 aresample</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 class="var">sample_rate</var>:]<var class="var">resampler_options</var>, where <var class="var">sample_rate</var>
expresses a sample rate and <var class="var">resampler_options</var> is a list of
<var class="var">key</var>=<var class="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>
<ul class="mini-toc">
<li><a href="#Examples-31" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-31">
<h4 class="subsection">27.46.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Resample the input audio to 44100Hz:
<div class="example">
<pre class="example-preformatted">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-preformatted">aresample=async=1000
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="areverse">
<h3 class="section">27.47 areverse</h3>
<p>Reverse an audio clip.
</p>
<p>Warning: This filter requires memory to buffer the entire clip, so trimming
is suggested.
</p>
<ul class="mini-toc">
<li><a href="#Examples-32" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-32">
<h4 class="subsection">27.47.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Take the first 5 seconds of a clip, and reverse it.
<div class="example">
<pre class="example-preformatted">atrim=end=5,areverse
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="arls">
<h3 class="section">27.48 arls</h3>
<p>Apply Recursive Least Squares algorithm to the first audio stream using the second audio stream.
</p>
<p>This adaptive filter is used to mimic a desired filter by recursively finding the filter coefficients that
relate to producing the minimal weighted linear least squares cost function 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 class="table">
<dt><samp class="option">order</samp></dt>
<dd><p>Set the filter order.
</p>
</dd>
<dt><samp class="option">lambda</samp></dt>
<dd><p>Set the forgetting factor.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set the coefficient to initialize internal covariance matrix.
</p>
</dd>
<dt><samp class="option">out_mode</samp></dt>
<dd><p>Set the filter output samples. It accepts the following values:
</p><dl class="table">
<dt><samp class="option">i</samp></dt>
<dd><p>Pass the 1st input.
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>Pass the 2nd input.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Pass difference between desired, 2nd input and error signal estimate.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>Pass difference between input, 1st input and error signal estimate.
</p>
</dd>
<dt><samp class="option">e</samp></dt>
<dd><p>Pass error signal estimated samples.
</p>
<p>Default value is <var class="var">o</var>.
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="arnndn">
<h3 class="section">27.49 arnndn</h3>
<p>Reduce noise from speech using Recurrent Neural Networks.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">model, m</samp></dt>
<dd><p>Set train model file to load. This option is always required.
</p>
</dd>
<dt><samp class="option">mix</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-20" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-20">
<h4 class="subsection">27.49.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="asdr">
<h3 class="section">27.50 asdr</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>
</div>
<div class="section-level-extent" id="asetnsamples">
<h3 class="section">27.51 asetnsamples</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 class="table">
<dt><samp class="option">nb_out_samples, n</samp></dt>
<dd><p>Set the number of frames per each output audio frame. The number is
intended as the number of samples <em class="emph">per each channel</em>.
Default value is 1024.
</p>
</dd>
<dt><samp class="option">pad, p</samp></dt>
<dd><p>If set to 1, the filter will pad the last audio frame with zeroes, so
that the last frame will contain the same number of samples as the
previous ones. Default value is 1.
</p></dd>
</dl>
<p>For example, to set the number of per-frame samples to 1234 and
disable padding for the last frame, use:
</p><div class="example">
<pre class="example-preformatted">asetnsamples=n=1234:p=0
</pre></div>
</div>
<div class="section-level-extent" id="asetrate">
<h3 class="section">27.52 asetrate</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 class="table">
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Set the output sample rate. Default is 44100 Hz.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="ashowinfo">
<h3 class="section">27.53 ashowinfo</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 class="var">key</var>:<var class="var">value</var>.
</p>
<p>The following values are shown in the output:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>The presentation timestamp of the input frame, in time base units; the time base
depends on the filter input pad, and is usually 1/<var class="var">sample_rate</var>.
</p>
</dd>
<dt><samp class="option">pts_time</samp></dt>
<dd><p>The presentation timestamp of the input frame in seconds.
</p>
</dd>
<dt><samp class="option">fmt</samp></dt>
<dd><p>The sample format.
</p>
</dd>
<dt><samp class="option">chlayout</samp></dt>
<dd><p>The channel layout.
</p>
</dd>
<dt><samp class="option">rate</samp></dt>
<dd><p>The sample rate for the audio frame.
</p>
</dd>
<dt><samp class="option">nb_samples</samp></dt>
<dd><p>The number of samples (per channel) in the frame.
</p>
</dd>
<dt><samp class="option">checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar
audio, the data is treated as if all the planes were concatenated.
</p>
</dd>
<dt><samp class="option">plane_checksums</samp></dt>
<dd><p>A list of Adler-32 checksums for each data plane.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="asisdr">
<h3 class="section">27.54 asisdr</h3>
<p>Measure Audio Scaled-Invariant 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>
</div>
<div class="section-level-extent" id="asoftclip">
<h3 class="section">27.55 asoftclip</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 class="table">
<dt><samp class="option">type</samp></dt>
<dd><p>Set type of soft-clipping.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">hard</samp></dt>
<dt><samp class="option">tanh</samp></dt>
<dt><samp class="option">atan</samp></dt>
<dt><samp class="option">cubic</samp></dt>
<dt><samp class="option">exp</samp></dt>
<dt><samp class="option">alg</samp></dt>
<dt><samp class="option">quintic</samp></dt>
<dt><samp class="option">sin</samp></dt>
<dt><samp class="option">erf</samp></dt>
</dl>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>Set threshold from where to start clipping. Default value is 0dB or 1.
</p>
</dd>
<dt><samp class="option">output</samp></dt>
<dd><p>Set gain applied to output. Default value is 0dB or 1.
</p>
</dd>
<dt><samp class="option">param</samp></dt>
<dd><p>Set additional parameter which controls sigmoid function.
</p>
</dd>
<dt><samp class="option">oversample</samp></dt>
<dd><p>Set oversampling factor.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-21" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-21">
<h4 class="subsection">27.55.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="aspectralstats">
<h3 class="section">27.56 aspectralstats</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 class="table">
<dt><samp class="option">win_size</samp></dt>
<dd><p>Set the window length in samples. Default value is 2048.
Allowed range is from 32 to 65536.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann, hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set window overlap. Allowed range is from <code class="code">0</code>
to <code class="code">1</code>. Default value is <code class="code">0.5</code>.
</p>
</dd>
<dt><samp class="option">measure</samp></dt>
<dd><p>Select the parameters which are measured. The metadata keys can
be used as flags, default is <samp class="option">all</samp> which measures everything.
<samp class="option">none</samp> disables all measurement.
</p></dd>
</dl>
<p>A list of each metadata key follows:
</p>
<dl class="table">
<dt><samp class="option">mean</samp></dt>
<dt><samp class="option">variance</samp></dt>
<dt><samp class="option">centroid</samp></dt>
<dt><samp class="option">spread</samp></dt>
<dt><samp class="option">skewness</samp></dt>
<dt><samp class="option">kurtosis</samp></dt>
<dt><samp class="option">entropy</samp></dt>
<dt><samp class="option">flatness</samp></dt>
<dt><samp class="option">crest</samp></dt>
<dt><samp class="option">flux</samp></dt>
<dt><samp class="option">slope</samp></dt>
<dt><samp class="option">decrease</samp></dt>
<dt><samp class="option">rolloff</samp></dt>
</dl>
</div>
<div class="section-level-extent" id="asr">
<h3 class="section">27.57 asr</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 class="code">--enable-pocketsphinx</code>.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rate</samp></dt>
<dd><p>Set sampling rate of input audio. Defaults is <code class="code">16000</code>.
This need to match speech models, otherwise one will get poor results.
</p>
</dd>
<dt><samp class="option">hmm</samp></dt>
<dd><p>Set dictionary containing acoustic model files.
</p>
</dd>
<dt><samp class="option">dict</samp></dt>
<dd><p>Set pronunciation dictionary.
</p>
</dd>
<dt><samp class="option">lm</samp></dt>
<dd><p>Set language model file.
</p>
</dd>
<dt><samp class="option">lmctl</samp></dt>
<dd><p>Set language model set.
</p>
</dd>
<dt><samp class="option">lmname</samp></dt>
<dd><p>Set which language model to use.
</p>
</dd>
<dt><samp class="option">logfn</samp></dt>
<dd><p>Set output for log messages.
</p></dd>
</dl>
<p>The filter exports recognized speech as the frame metadata <code class="code">lavfi.asr.text</code>.
</p>
<a class="anchor" id="astats"></a></div>
<div class="section-level-extent" id="astats-1">
<h3 class="section">27.58 astats</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 class="table">
<dt><samp class="option">length</samp></dt>
<dd><p>Short window length in seconds, used for peak and trough RMS measurement.
Default is <code class="code">0.05</code> (50 milliseconds). Allowed range is <code class="code">[0 - 10]</code>.
</p>
</dd>
<dt><samp class="option">metadata</samp></dt>
<dd>
<p>Set metadata injection. All the metadata keys are prefixed with <code class="code">lavfi.astats.X</code>,
where <code class="code">X</code> is channel number starting from 1 or string <code class="code">Overall</code>. Default is
disabled.
</p>
<p>Available keys for each channel are:
<var class="var">Bit_depth</var>
<var class="var">Crest_factor</var>
<var class="var">DC_offset</var>
<var class="var">Dynamic_range</var>
<var class="var">Entropy</var>
<var class="var">Flat_factor</var>
<var class="var">Max_difference</var>
<var class="var">Max_level</var>
<var class="var">Mean_difference</var>
<var class="var">Min_difference</var>
<var class="var">Min_level</var>
<var class="var">Noise_floor</var>
<var class="var">Noise_floor_count</var>
<var class="var">Number_of_Infs</var>
<var class="var">Number_of_NaNs</var>
<var class="var">Number_of_denormals</var>
<var class="var">Peak_count</var>
<var class="var">Abs_Peak_count</var>
<var class="var">Peak_level</var>
<var class="var">RMS_difference</var>
<var class="var">RMS_peak</var>
<var class="var">RMS_trough</var>
<var class="var">Zero_crossings</var>
<var class="var">Zero_crossings_rate</var>
</p>
<p>and for <code class="code">Overall</code>:
<var class="var">Bit_depth</var>
<var class="var">DC_offset</var>
<var class="var">Entropy</var>
<var class="var">Flat_factor</var>
<var class="var">Max_difference</var>
<var class="var">Max_level</var>
<var class="var">Mean_difference</var>
<var class="var">Min_difference</var>
<var class="var">Min_level</var>
<var class="var">Noise_floor</var>
<var class="var">Noise_floor_count</var>
<var class="var">Number_of_Infs</var>
<var class="var">Number_of_NaNs</var>
<var class="var">Number_of_denormals</var>
<var class="var">Number_of_samples</var>
<var class="var">Peak_count</var>
<var class="var">Abs_Peak_count</var>
<var class="var">Peak_level</var>
<var class="var">RMS_difference</var>
<var class="var">RMS_level</var>
<var class="var">RMS_peak</var>
<var class="var">RMS_trough</var>
</p>
<p>For example, a full key looks like <code class="code">lavfi.astats.1.DC_offset</code> or
<code class="code">lavfi.astats.Overall.Peak_count</code>.
</p>
<p>Read below for the description of the keys.
</p>
</dd>
<dt><samp class="option">reset</samp></dt>
<dd><p>Set the number of frames over which cumulative stats are calculated before
being reset. Default is disabled.
</p>
</dd>
<dt><samp class="option">measure_perchannel</samp></dt>
<dd><p>Select the parameters which are measured per channel. The metadata keys can
be used as flags, default is <samp class="option">all</samp> which measures everything.
<samp class="option">none</samp> disables all per channel measurement.
</p>
</dd>
<dt><samp class="option">measure_overall</samp></dt>
<dd><p>Select the parameters which are measured overall. The metadata keys can
be used as flags, default is <samp class="option">all</samp> which measures everything.
<samp class="option">none</samp> disables all overall measurement.
</p>
</dd>
</dl>
<p>A description of the measure keys follow:
</p>
<dl class="table">
<dt><samp class="option">none</samp></dt>
<dd><p>no measures
</p>
</dd>
<dt><samp class="option">all</samp></dt>
<dd><p>all measures
</p>
</dd>
<dt><samp class="option">Bit_depth</samp></dt>
<dd><p>overall bit depth of audio, i.e. number of bits used for each sample
</p>
</dd>
<dt><samp class="option">Crest_factor</samp></dt>
<dd><p>standard ratio of peak to RMS level (note: not in dB)
</p>
</dd>
<dt><samp class="option">DC_offset</samp></dt>
<dd><p>mean amplitude displacement from zero
</p>
</dd>
<dt><samp class="option">Dynamic_range</samp></dt>
<dd><p>measured dynamic range of audio in dB
</p>
</dd>
<dt><samp class="option">Entropy</samp></dt>
<dd><p>entropy measured across whole audio, entropy of value near 1.0 is typically measured for white noise
</p>
</dd>
<dt><samp class="option">Flat_factor</samp></dt>
<dd><p>flatness (i.e. consecutive samples with the same value) of the signal at its peak levels
(i.e. either <var class="var">Min_level</var> or <var class="var">Max_level</var>)
</p>
</dd>
<dt><samp class="option">Max_difference</samp></dt>
<dd><p>maximal difference between two consecutive samples
</p>
</dd>
<dt><samp class="option">Max_level</samp></dt>
<dd><p>maximal sample level
</p>
</dd>
<dt><samp class="option">Mean_difference</samp></dt>
<dd><p>mean difference between two consecutive samples, i.e. the average of each difference between two consecutive samples
</p>
</dd>
<dt><samp class="option">Min_difference</samp></dt>
<dd><p>minimal difference between two consecutive samples
</p>
</dd>
<dt><samp class="option">Min_level</samp></dt>
<dd><p>minimal sample level
</p>
</dd>
<dt><samp class="option">Noise_floor</samp></dt>
<dd><p>minimum local peak measured in dBFS over a short window
</p>
</dd>
<dt><samp class="option">Noise_floor_count</samp></dt>
<dd><p>number of occasions (not the number of samples) that the signal attained
<var class="var">Noise floor</var>
</p>
</dd>
<dt><samp class="option">Number_of_Infs</samp></dt>
<dd><p>number of samples with an infinite value
</p>
</dd>
<dt><samp class="option">Number_of_NaNs</samp></dt>
<dd><p>number of samples with a NaN (not a number) value
</p>
</dd>
<dt><samp class="option">Number_of_denormals</samp></dt>
<dd><p>number of samples with a subnormal value
</p>
</dd>
<dt><samp class="option">Number_of_samples</samp></dt>
<dd><p>number of samples
</p>
</dd>
<dt><samp class="option">Peak_count</samp></dt>
<dd><p>number of occasions (not the number of samples) that the signal attained either
<var class="var">Min_level</var> or <var class="var">Max_level</var>
</p>
</dd>
<dt><samp class="option">Abs_Peak_count</samp></dt>
<dd><p>number of occasions that the absolute samples taken from the signal attained
max absolute value of <var class="var">Min_level</var> and <var class="var">Max_level</var>
</p>
</dd>
<dt><samp class="option">Peak_level</samp></dt>
<dd><p>standard peak level measured in dBFS
</p>
</dd>
<dt><samp class="option">RMS_difference</samp></dt>
<dd><p>Root Mean Square difference between two consecutive samples
</p>
</dd>
<dt><samp class="option">RMS_level</samp></dt>
<dd><p>standard RMS level measured in dBFS
</p>
</dd>
<dt><samp class="option">RMS_peak</samp></dt>
<dt><samp class="option">RMS_trough</samp></dt>
<dd><p>peak and trough values for RMS level measured over a short window,
measured in dBFS.
</p>
</dd>
<dt><samp class="option">Zero crossings</samp></dt>
<dd><p>number of points where the waveform crosses the zero level axis
</p>
</dd>
<dt><samp class="option">Zero crossings rate</samp></dt>
<dd><p>rate of Zero crossings and number of audio samples
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="asubboost">
<h3 class="section">27.59 asubboost</h3>
<p>Boost subwoofer frequencies.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">dry</samp></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><samp class="option">wet</samp></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><samp class="option">boost</samp></dt>
<dd><p>Set max boost factor. Allowed range is from 1 to 12. Default value is 2.
</p>
</dd>
<dt><samp class="option">decay</samp></dt>
<dd><p>Set delay line decay gain value. Allowed range is from 0 to 1.
Default value is 0.0.
</p>
</dd>
<dt><samp class="option">feedback</samp></dt>
<dd><p>Set delay line feedback gain value. Allowed range is from 0 to 1.
Default value is 0.9.
</p>
</dd>
<dt><samp class="option">cutoff</samp></dt>
<dd><p>Set cutoff frequency in Hertz. Allowed range is 50 to 900.
Default value is 100.
</p>
</dd>
<dt><samp class="option">slope</samp></dt>
<dd><p>Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1.
Default value is 0.5.
</p>
</dd>
<dt><samp class="option">delay</samp></dt>
<dd><p>Set delay. Allowed range is from 1 to 100.
Default value is 20.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set the channels to process. Default value is all available.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-22" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-22">
<h4 class="subsection">27.59.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="asubcut">
<h3 class="section">27.60 asubcut</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 class="table">
<dt><samp class="option">cutoff</samp></dt>
<dd><p>Set cutoff frequency in Hertz. Allowed range is 2 to 200.
Default value is 20.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set filter order. Available values are from 3 to 20.
Default value is 10.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-23" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-23">
<h4 class="subsection">27.60.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="asupercut">
<h3 class="section">27.61 asupercut</h3>
<p>Cut super frequencies.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">cutoff</samp></dt>
<dd><p>Set cutoff frequency in Hertz. Allowed range is 20000 to 192000.
Default value is 20000.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set filter order. Available values are from 3 to 20.
Default value is 10.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input gain level. Allowed range is from 0 to 1. Default value is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-24" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-24">
<h4 class="subsection">27.61.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="asuperpass">
<h3 class="section">27.62 asuperpass</h3>
<p>Apply high order Butterworth band-pass filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">centerf</samp></dt>
<dd><p>Set center frequency in Hertz. Allowed range is 2 to 999999.
Default value is 1000.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set filter order. Available values are from 4 to 20.
Default value is 4.
</p>
</dd>
<dt><samp class="option">qfactor</samp></dt>
<dd><p>Set Q-factor. Allowed range is from 0.01 to 100. Default value is 1.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input gain level. Allowed range is from 0 to 2. Default value is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-25" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-25">
<h4 class="subsection">27.62.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="asuperstop">
<h3 class="section">27.63 asuperstop</h3>
<p>Apply high order Butterworth band-stop filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">centerf</samp></dt>
<dd><p>Set center frequency in Hertz. Allowed range is 2 to 999999.
Default value is 1000.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set filter order. Available values are from 4 to 20.
Default value is 4.
</p>
</dd>
<dt><samp class="option">qfactor</samp></dt>
<dd><p>Set Q-factor. Allowed range is from 0.01 to 100. Default value is 1.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input gain level. Allowed range is from 0 to 2. Default value is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-26" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-26">
<h4 class="subsection">27.63.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="atempo">
<h3 class="section">27.64 atempo</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>
<ul class="mini-toc">
<li><a href="#Examples-33" accesskey="1">Examples</a></li>
<li><a href="#Commands-27" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-33">
<h4 class="subsection">27.64.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Slow down audio to 80% tempo:
<div class="example">
<pre class="example-preformatted">atempo=0.8
</pre></div>
</li><li>To speed up audio to 300% tempo:
<div class="example">
<pre class="example-preformatted">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-preformatted">atempo=sqrt(3),atempo=sqrt(3)
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-27">
<h4 class="subsection">27.64.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">tempo</samp></dt>
<dd><p>Change filter tempo scale factor.
Syntax for the command is : "<var class="var">tempo</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="atilt">
<h3 class="section">27.65 atilt</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 class="table">
<dt><samp class="option">freq</samp></dt>
<dd><p>Set central frequency of tilt in Hz. Default is 10000 Hz.
</p>
</dd>
<dt><samp class="option">slope</samp></dt>
<dd><p>Set slope direction of tilt. Default is 0. Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">width</samp></dt>
<dd><p>Set width of tilt. Default is 1000. Allowed range is from 100 to 10000.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set order of tilt filter.
</p>
</dd>
<dt><samp class="option">level</samp></dt>
<dd><p>Set input volume level. Allowed range is from 0 to 4.
Defalt is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-28" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-28">
<h4 class="subsection">27.65.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="atrim">
<h3 class="section">27.66 atrim</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 class="table">
<dt><samp class="option">start</samp></dt>
<dd><p>Timestamp (in seconds) of the start of the section to keep. I.e. the audio
sample with the timestamp <var class="var">start</var> will be the first sample in the output.
</p>
</dd>
<dt><samp class="option">end</samp></dt>
<dd><p>Specify time of the first audio sample that will be dropped, i.e. the
audio sample immediately preceding the one with the timestamp <var class="var">end</var> will be
the last sample in the output.
</p>
</dd>
<dt><samp class="option">start_pts</samp></dt>
<dd><p>Same as <var class="var">start</var>, except this option sets the start timestamp in samples
instead of seconds.
</p>
</dd>
<dt><samp class="option">end_pts</samp></dt>
<dd><p>Same as <var class="var">end</var>, except this option sets the end timestamp in samples instead
of seconds.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>The maximum duration of the output in seconds.
</p>
</dd>
<dt><samp class="option">start_sample</samp></dt>
<dd><p>The number of the first sample that should be output.
</p>
</dd>
<dt><samp class="option">end_sample</samp></dt>
<dd><p>The number of the first sample that should be dropped.
</p></dd>
</dl>
<p><samp class="option">start</samp>, <samp class="option">end</samp>, and <samp class="option">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 class="option">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 class="itemize mark-bullet">
<li>Drop everything except the second minute of input:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -af atrim=60:120
</pre></div>
</li><li>Keep only the first 1000 samples:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -af atrim=end_sample=1000
</pre></div>
</li></ul>
</div>
<div class="section-level-extent" id="axcorrelate">
<h3 class="section">27.67 axcorrelate</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 class="table">
<dt><samp class="option">size</samp></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><samp class="option">algo</samp></dt>
<dd><p>Set algorithm for cross-correlation. Can be <code class="code">slow</code> or <code class="code">fast</code> or <code class="code">best</code>.
Default is <code class="code">best</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>
<ul class="mini-toc">
<li><a href="#Examples-34" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-34">
<h4 class="subsection">27.67.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Calculate correlation between channels in stereo audio stream:
<div class="example">
<pre class="example-preformatted">ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="bandpass">
<h3 class="section">27.68 bandpass</h3>
<p>Apply a two-pole Butterworth band-pass filter with central
frequency <var class="var">frequency</var>, and (3dB-point) band-width width.
The <var class="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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set the filter’s central frequency. Default is <code class="code">3000</code>.
</p>
</dd>
<dt><samp class="option">csg</samp></dt>
<dd><p>Constant skirt gain if set to 1. Defaults to 0.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-29" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-29">
<h4 class="subsection">27.68.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change bandpass frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change bandpass width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change bandpass width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change bandpass mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="bandreject">
<h3 class="section">27.69 bandreject</h3>
<p>Apply a two-pole Butterworth band-reject filter with central
frequency <var class="var">frequency</var>, and (3dB-point) band-width <var class="var">width</var>.
The filter roll off at 6dB per octave (20dB per decade).
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set the filter’s central frequency. Default is <code class="code">3000</code>.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-30" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-30">
<h4 class="subsection">27.69.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change bandreject frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change bandreject width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change bandreject width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change bandreject mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="bass_002c-lowshelf">
<h3 class="section">27.70 bass, lowshelf</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 class="table">
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Give the gain at 0 Hz. Its useful range is about -20
(for a large cut) to +20 (for a large boost).
Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp class="option">frequency, f</samp></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 class="code">100</code> Hz.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Determine how steep is the filter’s shelf transition.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-31" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-31">
<h4 class="subsection">27.70.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change bass frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change bass width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change bass width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Change bass gain.
Syntax for the command is : "<var class="var">gain</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change bass mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="biquad">
<h3 class="section">27.71 biquad</h3>
<p>Apply a biquad IIR filter with the given coefficients.
Where <var class="var">b0</var>, <var class="var">b1</var>, <var class="var">b2</var> and <var class="var">a0</var>, <var class="var">a1</var>, <var class="var">a2</var>
are the numerator and denominator coefficients respectively.
and <var class="var">channels</var>, <var class="var">c</var> specify which channels to filter, by default all
available are filtered.
</p>
<ul class="mini-toc">
<li><a href="#Commands-32" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-32">
<h4 class="subsection">27.71.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">a0</samp></dt>
<dt><samp class="option">a1</samp></dt>
<dt><samp class="option">a2</samp></dt>
<dt><samp class="option">b0</samp></dt>
<dt><samp class="option">b1</samp></dt>
<dt><samp class="option">b2</samp></dt>
<dd><p>Change biquad parameter.
Syntax for the command is : "<var class="var">value</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
</div>
</div>
<div class="section-level-extent" id="bs2b">
<h3 class="section">27.72 bs2b</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 class="code">--enable-libbs2b</code>.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">profile</samp></dt>
<dd><p>Pre-defined crossfeed level.
</p><dl class="table">
<dt><samp class="option">default</samp></dt>
<dd><p>Default level (fcut=700, feed=50).
</p>
</dd>
<dt><samp class="option">cmoy</samp></dt>
<dd><p>Chu Moy circuit (fcut=700, feed=60).
</p>
</dd>
<dt><samp class="option">jmeier</samp></dt>
<dd><p>Jan Meier circuit (fcut=650, feed=95).
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">fcut</samp></dt>
<dd><p>Cut frequency (in Hz).
</p>
</dd>
<dt><samp class="option">feed</samp></dt>
<dd><p>Feed level (in Hz).
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="channelmap">
<h3 class="section">27.73 channelmap</h3>
<p>Remap input channels to new locations.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">map</samp></dt>
<dd><p>Map channels from input to output. The argument is a ’|’-separated list of
mappings, each in the <code class="code"><var class="var">in_channel</var>-<var class="var">out_channel</var></code> or
<var class="var">in_channel</var> form. <var class="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 class="var">out_channel</var> is the name of the output channel or its index in the output
channel layout. If <var class="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><samp class="option">channel_layout</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-35" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-35">
<h4 class="subsection">27.73.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>For example, assuming a 5.1+downmix input MOV file,
<div class="example">
<pre class="example-preformatted">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-preformatted">ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="channelsplit">
<h3 class="section">27.74 channelsplit</h3>
<p>Split each channel from an input audio stream into a separate output stream.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">channel_layout</samp></dt>
<dd><p>The channel layout of the input stream. The default is "stereo".
</p></dd>
<dt><samp class="option">channels</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-36" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-36">
<h4 class="subsection">27.74.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>For example, assuming a stereo input MP3 file,
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
-map '[LFE]' lfe.wav
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="chorus">
<h3 class="section">27.75 chorus</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 class="table">
<dt><samp class="option">in_gain</samp></dt>
<dd><p>Set input gain. Default is 0.4.
</p>
</dd>
<dt><samp class="option">out_gain</samp></dt>
<dd><p>Set output gain. Default is 0.4.
</p>
</dd>
<dt><samp class="option">delays</samp></dt>
<dd><p>Set delays. A typical delay is around 40ms to 60ms.
</p>
</dd>
<dt><samp class="option">decays</samp></dt>
<dd><p>Set decays.
</p>
</dd>
<dt><samp class="option">speeds</samp></dt>
<dd><p>Set speeds.
</p>
</dd>
<dt><samp class="option">depths</samp></dt>
<dd><p>Set depths.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-37" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-37">
<h4 class="subsection">27.75.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>A single delay:
<div class="example">
<pre class="example-preformatted">chorus=0.7:0.9:55:0.4:0.25:2
</pre></div>
</li><li>Two delays:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="compand">
<h3 class="section">27.76 compand</h3>
<p>Compress or expand the audio’s dynamic range.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">attacks</samp></dt>
<dt><samp class="option">decays</samp></dt>
<dd><p>A list of times in seconds for each channel over which the instantaneous level
of the input signal is averaged to determine its volume. <var class="var">attacks</var> refers to
increase of volume and <var class="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><samp class="option">points</samp></dt>
<dd><p>A list of points for the transfer function, specified in dB relative to the
maximum possible signal amplitude. Each key points list must be defined using
the following syntax: <code class="code">x0/y0|x1/y1|x2/y2|....</code> or
<code class="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 class="code">0/0</code> is assumed but
may be overridden (by <code class="code">0/out-dBn</code>). Typical values for the transfer
function are <code class="code">-70/-70|-60/-20|1/0</code>.
</p>
</dd>
<dt><samp class="option">soft-knee</samp></dt>
<dd><p>Set the curve radius in dB for all joints. It defaults to 0.01.
</p>
</dd>
<dt><samp class="option">gain</samp></dt>
<dd><p>Set the additional gain in dB to be applied at all points on the transfer
function. This allows for easy adjustment of the overall gain.
It defaults to 0.
</p>
</dd>
<dt><samp class="option">volume</samp></dt>
<dd><p>Set an initial volume, in dB, to be assumed for each channel when filtering
starts. This permits the user to supply a nominal level initially, so that, for
example, a very large gain is not applied to initial signal levels before the
companding has begun to operate. A typical value for audio which is initially
quiet is -90 dB. It defaults to 0.
</p>
</dd>
<dt><samp class="option">delay</samp></dt>
<dd><p>Set a delay, in seconds. The input audio is analyzed immediately, but audio is
delayed before being fed to the volume adjuster. Specifying a delay
approximately equal to the attack/decay times allows the filter to effectively
operate in predictive rather than reactive mode. It defaults to 0.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-38" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-38">
<h4 class="subsection">27.76.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make music with both quiet and loud passages suitable for listening to in a
noisy environment:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
</pre></div>
</li><li>Compressor/Gate:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">compand=attacks=0:points=-80/-80|-6/-6|20/-6
</pre></div>
</li><li>Hard limiter at -12dB:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="compensationdelay">
<h3 class="section">27.77 compensationdelay</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 class="table">
<dt><samp class="option">mm</samp></dt>
<dd><p>Set millimeters distance. This is compensation distance for fine tuning.
Default is 0.
</p>
</dd>
<dt><samp class="option">cm</samp></dt>
<dd><p>Set cm distance. This is compensation distance for tightening distance setup.
Default is 0.
</p>
</dd>
<dt><samp class="option">m</samp></dt>
<dd><p>Set meters distance. This is compensation distance for hard distance setup.
Default is 0.
</p>
</dd>
<dt><samp class="option">dry</samp></dt>
<dd><p>Set dry amount. Amount of unprocessed (dry) signal.
Default is 0.
</p>
</dd>
<dt><samp class="option">wet</samp></dt>
<dd><p>Set wet amount. Amount of processed (wet) signal.
Default is 1.
</p>
</dd>
<dt><samp class="option">temp</samp></dt>
<dd><p>Set temperature in degrees Celsius. This is the temperature of the environment.
Default is 20.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-33" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-33">
<h4 class="subsection">27.77.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="crossfeed">
<h3 class="section">27.78 crossfeed</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 class="table">
<dt><samp class="option">strength</samp></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><samp class="option">range</samp></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><samp class="option">slope</samp></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><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. Default is 0.9.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output gain. Default is 1.
</p>
</dd>
<dt><samp class="option">block_size</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-34" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-34">
<h4 class="subsection">27.78.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="crystalizer">
<h3 class="section">27.79 crystalizer</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 class="table">
<dt><samp class="option">i</samp></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><samp class="option">c</samp></dt>
<dd><p>Enable clipping. By default is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-35" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-35">
<h4 class="subsection">27.79.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="dcshift">
<h3 class="section">27.80 dcshift</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 class="ref" href="#astats">astats</a> filter can be used to determine if
a signal has a DC offset.
</p>
<dl class="table">
<dt><samp class="option">shift</samp></dt>
<dd><p>Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift
the audio.
</p>
</dd>
<dt><samp class="option">limitergain</samp></dt>
<dd><p>Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is
used to prevent clipping.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="deesser">
<h3 class="section">27.81 deesser</h3>
<p>Apply de-essing to the audio samples.
</p>
<dl class="table">
<dt><samp class="option">i</samp></dt>
<dd><p>Set intensity for triggering de-essing. Allowed range is from 0 to 1.
Default is 0.
</p>
</dd>
<dt><samp class="option">m</samp></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><samp class="option">f</samp></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><samp class="option">s</samp></dt>
<dd><p>Set the output mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">i</samp></dt>
<dd><p>Pass input unchanged.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Pass ess filtered out.
</p>
</dd>
<dt><samp class="option">e</samp></dt>
<dd><p>Pass only ess.
</p>
<p>Default value is <var class="var">o</var>.
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="dialoguenhance">
<h3 class="section">27.82 dialoguenhance</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 class="table">
<dt><samp class="option">original</samp></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><samp class="option">enhance</samp></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><samp class="option">voice</samp></dt>
<dd><p>Set the voice detection factor.
Allowed range is from 2 to 32. Default value is 2.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-36" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-36">
<h4 class="subsection">27.82.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="drmeter">
<h3 class="section">27.83 drmeter</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 class="table">
<dt><samp class="option">length</samp></dt>
<dd><p>Set window length in seconds used to split audio into segments of equal length.
Default is 3 seconds.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="dynaudnorm">
<h3 class="section">27.84 dynaudnorm</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 class="table">
<dt><samp class="option">framelen, f</samp></dt>
<dd><p>Set the frame length in milliseconds. In range from 10 to 8000 milliseconds.
Default is 500 milliseconds.
The Dynamic Audio Normalizer processes the input audio in small chunks,
referred to as frames. This is required, because a peak magnitude has no
meaning for just a single sample value. Instead, we need to determine the
peak magnitude for a contiguous sequence of sample values. While a "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><samp class="option">gausssize, g</samp></dt>
<dd><p>Set the Gaussian filter window size. In range from 3 to 301, must be odd
number. Default is 31.
Probably the most important parameter of the Dynamic Audio Normalizer is the
<code class="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><samp class="option">peak, p</samp></dt>
<dd><p>Set the target peak value. This specifies the highest permissible magnitude
level for the normalized audio input. This filter will try to approach the
target peak magnitude as closely as possible, but at the same time it also
makes sure that the normalized signal will never exceed the peak magnitude.
A frame’s maximum local gain factor is imposed directly by the target peak
magnitude. The default value is 0.95 and thus leaves a headroom of 5%*.
It is not recommended to go above this value.
</p>
</dd>
<dt><samp class="option">maxgain, m</samp></dt>
<dd><p>Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0.
The Dynamic Audio Normalizer determines the maximum possible (local) gain
factor for each input frame, i.e. the maximum gain factor that does not
result in clipping or distortion. The maximum gain factor is determined by
the frame’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><samp class="option">targetrms, r</samp></dt>
<dd><p>Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled.
By default, the Dynamic Audio Normalizer performs "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><samp class="option">coupling, n</samp></dt>
<dd><p>Enable channels coupling. By default is enabled.
By default, the Dynamic Audio Normalizer will amplify all channels by the same
amount. This means the same gain factor will be applied to all channels, i.e.
the maximum possible gain factor is determined by the "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><samp class="option">correctdc, c</samp></dt>
<dd><p>Enable DC bias correction. By default is disabled.
An audio signal (in the time domain) is a sequence of sample values.
In the Dynamic Audio Normalizer these sample values are represented in the
-1.0 to 1.0 range, regardless of the original input format. Normally, the
audio signal, or "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><samp class="option">altboundary, b</samp></dt>
<dd><p>Enable alternative boundary mode. By default is disabled.
The Dynamic Audio Normalizer takes into account a certain neighbourhood
around each frame. This includes the preceding frames as well as the
subsequent frames. However, for the "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><samp class="option">compress, s</samp></dt>
<dd><p>Set the compress factor. In range from 0.0 to 30.0. Default is 0.0.
By default, the Dynamic Audio Normalizer does not apply "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><samp class="option">threshold, t</samp></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><samp class="option">channels, h</samp></dt>
<dd><p>Specify which channels to filter, by default all available channels are filtered.
</p>
</dd>
<dt><samp class="option">overlap, o</samp></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><samp class="option">curve, v</samp></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 class="table">
<dt><samp class="option">ch</samp></dt>
<dd><p>current channel number
</p>
</dd>
<dt><samp class="option">sn</samp></dt>
<dd><p>current sample number
</p>
</dd>
<dt><samp class="option">nb_channels</samp></dt>
<dd><p>number of channels
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>timestamp expressed in seconds
</p>
</dd>
<dt><samp class="option">sr</samp></dt>
<dd><p>sample rate
</p>
</dd>
<dt><samp class="option">p</samp></dt>
<dd><p>current frame peak value
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-37" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-37">
<h4 class="subsection">27.84.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="earwax">
<h3 class="section">27.85 earwax</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>
</div>
<div class="section-level-extent" id="equalizer">
<h3 class="section">27.86 equalizer</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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set the filter’s central frequency in Hz.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
</p>
</dd>
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Set the required gain or attenuation in dB.
Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-39" accesskey="1">Examples</a></li>
<li><a href="#Commands-38" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-39">
<h4 class="subsection">27.86.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz:
<div class="example">
<pre class="example-preformatted">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-preformatted">equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-38">
<h4 class="subsection">27.86.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change equalizer frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change equalizer width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change equalizer width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Change equalizer gain.
Syntax for the command is : "<var class="var">gain</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change equalizer mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="extrastereo">
<h3 class="section">27.87 extrastereo</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 class="table">
<dt><samp class="option">m</samp></dt>
<dd><p>Sets the difference coefficient (default: 2.5). 0.0 means mono sound
(average of both channels), with 1.0 sound will be unchanged, with
-1.0 left and right channels will be swapped.
</p>
</dd>
<dt><samp class="option">c</samp></dt>
<dd><p>Enable clipping. By default is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-39" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-39">
<h4 class="subsection">27.87.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="firequalizer">
<h3 class="section">27.88 firequalizer</h3>
<p>Apply FIR Equalization using arbitrary frequency response.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">gain</samp></dt>
<dd><p>Set gain curve equation (in dB). The expression can contain variables:
</p><dl class="table">
<dt><samp class="option">f</samp></dt>
<dd><p>the evaluated frequency
</p></dd>
<dt><samp class="option">sr</samp></dt>
<dd><p>sample rate
</p></dd>
<dt><samp class="option">ch</samp></dt>
<dd><p>channel number, set to 0 when multichannels evaluation is disabled
</p></dd>
<dt><samp class="option">chid</samp></dt>
<dd><p>channel id, see libavutil/channel_layout.h, set to the first channel id when
multichannels evaluation is disabled
</p></dd>
<dt><samp class="option">chs</samp></dt>
<dd><p>number of channels
</p></dd>
<dt><samp class="option">chlayout</samp></dt>
<dd><p>channel_layout, see libavutil/channel_layout.h
</p>
</dd>
</dl>
<p>and functions:
</p><dl class="table">
<dt><samp class="option">gain_interpolate(f)</samp></dt>
<dd><p>interpolate gain on frequency f based on gain_entry
</p></dd>
<dt><samp class="option">cubic_interpolate(f)</samp></dt>
<dd><p>same as gain_interpolate, but smoother
</p></dd>
</dl>
<p>This option is also available as command. Default is <code class="code">gain_interpolate(f)</code>.
</p>
</dd>
<dt><samp class="option">gain_entry</samp></dt>
<dd><p>Set gain entry for gain_interpolate function. The expression can
contain functions:
</p><dl class="table">
<dt><samp class="option">entry(f, g)</samp></dt>
<dd><p>store gain entry at frequency f with value g
</p></dd>
</dl>
<p>This option is also available as command.
</p>
</dd>
<dt><samp class="option">delay</samp></dt>
<dd><p>Set filter delay in seconds. Higher value means more accurate.
Default is <code class="code">0.01</code>.
</p>
</dd>
<dt><samp class="option">accuracy</samp></dt>
<dd><p>Set filter accuracy in Hz. Lower value means more accurate.
Default is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">wfunc</samp></dt>
<dd><p>Set window function. Acceptable values are:
</p><dl class="table">
<dt><samp class="option">rectangular</samp></dt>
<dd><p>rectangular window, useful when gain curve is already smooth
</p></dd>
<dt><samp class="option">hann</samp></dt>
<dd><p>hann window (default)
</p></dd>
<dt><samp class="option">hamming</samp></dt>
<dd><p>hamming window
</p></dd>
<dt><samp class="option">blackman</samp></dt>
<dd><p>blackman window
</p></dd>
<dt><samp class="option">nuttall3</samp></dt>
<dd><p>3-terms continuous 1st derivative nuttall window
</p></dd>
<dt><samp class="option">mnuttall3</samp></dt>
<dd><p>minimum 3-terms discontinuous nuttall window
</p></dd>
<dt><samp class="option">nuttall</samp></dt>
<dd><p>4-terms continuous 1st derivative nuttall window
</p></dd>
<dt><samp class="option">bnuttall</samp></dt>
<dd><p>minimum 4-terms discontinuous nuttall (blackman-nuttall) window
</p></dd>
<dt><samp class="option">bharris</samp></dt>
<dd><p>blackman-harris window
</p></dd>
<dt><samp class="option">tukey</samp></dt>
<dd><p>tukey window
</p></dd>
</dl>
</dd>
<dt><samp class="option">fixed</samp></dt>
<dd><p>If enabled, use fixed number of audio samples. This improves speed when
filtering with large delay. Default is disabled.
</p>
</dd>
<dt><samp class="option">multi</samp></dt>
<dd><p>Enable multichannels evaluation on gain. Default is disabled.
</p>
</dd>
<dt><samp class="option">zero_phase</samp></dt>
<dd><p>Enable zero phase mode by subtracting timestamp to compensate delay.
Default is disabled.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set scale used by gain. Acceptable values are:
</p><dl class="table">
<dt><samp class="option">linlin</samp></dt>
<dd><p>linear frequency, linear gain
</p></dd>
<dt><samp class="option">linlog</samp></dt>
<dd><p>linear frequency, logarithmic (in dB) gain (default)
</p></dd>
<dt><samp class="option">loglin</samp></dt>
<dd><p>logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain
</p></dd>
<dt><samp class="option">loglog</samp></dt>
<dd><p>logarithmic frequency, logarithmic gain
</p></dd>
</dl>
</dd>
<dt><samp class="option">dumpfile</samp></dt>
<dd><p>Set file for dumping, suitable for gnuplot.
</p>
</dd>
<dt><samp class="option">dumpscale</samp></dt>
<dd><p>Set scale for dumpfile. Acceptable values are same with scale option.
Default is linlog.
</p>
</dd>
<dt><samp class="option">fft2</samp></dt>
<dd><p>Enable 2-channel convolution using complex FFT. This improves speed significantly.
Default is disabled.
</p>
</dd>
<dt><samp class="option">min_phase</samp></dt>
<dd><p>Enable minimum phase impulse response. Default is disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-40" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-40">
<h4 class="subsection">27.88.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>lowpass at 1000 Hz:
<div class="example">
<pre class="example-preformatted">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-preformatted">firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
</pre></div>
</li><li>custom equalization:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="flanger">
<h3 class="section">27.89 flanger</h3>
<p>Apply a flanging effect to the audio.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">delay</samp></dt>
<dd><p>Set base delay in milliseconds. Range from 0 to 30. Default value is 0.
</p>
</dd>
<dt><samp class="option">depth</samp></dt>
<dd><p>Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2.
</p>
</dd>
<dt><samp class="option">regen</samp></dt>
<dd><p>Set percentage regeneration (delayed signal feedback). Range from -95 to 95.
Default value is 0.
</p>
</dd>
<dt><samp class="option">width</samp></dt>
<dd><p>Set percentage of delayed signal mixed with original. Range from 0 to 100.
Default value is 71.
</p>
</dd>
<dt><samp class="option">speed</samp></dt>
<dd><p>Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5.
</p>
</dd>
<dt><samp class="option">shape</samp></dt>
<dd><p>Set swept wave shape, can be <var class="var">triangular</var> or <var class="var">sinusoidal</var>.
Default value is <var class="var">sinusoidal</var>.
</p>
</dd>
<dt><samp class="option">phase</samp></dt>
<dd><p>Set swept wave percentage-shift for multi channel. Range from 0 to 100.
Default value is 25.
</p>
</dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Set delay-line interpolation, <var class="var">linear</var> or <var class="var">quadratic</var>.
Default is <var class="var">linear</var>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="haas">
<h3 class="section">27.90 haas</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input level. By default is <var class="var">1</var>, or 0dB
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output level. By default is <var class="var">1</var>, or 0dB.
</p>
</dd>
<dt><samp class="option">side_gain</samp></dt>
<dd><p>Set gain applied to side part of signal. By default is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">middle_source</samp></dt>
<dd><p>Set kind of middle source. Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">left</samp>’</dt>
<dd><p>Pick left channel.
</p>
</dd>
<dt>‘<samp class="samp">right</samp>’</dt>
<dd><p>Pick right channel.
</p>
</dd>
<dt>‘<samp class="samp">mid</samp>’</dt>
<dd><p>Pick middle part signal of stereo image.
</p>
</dd>
<dt>‘<samp class="samp">side</samp>’</dt>
<dd><p>Pick side part signal of stereo image.
</p></dd>
</dl>
</dd>
<dt><samp class="option">middle_phase</samp></dt>
<dd><p>Change middle phase. By default is disabled.
</p>
</dd>
<dt><samp class="option">left_delay</samp></dt>
<dd><p>Set left channel delay. By default is <var class="var">2.05</var> milliseconds.
</p>
</dd>
<dt><samp class="option">left_balance</samp></dt>
<dd><p>Set left channel balance. By default is <var class="var">-1</var>.
</p>
</dd>
<dt><samp class="option">left_gain</samp></dt>
<dd><p>Set left channel gain. By default is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">left_phase</samp></dt>
<dd><p>Change left phase. By default is disabled.
</p>
</dd>
<dt><samp class="option">right_delay</samp></dt>
<dd><p>Set right channel delay. By defaults is <var class="var">2.12</var> milliseconds.
</p>
</dd>
<dt><samp class="option">right_balance</samp></dt>
<dd><p>Set right channel balance. By default is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">right_gain</samp></dt>
<dd><p>Set right channel gain. By default is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">right_phase</samp></dt>
<dd><p>Change right phase. By default is enabled.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="hdcd">
<h3 class="section">27.91 hdcd</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-preformatted">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 class="command">-acodec pcm_s24le</code> after the filter to get 24-bit PCM output.
</p><div class="example">
<pre class="example-preformatted">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 class="table">
<dt><samp class="option">disable_autoconvert</samp></dt>
<dd><p>Disable any automatic format conversion or resampling in the filter graph.
</p>
</dd>
<dt><samp class="option">process_stereo</samp></dt>
<dd><p>Process the stereo channels together. If target_gain does not match between
channels, consider it invalid and use the last valid target_gain.
</p>
</dd>
<dt><samp class="option">cdt_ms</samp></dt>
<dd><p>Set the code detect timer period in ms.
</p>
</dd>
<dt><samp class="option">force_pe</samp></dt>
<dd><p>Always extend peaks above -3dBFS even if PE isn’t signaled.
</p>
</dd>
<dt><samp class="option">analyze_mode</samp></dt>
<dd><p>Replace audio with a solid tone and adjust the amplitude to signal some
specific aspect of the decoding process. The output file can be loaded in
an audio editor alongside the original to aid analysis.
</p>
<p><code class="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 class="table">
<dt>‘<samp class="samp">0, off</samp>’</dt>
<dd><p>Disabled
</p></dd>
<dt>‘<samp class="samp">1, lle</samp>’</dt>
<dd><p>Gain adjustment level at each sample
</p></dd>
<dt>‘<samp class="samp">2, pe</samp>’</dt>
<dd><p>Samples where peak extend occurs
</p></dd>
<dt>‘<samp class="samp">3, cdt</samp>’</dt>
<dd><p>Samples where the code detect timer is active
</p></dd>
<dt>‘<samp class="samp">4, tgm</samp>’</dt>
<dd><p>Samples where the target gain does not match between channels
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="headphone">
<h3 class="section">27.92 headphone</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 class="table">
<dt><samp class="option">map</samp></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><samp class="option">gain</samp></dt>
<dd><p>Set gain applied to audio. Value is in dB. Default is 0.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set processing type. Can be <var class="var">time</var> or <var class="var">freq</var>. <var class="var">time</var> is
processing audio in time domain which is slow.
<var class="var">freq</var> is processing audio in frequency domain which is fast.
Default is <var class="var">freq</var>.
</p>
</dd>
<dt><samp class="option">lfe</samp></dt>
<dd><p>Set custom gain for LFE channels. Value is in dB. Default is 0.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set size of frame in number of samples which will be processed at once.
Default value is <var class="var">1024</var>. Allowed range is from 1024 to 96000.
</p>
</dd>
<dt><samp class="option">hrir</samp></dt>
<dd><p>Set format of hrir stream.
Default value is <var class="var">stereo</var>. Alternative value is <var class="var">multich</var>.
If value is set to <var class="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 class="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>
<ul class="mini-toc">
<li><a href="#Examples-41" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-41">
<h4 class="subsection">27.92.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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 class="var">multich</var> <var class="var">hrir</var> format.
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="highpass">
<h3 class="section">27.93 highpass</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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set frequency in Hz. Default is 3000.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
Applies only to double-pole filter.
The default is 0.707q and gives a Butterworth response.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-40" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-40">
<h4 class="subsection">27.93.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change highpass frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change highpass width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change highpass width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change highpass mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="join">
<h3 class="section">27.94 join</h3>
<p>Join multiple input streams into one multi-channel stream.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>The number of input streams. It defaults to 2.
</p>
</dd>
<dt><samp class="option">channel_layout</samp></dt>
<dd><p>The desired output channel layout. It defaults to stereo.
</p>
</dd>
<dt><samp class="option">map</samp></dt>
<dd><p>Map channels from inputs to output. The argument is a ’|’-separated list of
mappings, each in the <code class="code"><var class="var">input_idx</var>.<var class="var">in_channel</var>-<var class="var">out_channel</var></code>
form. <var class="var">input_idx</var> is the 0-based index of the input stream. <var class="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 class="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-preformatted">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-preformatted">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>
</div>
<div class="section-level-extent" id="ladspa">
<h3 class="section">27.95 ladspa</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 class="code">--enable-ladspa</code>.
</p>
<dl class="table">
<dt><samp class="option">file, f</samp></dt>
<dd><p>Specifies the name of LADSPA plugin library to load. If the environment
variable <code class="env">LADSPA_PATH</code> is defined, the LADSPA plugin is searched in
each one of the directories specified by the colon separated list in
<code class="env">LADSPA_PATH</code>, otherwise in the standard LADSPA paths, which are in
this order: <samp class="file">HOME/.ladspa/lib/</samp>, <samp class="file">/usr/local/lib/ladspa/</samp>,
<samp class="file">/usr/lib/ladspa/</samp>.
</p>
</dd>
<dt><samp class="option">plugin, p</samp></dt>
<dd><p>Specifies the plugin within the library. Some libraries contain only
one plugin, but others contain many of them. If this is not set filter
will list all available plugins within the specified library.
</p>
</dd>
<dt><samp class="option">controls, c</samp></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 class="var">value0</var>|c1=<var class="var">value1</var>|c2=<var class="var">value2</var>|..., where
<var class="var">valuei</var> is the value set on the <var class="var">i</var>-th control.
Alternatively they can be also defined using the following syntax:
<var class="var">value0</var>|<var class="var">value1</var>|<var class="var">value2</var>|..., where
<var class="var">valuei</var> is the value set on the <var class="var">i</var>-th control.
If <samp class="option">controls</samp> is set to <code class="code">help</code>, all available controls and
their valid ranges are printed.
</p>
</dd>
<dt><samp class="option">sample_rate, s</samp></dt>
<dd><p>Specify the sample rate, default to 44100. Only used if plugin have
zero inputs.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per channel per each output frame, default
is 1024. Only used if plugin have zero inputs.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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><samp class="option">latency, l</samp></dt>
<dd><p>Enable latency compensation, by default is disabled.
Only used if plugin have inputs.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-42" accesskey="1">Examples</a></li>
<li><a href="#Commands-41" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-42">
<h4 class="subsection">27.95.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>List all available plugins within amp (LADSPA example plugin) library:
<div class="example">
<pre class="example-preformatted">ladspa=file=amp
</pre></div>
</li><li>List all available controls and their valid ranges for <code class="code">vcf_notch</code>
plugin from <code class="code">VCF</code> library:
<div class="example">
<pre class="example-preformatted">ladspa=f=vcf:p=vcf_notch:c=help
</pre></div>
</li><li>Simulate low quality audio equipment using <code class="code">Computer Music Toolkit</code> (CMT)
plugin library:
<div class="example">
<pre class="example-preformatted">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-preformatted">ladspa=file=tap_reverb:tap_reverb
</pre></div>
</li><li>Generate white noise, with 0.2 amplitude:
<div class="example">
<pre class="example-preformatted">ladspa=file=cmt:noise_source_white:c=c0=.2
</pre></div>
</li><li>Generate 20 bpm clicks using plugin <code class="code">C* Click - Metronome</code> from the
<code class="code">C* Audio Plugin Suite</code> (CAPS) library:
<div class="example">
<pre class="example-preformatted">ladspa=file=caps:Click:c=c1=20'
</pre></div>
</li><li>Apply <code class="code">C* Eq10X2 - Stereo 10-band equaliser</code> effect:
<div class="example">
<pre class="example-preformatted">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 class="code">SWH Plugins</code> collection:
<div class="example">
<pre class="example-preformatted">ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
</pre></div>
</li><li>Attenuate low frequencies using Multiband EQ from Steve Harris
<code class="code">SWH Plugins</code> collection:
<div class="example">
<pre class="example-preformatted">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 class="code">Narrower</code> from the <code class="code">C* Audio Plugin Suite</code>
(CAPS) library:
<div class="example">
<pre class="example-preformatted">ladspa=caps:Narrower
</pre></div>
</li><li>Another white noise, now using <code class="code">C* Audio Plugin Suite</code> (CAPS) library:
<div class="example">
<pre class="example-preformatted">ladspa=caps:White:.2
</pre></div>
</li><li>Some fractal noise, using <code class="code">C* Audio Plugin Suite</code> (CAPS) library:
<div class="example">
<pre class="example-preformatted">ladspa=caps:Fractal:c=c1=1
</pre></div>
</li><li>Dynamic volume normalization using <code class="code">VLevel</code> plugin:
<div class="example">
<pre class="example-preformatted">ladspa=vlevel-ladspa:vlevel_mono
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-41">
<h4 class="subsection">27.95.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">cN</samp></dt>
<dd><p>Modify the <var class="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>
</div>
</div>
<div class="section-level-extent" id="loudnorm">
<h3 class="section">27.96 loudnorm</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 class="code">-ar</code> option or <code class="code">aresample</code> filter to explicitly set an output sample rate.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">I, i</samp></dt>
<dd><p>Set integrated loudness target.
Range is -70.0 - -5.0. Default value is -24.0.
</p>
</dd>
<dt><samp class="option">LRA, lra</samp></dt>
<dd><p>Set loudness range target.
Range is 1.0 - 50.0. Default value is 7.0.
</p>
</dd>
<dt><samp class="option">TP, tp</samp></dt>
<dd><p>Set maximum true peak.
Range is -9.0 - +0.0. Default value is -2.0.
</p>
</dd>
<dt><samp class="option">measured_I, measured_i</samp></dt>
<dd><p>Measured IL of input file.
Range is -99.0 - +0.0.
</p>
</dd>
<dt><samp class="option">measured_LRA, measured_lra</samp></dt>
<dd><p>Measured LRA of input file.
Range is 0.0 - 99.0.
</p>
</dd>
<dt><samp class="option">measured_TP, measured_tp</samp></dt>
<dd><p>Measured true peak of input file.
Range is -99.0 - +99.0.
</p>
</dd>
<dt><samp class="option">measured_thresh</samp></dt>
<dd><p>Measured threshold of input file.
Range is -99.0 - +0.0.
</p>
</dd>
<dt><samp class="option">offset</samp></dt>
<dd><p>Set offset gain. Gain is applied before the true-peak limiter.
Range is -99.0 - +99.0. Default is +0.0.
</p>
</dd>
<dt><samp class="option">linear</samp></dt>
<dd><p>Normalize by linearly scaling the source audio.
<code class="code">measured_I</code>, <code class="code">measured_LRA</code>, <code class="code">measured_TP</code>,
and <code class="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 class="var">dynamic</var>.
Options are <code class="code">true</code> or <code class="code">false</code>. Default is <code class="code">true</code>.
</p>
</dd>
<dt><samp class="option">dual_mono</samp></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 class="code">true</code>, this option will compensate for this effect.
Multi-channel input files are not affected by this option.
Options are true or false. Default is false.
</p>
</dd>
<dt><samp class="option">print_format</samp></dt>
<dd><p>Set print format for stats. Options are summary, json, or none.
Default value is none.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="lowpass">
<h3 class="section">27.97 lowpass</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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set frequency in Hz. Default is 500.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Specify the band-width of a filter in width_type units.
Applies only to double-pole filter.
The default is 0.707q and gives a Butterworth response.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-43" accesskey="1">Examples</a></li>
<li><a href="#Commands-42" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-43">
<h4 class="subsection">27.97.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Lowpass only LFE channel, it LFE is not present it does nothing:
<div class="example">
<pre class="example-preformatted">lowpass=c=LFE
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-42">
<h4 class="subsection">27.97.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change lowpass frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change lowpass width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change lowpass width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change lowpass mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="lv2">
<h3 class="section">27.98 lv2</h3>
<p>Load a LV2 (LADSPA Version 2) plugin.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code class="code">--enable-lv2</code>.
</p>
<dl class="table">
<dt><samp class="option">plugin, p</samp></dt>
<dd><p>Specifies the plugin URI. You may need to escape ’:’.
</p>
</dd>
<dt><samp class="option">controls, c</samp></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 class="option">controls</samp> is set to <code class="code">help</code>, all available controls and
their valid ranges are printed.
</p>
</dd>
<dt><samp class="option">sample_rate, s</samp></dt>
<dd><p>Specify the sample rate, default to 44100. Only used if plugin have
zero inputs.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per channel per each output frame, default
is 1024. Only used if plugin have zero inputs.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-44" accesskey="1">Examples</a></li>
<li><a href="#Commands-43" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-44">
<h4 class="subsection">27.98.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply bass enhancer plugin from Calf:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-43">
<h4 class="subsection">27.98.2 Commands</h4>
<p>This filter supports all options that are exported by plugin as commands.
</p>
</div>
</div>
<div class="section-level-extent" id="mcompand">
<h3 class="section">27.99 mcompand</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 class="table">
<dt><samp class="option">args</samp></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>
<a class="anchor" id="pan"></a></div>
<div class="section-level-extent" id="pan-1">
<h3 class="section">27.100 pan</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 class="var">l</var>|<var class="var">outdef</var>|<var class="var">outdef</var>|..."
</p>
<dl class="table">
<dt><samp class="option">l</samp></dt>
<dd><p>output channel layout or number of channels
</p>
</dd>
<dt><samp class="option">outdef</samp></dt>
<dd><p>output channel specification, of the form:
"<var class="var">out_name</var>=[<var class="var">gain</var>*]<var class="var">in_name</var>[(+-)[<var class="var">gain</var>*]<var class="var">in_name</var>...]"
</p>
</dd>
<dt><samp class="option">out_name</samp></dt>
<dd><p>output channel to define, either a channel name (FL, FR, etc.) or a channel
number (c0, c1, etc.)
</p>
</dd>
<dt><samp class="option">gain</samp></dt>
<dd><p>multiplicative coefficient for the channel, 1 leaving the volume unchanged
</p>
</dd>
<dt><samp class="option">in_name</samp></dt>
<dd><p>input channel to use, see out_name for details; it is not possible to mix
named and numbered input channels
</p></dd>
</dl>
<p>If the ‘=’ 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>
<ul class="mini-toc">
<li><a href="#Mixing-examples" accesskey="1">Mixing examples</a></li>
<li><a href="#Remapping-examples" accesskey="2">Remapping examples</a></li>
</ul>
<div class="subsection-level-extent" id="Mixing-examples">
<h4 class="subsection">27.100.1 Mixing examples</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-preformatted">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-preformatted">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 class="command">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>
</div>
<div class="subsection-level-extent" id="Remapping-examples">
<h4 class="subsection">27.100.2 Remapping examples</h4>
<p>The channel remapping will be effective if, and only if:
</p>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">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-preformatted">pan="stereo| c0=FR | c1=FR"
</pre></div>
</div>
</div>
<div class="section-level-extent" id="replaygain">
<h3 class="section">27.101 replaygain</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 class="code">track_gain</code> and <code class="code">track_peak</code>.
</p>
<p>The filter accepts the following exported read-only options:
</p>
<dl class="table">
<dt><samp class="option">track_gain</samp></dt>
<dd><p>Exported track gain in dB at end of stream.
</p>
</dd>
<dt><samp class="option">track_peak</samp></dt>
<dd><p>Exported track peak at end of stream.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="resample">
<h3 class="section">27.102 resample</h3>
<p>Convert the audio sample format, sample rate and channel layout. It is
not meant to be used directly.
</p>
</div>
<div class="section-level-extent" id="rubberband">
<h3 class="section">27.103 rubberband</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 class="code">--enable-librubberband</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">tempo</samp></dt>
<dd><p>Set tempo scale factor.
</p>
</dd>
<dt><samp class="option">pitch</samp></dt>
<dd><p>Set pitch scale factor.
</p>
</dd>
<dt><samp class="option">transients</samp></dt>
<dd><p>Set transients detector.
Possible values are:
</p><dl class="table">
<dt><var class="var">crisp</var></dt>
<dt><var class="var">mixed</var></dt>
<dt><var class="var">smooth</var></dt>
</dl>
</dd>
<dt><samp class="option">detector</samp></dt>
<dd><p>Set detector.
Possible values are:
</p><dl class="table">
<dt><var class="var">compound</var></dt>
<dt><var class="var">percussive</var></dt>
<dt><var class="var">soft</var></dt>
</dl>
</dd>
<dt><samp class="option">phase</samp></dt>
<dd><p>Set phase.
Possible values are:
</p><dl class="table">
<dt><var class="var">laminar</var></dt>
<dt><var class="var">independent</var></dt>
</dl>
</dd>
<dt><samp class="option">window</samp></dt>
<dd><p>Set processing window size.
Possible values are:
</p><dl class="table">
<dt><var class="var">standard</var></dt>
<dt><var class="var">short</var></dt>
<dt><var class="var">long</var></dt>
</dl>
</dd>
<dt><samp class="option">smoothing</samp></dt>
<dd><p>Set smoothing.
Possible values are:
</p><dl class="table">
<dt><var class="var">off</var></dt>
<dt><var class="var">on</var></dt>
</dl>
</dd>
<dt><samp class="option">formant</samp></dt>
<dd><p>Enable formant preservation when shift pitching.
Possible values are:
</p><dl class="table">
<dt><var class="var">shifted</var></dt>
<dt><var class="var">preserved</var></dt>
</dl>
</dd>
<dt><samp class="option">pitchq</samp></dt>
<dd><p>Set pitch quality.
Possible values are:
</p><dl class="table">
<dt><var class="var">quality</var></dt>
<dt><var class="var">speed</var></dt>
<dt><var class="var">consistency</var></dt>
</dl>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set channels.
Possible values are:
</p><dl class="table">
<dt><var class="var">apart</var></dt>
<dt><var class="var">together</var></dt>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-44" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-44">
<h4 class="subsection">27.103.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">tempo</samp></dt>
<dd><p>Change filter tempo scale factor.
Syntax for the command is : "<var class="var">tempo</var>"
</p>
</dd>
<dt><samp class="option">pitch</samp></dt>
<dd><p>Change filter pitch scale factor.
Syntax for the command is : "<var class="var">pitch</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="sidechaincompress">
<h3 class="section">27.104 sidechaincompress</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 class="ref" href="#pan">pan</a> and <a class="ref" href="#amerge">amerge</a> filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set mode of compressor operation. Can be <code class="code">upward</code> or <code class="code">downward</code>.
Default is <code class="code">downward</code>.
</p>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>If a signal of second stream raises above this level it will affect the gain
reduction of first stream.
By default is 0.125. Range is between 0.00097563 and 1.
</p>
</dd>
<dt><samp class="option">ratio</samp></dt>
<dd><p>Set a ratio about which the signal is reduced. 1:2 means that if the level
raised 4dB above the threshold, it will be only 2dB above after the reduction.
Default is 2. Range is between 1 and 20.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction starts. Default is 20. Range is between 0.01 and 2000.
</p>
</dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before
reduction is decreased again. Default is 250. Range is between 0.01 and 9000.
</p>
</dd>
<dt><samp class="option">makeup</samp></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><samp class="option">knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.82843. Range is between 1 and 8.
</p>
</dd>
<dt><samp class="option">link</samp></dt>
<dd><p>Choose if the <code class="code">average</code> level between all channels of side-chain stream
or the louder(<code class="code">maximum</code>) channel of side-chain stream affects the
reduction. Default is <code class="code">average</code>.
</p>
</dd>
<dt><samp class="option">detection</samp></dt>
<dd><p>Should the exact signal be taken in case of <code class="code">peak</code> or an RMS one in case
of <code class="code">rms</code>. Default is <code class="code">rms</code> which is mainly smoother.
</p>
</dd>
<dt><samp class="option">level_sc</samp></dt>
<dd><p>Set sidechain gain. Default is 1. Range is between 0.015625 and 64.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>How much to use compressed signal in output. Default is 1.
Range is between 0 and 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-45" accesskey="1">Commands</a></li>
<li><a href="#Examples-45" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-45">
<h4 class="subsection">27.104.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-45">
<h4 class="subsection">27.104.2 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="sidechaingate">
<h3 class="section">27.105 sidechaingate</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input level before filtering.
Default is 1. Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the mode of operation. Can be <code class="code">upward</code> or <code class="code">downward</code>.
Default is <code class="code">downward</code>. If set to <code class="code">upward</code> mode, higher parts of signal
will be amplified, expanding dynamic range in upward direction.
Otherwise, in case of <code class="code">downward</code> lower parts of signal will be reduced.
</p>
</dd>
<dt><samp class="option">range</samp></dt>
<dd><p>Set the level of gain reduction when the signal is below the threshold.
Default is 0.06125. Allowed range is from 0 to 1.
Setting this to 0 disables reduction and then filter behaves like expander.
</p>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>If a signal rises above this level the gain reduction is released.
Default is 0.125. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp class="option">ratio</samp></dt>
<dd><p>Set a ratio about which the signal is reduced.
Default is 2. Allowed range is from 1 to 9000.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Amount of milliseconds the signal has to rise above the threshold before gain
reduction stops.
Default is 20 milliseconds. Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp class="option">release</samp></dt>
<dd><p>Amount of milliseconds the signal has to fall below the threshold before the
reduction is increased again. Default is 250 milliseconds.
Allowed range is from 0.01 to 9000.
</p>
</dd>
<dt><samp class="option">makeup</samp></dt>
<dd><p>Set amount of amplification of signal after processing.
Default is 1. Allowed range is from 1 to 64.
</p>
</dd>
<dt><samp class="option">knee</samp></dt>
<dd><p>Curve the sharp knee around the threshold to enter gain reduction more softly.
Default is 2.828427125. Allowed range is from 1 to 8.
</p>
</dd>
<dt><samp class="option">detection</samp></dt>
<dd><p>Choose if exact signal should be taken for detection or an RMS like one.
Default is rms. Can be peak or rms.
</p>
</dd>
<dt><samp class="option">link</samp></dt>
<dd><p>Choose if the average level between all channels or the louder channel affects
the reduction.
Default is average. Can be average or maximum.
</p>
</dd>
<dt><samp class="option">level_sc</samp></dt>
<dd><p>Set sidechain gain. Default is 1. Range is from 0.015625 to 64.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-46" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-46">
<h4 class="subsection">27.105.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="silencedetect">
<h3 class="section">27.106 silencedetect</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 class="code">lavfi.silence_start</code> or <code class="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 class="code">lavfi.silence_duration</code> or <code class="code">lavfi.silence_duration.X</code>
and <code class="code">lavfi.silence_end</code> or <code class="code">lavfi.silence_end.X</code> metadata
keys are set on the first frame after the silence. If <samp class="option">mono</samp> is
enabled, and each channel is evaluated separately, the <code class="code">.X</code>
suffixed keys are used, and <code class="code">X</code> corresponds to the channel number.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">noise, n</samp></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><samp class="option">duration, d</samp></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><samp class="option">mono, m</samp></dt>
<dd><p>Process each channel separately, instead of combined. By default is disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-46" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-46">
<h4 class="subsection">27.106.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Detect 5 seconds of silence with -50dB noise tolerance:
<div class="example">
<pre class="example-preformatted">silencedetect=n=-50dB:d=5
</pre></div>
</li><li>Complete example with <code class="command">ffmpeg</code> to detect silence with 0.0001 noise
tolerance in <samp class="file">silence.mp3</samp>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="silenceremove">
<h3 class="section">27.107 silenceremove</h3>
<p>Remove silence from the beginning, middle or end of the audio.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">start_periods</samp></dt>
<dd><p>This value is used to indicate if audio should be trimmed at beginning of
the audio. A value of zero indicates no silence should be trimmed from the
beginning. When specifying a non-zero value, it trims audio up until it
finds non-silence. Normally, when trimming silence from beginning of audio
the <var class="var">start_periods</var> will be <code class="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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">start_duration</samp></dt>
<dd><p>Specify the amount of time that non-silence must be detected before it stops
trimming audio. By increasing the duration, bursts of noises can be treated
as silence and trimmed off. Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">start_threshold</samp></dt>
<dd><p>This indicates what sample value should be treated as silence. For digital
audio, a value of <code class="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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">start_silence</samp></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><samp class="option">start_mode</samp></dt>
<dd><p>Specify mode of detection of silence end at start of multi-channel audio.
Can be <var class="var">any</var> or <var class="var">all</var>. Default is <var class="var">any</var>.
With <var class="var">any</var>, any sample from any channel that is detected as non-silence
will trigger end of silence trimming at start of audio stream.
With <var class="var">all</var>, only if every sample from every channel is detected as non-silence
will trigger end of silence trimming at start of audio stream, limited usage.
</p>
</dd>
<dt><samp class="option">stop_periods</samp></dt>
<dd><p>Set the count for trimming silence from the end of audio. When specifying a
positive value, it trims audio after it finds specified silence period.
To remove silence from the middle of a file, specify a <var class="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 class="var">stop_periods</var>, making it suitable for removing periods of silence
in the middle of the audio.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">stop_duration</samp></dt>
<dd><p>Specify a duration of silence that must exist before audio is not copied any
more. By specifying a higher duration, silence that is wanted can be left in
the audio.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">stop_threshold</samp></dt>
<dd><p>This is the same as <samp class="option">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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">stop_silence</samp></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><samp class="option">stop_mode</samp></dt>
<dd><p>Specify mode of detection of silence start after start of multi-channel audio.
Can be <var class="var">any</var> or <var class="var">all</var>. Default is <var class="var">all</var>.
With <var class="var">any</var>, any sample from any channel that is detected as silence
will trigger start of silence trimming after start of audio stream, limited usage.
With <var class="var">all</var>, only if every sample from every channel is detected as silence
will trigger start of silence trimming after start of audio stream.
</p>
</dd>
<dt><samp class="option">detection</samp></dt>
<dd><p>Set how is silence detected.
</p><dl class="table">
<dt><samp class="option">avg</samp></dt>
<dd><p>Mean of absolute values of samples in moving window.
</p></dd>
<dt><samp class="option">rms</samp></dt>
<dd><p>Root squared mean of absolute values of samples in moving window.
</p></dd>
<dt><samp class="option">peak</samp></dt>
<dd><p>Maximum of absolute values of samples in moving window.
</p></dd>
<dt><samp class="option">median</samp></dt>
<dd><p>Median of absolute values of samples in moving window.
</p></dd>
<dt><samp class="option">ptp</samp></dt>
<dd><p>Absolute of max peak to min peak difference of samples in moving window.
</p></dd>
<dt><samp class="option">dev</samp></dt>
<dd><p>Standard deviation of values of samples in moving window.
</p></dd>
</dl>
<p>Default value is <code class="code">rms</code>.
</p>
</dd>
<dt><samp class="option">window</samp></dt>
<dd><p>Set duration in number of seconds used to calculate size of window in number
of samples for detecting silence. Using <code class="code">0</code> will effectively disable
any windowing and use only single sample per channel for silence detection.
In that case it may be needed to also set <samp class="option">start_silence</samp> and/or
<samp class="option">stop_silence</samp> to nonzero values with also <samp class="option">start_duration</samp> and/or
<samp class="option">stop_duration</samp> to nonzero values.
Default value is <code class="code">0.02</code>. Allowed range is from <code class="code">0</code> to <code class="code">10</code>.
</p>
</dd>
<dt><samp class="option">timestamp</samp></dt>
<dd><p>Set processing mode of every audio frame output timestamp.
</p><dl class="table">
<dt><samp class="option">write</samp></dt>
<dd><p>Full timestamps rewrite, keep only the start time for the first output frame.
</p></dd>
<dt><samp class="option">copy</samp></dt>
<dd><p>Non-dropped frames are left with same timestamp as input audio frame.
</p></dd>
</dl>
<p>Defaults value is <code class="code">write</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-47" accesskey="1">Examples</a></li>
<li><a href="#Commands-47" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-47">
<h4 class="subsection">27.107.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0
</pre></div>
</li><li>Trim every 2nd encountered silence period from beginning to end where there is
more than 1 second of silence per silence period in audio:
<div class="example">
<pre class="example-preformatted">silenceremove=stop_periods=-2:stop_duration=1:stop_threshold=-90dB
</pre></div>
</li><li>Similar as above, but keep maximum of 0.5 seconds of silence from each trimmed period:
<div class="example">
<pre class="example-preformatted">silenceremove=stop_periods=-2:stop_duration=1:stop_threshold=-90dB:stop_silence=0.5
</pre></div>
</li><li>Similar as above, but keep maximum of 1.5 seconds of silence from start of audio:
<div class="example">
<pre class="example-preformatted">silenceremove=stop_periods=-2:stop_duration=1:stop_threshold=-90dB:stop_silence=0.5:start_periods=1:start_duration=1:start_silence=1.5:stop_threshold=-90dB
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-47">
<h4 class="subsection">27.107.2 Commands</h4>
<p>This filter supports some above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="sofalizer">
<h3 class="section">27.108 sofalizer</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 class="url" 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 class="code">--enable-libmysofa</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sofa</samp></dt>
<dd><p>Set the SOFA file used for rendering.
</p>
</dd>
<dt><samp class="option">gain</samp></dt>
<dd><p>Set gain applied to audio. Value is in dB. Default is 0.
</p>
</dd>
<dt><samp class="option">rotation</samp></dt>
<dd><p>Set rotation of virtual loudspeakers in deg. Default is 0.
</p>
</dd>
<dt><samp class="option">elevation</samp></dt>
<dd><p>Set elevation of virtual speakers in deg. Default is 0.
</p>
</dd>
<dt><samp class="option">radius</samp></dt>
<dd><p>Set distance in meters between loudspeakers and the listener with near-field
HRTFs. Default is 1.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set processing type. Can be <var class="var">time</var> or <var class="var">freq</var>. <var class="var">time</var> is
processing audio in time domain which is slow.
<var class="var">freq</var> is processing audio in frequency domain which is fast.
Default is <var class="var">freq</var>.
</p>
</dd>
<dt><samp class="option">speakers</samp></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><samp class="option">lfegain</samp></dt>
<dd><p>Set custom gain for LFE channels. Value is in dB. Default is 0.
</p>
</dd>
<dt><samp class="option">framesize</samp></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 class="samp">type</samp>’
is set to <var class="var">freq</var>.
</p>
</dd>
<dt><samp class="option">normalize</samp></dt>
<dd><p>Should all IRs be normalized upon importing SOFA file.
By default is enabled.
</p>
</dd>
<dt><samp class="option">interpolate</samp></dt>
<dd><p>Should nearest IRs be interpolated with neighbor IRs if exact position
does not match. By default is disabled.
</p>
</dd>
<dt><samp class="option">minphase</samp></dt>
<dd><p>Minphase all IRs upon loading of SOFA file. By default is disabled.
</p>
</dd>
<dt><samp class="option">anglestep</samp></dt>
<dd><p>Set neighbor search angle step. Only used if option <var class="var">interpolate</var> is enabled.
</p>
</dd>
<dt><samp class="option">radstep</samp></dt>
<dd><p>Set neighbor search radius step. Only used if option <var class="var">interpolate</var> is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-48" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-48">
<h4 class="subsection">27.108.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Using ClubFritz6 sofa file:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">"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>
</div>
</div>
<div class="section-level-extent" id="speechnorm">
<h3 class="section">27.109 speechnorm</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 class="table">
<dt><samp class="option">peak, p</samp></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><samp class="option">expansion, e</samp></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><samp class="option">compression, c</samp></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 class="option">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 class="option">threshold</samp> all samples belonging to
that peak’s half-cycle will be compressed by current compression factor.
</p>
</dd>
<dt><samp class="option">threshold, t</samp></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><samp class="option">raise, r</samp></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 class="option">expansion</samp> value.
Setting this options too high may lead to distortions.
</p>
</dd>
<dt><samp class="option">fall, f</samp></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 class="option">compression</samp> value.
</p>
</dd>
<dt><samp class="option">channels, h</samp></dt>
<dd><p>Specify which channels to filter, by default all available channels are filtered.
</p>
</dd>
<dt><samp class="option">invert, i</samp></dt>
<dd><p>Enable inverted filtering, by default is disabled. This inverts interpretation of <samp class="option">threshold</samp>
option. When enabled any half-cycle of samples with their local peak value below or same as
<samp class="option">threshold</samp> option will be expanded otherwise it will be compressed.
</p>
</dd>
<dt><samp class="option">link, l</samp></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><samp class="option">rms, m</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-48" accesskey="1">Commands</a></li>
<li><a href="#Examples-49" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-48">
<h4 class="subsection">27.109.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-49">
<h4 class="subsection">27.109.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Weak and slow amplification:
<div class="example">
<pre class="example-preformatted">speechnorm=e=3:r=0.00001:l=1
</pre></div>
</li><li>Moderate and slow amplification:
<div class="example">
<pre class="example-preformatted">speechnorm=e=6.25:r=0.00001:l=1
</pre></div>
</li><li>Strong and fast amplification:
<div class="example">
<pre class="example-preformatted">speechnorm=e=12.5:r=0.0001:l=1
</pre></div>
</li><li>Very strong and fast amplification:
<div class="example">
<pre class="example-preformatted">speechnorm=e=25:r=0.0001:l=1
</pre></div>
</li><li>Extreme and fast amplification:
<div class="example">
<pre class="example-preformatted">speechnorm=e=50:r=0.0001:l=1
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="stereotools">
<h3 class="section">27.110 stereotools</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 class="table">
<dt><samp class="option">level_in</samp></dt>
<dd><p>Set input level before filtering for both channels. Defaults is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output level after filtering for both channels. Defaults is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">balance_in</samp></dt>
<dd><p>Set input balance between both channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">balance_out</samp></dt>
<dd><p>Set output balance between both channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">softclip</samp></dt>
<dd><p>Enable softclipping. Results in analog distortion instead of harsh digital 0dB
clipping. Disabled by default.
</p>
</dd>
<dt><samp class="option">mutel</samp></dt>
<dd><p>Mute the left channel. Disabled by default.
</p>
</dd>
<dt><samp class="option">muter</samp></dt>
<dd><p>Mute the right channel. Disabled by default.
</p>
</dd>
<dt><samp class="option">phasel</samp></dt>
<dd><p>Change the phase of the left channel. Disabled by default.
</p>
</dd>
<dt><samp class="option">phaser</samp></dt>
<dd><p>Change the phase of the right channel. Disabled by default.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set stereo mode. Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">lr>lr</samp>’</dt>
<dd><p>Left/Right to Left/Right, this is default.
</p>
</dd>
<dt>‘<samp class="samp">lr>ms</samp>’</dt>
<dd><p>Left/Right to Mid/Side.
</p>
</dd>
<dt>‘<samp class="samp">ms>lr</samp>’</dt>
<dd><p>Mid/Side to Left/Right.
</p>
</dd>
<dt>‘<samp class="samp">lr>ll</samp>’</dt>
<dd><p>Left/Right to Left/Left.
</p>
</dd>
<dt>‘<samp class="samp">lr>rr</samp>’</dt>
<dd><p>Left/Right to Right/Right.
</p>
</dd>
<dt>‘<samp class="samp">lr>l+r</samp>’</dt>
<dd><p>Left/Right to Left + Right.
</p>
</dd>
<dt>‘<samp class="samp">lr>rl</samp>’</dt>
<dd><p>Left/Right to Right/Left.
</p>
</dd>
<dt>‘<samp class="samp">ms>ll</samp>’</dt>
<dd><p>Mid/Side to Left/Left.
</p>
</dd>
<dt>‘<samp class="samp">ms>rr</samp>’</dt>
<dd><p>Mid/Side to Right/Right.
</p>
</dd>
<dt>‘<samp class="samp">ms>rl</samp>’</dt>
<dd><p>Mid/Side to Right/Left.
</p>
</dd>
<dt>‘<samp class="samp">lr>l-r</samp>’</dt>
<dd><p>Left/Right to Left - Right.
</p></dd>
</dl>
</dd>
<dt><samp class="option">slev</samp></dt>
<dd><p>Set level of side signal. Default is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">sbal</samp></dt>
<dd><p>Set balance of side signal. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">mlev</samp></dt>
<dd><p>Set level of the middle signal. Default is 1.
Allowed range is from 0.015625 to 64.
</p>
</dd>
<dt><samp class="option">mpan</samp></dt>
<dd><p>Set middle signal pan. Default is 0. Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">base</samp></dt>
<dd><p>Set stereo base between mono and inversed channels. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">delay</samp></dt>
<dd><p>Set delay in milliseconds how much to delay left from right channel and
vice versa. Default is 0. Allowed range is from -20 to 20.
</p>
</dd>
<dt><samp class="option">sclevel</samp></dt>
<dd><p>Set S/C level. Default is 1. Allowed range is from 1 to 100.
</p>
</dd>
<dt><samp class="option">phase</samp></dt>
<dd><p>Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360.
</p>
</dd>
<dt><samp class="option">bmode_in, bmode_out</samp></dt>
<dd><p>Set balance mode for balance_in/balance_out option.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">balance</samp>’</dt>
<dd><p>Classic balance mode. Attenuate one channel at time.
Gain is raised up to 1.
</p>
</dd>
<dt>‘<samp class="samp">amplitude</samp>’</dt>
<dd><p>Similar as classic mode above but gain is raised up to 2.
</p>
</dd>
<dt>‘<samp class="samp">power</samp>’</dt>
<dd><p>Equal power distribution, from -6dB to +6dB range.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-49" accesskey="1">Commands</a></li>
<li><a href="#Examples-50" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-49">
<h4 class="subsection">27.110.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-50">
<h4 class="subsection">27.110.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply karaoke like effect:
<div class="example">
<pre class="example-preformatted">stereotools=mlev=0.015625
</pre></div>
</li><li>Convert M/S signal to L/R:
<div class="example">
<pre class="example-preformatted">"stereotools=mode=ms>lr"
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="stereowiden">
<h3 class="section">27.111 stereowiden</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 class="table">
<dt><samp class="option">delay</samp></dt>
<dd><p>Time in milliseconds of the delay of left signal into right and vice versa.
Default is 20 milliseconds.
</p>
</dd>
<dt><samp class="option">feedback</samp></dt>
<dd><p>Amount of gain in delayed signal into right and vice versa. Gives a delay
effect of left signal in right output and vice versa which gives widening
effect. Default is 0.3.
</p>
</dd>
<dt><samp class="option">crossfeed</samp></dt>
<dd><p>Cross feed of left into right with inverted phase. This helps in suppressing
the mono. If the value is 1 it will cancel all the signal common to both
channels. Default is 0.3.
</p>
</dd>
<dt><samp class="option">drymix</samp></dt>
<dd><p>Set level of input signal of original channel. Default is 0.8.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-50" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-50">
<h4 class="subsection">27.111.1 Commands</h4>
<p>This filter supports the all above options except <code class="code">delay</code> as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="superequalizer">
<h3 class="section">27.112 superequalizer</h3>
<p>Apply 18 band equalizer.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">1b</samp></dt>
<dd><p>Set 65Hz band gain.
</p></dd>
<dt><samp class="option">2b</samp></dt>
<dd><p>Set 92Hz band gain.
</p></dd>
<dt><samp class="option">3b</samp></dt>
<dd><p>Set 131Hz band gain.
</p></dd>
<dt><samp class="option">4b</samp></dt>
<dd><p>Set 185Hz band gain.
</p></dd>
<dt><samp class="option">5b</samp></dt>
<dd><p>Set 262Hz band gain.
</p></dd>
<dt><samp class="option">6b</samp></dt>
<dd><p>Set 370Hz band gain.
</p></dd>
<dt><samp class="option">7b</samp></dt>
<dd><p>Set 523Hz band gain.
</p></dd>
<dt><samp class="option">8b</samp></dt>
<dd><p>Set 740Hz band gain.
</p></dd>
<dt><samp class="option">9b</samp></dt>
<dd><p>Set 1047Hz band gain.
</p></dd>
<dt><samp class="option">10b</samp></dt>
<dd><p>Set 1480Hz band gain.
</p></dd>
<dt><samp class="option">11b</samp></dt>
<dd><p>Set 2093Hz band gain.
</p></dd>
<dt><samp class="option">12b</samp></dt>
<dd><p>Set 2960Hz band gain.
</p></dd>
<dt><samp class="option">13b</samp></dt>
<dd><p>Set 4186Hz band gain.
</p></dd>
<dt><samp class="option">14b</samp></dt>
<dd><p>Set 5920Hz band gain.
</p></dd>
<dt><samp class="option">15b</samp></dt>
<dd><p>Set 8372Hz band gain.
</p></dd>
<dt><samp class="option">16b</samp></dt>
<dd><p>Set 11840Hz band gain.
</p></dd>
<dt><samp class="option">17b</samp></dt>
<dd><p>Set 16744Hz band gain.
</p></dd>
<dt><samp class="option">18b</samp></dt>
<dd><p>Set 20000Hz band gain.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="surround">
<h3 class="section">27.113 surround</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 class="table">
<dt><samp class="option">chl_out</samp></dt>
<dd><p>Set output channel layout. By default, this is <var class="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><samp class="option">chl_in</samp></dt>
<dd><p>Set input channel layout. By default, this is <var class="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><samp class="option">level_in</samp></dt>
<dd><p>Set input volume level. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">level_out</samp></dt>
<dd><p>Set output volume level. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">lfe</samp></dt>
<dd><p>Enable LFE channel output if output channel layout has it. By default, this is enabled.
</p>
</dd>
<dt><samp class="option">lfe_low</samp></dt>
<dd><p>Set LFE low cut off frequency. By default, this is <var class="var">128</var> Hz.
</p>
</dd>
<dt><samp class="option">lfe_high</samp></dt>
<dd><p>Set LFE high cut off frequency. By default, this is <var class="var">256</var> Hz.
</p>
</dd>
<dt><samp class="option">lfe_mode</samp></dt>
<dd><p>Set LFE mode, can be <var class="var">add</var> or <var class="var">sub</var>. Default is <var class="var">add</var>.
In <var class="var">add</var> mode, LFE channel is created from input audio and added to output.
In <var class="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><samp class="option">smooth</samp></dt>
<dd><p>Set temporal smoothness strength, used to gradually change factors when transforming
stereo sound in time. Allowed range is from <var class="var">0.0</var> to <var class="var">1.0</var>.
Useful to improve output quality with <var class="var">focus</var> option values greater than <var class="var">0.0</var>.
Default is <var class="var">0.0</var>. Only values inside this range and without edges are effective.
</p>
</dd>
<dt><samp class="option">angle</samp></dt>
<dd><p>Set angle of stereo surround transform, Allowed range is from <var class="var">0</var> to <var class="var">360</var>.
Default is <var class="var">90</var>.
</p>
</dd>
<dt><samp class="option">focus</samp></dt>
<dd><p>Set focus of stereo surround transform, Allowed range is from <var class="var">-1</var> to <var class="var">1</var>.
Default is <var class="var">0</var>.
</p>
</dd>
<dt><samp class="option">fc_in</samp></dt>
<dd><p>Set front center input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">fc_out</samp></dt>
<dd><p>Set front center output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">fl_in</samp></dt>
<dd><p>Set front left input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">fl_out</samp></dt>
<dd><p>Set front left output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">fr_in</samp></dt>
<dd><p>Set front right input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">fr_out</samp></dt>
<dd><p>Set front right output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">sl_in</samp></dt>
<dd><p>Set side left input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">sl_out</samp></dt>
<dd><p>Set side left output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">sr_in</samp></dt>
<dd><p>Set side right input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">sr_out</samp></dt>
<dd><p>Set side right output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">bl_in</samp></dt>
<dd><p>Set back left input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">bl_out</samp></dt>
<dd><p>Set back left output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">br_in</samp></dt>
<dd><p>Set back right input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">br_out</samp></dt>
<dd><p>Set back right output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">bc_in</samp></dt>
<dd><p>Set back center input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">bc_out</samp></dt>
<dd><p>Set back center output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">lfe_in</samp></dt>
<dd><p>Set LFE input volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">lfe_out</samp></dt>
<dd><p>Set LFE output volume. By default, this is <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">allx</samp></dt>
<dd><p>Set spread usage of stereo image across X axis for all channels.
Allowed range is from <var class="var">-1</var> to <var class="var">15</var>.
By default this value is negative <var class="var">-1</var>, and thus unused.
</p>
</dd>
<dt><samp class="option">ally</samp></dt>
<dd><p>Set spread usage of stereo image across Y axis for all channels.
Allowed range is from <var class="var">-1</var> to <var class="var">15</var>.
By default this value is negative <var class="var">-1</var>, and thus unused.
</p>
</dd>
<dt><samp class="option">fcx, flx, frx, blx, brx, slx, srx, bcx</samp></dt>
<dd><p>Set spread usage of stereo image across X axis for each channel.
Allowed range is from <var class="var">0.06</var> to <var class="var">15</var>.
By default this value is <var class="var">0.5</var>.
</p>
</dd>
<dt><samp class="option">fcy, fly, fry, bly, bry, sly, sry, bcy</samp></dt>
<dd><p>Set spread usage of stereo image across Y axis for each channel.
Allowed range is from <var class="var">0.06</var> to <var class="var">15</var>.
By default this value is <var class="var">0.5</var>.
</p>
</dd>
<dt><samp class="option">win_size</samp></dt>
<dd><p>Set window size. Allowed range is from <var class="var">1024</var> to <var class="var">65536</var>. Default size is <var class="var">4096</var>.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann, hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set window overlap. If set to 1, the recommended overlap for selected
window function will be picked. Default is <code class="code">0.5</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="tiltshelf">
<h3 class="section">27.114 tiltshelf</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 class="table">
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Give the gain at 0 Hz. Its useful range is about -20
(for a large cut) to +20 (for a large boost).
Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp class="option">frequency, f</samp></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 class="code">3000</code> Hz.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Determine how steep is the filter’s shelf transition.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-51" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-51">
<h4 class="subsection">27.114.1 Commands</h4>
<p>This filter supports some options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="treble_002c-highshelf">
<h3 class="section">27.115 treble, highshelf</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 class="table">
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Give the gain at whichever is the lower of ~22 kHz and the
Nyquist frequency. Its useful range is about -20 (for a large cut)
to +20 (for a large boost). Beware of clipping when using a positive gain.
</p>
</dd>
<dt><samp class="option">frequency, f</samp></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 class="code">3000</code> Hz.
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Set method to specify band-width of filter.
</p><dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Hz
</p></dd>
<dt><samp class="option">q</samp></dt>
<dd><p>Q-Factor
</p></dd>
<dt><samp class="option">o</samp></dt>
<dd><p>octave
</p></dd>
<dt><samp class="option">s</samp></dt>
<dd><p>slope
</p></dd>
<dt><samp class="option">k</samp></dt>
<dd><p>kHz
</p></dd>
</dl>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Determine how steep is the filter’s shelf transition.
</p>
</dd>
<dt><samp class="option">poles, p</samp></dt>
<dd><p>Set number of poles. Default is 2.
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>How much to use filtered signal in output. Default is 1.
Range is between 0 and 1.
</p>
</dd>
<dt><samp class="option">channels, c</samp></dt>
<dd><p>Specify which channels to filter, by default all available are filtered.
</p>
</dd>
<dt><samp class="option">normalize, n</samp></dt>
<dd><p>Normalize biquad coefficients, by default is disabled.
Enabling it will normalize magnitude response at DC to 0dB.
</p>
</dd>
<dt><samp class="option">transform, a</samp></dt>
<dd><p>Set transform type of IIR filter.
</p><dl class="table">
<dt><samp class="option">di</samp></dt>
<dt><samp class="option">dii</samp></dt>
<dt><samp class="option">tdi</samp></dt>
<dt><samp class="option">tdii</samp></dt>
<dt><samp class="option">latt</samp></dt>
<dt><samp class="option">svf</samp></dt>
<dt><samp class="option">zdf</samp></dt>
</dl>
</dd>
<dt><samp class="option">precision, r</samp></dt>
<dd><p>Set precison of filtering.
</p><dl class="table">
<dt><samp class="option">auto</samp></dt>
<dd><p>Pick automatic sample format depending on surround filters.
</p></dd>
<dt><samp class="option">s16</samp></dt>
<dd><p>Always use signed 16-bit.
</p></dd>
<dt><samp class="option">s32</samp></dt>
<dd><p>Always use signed 32-bit.
</p></dd>
<dt><samp class="option">f32</samp></dt>
<dd><p>Always use float 32-bit.
</p></dd>
<dt><samp class="option">f64</samp></dt>
<dd><p>Always use float 64-bit.
</p></dd>
</dl>
</dd>
<dt><samp class="option">block_size, b</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-52" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-52">
<h4 class="subsection">27.115.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Change treble frequency.
Syntax for the command is : "<var class="var">frequency</var>"
</p>
</dd>
<dt><samp class="option">width_type, t</samp></dt>
<dd><p>Change treble width_type.
Syntax for the command is : "<var class="var">width_type</var>"
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dd><p>Change treble width.
Syntax for the command is : "<var class="var">width</var>"
</p>
</dd>
<dt><samp class="option">gain, g</samp></dt>
<dd><p>Change treble gain.
Syntax for the command is : "<var class="var">gain</var>"
</p>
</dd>
<dt><samp class="option">mix, m</samp></dt>
<dd><p>Change treble mix.
Syntax for the command is : "<var class="var">mix</var>"
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="tremolo">
<h3 class="section">27.116 tremolo</h3>
<p>Sinusoidal amplitude modulation.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">f</samp></dt>
<dd><p>Modulation frequency in Hertz. Modulation frequencies in the subharmonic range
(20 Hz or lower) will result in a tremolo effect.
This filter may also be used as a ring modulator by specifying
a modulation frequency higher than 20 Hz.
Range is 0.1 - 20000.0. Default value is 5.0 Hz.
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>Depth of modulation as a percentage. Range is 0.0 - 1.0.
Default value is 0.5.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="vibrato">
<h3 class="section">27.117 vibrato</h3>
<p>Sinusoidal phase modulation.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">f</samp></dt>
<dd><p>Modulation frequency in Hertz.
Range is 0.1 - 20000.0. Default value is 5.0 Hz.
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>Depth of modulation as a percentage. Range is 0.0 - 1.0.
Default value is 0.5.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="virtualbass">
<h3 class="section">27.118 virtualbass</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 class="table">
<dt><samp class="option">cutoff</samp></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><samp class="option">strength</samp></dt>
<dd><p>Set the virtual bass strength. Allowed range is from 0.5 to 3.
Default value is 3.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="volume">
<h3 class="section">27.119 volume</h3>
<p>Adjust the input audio volume.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">volume</samp></dt>
<dd><p>Set audio volume expression.
</p>
<p>Output values are clipped to the maximum value.
</p>
<p>The output audio volume is given by the relation:
</p><div class="example">
<pre class="example-preformatted"><var class="var">output_volume</var> = <var class="var">volume</var> * <var class="var">input_volume</var>
</pre></div>
<p>The default value for <var class="var">volume</var> is "1.0".
</p>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>This parameter represents the mathematical precision.
</p>
<p>It determines which input sample formats will be allowed, which affects the
precision of the volume scaling.
</p>
<dl class="table">
<dt><samp class="option">fixed</samp></dt>
<dd><p>8-bit fixed-point; this limits input sample format to U8, S16, and S32.
</p></dd>
<dt><samp class="option">float</samp></dt>
<dd><p>32-bit floating-point; this limits input sample format to FLT. (default)
</p></dd>
<dt><samp class="option">double</samp></dt>
<dd><p>64-bit floating-point; this limits input sample format to DBL.
</p></dd>
</dl>
</dd>
<dt><samp class="option">replaygain</samp></dt>
<dd><p>Choose the behaviour on encountering ReplayGain side data in input frames.
</p>
<dl class="table">
<dt><samp class="option">drop</samp></dt>
<dd><p>Remove ReplayGain side data, ignoring its contents (the default).
</p>
</dd>
<dt><samp class="option">ignore</samp></dt>
<dd><p>Ignore ReplayGain side data, but leave it in the frame.
</p>
</dd>
<dt><samp class="option">track</samp></dt>
<dd><p>Prefer the track gain, if present.
</p>
</dd>
<dt><samp class="option">album</samp></dt>
<dd><p>Prefer the album gain, if present.
</p></dd>
</dl>
</dd>
<dt><samp class="option">replaygain_preamp</samp></dt>
<dd><p>Pre-amplification gain in dB to apply to the selected replaygain gain.
</p>
<p>Default value for <var class="var">replaygain_preamp</var> is 0.0.
</p>
</dd>
<dt><samp class="option">replaygain_noclip</samp></dt>
<dd><p>Prevent clipping by limiting the gain applied.
</p>
<p>Default value for <var class="var">replaygain_noclip</var> is 1.
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set when the volume expression is evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">once</samp>’</dt>
<dd><p>only evaluate expression once during the filter initialization, or
when the ‘<samp class="samp">volume</samp>’ command is sent
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>evaluate expression for each incoming frame
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">once</samp>’.
</p></dd>
</dl>
<p>The volume expression can contain the following parameters.
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>frame number (starting at zero)
</p></dd>
<dt><samp class="option">nb_channels</samp></dt>
<dd><p>number of channels
</p></dd>
<dt><samp class="option">nb_consumed_samples</samp></dt>
<dd><p>number of samples consumed by the filter
</p></dd>
<dt><samp class="option">nb_samples</samp></dt>
<dd><p>number of samples in the current frame
</p></dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>original frame position in the file; deprecated, do not use
</p></dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>frame PTS
</p></dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>sample rate
</p></dd>
<dt><samp class="option">startpts</samp></dt>
<dd><p>PTS at start of stream
</p></dd>
<dt><samp class="option">startt</samp></dt>
<dd><p>time at start of stream
</p></dd>
<dt><samp class="option">t</samp></dt>
<dd><p>frame time
</p></dd>
<dt><samp class="option">tb</samp></dt>
<dd><p>timestamp timebase
</p></dd>
<dt><samp class="option">volume</samp></dt>
<dd><p>last set volume value
</p></dd>
</dl>
<p>Note that when <samp class="option">eval</samp> is set to ‘<samp class="samp">once</samp>’ only the
<var class="var">sample_rate</var> and <var class="var">tb</var> variables are available, all other
variables will evaluate to NAN.
</p>
<ul class="mini-toc">
<li><a href="#Commands-53" accesskey="1">Commands</a></li>
<li><a href="#Examples-51" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-53">
<h4 class="subsection">27.119.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">volume</samp></dt>
<dd><p>Modify the volume expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-51">
<h4 class="subsection">27.119.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Halve the input audio volume:
<div class="example">
<pre class="example-preformatted">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 class="option">volume</samp> can be
omitted, for example like in:
</p><div class="example">
<pre class="example-preformatted">volume=0.5
</pre></div>
</li><li>Increase input audio power by 6 decibels using fixed-point precision:
<div class="example">
<pre class="example-preformatted">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-preformatted">volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="volumedetect">
<h3 class="section">27.120 volumedetect</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>
<ul class="mini-toc">
<li><a href="#Examples-52" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-52">
<h4 class="subsection">27.120.1 Examples</h4>
<p>Here is an excerpt of the output:
</p><div class="example">
<pre class="example-preformatted">[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 class="itemize mark-bullet">
<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>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Audio-Sources">
<h2 class="chapter">28 Audio Sources</h2>
<p>Below is a description of the currently available audio sources.
</p>
<ul class="mini-toc">
<li><a href="#abuffer" accesskey="1">abuffer</a></li>
<li><a href="#aevalsrc" accesskey="2">aevalsrc</a></li>
<li><a href="#afdelaysrc" accesskey="3">afdelaysrc</a></li>
<li><a href="#afireqsrc" accesskey="4">afireqsrc</a></li>
<li><a href="#afirsrc" accesskey="5">afirsrc</a></li>
<li><a href="#anullsrc" accesskey="6">anullsrc</a></li>
<li><a href="#flite" accesskey="7">flite</a></li>
<li><a href="#anoisesrc" accesskey="8">anoisesrc</a></li>
<li><a href="#hilbert" accesskey="9">hilbert</a></li>
<li><a href="#sinc">sinc</a></li>
<li><a href="#sine">sine</a></li>
</ul>
<div class="section-level-extent" id="abuffer">
<h3 class="section">28.1 abuffer</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 class="file">libavfilter/buffersrc.h</samp>.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">time_base</samp></dt>
<dd><p>The timebase which will be used for timestamps of submitted frames. It must be
either a floating-point number or in <var class="var">numerator</var>/<var class="var">denominator</var> form.
</p>
</dd>
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>The sample rate of the incoming audio buffers.
</p>
</dd>
<dt><samp class="option">sample_fmt</samp></dt>
<dd><p>The sample format of the incoming audio buffers.
Either a sample format name or its corresponding integer representation from
the enum AVSampleFormat in <samp class="file">libavutil/samplefmt.h</samp>
</p>
</dd>
<dt><samp class="option">channel_layout</samp></dt>
<dd><p>The channel layout of the incoming audio buffers.
Either a channel layout name from channel_layout_map in
<samp class="file">libavutil/channel_layout.c</samp> or its corresponding integer representation
from the AV_CH_LAYOUT_* macros in <samp class="file">libavutil/channel_layout.h</samp>
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>The number of channels of the incoming audio buffers.
If both <var class="var">channels</var> and <var class="var">channel_layout</var> are specified, then they
must be consistent.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-53" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-53">
<h4 class="subsection">28.1.1 Examples</h4>
<div class="example">
<pre class="example-preformatted">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-preformatted">abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
</pre></div>
</div>
</div>
<div class="section-level-extent" id="aevalsrc">
<h3 class="section">28.2 aevalsrc</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 class="table">
<dt><samp class="option">exprs</samp></dt>
<dd><p>Set the ’|’-separated expressions list for each separate channel. In case the
<samp class="option">channel_layout</samp> option is not specified, the selected channel layout
depends on the number of provided expressions. Otherwise the last
specified expression is applied to the remaining output channels.
</p>
</dd>
<dt><samp class="option">channel_layout, c</samp></dt>
<dd><p>Set the channel layout. The number of channels in the specified layout
must be equal to the number of specified expressions.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per channel per each output frame,
default to 1024.
</p>
</dd>
<dt><samp class="option">sample_rate, s</samp></dt>
<dd><p>Specify the sample rate, default to 44100.
</p></dd>
</dl>
<p>Each expression in <var class="var">exprs</var> can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>number of the evaluated sample, starting from 0
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>time of the evaluated sample expressed in seconds, starting from 0
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>sample rate
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-54" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-54">
<h4 class="subsection">28.2.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Generate silence:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">aevalsrc="-2+random(0)"
</pre></div>
</li><li>Generate an amplitude modulated signal:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="afdelaysrc">
<h3 class="section">28.3 afdelaysrc</h3>
<p>Generate a fractional delay FIR coefficients.
</p>
<p>The resulting stream can be used with <a class="ref" href="#afir">afir</a> filter for filtering the audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">delay, d</samp></dt>
<dd><p>Set the fractional delay. Default is 0.
</p>
</dd>
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Set the sample rate, default is 44100.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per each frame. Default is 1024.
</p>
</dd>
<dt><samp class="option">taps, t</samp></dt>
<dd><p>Set the number of filter coefficents in output audio stream.
Default value is 0.
</p>
</dd>
<dt><samp class="option">channel_layout, c</samp></dt>
<dd><p>Specifies the channel layout, and can be a string representing a channel layout.
The default value of <var class="var">channel_layout</var> is "stereo".
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="afireqsrc">
<h3 class="section">28.4 afireqsrc</h3>
<p>Generate a FIR equalizer coefficients.
</p>
<p>The resulting stream can be used with <a class="ref" href="#afir">afir</a> filter for filtering the audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">preset, p</samp></dt>
<dd><p>Set equalizer preset.
Default preset is <code class="code">flat</code>.
</p>
<p>Available presets are:
</p><dl class="table">
<dt>‘<samp class="samp">custom</samp>’</dt>
<dt>‘<samp class="samp">flat</samp>’</dt>
<dt>‘<samp class="samp">acoustic</samp>’</dt>
<dt>‘<samp class="samp">bass</samp>’</dt>
<dt>‘<samp class="samp">beats</samp>’</dt>
<dt>‘<samp class="samp">classic</samp>’</dt>
<dt>‘<samp class="samp">clear</samp>’</dt>
<dt>‘<samp class="samp">deep bass</samp>’</dt>
<dt>‘<samp class="samp">dubstep</samp>’</dt>
<dt>‘<samp class="samp">electronic</samp>’</dt>
<dt>‘<samp class="samp">hard-style</samp>’</dt>
<dt>‘<samp class="samp">hip-hop</samp>’</dt>
<dt>‘<samp class="samp">jazz</samp>’</dt>
<dt>‘<samp class="samp">metal</samp>’</dt>
<dt>‘<samp class="samp">movie</samp>’</dt>
<dt>‘<samp class="samp">pop</samp>’</dt>
<dt>‘<samp class="samp">r&b</samp>’</dt>
<dt>‘<samp class="samp">rock</samp>’</dt>
<dt>‘<samp class="samp">vocal booster</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">gains, g</samp></dt>
<dd><p>Set custom gains for each band. Only used if the preset option is set to <code class="code">custom</code>.
Gains are separated by white spaces and each gain is set in dBFS.
Default is <code class="code">0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0</code>.
</p>
</dd>
<dt><samp class="option">bands, b</samp></dt>
<dd><p>Set the custom bands from where custon equalizer gains are set.
This must be in strictly increasing order. Only used if the preset option is set to <code class="code">custom</code>.
Bands are separated by white spaces and each band represent frequency in Hz.
Default is <code class="code">25 40 63 100 160 250 400 630 1000 1600 2500 4000 6300 10000 16000 24000</code>.
</p>
</dd>
<dt><samp class="option">taps, t</samp></dt>
<dd><p>Set number of filter coefficents in output audio stream.
Default value is <code class="code">4096</code>.
</p>
</dd>
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Set sample rate of output audio stream, default is <code class="code">44100</code>.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set number of samples per each frame in output audio stream. Default is <code class="code">1024</code>.
</p>
</dd>
<dt><samp class="option">interp, i</samp></dt>
<dd><p>Set interpolation method for FIR equalizer coefficients. Can be <code class="code">linear</code> or <code class="code">cubic</code>.
</p>
</dd>
<dt><samp class="option">phase, h</samp></dt>
<dd><p>Set phase type of FIR filter. Can be <code class="code">linear</code> or <code class="code">min</code>: minimum-phase.
Default is minimum-phase filter.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="afirsrc">
<h3 class="section">28.5 afirsrc</h3>
<p>Generate a FIR coefficients using frequency sampling method.
</p>
<p>The resulting stream can be used with <a class="ref" href="#afir">afir</a> filter for filtering the audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">taps, t</samp></dt>
<dd><p>Set number of filter coefficents in output audio stream.
Default value is 1025.
</p>
</dd>
<dt><samp class="option">frequency, f</samp></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><samp class="option">magnitude, m</samp></dt>
<dd><p>Set magnitude value for every frequency point set by <samp class="option">frequency</samp>.
Number of values must be same as number of frequency points.
Values are separated by white spaces.
</p>
</dd>
<dt><samp class="option">phase, p</samp></dt>
<dd><p>Set phase value for every frequency point set by <samp class="option">frequency</samp>.
Number of values must be same as number of frequency points.
Values are separated by white spaces.
</p>
</dd>
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Set sample rate, default is 44100.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set number of samples per each frame. Default is 1024.
</p>
</dd>
<dt><samp class="option">win_func, w</samp></dt>
<dd><p>Set window function. Default is blackman.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="anullsrc">
<h3 class="section">28.6 anullsrc</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 class="table">
<dt><samp class="option">channel_layout, cl</samp></dt>
<dd>
<p>Specifies the channel layout, and can be either an integer or a string
representing a channel layout. The default value of <var class="var">channel_layout</var>
is "stereo".
</p>
<p>Check the channel_layout_map definition in
<samp class="file">libavutil/channel_layout.c</samp> for the mapping between strings and
channel layout values.
</p>
</dd>
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Specifies the sample rate, and defaults to 44100.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per requested frames.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-55" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-55">
<h4 class="subsection">28.6.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO.
<div class="example">
<pre class="example-preformatted">anullsrc=r=48000:cl=4
</pre></div>
</li><li>Do the same operation with a more obvious syntax:
<div class="example">
<pre class="example-preformatted">anullsrc=r=48000:cl=mono
</pre></div>
</li></ul>
<p>All the parameters need to be explicitly defined.
</p>
</div>
</div>
<div class="section-level-extent" id="flite">
<h3 class="section">28.7 flite</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 class="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 class="table">
<dt><samp class="option">list_voices</samp></dt>
<dd><p>If set to 1, list the names of the available voices and exit
immediately. Default value is 0.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the maximum number of samples per frame. Default value is 512.
</p>
</dd>
<dt><samp class="option">textfile</samp></dt>
<dd><p>Set the filename containing the text to speak.
</p>
</dd>
<dt><samp class="option">text</samp></dt>
<dd><p>Set the text to speak.
</p>
</dd>
<dt><samp class="option">voice, v</samp></dt>
<dd><p>Set the voice to use for the speech synthesis. Default value is
<code class="code">kal</code>. See also the <var class="var">list_voices</var> option.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-56" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-56">
<h4 class="subsection">28.7.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Read from file <samp class="file">speech.txt</samp>, and synthesize the text using the
standard flite voice:
<div class="example">
<pre class="example-preformatted">flite=textfile=speech.txt
</pre></div>
</li><li>Read the specified text selecting the <code class="code">slt</code> voice:
<div class="example">
<pre class="example-preformatted">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-preformatted">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 class="file">ffplay</samp> speak the specified text, using <code class="code">flite</code> and
the <code class="code">lavfi</code> device:
<div class="example">
<pre class="example-preformatted">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 class="url" href="http://www.festvox.org/flite/">http://www.festvox.org/flite/</a>
</p>
</div>
</div>
<div class="section-level-extent" id="anoisesrc">
<h3 class="section">28.8 anoisesrc</h3>
<p>Generate a noise audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Specify the sample rate. Default value is 48000 Hz.
</p>
</dd>
<dt><samp class="option">amplitude, a</samp></dt>
<dd><p>Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value
is 1.0.
</p>
</dd>
<dt><samp class="option">duration, d</samp></dt>
<dd><p>Specify the duration of the generated audio stream. Not specifying this option
results in noise with an infinite length.
</p>
</dd>
<dt><samp class="option">color, colour, c</samp></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><samp class="option">seed, s</samp></dt>
<dd><p>Specify a value used to seed the PRNG.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set the number of samples per each output frame, default is 1024.
</p>
</dd>
<dt><samp class="option">density</samp></dt>
<dd><p>Set the density (0.0 - 1.0) for the velvet noise generator, default is 0.05.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-57" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-57">
<h4 class="subsection">28.8.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">anoisesrc=d=60:c=pink:r=44100:a=0.5
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="hilbert">
<h3 class="section">28.9 hilbert</h3>
<p>Generate odd-tap Hilbert transform FIR coefficients.
</p>
<p>The resulting stream can be used with <a class="ref" 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 class="table">
<dt><samp class="option">sample_rate, s</samp></dt>
<dd><p>Set sample rate, default is 44100.
</p>
</dd>
<dt><samp class="option">taps, t</samp></dt>
<dd><p>Set length of FIR filter, default is 22051.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set number of samples per each frame.
</p>
</dd>
<dt><samp class="option">win_func, w</samp></dt>
<dd><p>Set window function to be used when generating FIR coefficients.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="sinc">
<h3 class="section">28.10 sinc</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 class="ref" href="#afir">afir</a> filter for filtering the audio signal.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Set sample rate, default is 44100.
</p>
</dd>
<dt><samp class="option">nb_samples, n</samp></dt>
<dd><p>Set number of samples per each frame. Default is 1024.
</p>
</dd>
<dt><samp class="option">hp</samp></dt>
<dd><p>Set high-pass frequency. Default is 0.
</p>
</dd>
<dt><samp class="option">lp</samp></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><samp class="option">phase</samp></dt>
<dd><p>Set filter phase response. Default is 50. Allowed range is from 0 to 100.
</p>
</dd>
<dt><samp class="option">beta</samp></dt>
<dd><p>Set Kaiser window beta.
</p>
</dd>
<dt><samp class="option">att</samp></dt>
<dd><p>Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB.
</p>
</dd>
<dt><samp class="option">round</samp></dt>
<dd><p>Enable rounding, by default is disabled.
</p>
</dd>
<dt><samp class="option">hptaps</samp></dt>
<dd><p>Set number of taps for high-pass filter.
</p>
</dd>
<dt><samp class="option">lptaps</samp></dt>
<dd><p>Set number of taps for low-pass filter.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="sine">
<h3 class="section">28.11 sine</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 class="table">
<dt><samp class="option">frequency, f</samp></dt>
<dd><p>Set the carrier frequency. Default is 440 Hz.
</p>
</dd>
<dt><samp class="option">beep_factor, b</samp></dt>
<dd><p>Enable a periodic beep every second with frequency <var class="var">beep_factor</var> times
the carrier frequency. Default is 0, meaning the beep is disabled.
</p>
</dd>
<dt><samp class="option">sample_rate, r</samp></dt>
<dd><p>Specify the sample rate, default is 44100.
</p>
</dd>
<dt><samp class="option">duration, d</samp></dt>
<dd><p>Specify the duration of the generated audio stream.
</p>
</dd>
<dt><samp class="option">samples_per_frame</samp></dt>
<dd><p>Set the number of samples per output frame.
</p>
<p>The expression can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>The (sequential) number of the output audio frame, starting from 0.
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>The PTS (Presentation TimeStamp) of the output audio frame,
expressed in <var class="var">TB</var> units.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>The PTS of the output audio frame, expressed in seconds.
</p>
</dd>
<dt><samp class="option">TB</samp></dt>
<dd><p>The timebase of the output audio frames.
</p></dd>
</dl>
<p>Default is <code class="code">1024</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-58" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-58">
<h4 class="subsection">28.11.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Generate a simple 440 Hz sine wave:
<div class="example">
<pre class="example-preformatted">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-preformatted">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 class="code">1602,1601,1602,1601,1602</code> NTSC
pattern:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Audio-Sinks">
<h2 class="chapter">29 Audio Sinks</h2>
<p>Below is a description of the currently available audio sinks.
</p>
<ul class="mini-toc">
<li><a href="#abuffersink" accesskey="1">abuffersink</a></li>
<li><a href="#anullsink" accesskey="2">anullsink</a></li>
</ul>
<div class="section-level-extent" id="abuffersink">
<h3 class="section">29.1 abuffersink</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 class="file">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 class="code">avfilter_init_filter</code> for initialization.
</p></div>
<div class="section-level-extent" id="anullsink">
<h3 class="section">29.2 anullsink</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>
</div>
</div>
<div class="chapter-level-extent" id="Video-Filters">
<h2 class="chapter">30 Video Filters</h2>
<p>When you configure your FFmpeg build, you can disable any of the
existing filters using <code class="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>
<ul class="mini-toc">
<li><a href="#addroi" accesskey="1">addroi</a></li>
<li><a href="#alphaextract" accesskey="2">alphaextract</a></li>
<li><a href="#alphamerge" accesskey="3">alphamerge</a></li>
<li><a href="#amplify" accesskey="4">amplify</a></li>
<li><a href="#ass" accesskey="5">ass</a></li>
<li><a href="#atadenoise" accesskey="6">atadenoise</a></li>
<li><a href="#avgblur" accesskey="7">avgblur</a></li>
<li><a href="#backgroundkey" accesskey="8">backgroundkey</a></li>
<li><a href="#bbox" accesskey="9">bbox</a></li>
<li><a href="#bilateral">bilateral</a></li>
<li><a href="#bilateral_005fcuda">bilateral_cuda</a></li>
<li><a href="#bitplanenoise">bitplanenoise</a></li>
<li><a href="#blackdetect">blackdetect</a></li>
<li><a href="#blackframe">blackframe</a></li>
<li><a href="#blend-1">blend</a></li>
<li><a href="#blockdetect-1">blockdetect</a></li>
<li><a href="#blurdetect-1">blurdetect</a></li>
<li><a href="#bm3d">bm3d</a></li>
<li><a href="#boxblur">boxblur</a></li>
<li><a href="#bwdif-1">bwdif</a></li>
<li><a href="#bwdif_005fcuda">bwdif_cuda</a></li>
<li><a href="#ccrepack">ccrepack</a></li>
<li><a href="#cas">cas</a></li>
<li><a href="#chromahold">chromahold</a></li>
<li><a href="#chromakey-1">chromakey</a></li>
<li><a href="#chromakey_005fcuda">chromakey_cuda</a></li>
<li><a href="#chromanr">chromanr</a></li>
<li><a href="#chromashift">chromashift</a></li>
<li><a href="#ciescope">ciescope</a></li>
<li><a href="#codecview">codecview</a></li>
<li><a href="#colorbalance">colorbalance</a></li>
<li><a href="#colorcontrast">colorcontrast</a></li>
<li><a href="#colorcorrect">colorcorrect</a></li>
<li><a href="#colorchannelmixer">colorchannelmixer</a></li>
<li><a href="#colorize">colorize</a></li>
<li><a href="#colorkey">colorkey</a></li>
<li><a href="#colorhold">colorhold</a></li>
<li><a href="#colorlevels">colorlevels</a></li>
<li><a href="#colormap">colormap</a></li>
<li><a href="#colormatrix">colormatrix</a></li>
<li><a href="#colorspace">colorspace</a></li>
<li><a href="#colorspace_005fcuda">colorspace_cuda</a></li>
<li><a href="#colortemperature">colortemperature</a></li>
<li><a href="#convolution">convolution</a></li>
<li><a href="#convolve">convolve</a></li>
<li><a href="#copy">copy</a></li>
<li><a href="#coreimage-1">coreimage</a></li>
<li><a href="#corr">corr</a></li>
<li><a href="#cover_005frect">cover_rect</a></li>
<li><a href="#crop">crop</a></li>
<li><a href="#cropdetect">cropdetect</a></li>
<li><a href="#cue-1">cue</a></li>
<li><a href="#curves-1">curves</a></li>
<li><a href="#datascope">datascope</a></li>
<li><a href="#dblur">dblur</a></li>
<li><a href="#dctdnoiz">dctdnoiz</a></li>
<li><a href="#deband">deband</a></li>
<li><a href="#deblock">deblock</a></li>
<li><a href="#decimate-1">decimate</a></li>
<li><a href="#deconvolve">deconvolve</a></li>
<li><a href="#dedot">dedot</a></li>
<li><a href="#deflate">deflate</a></li>
<li><a href="#deflicker">deflicker</a></li>
<li><a href="#dejudder">dejudder</a></li>
<li><a href="#delogo">delogo</a></li>
<li><a href="#derain-1">derain</a></li>
<li><a href="#deshake">deshake</a></li>
<li><a href="#despill">despill</a></li>
<li><a href="#detelecine">detelecine</a></li>
<li><a href="#dilation-1">dilation</a></li>
<li><a href="#displace">displace</a></li>
<li><a href="#dnn_005fclassify">dnn_classify</a></li>
<li><a href="#dnn_005fdetect">dnn_detect</a></li>
<li><a href="#dnn_005fprocessing-1">dnn_processing</a></li>
<li><a href="#drawbox">drawbox</a></li>
<li><a href="#drawgraph-1">drawgraph</a></li>
<li><a href="#drawgrid">drawgrid</a></li>
<li><a href="#drawtext-1">drawtext</a></li>
<li><a href="#edgedetect">edgedetect</a></li>
<li><a href="#elbg">elbg</a></li>
<li><a href="#entropy">entropy</a></li>
<li><a href="#epx">epx</a></li>
<li><a href="#eq">eq</a></li>
<li><a href="#erosion-1">erosion</a></li>
<li><a href="#estdif">estdif</a></li>
<li><a href="#exposure">exposure</a></li>
<li><a href="#extractplanes">extractplanes</a></li>
<li><a href="#fade">fade</a></li>
<li><a href="#feedback">feedback</a></li>
<li><a href="#fftdnoiz">fftdnoiz</a></li>
<li><a href="#fftfilt">fftfilt</a></li>
<li><a href="#field">field</a></li>
<li><a href="#fieldhint">fieldhint</a></li>
<li><a href="#fieldmatch">fieldmatch</a></li>
<li><a href="#fieldorder">fieldorder</a></li>
<li><a href="#fifo_002c-afifo">fifo, afifo</a></li>
<li><a href="#fillborders">fillborders</a></li>
<li><a href="#find_005frect">find_rect</a></li>
<li><a href="#floodfill">floodfill</a></li>
<li><a href="#format-1">format</a></li>
<li><a href="#fps-1">fps</a></li>
<li><a href="#framepack">framepack</a></li>
<li><a href="#framerate">framerate</a></li>
<li><a href="#framestep">framestep</a></li>
<li><a href="#freezedetect">freezedetect</a></li>
<li><a href="#freezeframes">freezeframes</a></li>
<li><a href="#frei0r-1">frei0r</a></li>
<li><a href="#fspp">fspp</a></li>
<li><a href="#gblur">gblur</a></li>
<li><a href="#geq">geq</a></li>
<li><a href="#gradfun">gradfun</a></li>
<li><a href="#graphmonitor-1">graphmonitor</a></li>
<li><a href="#grayworld">grayworld</a></li>
<li><a href="#greyedge">greyedge</a></li>
<li><a href="#guided">guided</a></li>
<li><a href="#haldclut-1">haldclut</a></li>
<li><a href="#hflip">hflip</a></li>
<li><a href="#histeq">histeq</a></li>
<li><a href="#histogram-1">histogram</a></li>
<li><a href="#hqdn3d-1">hqdn3d</a></li>
<li><a href="#hwdownload-1">hwdownload</a></li>
<li><a href="#hwmap">hwmap</a></li>
<li><a href="#hwupload-1">hwupload</a></li>
<li><a href="#hwupload_005fcuda-1">hwupload_cuda</a></li>
<li><a href="#hqx">hqx</a></li>
<li><a href="#hstack-1">hstack</a></li>
<li><a href="#hsvhold">hsvhold</a></li>
<li><a href="#hsvkey">hsvkey</a></li>
<li><a href="#hue">hue</a></li>
<li><a href="#huesaturation">huesaturation</a></li>
<li><a href="#hysteresis">hysteresis</a></li>
<li><a href="#iccdetect">iccdetect</a></li>
<li><a href="#iccgen">iccgen</a></li>
<li><a href="#identity">identity</a></li>
<li><a href="#idet">idet</a></li>
<li><a href="#il">il</a></li>
<li><a href="#inflate">inflate</a></li>
<li><a href="#interlace">interlace</a></li>
<li><a href="#kerndeint">kerndeint</a></li>
<li><a href="#kirsch">kirsch</a></li>
<li><a href="#lagfun">lagfun</a></li>
<li><a href="#lenscorrection">lenscorrection</a></li>
<li><a href="#lensfun">lensfun</a></li>
<li><a href="#libplacebo">libplacebo</a></li>
<li><a href="#libvmaf-1">libvmaf</a></li>
<li><a href="#libvmaf_005fcuda">libvmaf_cuda</a></li>
<li><a href="#limitdiff">limitdiff</a></li>
<li><a href="#limiter">limiter</a></li>
<li><a href="#loop">loop</a></li>
<li><a href="#lut1d">lut1d</a></li>
<li><a href="#lut3d-1">lut3d</a></li>
<li><a href="#lumakey">lumakey</a></li>
<li><a href="#lut_002c-lutrgb_002c-lutyuv">lut, lutrgb, lutyuv</a></li>
<li><a href="#lut2_002c-tlut2">lut2, tlut2</a></li>
<li><a href="#maskedclamp">maskedclamp</a></li>
<li><a href="#maskedmax">maskedmax</a></li>
<li><a href="#maskedmerge">maskedmerge</a></li>
<li><a href="#maskedmin">maskedmin</a></li>
<li><a href="#maskedthreshold">maskedthreshold</a></li>
<li><a href="#maskfun">maskfun</a></li>
<li><a href="#mcdeint">mcdeint</a></li>
<li><a href="#median">median</a></li>
<li><a href="#mergeplanes">mergeplanes</a></li>
<li><a href="#mestimate">mestimate</a></li>
<li><a href="#midequalizer">midequalizer</a></li>
<li><a href="#minterpolate">minterpolate</a></li>
<li><a href="#mix">mix</a></li>
<li><a href="#monochrome">monochrome</a></li>
<li><a href="#morpho">morpho</a></li>
<li><a href="#mpdecimate">mpdecimate</a></li>
<li><a href="#msad">msad</a></li>
<li><a href="#multiply">multiply</a></li>
<li><a href="#negate">negate</a></li>
<li><a href="#nlmeans-1">nlmeans</a></li>
<li><a href="#nnedi">nnedi</a></li>
<li><a href="#noformat">noformat</a></li>
<li><a href="#noise-1">noise</a></li>
<li><a href="#normalize">normalize</a></li>
<li><a href="#null-1">null</a></li>
<li><a href="#ocr">ocr</a></li>
<li><a href="#ocv">ocv</a></li>
<li><a href="#oscilloscope">oscilloscope</a></li>
<li><a href="#overlay-1">overlay</a></li>
<li><a href="#overlay_005fcuda-1">overlay_cuda</a></li>
<li><a href="#owdenoise">owdenoise</a></li>
<li><a href="#pad-1">pad</a></li>
<li><a href="#palettegen-1">palettegen</a></li>
<li><a href="#paletteuse">paletteuse</a></li>
<li><a href="#perspective">perspective</a></li>
<li><a href="#phase">phase</a></li>
<li><a href="#photosensitivity">photosensitivity</a></li>
<li><a href="#pixdesctest">pixdesctest</a></li>
<li><a href="#pixelize">pixelize</a></li>
<li><a href="#pixscope">pixscope</a></li>
<li><a href="#pp">pp</a></li>
<li><a href="#pp7">pp7</a></li>
<li><a href="#premultiply">premultiply</a></li>
<li><a href="#prewitt">prewitt</a></li>
<li><a href="#pseudocolor">pseudocolor</a></li>
<li><a href="#psnr">psnr</a></li>
<li><a href="#pullup-1">pullup</a></li>
<li><a href="#qp">qp</a></li>
<li><a href="#random">random</a></li>
<li><a href="#readeia608">readeia608</a></li>
<li><a href="#readvitc">readvitc</a></li>
<li><a href="#remap">remap</a></li>
<li><a href="#removegrain">removegrain</a></li>
<li><a href="#removelogo">removelogo</a></li>
<li><a href="#repeatfields">repeatfields</a></li>
<li><a href="#reverse">reverse</a></li>
<li><a href="#rgbashift">rgbashift</a></li>
<li><a href="#roberts">roberts</a></li>
<li><a href="#rotate">rotate</a></li>
<li><a href="#sab">sab</a></li>
<li><a href="#scale-1">scale</a></li>
<li><a href="#scale_005fcuda-1">scale_cuda</a></li>
<li><a href="#scale_005fnpp-1">scale_npp</a></li>
<li><a href="#scale2ref">scale2ref</a></li>
<li><a href="#scale2ref_005fnpp">scale2ref_npp</a></li>
<li><a href="#scale_005fvt">scale_vt</a></li>
<li><a href="#scharr">scharr</a></li>
<li><a href="#scroll">scroll</a></li>
<li><a href="#scdet-1">scdet</a></li>
<li><a href="#selectivecolor-1">selectivecolor</a></li>
<li><a href="#separatefields-1">separatefields</a></li>
<li><a href="#setdar_002c-setsar">setdar, setsar</a></li>
<li><a href="#setfield-1">setfield</a></li>
<li><a href="#setparams-1">setparams</a></li>
<li><a href="#sharpen_005fnpp">sharpen_npp</a></li>
<li><a href="#shear">shear</a></li>
<li><a href="#showinfo">showinfo</a></li>
<li><a href="#showpalette">showpalette</a></li>
<li><a href="#shuffleframes">shuffleframes</a></li>
<li><a href="#shufflepixels">shufflepixels</a></li>
<li><a href="#shuffleplanes">shuffleplanes</a></li>
<li><a href="#signalstats-1">signalstats</a></li>
<li><a href="#signature-1">signature</a></li>
<li><a href="#siti-1">siti</a></li>
<li><a href="#smartblur-1">smartblur</a></li>
<li><a href="#sobel">sobel</a></li>
<li><a href="#spp-1">spp</a></li>
<li><a href="#sr-1">sr</a></li>
<li><a href="#ssim">ssim</a></li>
<li><a href="#stereo3d">stereo3d</a></li>
<li><a href="#streamselect_002c-astreamselect">streamselect, astreamselect</a></li>
<li><a href="#subtitles-1">subtitles</a></li>
<li><a href="#super2xsai">super2xsai</a></li>
<li><a href="#swaprect">swaprect</a></li>
<li><a href="#swapuv">swapuv</a></li>
<li><a href="#tblend">tblend</a></li>
<li><a href="#telecine">telecine</a></li>
<li><a href="#thistogram">thistogram</a></li>
<li><a href="#threshold">threshold</a></li>
<li><a href="#thumbnail">thumbnail</a></li>
<li><a href="#tile-1">tile</a></li>
<li><a href="#tinterlace">tinterlace</a></li>
<li><a href="#tmedian">tmedian</a></li>
<li><a href="#tmidequalizer">tmidequalizer</a></li>
<li><a href="#tmix">tmix</a></li>
<li><a href="#tonemap-1">tonemap</a></li>
<li><a href="#tpad">tpad</a></li>
<li><a href="#transpose-1">transpose</a></li>
<li><a href="#transpose_005fnpp">transpose_npp</a></li>
<li><a href="#trim">trim</a></li>
<li><a href="#unpremultiply">unpremultiply</a></li>
<li><a href="#unsharp-1">unsharp</a></li>
<li><a href="#untile-1">untile</a></li>
<li><a href="#uspp">uspp</a></li>
<li><a href="#v360">v360</a></li>
<li><a href="#vaguedenoiser">vaguedenoiser</a></li>
<li><a href="#varblur">varblur</a></li>
<li><a href="#vectorscope">vectorscope</a></li>
<li><a href="#vidstabdetect-1">vidstabdetect</a></li>
<li><a href="#vidstabtransform-1">vidstabtransform</a></li>
<li><a href="#vflip">vflip</a></li>
<li><a href="#vfrdet">vfrdet</a></li>
<li><a href="#vibrance">vibrance</a></li>
<li><a href="#vif">vif</a></li>
<li><a href="#vignette-1">vignette</a></li>
<li><a href="#vmafmotion">vmafmotion</a></li>
<li><a href="#vstack-1">vstack</a></li>
<li><a href="#w3fdif">w3fdif</a></li>
<li><a href="#waveform">waveform</a></li>
<li><a href="#weave_002c-doubleweave">weave, doubleweave</a></li>
<li><a href="#xbr">xbr</a></li>
<li><a href="#xcorrelate">xcorrelate</a></li>
<li><a href="#xfade">xfade</a></li>
<li><a href="#xmedian">xmedian</a></li>
<li><a href="#xstack-1">xstack</a></li>
<li><a href="#yadif-1">yadif</a></li>
<li><a href="#yadif_005fcuda">yadif_cuda</a></li>
<li><a href="#yaepblur">yaepblur</a></li>
<li><a href="#zoompan">zoompan</a></li>
<li><a href="#zscale-1">zscale</a></li>
</ul>
<div class="section-level-extent" id="addroi">
<h3 class="section">30.1 addroi</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 class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Region distance in pixels from the left edge of the frame.
</p></dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Region distance in pixels from the top edge of the frame.
</p></dd>
<dt><samp class="option">w</samp></dt>
<dd><p>Region width in pixels.
</p></dd>
<dt><samp class="option">h</samp></dt>
<dd><p>Region height in pixels.
</p>
<p>The parameters <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var> and <var class="var">h</var> are expressions,
and may contain the following variables:
</p><dl class="table">
<dt><samp class="option">iw</samp></dt>
<dd><p>Width of the input frame.
</p></dd>
<dt><samp class="option">ih</samp></dt>
<dd><p>Height of the input frame.
</p></dd>
</dl>
</dd>
<dt><samp class="option">qoffset</samp></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><samp class="option">clear</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-59" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-59">
<h4 class="subsection">30.1.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Mark the centre quarter of the frame as interesting.
<div class="example">
<pre class="example-preformatted">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-preformatted">addroi=0:0:100:ih:+1/5
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="alphaextract">
<h3 class="section">30.2 alphaextract</h3>
<p>Extract the alpha component from the input as a grayscale video. This
is especially useful with the <var class="var">alphamerge</var> filter.
</p>
</div>
<div class="section-level-extent" id="alphamerge">
<h3 class="section">30.3 alphamerge</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 class="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 class="var">alphaextract</var>, you might use:
</p><div class="example">
<pre class="example-preformatted">movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
</pre></div>
</div>
<div class="section-level-extent" id="amplify">
<h3 class="section">30.4 amplify</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 class="table">
<dt><samp class="option">radius</samp></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><samp class="option">factor</samp></dt>
<dd><p>Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535.
</p>
</dd>
<dt><samp class="option">threshold</samp></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><samp class="option">tolerance</samp></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><samp class="option">low</samp></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><samp class="option">high</samp></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><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-54" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-54">
<h4 class="subsection">30.4.1 Commands</h4>
<p>This filter supports the following <a class="ref" href="#commands">commands</a> that corresponds to option of same name:
</p><dl class="table">
<dt><samp class="option">factor</samp></dt>
<dt><samp class="option">threshold</samp></dt>
<dt><samp class="option">tolerance</samp></dt>
<dt><samp class="option">low</samp></dt>
<dt><samp class="option">high</samp></dt>
<dt><samp class="option">planes</samp></dt>
</dl>
</div>
</div>
<div class="section-level-extent" id="ass">
<h3 class="section">30.5 ass</h3>
<p>Same as the <a class="ref" 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 class="ref" href="#subtitles">subtitles</a> filter:
</p>
<dl class="table">
<dt><samp class="option">shaping</samp></dt>
<dd><p>Set the shaping engine
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>The default libass shaping engine, which is the best available.
</p></dd>
<dt>‘<samp class="samp">simple</samp>’</dt>
<dd><p>Fast, font-agnostic shaper that can do only substitutions
</p></dd>
<dt>‘<samp class="samp">complex</samp>’</dt>
<dd><p>Slower shaper using OpenType for substitutions and positioning
</p></dd>
</dl>
<p>The default is <code class="code">auto</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="atadenoise">
<h3 class="section">30.6 atadenoise</h3>
<p>Apply an Adaptive Temporal Averaging Denoiser to the video input.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">0a</samp></dt>
<dd><p>Set threshold A for 1st plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp class="option">0b</samp></dt>
<dd><p>Set threshold B for 1st plane. Default is 0.04.
Valid range is 0 to 5.
</p>
</dd>
<dt><samp class="option">1a</samp></dt>
<dd><p>Set threshold A for 2nd plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp class="option">1b</samp></dt>
<dd><p>Set threshold B for 2nd plane. Default is 0.04.
Valid range is 0 to 5.
</p>
</dd>
<dt><samp class="option">2a</samp></dt>
<dd><p>Set threshold A for 3rd plane. Default is 0.02.
Valid range is 0 to 0.3.
</p>
</dd>
<dt><samp class="option">2b</samp></dt>
<dd><p>Set threshold B for 3rd plane. Default is 0.04.
Valid range is 0 to 5.
</p>
<p>Threshold A is designed to react on abrupt changes in the input signal and
threshold B is designed to react on continuous changes in the input signal.
</p>
</dd>
<dt><samp class="option">s</samp></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><samp class="option">p</samp></dt>
<dd><p>Set what planes of frame filter will use for averaging. Default is all.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>Set what variant of algorithm filter will use for averaging. Default is <code class="code">p</code> parallel.
Alternatively can be set to <code class="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><samp class="option">0s</samp></dt>
<dt><samp class="option">1s</samp></dt>
<dt><samp class="option">2s</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-55" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-55">
<h4 class="subsection">30.6.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options except option <code class="code">s</code>.
The command accepts the same syntax of the corresponding option.
</p>
</div>
</div>
<div class="section-level-extent" id="avgblur">
<h3 class="section">30.7 avgblur</h3>
<p>Apply average blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sizeX</samp></dt>
<dd><p>Set horizontal radius size.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p>
</dd>
<dt><samp class="option">sizeY</samp></dt>
<dd><p>Set vertical radius size, if zero it will be same as <code class="code">sizeX</code>.
Default is <code class="code">0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-56" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-56">
<h4 class="subsection">30.7.1 Commands</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>
</div>
</div>
<div class="section-level-extent" id="backgroundkey">
<h3 class="section">30.8 backgroundkey</h3>
<p>Turns a static background into transparency.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">threshold</samp></dt>
<dd><p>Threshold for scene change detection.
</p></dd>
<dt><samp class="option">similarity</samp></dt>
<dd><p>Similarity percentage with the background.
</p></dd>
<dt><samp class="option">blend</samp></dt>
<dd><p>Set the blend amount for pixels that are not similar.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-57" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-57">
<h4 class="subsection">30.8.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="bbox">
<h3 class="section">30.9 bbox</h3>
<p>Compute the bounding box for the non-black pixels in the input frame
luma plane.
</p>
<p>This filter computes the bounding box containing all the pixels with a
luma 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 class="table">
<dt><samp class="option">min_val</samp></dt>
<dd><p>Set the minimal luma value. Default is <code class="code">16</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-58" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-58">
<h4 class="subsection">30.9.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="bilateral">
<h3 class="section">30.10 bilateral</h3>
<p>Apply bilateral filter, spatial smoothing while preserving edges.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">sigmaS</samp></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><samp class="option">sigmaR</samp></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><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is first only.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-59" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-59">
<h4 class="subsection">30.10.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="bilateral_005fcuda">
<h3 class="section">30.11 bilateral_cuda</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 class="table">
<dt><samp class="option">sigmaS</samp></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><samp class="option">sigmaR</samp></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><samp class="option">window_size</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-60" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-60">
<h4 class="subsection">30.11.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply the bilateral filter on a video.
<div class="example">
<pre class="example-preformatted">./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>
</div>
</div>
<div class="section-level-extent" id="bitplanenoise">
<h3 class="section">30.12 bitplanenoise</h3>
<p>Show and measure bit plane noise.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">bitplane</samp></dt>
<dd><p>Set which plane to analyze. Default is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">filter</samp></dt>
<dd><p>Filter out noisy pixels from <code class="code">bitplane</code> set above.
Default is disabled.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="blackdetect">
<h3 class="section">30.13 blackdetect</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 class="code">info</code>. In addition,
a log line with level <code class="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 class="code">lavfi.black_start</code> and to the first frame
after the black segment ends with key <code class="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 class="table">
<dt><samp class="option">black_min_duration, d</samp></dt>
<dd><p>Set the minimum detected black duration expressed in seconds. It must
be a non-negative floating point number.
</p>
<p>Default value is 2.0.
</p>
</dd>
<dt><samp class="option">picture_black_ratio_th, pic_th</samp></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-preformatted"><var class="var">nb_black_pixels</var> / <var class="var">nb_pixels</var>
</pre></div>
<p>for which a picture is considered black.
Default value is 0.98.
</p>
</dd>
<dt><samp class="option">pixel_black_th, pix_th</samp></dt>
<dd><p>Set the threshold for considering a pixel "black".
</p>
<p>The threshold expresses the maximum pixel luma 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-preformatted"><var class="var">absolute_threshold</var> = <var class="var">luma_minimum_value</var> + <var class="var">pixel_black_th</var> * <var class="var">luma_range_size</var>
</pre></div>
<p><var class="var">luma_range_size</var> and <var class="var">luma_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-preformatted">blackdetect=d=2:pix_th=0.00
</pre></div>
</div>
<div class="section-level-extent" id="blackframe">
<h3 class="section">30.14 blackframe</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 class="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 class="table">
<dt><samp class="option">amount</samp></dt>
<dd><p>The percentage of the pixels that have to be below the threshold; it defaults to
<code class="code">98</code>.
</p>
</dd>
<dt><samp class="option">threshold, thresh</samp></dt>
<dd><p>The threshold below which a pixel value is considered black; it defaults to
<code class="code">32</code>.
</p>
</dd>
</dl>
<a class="anchor" id="blend"></a></div>
<div class="section-level-extent" id="blend-1">
<h3 class="section">30.15 blend</h3>
<p>Blend two video frames into each other.
</p>
<p>The <code class="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 class="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 class="table">
<dt><samp class="option">c0_mode</samp></dt>
<dt><samp class="option">c1_mode</samp></dt>
<dt><samp class="option">c2_mode</samp></dt>
<dt><samp class="option">c3_mode</samp></dt>
<dt><samp class="option">all_mode</samp></dt>
<dd><p>Set blend mode for specific pixel component or all pixel components in case
of <var class="var">all_mode</var>. Default value is <code class="code">normal</code>.
</p>
<p>Available values for component modes are:
</p><dl class="table">
<dt>‘<samp class="samp">addition</samp>’</dt>
<dt>‘<samp class="samp">and</samp>’</dt>
<dt>‘<samp class="samp">average</samp>’</dt>
<dt>‘<samp class="samp">bleach</samp>’</dt>
<dt>‘<samp class="samp">burn</samp>’</dt>
<dt>‘<samp class="samp">darken</samp>’</dt>
<dt>‘<samp class="samp">difference</samp>’</dt>
<dt>‘<samp class="samp">divide</samp>’</dt>
<dt>‘<samp class="samp">dodge</samp>’</dt>
<dt>‘<samp class="samp">exclusion</samp>’</dt>
<dt>‘<samp class="samp">extremity</samp>’</dt>
<dt>‘<samp class="samp">freeze</samp>’</dt>
<dt>‘<samp class="samp">geometric</samp>’</dt>
<dt>‘<samp class="samp">glow</samp>’</dt>
<dt>‘<samp class="samp">grainextract</samp>’</dt>
<dt>‘<samp class="samp">grainmerge</samp>’</dt>
<dt>‘<samp class="samp">hardlight</samp>’</dt>
<dt>‘<samp class="samp">hardmix</samp>’</dt>
<dt>‘<samp class="samp">hardoverlay</samp>’</dt>
<dt>‘<samp class="samp">harmonic</samp>’</dt>
<dt>‘<samp class="samp">heat</samp>’</dt>
<dt>‘<samp class="samp">interpolate</samp>’</dt>
<dt>‘<samp class="samp">lighten</samp>’</dt>
<dt>‘<samp class="samp">linearlight</samp>’</dt>
<dt>‘<samp class="samp">multiply</samp>’</dt>
<dt>‘<samp class="samp">multiply128</samp>’</dt>
<dt>‘<samp class="samp">negation</samp>’</dt>
<dt>‘<samp class="samp">normal</samp>’</dt>
<dt>‘<samp class="samp">or</samp>’</dt>
<dt>‘<samp class="samp">overlay</samp>’</dt>
<dt>‘<samp class="samp">phoenix</samp>’</dt>
<dt>‘<samp class="samp">pinlight</samp>’</dt>
<dt>‘<samp class="samp">reflect</samp>’</dt>
<dt>‘<samp class="samp">screen</samp>’</dt>
<dt>‘<samp class="samp">softdifference</samp>’</dt>
<dt>‘<samp class="samp">softlight</samp>’</dt>
<dt>‘<samp class="samp">stain</samp>’</dt>
<dt>‘<samp class="samp">subtract</samp>’</dt>
<dt>‘<samp class="samp">vividlight</samp>’</dt>
<dt>‘<samp class="samp">xor</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">c0_opacity</samp></dt>
<dt><samp class="option">c1_opacity</samp></dt>
<dt><samp class="option">c2_opacity</samp></dt>
<dt><samp class="option">c3_opacity</samp></dt>
<dt><samp class="option">all_opacity</samp></dt>
<dd><p>Set blend opacity for specific pixel component or all pixel components in case
of <var class="var">all_opacity</var>. Only used in combination with pixel component blend modes.
</p>
</dd>
<dt><samp class="option">c0_expr</samp></dt>
<dt><samp class="option">c1_expr</samp></dt>
<dt><samp class="option">c2_expr</samp></dt>
<dt><samp class="option">c3_expr</samp></dt>
<dt><samp class="option">all_expr</samp></dt>
<dd><p>Set blend expression for specific pixel component or all pixel components in case
of <var class="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 class="table">
<dt><samp class="option">N</samp></dt>
<dd><p>The sequential number of the filtered frame, starting from <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">X</samp></dt>
<dt><samp class="option">Y</samp></dt>
<dd><p>the coordinates of the current sample
</p>
</dd>
<dt><samp class="option">W</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>the width and height of currently filtered plane
</p>
</dd>
<dt><samp class="option">SW</samp></dt>
<dt><samp class="option">SH</samp></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 class="code">yuv420p</code> frame, the values are <code class="code">1,1</code> for
the luma plane and <code class="code">0.5,0.5</code> for the chroma planes.
</p>
</dd>
<dt><samp class="option">T</samp></dt>
<dd><p>Time of the current frame, expressed in seconds.
</p>
</dd>
<dt><samp class="option">TOP, A</samp></dt>
<dd><p>Value of pixel component at current location for first video frame (top layer).
</p>
</dd>
<dt><samp class="option">BOTTOM, B</samp></dt>
<dd><p>Value of pixel component at current location for second video frame (bottom layer).
</p></dd>
</dl>
</dd>
</dl>
<p>The <code class="code">blend</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<ul class="mini-toc">
<li><a href="#Examples-61" accesskey="1">Examples</a></li>
<li><a href="#Commands-60" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-61">
<h4 class="subsection">30.15.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply transition from bottom layer to top layer in first 10 seconds:
<div class="example">
<pre class="example-preformatted">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-preformatted">blend=all_expr='A*(X/W)+B*(1-X/W)'
</pre></div>
</li><li>Apply 1x1 checkerboard effect:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">tblend=all_mode=grainextract
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-60">
<h4 class="subsection">30.15.2 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
<a class="anchor" id="blockdetect"></a></div>
</div>
<div class="section-level-extent" id="blockdetect-1">
<h3 class="section">30.16 blockdetect</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 class="table">
<dt><samp class="option">period_min</samp></dt>
<dt><samp class="option">period_max</samp></dt>
<dd><p>Set minimum and maximum values for determining pixel grids (periods).
Default values are [3,24].
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is first only.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-62" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-62">
<h4 class="subsection">30.16.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Determine blockiness for the first plane and search for periods within [8,32]:
<div class="example">
<pre class="example-preformatted">blockdetect=period_min=8:period_max=32:planes=1
</pre></div>
</li></ul>
<a class="anchor" id="blurdetect"></a></div>
</div>
<div class="section-level-extent" id="blurdetect-1">
<h3 class="section">30.17 blurdetect</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 class="table">
<dt><samp class="option">low</samp></dt>
<dt><samp class="option">high</samp></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 class="var">low</var> and <var class="var">high</var> threshold values must be chosen in the range
[0,1], and <var class="var">low</var> should be lesser or equal to <var class="var">high</var>.
</p>
<p>Default value for <var class="var">low</var> is <code class="code">20/255</code>, and default value for <var class="var">high</var>
is <code class="code">50/255</code>.
</p>
</dd>
<dt><samp class="option">radius</samp></dt>
<dd><p>Define the radius to search around an edge pixel for local maxima.
</p>
</dd>
<dt><samp class="option">block_pct</samp></dt>
<dd><p>Determine blurriness only for the most significant blocks, given in percentage.
</p>
</dd>
<dt><samp class="option">block_width</samp></dt>
<dd><p>Determine blurriness for blocks of width <var class="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 class="var">block_height</var>.
</p>
</dd>
<dt><samp class="option">block_height</samp></dt>
<dd><p>Determine blurriness for blocks of height <var class="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 class="var">block_width</var>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is first only.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-63" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-63">
<h4 class="subsection">30.17.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Determine blur for 80% of most significant 32x32 blocks:
<div class="example">
<pre class="example-preformatted">blurdetect=block_width=32:block_height=32:block_pct=80
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="bm3d">
<h3 class="section">30.18 bm3d</h3>
<p>Denoise frames using Block-Matching 3D algorithm.
</p>
<p>The filter accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">sigma</samp></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><samp class="option">block</samp></dt>
<dd><p>Set local patch size. This sets dimensions in 2D.
</p>
</dd>
<dt><samp class="option">bstep</samp></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><samp class="option">group</samp></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><samp class="option">range</samp></dt>
<dd><p>Set radius for search block matching. Default is 9.
Allowed range is from 1 to INT32_MAX.
</p>
</dd>
<dt><samp class="option">mstep</samp></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><samp class="option">thmse</samp></dt>
<dd><p>Set threshold of mean square error for block matching. Valid range is 0 to
INT32_MAX.
</p>
</dd>
<dt><samp class="option">hdthr</samp></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><samp class="option">estim</samp></dt>
<dd><p>Set filtering estimation mode. Can be <code class="code">basic</code> or <code class="code">final</code>.
Default is <code class="code">basic</code>.
</p>
</dd>
<dt><samp class="option">ref</samp></dt>
<dd><p>If enabled, filter will use 2nd stream for block matching.
Default is disabled for <code class="code">basic</code> value of <var class="var">estim</var> option,
and always enabled if value of <var class="var">estim</var> is <code class="code">final</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is all available except alpha.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-64" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-64">
<h4 class="subsection">30.18.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Basic filtering with bm3d:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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 class="ref" href="#nlmeans">nlmeans</a> filter instead:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="boxblur">
<h3 class="section">30.19 boxblur</h3>
<p>Apply a boxblur algorithm to the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dt><samp class="option">luma_power, lp</samp></dt>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dt><samp class="option">chroma_power, cp</samp></dt>
<dt><samp class="option">alpha_radius, ar</samp></dt>
<dt><samp class="option">alpha_power, ap</samp></dt>
</dl>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dt><samp class="option">alpha_radius, ar</samp></dt>
<dd><p>Set an expression for the box radius in pixels used for blurring the
corresponding input plane.
</p>
<p>The radius value must be a non-negative number, and must not be
greater than the value of the expression <code class="code">min(w,h)/2</code> for the
luma and alpha planes, and of <code class="code">min(cw,ch)/2</code> for the chroma
planes.
</p>
<p>Default value for <samp class="option">luma_radius</samp> is "2". If not specified,
<samp class="option">chroma_radius</samp> and <samp class="option">alpha_radius</samp> default to the
corresponding value set for <samp class="option">luma_radius</samp>.
</p>
<p>The expressions can contain the following constants:
</p><dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height in pixels.
</p>
</dd>
<dt><samp class="option">cw</samp></dt>
<dt><samp class="option">ch</samp></dt>
<dd><p>The input chroma image width and height in pixels.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>The horizontal and vertical chroma subsample values. For example, for the
pixel format "yuv422p", <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p></dd>
</dl>
</dd>
<dt><samp class="option">luma_power, lp</samp></dt>
<dt><samp class="option">chroma_power, cp</samp></dt>
<dt><samp class="option">alpha_power, ap</samp></dt>
<dd><p>Specify how many times the boxblur filter is applied to the
corresponding plane.
</p>
<p>Default value for <samp class="option">luma_power</samp> is 2. If not specified,
<samp class="option">chroma_power</samp> and <samp class="option">alpha_power</samp> default to the
corresponding value set for <samp class="option">luma_power</samp>.
</p>
<p>A value of 0 will disable the effect.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-65" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-65">
<h4 class="subsection">30.19.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply a boxblur filter with the luma, chroma, and alpha radii
set to 2:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
</pre></div>
</li></ul>
<a class="anchor" id="bwdif"></a></div>
</div>
<div class="section-level-extent" id="bwdif-1">
<h3 class="section">30.20 bwdif</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code class="code">send_field</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="bwdif_005fcuda">
<h3 class="section">30.21 bwdif_cuda</h3>
<p>Deinterlace the input video using the <a class="ref" href="#bwdif">bwdif</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code class="code">send_field</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="ccrepack">
<h3 class="section">30.22 ccrepack</h3>
<p>Repack CEA-708 closed captioning side data
</p>
<p>This filter fixes various issues seen with commerical encoders
related to upstream malformed CEA-708 payloads, specifically
incorrect number of tuples (wrong cc_count for the target FPS),
and incorrect ordering of tuples (i.e. the CEA-608 tuples are not at
the first entries in the payload).
</p>
</div>
<div class="section-level-extent" id="cas">
<h3 class="section">30.23 cas</h3>
<p>Apply Contrast Adaptive Sharpen filter to video stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">strength</samp></dt>
<dd><p>Set the sharpening strength. Default value is 0.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default value is to filter all
planes except alpha plane.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-61" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-61">
<h4 class="subsection">30.23.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="chromahold">
<h3 class="section">30.24 chromahold</h3>
<p>Remove all color information for all colors except for certain one.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color which will not be replaced with neutral chroma.
</p>
</dd>
<dt><samp class="option">similarity</samp></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><samp class="option">blend</samp></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><samp class="option">yuv</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-62" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-62">
<h4 class="subsection">30.24.1 Commands</h4>
<p>This filter supports same <a class="ref" 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 class="anchor" id="chromakey"></a></div>
</div>
<div class="section-level-extent" id="chromakey-1">
<h3 class="section">30.25 chromakey</h3>
<p>YUV colorspace color/chroma keying.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color which will be replaced with transparency.
</p>
</dd>
<dt><samp class="option">similarity</samp></dt>
<dd><p>Similarity percentage with the key color.
</p>
<p>0.01 matches only the exact key color, while 1.0 matches everything.
</p>
</dd>
<dt><samp class="option">blend</samp></dt>
<dd><p>Blend percentage.
</p>
<p>0.0 makes pixels either fully transparent, or not transparent at all.
</p>
<p>Higher values result in semi-transparent pixels, with a higher transparency
the more similar the pixels color is to the key color.
</p>
</dd>
<dt><samp class="option">yuv</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-63" accesskey="1">Commands</a></li>
<li><a href="#Examples-66" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-63">
<h4 class="subsection">30.25.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
<div class="subsection-level-extent" id="Examples-66">
<h4 class="subsection">30.25.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make every green pixel in the input image transparent:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="chromakey_005fcuda">
<h3 class="section">30.26 chromakey_cuda</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 class="ref" href="#chromakey">chromakey</a>.
</p>
<ul class="mini-toc">
<li><a href="#Examples-67" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-67">
<h4 class="subsection">30.26.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">./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-preformatted">./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>
</div>
</div>
<div class="section-level-extent" id="chromanr">
<h3 class="section">30.27 chromanr</h3>
<p>Reduce chrominance noise.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">thres</samp></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><samp class="option">sizew</samp></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><samp class="option">sizeh</samp></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><samp class="option">stepw</samp></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><samp class="option">steph</samp></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><samp class="option">threy</samp></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><samp class="option">threu</samp></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><samp class="option">threv</samp></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><samp class="option">distance</samp></dt>
<dd><p>Set distance type used in calculations.
</p>
<dl class="table">
<dt>‘<samp class="samp">manhattan</samp>’</dt>
<dd><p>Absolute difference.
</p></dd>
<dt>‘<samp class="samp">euclidean</samp>’</dt>
<dd><p>Difference squared.
</p></dd>
</dl>
<p>Default distance type is manhattan.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-64" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-64">
<h4 class="subsection">30.27.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
The command accepts the same syntax of the corresponding option.
</p>
</div>
</div>
<div class="section-level-extent" id="chromashift">
<h3 class="section">30.28 chromashift</h3>
<p>Shift chroma pixels horizontally and/or vertically.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">cbh</samp></dt>
<dd><p>Set amount to shift chroma-blue horizontally.
</p></dd>
<dt><samp class="option">cbv</samp></dt>
<dd><p>Set amount to shift chroma-blue vertically.
</p></dd>
<dt><samp class="option">crh</samp></dt>
<dd><p>Set amount to shift chroma-red horizontally.
</p></dd>
<dt><samp class="option">crv</samp></dt>
<dd><p>Set amount to shift chroma-red vertically.
</p></dd>
<dt><samp class="option">edge</samp></dt>
<dd><p>Set edge mode, can be <var class="var">smear</var>, default, or <var class="var">warp</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-65" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-65">
<h4 class="subsection">30.28.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="ciescope">
<h3 class="section">30.29 ciescope</h3>
<p>Display CIE color diagram with pixels overlaid onto it.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">system</samp></dt>
<dd><p>Set color system.
</p>
<dl class="table">
<dt>‘<samp class="samp">ntsc, 470m</samp>’</dt>
<dt>‘<samp class="samp">ebu, 470bg</samp>’</dt>
<dt>‘<samp class="samp">smpte</samp>’</dt>
<dt>‘<samp class="samp">240m</samp>’</dt>
<dt>‘<samp class="samp">apple</samp>’</dt>
<dt>‘<samp class="samp">widergb</samp>’</dt>
<dt>‘<samp class="samp">cie1931</samp>’</dt>
<dt>‘<samp class="samp">rec709, hdtv</samp>’</dt>
<dt>‘<samp class="samp">uhdtv, rec2020</samp>’</dt>
<dt>‘<samp class="samp">dcip3</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">cie</samp></dt>
<dd><p>Set CIE system.
</p>
<dl class="table">
<dt>‘<samp class="samp">xyy</samp>’</dt>
<dt>‘<samp class="samp">ucs</samp>’</dt>
<dt>‘<samp class="samp">luv</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">gamuts</samp></dt>
<dd><p>Set what gamuts to draw.
</p>
<p>See <code class="code">system</code> option for available values.
</p>
</dd>
<dt><samp class="option">size, s</samp></dt>
<dd><p>Set ciescope size, by default set to 512.
</p>
</dd>
<dt><samp class="option">intensity, i</samp></dt>
<dd><p>Set intensity used to map input pixel values to CIE diagram.
</p>
</dd>
<dt><samp class="option">contrast</samp></dt>
<dd><p>Set contrast used to draw tongue colors that are out of active color system gamut.
</p>
</dd>
<dt><samp class="option">corrgamma</samp></dt>
<dd><p>Correct gamma displayed on scope, by default enabled.
</p>
</dd>
<dt><samp class="option">showwhite</samp></dt>
<dd><p>Show white point on CIE diagram, by default disabled.
</p>
</dd>
<dt><samp class="option">gamma</samp></dt>
<dd><p>Set input gamma. Used only with XYZ input color space.
</p>
</dd>
<dt><samp class="option">fill</samp></dt>
<dd><p>Fill with CIE colors. By default is enabled.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="codecview">
<h3 class="section">30.30 codecview</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 class="var">export_mvs</var> flag in the codec <samp class="option">flags2</samp> option.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">block</samp></dt>
<dd><p>Display block partition structure using the luma plane.
</p>
</dd>
<dt><samp class="option">mv</samp></dt>
<dd><p>Set motion vectors to visualize.
</p>
<p>Available flags for <var class="var">mv</var> are:
</p>
<dl class="table">
<dt>‘<samp class="samp">pf</samp>’</dt>
<dd><p>forward predicted MVs of P-frames
</p></dd>
<dt>‘<samp class="samp">bf</samp>’</dt>
<dd><p>forward predicted MVs of B-frames
</p></dd>
<dt>‘<samp class="samp">bb</samp>’</dt>
<dd><p>backward predicted MVs of B-frames
</p></dd>
</dl>
</dd>
<dt><samp class="option">qp</samp></dt>
<dd><p>Display quantization parameters using the chroma planes.
</p>
</dd>
<dt><samp class="option">mv_type, mvt</samp></dt>
<dd><p>Set motion vectors type to visualize. Includes MVs from all frames unless specified by <var class="var">frame_type</var> option.
</p>
<p>Available flags for <var class="var">mv_type</var> are:
</p>
<dl class="table">
<dt>‘<samp class="samp">fp</samp>’</dt>
<dd><p>forward predicted MVs
</p></dd>
<dt>‘<samp class="samp">bp</samp>’</dt>
<dd><p>backward predicted MVs
</p></dd>
</dl>
</dd>
<dt><samp class="option">frame_type, ft</samp></dt>
<dd><p>Set frame type to visualize motion vectors of.
</p>
<p>Available flags for <var class="var">frame_type</var> are:
</p>
<dl class="table">
<dt>‘<samp class="samp">if</samp>’</dt>
<dd><p>intra-coded frames (I-frames)
</p></dd>
<dt>‘<samp class="samp">pf</samp>’</dt>
<dd><p>predicted frames (P-frames)
</p></dd>
<dt>‘<samp class="samp">bf</samp>’</dt>
<dd><p>bi-directionally predicted frames (B-frames)
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-68" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-68">
<h4 class="subsection">30.30.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Visualize forward predicted MVs of all frames using <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">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 class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="colorbalance">
<h3 class="section">30.31 colorbalance</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 class="table">
<dt><samp class="option">rs</samp></dt>
<dt><samp class="option">gs</samp></dt>
<dt><samp class="option">bs</samp></dt>
<dd><p>Adjust red, green and blue shadows (darkest pixels).
</p>
</dd>
<dt><samp class="option">rm</samp></dt>
<dt><samp class="option">gm</samp></dt>
<dt><samp class="option">bm</samp></dt>
<dd><p>Adjust red, green and blue midtones (medium pixels).
</p>
</dd>
<dt><samp class="option">rh</samp></dt>
<dt><samp class="option">gh</samp></dt>
<dt><samp class="option">bh</samp></dt>
<dd><p>Adjust red, green and blue highlights (brightest pixels).
</p>
<p>Allowed ranges for options are <code class="code">[-1.0, 1.0]</code>. Defaults are <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">pl</samp></dt>
<dd><p>Preserve lightness when changing color balance. Default is disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-69" accesskey="1">Examples</a></li>
<li><a href="#Commands-66" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-69">
<h4 class="subsection">30.31.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Add red color cast to shadows:
<div class="example">
<pre class="example-preformatted">colorbalance=rs=.3
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-66">
<h4 class="subsection">30.31.2 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colorcontrast">
<h3 class="section">30.32 colorcontrast</h3>
<p>Adjust color contrast between RGB components.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rc</samp></dt>
<dd><p>Set the red-cyan contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0.
</p>
</dd>
<dt><samp class="option">gm</samp></dt>
<dd><p>Set the green-magenta contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0.
</p>
</dd>
<dt><samp class="option">by</samp></dt>
<dd><p>Set the blue-yellow contrast. Defaults is 0.0. Allowed range is from -1.0 to 1.0.
</p>
</dd>
<dt><samp class="option">rcw</samp></dt>
<dt><samp class="option">gmw</samp></dt>
<dt><samp class="option">byw</samp></dt>
<dd><p>Set the weight of each <code class="code">rc</code>, <code class="code">gm</code>, <code class="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><samp class="option">pl</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-67" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-67">
<h4 class="subsection">30.32.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colorcorrect">
<h3 class="section">30.33 colorcorrect</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 class="table">
<dt><samp class="option">rl</samp></dt>
<dd><p>Set the red shadow spot. Allowed range is from -1.0 to 1.0.
Default value is 0.
</p>
</dd>
<dt><samp class="option">bl</samp></dt>
<dd><p>Set the blue shadow spot. Allowed range is from -1.0 to 1.0.
Default value is 0.
</p>
</dd>
<dt><samp class="option">rh</samp></dt>
<dd><p>Set the red highlight spot. Allowed range is from -1.0 to 1.0.
Default value is 0.
</p>
</dd>
<dt><samp class="option">bh</samp></dt>
<dd><p>Set the blue highlight spot. Allowed range is from -1.0 to 1.0.
Default value is 0.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set the amount of saturation. Allowed range is from -3.0 to 3.0.
Default value is 1.
</p>
</dd>
<dt><samp class="option">analyze</samp></dt>
<dd><p>If set to anything other than <code class="code">manual</code> it will analyze every frame and use derived
parameters for filtering output frame.
</p>
<p>Possible values are:
</p><dl class="table">
<dt>‘<samp class="samp">manual</samp>’</dt>
<dt>‘<samp class="samp">average</samp>’</dt>
<dt>‘<samp class="samp">minmax</samp>’</dt>
<dt>‘<samp class="samp">median</samp>’</dt>
</dl>
<p>Default value is <code class="code">manual</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-68" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-68">
<h4 class="subsection">30.33.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colorchannelmixer">
<h3 class="section">30.34 colorchannelmixer</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-preformatted"><var class="var">red</var>=<var class="var">red</var>*<var class="var">rr</var> + <var class="var">blue</var>*<var class="var">rb</var> + <var class="var">green</var>*<var class="var">rg</var> + <var class="var">alpha</var>*<var class="var">ra</var>
</pre></div>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rr</samp></dt>
<dt><samp class="option">rg</samp></dt>
<dt><samp class="option">rb</samp></dt>
<dt><samp class="option">ra</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output red channel.
Default is <code class="code">1</code> for <var class="var">rr</var>, and <code class="code">0</code> for <var class="var">rg</var>, <var class="var">rb</var> and <var class="var">ra</var>.
</p>
</dd>
<dt><samp class="option">gr</samp></dt>
<dt><samp class="option">gg</samp></dt>
<dt><samp class="option">gb</samp></dt>
<dt><samp class="option">ga</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output green channel.
Default is <code class="code">1</code> for <var class="var">gg</var>, and <code class="code">0</code> for <var class="var">gr</var>, <var class="var">gb</var> and <var class="var">ga</var>.
</p>
</dd>
<dt><samp class="option">br</samp></dt>
<dt><samp class="option">bg</samp></dt>
<dt><samp class="option">bb</samp></dt>
<dt><samp class="option">ba</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output blue channel.
Default is <code class="code">1</code> for <var class="var">bb</var>, and <code class="code">0</code> for <var class="var">br</var>, <var class="var">bg</var> and <var class="var">ba</var>.
</p>
</dd>
<dt><samp class="option">ar</samp></dt>
<dt><samp class="option">ag</samp></dt>
<dt><samp class="option">ab</samp></dt>
<dt><samp class="option">aa</samp></dt>
<dd><p>Adjust contribution of input red, green, blue and alpha channels for output alpha channel.
Default is <code class="code">1</code> for <var class="var">aa</var>, and <code class="code">0</code> for <var class="var">ar</var>, <var class="var">ag</var> and <var class="var">ab</var>.
</p>
<p>Allowed ranges for options are <code class="code">[-2.0, 2.0]</code>.
</p>
</dd>
<dt><samp class="option">pc</samp></dt>
<dd><p>Set preserve color mode. The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disable color preserving, this is default.
</p></dd>
<dt>‘<samp class="samp">lum</samp>’</dt>
<dd><p>Preserve luminance.
</p></dd>
<dt>‘<samp class="samp">max</samp>’</dt>
<dd><p>Preserve max value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">avg</samp>’</dt>
<dd><p>Preserve average value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">sum</samp>’</dt>
<dd><p>Preserve sum value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">nrm</samp>’</dt>
<dd><p>Preserve normalized value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">pwr</samp>’</dt>
<dd><p>Preserve power value of RGB triplet.
</p></dd>
</dl>
</dd>
<dt><samp class="option">pa</samp></dt>
<dd><p>Set the preserve color amount when changing colors. Allowed range is from <code class="code">[0.0, 1.0]</code>.
Default is <code class="code">0.0</code>, thus disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-70" accesskey="1">Examples</a></li>
<li><a href="#Commands-69" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-70">
<h4 class="subsection">30.34.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Convert source to grayscale:
<div class="example">
<pre class="example-preformatted">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-preformatted">colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-69">
<h4 class="subsection">30.34.2 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colorize">
<h3 class="section">30.35 colorize</h3>
<p>Overlay a solid color on the video stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">hue</samp></dt>
<dd><p>Set the color hue. Allowed range is from 0 to 360.
Default value is 0.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set the color saturation. Allowed range is from 0 to 1.
Default value is 0.5.
</p>
</dd>
<dt><samp class="option">lightness</samp></dt>
<dd><p>Set the color lightness. Allowed range is from 0 to 1.
Default value is 0.5.
</p>
</dd>
<dt><samp class="option">mix</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-70" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-70">
<h4 class="subsection">30.35.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colorkey">
<h3 class="section">30.36 colorkey</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 class="table">
<dt><samp class="option">color</samp></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 class="code">black</code>.
</p>
</dd>
<dt><samp class="option">similarity</samp></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 class="code">0.01</code>.
</p>
</dd>
<dt><samp class="option">blend</samp></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 class="code">0.0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-71" accesskey="1">Examples</a></li>
<li><a href="#Commands-71" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-71">
<h4 class="subsection">30.36.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make every green pixel in the input image transparent:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-71">
<h4 class="subsection">30.36.2 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="colorhold">
<h3 class="section">30.37 colorhold</h3>
<p>Remove all color information for all RGB colors except for certain one.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color which will not be replaced with neutral gray.
</p>
</dd>
<dt><samp class="option">similarity</samp></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><samp class="option">blend</samp></dt>
<dd><p>Blend percentage. 0.0 makes pixels fully gray.
Higher values result in more preserved color.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-72" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-72">
<h4 class="subsection">30.37.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="colorlevels">
<h3 class="section">30.38 colorlevels</h3>
<p>Adjust video input frames using levels.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rimin</samp></dt>
<dt><samp class="option">gimin</samp></dt>
<dt><samp class="option">bimin</samp></dt>
<dt><samp class="option">aimin</samp></dt>
<dd><p>Adjust red, green, blue and alpha input black point.
Allowed ranges for options are <code class="code">[-1.0, 1.0]</code>. Defaults are <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">rimax</samp></dt>
<dt><samp class="option">gimax</samp></dt>
<dt><samp class="option">bimax</samp></dt>
<dt><samp class="option">aimax</samp></dt>
<dd><p>Adjust red, green, blue and alpha input white point.
Allowed ranges for options are <code class="code">[-1.0, 1.0]</code>. Defaults are <code class="code">1</code>.
</p>
<p>Input levels are used to lighten highlights (bright tones), darken shadows
(dark tones), change the balance of bright and dark tones.
</p>
</dd>
<dt><samp class="option">romin</samp></dt>
<dt><samp class="option">gomin</samp></dt>
<dt><samp class="option">bomin</samp></dt>
<dt><samp class="option">aomin</samp></dt>
<dd><p>Adjust red, green, blue and alpha output black point.
Allowed ranges for options are <code class="code">[0, 1.0]</code>. Defaults are <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">romax</samp></dt>
<dt><samp class="option">gomax</samp></dt>
<dt><samp class="option">bomax</samp></dt>
<dt><samp class="option">aomax</samp></dt>
<dd><p>Adjust red, green, blue and alpha output white point.
Allowed ranges for options are <code class="code">[0, 1.0]</code>. Defaults are <code class="code">1</code>.
</p>
<p>Output levels allows manual selection of a constrained output level range.
</p>
</dd>
<dt><samp class="option">preserve</samp></dt>
<dd><p>Set preserve color mode. The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disable color preserving, this is default.
</p></dd>
<dt>‘<samp class="samp">lum</samp>’</dt>
<dd><p>Preserve luminance.
</p></dd>
<dt>‘<samp class="samp">max</samp>’</dt>
<dd><p>Preserve max value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">avg</samp>’</dt>
<dd><p>Preserve average value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">sum</samp>’</dt>
<dd><p>Preserve sum value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">nrm</samp>’</dt>
<dd><p>Preserve normalized value of RGB triplet.
</p></dd>
<dt>‘<samp class="samp">pwr</samp>’</dt>
<dd><p>Preserve power value of RGB triplet.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-72" accesskey="1">Examples</a></li>
<li><a href="#Commands-73" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-72">
<h4 class="subsection">30.38.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make video output darker:
<div class="example">
<pre class="example-preformatted">colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
</pre></div>
</li><li>Increase contrast:
<div class="example">
<pre class="example-preformatted">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-preformatted">colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
</pre></div>
</li><li>Increase brightness:
<div class="example">
<pre class="example-preformatted">colorlevels=romin=0.5:gomin=0.5:bomin=0.5
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-73">
<h4 class="subsection">30.38.2 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="colormap">
<h3 class="section">30.39 colormap</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 class="table">
<dt><samp class="option">patch_size</samp></dt>
<dd><p>Set the source and target video stream patch size in pixels.
</p>
</dd>
<dt><samp class="option">nb_patches</samp></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 class="code">64</code>.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set the adjustments used for target colors. Can be <code class="code">relative</code> or <code class="code">absolute</code>.
Defaults is <code class="code">absolute</code>.
</p>
</dd>
<dt><samp class="option">kernel</samp></dt>
<dd><p>Set the kernel used to measure color differences between mapped colors.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">euclidean</samp>’</dt>
<dt>‘<samp class="samp">weuclidean</samp>’</dt>
</dl>
<p>Default is <code class="code">euclidean</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="colormatrix">
<h3 class="section">30.40 colormatrix</h3>
<p>Convert color matrix.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">src</samp></dt>
<dt><samp class="option">dst</samp></dt>
<dd><p>Specify the source and destination color matrix. Both values must be
specified.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">fcc</samp>’</dt>
<dd><p>FCC
</p>
</dd>
<dt>‘<samp class="samp">bt601</samp>’</dt>
<dd><p>BT.601
</p>
</dd>
<dt>‘<samp class="samp">bt470</samp>’</dt>
<dd><p>BT.470
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">bt2020</samp>’</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-preformatted">colormatrix=bt601:smpte240m
</pre></div>
</div>
<div class="section-level-extent" id="colorspace">
<h3 class="section">30.41 colorspace</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 class="table">
<dd><a class="anchor" id="all"></a></dd>
<dt><samp class="option">all</samp></dt>
<dd><p>Specify all color properties at once.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dd><p>BT.470M
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG
</p>
</dd>
<dt>‘<samp class="samp">bt601-6-525</samp>’</dt>
<dd><p>BT.601-6 525
</p>
</dd>
<dt>‘<samp class="samp">bt601-6-625</samp>’</dt>
<dd><p>BT.601-6 625
</p>
</dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dd><p>BT.2020
</p>
</dd>
</dl>
<a class="anchor" id="space"></a></dd>
<dt><samp class="option">space</samp></dt>
<dd><p>Specify output colorspace.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">fcc</samp>’</dt>
<dd><p>FCC
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG or BT.601-6 625
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M or BT.601-6 525
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">ycgco</samp>’</dt>
<dd><p>YCgCo
</p>
</dd>
<dt>‘<samp class="samp">bt2020ncl</samp>’</dt>
<dd><p>BT.2020 with non-constant luminance
</p>
</dd>
</dl>
<a class="anchor" id="trc"></a></dd>
<dt><samp class="option">trc</samp></dt>
<dd><p>Specify output transfer characteristics.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dd><p>BT.470M
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG
</p>
</dd>
<dt>‘<samp class="samp">gamma22</samp>’</dt>
<dd><p>Constant gamma of 2.2
</p>
</dd>
<dt>‘<samp class="samp">gamma28</samp>’</dt>
<dd><p>Constant gamma of 2.8
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M, BT.601-6 625 or BT.601-6 525
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">srgb</samp>’</dt>
<dd><p>SRGB
</p>
</dd>
<dt>‘<samp class="samp">iec61966-2-1</samp>’</dt>
<dd><p>iec61966-2-1
</p>
</dd>
<dt>‘<samp class="samp">iec61966-2-4</samp>’</dt>
<dd><p>iec61966-2-4
</p>
</dd>
<dt>‘<samp class="samp">xvycc</samp>’</dt>
<dd><p>xvycc
</p>
</dd>
<dt>‘<samp class="samp">bt2020-10</samp>’</dt>
<dd><p>BT.2020 for 10-bits content
</p>
</dd>
<dt>‘<samp class="samp">bt2020-12</samp>’</dt>
<dd><p>BT.2020 for 12-bits content
</p>
</dd>
</dl>
<a class="anchor" id="primaries"></a></dd>
<dt><samp class="option">primaries</samp></dt>
<dd><p>Specify output color primaries.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dd><p>BT.470M
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG or BT.601-6 625
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M or BT.601-6 525
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">film</samp>’</dt>
<dd><p>film
</p>
</dd>
<dt>‘<samp class="samp">smpte431</samp>’</dt>
<dd><p>SMPTE-431
</p>
</dd>
<dt>‘<samp class="samp">smpte432</samp>’</dt>
<dd><p>SMPTE-432
</p>
</dd>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dd><p>BT.2020
</p>
</dd>
<dt>‘<samp class="samp">jedec-p22</samp>’</dt>
<dd><p>JEDEC P22 phosphors
</p>
</dd>
</dl>
<a class="anchor" id="range"></a></dd>
<dt><samp class="option">range</samp></dt>
<dd><p>Specify output color range.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">tv</samp>’</dt>
<dd><p>TV (restricted) range
</p>
</dd>
<dt>‘<samp class="samp">mpeg</samp>’</dt>
<dd><p>MPEG (restricted) range
</p>
</dd>
<dt>‘<samp class="samp">pc</samp>’</dt>
<dd><p>PC (full) range
</p>
</dd>
<dt>‘<samp class="samp">jpeg</samp>’</dt>
<dd><p>JPEG (full) range
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>Specify output color format.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">yuv420p</samp>’</dt>
<dd><p>YUV 4:2:0 planar 8-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv420p10</samp>’</dt>
<dd><p>YUV 4:2:0 planar 10-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv420p12</samp>’</dt>
<dd><p>YUV 4:2:0 planar 12-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv422p</samp>’</dt>
<dd><p>YUV 4:2:2 planar 8-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv422p10</samp>’</dt>
<dd><p>YUV 4:2:2 planar 10-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv422p12</samp>’</dt>
<dd><p>YUV 4:2:2 planar 12-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv444p</samp>’</dt>
<dd><p>YUV 4:4:4 planar 8-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv444p10</samp>’</dt>
<dd><p>YUV 4:4:4 planar 10-bits
</p>
</dd>
<dt>‘<samp class="samp">yuv444p12</samp>’</dt>
<dd><p>YUV 4:4:4 planar 12-bits
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">fast</samp></dt>
<dd><p>Do a fast conversion, which skips gamma/primary correction. This will take
significantly less CPU, but will be mathematically incorrect. To get output
compatible with that produced by the colormatrix filter, use fast=1.
</p>
</dd>
<dt><samp class="option">dither</samp></dt>
<dd><p>Specify dithering mode.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No dithering
</p>
</dd>
<dt>‘<samp class="samp">fsb</samp>’</dt>
<dd><p>Floyd-Steinberg dithering
</p></dd>
</dl>
</dd>
<dt><samp class="option">wpadapt</samp></dt>
<dd><p>Whitepoint adaptation mode.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">bradford</samp>’</dt>
<dd><p>Bradford whitepoint adaptation
</p>
</dd>
<dt>‘<samp class="samp">vonkries</samp>’</dt>
<dd><p>von Kries whitepoint adaptation
</p>
</dd>
<dt>‘<samp class="samp">identity</samp>’</dt>
<dd><p>identity whitepoint adaptation (i.e. no whitepoint adaptation)
</p></dd>
</dl>
</dd>
<dt><samp class="option">iall</samp></dt>
<dd><p>Override all input properties at once. Same accepted values as <a class="ref" href="#all">all</a>.
</p>
</dd>
<dt><samp class="option">ispace</samp></dt>
<dd><p>Override input colorspace. Same accepted values as <a class="ref" href="#space">space</a>.
</p>
</dd>
<dt><samp class="option">iprimaries</samp></dt>
<dd><p>Override input color primaries. Same accepted values as <a class="ref" href="#primaries">primaries</a>.
</p>
</dd>
<dt><samp class="option">itrc</samp></dt>
<dd><p>Override input transfer characteristics. Same accepted values as <a class="ref" href="#trc">trc</a>.
</p>
</dd>
<dt><samp class="option">irange</samp></dt>
<dd><p>Override input color range. Same accepted values as <a class="ref" 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-preformatted">colorspace=smpte240m
</pre></div>
</div>
<div class="section-level-extent" id="colorspace_005fcuda">
<h3 class="section">30.42 colorspace_cuda</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 class="table">
<dt><samp class="option">range</samp></dt>
<dd><p>Specify output color range.
</p>
<p>The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">tv</samp>’</dt>
<dd><p>TV (restricted) range
</p>
</dd>
<dt>‘<samp class="samp">mpeg</samp>’</dt>
<dd><p>MPEG (restricted) range
</p>
</dd>
<dt>‘<samp class="samp">pc</samp>’</dt>
<dd><p>PC (full) range
</p>
</dd>
<dt>‘<samp class="samp">jpeg</samp>’</dt>
<dd><p>JPEG (full) range
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="colortemperature">
<h3 class="section">30.43 colortemperature</h3>
<p>Adjust color temperature in video to simulate variations in ambient color temperature.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">temperature</samp></dt>
<dd><p>Set the temperature in Kelvin. Allowed range is from 1000 to 40000.
Default value is 6500 K.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>Set mixing with filtered output. Allowed range is from 0 to 1.
Default value is 1.
</p>
</dd>
<dt><samp class="option">pl</samp></dt>
<dd><p>Set the amount of preserving lightness. Allowed range is from 0 to 1.
Default value is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-74" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-74">
<h4 class="subsection">30.43.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="convolution">
<h3 class="section">30.44 convolution</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 class="table">
<dt><samp class="option">0m</samp></dt>
<dt><samp class="option">1m</samp></dt>
<dt><samp class="option">2m</samp></dt>
<dt><samp class="option">3m</samp></dt>
<dd><p>Set matrix for each plane.
Matrix is sequence of 9, 25 or 49 signed integers in <var class="var">square</var> mode,
and from 1 to 49 odd number of signed integers in <var class="var">row</var> mode.
</p>
</dd>
<dt><samp class="option">0rdiv</samp></dt>
<dt><samp class="option">1rdiv</samp></dt>
<dt><samp class="option">2rdiv</samp></dt>
<dt><samp class="option">3rdiv</samp></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><samp class="option">0bias</samp></dt>
<dt><samp class="option">1bias</samp></dt>
<dt><samp class="option">2bias</samp></dt>
<dt><samp class="option">3bias</samp></dt>
<dd><p>Set bias for each plane. This value is added to the result of the multiplication.
Useful for making the overall image brighter or darker. Default is 0.0.
</p>
</dd>
<dt><samp class="option">0mode</samp></dt>
<dt><samp class="option">1mode</samp></dt>
<dt><samp class="option">2mode</samp></dt>
<dt><samp class="option">3mode</samp></dt>
<dd><p>Set matrix mode for each plane. Can be <var class="var">square</var>, <var class="var">row</var> or <var class="var">column</var>.
Default is <var class="var">square</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-75" accesskey="1">Commands</a></li>
<li><a href="#Examples-73" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-75">
<h4 class="subsection">30.44.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-73">
<h4 class="subsection">30.44.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply sharpen:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="convolve">
<h3 class="section">30.45 convolve</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process.
</p>
</dd>
<dt><samp class="option">impulse</samp></dt>
<dd><p>Set which impulse video frames will be processed, can be <var class="var">first</var>
or <var class="var">all</var>. Default is <var class="var">all</var>.
</p></dd>
</dl>
<p>The <code class="code">convolve</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
</div>
<div class="section-level-extent" id="copy">
<h3 class="section">30.46 copy</h3>
<p>Copy the input video source unchanged to the output. This is mainly useful for
testing purposes.
</p>
<a class="anchor" id="coreimage"></a></div>
<div class="section-level-extent" id="coreimage-1">
<h3 class="section">30.47 coreimage</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 class="table">
<dt><samp class="option">list_filters</samp></dt>
<dd><p>List all available filters and generators along with all their respective
options as well as possible minimum and maximum values along with the default
values.
</p><div class="example">
<pre class="example-preformatted">list_filters=true
</pre></div>
</dd>
<dt><samp class="option">filter</samp></dt>
<dd><p>Specify all filters by their respective name and options.
Use <var class="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 class="code">default</code> is available to use default options for a
filter.
</p>
<p>It is required to specify either <code class="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-preformatted">filter=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...]
</pre></div>
</dd>
<dt><samp class="option">output_rect</samp></dt>
<dd><p>Specify a rectangle where the output of the filter chain is copied into the
input image. It is given by a list of space separated float values:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">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 class="ref" 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>
<ul class="mini-toc">
<li><a href="#Examples-74" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-74">
<h4 class="subsection">30.47.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>List all filters available:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="corr">
<h3 class="section">30.48 corr</h3>
<p>Obtain the correlation 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 correlation is printed through
the logging system.
</p>
<p>The filter stores the calculated correlation of each frame in frame metadata.
</p>
<p>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<p>In the below example the input file <samp class="file">main.mpg</samp> being processed is compared
with the reference file <samp class="file">ref.mpg</samp>.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i main.mpg -i ref.mpg -lavfi corr -f null -
</pre></div>
</div>
<div class="section-level-extent" id="cover_005frect">
<h3 class="section">30.49 cover_rect</h3>
<p>Cover a rectangular object
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">cover</samp></dt>
<dd><p>Filepath of the optional cover image, needs to be in yuv420.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set covering mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">cover</samp>’</dt>
<dd><p>cover it by the supplied image
</p></dd>
<dt>‘<samp class="samp">blur</samp>’</dt>
<dd><p>cover it by interpolating the surrounding pixels
</p></dd>
</dl>
<p>Default value is <var class="var">blur</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-75" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-75">
<h4 class="subsection">30.49.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Cover a rectangular object by the supplied image of a given video using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="crop">
<h3 class="section">30.50 crop</h3>
<p>Crop the input video to given dimensions.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">w, out_w</samp></dt>
<dd><p>The width of the output video. It defaults to <code class="code">iw</code>.
This expression is evaluated only once during the filter
configuration, or when the ‘<samp class="samp">w</samp>’ or ‘<samp class="samp">out_w</samp>’ command is sent.
</p>
</dd>
<dt><samp class="option">h, out_h</samp></dt>
<dd><p>The height of the output video. It defaults to <code class="code">ih</code>.
This expression is evaluated only once during the filter
configuration, or when the ‘<samp class="samp">h</samp>’ or ‘<samp class="samp">out_h</samp>’ command is sent.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dd><p>The horizontal position, in the input video, of the left edge of the output
video. It defaults to <code class="code">(in_w-out_w)/2</code>.
This expression is evaluated per-frame.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>The vertical position, in the input video, of the top edge of the output video.
It defaults to <code class="code">(in_h-out_h)/2</code>.
This expression is evaluated per-frame.
</p>
</dd>
<dt><samp class="option">keep_aspect</samp></dt>
<dd><p>If set to 1 will force the output display aspect ratio
to be the same of the input, by changing the output sample aspect
ratio. It defaults to 0.
</p>
</dd>
<dt><samp class="option">exact</samp></dt>
<dd><p>Enable exact cropping. If enabled, subsampled videos will be cropped at exact
width/height/x/y as specified and will not be rounded to nearest smaller value.
It defaults to 0.
</p></dd>
</dl>
<p>The <var class="var">out_w</var>, <var class="var">out_h</var>, <var class="var">x</var>, <var class="var">y</var> parameters are
expressions containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The computed values for <var class="var">x</var> and <var class="var">y</var>. They are evaluated for
each new frame.
</p>
</dd>
<dt><samp class="option">in_w</samp></dt>
<dt><samp class="option">in_h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">iw</samp></dt>
<dt><samp class="option">ih</samp></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><samp class="option">out_w</samp></dt>
<dt><samp class="option">out_h</samp></dt>
<dd><p>The output (cropped) width and height.
</p>
</dd>
<dt><samp class="option">ow</samp></dt>
<dt><samp class="option">oh</samp></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var class="var">iw</var> / <var class="var">ih</var>) * <var class="var">sar</var>
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>The number of the input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown; deprecated,
do not use
</p>
</dd>
<dt><samp class="option">t</samp></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 class="var">out_w</var> may depend on the value of <var class="var">out_h</var>,
and the expression for <var class="var">out_h</var> may depend on <var class="var">out_w</var>, but they
cannot depend on <var class="var">x</var> and <var class="var">y</var>, as <var class="var">x</var> and <var class="var">y</var> are
evaluated after <var class="var">out_w</var> and <var class="var">out_h</var>.
</p>
<p>The <var class="var">x</var> and <var class="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 class="var">x</var> may depend on <var class="var">y</var>, and the expression
for <var class="var">y</var> may depend on <var class="var">x</var>.
</p>
<ul class="mini-toc">
<li><a href="#Examples-76" accesskey="1">Examples</a></li>
<li><a href="#Commands-76" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-76">
<h4 class="subsection">30.50.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Crop area with size 100x100 at position (12,34).
<div class="example">
<pre class="example-preformatted">crop=100:100:12:34
</pre></div>
<p>Using named options, the example above becomes:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">crop=in_w:1/PHI*in_w
</pre></div>
</li><li>Apply trembling effect:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">crop=in_w/2:in_h/2:y:10+10*sin(n/10)
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-76">
<h4 class="subsection">30.50.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">w, out_w</samp></dt>
<dt><samp class="option">h, out_h</samp></dt>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Set width/height of the output video and the horizontal/vertical position
in the input video.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="cropdetect">
<h3 class="section">30.51 cropdetect</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 class="var">mode</var>.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Depending on <var class="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 class="table">
<dt>‘<samp class="samp">black</samp>’</dt>
<dd><p>Detect black pixels surrounding the playing video. For fine control use option <var class="var">limit</var>.
</p>
</dd>
<dt>‘<samp class="samp">mvedges</samp>’</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><samp class="option">limit</samp></dt>
<dd><p>Set higher black value threshold, which can be optionally specified
from nothing (0) to everything (255 for 8-bit based formats). An intensity
value greater to the set value is considered non-black. It defaults to 24.
You can also specify a value between 0.0 and 1.0 which will be scaled depending
on the bitdepth of the pixel format.
</p>
</dd>
<dt><samp class="option">round</samp></dt>
<dd><p>The value which the width/height should be divisible by. It defaults to
16. The offset is automatically adjusted to center the video. Use 2 to
get only even dimensions (needed for 4:2:2 video). 16 is best when
encoding to most video codecs.
</p>
</dd>
<dt><samp class="option">skip</samp></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><samp class="option">reset_count, reset</samp></dt>
<dd><p>Set the counter that determines after how many frames cropdetect will
reset the previously detected largest video area and start over to
detect the current optimal crop area. Default value is 0.
</p>
<p>This can be useful when channel logos distort the video area. 0
indicates ’never reset’, and returns the largest area encountered during
playback.
</p>
</dd>
<dt><samp class="option">mv_threshold</samp></dt>
<dd><p>Set motion in pixel units as threshold for motion detection. It defaults to 8.
</p>
</dd>
<dt><samp class="option">low</samp></dt>
<dt><samp class="option">high</samp></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 class="var">low</var> and <var class="var">high</var> threshold values must be chosen in the range
[0,1], and <var class="var">low</var> should be lesser or equal to <var class="var">high</var>.
</p>
<p>Default value for <var class="var">low</var> is <code class="code">5/255</code>, and default value for <var class="var">high</var>
is <code class="code">15/255</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-77" accesskey="1">Examples</a></li>
<li><a href="#Commands-77" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-77">
<h4 class="subsection">30.51.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Find video area surrounded by black borders:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">ffmpeg -flags2 +export_mvs -i file.mp4 -vf cropdetect=mode=mvedges,metadata=mode=print -f null -
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-77">
<h4 class="subsection">30.51.2 Commands</h4>
<p>This filter supports the following commands:
</p>
<dl class="table">
<dt><samp class="option">limit</samp></dt>
<dd><p>The command accepts the same syntax of the corresponding option.
If the specified expression is not valid, it is kept at its current value.
</p></dd>
</dl>
<a class="anchor" id="cue"></a></div>
</div>
<div class="section-level-extent" id="cue-1">
<h3 class="section">30.52 cue</h3>
<p>Delay video filtering until a given wallclock timestamp. The filter first
passes on <samp class="option">preroll</samp> amount of frames, then it buffers at most
<samp class="option">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 class="table">
<dt><samp class="option">cue</samp></dt>
<dd><p>The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0.
</p>
</dd>
<dt><samp class="option">preroll</samp></dt>
<dd><p>The duration of content to pass on as preroll expressed in seconds. Default is 0.
</p>
</dd>
<dt><samp class="option">buffer</samp></dt>
<dd><p>The maximum duration of content to buffer before waiting for the cue expressed
in seconds. Default is 0.
</p>
</dd>
</dl>
<a class="anchor" id="curves"></a></div>
<div class="section-level-extent" id="curves-1">
<h3 class="section">30.53 curves</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 class="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 class="var">(0;0)</var> and
<var class="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 class="var">x</var> and <var class="var">y</var> values must be in the <var class="var">[0;1]</var> interval. The curve is
formed by using a natural or monotonic cubic spline interpolation, depending
on the <var class="var">interp</var> option (default: <code class="code">natural</code>). The <code class="code">natural</code>
spline produces a smoother curve in general while the monotonic (<code class="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 class="table">
<dt><samp class="option">preset</samp></dt>
<dd><p>Select one of the available color presets. This option can be used in addition
to the <samp class="option">r</samp>, <samp class="option">g</samp>, <samp class="option">b</samp> parameters; in this case, the later
options takes priority on the preset values.
Available presets are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dt>‘<samp class="samp">color_negative</samp>’</dt>
<dt>‘<samp class="samp">cross_process</samp>’</dt>
<dt>‘<samp class="samp">darker</samp>’</dt>
<dt>‘<samp class="samp">increase_contrast</samp>’</dt>
<dt>‘<samp class="samp">lighter</samp>’</dt>
<dt>‘<samp class="samp">linear_contrast</samp>’</dt>
<dt>‘<samp class="samp">medium_contrast</samp>’</dt>
<dt>‘<samp class="samp">negative</samp>’</dt>
<dt>‘<samp class="samp">strong_contrast</samp>’</dt>
<dt>‘<samp class="samp">vintage</samp>’</dt>
</dl>
<p>Default is <code class="code">none</code>.
</p></dd>
<dt><samp class="option">master, m</samp></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 class="option">r</samp>, <samp class="option">g</samp>, <samp class="option">b</samp> or <samp class="option">all</samp> since it acts like a
post-processing LUT.
</p></dd>
<dt><samp class="option">red, r</samp></dt>
<dd><p>Set the key points for the red component.
</p></dd>
<dt><samp class="option">green, g</samp></dt>
<dd><p>Set the key points for the green component.
</p></dd>
<dt><samp class="option">blue, b</samp></dt>
<dd><p>Set the key points for the blue component.
</p></dd>
<dt><samp class="option">all</samp></dt>
<dd><p>Set the key points for all components (not including master).
Can be used in addition to the other key points component
options. In this case, the unset component(s) will fallback on this
<samp class="option">all</samp> setting.
</p></dd>
<dt><samp class="option">psfile</samp></dt>
<dd><p>Specify a Photoshop curves file (<code class="code">.acv</code>) to import the settings from.
</p></dd>
<dt><samp class="option">plot</samp></dt>
<dd><p>Save Gnuplot script of the curves in specified file.
</p></dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Specify the kind of interpolation. Available algorithms are:
</p><dl class="table">
<dt>‘<samp class="samp">natural</samp>’</dt>
<dd><p>Natural cubic spline using a piece-wise cubic polynomial that is twice continuously differentiable.
</p></dd>
<dt>‘<samp class="samp">pchip</samp>’</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 class="code">x0/y0 x1/y1 x2/y2 ...</code>.
</p>
<ul class="mini-toc">
<li><a href="#Commands-78" accesskey="1">Commands</a></li>
<li><a href="#Examples-78" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-78">
<h4 class="subsection">30.53.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
<div class="subsection-level-extent" id="Examples-78">
<h4 class="subsection">30.53.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Increase slightly the middle level of blue:
<div class="example">
<pre class="example-preformatted">curves=blue='0/0 0.5/0.58 1/1'
</pre></div>
</li><li>Vintage effect:
<div class="example">
<pre class="example-preformatted">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 class="table">
<dt><var class="var">red</var></dt>
<dd><p><code class="code">(0;0.11) (0.42;0.51) (1;0.95)</code>
</p></dd>
<dt><var class="var">green</var></dt>
<dd><p><code class="code">(0;0) (0.50;0.48) (1;1)</code>
</p></dd>
<dt><var class="var">blue</var></dt>
<dd><p><code class="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-preformatted">curves=preset=vintage
</pre></div>
</li><li>Or simply:
<div class="example">
<pre class="example-preformatted">curves=vintage
</pre></div>
</li><li>Use a Photoshop preset and redefine the points of the green component:
<div class="example">
<pre class="example-preformatted">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 class="code">cross_process</code> profile using <code class="command">ffmpeg</code>
and <code class="command">gnuplot</code>:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="datascope">
<h3 class="section">30.54 datascope</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 class="table">
<dt><samp class="option">size, s</samp></dt>
<dd><p>Set output video size.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dd><p>Set x offset from where to pick pixels.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set y offset from where to pick pixels.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set scope mode, can be one of the following:
</p><dl class="table">
<dt>‘<samp class="samp">mono</samp>’</dt>
<dd><p>Draw hexadecimal pixel values with white color on black background.
</p>
</dd>
<dt>‘<samp class="samp">color</samp>’</dt>
<dd><p>Draw hexadecimal pixel values with input video pixel color on black
background.
</p>
</dd>
<dt>‘<samp class="samp">color2</samp>’</dt>
<dd><p>Draw hexadecimal pixel values on color background picked from input video,
the text color is picked in such way so its always visible.
</p></dd>
</dl>
</dd>
<dt><samp class="option">axis</samp></dt>
<dd><p>Draw rows and columns numbers on left and top of video.
</p>
</dd>
<dt><samp class="option">opacity</samp></dt>
<dd><p>Set background opacity.
</p>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>Set display number format. Can be <code class="code">hex</code>, or <code class="code">dec</code>. Default is <code class="code">hex</code>.
</p>
</dd>
<dt><samp class="option">components</samp></dt>
<dd><p>Set pixel components to display. By default all pixel components are displayed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-79" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-79">
<h4 class="subsection">30.54.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options excluding <code class="code">size</code> option.
</p>
</div>
</div>
<div class="section-level-extent" id="dblur">
<h3 class="section">30.55 dblur</h3>
<p>Apply Directional blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">angle</samp></dt>
<dd><p>Set angle of directional blur. Default is <code class="code">45</code>.
</p>
</dd>
<dt><samp class="option">radius</samp></dt>
<dd><p>Set radius of directional blur. Default is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-80" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-80">
<h4 class="subsection">30.55.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="dctdnoiz">
<h3 class="section">30.56 dctdnoiz</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 class="table">
<dt><samp class="option">sigma, s</samp></dt>
<dd><p>Set the noise sigma constant.
</p>
<p>This <var class="var">sigma</var> defines a hard threshold of <code class="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 class="option">expr</samp>.
</p>
<p>Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set number overlapping pixels for each block. Since the filter can be slow, you
may want to reduce this value, at the cost of a less effective filter and the
risk of various artefacts.
</p>
<p>If the overlapping value doesn’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 class="var">blocksize</var>-1, which is the best possible setting.
</p>
</dd>
<dt><samp class="option">expr, e</samp></dt>
<dd><p>Set the coefficient factor expression.
</p>
<p>For each coefficient of a DCT block, this expression will be evaluated as a
multiplier value for the coefficient.
</p>
<p>If this is option is set, the <samp class="option">sigma</samp> option will be ignored.
</p>
<p>The absolute value of the coefficient can be accessed through the <var class="var">c</var>
variable.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>Set the <var class="var">blocksize</var> using the number of bits. <code class="code">1<<<var class="var">n</var></code> defines the
<var class="var">blocksize</var>, which is the width and height of the processed blocks.
</p>
<p>The default value is <var class="var">3</var> (8x8) and can be raised to <var class="var">4</var> for a
<var class="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>
<ul class="mini-toc">
<li><a href="#Examples-79" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-79">
<h4 class="subsection">30.56.1 Examples</h4>
<p>Apply a denoise with a <samp class="option">sigma</samp> of <code class="code">4.5</code>:
</p><div class="example">
<pre class="example-preformatted">dctdnoiz=4.5
</pre></div>
<p>The same operation can be achieved using the expression system:
</p><div class="example">
<pre class="example-preformatted">dctdnoiz=e='gte(c, 4.5*3)'
</pre></div>
<p>Violent denoise using a block size of <code class="code">16x16</code>:
</p><div class="example">
<pre class="example-preformatted">dctdnoiz=15:n=4
</pre></div>
</div>
</div>
<div class="section-level-extent" id="deband">
<h3 class="section">30.57 deband</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 class="table">
<dt><samp class="option">1thr</samp></dt>
<dt><samp class="option">2thr</samp></dt>
<dt><samp class="option">3thr</samp></dt>
<dt><samp class="option">4thr</samp></dt>
<dd><p>Set banding detection threshold for each plane. Default is 0.02.
Valid range is 0.00003 to 0.5.
If difference between current pixel and reference pixel is less than threshold,
it will be considered as banded.
</p>
</dd>
<dt><samp class="option">range, r</samp></dt>
<dd><p>Banding detection range in pixels. Default is 16. If positive, random number
in range 0 to set value will be used. If negative, exact absolute value
will be used.
The range defines square of four pixels around current pixel.
</p>
</dd>
<dt><samp class="option">direction, d</samp></dt>
<dd><p>Set direction in radians from which four pixel will be compared. If positive,
random direction from 0 to set direction will be picked. If negative, exact of
absolute value will be picked. For example direction 0, -PI or -2*PI radians
will pick only pixels on same row and -PI/2 will pick only pixels on same
column.
</p>
</dd>
<dt><samp class="option">blur, b</samp></dt>
<dd><p>If enabled, current pixel is compared with average value of all four
surrounding pixels. The default is enabled. If disabled current pixel is
compared with all four surrounding pixels. The pixel is considered banded
if only all four differences with surrounding pixels are less than threshold.
</p>
</dd>
<dt><samp class="option">coupling, c</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-81" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-81">
<h4 class="subsection">30.57.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="deblock">
<h3 class="section">30.58 deblock</h3>
<p>Remove blocking artifacts from input video.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">filter</samp></dt>
<dd><p>Set filter type, can be <var class="var">weak</var> or <var class="var">strong</var>. Default is <var class="var">strong</var>.
This controls what kind of deblocking is applied.
</p>
</dd>
<dt><samp class="option">block</samp></dt>
<dd><p>Set size of block, allowed range is from 4 to 512. Default is <var class="var">8</var>.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dt><samp class="option">beta</samp></dt>
<dt><samp class="option">gamma</samp></dt>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set blocking detection thresholds. Allowed range is 0 to 1.
Defaults are: <var class="var">0.098</var> for <var class="var">alpha</var> and <var class="var">0.05</var> for the rest.
Using higher threshold gives more deblocking strength.
Setting <var class="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 class="var">0</var> disables
deblocking.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is to filter all available planes.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-80" accesskey="1">Examples</a></li>
<li><a href="#Commands-82" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-80">
<h4 class="subsection">30.58.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Deblock using weak filter and block size of 4 pixels.
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-82">
<h4 class="subsection">30.58.2 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
<a class="anchor" id="decimate"></a></div>
</div>
<div class="section-level-extent" id="decimate-1">
<h3 class="section">30.59 decimate</h3>
<p>Drop duplicated frames at regular intervals.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">cycle</samp></dt>
<dd><p>Set the number of frames from which one will be dropped. Setting this to
<var class="var">N</var> means one frame in every batch of <var class="var">N</var> frames will be dropped.
Default is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">dupthresh</samp></dt>
<dd><p>Set the threshold for duplicate detection. If the difference metric for a frame
is less than or equal to this value, then it is declared as duplicate. Default
is <code class="code">1.1</code>
</p>
</dd>
<dt><samp class="option">scthresh</samp></dt>
<dd><p>Set scene change threshold. Default is <code class="code">15</code>.
</p>
</dd>
<dt><samp class="option">blockx</samp></dt>
<dt><samp class="option">blocky</samp></dt>
<dd><p>Set the size of the x and y-axis blocks used during metric calculations.
Larger blocks give better noise suppression, but also give worse detection of
small movements. Must be a power of two. Default is <code class="code">32</code>.
</p>
</dd>
<dt><samp class="option">ppsrc</samp></dt>
<dd><p>Mark main input as a pre-processed input and activate clean source input
stream. This allows the input to be pre-processed with various filters to help
the metrics calculation while keeping the frame selection lossless. When set to
<code class="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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">chroma</samp></dt>
<dd><p>Set whether or not chroma is considered in the metric calculations. Default is
<code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">mixed</samp></dt>
<dd><p>Set whether or not the input only partially contains content to be decimated.
Default is <code class="code">false</code>.
If enabled video output stream will be in variable frame rate.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="deconvolve">
<h3 class="section">30.60 deconvolve</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process.
</p>
</dd>
<dt><samp class="option">impulse</samp></dt>
<dd><p>Set which impulse video frames will be processed, can be <var class="var">first</var>
or <var class="var">all</var>. Default is <var class="var">all</var>.
</p>
</dd>
<dt><samp class="option">noise</samp></dt>
<dd><p>Set noise when doing divisions. Default is <var class="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 class="code">deconvolve</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
</div>
<div class="section-level-extent" id="dedot">
<h3 class="section">30.61 dedot</h3>
<p>Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">m</samp></dt>
<dd><p>Set mode of operation. Can be combination of <var class="var">dotcrawl</var> for cross-luminance reduction and/or
<var class="var">rainbows</var> for cross-color reduction.
</p>
</dd>
<dt><samp class="option">lt</samp></dt>
<dd><p>Set spatial luma threshold. Lower values increases reduction of cross-luminance.
</p>
</dd>
<dt><samp class="option">tl</samp></dt>
<dd><p>Set tolerance for temporal luma. Higher values increases reduction of cross-luminance.
</p>
</dd>
<dt><samp class="option">tc</samp></dt>
<dd><p>Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color.
</p>
</dd>
<dt><samp class="option">ct</samp></dt>
<dd><p>Set temporal chroma threshold. Lower values increases reduction of cross-color.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="deflate">
<h3 class="section">30.62 deflate</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-83" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-83">
<h4 class="subsection">30.62.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="deflicker">
<h3 class="section">30.63 deflicker</h3>
<p>Remove temporal frame luminance variations.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></dt>
<dd><p>Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129.
</p>
</dd>
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set averaging mode to smooth temporal luminance variations.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">am</samp>’</dt>
<dd><p>Arithmetic mean
</p>
</dd>
<dt>‘<samp class="samp">gm</samp>’</dt>
<dd><p>Geometric mean
</p>
</dd>
<dt>‘<samp class="samp">hm</samp>’</dt>
<dd><p>Harmonic mean
</p>
</dd>
<dt>‘<samp class="samp">qm</samp>’</dt>
<dd><p>Quadratic mean
</p>
</dd>
<dt>‘<samp class="samp">cm</samp>’</dt>
<dd><p>Cubic mean
</p>
</dd>
<dt>‘<samp class="samp">pm</samp>’</dt>
<dd><p>Power mean
</p>
</dd>
<dt>‘<samp class="samp">median</samp>’</dt>
<dd><p>Median
</p></dd>
</dl>
</dd>
<dt><samp class="option">bypass</samp></dt>
<dd><p>Do not actually modify frame. Useful when one only wants metadata.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="dejudder">
<h3 class="section">30.64 dejudder</h3>
<p>Remove judder produced by partially interlaced telecined content.
</p>
<p>Judder can be introduced, for instance, by <a class="ref" href="#pullup">pullup</a> filter. If the original
source was partially telecined content then the output of <code class="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 class="table">
<dt><samp class="option">cycle</samp></dt>
<dd><p>Specify the length of the window over which the judder repeats.
</p>
<p>Accepts any integer greater than 1. Useful values are:
</p><dl class="table">
<dt>‘<samp class="samp">4</samp>’</dt>
<dd><p>If the original was telecined from 24 to 30 fps (Film to NTSC).
</p>
</dd>
<dt>‘<samp class="samp">5</samp>’</dt>
<dd><p>If the original was telecined from 25 to 30 fps (PAL to NTSC).
</p>
</dd>
<dt>‘<samp class="samp">20</samp>’</dt>
<dd><p>If a mixture of the two.
</p></dd>
</dl>
<p>The default is ‘<samp class="samp">4</samp>’.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="delogo">
<h3 class="section">30.65 delogo</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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Specify the top left corner coordinates of the logo. They must be
specified.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Specify the width and height of the logo to clear. They must be
specified.
</p>
</dd>
<dt><samp class="option">show</samp></dt>
<dd><p>When set to 1, a green rectangle is drawn on the screen to simplify
finding the right <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var>, and <var class="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>
<ul class="mini-toc">
<li><a href="#Examples-81" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-81">
<h4 class="subsection">30.65.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Set a rectangle covering the area with top left corner coordinates 0,0
and size 100x77:
<div class="example">
<pre class="example-preformatted">delogo=x=0:y=0:w=100:h=77
</pre></div>
</li></ul>
<a class="anchor" id="derain"></a></div>
</div>
<div class="section-level-extent" id="derain-1">
<h3 class="section">30.66 derain</h3>
<p>Remove the rain in the input image/video by applying the derain methods based on
convolutional neural networks. Supported models:
</p>
<ul class="itemize mark-bullet">
<li>Recurrent Squeeze-and-Excitation Context Aggregation Net (RESCAN).
See <a class="url" 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 class="url" href="https://github.com/XueweiMeng/derain_filter.git">https://github.com/XueweiMeng/derain_filter.git</a>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">filter_type</samp></dt>
<dd><p>Specify which filter to use. This option accepts the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">derain</samp>’</dt>
<dd><p>Derain filter. To conduct derain filter, you need to use a derain model.
</p>
</dd>
<dt>‘<samp class="samp">dehaze</samp>’</dt>
<dd><p>Dehaze filter. To conduct dehaze filter, you need to use a dehaze model.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">derain</samp>’.
</p>
</dd>
<dt><samp class="option">dnn_backend</samp></dt>
<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts
the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">tensorflow</samp>’</dt>
<dd><p>TensorFlow backend. To enable this backend you
need to install the TensorFlow for C library (see
<a class="url" href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with
<code class="code">--enable-libtensorflow</code>
</p></dd>
</dl>
</dd>
<dt><samp class="option">model</samp></dt>
<dd><p>Set path to model file specifying network architecture and its parameters.
Note that different backends use different file formats. TensorFlow can load files for only its format.
</p></dd>
</dl>
<p>To get full functionality (such as async execution), please use the <a class="ref" href="#dnn_005fprocessing">dnn_processing</a> filter.
</p>
</div>
<div class="section-level-extent" id="deshake">
<h3 class="section">30.67 deshake</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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Specify a rectangular area where to limit the search for motion
vectors.
If desired the search for motion vectors can be limited to a
rectangular area of the frame defined by its top left corner, width
and height. These parameters have the same meaning as the drawbox
filter which can be used to visualise the position of the bounding
box.
</p>
<p>This is useful when simultaneous movement of subjects within the frame
might be confused for camera motion by the motion vector search.
</p>
<p>If any or all of <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var> and <var class="var">h</var> are set to -1
then the full frame is used. This allows later options to be set
without specifying the bounding box for the motion vector search.
</p>
<p>Default - search the whole frame.
</p>
</dd>
<dt><samp class="option">rx</samp></dt>
<dt><samp class="option">ry</samp></dt>
<dd><p>Specify the maximum extent of movement in x and y directions in the
range 0-64 pixels. Default 16.
</p>
</dd>
<dt><samp class="option">edge</samp></dt>
<dd><p>Specify how to generate pixels to fill blanks at the edge of the
frame. Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">blank, 0</samp>’</dt>
<dd><p>Fill zeroes at blank locations
</p></dd>
<dt>‘<samp class="samp">original, 1</samp>’</dt>
<dd><p>Original image at blank locations
</p></dd>
<dt>‘<samp class="samp">clamp, 2</samp>’</dt>
<dd><p>Extruded edge value at blank locations
</p></dd>
<dt>‘<samp class="samp">mirror, 3</samp>’</dt>
<dd><p>Mirrored edge at blank locations
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">mirror</samp>’.
</p>
</dd>
<dt><samp class="option">blocksize</samp></dt>
<dd><p>Specify the blocksize to use for motion search. Range 4-128 pixels,
default 8.
</p>
</dd>
<dt><samp class="option">contrast</samp></dt>
<dd><p>Specify the contrast threshold for blocks. Only blocks with more than
the specified contrast (difference between darkest and lightest
pixels) will be considered. Range 1-255, default 125.
</p>
</dd>
<dt><samp class="option">search</samp></dt>
<dd><p>Specify the search strategy. Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">exhaustive, 0</samp>’</dt>
<dd><p>Set exhaustive search
</p></dd>
<dt>‘<samp class="samp">less, 1</samp>’</dt>
<dd><p>Set less exhaustive search.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">exhaustive</samp>’.
</p>
</dd>
<dt><samp class="option">filename</samp></dt>
<dd><p>If set then a detailed log of the motion search is written to the
specified file.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="despill">
<h3 class="section">30.68 despill</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 class="table">
<dt><samp class="option">type</samp></dt>
<dd><p>Set what type of despill to use.
</p>
</dd>
<dt><samp class="option">mix</samp></dt>
<dd><p>Set how spillmap will be generated.
</p>
</dd>
<dt><samp class="option">expand</samp></dt>
<dd><p>Set how much to get rid of still remaining spill.
</p>
</dd>
<dt><samp class="option">red</samp></dt>
<dd><p>Controls amount of red in spill area.
</p>
</dd>
<dt><samp class="option">green</samp></dt>
<dd><p>Controls amount of green in spill area.
Should be -1 for greenscreen.
</p>
</dd>
<dt><samp class="option">blue</samp></dt>
<dd><p>Controls amount of blue in spill area.
Should be -1 for bluescreen.
</p>
</dd>
<dt><samp class="option">brightness</samp></dt>
<dd><p>Controls brightness of spill area, preserving colors.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>Modify alpha from generated spillmap.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-84" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-84">
<h4 class="subsection">30.68.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="detelecine">
<h3 class="section">30.69 detelecine</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 class="table">
<dt><samp class="option">first_field</samp></dt>
<dd><dl class="table">
<dt>‘<samp class="samp">top, t</samp>’</dt>
<dd><p>top field first
</p></dd>
<dt>‘<samp class="samp">bottom, b</samp>’</dt>
<dd><p>bottom field first
The default value is <code class="code">top</code>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">pattern</samp></dt>
<dd><p>A string of numbers representing the pulldown pattern you wish to apply.
The default value is <code class="code">23</code>.
</p>
</dd>
<dt><samp class="option">start_frame</samp></dt>
<dd><p>A number representing position of the first frame with respect to the telecine
pattern. This is to be used if the stream is cut. The default value is <code class="code">0</code>.
</p></dd>
</dl>
<a class="anchor" id="dilation"></a></div>
<div class="section-level-extent" id="dilation-1">
<h3 class="section">30.70 dilation</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p>
</dd>
<dt><samp class="option">coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
pixels are used.
</p>
<p>Flags to local 3x3 coordinates maps like this:
</p>
<p>1 2 3
4 5
6 7 8
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-85" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-85">
<h4 class="subsection">30.70.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="displace">
<h3 class="section">30.71 displace</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 class="table">
<dt><samp class="option">edge</samp></dt>
<dd><p>Set displace behavior for pixels that are out of range.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">blank</samp>’</dt>
<dd><p>Missing pixels are replaced by black pixels.
</p>
</dd>
<dt>‘<samp class="samp">smear</samp>’</dt>
<dd><p>Adjacent pixels will spread out to replace missing pixels.
</p>
</dd>
<dt>‘<samp class="samp">wrap</samp>’</dt>
<dd><p>Out of range pixels are wrapped so they point to pixels of other side.
</p>
</dd>
<dt>‘<samp class="samp">mirror</samp>’</dt>
<dd><p>Out of range pixels will be replaced with mirrored pixels.
</p></dd>
</dl>
<p>Default is ‘<samp class="samp">smear</samp>’.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-82" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-82">
<h4 class="subsection">30.71.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Add ripple effect to rgb input of video size hd720:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="dnn_005fclassify">
<h3 class="section">30.72 dnn_classify</h3>
<p>Do classification with deep neural networks based on bounding boxes.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">dnn_backend</samp></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><samp class="option">model</samp></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><samp class="option">input</samp></dt>
<dd><p>Set the input name of the dnn network.
</p>
</dd>
<dt><samp class="option">output</samp></dt>
<dd><p>Set the output name of the dnn network.
</p>
</dd>
<dt><samp class="option">confidence</samp></dt>
<dd><p>Set the confidence threshold (default: 0.5).
</p>
</dd>
<dt><samp class="option">labels</samp></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><samp class="option">backend_configs</samp></dt>
<dd><p>Set the configs to be passed into backend
</p>
<p>For tensorflow backend, you can set its configs with <samp class="option">sess_config</samp> options,
please use tools/python/tf_sess_config.py to get the configs for your system.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="dnn_005fdetect">
<h3 class="section">30.73 dnn_detect</h3>
<p>Do object detection with deep neural networks.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">dnn_backend</samp></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><samp class="option">model</samp></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><samp class="option">input</samp></dt>
<dd><p>Set the input name of the dnn network.
</p>
</dd>
<dt><samp class="option">output</samp></dt>
<dd><p>Set the output name of the dnn network.
</p>
</dd>
<dt><samp class="option">confidence</samp></dt>
<dd><p>Set the confidence threshold (default: 0.5).
</p>
</dd>
<dt><samp class="option">labels</samp></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><samp class="option">backend_configs</samp></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>
<a class="anchor" id="dnn_005fprocessing"></a></div>
<div class="section-level-extent" id="dnn_005fprocessing-1">
<h3 class="section">30.74 dnn_processing</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 class="table">
<dt><samp class="option">dnn_backend</samp></dt>
<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts
the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">tensorflow</samp>’</dt>
<dd><p>TensorFlow backend. To enable this backend you
need to install the TensorFlow for C library (see
<a class="url" href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with
<code class="code">--enable-libtensorflow</code>
</p>
</dd>
<dt>‘<samp class="samp">openvino</samp>’</dt>
<dd><p>OpenVINO backend. To enable this backend you
need to build and install the OpenVINO for C library (see
<a class="url" 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 class="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>
</dd>
<dt><samp class="option">model</samp></dt>
<dd><p>Set path to model file specifying network architecture and its parameters.
Note that different backends use different file formats. TensorFlow, OpenVINO backend can load files for only its format.
</p>
</dd>
<dt><samp class="option">input</samp></dt>
<dd><p>Set the input name of the dnn network.
</p>
</dd>
<dt><samp class="option">output</samp></dt>
<dd><p>Set the output name of the dnn network.
</p>
</dd>
<dt><samp class="option">backend_configs</samp></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 class="option">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>
<ul class="mini-toc">
<li><a href="#Examples-83" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-83">
<h4 class="subsection">30.74.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Remove rain in rgb24 frame with can.pb (see <a class="ref" href="#derain">derain</a> filter):
<div class="example">
<pre class="example-preformatted">./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>Handle the Y channel with srcnn.pb (see <a class="ref" href="#sr">sr</a> filter) for frame with yuv420p (planar YUV formats supported):
<div class="example">
<pre class="example-preformatted">./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 class="ref" 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-preformatted">./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>
</div>
</div>
<div class="section-level-extent" id="drawbox">
<h3 class="section">30.75 drawbox</h3>
<p>Draw a colored box on the input image.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The expressions which specify the top left corner coordinates of the box. It defaults to 0.
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>The expressions which specify the width and height of the box; if 0 they are interpreted as
the input width and height. It defaults to 0.
</p>
</dd>
<dt><samp class="option">color, c</samp></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 class="code">invert</code> is used, the box edge color is the same as the
video with inverted luma.
</p>
</dd>
<dt><samp class="option">thickness, t</samp></dt>
<dd><p>The expression which sets the thickness of the box edge.
A value of <code class="code">fill</code> will create a filled box. Default value is <code class="code">3</code>.
</p>
<p>See below for the list of accepted constants.
</p>
</dd>
<dt><samp class="option">replace</samp></dt>
<dd><p>Applicable if the input has alpha. With value <code class="code">1</code>, the pixels of the painted box
will overwrite the video’s color and alpha pixels.
Default is <code class="code">0</code>, which composites the box onto the input, leaving the video’s alpha intact.
</p></dd>
</dl>
<p>The parameters for <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var> and <var class="var">h</var> and <var class="var">t</var> are expressions containing the
following constants:
</p>
<dl class="table">
<dt><samp class="option">dar</samp></dt>
<dd><p>The input display aspect ratio, it is the same as (<var class="var">w</var> / <var class="var">h</var>) * <var class="var">sar</var>.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">in_h, ih</samp></dt>
<dt><samp class="option">in_w, iw</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The x and y offset coordinates where the box is drawn.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The width and height of the drawn box.
</p>
</dd>
<dt><samp class="option">box_source</samp></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 class="var">box_source</var> is set, the <var class="var">x</var>, <var class="var">y</var>, <var class="var">width</var> and <var class="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><samp class="option">t</samp></dt>
<dd><p>The thickness of the drawn box.
</p>
<p>These constants allow the <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var>, <var class="var">h</var> and <var class="var">t</var> expressions to refer to
each other, so you may for example specify <code class="code">y=x/dar</code> or <code class="code">h=w/dar</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-84" accesskey="1">Examples</a></li>
<li><a href="#Commands-86" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-84">
<h4 class="subsection">30.75.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Draw a black box around the edge of the input image:
<div class="example">
<pre class="example-preformatted">drawbox
</pre></div>
</li><li>Draw a box with color red and an opacity of 50%:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-86">
<h4 class="subsection">30.75.2 Commands</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 class="anchor" id="drawgraph"></a></div>
</div>
<div class="section-level-extent" id="drawgraph-1">
<h3 class="section">30.76 drawgraph</h3>
<p>Draw a graph using input video metadata.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">m1</samp></dt>
<dd><p>Set 1st frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp class="option">fg1</samp></dt>
<dd><p>Set 1st foreground color expression.
</p>
</dd>
<dt><samp class="option">m2</samp></dt>
<dd><p>Set 2nd frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp class="option">fg2</samp></dt>
<dd><p>Set 2nd foreground color expression.
</p>
</dd>
<dt><samp class="option">m3</samp></dt>
<dd><p>Set 3rd frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp class="option">fg3</samp></dt>
<dd><p>Set 3rd foreground color expression.
</p>
</dd>
<dt><samp class="option">m4</samp></dt>
<dd><p>Set 4th frame metadata key from which metadata values will be used to draw a graph.
</p>
</dd>
<dt><samp class="option">fg4</samp></dt>
<dd><p>Set 4th foreground color expression.
</p>
</dd>
<dt><samp class="option">min</samp></dt>
<dd><p>Set minimal value of metadata value.
</p>
</dd>
<dt><samp class="option">max</samp></dt>
<dd><p>Set maximal value of metadata value.
</p>
</dd>
<dt><samp class="option">bg</samp></dt>
<dd><p>Set graph background color. Default is white.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set graph mode.
</p>
<p>Available values for mode is:
</p><dl class="table">
<dt>‘<samp class="samp">bar</samp>’</dt>
<dt>‘<samp class="samp">dot</samp>’</dt>
<dt>‘<samp class="samp">line</samp>’</dt>
</dl>
<p>Default is <code class="code">line</code>.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Set slide mode.
</p>
<p>Available values for slide is:
</p><dl class="table">
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Draw new frame when right border is reached.
</p>
</dd>
<dt>‘<samp class="samp">replace</samp>’</dt>
<dd><p>Replace old columns with new ones.
</p>
</dd>
<dt>‘<samp class="samp">scroll</samp>’</dt>
<dd><p>Scroll from right to left.
</p>
</dd>
<dt>‘<samp class="samp">rscroll</samp>’</dt>
<dd><p>Scroll from left to right.
</p>
</dd>
<dt>‘<samp class="samp">picture</samp>’</dt>
<dd><p>Draw single picture.
</p></dd>
</dl>
<p>Default is <code class="code">frame</code>.
</p>
</dd>
<dt><samp class="option">size</samp></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 class="code">900x256</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code class="code">25</code>.
</p>
<p>The foreground color expressions can use the following variables:
</p><dl class="table">
<dt><samp class="option">MIN</samp></dt>
<dd><p>Minimal value of metadata value.
</p>
</dd>
<dt><samp class="option">MAX</samp></dt>
<dd><p>Maximal value of metadata value.
</p>
</dd>
<dt><samp class="option">VAL</samp></dt>
<dd><p>Current metadata key value.
</p></dd>
</dl>
<p>The color is defined as 0xAABBGGRR.
</p></dd>
</dl>
<p>Example using metadata from <a class="ref" href="#signalstats">signalstats</a> filter:
</p><div class="example">
<pre class="example-preformatted">signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
</pre></div>
<p>Example using metadata from <a class="ref" href="#ebur128">ebur128</a> filter:
</p><div class="example">
<pre class="example-preformatted">ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
</pre></div>
</div>
<div class="section-level-extent" id="drawgrid">
<h3 class="section">30.77 drawgrid</h3>
<p>Draw a grid on the input image.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0.
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the
input width and height, respectively, minus <code class="code">thickness</code>, so image gets
framed. Default to 0.
</p>
</dd>
<dt><samp class="option">color, c</samp></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 class="code">invert</code> is used, the grid color is the same as the
video with inverted luma.
</p>
</dd>
<dt><samp class="option">thickness, t</samp></dt>
<dd><p>The expression which sets the thickness of the grid line. Default value is <code class="code">1</code>.
</p>
<p>See below for the list of accepted constants.
</p>
</dd>
<dt><samp class="option">replace</samp></dt>
<dd><p>Applicable if the input has alpha. With <code class="code">1</code> the pixels of the painted grid
will overwrite the video’s color and alpha pixels.
Default is <code class="code">0</code>, which composites the grid onto the input, leaving the video’s alpha intact.
</p></dd>
</dl>
<p>The parameters for <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var> and <var class="var">h</var> and <var class="var">t</var> are expressions containing the
following constants:
</p>
<dl class="table">
<dt><samp class="option">dar</samp></dt>
<dd><p>The input display aspect ratio, it is the same as (<var class="var">w</var> / <var class="var">h</var>) * <var class="var">sar</var>.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">in_h, ih</samp></dt>
<dt><samp class="option">in_w, iw</samp></dt>
<dd><p>The input grid cell width and height.
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The x and y coordinates of some point of grid intersection (meant to configure offset).
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The width and height of the drawn cell.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>The thickness of the drawn cell.
</p>
<p>These constants allow the <var class="var">x</var>, <var class="var">y</var>, <var class="var">w</var>, <var class="var">h</var> and <var class="var">t</var> expressions to refer to
each other, so you may for example specify <code class="code">y=x/dar</code> or <code class="code">h=w/dar</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-85" accesskey="1">Examples</a></li>
<li><a href="#Commands-87" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-85">
<h4 class="subsection">30.77.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-87">
<h4 class="subsection">30.77.2 Commands</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 class="anchor" id="drawtext"></a></div>
</div>
<div class="section-level-extent" id="drawtext-1">
<h3 class="section">30.78 drawtext</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 class="code">--enable-libfreetype</code> and <code class="code">--enable-libharfbuzz</code>.
To enable default font fallback and the <var class="var">font</var> option you need to
configure FFmpeg with <code class="code">--enable-libfontconfig</code>.
To enable the <var class="var">text_shaping</var> option, you need to configure FFmpeg with
<code class="code">--enable-libfribidi</code>.
</p>
<ul class="mini-toc">
<li><a href="#Syntax-2" accesskey="1">Syntax</a></li>
<li><a href="#Text-expansion" accesskey="2">Text expansion</a></li>
<li><a href="#Commands-88" accesskey="3">Commands</a></li>
<li><a href="#Examples-86" accesskey="4">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Syntax-2">
<h4 class="subsection">30.78.1 Syntax</h4>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">box</samp></dt>
<dd><p>Used to draw a box around text using the background color.
The value must be either 1 (enable) or 0 (disable).
The default value of <var class="var">box</var> is 0.
</p>
</dd>
<dt><samp class="option">boxborderw</samp></dt>
<dd><p>Set the width of the border to be drawn around the box using <var class="var">boxcolor</var>.
The value must be specified using one of the following formats:
</p><ul class="itemize mark-bullet">
<li><code class="code">boxborderw=10</code> set the width of all the borders to 10
</li><li><code class="code">boxborderw=10|20</code> set the width of the top and bottom borders to 10
and the width of the left and right borders to 20
</li><li><code class="code">boxborderw=10|20|30</code> set the width of the top border to 10, the width
of the bottom border to 30 and the width of the left and right borders to 20
</li><li><code class="code">boxborderw=10|20|30|40</code> set the borders width to 10 (top), 20 (right),
30 (bottom), 40 (left)
</li></ul>
<p>The default value of <var class="var">boxborderw</var> is "0".
</p>
</dd>
<dt><samp class="option">boxcolor</samp></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 class="var">boxcolor</var> is "white".
</p>
</dd>
<dt><samp class="option">line_spacing</samp></dt>
<dd><p>Set the line spacing in pixels. The default value of <var class="var">line_spacing</var> is 0.
</p>
</dd>
<dt><samp class="option">text_align</samp></dt>
<dd><p>Set the vertical and horizontal alignment of the text with respect to the box boundaries.
The value is combination of flags, one for the vertical alignment (T=top,
M=middle, B=bottom) and one for the horizontal alignment (L=left, C=center, R=right).
Please note that tab characters are only supported with the left horizontal alignment.
</p>
</dd>
<dt><samp class="option">y_align</samp></dt>
<dd><p>Specify what the <var class="var">y</var> value is referred to. Possible values are:
</p><ul class="itemize mark-bullet">
<li><code class="code">text</code> the top of the highest glyph of the first text line is placed at <var class="var">y</var>
</li><li><code class="code">baseline</code> the baseline of the first text line is placed at <var class="var">y</var>
</li><li><code class="code">font</code> the baseline of the first text line is placed at <var class="var">y</var> plus the
ascent (in pixels) defined in the font metrics
</li></ul>
<p>The default value of <var class="var">y_align</var> is "text" for backward compatibility.
</p>
</dd>
<dt><samp class="option">borderw</samp></dt>
<dd><p>Set the width of the border to be drawn around the text using <var class="var">bordercolor</var>.
The default value of <var class="var">borderw</var> is 0.
</p>
</dd>
<dt><samp class="option">bordercolor</samp></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 class="var">bordercolor</var> is "black".
</p>
</dd>
<dt><samp class="option">expansion</samp></dt>
<dd><p>Select how the <var class="var">text</var> is expanded. Can be either <code class="code">none</code>,
<code class="code">strftime</code> (deprecated) or <code class="code">normal</code> (default). See the
<a class="ref" href="#drawtext_005fexpansion">Text expansion</a> section below for details.
</p>
</dd>
<dt><samp class="option">basetime</samp></dt>
<dd><p>Set a start time for the count. Value is in microseconds. Only applied
in the deprecated <code class="code">strftime</code> expansion mode. To emulate in normal expansion
mode use the <code class="code">pts</code> function, supplying the start time (in seconds)
as the second argument.
</p>
</dd>
<dt><samp class="option">fix_bounds</samp></dt>
<dd><p>If true, check and fix text coords to avoid clipping.
</p>
</dd>
<dt><samp class="option">fontcolor</samp></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 class="var">fontcolor</var> is "black".
</p>
</dd>
<dt><samp class="option">fontcolor_expr</samp></dt>
<dd><p>String which is expanded the same way as <var class="var">text</var> to obtain dynamic
<var class="var">fontcolor</var> value. By default this option has empty value and is not
processed. When this option is set, it overrides <var class="var">fontcolor</var> option.
</p>
</dd>
<dt><samp class="option">font</samp></dt>
<dd><p>The font family to be used for drawing text. By default Sans.
</p>
</dd>
<dt><samp class="option">fontfile</samp></dt>
<dd><p>The font file to be used for drawing text. The path must be included.
This parameter is mandatory if the fontconfig support is disabled.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>Draw the text applying alpha blending. The value can
be a number between 0.0 and 1.0.
The expression accepts the same variables <var class="var">x, y</var> as well.
The default value is 1.
Please see <var class="var">fontcolor_expr</var>.
</p>
</dd>
<dt><samp class="option">fontsize</samp></dt>
<dd><p>The font size to be used for drawing text.
The default value of <var class="var">fontsize</var> is 16.
</p>
</dd>
<dt><samp class="option">text_shaping</samp></dt>
<dd><p>If set to 1, attempt to shape the text (for example, reverse the order of
right-to-left text and join Arabic characters) before drawing it.
Otherwise, just draw the text exactly as given.
By default 1 (if supported).
</p>
</dd>
<dt><samp class="option">ft_load_flags</samp></dt>
<dd><p>The flags to be used for loading the fonts.
</p>
<p>The flags map the corresponding flags supported by libfreetype, and are
a combination of the following values:
</p><dl class="table">
<dt><var class="var">default</var></dt>
<dt><var class="var">no_scale</var></dt>
<dt><var class="var">no_hinting</var></dt>
<dt><var class="var">render</var></dt>
<dt><var class="var">no_bitmap</var></dt>
<dt><var class="var">vertical_layout</var></dt>
<dt><var class="var">force_autohint</var></dt>
<dt><var class="var">crop_bitmap</var></dt>
<dt><var class="var">pedantic</var></dt>
<dt><var class="var">ignore_global_advance_width</var></dt>
<dt><var class="var">no_recurse</var></dt>
<dt><var class="var">ignore_transform</var></dt>
<dt><var class="var">monochrome</var></dt>
<dt><var class="var">linear_design</var></dt>
<dt><var class="var">no_autohint</var></dt>
</dl>
<p>Default value is "default".
</p>
<p>For more information consult the documentation for the FT_LOAD_*
libfreetype flags.
</p>
</dd>
<dt><samp class="option">shadowcolor</samp></dt>
<dd><p>The color to be used for drawing a shadow behind the drawn text. For the
syntax of this option, check the <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 class="var">shadowcolor</var> is "black".
</p>
</dd>
<dt><samp class="option">boxw</samp></dt>
<dd><p>Set the width of the box to be drawn around text.
The default value of <var class="var">boxw</var> is computed automatically to match the text width
</p>
</dd>
<dt><samp class="option">boxh</samp></dt>
<dd><p>Set the height of the box to be drawn around text.
The default value of <var class="var">boxh</var> is computed automatically to match the text height
</p>
</dd>
<dt><samp class="option">shadowx</samp></dt>
<dt><samp class="option">shadowy</samp></dt>
<dd><p>The x and y offsets for the text shadow position with respect to the
position of the text. They can be either positive or negative
values. The default value for both is "0".
</p>
</dd>
<dt><samp class="option">start_number</samp></dt>
<dd><p>The starting frame number for the n/frame_num variable. The default value
is "0".
</p>
</dd>
<dt><samp class="option">tabsize</samp></dt>
<dd><p>The size in number of spaces to use for rendering the tab.
Default value is 4.
</p>
</dd>
<dt><samp class="option">timecode</samp></dt>
<dd><p>Set the initial timecode representation in "hh:mm:ss[:;.]ff"
format. It can be used with or without text parameter. <var class="var">timecode_rate</var>
option must be specified.
</p>
</dd>
<dt><samp class="option">timecode_rate, rate, r</samp></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><samp class="option">tc24hmax</samp></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><samp class="option">text</samp></dt>
<dd><p>The text string to be drawn. The text must be a sequence of UTF-8
encoded characters.
This parameter is mandatory if no file is specified with the parameter
<var class="var">textfile</var>.
</p>
</dd>
<dt><samp class="option">textfile</samp></dt>
<dd><p>A text file containing text to be drawn. The text must be a sequence
of UTF-8 encoded characters.
</p>
<p>This parameter is mandatory if no text string is specified with the
parameter <var class="var">text</var>.
</p>
<p>If both <var class="var">text</var> and <var class="var">textfile</var> are specified, an error is thrown.
</p>
</dd>
<dt><samp class="option">text_source</samp></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 class="var">text</var> and <var class="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><samp class="option">reload</samp></dt>
<dd><p>The <var class="var">textfile</var> will be reloaded at specified frame interval.
Be sure to update <var class="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><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The expressions which specify the offsets where text will be drawn
within the video frame. They are relative to the top/left border of the
output image.
</p>
<p>The default value of <var class="var">x</var> and <var class="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 class="var">x</var> and <var class="var">y</var> are expressions containing the
following constants and functions:
</p>
<dl class="table">
<dt><samp class="option">dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var class="var">w</var> / <var class="var">h</var>) * <var class="var">sar</var>
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">line_h, lh</samp></dt>
<dd><p>the height of each text line
</p>
</dd>
<dt><samp class="option">main_h, h, H</samp></dt>
<dd><p>the input height
</p>
</dd>
<dt><samp class="option">main_w, w, W</samp></dt>
<dd><p>the input width
</p>
</dd>
<dt><samp class="option">max_glyph_a, ascent</samp></dt>
<dd><p>the maximum distance from the baseline to the highest/upper grid
coordinate used to place a glyph outline point, for all the rendered
glyphs.
It is a positive value, due to the grid’s orientation with the Y axis
upwards.
</p>
</dd>
<dt><samp class="option">max_glyph_d, descent</samp></dt>
<dd><p>the maximum distance from the baseline to the lowest grid coordinate
used to place a glyph outline point, for all the rendered glyphs.
This is a negative value, due to the grid’s orientation, with the Y axis
upwards.
</p>
</dd>
<dt><samp class="option">max_glyph_h</samp></dt>
<dd><p>maximum glyph height, that is the maximum height for all the glyphs
contained in the rendered text, it is equivalent to <var class="var">ascent</var> -
<var class="var">descent</var>.
</p>
</dd>
<dt><samp class="option">max_glyph_w</samp></dt>
<dd><p>maximum glyph width, that is the maximum width for all the glyphs
contained in the rendered text
</p>
</dd>
<dt><samp class="option">font_a</samp></dt>
<dd><p>the ascent size defined in the font metrics
</p>
</dd>
<dt><samp class="option">font_d</samp></dt>
<dd><p>the descent size defined in the font metrics
</p>
</dd>
<dt><samp class="option">top_a</samp></dt>
<dd><p>the maximum ascender of the glyphs of the first text line
</p>
</dd>
<dt><samp class="option">bottom_d</samp></dt>
<dd><p>the maximum descender of the glyphs of the last text line
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp class="option">rand(min, max)</samp></dt>
<dd><p>return a random number included between <var class="var">min</var> and <var class="var">max</var>
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt><samp class="option">text_h, th</samp></dt>
<dd><p>the height of the rendered text
</p>
</dd>
<dt><samp class="option">text_w, tw</samp></dt>
<dd><p>the width of the rendered text
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>the x and y offset coordinates where the text is drawn.
</p>
<p>These parameters allow the <var class="var">x</var> and <var class="var">y</var> expressions to refer
to each other, so you can for example specify <code class="code">y=x/dar</code>.
</p>
</dd>
<dt><samp class="option">pict_type</samp></dt>
<dd><p>A one character description of the current frame’s picture type.
</p>
</dd>
<dt><samp class="option">pkt_pos</samp></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><samp class="option">duration</samp></dt>
<dd><p>The current packet’s duration, in seconds.
</p>
</dd>
<dt><samp class="option">pkt_size</samp></dt>
<dd><p>The current packet’s size (in bytes).
</p></dd>
</dl>
<a class="anchor" id="drawtext_005fexpansion"></a></div>
<div class="subsection-level-extent" id="Text-expansion">
<h4 class="subsection">30.78.2 Text expansion</h4>
<p>If <samp class="option">expansion</samp> is set to <code class="code">strftime</code>, the filter recognizes
sequences accepted by the <code class="code">strftime</code> C function in the provided
text and expands them accordingly. Check the documentation of
<code class="code">strftime</code>. This feature is deprecated in favor of <code class="code">normal</code>
expansion with the <code class="code">gmtime</code> or <code class="code">localtime</code> expansion
functions.
</p>
<p>If <samp class="option">expansion</samp> is set to <code class="code">none</code>, the text is printed verbatim.
</p>
<p>If <samp class="option">expansion</samp> is set to <code class="code">normal</code> (which is the default),
the following expansion mechanism is used.
</p>
<p>The backslash character ‘<samp class="samp">\</samp>’, followed by any character, always expands to
the second character.
</p>
<p>Sequences of the form <code class="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 class="option">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 with the <samp class="option">textfile</samp> option avoids
these problems.
</p>
<p>The following functions are available:
</p>
<dl class="table">
<dt><code class="command">expr, e</code></dt>
<dd><p>The expression evaluation result.
</p>
<p>It must take one argument specifying the expression to be evaluated,
which accepts the same constants and functions as the <var class="var">x</var> and
<var class="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 class="var">text_w</var> and <var class="var">text_h</var> will have an undefined
value.
</p>
</dd>
<dt><code class="command">expr_int_format, eif</code></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 class="var">expr</var> function.
The second argument specifies the output format. Allowed values are ‘<samp class="samp">x</samp>’,
‘<samp class="samp">X</samp>’, ‘<samp class="samp">d</samp>’ and ‘<samp class="samp">u</samp>’. They are treated exactly as in the
<code class="code">printf</code> function.
The third parameter is optional and sets the number of positions taken by the output.
It can be used to add padding with zeros from the left.
</p>
</dd>
<dt><code class="command">gmtime</code></dt>
<dd><p>The time at which the filter is running, expressed in UTC.
It can accept an argument: a <code class="code">strftime</code> C function format string.
The format string is extended to support the variable <var class="var">%[1-6]N</var>
which prints fractions of the second with optionally specified number of digits.
</p>
</dd>
<dt><code class="command">localtime</code></dt>
<dd><p>The time at which the filter is running, expressed in the local time zone.
It can accept an argument: a <code class="code">strftime</code> C function format string.
The format string is extended to support the variable <var class="var">%[1-6]N</var>
which prints fractions of the second with optionally specified number of digits.
</p>
</dd>
<dt><code class="command">metadata</code></dt>
<dd><p>Frame metadata. Takes one or two arguments.
</p>
<p>The first argument is mandatory and specifies the metadata key.
</p>
<p>The second argument is optional and specifies a default value, used when the
metadata key is not found or empty.
</p>
<p>Available metadata can be identified by inspecting entries
starting with TAG included within each frame section
printed by running <code class="code">ffprobe -show_frames</code>.
</p>
<p>String metadata generated in filters leading to
the drawtext filter are also available.
</p>
</dd>
<dt><code class="command">n, frame_num</code></dt>
<dd><p>The frame number, starting from 0.
</p>
</dd>
<dt><code class="command">pict_type</code></dt>
<dd><p>A one character description of the current picture type.
</p>
</dd>
<dt><code class="command">pts</code></dt>
<dd><p>The timestamp of the current frame.
It can take up to three arguments.
</p>
<p>The first argument is the format of the timestamp; it defaults to <code class="code">flt</code>
for seconds as a decimal number with microsecond accuracy; <code class="code">hms</code> stands
for a formatted <var class="var">[-]HH:MM:SS.mmm</var> timestamp with millisecond accuracy.
<code class="code">gmtime</code> stands for the timestamp of the frame formatted as UTC time;
<code class="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 class="code">hms</code>, a third argument <code class="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 class="code">localtime</code> or <code class="code">gmtime</code>, a third
argument may be supplied: a <code class="code">strftime</code> C function format string.
By default, <var class="var">YYYY-MM-DD HH:MM:SS</var> format will be used.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Commands-88">
<h4 class="subsection">30.78.3 Commands</h4>
<p>This filter supports altering parameters via commands:
</p><dl class="table">
<dt><samp class="option">reinit</samp></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-preformatted">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-preformatted">sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World'
</pre></div>
<p>If the entire argument can’t be parsed or applied as valid values then the filter will
continue with its existing parameters.
</p>
</dd>
</dl>
<p>The following options are also supported as <a class="ref" href="#commands">commands</a>:
</p>
<ul class="itemize mark-bullet">
<li>x
</li><li>y
</li><li>alpha
</li><li>fontsize
</li><li>fontcolor
</li><li>boxcolor
</li><li>bordercolor
</li><li>shadowcolor
</li><li>box
</li><li>boxw
</li><li>boxh
</li><li>boxborderw
</li><li>line_spacing
</li><li>text_align
</li><li>shadowx
</li><li>shadowy
</li><li>borderw
</li></ul>
</div>
<div class="subsection-level-extent" id="Examples-86">
<h4 class="subsection">30.78.4 Examples</h4>
<ul class="itemize mark-bullet">
<li>Draw "Test Text" with font FreeSerif, using the default values for the
optional parameters.
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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 class="file">LONG_LINE</samp> is assumed to contain a single line
with no newlines.
<div class="example">
<pre class="example-preformatted">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 class="file">CREDITS</samp> off the bottom of the frame and scroll up.
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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 documentation for the
<code class="code">strftime</code> C function):
<div class="example">
<pre class="example-preformatted">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-preformatted">#!/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 class="option">max_glyph_a</samp>
and the <samp class="option">fontsize</samp> value are included in the <samp class="option">y</samp> offset.
<div class="example">
<pre class="example-preformatted">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 class="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 class="option">-export_path_metadata 1</samp> for the special metadata fields
to be available for filters.
<div class="example">
<pre class="example-preformatted">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 class="url" href="http://www.freetype.org/">http://www.freetype.org/</a>.
</p>
<p>For more information about fontconfig, check:
<a class="url" 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 class="url" href="http://fribidi.org/">http://fribidi.org/</a>.
</p>
<p>For more information about libharfbuzz, check:
<a class="url" href="https://github.com/harfbuzz/harfbuzz">https://github.com/harfbuzz/harfbuzz</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="edgedetect">
<h3 class="section">30.79 edgedetect</h3>
<p>Detect and draw edges. The filter uses the Canny Edge Detection algorithm.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">low</samp></dt>
<dt><samp class="option">high</samp></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 class="var">low</var> and <var class="var">high</var> threshold values must be chosen in the range
[0,1], and <var class="var">low</var> should be lesser or equal to <var class="var">high</var>.
</p>
<p>Default value for <var class="var">low</var> is <code class="code">20/255</code>, and default value for <var class="var">high</var>
is <code class="code">50/255</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Define the drawing mode.
</p>
<dl class="table">
<dt>‘<samp class="samp">wires</samp>’</dt>
<dd><p>Draw white/gray wires on black background.
</p>
</dd>
<dt>‘<samp class="samp">colormix</samp>’</dt>
<dd><p>Mix the colors to create a paint/cartoon effect.
</p>
</dd>
<dt>‘<samp class="samp">canny</samp>’</dt>
<dd><p>Apply Canny edge detector on all selected planes.
</p></dd>
</dl>
<p>Default value is <var class="var">wires</var>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Select planes for filtering. By default all available planes are filtered.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-87" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-87">
<h4 class="subsection">30.79.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Standard edge detection with custom values for the hysteresis thresholding:
<div class="example">
<pre class="example-preformatted">edgedetect=low=0.1:high=0.4
</pre></div>
</li><li>Painting effect without thresholding:
<div class="example">
<pre class="example-preformatted">edgedetect=mode=colormix:high=0
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="elbg">
<h3 class="section">30.80 elbg</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 class="table">
<dt><samp class="option">codebook_length, l</samp></dt>
<dd><p>Set codebook length. The value must be a positive integer, and
represents the number of distinct output colors. Default value is 256.
</p>
</dd>
<dt><samp class="option">nb_steps, n</samp></dt>
<dd><p>Set the maximum number of iterations to apply for computing the optimal
mapping. The higher the value the better the result and the higher the
computation time. Default value is 1.
</p>
</dd>
<dt><samp class="option">seed, s</samp></dt>
<dd><p>Set a random seed, must be an integer included between 0 and
UINT32_MAX. If not specified, or if explicitly set to -1, the filter
will try to use a good random seed on a best effort basis.
</p>
</dd>
<dt><samp class="option">pal8</samp></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><samp class="option">use_alpha</samp></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>
</div>
<div class="section-level-extent" id="entropy">
<h3 class="section">30.81 entropy</h3>
<p>Measure graylevel entropy in histogram of color channels of video frames.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Can be either <var class="var">normal</var> or <var class="var">diff</var>. Default is <var class="var">normal</var>.
</p>
<p><var class="var">diff</var> mode measures entropy of histogram delta values, absolute differences
between neighbour histogram values.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="epx">
<h3 class="section">30.82 epx</h3>
<p>Apply the EPX magnification filter which is designed for pixel art.
</p>
<p>It accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>Set the scaling dimension: <code class="code">2</code> for <code class="code">2xEPX</code>, <code class="code">3</code> for
<code class="code">3xEPX</code>.
Default is <code class="code">3</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="eq">
<h3 class="section">30.83 eq</h3>
<p>Set brightness, contrast, saturation and approximate gamma adjustment.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">contrast</samp></dt>
<dd><p>Set the contrast expression. The value must be a float value in range
<code class="code">-1000.0</code> to <code class="code">1000.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">brightness</samp></dt>
<dd><p>Set the brightness expression. The value must be a float value in
range <code class="code">-1.0</code> to <code class="code">1.0</code>. The default value is "0".
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set the saturation expression. The value must be a float in
range <code class="code">0.0</code> to <code class="code">3.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">gamma</samp></dt>
<dd><p>Set the gamma expression. The value must be a float in range
<code class="code">0.1</code> to <code class="code">10.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">gamma_r</samp></dt>
<dd><p>Set the gamma expression for red. The value must be a float in
range <code class="code">0.1</code> to <code class="code">10.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">gamma_g</samp></dt>
<dd><p>Set the gamma expression for green. The value must be a float in range
<code class="code">0.1</code> to <code class="code">10.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">gamma_b</samp></dt>
<dd><p>Set the gamma expression for blue. The value must be a float in range
<code class="code">0.1</code> to <code class="code">10.0</code>. The default value is "1".
</p>
</dd>
<dt><samp class="option">gamma_weight</samp></dt>
<dd><p>Set the gamma weight expression. It can be used to reduce the effect
of a high gamma value on bright image areas, e.g. keep them from
getting overamplified and just plain white. The value must be a float
in range <code class="code">0.0</code> to <code class="code">1.0</code>. A value of <code class="code">0.0</code> turns the
gamma correction all the way down while <code class="code">1.0</code> leaves it at its
full strength. Default is "1".
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set when the expressions for brightness, contrast, saturation and
gamma expressions are evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">init</samp>’.
</p></dd>
</dl>
<p>The expressions accept the following parameters:
</p><dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>frame count of the input frame starting from 0
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>byte position of the corresponding packet in the input file, NAN if
unspecified; deprecated, do not use
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-89" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-89">
<h4 class="subsection">30.83.1 Commands</h4>
<p>The filter supports the following commands:
</p>
<dl class="table">
<dt><samp class="option">contrast</samp></dt>
<dd><p>Set the contrast expression.
</p>
</dd>
<dt><samp class="option">brightness</samp></dt>
<dd><p>Set the brightness expression.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set the saturation expression.
</p>
</dd>
<dt><samp class="option">gamma</samp></dt>
<dd><p>Set the gamma expression.
</p>
</dd>
<dt><samp class="option">gamma_r</samp></dt>
<dd><p>Set the gamma_r expression.
</p>
</dd>
<dt><samp class="option">gamma_g</samp></dt>
<dd><p>Set gamma_g expression.
</p>
</dd>
<dt><samp class="option">gamma_b</samp></dt>
<dd><p>Set gamma_b expression.
</p>
</dd>
<dt><samp class="option">gamma_weight</samp></dt>
<dd><p>Set gamma_weight expression.
</p>
<p>The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p>
</dd>
</dl>
<a class="anchor" id="erosion"></a></div>
</div>
<div class="section-level-extent" id="erosion-1">
<h3 class="section">30.84 erosion</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p>
</dd>
<dt><samp class="option">coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to. Default is 255 i.e. all eight
pixels are used.
</p>
<p>Flags to local 3x3 coordinates maps like this:
</p>
<p>1 2 3
4 5
6 7 8
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-90" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-90">
<h4 class="subsection">30.84.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="estdif">
<h3 class="section">30.85 estdif</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code class="code">field</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p>
</dd>
<dt><samp class="option">rslope</samp></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><samp class="option">redge</samp></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><samp class="option">ecost</samp></dt>
<dd><p>Specify the edge cost for edge matching. Default value is 2.
Allowed range is from 0 to 50.
</p>
</dd>
<dt><samp class="option">mcost</samp></dt>
<dd><p>Specify the middle cost for edge matching. Default value is 1.
Allowed range is from 0 to 50.
</p>
</dd>
<dt><samp class="option">dcost</samp></dt>
<dd><p>Specify the distance cost for edge matching. Default value is 1.
Allowed range is from 0 to 50.
</p>
</dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Specify the interpolation used. Default is 4-point interpolation. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">2p</samp></dt>
<dd><p>Two-point interpolation.
</p></dd>
<dt><samp class="option">4p</samp></dt>
<dd><p>Four-point interpolation.
</p></dd>
<dt><samp class="option">6p</samp></dt>
<dd><p>Six-point interpolation.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-91" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-91">
<h4 class="subsection">30.85.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="exposure">
<h3 class="section">30.86 exposure</h3>
<p>Adjust exposure of the video stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">exposure</samp></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><samp class="option">black</samp></dt>
<dd><p>Set the black level correction. Allowed range is from -1.0 to 1.0.
Default value is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-92" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-92">
<h4 class="subsection">30.86.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="extractplanes">
<h3 class="section">30.87 extractplanes</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set plane(s) to extract.
</p>
<p>Available values for planes are:
</p><dl class="table">
<dt>‘<samp class="samp">y</samp>’</dt>
<dt>‘<samp class="samp">u</samp>’</dt>
<dt>‘<samp class="samp">v</samp>’</dt>
<dt>‘<samp class="samp">a</samp>’</dt>
<dt>‘<samp class="samp">r</samp>’</dt>
<dt>‘<samp class="samp">g</samp>’</dt>
<dt>‘<samp class="samp">b</samp>’</dt>
</dl>
<p>Choosing planes not available in the input will result in an error.
That means you cannot select <code class="code">r</code>, <code class="code">g</code>, <code class="code">b</code> planes
with <code class="code">y</code>, <code class="code">u</code>, <code class="code">v</code> planes at same time.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-88" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-88">
<h4 class="subsection">30.87.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Extract luma, u and v color channel component from input video frame
into 3 grayscale outputs:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="fade">
<h3 class="section">30.88 fade</h3>
<p>Apply a fade-in/out effect to the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">type, t</samp></dt>
<dd><p>The effect type can be either "in" for a fade-in, or "out" for a fade-out
effect.
Default is <code class="code">in</code>.
</p>
</dd>
<dt><samp class="option">start_frame, s</samp></dt>
<dd><p>Specify the number of the frame to start applying the fade
effect at. Default is 0.
</p>
</dd>
<dt><samp class="option">nb_frames, n</samp></dt>
<dd><p>The number of frames that the fade effect lasts. At the end of the
fade-in effect, the output video will have the same intensity as the input video.
At the end of the fade-out transition, the output video will be filled with the
selected <samp class="option">color</samp>.
Default is 25.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>If set to 1, fade only alpha channel, if one exists on the input.
Default value is 0.
</p>
</dd>
<dt><samp class="option">start_time, st</samp></dt>
<dd><p>Specify the timestamp (in seconds) of the frame to start to apply the fade
effect. If both start_frame and start_time are specified, the fade will start at
whichever comes last. Default is 0.
</p>
</dd>
<dt><samp class="option">duration, d</samp></dt>
<dd><p>The number of seconds for which the fade effect has to last. At the end of the
fade-in effect the output video will have the same intensity as the input video,
at the end of the fade-out transition the output video will be filled with the
selected <samp class="option">color</samp>.
If both duration and nb_frames are specified, duration is used. Default is 0
(nb_frames is used by default).
</p>
</dd>
<dt><samp class="option">color, c</samp></dt>
<dd><p>Specify the color of the fade. Default is "black".
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-89" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-89">
<h4 class="subsection">30.88.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Fade in the first 30 frames of video:
<div class="example">
<pre class="example-preformatted">fade=in:0:30
</pre></div>
<p>The command above is equivalent to:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">fade=t=in:st=5.5:d=0.5
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="feedback">
<h3 class="section">30.89 feedback</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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Set the top left crop position.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Set the crop size.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-90" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-90">
<h4 class="subsection">30.89.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Blur only top left rectangular part of video frame size 100x100 with gblur filter.
<div class="example">
<pre class="example-preformatted">[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-preformatted">[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>
</div>
</div>
<div class="section-level-extent" id="fftdnoiz">
<h3 class="section">30.90 fftdnoiz</h3>
<p>Denoise frames using 3D FFT (frequency domain filtering).
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sigma</samp></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><samp class="option">amount</samp></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><samp class="option">block</samp></dt>
<dd><p>Set size of block in pixels, Default is 32, can be 8 to 256.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8.
</p>
</dd>
<dt><samp class="option">method</samp></dt>
<dd><p>Set denoising method. Default is <code class="code">wiener</code>, can also be <code class="code">hard</code>.
</p>
</dd>
<dt><samp class="option">prev</samp></dt>
<dd><p>Set number of previous frames to use for denoising. By default is set to 0.
</p>
</dd>
<dt><samp class="option">next</samp></dt>
<dd><p>Set number of next frames to to use for denoising. By default is set to 0.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes which will be filtered, by default are all available filtered
except alpha.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="fftfilt">
<h3 class="section">30.91 fftfilt</h3>
<p>Apply arbitrary expressions to samples in frequency domain
</p>
<dl class="table">
<dt><samp class="option">dc_Y</samp></dt>
<dd><p>Adjust the dc value (gain) of the luma plane of the image. The filter
accepts an integer value in range <code class="code">0</code> to <code class="code">1000</code>. The default
value is set to <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">dc_U</samp></dt>
<dd><p>Adjust the dc value (gain) of the 1st chroma plane of the image. The
filter accepts an integer value in range <code class="code">0</code> to <code class="code">1000</code>. The
default value is set to <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">dc_V</samp></dt>
<dd><p>Adjust the dc value (gain) of the 2nd chroma plane of the image. The
filter accepts an integer value in range <code class="code">0</code> to <code class="code">1000</code>. The
default value is set to <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">weight_Y</samp></dt>
<dd><p>Set the frequency domain weight expression for the luma plane.
</p>
</dd>
<dt><samp class="option">weight_U</samp></dt>
<dd><p>Set the frequency domain weight expression for the 1st chroma plane.
</p>
</dd>
<dt><samp class="option">weight_V</samp></dt>
<dd><p>Set the frequency domain weight expression for the 2nd chroma plane.
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set when the expressions are evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>Only evaluate expressions once during the filter initialization.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Evaluate expressions for each incoming frame.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">init</samp>’.
</p>
<p>The filter accepts the following variables:
</p></dd>
<dt><samp class="option">X</samp></dt>
<dt><samp class="option">Y</samp></dt>
<dd><p>The coordinates of the current sample.
</p>
</dd>
<dt><samp class="option">W</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>The width and height of the image.
</p>
</dd>
<dt><samp class="option">N</samp></dt>
<dd><p>The number of input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">WS</samp></dt>
<dt><samp class="option">HS</samp></dt>
<dd><p>The size of FFT array for horizontal and vertical processing.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-91" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-91">
<h4 class="subsection">30.91.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>High-pass:
<div class="example">
<pre class="example-preformatted">fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
</pre></div>
</li><li>Low-pass:
<div class="example">
<pre class="example-preformatted">fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
</pre></div>
</li><li>Sharpen:
<div class="example">
<pre class="example-preformatted">fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
</pre></div>
</li><li>Blur:
<div class="example">
<pre class="example-preformatted">fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="field">
<h3 class="section">30.92 field</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 class="table">
<dt><samp class="option">type</samp></dt>
<dd><p>Specify whether to extract the top (if the value is <code class="code">0</code> or
<code class="code">top</code>) or the bottom field (if the value is <code class="code">1</code> or
<code class="code">bottom</code>).
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="fieldhint">
<h3 class="section">30.93 fieldhint</h3>
<p>Create new frames by copying the top and bottom fields from surrounding frames
supplied as numbers by the hint file.
</p>
<dl class="table">
<dt><samp class="option">hint</samp></dt>
<dd><p>Set file containing hints: absolute/relative frame numbers.
</p>
<p>There must be one line for each frame in a clip. Each line must contain two
numbers separated by the comma, optionally followed by <code class="code">-</code> or <code class="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 class="code">absolute</code> mode or out of [-1, 1] range
for <code class="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 class="code">+</code> output frame will be marked as interlaced,
else if followed by <code class="code">-</code> output frame will be marked as progressive, else
it will be marked same as input frame.
If optionally followed by <code class="code">t</code> output frame will use only top field, or in
case of <code class="code">b</code> it will use only bottom field.
If line starts with <code class="code">#</code> or <code class="code">;</code> that line is skipped.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Can be item <code class="code">absolute</code> or <code class="code">relative</code> or <code class="code">pattern</code>. Default is <code class="code">absolute</code>.
The <code class="code">pattern</code> mode is same as <code class="code">relative</code> mode, except at last entry of file if there
are more frames to process than <code class="code">hint</code> file is seek back to start.
</p></dd>
</dl>
<p>Example of first several lines of <code class="code">hint</code> file for <code class="code">relative</code> mode:
</p><div class="example">
<pre class="example-preformatted">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>
</div>
<div class="section-level-extent" id="fieldmatch">
<h3 class="section">30.94 fieldmatch</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 class="code">fieldmatch</code> needs to be
followed by a decimation filter such as <a class="ref" 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 class="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 class="ref" href="#yadif">yadif</a> before decimation.
</p>
<p>In addition to the various configuration options, <code class="code">fieldmatch</code> can take an
optional second stream, activated through the <samp class="option">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 class="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 class="ref" 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 class="code">dejudder,fps=30000/1001,fieldmatch,decimate</code>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">order</samp></dt>
<dd><p>Specify the assumed field order of the input stream. Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Auto detect parity (use FFmpeg’s internal parity value).
</p></dd>
<dt>‘<samp class="samp">bff</samp>’</dt>
<dd><p>Assume bottom field first.
</p></dd>
<dt>‘<samp class="samp">tff</samp>’</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 class="var">auto</var>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the matching mode or strategy to use. <samp class="option">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 class="option">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 class="option">pc</samp> and <samp class="option">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 class="ref" href="#p_002fc_002fn_002fu_002fb-meaning">p/c/n/u/b meaning</a> section.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">pc</samp>’</dt>
<dd><p>2-way matching (p/c)
</p></dd>
<dt>‘<samp class="samp">pc_n</samp>’</dt>
<dd><p>2-way matching, and trying 3rd match if still combed (p/c + n)
</p></dd>
<dt>‘<samp class="samp">pc_u</samp>’</dt>
<dd><p>2-way matching, and trying 3rd match (same order) if still combed (p/c + u)
</p></dd>
<dt>‘<samp class="samp">pc_n_ub</samp>’</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>‘<samp class="samp">pcn</samp>’</dt>
<dd><p>3-way matching (p/c/n)
</p></dd>
<dt>‘<samp class="samp">pcn_ub</samp>’</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 class="option">order</samp>=<var class="var">tff</var> (and <samp class="option">field</samp> on <var class="var">auto</var> or
<var class="var">top</var>).
</p>
<p>In terms of speed <samp class="option">pc</samp> mode is by far the fastest and <samp class="option">pcn_ub</samp> is
the slowest.
</p>
<p>Default value is <var class="var">pc_n</var>.
</p>
</dd>
<dt><samp class="option">ppsrc</samp></dt>
<dd><p>Mark the main input stream as a pre-processed input, and enable the secondary
input stream as the clean source to pick the fields from. See the filter
introduction for more details. It is similar to the <samp class="option">clip2</samp> feature from
VFM/TFM.
</p>
<p>Default value is <code class="code">0</code> (disabled).
</p>
</dd>
<dt><samp class="option">field</samp></dt>
<dd><p>Set the field to match from. It is recommended to set this to the same value as
<samp class="option">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 class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Automatic (same value as <samp class="option">order</samp>).
</p></dd>
<dt>‘<samp class="samp">bottom</samp>’</dt>
<dd><p>Match from the bottom field.
</p></dd>
<dt>‘<samp class="samp">top</samp>’</dt>
<dd><p>Match from the top field.
</p></dd>
</dl>
<p>Default value is <var class="var">auto</var>.
</p>
</dd>
<dt><samp class="option">mchroma</samp></dt>
<dd><p>Set whether or not chroma is included during the match comparisons. In most
cases it is recommended to leave this enabled. You should set this to <code class="code">0</code>
only if your clip has bad chroma problems such as heavy rainbowing or other
artifacts. Setting this to <code class="code">0</code> could also be used to speed things up at
the cost of some accuracy.
</p>
<p>Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">y0</samp></dt>
<dt><samp class="option">y1</samp></dt>
<dd><p>These define an exclusion band which excludes the lines between <samp class="option">y0</samp> and
<samp class="option">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 class="option">y0</samp> sets the starting scan line and
<samp class="option">y1</samp> sets the ending line; all lines in between <samp class="option">y0</samp> and
<samp class="option">y1</samp> (including <samp class="option">y0</samp> and <samp class="option">y1</samp>) will be ignored. Setting
<samp class="option">y0</samp> and <samp class="option">y1</samp> to the same value will disable the feature.
<samp class="option">y0</samp> and <samp class="option">y1</samp> defaults to <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">scthresh</samp></dt>
<dd><p>Set the scene change detection threshold as a percentage of maximum change on
the luma plane. Good values are in the <code class="code">[8.0, 14.0]</code> range. Scene change
detection is only relevant in case <samp class="option">combmatch</samp>=<var class="var">sc</var>. The range for
<samp class="option">scthresh</samp> is <code class="code">[0.0, 100.0]</code>.
</p>
<p>Default value is <code class="code">12.0</code>.
</p>
</dd>
<dt><samp class="option">combmatch</samp></dt>
<dd><p>When <samp class="option">combatch</samp> is not <var class="var">none</var>, <code class="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 class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No final matching based on combed scores.
</p></dd>
<dt>‘<samp class="samp">sc</samp>’</dt>
<dd><p>Combed scores are only used when a scene change is detected.
</p></dd>
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>Use combed scores all the time.
</p></dd>
</dl>
<p>Default is <var class="var">sc</var>.
</p>
</dd>
<dt><samp class="option">combdbg</samp></dt>
<dd><p>Force <code class="code">fieldmatch</code> to calculate the combed metrics for certain matches and
print them. This setting is known as <samp class="option">micout</samp> in TFM/VFM vocabulary.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No forced calculation.
</p></dd>
<dt>‘<samp class="samp">pcn</samp>’</dt>
<dd><p>Force p/c/n calculations.
</p></dd>
<dt>‘<samp class="samp">pcnub</samp>’</dt>
<dd><p>Force p/c/n/u/b calculations.
</p></dd>
</dl>
<p>Default value is <var class="var">none</var>.
</p>
</dd>
<dt><samp class="option">cthresh</samp></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 class="code">-1</code> (every pixel will be detected as combed) to <code class="code">255</code> (no pixel will
be detected as combed). This is basically a pixel difference value. A good
range is <code class="code">[8, 12]</code>.
</p>
<p>Default value is <code class="code">9</code>.
</p>
</dd>
<dt><samp class="option">chroma</samp></dt>
<dd><p>Sets whether or not chroma is considered in the combed frame decision. Only
disable this if your source has chroma problems (rainbowing, etc.) that are
causing problems for the combed frame detection with chroma enabled. Actually,
using <samp class="option">chroma</samp>=<var class="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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">blockx</samp></dt>
<dt><samp class="option">blocky</samp></dt>
<dd><p>Respectively set the x-axis and y-axis size of the window used during combed
frame detection. This has to do with the size of the area in which
<samp class="option">combpel</samp> pixels are required to be detected as combed for a frame to be
declared combed. See the <samp class="option">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 class="code">16</code>.
</p>
</dd>
<dt><samp class="option">combpel</samp></dt>
<dd><p>The number of combed pixels inside any of the <samp class="option">blocky</samp> by
<samp class="option">blockx</samp> size blocks on the frame for the frame to be detected as
combed. While <samp class="option">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 class="option">blockx</samp> and <samp class="option">blocky</samp> settings) on the
frame. Minimum value is <code class="code">0</code> and maximum is <code class="code">blocky x blockx</code> (at
which point no frames will ever be detected as combed). This setting is known
as <samp class="option">MI</samp> in TFM/VFM vocabulary.
</p>
<p>Default value is <code class="code">80</code>.
</p></dd>
</dl>
<a class="anchor" id="p_002fc_002fn_002fu_002fb-meaning"></a><ul class="mini-toc">
<li><a href="#p_002fc_002fn_002fu_002fb-meaning-1" accesskey="1">p/c/n/u/b meaning</a></li>
<li><a href="#Examples-92" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="p_002fc_002fn_002fu_002fb-meaning-1">
<h4 class="subsection">30.94.1 p/c/n/u/b meaning</h4>
<ul class="mini-toc">
<li><a href="#p_002fc_002fn" accesskey="1">p/c/n</a></li>
<li><a href="#u_002fb" accesskey="2">u/b</a></li>
</ul>
<div class="subsubsection-level-extent" id="p_002fc_002fn">
<h4 class="subsubsection">30.94.1.1 p/c/n</h4>
<p>We assume the following telecined stream:
</p>
<div class="example">
<pre class="example-preformatted">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 class="code">fieldmatch</code> is configured to run a matching from bottom
(<samp class="option">field</samp>=<var class="var">bottom</var>) this is how this input stream get transformed:
</p>
<div class="example">
<pre class="example-preformatted">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 class="ref" href="#decimate">decimate</a> filter.
</p>
<p>The same operation now matching from top fields (<samp class="option">field</samp>=<var class="var">top</var>)
looks like this:
</p>
<div class="example">
<pre class="example-preformatted">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 class="var">p</var>, <var class="var">c</var> and <var class="var">n</var> mean;
basically, they refer to the frame and field of the opposite parity:
</p>
<ul class="itemize mark-bullet">
<li><var class="var">p</var> matches the field of the opposite parity in the previous frame
</li><li><var class="var">c</var> matches the field of the opposite parity in the current frame
</li><li><var class="var">n</var> matches the field of the opposite parity in the next frame
</li></ul>
</div>
<div class="subsubsection-level-extent" id="u_002fb">
<h4 class="subsubsection">30.94.1.2 u/b</h4>
<p>The <var class="var">u</var> and <var class="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 class="option">field</samp>=<var class="var">bottom</var>):
</p><div class="example">
<pre class="example-preformatted">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 class="option">field</samp>=<var class="var">top</var>):
</p><div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="subsection-level-extent" id="Examples-92">
<h4 class="subsection">30.94.2 Examples</h4>
<p>Simple IVTC of a top field first telecined stream:
</p><div class="example">
<pre class="example-preformatted">fieldmatch=order=tff:combmatch=none, decimate
</pre></div>
<p>Advanced IVTC, with fallback on <a class="ref" href="#yadif">yadif</a> for still combed frames:
</p><div class="example">
<pre class="example-preformatted">fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
</pre></div>
</div>
</div>
<div class="section-level-extent" id="fieldorder">
<h3 class="section">30.95 fieldorder</h3>
<p>Transform the field order of the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">order</samp></dt>
<dd><p>The output field order. Valid values are <var class="var">tff</var> for top field first or <var class="var">bff</var>
for bottom field first.
</p></dd>
</dl>
<p>The default value is ‘<samp class="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-preformatted">ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
</pre></div>
</div>
<div class="section-level-extent" id="fifo_002c-afifo">
<h3 class="section">30.96 fifo, afifo</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>
</div>
<div class="section-level-extent" id="fillborders">
<h3 class="section">30.97 fillborders</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 class="table">
<dt><samp class="option">left</samp></dt>
<dd><p>Number of pixels to fill from left border.
</p>
</dd>
<dt><samp class="option">right</samp></dt>
<dd><p>Number of pixels to fill from right border.
</p>
</dd>
<dt><samp class="option">top</samp></dt>
<dd><p>Number of pixels to fill from top border.
</p>
</dd>
<dt><samp class="option">bottom</samp></dt>
<dd><p>Number of pixels to fill from bottom border.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set fill mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">smear</samp>’</dt>
<dd><p>fill pixels using outermost pixels
</p>
</dd>
<dt>‘<samp class="samp">mirror</samp>’</dt>
<dd><p>fill pixels using mirroring (half sample symmetric)
</p>
</dd>
<dt>‘<samp class="samp">fixed</samp>’</dt>
<dd><p>fill pixels with constant value
</p>
</dd>
<dt>‘<samp class="samp">reflect</samp>’</dt>
<dd><p>fill pixels using reflecting (whole sample symmetric)
</p>
</dd>
<dt>‘<samp class="samp">wrap</samp>’</dt>
<dd><p>fill pixels using wrapping
</p>
</dd>
<dt>‘<samp class="samp">fade</samp>’</dt>
<dd><p>fade pixels to constant value
</p>
</dd>
<dt>‘<samp class="samp">margins</samp>’</dt>
<dd><p>fill pixels at top and bottom with weighted averages pixels near borders
</p></dd>
</dl>
<p>Default is <var class="var">smear</var>.
</p>
</dd>
<dt><samp class="option">color</samp></dt>
<dd><p>Set color for pixels in fixed or fade mode. Default is <var class="var">black</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-93" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-93">
<h4 class="subsection">30.97.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="find_005frect">
<h3 class="section">30.98 find_rect</h3>
<p>Find a rectangular object in the input video.
</p>
<p>The object to search for must be specified as a gray8 image specified with the
<samp class="option">object</samp> option.
</p>
<p>For each possible match, a score is computed. If the score reaches the specified
threshold, the object is considered found.
</p>
<p>If the input video contains multiple instances of the object, the filter will
find only one of them.
</p>
<p>When an object is found, the following metadata entries are set in the matching
frame:
</p><dl class="table">
<dt><samp class="option">lavfi.rect.w</samp></dt>
<dd><p>width of object
</p>
</dd>
<dt><samp class="option">lavfi.rect.h</samp></dt>
<dd><p>height of object
</p>
</dd>
<dt><samp class="option">lavfi.rect.x</samp></dt>
<dd><p>x position of object
</p>
</dd>
<dt><samp class="option">lavfi.rect.y</samp></dt>
<dd><p>y position of object
</p>
</dd>
<dt><samp class="option">lavfi.rect.score</samp></dt>
<dd><p>match score of the found object
</p></dd>
</dl>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">object</samp></dt>
<dd><p>Filepath of the object image, needs to be in gray8.
</p>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>Detection threshold, expressed as a decimal number in the range 0-1.
</p>
<p>A threshold value of 0.01 means only exact matches, a threshold of 0.99 means
almost everything matches.
</p>
<p>Default value is 0.5.
</p>
</dd>
<dt><samp class="option">mipmaps</samp></dt>
<dd><p>Number of mipmaps, default is 3.
</p>
</dd>
<dt><samp class="option">xmin, ymin, xmax, ymax</samp></dt>
<dd><p>Specifies the rectangle in which to search.
</p>
</dd>
<dt><samp class="option">discard</samp></dt>
<dd><p>Discard frames where object is not detected. Default is disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-93" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-93">
<h4 class="subsection">30.98.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Cover a rectangular object by the supplied image of a given video using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
</pre></div>
</li><li>Find the position of an object in each frame using <code class="command">ffprobe</code> and write
it to a log file:
<div class="example">
<pre class="example-preformatted">ffprobe -f lavfi movie=test.mp4,find_rect=object=object.pgm:threshold=0.3 \
-show_entries frame=pkt_pts_time:frame_tags=lavfi.rect.x,lavfi.rect.y \
-of csv -o find_rect.csv
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="floodfill">
<h3 class="section">30.99 floodfill</h3>
<p>Flood area with values of same pixel components with another values.
</p>
<p>It accepts the following options:
</p><dl class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Set pixel x coordinate.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set pixel y coordinate.
</p>
</dd>
<dt><samp class="option">s0</samp></dt>
<dd><p>Set source #0 component value.
</p>
</dd>
<dt><samp class="option">s1</samp></dt>
<dd><p>Set source #1 component value.
</p>
</dd>
<dt><samp class="option">s2</samp></dt>
<dd><p>Set source #2 component value.
</p>
</dd>
<dt><samp class="option">s3</samp></dt>
<dd><p>Set source #3 component value.
</p>
</dd>
<dt><samp class="option">d0</samp></dt>
<dd><p>Set destination #0 component value.
</p>
</dd>
<dt><samp class="option">d1</samp></dt>
<dd><p>Set destination #1 component value.
</p>
</dd>
<dt><samp class="option">d2</samp></dt>
<dd><p>Set destination #2 component value.
</p>
</dd>
<dt><samp class="option">d3</samp></dt>
<dd><p>Set destination #3 component value.
</p></dd>
</dl>
<a class="anchor" id="format"></a></div>
<div class="section-level-extent" id="format-1">
<h3 class="section">30.100 format</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 class="table">
<dt><samp class="option">pix_fmts</samp></dt>
<dd><p>A ’|’-separated list of pixel format names, such as
"pix_fmts=yuv420p|monow|rgb24".
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-94" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-94">
<h4 class="subsection">30.100.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Convert the input video to the <var class="var">yuv420p</var> format
<div class="example">
<pre class="example-preformatted">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-preformatted">format=pix_fmts=yuv420p|yuv444p|yuv410p
</pre></div>
</li></ul>
<a class="anchor" id="fps"></a></div>
</div>
<div class="section-level-extent" id="fps-1">
<h3 class="section">30.101 fps</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 class="table">
<dt><samp class="option">fps</samp></dt>
<dd><p>The desired output frame rate. It accepts expressions containing the following
constants:
</p>
<dl class="table">
<dt>‘<samp class="samp">source_fps</samp>’</dt>
<dd><p>The input’s frame rate
</p>
</dd>
<dt>‘<samp class="samp">ntsc</samp>’</dt>
<dd><p>NTSC frame rate of <code class="code">30000/1001</code>
</p>
</dd>
<dt>‘<samp class="samp">pal</samp>’</dt>
<dd><p>PAL frame rate of <code class="code">25.0</code>
</p>
</dd>
<dt>‘<samp class="samp">film</samp>’</dt>
<dd><p>Film frame rate of <code class="code">24.0</code>
</p>
</dd>
<dt>‘<samp class="samp">ntsc_film</samp>’</dt>
<dd><p>NTSC-film frame rate of <code class="code">24000/1001</code>
</p></dd>
</dl>
<p>The default is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">start_time</samp></dt>
<dd><p>Assume the first PTS should be the given value, in seconds. This allows for
padding/trimming at the start of stream. By default, no assumption is made
about the first frame’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><samp class="option">round</samp></dt>
<dd><p>Timestamp (PTS) rounding method.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><samp class="option">zero</samp></dt>
<dd><p>round towards 0
</p></dd>
<dt><samp class="option">inf</samp></dt>
<dd><p>round away from 0
</p></dd>
<dt><samp class="option">down</samp></dt>
<dd><p>round towards -infinity
</p></dd>
<dt><samp class="option">up</samp></dt>
<dd><p>round towards +infinity
</p></dd>
<dt><samp class="option">near</samp></dt>
<dd><p>round to nearest
</p></dd>
</dl>
<p>The default is <code class="code">near</code>.
</p>
</dd>
<dt><samp class="option">eof_action</samp></dt>
<dd><p>Action performed when reading the last frame.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><samp class="option">round</samp></dt>
<dd><p>Use same timestamp rounding method as used for other frames.
</p></dd>
<dt><samp class="option">pass</samp></dt>
<dd><p>Pass through last frame if input duration has not been reached yet.
</p></dd>
</dl>
<p>The default is <code class="code">round</code>.
</p>
</dd>
</dl>
<p>Alternatively, the options can be specified as a flat string:
<var class="var">fps</var>[:<var class="var">start_time</var>[:<var class="var">round</var>]].
</p>
<p>See also the <a class="ref" href="#setpts">setpts</a> filter.
</p>
<ul class="mini-toc">
<li><a href="#Examples-95" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-95">
<h4 class="subsection">30.101.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>A typical usage in order to set the fps to 25:
<div class="example">
<pre class="example-preformatted">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-preformatted">fps=fps=film:round=near
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="framepack">
<h3 class="section">30.102 framepack</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 class="ref" href="#scale">scale</a> and
<a class="ref" href="#fps">fps</a> filters.
</p>
<p>It accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">format</samp></dt>
<dd><p>The desired packing format. Supported values are:
</p>
<dl class="table">
<dt><samp class="option">sbs</samp></dt>
<dd><p>The views are next to each other (default).
</p>
</dd>
<dt><samp class="option">tab</samp></dt>
<dd><p>The views are on top of each other.
</p>
</dd>
<dt><samp class="option">lines</samp></dt>
<dd><p>The views are packed by line.
</p>
</dd>
<dt><samp class="option">columns</samp></dt>
<dd><p>The views are packed by column.
</p>
</dd>
<dt><samp class="option">frameseq</samp></dt>
<dd><p>The views are temporally interleaved.
</p>
</dd>
</dl>
</dd>
</dl>
<p>Some examples:
</p>
<div class="example">
<pre class="example-preformatted"># 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>
</div>
<div class="section-level-extent" id="framerate">
<h3 class="section">30.103 framerate</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 class="table">
<dt><samp class="option">fps</samp></dt>
<dd><p>Specify the output frames per second. This option can also be specified
as a value alone. The default is <code class="code">50</code>.
</p>
</dd>
<dt><samp class="option">interp_start</samp></dt>
<dd><p>Specify the start of a range where the output frame will be created as a
linear interpolation of two frames. The range is [<code class="code">0</code>-<code class="code">255</code>],
the default is <code class="code">15</code>.
</p>
</dd>
<dt><samp class="option">interp_end</samp></dt>
<dd><p>Specify the end of a range where the output frame will be created as a
linear interpolation of two frames. The range is [<code class="code">0</code>-<code class="code">255</code>],
the default is <code class="code">240</code>.
</p>
</dd>
<dt><samp class="option">scene</samp></dt>
<dd><p>Specify the level at which a scene change is detected as a value between
0 and 100 to indicate a new scene; a low value reflects a low
probability for the current frame to introduce a new scene, while a higher
value means the current frame is more likely to be one.
The default is <code class="code">8.2</code>.
</p>
</dd>
<dt><samp class="option">flags</samp></dt>
<dd><p>Specify flags influencing the filter process.
</p>
<p>Available value for <var class="var">flags</var> is:
</p>
<dl class="table">
<dt><samp class="option">scene_change_detect, scd</samp></dt>
<dd><p>Enable scene change detection using the value of the option <var class="var">scene</var>.
This flag is enabled by default.
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="framestep">
<h3 class="section">30.104 framestep</h3>
<p>Select one frame every N-th frame.
</p>
<p>This filter accepts the following option:
</p><dl class="table">
<dt><samp class="option">step</samp></dt>
<dd><p>Select frame after every <code class="code">step</code> frames.
Allowed values are positive integers higher than 0. Default value is <code class="code">1</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="freezedetect">
<h3 class="section">30.105 freezedetect</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 class="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 class="code">lavfi.freezedetect.freeze_duration</code> and
<code class="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 class="table">
<dt><samp class="option">noise, n</samp></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><samp class="option">duration, d</samp></dt>
<dd><p>Set freeze duration until notification (default is 2 seconds).
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="freezeframes">
<h3 class="section">30.106 freezeframes</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 class="table">
<dt><samp class="option">first</samp></dt>
<dd><p>Set number of first frame from which to start freeze.
</p>
</dd>
<dt><samp class="option">last</samp></dt>
<dd><p>Set number of last frame from which to end freeze.
</p>
</dd>
<dt><samp class="option">replace</samp></dt>
<dd><p>Set number of frame from 2nd input which will be used instead of replaced frames.
</p></dd>
</dl>
<a class="anchor" id="frei0r"></a></div>
<div class="section-level-extent" id="frei0r-1">
<h3 class="section">30.107 frei0r</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 class="code">--enable-frei0r</code>.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">filter_name</samp></dt>
<dd><p>The name of the frei0r effect to load. If the environment variable
<code class="env">FREI0R_PATH</code> is defined, the frei0r effect is searched for in each of the
directories specified by the colon-separated list in <code class="env">FREI0R_PATH</code>.
Otherwise, the standard frei0r paths are searched, in this order:
<samp class="file">HOME/.frei0r-1/lib/</samp>, <samp class="file">/usr/local/lib/frei0r-1/</samp>,
<samp class="file">/usr/lib/frei0r-1/</samp>.
</p>
</dd>
<dt><samp class="option">filter_params</samp></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 class="var">R</var>/<var class="var">G</var>/<var class="var">B</var>, where <var class="var">R</var>, <var class="var">G</var>, and <var class="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 class="var">X</var>/<var class="var">Y</var>, where
<var class="var">X</var> and <var class="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>
<ul class="mini-toc">
<li><a href="#Examples-96" accesskey="1">Examples</a></li>
<li><a href="#Commands-94" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-96">
<h4 class="subsection">30.107.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply the distort0r effect, setting the first two double parameters:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">frei0r=perspective:0.2/0.2|0.8/0.2
</pre></div>
</li></ul>
<p>For more information, see
<a class="url" href="http://frei0r.dyne.org">http://frei0r.dyne.org</a>
</p>
</div>
<div class="subsection-level-extent" id="Commands-94">
<h4 class="subsection">30.107.2 Commands</h4>
<p>This filter supports the <samp class="option">filter_params</samp> option as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="fspp">
<h3 class="section">30.108 fspp</h3>
<p>Apply fast and simple postprocessing. It is a faster version of <a class="ref" 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 class="table">
<dt><samp class="option">quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 4-5. Default value is <code class="code">4</code>.
</p>
</dd>
<dt><samp class="option">qp</samp></dt>
<dd><p>Force a constant quantization parameter. It accepts an integer in range 0-63.
If not set, the filter will use the QP from the video stream (if available).
</p>
</dd>
<dt><samp class="option">strength</samp></dt>
<dd><p>Set filter strength. It accepts an integer in range -15 to 32. Lower values mean
more details but also more artifacts, while higher values make the image smoother
but also blurrier. Default value is <code class="code">0</code> − PSNR optimal.
</p>
</dd>
<dt><samp class="option">use_bframe_qp</samp></dt>
<dd><p>Enable the use of the QP from the B-Frames if set to <code class="code">1</code>. Using this
option may cause flicker since the B-Frames have often larger QP. Default is
<code class="code">0</code> (not enabled).
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="gblur">
<h3 class="section">30.109 gblur</h3>
<p>Apply Gaussian blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sigma</samp></dt>
<dd><p>Set horizontal sigma, standard deviation of Gaussian blur. Default is <code class="code">0.5</code>.
</p>
</dd>
<dt><samp class="option">steps</samp></dt>
<dd><p>Set number of steps for Gaussian approximation. Default is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p>
</dd>
<dt><samp class="option">sigmaV</samp></dt>
<dd><p>Set vertical sigma, if negative it will be same as <code class="code">sigma</code>.
Default is <code class="code">-1</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-95" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-95">
<h4 class="subsection">30.109.1 Commands</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>
</div>
</div>
<div class="section-level-extent" id="geq">
<h3 class="section">30.110 geq</h3>
<p>Apply generic equation to each pixel.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">lum_expr, lum</samp></dt>
<dd><p>Set the luma expression.
</p></dd>
<dt><samp class="option">cb_expr, cb</samp></dt>
<dd><p>Set the chrominance blue expression.
</p></dd>
<dt><samp class="option">cr_expr, cr</samp></dt>
<dd><p>Set the chrominance red expression.
</p></dd>
<dt><samp class="option">alpha_expr, a</samp></dt>
<dd><p>Set the alpha expression.
</p></dd>
<dt><samp class="option">red_expr, r</samp></dt>
<dd><p>Set the red expression.
</p></dd>
<dt><samp class="option">green_expr, g</samp></dt>
<dd><p>Set the green expression.
</p></dd>
<dt><samp class="option">blue_expr, b</samp></dt>
<dd><p>Set the blue expression.
</p></dd>
</dl>
<p>The colorspace is selected according to the specified options. If one
of the <samp class="option">lum_expr</samp>, <samp class="option">cb_expr</samp>, or <samp class="option">cr_expr</samp>
options is specified, the filter will automatically select a YCbCr
colorspace. If one of the <samp class="option">red_expr</samp>, <samp class="option">green_expr</samp>, or
<samp class="option">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 luma expression.
</p>
<p>The expressions can use the following variables and functions:
</p>
<dl class="table">
<dt><samp class="option">N</samp></dt>
<dd><p>The sequential number of the filtered frame, starting from <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">X</samp></dt>
<dt><samp class="option">Y</samp></dt>
<dd><p>The coordinates of the current sample.
</p>
</dd>
<dt><samp class="option">W</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>The width and height of the image.
</p>
</dd>
<dt><samp class="option">SW</samp></dt>
<dt><samp class="option">SH</samp></dt>
<dd><p>Width and height scale depending on the currently filtered plane. It is the
ratio between the corresponding luma plane number of pixels and the current
plane ones. E.g. for YUV4:2:0 the values are <code class="code">1,1</code> for the luma plane, and
<code class="code">0.5,0.5</code> for chroma planes.
</p>
</dd>
<dt><samp class="option">T</samp></dt>
<dd><p>Time of the current frame, expressed in seconds.
</p>
</dd>
<dt><samp class="option">p(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the current
plane.
</p>
</dd>
<dt><samp class="option">lum(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the luma
plane.
</p>
</dd>
<dt><samp class="option">cb(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the
blue-difference chroma plane. Return 0 if there is no such plane.
</p>
</dd>
<dt><samp class="option">cr(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the
red-difference chroma plane. Return 0 if there is no such plane.
</p>
</dd>
<dt><samp class="option">r(x, y)</samp></dt>
<dt><samp class="option">g(x, y)</samp></dt>
<dt><samp class="option">b(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the
red/green/blue component. Return 0 if there is no such component.
</p>
</dd>
<dt><samp class="option">alpha(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the alpha
plane. Return 0 if there is no such plane.
</p>
</dd>
<dt><samp class="option">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></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><samp class="option">interpolation</samp></dt>
<dd><p>Set one of interpolation methods:
</p><dl class="table">
<dt><samp class="option">nearest, n</samp></dt>
<dt><samp class="option">bilinear, b</samp></dt>
</dl>
<p>Default is bilinear.
</p></dd>
</dl>
<p>For functions, if <var class="var">x</var> and <var class="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>
<ul class="mini-toc">
<li><a href="#Examples-97" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-97">
<h4 class="subsection">30.110.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Flip the image horizontally:
<div class="example">
<pre class="example-preformatted">geq=p(W-X\,Y)
</pre></div>
</li><li>Generate a bidimensional sine wave, with angle <code class="code">PI/3</code> and a
wavelength of 100 pixels:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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 class="ref" href="#vignette">vignette</a> filter):
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="gradfun">
<h3 class="section">30.111 gradfun</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 class="table">
<dt><samp class="option">strength</samp></dt>
<dd><p>The maximum amount by which the filter will change any one pixel. This is also
the threshold for detecting nearly flat regions. Acceptable values range from
.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the
valid range.
</p>
</dd>
<dt><samp class="option">radius</samp></dt>
<dd><p>The neighborhood to fit the gradient to. A larger radius makes for smoother
gradients, but also prevents the filter from modifying the pixels near detailed
regions. Acceptable values are 8-32; the default value is 16. Out-of-range
values will be clipped to the valid range.
</p>
</dd>
</dl>
<p>Alternatively, the options can be specified as a flat string:
<var class="var">strength</var>[:<var class="var">radius</var>]
</p>
<ul class="mini-toc">
<li><a href="#Examples-98" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-98">
<h4 class="subsection">30.111.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply the filter with a <code class="code">3.5</code> strength and radius of <code class="code">8</code>:
<div class="example">
<pre class="example-preformatted">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-preformatted">gradfun=radius=8
</pre></div>
</li></ul>
<a class="anchor" id="graphmonitor"></a></div>
</div>
<div class="section-level-extent" id="graphmonitor-1">
<h3 class="section">30.112 graphmonitor</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 class="table">
<dt><samp class="option">size, s</samp></dt>
<dd><p>Set video output size. Default is <var class="var">hd720</var>.
</p>
</dd>
<dt><samp class="option">opacity, o</samp></dt>
<dd><p>Set video opacity. Default is <var class="var">0.9</var>. Allowed range is from <var class="var">0</var> to <var class="var">1</var>.
</p>
</dd>
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set output mode flags.
</p>
<p>Available values for flags are:
</p><dl class="table">
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>No any filtering. Default.
</p></dd>
<dt>‘<samp class="samp">compact</samp>’</dt>
<dd><p>Show only filters with queued frames.
</p></dd>
<dt>‘<samp class="samp">nozero</samp>’</dt>
<dd><p>Show only filters with non-zero stats.
</p></dd>
<dt>‘<samp class="samp">noeof</samp>’</dt>
<dd><p>Show only filters with non-eof stat.
</p></dd>
<dt>‘<samp class="samp">nodisabled</samp>’</dt>
<dd><p>Show only filters that are enabled in timeline.
</p></dd>
</dl>
</dd>
<dt><samp class="option">flags, f</samp></dt>
<dd><p>Set flags which enable which stats are shown in video.
</p>
<p>Available values for flags are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>All flags turned off.
</p>
</dd>
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>All flags turned on.
</p>
</dd>
<dt>‘<samp class="samp">queue</samp>’</dt>
<dd><p>Display number of queued frames in each link.
</p>
</dd>
<dt>‘<samp class="samp">frame_count_in</samp>’</dt>
<dd><p>Display number of frames taken from filter.
</p>
</dd>
<dt>‘<samp class="samp">frame_count_out</samp>’</dt>
<dd><p>Display number of frames given out from filter.
</p>
</dd>
<dt>‘<samp class="samp">frame_count_delta</samp>’</dt>
<dd><p>Display delta number of frames between above two values.
</p>
</dd>
<dt>‘<samp class="samp">pts</samp>’</dt>
<dd><p>Display current filtered frame pts.
</p>
</dd>
<dt>‘<samp class="samp">pts_delta</samp>’</dt>
<dd><p>Display pts delta between current and previous frame.
</p>
</dd>
<dt>‘<samp class="samp">time</samp>’</dt>
<dd><p>Display current filtered frame time.
</p>
</dd>
<dt>‘<samp class="samp">time_delta</samp>’</dt>
<dd><p>Display time delta between current and previous frame.
</p>
</dd>
<dt>‘<samp class="samp">timebase</samp>’</dt>
<dd><p>Display time base for filter link.
</p>
</dd>
<dt>‘<samp class="samp">format</samp>’</dt>
<dd><p>Display used format for filter link.
</p>
</dd>
<dt>‘<samp class="samp">size</samp>’</dt>
<dd><p>Display video size or number of audio channels in case of audio used by filter link.
</p>
</dd>
<dt>‘<samp class="samp">rate</samp>’</dt>
<dd><p>Display video frame rate or sample rate in case of audio used by filter link.
</p>
</dd>
<dt>‘<samp class="samp">eof</samp>’</dt>
<dd><p>Display link output status.
</p>
</dd>
<dt>‘<samp class="samp">sample_count_in</samp>’</dt>
<dd><p>Display number of samples taken from filter.
</p>
</dd>
<dt>‘<samp class="samp">sample_count_out</samp>’</dt>
<dd><p>Display number of samples given out from filter.
</p>
</dd>
<dt>‘<samp class="samp">sample_count_delta</samp>’</dt>
<dd><p>Display delta number of samples between above two values.
</p>
</dd>
<dt>‘<samp class="samp">disabled</samp>’</dt>
<dd><p>Show the timeline filter status.
</p></dd>
</dl>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set upper limit for video rate of output stream, Default value is <var class="var">25</var>.
This guarantee that output video frame rate will not be higher than this value.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="grayworld">
<h3 class="section">30.113 grayworld</h3>
<p>A color constancy filter that applies color correction based on the grayworld assumption
</p>
<p>See: <a class="url" 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-preformatted">ffmpeg -i INPUT -vf zscale=transfer=linear,grayworld,zscale=transfer=bt709,format=yuv420p OUTPUT
</pre></div>
</div>
<div class="section-level-extent" id="greyedge">
<h3 class="section">30.114 greyedge</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 class="url" 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 class="table">
<dt><samp class="option">difford</samp></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><samp class="option">minknorm</samp></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><samp class="option">sigma</samp></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 class="var">sigma</var> * break_off_sigma(3) )
can’t be equal to 0 if <var class="var">difford</var> is greater than 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-99" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-99">
<h4 class="subsection">30.114.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Grey Edge:
<div class="example">
<pre class="example-preformatted">greyedge=difford=1:minknorm=5:sigma=2
</pre></div>
</li><li>Max Edge:
<div class="example">
<pre class="example-preformatted">greyedge=difford=1:minknorm=0:sigma=2
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="guided">
<h3 class="section">30.115 guided</h3>
<p>Apply guided filter for edge-preserving smoothing, dehazing and so on.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">radius</samp></dt>
<dd><p>Set the box radius in pixels.
Allowed range is 1 to 20. Default is 3.
</p>
</dd>
<dt><samp class="option">eps</samp></dt>
<dd><p>Set regularization parameter (with square).
Allowed range is 0 to 1. Default is 0.01.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set filter mode. Can be <code class="code">basic</code> or <code class="code">fast</code>.
Default is <code class="code">basic</code>.
</p>
</dd>
<dt><samp class="option">sub</samp></dt>
<dd><p>Set subsampling ratio for <code class="code">fast</code> mode.
Range is 2 to 64. Default is 4.
No subsampling occurs in <code class="code">basic</code> mode.
</p>
</dd>
<dt><samp class="option">guidance</samp></dt>
<dd><p>Set guidance mode. Can be <code class="code">off</code> or <code class="code">on</code>. Default is <code class="code">off</code>.
If <code class="code">off</code>, single input is required.
If <code class="code">on</code>, two inputs of the same resolution and pixel format are required.
The second input serves as the guidance.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter. Default is first only.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-96" accesskey="1">Commands</a></li>
<li><a href="#Examples-100" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-96">
<h4 class="subsection">30.115.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-100">
<h4 class="subsection">30.115.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Edge-preserving smoothing with guided filter:
<div class="example">
<pre class="example-preformatted">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 class="url" href="http://kaiminghe.com/publications/pami12guidedfilter.pdf">http://kaiminghe.com/publications/pami12guidedfilter.pdf</a>.
<div class="example">
<pre class="example-preformatted">ffmpeg -i in.png -i guidance.png -filter_complex guided=guidance=on out.png
</pre></div>
</li></ul>
<a class="anchor" id="haldclut"></a></div>
</div>
<div class="section-level-extent" id="haldclut-1">
<h3 class="section">30.116 haldclut</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 class="table">
<dt><samp class="option">clut</samp></dt>
<dd><p>Set which CLUT video frames will be processed from second input stream,
can be <var class="var">first</var> or <var class="var">all</var>. Default is <var class="var">all</var>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>Force termination when the shortest input terminates. Default is <code class="code">0</code>.
</p></dd>
<dt><samp class="option">repeatlast</samp></dt>
<dd><p>Continue applying the last CLUT after the end of the stream. A value of
<code class="code">0</code> disable the filter after the last frame of the CLUT is reached.
Default is <code class="code">1</code>.
</p></dd>
</dl>
<p><code class="code">haldclut</code> also has the same interpolation options as <a class="ref" href="#lut3d">lut3d</a> (both
filters share the same internals).
</p>
<p>This filter also supports the <a class="ref" 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 class="url" href="http://www.quelsolaar.com/technology/clut.html">http://www.quelsolaar.com/technology/clut.html</a>.
</p>
<ul class="mini-toc">
<li><a href="#Commands-97" accesskey="1">Commands</a></li>
<li><a href="#Workflow-examples" accesskey="2">Workflow examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-97">
<h4 class="subsection">30.116.1 Commands</h4>
<p>This filter supports the <code class="code">interp</code> option as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Workflow-examples">
<h4 class="subsection">30.116.2 Workflow examples</h4>
<ul class="mini-toc">
<li><a href="#Hald-CLUT-video-stream" accesskey="1">Hald CLUT video stream</a></li>
<li><a href="#Hald-CLUT-with-preview" accesskey="2">Hald CLUT with preview</a></li>
</ul>
<div class="subsubsection-level-extent" id="Hald-CLUT-video-stream">
<h4 class="subsubsection">30.116.2.1 Hald CLUT video stream</h4>
<p>Generate an identity Hald CLUT stream altered with various effects:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -f lavfi -i <a class="ref" 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 class="code">haldclut</code> to apply it on some random stream:
</p><div class="example">
<pre class="example-preformatted">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 class="file">clut.nut</samp>), then the latest picture of that CLUT stream will be applied
to the remaining frames of the <code class="code">mandelbrot</code> stream.
</p>
</div>
<div class="subsubsection-level-extent" id="Hald-CLUT-with-preview">
<h4 class="subsubsection">30.116.2.2 Hald CLUT with preview</h4>
<p>A Hald CLUT is supposed to be a squared image of <code class="code">Level*Level*Level</code> by
<code class="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 class="code">haldclut</code> filter:
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -f lavfi -i <a class="ref" 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-preformatted">ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
</pre></div>
</div>
</div>
</div>
<div class="section-level-extent" id="hflip">
<h3 class="section">30.117 hflip</h3>
<p>Flip the input video horizontally.
</p>
<p>For example, to horizontally flip the input video with <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i in.avi -vf "hflip" out.avi
</pre></div>
</div>
<div class="section-level-extent" id="histeq">
<h3 class="section">30.118 histeq</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 class="table">
<dt><samp class="option">strength</samp></dt>
<dd><p>Determine the amount of equalization to be applied. As the strength
is reduced, the distribution of pixel intensities more-and-more
approaches that of the input frame. The value must be a float number
in the range [0,1] and defaults to 0.200.
</p>
</dd>
<dt><samp class="option">intensity</samp></dt>
<dd><p>Set the maximum intensity that can generated and scale the output
values appropriately. The strength should be set as desired and then
the intensity can be limited if needed to avoid washing-out. The value
must be a float number in the range [0,1] and defaults to 0.210.
</p>
</dd>
<dt><samp class="option">antibanding</samp></dt>
<dd><p>Set the antibanding level. If enabled the filter will randomly vary
the luminance of output pixels by a small amount to avoid banding of
the histogram. Possible values are <code class="code">none</code>, <code class="code">weak</code> or
<code class="code">strong</code>. It defaults to <code class="code">none</code>.
</p></dd>
</dl>
<a class="anchor" id="histogram"></a></div>
<div class="section-level-extent" id="histogram-1">
<h3 class="section">30.119 histogram</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 class="table">
<dt><samp class="option">level_height</samp></dt>
<dd><p>Set height of level. Default value is <code class="code">200</code>.
Allowed range is [50, 2048].
</p>
</dd>
<dt><samp class="option">scale_height</samp></dt>
<dd><p>Set height of color scale. Default value is <code class="code">12</code>.
Allowed range is [0, 40].
</p>
</dd>
<dt><samp class="option">display_mode</samp></dt>
<dd><p>Set display mode.
It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">stack</samp>’</dt>
<dd><p>Per color component graphs are placed below each other.
</p>
</dd>
<dt>‘<samp class="samp">parade</samp>’</dt>
<dd><p>Per color component graphs are placed side by side.
</p>
</dd>
<dt>‘<samp class="samp">overlay</samp>’</dt>
<dd><p>Presents information identical to that in the <code class="code">parade</code>, except
that the graphs representing color components are superimposed directly
over one another.
</p></dd>
</dl>
<p>Default is <code class="code">stack</code>.
</p>
</dd>
<dt><samp class="option">levels_mode</samp></dt>
<dd><p>Set mode. Can be either <code class="code">linear</code>, or <code class="code">logarithmic</code>.
Default is <code class="code">linear</code>.
</p>
</dd>
<dt><samp class="option">components</samp></dt>
<dd><p>Set what color components to display.
Default is <code class="code">7</code>.
</p>
</dd>
<dt><samp class="option">fgopacity</samp></dt>
<dd><p>Set foreground opacity. Default is <code class="code">0.7</code>.
</p>
</dd>
<dt><samp class="option">bgopacity</samp></dt>
<dd><p>Set background opacity. Default is <code class="code">0.5</code>.
</p>
</dd>
<dt><samp class="option">colors_mode</samp></dt>
<dd><p>Set colors mode.
It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">whiteonblack</samp>’</dt>
<dt>‘<samp class="samp">blackonwhite</samp>’</dt>
<dt>‘<samp class="samp">whiteongray</samp>’</dt>
<dt>‘<samp class="samp">blackongray</samp>’</dt>
<dt>‘<samp class="samp">coloronblack</samp>’</dt>
<dt>‘<samp class="samp">coloronwhite</samp>’</dt>
<dt>‘<samp class="samp">colorongray</samp>’</dt>
<dt>‘<samp class="samp">blackoncolor</samp>’</dt>
<dt>‘<samp class="samp">whiteoncolor</samp>’</dt>
<dt>‘<samp class="samp">grayoncolor</samp>’</dt>
</dl>
<p>Default is <code class="code">whiteonblack</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-101" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-101">
<h4 class="subsection">30.119.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Calculate and draw histogram:
<div class="example">
<pre class="example-preformatted">ffplay -i input -vf histogram
</pre></div>
</li></ul>
<a class="anchor" id="hqdn3d"></a></div>
</div>
<div class="section-level-extent" id="hqdn3d-1">
<h3 class="section">30.120 hqdn3d</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 class="table">
<dt><samp class="option">luma_spatial</samp></dt>
<dd><p>A non-negative floating point number which specifies spatial luma strength.
It defaults to 4.0.
</p>
</dd>
<dt><samp class="option">chroma_spatial</samp></dt>
<dd><p>A non-negative floating point number which specifies spatial chroma strength.
It defaults to 3.0*<var class="var">luma_spatial</var>/4.0.
</p>
</dd>
<dt><samp class="option">luma_tmp</samp></dt>
<dd><p>A floating point number which specifies luma temporal strength. It defaults to
6.0*<var class="var">luma_spatial</var>/4.0.
</p>
</dd>
<dt><samp class="option">chroma_tmp</samp></dt>
<dd><p>A floating point number which specifies chroma temporal strength. It defaults to
<var class="var">luma_tmp</var>*<var class="var">chroma_spatial</var>/<var class="var">luma_spatial</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-98" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-98">
<h4 class="subsection">30.120.1 Commands</h4>
<p>This filter supports same <a class="ref" 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 class="anchor" id="hwdownload"></a></div>
</div>
<div class="section-level-extent" id="hwdownload-1">
<h3 class="section">30.121 hwdownload</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 class="option">format</samp> filter immediately following in the graph to get
the output in a supported format.
</p>
</div>
<div class="section-level-extent" id="hwmap">
<h3 class="section">30.122 hwmap</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 class="itemize mark-bullet">
<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 class="option">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 class="option">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 class="option">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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the frame mapping mode. Some combination of:
</p><dl class="table">
<dt><var class="var">read</var></dt>
<dd><p>The mapped frame should be readable.
</p></dd>
<dt><var class="var">write</var></dt>
<dd><p>The mapped frame should be writeable.
</p></dd>
<dt><var class="var">overwrite</var></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><var class="var">direct</var></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 class="var">read+write</var> if not specified.
</p>
</dd>
<dt><samp class="option">derive_device <var class="var">type</var></samp></dt>
<dd><p>Rather than using the device supplied at initialisation, instead derive a new
device of type <var class="var">type</var> from the device the input frames exist on.
</p>
</dd>
<dt><samp class="option">reverse</samp></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>
<a class="anchor" id="hwupload"></a></div>
<div class="section-level-extent" id="hwupload-1">
<h3 class="section">30.123 hwupload</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 class="option">-filter_hw_device</samp>
option or with the <samp class="option">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 class="table">
<dt><samp class="option">derive_device <var class="var">type</var></samp></dt>
<dd><p>Rather than using the device supplied at initialisation, instead derive a new
device of type <var class="var">type</var> from the device the input frames exist on.
</p></dd>
</dl>
<a class="anchor" id="hwupload_005fcuda"></a></div>
<div class="section-level-extent" id="hwupload_005fcuda-1">
<h3 class="section">30.124 hwupload_cuda</h3>
<p>Upload system memory frames to a CUDA device.
</p>
<p>It accepts the following optional parameters:
</p>
<dl class="table">
<dt><samp class="option">device</samp></dt>
<dd><p>The number of the CUDA device to use
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="hqx">
<h3 class="section">30.125 hqx</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 class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>Set the scaling dimension: <code class="code">2</code> for <code class="code">hq2x</code>, <code class="code">3</code> for
<code class="code">hq3x</code> and <code class="code">4</code> for <code class="code">hq4x</code>.
Default is <code class="code">3</code>.
</p></dd>
</dl>
<a class="anchor" id="hstack"></a></div>
<div class="section-level-extent" id="hstack-1">
<h3 class="section">30.126 hstack</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 class="ref" href="#overlay">overlay</a> and <a class="ref" href="#pad">pad</a> filter
to create same output.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set number of input streams. Default is 2.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="hsvhold">
<h3 class="section">30.127 hsvhold</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 class="table">
<dt><samp class="option">hue</samp></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><samp class="option">sat</samp></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><samp class="option">val</samp></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><samp class="option">similarity</samp></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><samp class="option">blend</samp></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>
</div>
<div class="section-level-extent" id="hsvkey">
<h3 class="section">30.128 hsvkey</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 class="table">
<dt><samp class="option">hue</samp></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><samp class="option">sat</samp></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><samp class="option">val</samp></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><samp class="option">similarity</samp></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><samp class="option">blend</samp></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>
</div>
<div class="section-level-extent" id="hue">
<h3 class="section">30.129 hue</h3>
<p>Modify the hue and/or the saturation of the input.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">h</samp></dt>
<dd><p>Specify the hue angle as a number of degrees. It accepts an expression,
and defaults to "0".
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>Specify the saturation in the [-10,10] range. It accepts an expression and
defaults to "1".
</p>
</dd>
<dt><samp class="option">H</samp></dt>
<dd><p>Specify the hue angle as a number of radians. It accepts an
expression, and defaults to "0".
</p>
</dd>
<dt><samp class="option">b</samp></dt>
<dd><p>Specify the brightness in the [-10,10] range. It accepts an expression and
defaults to "0".
</p></dd>
</dl>
<p><samp class="option">h</samp> and <samp class="option">H</samp> are mutually exclusive, and can’t be
specified at the same time.
</p>
<p>The <samp class="option">b</samp>, <samp class="option">h</samp>, <samp class="option">H</samp> and <samp class="option">s</samp> option values are
expressions containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>frame count of the input frame starting from 0
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>presentation timestamp of the input frame expressed in time base units
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>timestamp expressed in seconds, NAN if the input timestamp is unknown
</p>
</dd>
<dt><samp class="option">tb</samp></dt>
<dd><p>time base of the input video
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-102" accesskey="1">Examples</a></li>
<li><a href="#Commands-99" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-102">
<h4 class="subsection">30.129.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Set the hue to 90 degrees and the saturation to 1.0:
<div class="example">
<pre class="example-preformatted">hue=h=90:s=1
</pre></div>
</li><li>Same command but expressing the hue in radians:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-99">
<h4 class="subsection">30.129.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">b</samp></dt>
<dt><samp class="option">s</samp></dt>
<dt><samp class="option">h</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>Modify the hue and/or the saturation and/or brightness of the input video.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="huesaturation">
<h3 class="section">30.130 huesaturation</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 class="table">
<dt><samp class="option">hue</samp></dt>
<dd><p>Set the hue shift in degrees to apply. Default is 0.
Allowed range is from -180 to 180.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set the saturation shift. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">intensity</samp></dt>
<dd><p>Set the intensity shift. Default is 0.
Allowed range is from -1 to 1.
</p>
</dd>
<dt><samp class="option">colors</samp></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 class="table">
<dt>‘<samp class="samp">r</samp>’</dt>
<dd><p>Adjust reds.
</p></dd>
<dt>‘<samp class="samp">y</samp>’</dt>
<dd><p>Adjust yellows.
</p></dd>
<dt>‘<samp class="samp">g</samp>’</dt>
<dd><p>Adjust greens.
</p></dd>
<dt>‘<samp class="samp">c</samp>’</dt>
<dd><p>Adjust cyans.
</p></dd>
<dt>‘<samp class="samp">b</samp>’</dt>
<dd><p>Adjust blues.
</p></dd>
<dt>‘<samp class="samp">m</samp>’</dt>
<dd><p>Adjust magentas.
</p></dd>
<dt>‘<samp class="samp">a</samp>’</dt>
<dd><p>Adjust all colors.
</p></dd>
</dl>
</dd>
<dt><samp class="option">strength</samp></dt>
<dd><p>Set strength of filtering. Allowed range is from 0 to 100.
Default value is 1.
</p>
</dd>
<dt><samp class="option">rw, gw, bw</samp></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><samp class="option">lightness</samp></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>
</div>
<div class="section-level-extent" id="hysteresis">
<h3 class="section">30.131 hysteresis</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">threshold</samp></dt>
<dd><p>Set threshold which is used in filtering. If pixel component value is higher than
this value filter algorithm for connecting components is activated.
By default value is 0.
</p></dd>
</dl>
<p>The <code class="code">hysteresis</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
</div>
<div class="section-level-extent" id="iccdetect">
<h3 class="section">30.132 iccdetect</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 class="table">
<dt><samp class="option">force</samp></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 class="code">unknown</code>. Enabled by default.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="iccgen">
<h3 class="section">30.133 iccgen</h3>
<p>Generate ICC profiles and attach them to frames.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">color_primaries</samp></dt>
<dt><samp class="option">color_trc</samp></dt>
<dd><p>Configure the colorspace that the ICC profile will be generated for. The
default value of <code class="code">auto</code> infers the value from the input frame’s metadata,
defaulting to BT.709/sRGB as appropriate.
</p>
<p>See the <a class="ref" href="#setparams">setparams</a> filter for a list of possible values, but note that
<code class="code">unknown</code> are not valid values for this filter.
</p>
</dd>
<dt><samp class="option">force</samp></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>
</div>
<div class="section-level-extent" id="identity">
<h3 class="section">30.134 identity</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>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<p>In the below example the input file <samp class="file">main.mpg</samp> being processed is compared
with the reference file <samp class="file">ref.mpg</samp>.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i main.mpg -i ref.mpg -lavfi identity -f null -
</pre></div>
</div>
<div class="section-level-extent" id="idet">
<h3 class="section">30.135 idet</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 class="table">
<dt><samp class="option">single.current_frame</samp></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><samp class="option">single.tff</samp></dt>
<dd><p>Cumulative number of frames detected as top field first using single-frame detection.
</p>
</dd>
<dt><samp class="option">multiple.tff</samp></dt>
<dd><p>Cumulative number of frames detected as top field first using multiple-frame detection.
</p>
</dd>
<dt><samp class="option">single.bff</samp></dt>
<dd><p>Cumulative number of frames detected as bottom field first using single-frame detection.
</p>
</dd>
<dt><samp class="option">multiple.current_frame</samp></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><samp class="option">multiple.bff</samp></dt>
<dd><p>Cumulative number of frames detected as bottom field first using multiple-frame detection.
</p>
</dd>
<dt><samp class="option">single.progressive</samp></dt>
<dd><p>Cumulative number of frames detected as progressive using single-frame detection.
</p>
</dd>
<dt><samp class="option">multiple.progressive</samp></dt>
<dd><p>Cumulative number of frames detected as progressive using multiple-frame detection.
</p>
</dd>
<dt><samp class="option">single.undetermined</samp></dt>
<dd><p>Cumulative number of frames that could not be classified using single-frame detection.
</p>
</dd>
<dt><samp class="option">multiple.undetermined</samp></dt>
<dd><p>Cumulative number of frames that could not be classified using multiple-frame detection.
</p>
</dd>
<dt><samp class="option">repeated.current_frame</samp></dt>
<dd><p>Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”.
</p>
</dd>
<dt><samp class="option">repeated.neither</samp></dt>
<dd><p>Cumulative number of frames with no repeated field.
</p>
</dd>
<dt><samp class="option">repeated.top</samp></dt>
<dd><p>Cumulative number of frames with the top field repeated from the previous frame’s top field.
</p>
</dd>
<dt><samp class="option">repeated.bottom</samp></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 class="table">
<dt><samp class="option">intl_thres</samp></dt>
<dd><p>Set interlacing threshold.
</p></dd>
<dt><samp class="option">prog_thres</samp></dt>
<dd><p>Set progressive threshold.
</p></dd>
<dt><samp class="option">rep_thres</samp></dt>
<dd><p>Threshold for repeated field detection.
</p></dd>
<dt><samp class="option">half_life</samp></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><samp class="option">analyze_interlaced_flag</samp></dt>
<dd><p>When this is not 0 then idet will use the specified number of frames to determine
if the interlaced flag is accurate, it will not count undetermined frames.
If the flag is found to be accurate it will be used without any further
computations, if it is found to be inaccurate it will be cleared without any
further computations. This allows inserting the idet filter as a low computational
method to clean up the interlaced flag
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="il">
<h3 class="section">30.136 il</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 class="table">
<dt><samp class="option">luma_mode, l</samp></dt>
<dt><samp class="option">chroma_mode, c</samp></dt>
<dt><samp class="option">alpha_mode, a</samp></dt>
<dd><p>Available values for <var class="var">luma_mode</var>, <var class="var">chroma_mode</var> and
<var class="var">alpha_mode</var> are:
</p>
<dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Do nothing.
</p>
</dd>
<dt>‘<samp class="samp">deinterleave, d</samp>’</dt>
<dd><p>Deinterleave fields, placing one above the other.
</p>
</dd>
<dt>‘<samp class="samp">interleave, i</samp>’</dt>
<dd><p>Interleave fields. Reverse the effect of deinterleaving.
</p></dd>
</dl>
<p>Default value is <code class="code">none</code>.
</p>
</dd>
<dt><samp class="option">luma_swap, ls</samp></dt>
<dt><samp class="option">chroma_swap, cs</samp></dt>
<dt><samp class="option">alpha_swap, as</samp></dt>
<dd><p>Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is <code class="code">0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-100" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-100">
<h4 class="subsection">30.136.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="inflate">
<h3 class="section">30.137 inflate</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane, default is 65535.
If 0, plane will remain unchanged.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-101" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-101">
<h4 class="subsection">30.137.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="interlace">
<h3 class="section">30.138 interlace</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-preformatted"> 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 class="table">
<dt><samp class="option">scan</samp></dt>
<dd><p>This determines whether the interlaced frame is taken from the even
(tff - default) or odd (bff) lines of the progressive frame.
</p>
</dd>
<dt><samp class="option">lowpass</samp></dt>
<dd><p>Vertical lowpass filter to avoid twitter interlacing and
reduce moire patterns.
</p>
<dl class="table">
<dt>‘<samp class="samp">0, off</samp>’</dt>
<dd><p>Disable vertical lowpass filter
</p>
</dd>
<dt>‘<samp class="samp">1, linear</samp>’</dt>
<dd><p>Enable linear filter (default)
</p>
</dd>
<dt>‘<samp class="samp">2, complex</samp>’</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>
</div>
<div class="section-level-extent" id="kerndeint">
<h3 class="section">30.139 kerndeint</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 class="table">
<dt><samp class="option">thresh</samp></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><samp class="option">map</samp></dt>
<dd><p>Paint pixels exceeding the threshold value to white if set to 1.
Default is 0.
</p>
</dd>
<dt><samp class="option">order</samp></dt>
<dd><p>Set the fields order. Swap fields if set to 1, leave fields alone if
0. Default is 0.
</p>
</dd>
<dt><samp class="option">sharp</samp></dt>
<dd><p>Enable additional sharpening if set to 1. Default is 0.
</p>
</dd>
<dt><samp class="option">twoway</samp></dt>
<dd><p>Enable twoway sharpening if set to 1. Default is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-103" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-103">
<h4 class="subsection">30.139.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply default values:
<div class="example">
<pre class="example-preformatted">kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
</pre></div>
</li><li>Enable additional sharpening:
<div class="example">
<pre class="example-preformatted">kerndeint=sharp=1
</pre></div>
</li><li>Paint processed pixels in white:
<div class="example">
<pre class="example-preformatted">kerndeint=map=1
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="kirsch">
<h3 class="section">30.140 kirsch</h3>
<p>Apply kirsch operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-102" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-102">
<h4 class="subsection">30.140.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="lagfun">
<h3 class="section">30.141 lagfun</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 class="table">
<dt><samp class="option">decay</samp></dt>
<dd><p>Set factor for decaying. Default is .95. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-103" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-103">
<h4 class="subsection">30.141.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="lenscorrection">
<h3 class="section">30.142 lenscorrection</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 class="ref" href="#vignette">vignette</a> filter, which can also be used to compensate lens errors,
this filter corrects the distortion of the image, whereas <a class="ref" 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>
<ul class="mini-toc">
<li><a href="#Options-35" accesskey="1">Options</a></li>
<li><a href="#Commands-104" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Options-35">
<h4 class="subsection">30.142.1 Options</h4>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">cx</samp></dt>
<dd><p>Relative x-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
width. Default is 0.5.
</p></dd>
<dt><samp class="option">cy</samp></dt>
<dd><p>Relative y-coordinate of the focal point of the image, and thereby the center of the
distortion. This value has a range [0,1] and is expressed as fractions of the image
height. Default is 0.5.
</p></dd>
<dt><samp class="option">k1</samp></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><samp class="option">k2</samp></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><samp class="option">i</samp></dt>
<dd><p>Set interpolation type. Can be <code class="code">nearest</code> or <code class="code">bilinear</code>.
Default is <code class="code">nearest</code>.
</p></dd>
<dt><samp class="option">fc</samp></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 class="code">black@0</code>.
</p></dd>
</dl>
<p>The formula that generates the correction is:
</p>
<p><var class="var">r_src</var> = <var class="var">r_tgt</var> * (1 + <var class="var">k1</var> * (<var class="var">r_tgt</var> / <var class="var">r_0</var>)^2 + <var class="var">k2</var> * (<var class="var">r_tgt</var> / <var class="var">r_0</var>)^4)
</p>
<p>where <var class="var">r_0</var> is halve of the image diagonal and <var class="var">r_src</var> and <var class="var">r_tgt</var> are the
distances from the focal point in the source and target images, respectively.
</p>
</div>
<div class="subsection-level-extent" id="Commands-104">
<h4 class="subsection">30.142.2 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="lensfun">
<h3 class="section">30.143 lensfun</h3>
<p>Apply lens correction via the lensfun library (<a class="url" href="http://lensfun.sourceforge.net/">http://lensfun.sourceforge.net/</a>).
</p>
<p>The <code class="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 class="code">make</code> and
<code class="code">model</code> options. The filter will send the full list to the log with level <code class="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 class="code">lens_model</code> option. The filter will send the full list of lenses in the log with level
<code class="code">INFO</code>. The ffmpeg tool will exit after the list is printed.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">make</samp></dt>
<dd><p>The make of the camera (for example, "Canon"). This option is required.
</p>
</dd>
<dt><samp class="option">model</samp></dt>
<dd><p>The model of the camera (for example, "Canon EOS 100D"). This option is
required.
</p>
</dd>
<dt><samp class="option">lens_model</samp></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><samp class="option">db_path</samp></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><samp class="option">mode</samp></dt>
<dd><p>The type of correction to apply. The following values are valid options:
</p>
<dl class="table">
<dt>‘<samp class="samp">vignetting</samp>’</dt>
<dd><p>Enables fixing lens vignetting.
</p>
</dd>
<dt>‘<samp class="samp">geometry</samp>’</dt>
<dd><p>Enables fixing lens geometry. This is the default.
</p>
</dd>
<dt>‘<samp class="samp">subpixel</samp>’</dt>
<dd><p>Enables fixing chromatic aberrations.
</p>
</dd>
<dt>‘<samp class="samp">vig_geo</samp>’</dt>
<dd><p>Enables fixing lens vignetting and lens geometry.
</p>
</dd>
<dt>‘<samp class="samp">vig_subpixel</samp>’</dt>
<dd><p>Enables fixing lens vignetting and chromatic aberrations.
</p>
</dd>
<dt>‘<samp class="samp">distortion</samp>’</dt>
<dd><p>Enables fixing both lens geometry and chromatic aberrations.
</p>
</dd>
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>Enables all possible corrections.
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">focal_length</samp></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><samp class="option">aperture</samp></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><samp class="option">focus_distance</samp></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><samp class="option">scale</samp></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><samp class="option">target_geometry</samp></dt>
<dd><p>The target geometry of the output image/video. The following values are valid
options:
</p>
<dl class="table">
<dt>‘<samp class="samp">rectilinear (default)</samp>’</dt>
<dt>‘<samp class="samp">fisheye</samp>’</dt>
<dt>‘<samp class="samp">panoramic</samp>’</dt>
<dt>‘<samp class="samp">equirectangular</samp>’</dt>
<dt>‘<samp class="samp">fisheye_orthographic</samp>’</dt>
<dt>‘<samp class="samp">fisheye_stereographic</samp>’</dt>
<dt>‘<samp class="samp">fisheye_equisolid</samp>’</dt>
<dt>‘<samp class="samp">fisheye_thoby</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">reverse</samp></dt>
<dd><p>Apply the reverse of image correction (instead of correcting distortion, apply
it).
</p>
</dd>
<dt><samp class="option">interpolation</samp></dt>
<dd><p>The type of interpolation used when correcting distortion. The following values
are valid options:
</p>
<dl class="table">
<dt>‘<samp class="samp">nearest</samp>’</dt>
<dt>‘<samp class="samp">linear (default)</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-104" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-104">
<h4 class="subsection">30.143.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="libplacebo">
<h3 class="section">30.144 libplacebo</h3>
<p>Flexible GPU-accelerated processing filter based on libplacebo
(<a class="url" href="https://code.videolan.org/videolan/libplacebo">https://code.videolan.org/videolan/libplacebo</a>).
</p>
<ul class="mini-toc">
<li><a href="#Options-36" accesskey="1">Options</a></li>
<li><a href="#Commands-105" accesskey="2">Commands</a></li>
<li><a href="#Examples-105" accesskey="3">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-36">
<h4 class="subsection">30.144.1 Options</h4>
<p>The options for this filter are divided into the following sections:
</p>
<ul class="mini-toc">
<li><a href="#Output-mode" accesskey="1">Output mode</a></li>
<li><a href="#Scaling" accesskey="2">Scaling</a></li>
<li><a href="#Debanding" accesskey="3">Debanding</a></li>
<li><a href="#Color-adjustment" accesskey="4">Color adjustment</a></li>
<li><a href="#Peak-detection" accesskey="5">Peak detection</a></li>
<li><a href="#Tone-mapping" accesskey="6">Tone mapping</a></li>
<li><a href="#Dithering" accesskey="7">Dithering</a></li>
<li><a href="#Custom-shaders" accesskey="8">Custom shaders</a></li>
<li><a href="#Debugging-_002f-performance" accesskey="9">Debugging / performance</a></li>
</ul>
<div class="subsubsection-level-extent" id="Output-mode">
<h4 class="subsubsection">30.144.1.1 Output mode</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 class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set the number of inputs. This can be used, alongside the <code class="code">idx</code> variable,
to allow placing/blending multiple inputs inside the output frame. This
effectively enables functionality similar to <a class="ref" href="#hstack">hstack</a>, <a class="ref" href="#overlay">overlay</a>, etc.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Set the output video dimension expression. Default values are <code class="code">iw</code> and
<code class="code">ih</code>.
</p>
<p>Allows for the same expressions as the <a class="ref" href="#scale">scale</a> filter.
</p>
</dd>
<dt><samp class="option">crop_x</samp></dt>
<dt><samp class="option">crop_y</samp></dt>
<dd><p>Set the input crop x/y expressions, default values are <code class="code">(iw-cw)/2</code> and
<code class="code">(ih-ch)/2</code>.
</p>
</dd>
<dt><samp class="option">crop_w</samp></dt>
<dt><samp class="option">crop_h</samp></dt>
<dd><p>Set the input crop width/height expressions, default values are <code class="code">iw</code> and
<code class="code">ih</code>.
</p>
</dd>
<dt><samp class="option">pos_x</samp></dt>
<dt><samp class="option">pos_y</samp></dt>
<dd><p>Set the output placement x/y expressions, default values are <code class="code">(ow-pw)/2</code>
and <code class="code">(oh-ph)/2</code>.
</p>
</dd>
<dt><samp class="option">pos_w</samp></dt>
<dt><samp class="option">pos_h</samp></dt>
<dd><p>Set the output placement width/height expressions, default values are <code class="code">ow</code>
and <code class="code">oh</code>.
</p>
</dd>
<dt><samp class="option">fps</samp></dt>
<dd><p>Set the output frame rate. This can be rational, e.g. <code class="code">60000/1001</code>. If
set to the special string <code class="code">none</code> (the default), input timestamps will
instead be passed through to the output unmodified. Otherwise, the input video
frames will be interpolated as necessary to rescale the video to the specified
target framerate, in a manner as determined by the <samp class="option">frame_mixer</samp> option.
</p>
</dd>
<dt><samp class="option">format</samp></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><samp class="option">force_original_aspect_ratio</samp></dt>
<dt><samp class="option">force_divisible_by</samp></dt>
<dd><p>Work the same as the identical <a class="ref" href="#scale">scale</a> filter options.
</p>
</dd>
<dt><samp class="option">normalize_sar</samp></dt>
<dd><p>If enabled, output frames will always have a pixel aspect ratio of 1:1. This
will introduce additional 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><samp class="option">pad_crop_ratio</samp></dt>
<dd><p>Specifies a ratio (between <code class="code">0.0</code> and <code class="code">1.0</code>) between padding and
cropping when the input aspect ratio does not match the output aspect ratio and
<samp class="option">normalize_sar</samp> is in effect. The default of <code class="code">0.0</code> always pads the
content with black borders, while a value of <code class="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><samp class="option">fillcolor</samp></dt>
<dd><p>Set the color used to fill the output area not covered by the output image, for
example as a result of <samp class="option">normalize_sar</samp>. 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>. Defaults to <code class="code">black</code>.
</p>
</dd>
<dt><samp class="option">corner_rounding</samp></dt>
<dd><p>Render frames with rounded corners. The value, given as a float ranging from
<code class="code">0.0</code> to <code class="code">1.0</code>, indicates the relative degree of rounding, from fully
square to fully circular. In other words, it gives the radius divided by half
the smaller side length. Defaults to <code class="code">0.0</code>.
</p>
</dd>
<dt><samp class="option">extra_opts</samp></dt>
<dd><p>Pass extra libplacebo internal configuration options. These can be specified
as a list of <var class="var">key</var>=<var class="var">value</var> pairs separated by ’:’. The following example
shows how to configure a custom filter kernel ("EWA LanczosSharp") and use it
to double the input image resolution:
</p>
<div class="example">
<pre class="example-preformatted">-vf "libplacebo=w=iw*2:h=ih*2:extra_opts='upscaler=custom\:upscaler_preset=ewa_lanczos\:upscaler_blur=0.9812505644269356'"
</pre></div>
</dd>
<dt><samp class="option">colorspace</samp></dt>
<dt><samp class="option">color_primaries</samp></dt>
<dt><samp class="option">color_trc</samp></dt>
<dt><samp class="option">range</samp></dt>
<dd><p>Configure the colorspace that output frames will be delivered in. The default
value of <code class="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 class="ref" href="#setparams">setparams</a> filter for a list of possible values.
</p>
</dd>
<dt><samp class="option">apply_filmgrain</samp></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><samp class="option">apply_dolbyvision</samp></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 class="code">auto</code> for the respective frame output options.
</p></dd>
</dl>
<p>In addition to the expression constants documented for the <a class="ref" href="#scale">scale</a> filter,
the <samp class="option">crop_w</samp>, <samp class="option">crop_h</samp>, <samp class="option">crop_x</samp>, <samp class="option">crop_y</samp>,
<samp class="option">pos_w</samp>, <samp class="option">pos_h</samp>, <samp class="option">pos_x</samp> and <samp class="option">pos_y</samp> options can
also contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">in_idx, idx</samp></dt>
<dd><p>The (0-based) numeric index of the currently active input stream.
</p></dd>
<dt><samp class="option">crop_w, cw</samp></dt>
<dt><samp class="option">crop_h, ch</samp></dt>
<dd><p>The computed values of <samp class="option">crop_w</samp> and <samp class="option">crop_h</samp>.
</p>
</dd>
<dt><samp class="option">pos_w, pw</samp></dt>
<dt><samp class="option">pos_h, ph</samp></dt>
<dd><p>The computed values of <samp class="option">pos_w</samp> and <samp class="option">pos_h</samp>.
</p>
</dd>
<dt><samp class="option">in_t, t</samp></dt>
<dd><p>The input frame timestamp, in seconds. NAN if input timestamp is unknown.
</p>
</dd>
<dt><samp class="option">out_t, ot</samp></dt>
<dd><p>The input frame timestamp, in seconds. NAN if input timestamp is unknown.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>The input frame number, starting with 0.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Scaling">
<h4 class="subsubsection">30.144.1.2 Scaling</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 class="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 class="table">
<dt><samp class="option">upscaler</samp></dt>
<dt><samp class="option">downscaler</samp></dt>
<dd><p>Configure the filter kernel used for upscaling and downscaling. The respective
defaults are <code class="code">spline36</code> and <code class="code">mitchell</code>. For a full list of possible
values, pass <code class="code">help</code> to these options. The most important values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</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>‘<samp class="samp">bilinear</samp>’</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>‘<samp class="samp">nearest</samp>’</dt>
<dd><p>Nearest-neighbour interpolation. Sharp but highly aliasing.
</p>
</dd>
<dt>‘<samp class="samp">oversample</samp>’</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>‘<samp class="samp">lanczos</samp>’</dt>
<dd><p>Standard sinc-sinc interpolation kernel.
</p>
</dd>
<dt>‘<samp class="samp">spline36</samp>’</dt>
<dd><p>Cubic spline approximation of lanczos. No difference in performance, but has
very slightly less ringing.
</p>
</dd>
<dt>‘<samp class="samp">ewa_lanczos</samp>’</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>‘<samp class="samp">gaussian</samp>’</dt>
<dd><p>Gaussian kernel. Has certain ideal mathematical properties, but subjectively
very blurry.
</p>
</dd>
<dt>‘<samp class="samp">mitchell</samp>’</dt>
<dd><p>Cubic BC spline with parameters recommended by Mitchell and Netravali. Very
little ringing.
</p></dd>
</dl>
</dd>
<dt><samp class="option">frame_mixer</samp></dt>
<dd><p>Controls the kernel used for mixing frames temporally. The default value is
<code class="code">none</code>, which disables frame mixing. For a full list of possible values,
pass <code class="code">help</code> to this option. The most important values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disables frame mixing, giving a result equivalent to "nearest neighbour"
semantics.
</p>
</dd>
<dt>‘<samp class="samp">oversample</samp>’</dt>
<dd><p>Oversamples the input video to create a "Smooth Motion"-type effect: if an
output frame would exactly fall on the transition between two video frames, it
is blended according to the relative overlap. This is the recommended option
whenever preserving the original subjective appearance is desired.
</p>
</dd>
<dt>‘<samp class="samp">mitchell_clamp</samp>’</dt>
<dd><p>Larger filter kernel that smoothly interpolates multiple frames in a manner
designed to eliminate ringing and other artefacts as much as possible. This is
the recommended option wherever maximum visual smoothness is desired.
</p>
</dd>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>Linear blend/fade between frames. Especially useful for constructing e.g.
slideshows.
</p></dd>
</dl>
</dd>
<dt><samp class="option">lut_entries</samp></dt>
<dd><p>Configures the size of scaler LUTs, ranging from <code class="code">1</code> to <code class="code">256</code>. The
default of <code class="code">0</code> will pick libplacebo’s internal default, typically
<code class="code">64</code>.
</p>
</dd>
<dt><samp class="option">antiringing</samp></dt>
<dd><p>Enables anti-ringing (for non-EWA filters). The value (between <code class="code">0.0</code> and
<code class="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><samp class="option">sigmoid</samp></dt>
<dd><p>Enable sigmoidal compression during upscaling. Reduces ringing slightly.
Enabled by default.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Debanding">
<h4 class="subsubsection">30.144.1.3 Debanding</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 class="table">
<dt><samp class="option">deband</samp></dt>
<dd><p>Enable (fast) debanding algorithm. Disabled by default.
</p>
</dd>
<dt><samp class="option">deband_iterations</samp></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 class="code">1</code> to <code class="code">4</code>. Defaults to <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">deband_threshold</samp></dt>
<dd><p>Debanding filter strength. Higher numbers lead to more aggressive debanding.
Defaults to <code class="code">4.0</code>.
</p>
</dd>
<dt><samp class="option">deband_radius</samp></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 class="code">16.0</code>.
</p>
</dd>
<dt><samp class="option">deband_grain</samp></dt>
<dd><p>Amount of extra output grain to add. Helps hide imperfections. Defaults to
<code class="code">6.0</code>.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Color-adjustment">
<h4 class="subsubsection">30.144.1.4 Color adjustment</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 class="table">
<dt><samp class="option">brightness</samp></dt>
<dd><p>Brightness boost, between <code class="code">-1.0</code> and <code class="code">1.0</code>. Defaults to <code class="code">0.0</code>.
</p>
</dd>
<dt><samp class="option">contrast</samp></dt>
<dd><p>Contrast gain, between <code class="code">0.0</code> and <code class="code">16.0</code>. Defaults to <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Saturation gain, between <code class="code">0.0</code> and <code class="code">16.0</code>. Defaults to <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">hue</samp></dt>
<dd><p>Hue shift in radians, between <code class="code">-3.14</code> and <code class="code">3.14</code>. Defaults to
<code class="code">0.0</code>. This will rotate the UV subvector, defaulting to BT.709
coefficients for RGB inputs.
</p>
</dd>
<dt><samp class="option">gamma</samp></dt>
<dd><p>Gamma adjustment, between <code class="code">0.0</code> and <code class="code">16.0</code>. Defaults to <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">cones</samp></dt>
<dd><p>Cone model to use for color blindness simulation. Accepts any combination of
<code class="code">l</code>, <code class="code">m</code> and <code class="code">s</code>. Here are some examples:
</p><dl class="table">
<dt>‘<samp class="samp">m</samp>’</dt>
<dd><p>Deuteranomaly / deuteranopia (affecting 3%-4% of the population)
</p></dd>
<dt>‘<samp class="samp">l</samp>’</dt>
<dd><p>Protanomaly / protanopia (affecting 1%-2% of the population)
</p></dd>
<dt>‘<samp class="samp">l+m</samp>’</dt>
<dd><p>Monochromacy (very rare)
</p></dd>
<dt>‘<samp class="samp">l+m+s</samp>’</dt>
<dd><p>Achromatopsy (complete loss of daytime vision, extremely rare)
</p></dd>
</dl>
</dd>
<dt><samp class="option">cone-strength</samp></dt>
<dd><p>Gain factor for the cones specified by <code class="code">cones</code>, between <code class="code">0.0</code> and
<code class="code">10.0</code>. A value of <code class="code">1.0</code> results in no change to color vision. A
value of <code class="code">0.0</code> (the default) simulates complete loss of those cones. Values
above <code class="code">1.0</code> result in exaggerating the differences between cones, which
may help compensate for reduced color vision.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Peak-detection">
<h4 class="subsubsection">30.144.1.5 Peak detection</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 class="table">
<dt><samp class="option">peak_detect</samp></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><samp class="option">smoothing_period</samp></dt>
<dd><p>Peak detection smoothing period, between <code class="code">0.0</code> and <code class="code">1000.0</code>. Higher
values result in peak detection becoming less responsive to changes in the
input. Defaults to <code class="code">100.0</code>.
</p>
</dd>
<dt><samp class="option">minimum_peak</samp></dt>
<dd><p>Lower bound on the detected peak (relative to SDR white), between <code class="code">0.0</code>
and <code class="code">100.0</code>. Defaults to <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">scene_threshold_low</samp></dt>
<dt><samp class="option">scene_threshold_high</samp></dt>
<dd><p>Lower and upper thresholds for scene change detection. Expressed in a
logarithmic scale between <code class="code">0.0</code> and <code class="code">100.0</code>. Default to <code class="code">5.5</code>
and <code class="code">10.0</code>, respectively. Setting either to a negative value disables
this functionality.
</p>
</dd>
<dt><samp class="option">percentile</samp></dt>
<dd><p>Which percentile of the frame brightness histogram to use as the source peak
for tone-mapping. Defaults to <code class="code">99.995</code>, a fairly conservative value.
Setting this to <code class="code">100.0</code> disables frame histogram measurement and instead
uses the true peak brightness for tone-mapping.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Tone-mapping">
<h4 class="subsubsection">30.144.1.6 Tone mapping</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 class="table">
<dt><samp class="option">gamut_mode</samp></dt>
<dd><p>How to handle out-of-gamut colors that can occur as a result of colorimetric
gamut mapping.
</p><dl class="table">
<dt>‘<samp class="samp">clip</samp>’</dt>
<dd><p>Do nothing, simply clip out-of-range colors to the RGB volume. Low quality but
extremely fast.
</p></dd>
<dt>‘<samp class="samp">perceptual</samp>’</dt>
<dd><p>Perceptually soft-clip colors to the gamut volume. This is the default.
</p></dd>
<dt>‘<samp class="samp">relative</samp>’</dt>
<dd><p>Relative colorimetric hard-clip. Similar to <code class="code">perceptual</code> but without
the soft knee.
</p></dd>
<dt>‘<samp class="samp">saturation</samp>’</dt>
<dd><p>Saturation mapping, maps primaries directly to primaries in RGB space.
Not recommended except for artificial computer graphics for which a bright,
saturated display is desired.
</p></dd>
<dt>‘<samp class="samp">absolute</samp>’</dt>
<dd><p>Absolute colorimetric hard-clip. Performs no adjustment of the white point.
</p></dd>
<dt>‘<samp class="samp">desaturate</samp>’</dt>
<dd><p>Hard-desaturates out-of-gamut colors towards white, while preserving the
luminance. Has a tendency to distort the visual appearance of bright objects.
</p></dd>
<dt>‘<samp class="samp">darken</samp>’</dt>
<dd><p>Linearly reduces content brightness to preserves saturated details, followed by
clipping the remaining out-of-gamut colors.
</p></dd>
<dt>‘<samp class="samp">warn</samp>’</dt>
<dd><p>Highlight out-of-gamut pixels (by inverting/marking them).
</p></dd>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>Linearly reduces chromaticity of the entire image to make it fit within the
target color volume. Be careful when using this on BT.2020 sources without
proper mastering metadata, as doing so will lead to excessive desaturation.
</p></dd>
</dl>
</dd>
<dt><samp class="option">tonemapping</samp></dt>
<dd><p>Tone-mapping algorithm to use. Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Automatic selection based on internal heuristics. This is the default.
</p></dd>
<dt>‘<samp class="samp">clip</samp>’</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>‘<samp class="samp">st2094-40</samp>’</dt>
<dd><p>EETF from SMPTE ST 2094-40 Annex B, which applies the Bezier curves from HDR10+
dynamic metadata based on Bezier curves to perform tone-mapping. The OOTF used
is adjusted based on the ratio between the targeted and actual display peak
luminances.
</p></dd>
<dt>‘<samp class="samp">st2094-10</samp>’</dt>
<dd><p>EETF from SMPTE ST 2094-10 Annex B.2, which takes into account the input signal
average luminance in addition to the maximum/minimum. The configurable contrast
parameter influences the slope of the linear output segment, defaulting to
<code class="code">1.0</code> for no increase/decrease in contrast. Note that this does not
currently include the subjective gain/offset/gamma controls defined in Annex
B.3.
</p></dd>
<dt>‘<samp class="samp">bt.2390</samp>’</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 class="code">1.0</code>, rather than the value of <code class="code">0.5</code> from the ITU-R
spec.
</p></dd>
<dt>‘<samp class="samp">bt.2446a</samp>’</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>‘<samp class="samp">spline</samp>’</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 class="code">0.30</code>.
Can be used for both forward and inverse tone mapping.
</p></dd>
<dt>‘<samp class="samp">reinhard</samp>’</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 class="code">0.5</code> implies that the reference white will be about half as bright as
when clipping. Defaults to <code class="code">0.5</code>, which results in the simplest
formulation of this function.
</p></dd>
<dt>‘<samp class="samp">mobius</samp>’</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 class="var">x</var>, every color value below <var class="var">x</var> will be mapped linearly,
while higher values get non-linearly tone-mapped. Values near <code class="code">1.0</code> make
this curve behave like <code class="code">clip</code>, while values near <code class="code">0.0</code> make this
curve behave like <code class="code">reinhard</code>. The default value is <code class="code">0.3</code>, which
provides a good balance between colorimetric accuracy and preserving
out-of-gamut details.
</p></dd>
<dt>‘<samp class="samp">hable</samp>’</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 class="code">reinhard</code> with parameter <code class="code">0.24</code>.
</p></dd>
<dt>‘<samp class="samp">gamma</samp>’</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 class="code">0.5</code>.
</p></dd>
<dt>‘<samp class="samp">linear</samp>’</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 class="code">1.0</code>).
</p></dd>
</dl>
</dd>
<dt><samp class="option">tonemapping_param</samp></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 class="code">tonemapping</code>. The default
value of <code class="code">0.0</code> is replaced by the curve’s preferred default setting.
</p>
</dd>
<dt><samp class="option">inverse_tonemapping</samp></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><samp class="option">tonemapping_lut_size</samp></dt>
<dd><p>Size of the tone-mapping LUT, between <code class="code">2</code> and <code class="code">1024</code>. Defaults to
<code class="code">256</code>. Note that this figure is squared when combined with
<code class="code">peak_detect</code>.
</p>
</dd>
<dt><samp class="option">contrast_recovery</samp></dt>
<dd><p>Contrast recovery strength. If set to a value above <code class="code">0.0</code>, the source
image will be divided into high-frequency and low-frequency components, and a
portion of the high-frequency image is added back onto the tone-mapped output.
May cause excessive ringing artifacts for some HDR sources, but can improve the
subjective sharpness and detail left over in the image after tone-mapping.
Defaults to <code class="code">0.30</code>.
</p>
</dd>
<dt><samp class="option">contrast_smoothness</samp></dt>
<dd><p>Contrast recovery lowpass kernel size. Defaults to <code class="code">3.5</code>. Increasing or
decreasing this will affect the visual appearance substantially. Has no effect
when <code class="code">contrast_recovery</code> is disabled.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Dithering">
<h4 class="subsubsection">30.144.1.7 Dithering</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 class="code">debanding</code> filter is enabled. If maximum performance is needed,
use <code class="code">ordered_fixed</code> instead of disabling dithering.
</p><dl class="table">
<dt><samp class="option">dithering</samp></dt>
<dd><p>Dithering method to use. Accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disables dithering completely. May result in visible banding.
</p></dd>
<dt>‘<samp class="samp">blue</samp>’</dt>
<dd><p>Dither with pseudo-blue noise. This is the default.
</p></dd>
<dt>‘<samp class="samp">ordered</samp>’</dt>
<dd><p>Tunable ordered dither pattern.
</p></dd>
<dt>‘<samp class="samp">ordered_fixed</samp>’</dt>
<dd><p>Faster ordered dither with a fixed size of <code class="code">6</code>. Texture-less.
</p></dd>
<dt>‘<samp class="samp">white</samp>’</dt>
<dd><p>Dither with white noise. Texture-less.
</p></dd>
</dl>
</dd>
<dt><samp class="option">dither_lut_size</samp></dt>
<dd><p>Dither LUT size, as log base2 between <code class="code">1</code> and <code class="code">8</code>. Defaults to
<code class="code">6</code>, corresponding to a LUT size of <code class="code">64x64</code>.
</p>
</dd>
<dt><samp class="option">dither_temporal</samp></dt>
<dd><p>Enables temporal dithering. Disabled by default.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Custom-shaders">
<h4 class="subsubsection">30.144.1.8 Custom shaders</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 class="url" 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 class="url" href="https://mpv.io/manual/master/#options-glsl-shader">https://mpv.io/manual/master/#options-glsl-shader</a>
</p><dl class="table">
<dt><samp class="option">custom_shader_path</samp></dt>
<dd><p>Specifies a path to a custom shader file to load at runtime.
</p>
</dd>
<dt><samp class="option">custom_shader_bin</samp></dt>
<dd><p>Specifies a complete custom shader as a raw string.
</p></dd>
</dl>
</div>
<div class="subsubsection-level-extent" id="Debugging-_002f-performance">
<h4 class="subsubsection">30.144.1.9 Debugging / performance</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 class="table">
<dt><samp class="option">skip_aa</samp></dt>
<dd><p>Disable anti-aliasing when downscaling.
</p>
</dd>
<dt><samp class="option">polar_cutoff</samp></dt>
<dd><p>Truncate polar (EWA) scaler kernels below this absolute magnitude, between
<code class="code">0.0</code> and <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">disable_linear</samp></dt>
<dd><p>Disable linear light scaling.
</p>
</dd>
<dt><samp class="option">disable_builtin</samp></dt>
<dd><p>Disable built-in GPU sampling (forces LUT).
</p>
</dd>
<dt><samp class="option">disable_fbos</samp></dt>
<dd><p>Forcibly disable FBOs, resulting in loss of almost all functionality, but
offering the maximum possible speed.
</p></dd>
</dl>
</div>
</div>
<div class="subsection-level-extent" id="Commands-105">
<h4 class="subsection">30.144.2 Commands</h4>
<p>This filter supports almost all of the above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-105">
<h4 class="subsection">30.144.3 Examples</h4>
<ul class="itemize mark-bullet">
<li>Tone-map input to standard gamut BT.709 output:
<div class="example">
<pre class="example-preformatted">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-preformatted">libplacebo=w=1920:h=1080:force_original_aspect_ratio=decrease:normalize_sar=true:upscaler=ewa_lanczos:downscaler=ewa_lanczos
</pre></div>
</li><li>Interpolate low FPS / VFR input to smoothed constant 60 fps output:
<div class="example">
<pre class="example-preformatted">libplacebo=fps=60:frame_mixer=mitchell_clamp
</pre></div>
</li><li>Convert input to standard sRGB JPEG:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">ffmpeg -export_side_data +film_grain ... -vf libplacebo=apply_filmgrain=true
</pre></div>
</li><li>Interop with VAAPI hwdec to avoid round-tripping through RAM:
<div class="example">
<pre class="example-preformatted">ffmpeg -init_hw_device vulkan -hwaccel vaapi -hwaccel_output_format vaapi ... -vf libplacebo
</pre></div>
</li></ul>
<a class="anchor" id="libvmaf"></a></div>
</div>
<div class="section-level-extent" id="libvmaf-1">
<h3 class="section">30.145 libvmaf</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 class="code">./configure --enable-libvmaf</code>.
</p>
<p>The filter has following options:
</p>
<dl class="table">
<dt><samp class="option">model</samp></dt>
<dd><p>A ‘|‘ delimited list of vmaf models. Each model can be configured with a number of parameters.
Default value: <code class="code">"version=vmaf_v0.6.1"</code>
</p>
</dd>
<dt><samp class="option">feature</samp></dt>
<dd><p>A ‘|‘ delimited list of features. Each feature can be configured with a number of parameters.
</p>
</dd>
<dt><samp class="option">log_path</samp></dt>
<dd><p>Set the file path to be used to store log files.
</p>
</dd>
<dt><samp class="option">log_fmt</samp></dt>
<dd><p>Set the format of the log file (xml, json, csv, or sub).
</p>
</dd>
<dt><samp class="option">n_threads</samp></dt>
<dd><p>Set number of threads to be used when initializing libvmaf.
Default value: <code class="code">0</code>, no threads.
</p>
</dd>
<dt><samp class="option">n_subsample</samp></dt>
<dd><p>Set frame subsampling interval to be used.
</p></dd>
</dl>
<p>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<ul class="mini-toc">
<li><a href="#Examples-106" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-106">
<h4 class="subsection">30.145.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>In the examples below, a distorted video <samp class="file">distorted.mpg</samp> is
compared with a reference file <samp class="file">reference.mpg</samp>.
</li><li>Basic usage:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="libvmaf_005fcuda">
<h3 class="section">30.146 libvmaf_cuda</h3>
<p>This is the CUDA variant of the <a class="ref" href="#libvmaf">libvmaf</a> filter. It only accepts CUDA frames.
</p>
<p>It requires Netflix’s vmaf library (libvmaf) as a pre-requisite.
After installing the library it can be enabled using:
<code class="code">./configure --enable-nonfree --enable-ffnvcodec --enable-libvmaf</code>.
</p>
<ul class="mini-toc">
<li><a href="#Examples-107" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-107">
<h4 class="subsection">30.146.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Basic usage showing CUVID hardware decoding and CUDA scaling with <a class="ref" href="#scale_005fcuda">scale_cuda</a>:
<div class="example">
<pre class="example-preformatted">ffmpeg \
-hwaccel cuda -hwaccel_output_format cuda -codec:v av1_cuvid -i dis.obu \
-hwaccel cuda -hwaccel_output_format cuda -codec:v av1_cuvid -i ref.obu \
-filter_complex "
[0:v]scale_cuda=format=yuv420p[ref]; \
[1:v]scale_cuda=format=yuv420p[dis]; \
[dis][ref]libvmaf_cuda=log_fmt=json:log_path=output.json
" \
-f null -
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="limitdiff">
<h3 class="section">30.147 limitdiff</h3>
<p>Apply limited difference filter using second and optionally third video stream.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">threshold</samp></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><samp class="option">elasticity</samp></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><samp class="option">reference</samp></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><samp class="option">planes</samp></dt>
<dd><p>Specify which planes will be processed. Defaults to all available.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-106" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-106">
<h4 class="subsection">30.147.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a> except option ‘<samp class="samp">reference</samp>’.
</p>
</div>
</div>
<div class="section-level-extent" id="limiter">
<h3 class="section">30.148 limiter</h3>
<p>Limits the pixel components values to the specified range [min, max].
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">min</samp></dt>
<dd><p>Lower bound. Defaults to the lowest allowed value for the input.
</p>
</dd>
<dt><samp class="option">max</samp></dt>
<dd><p>Upper bound. Defaults to the highest allowed value for the input.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Specify which planes will be processed. Defaults to all available.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-107" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-107">
<h4 class="subsection">30.148.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="loop">
<h3 class="section">30.149 loop</h3>
<p>Loop video frames.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">loop</samp></dt>
<dd><p>Set the number of loops. Setting this value to -1 will result in infinite loops.
Default is 0.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set maximal size in number of frames. Default is 0.
</p>
</dd>
<dt><samp class="option">start</samp></dt>
<dd><p>Set first frame of loop. Default is 0.
</p>
</dd>
<dt><samp class="option">time</samp></dt>
<dd><p>Set the time of loop start in seconds.
Only used if option named <var class="var">start</var> is set to <code class="code">-1</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-108" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-108">
<h4 class="subsection">30.149.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Loop single first frame infinitely:
<div class="example">
<pre class="example-preformatted">loop=loop=-1:size=1:start=0
</pre></div>
</li><li>Loop single first frame 10 times:
<div class="example">
<pre class="example-preformatted">loop=loop=10:size=1:start=0
</pre></div>
</li><li>Loop 10 first frames 5 times:
<div class="example">
<pre class="example-preformatted">loop=loop=5:size=10:start=0
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="lut1d">
<h3 class="section">30.150 lut1d</h3>
<p>Apply a 1D LUT to an input video.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">file</samp></dt>
<dd><p>Set the 1D LUT file name.
</p>
<p>Currently supported formats:
</p><dl class="table">
<dt>‘<samp class="samp">cube</samp>’</dt>
<dd><p>Iridas
</p></dd>
<dt>‘<samp class="samp">csp</samp>’</dt>
<dd><p>cineSpace
</p></dd>
</dl>
</dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Select interpolation mode.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">nearest</samp>’</dt>
<dd><p>Use values from the nearest defined point.
</p></dd>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>Interpolate values using the linear interpolation.
</p></dd>
<dt>‘<samp class="samp">cosine</samp>’</dt>
<dd><p>Interpolate values using the cosine interpolation.
</p></dd>
<dt>‘<samp class="samp">cubic</samp>’</dt>
<dd><p>Interpolate values using the cubic interpolation.
</p></dd>
<dt>‘<samp class="samp">spline</samp>’</dt>
<dd><p>Interpolate values using the spline interpolation.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-108" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-108">
<h4 class="subsection">30.150.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
<a class="anchor" id="lut3d"></a></div>
</div>
<div class="section-level-extent" id="lut3d-1">
<h3 class="section">30.151 lut3d</h3>
<p>Apply a 3D LUT to an input video.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">file</samp></dt>
<dd><p>Set the 3D LUT file name.
</p>
<p>Currently supported formats:
</p><dl class="table">
<dt>‘<samp class="samp">3dl</samp>’</dt>
<dd><p>AfterEffects
</p></dd>
<dt>‘<samp class="samp">cube</samp>’</dt>
<dd><p>Iridas
</p></dd>
<dt>‘<samp class="samp">dat</samp>’</dt>
<dd><p>DaVinci
</p></dd>
<dt>‘<samp class="samp">m3d</samp>’</dt>
<dd><p>Pandora
</p></dd>
<dt>‘<samp class="samp">csp</samp>’</dt>
<dd><p>cineSpace
</p></dd>
</dl>
</dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Select interpolation mode.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">nearest</samp>’</dt>
<dd><p>Use values from the nearest defined point.
</p></dd>
<dt>‘<samp class="samp">trilinear</samp>’</dt>
<dd><p>Interpolate values using the 8 points defining a cube.
</p></dd>
<dt>‘<samp class="samp">tetrahedral</samp>’</dt>
<dd><p>Interpolate values using a tetrahedron.
</p></dd>
<dt>‘<samp class="samp">pyramid</samp>’</dt>
<dd><p>Interpolate values using a pyramid.
</p></dd>
<dt>‘<samp class="samp">prism</samp>’</dt>
<dd><p>Interpolate values using a prism.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-109" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-109">
<h4 class="subsection">30.151.1 Commands</h4>
<p>This filter supports the <code class="code">interp</code> option as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="lumakey">
<h3 class="section">30.152 lumakey</h3>
<p>Turn certain luma values into transparency.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">threshold</samp></dt>
<dd><p>Set the luma which will be used as base for transparency.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">tolerance</samp></dt>
<dd><p>Set the range of luma values to be keyed out.
Default value is <code class="code">0.01</code>.
</p>
</dd>
<dt><samp class="option">softness</samp></dt>
<dd><p>Set the range of softness. Default value is <code class="code">0</code>.
Use this to control gradual transition from zero to full transparency.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-110" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-110">
<h4 class="subsection">30.152.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="lut_002c-lutrgb_002c-lutyuv">
<h3 class="section">30.153 lut, lutrgb, lutyuv</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 class="var">lutyuv</var> applies a lookup table to a YUV input video, <var class="var">lutrgb</var>
to an RGB input video.
</p>
<p>These filters accept the following parameters:
</p><dl class="table">
<dt><samp class="option">c0</samp></dt>
<dd><p>set first pixel component expression
</p></dd>
<dt><samp class="option">c1</samp></dt>
<dd><p>set second pixel component expression
</p></dd>
<dt><samp class="option">c2</samp></dt>
<dd><p>set third pixel component expression
</p></dd>
<dt><samp class="option">c3</samp></dt>
<dd><p>set fourth pixel component expression, corresponds to the alpha component
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>set red component expression
</p></dd>
<dt><samp class="option">g</samp></dt>
<dd><p>set green component expression
</p></dd>
<dt><samp class="option">b</samp></dt>
<dd><p>set blue component expression
</p></dd>
<dt><samp class="option">a</samp></dt>
<dd><p>alpha component expression
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>set Y/luma component expression
</p></dd>
<dt><samp class="option">u</samp></dt>
<dd><p>set U/Cb component expression
</p></dd>
<dt><samp class="option">v</samp></dt>
<dd><p>set V/Cr component expression
</p></dd>
</dl>
<p>Each of them specifies the expression to use for computing the lookup table for
the corresponding pixel component values.
</p>
<p>The exact component associated to each of the <var class="var">c*</var> options depends on the
format in input.
</p>
<p>The <var class="var">lut</var> filter requires either YUV or RGB pixel formats in input,
<var class="var">lutrgb</var> requires RGB pixel formats in input, and <var class="var">lutyuv</var> requires YUV.
</p>
<p>The expressions can contain the following constants and functions:
</p>
<dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">val</samp></dt>
<dd><p>The input value for the pixel component.
</p>
</dd>
<dt><samp class="option">clipval</samp></dt>
<dd><p>The input value, clipped to the <var class="var">minval</var>-<var class="var">maxval</var> range.
</p>
</dd>
<dt><samp class="option">maxval</samp></dt>
<dd><p>The maximum value for the pixel component.
</p>
</dd>
<dt><samp class="option">minval</samp></dt>
<dd><p>The minimum value for the pixel component.
</p>
</dd>
<dt><samp class="option">negval</samp></dt>
<dd><p>The negated value for the pixel component value, clipped to the
<var class="var">minval</var>-<var class="var">maxval</var> range; it corresponds to the expression
"maxval-clipval+minval".
</p>
</dd>
<dt><samp class="option">clip(val)</samp></dt>
<dd><p>The computed value in <var class="var">val</var>, clipped to the
<var class="var">minval</var>-<var class="var">maxval</var> range.
</p>
</dd>
<dt><samp class="option">gammaval(gamma)</samp></dt>
<dd><p>The computed gamma correction value of the pixel component value,
clipped to the <var class="var">minval</var>-<var class="var">maxval</var> range. It corresponds to the
expression
"pow((clipval-minval)/(maxval-minval)\,<var class="var">gamma</var>)*(maxval-minval)+minval"
</p>
</dd>
</dl>
<p>All expressions default to "clipval".
</p>
<ul class="mini-toc">
<li><a href="#Commands-111" accesskey="1">Commands</a></li>
<li><a href="#Examples-109" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-111">
<h4 class="subsection">30.153.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
<div class="subsection-level-extent" id="Examples-109">
<h4 class="subsection">30.153.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Negate input video:
<div class="example">
<pre class="example-preformatted">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-preformatted">lutrgb="r=negval:g=negval:b=negval"
lutyuv="y=negval:u=negval:v=negval"
</pre></div>
</li><li>Negate luma:
<div class="example">
<pre class="example-preformatted">lutyuv=y=negval
</pre></div>
</li><li>Remove chroma components, turning the video into a graytone image:
<div class="example">
<pre class="example-preformatted">lutyuv="u=128:v=128"
</pre></div>
</li><li>Apply a luma burning effect:
<div class="example">
<pre class="example-preformatted">lutyuv="y=2*val"
</pre></div>
</li><li>Remove green and blue components:
<div class="example">
<pre class="example-preformatted">lutrgb="g=0:b=0"
</pre></div>
</li><li>Set a constant alpha channel value on input:
<div class="example">
<pre class="example-preformatted">format=rgba,lutrgb=a="maxval-minval/2"
</pre></div>
</li><li>Correct luma gamma by a factor of 0.5:
<div class="example">
<pre class="example-preformatted">lutyuv=y=gammaval(0.5)
</pre></div>
</li><li>Discard least significant bits of luma:
<div class="example">
<pre class="example-preformatted">lutyuv=y='bitand(val, 128+64+32)'
</pre></div>
</li><li>Technicolor like effect:
<div class="example">
<pre class="example-preformatted">lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="lut2_002c-tlut2">
<h3 class="section">30.154 lut2, tlut2</h3>
<p>The <code class="code">lut2</code> filter takes two input streams and outputs one
stream.
</p>
<p>The <code class="code">tlut2</code> (time lut2) filter takes two consecutive frames
from one single stream.
</p>
<p>This filter accepts the following parameters:
</p><dl class="table">
<dt><samp class="option">c0</samp></dt>
<dd><p>set first pixel component expression
</p></dd>
<dt><samp class="option">c1</samp></dt>
<dd><p>set second pixel component expression
</p></dd>
<dt><samp class="option">c2</samp></dt>
<dd><p>set third pixel component expression
</p></dd>
<dt><samp class="option">c3</samp></dt>
<dd><p>set fourth pixel component expression, corresponds to the alpha component
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>set output bit depth, only available for <code class="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 class="code">lut2</code> filter also supports the <a class="ref" 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 class="var">c*</var> options depends on the
format in inputs.
</p>
<p>The expressions can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dd><p>The first input value for the pixel component.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>The second input value for the pixel component.
</p>
</dd>
<dt><samp class="option">bdx</samp></dt>
<dd><p>The first input video bit depth.
</p>
</dd>
<dt><samp class="option">bdy</samp></dt>
<dd><p>The second input video bit depth.
</p></dd>
</dl>
<p>All expressions default to "x".
</p>
<ul class="mini-toc">
<li><a href="#Commands-112" accesskey="1">Commands</a></li>
<li><a href="#Examples-110" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-112">
<h4 class="subsection">30.154.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a> except option <code class="code">d</code>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-110">
<h4 class="subsection">30.154.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Highlight differences between two RGB video streams:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="maskedclamp">
<h3 class="section">30.155 maskedclamp</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 class="code">undershoot</code> and third input stream + <code class="code">overshoot</code>.
</p>
<p>This filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">undershoot</samp></dt>
<dd><p>Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">overshoot</samp></dt>
<dd><p>Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-113" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-113">
<h4 class="subsection">30.155.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="maskedmax">
<h3 class="section">30.156 maskedmax</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-114" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-114">
<h4 class="subsection">30.156.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="maskedmerge">
<h3 class="section">30.157 maskedmerge</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-115" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-115">
<h4 class="subsection">30.157.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="maskedmin">
<h3 class="section">30.158 maskedmin</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed as bitmap, unprocessed planes will be
copied from first stream.
By default value 0xf, all planes will be processed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-116" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-116">
<h4 class="subsection">30.158.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="maskedthreshold">
<h3 class="section">30.159 maskedthreshold</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 class="table">
<dt><samp class="option">threshold</samp></dt>
<dd><p>Set threshold used when picking pixels from absolute difference from two input
video streams.
</p>
</dd>
<dt><samp class="option">planes</samp></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><samp class="option">mode</samp></dt>
<dd><p>Set mode of filter operation. Can be <code class="code">abs</code> or <code class="code">diff</code>.
Default is <code class="code">abs</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-117" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-117">
<h4 class="subsection">30.159.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="maskfun">
<h3 class="section">30.160 maskfun</h3>
<p>Create mask from input video.
</p>
<p>For example it is useful to create motion masks after <code class="code">tblend</code> filter.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">low</samp></dt>
<dd><p>Set low threshold. Any pixel component lower or exact than this value will be set to 0.
</p>
</dd>
<dt><samp class="option">high</samp></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><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter, by default all available planes are filtered.
</p>
</dd>
<dt><samp class="option">fill</samp></dt>
<dd><p>Fill all frame pixels with this value.
</p>
</dd>
<dt><samp class="option">sum</samp></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 class="var">fill</var> option.
Typically useful for scene changes when used in combination with <code class="code">tblend</code> filter.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-118" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-118">
<h4 class="subsection">30.160.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="mcdeint">
<h3 class="section">30.161 mcdeint</h3>
<p>Apply motion-compensation deinterlacing.
</p>
<p>It needs one field per frame as input and must thus be used together
with yadif=1/3 or equivalent.
</p>
<p>This filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the deinterlacing mode.
</p>
<p>It accepts one of the following values:
</p><dl class="table">
<dt>‘<samp class="samp">fast</samp>’</dt>
<dt>‘<samp class="samp">medium</samp>’</dt>
<dt>‘<samp class="samp">slow</samp>’</dt>
<dd><p>use iterative motion estimation
</p></dd>
<dt>‘<samp class="samp">extra_slow</samp>’</dt>
<dd><p>like ‘<samp class="samp">slow</samp>’, but use multiple reference frames.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">fast</samp>’.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>Set the picture field parity assumed for the input video. It must be
one of the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">0, tff</samp>’</dt>
<dd><p>assume top field first
</p></dd>
<dt>‘<samp class="samp">1, bff</samp>’</dt>
<dd><p>assume bottom field first
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">bff</samp>’.
</p>
</dd>
<dt><samp class="option">qp</samp></dt>
<dd><p>Set per-block quantization parameter (QP) used by the internal
encoder.
</p>
<p>Higher values should result in a smoother motion vector field but less
optimal individual vectors. Default value is 1.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="median">
<h3 class="section">30.162 median</h3>
<p>Pick median pixel from certain rectangle defined by radius.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">radius</samp></dt>
<dd><p>Set horizontal radius size. Default value is <code class="code">1</code>.
Allowed range is integer from 1 to 127.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process. Default is <code class="code">15</code>, which is all available planes.
</p>
</dd>
<dt><samp class="option">radiusV</samp></dt>
<dd><p>Set vertical radius size. Default value is <code class="code">0</code>.
Allowed range is integer from 0 to 127.
If it is 0, value will be picked from horizontal <code class="code">radius</code> option.
</p>
</dd>
<dt><samp class="option">percentile</samp></dt>
<dd><p>Set median percentile. Default value is <code class="code">0.5</code>.
Default value of <code class="code">0.5</code> will pick always median values, while <code class="code">0</code> will pick
minimum values, and <code class="code">1</code> maximum values.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-119" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-119">
<h4 class="subsection">30.162.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
</div>
<div class="section-level-extent" id="mergeplanes">
<h3 class="section">30.163 mergeplanes</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 class="table">
<dt><samp class="option">mapping</samp></dt>
<dd><p>Set input to output plane mapping. Default is <code class="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><samp class="option">format</samp></dt>
<dd><p>Set output pixel format. Default is <code class="code">yuva444p</code>.
</p>
</dd>
<dt><samp class="option">map0s</samp></dt>
<dt><samp class="option">map1s</samp></dt>
<dt><samp class="option">map2s</samp></dt>
<dt><samp class="option">map3s</samp></dt>
<dd><p>Set input to output stream mapping for output Nth plane. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">map0p</samp></dt>
<dt><samp class="option">map1p</samp></dt>
<dt><samp class="option">map2p</samp></dt>
<dt><samp class="option">map3p</samp></dt>
<dd><p>Set input to output plane mapping for output Nth plane. Default is <code class="code">0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-111" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-111">
<h4 class="subsection">30.163.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Merge three gray video streams of same width and height into single video stream:
<div class="example">
<pre class="example-preformatted">[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-preformatted">[a0][a1]mergeplanes=0x00010210:yuva444p
</pre></div>
</li><li>Swap Y and A plane in yuva444p stream:
<div class="example">
<pre class="example-preformatted">format=yuva444p,mergeplanes=0x03010200:yuva444p
</pre></div>
</li><li>Swap U and V plane in yuv420p stream:
<div class="example">
<pre class="example-preformatted">format=yuv420p,mergeplanes=0x000201:yuv420p
</pre></div>
</li><li>Cast a rgb24 clip to yuv444p:
<div class="example">
<pre class="example-preformatted">format=rgb24,mergeplanes=0x000102:yuv444p
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="mestimate">
<h3 class="section">30.164 mestimate</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 class="table">
<dt><samp class="option">method</samp></dt>
<dd><p>Specify the motion estimation method. Accepts one of the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">esa</samp>’</dt>
<dd><p>Exhaustive search algorithm.
</p></dd>
<dt>‘<samp class="samp">tss</samp>’</dt>
<dd><p>Three step search algorithm.
</p></dd>
<dt>‘<samp class="samp">tdls</samp>’</dt>
<dd><p>Two dimensional logarithmic search algorithm.
</p></dd>
<dt>‘<samp class="samp">ntss</samp>’</dt>
<dd><p>New three step search algorithm.
</p></dd>
<dt>‘<samp class="samp">fss</samp>’</dt>
<dd><p>Four step search algorithm.
</p></dd>
<dt>‘<samp class="samp">ds</samp>’</dt>
<dd><p>Diamond search algorithm.
</p></dd>
<dt>‘<samp class="samp">hexbs</samp>’</dt>
<dd><p>Hexagon-based search algorithm.
</p></dd>
<dt>‘<samp class="samp">epzs</samp>’</dt>
<dd><p>Enhanced predictive zonal search algorithm.
</p></dd>
<dt>‘<samp class="samp">umh</samp>’</dt>
<dd><p>Uneven multi-hexagon search algorithm.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">esa</samp>’.
</p>
</dd>
<dt><samp class="option">mb_size</samp></dt>
<dd><p>Macroblock size. Default <code class="code">16</code>.
</p>
</dd>
<dt><samp class="option">search_param</samp></dt>
<dd><p>Search parameter. Default <code class="code">7</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="midequalizer">
<h3 class="section">30.165 midequalizer</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process. Default is <code class="code">15</code>, which is all available planes.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="minterpolate">
<h3 class="section">30.166 minterpolate</h3>
<p>Convert the video to specified frame rate using motion interpolation.
</p>
<p>This filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">fps</samp></dt>
<dd><p>Specify the output frame rate. This can be rational e.g. <code class="code">60000/1001</code>. Frames are dropped if <var class="var">fps</var> is lower than source fps. Default <code class="code">60</code>.
</p>
</dd>
<dt><samp class="option">mi_mode</samp></dt>
<dd><p>Motion interpolation mode. Following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">dup</samp>’</dt>
<dd><p>Duplicate previous or next frame for interpolating new ones.
</p></dd>
<dt>‘<samp class="samp">blend</samp>’</dt>
<dd><p>Blend source frames. Interpolated frame is mean of previous and next frames.
</p></dd>
<dt>‘<samp class="samp">mci</samp>’</dt>
<dd><p>Motion compensated interpolation. Following options are effective when this mode is selected:
</p>
<dl class="table">
<dt>‘<samp class="samp">mc_mode</samp>’</dt>
<dd><p>Motion compensation mode. Following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">obmc</samp>’</dt>
<dd><p>Overlapped block motion compensation.
</p></dd>
<dt>‘<samp class="samp">aobmc</samp>’</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 class="samp">obmc</samp>’.
</p>
</dd>
<dt>‘<samp class="samp">me_mode</samp>’</dt>
<dd><p>Motion estimation mode. Following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">bidir</samp>’</dt>
<dd><p>Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions.
</p></dd>
<dt>‘<samp class="samp">bilat</samp>’</dt>
<dd><p>Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame.
</p></dd>
</dl>
<p>Default mode is ‘<samp class="samp">bilat</samp>’.
</p>
</dd>
<dt>‘<samp class="samp">me</samp>’</dt>
<dd><p>The algorithm to be used for motion estimation. Following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">esa</samp>’</dt>
<dd><p>Exhaustive search algorithm.
</p></dd>
<dt>‘<samp class="samp">tss</samp>’</dt>
<dd><p>Three step search algorithm.
</p></dd>
<dt>‘<samp class="samp">tdls</samp>’</dt>
<dd><p>Two dimensional logarithmic search algorithm.
</p></dd>
<dt>‘<samp class="samp">ntss</samp>’</dt>
<dd><p>New three step search algorithm.
</p></dd>
<dt>‘<samp class="samp">fss</samp>’</dt>
<dd><p>Four step search algorithm.
</p></dd>
<dt>‘<samp class="samp">ds</samp>’</dt>
<dd><p>Diamond search algorithm.
</p></dd>
<dt>‘<samp class="samp">hexbs</samp>’</dt>
<dd><p>Hexagon-based search algorithm.
</p></dd>
<dt>‘<samp class="samp">epzs</samp>’</dt>
<dd><p>Enhanced predictive zonal search algorithm.
</p></dd>
<dt>‘<samp class="samp">umh</samp>’</dt>
<dd><p>Uneven multi-hexagon search algorithm.
</p></dd>
</dl>
<p>Default algorithm is ‘<samp class="samp">epzs</samp>’.
</p>
</dd>
<dt>‘<samp class="samp">mb_size</samp>’</dt>
<dd><p>Macroblock size. Default <code class="code">16</code>.
</p>
</dd>
<dt>‘<samp class="samp">search_param</samp>’</dt>
<dd><p>Motion estimation search parameter. Default <code class="code">32</code>.
</p>
</dd>
<dt>‘<samp class="samp">vsbmc</samp>’</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 class="code">0</code> (disabled).
</p></dd>
</dl>
</dd>
</dl>
</dd>
<dt><samp class="option">scd</samp></dt>
<dd><p>Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disable scene change detection.
</p></dd>
<dt>‘<samp class="samp">fdiff</samp>’</dt>
<dd><p>Frame difference. Corresponding pixel values are compared and if it satisfies <var class="var">scd_threshold</var> scene change is detected.
</p></dd>
</dl>
<p>Default method is ‘<samp class="samp">fdiff</samp>’.
</p>
</dd>
<dt><samp class="option">scd_threshold</samp></dt>
<dd><p>Scene change detection threshold. Default is <code class="code">10.</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="mix">
<h3 class="section">30.167 mix</h3>
<p>Mix several video input streams into one video stream.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>The number of inputs. If unspecified, it defaults to 2.
</p>
</dd>
<dt><samp class="option">weights</samp></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 class="var">frames</var> last specified
weight will be used for all remaining unset weights.
</p>
</dd>
<dt><samp class="option">scale</samp></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 class="var">scale</var> is auto scaled to sum of weights.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>Specify how end of stream is determined.
</p><dl class="table">
<dt>‘<samp class="samp">longest</samp>’</dt>
<dd><p>The duration of the longest input. (default)
</p>
</dd>
<dt>‘<samp class="samp">shortest</samp>’</dt>
<dd><p>The duration of the shortest input.
</p>
</dd>
<dt>‘<samp class="samp">first</samp>’</dt>
<dd><p>The duration of the first input.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-120" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-120">
<h4 class="subsection">30.167.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">weights</samp></dt>
<dt><samp class="option">scale</samp></dt>
<dt><samp class="option">planes</samp></dt>
<dd><p>Syntax is same as option with same name.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="monochrome">
<h3 class="section">30.168 monochrome</h3>
<p>Convert video to gray using custom color filter.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">cb</samp></dt>
<dd><p>Set the chroma blue spot. Allowed range is from -1 to 1.
Default value is 0.
</p>
</dd>
<dt><samp class="option">cr</samp></dt>
<dd><p>Set the chroma red spot. Allowed range is from -1 to 1.
Default value is 0.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set the color filter size. Allowed range is from .1 to 10.
Default value is 1.
</p>
</dd>
<dt><samp class="option">high</samp></dt>
<dd><p>Set the highlights strength. Allowed range is from 0 to 1.
Default value is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-121" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-121">
<h4 class="subsection">30.168.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="morpho">
<h3 class="section">30.169 morpho</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 class="ref" href="#erosion">erosion</a>
and <a class="ref" href="#dilation">dilation</a> filters, when speed is critical <code class="code">morpho</code> filter
should be used instead.
</p>
<p>A description of accepted options follows,
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set morphological transform to apply, can be:
</p>
<dl class="table">
<dt>‘<samp class="samp">erode</samp>’</dt>
<dt>‘<samp class="samp">dilate</samp>’</dt>
<dt>‘<samp class="samp">open</samp>’</dt>
<dt>‘<samp class="samp">close</samp>’</dt>
<dt>‘<samp class="samp">gradient</samp>’</dt>
<dt>‘<samp class="samp">tophat</samp>’</dt>
<dt>‘<samp class="samp">blackhat</samp>’</dt>
</dl>
<p>Default is <code class="code">erode</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set planes to filter, by default all planes except alpha are filtered.
</p>
</dd>
<dt><samp class="option">structure</samp></dt>
<dd><p>Set which structure video frames will be processed from second input stream,
can be <var class="var">first</var> or <var class="var">all</var>. Default is <var class="var">all</var>.
</p></dd>
</dl>
<p>The <code class="code">morpho</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<ul class="mini-toc">
<li><a href="#Commands-122" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-122">
<h4 class="subsection">30.169.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="mpdecimate">
<h3 class="section">30.170 mpdecimate</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 class="table">
<dt><samp class="option">max</samp></dt>
<dd><p>Set the maximum number of consecutive frames which can be dropped (if
positive), or the minimum interval between dropped frames (if
negative). If the value is 0, the frame is dropped disregarding the
number of previous sequentially dropped frames.
</p>
<p>Default value is 0.
</p>
</dd>
<dt><samp class="option">keep</samp></dt>
<dd><p>Set the maximum number of consecutive similar frames to ignore before to start dropping them.
If the value is 0, the frame is dropped disregarding the
number of previous sequentially similar frames.
</p>
<p>Default value is 0.
</p>
</dd>
<dt><samp class="option">hi</samp></dt>
<dt><samp class="option">lo</samp></dt>
<dt><samp class="option">frac</samp></dt>
<dd><p>Set the dropping threshold values.
</p>
<p>Values for <samp class="option">hi</samp> and <samp class="option">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 class="option">hi</samp>, and if no more than <samp class="option">frac</samp> blocks (1
meaning the whole image) differ by more than a threshold of <samp class="option">lo</samp>.
</p>
<p>Default value for <samp class="option">hi</samp> is 64*12, default value for <samp class="option">lo</samp> is
64*5, and default value for <samp class="option">frac</samp> is 0.33.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="msad">
<h3 class="section">30.171 msad</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>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<p>In the below example the input file <samp class="file">main.mpg</samp> being processed is compared
with the reference file <samp class="file">ref.mpg</samp>.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i main.mpg -i ref.mpg -lavfi msad -f null -
</pre></div>
</div>
<div class="section-level-extent" id="multiply">
<h3 class="section">30.172 multiply</h3>
<p>Multiply first video stream pixels values with second video stream pixels values.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">scale</samp></dt>
<dd><p>Set the scale applied to second video stream. By default is <code class="code">1</code>.
Allowed range is from <code class="code">0</code> to <code class="code">9</code>.
</p>
</dd>
<dt><samp class="option">offset</samp></dt>
<dd><p>Set the offset applied to second video stream. By default is <code class="code">0.5</code>.
Allowed range is from <code class="code">-1</code> to <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Specify planes from input video stream that will be processed.
By default all planes are processed.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-123" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-123">
<h4 class="subsection">30.172.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="negate">
<h3 class="section">30.173 negate</h3>
<p>Negate (invert) the input video.
</p>
<p>It accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">components</samp></dt>
<dd><p>Set components to negate.
</p>
<p>Available values for components are:
</p><dl class="table">
<dt>‘<samp class="samp">y</samp>’</dt>
<dt>‘<samp class="samp">u</samp>’</dt>
<dt>‘<samp class="samp">v</samp>’</dt>
<dt>‘<samp class="samp">a</samp>’</dt>
<dt>‘<samp class="samp">r</samp>’</dt>
<dt>‘<samp class="samp">g</samp>’</dt>
<dt>‘<samp class="samp">b</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">negate_alpha</samp></dt>
<dd><p>With value 1, it negates the alpha component, if present. Default value is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-124" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-124">
<h4 class="subsection">30.173.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
<a class="anchor" id="nlmeans"></a></div>
</div>
<div class="section-level-extent" id="nlmeans-1">
<h3 class="section">30.174 nlmeans</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 class="option">p</samp>x<samp class="option">p</samp>. Patches are searched in an area of <samp class="option">r</samp>x<samp class="option">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 class="table">
<dt><samp class="option">s</samp></dt>
<dd><p>Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0].
</p>
</dd>
<dt><samp class="option">p</samp></dt>
<dd><p>Set patch size. Default is 7. Must be odd number in range [0, 99].
</p>
</dd>
<dt><samp class="option">pc</samp></dt>
<dd><p>Same as <samp class="option">p</samp> but for chroma planes.
</p>
<p>The default value is <var class="var">0</var> and means automatic.
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>Set research size. Default is 15. Must be odd number in range [0, 99].
</p>
</dd>
<dt><samp class="option">rc</samp></dt>
<dd><p>Same as <samp class="option">r</samp> but for chroma planes.
</p>
<p>The default value is <var class="var">0</var> and means automatic.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="nnedi">
<h3 class="section">30.175 nnedi</h3>
<p>Deinterlace video using neural network edge directed interpolation.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">weights</samp></dt>
<dd><p>Mandatory option, without binary file filter can not work.
Currently file can be found here:
https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Set which frames to deinterlace, by default it is <code class="code">all</code>.
Can be <code class="code">all</code> or <code class="code">interlaced</code>.
</p>
</dd>
<dt><samp class="option">field</samp></dt>
<dd><p>Set mode of operation.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">af</samp>’</dt>
<dd><p>Use frame flags, both fields.
</p></dd>
<dt>‘<samp class="samp">a</samp>’</dt>
<dd><p>Use frame flags, single field.
</p></dd>
<dt>‘<samp class="samp">t</samp>’</dt>
<dd><p>Use top field only.
</p></dd>
<dt>‘<samp class="samp">b</samp>’</dt>
<dd><p>Use bottom field only.
</p></dd>
<dt>‘<samp class="samp">tf</samp>’</dt>
<dd><p>Use both fields, top first.
</p></dd>
<dt>‘<samp class="samp">bf</samp>’</dt>
<dd><p>Use both fields, bottom first.
</p></dd>
</dl>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process, by default filter process all frames.
</p>
</dd>
<dt><samp class="option">nsize</samp></dt>
<dd><p>Set size of local neighborhood around each pixel, used by the predictor neural
network.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">s8x6</samp>’</dt>
<dt>‘<samp class="samp">s16x6</samp>’</dt>
<dt>‘<samp class="samp">s32x6</samp>’</dt>
<dt>‘<samp class="samp">s48x6</samp>’</dt>
<dt>‘<samp class="samp">s8x4</samp>’</dt>
<dt>‘<samp class="samp">s16x4</samp>’</dt>
<dt>‘<samp class="samp">s32x4</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">nns</samp></dt>
<dd><p>Set the number of neurons in predictor neural network.
Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">n16</samp>’</dt>
<dt>‘<samp class="samp">n32</samp>’</dt>
<dt>‘<samp class="samp">n64</samp>’</dt>
<dt>‘<samp class="samp">n128</samp>’</dt>
<dt>‘<samp class="samp">n256</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">qual</samp></dt>
<dd><p>Controls the number of different neural network predictions that are blended
together to compute the final output value. Can be <code class="code">fast</code>, default or
<code class="code">slow</code>.
</p>
</dd>
<dt><samp class="option">etype</samp></dt>
<dd><p>Set which set of weights to use in the predictor.
Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">a, abs</samp>’</dt>
<dd><p>weights trained to minimize absolute error
</p></dd>
<dt>‘<samp class="samp">s, mse</samp>’</dt>
<dd><p>weights trained to minimize squared error
</p></dd>
</dl>
</dd>
<dt><samp class="option">pscrn</samp></dt>
<dd><p>Controls whether or not the prescreener neural network is used to decide
which pixels should be processed by the predictor neural network and which
can be handled by simple cubic interpolation.
The prescreener is trained to know whether cubic interpolation will be
sufficient for a pixel or whether it should be predicted by the predictor nn.
The computational complexity of the prescreener nn is much less than that of
the predictor nn. Since most pixels can be handled by cubic interpolation,
using the prescreener generally results in much faster processing.
The prescreener is pretty accurate, so the difference between using it and not
using it is almost always unnoticeable.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dt>‘<samp class="samp">original</samp>’</dt>
<dt>‘<samp class="samp">new</samp>’</dt>
<dt>‘<samp class="samp">new2</samp>’</dt>
<dt>‘<samp class="samp">new3</samp>’</dt>
</dl>
<p>Default is <code class="code">new</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-125" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-125">
<h4 class="subsection">30.175.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options, excluding <var class="var">weights</var> option.
</p>
</div>
</div>
<div class="section-level-extent" id="noformat">
<h3 class="section">30.176 noformat</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 class="table">
<dt><samp class="option">pix_fmts</samp></dt>
<dd><p>A ’|’-separated list of pixel format names, such as
pix_fmts=yuv420p|monow|rgb24".
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-112" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-112">
<h4 class="subsection">30.176.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Force libavfilter to use a format different from <var class="var">yuv420p</var> for the
input to the vflip filter:
<div class="example">
<pre class="example-preformatted">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-preformatted">noformat=yuv420p|yuv444p|yuv410p
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="noise-1">
<h3 class="section">30.177 noise</h3>
<p>Add noise on video input frame.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">all_seed</samp></dt>
<dt><samp class="option">c0_seed</samp></dt>
<dt><samp class="option">c1_seed</samp></dt>
<dt><samp class="option">c2_seed</samp></dt>
<dt><samp class="option">c3_seed</samp></dt>
<dd><p>Set noise seed for specific pixel component or all pixel components in case
of <var class="var">all_seed</var>. Default value is <code class="code">123457</code>.
</p>
</dd>
<dt><samp class="option">all_strength, alls</samp></dt>
<dt><samp class="option">c0_strength, c0s</samp></dt>
<dt><samp class="option">c1_strength, c1s</samp></dt>
<dt><samp class="option">c2_strength, c2s</samp></dt>
<dt><samp class="option">c3_strength, c3s</samp></dt>
<dd><p>Set noise strength for specific pixel component or all pixel components in case
<var class="var">all_strength</var>. Default value is <code class="code">0</code>. Allowed range is [0, 100].
</p>
</dd>
<dt><samp class="option">all_flags, allf</samp></dt>
<dt><samp class="option">c0_flags, c0f</samp></dt>
<dt><samp class="option">c1_flags, c1f</samp></dt>
<dt><samp class="option">c2_flags, c2f</samp></dt>
<dt><samp class="option">c3_flags, c3f</samp></dt>
<dd><p>Set pixel component flags or set flags for all components if <var class="var">all_flags</var>.
Available values for component flags are:
</p><dl class="table">
<dt>‘<samp class="samp">a</samp>’</dt>
<dd><p>averaged temporal noise (smoother)
</p></dd>
<dt>‘<samp class="samp">p</samp>’</dt>
<dd><p>mix random noise with a (semi)regular pattern
</p></dd>
<dt>‘<samp class="samp">t</samp>’</dt>
<dd><p>temporal noise (noise pattern changes between frames)
</p></dd>
<dt>‘<samp class="samp">u</samp>’</dt>
<dd><p>uniform noise (gaussian otherwise)
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-113" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-113">
<h4 class="subsection">30.177.1 Examples</h4>
<p>Add temporal and uniform noise to input video:
</p><div class="example">
<pre class="example-preformatted">noise=alls=20:allf=t+u
</pre></div>
</div>
</div>
<div class="section-level-extent" id="normalize">
<h3 class="section">30.178 normalize</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 class="table">
<dt><samp class="option">blackpt</samp></dt>
<dt><samp class="option">whitept</samp></dt>
<dd><p>Colors which define the output range. The minimum input value is mapped to
the <var class="var">blackpt</var>. The maximum input value is mapped to the <var class="var">whitept</var>.
The defaults are black and white respectively. Specifying white for
<var class="var">blackpt</var> and black for <var class="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><samp class="option">smoothing</samp></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 class="var">smoothing</var> previous frames. The default is 0 (no temporal
smoothing).
</p>
</dd>
<dt><samp class="option">independence</samp></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><samp class="option">strength</samp></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>
<ul class="mini-toc">
<li><a href="#Commands-126" accesskey="1">Commands</a></li>
<li><a href="#Examples-114" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-126">
<h4 class="subsection">30.178.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options, excluding <var class="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>
</div>
<div class="subsection-level-extent" id="Examples-114">
<h4 class="subsection">30.178.2 Examples</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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">normalize=blackpt=red:whitept=cyan
</pre></div>
</div>
</div>
<div class="section-level-extent" id="null-1">
<h3 class="section">30.179 null</h3>
<p>Pass the video source unchanged to the output.
</p>
</div>
<div class="section-level-extent" id="ocr">
<h3 class="section">30.180 ocr</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 class="code">--enable-libtesseract</code>.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">datapath</samp></dt>
<dd><p>Set datapath to tesseract data. Default is to use whatever was
set at installation.
</p>
</dd>
<dt><samp class="option">language</samp></dt>
<dd><p>Set language, default is "eng".
</p>
</dd>
<dt><samp class="option">whitelist</samp></dt>
<dd><p>Set character whitelist.
</p>
</dd>
<dt><samp class="option">blacklist</samp></dt>
<dd><p>Set character blacklist.
</p></dd>
</dl>
<p>The filter exports recognized text as the frame metadata <code class="code">lavfi.ocr.text</code>.
The filter exports confidence of recognized words as the frame metadata <code class="code">lavfi.ocr.confidence</code>.
</p>
</div>
<div class="section-level-extent" id="ocv">
<h3 class="section">30.181 ocv</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 class="code">--enable-libopencv</code>.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">filter_name</samp></dt>
<dd><p>The name of the libopencv filter to apply.
</p>
</dd>
<dt><samp class="option">filter_params</samp></dt>
<dd><p>The parameters to pass to the libopencv filter. If not specified, the default
values are assumed.
</p>
</dd>
</dl>
<p>Refer to the official libopencv documentation for more precise
information:
<a class="url" href="http://docs.opencv.org/master/modules/imgproc/doc/filtering.html">http://docs.opencv.org/master/modules/imgproc/doc/filtering.html</a>
</p>
<p>Several libopencv filters are supported; see the following subsections.
</p>
<a class="anchor" id="dilate"></a><ul class="mini-toc">
<li><a href="#dilate-1" accesskey="1">dilate</a></li>
<li><a href="#erode" accesskey="2">erode</a></li>
<li><a href="#smooth" accesskey="3">smooth</a></li>
</ul>
<div class="subsection-level-extent" id="dilate-1">
<h4 class="subsection">30.181.1 dilate</h4>
<p>Dilate an image by using a specific structuring element.
It corresponds to the libopencv function <code class="code">cvDilate</code>.
</p>
<p>It accepts the parameters: <var class="var">struct_el</var>|<var class="var">nb_iterations</var>.
</p>
<p><var class="var">struct_el</var> represents a structuring element, and has the syntax:
<var class="var">cols</var>x<var class="var">rows</var>+<var class="var">anchor_x</var>x<var class="var">anchor_y</var>/<var class="var">shape</var>
</p>
<p><var class="var">cols</var> and <var class="var">rows</var> represent the number of columns and rows of
the structuring element, <var class="var">anchor_x</var> and <var class="var">anchor_y</var> the anchor
point, and <var class="var">shape</var> the shape for the structuring element. <var class="var">shape</var>
must be "rect", "cross", "ellipse", or "custom".
</p>
<p>If the value for <var class="var">shape</var> is "custom", it must be followed by a
string of the form "=<var class="var">filename</var>". The file with name
<var class="var">filename</var> is assumed to represent a binary image, with each
printable character corresponding to a bright pixel. When a custom
<var class="var">shape</var> is used, <var class="var">cols</var> and <var class="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 class="var">struct_el</var> is "3x3+0x0/rect".
</p>
<p><var class="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-preformatted"># 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>
</div>
<div class="subsection-level-extent" id="erode">
<h4 class="subsection">30.181.2 erode</h4>
<p>Erode an image by using a specific structuring element.
It corresponds to the libopencv function <code class="code">cvErode</code>.
</p>
<p>It accepts the parameters: <var class="var">struct_el</var>:<var class="var">nb_iterations</var>,
with the same syntax and semantics as the <a class="ref" href="#dilate">dilate</a> filter.
</p>
</div>
<div class="subsection-level-extent" id="smooth">
<h4 class="subsection">30.181.3 smooth</h4>
<p>Smooth the input video.
</p>
<p>The filter takes the following parameters:
<var class="var">type</var>|<var class="var">param1</var>|<var class="var">param2</var>|<var class="var">param3</var>|<var class="var">param4</var>.
</p>
<p><var class="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 class="var">param1</var>, <var class="var">param2</var>, <var class="var">param3</var>, and <var class="var">param4</var>
depends on the smooth type. <var class="var">param1</var> and
<var class="var">param2</var> accept integer positive values or 0. <var class="var">param3</var> and
<var class="var">param4</var> accept floating point values.
</p>
<p>The default value for <var class="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 class="code">cvSmooth</code>.
</p>
</div>
</div>
<div class="section-level-extent" id="oscilloscope">
<h3 class="section">30.182 oscilloscope</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 class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Set scope center x position.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set scope center y position.
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>Set scope size, relative to frame diagonal.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>Set scope tilt/rotation.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Set trace opacity.
</p>
</dd>
<dt><samp class="option">tx</samp></dt>
<dd><p>Set trace center x position.
</p>
</dd>
<dt><samp class="option">ty</samp></dt>
<dd><p>Set trace center y position.
</p>
</dd>
<dt><samp class="option">tw</samp></dt>
<dd><p>Set trace width, relative to width of frame.
</p>
</dd>
<dt><samp class="option">th</samp></dt>
<dd><p>Set trace height, relative to height of frame.
</p>
</dd>
<dt><samp class="option">c</samp></dt>
<dd><p>Set which components to trace. By default it traces first three components.
</p>
</dd>
<dt><samp class="option">g</samp></dt>
<dd><p>Draw trace grid. By default is enabled.
</p>
</dd>
<dt><samp class="option">st</samp></dt>
<dd><p>Draw some statistics. By default is enabled.
</p>
</dd>
<dt><samp class="option">sc</samp></dt>
<dd><p>Draw scope. By default is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-127" accesskey="1">Commands</a></li>
<li><a href="#Examples-115" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-127">
<h4 class="subsection">30.182.1 Commands</h4>
<p>This filter supports same <a class="ref" 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>
</div>
<div class="subsection-level-extent" id="Examples-115">
<h4 class="subsection">30.182.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Inspect full first row of video frame.
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">oscilloscope=x=1:y=0.5:s=1:t=1
</pre></div>
</li></ul>
<a class="anchor" id="overlay"></a></div>
</div>
<div class="section-level-extent" id="overlay-1">
<h3 class="section">30.183 overlay</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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Set the expression for the x and y coordinates of the overlaid video
on the main video. Default value is "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><samp class="option">eof_action</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set when the expressions for <samp class="option">x</samp>, and <samp class="option">y</samp> are evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">frame</samp>’.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>Set the format for the output video.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">yuv420</samp>’</dt>
<dd><p>force YUV 4:2:0 8-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">yuv420p10</samp>’</dt>
<dd><p>force YUV 4:2:0 10-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">yuv422</samp>’</dt>
<dd><p>force YUV 4:2:2 8-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">yuv422p10</samp>’</dt>
<dd><p>force YUV 4:2:2 10-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">yuv444</samp>’</dt>
<dd><p>force YUV 4:4:4 8-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">yuv444p10</samp>’</dt>
<dd><p>force YUV 4:4:4 10-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">rgb</samp>’</dt>
<dd><p>force RGB 8-bit packed output
</p>
</dd>
<dt>‘<samp class="samp">gbrp</samp>’</dt>
<dd><p>force RGB 8-bit planar output
</p>
</dd>
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>automatically pick format
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">yuv420</samp>’.
</p>
</dd>
<dt><samp class="option">repeatlast</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>Set format of alpha of the overlaid video, it can be <var class="var">straight</var> or
<var class="var">premultiplied</var>. Default is <var class="var">straight</var>.
</p></dd>
</dl>
<p>The <samp class="option">x</samp>, and <samp class="option">y</samp> expressions can contain the following
parameters.
</p>
<dl class="table">
<dt><samp class="option">main_w, W</samp></dt>
<dt><samp class="option">main_h, H</samp></dt>
<dd><p>The main input width and height.
</p>
</dd>
<dt><samp class="option">overlay_w, w</samp></dt>
<dt><samp class="option">overlay_h, h</samp></dt>
<dd><p>The overlay input width and height.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The computed values for <var class="var">x</var> and <var class="var">y</var>. They are evaluated for
each new frame.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values of the output
format. For example for the pixel format "yuv422p" <var class="var">hsub</var> is 2 and
<var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown; deprecated,
do not use
</p>
</dd>
<dt><samp class="option">t</samp></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 class="ref" href="#framesync">framesync</a> options.
</p>
<p>Note that the <var class="var">n</var>, <var class="var">t</var> variables are available only
when evaluation is done <em class="emph">per frame</em>, and will evaluate to NAN
when <samp class="option">eval</samp> is set to ‘<samp class="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 class="var">setpts=PTS-STARTPTS</var> filter to
have them begin in the same zero timestamp, as the example for
the <var class="var">movie</var> filter does.
</p>
<p>You can chain together more overlays but you should test the
efficiency of such approach.
</p>
<ul class="mini-toc">
<li><a href="#Commands-128" accesskey="1">Commands</a></li>
<li><a href="#Examples-116" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-128">
<h4 class="subsection">30.183.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Modify the x and y of the overlay input.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-116">
<h4 class="subsection">30.183.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Draw the overlay at 10 pixels from the bottom right corner of the main
video:
<div class="example">
<pre class="example-preformatted">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-preformatted">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 class="command">ffmpeg</code> tool with the <code class="code">-filter_complex</code> option:
<div class="example">
<pre class="example-preformatted">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 class="command">ffmpeg</code> tool:
<div class="example">
<pre class="example-preformatted">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 class="code">WxH</code>
must specify the size of the main input to the overlay filter:
<div class="example">
<pre class="example-preformatted">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 class="command">ffplay</code> tool:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">nullsrc=s=200x200 [bg];
testsrc=s=100x100, split=4 [in0][in1][in2][in3];
[in0] lutrgb=r=0, [bg] overlay=0:0 [mid0];
[in1] lutrgb=g=0, [mid0] overlay=100:0 [mid1];
[in2] lutrgb=b=0, [mid1] overlay=0:100 [mid2];
[in3] null, [mid2] overlay=100:100 [out0]
</pre></div>
</li></ul>
<a class="anchor" id="overlay_005fcuda"></a></div>
</div>
<div class="section-level-extent" id="overlay_005fcuda-1">
<h3 class="section">30.184 overlay_cuda</h3>
<p>Overlay one video on top of another.
</p>
<p>This is the CUDA variant of the <a class="ref" 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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></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 class="table">
<dt><samp class="option">main_w, W</samp></dt>
<dt><samp class="option">main_h, H</samp></dt>
<dd><p>The main input width and height.
</p>
</dd>
<dt><samp class="option">overlay_w, w</samp></dt>
<dt><samp class="option">overlay_h, h</samp></dt>
<dd><p>The overlay input width and height.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The computed values for <var class="var">x</var> and <var class="var">y</var>. They are evaluated for
each new frame.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>The ordinal index of the main input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>The byte offset position in the file of the main input frame, NAN if unknown.
Deprecated, do not use.
</p>
</dd>
<dt><samp class="option">t</samp></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><samp class="option">eval</samp></dt>
<dd><p>Set when the expressions for <samp class="option">x</samp> and <samp class="option">y</samp> are evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt><samp class="option">init</samp></dt>
<dd><p>Evaluate expressions once during filter initialization or
when a command is processed.
</p>
</dd>
<dt><samp class="option">frame</samp></dt>
<dd><p>Evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is <samp class="option">frame</samp>.
</p>
</dd>
<dt><samp class="option">eof_action</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">repeatlast</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
</dl>
<p>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
</div>
<div class="section-level-extent" id="owdenoise">
<h3 class="section">30.185 owdenoise</h3>
<p>Apply Overcomplete Wavelet denoiser.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">depth</samp></dt>
<dd><p>Set depth.
</p>
<p>Larger depth values will denoise lower frequency components more, but
slow down filtering.
</p>
<p>Must be an int in the range 8-16, default is <code class="code">8</code>.
</p>
</dd>
<dt><samp class="option">luma_strength, ls</samp></dt>
<dd><p>Set luma strength.
</p>
<p>Must be a double value in the range 0-1000, default is <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">chroma_strength, cs</samp></dt>
<dd><p>Set chroma strength.
</p>
<p>Must be a double value in the range 0-1000, default is <code class="code">1.0</code>.
</p></dd>
</dl>
<a class="anchor" id="pad"></a></div>
<div class="section-level-extent" id="pad-1">
<h3 class="section">30.186 pad</h3>
<p>Add paddings to the input image, and place the original input at the
provided <var class="var">x</var>, <var class="var">y</var> coordinates.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Specify an expression for the size of the output image with the
paddings added. If the value for <var class="var">width</var> or <var class="var">height</var> is 0, the
corresponding input size is used for the output.
</p>
<p>The <var class="var">width</var> expression can reference the value set by the
<var class="var">height</var> expression, and vice versa.
</p>
<p>The default value of <var class="var">width</var> and <var class="var">height</var> is 0.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Specify the offsets to place the input image at within the padded area,
with respect to the top/left border of the output image.
</p>
<p>The <var class="var">x</var> expression can reference the value set by the <var class="var">y</var>
expression, and vice versa.
</p>
<p>The default value of <var class="var">x</var> and <var class="var">y</var> is 0.
</p>
<p>If <var class="var">x</var> or <var class="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><samp class="option">color</samp></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 class="var">color</var> is "black".
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Specify when to evaluate <var class="var">width</var>, <var class="var">height</var>, <var class="var">x</var> and <var class="var">y</var> expression.
</p>
<p>It accepts the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>Only evaluate expressions once during the filter initialization or when
a command is processed.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Evaluate expressions for each incoming frame.
</p>
</dd>
</dl>
<p>Default value is ‘<samp class="samp">init</samp>’.
</p>
</dd>
<dt><samp class="option">aspect</samp></dt>
<dd><p>Pad to aspect instead to a resolution.
</p>
</dd>
</dl>
<p>The value for the <var class="var">width</var>, <var class="var">height</var>, <var class="var">x</var>, and <var class="var">y</var>
options are expressions containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">in_w</samp></dt>
<dt><samp class="option">in_h</samp></dt>
<dd><p>The input video width and height.
</p>
</dd>
<dt><samp class="option">iw</samp></dt>
<dt><samp class="option">ih</samp></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><samp class="option">out_w</samp></dt>
<dt><samp class="option">out_h</samp></dt>
<dd><p>The output width and height (the size of the padded area), as
specified by the <var class="var">width</var> and <var class="var">height</var> expressions.
</p>
</dd>
<dt><samp class="option">ow</samp></dt>
<dt><samp class="option">oh</samp></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The x and y offsets as specified by the <var class="var">x</var> and <var class="var">y</var>
expressions, or NAN if not yet specified.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var class="var">iw</var> / <var class="var">ih</var>) * <var class="var">sar</var>
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>The horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-117" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-117">
<h4 class="subsection">30.186.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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 class="var">sar</var> in the expression,
according to the relation:
<div class="example">
<pre class="example-preformatted">(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-preformatted">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-preformatted">pad="2*iw:2*ih:ow-iw:oh-ih"
</pre></div>
</li></ul>
<a class="anchor" id="palettegen"></a></div>
</div>
<div class="section-level-extent" id="palettegen-1">
<h3 class="section">30.187 palettegen</h3>
<p>Generate one palette for a whole video stream.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">max_colors</samp></dt>
<dd><p>Set the maximum number of colors to quantize in the palette.
Note: the palette will still contain 256 colors; the unused palette entries
will be black.
</p>
</dd>
<dt><samp class="option">reserve_transparent</samp></dt>
<dd><p>Create a palette of 255 colors maximum and reserve the last one for
transparency. Reserving the transparency color is useful for GIF optimization.
If not set, the maximum of colors in the palette will be 256. You probably want
to disable this option for a standalone image.
Set by default.
</p>
</dd>
<dt><samp class="option">transparency_color</samp></dt>
<dd><p>Set the color that will be used as background for transparency.
</p>
</dd>
<dt><samp class="option">stats_mode</samp></dt>
<dd><p>Set statistics mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>Compute full frame histograms.
</p></dd>
<dt>‘<samp class="samp">diff</samp>’</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>‘<samp class="samp">single</samp>’</dt>
<dd><p>Compute new histogram for each frame.
</p></dd>
</dl>
<p>Default value is <var class="var">full</var>.
</p></dd>
</dl>
<p>The filter also exports the frame metadata <code class="code">lavfi.color_quant_ratio</code>
(<code class="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 class="var">info</var> logging level.
</p>
<ul class="mini-toc">
<li><a href="#Examples-118" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-118">
<h4 class="subsection">30.187.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Generate a representative palette of a given video using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i input.mkv -vf palettegen palette.png
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="paletteuse">
<h3 class="section">30.188 paletteuse</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 class="table">
<dt><samp class="option">dither</samp></dt>
<dd><p>Select dithering mode. Available algorithms are:
</p><dl class="table">
<dt>‘<samp class="samp">bayer</samp>’</dt>
<dd><p>Ordered 8x8 bayer dithering (deterministic)
</p></dd>
<dt>‘<samp class="samp">heckbert</samp>’</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>‘<samp class="samp">floyd_steinberg</samp>’</dt>
<dd><p>Floyd and Steingberg dithering (error diffusion)
</p></dd>
<dt>‘<samp class="samp">sierra2</samp>’</dt>
<dd><p>Frankie Sierra dithering v2 (error diffusion)
</p></dd>
<dt>‘<samp class="samp">sierra2_4a</samp>’</dt>
<dd><p>Frankie Sierra dithering v2 "Lite" (error diffusion)
</p></dd>
<dt>‘<samp class="samp">sierra3</samp>’</dt>
<dd><p>Frankie Sierra dithering v3 (error diffusion)
</p></dd>
<dt>‘<samp class="samp">burkes</samp>’</dt>
<dd><p>Burkes dithering (error diffusion)
</p></dd>
<dt>‘<samp class="samp">atkinson</samp>’</dt>
<dd><p>Atkinson dithering by Bill Atkinson at Apple Computer (error diffusion)
</p></dd>
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disable dithering.
</p></dd>
</dl>
<p>Default is <var class="var">sierra2_4a</var>.
</p>
</dd>
<dt><samp class="option">bayer_scale</samp></dt>
<dd><p>When <var class="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 class="var">2</var>.
</p>
</dd>
<dt><samp class="option">diff_mode</samp></dt>
<dd><p>If set, define the zone to process
</p>
<dl class="table">
<dt>‘<samp class="samp">rectangle</samp>’</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 class="option">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 class="var">none</var>.
</p>
</dd>
<dt><samp class="option">new</samp></dt>
<dd><p>Take new palette for each output frame.
</p>
</dd>
<dt><samp class="option">alpha_threshold</samp></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 class="var">128</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-119" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-119">
<h4 class="subsection">30.188.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use a palette (generated for example with <a class="ref" href="#palettegen">palettegen</a>) to encode a GIF
using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="perspective">
<h3 class="section">30.189 perspective</h3>
<p>Correct perspective of video not recorded perpendicular to the screen.
</p>
<p>A description of the accepted parameters follows.
</p>
<dl class="table">
<dt><samp class="option">x0</samp></dt>
<dt><samp class="option">y0</samp></dt>
<dt><samp class="option">x1</samp></dt>
<dt><samp class="option">y1</samp></dt>
<dt><samp class="option">x2</samp></dt>
<dt><samp class="option">y2</samp></dt>
<dt><samp class="option">x3</samp></dt>
<dt><samp class="option">y3</samp></dt>
<dd><p>Set coordinates expression for top left, top right, bottom left and bottom right corners.
Default values are <code class="code">0:0:W:0:0:H:W:H</code> with which perspective will remain unchanged.
If the <code class="code">sense</code> option is set to <code class="code">source</code>, then the specified points will be sent
to the corners of the destination. If the <code class="code">sense</code> option is set to <code class="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 class="table">
<dt><samp class="option">W</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>the width and height of video frame.
</p></dd>
<dt><samp class="option">in</samp></dt>
<dd><p>Input frame count.
</p></dd>
<dt><samp class="option">on</samp></dt>
<dd><p>Output frame count.
</p></dd>
</dl>
</dd>
<dt><samp class="option">interpolation</samp></dt>
<dd><p>Set interpolation for perspective correction.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">linear</samp>’</dt>
<dt>‘<samp class="samp">cubic</samp>’</dt>
</dl>
<p>Default value is ‘<samp class="samp">linear</samp>’.
</p>
</dd>
<dt><samp class="option">sense</samp></dt>
<dd><p>Set interpretation of coordinate options.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">0, source</samp>’</dt>
<dd>
<p>Send point in the source specified by the given coordinates to
the corners of the destination.
</p>
</dd>
<dt>‘<samp class="samp">1, destination</samp>’</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 class="samp">source</samp>’.
</p></dd>
</dl>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set when the expressions for coordinates <samp class="option">x0,y0,...x3,y3</samp> are evaluated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>only evaluate expressions once during the filter initialization or
when a command is processed
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>evaluate expressions for each incoming frame
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">init</samp>’.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="phase">
<h3 class="section">30.190 phase</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set phase mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">t</samp>’</dt>
<dd><p>Capture field order top-first, transfer bottom-first.
Filter will delay the bottom field.
</p>
</dd>
<dt>‘<samp class="samp">b</samp>’</dt>
<dd><p>Capture field order bottom-first, transfer top-first.
Filter will delay the top field.
</p>
</dd>
<dt>‘<samp class="samp">p</samp>’</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>‘<samp class="samp">a</samp>’</dt>
<dd><p>Capture field order determined automatically by field flags, transfer
opposite.
Filter selects among ‘<samp class="samp">t</samp>’ and ‘<samp class="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 class="samp">u</samp>’.
</p>
</dd>
<dt>‘<samp class="samp">u</samp>’</dt>
<dd><p>Capture unknown or varying, transfer opposite.
Filter selects among ‘<samp class="samp">t</samp>’ and ‘<samp class="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>‘<samp class="samp">T</samp>’</dt>
<dd><p>Capture top-first, transfer unknown or varying.
Filter selects among ‘<samp class="samp">t</samp>’ and ‘<samp class="samp">p</samp>’ using image analysis.
</p>
</dd>
<dt>‘<samp class="samp">B</samp>’</dt>
<dd><p>Capture bottom-first, transfer unknown or varying.
Filter selects among ‘<samp class="samp">b</samp>’ and ‘<samp class="samp">p</samp>’ using image analysis.
</p>
</dd>
<dt>‘<samp class="samp">A</samp>’</dt>
<dd><p>Capture determined by field flags, transfer unknown or varying.
Filter selects among ‘<samp class="samp">t</samp>’, ‘<samp class="samp">b</samp>’ and ‘<samp class="samp">p</samp>’ using field flags and
image analysis. If no field information is available, then this works just
like ‘<samp class="samp">U</samp>’. This is the default mode.
</p>
</dd>
<dt>‘<samp class="samp">U</samp>’</dt>
<dd><p>Both capture and transfer unknown or varying.
Filter selects among ‘<samp class="samp">t</samp>’, ‘<samp class="samp">b</samp>’ and ‘<samp class="samp">p</samp>’ using image analysis only.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-129" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-129">
<h4 class="subsection">30.190.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="photosensitivity">
<h3 class="section">30.191 photosensitivity</h3>
<p>Reduce various flashes in video, so to help users with epilepsy.
</p>
<p>It accepts the following options:
</p><dl class="table">
<dt><samp class="option">frames, f</samp></dt>
<dd><p>Set how many frames to use when filtering. Default is 30.
</p>
</dd>
<dt><samp class="option">threshold, t</samp></dt>
<dd><p>Set detection threshold factor. Default is 1.
Lower is stricter.
</p>
</dd>
<dt><samp class="option">skip</samp></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><samp class="option">bypass</samp></dt>
<dd><p>Leave frames unchanged. Default is disabled.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="pixdesctest">
<h3 class="section">30.192 pixdesctest</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-preformatted">format=monow, pixdesctest
</pre></div>
<p>can be used to test the monowhite pixel format descriptor definition.
</p>
</div>
<div class="section-level-extent" id="pixelize">
<h3 class="section">30.193 pixelize</h3>
<p>Apply pixelization to video stream.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set block dimensions that will be used for pixelization.
Default value is <code class="code">16</code>.
</p>
</dd>
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set the mode of pixelization used.
</p>
<p>Possible values are:
</p><dl class="table">
<dt>‘<samp class="samp">avg</samp>’</dt>
<dt>‘<samp class="samp">min</samp>’</dt>
<dt>‘<samp class="samp">max</samp>’</dt>
</dl>
<p>Default value is <code class="code">avg</code>.
</p>
</dd>
<dt><samp class="option">planes, p</samp></dt>
<dd><p>Set what planes to filter. Default is to filter all planes.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-130" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-130">
<h4 class="subsection">30.193.1 Commands</h4>
<p>This filter supports all options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="pixscope">
<h3 class="section">30.194 pixscope</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 class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Set scope X position, relative offset on X axis.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set scope Y position, relative offset on Y axis.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dd><p>Set scope width.
</p>
</dd>
<dt><samp class="option">h</samp></dt>
<dd><p>Set scope height.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Set window opacity. This window also holds statistics about pixel area.
</p>
</dd>
<dt><samp class="option">wx</samp></dt>
<dd><p>Set window X position, relative offset on X axis.
</p>
</dd>
<dt><samp class="option">wy</samp></dt>
<dd><p>Set window Y position, relative offset on Y axis.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-131" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-131">
<h4 class="subsection">30.194.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="pp">
<h3 class="section">30.195 pp</h3>
<p>Enable the specified chain of postprocessing subfilters using libpostproc. This
library should be automatically selected with a GPL build (<code class="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 class="table">
<dt><samp class="option">subfilters</samp></dt>
<dd><p>Set postprocessing subfilters string.
</p></dd>
</dl>
<p>All subfilters share common options to determine their scope:
</p>
<dl class="table">
<dt><samp class="option">a/autoq</samp></dt>
<dd><p>Honor the quality commands for this subfilter.
</p>
</dd>
<dt><samp class="option">c/chrom</samp></dt>
<dd><p>Do chrominance filtering, too (default).
</p>
</dd>
<dt><samp class="option">y/nochrom</samp></dt>
<dd><p>Do luma filtering only (no chrominance).
</p>
</dd>
<dt><samp class="option">n/noluma</samp></dt>
<dd><p>Do chrominance filtering only (no luma).
</p></dd>
</dl>
<p>These options can be appended after the subfilter name, separated by a ’|’.
</p>
<p>Available subfilters are:
</p>
<dl class="table">
<dt><samp class="option">hb/hdeblock[|difference[|flatness]]</samp></dt>
<dd><p>Horizontal deblocking filter
</p><dl class="table">
<dt><samp class="option">difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code class="code">32</code>).
</p></dd>
<dt><samp class="option">flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code class="code">39</code>).
</p></dd>
</dl>
</dd>
<dt><samp class="option">vb/vdeblock[|difference[|flatness]]</samp></dt>
<dd><p>Vertical deblocking filter
</p><dl class="table">
<dt><samp class="option">difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code class="code">32</code>).
</p></dd>
<dt><samp class="option">flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code class="code">39</code>).
</p></dd>
</dl>
</dd>
<dt><samp class="option">ha/hadeblock[|difference[|flatness]]</samp></dt>
<dd><p>Accurate horizontal deblocking filter
</p><dl class="table">
<dt><samp class="option">difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code class="code">32</code>).
</p></dd>
<dt><samp class="option">flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code class="code">39</code>).
</p></dd>
</dl>
</dd>
<dt><samp class="option">va/vadeblock[|difference[|flatness]]</samp></dt>
<dd><p>Accurate vertical deblocking filter
</p><dl class="table">
<dt><samp class="option">difference</samp></dt>
<dd><p>Difference factor where higher values mean more deblocking (default: <code class="code">32</code>).
</p></dd>
<dt><samp class="option">flatness</samp></dt>
<dd><p>Flatness threshold where lower values mean more deblocking (default: <code class="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 class="table">
<dt><samp class="option">h1/x1hdeblock</samp></dt>
<dd><p>Experimental horizontal deblocking filter
</p>
</dd>
<dt><samp class="option">v1/x1vdeblock</samp></dt>
<dd><p>Experimental vertical deblocking filter
</p>
</dd>
<dt><samp class="option">dr/dering</samp></dt>
<dd><p>Deringing filter
</p>
</dd>
<dt><samp class="option">tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer</samp></dt>
<dd><dl class="table">
<dt><samp class="option">threshold1</samp></dt>
<dd><p>larger -> stronger filtering
</p></dd>
<dt><samp class="option">threshold2</samp></dt>
<dd><p>larger -> stronger filtering
</p></dd>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>larger -> stronger filtering
</p></dd>
</dl>
</dd>
<dt><samp class="option">al/autolevels[:f/fullyrange], automatic brightness / contrast correction</samp></dt>
<dd><dl class="table">
<dt><samp class="option">f/fullyrange</samp></dt>
<dd><p>Stretch luma to <code class="code">0-255</code>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">lb/linblenddeint</samp></dt>
<dd><p>Linear blend deinterlacing filter that deinterlaces the given block by
filtering all lines with a <code class="code">(1 2 1)</code> filter.
</p>
</dd>
<dt><samp class="option">li/linipoldeint</samp></dt>
<dd><p>Linear interpolating deinterlacing filter that deinterlaces the given block by
linearly interpolating every second line.
</p>
</dd>
<dt><samp class="option">ci/cubicipoldeint</samp></dt>
<dd><p>Cubic interpolating deinterlacing filter deinterlaces the given block by
cubically interpolating every second line.
</p>
</dd>
<dt><samp class="option">md/mediandeint</samp></dt>
<dd><p>Median deinterlacing filter that deinterlaces the given block by applying a
median filter to every second line.
</p>
</dd>
<dt><samp class="option">fd/ffmpegdeint</samp></dt>
<dd><p>FFmpeg deinterlacing filter that deinterlaces the given block by filtering every
second line with a <code class="code">(-1 4 2 4 -1)</code> filter.
</p>
</dd>
<dt><samp class="option">l5/lowpass5</samp></dt>
<dd><p>Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given
block by filtering all lines with a <code class="code">(-1 2 6 2 -1)</code> filter.
</p>
</dd>
<dt><samp class="option">fq/forceQuant[|quantizer]</samp></dt>
<dd><p>Overrides the quantizer table from the input with the constant quantizer you
specify.
</p><dl class="table">
<dt><samp class="option">quantizer</samp></dt>
<dd><p>Quantizer to use
</p></dd>
</dl>
</dd>
<dt><samp class="option">de/default</samp></dt>
<dd><p>Default pp filter combination (<code class="code">hb|a,vb|a,dr|a</code>)
</p>
</dd>
<dt><samp class="option">fa/fast</samp></dt>
<dd><p>Fast pp filter combination (<code class="code">h1|a,v1|a,dr|a</code>)
</p>
</dd>
<dt><samp class="option">ac</samp></dt>
<dd><p>High quality pp filter combination (<code class="code">ha|a|128|7,va|a,dr|a</code>)
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-120" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-120">
<h4 class="subsection">30.195.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply horizontal and vertical deblocking, deringing and automatic
brightness/contrast:
<div class="example">
<pre class="example-preformatted">pp=hb/vb/dr/al
</pre></div>
</li><li>Apply default filters without brightness/contrast correction:
<div class="example">
<pre class="example-preformatted">pp=de/-al
</pre></div>
</li><li>Apply default filters and temporal denoiser:
<div class="example">
<pre class="example-preformatted">pp=default/tmpnoise|1|2|3
</pre></div>
</li><li>Apply deblocking on luma only, and switch vertical deblocking on or off
automatically depending on available CPU time:
<div class="example">
<pre class="example-preformatted">pp=hb|y/vb|a
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="pp7">
<h3 class="section">30.196 pp7</h3>
<p>Apply Postprocessing filter 7. It is variant of the <a class="ref" 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 class="table">
<dt><samp class="option">qp</samp></dt>
<dd><p>Force a constant quantization parameter. It accepts an integer in range
0 to 63. If not set, the filter will use the QP from the video stream
(if available).
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set thresholding mode. Available modes are:
</p>
<dl class="table">
<dt>‘<samp class="samp">hard</samp>’</dt>
<dd><p>Set hard thresholding.
</p></dd>
<dt>‘<samp class="samp">soft</samp>’</dt>
<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier).
</p></dd>
<dt>‘<samp class="samp">medium</samp>’</dt>
<dd><p>Set medium thresholding (good results, default).
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="premultiply">
<h3 class="section">30.197 premultiply</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">inplace</samp></dt>
<dd><p>Do not require 2nd input for processing, instead use alpha plane from input stream.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="prewitt">
<h3 class="section">30.198 prewitt</h3>
<p>Apply prewitt operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-132" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-132">
<h4 class="subsection">30.198.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="pseudocolor">
<h3 class="section">30.199 pseudocolor</h3>
<p>Alter frame colors in video with pseudocolors.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">c0</samp></dt>
<dd><p>set pixel first component expression
</p>
</dd>
<dt><samp class="option">c1</samp></dt>
<dd><p>set pixel second component expression
</p>
</dd>
<dt><samp class="option">c2</samp></dt>
<dd><p>set pixel third component expression
</p>
</dd>
<dt><samp class="option">c3</samp></dt>
<dd><p>set pixel fourth component expression, corresponds to the alpha component
</p>
</dd>
<dt><samp class="option">index, i</samp></dt>
<dd><p>set component to use as base for altering colors
</p>
</dd>
<dt><samp class="option">preset, p</samp></dt>
<dd><p>Pick one of built-in LUTs. By default is set to none.
</p>
<p>Available LUTs:
</p><dl class="table">
<dt>‘<samp class="samp">magma</samp>’</dt>
<dt>‘<samp class="samp">inferno</samp>’</dt>
<dt>‘<samp class="samp">plasma</samp>’</dt>
<dt>‘<samp class="samp">viridis</samp>’</dt>
<dt>‘<samp class="samp">turbo</samp>’</dt>
<dt>‘<samp class="samp">cividis</samp>’</dt>
<dt>‘<samp class="samp">range1</samp>’</dt>
<dt>‘<samp class="samp">range2</samp>’</dt>
<dt>‘<samp class="samp">shadows</samp>’</dt>
<dt>‘<samp class="samp">highlights</samp>’</dt>
<dt>‘<samp class="samp">solar</samp>’</dt>
<dt>‘<samp class="samp">nominal</samp>’</dt>
<dt>‘<samp class="samp">preferred</samp>’</dt>
<dt>‘<samp class="samp">total</samp>’</dt>
<dt>‘<samp class="samp">spectral</samp>’</dt>
<dt>‘<samp class="samp">cool</samp>’</dt>
<dt>‘<samp class="samp">heat</samp>’</dt>
<dt>‘<samp class="samp">fiery</samp>’</dt>
<dt>‘<samp class="samp">blues</samp>’</dt>
<dt>‘<samp class="samp">green</samp>’</dt>
<dt>‘<samp class="samp">helix</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">opacity</samp></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 class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">val</samp></dt>
<dd><p>The input value for the pixel component.
</p>
</dd>
<dt><samp class="option">ymin, umin, vmin, amin</samp></dt>
<dd><p>The minimum allowed component value.
</p>
</dd>
<dt><samp class="option">ymax, umax, vmax, amax</samp></dt>
<dd><p>The maximum allowed component value.
</p></dd>
</dl>
<p>All expressions default to "val".
</p>
<ul class="mini-toc">
<li><a href="#Commands-133" accesskey="1">Commands</a></li>
<li><a href="#Examples-121" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-133">
<h4 class="subsection">30.199.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-121">
<h4 class="subsection">30.199.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Change too high luma values to gradient:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="psnr">
<h3 class="section">30.200 psnr</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-preformatted">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 class="table">
<dt><samp class="option">stats_file, f</samp></dt>
<dd><p>If specified the filter will use the named file to save the PSNR of
each individual frame. When filename equals "-" the data is sent to
standard output.
</p>
</dd>
<dt><samp class="option">stats_version</samp></dt>
<dd><p>Specifies which version of the stats file format to use. Details of
each format are written below.
Default value is 1.
</p>
</dd>
<dt><samp class="option">stats_add_max</samp></dt>
<dd><p>Determines whether the max value is output to the stats log.
Default value is 0.
Requires stats_version >= 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 class="ref" href="#framesync">framesync</a> options.
</p>
<p>The file printed if <var class="var">stats_file</var> is selected, contains a sequence of
key/value pairs of the form <var class="var">key</var>:<var class="var">value</var> for each compared
couple of frames.
</p>
<p>If a <var class="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 class="table">
<dt><samp class="option">psnr_log_version</samp></dt>
<dd><p>The version of the log file format. Will match <var class="var">stats_version</var>.
</p>
</dd>
<dt><samp class="option">fields</samp></dt>
<dd><p>A comma separated list of the per-frame-pair parameters included in
the log.
</p></dd>
</dl>
<p>A description of each shown per-frame-pair parameter follows:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>sequential number of the input frame, starting from 1
</p>
</dd>
<dt><samp class="option">mse_avg</samp></dt>
<dd><p>Mean Square Error pixel-by-pixel average difference of the compared
frames, averaged over all the image components.
</p>
</dd>
<dt><samp class="option">mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a</samp></dt>
<dd><p>Mean Square Error pixel-by-pixel average difference of the compared
frames for the component specified by the suffix.
</p>
</dd>
<dt><samp class="option">psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a</samp></dt>
<dd><p>Peak Signal to Noise ratio of the compared frames for the component
specified by the suffix.
</p>
</dd>
<dt><samp class="option">max_avg, max_y, max_u, max_v</samp></dt>
<dd><p>Maximum allowed value for each channel, and average over all
channels.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-122" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-122">
<h4 class="subsection">30.200.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>For example:
<div class="example">
<pre class="example-preformatted">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 class="file">ref_movie.mpg</samp>. The PSNR of each individual frame
is stored in <samp class="file">stats.log</samp>.
</p>
</li><li>Another example with different containers:
<div class="example">
<pre class="example-preformatted">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>
<a class="anchor" id="pullup"></a></div>
</div>
<div class="section-level-extent" id="pullup-1">
<h3 class="section">30.201 pullup</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 class="code">fps=24000/1001</code> if the input frame rate is 29.97fps,
<code class="code">fps=24</code> for 30fps and the (rare) telecined 25fps input.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">jl</samp></dt>
<dt><samp class="option">jr</samp></dt>
<dt><samp class="option">jt</samp></dt>
<dt><samp class="option">jb</samp></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><samp class="option">sb</samp></dt>
<dd><p>Set the strict breaks. Setting this option to 1 will reduce the chances of
filter generating an occasional mismatched frame, but it may also cause an
excessive number of frames to be dropped during high motion sequences.
Conversely, setting it to -1 will make filter match fields more easily.
This may help processing of video where there is slight blurring between
the fields, but may also cause there to be interlaced frames in the output.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">mp</samp></dt>
<dd><p>Set the metric plane to use. It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">l</samp>’</dt>
<dd><p>Use luma plane.
</p>
</dd>
<dt>‘<samp class="samp">u</samp>’</dt>
<dd><p>Use chroma blue plane.
</p>
</dd>
<dt>‘<samp class="samp">v</samp>’</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 class="option">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-preformatted">ffmpeg -i input -vf pullup -r 24000/1001 ...
</pre></div>
</div>
<div class="section-level-extent" id="qp">
<h3 class="section">30.202 qp</h3>
<p>Change video quantization parameters (QP).
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">qp</samp></dt>
<dd><p>Set expression for quantization parameter.
</p></dd>
</dl>
<p>The expression is evaluated through the eval API and can contain, among others,
the following constants:
</p>
<dl class="table">
<dt><var class="var">known</var></dt>
<dd><p>1 if index is not 129, 0 otherwise.
</p>
</dd>
<dt><var class="var">qp</var></dt>
<dd><p>Sequential index starting from -129 to 128.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-123" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-123">
<h4 class="subsection">30.202.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Some equation like:
<div class="example">
<pre class="example-preformatted">qp=2+2*sin(PI*qp)
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="random">
<h3 class="section">30.203 random</h3>
<p>Flush video frames from internal cache of frames into a random order.
No frame is discarded.
Inspired by <a class="ref" href="#frei0r">frei0r</a> nervous filter.
</p>
<dl class="table">
<dt><samp class="option">frames</samp></dt>
<dd><p>Set size in number of frames of internal cache, in range from <code class="code">2</code> to
<code class="code">512</code>. Default is <code class="code">30</code>.
</p>
</dd>
<dt><samp class="option">seed</samp></dt>
<dd><p>Set seed for random number generator, must be an integer included between
<code class="code">0</code> and <code class="code">UINT32_MAX</code>. If not specified, or if explicitly set to
less than <code class="code">0</code>, the filter will try to use a good random seed on a
best effort basis.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="readeia608">
<h3 class="section">30.204 readeia608</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 class="code">lavfi.readeia608.X.cc</code> and
<code class="code">lavfi.readeia608.X.line</code>, where <code class="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 class="table">
<dt><samp class="option">lavfi.readeia608.X.cc</samp></dt>
<dd><p>The two bytes stored as EIA-608 data (printed in hexadecimal).
</p>
</dd>
<dt><samp class="option">lavfi.readeia608.X.line</samp></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 class="table">
<dt><samp class="option">scan_min</samp></dt>
<dd><p>Set the line to start scanning for EIA-608 data. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">scan_max</samp></dt>
<dd><p>Set the line to end scanning for EIA-608 data. Default is <code class="code">29</code>.
</p>
</dd>
<dt><samp class="option">spw</samp></dt>
<dd><p>Set the ratio of width reserved for sync code detection.
Default is <code class="code">0.27</code>. Allowed range is <code class="code">[0.1 - 0.7]</code>.
</p>
</dd>
<dt><samp class="option">chp</samp></dt>
<dd><p>Enable checking the parity bit. In the event of a parity error, the filter will output
<code class="code">0x00</code> for that character. Default is false.
</p>
</dd>
<dt><samp class="option">lp</samp></dt>
<dd><p>Lowpass lines prior to further processing. Default is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-134" accesskey="1">Commands</a></li>
<li><a href="#Examples-124" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-134">
<h4 class="subsection">30.204.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-124">
<h4 class="subsection">30.204.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Output a csv with presentation time and the first two lines of identified EIA-608 captioning data.
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="readvitc">
<h3 class="section">30.205 readvitc</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 class="code">lavfi.readvitc.tc_str</code> with the
timecode value, if a valid timecode has been detected. Further metadata key
<code class="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 class="table">
<dt><samp class="option">scan_max</samp></dt>
<dd><p>Set the maximum number of lines to scan for VITC data. If the value is set to
<code class="code">-1</code> the full video frame is scanned. Default is <code class="code">45</code>.
</p>
</dd>
<dt><samp class="option">thr_b</samp></dt>
<dd><p>Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0],
default value is <code class="code">0.2</code>. The value must be equal or less than <code class="code">thr_w</code>.
</p>
</dd>
<dt><samp class="option">thr_w</samp></dt>
<dd><p>Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0],
default value is <code class="code">0.6</code>. The value must be equal or greater than <code class="code">thr_b</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-125" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-125">
<h4 class="subsection">30.205.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Detect and draw VITC data onto the video frame; if no valid VITC is detected,
draw <code class="code">--:--:--:--</code> as a placeholder:
<div class="example">
<pre class="example-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="remap">
<h3 class="section">30.206 remap</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 class="table">
<dt><samp class="option">format</samp></dt>
<dd><p>Specify pixel format of output from this filter. Can be <code class="code">color</code> or <code class="code">gray</code>.
Default is <code class="code">color</code>.
</p>
</dd>
<dt><samp class="option">fill</samp></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 class="code">black</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="removegrain">
<h3 class="section">30.207 removegrain</h3>
<p>The removegrain filter is a spatial denoiser for progressive video.
</p>
<dl class="table">
<dt><samp class="option">m0</samp></dt>
<dd><p>Set mode for the first plane.
</p>
</dd>
<dt><samp class="option">m1</samp></dt>
<dd><p>Set mode for the second plane.
</p>
</dd>
<dt><samp class="option">m2</samp></dt>
<dd><p>Set mode for the third plane.
</p>
</dd>
<dt><samp class="option">m3</samp></dt>
<dd><p>Set mode for the fourth plane.
</p></dd>
</dl>
<p>Range of mode is from 0 to 24. Description of each mode follows:
</p>
<dl class="table">
<dt><var class="var">0</var></dt>
<dd><p>Leave input plane unchanged. Default.
</p>
</dd>
<dt><var class="var">1</var></dt>
<dd><p>Clips the pixel with the minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var class="var">2</var></dt>
<dd><p>Clips the pixel with the second minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var class="var">3</var></dt>
<dd><p>Clips the pixel with the third minimum and maximum of the 8 neighbour pixels.
</p>
</dd>
<dt><var class="var">4</var></dt>
<dd><p>Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels.
This is equivalent to a median filter.
</p>
</dd>
<dt><var class="var">5</var></dt>
<dd><p>Line-sensitive clipping giving the minimal change.
</p>
</dd>
<dt><var class="var">6</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var class="var">7</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var class="var">8</var></dt>
<dd><p>Line-sensitive clipping, intermediate.
</p>
</dd>
<dt><var class="var">9</var></dt>
<dd><p>Line-sensitive clipping on a line where the neighbours pixels are the closest.
</p>
</dd>
<dt><var class="var">10</var></dt>
<dd><p>Replaces the target pixel with the closest neighbour.
</p>
</dd>
<dt><var class="var">11</var></dt>
<dd><p>[1 2 1] horizontal and vertical kernel blur.
</p>
</dd>
<dt><var class="var">12</var></dt>
<dd><p>Same as mode 11.
</p>
</dd>
<dt><var class="var">13</var></dt>
<dd><p>Bob mode, interpolates top field from the line where the neighbours
pixels are the closest.
</p>
</dd>
<dt><var class="var">14</var></dt>
<dd><p>Bob mode, interpolates bottom field from the line where the neighbours
pixels are the closest.
</p>
</dd>
<dt><var class="var">15</var></dt>
<dd><p>Bob mode, interpolates top field. Same as 13 but with a more complicated
interpolation formula.
</p>
</dd>
<dt><var class="var">16</var></dt>
<dd><p>Bob mode, interpolates bottom field. Same as 14 but with a more complicated
interpolation formula.
</p>
</dd>
<dt><var class="var">17</var></dt>
<dd><p>Clips the pixel with the minimum and maximum of respectively the maximum and
minimum of each pair of opposite neighbour pixels.
</p>
</dd>
<dt><var class="var">18</var></dt>
<dd><p>Line-sensitive clipping using opposite neighbours whose greatest distance from
the current pixel is minimal.
</p>
</dd>
<dt><var class="var">19</var></dt>
<dd><p>Replaces the pixel with the average of its 8 neighbours.
</p>
</dd>
<dt><var class="var">20</var></dt>
<dd><p>Averages the 9 pixels ([1 1 1] horizontal and vertical blur).
</p>
</dd>
<dt><var class="var">21</var></dt>
<dd><p>Clips pixels using the averages of opposite neighbour.
</p>
</dd>
<dt><var class="var">22</var></dt>
<dd><p>Same as mode 21 but simpler and faster.
</p>
</dd>
<dt><var class="var">23</var></dt>
<dd><p>Small edge and halo removal, but reputed useless.
</p>
</dd>
<dt><var class="var">24</var></dt>
<dd><p>Similar as 23.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="removelogo">
<h3 class="section">30.208 removelogo</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 class="table">
<dt><samp class="option">filename, f</samp></dt>
<dd><p>Set the filter bitmap file, which can be any image format supported by
libavformat. The width and height of the image file must match those of the
video stream being processed.
</p></dd>
</dl>
<p>Pixels in the provided bitmap image with a value of zero are not
considered part of the logo, non-zero pixels are considered part of
the logo. If you use white (255) for the logo and black (0) for the
rest, you will be safe. For making the filter bitmap, it is
recommended to take a screen capture of a black frame with the logo
visible, and then using a threshold filter followed by the erode
filter once or twice.
</p>
<p>If needed, little splotches can be fixed manually. Remember that if
logo pixels are not covered, the filter quality will be much
reduced. Marking too many pixels as part of the logo does not hurt as
much, but it will increase the amount of blurring needed to cover over
the image and will destroy more information than necessary, and extra
pixels will slow things down on a large logo.
</p>
</div>
<div class="section-level-extent" id="repeatfields">
<h3 class="section">30.209 repeatfields</h3>
<p>This filter uses the repeat_field flag from the Video ES headers and hard repeats
fields based on its value.
</p>
</div>
<div class="section-level-extent" id="reverse">
<h3 class="section">30.210 reverse</h3>
<p>Reverse a video clip.
</p>
<p>Warning: This filter requires memory to buffer the entire clip, so trimming
is suggested.
</p>
<ul class="mini-toc">
<li><a href="#Examples-126" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-126">
<h4 class="subsection">30.210.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Take the first 5 seconds of a clip, and reverse it.
<div class="example">
<pre class="example-preformatted">trim=end=5,reverse
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="rgbashift">
<h3 class="section">30.211 rgbashift</h3>
<p>Shift R/G/B/A pixels horizontally and/or vertically.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">rh</samp></dt>
<dd><p>Set amount to shift red horizontally.
</p></dd>
<dt><samp class="option">rv</samp></dt>
<dd><p>Set amount to shift red vertically.
</p></dd>
<dt><samp class="option">gh</samp></dt>
<dd><p>Set amount to shift green horizontally.
</p></dd>
<dt><samp class="option">gv</samp></dt>
<dd><p>Set amount to shift green vertically.
</p></dd>
<dt><samp class="option">bh</samp></dt>
<dd><p>Set amount to shift blue horizontally.
</p></dd>
<dt><samp class="option">bv</samp></dt>
<dd><p>Set amount to shift blue vertically.
</p></dd>
<dt><samp class="option">ah</samp></dt>
<dd><p>Set amount to shift alpha horizontally.
</p></dd>
<dt><samp class="option">av</samp></dt>
<dd><p>Set amount to shift alpha vertically.
</p></dd>
<dt><samp class="option">edge</samp></dt>
<dd><p>Set edge mode, can be <var class="var">smear</var>, default, or <var class="var">warp</var>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-135" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-135">
<h4 class="subsection">30.211.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="roberts">
<h3 class="section">30.212 roberts</h3>
<p>Apply roberts cross operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-136" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-136">
<h4 class="subsection">30.212.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="rotate">
<h3 class="section">30.213 rotate</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 class="table">
<dt><samp class="option">angle, a</samp></dt>
<dd><p>Set an expression for the angle by which to rotate the input video
clockwise, expressed as a number of radians. A negative value will
result in a counter-clockwise rotation. By default it is set to "0".
</p>
<p>This expression is evaluated for each frame.
</p>
</dd>
<dt><samp class="option">out_w, ow</samp></dt>
<dd><p>Set the output width expression, default value is "iw".
This expression is evaluated just once during configuration.
</p>
</dd>
<dt><samp class="option">out_h, oh</samp></dt>
<dd><p>Set the output height expression, default value is "ih".
This expression is evaluated just once during configuration.
</p>
</dd>
<dt><samp class="option">bilinear</samp></dt>
<dd><p>Enable bilinear interpolation if set to 1, a value of 0 disables
it. Default value is 1.
</p>
</dd>
<dt><samp class="option">fillcolor, c</samp></dt>
<dd><p>Set the color used to fill the output area not covered by the rotated
image. For the general syntax of this option, check the
<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 class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>sequential number of the input frame, starting from 0. It is always NAN
before the first frame is filtered.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>time in seconds of the input frame, it is set to 0 when the filter is
configured. It is always NAN before the first frame is filtered.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>horizontal and vertical chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><samp class="option">in_w, iw</samp></dt>
<dt><samp class="option">in_h, ih</samp></dt>
<dd><p>the input video width and height
</p>
</dd>
<dt><samp class="option">out_w, ow</samp></dt>
<dt><samp class="option">out_h, oh</samp></dt>
<dd><p>the output width and height, that is the size of the padded area as
specified by the <var class="var">width</var> and <var class="var">height</var> expressions
</p>
</dd>
<dt><samp class="option">rotw(a)</samp></dt>
<dt><samp class="option">roth(a)</samp></dt>
<dd><p>the minimal width/height required for completely containing the input
video rotated by <var class="var">a</var> radians.
</p>
<p>These are only available when computing the <samp class="option">out_w</samp> and
<samp class="option">out_h</samp> expressions.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-127" accesskey="1">Examples</a></li>
<li><a href="#Commands-137" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-127">
<h4 class="subsection">30.213.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Rotate the input by PI/6 radians clockwise:
<div class="example">
<pre class="example-preformatted">rotate=PI/6
</pre></div>
</li><li>Rotate the input by PI/6 radians counter-clockwise:
<div class="example">
<pre class="example-preformatted">rotate=-PI/6
</pre></div>
</li><li>Rotate the input by 45 degrees clockwise:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-137">
<h4 class="subsection">30.213.2 Commands</h4>
<p>The filter supports the following commands:
</p>
<dl class="table">
<dt><samp class="option">a, angle</samp></dt>
<dd><p>Set the angle expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="sab">
<h3 class="section">30.214 sab</h3>
<p>Apply Shape Adaptive Blur.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dd><p>Set luma blur filter strength, must be a value in range 0.1-4.0, default
value is 1.0. A greater value will result in a more blurred image, and
in slower processing.
</p>
</dd>
<dt><samp class="option">luma_pre_filter_radius, lpfr</samp></dt>
<dd><p>Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default
value is 1.0.
</p>
</dd>
<dt><samp class="option">luma_strength, ls</samp></dt>
<dd><p>Set luma maximum difference between pixels to still be considered, must
be a value in the 0.1-100.0 range, default value is 1.0.
</p>
</dd>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dd><p>Set chroma blur filter strength, must be a value in range -0.9-4.0. A
greater value will result in a more blurred image, and in slower
processing.
</p>
</dd>
<dt><samp class="option">chroma_pre_filter_radius, cpfr</samp></dt>
<dd><p>Set chroma pre-filter radius, must be a value in the -0.9-2.0 range.
</p>
</dd>
<dt><samp class="option">chroma_strength, cs</samp></dt>
<dd><p>Set chroma maximum difference between pixels to still be considered,
must be a value in the -0.9-100.0 range.
</p></dd>
</dl>
<p>Each chroma option value, if not explicitly specified, is set to the
corresponding luma option value.
</p>
<a class="anchor" id="scale"></a></div>
<div class="section-level-extent" id="scale-1">
<h3 class="section">30.215 scale</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>
<ul class="mini-toc">
<li><a href="#Options-37" accesskey="1">Options</a></li>
<li><a href="#Examples-128" accesskey="2">Examples</a></li>
<li><a href="#Commands-138" accesskey="3">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Options-37">
<h4 class="subsection">30.215.1 Options</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 class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set the output video dimension expression. Default value is the input
dimension.
</p>
<p>If the <var class="var">width</var> or <var class="var">w</var> value is 0, the input width is used for
the output. If the <var class="var">height</var> or <var class="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><samp class="option">eval</samp></dt>
<dd><p>Specify when to evaluate <var class="var">width</var> and <var class="var">height</var> expression. It accepts the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>Only evaluate expressions once during the filter initialization or when a command is processed.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Evaluate expressions for each incoming frame.
</p>
</dd>
</dl>
<p>Default value is ‘<samp class="samp">init</samp>’.
</p>
</dd>
<dt><samp class="option">interl</samp></dt>
<dd><p>Set the interlacing mode. It accepts the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">1</samp>’</dt>
<dd><p>Force interlaced aware scaling.
</p>
</dd>
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>Do not apply interlaced scaling.
</p>
</dd>
<dt>‘<samp class="samp">-1</samp>’</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 class="samp">0</samp>’.
</p>
</dd>
<dt><samp class="option">flags</samp></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><samp class="option">param0, param1</samp></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><samp class="option">size, s</samp></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><samp class="option">in_color_matrix</samp></dt>
<dt><samp class="option">out_color_matrix</samp></dt>
<dd><p>Set in/output YCbCr color space type.
</p>
<p>This allows the autodetected value to be overridden as well as allows forcing
a specific value used for the output and encoder.
</p>
<p>If not specified, the color space type depends on the pixel format.
</p>
<p>Possible values:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Choose automatically.
</p>
</dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>Format conforming to International Telecommunication Union (ITU)
Recommendation BT.709.
</p>
</dd>
<dt>‘<samp class="samp">fcc</samp>’</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>‘<samp class="samp">bt601</samp>’</dt>
<dt>‘<samp class="samp">bt470</samp>’</dt>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>Set color space conforming to:
</p>
<ul class="itemize mark-bullet">
<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>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>Set color space conforming to SMPTE ST 240:1999.
</p>
</dd>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dd><p>Set color space conforming to ITU-R BT.2020 non-constant luminance system.
</p></dd>
</dl>
</dd>
<dt><samp class="option">in_range</samp></dt>
<dt><samp class="option">out_range</samp></dt>
<dd><p>Set in/output YCbCr sample range.
</p>
<p>This allows the autodetected value to be overridden as well as allows forcing
a specific value used for the output and encoder. If not specified, the
range depends on the pixel format. Possible values:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto/unknown</samp>’</dt>
<dd><p>Choose automatically.
</p>
</dd>
<dt>‘<samp class="samp">jpeg/full/pc</samp>’</dt>
<dd><p>Set full range (0-255 in case of 8-bit luma).
</p>
</dd>
<dt>‘<samp class="samp">mpeg/limited/tv</samp>’</dt>
<dd><p>Set "MPEG" range (16-235 in case of 8-bit luma).
</p></dd>
</dl>
</dd>
<dt><samp class="option">force_original_aspect_ratio</samp></dt>
<dd><p>Enable decreasing or increasing output video width or height if necessary to
keep the original aspect ratio. Possible values:
</p>
<dl class="table">
<dt>‘<samp class="samp">disable</samp>’</dt>
<dd><p>Scale the video as specified and disable this feature.
</p>
</dd>
<dt>‘<samp class="samp">decrease</samp>’</dt>
<dd><p>The output video dimensions will automatically be decreased if needed.
</p>
</dd>
<dt>‘<samp class="samp">increase</samp>’</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 class="option">w</samp>
or <samp class="option">h</samp>, you still need to specify the output resolution for this option
to work.
</p>
</dd>
<dt><samp class="option">force_divisible_by</samp></dt>
<dd><p>Ensures that both the output dimensions, width and height, are divisible by the
given integer when used together with <samp class="option">force_original_aspect_ratio</samp>. This
works similar to using <code class="code">-n</code> in the <samp class="option">w</samp> and <samp class="option">h</samp> options.
</p>
<p>This option respects the value set for <samp class="option">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 class="option">force_original_aspect_ratio</samp> but also have
encoder restrictions on width or height divisibility.
</p>
</dd>
</dl>
<p>The values of the <samp class="option">w</samp> and <samp class="option">h</samp> options are expressions
containing the following constants:
</p>
<dl class="table">
<dt><var class="var">in_w</var></dt>
<dt><var class="var">in_h</var></dt>
<dd><p>The input width and height
</p>
</dd>
<dt><var class="var">iw</var></dt>
<dt><var class="var">ih</var></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><var class="var">out_w</var></dt>
<dt><var class="var">out_h</var></dt>
<dd><p>The output (scaled) width and height
</p>
</dd>
<dt><var class="var">ow</var></dt>
<dt><var class="var">oh</var></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>
</p>
</dd>
<dt><var class="var">a</var></dt>
<dd><p>The same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><var class="var">sar</var></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><var class="var">dar</var></dt>
<dd><p>The input display aspect ratio. Calculated from <code class="code">(iw / ih) * sar</code>.
</p>
</dd>
<dt><var class="var">hsub</var></dt>
<dt><var class="var">vsub</var></dt>
<dd><p>horizontal and vertical input chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><var class="var">ohsub</var></dt>
<dt><var class="var">ovsub</var></dt>
<dd><p>horizontal and vertical output chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><var class="var">n</var></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">t</var></dt>
<dd><p>The presentation timestamp of the input frame, expressed as a number of
seconds. Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">pos</var></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 class="code">eval=frame</code>.
Deprecated, do not use.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-128">
<h4 class="subsection">30.215.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Scale the input video to a size of 200x100
<div class="example">
<pre class="example-preformatted">scale=w=200:h=100
</pre></div>
<p>This is equivalent to:
</p><div class="example">
<pre class="example-preformatted">scale=200:100
</pre></div>
<p>or:
</p><div class="example">
<pre class="example-preformatted">scale=200x100
</pre></div>
</li><li>Specify a size abbreviation for the output size:
<div class="example">
<pre class="example-preformatted">scale=qcif
</pre></div>
<p>which can also be written as:
</p><div class="example">
<pre class="example-preformatted">scale=size=qcif
</pre></div>
</li><li>Scale the input to 2x:
<div class="example">
<pre class="example-preformatted">scale=w=2*iw:h=2*ih
</pre></div>
</li><li>The above is the same as:
<div class="example">
<pre class="example-preformatted">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-preformatted">scale=2*iw:2*ih:interl=1
</pre></div>
</li><li>Scale the input to half size:
<div class="example">
<pre class="example-preformatted">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-preformatted">scale=3/2*iw:ow
</pre></div>
</li><li>Seek Greek harmony:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-138">
<h4 class="subsection">30.215.3 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set the output video dimension expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
<a class="anchor" id="scale_005fcuda"></a></div>
</div>
<div class="section-level-extent" id="scale_005fcuda-1">
<h3 class="section">30.216 scale_cuda</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 class="ref" href="#scale">scale</a> filter.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></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 class="ref" href="#scale">scale</a> filter.
</p>
</dd>
<dt><samp class="option">interp_algo</samp></dt>
<dd><p>Sets the algorithm used for scaling:
</p>
<dl class="table">
<dt><var class="var">nearest</var></dt>
<dd><p>Nearest neighbour
</p>
<p>Used by default if input parameters match the desired output.
</p>
</dd>
<dt><var class="var">bilinear</var></dt>
<dd><p>Bilinear
</p>
</dd>
<dt><var class="var">bicubic</var></dt>
<dd><p>Bicubic
</p>
<p>This is the default.
</p>
</dd>
<dt><var class="var">lanczos</var></dt>
<dd><p>Lanczos
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">format</samp></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><samp class="option">passthrough</samp></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><samp class="option">param</samp></dt>
<dd><p>Algorithm-Specific parameter.
</p>
<p>Affects the curves of the bicubic algorithm.
</p>
</dd>
<dt><samp class="option">force_original_aspect_ratio</samp></dt>
<dt><samp class="option">force_divisible_by</samp></dt>
<dd><p>Work the same as the identical <a class="ref" href="#scale">scale</a> filter options.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-129" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-129">
<h4 class="subsection">30.216.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Scale input to 720p, keeping aspect ratio and ensuring the output is yuv420p.
<div class="example">
<pre class="example-preformatted">scale_cuda=-2:720:format=yuv420p
</pre></div>
</li><li>Upscale to 4K using nearest neighbour algorithm.
<div class="example">
<pre class="example-preformatted">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-preformatted">scale_cuda=passthrough=0
</pre></div>
</li></ul>
<a class="anchor" id="scale_005fnpp"></a></div>
</div>
<div class="section-level-extent" id="scale_005fnpp-1">
<h3 class="section">30.217 scale_npp</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 class="var">scale</var> filter.
</p>
<p>The following additional options are accepted:
</p><dl class="table">
<dt><samp class="option">format</samp></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><samp class="option">interp_algo</samp></dt>
<dd><p>The interpolation algorithm used for resizing. One of the following:
</p><dl class="table">
<dt><samp class="option">nn</samp></dt>
<dd><p>Nearest neighbour.
</p>
</dd>
<dt><samp class="option">linear</samp></dt>
<dt><samp class="option">cubic</samp></dt>
<dt><samp class="option">cubic2p_bspline</samp></dt>
<dd><p>2-parameter cubic (B=1, C=0)
</p>
</dd>
<dt><samp class="option">cubic2p_catmullrom</samp></dt>
<dd><p>2-parameter cubic (B=0, C=1/2)
</p>
</dd>
<dt><samp class="option">cubic2p_b05c03</samp></dt>
<dd><p>2-parameter cubic (B=1/2, C=3/10)
</p>
</dd>
<dt><samp class="option">super</samp></dt>
<dd><p>Supersampling
</p>
</dd>
<dt><samp class="option">lanczos</samp></dt>
</dl>
</dd>
<dt><samp class="option">force_original_aspect_ratio</samp></dt>
<dd><p>Enable decreasing or increasing output video width or height if necessary to
keep the original aspect ratio. Possible values:
</p>
<dl class="table">
<dt>‘<samp class="samp">disable</samp>’</dt>
<dd><p>Scale the video as specified and disable this feature.
</p>
</dd>
<dt>‘<samp class="samp">decrease</samp>’</dt>
<dd><p>The output video dimensions will automatically be decreased if needed.
</p>
</dd>
<dt>‘<samp class="samp">increase</samp>’</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 class="option">w</samp>
or <samp class="option">h</samp>, you still need to specify the output resolution for this option
to work.
</p>
</dd>
<dt><samp class="option">force_divisible_by</samp></dt>
<dd><p>Ensures that both the output dimensions, width and height, are divisible by the
given integer when used together with <samp class="option">force_original_aspect_ratio</samp>. This
works similar to using <code class="code">-n</code> in the <samp class="option">w</samp> and <samp class="option">h</samp> options.
</p>
<p>This option respects the value set for <samp class="option">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 class="option">force_original_aspect_ratio</samp> but also have
encoder restrictions on width or height divisibility.
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Specify when to evaluate <var class="var">width</var> and <var class="var">height</var> expression. It accepts the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>Only evaluate expressions once during the filter initialization or when a command is processed.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Evaluate expressions for each incoming frame.
</p>
</dd>
</dl>
</dd>
</dl>
<p>The values of the <samp class="option">w</samp> and <samp class="option">h</samp> options are expressions
containing the following constants:
</p>
<dl class="table">
<dt><var class="var">in_w</var></dt>
<dt><var class="var">in_h</var></dt>
<dd><p>The input width and height
</p>
</dd>
<dt><var class="var">iw</var></dt>
<dt><var class="var">ih</var></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><var class="var">out_w</var></dt>
<dt><var class="var">out_h</var></dt>
<dd><p>The output (scaled) width and height
</p>
</dd>
<dt><var class="var">ow</var></dt>
<dt><var class="var">oh</var></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>
</p>
</dd>
<dt><var class="var">a</var></dt>
<dd><p>The same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><var class="var">sar</var></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><var class="var">dar</var></dt>
<dd><p>The input display aspect ratio. Calculated from <code class="code">(iw / ih) * sar</code>.
</p>
</dd>
<dt><var class="var">n</var></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">t</var></dt>
<dd><p>The presentation timestamp of the input frame, expressed as a number of
seconds. Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">pos</var></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 class="code">eval=frame</code>.
Deprecated, do not use.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="scale2ref">
<h3 class="section">30.218 scale2ref</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 class="option">w</samp> and
<samp class="option">h</samp> options:
</p>
<dl class="table">
<dt><var class="var">main_w</var></dt>
<dt><var class="var">main_h</var></dt>
<dd><p>The main input video’s width and height
</p>
</dd>
<dt><var class="var">main_a</var></dt>
<dd><p>The same as <var class="var">main_w</var> / <var class="var">main_h</var>
</p>
</dd>
<dt><var class="var">main_sar</var></dt>
<dd><p>The main input video’s sample aspect ratio
</p>
</dd>
<dt><var class="var">main_dar, mdar</var></dt>
<dd><p>The main input video’s display aspect ratio. Calculated from
<code class="code">(main_w / main_h) * main_sar</code>.
</p>
</dd>
<dt><var class="var">main_hsub</var></dt>
<dt><var class="var">main_vsub</var></dt>
<dd><p>The main input video’s horizontal and vertical chroma subsample values.
For example for the pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var>
is 1.
</p>
</dd>
<dt><var class="var">main_n</var></dt>
<dd><p>The (sequential) number of the main input frame, starting from 0.
Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">main_t</var></dt>
<dd><p>The presentation timestamp of the main input frame, expressed as a number of
seconds. Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">main_pos</var></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 class="code">eval=frame</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-130" accesskey="1">Examples</a></li>
<li><a href="#Commands-139" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-130">
<h4 class="subsection">30.218.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Scale a subtitle stream (b) to match the main video (a) in size before overlaying
<div class="example">
<pre class="example-preformatted">'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-preformatted">[logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out]
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-139">
<h4 class="subsection">30.218.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set the output video dimension expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="scale2ref_005fnpp">
<h3 class="section">30.219 scale2ref_npp</h3>
<p>Use the NVIDIA Performance Primitives (libnpp) to scale (resize) the input
video, based on a reference video.
</p>
<p>See the <a class="ref" 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 class="option">w</samp> and
<samp class="option">h</samp> options:
</p>
<dl class="table">
<dt><var class="var">main_w</var></dt>
<dt><var class="var">main_h</var></dt>
<dd><p>The main input video’s width and height
</p>
</dd>
<dt><var class="var">main_a</var></dt>
<dd><p>The same as <var class="var">main_w</var> / <var class="var">main_h</var>
</p>
</dd>
<dt><var class="var">main_sar</var></dt>
<dd><p>The main input video’s sample aspect ratio
</p>
</dd>
<dt><var class="var">main_dar, mdar</var></dt>
<dd><p>The main input video’s display aspect ratio. Calculated from
<code class="code">(main_w / main_h) * main_sar</code>.
</p>
</dd>
<dt><var class="var">main_n</var></dt>
<dd><p>The (sequential) number of the main input frame, starting from 0.
Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">main_t</var></dt>
<dd><p>The presentation timestamp of the main input frame, expressed as a number of
seconds. Only available with <code class="code">eval=frame</code>.
</p>
</dd>
<dt><var class="var">main_pos</var></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 class="code">eval=frame</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-131" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-131">
<h4 class="subsection">30.219.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Scale a subtitle stream (b) to match the main video (a) in size before overlaying
<div class="example">
<pre class="example-preformatted">'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-preformatted">[logo-in][video-in]scale2ref_npp=w=oh*mdar:h=ih/10[logo-out][video-out]
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="scale_005fvt">
<h3 class="section">30.220 scale_vt</h3>
<p>Scale and convert the color parameters using VTPixelTransferSession.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Set the output video dimension expression. Default value is the input dimension.
</p>
</dd>
<dt><samp class="option">color_matrix</samp></dt>
<dd><p>Set the output colorspace matrix.
</p>
</dd>
<dt><samp class="option">color_primaries</samp></dt>
<dd><p>Set the output color primaries.
</p>
</dd>
<dt><samp class="option">color_transfer</samp></dt>
<dd><p>Set the output transfer characteristics.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="scharr">
<h3 class="section">30.221 scharr</h3>
<p>Apply scharr operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-140" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-140">
<h4 class="subsection">30.221.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="scroll">
<h3 class="section">30.222 scroll</h3>
<p>Scroll input video horizontally and/or vertically by constant speed.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">horizontal, h</samp></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><samp class="option">vertical, v</samp></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><samp class="option">hpos</samp></dt>
<dd><p>Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1.
</p>
</dd>
<dt><samp class="option">vpos</samp></dt>
<dd><p>Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-141" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-141">
<h4 class="subsection">30.222.1 Commands</h4>
<p>This filter supports the following <a class="ref" href="#commands">commands</a>:
</p><dl class="table">
<dt><samp class="option">horizontal, h</samp></dt>
<dd><p>Set the horizontal scrolling speed.
</p></dd>
<dt><samp class="option">vertical, v</samp></dt>
<dd><p>Set the vertical scrolling speed.
</p></dd>
</dl>
<a class="anchor" id="scdet"></a></div>
</div>
<div class="section-level-extent" id="scdet-1">
<h3 class="section">30.223 scdet</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 class="option">threshold</samp>.
</p>
<p><code class="code">lavfi.scd.mafd</code> metadata keys are set with mafd for every frame.
</p>
<p><code class="code">lavfi.scd.score</code> metadata keys are set with scene change score for every frame
to detect scene change.
</p>
<p><code class="code">lavfi.scd.time</code> metadata keys are set with current filtered frame time which
detect scene change with <samp class="option">threshold</samp>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">threshold, t</samp></dt>
<dd><p>Set the scene change detection threshold as a percentage of maximum change. Good
values are in the <code class="code">[8.0, 14.0]</code> range. The range for <samp class="option">threshold</samp> is
<code class="code">[0., 100.]</code>.
</p>
<p>Default value is <code class="code">10.</code>.
</p>
</dd>
<dt><samp class="option">sc_pass, s</samp></dt>
<dd><p>Set the flag to pass scene change frames to the next filter. Default value is <code class="code">0</code>
You can enable it if you want to get snapshot of scene change frames only.
</p></dd>
</dl>
<a class="anchor" id="selectivecolor"></a></div>
<div class="section-level-extent" id="selectivecolor-1">
<h3 class="section">30.224 selectivecolor</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 class="table">
<dt><samp class="option">correction_method</samp></dt>
<dd><p>Select color correction method.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">absolute</samp>’</dt>
<dd><p>Specified adjustments are applied "as-is" (added/subtracted to original pixel
component value).
</p></dd>
<dt>‘<samp class="samp">relative</samp>’</dt>
<dd><p>Specified adjustments are relative to the original component value.
</p></dd>
</dl>
<p>Default is <code class="code">absolute</code>.
</p></dd>
<dt><samp class="option">reds</samp></dt>
<dd><p>Adjustments for red pixels (pixels where the red component is the maximum)
</p></dd>
<dt><samp class="option">yellows</samp></dt>
<dd><p>Adjustments for yellow pixels (pixels where the blue component is the minimum)
</p></dd>
<dt><samp class="option">greens</samp></dt>
<dd><p>Adjustments for green pixels (pixels where the green component is the maximum)
</p></dd>
<dt><samp class="option">cyans</samp></dt>
<dd><p>Adjustments for cyan pixels (pixels where the red component is the minimum)
</p></dd>
<dt><samp class="option">blues</samp></dt>
<dd><p>Adjustments for blue pixels (pixels where the blue component is the maximum)
</p></dd>
<dt><samp class="option">magentas</samp></dt>
<dd><p>Adjustments for magenta pixels (pixels where the green component is the minimum)
</p></dd>
<dt><samp class="option">whites</samp></dt>
<dd><p>Adjustments for white pixels (pixels where all components are greater than 128)
</p></dd>
<dt><samp class="option">neutrals</samp></dt>
<dd><p>Adjustments for all pixels except pure black and pure white
</p></dd>
<dt><samp class="option">blacks</samp></dt>
<dd><p>Adjustments for black pixels (pixels where all components are lesser than 128)
</p></dd>
<dt><samp class="option">psfile</samp></dt>
<dd><p>Specify a Photoshop selective color file (<code class="code">.asv</code>) to import the settings from.
</p></dd>
</dl>
<p>All the adjustment settings (<samp class="option">reds</samp>, <samp class="option">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>
<ul class="mini-toc">
<li><a href="#Examples-132" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-132">
<h4 class="subsection">30.224.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
</pre></div>
</li></ul>
<a class="anchor" id="separatefields"></a></div>
</div>
<div class="section-level-extent" id="separatefields-1">
<h3 class="section">30.225 separatefields</h3>
<p>The <code class="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 class="ref" href="#setfield">setfield</a> filter before <code class="code">separatefields</code> filter.
</p>
</div>
<div class="section-level-extent" id="setdar_002c-setsar">
<h3 class="section">30.226 setdar, setsar</h3>
<p>The <code class="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-preformatted"><var class="var">DAR</var> = <var class="var">HORIZONTAL_RESOLUTION</var> / <var class="var">VERTICAL_RESOLUTION</var> * <var class="var">SAR</var>
</pre></div>
<p>Keep in mind that the <code class="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 class="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 class="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 class="table">
<dt><samp class="option">r, ratio, dar (<code class="code">setdar</code> only), sar (<code class="code">setsar</code> only)</samp></dt>
<dd><p>Set the aspect ratio used by the filter.
</p>
<p>The parameter can be a floating point number string, or an expression. If the
parameter is not specified, the value "0" is assumed, meaning that the same
input value is used.
</p>
</dd>
<dt><samp class="option">max</samp></dt>
<dd><p>Set the maximum integer value to use for expressing numerator and
denominator when reducing the expressed aspect ratio to a rational.
Default value is <code class="code">100</code>.
</p>
</dd>
</dl>
<p>The parameter <var class="var">sar</var> is an expression containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">w, h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>Same as <var class="var">w</var> / <var class="var">h</var>.
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The input sample aspect ratio.
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>The input display aspect ratio. It is the same as
(<var class="var">w</var> / <var class="var">h</var>) * <var class="var">sar</var>.
</p>
</dd>
<dt><samp class="option">hsub, vsub</samp></dt>
<dd><p>Horizontal and vertical chroma subsample values. For example, for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-133" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-133">
<h4 class="subsection">30.226.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>To change the display aspect ratio to 16:9, specify one of the following:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">setdar=ratio=16/9:max=1000
</pre></div>
</li></ul>
<a class="anchor" id="setfield"></a></div>
</div>
<div class="section-level-extent" id="setfield-1">
<h3 class="section">30.227 setfield</h3>
<p>Force field for the output video frame.
</p>
<p>The <code class="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 class="code">fieldorder</code> or <code class="code">yadif</code>).
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same field property.
</p>
</dd>
<dt>‘<samp class="samp">bff</samp>’</dt>
<dd><p>Mark the frame as bottom-field-first.
</p>
</dd>
<dt>‘<samp class="samp">tff</samp>’</dt>
<dd><p>Mark the frame as top-field-first.
</p>
</dd>
<dt>‘<samp class="samp">prog</samp>’</dt>
<dd><p>Mark the frame as progressive.
</p></dd>
</dl>
</dd>
</dl>
<a class="anchor" id="setparams"></a></div>
<div class="section-level-extent" id="setparams-1">
<h3 class="section">30.228 setparams</h3>
<p>Force frame parameter for the output video frame.
</p>
<p>The <code class="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 class="table">
<dt><samp class="option">field_mode</samp></dt>
<dd><p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same field property (default).
</p>
</dd>
<dt>‘<samp class="samp">bff</samp>’</dt>
<dd><p>Mark the frame as bottom-field-first.
</p>
</dd>
<dt>‘<samp class="samp">tff</samp>’</dt>
<dd><p>Mark the frame as top-field-first.
</p>
</dd>
<dt>‘<samp class="samp">prog</samp>’</dt>
<dd><p>Mark the frame as progressive.
</p></dd>
</dl>
</dd>
<dt><samp class="option">range</samp></dt>
<dd><p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same color range property (default).
</p>
</dd>
<dt>‘<samp class="samp">unspecified, unknown</samp>’</dt>
<dd><p>Mark the frame as unspecified color range.
</p>
</dd>
<dt>‘<samp class="samp">limited, tv, mpeg</samp>’</dt>
<dd><p>Mark the frame as limited range.
</p>
</dd>
<dt>‘<samp class="samp">full, pc, jpeg</samp>’</dt>
<dd><p>Mark the frame as full range.
</p></dd>
</dl>
</dd>
<dt><samp class="option">color_primaries</samp></dt>
<dd><p>Set the color primaries.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same color primaries property (default).
</p>
</dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dt>‘<samp class="samp">film</samp>’</dt>
<dt>‘<samp class="samp">bt2020</samp>’</dt>
<dt>‘<samp class="samp">smpte428</samp>’</dt>
<dt>‘<samp class="samp">smpte431</samp>’</dt>
<dt>‘<samp class="samp">smpte432</samp>’</dt>
<dt>‘<samp class="samp">jedec-p22</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">color_trc</samp></dt>
<dd><p>Set the color transfer.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same color trc property (default).
</p>
</dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">bt470m</samp>’</dt>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dt>‘<samp class="samp">log100</samp>’</dt>
<dt>‘<samp class="samp">log316</samp>’</dt>
<dt>‘<samp class="samp">iec61966-2-4</samp>’</dt>
<dt>‘<samp class="samp">bt1361e</samp>’</dt>
<dt>‘<samp class="samp">iec61966-2-1</samp>’</dt>
<dt>‘<samp class="samp">bt2020-10</samp>’</dt>
<dt>‘<samp class="samp">bt2020-12</samp>’</dt>
<dt>‘<samp class="samp">smpte2084</samp>’</dt>
<dt>‘<samp class="samp">smpte428</samp>’</dt>
<dt>‘<samp class="samp">arib-std-b67</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">colorspace</samp></dt>
<dd><p>Set the colorspace.
Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same colorspace property (default).
</p>
</dd>
<dt>‘<samp class="samp">gbr</samp>’</dt>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dt>‘<samp class="samp">unknown</samp>’</dt>
<dt>‘<samp class="samp">fcc</samp>’</dt>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dt>‘<samp class="samp">ycgco</samp>’</dt>
<dt>‘<samp class="samp">bt2020nc</samp>’</dt>
<dt>‘<samp class="samp">bt2020c</samp>’</dt>
<dt>‘<samp class="samp">smpte2085</samp>’</dt>
<dt>‘<samp class="samp">chroma-derived-nc</samp>’</dt>
<dt>‘<samp class="samp">chroma-derived-c</samp>’</dt>
<dt>‘<samp class="samp">ictcp</samp>’</dt>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="sharpen_005fnpp">
<h3 class="section">30.229 sharpen_npp</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 class="table">
<dt><samp class="option">border_type</samp></dt>
<dd><p>Type of sampling to be used ad frame borders. One of the following:
</p><dl class="table">
<dt><samp class="option">replicate</samp></dt>
<dd><p>Replicate pixel values.
</p>
</dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="shear">
<h3 class="section">30.230 shear</h3>
<p>Apply shear transform to input video.
</p>
<p>This filter supports the following options:
</p>
<dl class="table">
<dt><samp class="option">shx</samp></dt>
<dd><p>Shear factor in X-direction. Default value is 0.
Allowed range is from -2 to 2.
</p>
</dd>
<dt><samp class="option">shy</samp></dt>
<dd><p>Shear factor in Y-direction. Default value is 0.
Allowed range is from -2 to 2.
</p>
</dd>
<dt><samp class="option">fillcolor, c</samp></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><samp class="option">interp</samp></dt>
<dd><p>Set interpolation type. Can be <code class="code">bilinear</code> or <code class="code">nearest</code>. Default is <code class="code">bilinear</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-142" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-142">
<h4 class="subsection">30.230.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="showinfo">
<h3 class="section">30.231 showinfo</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 class="table">
<dt><samp class="option">checksum</samp></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 class="var">key</var>:<var class="var">value</var>.
</p>
<p>The following values are shown in the output:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>The (sequential) number of the input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>The Presentation TimeStamp of the input frame, expressed as a number of
time base units. The time base unit depends on the filter input pad.
</p>
</dd>
<dt><samp class="option">pts_time</samp></dt>
<dd><p>The Presentation TimeStamp of the input frame, expressed as a number of
seconds.
</p>
</dd>
<dt><samp class="option">fmt</samp></dt>
<dd><p>The pixel format name.
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The sample aspect ratio of the input frame, expressed in the form
<var class="var">num</var>/<var class="var">den</var>.
</p>
</dd>
<dt><samp class="option">s</samp></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><samp class="option">i</samp></dt>
<dd><p>The type of interlaced mode ("P" for "progressive", "T" for top field first, "B"
for bottom field first).
</p>
</dd>
<dt><samp class="option">iskey</samp></dt>
<dd><p>This is 1 if the frame is a key frame, 0 otherwise.
</p>
</dd>
<dt><samp class="option">type</samp></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 class="code">AVPictureType</code> enum and of
the <code class="code">av_get_picture_type_char</code> function defined in
<samp class="file">libavutil/avutil.h</samp>.
</p>
</dd>
<dt><samp class="option">checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame.
</p>
</dd>
<dt><samp class="option">plane_checksum</samp></dt>
<dd><p>The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame,
expressed in the form "[<var class="var">c0</var> <var class="var">c1</var> <var class="var">c2</var> <var class="var">c3</var>]".
</p>
</dd>
<dt><samp class="option">mean</samp></dt>
<dd><p>The mean value of pixels in each plane of the input frame, expressed in the form
"[<var class="var">mean0</var> <var class="var">mean1</var> <var class="var">mean2</var> <var class="var">mean3</var>]".
</p>
</dd>
<dt><samp class="option">stdev</samp></dt>
<dd><p>The standard deviation of pixel values in each plane of the input frame, expressed
in the form "[<var class="var">stdev0</var> <var class="var">stdev1</var> <var class="var">stdev2</var> <var class="var">stdev3</var>]".
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="showpalette">
<h3 class="section">30.232 showpalette</h3>
<p>Displays the 256 colors palette of each frame. This filter is only relevant for
<var class="var">pal8</var> pixel format frames.
</p>
<p>It accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">s</samp></dt>
<dd><p>Set the size of the box used to represent one palette color entry. Default is
<code class="code">30</code> (for a <code class="code">30x30</code> pixel box).
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="shuffleframes">
<h3 class="section">30.233 shuffleframes</h3>
<p>Reorder and/or duplicate and/or drop video frames.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">mapping</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-134" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-134">
<h4 class="subsection">30.233.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Swap second and third frame of every three frames of the input:
<div class="example">
<pre class="example-preformatted">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-preformatted">ffmpeg -i INPUT -vf "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="shufflepixels">
<h3 class="section">30.234 shufflepixels</h3>
<p>Reorder pixels in video frames.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">direction, d</samp></dt>
<dd><p>Set shuffle direction. Can be forward or inverse direction.
Default direction is forward.
</p>
</dd>
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set shuffle mode. Can be horizontal, vertical or block mode.
</p>
</dd>
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></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><samp class="option">seed, s</samp></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>
</div>
<div class="section-level-extent" id="shuffleplanes">
<h3 class="section">30.235 shuffleplanes</h3>
<p>Reorder and/or duplicate video planes.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">map0</samp></dt>
<dd><p>The index of the input plane to be used as the first output plane.
</p>
</dd>
<dt><samp class="option">map1</samp></dt>
<dd><p>The index of the input plane to be used as the second output plane.
</p>
</dd>
<dt><samp class="option">map2</samp></dt>
<dd><p>The index of the input plane to be used as the third output plane.
</p>
</dd>
<dt><samp class="option">map3</samp></dt>
<dd><p>The index of the input plane to be used as the fourth output plane.
</p>
</dd>
</dl>
<p>The first plane has the index 0. The default is to keep the input unchanged.
</p>
<ul class="mini-toc">
<li><a href="#Examples-135" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-135">
<h4 class="subsection">30.235.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Swap the second and third planes of the input:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
</pre></div>
</li></ul>
<a class="anchor" id="signalstats"></a></div>
</div>
<div class="section-level-extent" id="signalstats-1">
<h3 class="section">30.236 signalstats</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 class="table">
<dt><samp class="option">YMIN</samp></dt>
<dd><p>Display the minimal Y value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">YLOW</samp></dt>
<dd><p>Display the Y value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">YAVG</samp></dt>
<dd><p>Display the average Y value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp class="option">YHIGH</samp></dt>
<dd><p>Display the Y value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">YMAX</samp></dt>
<dd><p>Display the maximum Y value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">UMIN</samp></dt>
<dd><p>Display the minimal U value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">ULOW</samp></dt>
<dd><p>Display the U value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">UAVG</samp></dt>
<dd><p>Display the average U value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp class="option">UHIGH</samp></dt>
<dd><p>Display the U value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">UMAX</samp></dt>
<dd><p>Display the maximum U value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">VMIN</samp></dt>
<dd><p>Display the minimal V value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">VLOW</samp></dt>
<dd><p>Display the V value at the 10% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">VAVG</samp></dt>
<dd><p>Display the average V value within the input frame. Expressed in range of
[0-255].
</p>
</dd>
<dt><samp class="option">VHIGH</samp></dt>
<dd><p>Display the V value at the 90% percentile within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">VMAX</samp></dt>
<dd><p>Display the maximum V value contained within the input frame. Expressed in
range of [0-255].
</p>
</dd>
<dt><samp class="option">SATMIN</samp></dt>
<dd><p>Display the minimal saturation value contained within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp class="option">SATLOW</samp></dt>
<dd><p>Display the saturation value at the 10% percentile within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp class="option">SATAVG</samp></dt>
<dd><p>Display the average saturation value within the input frame. Expressed in range
of [0-~181.02].
</p>
</dd>
<dt><samp class="option">SATHIGH</samp></dt>
<dd><p>Display the saturation value at the 90% percentile within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp class="option">SATMAX</samp></dt>
<dd><p>Display the maximum saturation value contained within the input frame.
Expressed in range of [0-~181.02].
</p>
</dd>
<dt><samp class="option">HUEMED</samp></dt>
<dd><p>Display the median value for hue within the input frame. Expressed in range of
[0-360].
</p>
</dd>
<dt><samp class="option">HUEAVG</samp></dt>
<dd><p>Display the average value for hue within the input frame. Expressed in range of
[0-360].
</p>
</dd>
<dt><samp class="option">YDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the Y
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp class="option">UDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the U
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp class="option">VDIF</samp></dt>
<dd><p>Display the average of sample value difference between all values of the V
plane in the current frame and corresponding values of the previous input frame.
Expressed in range of [0-255].
</p>
</dd>
<dt><samp class="option">YBITDEPTH</samp></dt>
<dd><p>Display bit depth of Y plane in current frame.
Expressed in range of [0-16].
</p>
</dd>
<dt><samp class="option">UBITDEPTH</samp></dt>
<dd><p>Display bit depth of U plane in current frame.
Expressed in range of [0-16].
</p>
</dd>
<dt><samp class="option">VBITDEPTH</samp></dt>
<dd><p>Display bit depth of V plane in current frame.
Expressed in range of [0-16].
</p></dd>
</dl>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">stat</samp></dt>
<dt><samp class="option">out</samp></dt>
<dd>
<p><samp class="option">stat</samp> specify an additional form of image analysis.
<samp class="option">out</samp> output video with the specified type of pixel highlighted.
</p>
<p>Both options accept the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">tout</samp>’</dt>
<dd><p>Identify <var class="var">temporal outliers</var> pixels. A <var class="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>‘<samp class="samp">vrep</samp>’</dt>
<dd><p>Identify <var class="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>‘<samp class="samp">brng</samp>’</dt>
<dd><p>Identify pixels that fall outside of legal broadcast range.
</p></dd>
</dl>
</dd>
<dt><samp class="option">color, c</samp></dt>
<dd><p>Set the highlight color for the <samp class="option">out</samp> option. The default color is
yellow.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-136" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-136">
<h4 class="subsection">30.236.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Output data of various video metrics:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">time %{pts:hms}
Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
</pre></div>
</li></ul>
<a class="anchor" id="signature"></a></div>
</div>
<div class="section-level-extent" id="signature-1">
<h3 class="section">30.237 signature</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 class="table">
<dt><samp class="option">detectmode</samp></dt>
<dd><p>Enable or disable the matching process.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">off</samp>’</dt>
<dd><p>Disable the calculation of a matching (default).
</p></dd>
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>Calculate the matching for the whole video and output whether the whole video
matches or only parts.
</p></dd>
<dt>‘<samp class="samp">fast</samp>’</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><samp class="option">nb_inputs</samp></dt>
<dd><p>Set the number of inputs. The option value must be a non negative integer.
Default value is 1.
</p>
</dd>
<dt><samp class="option">filename</samp></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><samp class="option">format</samp></dt>
<dd><p>Choose the output format.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">binary</samp>’</dt>
<dd><p>Use the specified binary representation (default).
</p></dd>
<dt>‘<samp class="samp">xml</samp>’</dt>
<dd><p>Use the specified xml representation.
</p></dd>
</dl>
</dd>
<dt><samp class="option">th_d</samp></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><samp class="option">th_dc</samp></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><samp class="option">th_xh</samp></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><samp class="option">th_di</samp></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><samp class="option">th_it</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-137" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-137">
<h4 class="subsection">30.237.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>To calculate the signature of an input video and store it in signature.bin:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
<a class="anchor" id="siti"></a></div>
</div>
<div class="section-level-extent" id="siti-1">
<h3 class="section">30.238 siti</h3>
<p>Calculate Spatial Information (SI) and Temporal Information (TI) scores for a video,
as defined in ITU-T Rec. P.910 (11/21): Subjective video quality assessment methods
for multimedia applications. Available PDF at <a class="url" href="https://www.itu.int/rec/T-REC-P.910-202111-S/en">https://www.itu.int/rec/T-REC-P.910-202111-S/en</a>.
Note that this is a legacy implementation that corresponds to a superseded recommendation.
Refer to ITU-T Rec. P.910 (07/22) for the latest version: <a class="url" href="https://www.itu.int/rec/T-REC-P.910-202207-I/en">https://www.itu.int/rec/T-REC-P.910-202207-I/en</a>
</p>
<p>It accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">print_summary</samp></dt>
<dd><p>If set to 1, Summary statistics will be printed to the console. Default 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-138" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-138">
<h4 class="subsection">30.238.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>To calculate SI/TI metrics and print summary:
<div class="example">
<pre class="example-preformatted">ffmpeg -i input.mp4 -vf siti=print_summary=1 -f null -
</pre></div>
</li></ul>
<a class="anchor" id="smartblur"></a></div>
</div>
<div class="section-level-extent" id="smartblur-1">
<h3 class="section">30.239 smartblur</h3>
<p>Blur the input video without impacting the outlines.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dd><p>Set the luma radius. The option value must be a float number in
the range [0.1,5.0] that specifies the variance of the gaussian filter
used to blur the image (slower if larger). Default value is 1.0.
</p>
</dd>
<dt><samp class="option">luma_strength, ls</samp></dt>
<dd><p>Set the luma strength. The option value must be a float number
in the range [-1.0,1.0] that configures the blurring. A value included
in [0.0,1.0] will blur the image whereas a value included in
[-1.0,0.0] will sharpen the image. Default value is 1.0.
</p>
</dd>
<dt><samp class="option">luma_threshold, lt</samp></dt>
<dd><p>Set the luma threshold used as a coefficient to determine
whether a pixel should be blurred or not. The option value must be an
integer in the range [-30,30]. A value of 0 will filter all the image,
a value included in [0,30] will filter flat areas and a value included
in [-30,0] will filter edges. Default value is 0.
</p>
</dd>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dd><p>Set the chroma radius. The option value must be a float number in
the range [0.1,5.0] that specifies the variance of the gaussian filter
used to blur the image (slower if larger). Default value is <samp class="option">luma_radius</samp>.
</p>
</dd>
<dt><samp class="option">chroma_strength, cs</samp></dt>
<dd><p>Set the chroma strength. The option value must be a float number
in the range [-1.0,1.0] that configures the blurring. A value included
in [0.0,1.0] will blur the image whereas a value included in
[-1.0,0.0] will sharpen the image. Default value is <samp class="option">luma_strength</samp>.
</p>
</dd>
<dt><samp class="option">chroma_threshold, ct</samp></dt>
<dd><p>Set the chroma threshold used as a coefficient to determine
whether a pixel should be blurred or not. The option value must be an
integer in the range [-30,30]. A value of 0 will filter all the image,
a value included in [0,30] will filter flat areas and a value included
in [-30,0] will filter edges. Default value is <samp class="option">luma_threshold</samp>.
</p></dd>
</dl>
<p>If a chroma option is not explicitly set, the corresponding luma value
is set.
</p>
</div>
<div class="section-level-extent" id="sobel">
<h3 class="section">30.240 sobel</h3>
<p>Apply sobel operator to input video stream.
</p>
<p>The filter accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-143" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-143">
<h4 class="subsection">30.240.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
<a class="anchor" id="spp"></a></div>
</div>
<div class="section-level-extent" id="spp-1">
<h3 class="section">30.241 spp</h3>
<p>Apply a simple postprocessing filter that compresses and decompresses the image
at several (or - in the case of <samp class="option">quality</samp> level <code class="code">6</code> - all) shifts
and average the results.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 0-6. If set to <code class="code">0</code>, the filter will have no
effect. A value of <code class="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 class="code">3</code>.
</p>
</dd>
<dt><samp class="option">qp</samp></dt>
<dd><p>Force a constant quantization parameter. If not set, the filter will use the QP
from the video stream (if available).
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set thresholding mode. Available modes are:
</p>
<dl class="table">
<dt>‘<samp class="samp">hard</samp>’</dt>
<dd><p>Set hard thresholding (default).
</p></dd>
<dt>‘<samp class="samp">soft</samp>’</dt>
<dd><p>Set soft thresholding (better de-ringing effect, but likely blurrier).
</p></dd>
</dl>
</dd>
<dt><samp class="option">use_bframe_qp</samp></dt>
<dd><p>Enable the use of the QP from the B-Frames if set to <code class="code">1</code>. Using this
option may cause flicker since the B-Frames have often larger QP. Default is
<code class="code">0</code> (not enabled).
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-144" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-144">
<h4 class="subsection">30.241.1 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">quality, level</samp></dt>
<dd><p>Set quality level. The value <code class="code">max</code> can be used to set the maximum level,
currently <code class="code">6</code>.
</p></dd>
</dl>
<a class="anchor" id="sr"></a></div>
</div>
<div class="section-level-extent" id="sr-1">
<h3 class="section">30.242 sr</h3>
<p>Scale the input by applying one of the super-resolution methods based on
convolutional neural networks. Supported models:
</p>
<ul class="itemize mark-bullet">
<li>Super-Resolution Convolutional Neural Network model (SRCNN).
See <a class="url" 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 class="url" 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 class="url" 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 class="url" href="https://github.com/HighVoltageRocknRoll/sr.git">https://github.com/HighVoltageRocknRoll/sr.git</a>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">dnn_backend</samp></dt>
<dd><p>Specify which DNN backend to use for model loading and execution. This option accepts
the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">tensorflow</samp>’</dt>
<dd><p>TensorFlow backend. To enable this backend you
need to install the TensorFlow for C library (see
<a class="url" href="https://www.tensorflow.org/install/lang_c">https://www.tensorflow.org/install/lang_c</a>) and configure FFmpeg with
<code class="code">--enable-libtensorflow</code>
</p></dd>
</dl>
</dd>
<dt><samp class="option">model</samp></dt>
<dd><p>Set path to model file specifying network architecture and its parameters.
Note that different backends use different file formats. TensorFlow, OpenVINO backend
can load files for only its format.
</p>
</dd>
<dt><samp class="option">scale_factor</samp></dt>
<dd><p>Set scale factor for SRCNN model. Allowed values are <code class="code">2</code>, <code class="code">3</code> and <code class="code">4</code>.
Default value is <code class="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 class="ref" href="#dnn_005fprocessing">dnn_processing</a> filter.
</p>
</div>
<div class="section-level-extent" id="ssim">
<h3 class="section">30.243 ssim</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 class="table">
<dt><samp class="option">stats_file, f</samp></dt>
<dd><p>If specified the filter will use the named file to save the SSIM of
each individual frame. When filename equals "-" the data is sent to
standard output.
</p></dd>
</dl>
<p>The file printed if <var class="var">stats_file</var> is selected, contains a sequence of
key/value pairs of the form <var class="var">key</var>:<var class="var">value</var> for each compared
couple of frames.
</p>
<p>A description of each shown parameter follows:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>sequential number of the input frame, starting from 1
</p>
</dd>
<dt><samp class="option">Y, U, V, R, G, B</samp></dt>
<dd><p>SSIM of the compared frames for the component specified by the suffix.
</p>
</dd>
<dt><samp class="option">All</samp></dt>
<dd><p>SSIM of the compared frames for the whole frame.
</p>
</dd>
<dt><samp class="option">dB</samp></dt>
<dd><p>Same as above but in dB representation.
</p></dd>
</dl>
<p>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<ul class="mini-toc">
<li><a href="#Examples-139" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-139">
<h4 class="subsection">30.243.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>For example:
<div class="example">
<pre class="example-preformatted">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 class="file">ref_movie.mpg</samp>. The SSIM of each individual frame
is stored in <samp class="file">stats.log</samp>.
</p>
</li><li>Another example with both psnr and ssim at same time:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="stereo3d">
<h3 class="section">30.244 stereo3d</h3>
<p>Convert between different stereoscopic image formats.
</p>
<p>The filters accept the following options:
</p>
<dl class="table">
<dt><samp class="option">in</samp></dt>
<dd><p>Set stereoscopic image format of input.
</p>
<p>Available values for input image formats are:
</p><dl class="table">
<dt>‘<samp class="samp">sbsl</samp>’</dt>
<dd><p>side by side parallel (left eye left, right eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbsr</samp>’</dt>
<dd><p>side by side crosseye (right eye left, left eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbs2l</samp>’</dt>
<dd><p>side by side parallel with half width resolution
(left eye left, right eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbs2r</samp>’</dt>
<dd><p>side by side crosseye with half width resolution
(right eye left, left eye right)
</p>
</dd>
<dt>‘<samp class="samp">abl</samp>’</dt>
<dt>‘<samp class="samp">tbl</samp>’</dt>
<dd><p>above-below (left eye above, right eye below)
</p>
</dd>
<dt>‘<samp class="samp">abr</samp>’</dt>
<dt>‘<samp class="samp">tbr</samp>’</dt>
<dd><p>above-below (right eye above, left eye below)
</p>
</dd>
<dt>‘<samp class="samp">ab2l</samp>’</dt>
<dt>‘<samp class="samp">tb2l</samp>’</dt>
<dd><p>above-below with half height resolution
(left eye above, right eye below)
</p>
</dd>
<dt>‘<samp class="samp">ab2r</samp>’</dt>
<dt>‘<samp class="samp">tb2r</samp>’</dt>
<dd><p>above-below with half height resolution
(right eye above, left eye below)
</p>
</dd>
<dt>‘<samp class="samp">al</samp>’</dt>
<dd><p>alternating frames (left eye first, right eye second)
</p>
</dd>
<dt>‘<samp class="samp">ar</samp>’</dt>
<dd><p>alternating frames (right eye first, left eye second)
</p>
</dd>
<dt>‘<samp class="samp">irl</samp>’</dt>
<dd><p>interleaved rows (left eye has top row, right eye starts on next row)
</p>
</dd>
<dt>‘<samp class="samp">irr</samp>’</dt>
<dd><p>interleaved rows (right eye has top row, left eye starts on next row)
</p>
</dd>
<dt>‘<samp class="samp">icl</samp>’</dt>
<dd><p>interleaved columns, left eye first
</p>
</dd>
<dt>‘<samp class="samp">icr</samp>’</dt>
<dd><p>interleaved columns, right eye first
</p>
<p>Default value is ‘<samp class="samp">sbsl</samp>’.
</p></dd>
</dl>
</dd>
<dt><samp class="option">out</samp></dt>
<dd><p>Set stereoscopic image format of output.
</p>
<dl class="table">
<dt>‘<samp class="samp">sbsl</samp>’</dt>
<dd><p>side by side parallel (left eye left, right eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbsr</samp>’</dt>
<dd><p>side by side crosseye (right eye left, left eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbs2l</samp>’</dt>
<dd><p>side by side parallel with half width resolution
(left eye left, right eye right)
</p>
</dd>
<dt>‘<samp class="samp">sbs2r</samp>’</dt>
<dd><p>side by side crosseye with half width resolution
(right eye left, left eye right)
</p>
</dd>
<dt>‘<samp class="samp">abl</samp>’</dt>
<dt>‘<samp class="samp">tbl</samp>’</dt>
<dd><p>above-below (left eye above, right eye below)
</p>
</dd>
<dt>‘<samp class="samp">abr</samp>’</dt>
<dt>‘<samp class="samp">tbr</samp>’</dt>
<dd><p>above-below (right eye above, left eye below)
</p>
</dd>
<dt>‘<samp class="samp">ab2l</samp>’</dt>
<dt>‘<samp class="samp">tb2l</samp>’</dt>
<dd><p>above-below with half height resolution
(left eye above, right eye below)
</p>
</dd>
<dt>‘<samp class="samp">ab2r</samp>’</dt>
<dt>‘<samp class="samp">tb2r</samp>’</dt>
<dd><p>above-below with half height resolution
(right eye above, left eye below)
</p>
</dd>
<dt>‘<samp class="samp">al</samp>’</dt>
<dd><p>alternating frames (left eye first, right eye second)
</p>
</dd>
<dt>‘<samp class="samp">ar</samp>’</dt>
<dd><p>alternating frames (right eye first, left eye second)
</p>
</dd>
<dt>‘<samp class="samp">irl</samp>’</dt>
<dd><p>interleaved rows (left eye has top row, right eye starts on next row)
</p>
</dd>
<dt>‘<samp class="samp">irr</samp>’</dt>
<dd><p>interleaved rows (right eye has top row, left eye starts on next row)
</p>
</dd>
<dt>‘<samp class="samp">arbg</samp>’</dt>
<dd><p>anaglyph red/blue gray
(red filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">argg</samp>’</dt>
<dd><p>anaglyph red/green gray
(red filter on left eye, green filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">arcg</samp>’</dt>
<dd><p>anaglyph red/cyan gray
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">arch</samp>’</dt>
<dd><p>anaglyph red/cyan half colored
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">arcc</samp>’</dt>
<dd><p>anaglyph red/cyan color
(red filter on left eye, cyan filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">arcd</samp>’</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>‘<samp class="samp">agmg</samp>’</dt>
<dd><p>anaglyph green/magenta gray
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">agmh</samp>’</dt>
<dd><p>anaglyph green/magenta half colored
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">agmc</samp>’</dt>
<dd><p>anaglyph green/magenta colored
(green filter on left eye, magenta filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">agmd</samp>’</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>‘<samp class="samp">aybg</samp>’</dt>
<dd><p>anaglyph yellow/blue gray
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">aybh</samp>’</dt>
<dd><p>anaglyph yellow/blue half colored
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">aybc</samp>’</dt>
<dd><p>anaglyph yellow/blue colored
(yellow filter on left eye, blue filter on right eye)
</p>
</dd>
<dt>‘<samp class="samp">aybd</samp>’</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>‘<samp class="samp">ml</samp>’</dt>
<dd><p>mono output (left eye only)
</p>
</dd>
<dt>‘<samp class="samp">mr</samp>’</dt>
<dd><p>mono output (right eye only)
</p>
</dd>
<dt>‘<samp class="samp">chl</samp>’</dt>
<dd><p>checkerboard, left eye first
</p>
</dd>
<dt>‘<samp class="samp">chr</samp>’</dt>
<dd><p>checkerboard, right eye first
</p>
</dd>
<dt>‘<samp class="samp">icl</samp>’</dt>
<dd><p>interleaved columns, left eye first
</p>
</dd>
<dt>‘<samp class="samp">icr</samp>’</dt>
<dd><p>interleaved columns, right eye first
</p>
</dd>
<dt>‘<samp class="samp">hdmi</samp>’</dt>
<dd><p>HDMI frame pack
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">arcd</samp>’.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-140" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-140">
<h4 class="subsection">30.244.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Convert input video from side by side parallel to anaglyph yellow/blue dubois:
<div class="example">
<pre class="example-preformatted">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-preformatted">stereo3d=abl:sbsr
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="streamselect_002c-astreamselect">
<h3 class="section">30.245 streamselect, astreamselect</h3>
<p>Select video or audio streams.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set number of inputs. Default is 2.
</p>
</dd>
<dt><samp class="option">map</samp></dt>
<dd><p>Set input indexes to remap to outputs.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-145" accesskey="1">Commands</a></li>
<li><a href="#Examples-141" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-145">
<h4 class="subsection">30.245.1 Commands</h4>
<p>The <code class="code">streamselect</code> and <code class="code">astreamselect</code> filter supports the following
commands:
</p>
<dl class="table">
<dt><samp class="option">map</samp></dt>
<dd><p>Set input indexes to remap to outputs.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-141">
<h4 class="subsection">30.245.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Select first 5 seconds 1st stream and rest of time 2nd stream:
<div class="example">
<pre class="example-preformatted">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-preformatted">asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
</pre></div>
</li></ul>
<a class="anchor" id="subtitles"></a></div>
</div>
<div class="section-level-extent" id="subtitles-1">
<h3 class="section">30.246 subtitles</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 class="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 class="table">
<dt><samp class="option">filename, f</samp></dt>
<dd><p>Set the filename of the subtitle file to read. It must be specified.
</p>
</dd>
<dt><samp class="option">original_size</samp></dt>
<dd><p>Specify the size of the original video, the video for which the ASS file
was composed. For the syntax of this option, check the
<a 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><samp class="option">fontsdir</samp></dt>
<dd><p>Set a directory path containing fonts that can be used by the filter.
These fonts will be used in addition to whatever the font provider uses.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>Process alpha channel, by default alpha channel is untouched.
</p>
</dd>
<dt><samp class="option">charenc</samp></dt>
<dd><p>Set subtitles input character encoding. <code class="code">subtitles</code> filter only. Only
useful if not UTF-8.
</p>
</dd>
<dt><samp class="option">stream_index, si</samp></dt>
<dd><p>Set subtitles stream index. <code class="code">subtitles</code> filter only.
</p>
</dd>
<dt><samp class="option">force_style</samp></dt>
<dd><p>Override default style or script info parameters of the subtitles. It accepts a
string containing ASS style format <code class="code">KEY=VALUE</code> couples separated by ",".
</p>
</dd>
<dt><samp class="option">wrap_unicode</samp></dt>
<dd><p>Break lines according to the Unicode Line Breaking Algorithm. Availability requires
at least libass release 0.17.0 (or LIBASS_VERSION 0x01600010), <em class="emph">and</em> libass must
have been built with libunibreak.
</p>
<p>The option is enabled by default except for native ASS.
</p></dd>
</dl>
<p>If the first key is not specified, it is assumed that the first value
specifies the <samp class="option">filename</samp>.
</p>
<p>For example, to render the file <samp class="file">sub.srt</samp> on top of the input
video, use the command:
</p><div class="example">
<pre class="example-preformatted">subtitles=sub.srt
</pre></div>
<p>which is equivalent to:
</p><div class="example">
<pre class="example-preformatted">subtitles=filename=sub.srt
</pre></div>
<p>To render the default subtitles stream from file <samp class="file">video.mkv</samp>, use:
</p><div class="example">
<pre class="example-preformatted">subtitles=video.mkv
</pre></div>
<p>To render the second subtitles stream from that file, use:
</p><div class="example">
<pre class="example-preformatted">subtitles=video.mkv:si=1
</pre></div>
<p>To make the subtitles stream from <samp class="file">sub.srt</samp> appear in 80% transparent blue
<code class="code">DejaVu Serif</code>, use:
</p><div class="example">
<pre class="example-preformatted">subtitles=sub.srt:force_style='Fontname=DejaVu Serif,PrimaryColour=&HCCFF0000'
</pre></div>
</div>
<div class="section-level-extent" id="super2xsai">
<h3 class="section">30.247 super2xsai</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>
</div>
<div class="section-level-extent" id="swaprect">
<h3 class="section">30.248 swaprect</h3>
<p>Swap two rectangular objects in video.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">w</samp></dt>
<dd><p>Set object width.
</p>
</dd>
<dt><samp class="option">h</samp></dt>
<dd><p>Set object height.
</p>
</dd>
<dt><samp class="option">x1</samp></dt>
<dd><p>Set 1st rect x coordinate.
</p>
</dd>
<dt><samp class="option">y1</samp></dt>
<dd><p>Set 1st rect y coordinate.
</p>
</dd>
<dt><samp class="option">x2</samp></dt>
<dd><p>Set 2nd rect x coordinate.
</p>
</dd>
<dt><samp class="option">y2</samp></dt>
<dd><p>Set 2nd rect y coordinate.
</p>
<p>All expressions are evaluated once for each frame.
</p></dd>
</dl>
<p>The all options are expressions containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>same as <var class="var">w</var> / <var class="var">h</var>
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var class="var">w</var> / <var class="var">h</var>) * <var class="var">sar</var>
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>The number of the input frame, starting from 0.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown.
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>the position in the file of the input frame, NAN if unknown; deprecated,
do not use
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-146" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-146">
<h4 class="subsection">30.248.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="swapuv">
<h3 class="section">30.249 swapuv</h3>
<p>Swap U & V plane.
</p>
</div>
<div class="section-level-extent" id="tblend">
<h3 class="section">30.250 tblend</h3>
<p>Blend successive video frames.
</p>
<p>See <a class="ref" href="#blend">blend</a>
</p>
</div>
<div class="section-level-extent" id="telecine">
<h3 class="section">30.251 telecine</h3>
<p>Apply telecine process to the video.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">first_field</samp></dt>
<dd><dl class="table">
<dt>‘<samp class="samp">top, t</samp>’</dt>
<dd><p>top field first
</p></dd>
<dt>‘<samp class="samp">bottom, b</samp>’</dt>
<dd><p>bottom field first
The default value is <code class="code">top</code>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">pattern</samp></dt>
<dd><p>A string of numbers representing the pulldown pattern you wish to apply.
The default value is <code class="code">23</code>.
</p></dd>
</dl>
<div class="example">
<pre class="example-preformatted">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>
</div>
<div class="section-level-extent" id="thistogram">
<h3 class="section">30.252 thistogram</h3>
<p>Compute and draw a color distribution histogram for the input video across time.
</p>
<p>Unlike <a class="ref" 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 class="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 class="table">
<dt><samp class="option">width, w</samp></dt>
<dd><p>Set width of single color component output. Default value is <code class="code">0</code>.
Value of <code class="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><samp class="option">display_mode, d</samp></dt>
<dd><p>Set display mode.
It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">stack</samp>’</dt>
<dd><p>Per color component graphs are placed below each other.
</p>
</dd>
<dt>‘<samp class="samp">parade</samp>’</dt>
<dd><p>Per color component graphs are placed side by side.
</p>
</dd>
<dt>‘<samp class="samp">overlay</samp>’</dt>
<dd><p>Presents information identical to that in the <code class="code">parade</code>, except
that the graphs representing color components are superimposed directly
over one another.
</p></dd>
</dl>
<p>Default is <code class="code">stack</code>.
</p>
</dd>
<dt><samp class="option">levels_mode, m</samp></dt>
<dd><p>Set mode. Can be either <code class="code">linear</code>, or <code class="code">logarithmic</code>.
Default is <code class="code">linear</code>.
</p>
</dd>
<dt><samp class="option">components, c</samp></dt>
<dd><p>Set what color components to display.
Default is <code class="code">7</code>.
</p>
</dd>
<dt><samp class="option">bgopacity, b</samp></dt>
<dd><p>Set background opacity. Default is <code class="code">0.9</code>.
</p>
</dd>
<dt><samp class="option">envelope, e</samp></dt>
<dd><p>Show envelope. Default is disabled.
</p>
</dd>
<dt><samp class="option">ecolor, ec</samp></dt>
<dd><p>Set envelope color. Default is <code class="code">gold</code>.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Set slide mode.
</p>
<p>Available values for slide is:
</p><dl class="table">
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Draw new frame when right border is reached.
</p>
</dd>
<dt>‘<samp class="samp">replace</samp>’</dt>
<dd><p>Replace old columns with new ones.
</p>
</dd>
<dt>‘<samp class="samp">scroll</samp>’</dt>
<dd><p>Scroll from right to left.
</p>
</dd>
<dt>‘<samp class="samp">rscroll</samp>’</dt>
<dd><p>Scroll from left to right.
</p>
</dd>
<dt>‘<samp class="samp">picture</samp>’</dt>
<dd><p>Draw single picture.
</p></dd>
</dl>
<p>Default is <code class="code">replace</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="threshold">
<h3 class="section">30.253 threshold</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p></dd>
</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>
<ul class="mini-toc">
<li><a href="#Commands-147" accesskey="1">Commands</a></li>
<li><a href="#Examples-142" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-147">
<h4 class="subsection">30.253.1 Commands</h4>
<p>This filter supports the all options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-142">
<h4 class="subsection">30.253.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Binary threshold, using gray color as threshold:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="thumbnail">
<h3 class="section">30.254 thumbnail</h3>
<p>Select the most representative frame in a given sequence of consecutive frames.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>Set the frames batch size to analyze; in a set of <var class="var">n</var> frames, the filter
will pick one of them, and then handle the next batch of <var class="var">n</var> frames until
the end. Default is <code class="code">100</code>.
</p>
</dd>
<dt><samp class="option">log</samp></dt>
<dd><p>Set the log level to display picked frame stats.
Default is <code class="code">info</code>.
</p></dd>
</dl>
<p>Since the filter keeps track of the whole frames sequence, a bigger <var class="var">n</var>
value will result in a higher memory usage, so a high value is not recommended.
</p>
<ul class="mini-toc">
<li><a href="#Examples-143" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-143">
<h4 class="subsection">30.254.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Extract one picture each 50 frames:
<div class="example">
<pre class="example-preformatted">thumbnail=50
</pre></div>
</li><li>Complete example of a thumbnail creation with <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
</pre></div>
</li></ul>
<a class="anchor" id="tile"></a></div>
</div>
<div class="section-level-extent" id="tile-1">
<h3 class="section">30.255 tile</h3>
<p>Tile several successive frames together.
</p>
<p>The <a class="ref" href="#untile">untile</a> filter can do the reverse.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">layout</samp></dt>
<dd><p>Set the grid size in the form <code class="code">COLUMNSxROWS</code>. Range is upto UINT_MAX cells.
Default is <code class="code">6x5</code>.
</p>
</dd>
<dt><samp class="option">nb_frames</samp></dt>
<dd><p>Set the maximum number of frames to render in the given area. It must be less
than or equal to <var class="var">w</var>x<var class="var">h</var>. The default value is <code class="code">0</code>, meaning all
the area will be used.
</p>
</dd>
<dt><samp class="option">margin</samp></dt>
<dd><p>Set the outer border margin in pixels. Range is 0 to 1024. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">padding</samp></dt>
<dd><p>Set the inner border thickness (i.e. the number of pixels between frames). For
more advanced padding options (such as having different values for the edges),
refer to the pad video filter. Range is 0 to 1024. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">color</samp></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 class="var">color</var> is "black".
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set the number of frames to overlap when tiling several successive frames together.
The value must be between <code class="code">0</code> and <var class="var">nb_frames - 1</var>. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">init_padding</samp></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 class="code">0</code> and <var class="var">nb_frames - 1</var>. Default is <code class="code">0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-144" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-144">
<h4 class="subsection">30.255.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Produce 8x8 PNG tiles of all keyframes (<samp class="option">-skip_frame nokey</samp>) in a movie:
<div class="example">
<pre class="example-preformatted">ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
</pre></div>
<p>The <samp class="option">-vsync 0</samp> is necessary to prevent <code class="command">ffmpeg</code> from
duplicating each output frame to accommodate the originally detected frame
rate.
</p>
</li><li>Display <code class="code">5</code> pictures in an area of <code class="code">3x2</code> frames,
with <code class="code">7</code> pixels between them, and <code class="code">2</code> pixels of initial margin, using
mixed flat and named options:
<div class="example">
<pre class="example-preformatted">tile=3x2:nb_frames=5:padding=7:margin=2
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="tinterlace">
<h3 class="section">30.256 tinterlace</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Specify the mode of the interlacing. This option can also be specified
as a value alone. See below for a list of values for this option.
</p>
<p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">merge, 0</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">drop_even, 1</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">drop_odd, 2</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">pad, 3</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">interleave_top, 4</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">interleave_bottom, 5</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">interlacex2, 6</samp>’</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-preformatted"> ------> 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>‘<samp class="samp">mergex2, 7</samp>’</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-preformatted"> ------> 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 class="code">merge</code>.
</p>
</dd>
<dt><samp class="option">flags</samp></dt>
<dd><p>Specify flags influencing the filter process.
</p>
<p>Available value for <var class="var">flags</var> is:
</p>
<dl class="table">
<dt><samp class="option">low_pass_filter, vlpf</samp></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><samp class="option">complex_filter, cvlpf</samp></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><samp class="option">bypass_il</samp></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 class="option">mode</samp> <var class="var">interleave_top</var> and <var class="var">interleave_bottom</var>.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="tmedian">
<h3 class="section">30.257 tmedian</h3>
<p>Pick median pixels from several successive input video frames.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">radius</samp></dt>
<dd><p>Set radius of median filter.
Default is 1. Allowed range is from 1 to 127.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">15</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">percentile</samp></dt>
<dd><p>Set median percentile. Default value is <code class="code">0.5</code>.
Default value of <code class="code">0.5</code> will pick always median values, while <code class="code">0</code> will pick
minimum values, and <code class="code">1</code> maximum values.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-148" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-148">
<h4 class="subsection">30.257.1 Commands</h4>
<p>This filter supports all above options as <a class="ref" href="#commands">commands</a>, excluding option <code class="code">radius</code>.
</p>
</div>
</div>
<div class="section-level-extent" id="tmidequalizer">
<h3 class="section">30.258 tmidequalizer</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 class="table">
<dt><samp class="option">radius</samp></dt>
<dd><p>Set filtering radius. Default is <code class="code">5</code>. Allowed range is from 1 to 127.
</p>
</dd>
<dt><samp class="option">sigma</samp></dt>
<dd><p>Set filtering sigma. Default is <code class="code">0.5</code>. This controls strength of filtering.
Setting this option to 0 effectively does nothing.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process. Default is <code class="code">15</code>, which is all available planes.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="tmix">
<h3 class="section">30.259 tmix</h3>
<p>Mix successive video frames.
</p>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">frames</samp></dt>
<dd><p>The number of successive frames to mix. If unspecified, it defaults to 3.
</p>
</dd>
<dt><samp class="option">weights</samp></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 class="var">frames</var> last specified weight will be used for all remaining
unset weights.
</p>
</dd>
<dt><samp class="option">scale</samp></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 class="var">scale</var> is auto scaled to sum of weights.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default is all. Allowed range is from 0 to 15.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-145" accesskey="1">Examples</a></li>
<li><a href="#Commands-149" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-145">
<h4 class="subsection">30.259.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Average 7 successive frames:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">tmix=frames=3:weights="-1 2 -1":scale=1
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-149">
<h4 class="subsection">30.259.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">weights</samp></dt>
<dt><samp class="option">scale</samp></dt>
<dt><samp class="option">planes</samp></dt>
<dd><p>Syntax is same as option with same name.
</p></dd>
</dl>
<a class="anchor" id="tonemap"></a></div>
</div>
<div class="section-level-extent" id="tonemap-1">
<h3 class="section">30.260 tonemap</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 class="ref" 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-preformatted">ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT
</pre></div>
<ul class="mini-toc">
<li><a href="#Options-38" accesskey="1">Options</a></li>
</ul>
<div class="subsection-level-extent" id="Options-38">
<h4 class="subsection">30.260.1 Options</h4>
<p>The filter accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">tonemap</samp></dt>
<dd><p>Set the tone map algorithm to use.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">none</var></dt>
<dd><p>Do not apply any tone map, only desaturate overbright pixels.
</p>
</dd>
<dt><var class="var">clip</var></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><var class="var">linear</var></dt>
<dd><p>Stretch the entire reference gamut to a linear multiple of the display.
</p>
</dd>
<dt><var class="var">gamma</var></dt>
<dd><p>Fit a logarithmic transfer between the tone curves.
</p>
</dd>
<dt><var class="var">reinhard</var></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><var class="var">hable</var></dt>
<dd><p>Preserve both dark and bright details better than <var class="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><var class="var">mobius</var></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><samp class="option">param</samp></dt>
<dd><p>Tune the tone mapping algorithm.
</p>
<p>This affects the following algorithms:
</p><dl class="table">
<dt><var class="var">none</var></dt>
<dd><p>Ignored.
</p>
</dd>
<dt><var class="var">linear</var></dt>
<dd><p>Specifies the scale factor to use while stretching.
Default to 1.0.
</p>
</dd>
<dt><var class="var">gamma</var></dt>
<dd><p>Specifies the exponent of the function.
Default to 1.8.
</p>
</dd>
<dt><var class="var">clip</var></dt>
<dd><p>Specify an extra linear coefficient to multiply into the signal before clipping.
Default to 1.0.
</p>
</dd>
<dt><var class="var">reinhard</var></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><var class="var">hable</var></dt>
<dd><p>Ignored.
</p>
</dd>
<dt><var class="var">mobius</var></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><samp class="option">desat</samp></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><samp class="option">peak</samp></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>
</div>
</div>
<div class="section-level-extent" id="tpad">
<h3 class="section">30.261 tpad</h3>
<p>Temporarily pad video frames.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">start</samp></dt>
<dd><p>Specify number of delay frames before input video stream. Default is 0.
</p>
</dd>
<dt><samp class="option">stop</samp></dt>
<dd><p>Specify number of padding frames after input video stream.
Set to -1 to pad indefinitely. Default is 0.
</p>
</dd>
<dt><samp class="option">start_mode</samp></dt>
<dd><p>Set kind of frames added to beginning of stream.
Can be either <var class="var">add</var> or <var class="var">clone</var>.
With <var class="var">add</var> frames of solid-color are added.
With <var class="var">clone</var> frames are clones of first frame.
Default is <var class="var">add</var>.
</p>
</dd>
<dt><samp class="option">stop_mode</samp></dt>
<dd><p>Set kind of frames added to end of stream.
Can be either <var class="var">add</var> or <var class="var">clone</var>.
With <var class="var">add</var> frames of solid-color are added.
With <var class="var">clone</var> frames are clones of last frame.
Default is <var class="var">add</var>.
</p>
</dd>
<dt><samp class="option">start_duration, stop_duration</samp></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 class="var">start</var> and <var class="var">stop</var>. Default is 0.
</p>
</dd>
<dt><samp class="option">color</samp></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 class="var">color</var> is "black".
</p></dd>
</dl>
<a class="anchor" id="transpose"></a></div>
<div class="section-level-extent" id="transpose-1">
<h3 class="section">30.262 transpose</h3>
<p>Transpose rows with columns in the input video and optionally flip it.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">dir</samp></dt>
<dd><p>Specify the transposition direction.
</p>
<p>Can assume the following values:
</p><dl class="table">
<dt>‘<samp class="samp">0, 4, cclock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise and vertically flip (default), that is:
</p><div class="example">
<pre class="example-preformatted">L.R L.l
. . -> . .
l.r R.r
</pre></div>
</dd>
<dt>‘<samp class="samp">1, 5, clock</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise, that is:
</p><div class="example">
<pre class="example-preformatted">L.R l.L
. . -> . .
l.r r.R
</pre></div>
</dd>
<dt>‘<samp class="samp">2, 6, cclock</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise, that is:
</p><div class="example">
<pre class="example-preformatted">L.R R.r
. . -> . .
l.r L.l
</pre></div>
</dd>
<dt>‘<samp class="samp">3, 7, clock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise and vertically flip, that is:
</p><div class="example">
<pre class="example-preformatted">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 class="code">passthrough</code> option should be used instead.
</p>
<p>Numerical values are deprecated, and should be dropped in favor of
symbolic constants.
</p>
</dd>
<dt><samp class="option">passthrough</samp></dt>
<dd><p>Do not apply the transposition if the input geometry matches the one
specified by the specified value. It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Always apply transposition.
</p></dd>
<dt>‘<samp class="samp">portrait</samp>’</dt>
<dd><p>Preserve portrait geometry (when <var class="var">height</var> >= <var class="var">width</var>).
</p></dd>
<dt>‘<samp class="samp">landscape</samp>’</dt>
<dd><p>Preserve landscape geometry (when <var class="var">width</var> >= <var class="var">height</var>).
</p></dd>
</dl>
<p>Default value is <code class="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-preformatted">transpose=dir=1:passthrough=portrait
</pre></div>
<p>The command above can also be specified as:
</p><div class="example">
<pre class="example-preformatted">transpose=1:portrait
</pre></div>
</div>
<div class="section-level-extent" id="transpose_005fnpp">
<h3 class="section">30.263 transpose_npp</h3>
<p>Transpose rows with columns in the input video and optionally flip it.
For more in depth examples see the <a class="ref" href="#transpose">transpose</a> video filter, which shares mostly the same options.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">dir</samp></dt>
<dd><p>Specify the transposition direction.
</p>
<p>Can assume the following values:
</p><dl class="table">
<dt>‘<samp class="samp">cclock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise and vertically flip. (default)
</p>
</dd>
<dt>‘<samp class="samp">clock</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise.
</p>
</dd>
<dt>‘<samp class="samp">cclock</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise.
</p>
</dd>
<dt>‘<samp class="samp">clock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise and vertically flip.
</p></dd>
</dl>
</dd>
<dt><samp class="option">passthrough</samp></dt>
<dd><p>Do not apply the transposition if the input geometry matches the one
specified by the specified value. It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Always apply transposition. (default)
</p></dd>
<dt>‘<samp class="samp">portrait</samp>’</dt>
<dd><p>Preserve portrait geometry (when <var class="var">height</var> >= <var class="var">width</var>).
</p></dd>
<dt>‘<samp class="samp">landscape</samp>’</dt>
<dd><p>Preserve landscape geometry (when <var class="var">width</var> >= <var class="var">height</var>).
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="trim">
<h3 class="section">30.264 trim</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 class="table">
<dt><samp class="option">start</samp></dt>
<dd><p>Specify the time of the start of the kept section, i.e. the frame with the
timestamp <var class="var">start</var> will be the first frame in the output.
</p>
</dd>
<dt><samp class="option">end</samp></dt>
<dd><p>Specify the time of the first frame that will be dropped, i.e. the frame
immediately preceding the one with the timestamp <var class="var">end</var> will be the last
frame in the output.
</p>
</dd>
<dt><samp class="option">start_pts</samp></dt>
<dd><p>This is the same as <var class="var">start</var>, except this option sets the start timestamp
in timebase units instead of seconds.
</p>
</dd>
<dt><samp class="option">end_pts</samp></dt>
<dd><p>This is the same as <var class="var">end</var>, except this option sets the end timestamp
in timebase units instead of seconds.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>The maximum duration of the output in seconds.
</p>
</dd>
<dt><samp class="option">start_frame</samp></dt>
<dd><p>The number of the first frame that should be passed to the output.
</p>
</dd>
<dt><samp class="option">end_frame</samp></dt>
<dd><p>The number of the first frame that should be dropped.
</p></dd>
</dl>
<p><samp class="option">start</samp>, <samp class="option">end</samp>, and <samp class="option">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 class="option">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 class="itemize mark-bullet">
<li>Drop everything except the second minute of input:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -vf trim=60:120
</pre></div>
</li><li>Keep only the first second:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -vf trim=duration=1
</pre></div>
</li></ul>
</div>
<div class="section-level-extent" id="unpremultiply">
<h3 class="section">30.265 unpremultiply</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes will be processed, unprocessed planes will be copied.
By default value 0xf, all planes will be processed.
</p>
<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><samp class="option">inplace</samp></dt>
<dd><p>Do not require 2nd input for processing, instead use alpha plane from input stream.
</p></dd>
</dl>
<a class="anchor" id="unsharp"></a></div>
<div class="section-level-extent" id="unsharp-1">
<h3 class="section">30.266 unsharp</h3>
<p>Sharpen or blur the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">luma_msize_x, lx</samp></dt>
<dd><p>Set the luma matrix horizontal size. It must be an odd integer between
3 and 23. The default value is 5.
</p>
</dd>
<dt><samp class="option">luma_msize_y, ly</samp></dt>
<dd><p>Set the luma matrix vertical size. It must be an odd integer between 3
and 23. The default value is 5.
</p>
</dd>
<dt><samp class="option">luma_amount, la</samp></dt>
<dd><p>Set the luma effect strength. It must be a floating point number, reasonable
values lay between -1.5 and 1.5.
</p>
<p>Negative values will blur the input video, while positive values will
sharpen it, a value of zero will disable the effect.
</p>
<p>Default value is 1.0.
</p>
</dd>
<dt><samp class="option">chroma_msize_x, cx</samp></dt>
<dd><p>Set the chroma matrix horizontal size. It must be an odd integer
between 3 and 23. The default value is 5.
</p>
</dd>
<dt><samp class="option">chroma_msize_y, cy</samp></dt>
<dd><p>Set the chroma matrix vertical size. It must be an odd integer
between 3 and 23. The default value is 5.
</p>
</dd>
<dt><samp class="option">chroma_amount, ca</samp></dt>
<dd><p>Set the chroma effect strength. It must be a floating point number, reasonable
values lay between -1.5 and 1.5.
</p>
<p>Negative values will blur the input video, while positive values will
sharpen it, a value of zero will disable the effect.
</p>
<p>Default value is 0.0.
</p>
</dd>
<dt><samp class="option">alpha_msize_x, ax</samp></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><samp class="option">alpha_msize_y, ay</samp></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><samp class="option">alpha_amount, aa</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-146" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-146">
<h4 class="subsection">30.266.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply strong luma sharpen effect:
<div class="example">
<pre class="example-preformatted">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-preformatted">unsharp=7:7:-2:7:7:-2
</pre></div>
</li></ul>
<a class="anchor" id="untile"></a></div>
</div>
<div class="section-level-extent" id="untile-1">
<h3 class="section">30.267 untile</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 class="ref" href="#tile">tile</a>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">layout</samp></dt>
<dd><p>Set the grid size (i.e. the number of lines and columns). For the syntax of
this option, check the
<a 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>
<ul class="mini-toc">
<li><a href="#Examples-147" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-147">
<h4 class="subsection">30.267.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="uspp">
<h3 class="section">30.268 uspp</h3>
<p>Apply ultra slow/simple postprocessing filter that compresses and decompresses
the image at several (or - in the case of <samp class="option">quality</samp> level <code class="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 class="table">
<dt><samp class="option">quality</samp></dt>
<dd><p>Set quality. This option defines the number of levels for averaging. It accepts
an integer in the range 0-8. If set to <code class="code">0</code>, the filter will have no
effect. A value of <code class="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 class="code">3</code>.
</p>
</dd>
<dt><samp class="option">qp</samp></dt>
<dd><p>Force a constant quantization parameter. If not set, the filter will use the QP
from the video stream (if available).
</p>
</dd>
<dt><samp class="option">codec</samp></dt>
<dd><p>Use specified codec instead of snow.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="v360">
<h3 class="section">30.269 v360</h3>
<p>Convert 360 videos between various formats.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">input</samp></dt>
<dt><samp class="option">output</samp></dt>
<dd><p>Set format of the input/output video.
</p>
<p>Available formats:
</p>
<dl class="table">
<dt>‘<samp class="samp">e</samp>’</dt>
<dt>‘<samp class="samp">equirect</samp>’</dt>
<dd><p>Equirectangular projection.
</p>
</dd>
<dt>‘<samp class="samp">c3x2</samp>’</dt>
<dt>‘<samp class="samp">c6x1</samp>’</dt>
<dt>‘<samp class="samp">c1x6</samp>’</dt>
<dd><p>Cubemap with 3x2/6x1/1x6 layout.
</p>
<p>Format specific options:
</p>
<dl class="table">
<dt><samp class="option">in_pad</samp></dt>
<dt><samp class="option">out_pad</samp></dt>
<dd><p>Set padding proportion for the input/output cubemap. Values in decimals.
</p>
<p>Example values:
</p><dl class="table">
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>No padding.
</p></dd>
<dt>‘<samp class="samp">0.01</samp>’</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 class="b">‘<samp class="samp">0</samp>’</b>.
Maximum value is <b class="b">‘<samp class="samp">0.1</samp>’</b>.
</p>
</dd>
<dt><samp class="option">fin_pad</samp></dt>
<dt><samp class="option">fout_pad</samp></dt>
<dd><p>Set fixed padding for the input/output cubemap. Values in pixels.
</p>
<p>Default value is <b class="b">‘<samp class="samp">0</samp>’</b>. If greater than zero it overrides other padding options.
</p>
</dd>
<dt><samp class="option">in_forder</samp></dt>
<dt><samp class="option">out_forder</samp></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 class="table">
<dt>‘<samp class="samp">r</samp>’</dt>
<dd><p>right
</p></dd>
<dt>‘<samp class="samp">l</samp>’</dt>
<dd><p>left
</p></dd>
<dt>‘<samp class="samp">u</samp>’</dt>
<dd><p>up
</p></dd>
<dt>‘<samp class="samp">d</samp>’</dt>
<dd><p>down
</p></dd>
<dt>‘<samp class="samp">f</samp>’</dt>
<dd><p>forward
</p></dd>
<dt>‘<samp class="samp">b</samp>’</dt>
<dd><p>back
</p></dd>
</dl>
<p>Default value is <b class="b">‘<samp class="samp">rludfb</samp>’</b>.
</p>
</dd>
<dt><samp class="option">in_frot</samp></dt>
<dt><samp class="option">out_frot</samp></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 class="table">
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>0 degrees clockwise
</p></dd>
<dt>‘<samp class="samp">1</samp>’</dt>
<dd><p>90 degrees clockwise
</p></dd>
<dt>‘<samp class="samp">2</samp>’</dt>
<dd><p>180 degrees clockwise
</p></dd>
<dt>‘<samp class="samp">3</samp>’</dt>
<dd><p>270 degrees clockwise
</p></dd>
</dl>
<p>Default value is <b class="b">‘<samp class="samp">000000</samp>’</b>.
</p></dd>
</dl>
</dd>
<dt>‘<samp class="samp">eac</samp>’</dt>
<dd><p>Equi-Angular Cubemap.
</p>
</dd>
<dt>‘<samp class="samp">flat</samp>’</dt>
<dt>‘<samp class="samp">gnomonic</samp>’</dt>
<dt>‘<samp class="samp">rectilinear</samp>’</dt>
<dd><p>Regular video.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">dfisheye</samp>’</dt>
<dd><p>Dual fisheye.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">barrel</samp>’</dt>
<dt>‘<samp class="samp">fb</samp>’</dt>
<dt>‘<samp class="samp">barrelsplit</samp>’</dt>
<dd><p>Facebook’s 360 formats.
</p>
</dd>
<dt>‘<samp class="samp">sg</samp>’</dt>
<dd><p>Stereographic format.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">mercator</samp>’</dt>
<dd><p>Mercator format.
</p>
</dd>
<dt>‘<samp class="samp">ball</samp>’</dt>
<dd><p>Ball format, gives significant distortion toward the back.
</p>
</dd>
<dt>‘<samp class="samp">hammer</samp>’</dt>
<dd><p>Hammer-Aitoff map projection format.
</p>
</dd>
<dt>‘<samp class="samp">sinusoidal</samp>’</dt>
<dd><p>Sinusoidal map projection format.
</p>
</dd>
<dt>‘<samp class="samp">fisheye</samp>’</dt>
<dd><p>Fisheye projection.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">pannini</samp>’</dt>
<dd><p>Pannini projection.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dd><p>Set output pannini parameter.
</p>
</dd>
<dt><samp class="option">ih_fov</samp></dt>
<dd><p>Set input pannini parameter.
</p></dd>
</dl>
</dd>
<dt>‘<samp class="samp">cylindrical</samp>’</dt>
<dd><p>Cylindrical projection.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">perspective</samp>’</dt>
<dd><p>Perspective projection. <i class="i">(output only)</i>
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">v_fov</samp></dt>
<dd><p>Set perspective parameter.
</p></dd>
</dl>
</dd>
<dt>‘<samp class="samp">tetrahedron</samp>’</dt>
<dd><p>Tetrahedron projection.
</p>
</dd>
<dt>‘<samp class="samp">tsp</samp>’</dt>
<dd><p>Truncated square pyramid projection.
</p>
</dd>
<dt>‘<samp class="samp">he</samp>’</dt>
<dt>‘<samp class="samp">hequirect</samp>’</dt>
<dd><p>Half equirectangular projection.
</p>
</dd>
<dt>‘<samp class="samp">equisolid</samp>’</dt>
<dd><p>Equisolid format.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">og</samp>’</dt>
<dd><p>Orthographic format.
</p>
<p>Format specific options:
</p><dl class="table">
<dt><samp class="option">h_fov</samp></dt>
<dt><samp class="option">v_fov</samp></dt>
<dt><samp class="option">d_fov</samp></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><samp class="option">ih_fov</samp></dt>
<dt><samp class="option">iv_fov</samp></dt>
<dt><samp class="option">id_fov</samp></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>‘<samp class="samp">octahedron</samp>’</dt>
<dd><p>Octahedron projection.
</p>
</dd>
<dt>‘<samp class="samp">cylindricalea</samp>’</dt>
<dd><p>Cylindrical Equal Area projection.
</p></dd>
</dl>
</dd>
<dt><samp class="option">interp</samp></dt>
<dd><p>Set interpolation method.<br>
<i class="i">Note: more complex interpolation methods require much more memory to run.</i>
</p>
<p>Available methods:
</p>
<dl class="table">
<dt>‘<samp class="samp">near</samp>’</dt>
<dt>‘<samp class="samp">nearest</samp>’</dt>
<dd><p>Nearest neighbour.
</p></dd>
<dt>‘<samp class="samp">line</samp>’</dt>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>Bilinear interpolation.
</p></dd>
<dt>‘<samp class="samp">lagrange9</samp>’</dt>
<dd><p>Lagrange9 interpolation.
</p></dd>
<dt>‘<samp class="samp">cube</samp>’</dt>
<dt>‘<samp class="samp">cubic</samp>’</dt>
<dd><p>Bicubic interpolation.
</p></dd>
<dt>‘<samp class="samp">lanc</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dd><p>Lanczos interpolation.
</p></dd>
<dt>‘<samp class="samp">sp16</samp>’</dt>
<dt>‘<samp class="samp">spline16</samp>’</dt>
<dd><p>Spline16 interpolation.
</p></dd>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">gaussian</samp>’</dt>
<dd><p>Gaussian interpolation.
</p></dd>
<dt>‘<samp class="samp">mitchell</samp>’</dt>
<dd><p>Mitchell interpolation.
</p></dd>
</dl>
<p>Default value is <b class="b">‘<samp class="samp">line</samp>’</b>.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>Set the output video resolution.
</p>
<p>Default resolution depends on formats.
</p>
</dd>
<dt><samp class="option">in_stereo</samp></dt>
<dt><samp class="option">out_stereo</samp></dt>
<dd><p>Set the input/output stereo format.
</p>
<dl class="table">
<dt>‘<samp class="samp">2d</samp>’</dt>
<dd><p>2D mono
</p></dd>
<dt>‘<samp class="samp">sbs</samp>’</dt>
<dd><p>Side by side
</p></dd>
<dt>‘<samp class="samp">tb</samp>’</dt>
<dd><p>Top bottom
</p></dd>
</dl>
<p>Default value is <b class="b">‘<samp class="samp">2d</samp>’</b> for input and output format.
</p>
</dd>
<dt><samp class="option">yaw</samp></dt>
<dt><samp class="option">pitch</samp></dt>
<dt><samp class="option">roll</samp></dt>
<dd><p>Set rotation for the output video. Values in degrees.
</p>
</dd>
<dt><samp class="option">rorder</samp></dt>
<dd><p>Set rotation order for the output video. Choose one item for each position.
</p>
<dl class="table">
<dt>‘<samp class="samp">y, Y</samp>’</dt>
<dd><p>yaw
</p></dd>
<dt>‘<samp class="samp">p, P</samp>’</dt>
<dd><p>pitch
</p></dd>
<dt>‘<samp class="samp">r, R</samp>’</dt>
<dd><p>roll
</p></dd>
</dl>
<p>Default value is <b class="b">‘<samp class="samp">ypr</samp>’</b>.
</p>
</dd>
<dt><samp class="option">h_flip</samp></dt>
<dt><samp class="option">v_flip</samp></dt>
<dt><samp class="option">d_flip</samp></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><samp class="option">ih_flip</samp></dt>
<dt><samp class="option">iv_flip</samp></dt>
<dd><p>Set if input video is flipped horizontally/vertically. Boolean values.
</p>
</dd>
<dt><samp class="option">in_trans</samp></dt>
<dd><p>Set if input video is transposed. Boolean value, by default disabled.
</p>
</dd>
<dt><samp class="option">out_trans</samp></dt>
<dd><p>Set if output video needs to be transposed. Boolean value, by default disabled.
</p>
</dd>
<dt><samp class="option">h_offset</samp></dt>
<dt><samp class="option">v_offset</samp></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><samp class="option">alpha_mask</samp></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><samp class="option">reset_rot</samp></dt>
<dd><p>Reset rotation of output video. Boolean value, by default disabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-148" accesskey="1">Examples</a></li>
<li><a href="#Commands-150" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-148">
<h4 class="subsection">30.269.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-150">
<h4 class="subsection">30.269.2 Commands</h4>
<p>This filter supports subset of above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="vaguedenoiser">
<h3 class="section">30.270 vaguedenoiser</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 class="table">
<dt><samp class="option">threshold</samp></dt>
<dd><p>The filtering strength. The higher, the more filtered the video will be.
Hard thresholding can use a higher threshold than soft thresholding
before the video looks overfiltered. Default value is 2.
</p>
</dd>
<dt><samp class="option">method</samp></dt>
<dd><p>The filtering method the filter will use.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">hard</samp>’</dt>
<dd><p>All values under the threshold will be zeroed.
</p>
</dd>
<dt>‘<samp class="samp">soft</samp>’</dt>
<dd><p>All values under the threshold will be zeroed. All values above will be
reduced by the threshold.
</p>
</dd>
<dt>‘<samp class="samp">garrote</samp>’</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><samp class="option">nsteps</samp></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><samp class="option">percent</samp></dt>
<dd><p>Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>A list of the planes to process. By default all planes are processed.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>The threshold type the filter will use.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">universal</samp>’</dt>
<dd><p>Threshold used is same for all decompositions.
</p>
</dd>
<dt>‘<samp class="samp">bayes</samp>’</dt>
<dd><p>Threshold used depends also on each decomposition coefficients.
</p></dd>
</dl>
<p>Default is universal.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="varblur">
<h3 class="section">30.271 varblur</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 class="table">
<dt><samp class="option">min_r</samp></dt>
<dd><p>Set min allowed radius. Allowed range is from 0 to 254. Default is 0.
</p></dd>
<dt><samp class="option">max_r</samp></dt>
<dd><p>Set max allowed radius. Allowed range is from 1 to 255. Default is 8.
</p></dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process. By default, all are used.
</p></dd>
</dl>
<p>The <code class="code">varblur</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<ul class="mini-toc">
<li><a href="#Commands-151" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-151">
<h4 class="subsection">30.271.1 Commands</h4>
<p>This filter supports all the above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="vectorscope">
<h3 class="section">30.272 vectorscope</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 class="table">
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set vectorscope mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">gray</samp>’</dt>
<dt>‘<samp class="samp">tint</samp>’</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>‘<samp class="samp">color</samp>’</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 class="code">x</code> and <code class="code">y</code>. The 3rd color component is static.
</p>
</dd>
<dt>‘<samp class="samp">color2</samp>’</dt>
<dd><p>Actual color components values present in video frame are displayed on graph.
</p>
</dd>
<dt>‘<samp class="samp">color3</samp>’</dt>
<dd><p>Similar as color2 but higher frequency of same values <code class="code">x</code> and <code class="code">y</code>
on graph increases value of another color component, which is luminance by
default values of <code class="code">x</code> and <code class="code">y</code>.
</p>
</dd>
<dt>‘<samp class="samp">color4</samp>’</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>‘<samp class="samp">color5</samp>’</dt>
<dd><p>Gray values are displayed on graph. Similar to <code class="code">color</code> but with 3rd color
component picked from radial gradient.
</p></dd>
</dl>
</dd>
<dt><samp class="option">x</samp></dt>
<dd><p>Set which color component will be represented on X-axis. Default is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set which color component will be represented on Y-axis. Default is <code class="code">2</code>.
</p>
</dd>
<dt><samp class="option">intensity, i</samp></dt>
<dd><p>Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness
of color component which represents frequency of (X, Y) location in graph.
</p>
</dd>
<dt><samp class="option">envelope, e</samp></dt>
<dd><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No envelope, this is default.
</p>
</dd>
<dt>‘<samp class="samp">instant</samp>’</dt>
<dd><p>Instant envelope, even darkest single pixel will be clearly highlighted.
</p>
</dd>
<dt>‘<samp class="samp">peak</samp>’</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>‘<samp class="samp">peak+instant</samp>’</dt>
<dd><p>Peak and instant envelope combined together.
</p></dd>
</dl>
</dd>
<dt><samp class="option">graticule, g</samp></dt>
<dd><p>Set what kind of graticule to draw.
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dt>‘<samp class="samp">green</samp>’</dt>
<dt>‘<samp class="samp">color</samp>’</dt>
<dt>‘<samp class="samp">invert</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">opacity, o</samp></dt>
<dd><p>Set graticule opacity.
</p>
</dd>
<dt><samp class="option">flags, f</samp></dt>
<dd><p>Set graticule flags.
</p>
<dl class="table">
<dt>‘<samp class="samp">white</samp>’</dt>
<dd><p>Draw graticule for white point.
</p>
</dd>
<dt>‘<samp class="samp">black</samp>’</dt>
<dd><p>Draw graticule for black point.
</p>
</dd>
<dt>‘<samp class="samp">name</samp>’</dt>
<dd><p>Draw color points short names.
</p></dd>
</dl>
</dd>
<dt><samp class="option">bgopacity, b</samp></dt>
<dd><p>Set background opacity.
</p>
</dd>
<dt><samp class="option">lthreshold, l</samp></dt>
<dd><p>Set low threshold for color component not represented on X or Y axis.
Values lower than this value will be ignored. Default is 0.
Note this value is multiplied with actual max possible value one pixel component
can have. So for 8-bit input and low threshold value of 0.1 actual threshold
is 0.1 * 255 = 25.
</p>
</dd>
<dt><samp class="option">hthreshold, h</samp></dt>
<dd><p>Set high threshold for color component not represented on X or Y axis.
Values higher than this value will be ignored. Default is 1.
Note this value is multiplied with actual max possible value one pixel component
can have. So for 8-bit input and high threshold value of 0.9 actual threshold
is 0.9 * 255 = 230.
</p>
</dd>
<dt><samp class="option">colorspace, c</samp></dt>
<dd><p>Set what kind of colorspace to use when drawing graticule.
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dt>‘<samp class="samp">601</samp>’</dt>
<dt>‘<samp class="samp">709</samp>’</dt>
</dl>
<p>Default is auto.
</p>
</dd>
<dt><samp class="option">tint0, t0</samp></dt>
<dt><samp class="option">tint1, t1</samp></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>
<a class="anchor" id="vidstabdetect"></a></div>
<div class="section-level-extent" id="vidstabdetect-1">
<h3 class="section">30.273 vidstabdetect</h3>
<p>Analyze video stabilization/deshaking. Perform pass 1 of 2, see
<a class="ref" 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 class="ref" href="#vidstabtransform">vidstabtransform</a> filter.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code class="code">--enable-libvidstab</code>.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">result</samp></dt>
<dd><p>Set the path to the file used to write the transforms information.
Default value is <samp class="file">transforms.trf</samp>.
</p>
</dd>
<dt><samp class="option">shakiness</samp></dt>
<dd><p>Set how shaky the video is and how quick the camera is. It accepts an
integer in the range 1-10, a value of 1 means little shakiness, a
value of 10 means strong shakiness. Default value is 5.
</p>
</dd>
<dt><samp class="option">accuracy</samp></dt>
<dd><p>Set the accuracy of the detection process. It must be a value in the
range 1-15. A value of 1 means low accuracy, a value of 15 means high
accuracy. Default value is 15.
</p>
</dd>
<dt><samp class="option">stepsize</samp></dt>
<dd><p>Set stepsize of the search process. The region around minimum is
scanned with 1 pixel resolution. Default value is 6.
</p>
</dd>
<dt><samp class="option">mincontrast</samp></dt>
<dd><p>Set minimum contrast. Below this value a local measurement field is
discarded. Must be a floating point value in the range 0-1. Default
value is 0.3.
</p>
</dd>
<dt><samp class="option">tripod</samp></dt>
<dd><p>Set reference frame number for tripod mode.
</p>
<p>If enabled, the motion of the frames is compared to a reference frame
in the filtered stream, identified by the specified number. The idea
is to compensate all movements in a more-or-less static scene and keep
the camera view absolutely still.
</p>
<p>If set to 0, it is disabled. The frames are counted starting from 1.
</p>
</dd>
<dt><samp class="option">show</samp></dt>
<dd><p>Show fields and transforms in the resulting frames. It accepts an
integer in the range 0-2. Default value is 0, which disables any
visualization.
</p>
</dd>
<dt><samp class="option">fileformat</samp></dt>
<dd><p>Format for the transforms data file to be written.
Acceptable values are
</p>
<dl class="table">
<dt>‘<samp class="samp">ascii</samp>’</dt>
<dd><p>Human-readable plain text
</p>
</dd>
<dt>‘<samp class="samp">binary</samp>’</dt>
<dd><p>Binary format, roughly 40% smaller than <code class="code">ascii</code>. (<em class="emph">default</em>)
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-149" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-149">
<h4 class="subsection">30.273.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use default values:
<div class="example">
<pre class="example-preformatted">vidstabdetect
</pre></div>
</li><li>Analyze strongly shaky movie and put the results in file
<samp class="file">mytransforms.trf</samp>:
<div class="example">
<pre class="example-preformatted">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-preformatted">vidstabdetect=show=1
</pre></div>
</li><li>Analyze a video with medium shakiness using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
</pre></div>
</li></ul>
<a class="anchor" id="vidstabtransform"></a></div>
</div>
<div class="section-level-extent" id="vidstabtransform-1">
<h3 class="section">30.274 vidstabtransform</h3>
<p>Video stabilization/deshaking: pass 2 of 2,
see <a class="ref" 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 class="ref" href="#vidstabdetect">vidstabdetect</a>
filter this can be used to deshake videos. See also
<a class="url" href="http://public.hronopik.de/vid.stab">http://public.hronopik.de/vid.stab</a>. It is important to also use
the <a class="ref" href="#unsharp">unsharp</a> filter, see below.
</p>
<p>To enable compilation of this filter you need to configure FFmpeg with
<code class="code">--enable-libvidstab</code>.
</p>
<ul class="mini-toc">
<li><a href="#Options-39" accesskey="1">Options</a></li>
<li><a href="#Examples-150" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Options-39">
<h4 class="subsection">30.274.1 Options</h4>
<dl class="table">
<dt><samp class="option">input</samp></dt>
<dd><p>Set path to the file used to read the transforms. Default value is
<samp class="file">transforms.trf</samp>.
</p>
</dd>
<dt><samp class="option">smoothing</samp></dt>
<dd><p>Set the number of frames (value*2 + 1) used for lowpass filtering the
camera movements. Default value is 10.
</p>
<p>For example a number of 10 means that 21 frames are used (10 in the
past and 10 in the future) to smoothen the motion in the video. A
larger value leads to a smoother video, but limits the acceleration of
the camera (pan/tilt movements). 0 is a special case where a static
camera is simulated.
</p>
</dd>
<dt><samp class="option">optalgo</samp></dt>
<dd><p>Set the camera path optimization algorithm.
</p>
<p>Accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dd><p>gaussian kernel low-pass filter on camera motion (default)
</p></dd>
<dt>‘<samp class="samp">avg</samp>’</dt>
<dd><p>averaging on transformations
</p></dd>
</dl>
</dd>
<dt><samp class="option">maxshift</samp></dt>
<dd><p>Set maximal number of pixels to translate frames. Default value is -1,
meaning no limit.
</p>
</dd>
<dt><samp class="option">maxangle</samp></dt>
<dd><p>Set maximal angle in radians (degree*PI/180) to rotate frames. Default
value is -1, meaning no limit.
</p>
</dd>
<dt><samp class="option">crop</samp></dt>
<dd><p>Specify how to deal with borders that may be visible due to movement
compensation.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">keep</samp>’</dt>
<dd><p>keep image information from previous frame (default)
</p></dd>
<dt>‘<samp class="samp">black</samp>’</dt>
<dd><p>fill the border black
</p></dd>
</dl>
</dd>
<dt><samp class="option">invert</samp></dt>
<dd><p>Invert transforms if set to 1. Default value is 0.
</p>
</dd>
<dt><samp class="option">relative</samp></dt>
<dd><p>Consider transforms as relative to previous frame if set to 1,
absolute if set to 0. Default value is 0.
</p>
</dd>
<dt><samp class="option">zoom</samp></dt>
<dd><p>Set percentage to zoom. A positive value will result in a zoom-in
effect, a negative value in a zoom-out effect. Default value is 0 (no
zoom).
</p>
</dd>
<dt><samp class="option">optzoom</samp></dt>
<dd><p>Set optimal zooming to avoid borders.
</p>
<p>Accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">0</samp>’</dt>
<dd><p>disabled
</p></dd>
<dt>‘<samp class="samp">1</samp>’</dt>
<dd><p>optimal static zoom value is determined (only very strong movements
will lead to visible borders) (default)
</p></dd>
<dt>‘<samp class="samp">2</samp>’</dt>
<dd><p>optimal adaptive zoom value is determined (no borders will be
visible), see <samp class="option">zoomspeed</samp>
</p></dd>
</dl>
<p>Note that the value given at zoom is added to the one calculated here.
</p>
</dd>
<dt><samp class="option">zoomspeed</samp></dt>
<dd><p>Set percent to zoom maximally each frame (enabled when
<samp class="option">optzoom</samp> is set to 2). Range is from 0 to 5, default value is
0.25.
</p>
</dd>
<dt><samp class="option">interpol</samp></dt>
<dd><p>Specify type of interpolation.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">no</samp>’</dt>
<dd><p>no interpolation
</p></dd>
<dt>‘<samp class="samp">linear</samp>’</dt>
<dd><p>linear only horizontal
</p></dd>
<dt>‘<samp class="samp">bilinear</samp>’</dt>
<dd><p>linear in both directions (default)
</p></dd>
<dt>‘<samp class="samp">bicubic</samp>’</dt>
<dd><p>cubic in both directions (slow)
</p></dd>
</dl>
</dd>
<dt><samp class="option">tripod</samp></dt>
<dd><p>Enable virtual tripod mode if set to 1, which is equivalent to
<code class="code">relative=0:smoothing=0</code>. Default value is 0.
</p>
<p>Use also <code class="code">tripod</code> option of <a class="ref" href="#vidstabdetect">vidstabdetect</a>.
</p>
</dd>
<dt><samp class="option">debug</samp></dt>
<dd><p>Increase log verbosity if set to 1. Also the detected global motions
are written to the temporary file <samp class="file">global_motions.trf</samp>. Default
value is 0.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-150">
<h4 class="subsection">30.274.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Use <code class="command">ffmpeg</code> for a typical stabilization with default values:
<div class="example">
<pre class="example-preformatted">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 class="ref" 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-preformatted">vidstabtransform=zoom=5:input="mytransforms.trf"
</pre></div>
</li><li>Smoothen the video even more:
<div class="example">
<pre class="example-preformatted">vidstabtransform=smoothing=30
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="vflip">
<h3 class="section">30.275 vflip</h3>
<p>Flip the input video vertically.
</p>
<p>For example, to vertically flip a video with <code class="command">ffmpeg</code>:
</p><div class="example">
<pre class="example-preformatted">ffmpeg -i in.avi -vf "vflip" out.avi
</pre></div>
</div>
<div class="section-level-extent" id="vfrdet">
<h3 class="section">30.276 vfrdet</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>
</div>
<div class="section-level-extent" id="vibrance">
<h3 class="section">30.277 vibrance</h3>
<p>Boost or alter saturation.
</p>
<p>The filter accepts the following options:
</p><dl class="table">
<dt><samp class="option">intensity</samp></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><samp class="option">rbal</samp></dt>
<dd><p>Set the red balance. Default is 1. Allowed range is from -10 to 10.
</p>
</dd>
<dt><samp class="option">gbal</samp></dt>
<dd><p>Set the green balance. Default is 1. Allowed range is from -10 to 10.
</p>
</dd>
<dt><samp class="option">bbal</samp></dt>
<dd><p>Set the blue balance. Default is 1. Allowed range is from -10 to 10.
</p>
</dd>
<dt><samp class="option">rlum</samp></dt>
<dd><p>Set the red luma coefficient.
</p>
</dd>
<dt><samp class="option">glum</samp></dt>
<dd><p>Set the green luma coefficient.
</p>
</dd>
<dt><samp class="option">blum</samp></dt>
<dd><p>Set the blue luma coefficient.
</p>
</dd>
<dt><samp class="option">alternate</samp></dt>
<dd><p>If <code class="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>
<ul class="mini-toc">
<li><a href="#Commands-152" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-152">
<h4 class="subsection">30.277.1 Commands</h4>
<p>This filter supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="vif">
<h3 class="section">30.278 vif</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>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
<p>In the below example the input file <samp class="file">main.mpg</samp> being processed is compared
with the reference file <samp class="file">ref.mpg</samp>.
</p>
<div class="example">
<pre class="example-preformatted">ffmpeg -i main.mpg -i ref.mpg -lavfi vif -f null -
</pre></div>
<a class="anchor" id="vignette"></a></div>
<div class="section-level-extent" id="vignette-1">
<h3 class="section">30.279 vignette</h3>
<p>Make or reverse a natural vignetting effect.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">angle, a</samp></dt>
<dd><p>Set lens angle expression as a number of radians.
</p>
<p>The value is clipped in the <code class="code">[0,PI/2]</code> range.
</p>
<p>Default value: <code class="code">"PI/5"</code>
</p>
</dd>
<dt><samp class="option">x0</samp></dt>
<dt><samp class="option">y0</samp></dt>
<dd><p>Set center coordinates expressions. Respectively <code class="code">"w/2"</code> and <code class="code">"h/2"</code>
by default.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set forward/backward mode.
</p>
<p>Available modes are:
</p><dl class="table">
<dt>‘<samp class="samp">forward</samp>’</dt>
<dd><p>The larger the distance from the central point, the darker the image becomes.
</p>
</dd>
<dt>‘<samp class="samp">backward</samp>’</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 class="option">angle</samp> and other settings (yet). It can
also be used to create a burning effect.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">forward</samp>’.
</p>
</dd>
<dt><samp class="option">eval</samp></dt>
<dd><p>Set evaluation mode for the expressions (<samp class="option">angle</samp>, <samp class="option">x0</samp>, <samp class="option">y0</samp>).
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">init</samp>’</dt>
<dd><p>Evaluate expressions only once during the filter initialization.
</p>
</dd>
<dt>‘<samp class="samp">frame</samp>’</dt>
<dd><p>Evaluate expressions for each incoming frame. This is way slower than the
‘<samp class="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 class="samp">init</samp>’.
</p>
</dd>
<dt><samp class="option">dither</samp></dt>
<dd><p>Set dithering to reduce the circular banding effects. Default is <code class="code">1</code>
(enabled).
</p>
</dd>
<dt><samp class="option">aspect</samp></dt>
<dd><p>Set vignette aspect. This setting allows one to adjust the shape of the vignette.
Setting this value to the SAR of the input will make a rectangular vignetting
following the dimensions of the video.
</p>
<p>Default is <code class="code">1/1</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Expressions" accesskey="1">Expressions</a></li>
<li><a href="#Examples-151" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Expressions">
<h4 class="subsection">30.279.1 Expressions</h4>
<p>The <samp class="option">alpha</samp>, <samp class="option">x0</samp> and <samp class="option">y0</samp> expressions can contain the
following parameters.
</p>
<dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>input width and height
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>the number of input frame, starting from 0
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in
<var class="var">TB</var> units, NAN if undefined
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>frame rate of the input video, NAN if the input frame rate is unknown
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>the PTS (Presentation TimeStamp) of the filtered video frame,
expressed in seconds, NAN if undefined
</p>
</dd>
<dt><samp class="option">tb</samp></dt>
<dd><p>time base of the input video
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-151">
<h4 class="subsection">30.279.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply simple strong vignetting effect:
<div class="example">
<pre class="example-preformatted">vignette=PI/4
</pre></div>
</li><li>Make a flickering vignetting:
<div class="example">
<pre class="example-preformatted">vignette='PI/4+random(1)*PI/50':eval=frame
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="vmafmotion">
<h3 class="section">30.280 vmafmotion</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 class="table">
<dt><samp class="option">stats_file</samp></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-preformatted">ffmpeg -i ref.mpg -vf vmafmotion -f null -
</pre></div>
<a class="anchor" id="vstack"></a></div>
<div class="section-level-extent" id="vstack-1">
<h3 class="section">30.281 vstack</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 class="ref" href="#overlay">overlay</a> and <a class="ref" href="#pad">pad</a> filter
to create same output.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set number of input streams. Default is 2.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="w3fdif">
<h3 class="section">30.282 w3fdif</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 class="ref" href="#setfield">setfield</a> filter before <code class="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 class="table">
<dt><samp class="option">filter</samp></dt>
<dd><p>Set the interlacing filter coefficients. Accepts one of the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">simple</samp>’</dt>
<dd><p>Simple filter coefficient set.
</p></dd>
<dt>‘<samp class="samp">complex</samp>’</dt>
<dd><p>More-complex filter coefficient set.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">complex</samp>’.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code class="code">field</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following values:
</p>
<dl class="table">
<dt>‘<samp class="samp">all</samp>’</dt>
<dd><p>Deinterlace all frames,
</p></dd>
<dt>‘<samp class="samp">interlaced</samp>’</dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">all</samp>’.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-153" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-153">
<h4 class="subsection">30.282.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="waveform">
<h3 class="section">30.283 waveform</h3>
<p>Video waveform monitor.
</p>
<p>The waveform monitor plots color component intensity. By default luma
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 class="table">
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Can be either <code class="code">row</code>, or <code class="code">column</code>. Default is <code class="code">column</code>.
In row mode, the graph on the left side represents color component value 0 and
the right side represents value = 255. In column mode, the top side represents
color component value = 0 and bottom side represents value = 255.
</p>
</dd>
<dt><samp class="option">intensity, i</samp></dt>
<dd><p>Set intensity. Smaller values are useful to find out how many values of the same
luminance are distributed across input rows/columns.
Default value is <code class="code">0.04</code>. Allowed range is [0, 1].
</p>
</dd>
<dt><samp class="option">mirror, r</samp></dt>
<dd><p>Set mirroring mode. <code class="code">0</code> means unmirrored, <code class="code">1</code> means mirrored.
In mirrored mode, higher values will be represented on the left
side for <code class="code">row</code> mode and at the top for <code class="code">column</code> mode. Default is
<code class="code">1</code> (mirrored).
</p>
</dd>
<dt><samp class="option">display, d</samp></dt>
<dd><p>Set display mode.
It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">overlay</samp>’</dt>
<dd><p>Presents information identical to that in the <code class="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>‘<samp class="samp">stack</samp>’</dt>
<dd><p>Display separate graph for the color components side by side in
<code class="code">row</code> mode or one below the other in <code class="code">column</code> mode.
</p>
</dd>
<dt>‘<samp class="samp">parade</samp>’</dt>
<dd><p>Display separate graph for the color components side by side in
<code class="code">column</code> mode or one below the other in <code class="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 class="code">stack</code>.
</p>
</dd>
<dt><samp class="option">components, c</samp></dt>
<dd><p>Set which color components to display. Default is 1, which means only luma
or red color component if input is in RGB colorspace. If is set for example to
7 it will display all 3 (if) available color components.
</p>
</dd>
<dt><samp class="option">envelope, e</samp></dt>
<dd><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No envelope, this is default.
</p>
</dd>
<dt>‘<samp class="samp">instant</samp>’</dt>
<dd><p>Instant envelope, minimum and maximum values presented in graph will be easily
visible even with small <code class="code">step</code> value.
</p>
</dd>
<dt>‘<samp class="samp">peak</samp>’</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>‘<samp class="samp">peak+instant</samp>’</dt>
<dd><p>Peak and instant envelope combined together.
</p></dd>
</dl>
</dd>
<dt><samp class="option">filter, f</samp></dt>
<dd><dl class="table">
<dt>‘<samp class="samp">lowpass</samp>’</dt>
<dd><p>No filtering, this is default.
</p>
</dd>
<dt>‘<samp class="samp">flat</samp>’</dt>
<dd><p>Luma and chroma combined together.
</p>
</dd>
<dt>‘<samp class="samp">aflat</samp>’</dt>
<dd><p>Similar as above, but shows difference between blue and red chroma.
</p>
</dd>
<dt>‘<samp class="samp">xflat</samp>’</dt>
<dd><p>Similar as above, but use different colors.
</p>
</dd>
<dt>‘<samp class="samp">yflat</samp>’</dt>
<dd><p>Similar as above, but again with different colors.
</p>
</dd>
<dt>‘<samp class="samp">chroma</samp>’</dt>
<dd><p>Displays only chroma.
</p>
</dd>
<dt>‘<samp class="samp">color</samp>’</dt>
<dd><p>Displays actual color value on waveform.
</p>
</dd>
<dt>‘<samp class="samp">acolor</samp>’</dt>
<dd><p>Similar as above, but with luma showing frequency of chroma values.
</p></dd>
</dl>
</dd>
<dt><samp class="option">graticule, g</samp></dt>
<dd><p>Set which graticule to display.
</p>
<dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Do not display graticule.
</p>
</dd>
<dt>‘<samp class="samp">green</samp>’</dt>
<dd><p>Display green graticule showing legal broadcast ranges.
</p>
</dd>
<dt>‘<samp class="samp">orange</samp>’</dt>
<dd><p>Display orange graticule showing legal broadcast ranges.
</p>
</dd>
<dt>‘<samp class="samp">invert</samp>’</dt>
<dd><p>Display invert graticule showing legal broadcast ranges.
</p></dd>
</dl>
</dd>
<dt><samp class="option">opacity, o</samp></dt>
<dd><p>Set graticule opacity.
</p>
</dd>
<dt><samp class="option">flags, fl</samp></dt>
<dd><p>Set graticule flags.
</p>
<dl class="table">
<dt>‘<samp class="samp">numbers</samp>’</dt>
<dd><p>Draw numbers above lines. By default enabled.
</p>
</dd>
<dt>‘<samp class="samp">dots</samp>’</dt>
<dd><p>Draw dots instead of lines.
</p></dd>
</dl>
</dd>
<dt><samp class="option">scale, s</samp></dt>
<dd><p>Set scale used for displaying graticule.
</p>
<dl class="table">
<dt>‘<samp class="samp">digital</samp>’</dt>
<dt>‘<samp class="samp">millivolts</samp>’</dt>
<dt>‘<samp class="samp">ire</samp>’</dt>
</dl>
<p>Default is digital.
</p>
</dd>
<dt><samp class="option">bgopacity, b</samp></dt>
<dd><p>Set background opacity.
</p>
</dd>
<dt><samp class="option">tint0, t0</samp></dt>
<dt><samp class="option">tint1, t1</samp></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><samp class="option">fitmode, fm</samp></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 class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Set sample aspect ration to 1/1.
</p></dd>
<dt>‘<samp class="samp">size</samp>’</dt>
<dd><p>Set sample aspect ratio to match input size of video
</p></dd>
</dl>
<p>Default is ‘<samp class="samp">none</samp>’.
</p>
</dd>
<dt><samp class="option">input</samp></dt>
<dd><p>Set input formats for filter to pick from.
Can be ‘<samp class="samp">all</samp>’, for selecting from all available formats,
or ‘<samp class="samp">first</samp>’, for selecting first available format.
Default is ‘<samp class="samp">first</samp>’.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="weave_002c-doubleweave">
<h3 class="section">30.284 weave, doubleweave</h3>
<p>The <code class="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 class="code">doubleweave</code> works same as <code class="code">weave</code> but without
halving frame rate and frame count.
</p>
<p>It accepts the following option:
</p>
<dl class="table">
<dt><samp class="option">first_field</samp></dt>
<dd><p>Set first field. Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">top, t</samp>’</dt>
<dd><p>Set the frame as top-field-first.
</p>
</dd>
<dt>‘<samp class="samp">bottom, b</samp>’</dt>
<dd><p>Set the frame as bottom-field-first.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-152" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-152">
<h4 class="subsection">30.284.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Interlace video using <a class="ref" href="#select">select</a> and <a class="ref" href="#separatefields">separatefields</a> filter:
<div class="example">
<pre class="example-preformatted">separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="xbr">
<h3 class="section">30.285 xbr</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 class="url" 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 class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>Set the scaling dimension: <code class="code">2</code> for <code class="code">2xBR</code>, <code class="code">3</code> for
<code class="code">3xBR</code> and <code class="code">4</code> for <code class="code">4xBR</code>.
Default is <code class="code">3</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="xcorrelate">
<h3 class="section">30.286 xcorrelate</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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to process.
</p>
</dd>
<dt><samp class="option">secondary</samp></dt>
<dd><p>Set which secondary video frames will be processed from second input video stream,
can be <var class="var">first</var> or <var class="var">all</var>. Default is <var class="var">all</var>.
</p></dd>
</dl>
<p>The <code class="code">xcorrelate</code> filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p>
</div>
<div class="section-level-extent" id="xfade">
<h3 class="section">30.287 xfade</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 class="table">
<dt><samp class="option">transition</samp></dt>
<dd><p>Set one of available transition effects:
</p>
<dl class="table">
<dt>‘<samp class="samp">custom</samp>’</dt>
<dt>‘<samp class="samp">fade</samp>’</dt>
<dt>‘<samp class="samp">wipeleft</samp>’</dt>
<dt>‘<samp class="samp">wiperight</samp>’</dt>
<dt>‘<samp class="samp">wipeup</samp>’</dt>
<dt>‘<samp class="samp">wipedown</samp>’</dt>
<dt>‘<samp class="samp">slideleft</samp>’</dt>
<dt>‘<samp class="samp">slideright</samp>’</dt>
<dt>‘<samp class="samp">slideup</samp>’</dt>
<dt>‘<samp class="samp">slidedown</samp>’</dt>
<dt>‘<samp class="samp">circlecrop</samp>’</dt>
<dt>‘<samp class="samp">rectcrop</samp>’</dt>
<dt>‘<samp class="samp">distance</samp>’</dt>
<dt>‘<samp class="samp">fadeblack</samp>’</dt>
<dt>‘<samp class="samp">fadewhite</samp>’</dt>
<dt>‘<samp class="samp">radial</samp>’</dt>
<dt>‘<samp class="samp">smoothleft</samp>’</dt>
<dt>‘<samp class="samp">smoothright</samp>’</dt>
<dt>‘<samp class="samp">smoothup</samp>’</dt>
<dt>‘<samp class="samp">smoothdown</samp>’</dt>
<dt>‘<samp class="samp">circleopen</samp>’</dt>
<dt>‘<samp class="samp">circleclose</samp>’</dt>
<dt>‘<samp class="samp">vertopen</samp>’</dt>
<dt>‘<samp class="samp">vertclose</samp>’</dt>
<dt>‘<samp class="samp">horzopen</samp>’</dt>
<dt>‘<samp class="samp">horzclose</samp>’</dt>
<dt>‘<samp class="samp">dissolve</samp>’</dt>
<dt>‘<samp class="samp">pixelize</samp>’</dt>
<dt>‘<samp class="samp">diagtl</samp>’</dt>
<dt>‘<samp class="samp">diagtr</samp>’</dt>
<dt>‘<samp class="samp">diagbl</samp>’</dt>
<dt>‘<samp class="samp">diagbr</samp>’</dt>
<dt>‘<samp class="samp">hlslice</samp>’</dt>
<dt>‘<samp class="samp">hrslice</samp>’</dt>
<dt>‘<samp class="samp">vuslice</samp>’</dt>
<dt>‘<samp class="samp">vdslice</samp>’</dt>
<dt>‘<samp class="samp">hblur</samp>’</dt>
<dt>‘<samp class="samp">fadegrays</samp>’</dt>
<dt>‘<samp class="samp">wipetl</samp>’</dt>
<dt>‘<samp class="samp">wipetr</samp>’</dt>
<dt>‘<samp class="samp">wipebl</samp>’</dt>
<dt>‘<samp class="samp">wipebr</samp>’</dt>
<dt>‘<samp class="samp">squeezeh</samp>’</dt>
<dt>‘<samp class="samp">squeezev</samp>’</dt>
<dt>‘<samp class="samp">zoomin</samp>’</dt>
<dt>‘<samp class="samp">fadefast</samp>’</dt>
<dt>‘<samp class="samp">fadeslow</samp>’</dt>
<dt>‘<samp class="samp">hlwind</samp>’</dt>
<dt>‘<samp class="samp">hrwind</samp>’</dt>
<dt>‘<samp class="samp">vuwind</samp>’</dt>
<dt>‘<samp class="samp">vdwind</samp>’</dt>
<dt>‘<samp class="samp">coverleft</samp>’</dt>
<dt>‘<samp class="samp">coverright</samp>’</dt>
<dt>‘<samp class="samp">coverup</samp>’</dt>
<dt>‘<samp class="samp">coverdown</samp>’</dt>
<dt>‘<samp class="samp">revealleft</samp>’</dt>
<dt>‘<samp class="samp">revealright</samp>’</dt>
<dt>‘<samp class="samp">revealup</samp>’</dt>
<dt>‘<samp class="samp">revealdown</samp>’</dt>
</dl>
<p>Default transition effect is fade.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>Set cross fade duration in seconds.
Range is 0 to 60 seconds.
Default duration is 1 second.
</p>
</dd>
<dt><samp class="option">offset</samp></dt>
<dd><p>Set cross fade start relative to first input stream in seconds.
Default offset is 0.
</p>
</dd>
<dt><samp class="option">expr</samp></dt>
<dd><p>Set expression for custom transition effect.
</p>
<p>The expressions can use the following variables and functions:
</p>
<dl class="table">
<dt><samp class="option">X</samp></dt>
<dt><samp class="option">Y</samp></dt>
<dd><p>The coordinates of the current sample.
</p>
</dd>
<dt><samp class="option">W</samp></dt>
<dt><samp class="option">H</samp></dt>
<dd><p>The width and height of the image.
</p>
</dd>
<dt><samp class="option">P</samp></dt>
<dd><p>Progress of transition effect.
</p>
</dd>
<dt><samp class="option">PLANE</samp></dt>
<dd><p>Currently processed plane.
</p>
</dd>
<dt><samp class="option">A</samp></dt>
<dd><p>Return value of first input at current location and plane.
</p>
</dd>
<dt><samp class="option">B</samp></dt>
<dd><p>Return value of second input at current location and plane.
</p>
</dd>
<dt><samp class="option">a0(x, y)</samp></dt>
<dt><samp class="option">a1(x, y)</samp></dt>
<dt><samp class="option">a2(x, y)</samp></dt>
<dt><samp class="option">a3(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the
first/second/third/fourth component of first input.
</p>
</dd>
<dt><samp class="option">b0(x, y)</samp></dt>
<dt><samp class="option">b1(x, y)</samp></dt>
<dt><samp class="option">b2(x, y)</samp></dt>
<dt><samp class="option">b3(x, y)</samp></dt>
<dd><p>Return the value of the pixel at location (<var class="var">x</var>,<var class="var">y</var>) of the
first/second/third/fourth component of second input.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-153" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-153">
<h4 class="subsection">30.287.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="xmedian">
<h3 class="section">30.288 xmedian</h3>
<p>Pick median pixels from several input videos.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></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><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">15</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">percentile</samp></dt>
<dd><p>Set median percentile. Default value is <code class="code">0.5</code>.
Default value of <code class="code">0.5</code> will pick always median values, while <code class="code">0</code> will pick
minimum values, and <code class="code">1</code> maximum values.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-154" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-154">
<h4 class="subsection">30.288.1 Commands</h4>
<p>This filter supports all above options as <a class="ref" href="#commands">commands</a>, excluding option <code class="code">inputs</code>.
</p>
<a class="anchor" id="xstack"></a></div>
</div>
<div class="section-level-extent" id="xstack-1">
<h3 class="section">30.289 xstack</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 class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>Set number of input streams. Default is 2.
</p>
</dd>
<dt><samp class="option">layout</samp></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 class="code">0_0|w0_0</code> (equivalent to
<code class="code">grid=2x1</code>) is set. In all other cases, a layout or a grid must be set by
the user. Either <code class="code">grid</code> or <code class="code">layout</code> can be specified at a time.
Specifying both will result in an error.
</p>
</dd>
<dt><samp class="option">grid</samp></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 class="code">COLUMNSxROWS</code>. There must be <code class="code">ROWS * COLUMNS</code>
input streams and they will be arranged as a grid with <code class="code">ROWS</code> rows and
<code class="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 class="code">grid</code> is set, then <code class="code">inputs</code> option is ignored and is implicitly
set to <code class="code">ROWS * COLUMNS</code>.
</p>
<p>For 2 inputs, a default grid of <code class="code">2x1</code> (equivalent to
<code class="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 class="code">grid</code> or <code class="code">layout</code> can be specified at a time.
Specifying both will result in an error.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>If set to 1, force the output to terminate when the shortest input
terminates. Default value is 0.
</p>
</dd>
<dt><samp class="option">fill</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-154" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-154">
<h4 class="subsection">30.289.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Display 4 inputs into 2x2 grid.
<p>Layout:
</p><div class="example">
<pre class="example-preformatted">input1(0, 0) | input3(w0, 0)
input2(0, h0) | input4(w0, h0)
</pre></div>
<div class="example">
<pre class="example-preformatted">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-preformatted">input1(0, 0)
input2(0, h0)
input3(0, h0+h1)
input4(0, h0+h1+h2)
</pre></div>
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
<a class="anchor" id="yadif"></a></div>
</div>
<div class="section-level-extent" id="yadif-1">
<h3 class="section">30.290 yadif</h3>
<p>Deinterlace the input video ("yadif" means "yet another deinterlacing
filter").
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
<dt><samp class="option">2, send_frame_nospatial</samp></dt>
<dd><p>Like <code class="code">send_frame</code>, but it skips the spatial interlacing check.
</p></dd>
<dt><samp class="option">3, send_field_nospatial</samp></dt>
<dd><p>Like <code class="code">send_field</code>, but it skips the spatial interlacing check.
</p></dd>
</dl>
<p>The default value is <code class="code">send_frame</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="yadif_005fcuda">
<h3 class="section">30.291 yadif_cuda</h3>
<p>Deinterlace the input video using the <a class="ref" 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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
<dt><samp class="option">2, send_frame_nospatial</samp></dt>
<dd><p>Like <code class="code">send_frame</code>, but it skips the spatial interlacing check.
</p></dd>
<dt><samp class="option">3, send_field_nospatial</samp></dt>
<dd><p>Like <code class="code">send_field</code>, but it skips the spatial interlacing check.
</p></dd>
</dl>
<p>The default value is <code class="code">send_frame</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="yaepblur">
<h3 class="section">30.292 yaepblur</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 class="table">
<dt><samp class="option">radius, r</samp></dt>
<dd><p>Set the window radius. Default value is 3.
</p>
</dd>
<dt><samp class="option">planes, p</samp></dt>
<dd><p>Set which planes to filter. Default is only the first plane.
</p>
</dd>
<dt><samp class="option">sigma, s</samp></dt>
<dd><p>Set blur strength. Default value is 128.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-155" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-155">
<h4 class="subsection">30.292.1 Commands</h4>
<p>This filter supports same <a class="ref" href="#commands">commands</a> as options.
</p>
</div>
</div>
<div class="section-level-extent" id="zoompan">
<h3 class="section">30.293 zoompan</h3>
<p>Apply Zoom & Pan effect.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">zoom, z</samp></dt>
<dd><p>Set the zoom expression. Range is 1-10. Default is 1.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Set the x and y expression. Default is 0.
</p>
</dd>
<dt><samp class="option">d</samp></dt>
<dd><p>Set the duration expression in number of frames.
This sets for how many number of frames effect will last for
single input image. Default is 90.
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>Set the output image size, default is ’hd720’.
</p>
</dd>
<dt><samp class="option">fps</samp></dt>
<dd><p>Set the output frame rate, default is ’25’.
</p></dd>
</dl>
<p>Each expression can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">in_w, iw</samp></dt>
<dd><p>Input width.
</p>
</dd>
<dt><samp class="option">in_h, ih</samp></dt>
<dd><p>Input height.
</p>
</dd>
<dt><samp class="option">out_w, ow</samp></dt>
<dd><p>Output width.
</p>
</dd>
<dt><samp class="option">out_h, oh</samp></dt>
<dd><p>Output height.
</p>
</dd>
<dt><samp class="option">in</samp></dt>
<dd><p>Input frame count.
</p>
</dd>
<dt><samp class="option">on</samp></dt>
<dd><p>Output frame count.
</p>
</dd>
<dt><samp class="option">in_time, it</samp></dt>
<dd><p>The input timestamp expressed in seconds. It’s NAN if the input timestamp is unknown.
</p>
</dd>
<dt><samp class="option">out_time, time, ot</samp></dt>
<dd><p>The output timestamp expressed in seconds.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression
for current input frame.
</p>
</dd>
<dt><samp class="option">px</samp></dt>
<dt><samp class="option">py</samp></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><samp class="option">zoom</samp></dt>
<dd><p>Last calculated zoom from ’z’ expression for current input frame.
</p>
</dd>
<dt><samp class="option">pzoom</samp></dt>
<dd><p>Last calculated zoom of last output frame of previous input frame.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>Number of output frames for current input frame. Calculated from ’d’ expression
for each input frame.
</p>
</dd>
<dt><samp class="option">pduration</samp></dt>
<dd><p>number of output frames created for previous input frame
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>Rational number: input width / input height
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>sample aspect ratio
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>display aspect ratio
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-155" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-155">
<h4 class="subsection">30.293.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">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-preformatted">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>
<a class="anchor" id="zscale"></a></div>
</div>
<div class="section-level-extent" id="zscale-1">
<h3 class="section">30.294 zscale</h3>
<p>Scale (resize) the input video, using the z.lib library:
<a class="url" 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 class="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>
<ul class="mini-toc">
<li><a href="#Options-40" accesskey="1">Options</a></li>
<li><a href="#Commands-156" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Options-40">
<h4 class="subsection">30.294.1 Options</h4>
<p>The filter accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set the output video dimension expression. Default value is the input
dimension.
</p>
<p>If the <var class="var">width</var> or <var class="var">w</var> value is 0, the input width is used for
the output. If the <var class="var">height</var> or <var class="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><samp class="option">size, s</samp></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><samp class="option">dither, d</samp></dt>
<dd><p>Set the dither type.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">none</var></dt>
<dt><var class="var">ordered</var></dt>
<dt><var class="var">random</var></dt>
<dt><var class="var">error_diffusion</var></dt>
</dl>
<p>Default is none.
</p>
</dd>
<dt><samp class="option">filter, f</samp></dt>
<dd><p>Set the resize filter type.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">point</var></dt>
<dt><var class="var">bilinear</var></dt>
<dt><var class="var">bicubic</var></dt>
<dt><var class="var">spline16</var></dt>
<dt><var class="var">spline36</var></dt>
<dt><var class="var">lanczos</var></dt>
</dl>
<p>Default is bilinear.
</p>
</dd>
<dt><samp class="option">range, r</samp></dt>
<dd><p>Set the color range.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">limited</var></dt>
<dt><var class="var">full</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">primaries, p</samp></dt>
<dd><p>Set the color primaries.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">170m</var></dt>
<dt><var class="var">240m</var></dt>
<dt><var class="var">2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">transfer, t</samp></dt>
<dd><p>Set the transfer characteristics.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">601</var></dt>
<dt><var class="var">linear</var></dt>
<dt><var class="var">2020_10</var></dt>
<dt><var class="var">2020_12</var></dt>
<dt><var class="var">smpte2084</var></dt>
<dt><var class="var">iec61966-2-1</var></dt>
<dt><var class="var">arib-std-b67</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">matrix, m</samp></dt>
<dd><p>Set the colorspace matrix.
</p>
<p>Possible value are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">470bg</var></dt>
<dt><var class="var">170m</var></dt>
<dt><var class="var">2020_ncl</var></dt>
<dt><var class="var">2020_cl</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">rangein, rin</samp></dt>
<dd><p>Set the input color range.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">limited</var></dt>
<dt><var class="var">full</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">primariesin, pin</samp></dt>
<dd><p>Set the input color primaries.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">170m</var></dt>
<dt><var class="var">240m</var></dt>
<dt><var class="var">2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">transferin, tin</samp></dt>
<dd><p>Set the input transfer characteristics.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">601</var></dt>
<dt><var class="var">linear</var></dt>
<dt><var class="var">2020_10</var></dt>
<dt><var class="var">2020_12</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">matrixin, min</samp></dt>
<dd><p>Set the input colorspace matrix.
</p>
<p>Possible value are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">709</var></dt>
<dt><var class="var">unspecified</var></dt>
<dt><var class="var">470bg</var></dt>
<dt><var class="var">170m</var></dt>
<dt><var class="var">2020_ncl</var></dt>
<dt><var class="var">2020_cl</var></dt>
</dl>
</dd>
<dt><samp class="option">chromal, c</samp></dt>
<dd><p>Set the output chroma location.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">left</var></dt>
<dt><var class="var">center</var></dt>
<dt><var class="var">topleft</var></dt>
<dt><var class="var">top</var></dt>
<dt><var class="var">bottomleft</var></dt>
<dt><var class="var">bottom</var></dt>
</dl>
</dd>
<dt><samp class="option">chromalin, cin</samp></dt>
<dd><p>Set the input chroma location.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">input</var></dt>
<dt><var class="var">left</var></dt>
<dt><var class="var">center</var></dt>
<dt><var class="var">topleft</var></dt>
<dt><var class="var">top</var></dt>
<dt><var class="var">bottomleft</var></dt>
<dt><var class="var">bottom</var></dt>
</dl>
</dd>
<dt><samp class="option">npl</samp></dt>
<dd><p>Set the nominal peak luminance.
</p>
</dd>
<dt><samp class="option">param_a</samp></dt>
<dd><p>Parameter A for scaling filters. Parameter "b" for bicubic, and the number of
filter taps for lanczos.
</p>
</dd>
<dt><samp class="option">param_b</samp></dt>
<dd><p>Parameter B for scaling filters. Parameter "c" for bicubic.
</p></dd>
</dl>
<p>The values of the <samp class="option">w</samp> and <samp class="option">h</samp> options are expressions
containing the following constants:
</p>
<dl class="table">
<dt><var class="var">in_w</var></dt>
<dt><var class="var">in_h</var></dt>
<dd><p>The input width and height
</p>
</dd>
<dt><var class="var">iw</var></dt>
<dt><var class="var">ih</var></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><var class="var">out_w</var></dt>
<dt><var class="var">out_h</var></dt>
<dd><p>The output (scaled) width and height
</p>
</dd>
<dt><var class="var">ow</var></dt>
<dt><var class="var">oh</var></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>
</p>
</dd>
<dt><var class="var">a</var></dt>
<dd><p>The same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><var class="var">sar</var></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><var class="var">dar</var></dt>
<dd><p>The input display aspect ratio. Calculated from <code class="code">(iw / ih) * sar</code>.
</p>
</dd>
<dt><var class="var">hsub</var></dt>
<dt><var class="var">vsub</var></dt>
<dd><p>horizontal and vertical input chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p>
</dd>
<dt><var class="var">ohsub</var></dt>
<dt><var class="var">ovsub</var></dt>
<dd><p>horizontal and vertical output chroma subsample values. For example for the
pixel format "yuv422p" <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Commands-156">
<h4 class="subsection">30.294.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Set the output video dimension expression.
The command accepts the same syntax of the corresponding option.
</p>
<p>If the specified expression is not valid, it is kept at its current
value.
</p></dd>
</dl>
</div>
</div>
</div>
<div class="chapter-level-extent" id="OpenCL-Video-Filters">
<h2 class="chapter">31 OpenCL Video Filters</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 class="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 class="table">
<dt><samp class="option">-init_hw_device opencl[=<var class="var">name</var>][:<var class="var">device</var>[,<var class="var">key=value</var>...]]</samp></dt>
<dd><p>Initialise a new hardware device of type <var class="var">opencl</var> called <var class="var">name</var>, using the
given device parameters.
</p>
</dd>
<dt><samp class="option">-filter_hw_device <var class="var">name</var></samp></dt>
<dd><p>Pass the hardware device called <var class="var">name</var> to all filters in any filter graph.
</p>
</dd>
</dl>
<p>For more detailed information see <a class="url" href="https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options">https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options</a>
</p>
<ul class="itemize mark-bullet">
<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-preformatted">-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 class="ref" href="#hwupload">hwupload</a>) to hardware surfaces connected to the appropriate device before being used and then downloaded(<a class="ref" href="#hwdownload">hwdownload</a>) back to normal memory. Note that <a class="ref" 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 class="ref" href="#format">format</a> filter immediately before to get the input into the right format and <a class="ref" href="#hwdownload">hwdownload</a> does not support all formats on the output - it may be necessary to insert an additional <a class="ref" href="#format">format</a> filter immediately following in the graph to get the output in a supported format.
</p>
<ul class="mini-toc">
<li><a href="#avgblur_005fopencl" accesskey="1">avgblur_opencl</a></li>
<li><a href="#boxblur_005fopencl" accesskey="2">boxblur_opencl</a></li>
<li><a href="#colorkey_005fopencl" accesskey="3">colorkey_opencl</a></li>
<li><a href="#convolution_005fopencl" accesskey="4">convolution_opencl</a></li>
<li><a href="#erosion_005fopencl" accesskey="5">erosion_opencl</a></li>
<li><a href="#deshake_005fopencl" accesskey="6">deshake_opencl</a></li>
<li><a href="#dilation_005fopencl" accesskey="7">dilation_opencl</a></li>
<li><a href="#nlmeans_005fopencl-1" accesskey="8">nlmeans_opencl</a></li>
<li><a href="#overlay_005fopencl" accesskey="9">overlay_opencl</a></li>
<li><a href="#pad_005fopencl">pad_opencl</a></li>
<li><a href="#prewitt_005fopencl">prewitt_opencl</a></li>
<li><a href="#program_005fopencl-1">program_opencl</a></li>
<li><a href="#remap_005fopencl">remap_opencl</a></li>
<li><a href="#roberts_005fopencl">roberts_opencl</a></li>
<li><a href="#sobel_005fopencl">sobel_opencl</a></li>
<li><a href="#tonemap_005fopencl">tonemap_opencl</a></li>
<li><a href="#unsharp_005fopencl">unsharp_opencl</a></li>
<li><a href="#xfade_005fopencl">xfade_opencl</a></li>
</ul>
<div class="section-level-extent" id="avgblur_005fopencl">
<h3 class="section">31.1 avgblur_opencl</h3>
<p>Apply average blur filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sizeX</samp></dt>
<dd><p>Set horizontal radius size.
Range is <code class="code">[1, 1024]</code> and default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">0xf</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">sizeY</samp></dt>
<dd><p>Set vertical radius size. Range is <code class="code">[1, 1024]</code> and default value is <code class="code">0</code>. If zero, <code class="code">sizeX</code> value will be used.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example">
<h4 class="subsection">31.1.1 Example</h4>
<ul class="itemize mark-bullet">
<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-preformatted">-i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="boxblur_005fopencl">
<h3 class="section">31.2 boxblur_opencl</h3>
<p>Apply a boxblur algorithm to the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dt><samp class="option">luma_power, lp</samp></dt>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dt><samp class="option">chroma_power, cp</samp></dt>
<dt><samp class="option">alpha_radius, ar</samp></dt>
<dt><samp class="option">alpha_power, ap</samp></dt>
</dl>
<p>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">luma_radius, lr</samp></dt>
<dt><samp class="option">chroma_radius, cr</samp></dt>
<dt><samp class="option">alpha_radius, ar</samp></dt>
<dd><p>Set an expression for the box radius in pixels used for blurring the
corresponding input plane.
</p>
<p>The radius value must be a non-negative number, and must not be
greater than the value of the expression <code class="code">min(w,h)/2</code> for the
luma and alpha planes, and of <code class="code">min(cw,ch)/2</code> for the chroma
planes.
</p>
<p>Default value for <samp class="option">luma_radius</samp> is "2". If not specified,
<samp class="option">chroma_radius</samp> and <samp class="option">alpha_radius</samp> default to the
corresponding value set for <samp class="option">luma_radius</samp>.
</p>
<p>The expressions can contain the following constants:
</p><dl class="table">
<dt><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></dt>
<dd><p>The input width and height in pixels.
</p>
</dd>
<dt><samp class="option">cw</samp></dt>
<dt><samp class="option">ch</samp></dt>
<dd><p>The input chroma image width and height in pixels.
</p>
</dd>
<dt><samp class="option">hsub</samp></dt>
<dt><samp class="option">vsub</samp></dt>
<dd><p>The horizontal and vertical chroma subsample values. For example, for the
pixel format "yuv422p", <var class="var">hsub</var> is 2 and <var class="var">vsub</var> is 1.
</p></dd>
</dl>
</dd>
<dt><samp class="option">luma_power, lp</samp></dt>
<dt><samp class="option">chroma_power, cp</samp></dt>
<dt><samp class="option">alpha_power, ap</samp></dt>
<dd><p>Specify how many times the boxblur filter is applied to the
corresponding plane.
</p>
<p>Default value for <samp class="option">luma_power</samp> is 2. If not specified,
<samp class="option">chroma_power</samp> and <samp class="option">alpha_power</samp> default to the
corresponding value set for <samp class="option">luma_power</samp>.
</p>
<p>A value of 0 will disable the effect.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-156" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-156">
<h4 class="subsection">31.2.1 Examples</h4>
<p>Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses <var class="var">luma_radius</var>, <var class="var">chroma_radius</var>, <var class="var">alpha_radius</var> for each plane respectively. The filter will apply <var class="var">luma_power</var>, <var class="var">chroma_power</var>, <var class="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 class="itemize mark-bullet">
<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-preformatted">-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-preformatted">-i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="colorkey_005fopencl">
<h3 class="section">31.3 colorkey_opencl</h3>
<p>RGB colorspace color keying.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color which will be replaced with transparency.
</p>
</dd>
<dt><samp class="option">similarity</samp></dt>
<dd><p>Similarity percentage with the key color.
</p>
<p>0.01 matches only the exact key color, while 1.0 matches everything.
</p>
</dd>
<dt><samp class="option">blend</samp></dt>
<dd><p>Blend percentage.
</p>
<p>0.0 makes pixels either fully transparent, or not transparent at all.
</p>
<p>Higher values result in semi-transparent pixels, with a higher transparency
the more similar the pixels color is to the key color.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-157" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-157">
<h4 class="subsection">31.3.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Make every semi-green pixel in the input transparent with some slight blending:
<div class="example">
<pre class="example-preformatted">-i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="convolution_005fopencl">
<h3 class="section">31.4 convolution_opencl</h3>
<p>Apply convolution of 3x3, 5x5, 7x7 matrix.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">0m</samp></dt>
<dt><samp class="option">1m</samp></dt>
<dt><samp class="option">2m</samp></dt>
<dt><samp class="option">3m</samp></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 class="code">0 0 0 0 1 0 0 0 0</code>.
</p>
</dd>
<dt><samp class="option">0rdiv</samp></dt>
<dt><samp class="option">1rdiv</samp></dt>
<dt><samp class="option">2rdiv</samp></dt>
<dt><samp class="option">3rdiv</samp></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 class="code">0.0</code>. Default value is <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">0bias</samp></dt>
<dt><samp class="option">1bias</samp></dt>
<dt><samp class="option">2bias</samp></dt>
<dt><samp class="option">3bias</samp></dt>
<dd><p>Set bias for each plane. This value is added to the result of the multiplication.
Useful for making the overall image brighter or darker.
The option value must be a float number greater or equal to <code class="code">0.0</code>. Default value is <code class="code">0.0</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-158" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-158">
<h4 class="subsection">31.4.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply sharpen:
<div class="example">
<pre class="example-preformatted">-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-preformatted">-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-preformatted">-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-preformatted">-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-preformatted">-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-preformatted">-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>
</div>
</div>
<div class="section-level-extent" id="erosion_005fopencl">
<h3 class="section">31.5 erosion_opencl</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane. Range is <code class="code">[0, 65535]</code> and default value is <code class="code">65535</code>.
If <code class="code">0</code>, plane will remain unchanged.
</p>
</dd>
<dt><samp class="option">coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to.
Range is <code class="code">[0, 255]</code> and default value is <code class="code">255</code>, i.e. all eight pixels are used.
</p>
<p>Flags to local 3x3 coordinates region centered on <code class="code">x</code>:
</p>
<p>1 2 3
</p>
<p>4 x 5
</p>
<p>6 7 8
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-1" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-1">
<h4 class="subsection">31.5.1 Example</h4>
<ul class="itemize mark-bullet">
<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-preformatted">-i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="deshake_005fopencl">
<h3 class="section">31.6 deshake_opencl</h3>
<p>Feature-point based video stabilization filter.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">tripod</samp></dt>
<dd><p>Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">debug</samp></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 class="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 class="code">0</code>.
</p>
</dd>
<dt><samp class="option">adaptive_crop</samp></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 class="code">1</code>.
</p>
</dd>
<dt><samp class="option">refine_features</samp></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 class="code">1</code>.
</p>
</dd>
<dt><samp class="option">smooth_strength</samp></dt>
<dd><p>The strength of the smoothing applied to the camera path from <code class="code">0.0</code> to <code class="code">1.0</code>.
</p>
<p><code class="code">1.0</code> is the maximum smoothing strength while values less than that result in less smoothing.
</p>
<p><code class="code">0.0</code> causes the filter to adaptively choose a smoothing strength on a per-frame basis.
</p>
<p>Defaults to <code class="code">0.0</code>.
</p>
</dd>
<dt><samp class="option">smooth_window_multiplier</samp></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 class="code">0.1</code> to <code class="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 class="code">2.0</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-159" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-159">
<h4 class="subsection">31.6.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Stabilize a video with a fixed, medium smoothing strength:
<div class="example">
<pre class="example-preformatted">-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-preformatted">-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>
</div>
</div>
<div class="section-level-extent" id="dilation_005fopencl">
<h3 class="section">31.7 dilation_opencl</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 class="table">
<dt><samp class="option">threshold0</samp></dt>
<dt><samp class="option">threshold1</samp></dt>
<dt><samp class="option">threshold2</samp></dt>
<dt><samp class="option">threshold3</samp></dt>
<dd><p>Limit the maximum change for each plane. Range is <code class="code">[0, 65535]</code> and default value is <code class="code">65535</code>.
If <code class="code">0</code>, plane will remain unchanged.
</p>
</dd>
<dt><samp class="option">coordinates</samp></dt>
<dd><p>Flag which specifies the pixel to refer to.
Range is <code class="code">[0, 255]</code> and default value is <code class="code">255</code>, i.e. all eight pixels are used.
</p>
<p>Flags to local 3x3 coordinates region centered on <code class="code">x</code>:
</p>
<p>1 2 3
</p>
<p>4 x 5
</p>
<p>6 7 8
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-2" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-2">
<h4 class="subsection">31.7.1 Example</h4>
<ul class="itemize mark-bullet">
<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-preformatted">-i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
</pre></div>
</li></ul>
<a class="anchor" id="nlmeans_005fopencl"></a></div>
</div>
<div class="section-level-extent" id="nlmeans_005fopencl-1">
<h3 class="section">31.8 nlmeans_opencl</h3>
<p>Non-local Means denoise filter through OpenCL, this filter accepts same options as <a class="ref" href="#nlmeans">nlmeans</a>.
</p>
</div>
<div class="section-level-extent" id="overlay_005fopencl">
<h3 class="section">31.9 overlay_opencl</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 class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Set the x coordinate of the overlaid video on the main video.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set the y coordinate of the overlaid video on the main video.
Default value is <code class="code">0</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-160" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-160">
<h4 class="subsection">31.9.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">-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-preformatted">-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>
</div>
</div>
<div class="section-level-extent" id="pad_005fopencl">
<h3 class="section">31.10 pad_opencl</h3>
<p>Add paddings to the input image, and place the original input at the
provided <var class="var">x</var>, <var class="var">y</var> coordinates.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">width, w</samp></dt>
<dt><samp class="option">height, h</samp></dt>
<dd><p>Specify an expression for the size of the output image with the
paddings added. If the value for <var class="var">width</var> or <var class="var">height</var> is 0, the
corresponding input size is used for the output.
</p>
<p>The <var class="var">width</var> expression can reference the value set by the
<var class="var">height</var> expression, and vice versa.
</p>
<p>The default value of <var class="var">width</var> and <var class="var">height</var> is 0.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>Specify the offsets to place the input image at within the padded area,
with respect to the top/left border of the output image.
</p>
<p>The <var class="var">x</var> expression can reference the value set by the <var class="var">y</var>
expression, and vice versa.
</p>
<p>The default value of <var class="var">x</var> and <var class="var">y</var> is 0.
</p>
<p>If <var class="var">x</var> or <var class="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><samp class="option">color</samp></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><samp class="option">aspect</samp></dt>
<dd><p>Pad to an aspect instead to a resolution.
</p></dd>
</dl>
<p>The value for the <var class="var">width</var>, <var class="var">height</var>, <var class="var">x</var>, and <var class="var">y</var>
options are expressions containing the following constants:
</p>
<dl class="table">
<dt><samp class="option">in_w</samp></dt>
<dt><samp class="option">in_h</samp></dt>
<dd><p>The input video width and height.
</p>
</dd>
<dt><samp class="option">iw</samp></dt>
<dt><samp class="option">ih</samp></dt>
<dd><p>These are the same as <var class="var">in_w</var> and <var class="var">in_h</var>.
</p>
</dd>
<dt><samp class="option">out_w</samp></dt>
<dt><samp class="option">out_h</samp></dt>
<dd><p>The output width and height (the size of the padded area), as
specified by the <var class="var">width</var> and <var class="var">height</var> expressions.
</p>
</dd>
<dt><samp class="option">ow</samp></dt>
<dt><samp class="option">oh</samp></dt>
<dd><p>These are the same as <var class="var">out_w</var> and <var class="var">out_h</var>.
</p>
</dd>
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></dt>
<dd><p>The x and y offsets as specified by the <var class="var">x</var> and <var class="var">y</var>
expressions, or NAN if not yet specified.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>same as <var class="var">iw</var> / <var class="var">ih</var>
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>input sample aspect ratio
</p>
</dd>
<dt><samp class="option">dar</samp></dt>
<dd><p>input display aspect ratio, it is the same as (<var class="var">iw</var> / <var class="var">ih</var>) * <var class="var">sar</var>
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="prewitt_005fopencl">
<h3 class="section">31.11 prewitt_opencl</h3>
<p>Apply the Prewitt operator (<a class="url" 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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">0xf</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
Range is <code class="code">[0.0, 65535]</code> and default value is <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
Range is <code class="code">[-65535, 65535]</code> and default value is <code class="code">0.0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-3" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-3">
<h4 class="subsection">31.11.1 Example</h4>
<ul class="itemize mark-bullet">
<li>Apply the Prewitt operator with scale set to 2 and delta set to 10.
<div class="example">
<pre class="example-preformatted">-i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT
</pre></div>
</li></ul>
<a class="anchor" id="program_005fopencl"></a></div>
</div>
<div class="section-level-extent" id="program_005fopencl-1">
<h3 class="section">31.12 program_opencl</h3>
<p>Filter video using an OpenCL program.
</p>
<dl class="table">
<dt><samp class="option">source</samp></dt>
<dd><p>OpenCL program source file.
</p>
</dd>
<dt><samp class="option">kernel</samp></dt>
<dd><p>Kernel name in program.
</p>
</dd>
<dt><samp class="option">inputs</samp></dt>
<dd><p>Number of inputs to the filter. Defaults to 1.
</p>
</dd>
<dt><samp class="option">size, s</samp></dt>
<dd><p>Size of output frames. Defaults to the same as the first input.
</p>
</dd>
</dl>
<p>The <code class="code">program_opencl</code> filter also supports the <a class="ref" 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 class="itemize mark-bullet">
<li>Destination image, <var class="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 class="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 class="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 class="itemize mark-bullet">
<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>
</div>
<div class="section-level-extent" id="remap_005fopencl">
<h3 class="section">31.13 remap_opencl</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 class="table">
<dt><samp class="option">interp</samp></dt>
<dd><p>Specify interpolation used for remapping of pixels.
Allowed values are <code class="code">near</code> and <code class="code">linear</code>.
Default value is <code class="code">linear</code>.
</p>
</dd>
<dt><samp class="option">fill</samp></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 class="code">black</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="roberts_005fopencl">
<h3 class="section">31.14 roberts_opencl</h3>
<p>Apply the Roberts cross operator (<a class="url" 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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">0xf</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
Range is <code class="code">[0.0, 65535]</code> and default value is <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
Range is <code class="code">[-65535, 65535]</code> and default value is <code class="code">0.0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-4" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-4">
<h4 class="subsection">31.14.1 Example</h4>
<ul class="itemize mark-bullet">
<li>Apply the Roberts cross operator with scale set to 2 and delta set to 10
<div class="example">
<pre class="example-preformatted">-i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="sobel_005fopencl">
<h3 class="section">31.15 sobel_opencl</h3>
<p>Apply the Sobel operator (<a class="url" 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 class="table">
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">0xf</code>, by which all planes are processed.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set value which will be multiplied with filtered result.
Range is <code class="code">[0.0, 65535]</code> and default value is <code class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">delta</samp></dt>
<dd><p>Set value which will be added to filtered result.
Range is <code class="code">[-65535, 65535]</code> and default value is <code class="code">0.0</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-5" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-5">
<h4 class="subsection">31.15.1 Example</h4>
<ul class="itemize mark-bullet">
<li>Apply sobel operator with scale set to 2 and delta set to 10
<div class="example">
<pre class="example-preformatted">-i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="tonemap_005fopencl">
<h3 class="section">31.16 tonemap_opencl</h3>
<p>Perform HDR(PQ/HLG) to SDR conversion with tone-mapping.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">tonemap</samp></dt>
<dd><p>Specify the tone-mapping operator to be used. Same as tonemap option in <a class="ref" href="#tonemap">tonemap</a>.
</p>
</dd>
<dt><samp class="option">param</samp></dt>
<dd><p>Tune the tone mapping algorithm. same as param option in <a class="ref" href="#tonemap">tonemap</a>.
</p>
</dd>
<dt><samp class="option">desat</samp></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><samp class="option">threshold</samp></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><samp class="option">format</samp></dt>
<dd><p>Specify the output pixel format.
</p>
<p>Currently supported formats are:
</p><dl class="table">
<dt><var class="var">p010</var></dt>
<dt><var class="var">nv12</var></dt>
</dl>
</dd>
<dt><samp class="option">range, r</samp></dt>
<dd><p>Set the output color range.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">tv/mpeg</var></dt>
<dt><var class="var">pc/jpeg</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">primaries, p</samp></dt>
<dd><p>Set the output color primaries.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">bt709</var></dt>
<dt><var class="var">bt2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">transfer, t</samp></dt>
<dd><p>Set the output transfer characteristics.
</p>
<p>Possible values are:
</p><dl class="table">
<dt><var class="var">bt709</var></dt>
<dt><var class="var">bt2020</var></dt>
</dl>
<p>Default is bt709.
</p>
</dd>
<dt><samp class="option">matrix, m</samp></dt>
<dd><p>Set the output colorspace matrix.
</p>
<p>Possible value are:
</p><dl class="table">
<dt><var class="var">bt709</var></dt>
<dt><var class="var">bt2020</var></dt>
</dl>
<p>Default is same as input.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-6" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-6">
<h4 class="subsection">31.16.1 Example</h4>
<ul class="itemize mark-bullet">
<li>Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator.
<div class="example">
<pre class="example-preformatted">-i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="unsharp_005fopencl">
<h3 class="section">31.17 unsharp_opencl</h3>
<p>Sharpen or blur the input video.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">luma_msize_x, lx</samp></dt>
<dd><p>Set the luma matrix horizontal size.
Range is <code class="code">[1, 23]</code> and default value is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">luma_msize_y, ly</samp></dt>
<dd><p>Set the luma matrix vertical size.
Range is <code class="code">[1, 23]</code> and default value is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">luma_amount, la</samp></dt>
<dd><p>Set the luma effect strength.
Range is <code class="code">[-10, 10]</code> and default value is <code class="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><samp class="option">chroma_msize_x, cx</samp></dt>
<dd><p>Set the chroma matrix horizontal size.
Range is <code class="code">[1, 23]</code> and default value is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">chroma_msize_y, cy</samp></dt>
<dd><p>Set the chroma matrix vertical size.
Range is <code class="code">[1, 23]</code> and default value is <code class="code">5</code>.
</p>
</dd>
<dt><samp class="option">chroma_amount, ca</samp></dt>
<dd><p>Set the chroma effect strength.
Range is <code class="code">[-10, 10]</code> and default value is <code class="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>
<ul class="mini-toc">
<li><a href="#Examples-161" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-161">
<h4 class="subsection">31.17.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Apply strong luma sharpen effect:
<div class="example">
<pre class="example-preformatted">-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-preformatted">-i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="xfade_005fopencl">
<h3 class="section">31.18 xfade_opencl</h3>
<p>Cross fade two videos with custom transition effect by using OpenCL.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">transition</samp></dt>
<dd><p>Set one of possible transition effects.
</p>
<dl class="table">
<dt><samp class="option">custom</samp></dt>
<dd><p>Select custom transition effect, the actual transition description
will be picked from source and kernel options.
</p>
</dd>
<dt><samp class="option">fade</samp></dt>
<dt><samp class="option">wipeleft</samp></dt>
<dt><samp class="option">wiperight</samp></dt>
<dt><samp class="option">wipeup</samp></dt>
<dt><samp class="option">wipedown</samp></dt>
<dt><samp class="option">slideleft</samp></dt>
<dt><samp class="option">slideright</samp></dt>
<dt><samp class="option">slideup</samp></dt>
<dt><samp class="option">slidedown</samp></dt>
<dd>
<p>Default transition is fade.
</p></dd>
</dl>
</dd>
<dt><samp class="option">source</samp></dt>
<dd><p>OpenCL program source file for custom transition.
</p>
</dd>
<dt><samp class="option">kernel</samp></dt>
<dd><p>Set name of kernel to use for custom transition from program source file.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>Set duration of video transition.
</p>
</dd>
<dt><samp class="option">offset</samp></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 class="itemize mark-bullet">
<li>Destination image, <var class="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 class="var">__read_only image2d_t</var>.
Second Source image, <var class="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 class="var">float</var>. This value is always between 0 and 1 inclusive.
</li></ul>
<p>Example programs:
</p>
<ul class="itemize mark-bullet">
<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>
</div>
</div>
<div class="chapter-level-extent" id="VAAPI-Video-Filters">
<h2 class="chapter">32 VAAPI Video Filters</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 class="code">--enable-vaapi</code>.
</p>
<p>To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read <a class="url" href="https://trac.ffmpeg.org/wiki/Hardware/VAAPI">https://trac.ffmpeg.org/wiki/Hardware/VAAPI</a>
</p>
<ul class="mini-toc">
<li><a href="#overlay_005fvaapi" accesskey="1">overlay_vaapi</a></li>
<li><a href="#tonemap_005fvaapi" accesskey="2">tonemap_vaapi</a></li>
<li><a href="#hstack_005fvaapi" accesskey="3">hstack_vaapi</a></li>
<li><a href="#vstack_005fvaapi" accesskey="4">vstack_vaapi</a></li>
<li><a href="#xstack_005fvaapi" accesskey="5">xstack_vaapi</a></li>
</ul>
<div class="section-level-extent" id="overlay_005fvaapi">
<h3 class="section">32.1 overlay_vaapi</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 class="table">
<dt><samp class="option">x</samp></dt>
<dt><samp class="option">y</samp></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><samp class="option">w</samp></dt>
<dt><samp class="option">h</samp></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 class="table">
<dt><samp class="option">main_w, W</samp></dt>
<dt><samp class="option">main_h, H</samp></dt>
<dd><p>The main input width and height.
</p>
</dd>
<dt><samp class="option">overlay_iw</samp></dt>
<dt><samp class="option">overlay_ih</samp></dt>
<dd><p>The overlay input width and height.
</p>
</dd>
<dt><samp class="option">overlay_w, w</samp></dt>
<dt><samp class="option">overlay_h, h</samp></dt>
<dd><p>The overlay output width and height.
</p>
</dd>
<dt><samp class="option">overlay_x, x</samp></dt>
<dt><samp class="option">overlay_y, y</samp></dt>
<dd><p>Position of the overlay layer inside of main
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">alpha</samp></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 class="code">1.0</code>.
</p>
</dd>
<dt><samp class="option">eof_action</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
<dt><samp class="option">repeatlast</samp></dt>
<dd><p>See <a class="ref" href="#framesync">framesync</a>.
</p>
</dd>
</dl>
<p>This filter also supports the <a class="ref" href="#framesync">framesync</a> options.
</p><ul class="mini-toc">
<li><a href="#Examples-162" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-162">
<h4 class="subsection">32.1.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">-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-preformatted">-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>
</div>
</div>
<div class="section-level-extent" id="tonemap_005fvaapi">
<h3 class="section">32.2 tonemap_vaapi</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 class="table">
<dt><samp class="option">format</samp></dt>
<dd><p>Specify the output pixel format.
</p>
<p>Currently supported formats are:
</p><dl class="table">
<dt><var class="var">p010</var></dt>
<dt><var class="var">nv12</var></dt>
</dl>
<p>Default is nv12.
</p>
</dd>
<dt><samp class="option">primaries, p</samp></dt>
<dd><p>Set the output color primaries.
</p>
<p>Default is same as input.
</p>
</dd>
<dt><samp class="option">transfer, t</samp></dt>
<dd><p>Set the output transfer characteristics.
</p>
<p>Default is bt709.
</p>
</dd>
<dt><samp class="option">matrix, m</samp></dt>
<dd><p>Set the output colorspace matrix.
</p>
<p>Default is same as input.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Example-7" accesskey="1">Example</a></li>
</ul>
<div class="subsection-level-extent" id="Example-7">
<h4 class="subsection">32.2.1 Example</h4>
<ul class="itemize mark-bullet">
<li>Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format
<div class="example">
<pre class="example-preformatted">tonemap_vaapi=format=p010:t=bt2020-10
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="hstack_005fvaapi">
<h3 class="section">32.3 hstack_vaapi</h3>
<p>Stack input videos horizontally.
</p>
<p>This is the VA-API variant of the <a class="ref" href="#hstack">hstack</a> filter, each input stream may
have different height, this filter will scale down/up each input stream while
keeping the orignal aspect.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#hstack">hstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#hstack">hstack</a>.
</p>
</dd>
<dt><samp class="option">height</samp></dt>
<dd><p>Set height of output. If set to 0, this filter will set height of output to
height of the first input stream. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="vstack_005fvaapi">
<h3 class="section">32.4 vstack_vaapi</h3>
<p>Stack input videos vertically.
</p>
<p>This is the VA-API variant of the <a class="ref" href="#vstack">vstack</a> filter, each input stream may
have different width, this filter will scale down/up each input stream while
keeping the orignal aspect.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#vstack">vstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#vstack">vstack</a>.
</p>
</dd>
<dt><samp class="option">width</samp></dt>
<dd><p>Set width of output. If set to 0, this filter will set width of output to
width of the first input stream. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="xstack_005fvaapi">
<h3 class="section">32.5 xstack_vaapi</h3>
<p>Stack video inputs into custom layout.
</p>
<p>This is the VA-API variant of the <a class="ref" href="#xstack">xstack</a> filter, each input stream may
have different size, this filter will scale down/up each input stream to the
given output size, or the size of the first input stream.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">layout</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
Moreover, this permits the user to supply output size for each input stream.
</p><div class="example">
<pre class="example-preformatted">xstack_vaapi=inputs=4:layout=0_0_1920x1080|0_h0_1920x1080|w0_0_1920x1080|w0_h0_1920x1080
</pre></div>
</dd>
<dt><samp class="option">grid</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">grid_tile_size</samp></dt>
<dd><p>Set output size for each input stream when <samp class="option">grid</samp> is set. If this option
is not set, this filter will set output size by default to the size of the
first input stream. 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><samp class="option">fill</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p></dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="Vulkan-Video-Filters">
<h2 class="chapter">33 Vulkan Video Filters</h2>
<p>Below is a description of the currently available Vulkan video filters.
</p>
<p>To enable compilation of these filters you need to configure FFmpeg with
<code class="code">--enable-vulkan</code> and either <code class="code">--enable-libglslang</code> or <code class="code">--enable-libshaderc</code>.
</p>
<p>Running Vulkan filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph.
</p><dl class="table">
<dt><samp class="option">-init_hw_device vulkan[=<var class="var">name</var>][:<var class="var">device</var>[,<var class="var">key=value</var>...]]</samp></dt>
<dd><p>Initialise a new hardware device of type <var class="var">vulkan</var> called <var class="var">name</var>, using the
given device parameters and options in <var class="var">key=value</var>. The following options
are supported:
</p>
<dl class="table">
<dt><samp class="option">debug</samp></dt>
<dd><p>Switches validation layers on if set to 1.
</p>
</dd>
<dt><samp class="option">linear_images</samp></dt>
<dd><p>Allocates linear images. Does not apply to decoding.
</p>
</dd>
<dt><samp class="option">disable_multiplane</samp></dt>
<dd><p>Disables multiplane images. Does not apply to decoding.
</p></dd>
</dl>
</dd>
<dt><samp class="option">-filter_hw_device <var class="var">name</var></samp></dt>
<dd><p>Pass the hardware device called <var class="var">name</var> to all filters in any filter graph.
</p>
</dd>
</dl>
<p>For more detailed information see <a class="url" href="https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options">https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options</a>
</p>
<ul class="itemize mark-bullet">
<li>Example of choosing the first device and running nlmeans_vulkan filter with default parameters on it.
<div class="example">
<pre class="example-preformatted">-init_hw_device vulkan=vk:0 -filter_hw_device vk -i INPUT -vf "hwupload,nlmeans_vulkan,hwdownload" OUTPUT
</pre></div>
</li></ul>
<p>As Vulkan filters are not able to access frame data in normal memory, all frame data needs to be uploaded (<a class="ref" href="#hwupload">hwupload</a>) to hardware surfaces connected to the appropriate device before being used and then downloaded (<a class="ref" href="#hwdownload">hwdownload</a>) back to normal memory. Note that <a class="ref" href="#hwupload">hwupload</a> will upload to a frame with the same layout as the software frame, so it may be necessary to add a <a class="ref" href="#format">format</a> filter immediately before to get the input into the right format and <a class="ref" href="#hwdownload">hwdownload</a> does not support all formats on the output - it is usually necessary to insert an additional <a class="ref" href="#format">format</a> filter immediately following in the graph to get the output in a supported format.
</p>
<ul class="mini-toc">
<li><a href="#avgblur_005fvulkan" accesskey="1">avgblur_vulkan</a></li>
<li><a href="#blend_005fvulkan" accesskey="2">blend_vulkan</a></li>
<li><a href="#bwdif_005fvulkan" accesskey="3">bwdif_vulkan</a></li>
<li><a href="#chromaber_005fvulkan" accesskey="4">chromaber_vulkan</a></li>
<li><a href="#color_005fvulkan" accesskey="5">color_vulkan</a></li>
<li><a href="#vflip_005fvulkan" accesskey="6">vflip_vulkan</a></li>
<li><a href="#hflip_005fvulkan" accesskey="7">hflip_vulkan</a></li>
<li><a href="#flip_005fvulkan" accesskey="8">flip_vulkan</a></li>
<li><a href="#gblur_005fvulkan" accesskey="9">gblur_vulkan</a></li>
<li><a href="#nlmeans_005fvulkan">nlmeans_vulkan</a></li>
<li><a href="#overlay_005fvulkan">overlay_vulkan</a></li>
<li><a href="#transpose_005fvt">transpose_vt</a></li>
<li><a href="#transpose_005fvulkan">transpose_vulkan</a></li>
</ul>
<div class="section-level-extent" id="avgblur_005fvulkan">
<h3 class="section">33.1 avgblur_vulkan</h3>
<p>Apply an average blur filter, implemented on the GPU using Vulkan.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sizeX</samp></dt>
<dd><p>Set horizontal radius size.
Range is <code class="code">[1, 32]</code> and default value is <code class="code">3</code>.
</p>
</dd>
<dt><samp class="option">sizeY</samp></dt>
<dd><p>Set vertical radius size. Range is <code class="code">[1, 32]</code> and default value is <code class="code">3</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. Default value is <code class="code">0xf</code>, by which all planes are processed.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="blend_005fvulkan">
<h3 class="section">33.2 blend_vulkan</h3>
<p>Blend two Vulkan frames into each other.
</p>
<p>The <code class="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>A description of the accepted options follows.
</p>
<dl class="table">
<dt><samp class="option">c0_mode</samp></dt>
<dt><samp class="option">c1_mode</samp></dt>
<dt><samp class="option">c2_mode</samp></dt>
<dt><samp class="option">c3_mode</samp></dt>
<dt><samp class="option">all_mode</samp></dt>
<dd><p>Set blend mode for specific pixel component or all pixel components in case
of <var class="var">all_mode</var>. Default value is <code class="code">normal</code>.
</p>
<p>Available values for component modes are:
</p><dl class="table">
<dt>‘<samp class="samp">normal</samp>’</dt>
<dt>‘<samp class="samp">multiply</samp>’</dt>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="bwdif_005fvulkan">
<h3 class="section">33.3 bwdif_vulkan</h3>
<p>Deinterlacer using <a class="ref" href="#bwdif">bwdif</a>, the "Bob Weaver Deinterlacing Filter" algorithm, implemented
on the GPU using Vulkan.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>The interlacing mode to adopt. It accepts one of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, send_frame</samp></dt>
<dd><p>Output one frame for each frame.
</p></dd>
<dt><samp class="option">1, send_field</samp></dt>
<dd><p>Output one frame for each field.
</p></dd>
</dl>
<p>The default value is <code class="code">send_field</code>.
</p>
</dd>
<dt><samp class="option">parity</samp></dt>
<dd><p>The picture field parity assumed for the input interlaced video. It accepts one
of the following values:
</p>
<dl class="table">
<dt><samp class="option">0, tff</samp></dt>
<dd><p>Assume the top field is first.
</p></dd>
<dt><samp class="option">1, bff</samp></dt>
<dd><p>Assume the bottom field is first.
</p></dd>
<dt><samp class="option">-1, auto</samp></dt>
<dd><p>Enable automatic detection of field parity.
</p></dd>
</dl>
<p>The default value is <code class="code">auto</code>.
If the interlacing is unknown or the decoder does not export this information,
top field first will be assumed.
</p>
</dd>
<dt><samp class="option">deint</samp></dt>
<dd><p>Specify which frames to deinterlace. Accepts one of the following
values:
</p>
<dl class="table">
<dt><samp class="option">0, all</samp></dt>
<dd><p>Deinterlace all frames.
</p></dd>
<dt><samp class="option">1, interlaced</samp></dt>
<dd><p>Only deinterlace frames marked as interlaced.
</p></dd>
</dl>
<p>The default value is <code class="code">all</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="chromaber_005fvulkan">
<h3 class="section">33.4 chromaber_vulkan</h3>
<p>Apply an effect that emulates chromatic aberration. Works best with RGB inputs,
but provides a similar effect with YCbCr inputs too.
</p>
<dl class="table">
<dt><samp class="option">dist_x</samp></dt>
<dd><p>Horizontal displacement multiplier. Each chroma pixel’s position will be multiplied
by this amount, starting from the center of the image. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">dist_y</samp></dt>
<dd><p>Similarly, this sets the vertical displacement multiplier. Default is <code class="code">0</code>.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="color_005fvulkan">
<h3 class="section">33.5 color_vulkan</h3>
<p>Video source that creates a Vulkan frame of a solid color.
Useful for benchmarking, or overlaying.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">color</samp></dt>
<dd><p>The color to use. Either a name, or a hexadecimal value.
The default value is <code class="code">black</code>.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>The size of the output frame. Default value is <code class="code">1920x1080</code>.
</p>
</dd>
<dt><samp class="option">rate</samp></dt>
<dd><p>The framerate to output at. Default value is <code class="code">60</code> frames per second.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>The video duration. Default value is <code class="code">-0.000001</code>.
</p>
</dd>
<dt><samp class="option">sar</samp></dt>
<dd><p>The video signal aspect ratio. Default value is <code class="code">1/1</code>.
</p>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>The pixel format of the output Vulkan frames. Default value is <code class="code">yuv444p</code>.
</p>
</dd>
<dt><samp class="option">out_range</samp></dt>
<dd><p>Set the 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 class="table">
<dt>‘<samp class="samp">auto/unknown</samp>’</dt>
<dd><p>Choose automatically.
</p>
</dd>
<dt>‘<samp class="samp">jpeg/full/pc</samp>’</dt>
<dd><p>Set full range (0-255 in case of 8-bit luma).
</p>
</dd>
<dt>‘<samp class="samp">mpeg/limited/tv</samp>’</dt>
<dd><p>Set "MPEG" range (16-235 in case of 8-bit luma).
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="vflip_005fvulkan">
<h3 class="section">33.6 vflip_vulkan</h3>
<p>Flips an image vertically.
</p>
</div>
<div class="section-level-extent" id="hflip_005fvulkan">
<h3 class="section">33.7 hflip_vulkan</h3>
<p>Flips an image horizontally.
</p>
</div>
<div class="section-level-extent" id="flip_005fvulkan">
<h3 class="section">33.8 flip_vulkan</h3>
<p>Flips an image along both the vertical and horizontal axis.
</p>
</div>
<div class="section-level-extent" id="gblur_005fvulkan">
<h3 class="section">33.9 gblur_vulkan</h3>
<p>Apply Gaussian blur filter on Vulkan frames.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sigma</samp></dt>
<dd><p>Set horizontal sigma, standard deviation of Gaussian blur. Default is <code class="code">0.5</code>.
</p>
</dd>
<dt><samp class="option">sigmaV</samp></dt>
<dd><p>Set vertical sigma, if negative it will be same as <code class="code">sigma</code>.
Default is <code class="code">-1</code>.
</p>
</dd>
<dt><samp class="option">planes</samp></dt>
<dd><p>Set which planes to filter. By default all planes are filtered.
</p>
</dd>
<dt><samp class="option">size</samp></dt>
<dd><p>Set the kernel size along the horizontal axis. Default is <code class="code">19</code>.
</p>
</dd>
<dt><samp class="option">sizeV</samp></dt>
<dd><p>Set the kernel size along the vertical axis. Default is <code class="code">0</code>,
which sets to use the same value as <var class="var">size</var>.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="nlmeans_005fvulkan">
<h3 class="section">33.10 nlmeans_vulkan</h3>
<p>Denoise frames using Non-Local Means algorithm, implemented on the GPU using
Vulkan.
Supports more pixel formats than <a class="ref" href="#nlmeans">nlmeans</a> or <a class="ref" href="#nlmeans_005fopencl">nlmeans_opencl</a>, including
alpha channel support.
</p>
<p>The filter accepts the following options.
</p>
<dl class="table">
<dt><samp class="option">s</samp></dt>
<dd><p>Set denoising strength for all components. Default is 1.0. Must be in range [1.0, 100.0].
</p>
</dd>
<dt><samp class="option">p</samp></dt>
<dd><p>Set patch size for all planes. Default is 7. Must be odd number in range [0, 99].
</p>
</dd>
<dt><samp class="option">r</samp></dt>
<dd><p>Set research size. Default is 15. Must be odd number in range [0, 99].
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>Set parallelism. Default is 36. Must be a number in the range [1, 168].
Larger values may speed up processing, at the cost of more VRAM.
Lower values will slow it down, reducing VRAM usage.
Only supported on GPUs with atomic float operations (RDNA3+, Ampere+).
</p>
</dd>
<dt><samp class="option">s0</samp></dt>
<dt><samp class="option">s1</samp></dt>
<dt><samp class="option">s2</samp></dt>
<dt><samp class="option">s3</samp></dt>
<dd><p>Set denoising strength for a specific component. Default is <var class="var">1</var>, equal to <samp class="option">s</samp>.
Must be odd number in range [1, 100].
</p>
</dd>
<dt><samp class="option">p0</samp></dt>
<dt><samp class="option">p1</samp></dt>
<dt><samp class="option">p2</samp></dt>
<dt><samp class="option">p3</samp></dt>
<dd><p>Set patch size for a specific component. Default is <var class="var">7</var>, equal to <samp class="option">p</samp>.
Must be odd number in range [0, 99].
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="overlay_005fvulkan">
<h3 class="section">33.11 overlay_vulkan</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 all inputs to use the same pixel format. So, format conversion may be needed.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">x</samp></dt>
<dd><p>Set the x coordinate of the overlaid video on the main video.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">y</samp></dt>
<dd><p>Set the y coordinate of the overlaid video on the main video.
Default value is <code class="code">0</code>.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="transpose_005fvt">
<h3 class="section">33.12 transpose_vt</h3>
<p>Transpose rows with columns in the input video and optionally flip it.
For more in depth examples see the <a class="ref" href="#transpose">transpose</a> video filter, which shares mostly the same options.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">dir</samp></dt>
<dd><p>Specify the transposition direction.
</p>
<p>Can assume the following values:
</p><dl class="table">
<dt>‘<samp class="samp">cclock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise and vertically flip. (default)
</p>
</dd>
<dt>‘<samp class="samp">clock</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise.
</p>
</dd>
<dt>‘<samp class="samp">cclock</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise.
</p>
</dd>
<dt>‘<samp class="samp">clock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise and vertically flip.
</p>
</dd>
<dt>‘<samp class="samp">hflip</samp>’</dt>
<dd><p>Flip the input video horizontally.
</p>
</dd>
<dt>‘<samp class="samp">vflip</samp>’</dt>
<dd><p>Flip the input video vertically.
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">passthrough</samp></dt>
<dd><p>Do not apply the transposition if the input geometry matches the one
specified by the specified value. It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Always apply transposition. (default)
</p></dd>
<dt>‘<samp class="samp">portrait</samp>’</dt>
<dd><p>Preserve portrait geometry (when <var class="var">height</var> >= <var class="var">width</var>).
</p></dd>
<dt>‘<samp class="samp">landscape</samp>’</dt>
<dd><p>Preserve landscape geometry (when <var class="var">width</var> >= <var class="var">height</var>).
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="transpose_005fvulkan">
<h3 class="section">33.13 transpose_vulkan</h3>
<p>Transpose rows with columns in the input video and optionally flip it.
For more in depth examples see the <a class="ref" href="#transpose">transpose</a> video filter, which shares mostly the same options.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">dir</samp></dt>
<dd><p>Specify the transposition direction.
</p>
<p>Can assume the following values:
</p><dl class="table">
<dt>‘<samp class="samp">cclock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise and vertically flip. (default)
</p>
</dd>
<dt>‘<samp class="samp">clock</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise.
</p>
</dd>
<dt>‘<samp class="samp">cclock</samp>’</dt>
<dd><p>Rotate by 90 degrees counterclockwise.
</p>
</dd>
<dt>‘<samp class="samp">clock_flip</samp>’</dt>
<dd><p>Rotate by 90 degrees clockwise and vertically flip.
</p></dd>
</dl>
</dd>
<dt><samp class="option">passthrough</samp></dt>
<dd><p>Do not apply the transposition if the input geometry matches the one
specified by the specified value. It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Always apply transposition. (default)
</p></dd>
<dt>‘<samp class="samp">portrait</samp>’</dt>
<dd><p>Preserve portrait geometry (when <var class="var">height</var> >= <var class="var">width</var>).
</p></dd>
<dt>‘<samp class="samp">landscape</samp>’</dt>
<dd><p>Preserve landscape geometry (when <var class="var">width</var> >= <var class="var">height</var>).
</p></dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="QSV-Video-Filters">
<h2 class="chapter">34 QSV Video Filters</h2>
<p>Below is a description of the currently available QSV video filters.
</p>
<p>To enable compilation of these filters you need to configure FFmpeg with
<code class="code">--enable-libmfx</code> or <code class="code">--enable-libvpl</code>.
</p>
<p>To use QSV filters, you need to setup the QSV device correctly. For more information, please read <a class="url" href="https://trac.ffmpeg.org/wiki/Hardware/QuickSync">https://trac.ffmpeg.org/wiki/Hardware/QuickSync</a>
</p>
<ul class="mini-toc">
<li><a href="#hstack_005fqsv" accesskey="1">hstack_qsv</a></li>
<li><a href="#vstack_005fqsv" accesskey="2">vstack_qsv</a></li>
<li><a href="#xstack_005fqsv" accesskey="3">xstack_qsv</a></li>
</ul>
<div class="section-level-extent" id="hstack_005fqsv">
<h3 class="section">34.1 hstack_qsv</h3>
<p>Stack input videos horizontally.
</p>
<p>This is the QSV variant of the <a class="ref" href="#hstack">hstack</a> filter, each input stream may
have different height, this filter will scale down/up each input stream while
keeping the orignal aspect.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#hstack">hstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#hstack">hstack</a>.
</p>
</dd>
<dt><samp class="option">height</samp></dt>
<dd><p>Set height of output. If set to 0, this filter will set height of output to
height of the first input stream. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="vstack_005fqsv">
<h3 class="section">34.2 vstack_qsv</h3>
<p>Stack input videos vertically.
</p>
<p>This is the QSV variant of the <a class="ref" href="#vstack">vstack</a> filter, each input stream may
have different width, this filter will scale down/up each input stream while
keeping the orignal aspect.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#vstack">vstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#vstack">vstack</a>.
</p>
</dd>
<dt><samp class="option">width</samp></dt>
<dd><p>Set width of output. If set to 0, this filter will set width of output to
width of the first input stream. Default value is 0.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="xstack_005fqsv">
<h3 class="section">34.3 xstack_qsv</h3>
<p>Stack video inputs into custom layout.
</p>
<p>This is the QSV variant of the <a class="ref" href="#xstack">xstack</a> filter.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">inputs</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">layout</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
Moreover, this permits the user to supply output size for each input stream.
</p><div class="example">
<pre class="example-preformatted">xstack_qsv=inputs=4:layout=0_0_1920x1080|0_h0_1920x1080|w0_0_1920x1080|w0_h0_1920x1080
</pre></div>
</dd>
<dt><samp class="option">grid</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p>
</dd>
<dt><samp class="option">grid_tile_size</samp></dt>
<dd><p>Set output size for each input stream when <samp class="option">grid</samp> is set. If this option
is not set, this filter will set output size by default to the size of the
first input stream. 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><samp class="option">fill</samp></dt>
<dd><p>See <a class="ref" href="#xstack">xstack</a>.
</p></dd>
</dl>
</div>
</div>
<div class="chapter-level-extent" id="Video-Sources">
<h2 class="chapter">35 Video Sources</h2>
<p>Below is a description of the currently available video sources.
</p>
<ul class="mini-toc">
<li><a href="#buffer" accesskey="1">buffer</a></li>
<li><a href="#cellauto" accesskey="2">cellauto</a></li>
<li><a href="#coreimagesrc-1" accesskey="3">coreimagesrc</a></li>
<li><a href="#ddagrab" accesskey="4">ddagrab</a></li>
<li><a href="#gradients" accesskey="5">gradients</a></li>
<li><a href="#mandelbrot" accesskey="6">mandelbrot</a></li>
<li><a href="#mptestsrc" accesskey="7">mptestsrc</a></li>
<li><a href="#frei0r_005fsrc" accesskey="8">frei0r_src</a></li>
<li><a href="#life" accesskey="9">life</a></li>
<li><a 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">allrgb, allyuv, color, colorchart, colorspectrum, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc</a></li>
<li><a href="#openclsrc">openclsrc</a></li>
<li><a href="#sierpinski">sierpinski</a></li>
<li><a href="#zoneplate">zoneplate</a></li>
</ul>
<div class="section-level-extent" id="buffer">
<h3 class="section">35.1 buffer</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 class="file">libavfilter/buffersrc.h</samp>.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">video_size</samp></dt>
<dd><p>Specify the size (width and height) of the buffered video frames. For the
syntax of this option, check the
<a 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><samp class="option">width</samp></dt>
<dd><p>The input video width.
</p>
</dd>
<dt><samp class="option">height</samp></dt>
<dd><p>The input video height.
</p>
</dd>
<dt><samp class="option">pix_fmt</samp></dt>
<dd><p>A string representing the pixel format of the buffered video frames.
It may be a number corresponding to a pixel format, or a pixel format
name.
</p>
</dd>
<dt><samp class="option">time_base</samp></dt>
<dd><p>Specify the timebase assumed by the timestamps of the buffered frames.
</p>
</dd>
<dt><samp class="option">frame_rate</samp></dt>
<dd><p>Specify the frame rate expected for the video stream.
</p>
</dd>
<dt><samp class="option">pixel_aspect, sar</samp></dt>
<dd><p>The sample (pixel) aspect ratio of the input video.
</p>
</dd>
<dt><samp class="option">hw_frames_ctx</samp></dt>
<dd><p>When using a hardware pixel format, this should be a reference to an
AVHWFramesContext describing input frames.
</p></dd>
</dl>
<p>For example:
</p><div class="example">
<pre class="example-preformatted">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 class="file">libavutil/pixfmt.h</samp>),
this example corresponds to:
</p><div class="example">
<pre class="example-preformatted">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 class="var">width</var>:<var class="var">height</var>:<var class="var">pix_fmt</var>:<var class="var">time_base.num</var>:<var class="var">time_base.den</var>:<var class="var">pixel_aspect.num</var>:<var class="var">pixel_aspect.den</var>
</p>
</div>
<div class="section-level-extent" id="cellauto">
<h3 class="section">35.2 cellauto</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 class="option">filename</samp> and <samp class="option">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 class="option">scroll</samp> option.
</p>
<p>This source accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">filename, f</samp></dt>
<dd><p>Read the initial cellular automaton state, i.e. the starting row, from
the specified file.
In the file, each non-whitespace character is considered an alive
cell, a newline will terminate the row, and further characters in the
file will be ignored.
</p>
</dd>
<dt><samp class="option">pattern, p</samp></dt>
<dd><p>Read the initial cellular automaton state, i.e. the starting row, from
the specified string.
</p>
<p>Each non-whitespace character in the string is considered an alive
cell, a newline will terminate the row, and further characters in the
string will be ignored.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the video rate, that is the number of frames generated per second.
Default is 25.
</p>
</dd>
<dt><samp class="option">random_fill_ratio, ratio</samp></dt>
<dd><p>Set the random fill ratio for the initial cellular automaton row. It
is a floating point number value ranging from 0 to 1, defaults to
1/PHI.
</p>
<p>This option is ignored when a file or a pattern is specified.
</p>
</dd>
<dt><samp class="option">random_seed, seed</samp></dt>
<dd><p>Set the seed for filling randomly the initial row, must be an integer
included between 0 and UINT32_MAX. If not specified, or if explicitly
set to -1, the filter will try to use a good random seed on a best
effort basis.
</p>
</dd>
<dt><samp class="option">rule</samp></dt>
<dd><p>Set the cellular automaton rule, it is a number ranging from 0 to 255.
Default value is 110.
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="option">filename</samp> or <samp class="option">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 class="var">width</var> * PHI.
</p>
<p>If <samp class="option">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><samp class="option">scroll</samp></dt>
<dd><p>If set to 1, scroll the output upward when all the rows in the output
have been already filled. If set to 0, the new generated row will be
written over the top row just after the bottom row is filled.
Defaults to 1.
</p>
</dd>
<dt><samp class="option">start_full, full</samp></dt>
<dd><p>If set to 1, completely fill the output with generated rows before
outputting the first frame.
This is the default behavior, for disabling set the value to 0.
</p>
</dd>
<dt><samp class="option">stitch</samp></dt>
<dd><p>If set to 1, stitch the left and right row edges together.
This is the default behavior, for disabling set the value to 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-163" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-163">
<h4 class="subsection">35.2.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Read the initial state from <samp class="file">pattern</samp>, and specify an output of
size 200x400.
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">cellauto=p=@:s=100x400:full=0:rule=18
</pre></div>
</li><li>Specify a more elaborated initial pattern:
<div class="example">
<pre class="example-preformatted">cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
</pre></div>
</li></ul>
<a class="anchor" id="coreimagesrc"></a></div>
</div>
<div class="section-level-extent" id="coreimagesrc-1">
<h3 class="section">35.3 coreimagesrc</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 class="ref" 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 class="table">
<dt><samp class="option">list_generators</samp></dt>
<dd><p>List all available generators along with all their respective options as well as
possible minimum and maximum values along with the default values.
</p><div class="example">
<pre class="example-preformatted">list_generators=true
</pre></div>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">320x240</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var class="var">frame_rate_num</var>/<var class="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><samp class="option">sar</samp></dt>
<dd><p>Set the sample aspect ratio of the sourced video.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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 class="ref" 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 class="ref" href="#coreimage">coreimage</a> documentation
and examples for details.
</p>
<ul class="mini-toc">
<li><a href="#Examples-164" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-164">
<h4 class="subsection">35.3.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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 class="ref" href="#coreimage">coreimage</a> without the
need for a nullsrc video source.
</p></li></ul>
</div>
</div>
<div class="section-level-extent" id="ddagrab">
<h3 class="section">35.4 ddagrab</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 class="ref" href="#hwdownload">hwdownload</a> is needed for any kind of
software processing.
</p>
<p>It accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">output_idx</samp></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><samp class="option">draw_mouse</samp></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><samp class="option">framerate</samp></dt>
<dd><p>Framerate at which the desktop will be captured.
</p>
<p>Defaults to 30 FPS.
</p>
</dd>
<dt><samp class="option">video_size</samp></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><samp class="option">offset_x</samp></dt>
<dd><p>Horizontal offset of the captured video.
</p>
</dd>
<dt><samp class="option">offset_y</samp></dt>
<dd><p>Vertical offset of the captured video.
</p>
</dd>
<dt><samp class="option">output_fmt</samp></dt>
<dd><p>Desired filter output format.
Defaults to 8 Bit BGRA.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Passes all supported output formats to DDA and returns what DDA decides to use.
</p></dd>
<dt>‘<samp class="samp">8bit</samp>’</dt>
<dt>‘<samp class="samp">bgra</samp>’</dt>
<dd><p>8 Bit formats always work, and DDA will convert to them if neccesary.
</p></dd>
<dt>‘<samp class="samp">10bit</samp>’</dt>
<dt>‘<samp class="samp">x2bgr10</samp>’</dt>
<dd><p>Filter initialization will fail if 10 bit format is requested but unavailable.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-165" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-165">
<h4 class="subsection">35.4.1 Examples</h4>
<p>Capture primary screen and encode using nvenc:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">ddagrab=video_size=800x600:offset_x=100:offset_y=100
</pre></div>
</div>
</div>
<div class="section-level-extent" id="gradients">
<h3 class="section">35.5 gradients</h3>
<p>Generate several gradients.
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">c0, c1, c2, c3, c4, c5, c6, c7</samp></dt>
<dd><p>Set 8 colors. Default values for colors is to pick random one.
</p>
</dd>
<dt><samp class="option">x0, y0, y0, y1</samp></dt>
<dd><p>Set gradient line source and destination points. If negative or out of range, random ones
are picked.
</p>
</dd>
<dt><samp class="option">nb_colors, n</samp></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><samp class="option">seed</samp></dt>
<dd><p>Set seed for picking gradient line points.
</p>
</dd>
<dt><samp class="option">duration, d</samp></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><samp class="option">speed</samp></dt>
<dd><p>Set speed of gradients rotation.
</p>
</dd>
<dt><samp class="option">type, t</samp></dt>
<dd><p>Set type of gradients, can be <code class="code">linear</code> or <code class="code">radial</code> or <code class="code">circular</code> or <code class="code">spiral</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="mandelbrot">
<h3 class="section">35.6 mandelbrot</h3>
<p>Generate a Mandelbrot set fractal, and progressively zoom towards the
point specified with <var class="var">start_x</var> and <var class="var">start_y</var>.
</p>
<p>This source accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">end_pts</samp></dt>
<dd><p>Set the terminal pts value. Default value is 400.
</p>
</dd>
<dt><samp class="option">end_scale</samp></dt>
<dd><p>Set the terminal scale value.
Must be a floating point value. Default value is 0.3.
</p>
</dd>
<dt><samp class="option">inner</samp></dt>
<dd><p>Set the inner coloring mode, that is the algorithm used to draw the
Mandelbrot fractal internal region.
</p>
<p>It shall assume one of the following values:
</p><dl class="table">
<dt><samp class="option">black</samp></dt>
<dd><p>Set black mode.
</p></dd>
<dt><samp class="option">convergence</samp></dt>
<dd><p>Show time until convergence.
</p></dd>
<dt><samp class="option">mincol</samp></dt>
<dd><p>Set color based on point closest to the origin of the iterations.
</p></dd>
<dt><samp class="option">period</samp></dt>
<dd><p>Set period mode.
</p></dd>
</dl>
<p>Default value is <var class="var">mincol</var>.
</p>
</dd>
<dt><samp class="option">bailout</samp></dt>
<dd><p>Set the bailout value. Default value is 10.0.
</p>
</dd>
<dt><samp class="option">maxiter</samp></dt>
<dd><p>Set the maximum of iterations performed by the rendering
algorithm. Default value is 7189.
</p>
</dd>
<dt><samp class="option">outer</samp></dt>
<dd><p>Set outer coloring mode.
It shall assume one of following values:
</p><dl class="table">
<dt><samp class="option">iteration_count</samp></dt>
<dd><p>Set iteration count mode.
</p></dd>
<dt><samp class="option">normalized_iteration_count</samp></dt>
<dd><p>set normalized iteration count mode.
</p></dd>
</dl>
<p>Default value is <var class="var">normalized_iteration_count</var>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">size, s</samp></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><samp class="option">start_scale</samp></dt>
<dd><p>Set the initial scale value. Default value is 3.0.
</p>
</dd>
<dt><samp class="option">start_x</samp></dt>
<dd><p>Set the initial x position. Must be a floating point value between
-100 and 100. Default value is -0.743643887037158704752191506114774.
</p>
</dd>
<dt><samp class="option">start_y</samp></dt>
<dd><p>Set the initial y position. Must be a floating point value between
-100 and 100. Default value is -0.131825904205311970493132056385139.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="mptestsrc">
<h3 class="section">35.7 mptestsrc</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 class="table">
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var class="var">frame_rate_num</var>/<var class="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><samp class="option">duration, d</samp></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><samp class="option">test, t</samp></dt>
<dd>
<p>Set the number or the name of the test to perform. Supported tests are:
</p><dl class="table">
<dt><samp class="option">dc_luma</samp></dt>
<dt><samp class="option">dc_chroma</samp></dt>
<dt><samp class="option">freq_luma</samp></dt>
<dt><samp class="option">freq_chroma</samp></dt>
<dt><samp class="option">amp_luma</samp></dt>
<dt><samp class="option">amp_chroma</samp></dt>
<dt><samp class="option">cbp</samp></dt>
<dt><samp class="option">mv</samp></dt>
<dt><samp class="option">ring1</samp></dt>
<dt><samp class="option">ring2</samp></dt>
<dt><samp class="option">all</samp></dt>
<dt><samp class="option">max_frames, m</samp></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-preformatted">mptestsrc=t=dc_luma
</pre></div>
<p>will generate a "dc_luma" test pattern.
</p>
</div>
<div class="section-level-extent" id="frei0r_005fsrc">
<h3 class="section">35.8 frei0r_src</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 class="code">--enable-frei0r</code>.
</p>
<p>This source accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">size</samp></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><samp class="option">framerate</samp></dt>
<dd><p>The framerate of the generated video. It may be a string of the form
<var class="var">num</var>/<var class="var">den</var> or a frame rate abbreviation.
</p>
</dd>
<dt><samp class="option">filter_name</samp></dt>
<dd><p>The name to the frei0r source to load. For more information regarding frei0r and
how to set the parameters, read the <a class="ref" href="#frei0r">frei0r</a> section in the video filters
documentation.
</p>
</dd>
<dt><samp class="option">filter_params</samp></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-preformatted">frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
</pre></div>
</div>
<div class="section-level-extent" id="life">
<h3 class="section">35.9 life</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 class="option">rule</samp> option allows one to specify
the rule to adopt.
</p>
<p>This source accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">filename, f</samp></dt>
<dd><p>Set the file from which to read the initial grid state. In the file,
each non-whitespace character is considered an alive cell, and newline
is used to delimit the end of each row.
</p>
<p>If this option is not specified, the initial grid is generated
randomly.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the video rate, that is the number of frames generated per second.
Default is 25.
</p>
</dd>
<dt><samp class="option">random_fill_ratio, ratio</samp></dt>
<dd><p>Set the random fill ratio for the initial random grid. It is a
floating point number value ranging from 0 to 1, defaults to 1/PHI.
It is ignored when a file is specified.
</p>
</dd>
<dt><samp class="option">random_seed, seed</samp></dt>
<dd><p>Set the seed for filling the initial random grid, must be an integer
included between 0 and UINT32_MAX. If not specified, or if explicitly
set to -1, the filter will try to use a good random seed on a best
effort basis.
</p>
</dd>
<dt><samp class="option">rule</samp></dt>
<dd><p>Set the life rule.
</p>
<p>A rule can be specified with a code of the kind "S<var class="var">NS</var>/B<var class="var">NB</var>",
where <var class="var">NS</var> and <var class="var">NB</var> are sequences of numbers in the range 0-8,
<var class="var">NS</var> specifies the number of alive neighbor cells which make a
live cell stay alive, and <var class="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 class="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><samp class="option">size, s</samp></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 class="option">filename</samp> is specified, the size is set by default to the
same size of the input file. If <samp class="option">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><samp class="option">stitch</samp></dt>
<dd><p>If set to 1, stitch the left and right grid edges together, and the
top and bottom edges also. Defaults to 1.
</p>
</dd>
<dt><samp class="option">mold</samp></dt>
<dd><p>Set cell mold speed. If set, a dead cell will go from <samp class="option">death_color</samp> to
<samp class="option">mold_color</samp> with a step of <samp class="option">mold</samp>. <samp class="option">mold</samp> can have a
value from 0 to 255.
</p>
</dd>
<dt><samp class="option">life_color</samp></dt>
<dd><p>Set the color of living (or new born) cells.
</p>
</dd>
<dt><samp class="option">death_color</samp></dt>
<dd><p>Set the color of dead cells. If <samp class="option">mold</samp> is set, this is the first color
used to represent a dead cell.
</p>
</dd>
<dt><samp class="option">mold_color</samp></dt>
<dd><p>Set mold color, for definitely dead and moldy cells.
</p>
<p>For the syntax of these 3 color options, check the <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#color-syntax">(ffmpeg-utils)"Color" section in the
ffmpeg-utils manual</a>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-166" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-166">
<h4 class="subsection">35.9.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Read a grid from <samp class="file">pattern</samp>, and center it on a grid of size
300x300 pixels:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">life=rule=S14/B34
</pre></div>
</li><li>Full example with slow death effect (mold) using <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
</pre></div>
</li></ul>
<a class="anchor" id="allrgb"></a><a class="anchor" id="allyuv"></a><a class="anchor" id="color"></a><a class="anchor" id="colorchart"></a><a class="anchor" id="colorspectrum"></a><a class="anchor" id="haldclutsrc"></a><a class="anchor" id="nullsrc"></a><a class="anchor" id="pal75bars"></a><a class="anchor" id="pal100bars"></a><a class="anchor" id="rgbtestsrc"></a><a class="anchor" id="smptebars"></a><a class="anchor" id="smptehdbars"></a><a class="anchor" id="testsrc"></a><a class="anchor" id="testsrc2"></a><a class="anchor" id="yuvtestsrc"></a></div>
</div>
<div class="section-level-extent" id="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">
<h3 class="section">35.10 allrgb, allyuv, color, colorchart, colorspectrum, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc</h3>
<p>The <code class="code">allrgb</code> source returns frames of size 4096x4096 of all rgb colors.
</p>
<p>The <code class="code">allyuv</code> source returns frames of size 4096x4096 of all yuv colors.
</p>
<p>The <code class="code">color</code> source provides an uniformly colored input.
</p>
<p>The <code class="code">colorchart</code> source provides a colors checker chart.
</p>
<p>The <code class="code">colorspectrum</code> source provides a color spectrum input.
</p>
<p>The <code class="code">haldclutsrc</code> source provides an identity Hald CLUT. See also
<a class="ref" href="#haldclut">haldclut</a> filter.
</p>
<p>The <code class="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 class="code">pal75bars</code> source generates a color bars pattern, based on
EBU PAL recommendations with 75% color levels.
</p>
<p>The <code class="code">pal100bars</code> source generates a color bars pattern, based on
EBU PAL recommendations with 100% color levels.
</p>
<p>The <code class="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 class="code">smptebars</code> source generates a color bars pattern, based on
the SMPTE Engineering Guideline EG 1-1990.
</p>
<p>The <code class="code">smptehdbars</code> source generates a color bars pattern, based on
the SMPTE RP 219-2002.
</p>
<p>The <code class="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 class="code">testsrc2</code> source is similar to testsrc, but supports more
pixel formats instead of just <code class="code">rgb24</code>. This allows using it as an
input for other tests without requiring a format conversion.
</p>
<p>The <code class="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 class="table">
<dt><samp class="option">level</samp></dt>
<dd><p>Specify the level of the Hald CLUT, only available in the <code class="code">haldclutsrc</code>
source. A level of <code class="code">N</code> generates a picture of <code class="code">N*N*N</code> by <code class="code">N*N*N</code>
pixels to be used as identity matrix for 3D lookup tables. Each component is
coded on a <code class="code">1/(N*N)</code> scale.
</p>
</dd>
<dt><samp class="option">color, c</samp></dt>
<dd><p>Specify the color of the source, only available in the <code class="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><samp class="option">size, s</samp></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 class="code">320x240</code>.
</p>
<p>This option is not available with the <code class="code">allrgb</code>, <code class="code">allyuv</code>, and
<code class="code">haldclutsrc</code> filters.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Specify the frame rate of the sourced video, as the number of frames
generated per second. It has to be a string in the format
<var class="var">frame_rate_num</var>/<var class="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><samp class="option">duration, d</samp></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><samp class="option">sar</samp></dt>
<dd><p>Set the sample aspect ratio of the sourced video.
</p>
</dd>
<dt><samp class="option">alpha</samp></dt>
<dd><p>Specify the alpha (opacity) of the background, only available in the
<code class="code">testsrc2</code> source. The value must be between 0 (fully transparent) and
255 (fully opaque, the default).
</p>
</dd>
<dt><samp class="option">decimals, n</samp></dt>
<dd><p>Set the number of decimals to show in the timestamp, only available in the
<code class="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><samp class="option">type</samp></dt>
<dd><p>Set the type of the color spectrum, only available in the
<code class="code">colorspectrum</code> source. Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">black</samp>’</dt>
<dt>‘<samp class="samp">white</samp>’</dt>
<dt>‘<samp class="samp">all</samp>’</dt>
</dl>
</dd>
<dt><samp class="option">patch_size</samp></dt>
<dd><p>Set patch size of single color patch, only available in the
<code class="code">colorchart</code> source. Default is <code class="code">64x64</code>.
</p>
</dd>
<dt><samp class="option">preset</samp></dt>
<dd><p>Set colorchecker colors preset, only available in the
<code class="code">colorchart</code> source.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">reference</samp>’</dt>
<dt>‘<samp class="samp">skintones</samp>’</dt>
</dl>
<p>Default value is <code class="code">reference</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-167" accesskey="1">Examples</a></li>
<li><a href="#Commands-157" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-167">
<h4 class="subsection">35.10.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">color=c=red@0.2:s=qcif:r=10
</pre></div>
</li><li>If the input content is to be ignored, <code class="code">nullsrc</code> can be used. The
following command generates noise in the luma plane by employing
the <code class="code">geq</code> filter:
<div class="example">
<pre class="example-preformatted">nullsrc=s=256x256, geq=random(1)*255:128:128
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-157">
<h4 class="subsection">35.10.2 Commands</h4>
<p>The <code class="code">color</code> source supports the following commands:
</p>
<dl class="table">
<dt><samp class="option">c, color</samp></dt>
<dd><p>Set the color of the created image. Accepts the same syntax of the
corresponding <samp class="option">color</samp> option.
</p></dd>
</dl>
</div>
</div>
<div class="section-level-extent" id="openclsrc">
<h3 class="section">35.11 openclsrc</h3>
<p>Generate video using an OpenCL program.
</p>
<dl class="table">
<dt><samp class="option">source</samp></dt>
<dd><p>OpenCL program source file.
</p>
</dd>
<dt><samp class="option">kernel</samp></dt>
<dd><p>Kernel name in program.
</p>
</dd>
<dt><samp class="option">size, s</samp></dt>
<dd><p>Size of frames to generate. This must be set.
</p>
</dd>
<dt><samp class="option">format</samp></dt>
<dd><p>Pixel format to use for the generated frames. This must be set.
</p>
</dd>
<dt><samp class="option">rate, r</samp></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 class="ref" href="#program_005fopencl">program_opencl</a>
filter.
</p>
<p>Example programs:
</p>
<ul class="itemize mark-bullet">
<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>
</div>
<div class="section-level-extent" id="sierpinski">
<h3 class="section">35.12 sierpinski</h3>
<p>Generate a Sierpinski carpet/triangle fractal, and randomly pan around.
</p>
<p>This source accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">seed</samp></dt>
<dd><p>Set seed which is used for random panning.
</p>
</dd>
<dt><samp class="option">jump</samp></dt>
<dd><p>Set max jump for single pan destination. Allowed range is from 1 to 10000.
</p>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set fractal type, can be default <code class="code">carpet</code> or <code class="code">triangle</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="zoneplate">
<h3 class="section">35.13 zoneplate</h3>
<p>Generate a zoneplate test video pattern.
</p>
<p>This source accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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 "320x240".
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">duration, d</samp></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><samp class="option">sar</samp></dt>
<dd><p>Set the sample aspect ratio of the sourced video.
</p>
</dd>
<dt><samp class="option">precision</samp></dt>
<dd><p>Set precision in bits for look-up table for sine calculations. Default value is 10.
Allowed range is from 4 to 16.
</p>
</dd>
<dt><samp class="option">xo</samp></dt>
<dd><p>Set horizontal axis offset for output signal. Default value is 0.
</p>
</dd>
<dt><samp class="option">yo</samp></dt>
<dd><p>Set vertical axis offset for output signal. Default value is 0.
</p>
</dd>
<dt><samp class="option">to</samp></dt>
<dd><p>Set time axis offset for output signal. Default value is 0.
</p>
</dd>
<dt><samp class="option">k0</samp></dt>
<dd><p>Set 0-order, constant added to signal phase. Default value is 0.
</p>
</dd>
<dt><samp class="option">kx</samp></dt>
<dd><p>Set 1-order, phase factor multiplier for horizontal axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">ky</samp></dt>
<dd><p>Set 1-order, phase factor multiplier for vertical axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">kt</samp></dt>
<dd><p>Set 1-order, phase factor multiplier for time axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">kxt, kyt, kxy</samp></dt>
<dd><p>Set phase factor multipliers for combination of spatial and temporal axis.
Default value is 0.
</p>
</dd>
<dt><samp class="option">kx2</samp></dt>
<dd><p>Set 2-order, phase factor multiplier for horizontal axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">ky2</samp></dt>
<dd><p>Set 2-order, phase factor multiplier for vertical axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">kt2</samp></dt>
<dd><p>Set 2-order, phase factor multiplier for time axis. Default value is 0.
</p>
</dd>
<dt><samp class="option">ku</samp></dt>
<dd><p>Set the constant added to final phase to produce chroma-blue component of signal.
Default value is 0.
</p>
</dd>
<dt><samp class="option">kv</samp></dt>
<dd><p>Set the constant added to final phase to produce chroma-red component of signal.
Default value is 0.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-158" accesskey="1">Commands</a></li>
<li><a href="#Examples-168" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-158">
<h4 class="subsection">35.13.1 Commands</h4>
<p>This source supports the some above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
<div class="subsection-level-extent" id="Examples-168">
<h4 class="subsection">35.13.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Generate horizontal color sine sweep:
<div class="example">
<pre class="example-preformatted">zoneplate=ku=512:kv=0:kt2=0:kx2=256:s=wvga:xo=-426:kt=11
</pre></div>
</li><li>Generate vertical color sine sweep:
<div class="example">
<pre class="example-preformatted">zoneplate=ku=512:kv=0:kt2=0:ky2=156:s=wvga:yo=-240:kt=11
</pre></div>
</li><li>Generate circular zone-plate:
<div class="example">
<pre class="example-preformatted">zoneplate=ku=512:kv=100:kt2=0:ky2=256:kx2=556:s=wvga:yo=0:kt=11
</pre></div>
</li></ul>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Video-Sinks">
<h2 class="chapter">36 Video Sinks</h2>
<p>Below is a description of the currently available video sinks.
</p>
<ul class="mini-toc">
<li><a href="#buffersink" accesskey="1">buffersink</a></li>
<li><a href="#nullsink" accesskey="2">nullsink</a></li>
</ul>
<div class="section-level-extent" id="buffersink">
<h3 class="section">36.1 buffersink</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 class="file">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 class="code">avfilter_init_filter</code> for initialization.
</p>
</div>
<div class="section-level-extent" id="nullsink">
<h3 class="section">36.2 nullsink</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>
</div>
</div>
<div class="chapter-level-extent" id="Multimedia-Filters">
<h2 class="chapter">37 Multimedia Filters</h2>
<p>Below is a description of the currently available multimedia filters.
</p>
<ul class="mini-toc">
<li><a href="#a3dscope" accesskey="1">a3dscope</a></li>
<li><a href="#abitscope" accesskey="2">abitscope</a></li>
<li><a href="#adrawgraph" accesskey="3">adrawgraph</a></li>
<li><a href="#agraphmonitor" accesskey="4">agraphmonitor</a></li>
<li><a href="#ahistogram" accesskey="5">ahistogram</a></li>
<li><a href="#aphasemeter" accesskey="6">aphasemeter</a></li>
<li><a href="#avectorscope" accesskey="7">avectorscope</a></li>
<li><a href="#bench_002c-abench" accesskey="8">bench, abench</a></li>
<li><a href="#concat-3" accesskey="9">concat</a></li>
<li><a href="#ebur128-1">ebur128</a></li>
<li><a href="#interleave_002c-ainterleave">interleave, ainterleave</a></li>
<li><a href="#latency_002c-alatency">latency, alatency</a></li>
<li><a href="#metadata_002c-ametadata">metadata, ametadata</a></li>
<li><a href="#perms_002c-aperms">perms, aperms</a></li>
<li><a href="#realtime_002c-arealtime">realtime, arealtime</a></li>
<li><a href="#segment_002c-asegment">segment, asegment</a></li>
<li><a href="#select_002c-aselect">select, aselect</a></li>
<li><a href="#sendcmd_002c-asendcmd">sendcmd, asendcmd</a></li>
<li><a href="#setpts_002c-asetpts">setpts, asetpts</a></li>
<li><a href="#setrange">setrange</a></li>
<li><a href="#settb_002c-asettb">settb, asettb</a></li>
<li><a href="#showcqt">showcqt</a></li>
<li><a href="#showcwt">showcwt</a></li>
<li><a href="#showfreqs">showfreqs</a></li>
<li><a href="#showspatial">showspatial</a></li>
<li><a href="#showspectrum-1">showspectrum</a></li>
<li><a href="#showspectrumpic">showspectrumpic</a></li>
<li><a href="#showvolume">showvolume</a></li>
<li><a href="#showwaves">showwaves</a></li>
<li><a href="#showwavespic">showwavespic</a></li>
<li><a href="#sidedata_002c-asidedata">sidedata, asidedata</a></li>
<li><a href="#spectrumsynth">spectrumsynth</a></li>
<li><a href="#split_002c-asplit">split, asplit</a></li>
<li><a href="#zmq_002c-azmq">zmq, azmq</a></li>
</ul>
<div class="section-level-extent" id="a3dscope">
<h3 class="section">37.1 a3dscope</h3>
<p>Convert input audio to 3d scope video output.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">hd720</code>.
</p>
</dd>
<dt><samp class="option">fov</samp></dt>
<dd><p>Set the camera field of view. Default is 90 degrees.
Allowed range is from 40 to 150.
</p>
</dd>
<dt><samp class="option">roll</samp></dt>
<dd><p>Set the camera roll.
</p>
</dd>
<dt><samp class="option">pitch</samp></dt>
<dd><p>Set the camera pitch.
</p>
</dd>
<dt><samp class="option">yaw</samp></dt>
<dd><p>Set the camera yaw.
</p>
</dd>
<dt><samp class="option">xzoom</samp></dt>
<dd><p>Set the camera zoom on X-axis.
</p>
</dd>
<dt><samp class="option">yzoom</samp></dt>
<dd><p>Set the camera zoom on Y-axis.
</p>
</dd>
<dt><samp class="option">zzoom</samp></dt>
<dd><p>Set the camera zoom on Z-axis.
</p>
</dd>
<dt><samp class="option">xpos</samp></dt>
<dd><p>Set the camera position on X-axis.
</p>
</dd>
<dt><samp class="option">ypos</samp></dt>
<dd><p>Set the camera position on Y-axis.
</p>
</dd>
<dt><samp class="option">zpos</samp></dt>
<dd><p>Set the camera position on Z-axis.
</p>
</dd>
<dt><samp class="option">length</samp></dt>
<dd><p>Set the length of displayed audio waves in number of frames.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-159" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-159">
<h4 class="subsection">37.1.1 Commands</h4>
<p>Filter supports the some above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="abitscope">
<h3 class="section">37.2 abitscope</h3>
<p>Convert input audio to a video output, displaying the audio bit scope.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">1024x256</code>.
</p>
</dd>
<dt><samp class="option">colors</samp></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><samp class="option">mode, m</samp></dt>
<dd><p>Set output mode. Can be <code class="code">bars</code> or <code class="code">trace</code>. Default is <code class="code">bars</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="adrawgraph">
<h3 class="section">37.3 adrawgraph</h3>
<p>Draw a graph using input audio metadata.
</p>
<p>See <a class="ref" href="#drawgraph">drawgraph</a>
</p>
</div>
<div class="section-level-extent" id="agraphmonitor">
<h3 class="section">37.4 agraphmonitor</h3>
<p>See <a class="ref" href="#graphmonitor">graphmonitor</a>.
</p>
</div>
<div class="section-level-extent" id="ahistogram">
<h3 class="section">37.5 ahistogram</h3>
<p>Convert input audio to a video output, displaying the volume histogram.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">dmode</samp></dt>
<dd><p>Specify how histogram is calculated.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">single</samp>’</dt>
<dd><p>Use single histogram for all channels.
</p></dd>
<dt>‘<samp class="samp">separate</samp>’</dt>
<dd><p>Use separate histogram for each channel.
</p></dd>
</dl>
<p>Default is <code class="code">single</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set frame rate, expressed as number of frames per second. Default
value is "25".
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">hd720</code>.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set display scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>square root
</p></dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>cubic root
</p></dd>
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
<dt>‘<samp class="samp">rlog</samp>’</dt>
<dd><p>reverse logarithmic
</p></dd>
</dl>
<p>Default is <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">ascale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
</dl>
<p>Default is <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">acount</samp></dt>
<dd><p>Set how much frames to accumulate in histogram.
Default is 1. Setting this to -1 accumulates all frames.
</p>
</dd>
<dt><samp class="option">rheight</samp></dt>
<dd><p>Set histogram ratio of window height.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Set sonogram sliding.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">replace</samp>’</dt>
<dd><p>replace old rows with new ones.
</p></dd>
<dt>‘<samp class="samp">scroll</samp>’</dt>
<dd><p>scroll from top to bottom.
</p></dd>
</dl>
<p>Default is <code class="code">replace</code>.
</p>
</dd>
<dt><samp class="option">hmode</samp></dt>
<dd><p>Set histogram mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">abs</samp>’</dt>
<dd><p>Use absolute values of samples.
</p></dd>
<dt>‘<samp class="samp">sign</samp>’</dt>
<dd><p>Use untouched values of samples.
</p></dd>
</dl>
<p>Default is <code class="code">abs</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="aphasemeter">
<h3 class="section">37.6 aphasemeter</h3>
<p>Measures phase of input audio, which is exported as metadata <code class="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 class="code">[-1, 1]</code> where <code class="code">-1</code> means left and right channels are completely out of phase
and <code class="code">1</code> means channels are in phase.
</p>
<p>The filter accepts the following options, all related to its video output:
</p>
<dl class="table">
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">800x400</code>.
</p>
</dd>
<dt><samp class="option">rc</samp></dt>
<dt><samp class="option">gc</samp></dt>
<dt><samp class="option">bc</samp></dt>
<dd><p>Specify the red, green, blue contrast. Default values are <code class="code">2</code>,
<code class="code">7</code> and <code class="code">1</code>.
Allowed range is <code class="code">[0, 255]</code>.
</p>
</dd>
<dt><samp class="option">mpc</samp></dt>
<dd><p>Set color which will be used for drawing median phase. If color is
<code class="code">none</code> which is default, no median phase value will be drawn.
</p>
</dd>
<dt><samp class="option">video</samp></dt>
<dd><p>Enable video output. Default is enabled.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#phasing-detection" accesskey="1">phasing detection</a></li>
<li><a href="#Examples-169" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="phasing-detection">
<h4 class="subsection">37.6.1 phasing detection</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 class="table">
<dt><samp class="option">phasing</samp></dt>
<dd><p>Enable mono and out of phase detection. Default is disabled.
</p>
</dd>
<dt><samp class="option">tolerance, t</samp></dt>
<dd><p>Set phase tolerance for mono detection, in amplitude ratio. Default is <code class="code">0</code>.
Allowed range is <code class="code">[0, 1]</code>.
</p>
</dd>
<dt><samp class="option">angle, a</samp></dt>
<dd><p>Set angle threshold for out of phase detection, in degree. Default is <code class="code">170</code>.
Allowed range is <code class="code">[90, 180]</code>.
</p>
</dd>
<dt><samp class="option">duration, d</samp></dt>
<dd><p>Set mono or out of phase duration until notification, expressed in seconds. Default is <code class="code">2</code>.
</p></dd>
</dl>
</div>
<div class="subsection-level-extent" id="Examples-169">
<h4 class="subsection">37.6.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Complete example with <code class="command">ffmpeg</code> to detect 1 second of mono with 0.001 phase tolerance:
<div class="example">
<pre class="example-preformatted">ffmpeg -i stereo.wav -af aphasemeter=video=0:phasing=1:duration=1:tolerance=0.001 -f null -
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="avectorscope">
<h3 class="section">37.7 avectorscope</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 class="table">
<dt><samp class="option">mode, m</samp></dt>
<dd><p>Set the vectorscope mode.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">lissajous</samp>’</dt>
<dd><p>Lissajous rotated by 45 degrees.
</p>
</dd>
<dt>‘<samp class="samp">lissajous_xy</samp>’</dt>
<dd><p>Same as above but not rotated.
</p>
</dd>
<dt>‘<samp class="samp">polar</samp>’</dt>
<dd><p>Shape resembling half of circle.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">lissajous</samp>’.
</p>
</dd>
<dt><samp class="option">size, s</samp></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 class="code">400x400</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">rc</samp></dt>
<dt><samp class="option">gc</samp></dt>
<dt><samp class="option">bc</samp></dt>
<dt><samp class="option">ac</samp></dt>
<dd><p>Specify the red, green, blue and alpha contrast. Default values are <code class="code">40</code>,
<code class="code">160</code>, <code class="code">80</code> and <code class="code">255</code>.
Allowed range is <code class="code">[0, 255]</code>.
</p>
</dd>
<dt><samp class="option">rf</samp></dt>
<dt><samp class="option">gf</samp></dt>
<dt><samp class="option">bf</samp></dt>
<dt><samp class="option">af</samp></dt>
<dd><p>Specify the red, green, blue and alpha fade. Default values are <code class="code">15</code>,
<code class="code">10</code>, <code class="code">5</code> and <code class="code">5</code>.
Allowed range is <code class="code">[0, 255]</code>.
</p>
</dd>
<dt><samp class="option">zoom</samp></dt>
<dd><p>Set the zoom factor. Default value is <code class="code">1</code>. Allowed range is <code class="code">[0, 10]</code>.
Values lower than <var class="var">1</var> will auto adjust zoom factor to maximal possible value.
</p>
</dd>
<dt><samp class="option">draw</samp></dt>
<dd><p>Set the vectorscope drawing mode.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">dot</samp>’</dt>
<dd><p>Draw dot for each sample.
</p>
</dd>
<dt>‘<samp class="samp">line</samp>’</dt>
<dd><p>Draw line between previous and current sample.
</p>
</dd>
<dt>‘<samp class="samp">aaline</samp>’</dt>
<dd><p>Draw anti-aliased line between previous and current sample.
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">dot</samp>’.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Specify amplitude scale of audio samples.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>Linear.
</p>
</dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>Square root.
</p>
</dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>Cubic root.
</p>
</dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>Logarithmic.
</p></dd>
</dl>
</dd>
<dt><samp class="option">swap</samp></dt>
<dd><p>Swap left channel axis with right channel axis.
</p>
</dd>
<dt><samp class="option">mirror</samp></dt>
<dd><p>Mirror axis.
</p>
<dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>No mirror.
</p>
</dd>
<dt>‘<samp class="samp">x</samp>’</dt>
<dd><p>Mirror only x axis.
</p>
</dd>
<dt>‘<samp class="samp">y</samp>’</dt>
<dd><p>Mirror only y axis.
</p>
</dd>
<dt>‘<samp class="samp">xy</samp>’</dt>
<dd><p>Mirror both axis.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-170" accesskey="1">Examples</a></li>
<li><a href="#Commands-160" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-170">
<h4 class="subsection">37.7.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Complete example using <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-160">
<h4 class="subsection">37.7.2 Commands</h4>
<p>This filter supports the all above options as commands except options <code class="code">size</code> and <code class="code">rate</code>.
</p>
</div>
</div>
<div class="section-level-extent" id="bench_002c-abench">
<h3 class="section">37.8 bench, abench</h3>
<p>Benchmark part of a filtergraph.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">action</samp></dt>
<dd><p>Start or stop a timer.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">start</samp>’</dt>
<dd><p>Get the current time, set it as frame metadata (using the key
<code class="code">lavfi.bench.start_time</code>), and forward the frame to the next filter.
</p>
</dd>
<dt>‘<samp class="samp">stop</samp>’</dt>
<dd><p>Get the current time and fetch the <code class="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 class="code">t</code>, <code class="code">avg</code>, <code class="code">max</code> and
<code class="code">min</code>) are then printed. The timestamps are expressed in seconds.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-171" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-171">
<h4 class="subsection">37.8.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Benchmark <a class="ref" href="#selectivecolor">selectivecolor</a> filter:
<div class="example">
<pre class="example-preformatted">bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="concat-3">
<h3 class="section">37.9 concat</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 class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>Set the number of segments. Default is 2.
</p>
</dd>
<dt><samp class="option">v</samp></dt>
<dd><p>Set the number of output video streams, that is also the number of video
streams in each segment. Default is 1.
</p>
</dd>
<dt><samp class="option">a</samp></dt>
<dd><p>Set the number of output audio streams, that is also the number of audio
streams in each segment. Default is 0.
</p>
</dd>
<dt><samp class="option">unsafe</samp></dt>
<dd><p>Activate unsafe mode: do not fail if segments have a different format.
</p>
</dd>
</dl>
<p>The filter has <var class="var">v</var>+<var class="var">a</var> outputs: first <var class="var">v</var> video outputs, then
<var class="var">a</var> audio outputs.
</p>
<p>There are <var class="var">n</var>x(<var class="var">v</var>+<var class="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>
<ul class="mini-toc">
<li><a href="#Examples-172" accesskey="1">Examples</a></li>
<li><a href="#Commands-161" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-172">
<h4 class="subsection">37.9.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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>
</div>
<div class="subsection-level-extent" id="Commands-161">
<h4 class="subsection">37.9.2 Commands</h4>
<p>This filter supports the following commands:
</p><dl class="table">
<dt><samp class="option">next</samp></dt>
<dd><p>Close the current segment and step to the next one
</p></dd>
</dl>
<a class="anchor" id="ebur128"></a></div>
</div>
<div class="section-level-extent" id="ebur128-1">
<h3 class="section">37.10 ebur128</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 class="code">M</code>), Short-term loudness (<code class="code">S</code>),
Integrated loudness (<code class="code">I</code>) and Loudness Range (<code class="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 class="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 class="var">gauge</var>).
</p>
<p>The green area marks a +/- 1LU target range around the target loudness
(-23LUFS by default, unless modified through <var class="var">target</var>).
</p>
<p>More information about the Loudness Recommendation EBU R128 on
<a class="url" href="http://tech.ebu.ch/loudness">http://tech.ebu.ch/loudness</a>.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">video</samp></dt>
<dd><p>Activate the video output. The audio stream is passed unchanged whether this
option is set or no. The video stream will be the first output stream if
activated. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">size</samp></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 class="code">640x480</code>.
</p>
</dd>
<dt><samp class="option">meter</samp></dt>
<dd><p>Set the EBU scale meter. Default is <code class="code">9</code>. Common values are <code class="code">9</code> and
<code class="code">18</code>, respectively for EBU scale meter +9 and EBU scale meter +18. Any
other integer value between this range is allowed.
</p>
</dd>
<dt><samp class="option">metadata</samp></dt>
<dd><p>Set metadata injection. If set to <code class="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 class="code">lavfi.r128.</code>.
</p>
<p>Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">framelog</samp></dt>
<dd><p>Force the frame logging level.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">quiet</samp>’</dt>
<dd><p>logging disabled
</p></dd>
<dt>‘<samp class="samp">info</samp>’</dt>
<dd><p>information logging level
</p></dd>
<dt>‘<samp class="samp">verbose</samp>’</dt>
<dd><p>verbose logging level
</p></dd>
</dl>
<p>By default, the logging level is set to <var class="var">info</var>. If the <samp class="option">video</samp> or
the <samp class="option">metadata</samp> options are set, it switches to <var class="var">verbose</var>.
</p>
</dd>
<dt><samp class="option">peak</samp></dt>
<dd><p>Set peak mode(s).
</p>
<p>Available modes can be cumulated (the option is a <code class="code">flag</code> type). Possible
values are:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Disable any peak mode (default).
</p></dd>
<dt>‘<samp class="samp">sample</samp>’</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 class="code">SPK</code>).
</p></dd>
<dt>‘<samp class="samp">true</samp>’</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 class="code">TPK</code>) and true-peak per frame (identified by <code class="code">FTPK</code>).
This mode requires a build with <code class="code">libswresample</code>.
</p></dd>
</dl>
</dd>
<dt><samp class="option">dualmono</samp></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 class="code">true</code>, this option will compensate for this effect.
Multi-channel input files are not affected by this option.
</p>
</dd>
<dt><samp class="option">panlaw</samp></dt>
<dd><p>Set a specific pan law to be used for the measurement of dual mono files.
This parameter is optional, and has a default value of -3.01dB.
</p>
</dd>
<dt><samp class="option">target</samp></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><samp class="option">gauge</samp></dt>
<dd><p>Set the value displayed by the gauge. Valid values are <code class="code">momentary</code> and s
<code class="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><samp class="option">scale</samp></dt>
<dd><p>Sets the display scale for the loudness. Valid parameters are <code class="code">absolute</code>
(in LUFS) or <code class="code">relative</code> (LU) relative to the target. This only affects the
video output, not the summary or continuous log output.
</p>
</dd>
<dt><samp class="option">integrated</samp></dt>
<dd><p>Read-only exported value for measured integrated loudness, in LUFS.
</p>
</dd>
<dt><samp class="option">range</samp></dt>
<dd><p>Read-only exported value for measured loudness range, in LU.
</p>
</dd>
<dt><samp class="option">lra_low</samp></dt>
<dd><p>Read-only exported value for measured LRA low, in LUFS.
</p>
</dd>
<dt><samp class="option">lra_high</samp></dt>
<dd><p>Read-only exported value for measured LRA high, in LUFS.
</p>
</dd>
<dt><samp class="option">sample_peak</samp></dt>
<dd><p>Read-only exported value for measured sample peak, in dBFS.
</p>
</dd>
<dt><samp class="option">true_peak</samp></dt>
<dd><p>Read-only exported value for measured true peak, in dBFS.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-173" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-173">
<h4 class="subsection">37.10.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Real-time graph using <code class="command">ffplay</code>, with a EBU scale meter +18:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
</pre></div>
</li><li>Run an analysis with <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="interleave_002c-ainterleave">
<h3 class="section">37.11 interleave, ainterleave</h3>
<p>Temporally interleave frames from several inputs.
</p>
<p><code class="code">interleave</code> works with video inputs, <code class="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 class="code">select</code> filter
which always drops input frames. The <code class="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 class="table">
<dt><samp class="option">nb_inputs, n</samp></dt>
<dd><p>Set the number of different inputs, it is 2 by default.
</p>
</dd>
<dt><samp class="option">duration</samp></dt>
<dd><p>How to determine the end-of-stream.
</p>
<dl class="table">
<dt><samp class="option">longest</samp></dt>
<dd><p>The duration of the longest input. (default)
</p>
</dd>
<dt><samp class="option">shortest</samp></dt>
<dd><p>The duration of the shortest input.
</p>
</dd>
<dt><samp class="option">first</samp></dt>
<dd><p>The duration of the first input.
</p></dd>
</dl>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-174" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-174">
<h4 class="subsection">37.11.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Interleave frames belonging to different streams using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">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-preformatted">select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="latency_002c-alatency">
<h3 class="section">37.12 latency, alatency</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>
</div>
<div class="section-level-extent" id="metadata_002c-ametadata">
<h3 class="section">37.13 metadata, ametadata</h3>
<p>Manipulate frame metadata.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set mode of operation of the filter.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">select</samp>’</dt>
<dd><p>If both <code class="code">value</code> and <code class="code">key</code> is set, select frames
which have such metadata. If only <code class="code">key</code> is set, select
every frame that has such key in metadata.
</p>
</dd>
<dt>‘<samp class="samp">add</samp>’</dt>
<dd><p>Add new metadata <code class="code">key</code> and <code class="code">value</code>. If key is already available
do nothing.
</p>
</dd>
<dt>‘<samp class="samp">modify</samp>’</dt>
<dd><p>Modify value of already present key.
</p>
</dd>
<dt>‘<samp class="samp">delete</samp>’</dt>
<dd><p>If <code class="code">value</code> is set, delete only keys that have such value.
Otherwise, delete key. If <code class="code">key</code> is not set, delete all metadata values in
the frame.
</p>
</dd>
<dt>‘<samp class="samp">print</samp>’</dt>
<dd><p>Print key and its value if metadata was found. If <code class="code">key</code> is not set print all
metadata values available in frame.
</p></dd>
</dl>
</dd>
<dt><samp class="option">key</samp></dt>
<dd><p>Set key used with all modes. Must be set for all modes except <code class="code">print</code> and <code class="code">delete</code>.
</p>
</dd>
<dt><samp class="option">value</samp></dt>
<dd><p>Set metadata value which will be used. This option is mandatory for
<code class="code">modify</code> and <code class="code">add</code> mode.
</p>
</dd>
<dt><samp class="option">function</samp></dt>
<dd><p>Which function to use when comparing metadata value and <code class="code">value</code>.
</p>
<p>Can be one of following:
</p>
<dl class="table">
<dt>‘<samp class="samp">same_str</samp>’</dt>
<dd><p>Values are interpreted as strings, returns true if metadata value is same as <code class="code">value</code>.
</p>
</dd>
<dt>‘<samp class="samp">starts_with</samp>’</dt>
<dd><p>Values are interpreted as strings, returns true if metadata value starts with
the <code class="code">value</code> option string.
</p>
</dd>
<dt>‘<samp class="samp">less</samp>’</dt>
<dd><p>Values are interpreted as floats, returns true if metadata value is less than <code class="code">value</code>.
</p>
</dd>
<dt>‘<samp class="samp">equal</samp>’</dt>
<dd><p>Values are interpreted as floats, returns true if <code class="code">value</code> is equal with metadata value.
</p>
</dd>
<dt>‘<samp class="samp">greater</samp>’</dt>
<dd><p>Values are interpreted as floats, returns true if metadata value is greater than <code class="code">value</code>.
</p>
</dd>
<dt>‘<samp class="samp">expr</samp>’</dt>
<dd><p>Values are interpreted as floats, returns true if expression from option <code class="code">expr</code>
evaluates to true.
</p>
</dd>
<dt>‘<samp class="samp">ends_with</samp>’</dt>
<dd><p>Values are interpreted as strings, returns true if metadata value ends with
the <code class="code">value</code> option string.
</p></dd>
</dl>
</dd>
<dt><samp class="option">expr</samp></dt>
<dd><p>Set expression which is used when <code class="code">function</code> is set to <code class="code">expr</code>.
The expression is evaluated through the eval API and can contain the following
constants:
</p>
<dl class="table">
<dt><samp class="option">VALUE1, FRAMEVAL</samp></dt>
<dd><p>Float representation of <code class="code">value</code> from metadata key.
</p>
</dd>
<dt><samp class="option">VALUE2, USERVAL</samp></dt>
<dd><p>Float representation of <code class="code">value</code> as supplied by user in <code class="code">value</code> option.
</p></dd>
</dl>
</dd>
<dt><samp class="option">file</samp></dt>
<dd><p>If specified in <code class="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 class="code">file</code> option is not set, output is written to the log
with AV_LOG_INFO loglevel.
</p>
</dd>
<dt><samp class="option">direct</samp></dt>
<dd><p>Reduces buffering in print mode when output is written to a URL set using <var class="var">file</var>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-175" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-175">
<h4 class="subsection">37.13.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Print all metadata values for frames with key <code class="code">lavfi.signalstats.YDIF</code> with values
between 0 and 1.
<div class="example">
<pre class="example-preformatted">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 class="file">metadata.txt</samp>.
<div class="example">
<pre class="example-preformatted">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-preformatted">metadata=mode=print:file='pipe\:4'
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="perms_002c-aperms">
<h3 class="section">37.14 perms, aperms</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 class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Select the permissions mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">none</samp>’</dt>
<dd><p>Do nothing. This is the default.
</p></dd>
<dt>‘<samp class="samp">ro</samp>’</dt>
<dd><p>Set all the output frames read-only.
</p></dd>
<dt>‘<samp class="samp">rw</samp>’</dt>
<dd><p>Set all the output frames directly writable.
</p></dd>
<dt>‘<samp class="samp">toggle</samp>’</dt>
<dd><p>Make the frame read-only if writable, and writable if read-only.
</p></dd>
<dt>‘<samp class="samp">random</samp>’</dt>
<dd><p>Set each output frame read-only or writable randomly.
</p></dd>
</dl>
</dd>
<dt><samp class="option">seed</samp></dt>
<dd><p>Set the seed for the <var class="var">random</var> mode, must be an integer included between
<code class="code">0</code> and <code class="code">UINT32_MAX</code>. If not specified, or if explicitly set to
<code class="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 class="ref" href="#format">format</a> or <a class="ref" href="#aformat">aformat</a> filter before the
perms/aperms filter can avoid this problem.
</p>
</div>
<div class="section-level-extent" id="realtime_002c-arealtime">
<h3 class="section">37.15 realtime, arealtime</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 class="option">re</samp> option to <code class="code">ffmpeg</code>.
</p>
<p>They accept the following options:
</p>
<dl class="table">
<dt><samp class="option">limit</samp></dt>
<dd><p>Time limit for the pauses. Any pause longer than that will be considered
a timestamp discontinuity and reset the timer. Default is 2 seconds.
</p></dd>
<dt><samp class="option">speed</samp></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 class="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>
<ul class="mini-toc">
<li><a href="#Commands-162" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-162">
<h4 class="subsection">37.15.1 Commands</h4>
<p>Both filters supports the all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="segment_002c-asegment">
<h3 class="section">37.16 segment, asegment</h3>
<p>Split single input stream into multiple streams.
</p>
<p>This filter does opposite of concat filters.
</p>
<p><code class="code">segment</code> works on video frames, <code class="code">asegment</code> on audio samples.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">timestamps</samp></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><samp class="option">frames, samples</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-176" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-176">
<h4 class="subsection">37.16.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">asegment=timestamps="60|150"
</pre></div>
</li></ul>
<a class="anchor" id="select"></a></div>
</div>
<div class="section-level-extent" id="select_002c-aselect">
<h3 class="section">37.17 select, aselect</h3>
<p>Select frames to pass in output.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">expr, e</samp></dt>
<dd><p>Set expression, which is evaluated for each input frame.
</p>
<p>If the expression is evaluated to zero, the frame is discarded.
</p>
<p>If the evaluation result is negative or NaN, the frame is sent to the
first output; otherwise it is sent to the output with index
<code class="code">ceil(val)-1</code>, assuming that the input index starts from 0.
</p>
<p>For example a value of <code class="code">1.2</code> corresponds to the output with index
<code class="code">ceil(1.2)-1 = 2-1 = 1</code>, that is the second output.
</p>
</dd>
<dt><samp class="option">outputs, n</samp></dt>
<dd><p>Set the number of outputs. The output to which to send the selected
frame is based on the result of the evaluation. Default value is 1.
</p></dd>
</dl>
<p>The expression can contain the following constants:
</p>
<dl class="table">
<dt><samp class="option">n</samp></dt>
<dd><p>The (sequential) number of the filtered frame, starting from 0.
</p>
</dd>
<dt><samp class="option">selected_n</samp></dt>
<dd><p>The (sequential) number of the selected frame, starting from 0.
</p>
</dd>
<dt><samp class="option">prev_selected_n</samp></dt>
<dd><p>The sequential number of the last selected frame. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">TB</samp></dt>
<dd><p>The timebase of the input timestamps.
</p>
</dd>
<dt><samp class="option">pts</samp></dt>
<dd><p>The PTS (Presentation TimeStamp) of the filtered frame,
expressed in <var class="var">TB</var> units. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>The PTS of the filtered frame,
expressed in seconds. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">prev_pts</samp></dt>
<dd><p>The PTS of the previously filtered frame. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">prev_selected_pts</samp></dt>
<dd><p>The PTS of the last previously filtered frame. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">prev_selected_t</samp></dt>
<dd><p>The PTS of the last previously selected frame, expressed in seconds. It’s NAN if undefined.
</p>
</dd>
<dt><samp class="option">start_pts</samp></dt>
<dd><p>The first PTS in the stream which is not NAN. It remains NAN if not found.
</p>
</dd>
<dt><samp class="option">start_t</samp></dt>
<dd><p>The first PTS, in seconds, in the stream which is not NAN. It remains NAN if not found.
</p>
</dd>
<dt><samp class="option">pict_type <em class="emph">(video only)</em></samp></dt>
<dd><p>The type of the filtered frame. It can assume one of the following
values:
</p><dl class="table">
<dt><samp class="option">I</samp></dt>
<dt><samp class="option">P</samp></dt>
<dt><samp class="option">B</samp></dt>
<dt><samp class="option">S</samp></dt>
<dt><samp class="option">SI</samp></dt>
<dt><samp class="option">SP</samp></dt>
<dt><samp class="option">BI</samp></dt>
</dl>
</dd>
<dt><samp class="option">interlace_type <em class="emph">(video only)</em></samp></dt>
<dd><p>The frame interlace type. It can assume one of the following values:
</p><dl class="table">
<dt><samp class="option">PROGRESSIVE</samp></dt>
<dd><p>The frame is progressive (not interlaced).
</p></dd>
<dt><samp class="option">TOPFIRST</samp></dt>
<dd><p>The frame is top-field-first.
</p></dd>
<dt><samp class="option">BOTTOMFIRST</samp></dt>
<dd><p>The frame is bottom-field-first.
</p></dd>
</dl>
</dd>
<dt><samp class="option">consumed_sample_n <em class="emph">(audio only)</em></samp></dt>
<dd><p>the number of selected samples before the current frame
</p>
</dd>
<dt><samp class="option">samples_n <em class="emph">(audio only)</em></samp></dt>
<dd><p>the number of samples in the current frame
</p>
</dd>
<dt><samp class="option">sample_rate <em class="emph">(audio only)</em></samp></dt>
<dd><p>the input sample rate
</p>
</dd>
<dt><samp class="option">key</samp></dt>
<dd><p>This is 1 if the filtered frame is a key-frame, 0 otherwise.
</p>
</dd>
<dt><samp class="option">pos</samp></dt>
<dd><p>the position in the file of the filtered frame, -1 if the information
is not available (e.g. for synthetic video); deprecated, do not use
</p>
</dd>
<dt><samp class="option">scene <em class="emph">(video only)</em></samp></dt>
<dd><p>value between 0 and 1 to indicate a new scene; a low value reflects a low
probability for the current frame to introduce a new scene, while a higher
value means the current frame is more likely to be one (see the example below)
</p>
</dd>
<dt><samp class="option">concatdec_select</samp></dt>
<dd><p>The concat demuxer can select only part of a concat input file by setting an
inpoint and an outpoint, but the output packets may not be entirely contained
in the selected interval. By using this variable, it is possible to skip frames
generated by the concat demuxer which are not exactly contained in the selected
interval.
</p>
<p>This works by comparing the frame pts against the <var class="var">lavf.concat.start_time</var>
and the <var class="var">lavf.concat.duration</var> packet metadata values which are also
present in the decoded frames.
</p>
<p>The <var class="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>
<ul class="mini-toc">
<li><a href="#Examples-177" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-177">
<h4 class="subsection">37.17.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Select all frames in input:
<div class="example">
<pre class="example-preformatted">select
</pre></div>
<p>The example above is the same as:
</p><div class="example">
<pre class="example-preformatted">select=1
</pre></div>
</li><li>Skip all frames:
<div class="example">
<pre class="example-preformatted">select=0
</pre></div>
</li><li>Select only I-frames:
<div class="example">
<pre class="example-preformatted">select='eq(pict_type\,I)'
</pre></div>
</li><li>Select one frame every 100:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">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-preformatted">aselect='gt(samples_n\,100)'
</pre></div>
</li><li>Create a mosaic of the first scenes:
<div class="example">
<pre class="example-preformatted">ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
</pre></div>
<p>Comparing <var class="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-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="sendcmd_002c-asendcmd">
<h3 class="section">37.18 sendcmd, asendcmd</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 class="code">sendcmd</code> must be inserted between two video filters,
<code class="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 class="var">commands</var> option, or in a file specified by the
<var class="var">filename</var> option.
</p>
<p>These filters accept the following options:
</p><dl class="table">
<dt><samp class="option">commands, c</samp></dt>
<dd><p>Set the commands to be read and sent to the other filters.
</p></dd>
<dt><samp class="option">filename, f</samp></dt>
<dd><p>Set the filename of the commands to be read and sent to the other
filters.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-syntax" accesskey="1">Commands syntax</a></li>
<li><a href="#Examples-178" accesskey="2">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-syntax">
<h4 class="subsection">37.18.1 Commands syntax</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-preformatted"><var class="var">START</var>[-<var class="var">END</var>] <var class="var">COMMANDS</var>;
</pre></div>
<p>The time interval is specified by the <var class="var">START</var> and <var class="var">END</var> times.
<var class="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 class="var">START</var>, <var class="var">END</var>), that is when
the time is greater or equal to <var class="var">START</var> and is lesser than
<var class="var">END</var>.
</p>
<p><var class="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-preformatted">[<var class="var">FLAGS</var>] <var class="var">TARGET</var> <var class="var">COMMAND</var> <var class="var">ARG</var>
</pre></div>
<p><var class="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 class="table">
<dt><samp class="option">enter</samp></dt>
<dd><p>The command is sent when the current frame timestamp enters the
specified interval. In other words, the command is sent when the
previous frame timestamp was not in the given interval, and the
current is.
</p>
</dd>
<dt><samp class="option">leave</samp></dt>
<dd><p>The command is sent when the current frame timestamp leaves the
specified interval. In other words, the command is sent when the
previous frame timestamp was in the given interval, and the
current is not.
</p>
</dd>
<dt><samp class="option">expr</samp></dt>
<dd><p>The command <var class="var">ARG</var> is interpreted as expression and result of
expression is passed as <var class="var">ARG</var>.
</p>
<p>The expression is evaluated through the eval API and can contain the following
constants:
</p>
<dl class="table">
<dt><samp class="option">POS</samp></dt>
<dd><p>Original position in the file of the frame, or undefined if undefined
for the current frame. Deprecated, do not use.
</p>
</dd>
<dt><samp class="option">PTS</samp></dt>
<dd><p>The presentation timestamp in input.
</p>
</dd>
<dt><samp class="option">N</samp></dt>
<dd><p>The count of the input frame for video or audio, starting from 0.
</p>
</dd>
<dt><samp class="option">T</samp></dt>
<dd><p>The time in seconds of the current frame.
</p>
</dd>
<dt><samp class="option">TS</samp></dt>
<dd><p>The start time in seconds of the current command interval.
</p>
</dd>
<dt><samp class="option">TE</samp></dt>
<dd><p>The end time in seconds of the current command interval.
</p>
</dd>
<dt><samp class="option">TI</samp></dt>
<dd><p>The interpolated time of the current command interval, TI = (T - TS) / (TE - TS).
</p>
</dd>
<dt><samp class="option">W</samp></dt>
<dd><p>The video frame width.
</p>
</dd>
<dt><samp class="option">H</samp></dt>
<dd><p>The video frame height.
</p></dd>
</dl>
</dd>
</dl>
<p>If <var class="var">FLAGS</var> is not specified, a default value of <code class="code">[enter]</code> is
assumed.
</p>
<p><var class="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 class="var">COMMAND</var> specifies the name of the command for the target filter.
</p>
<p><var class="var">ARG</var> is optional and specifies the optional list of argument for
the given <var class="var">COMMAND</var>.
</p>
<p>Between one interval specification and another, whitespaces, or
sequences of characters starting with <code class="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-preformatted"><var class="var">COMMAND_FLAG</var> ::= "enter" | "leave"
<var class="var">COMMAND_FLAGS</var> ::= <var class="var">COMMAND_FLAG</var> [(+|"|")<var class="var">COMMAND_FLAG</var>]
<var class="var">COMMAND</var> ::= ["[" <var class="var">COMMAND_FLAGS</var> "]"] <var class="var">TARGET</var> <var class="var">COMMAND</var> [<var class="var">ARG</var>]
<var class="var">COMMANDS</var> ::= <var class="var">COMMAND</var> [,<var class="var">COMMANDS</var>]
<var class="var">INTERVAL</var> ::= <var class="var">START</var>[-<var class="var">END</var>] <var class="var">COMMANDS</var>
<var class="var">INTERVALS</var> ::= <var class="var">INTERVAL</var>[;<var class="var">INTERVALS</var>]
</pre></div>
</div>
<div class="subsection-level-extent" id="Examples-178">
<h4 class="subsection">37.18.2 Examples</h4>
<ul class="itemize mark-bullet">
<li>Specify audio tempo change at second 4:
<div class="example">
<pre class="example-preformatted">asendcmd=c='4.0 atempo tempo 1.5',atempo
</pre></div>
</li><li>Target a specific filter instance:
<div class="example">
<pre class="example-preformatted">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-preformatted"># 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 class="file">test.cmd</samp>, can be specified with:
</p><div class="example">
<pre class="example-preformatted">sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
</pre></div>
</li></ul>
<a class="anchor" id="setpts"></a></div>
</div>
<div class="section-level-extent" id="setpts_002c-asetpts">
<h3 class="section">37.19 setpts, asetpts</h3>
<p>Change the PTS (presentation timestamp) of the input frames.
</p>
<p><code class="code">setpts</code> works on video frames, <code class="code">asetpts</code> on audio frames.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">expr</samp></dt>
<dd><p>The expression which is evaluated for each frame to construct its timestamp.
</p>
</dd>
</dl>
<p>The expression is evaluated through the eval API and can contain the following
constants:
</p>
<dl class="table">
<dt><samp class="option">FRAME_RATE, FR</samp></dt>
<dd><p>frame rate, only defined for constant frame-rate video
</p>
</dd>
<dt><samp class="option">PTS</samp></dt>
<dd><p>The presentation timestamp in input
</p>
</dd>
<dt><samp class="option">N</samp></dt>
<dd><p>The count of the input frame for video or the number of consumed samples,
not including the current frame for audio, starting from 0.
</p>
</dd>
<dt><samp class="option">NB_CONSUMED_SAMPLES</samp></dt>
<dd><p>The number of consumed samples, not including the current frame (only
audio)
</p>
</dd>
<dt><samp class="option">NB_SAMPLES, S</samp></dt>
<dd><p>The number of samples in the current frame (only audio)
</p>
</dd>
<dt><samp class="option">SAMPLE_RATE, SR</samp></dt>
<dd><p>The audio sample rate.
</p>
</dd>
<dt><samp class="option">STARTPTS</samp></dt>
<dd><p>The PTS of the first frame.
</p>
</dd>
<dt><samp class="option">STARTT</samp></dt>
<dd><p>the time in seconds of the first frame
</p>
</dd>
<dt><samp class="option">INTERLACED</samp></dt>
<dd><p>State whether the current frame is interlaced.
</p>
</dd>
<dt><samp class="option">T</samp></dt>
<dd><p>the time in seconds of the current frame
</p>
</dd>
<dt><samp class="option">POS</samp></dt>
<dd><p>original position in the file of the frame, or undefined if undefined
for the current frame; deprecated, do not use
</p>
</dd>
<dt><samp class="option">PREV_INPTS</samp></dt>
<dd><p>The previous input PTS.
</p>
</dd>
<dt><samp class="option">PREV_INT</samp></dt>
<dd><p>previous input time in seconds
</p>
</dd>
<dt><samp class="option">PREV_OUTPTS</samp></dt>
<dd><p>The previous output PTS.
</p>
</dd>
<dt><samp class="option">PREV_OUTT</samp></dt>
<dd><p>previous output time in seconds
</p>
</dd>
<dt><samp class="option">RTCTIME</samp></dt>
<dd><p>The wallclock (RTC) time in microseconds. This is deprecated, use time(0)
instead.
</p>
</dd>
<dt><samp class="option">RTCSTART</samp></dt>
<dd><p>The wallclock (RTC) time at the start of the movie in microseconds.
</p>
</dd>
<dt><samp class="option">TB</samp></dt>
<dd><p>The timebase of the input timestamps.
</p>
</dd>
<dt><samp class="option">T_CHANGE</samp></dt>
<dd><p>Time of the first frame after command was applied or time of the first frame if no commands.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-179" accesskey="1">Examples</a></li>
<li><a href="#Commands-163" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-179">
<h4 class="subsection">37.19.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Start counting PTS from zero
<div class="example">
<pre class="example-preformatted">setpts=PTS-STARTPTS
</pre></div>
</li><li>Apply fast motion effect:
<div class="example">
<pre class="example-preformatted">setpts=0.5*PTS
</pre></div>
</li><li>Apply slow motion effect:
<div class="example">
<pre class="example-preformatted">setpts=2.0*PTS
</pre></div>
</li><li>Set fixed rate of 25 frames per second:
<div class="example">
<pre class="example-preformatted">setpts=N/(25*TB)
</pre></div>
</li><li>Set fixed rate 25 fps with some jitter:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
</pre></div>
</li><li>Generate timestamps by counting samples:
<div class="example">
<pre class="example-preformatted">asetpts=N/SR/TB
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-163">
<h4 class="subsection">37.19.2 Commands</h4>
<p>Both filters support all above options as <a class="ref" href="#commands">commands</a>.
</p>
</div>
</div>
<div class="section-level-extent" id="setrange">
<h3 class="section">37.20 setrange</h3>
<p>Force color range for the output video frame.
</p>
<p>The <code class="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 class="table">
<dt><samp class="option">range</samp></dt>
<dd><p>Available values are:
</p>
<dl class="table">
<dt>‘<samp class="samp">auto</samp>’</dt>
<dd><p>Keep the same color range property.
</p>
</dd>
<dt>‘<samp class="samp">unspecified, unknown</samp>’</dt>
<dd><p>Set the color range as unspecified.
</p>
</dd>
<dt>‘<samp class="samp">limited, tv, mpeg</samp>’</dt>
<dd><p>Set the color range as limited.
</p>
</dd>
<dt>‘<samp class="samp">full, pc, jpeg</samp>’</dt>
<dd><p>Set the color range as full.
</p></dd>
</dl>
</dd>
</dl>
</div>
<div class="section-level-extent" id="settb_002c-asettb">
<h3 class="section">37.21 settb, asettb</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 class="table">
<dt><samp class="option">expr, tb</samp></dt>
<dd><p>The expression which is evaluated into the output timebase.
</p>
</dd>
</dl>
<p>The value for <samp class="option">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>
<ul class="mini-toc">
<li><a href="#Examples-180" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-180">
<h4 class="subsection">37.21.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Set the timebase to 1/25:
<div class="example">
<pre class="example-preformatted">settb=expr=1/25
</pre></div>
</li><li>Set the timebase to 1/10:
<div class="example">
<pre class="example-preformatted">settb=expr=0.1
</pre></div>
</li><li>Set the timebase to 1001/1000:
<div class="example">
<pre class="example-preformatted">settb=1+0.001
</pre></div>
</li><li>Set the timebase to 2*intb:
<div class="example">
<pre class="example-preformatted">settb=2*intb
</pre></div>
</li><li>Set the default timebase value:
<div class="example">
<pre class="example-preformatted">settb=AVTB
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="showcqt">
<h3 class="section">37.22 showcqt</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 class="table">
<dt><samp class="option">size, s</samp></dt>
<dd><p>Specify the video size for the output. It must be even. For the syntax of this option,
check the <a 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 class="code">1920x1080</code>.
</p>
</dd>
<dt><samp class="option">fps, rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">bar_h</samp></dt>
<dd><p>Set the bargraph height. It must be even. Default value is <code class="code">-1</code> which
computes the bargraph height automatically.
</p>
</dd>
<dt><samp class="option">axis_h</samp></dt>
<dd><p>Set the axis height. It must be even. Default value is <code class="code">-1</code> which computes
the axis height automatically.
</p>
</dd>
<dt><samp class="option">sono_h</samp></dt>
<dd><p>Set the sonogram height. It must be even. Default value is <code class="code">-1</code> which
computes the sonogram height automatically.
</p>
</dd>
<dt><samp class="option">fullhd</samp></dt>
<dd><p>Set the fullhd resolution. This option is deprecated, use <var class="var">size</var>, <var class="var">s</var>
instead. Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">sono_v, volume</samp></dt>
<dd><p>Specify the sonogram volume expression. It can contain variables:
</p><dl class="table">
<dt><samp class="option">bar_v</samp></dt>
<dd><p>the <var class="var">bar_v</var> evaluated expression
</p></dd>
<dt><samp class="option">frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp class="option">timeclamp, tc</samp></dt>
<dd><p>the value of <var class="var">timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl class="table">
<dt><samp class="option">a_weighting(f)</samp></dt>
<dd><p>A-weighting of equal loudness
</p></dd>
<dt><samp class="option">b_weighting(f)</samp></dt>
<dd><p>B-weighting of equal loudness
</p></dd>
<dt><samp class="option">c_weighting(f)</samp></dt>
<dd><p>C-weighting of equal loudness.
</p></dd>
</dl>
<p>Default value is <code class="code">16</code>.
</p>
</dd>
<dt><samp class="option">bar_v, volume2</samp></dt>
<dd><p>Specify the bargraph volume expression. It can contain variables:
</p><dl class="table">
<dt><samp class="option">sono_v</samp></dt>
<dd><p>the <var class="var">sono_v</var> evaluated expression
</p></dd>
<dt><samp class="option">frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp class="option">timeclamp, tc</samp></dt>
<dd><p>the value of <var class="var">timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl class="table">
<dt><samp class="option">a_weighting(f)</samp></dt>
<dd><p>A-weighting of equal loudness
</p></dd>
<dt><samp class="option">b_weighting(f)</samp></dt>
<dd><p>B-weighting of equal loudness
</p></dd>
<dt><samp class="option">c_weighting(f)</samp></dt>
<dd><p>C-weighting of equal loudness.
</p></dd>
</dl>
<p>Default value is <code class="code">sono_v</code>.
</p>
</dd>
<dt><samp class="option">sono_g, gamma</samp></dt>
<dd><p>Specify the sonogram gamma. Lower gamma makes the spectrum more contrast,
higher gamma makes the spectrum having more range. Default value is <code class="code">3</code>.
Acceptable range is <code class="code">[1, 7]</code>.
</p>
</dd>
<dt><samp class="option">bar_g, gamma2</samp></dt>
<dd><p>Specify the bargraph gamma. Default value is <code class="code">1</code>. Acceptable range is
<code class="code">[1, 7]</code>.
</p>
</dd>
<dt><samp class="option">bar_t</samp></dt>
<dd><p>Specify the bargraph transparency level. Lower value makes the bargraph sharper.
Default value is <code class="code">1</code>. Acceptable range is <code class="code">[0, 1]</code>.
</p>
</dd>
<dt><samp class="option">timeclamp, tc</samp></dt>
<dd><p>Specify the transform timeclamp. At low frequency, there is trade-off between
accuracy in time domain and frequency domain. If timeclamp is lower,
event in time domain is represented more accurately (such as fast bass drum),
otherwise event in frequency domain is represented more accurately
(such as bass guitar). Acceptable range is <code class="code">[0.002, 1]</code>. Default value is <code class="code">0.17</code>.
</p>
</dd>
<dt><samp class="option">attack</samp></dt>
<dd><p>Set attack time in seconds. The default is <code class="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 class="code">[0, 1]</code>.
</p>
</dd>
<dt><samp class="option">basefreq</samp></dt>
<dd><p>Specify the transform base frequency. Default value is <code class="code">20.01523126408007475</code>,
which is frequency 50 cents below E0. Acceptable range is <code class="code">[10, 100000]</code>.
</p>
</dd>
<dt><samp class="option">endfreq</samp></dt>
<dd><p>Specify the transform end frequency. Default value is <code class="code">20495.59681441799654</code>,
which is frequency 50 cents above D#10. Acceptable range is <code class="code">[10, 100000]</code>.
</p>
</dd>
<dt><samp class="option">coeffclamp</samp></dt>
<dd><p>This option is deprecated and ignored.
</p>
</dd>
<dt><samp class="option">tlength</samp></dt>
<dd><p>Specify the transform length in time domain. Use this option to control accuracy
trade-off between time domain and frequency domain at every frequency sample.
It can contain variables:
</p><dl class="table">
<dt><samp class="option">frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp class="option">timeclamp, tc</samp></dt>
<dd><p>the value of <var class="var">timeclamp</var> option.
</p></dd>
</dl>
<p>Default value is <code class="code">384*tc/(384+tc*f)</code>.
</p>
</dd>
<dt><samp class="option">count</samp></dt>
<dd><p>Specify the transform count for every video frame. Default value is <code class="code">6</code>.
Acceptable range is <code class="code">[1, 30]</code>.
</p>
</dd>
<dt><samp class="option">fcount</samp></dt>
<dd><p>Specify the transform count for every single pixel. Default value is <code class="code">0</code>,
which makes it computed automatically. Acceptable range is <code class="code">[0, 10]</code>.
</p>
</dd>
<dt><samp class="option">fontfile</samp></dt>
<dd><p>Specify font file for use with freetype to draw the axis. If not specified,
use embedded font. Note that drawing with font file or embedded font is not
implemented with custom <var class="var">basefreq</var> and <var class="var">endfreq</var>, use <var class="var">axisfile</var>
option instead.
</p>
</dd>
<dt><samp class="option">font</samp></dt>
<dd><p>Specify fontconfig pattern. This has lower priority than <var class="var">fontfile</var>. The
<code class="code">:</code> in the pattern may be replaced by <code class="code">|</code> to avoid unnecessary
escaping.
</p>
</dd>
<dt><samp class="option">fontcolor</samp></dt>
<dd><p>Specify font color expression. This is arithmetic expression that should return
integer value 0xRRGGBB. It can contain variables:
</p><dl class="table">
<dt><samp class="option">frequency, freq, f</samp></dt>
<dd><p>the frequency where it is evaluated
</p></dd>
<dt><samp class="option">timeclamp, tc</samp></dt>
<dd><p>the value of <var class="var">timeclamp</var> option
</p></dd>
</dl>
<p>and functions:
</p><dl class="table">
<dt><samp class="option">midi(f)</samp></dt>
<dd><p>midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69)
</p></dd>
<dt><samp class="option">r(x), g(x), b(x)</samp></dt>
<dd><p>red, green, and blue value of intensity x.
</p></dd>
</dl>
<p>Default value is <code class="code">st(0, (midi(f)-59.5)/12);
st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0));
r(1-ld(1)) + b(ld(1))</code>.
</p>
</dd>
<dt><samp class="option">axisfile</samp></dt>
<dd><p>Specify image file to draw the axis. This option override <var class="var">fontfile</var> and
<var class="var">fontcolor</var> option.
</p>
</dd>
<dt><samp class="option">axis, text</samp></dt>
<dd><p>Enable/disable drawing text to the axis. If it is set to <code class="code">0</code>, drawing to
the axis is disabled, ignoring <var class="var">fontfile</var> and <var class="var">axisfile</var> option.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">csp</samp></dt>
<dd><p>Set colorspace. The accepted values are:
</p><dl class="table">
<dt>‘<samp class="samp">unspecified</samp>’</dt>
<dd><p>Unspecified (default)
</p>
</dd>
<dt>‘<samp class="samp">bt709</samp>’</dt>
<dd><p>BT.709
</p>
</dd>
<dt>‘<samp class="samp">fcc</samp>’</dt>
<dd><p>FCC
</p>
</dd>
<dt>‘<samp class="samp">bt470bg</samp>’</dt>
<dd><p>BT.470BG or BT.601-6 625
</p>
</dd>
<dt>‘<samp class="samp">smpte170m</samp>’</dt>
<dd><p>SMPTE-170M or BT.601-6 525
</p>
</dd>
<dt>‘<samp class="samp">smpte240m</samp>’</dt>
<dd><p>SMPTE-240M
</p>
</dd>
<dt>‘<samp class="samp">bt2020ncl</samp>’</dt>
<dd><p>BT.2020 with non-constant luminance
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">cscheme</samp></dt>
<dd><p>Set spectrogram color scheme. This is list of floating point values with format
<code class="code">left_r|left_g|left_b|right_r|right_g|right_b</code>.
The default is <code class="code">1|0.5|0|0|0.5|1</code>.
</p>
</dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-181" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-181">
<h4 class="subsection">37.22.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Playing audio while showing the spectrum:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">sono_h=0
</pre></div>
</li><li>A1 and its harmonics: A1, A2, (near)E3, A3:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">bar_g=2:sono_g=2
</pre></div>
</li><li>Custom tlength equation:
<div class="example">
<pre class="example-preformatted">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-preformatted">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-preformatted">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-preformatted">axisfile=myaxis.png:basefreq=40:endfreq=10000
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="showcwt">
<h3 class="section">37.23 showcwt</h3>
<p>Convert input audio to video output representing frequency spectrum
using Continuous Wavelet Transform and Morlet wavelet.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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 class="code">640x512</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the output frame rate. Default value is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set the frequency scale used. Allowed values are:
</p>
<dl class="table">
<dt><samp class="option">linear</samp></dt>
<dt><samp class="option">log</samp></dt>
<dt><samp class="option">bark</samp></dt>
<dt><samp class="option">mel</samp></dt>
<dt><samp class="option">erbs</samp></dt>
<dt><samp class="option">sqrt</samp></dt>
<dt><samp class="option">cbrt</samp></dt>
<dt><samp class="option">qdrt</samp></dt>
</dl>
<p>Default value is <code class="code">linear</code>.
</p>
</dd>
<dt><samp class="option">iscale</samp></dt>
<dd><p>Set the intensity scale used. Allowed values are:
</p>
<dl class="table">
<dt><samp class="option">linear</samp></dt>
<dt><samp class="option">log</samp></dt>
<dt><samp class="option">sqrt</samp></dt>
<dt><samp class="option">cbrt</samp></dt>
<dt><samp class="option">qdrt</samp></dt>
</dl>
<p>Default value is <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">min</samp></dt>
<dd><p>Set the minimum frequency that will be used in output.
Default is <code class="code">20</code> Hz.
</p>
</dd>
<dt><samp class="option">max</samp></dt>
<dd><p>Set the maximum frequency that will be used in output.
Default is <code class="code">20000</code> Hz. The real frequency upper limit
depends on input audio’s sample rate and such will be enforced
on this value when it is set to value greater than Nyquist frequency.
</p>
</dd>
<dt><samp class="option">imin</samp></dt>
<dd><p>Set the minimum intensity that will be used in output.
</p>
</dd>
<dt><samp class="option">imax</samp></dt>
<dd><p>Set the maximum intensity that will be used in output.
</p>
</dd>
<dt><samp class="option">logb</samp></dt>
<dd><p>Set the logarithmic basis for brightness strength when
mapping calculated magnitude values to pixel values.
Allowed range is from <code class="code">0</code> to <code class="code">1</code>.
Default value is <code class="code">0.0001</code>.
</p>
</dd>
<dt><samp class="option">deviation</samp></dt>
<dd><p>Set the frequency deviation.
Lower values than <code class="code">1</code> are more frequency oriented,
while higher values than <code class="code">1</code> are more time oriented.
Allowed range is from <code class="code">0</code> to <code class="code">10</code>.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">pps</samp></dt>
<dd><p>Set the number of pixel output per each second in one row.
Allowed range is from <code class="code">1</code> to <code class="code">1024</code>.
Default value is <code class="code">64</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set the output visual mode. Allowed values are:
</p>
<dl class="table">
<dt><samp class="option">magnitude</samp></dt>
<dd><p>Show magnitude.
</p></dd>
<dt><samp class="option">phase</samp></dt>
<dd><p>Show only phase.
</p></dd>
<dt><samp class="option">magphase</samp></dt>
<dd><p>Show combination of magnitude and phase.
Magnitude is mapped to brightness and phase to color.
</p></dd>
<dt><samp class="option">channel</samp></dt>
<dd><p>Show unique color per channel magnitude.
</p></dd>
<dt><samp class="option">stereo</samp></dt>
<dd><p>Show unique color per stereo difference.
</p></dd>
</dl>
<p>Default value is <code class="code">magnitude</code>.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Set the output slide method. Allowed values are:
</p>
<dl class="table">
<dt><samp class="option">replace</samp></dt>
<dt><samp class="option">scroll</samp></dt>
<dt><samp class="option">frame</samp></dt>
</dl>
</dd>
<dt><samp class="option">direction</samp></dt>
<dd><p>Set the direction method for output slide method. Allowed values are:
</p>
<dl class="table">
<dt><samp class="option">lr</samp></dt>
<dd><p>Direction from left to right.
</p></dd>
<dt><samp class="option">rl</samp></dt>
<dd><p>Direction from right to left.
</p></dd>
<dt><samp class="option">ud</samp></dt>
<dd><p>Direction from up to down.
</p></dd>
<dt><samp class="option">du</samp></dt>
<dd><p>Direction from down to up.
</p></dd>
</dl>
</dd>
<dt><samp class="option">bar</samp></dt>
<dd><p>Set the ratio of bargraph display to display size. Default is 0.
</p>
</dd>
<dt><samp class="option">rotation</samp></dt>
<dd><p>Set color rotation, must be in [-1.0, 1.0] range.
Default value is <code class="code">0</code>.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="showfreqs">
<h3 class="section">37.24 showfreqs</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 class="table">
<dt><samp class="option">size, s</samp></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 class="code">1024x512</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set video rate. Default is <code class="code">25</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set display mode.
This set how each frequency bin will be represented.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">line</samp>’</dt>
<dt>‘<samp class="samp">bar</samp>’</dt>
<dt>‘<samp class="samp">dot</samp>’</dt>
</dl>
<p>Default is <code class="code">bar</code>.
</p>
</dd>
<dt><samp class="option">ascale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>Linear scale.
</p>
</dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>Square root scale.
</p>
</dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>Cubic root scale.
</p>
</dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>Logarithmic scale.
</p></dd>
</dl>
<p>Default is <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">fscale</samp></dt>
<dd><p>Set frequency scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>Linear scale.
</p>
</dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>Logarithmic scale.
</p>
</dd>
<dt>‘<samp class="samp">rlog</samp>’</dt>
<dd><p>Reverse logarithmic scale.
</p></dd>
</dl>
<p>Default is <code class="code">lin</code>.
</p>
</dd>
<dt><samp class="option">win_size</samp></dt>
<dd><p>Set window size. Allowed range is from 16 to 65536.
</p>
<p>Default is <code class="code">2048</code>
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set windowing function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default is <code class="code">hanning</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set window overlap. In range <code class="code">[0, 1]</code>. Default is <code class="code">1</code>,
which means optimal overlap for selected window function will be picked.
</p>
</dd>
<dt><samp class="option">averaging</samp></dt>
<dd><p>Set time averaging. Setting this to 0 will display current maximal peaks.
Default is <code class="code">1</code>, which means time averaging is disabled.
</p>
</dd>
<dt><samp class="option">colors</samp></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><samp class="option">cmode</samp></dt>
<dd><p>Set channel display mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">combined</samp>’</dt>
<dt>‘<samp class="samp">separate</samp>’</dt>
</dl>
<p>Default is <code class="code">combined</code>.
</p>
</dd>
<dt><samp class="option">minamp</samp></dt>
<dd><p>Set minimum amplitude used in <code class="code">log</code> amplitude scaler.
</p>
</dd>
<dt><samp class="option">data</samp></dt>
<dd><p>Set data display mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">magnitude</samp>’</dt>
<dt>‘<samp class="samp">phase</samp>’</dt>
<dt>‘<samp class="samp">delay</samp>’</dt>
</dl>
<p>Default is <code class="code">magnitude</code>.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set channels to use when processing audio. By default all are processed.
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="showspatial">
<h3 class="section">37.25 showspatial</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 class="table">
<dt><samp class="option">size, s</samp></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 class="code">512x512</code>.
</p>
</dd>
<dt><samp class="option">win_size</samp></dt>
<dd><p>Set window size. Allowed range is from <var class="var">1024</var> to <var class="var">65536</var>. Default size is <var class="var">4096</var>.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann</samp>’</dt>
<dt>‘<samp class="samp">hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default value is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set output framerate.
</p></dd>
</dl>
<a class="anchor" id="showspectrum"></a></div>
<div class="section-level-extent" id="showspectrum-1">
<h3 class="section">37.26 showspectrum</h3>
<p>Convert input audio to a video output, representing the audio frequency
spectrum.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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 class="code">640x512</code>.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Specify how the spectrum should slide along the window.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">replace</samp>’</dt>
<dd><p>the samples start again on the left when they reach the right
</p></dd>
<dt>‘<samp class="samp">scroll</samp>’</dt>
<dd><p>the samples scroll from right to left
</p></dd>
<dt>‘<samp class="samp">fullframe</samp>’</dt>
<dd><p>frames are only produced when the samples reach the right
</p></dd>
<dt>‘<samp class="samp">rscroll</samp>’</dt>
<dd><p>the samples scroll from left to right
</p></dd>
<dt>‘<samp class="samp">lreplace</samp>’</dt>
<dd><p>the samples start again on the right when they reach the left
</p></dd>
</dl>
<p>Default value is <code class="code">replace</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Specify display mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">combined</samp>’</dt>
<dd><p>all channels are displayed in the same row
</p></dd>
<dt>‘<samp class="samp">separate</samp>’</dt>
<dd><p>all channels are displayed in separate rows
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">combined</samp>’.
</p>
</dd>
<dt><samp class="option">color</samp></dt>
<dd><p>Specify display color mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">channel</samp>’</dt>
<dd><p>each channel is displayed in a separate color
</p></dd>
<dt>‘<samp class="samp">intensity</samp>’</dt>
<dd><p>each channel is displayed using the same color scheme
</p></dd>
<dt>‘<samp class="samp">rainbow</samp>’</dt>
<dd><p>each channel is displayed using the rainbow color scheme
</p></dd>
<dt>‘<samp class="samp">moreland</samp>’</dt>
<dd><p>each channel is displayed using the moreland color scheme
</p></dd>
<dt>‘<samp class="samp">nebulae</samp>’</dt>
<dd><p>each channel is displayed using the nebulae color scheme
</p></dd>
<dt>‘<samp class="samp">fire</samp>’</dt>
<dd><p>each channel is displayed using the fire color scheme
</p></dd>
<dt>‘<samp class="samp">fiery</samp>’</dt>
<dd><p>each channel is displayed using the fiery color scheme
</p></dd>
<dt>‘<samp class="samp">fruit</samp>’</dt>
<dd><p>each channel is displayed using the fruit color scheme
</p></dd>
<dt>‘<samp class="samp">cool</samp>’</dt>
<dd><p>each channel is displayed using the cool color scheme
</p></dd>
<dt>‘<samp class="samp">magma</samp>’</dt>
<dd><p>each channel is displayed using the magma color scheme
</p></dd>
<dt>‘<samp class="samp">green</samp>’</dt>
<dd><p>each channel is displayed using the green color scheme
</p></dd>
<dt>‘<samp class="samp">viridis</samp>’</dt>
<dd><p>each channel is displayed using the viridis color scheme
</p></dd>
<dt>‘<samp class="samp">plasma</samp>’</dt>
<dd><p>each channel is displayed using the plasma color scheme
</p></dd>
<dt>‘<samp class="samp">cividis</samp>’</dt>
<dd><p>each channel is displayed using the cividis color scheme
</p></dd>
<dt>‘<samp class="samp">terrain</samp>’</dt>
<dd><p>each channel is displayed using the terrain color scheme
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">channel</samp>’.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Specify scale used for calculating intensity color values.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>square root, default
</p></dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>cubic root
</p></dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
<dt>‘<samp class="samp">4thrt</samp>’</dt>
<dd><p>4th root
</p></dd>
<dt>‘<samp class="samp">5thrt</samp>’</dt>
<dd><p>5th root
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">sqrt</samp>’.
</p>
</dd>
<dt><samp class="option">fscale</samp></dt>
<dd><p>Specify frequency scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">lin</samp>’.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set saturation modifier for displayed colors. Negative values provide
alternative color scheme. <code class="code">0</code> is no saturation at all.
Saturation must be in [-10.0, 10.0] range.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann</samp>’</dt>
<dt>‘<samp class="samp">hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default value is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">orientation</samp></dt>
<dd><p>Set orientation of time vs frequency axis. Can be <code class="code">vertical</code> or
<code class="code">horizontal</code>. Default is <code class="code">vertical</code>.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set ratio of overlap window. Default value is <code class="code">0</code>.
When value is <code class="code">1</code> overlap is set to recommended size for specific
window function currently used.
</p>
</dd>
<dt><samp class="option">gain</samp></dt>
<dd><p>Set scale gain for calculating intensity color values.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">data</samp></dt>
<dd><p>Set which data to display. Can be <code class="code">magnitude</code>, default or <code class="code">phase</code>,
or unwrapped phase: <code class="code">uphase</code>.
</p>
</dd>
<dt><samp class="option">rotation</samp></dt>
<dd><p>Set color rotation, must be in [-1.0, 1.0] range.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">start</samp></dt>
<dd><p>Set start frequency from which to display spectrogram. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">stop</samp></dt>
<dd><p>Set stop frequency to which to display spectrogram. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">fps</samp></dt>
<dd><p>Set upper frame rate limit. Default is <code class="code">auto</code>, unlimited.
</p>
</dd>
<dt><samp class="option">legend</samp></dt>
<dd><p>Draw time and frequency axes and legends. Default is disabled.
</p>
</dd>
<dt><samp class="option">drange</samp></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><samp class="option">limit</samp></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><samp class="option">opacity</samp></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>
<ul class="mini-toc">
<li><a href="#Examples-182" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-182">
<h4 class="subsection">37.26.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Large window with logarithmic color scaling:
<div class="example">
<pre class="example-preformatted">showspectrum=s=1280x480:scale=log
</pre></div>
</li><li>Complete example for a colored and sliding spectrum per channel using <code class="command">ffplay</code>:
<div class="example">
<pre class="example-preformatted">ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
[a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="showspectrumpic">
<h3 class="section">37.27 showspectrumpic</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 class="table">
<dt><samp class="option">size, s</samp></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 class="code">4096x2048</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Specify display mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">combined</samp>’</dt>
<dd><p>all channels are displayed in the same row
</p></dd>
<dt>‘<samp class="samp">separate</samp>’</dt>
<dd><p>all channels are displayed in separate rows
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">combined</samp>’.
</p>
</dd>
<dt><samp class="option">color</samp></dt>
<dd><p>Specify display color mode.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">channel</samp>’</dt>
<dd><p>each channel is displayed in a separate color
</p></dd>
<dt>‘<samp class="samp">intensity</samp>’</dt>
<dd><p>each channel is displayed using the same color scheme
</p></dd>
<dt>‘<samp class="samp">rainbow</samp>’</dt>
<dd><p>each channel is displayed using the rainbow color scheme
</p></dd>
<dt>‘<samp class="samp">moreland</samp>’</dt>
<dd><p>each channel is displayed using the moreland color scheme
</p></dd>
<dt>‘<samp class="samp">nebulae</samp>’</dt>
<dd><p>each channel is displayed using the nebulae color scheme
</p></dd>
<dt>‘<samp class="samp">fire</samp>’</dt>
<dd><p>each channel is displayed using the fire color scheme
</p></dd>
<dt>‘<samp class="samp">fiery</samp>’</dt>
<dd><p>each channel is displayed using the fiery color scheme
</p></dd>
<dt>‘<samp class="samp">fruit</samp>’</dt>
<dd><p>each channel is displayed using the fruit color scheme
</p></dd>
<dt>‘<samp class="samp">cool</samp>’</dt>
<dd><p>each channel is displayed using the cool color scheme
</p></dd>
<dt>‘<samp class="samp">magma</samp>’</dt>
<dd><p>each channel is displayed using the magma color scheme
</p></dd>
<dt>‘<samp class="samp">green</samp>’</dt>
<dd><p>each channel is displayed using the green color scheme
</p></dd>
<dt>‘<samp class="samp">viridis</samp>’</dt>
<dd><p>each channel is displayed using the viridis color scheme
</p></dd>
<dt>‘<samp class="samp">plasma</samp>’</dt>
<dd><p>each channel is displayed using the plasma color scheme
</p></dd>
<dt>‘<samp class="samp">cividis</samp>’</dt>
<dd><p>each channel is displayed using the cividis color scheme
</p></dd>
<dt>‘<samp class="samp">terrain</samp>’</dt>
<dd><p>each channel is displayed using the terrain color scheme
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">intensity</samp>’.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Specify scale used for calculating intensity color values.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>square root, default
</p></dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>cubic root
</p></dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
<dt>‘<samp class="samp">4thrt</samp>’</dt>
<dd><p>4th root
</p></dd>
<dt>‘<samp class="samp">5thrt</samp>’</dt>
<dd><p>5th root
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">log</samp>’.
</p>
</dd>
<dt><samp class="option">fscale</samp></dt>
<dd><p>Specify frequency scale.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>linear
</p></dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>logarithmic
</p></dd>
</dl>
<p>Default value is ‘<samp class="samp">lin</samp>’.
</p>
</dd>
<dt><samp class="option">saturation</samp></dt>
<dd><p>Set saturation modifier for displayed colors. Negative values provide
alternative color scheme. <code class="code">0</code> is no saturation at all.
Saturation must be in [-10.0, 10.0] range.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function.
</p>
<p>It accepts the following values:
</p><dl class="table">
<dt>‘<samp class="samp">rect</samp>’</dt>
<dt>‘<samp class="samp">bartlett</samp>’</dt>
<dt>‘<samp class="samp">hann</samp>’</dt>
<dt>‘<samp class="samp">hanning</samp>’</dt>
<dt>‘<samp class="samp">hamming</samp>’</dt>
<dt>‘<samp class="samp">blackman</samp>’</dt>
<dt>‘<samp class="samp">welch</samp>’</dt>
<dt>‘<samp class="samp">flattop</samp>’</dt>
<dt>‘<samp class="samp">bharris</samp>’</dt>
<dt>‘<samp class="samp">bnuttall</samp>’</dt>
<dt>‘<samp class="samp">bhann</samp>’</dt>
<dt>‘<samp class="samp">sine</samp>’</dt>
<dt>‘<samp class="samp">nuttall</samp>’</dt>
<dt>‘<samp class="samp">lanczos</samp>’</dt>
<dt>‘<samp class="samp">gauss</samp>’</dt>
<dt>‘<samp class="samp">tukey</samp>’</dt>
<dt>‘<samp class="samp">dolph</samp>’</dt>
<dt>‘<samp class="samp">cauchy</samp>’</dt>
<dt>‘<samp class="samp">parzen</samp>’</dt>
<dt>‘<samp class="samp">poisson</samp>’</dt>
<dt>‘<samp class="samp">bohman</samp>’</dt>
<dt>‘<samp class="samp">kaiser</samp>’</dt>
</dl>
<p>Default value is <code class="code">hann</code>.
</p>
</dd>
<dt><samp class="option">orientation</samp></dt>
<dd><p>Set orientation of time vs frequency axis. Can be <code class="code">vertical</code> or
<code class="code">horizontal</code>. Default is <code class="code">vertical</code>.
</p>
</dd>
<dt><samp class="option">gain</samp></dt>
<dd><p>Set scale gain for calculating intensity color values.
Default value is <code class="code">1</code>.
</p>
</dd>
<dt><samp class="option">legend</samp></dt>
<dd><p>Draw time and frequency axes and legends. Default is enabled.
</p>
</dd>
<dt><samp class="option">rotation</samp></dt>
<dd><p>Set color rotation, must be in [-1.0, 1.0] range.
Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">start</samp></dt>
<dd><p>Set start frequency from which to display spectrogram. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">stop</samp></dt>
<dd><p>Set stop frequency to which to display spectrogram. Default is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">drange</samp></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><samp class="option">limit</samp></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><samp class="option">opacity</samp></dt>
<dd><p>Set opacity strength when using pixel format output with alpha component.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-183" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-183">
<h4 class="subsection">37.27.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Extract an audio spectrogram of a whole audio track
in a 1024x1024 picture using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="showvolume">
<h3 class="section">37.28 showvolume</h3>
<p>Convert input audio volume to a video output.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set video rate.
</p>
</dd>
<dt><samp class="option">b</samp></dt>
<dd><p>Set border width, allowed range is [0, 5]. Default is 1.
</p>
</dd>
<dt><samp class="option">w</samp></dt>
<dd><p>Set channel width, allowed range is [80, 8192]. Default is 400.
</p>
</dd>
<dt><samp class="option">h</samp></dt>
<dd><p>Set channel height, allowed range is [1, 900]. Default is 20.
</p>
</dd>
<dt><samp class="option">f</samp></dt>
<dd><p>Set fade, allowed range is [0, 1]. Default is 0.95.
</p>
</dd>
<dt><samp class="option">c</samp></dt>
<dd><p>Set volume color expression.
</p>
<p>The expression can use the following variables:
</p>
<dl class="table">
<dt><samp class="option">VOLUME</samp></dt>
<dd><p>Current max volume of channel in dB.
</p>
</dd>
<dt><samp class="option">PEAK</samp></dt>
<dd><p>Current peak.
</p>
</dd>
<dt><samp class="option">CHANNEL</samp></dt>
<dd><p>Current channel number, starting from 0.
</p></dd>
</dl>
</dd>
<dt><samp class="option">t</samp></dt>
<dd><p>If set, displays channel names. Default is enabled.
</p>
</dd>
<dt><samp class="option">v</samp></dt>
<dd><p>If set, displays volume values. Default is enabled.
</p>
</dd>
<dt><samp class="option">o</samp></dt>
<dd><p>Set orientation, can be horizontal: <code class="code">h</code> or vertical: <code class="code">v</code>,
default is <code class="code">h</code>.
</p>
</dd>
<dt><samp class="option">s</samp></dt>
<dd><p>Set step size, allowed range is [0, 5]. Default is 0, which means
step is disabled.
</p>
</dd>
<dt><samp class="option">p</samp></dt>
<dd><p>Set background opacity, allowed range is [0, 1]. Default is 0.
</p>
</dd>
<dt><samp class="option">m</samp></dt>
<dd><p>Set metering mode, can be peak: <code class="code">p</code> or rms: <code class="code">r</code>,
default is <code class="code">p</code>.
</p>
</dd>
<dt><samp class="option">ds</samp></dt>
<dd><p>Set display scale, can be linear: <code class="code">lin</code> or log: <code class="code">log</code>,
default is <code class="code">lin</code>.
</p>
</dd>
<dt><samp class="option">dm</samp></dt>
<dd><p>In second.
If set to > 0., display a line for the max level
in the previous seconds.
default is disabled: <code class="code">0.</code>
</p>
</dd>
<dt><samp class="option">dmc</samp></dt>
<dd><p>The color of the max line. Use when <code class="code">dm</code> option is set to > 0.
default is: <code class="code">orange</code>
</p></dd>
</dl>
</div>
<div class="section-level-extent" id="showwaves">
<h3 class="section">37.29 showwaves</h3>
<p>Convert input audio to a video output, representing the samples waves.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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 class="code">600x240</code>.
</p>
</dd>
<dt><samp class="option">mode</samp></dt>
<dd><p>Set display mode.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">point</samp>’</dt>
<dd><p>Draw a point for each sample.
</p>
</dd>
<dt>‘<samp class="samp">line</samp>’</dt>
<dd><p>Draw a vertical line for each sample.
</p>
</dd>
<dt>‘<samp class="samp">p2p</samp>’</dt>
<dd><p>Draw a point for each sample and a line between them.
</p>
</dd>
<dt>‘<samp class="samp">cline</samp>’</dt>
<dd><p>Draw a centered vertical line for each sample.
</p></dd>
</dl>
<p>Default value is <code class="code">point</code>.
</p>
</dd>
<dt><samp class="option">n</samp></dt>
<dd><p>Set the number of samples which are printed on the same column. A
larger value will decrease the frame rate. Must be a positive
integer. This option can be set only if the value for <var class="var">rate</var>
is not explicitly specified.
</p>
</dd>
<dt><samp class="option">rate, r</samp></dt>
<dd><p>Set the (approximate) output frame rate. This is done by setting the
option <var class="var">n</var>. Default value is "25".
</p>
</dd>
<dt><samp class="option">split_channels</samp></dt>
<dd><p>Set if channels should be drawn separately or overlap. Default value is 0.
</p>
</dd>
<dt><samp class="option">colors</samp></dt>
<dd><p>Set colors separated by ’|’ which are going to be used for drawing of each channel.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>Linear.
</p>
</dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>Logarithmic.
</p>
</dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>Square root.
</p>
</dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>Cubic root.
</p></dd>
</dl>
<p>Default is linear.
</p>
</dd>
<dt><samp class="option">draw</samp></dt>
<dd><p>Set the draw mode. This is mostly useful to set for high <var class="var">n</var>.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">scale</samp>’</dt>
<dd><p>Scale pixel values for each drawn sample.
</p>
</dd>
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>Draw every sample directly.
</p></dd>
</dl>
<p>Default value is <code class="code">scale</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-184" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-184">
<h4 class="subsection">37.29.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Output the input file audio and the corresponding video representation
at the same time:
<div class="example">
<pre class="example-preformatted">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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="showwavespic">
<h3 class="section">37.30 showwavespic</h3>
<p>Convert input audio to a single video frame, representing the samples waves.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">size, s</samp></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 class="code">600x240</code>.
</p>
</dd>
<dt><samp class="option">split_channels</samp></dt>
<dd><p>Set if channels should be drawn separately or overlap. Default value is 0.
</p>
</dd>
<dt><samp class="option">colors</samp></dt>
<dd><p>Set colors separated by ’|’ which are going to be used for drawing of each channel.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set amplitude scale.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">lin</samp>’</dt>
<dd><p>Linear.
</p>
</dd>
<dt>‘<samp class="samp">log</samp>’</dt>
<dd><p>Logarithmic.
</p>
</dd>
<dt>‘<samp class="samp">sqrt</samp>’</dt>
<dd><p>Square root.
</p>
</dd>
<dt>‘<samp class="samp">cbrt</samp>’</dt>
<dd><p>Cubic root.
</p></dd>
</dl>
<p>Default is linear.
</p>
</dd>
<dt><samp class="option">draw</samp></dt>
<dd><p>Set the draw mode.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">scale</samp>’</dt>
<dd><p>Scale pixel values for each drawn sample.
</p>
</dd>
<dt>‘<samp class="samp">full</samp>’</dt>
<dd><p>Draw every sample directly.
</p></dd>
</dl>
<p>Default value is <code class="code">scale</code>.
</p>
</dd>
<dt><samp class="option">filter</samp></dt>
<dd><p>Set the filter mode.
</p>
<p>Available values are:
</p><dl class="table">
<dt>‘<samp class="samp">average</samp>’</dt>
<dd><p>Use average samples values for each drawn sample.
</p>
</dd>
<dt>‘<samp class="samp">peak</samp>’</dt>
<dd><p>Use peak samples values for each drawn sample.
</p></dd>
</dl>
<p>Default value is <code class="code">average</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-185" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-185">
<h4 class="subsection">37.30.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Extract a channel split representation of the wave form of a whole audio track
in a 1024x800 picture using <code class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="sidedata_002c-asidedata">
<h3 class="section">37.31 sidedata, asidedata</h3>
<p>Delete frame side data, or select frames based on it.
</p>
<p>This filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">mode</samp></dt>
<dd><p>Set mode of operation of the filter.
</p>
<p>Can be one of the following:
</p>
<dl class="table">
<dt>‘<samp class="samp">select</samp>’</dt>
<dd><p>Select every frame with side data of <code class="code">type</code>.
</p>
</dd>
<dt>‘<samp class="samp">delete</samp>’</dt>
<dd><p>Delete side data of <code class="code">type</code>. If <code class="code">type</code> is not set, delete all side
data in the frame.
</p>
</dd>
</dl>
</dd>
<dt><samp class="option">type</samp></dt>
<dd><p>Set side data type used with all modes. Must be set for <code class="code">select</code> mode. For
the list of frame side data types, refer to the <code class="code">AVFrameSideDataType</code> enum
in <samp class="file">libavutil/frame.h</samp>. For example, to choose
<code class="code">AV_FRAME_DATA_PANSCAN</code> side data, you must specify <code class="code">PANSCAN</code>.
</p>
</dd>
</dl>
</div>
<div class="section-level-extent" id="spectrumsynth">
<h3 class="section">37.32 spectrumsynth</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 class="ref" 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 class="code">channel</code> color mode in
<a class="ref" href="#showspectrum">showspectrum</a> filter) and <code class="code">log</code> scale for magnitude video and
<code class="code">lin</code> scale for phase video. To produce phase, for 2nd video, use
<code class="code">data</code> option. Inputs videos should generally use <code class="code">fullframe</code>
slide mode as that saves resources needed for decoding video.
</p>
<p>The filter accepts the following options:
</p>
<dl class="table">
<dt><samp class="option">sample_rate</samp></dt>
<dd><p>Specify sample rate of output audio, the sample rate of audio from which
spectrum was generated may differ.
</p>
</dd>
<dt><samp class="option">channels</samp></dt>
<dd><p>Set number of channels represented in input video spectrums.
</p>
</dd>
<dt><samp class="option">scale</samp></dt>
<dd><p>Set scale which was used when generating magnitude input spectrum.
Can be <code class="code">lin</code> or <code class="code">log</code>. Default is <code class="code">log</code>.
</p>
</dd>
<dt><samp class="option">slide</samp></dt>
<dd><p>Set slide which was used when generating inputs spectrums.
Can be <code class="code">replace</code>, <code class="code">scroll</code>, <code class="code">fullframe</code> or <code class="code">rscroll</code>.
Default is <code class="code">fullframe</code>.
</p>
</dd>
<dt><samp class="option">win_func</samp></dt>
<dd><p>Set window function used for resynthesis.
</p>
</dd>
<dt><samp class="option">overlap</samp></dt>
<dd><p>Set window overlap. In range <code class="code">[0, 1]</code>. Default is <code class="code">1</code>,
which means optimal overlap for selected window function will be picked.
</p>
</dd>
<dt><samp class="option">orientation</samp></dt>
<dd><p>Set orientation of input videos. Can be <code class="code">vertical</code> or <code class="code">horizontal</code>.
Default is <code class="code">vertical</code>.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Examples-186" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-186">
<h4 class="subsection">37.32.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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>
</div>
</div>
<div class="section-level-extent" id="split_002c-asplit">
<h3 class="section">37.33 split, asplit</h3>
<p>Split input into several identical outputs.
</p>
<p><code class="code">asplit</code> works with audio input, <code class="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>
<ul class="mini-toc">
<li><a href="#Examples-187" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-187">
<h4 class="subsection">37.33.1 Examples</h4>
<ul class="itemize mark-bullet">
<li>Create two separate outputs from the same input:
<div class="example">
<pre class="example-preformatted">[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-preformatted">[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-preformatted">[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 class="command">ffmpeg</code>:
<div class="example">
<pre class="example-preformatted">ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
</pre></div>
</li></ul>
</div>
</div>
<div class="section-level-extent" id="zmq_002c-azmq">
<h3 class="section">37.34 zmq, azmq</h3>
<p>Receive commands sent through a libzmq client, and forward them to
filters in the filtergraph.
</p>
<p><code class="code">zmq</code> and <code class="code">azmq</code> work as a pass-through filters. <code class="code">zmq</code>
must be inserted between two video filters, <code class="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 class="code">--enable-libzmq</code>.
</p>
<p>For more information about libzmq see:
<a class="url" href="http://www.zeromq.org/">http://www.zeromq.org/</a>
</p>
<p>The <code class="code">zmq</code> and <code class="code">azmq</code> filters work as a libzmq server, which
receives messages sent through a network interface defined by the
<samp class="option">bind_address</samp> (or the abbreviation "<samp class="option">b</samp>") option.
Default value of this option is <samp class="file">tcp://localhost:5555</samp>. You may
want to alter this value to your needs, but do not forget to escape any
’:’ signs (see <a class="ref" href="#filtergraph-escaping">filtergraph escaping</a>).
</p>
<p>The received message must be in the form:
</p><div class="example">
<pre class="example-preformatted"><var class="var">TARGET</var> <var class="var">COMMAND</var> [<var class="var">ARG</var>]
</pre></div>
<p><var class="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 class="samp">Parsed_<filter_name>_<index></samp>’,
but you can override this by using the ‘<samp class="samp">filter_name@id</samp>’ syntax
(see <a class="ref" href="#Filtergraph-syntax">Filtergraph syntax</a>).
</p>
<p><var class="var">COMMAND</var> specifies the name of the command for the target filter.
</p>
<p><var class="var">ARG</var> is optional and specifies the optional argument list for the
given <var class="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-preformatted"><var class="var">ERROR_CODE</var> <var class="var">ERROR_REASON</var>
<var class="var">MESSAGE</var>
</pre></div>
<p><var class="var">MESSAGE</var> is optional.
</p>
<ul class="mini-toc">
<li><a href="#Examples-188" accesskey="1">Examples</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-188">
<h4 class="subsection">37.34.1 Examples</h4>
<p>Look at <samp class="file">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 class="command">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-preformatted">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-preformatted">echo Parsed_color_0 c yellow | tools/zmqsend
</pre></div>
<p>To change the right side:
</p><div class="example">
<pre class="example-preformatted">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-preformatted">echo overlay@my x 150 | tools/zmqsend
</pre></div>
</div>
</div>
</div>
<div class="chapter-level-extent" id="Multimedia-Sources">
<h2 class="chapter">38 Multimedia Sources</h2>
<p>Below is a description of the currently available multimedia sources.
</p>
<ul class="mini-toc">
<li><a href="#amovie" accesskey="1">amovie</a></li>
<li><a href="#avsynctest" accesskey="2">avsynctest</a></li>
<li><a href="#movie-1" accesskey="3">movie</a></li>
</ul>
<div class="section-level-extent" id="amovie">
<h3 class="section">38.1 amovie</h3>
<p>This is the same as <a class="ref" href="#movie">movie</a> source, except it selects an audio
stream by default.
</p>
</div>
<div class="section-level-extent" id="avsynctest">
<h3 class="section">38.2 avsynctest</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 class="table">
<dt><samp class="option">size, s</samp></dt>
<dd><p>Set output video size. Default value is <code class="code">hd720</code>.
</p>
</dd>
<dt><samp class="option">framerate, fr</samp></dt>
<dd><p>Set output video frame rate. Default value is <code class="code">30</code>.
</p>
</dd>
<dt><samp class="option">samplerate, sr</samp></dt>
<dd><p>Set output audio sample rate. Default value is <code class="code">44100</code>.
</p>
</dd>
<dt><samp class="option">amplitude, a</samp></dt>
<dd><p>Set output audio beep amplitude. Default value is <code class="code">0.7</code>.
</p>
</dd>
<dt><samp class="option">period, p</samp></dt>
<dd><p>Set output audio beep period in seconds. Default value is <code class="code">3</code>.
</p>
</dd>
<dt><samp class="option">delay, dl</samp></dt>
<dd><p>Set output video flash delay in number of frames. Default value is <code class="code">0</code>.
</p>
</dd>
<dt><samp class="option">cycle, c</samp></dt>
<dd><p>Enable cycling of video delays, by default is disabled.
</p>
</dd>
<dt><samp class="option">duration, d</samp></dt>
<dd><p>Set stream output duration. By default duration is unlimited.
</p>
</dd>
<dt><samp class="option">fg, bg, ag</samp></dt>
<dd><p>Set foreground/background/additional color.
</p></dd>
</dl>
<ul class="mini-toc">
<li><a href="#Commands-164" accesskey="1">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Commands-164">
<h4 class="subsection">38.2.1 Commands</h4>
<p>This source supports the some above options as <a class="ref" href="#commands">commands</a>.
</p>
<a class="anchor" id="movie"></a></div>
</div>
<div class="section-level-extent" id="movie-1">
<h3 class="section">38.3 movie</h3>
<p>Read audio and/or video stream(s) from a movie container.
</p>
<p>It accepts the following parameters:
</p>
<dl class="table">
<dt><samp class="option">filename</samp></dt>
<dd><p>The name of the resource to read (not necessarily a file; it can also be a
device or a stream accessed through some protocol).
</p>
</dd>
<dt><samp class="option">format_name, f</samp></dt>
<dd><p>Specifies the format assumed for the movie to read, and can be either
the name of a container or an input device. If not specified, the
format is guessed from <var class="var">movie_name</var> or by probing.
</p>
</dd>
<dt><samp class="option">seek_point, sp</samp></dt>
<dd><p>Specifies the seek point in seconds. The frames will be output
starting from this seek point. The parameter is evaluated with
<code class="code">av_strtod</code>, so the numerical value may be suffixed by an IS
postfix. The default value is "0".
</p>
</dd>
<dt><samp class="option">streams, s</samp></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><samp class="option">stream_index, si</samp></dt>
<dd><p>Specifies the index of the video stream to read. If the value is -1,
the most suitable video stream will be automatically selected. The default
value is "-1". Deprecated. If the filter is called "amovie", it will select
audio instead of video.
</p>
</dd>
<dt><samp class="option">loop</samp></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><samp class="option">discontinuity</samp></dt>
<dd><p>Specifies the time difference between frames above which the point is
considered a timestamp discontinuity which is removed by adjusting the later
timestamps.
</p>
</dd>
<dt><samp class="option">dec_threads</samp></dt>
<dd><p>Specifies the number of threads for decoding
</p>
</dd>
<dt><samp class="option">format_opts</samp></dt>
<dd><p>Specify format options for the opened file. Format options can be specified
as a list of <var class="var">key</var>=<var class="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-preformatted">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-preformatted">input -----------> deltapts0 --> overlay --> output
^
|
movie --> scale--> deltapts1 -------+
</pre></div>
<ul class="mini-toc">
<li><a href="#Examples-189" accesskey="1">Examples</a></li>
<li><a href="#Commands-165" accesskey="2">Commands</a></li>
</ul>
<div class="subsection-level-extent" id="Examples-189">
<h4 class="subsection">38.3.1 Examples</h4>
<ul class="itemize mark-bullet">
<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-preformatted">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-preformatted">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-preformatted">movie=dvd.vob:s=v:0+#0x81 [video] [audio]
</pre></div>
</li></ul>
</div>
<div class="subsection-level-extent" id="Commands-165">
<h4 class="subsection">38.3.2 Commands</h4>
<p>Both movie and amovie support the following commands:
</p><dl class="table">
<dt><samp class="option">seek</samp></dt>
<dd><p>Perform seek using "av_seek_frame".
The syntax is: seek <var class="var">stream_index</var>|<var class="var">timestamp</var>|<var class="var">flags</var>
</p><ul class="itemize mark-bullet">
<li><var class="var">stream_index</var>: If stream_index is -1, a default
stream is selected, and <var class="var">timestamp</var> is automatically converted
from AV_TIME_BASE units to the stream specific time_base.
</li><li><var class="var">timestamp</var>: Timestamp in AVStream.time_base units
or, if no stream is specified, in AV_TIME_BASE units.
</li><li><var class="var">flags</var>: Flags which select direction and seeking mode.
</li></ul>
</dd>
<dt><samp class="option">get_duration</samp></dt>
<dd><p>Get movie duration in AV_TIME_BASE units.
</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="chapter-level-extent" id="External-libraries">
<h2 class="chapter">39 External libraries</h2>
<p>FFmpeg can be hooked up with a number of external libraries to add support
for more formats. None of them are used by default, their use has to be
explicitly requested by passing the appropriate flags to
<code class="command">./configure</code>.
</p>
<ul class="mini-toc">
<li><a href="#Alliance-for-Open-Media-_0028AOM_0029" accesskey="1">Alliance for Open Media (AOM)</a></li>
<li><a href="#AMD-AMF_002fVCE" accesskey="2">AMD AMF/VCE</a></li>
<li><a href="#AviSynth" accesskey="3">AviSynth</a></li>
<li><a href="#Chromaprint" accesskey="4">Chromaprint</a></li>
<li><a href="#codec2" accesskey="5">codec2</a></li>
<li><a href="#dav1d" accesskey="6">dav1d</a></li>
<li><a href="#davs2" accesskey="7">davs2</a></li>
<li><a href="#uavs3d" accesskey="8">uavs3d</a></li>
<li><a href="#Game-Music-Emu" accesskey="9">Game Music Emu</a></li>
<li><a href="#Intel-QuickSync-Video">Intel QuickSync Video</a></li>
<li><a href="#Kvazaar">Kvazaar</a></li>
<li><a href="#LAME">LAME</a></li>
<li><a href="#libilbc-1">libilbc</a></li>
<li><a href="#libjxl">libjxl</a></li>
<li><a href="#libvpx">libvpx</a></li>
<li><a href="#ModPlug">ModPlug</a></li>
<li><a href="#OpenCORE_002c-VisualOn_002c-and-Fraunhofer-libraries">OpenCORE, VisualOn, and Fraunhofer libraries</a></li>
<li><a href="#OpenH264">OpenH264</a></li>
<li><a href="#OpenJPEG">OpenJPEG</a></li>
<li><a href="#rav1e">rav1e</a></li>
<li><a href="#SVT_002dAV1">SVT-AV1</a></li>
<li><a href="#TwoLAME">TwoLAME</a></li>
<li><a href="#VapourSynth">VapourSynth</a></li>
<li><a href="#x264">x264</a></li>
<li><a href="#x265">x265</a></li>
<li><a href="#xavs">xavs</a></li>
<li><a href="#xavs2">xavs2</a></li>
<li><a href="#ZVBI">ZVBI</a></li>
</ul>
<div class="section-level-extent" id="Alliance-for-Open-Media-_0028AOM_0029">
<h3 class="section">39.1 Alliance for Open Media (AOM)</h3>
<p>FFmpeg can make use of the AOM library for AV1 decoding and encoding.
</p>
<p>Go to <a class="url" href="http://aomedia.org/">http://aomedia.org/</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libaom</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="AMD-AMF_002fVCE">
<h3 class="section">39.2 AMD AMF/VCE</h3>
<p>FFmpeg can use the AMD Advanced Media Framework library
for accelerated H.264 and HEVC(only windows) encoding on hardware with Video Coding Engine (VCE).
</p>
<p>To enable support you must obtain the AMF framework header files(version 1.4.9+) from
<a class="url" href="https://github.com/GPUOpen-LibrariesAndSDKs/AMF.git">https://github.com/GPUOpen-LibrariesAndSDKs/AMF.git</a>.
</p>
<p>Create an <code class="code">AMF/</code> directory in the system include path.
Copy the contents of <code class="code">AMF/amf/public/include/</code> into that directory.
Then configure FFmpeg with <code class="code">--enable-amf</code>.
</p>
<p>Initialization of amf encoder occurs in this order:
1) trying to initialize through dx11(only windows)
2) trying to initialize through dx9(only windows)
3) trying to initialize through vulkan
</p>
<p>To use h.264(AMD VCE) encoder on linux amdgru-pro version 19.20+ and amf-amdgpu-pro
package(amdgru-pro contains, but does not install automatically) are required.
</p>
<p>This driver can be installed using amdgpu-pro-install script in official amd driver archive.
</p>
</div>
<div class="section-level-extent" id="AviSynth">
<h3 class="section">39.3 AviSynth</h3>
<p>FFmpeg can read AviSynth scripts as input. To enable support, pass
<code class="code">--enable-avisynth</code> to configure after installing the headers
provided by <a class="url" href="https://github.com/AviSynth/AviSynthPlus">AviSynth+</a>.
AviSynth+ can be configured to install only the headers by either
passing <code class="code">-DHEADERS_ONLY:bool=on</code> to the normal CMake-based build
system, or by using the supplied <code class="code">GNUmakefile</code>.
</p>
<p>For Windows, supported AviSynth variants are
<a class="url" href="http://avisynth.nl">AviSynth 2.6 RC1 or higher</a> for 32-bit builds and
<a class="url" href="http://avisynth.nl/index.php/AviSynth+">AviSynth+ r1718 or higher</a> for 32-bit and 64-bit builds.
</p>
<p>For Linux, macOS, and BSD, the only supported AviSynth variant is
<a class="url" href="https://github.com/AviSynth/AviSynthPlus">AviSynth+</a>, starting with version 3.5.
</p>
<div class="info">
<p>In 2016, AviSynth+ added support for building with GCC. However, due to
the eccentricities of Windows’ calling conventions, 32-bit GCC builds
of AviSynth+ are not compatible with typical 32-bit builds of FFmpeg.
</p>
<p>By default, FFmpeg assumes compatibility with 32-bit MSVC builds of
AviSynth+ since that is the most widely-used and entrenched build
configuration. Users can override this and enable support for 32-bit
GCC builds of AviSynth+ by passing <code class="code">-DAVSC_WIN32_GCC32</code> to
<code class="code">--extra-cflags</code> when configuring FFmpeg.
</p>
<p>64-bit builds of FFmpeg are not affected, and can use either MSVC or
GCC builds of AviSynth+ without any special flags.
</p></div>
<div class="info">
<p>AviSynth(+) is loaded dynamically. Distributors can build FFmpeg
with <code class="code">--enable-avisynth</code>, and the binaries will work regardless
of the end user having AviSynth installed. If/when an end user
would like to use AviSynth scripts, then they can install AviSynth(+)
and FFmpeg will be able to find and use it to open scripts.
</p></div>
</div>
<div class="section-level-extent" id="Chromaprint">
<h3 class="section">39.4 Chromaprint</h3>
<p>FFmpeg can make use of the Chromaprint library for generating audio fingerprints.
Pass <code class="code">--enable-chromaprint</code> to configure to
enable it. See <a class="url" href="https://acoustid.org/chromaprint">https://acoustid.org/chromaprint</a>.
</p>
</div>
<div class="section-level-extent" id="codec2">
<h3 class="section">39.5 codec2</h3>
<p>FFmpeg can make use of the codec2 library for codec2 decoding and encoding.
There is currently no native decoder, so libcodec2 must be used for decoding.
</p>
<p>Go to <a class="url" href="http://freedv.org/">http://freedv.org/</a>, download "Codec 2 source archive".
Build and install using CMake. Debian users can install the libcodec2-dev package instead.
Once libcodec2 is installed you can pass <code class="code">--enable-libcodec2</code> to configure to enable it.
</p>
<p>The easiest way to use codec2 is with .c2 files, since they contain the mode information required for decoding.
To encode such a file, use a .c2 file extension and give the libcodec2 encoder the -mode option:
<code class="code">ffmpeg -i input.wav -mode 700C output.c2</code>.
Playback is as simple as <code class="code">ffplay output.c2</code>.
For a list of supported modes, run <code class="code">ffmpeg -h encoder=libcodec2</code>.
Raw codec2 files are also supported.
To make sense of them the mode in use needs to be specified as a format option:
<code class="code">ffmpeg -f codec2raw -mode 1300 -i input.raw output.wav</code>.
</p>
</div>
<div class="section-level-extent" id="dav1d">
<h3 class="section">39.6 dav1d</h3>
<p>FFmpeg can make use of the dav1d library for AV1 video decoding.
</p>
<p>Go to <a class="url" href="https://code.videolan.org/videolan/dav1d">https://code.videolan.org/videolan/dav1d</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libdav1d</code> to configure to enable it.
</p>
</div>
<div class="section-level-extent" id="davs2">
<h3 class="section">39.7 davs2</h3>
<p>FFmpeg can make use of the davs2 library for AVS2-P2/IEEE1857.4 video decoding.
</p>
<p>Go to <a class="url" href="https://github.com/pkuvcl/davs2">https://github.com/pkuvcl/davs2</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libdavs2</code> to configure to
enable it.
</p>
<div class="info">
<p>libdavs2 is under the GNU Public License Version 2 or later
(see <a class="url" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">http://www.gnu.org/licenses/old-licenses/gpl-2.0.html</a> for
details), you must upgrade FFmpeg’s license to GPL in order to use it.
</p></div>
</div>
<div class="section-level-extent" id="uavs3d">
<h3 class="section">39.8 uavs3d</h3>
<p>FFmpeg can make use of the uavs3d library for AVS3-P2/IEEE1857.10 video decoding.
</p>
<p>Go to <a class="url" href="https://github.com/uavs3/uavs3d">https://github.com/uavs3/uavs3d</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libuavs3d</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="Game-Music-Emu">
<h3 class="section">39.9 Game Music Emu</h3>
<p>FFmpeg can make use of the Game Music Emu library to read audio from supported video game
music file formats. Pass <code class="code">--enable-libgme</code> to configure to
enable it. See <a class="url" href="https://bitbucket.org/mpyne/game-music-emu/overview">https://bitbucket.org/mpyne/game-music-emu/overview</a>.
</p>
</div>
<div class="section-level-extent" id="Intel-QuickSync-Video">
<h3 class="section">39.10 Intel QuickSync Video</h3>
<p>FFmpeg can use Intel QuickSync Video (QSV) for accelerated decoding and encoding
of multiple codecs. To use QSV, FFmpeg must be linked against the <code class="code">libmfx</code>
dispatcher, which loads the actual decoding libraries.
</p>
<p>The dispatcher is open source and can be downloaded from
<a class="url" href="https://github.com/lu-zero/mfx_dispatch.git">https://github.com/lu-zero/mfx_dispatch.git</a>. FFmpeg needs to be configured
with the <code class="code">--enable-libmfx</code> option and <code class="code">pkg-config</code> needs to be able to
locate the dispatcher’s <code class="code">.pc</code> files.
</p>
</div>
<div class="section-level-extent" id="Kvazaar">
<h3 class="section">39.11 Kvazaar</h3>
<p>FFmpeg can make use of the Kvazaar library for HEVC encoding.
</p>
<p>Go to <a class="url" href="https://github.com/ultravideo/kvazaar">https://github.com/ultravideo/kvazaar</a> and follow the
instructions for installing the library. Then pass
<code class="code">--enable-libkvazaar</code> to configure to enable it.
</p>
</div>
<div class="section-level-extent" id="LAME">
<h3 class="section">39.12 LAME</h3>
<p>FFmpeg can make use of the LAME library for MP3 encoding.
</p>
<p>Go to <a class="url" href="http://lame.sourceforge.net/">http://lame.sourceforge.net/</a> and follow the
instructions for installing the library.
Then pass <code class="code">--enable-libmp3lame</code> to configure to enable it.
</p>
</div>
<div class="section-level-extent" id="libilbc-1">
<h3 class="section">39.13 libilbc</h3>
<p>iLBC is a narrowband speech codec that has been made freely available
by Google as part of the WebRTC project. libilbc is a packaging friendly
copy of the iLBC codec. FFmpeg can make use of the libilbc library for
iLBC decoding and encoding.
</p>
<p>Go to <a class="url" href="https://github.com/TimothyGu/libilbc">https://github.com/TimothyGu/libilbc</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libilbc</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="libjxl">
<h3 class="section">39.14 libjxl</h3>
<p>JPEG XL is an image format intended to fully replace legacy JPEG for an extended
period of life. See <a class="url" href="https://jpegxl.info/">https://jpegxl.info/</a> for more information, and see
<a class="url" href="https://github.com/libjxl/libjxl">https://github.com/libjxl/libjxl</a> for the library source. You can pass
<code class="code">--enable-libjxl</code> to configure in order enable the libjxl wrapper.
</p>
</div>
<div class="section-level-extent" id="libvpx">
<h3 class="section">39.15 libvpx</h3>
<p>FFmpeg can make use of the libvpx library for VP8/VP9 decoding and encoding.
</p>
<p>Go to <a class="url" href="http://www.webmproject.org/">http://www.webmproject.org/</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libvpx</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="ModPlug">
<h3 class="section">39.16 ModPlug</h3>
<p>FFmpeg can make use of this library, originating in Modplug-XMMS, to read from MOD-like music files.
See <a class="url" href="https://github.com/Konstanty/libmodplug">https://github.com/Konstanty/libmodplug</a>. Pass <code class="code">--enable-libmodplug</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="OpenCORE_002c-VisualOn_002c-and-Fraunhofer-libraries">
<h3 class="section">39.17 OpenCORE, VisualOn, and Fraunhofer libraries</h3>
<p>Spun off Google Android sources, OpenCore, VisualOn and Fraunhofer
libraries provide encoders for a number of audio codecs.
</p>
<div class="info">
<p>OpenCORE and VisualOn libraries are under the Apache License 2.0
(see <a class="url" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> for details), which is
incompatible to the LGPL version 2.1 and GPL version 2. You have to
upgrade FFmpeg’s license to LGPL version 3 (or if you have enabled
GPL components, GPL version 3) by passing <code class="code">--enable-version3</code> to configure in
order to use it.
</p>
<p>The license of the Fraunhofer AAC library is incompatible with the GPL.
Therefore, for GPL builds, you have to pass <code class="code">--enable-nonfree</code> to
configure in order to use it. To the best of our knowledge, it is
compatible with the LGPL.
</p></div>
<ul class="mini-toc">
<li><a href="#OpenCORE-AMR" accesskey="1">OpenCORE AMR</a></li>
<li><a href="#VisualOn-AMR_002dWB-encoder-library" accesskey="2">VisualOn AMR-WB encoder library</a></li>
<li><a href="#Fraunhofer-AAC-library" accesskey="3">Fraunhofer AAC library</a></li>
</ul>
<div class="subsection-level-extent" id="OpenCORE-AMR">
<h4 class="subsection">39.17.1 OpenCORE AMR</h4>
<p>FFmpeg can make use of the OpenCORE libraries for AMR-NB
decoding/encoding and AMR-WB decoding.
</p>
<p>Go to <a class="url" href="http://sourceforge.net/projects/opencore-amr/">http://sourceforge.net/projects/opencore-amr/</a> and follow the
instructions for installing the libraries.
Then pass <code class="code">--enable-libopencore-amrnb</code> and/or
<code class="code">--enable-libopencore-amrwb</code> to configure to enable them.
</p>
</div>
<div class="subsection-level-extent" id="VisualOn-AMR_002dWB-encoder-library">
<h4 class="subsection">39.17.2 VisualOn AMR-WB encoder library</h4>
<p>FFmpeg can make use of the VisualOn AMR-WBenc library for AMR-WB encoding.
</p>
<p>Go to <a class="url" href="http://sourceforge.net/projects/opencore-amr/">http://sourceforge.net/projects/opencore-amr/</a> and follow the
instructions for installing the library.
Then pass <code class="code">--enable-libvo-amrwbenc</code> to configure to enable it.
</p>
</div>
<div class="subsection-level-extent" id="Fraunhofer-AAC-library">
<h4 class="subsection">39.17.3 Fraunhofer AAC library</h4>
<p>FFmpeg can make use of the Fraunhofer AAC library for AAC decoding & encoding.
</p>
<p>Go to <a class="url" href="http://sourceforge.net/projects/opencore-amr/">http://sourceforge.net/projects/opencore-amr/</a> and follow the
instructions for installing the library.
Then pass <code class="code">--enable-libfdk-aac</code> to configure to enable it.
</p>
</div>
</div>
<div class="section-level-extent" id="OpenH264">
<h3 class="section">39.18 OpenH264</h3>
<p>FFmpeg can make use of the OpenH264 library for H.264 decoding and encoding.
</p>
<p>Go to <a class="url" href="http://www.openh264.org/">http://www.openh264.org/</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libopenh264</code> to configure to
enable it.
</p>
<p>For decoding, this library is much more limited than the built-in decoder
in libavcodec; currently, this library lacks support for decoding B-frames
and some other main/high profile features. (It currently only supports
constrained baseline profile and CABAC.) Using it is mostly useful for
testing and for taking advantage of Cisco’s patent portfolio license
(<a class="url" href="http://www.openh264.org/BINARY_LICENSE.txt">http://www.openh264.org/BINARY_LICENSE.txt</a>).
</p>
</div>
<div class="section-level-extent" id="OpenJPEG">
<h3 class="section">39.19 OpenJPEG</h3>
<p>FFmpeg can use the OpenJPEG libraries for decoding/encoding J2K videos. Go to
<a class="url" href="http://www.openjpeg.org/">http://www.openjpeg.org/</a> to get the libraries and follow the installation
instructions. To enable using OpenJPEG in FFmpeg, pass <code class="code">--enable-libopenjpeg</code> to
<samp class="file">./configure</samp>.
</p>
</div>
<div class="section-level-extent" id="rav1e">
<h3 class="section">39.20 rav1e</h3>
<p>FFmpeg can make use of rav1e (Rust AV1 Encoder) via its C bindings to encode videos.
Go to <a class="url" href="https://github.com/xiph/rav1e/">https://github.com/xiph/rav1e/</a> and follow the instructions to build
the C library. To enable using rav1e in FFmpeg, pass <code class="code">--enable-librav1e</code>
to <samp class="file">./configure</samp>.
</p>
</div>
<div class="section-level-extent" id="SVT_002dAV1">
<h3 class="section">39.21 SVT-AV1</h3>
<p>FFmpeg can make use of the Scalable Video Technology for AV1 library for AV1 encoding.
</p>
<p>Go to <a class="url" href="https://gitlab.com/AOMediaCodec/SVT-AV1/">https://gitlab.com/AOMediaCodec/SVT-AV1/</a> and follow the instructions
for installing the library. Then pass <code class="code">--enable-libsvtav1</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="TwoLAME">
<h3 class="section">39.22 TwoLAME</h3>
<p>FFmpeg can make use of the TwoLAME library for MP2 encoding.
</p>
<p>Go to <a class="url" href="http://www.twolame.org/">http://www.twolame.org/</a> and follow the
instructions for installing the library.
Then pass <code class="code">--enable-libtwolame</code> to configure to enable it.
</p>
</div>
<div class="section-level-extent" id="VapourSynth">
<h3 class="section">39.23 VapourSynth</h3>
<p>FFmpeg can read VapourSynth scripts as input. To enable support, pass
<code class="code">--enable-vapoursynth</code> to configure. Vapoursynth is detected via
<code class="code">pkg-config</code>. Versions 42 or greater supported.
See <a class="url" href="http://www.vapoursynth.com/">http://www.vapoursynth.com/</a>.
</p>
<p>Due to security concerns, Vapoursynth scripts will not
be autodetected so the input format has to be forced. For ff* CLI tools,
add <code class="code">-f vapoursynth</code> before the input <code class="code">-i yourscript.vpy</code>.
</p>
</div>
<div class="section-level-extent" id="x264">
<h3 class="section">39.24 x264</h3>
<p>FFmpeg can make use of the x264 library for H.264 encoding.
</p>
<p>Go to <a class="url" href="http://www.videolan.org/developers/x264.html">http://www.videolan.org/developers/x264.html</a> and follow the
instructions for installing the library. Then pass <code class="code">--enable-libx264</code> to
configure to enable it.
</p>
<div class="info">
<p>x264 is under the GNU Public License Version 2 or later
(see <a class="url" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">http://www.gnu.org/licenses/old-licenses/gpl-2.0.html</a> for
details), you must upgrade FFmpeg’s license to GPL in order to use it.
</p></div>
</div>
<div class="section-level-extent" id="x265">
<h3 class="section">39.25 x265</h3>
<p>FFmpeg can make use of the x265 library for HEVC encoding.
</p>
<p>Go to <a class="url" href="http://x265.org/developers.html">http://x265.org/developers.html</a> and follow the instructions
for installing the library. Then pass <code class="code">--enable-libx265</code> to configure
to enable it.
</p>
<div class="info">
<p>x265 is under the GNU Public License Version 2 or later
(see <a class="url" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">http://www.gnu.org/licenses/old-licenses/gpl-2.0.html</a> for
details), you must upgrade FFmpeg’s license to GPL in order to use it.
</p></div>
</div>
<div class="section-level-extent" id="xavs">
<h3 class="section">39.26 xavs</h3>
<p>FFmpeg can make use of the xavs library for AVS encoding.
</p>
<p>Go to <a class="url" href="http://xavs.sf.net/">http://xavs.sf.net/</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libxavs</code> to configure to
enable it.
</p>
</div>
<div class="section-level-extent" id="xavs2">
<h3 class="section">39.27 xavs2</h3>
<p>FFmpeg can make use of the xavs2 library for AVS2-P2/IEEE1857.4 video encoding.
</p>
<p>Go to <a class="url" href="https://github.com/pkuvcl/xavs2">https://github.com/pkuvcl/xavs2</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libxavs2</code> to configure to
enable it.
</p>
<div class="info">
<p>libxavs2 is under the GNU Public License Version 2 or later
(see <a class="url" href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">http://www.gnu.org/licenses/old-licenses/gpl-2.0.html</a> for
details), you must upgrade FFmpeg’s license to GPL in order to use it.
</p></div>
</div>
<div class="section-level-extent" id="ZVBI">
<h3 class="section">39.28 ZVBI</h3>
<p>ZVBI is a VBI decoding library which can be used by FFmpeg to decode DVB
teletext pages and DVB teletext subtitles.
</p>
<p>Go to <a class="url" href="http://sourceforge.net/projects/zapping/">http://sourceforge.net/projects/zapping/</a> and follow the instructions for
installing the library. Then pass <code class="code">--enable-libzvbi</code> to configure to
enable it.
</p>
</div>
</div>
<div class="chapter-level-extent" id="Supported-File-Formats_002c-Codecs-or-Features">
<h2 class="chapter">40 Supported File Formats, Codecs or Features</h2>
<p>You can use the <code class="code">-formats</code> and <code class="code">-codecs</code> options to have an exhaustive list.
</p>
<ul class="mini-toc">
<li><a href="#File-Formats" accesskey="1">File Formats</a></li>
<li><a href="#Image-Formats" accesskey="2">Image Formats</a></li>
<li><a href="#Video-Codecs" accesskey="3">Video Codecs</a></li>
<li><a href="#Audio-Codecs" accesskey="4">Audio Codecs</a></li>
<li><a href="#Subtitle-Formats" accesskey="5">Subtitle Formats</a></li>
<li><a href="#Network-Protocols" accesskey="6">Network Protocols</a></li>
<li><a href="#Input_002fOutput-Devices" accesskey="7">Input/Output Devices</a></li>
<li><a href="#Timecode" accesskey="8">Timecode</a></li>
</ul>
<div class="section-level-extent" id="File-Formats">
<h3 class="section">40.1 File Formats</h3>
<p>FFmpeg supports the following file formats through the <code class="code">libavformat</code>
library:
</p>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Encoding</td><td width="10%">Decoding</td><td width="40%">Comments</td></tr>
<tr><td width="40%">3dostr</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">4xm</td><td width="10%"></td><td width="10%">X</td><td width="40%">4X Technologies format, used in some games.</td></tr>
<tr><td width="40%">8088flex TMV</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">AAX</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audible Enhanced Audio format, used in audiobooks.</td></tr>
<tr><td width="40%">AA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audible Format 2, 3, and 4, used in audiobooks.</td></tr>
<tr><td width="40%">ACT Voice</td><td width="10%"></td><td width="10%">X</td><td width="40%">contains G.729 audio</td></tr>
<tr><td width="40%">Adobe Filmstrip</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Audio IFF (AIFF)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">American Laser Games MM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used in games like Mad Dog McCree.</td></tr>
<tr><td width="40%">3GPP AMR</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Amazing Studio Packed Animation File</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used in game Heart Of Darkness.</td></tr>
<tr><td width="40%">Apple HTTP Live Streaming</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Artworx Data Format</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Interplay ACM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio only format used in some Interplay games.</td></tr>
<tr><td width="40%">ADP</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the Nintendo Gamecube.</td></tr>
<tr><td width="40%">AFC</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the Nintendo Gamecube.</td></tr>
<tr><td width="40%">ADS/SS2</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the PS2.</td></tr>
<tr><td width="40%">APNG</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ASF</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Advanced / Active Streaming Format.</td></tr>
<tr><td width="40%">AST</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Audio format used on the Nintendo Wii.</td></tr>
<tr><td width="40%">AVI</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">AviSynth</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">AVR</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on Mac.</td></tr>
<tr><td width="40%">AVS</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used by the Creature Shock game.</td></tr>
<tr><td width="40%">Beam Software SIFF</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio and video format used in some games by Beam Software.</td></tr>
<tr><td width="40%">Bethesda Softworks VID</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some games from Bethesda Softworks.</td></tr>
<tr><td width="40%">Binary text</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Bink</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used by many games.</td></tr>
<tr><td width="40%">Bink Audio</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio only multimedia format used by some games.</td></tr>
<tr><td width="40%">Bitmap Brothers JV</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Z and Z95 games.</td></tr>
<tr><td width="40%">BRP</td><td width="10%"></td><td width="10%">X</td><td width="40%">Argonaut Games format.</td></tr>
<tr><td width="40%">Brute Force & Ignorance</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in the game Flash Traffic: City of Angels.</td></tr>
<tr><td width="40%">BFSTM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the Nintendo WiiU (based on BRSTM).</td></tr>
<tr><td width="40%">BRSTM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the Nintendo Wii.</td></tr>
<tr><td width="40%">BW64</td><td width="10%"></td><td width="10%">X</td><td width="40%">Broadcast Wave 64bit.</td></tr>
<tr><td width="40%">BWF</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">codec2 (raw)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Must be given -mode format option to decode correctly.</td></tr>
<tr><td width="40%">codec2 (.c2 files)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Contains header with version and mode info, simplifying playback.</td></tr>
<tr><td width="40%">CRI ADX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Audio-only format used in console video games.</td></tr>
<tr><td width="40%">CRI AIX</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">CRI HCA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio-only format used in console video games.</td></tr>
<tr><td width="40%">Discworld II BMV</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Interplay C93</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in the game Cyberia from Interplay.</td></tr>
<tr><td width="40%">Delphine Software International CIN</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used by Delphine Software games.</td></tr>
<tr><td width="40%">Digital Speech Standard (DSS)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">CD+G</td><td width="10%"></td><td width="10%">X</td><td width="40%">Video format used by CD+G karaoke disks</td></tr>
<tr><td width="40%">Phantom Cine</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Commodore CDXL</td><td width="10%"></td><td width="10%">X</td><td width="40%">Amiga CD video format</td></tr>
<tr><td width="40%">Core Audio Format</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Apple Core Audio Format</td></tr>
<tr><td width="40%">CRC testing format</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">Creative Voice</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Created for the Sound Blaster Pro.</td></tr>
<tr><td width="40%">CRYO APC</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used in some games by CRYO Interactive Entertainment.</td></tr>
<tr><td width="40%">D-Cinema audio</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Deluxe Paint Animation</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DCSTR</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DFA</td><td width="10%"></td><td width="10%">X</td><td width="40%">This format is used in Chronomaster game</td></tr>
<tr><td width="40%">DirectDraw Surface</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSD Stream File (DSF)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DV video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">DXA</td><td width="10%"></td><td width="10%">X</td><td width="40%">This format is used in the non-Windows version of the Feeble Files
game and different game cutscenes repacked for use with ScummVM.</td></tr>
<tr><td width="40%">Electronic Arts cdata</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Electronic Arts Multimedia</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in various EA games; files have extensions like WVE and UV2.</td></tr>
<tr><td width="40%">Ensoniq Paris Audio File</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">FFM (FFserver live feed)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Flash (SWF)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Flash 9 (AVM2)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Only embedded audio is decoded.</td></tr>
<tr><td width="40%">FLI/FLC/FLX animation</td><td width="10%"></td><td width="10%">X</td><td width="40%">.fli/.flc files</td></tr>
<tr><td width="40%">Flash Video (FLV)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Macromedia Flash video files</td></tr>
<tr><td width="40%">framecrc testing format</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">FunCom ISS</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used in various games from FunCom like The Longest Journey.</td></tr>
<tr><td width="40%">G.723.1</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">G.726</td><td width="10%"></td><td width="10%">X</td><td width="40%">Both left- and right-justified.</td></tr>
<tr><td width="40%">G.729 BIT</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">G.729 raw</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">GENH</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format for various games.</td></tr>
<tr><td width="40%">GIF Animation</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">GXF</td><td width="10%">X</td><td width="10%">X</td><td width="40%">General eXchange Format SMPTE 360M, used by Thomson Grass Valley
playout servers.</td></tr>
<tr><td width="40%">HNM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Only version 4 supported, used in some games from Cryo Interactive</td></tr>
<tr><td width="40%">iCEDraw File</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ICO</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Microsoft Windows ICO</td></tr>
<tr><td width="40%">id Quake II CIN video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">id RoQ</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Quake III, Jedi Knight 2 and other computer games.</td></tr>
<tr><td width="40%">IEC61937 encapsulation</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">IFF</td><td width="10%"></td><td width="10%">X</td><td width="40%">Interchange File Format</td></tr>
<tr><td width="40%">IFV</td><td width="10%"></td><td width="10%">X</td><td width="40%">A format used by some old CCTV DVRs.</td></tr>
<tr><td width="40%">iLBC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Interplay MVE</td><td width="10%"></td><td width="10%">X</td><td width="40%">Format used in various Interplay computer games.</td></tr>
<tr><td width="40%">Iterated Systems ClearVideo</td><td width="10%"></td><td width="10%">X</td><td width="40%">I-frames only</td></tr>
<tr><td width="40%">IV8</td><td width="10%"></td><td width="10%">X</td><td width="40%">A format generated by IndigoVision 8000 video server.</td></tr>
<tr><td width="40%">IVF (On2)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">A format used by libvpx</td></tr>
<tr><td width="40%">Internet Video Recording</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">IRCAM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">LAF</td><td width="10%"></td><td width="10%">X</td><td width="40%">Limitless Audio Format</td></tr>
<tr><td width="40%">LATM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">LMLM4</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used by Linux Media Labs MPEG-4 PCI boards</td></tr>
<tr><td width="40%">LOAS</td><td width="10%"></td><td width="10%">X</td><td width="40%">contains LATM multiplexed AAC audio</td></tr>
<tr><td width="40%">LRC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">LVF</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">LXF</td><td width="10%"></td><td width="10%">X</td><td width="40%">VR native stream format, used by Leitch/Harris’ video servers.</td></tr>
<tr><td width="40%">Magic Lantern Video (MLV)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Matroska</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Matroska audio</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">FFmpeg metadata</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Metadata in text format.</td></tr>
<tr><td width="40%">MAXIS XA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sim City 3000; file extension .xa.</td></tr>
<tr><td width="40%">MCA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some games from Capcom; file extension .mca.</td></tr>
<tr><td width="40%">MD Studio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Metal Gear Solid: The Twin Snakes</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Megalux Frame</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used by Megalux Ultimate Paint</td></tr>
<tr><td width="40%">MobiClip MODS</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MobiClip MOFLEX</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Mobotix .mxg</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Monkey’s Audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Motion Pixels MVI</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MOV/QuickTime/MP4</td><td width="10%">X</td><td width="10%">X</td><td width="40%">3GP, 3GP2, PSP, iPod variants supported</td></tr>
<tr><td width="40%">MP2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MP3</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-1 System</td><td width="10%">X</td><td width="10%">X</td><td width="40%">muxed audio and video, VCD format supported</td></tr>
<tr><td width="40%">MPEG-PS (program stream)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">also known as <code class="code">VOB</code> file, SVCD and DVD format supported</td></tr>
<tr><td width="40%">MPEG-TS (transport stream)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">also known as DVB Transport Stream</td></tr>
<tr><td width="40%">MPEG-4</td><td width="10%">X</td><td width="10%">X</td><td width="40%">MPEG-4 is a variant of QuickTime.</td></tr>
<tr><td width="40%">MSF</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the PS3.</td></tr>
<tr><td width="40%">Mirillis FIC video</td><td width="10%"></td><td width="10%">X</td><td width="40%">No cursor rendering.</td></tr>
<tr><td width="40%">MIDI Sample Dump Standard</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MIME multipart JPEG</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">MSN TCP webcam</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used by MSN Messenger webcam streams.</td></tr>
<tr><td width="40%">MTV</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Musepack</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Musepack SV8</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Material eXchange Format (MXF)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">SMPTE 377M, used by D-Cinema, broadcast industry.</td></tr>
<tr><td width="40%">Material eXchange Format (MXF), D-10 Mapping</td><td width="10%">X</td><td width="10%">X</td><td width="40%">SMPTE 386M, D-10/IMX Mapping.</td></tr>
<tr><td width="40%">NC camera feed</td><td width="10%"></td><td width="10%">X</td><td width="40%">NC (AVIP NC4600) camera streams</td></tr>
<tr><td width="40%">NIST SPeech HEader REsources</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Computerized Speech Lab NSP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">NTT TwinVQ (VQF)</td><td width="10%"></td><td width="10%">X</td><td width="40%">Nippon Telegraph and Telephone Corporation TwinVQ.</td></tr>
<tr><td width="40%">Nullsoft Streaming Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">NuppelVideo</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">NUT</td><td width="10%">X</td><td width="10%">X</td><td width="40%">NUT Open Container Format</td></tr>
<tr><td width="40%">Ogg</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Playstation Portable PMP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Portable Voice Format</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RK Audio (RKA)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">TechnoTrend PVA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used by TechnoTrend DVB PCI boards.</td></tr>
<tr><td width="40%">QCP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw ADTS (AAC)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw AC-3</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw AMR-NB</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw AMR-WB</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw APAC</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw aptX</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw aptX HD</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw Bonk</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw Chinese AVS video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw DFPWM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw Dirac</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw DNxHD</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw DTS</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw DTS-HD</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw E-AC-3</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw FLAC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw GSM</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw H.261</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw H.263</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw H.264</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw HEVC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw Ingenient MJPEG</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw MJPEG</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw MLP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw MPEG</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw MPEG-1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw MPEG-2</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw MPEG-4</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw NULL</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">raw video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw id RoQ</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">raw OBU</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw OSQ</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw SBC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw Shorten</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw TAK</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw TrueHD</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw VC-1</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM A-law</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM mu-law</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM Archimedes VIDC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 8 bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 16 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 16 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 24 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 24 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 32 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 32 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 64 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM signed 64 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 8 bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 16 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 16 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 24 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 24 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 32 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM unsigned 32 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM 16.8 floating point little-endian</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM 24.0 floating point little-endian</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM floating-point 32 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM floating-point 32 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM floating-point 64 bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">raw PCM floating-point 64 bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RDT</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">REDCODE R3D</td><td width="10%"></td><td width="10%">X</td><td width="40%">File format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.</td></tr>
<tr><td width="40%">RealMedia</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Redirector</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RedSpark</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Renderware TeXture Dictionary</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Resolume DXV</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RF64</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RL2</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio and video format used in some games by Entertainment Software Partners.</td></tr>
<tr><td width="40%">RPL/ARMovie</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Lego Mindstorms RSO</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RSD</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RTMP</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Output is performed by publishing stream to RTMP server</td></tr>
<tr><td width="40%">RTP</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RTSP</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Sample Dump eXchange</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SAP</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SBG</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SDNS</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SDP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SER</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Digital Pictures SGA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sega FILM/CPK</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in many Sega Saturn console games.</td></tr>
<tr><td width="40%">Silicon Graphics Movie</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sierra SOL</td><td width="10%"></td><td width="10%">X</td><td width="40%">.sol files used in Sierra Online games.</td></tr>
<tr><td width="40%">Sierra VMD</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sierra CD-ROM games.</td></tr>
<tr><td width="40%">Smacker</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used by many games.</td></tr>
<tr><td width="40%">SMJPEG</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in certain Loki game ports.</td></tr>
<tr><td width="40%">SMPTE 337M encapsulation</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Smush</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used in some LucasArts games.</td></tr>
<tr><td width="40%">Sony OpenMG (OMA)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Audio format used in Sony Sonic Stage and Sony Vegas.</td></tr>
<tr><td width="40%">Sony PlayStation STR</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sony Wave64 (W64)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SoX native format</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SUN AU format</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SUP raw PGS subtitles</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SVAG</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used in Konami PS2 games.</td></tr>
<tr><td width="40%">TDSC</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Text files</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">THP</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used on the Nintendo GameCube.</td></tr>
<tr><td width="40%">Tiertex Limited SEQ</td><td width="10%"></td><td width="10%">X</td><td width="40%">Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.</td></tr>
<tr><td width="40%">True Audio</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">VAG</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used in many Sony PS2 games.</td></tr>
<tr><td width="40%">VC-1 test bitstream</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Vidvox Hap</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Vivo</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">VPK</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used in Sony PS games.</td></tr>
<tr><td width="40%">Marble WADY</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WAV</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Waveform Archiver</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WavPack</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">WebM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Televison (WTV)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Wing Commander III movie</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used in Origin’s Wing Commander III computer game.</td></tr>
<tr><td width="40%">Westwood Studios audio</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Multimedia format used in Westwood Studios games.</td></tr>
<tr><td width="40%">Westwood Studios VQA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Multimedia format used in Westwood Studios games.</td></tr>
<tr><td width="40%">Wideband Single-bit Data (WSD)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WVE</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Konami XMD</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">XMV</td><td width="10%"></td><td width="10%">X</td><td width="40%">Microsoft video container used in Xbox games.</td></tr>
<tr><td width="40%">XVAG</td><td width="10%"></td><td width="10%">X</td><td width="40%">Audio format used on the PS3.</td></tr>
<tr><td width="40%">xWMA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Microsoft audio container used by XAudio 2.</td></tr>
<tr><td width="40%">eXtended BINary text (XBIN)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">YUV4MPEG pipe</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Psygnosis YOP</td><td width="10%"></td><td width="10%">X</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the feature in that column (encoding / decoding) is supported.
</p>
</div>
<div class="section-level-extent" id="Image-Formats">
<h3 class="section">40.2 Image Formats</h3>
<p>FFmpeg can read and write images for each frame of a video sequence. The
following image formats are supported:
</p>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Encoding</td><td width="10%">Decoding</td><td width="40%">Comments</td></tr>
<tr><td width="40%">.Y.U.V</td><td width="10%">X</td><td width="10%">X</td><td width="40%">one raw file per component</td></tr>
<tr><td width="40%">Alias PIX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Alias/Wavefront PIX image format</td></tr>
<tr><td width="40%">animated GIF</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">APNG</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Animated Portable Network Graphics</td></tr>
<tr><td width="40%">BMP</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Microsoft BMP image</td></tr>
<tr><td width="40%">BRender PIX</td><td width="10%"></td><td width="10%">X</td><td width="40%">Argonaut BRender 3D engine image format.</td></tr>
<tr><td width="40%">CRI</td><td width="10%"></td><td width="10%">X</td><td width="40%">Cintel RAW</td></tr>
<tr><td width="40%">DPX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Digital Picture Exchange</td></tr>
<tr><td width="40%">EXR</td><td width="10%"></td><td width="10%">X</td><td width="40%">OpenEXR</td></tr>
<tr><td width="40%">FITS</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Flexible Image Transport System</td></tr>
<tr><td width="40%">HDR</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Radiance HDR RGBE Image format</td></tr>
<tr><td width="40%">IMG</td><td width="10%"></td><td width="10%">X</td><td width="40%">GEM Raster image</td></tr>
<tr><td width="40%">JPEG</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Progressive JPEG is not supported.</td></tr>
<tr><td width="40%">JPEG 2000</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">JPEG-LS</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">LJPEG</td><td width="10%">X</td><td width="10%"></td><td width="40%">Lossless JPEG</td></tr>
<tr><td width="40%">Media 100</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MSP</td><td width="10%"></td><td width="10%">X</td><td width="40%">Microsoft Paint image</td></tr>
<tr><td width="40%">PAM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">PAM is a PNM extension with alpha support.</td></tr>
<tr><td width="40%">PBM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable BitMap image</td></tr>
<tr><td width="40%">PCD</td><td width="10%"></td><td width="10%">X</td><td width="40%">PhotoCD</td></tr>
<tr><td width="40%">PCX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">PC Paintbrush</td></tr>
<tr><td width="40%">PFM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable FloatMap image</td></tr>
<tr><td width="40%">PGM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable GrayMap image</td></tr>
<tr><td width="40%">PGMYUV</td><td width="10%">X</td><td width="10%">X</td><td width="40%">PGM with U and V components in YUV 4:2:0</td></tr>
<tr><td width="40%">PGX</td><td width="10%"></td><td width="10%">X</td><td width="40%">PGX file decoder</td></tr>
<tr><td width="40%">PHM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable HalfFloatMap image</td></tr>
<tr><td width="40%">PIC</td><td width="10%"></td><td width="10%">X</td><td width="40%">Pictor/PC Paint</td></tr>
<tr><td width="40%">PNG</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable Network Graphics image</td></tr>
<tr><td width="40%">PPM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Portable PixelMap image</td></tr>
<tr><td width="40%">PSD</td><td width="10%"></td><td width="10%">X</td><td width="40%">Photoshop</td></tr>
<tr><td width="40%">PTX</td><td width="10%"></td><td width="10%">X</td><td width="40%">V.Flash PTX format</td></tr>
<tr><td width="40%">QOI</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Quite OK Image format</td></tr>
<tr><td width="40%">SGI</td><td width="10%">X</td><td width="10%">X</td><td width="40%">SGI RGB image format</td></tr>
<tr><td width="40%">Sun Rasterfile</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Sun RAS image format</td></tr>
<tr><td width="40%">TIFF</td><td width="10%">X</td><td width="10%">X</td><td width="40%">YUV, JPEG and some extension is not supported yet.</td></tr>
<tr><td width="40%">Truevision Targa</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Targa (.TGA) image format</td></tr>
<tr><td width="40%">VBN</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Vizrt Binary Image format</td></tr>
<tr><td width="40%">WBMP</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Wireless Application Protocol Bitmap image format</td></tr>
<tr><td width="40%">WebP</td><td width="10%">E</td><td width="10%">X</td><td width="40%">WebP image format, encoding supported through external library libwebp</td></tr>
<tr><td width="40%">XBM</td><td width="10%">X</td><td width="10%">X</td><td width="40%">X BitMap image format</td></tr>
<tr><td width="40%">XFace</td><td width="10%">X</td><td width="10%">X</td><td width="40%">X-Face image format</td></tr>
<tr><td width="40%">XPM</td><td width="10%"></td><td width="10%">X</td><td width="40%">X PixMap image format</td></tr>
<tr><td width="40%">XWD</td><td width="10%">X</td><td width="10%">X</td><td width="40%">X Window Dump image format</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the feature in that column (encoding / decoding) is supported.
</p>
<p><code class="code">E</code> means that support is provided through an external library.
</p>
</div>
<div class="section-level-extent" id="Video-Codecs">
<h3 class="section">40.3 Video Codecs</h3>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Encoding</td><td width="10%">Decoding</td><td width="40%">Comments</td></tr>
<tr><td width="40%">4X Movie</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in certain computer games.</td></tr>
<tr><td width="40%">8088flex TMV</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">A64 multicolor</td><td width="10%">X</td><td width="10%"></td><td width="40%">Creates video suitable to be played on a commodore 64 (multicolor mode).</td></tr>
<tr><td width="40%">Amazing Studio PAF Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">American Laser Games MM</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in games like Mad Dog McCree.</td></tr>
<tr><td width="40%">Amuse Graphics Movie</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">AMV Video</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Chinese MP3 players.</td></tr>
<tr><td width="40%">ANSI/ASCII art</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Apple Intermediate Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Apple MJPEG-B</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Apple Pixlet</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Apple ProRes</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: apch,apcn,apcs,apco,ap4h,ap4x</td></tr>
<tr><td width="40%">Apple QuickDraw</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: qdrw</td></tr>
<tr><td width="40%">Argonaut Video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some Argonaut games.</td></tr>
<tr><td width="40%">Asus v1</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: ASV1</td></tr>
<tr><td width="40%">Asus v2</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: ASV2</td></tr>
<tr><td width="40%">ATI VCR1</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VCR1</td></tr>
<tr><td width="40%">ATI VCR2</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VCR2</td></tr>
<tr><td width="40%">Auravision Aura</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Auravision Aura 2</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Autodesk Animator Flic video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Autodesk RLE</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: AASC</td></tr>
<tr><td width="40%">AV1</td><td width="10%">E</td><td width="10%">E</td><td width="40%">Supported through external libraries libaom, libdav1d, librav1e and libsvtav1</td></tr>
<tr><td width="40%">Avid 1:1 10-bit RGB Packer</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: AVrp</td></tr>
<tr><td width="40%">AVS (Audio Video Standard) video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Video encoding used by the Creature Shock game.</td></tr>
<tr><td width="40%">AVS2-P2/IEEE1857.4</td><td width="10%">E</td><td width="10%">E</td><td width="40%">Supported through external libraries libxavs2 and libdavs2</td></tr>
<tr><td width="40%">AVS3-P2/IEEE1857.10</td><td width="10%"></td><td width="10%">E</td><td width="40%">Supported through external library libuavs3d</td></tr>
<tr><td width="40%">AYUV</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Microsoft uncompressed packed 4:4:4:4</td></tr>
<tr><td width="40%">Beam Software VB</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Bethesda VID video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some games from Bethesda Softworks.</td></tr>
<tr><td width="40%">Bink Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">BitJazz SheerVideo</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Bitmap Brothers JV video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">y41p Brooktree uncompressed 4:1:1 12-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Brooktree ProSumer Video</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: BT20</td></tr>
<tr><td width="40%">Brute Force & Ignorance</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in the game Flash Traffic: City of Angels.</td></tr>
<tr><td width="40%">C93 video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in Cyberia game.</td></tr>
<tr><td width="40%">CamStudio</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: CSCD</td></tr>
<tr><td width="40%">CD+G</td><td width="10%"></td><td width="10%">X</td><td width="40%">Video codec for CD+G karaoke disks</td></tr>
<tr><td width="40%">CDXL</td><td width="10%"></td><td width="10%">X</td><td width="40%">Amiga CD video codec</td></tr>
<tr><td width="40%">Chinese AVS video</td><td width="10%">E</td><td width="10%">X</td><td width="40%">AVS1-P2, JiZhun profile, encoding through external library libxavs</td></tr>
<tr><td width="40%">Delphine Software International CIN video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in Delphine Software International games.</td></tr>
<tr><td width="40%">Discworld II BMV Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">CineForm HD</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Canopus HQ</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Canopus HQA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Canopus HQX</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Canopus Lossless Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">CDToons</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in various Broderbund games.</td></tr>
<tr><td width="40%">Cinepak</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Cirrus Logic AccuPak</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: CLJR</td></tr>
<tr><td width="40%">CPiA Video Format</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Creative YUV (CYUV)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DFA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in Chronomaster game.</td></tr>
<tr><td width="40%">Dirac</td><td width="10%">E</td><td width="10%">X</td><td width="40%">supported though the native vc2 (Dirac Pro) encoder</td></tr>
<tr><td width="40%">Deluxe Paint Animation</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DNxHD</td><td width="10%">X</td><td width="10%">X</td><td width="40%">aka SMPTE VC3</td></tr>
<tr><td width="40%">Duck TrueMotion 1.0</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: DUCK</td></tr>
<tr><td width="40%">Duck TrueMotion 2.0</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: TM20</td></tr>
<tr><td width="40%">Duck TrueMotion 2.0 RT</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: TR20</td></tr>
<tr><td width="40%">DV (Digital Video)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Dxtory capture format</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Feeble Files/ScummVM DXA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec originally used in Feeble Files game.</td></tr>
<tr><td width="40%">Electronic Arts CMV video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in NHL 95 game.</td></tr>
<tr><td width="40%">Electronic Arts Madcow video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Electronic Arts TGV video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Electronic Arts TGQ video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Electronic Arts TQI video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Escape 124</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Escape 130</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">FFmpeg video codec #1</td><td width="10%">X</td><td width="10%">X</td><td width="40%">lossless codec (fourcc: FFV1)</td></tr>
<tr><td width="40%">Flash Screen Video v1</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: FSV1</td></tr>
<tr><td width="40%">Flash Screen Video v2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Flash Video (FLV)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Sorenson H.263 used in Flash</td></tr>
<tr><td width="40%">FM Screen Capture Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Forward Uncompressed</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Fraps</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Go2Meeting</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: G2M2, G2M3</td></tr>
<tr><td width="40%">Go2Webinar</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: G2M4</td></tr>
<tr><td width="40%">Gremlin Digital Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">H.261</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">H.263 / H.263-1996</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">H.263+ / H.263-1998 / H.263 version 2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libx264 and OpenH264</td></tr>
<tr><td width="40%">HEVC</td><td width="10%">X</td><td width="10%">X</td><td width="40%">encoding supported through external library libx265 and libkvazaar</td></tr>
<tr><td width="40%">HNM version 4</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">HuffYUV</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">HuffYUV FFmpeg variant</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">IBM Ultimotion</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: ULTI</td></tr>
<tr><td width="40%">id Cinematic video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Quake II.</td></tr>
<tr><td width="40%">id RoQ video</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Quake III, Jedi Knight 2, other computer games.</td></tr>
<tr><td width="40%">IFF ILBM</td><td width="10%"></td><td width="10%">X</td><td width="40%">IFF interleaved bitmap</td></tr>
<tr><td width="40%">IFF ByteRun1</td><td width="10%"></td><td width="10%">X</td><td width="40%">IFF run length encoded bitmap</td></tr>
<tr><td width="40%">Infinity IMM4</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Intel H.263</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Intel Indeo 2</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Intel Indeo 3</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Intel Indeo 4</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Intel Indeo 5</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Interplay C93</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in the game Cyberia from Interplay.</td></tr>
<tr><td width="40%">Interplay MVE video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Interplay .MVE files.</td></tr>
<tr><td width="40%">J2K</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Karl Morton’s video codec</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in Worms games.</td></tr>
<tr><td width="40%">Kega Game Video (KGV1)</td><td width="10%"></td><td width="10%">X</td><td width="40%">Kega emulator screen capture codec.</td></tr>
<tr><td width="40%">Lagarith</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">LCL (LossLess Codec Library) MSZH</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">LCL (LossLess Codec Library) ZLIB</td><td width="10%">E</td><td width="10%">E</td></tr>
<tr><td width="40%">LOCO</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">LucasArts SANM/Smush</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in LucasArts games / SMUSH animations.</td></tr>
<tr><td width="40%">lossless MJPEG</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MagicYUV Video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Mandsoft Screen Capture Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Microsoft ATC Screen</td><td width="10%"></td><td width="10%">X</td><td width="40%">Also known as Microsoft Screen 3.</td></tr>
<tr><td width="40%">Microsoft Expression Encoder Screen</td><td width="10%"></td><td width="10%">X</td><td width="40%">Also known as Microsoft Titanium Screen 2.</td></tr>
<tr><td width="40%">Microsoft RLE</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Microsoft Screen 1</td><td width="10%"></td><td width="10%">X</td><td width="40%">Also known as Windows Media Video V7 Screen.</td></tr>
<tr><td width="40%">Microsoft Screen 2</td><td width="10%"></td><td width="10%">X</td><td width="40%">Also known as Windows Media Video V9 Screen.</td></tr>
<tr><td width="40%">Microsoft Video 1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Mimic</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in MSN Messenger Webcam streams.</td></tr>
<tr><td width="40%">Miro VideoXL</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VIXL</td></tr>
<tr><td width="40%">MJPEG (Motion JPEG)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Mobotix MxPEG video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Motion Pixels video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-1 video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-2 video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-4 part 2</td><td width="10%">X</td><td width="10%">X</td><td width="40%">libxvidcore can be used alternatively for encoding.</td></tr>
<tr><td width="40%">MPEG-4 part 2 Microsoft variant version 1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-4 part 2 Microsoft variant version 2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG-4 part 2 Microsoft variant version 3</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Newtek SpeedHQ</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Nintendo Gamecube THP video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">NotchLC</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">NuppelVideo/RTjpeg</td><td width="10%"></td><td width="10%">X</td><td width="40%">Video encoding used in NuppelVideo files.</td></tr>
<tr><td width="40%">On2 VP3</td><td width="10%"></td><td width="10%">X</td><td width="40%">still experimental</td></tr>
<tr><td width="40%">On2 VP4</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VP40</td></tr>
<tr><td width="40%">On2 VP5</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VP50</td></tr>
<tr><td width="40%">On2 VP6</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VP60,VP61,VP62</td></tr>
<tr><td width="40%">On2 VP7</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: VP70,VP71</td></tr>
<tr><td width="40%">VP8</td><td width="10%">E</td><td width="10%">X</td><td width="40%">fourcc: VP80, encoding supported through external library libvpx</td></tr>
<tr><td width="40%">VP9</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libvpx</td></tr>
<tr><td width="40%">Pinnacle TARGA CineWave YUV16</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: Y216</td></tr>
<tr><td width="40%">Q-team QPEG</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourccs: QPEG, Q1.0, Q1.1</td></tr>
<tr><td width="40%">QuickTime 8BPS video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">QuickTime Animation (RLE) video</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: ’rle ’</td></tr>
<tr><td width="40%">QuickTime Graphics (SMC)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: ’smc ’</td></tr>
<tr><td width="40%">QuickTime video (RPZA)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: rpza</td></tr>
<tr><td width="40%">R10K AJA Kona 10-bit RGB Codec</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">R210 Quicktime Uncompressed RGB 10-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Raw Video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RealVideo 1.0</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RealVideo 2.0</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">RealVideo 3.0</td><td width="10%"></td><td width="10%">X</td><td width="40%">still far from ideal</td></tr>
<tr><td width="40%">RealVideo 4.0</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Renderware TXD (TeXture Dictionary)</td><td width="10%"></td><td width="10%">X</td><td width="40%">Texture dictionaries used by the Renderware Engine.</td></tr>
<tr><td width="40%">RivaTuner Video</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: ’RTV1’</td></tr>
<tr><td width="40%">RL2 video</td><td width="10%"></td><td width="10%">X</td><td width="40%">used in some games by Entertainment Software Partners</td></tr>
<tr><td width="40%">ScreenPressor</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Screenpresso</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Screen Recorder Gold Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sierra VMD video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sierra VMD files.</td></tr>
<tr><td width="40%">Silicon Graphics Motion Video Compressor 1 (MVC1)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Silicon Graphics Motion Video Compressor 2 (MVC2)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Silicon Graphics RLE 8-bit video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Smacker video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Video encoding used in Smacker.</td></tr>
<tr><td width="40%">SMPTE VC-1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Snow</td><td width="10%">X</td><td width="10%">X</td><td width="40%">experimental wavelet codec (fourcc: SNOW)</td></tr>
<tr><td width="40%">Sony PlayStation MDEC (Motion DECoder)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sorenson Vector Quantizer 1</td><td width="10%">X</td><td width="10%">X</td><td width="40%">fourcc: SVQ1</td></tr>
<tr><td width="40%">Sorenson Vector Quantizer 3</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: SVQ3</td></tr>
<tr><td width="40%">Sunplus JPEG (SP5X)</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: SP5X</td></tr>
<tr><td width="40%">TechSmith Screen Capture Codec</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: TSCC</td></tr>
<tr><td width="40%">TechSmith Screen Capture Codec 2</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: TSC2</td></tr>
<tr><td width="40%">Theora</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libtheora</td></tr>
<tr><td width="40%">Tiertex Limited SEQ video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in DOS CD-ROM FlashBack game.</td></tr>
<tr><td width="40%">Ut Video</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">v210 QuickTime uncompressed 4:2:2 10-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">v308 QuickTime uncompressed 4:4:4</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">v408 QuickTime uncompressed 4:4:4:4</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">v410 QuickTime uncompressed 4:4:4 10-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">VBLE Lossless Codec</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">vMix Video</td><td width="10%"></td><td width="10%">X</td><td width="40%">fourcc: ’VMX1’</td></tr>
<tr><td width="40%">VMware Screen Codec / VMware Video</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in videos captured by VMware.</td></tr>
<tr><td width="40%">Westwood Studios VQA (Vector Quantized Animation) video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Image</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Video 7</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Video 8</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Video 9</td><td width="10%"></td><td width="10%">X</td><td width="40%">not completely working</td></tr>
<tr><td width="40%">Wing Commander III / Xan</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Wing Commander III .MVE files.</td></tr>
<tr><td width="40%">Wing Commander IV / Xan</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Wing Commander IV.</td></tr>
<tr><td width="40%">Winnov WNV1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WMV7</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">YAMAHA SMAF</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Psygnosis YOP Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">yuv4</td><td width="10%">X</td><td width="10%">X</td><td width="40%">libquicktime uncompressed packed 4:2:0</td></tr>
<tr><td width="40%">ZeroCodec Lossless Video</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ZLIB</td><td width="10%">X</td><td width="10%">X</td><td width="40%">part of LCL, encoder experimental</td></tr>
<tr><td width="40%">Zip Motion Blocks Video</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Encoder works only in PAL8.</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the feature in that column (encoding / decoding) is supported.
</p>
<p><code class="code">E</code> means that support is provided through an external library.
</p>
</div>
<div class="section-level-extent" id="Audio-Codecs">
<h3 class="section">40.4 Audio Codecs</h3>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Encoding</td><td width="10%">Decoding</td><td width="40%">Comments</td></tr>
<tr><td width="40%">8SVX exponential</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">8SVX fibonacci</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">AAC</td><td width="10%">EX</td><td width="10%">X</td><td width="40%">encoding supported through internal encoder and external library libfdk-aac</td></tr>
<tr><td width="40%">AAC+</td><td width="10%">E</td><td width="10%">IX</td><td width="40%">encoding supported through external library libfdk-aac</td></tr>
<tr><td width="40%">AC-3</td><td width="10%">IX</td><td width="10%">IX</td></tr>
<tr><td width="40%">ACELP.KELVIN</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM 4X Movie</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Yamaha AICA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM AmuseGraphics Movie</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Argonaut Games</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM CDROM XA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Creative Technology</td><td width="10%"></td><td width="10%">X</td><td width="40%">16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2</td></tr>
<tr><td width="40%">ADPCM Electronic Arts</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in various EA titles.</td></tr>
<tr><td width="40%">ADPCM Electronic Arts Maxis CDROM XS</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sim City 3000.</td></tr>
<tr><td width="40%">ADPCM Electronic Arts R1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Electronic Arts R2</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Electronic Arts R3</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Electronic Arts XAS</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM G.722</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM G.726</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Acorn Replay</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA AMV</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in AMV files</td></tr>
<tr><td width="40%">ADPCM IMA Cunning Developments</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Electronic Arts EACS</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Electronic Arts SEAD</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Funcom</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA High Voltage Software ALP</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Mobiclip MOFLEX</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA QuickTime</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Simon & Schuster Interactive</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Ubisoft APM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Loki SDL MJPEG</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA WAV</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Westwood</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM ISS IMA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in FunCom games.</td></tr>
<tr><td width="40%">ADPCM IMA Dialogic</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM IMA Duck DK3</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some Sega Saturn console games.</td></tr>
<tr><td width="40%">ADPCM IMA Duck DK4</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in some Sega Saturn console games.</td></tr>
<tr><td width="40%">ADPCM IMA Radical</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Microsoft</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM MS IMA</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Nintendo Gamecube AFC</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Nintendo Gamecube DTK</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Nintendo THP</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Playstation</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM QT IMA</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM SEGA CRI ADX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Sega Dreamcast games.</td></tr>
<tr><td width="40%">ADPCM Shockwave Flash</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Sound Blaster Pro 2-bit</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Sound Blaster Pro 2.6-bit</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Sound Blaster Pro 4-bit</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM VIMA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in LucasArts SMUSH animations.</td></tr>
<tr><td width="40%">ADPCM Konami XMD</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Westwood Studios IMA</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Westwood Studios games like Command and Conquer.</td></tr>
<tr><td width="40%">ADPCM Yamaha</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">ADPCM Zork</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">AMR-NB</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libopencore-amrnb</td></tr>
<tr><td width="40%">AMR-WB</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libvo-amrwbenc</td></tr>
<tr><td width="40%">Amazing Studio PAF Audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Apple lossless audio</td><td width="10%">X</td><td width="10%">X</td><td width="40%">QuickTime fourcc ’alac’</td></tr>
<tr><td width="40%">aptX</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Bluetooth A2DP</td></tr>
<tr><td width="40%">aptX HD</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Bluetooth A2DP</td></tr>
<tr><td width="40%">ATRAC1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ATRAC3</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ATRAC3+</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">ATRAC9</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Bink Audio</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Bink and Smacker files in many games.</td></tr>
<tr><td width="40%">Bonk audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">CELT</td><td width="10%"></td><td width="10%">E</td><td width="40%">decoding supported through external library libcelt</td></tr>
<tr><td width="40%">codec2</td><td width="10%">E</td><td width="10%">E</td><td width="40%">en/decoding supported through external library libcodec2</td></tr>
<tr><td width="40%">CRI HCA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Delphine Software International CIN audio</td><td width="10%"></td><td width="10%">X</td><td width="40%">Codec used in Delphine Software International games.</td></tr>
<tr><td width="40%">DFPWM</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Digital Speech Standard - Standard Play mode (DSS SP)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Discworld II BMV Audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">COOK</td><td width="10%"></td><td width="10%">X</td><td width="40%">All versions except 5.1 are supported.</td></tr>
<tr><td width="40%">DCA (DTS Coherent Acoustics)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">supported extensions: XCh, XXCH, X96, XBR, XLL, LBR (partially)</td></tr>
<tr><td width="40%">Dolby E</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DPCM Cuberoot-Delta-Exact</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in few games.</td></tr>
<tr><td width="40%">DPCM Gremlin</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DPCM id RoQ</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Quake III, Jedi Knight 2 and other computer games.</td></tr>
<tr><td width="40%">DPCM Marble WADY</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DPCM Interplay</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in various Interplay computer games.</td></tr>
<tr><td width="40%">DPCM Squareroot-Delta-Exact</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in various games.</td></tr>
<tr><td width="40%">DPCM Sierra Online</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sierra Online game audio files.</td></tr>
<tr><td width="40%">DPCM Sol</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DPCM Xan</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Origin’s Wing Commander IV AVI files.</td></tr>
<tr><td width="40%">DPCM Xilam DERF</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSD (Direct Stream Digital), least significant bit first</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSD (Direct Stream Digital), most significant bit first</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSD (Direct Stream Digital), least significant bit first, planar</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSD (Direct Stream Digital), most significant bit first, planar</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DSP Group TrueSpeech</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DST (Direct Stream Transfer)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DV audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Enhanced AC-3</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">EVRC (Enhanced Variable Rate Codec)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">FLAC (Free Lossless Audio Codec)</td><td width="10%">X</td><td width="10%">IX</td></tr>
<tr><td width="40%">FTR Voice</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">G.723.1</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">G.729</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">GSM</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libgsm</td></tr>
<tr><td width="40%">GSM Microsoft variant</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libgsm</td></tr>
<tr><td width="40%">IAC (Indeo Audio Coder)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">iLBC (Internet Low Bitrate Codec)</td><td width="10%">E</td><td width="10%">EX</td><td width="40%">encoding and decoding supported through external library libilbc</td></tr>
<tr><td width="40%">IMC (Intel Music Coder)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Interplay ACM</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MACE (Macintosh Audio Compression/Expansion) 3:1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MACE (Macintosh Audio Compression/Expansion) 6:1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Marian’s A-pac audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MI-SC4 (Micronas SC-4 Audio)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MLP (Meridian Lossless Packing)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in DVD-Audio discs.</td></tr>
<tr><td width="40%">Monkey’s Audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MP1 (MPEG audio layer 1)</td><td width="10%"></td><td width="10%">IX</td></tr>
<tr><td width="40%">MP2 (MPEG audio layer 2)</td><td width="10%">IX</td><td width="10%">IX</td><td width="40%">encoding supported also through external library TwoLAME</td></tr>
<tr><td width="40%">MP3 (MPEG audio layer 3)</td><td width="10%">E</td><td width="10%">IX</td><td width="40%">encoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported</td></tr>
<tr><td width="40%">MPEG-4 Audio Lossless Coding (ALS)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MobiClip FastAudio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Musepack SV7</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Musepack SV8</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Nellymoser Asao</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">On2 AVC (Audio for Video Codec)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Opus</td><td width="10%">E</td><td width="10%">X</td><td width="40%">encoding supported through external library libopus</td></tr>
<tr><td width="40%">OSQ (Original Sound Quality)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">PCM A-law</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM mu-law</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM Archimedes VIDC</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 8-bit planar</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 16-bit big-endian planar</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 16-bit little-endian planar</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 24-bit little-endian planar</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 32-bit little-endian planar</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM 32-bit floating point big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM 32-bit floating point little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM 64-bit floating point big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM 64-bit floating point little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM D-Cinema audio signed 24-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 8-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 16-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 16-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 24-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 24-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 32-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 32-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM signed 16/20/24-bit big-endian in MPEG-TS</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 8-bit</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 16-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 16-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 24-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 24-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 32-bit big-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM unsigned 32-bit little-endian</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PCM SGA</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">QCELP / PureVoice</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">QDesign Music Codec 1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">QDesign Music Codec 2</td><td width="10%"></td><td width="10%">X</td><td width="40%">There are still some distortions.</td></tr>
<tr><td width="40%">RealAudio 1.0 (14.4K)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Real 14400 bit/s codec</td></tr>
<tr><td width="40%">RealAudio 2.0 (28.8K)</td><td width="10%"></td><td width="10%">X</td><td width="40%">Real 28800 bit/s codec</td></tr>
<tr><td width="40%">RealAudio 3.0 (dnet)</td><td width="10%">IX</td><td width="10%">X</td><td width="40%">Real low bitrate AC-3 codec</td></tr>
<tr><td width="40%">RealAudio Lossless</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RealAudio SIPR / ACELP.NET</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RK Audio (RKA)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SBC (low-complexity subband codec)</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in Bluetooth A2DP</td></tr>
<tr><td width="40%">Shorten</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Sierra VMD audio</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in Sierra VMD files.</td></tr>
<tr><td width="40%">Smacker audio</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SMPTE 302M AES3 audio</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Sonic</td><td width="10%">X</td><td width="10%">X</td><td width="40%">experimental codec</td></tr>
<tr><td width="40%">Sonic lossless</td><td width="10%">X</td><td width="10%">X</td><td width="40%">experimental codec</td></tr>
<tr><td width="40%">Speex</td><td width="10%">E</td><td width="10%">EX</td><td width="40%">supported through external library libspeex</td></tr>
<tr><td width="40%">TAK (Tom’s lossless Audio Kompressor)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">True Audio (TTA)</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">TrueHD</td><td width="10%">X</td><td width="10%">X</td><td width="40%">Used in HD-DVD and Blu-Ray discs.</td></tr>
<tr><td width="40%">TwinVQ (VQF flavor)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">VIMA</td><td width="10%"></td><td width="10%">X</td><td width="40%">Used in LucasArts SMUSH animations.</td></tr>
<tr><td width="40%">ViewQuest VQC</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Vorbis</td><td width="10%">E</td><td width="10%">X</td><td width="40%">A native but very primitive encoder exists.</td></tr>
<tr><td width="40%">Voxware MetaSound</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Waveform Archiver</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WavPack</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Westwood Audio (SND1)</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Audio 1</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Audio 2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Audio Lossless</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Audio Pro</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Windows Media Audio Voice</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Xbox Media Audio 1</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Xbox Media Audio 2</td><td width="10%"></td><td width="10%">X</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the feature in that column (encoding / decoding) is supported.
</p>
<p><code class="code">E</code> means that support is provided through an external library.
</p>
<p><code class="code">I</code> means that an integer-only version is available, too (ensures high
performance on systems without hardware floating point support).
</p>
</div>
<div class="section-level-extent" id="Subtitle-Formats">
<h3 class="section">40.5 Subtitle Formats</h3>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Muxing</td><td width="10%">Demuxing</td><td width="10%">Encoding</td><td width="10%">Decoding</td></tr>
<tr><td width="40%">3GPP Timed Text</td><td width="10%"></td><td width="10%"></td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">AQTitle</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DVB</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">DVB teletext</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">E</td></tr>
<tr><td width="40%">DVD</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">JACOsub</td><td width="10%">X</td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MicroDVD</td><td width="10%">X</td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MPL2</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">MPsub (MPlayer)</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">PGS</td><td width="10%"></td><td width="10%"></td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">PJS (Phoenix)</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">RealText</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SAMI</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Spruce format (STL)</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SSA/ASS</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SubRip (SRT)</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SubViewer v1</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">SubViewer</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">TED Talks captions</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">TTML</td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">VobSub (IDX+SUB)</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">VPlayer</td><td width="10%"></td><td width="10%">X</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">WebVTT</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">XSUB</td><td width="10%"></td><td width="10%"></td><td width="10%">X</td><td width="10%">X</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the feature is supported.
</p>
<p><code class="code">E</code> means that support is provided through an external library.
</p>
</div>
<div class="section-level-extent" id="Network-Protocols">
<h3 class="section">40.6 Network Protocols</h3>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Support</td></tr>
<tr><td width="40%">AMQP</td><td width="10%">E</td></tr>
<tr><td width="40%">file</td><td width="10%">X</td></tr>
<tr><td width="40%">FTP</td><td width="10%">X</td></tr>
<tr><td width="40%">Gopher</td><td width="10%">X</td></tr>
<tr><td width="40%">Gophers</td><td width="10%">X</td></tr>
<tr><td width="40%">HLS</td><td width="10%">X</td></tr>
<tr><td width="40%">HTTP</td><td width="10%">X</td></tr>
<tr><td width="40%">HTTPS</td><td width="10%">X</td></tr>
<tr><td width="40%">Icecast</td><td width="10%">X</td></tr>
<tr><td width="40%">MMSH</td><td width="10%">X</td></tr>
<tr><td width="40%">MMST</td><td width="10%">X</td></tr>
<tr><td width="40%">pipe</td><td width="10%">X</td></tr>
<tr><td width="40%">Pro-MPEG FEC</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMP</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMPE</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMPS</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMPT</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMPTE</td><td width="10%">X</td></tr>
<tr><td width="40%">RTMPTS</td><td width="10%">X</td></tr>
<tr><td width="40%">RTP</td><td width="10%">X</td></tr>
<tr><td width="40%">SAMBA</td><td width="10%">E</td></tr>
<tr><td width="40%">SCTP</td><td width="10%">X</td></tr>
<tr><td width="40%">SFTP</td><td width="10%">E</td></tr>
<tr><td width="40%">TCP</td><td width="10%">X</td></tr>
<tr><td width="40%">TLS</td><td width="10%">X</td></tr>
<tr><td width="40%">UDP</td><td width="10%">X</td></tr>
<tr><td width="40%">ZMQ</td><td width="10%">E</td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that the protocol is supported.
</p>
<p><code class="code">E</code> means that support is provided through an external library.
</p>
</div>
<div class="section-level-extent" id="Input_002fOutput-Devices">
<h3 class="section">40.7 Input/Output Devices</h3>
<table class="multitable">
<tbody><tr><td width="40%">Name</td><td width="10%">Input</td><td width="10%">Output</td></tr>
<tr><td width="40%">ALSA</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">BKTR</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">caca</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">DV1394</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">Lavfi virtual device</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">Linux framebuffer</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">JACK</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">LIBCDIO</td><td width="10%">X</td></tr>
<tr><td width="40%">LIBDC1394</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">OpenAL</td><td width="10%">X</td></tr>
<tr><td width="40%">OpenGL</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">OSS</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">PulseAudio</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">SDL</td><td width="10%"></td><td width="10%">X</td></tr>
<tr><td width="40%">Video4Linux2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">VfW capture</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">X11 grabbing</td><td width="10%">X</td><td width="10%"></td></tr>
<tr><td width="40%">Win32 grabbing</td><td width="10%">X</td><td width="10%"></td></tr>
</tbody>
</table>
<p><code class="code">X</code> means that input/output is supported.
</p>
</div>
<div class="section-level-extent" id="Timecode">
<h3 class="section">40.8 Timecode</h3>
<table class="multitable">
<tbody><tr><td width="40%">Codec/format</td><td width="10%">Read</td><td width="10%">Write</td></tr>
<tr><td width="40%">AVI</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">DV</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">GXF</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MOV</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MPEG1/2</td><td width="10%">X</td><td width="10%">X</td></tr>
<tr><td width="40%">MXF</td><td width="10%">X</td><td width="10%">X</td></tr>
</tbody>
</table>
</div>
</div>
<div class="chapter-level-extent" id="See-Also">
<h2 class="chapter">41 See Also</h2>
<p><a class="url" href="ffplay.html">ffplay</a>,
<a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
<a class="url" href="ffmpeg-utils.html">ffmpeg-utils</a>,
<a class="url" href="ffmpeg-scaler.html">ffmpeg-scaler</a>,
<a class="url" href="ffmpeg-resampler.html">ffmpeg-resampler</a>,
<a class="url" href="ffmpeg-codecs.html">ffmpeg-codecs</a>,
<a class="url" href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>,
<a class="url" href="ffmpeg-formats.html">ffmpeg-formats</a>,
<a class="url" href="ffmpeg-devices.html">ffmpeg-devices</a>,
<a class="url" href="ffmpeg-protocols.html">ffmpeg-protocols</a>,
<a class="url" href="ffmpeg-filters.html">ffmpeg-filters</a>
</p>
</div>
<div class="chapter-level-extent" id="Authors">
<h2 class="chapter">42 Authors</h2>
<p>The FFmpeg developers.
</p>
<p>For details about the authorship, see the Git history of the project
(https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
<code class="command">git log</code> in the FFmpeg source directory, or browsing the
online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
</p>
<p>Maintainers for the specific components are listed in the file
<samp class="file">MAINTAINERS</samp> in the source code tree.
</p>
</div>
</div>
<p style="font-size: small;">
This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
</p>
</div>
</body>
</html>