ffmpeg-codecs.html 234 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  6. <title>FFmpeg Codecs Documentation</title>
  7. <meta name="description" content="FFmpeg Codecs Documentation">
  8. <meta name="keywords" content="FFmpeg Codecs Documentation">
  9. <meta name="resource-type" content="document">
  10. <meta name="distribution" content="global">
  11. <meta name="Generator" content="makeinfo">
  12. <meta name="viewport" content="width=device-width,initial-scale=1">
  13. <link href="#SEC_Contents" rel="contents" title="Table of Contents">
  14. <style type="text/css">
  15. <!--
  16. a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
  17. a.summary-letter {text-decoration: none}
  18. blockquote.indentedblock {margin-right: 0em}
  19. div.display {margin-left: 3.2em}
  20. div.example {margin-left: 3.2em}
  21. kbd {font-style: oblique}
  22. pre.display {font-family: inherit}
  23. pre.format {font-family: inherit}
  24. pre.menu-comment {font-family: serif}
  25. pre.menu-preformatted {font-family: serif}
  26. span.nolinebreak {white-space: nowrap}
  27. span.roman {font-family: initial; font-weight: normal}
  28. span.sansserif {font-family: sans-serif; font-weight: normal}
  29. span:hover a.copiable-anchor {visibility: visible}
  30. ul.no-bullet {list-style: none}
  31. -->
  32. </style>
  33. </head>
  34. <body lang="en">
  35. <h1 class="settitle" align="center">FFmpeg Codecs Documentation</h1>
  36. <a name="SEC_Top"></a>
  37. <a name="Description"></a>
  38. <h2 class="chapter">1 Description<span class="pull-right"><a class="anchor hidden-xs" href="#Description" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Description" aria-hidden="true">TOC</a></span></h2>
  39. <p>This document describes the codecs (decoders and encoders) provided by
  40. the libavcodec library.
  41. </p>
  42. <span id="codec_002doptions"></span><a name="Codec-Options"></a>
  43. <h2 class="chapter">2 Codec Options<span class="pull-right"><a class="anchor hidden-xs" href="#Codec-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Codec-Options" aria-hidden="true">TOC</a></span></h2>
  44. <p>libavcodec provides some generic global options, which can be set on
  45. all the encoders and decoders. In addition each codec may support
  46. so-called private options, which are specific for a given codec.
  47. </p>
  48. <p>Sometimes, a global option may only affect a specific kind of codec,
  49. and may be nonsensical or ignored by another, so you need to be aware
  50. of the meaning of the specified options. Also some options are
  51. meant only for decoding or encoding.
  52. </p>
  53. <p>Options may be set by specifying -<var>option</var> <var>value</var> in the
  54. FFmpeg tools, or by setting the value explicitly in the
  55. <code>AVCodecContext</code> options or using the <samp>libavutil/opt.h</samp> API
  56. for programmatic use.
  57. </p>
  58. <p>The list of supported options follow:
  59. </p>
  60. <dl compact="compact">
  61. <dt><span><samp>b <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  62. <dd><p>Set bitrate in bits/s. Default value is 200K.
  63. </p>
  64. </dd>
  65. <dt><span><samp>ab <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  66. <dd><p>Set audio bitrate (in bits/s). Default value is 128K.
  67. </p>
  68. </dd>
  69. <dt><span><samp>bt <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  70. <dd><p>Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate
  71. tolerance specifies how far ratecontrol is willing to deviate from the
  72. target average bitrate value. This is not related to min/max
  73. bitrate. Lowering tolerance too much has an adverse effect on quality.
  74. </p>
  75. </dd>
  76. <dt><span><samp>flags <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></span></dt>
  77. <dd><p>Set generic flags.
  78. </p>
  79. <p>Possible values:
  80. </p><dl compact="compact">
  81. <dt><span>&lsquo;<samp>mv4</samp>&rsquo;</span></dt>
  82. <dd><p>Use four motion vector by macroblock (mpeg4).
  83. </p></dd>
  84. <dt><span>&lsquo;<samp>qpel</samp>&rsquo;</span></dt>
  85. <dd><p>Use 1/4 pel motion compensation.
  86. </p></dd>
  87. <dt><span>&lsquo;<samp>loop</samp>&rsquo;</span></dt>
  88. <dd><p>Use loop filter.
  89. </p></dd>
  90. <dt><span>&lsquo;<samp>qscale</samp>&rsquo;</span></dt>
  91. <dd><p>Use fixed qscale.
  92. </p></dd>
  93. <dt><span>&lsquo;<samp>pass1</samp>&rsquo;</span></dt>
  94. <dd><p>Use internal 2pass ratecontrol in first pass mode.
  95. </p></dd>
  96. <dt><span>&lsquo;<samp>pass2</samp>&rsquo;</span></dt>
  97. <dd><p>Use internal 2pass ratecontrol in second pass mode.
  98. </p></dd>
  99. <dt><span>&lsquo;<samp>gray</samp>&rsquo;</span></dt>
  100. <dd><p>Only decode/encode grayscale.
  101. </p></dd>
  102. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  103. <dd><p>Set error[?] variables during encoding.
  104. </p></dd>
  105. <dt><span>&lsquo;<samp>truncated</samp>&rsquo;</span></dt>
  106. <dd><p>Input bitstream might be randomly truncated.
  107. </p></dd>
  108. <dt><span>&lsquo;<samp>drop_changed</samp>&rsquo;</span></dt>
  109. <dd><p>Don&rsquo;t output frames whose parameters differ from first decoded frame in stream.
  110. Error AVERROR_INPUT_CHANGED is returned when a frame is dropped.
  111. </p>
  112. </dd>
  113. <dt><span>&lsquo;<samp>ildct</samp>&rsquo;</span></dt>
  114. <dd><p>Use interlaced DCT.
  115. </p></dd>
  116. <dt><span>&lsquo;<samp>low_delay</samp>&rsquo;</span></dt>
  117. <dd><p>Force low delay.
  118. </p></dd>
  119. <dt><span>&lsquo;<samp>global_header</samp>&rsquo;</span></dt>
  120. <dd><p>Place global headers in extradata instead of every keyframe.
  121. </p></dd>
  122. <dt><span>&lsquo;<samp>bitexact</samp>&rsquo;</span></dt>
  123. <dd><p>Only write platform-, build- and time-independent data. (except (I)DCT).
  124. This ensures that file and data checksums are reproducible and match between
  125. platforms. Its primary use is for regression testing.
  126. </p></dd>
  127. <dt><span>&lsquo;<samp>aic</samp>&rsquo;</span></dt>
  128. <dd><p>Apply H263 advanced intra coding / mpeg4 ac prediction.
  129. </p></dd>
  130. <dt><span>&lsquo;<samp>ilme</samp>&rsquo;</span></dt>
  131. <dd><p>Apply interlaced motion estimation.
  132. </p></dd>
  133. <dt><span>&lsquo;<samp>cgop</samp>&rsquo;</span></dt>
  134. <dd><p>Use closed gop.
  135. </p></dd>
  136. <dt><span>&lsquo;<samp>output_corrupt</samp>&rsquo;</span></dt>
  137. <dd><p>Output even potentially corrupted frames.
  138. </p></dd>
  139. </dl>
  140. </dd>
  141. <dt><span><samp>time_base <var>rational number</var></samp></span></dt>
  142. <dd><p>Set codec time base.
  143. </p>
  144. <p>It is the fundamental unit of time (in seconds) in terms of which
  145. frame timestamps are represented. For fixed-fps content, timebase
  146. should be <code>1 / frame_rate</code> and timestamp increments should be
  147. identically 1.
  148. </p>
  149. </dd>
  150. <dt><span><samp>g <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  151. <dd><p>Set the group of picture (GOP) size. Default value is 12.
  152. </p>
  153. </dd>
  154. <dt><span><samp>ar <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></span></dt>
  155. <dd><p>Set audio sampling rate (in Hz).
  156. </p>
  157. </dd>
  158. <dt><span><samp>ac <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></span></dt>
  159. <dd><p>Set number of audio channels.
  160. </p>
  161. </dd>
  162. <dt><span><samp>cutoff <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  163. <dd><p>Set cutoff bandwidth. (Supported only by selected encoders, see
  164. their respective documentation sections.)
  165. </p>
  166. </dd>
  167. <dt><span><samp>frame_size <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  168. <dd><p>Set audio frame size.
  169. </p>
  170. <p>Each submitted frame except the last must contain exactly frame_size
  171. samples per channel. May be 0 when the codec has
  172. CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not
  173. restricted. It is set by some decoders to indicate constant frame
  174. size.
  175. </p>
  176. </dd>
  177. <dt><span><samp>frame_number <var>integer</var></samp></span></dt>
  178. <dd><p>Set the frame number.
  179. </p>
  180. </dd>
  181. <dt><span><samp>delay <var>integer</var></samp></span></dt>
  182. <dt><span><samp>qcomp <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  183. <dd><p>Set video quantizer scale compression (VBR). It is used as a constant
  184. in the ratecontrol equation. Recommended range for default rc_eq:
  185. 0.0-1.0.
  186. </p>
  187. </dd>
  188. <dt><span><samp>qblur <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  189. <dd><p>Set video quantizer scale blur (VBR).
  190. </p>
  191. </dd>
  192. <dt><span><samp>qmin <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  193. <dd><p>Set min video quantizer scale (VBR). Must be included between -1 and
  194. 69, default value is 2.
  195. </p>
  196. </dd>
  197. <dt><span><samp>qmax <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  198. <dd><p>Set max video quantizer scale (VBR). Must be included between -1 and
  199. 1024, default value is 31.
  200. </p>
  201. </dd>
  202. <dt><span><samp>qdiff <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  203. <dd><p>Set max difference between the quantizer scale (VBR).
  204. </p>
  205. </dd>
  206. <dt><span><samp>bf <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  207. <dd><p>Set max number of B frames between non-B-frames.
  208. </p>
  209. <p>Must be an integer between -1 and 16. 0 means that B-frames are
  210. disabled. If a value of -1 is used, it will choose an automatic value
  211. depending on the encoder.
  212. </p>
  213. <p>Default value is 0.
  214. </p>
  215. </dd>
  216. <dt><span><samp>b_qfactor <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  217. <dd><p>Set qp factor between P and B frames.
  218. </p>
  219. </dd>
  220. <dt><span><samp>b_strategy <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  221. <dd><p>Set strategy to choose between I/P/B-frames.
  222. </p>
  223. </dd>
  224. <dt><span><samp>ps <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  225. <dd><p>Set RTP payload size in bytes.
  226. </p>
  227. </dd>
  228. <dt><span><samp>mv_bits <var>integer</var></samp></span></dt>
  229. <dt><span><samp>header_bits <var>integer</var></samp></span></dt>
  230. <dt><span><samp>i_tex_bits <var>integer</var></samp></span></dt>
  231. <dt><span><samp>p_tex_bits <var>integer</var></samp></span></dt>
  232. <dt><span><samp>i_count <var>integer</var></samp></span></dt>
  233. <dt><span><samp>p_count <var>integer</var></samp></span></dt>
  234. <dt><span><samp>skip_count <var>integer</var></samp></span></dt>
  235. <dt><span><samp>misc_bits <var>integer</var></samp></span></dt>
  236. <dt><span><samp>frame_bits <var>integer</var></samp></span></dt>
  237. <dt><span><samp>codec_tag <var>integer</var></samp></span></dt>
  238. <dt><span><samp>bug <var>flags</var> (<em>decoding,video</em>)</samp></span></dt>
  239. <dd><p>Workaround not auto detected encoder bugs.
  240. </p>
  241. <p>Possible values:
  242. </p><dl compact="compact">
  243. <dt><span>&lsquo;<samp>autodetect</samp>&rsquo;</span></dt>
  244. <dt><span>&lsquo;<samp>xvid_ilace</samp>&rsquo;</span></dt>
  245. <dd><p>Xvid interlacing bug (autodetected if fourcc==XVIX)
  246. </p></dd>
  247. <dt><span>&lsquo;<samp>ump4</samp>&rsquo;</span></dt>
  248. <dd><p>(autodetected if fourcc==UMP4)
  249. </p></dd>
  250. <dt><span>&lsquo;<samp>no_padding</samp>&rsquo;</span></dt>
  251. <dd><p>padding bug (autodetected)
  252. </p></dd>
  253. <dt><span>&lsquo;<samp>amv</samp>&rsquo;</span></dt>
  254. <dt><span>&lsquo;<samp>qpel_chroma</samp>&rsquo;</span></dt>
  255. <dt><span>&lsquo;<samp>std_qpel</samp>&rsquo;</span></dt>
  256. <dd><p>old standard qpel (autodetected per fourcc/version)
  257. </p></dd>
  258. <dt><span>&lsquo;<samp>qpel_chroma2</samp>&rsquo;</span></dt>
  259. <dt><span>&lsquo;<samp>direct_blocksize</samp>&rsquo;</span></dt>
  260. <dd><p>direct-qpel-blocksize bug (autodetected per fourcc/version)
  261. </p></dd>
  262. <dt><span>&lsquo;<samp>edge</samp>&rsquo;</span></dt>
  263. <dd><p>edge padding bug (autodetected per fourcc/version)
  264. </p></dd>
  265. <dt><span>&lsquo;<samp>hpel_chroma</samp>&rsquo;</span></dt>
  266. <dt><span>&lsquo;<samp>dc_clip</samp>&rsquo;</span></dt>
  267. <dt><span>&lsquo;<samp>ms</samp>&rsquo;</span></dt>
  268. <dd><p>Workaround various bugs in microsoft broken decoders.
  269. </p></dd>
  270. <dt><span>&lsquo;<samp>trunc</samp>&rsquo;</span></dt>
  271. <dd><p>trancated frames
  272. </p></dd>
  273. </dl>
  274. </dd>
  275. <dt><span><samp>strict <var>integer</var> (<em>decoding/encoding,audio,video</em>)</samp></span></dt>
  276. <dd><p>Specify how strictly to follow the standards.
  277. </p>
  278. <p>Possible values:
  279. </p><dl compact="compact">
  280. <dt><span>&lsquo;<samp>very</samp>&rsquo;</span></dt>
  281. <dd><p>strictly conform to an older more strict version of the spec or reference software
  282. </p></dd>
  283. <dt><span>&lsquo;<samp>strict</samp>&rsquo;</span></dt>
  284. <dd><p>strictly conform to all the things in the spec no matter what consequences
  285. </p></dd>
  286. <dt><span>&lsquo;<samp>normal</samp>&rsquo;</span></dt>
  287. <dt><span>&lsquo;<samp>unofficial</samp>&rsquo;</span></dt>
  288. <dd><p>allow unofficial extensions
  289. </p></dd>
  290. <dt><span>&lsquo;<samp>experimental</samp>&rsquo;</span></dt>
  291. <dd><p>allow non standardized experimental things, experimental
  292. (unfinished/work in progress/not well tested) decoders and encoders.
  293. Note: experimental decoders can pose a security risk, do not use this for
  294. decoding untrusted input.
  295. </p></dd>
  296. </dl>
  297. </dd>
  298. <dt><span><samp>b_qoffset <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  299. <dd><p>Set QP offset between P and B frames.
  300. </p>
  301. </dd>
  302. <dt><span><samp>err_detect <var>flags</var> (<em>decoding,audio,video</em>)</samp></span></dt>
  303. <dd><p>Set error detection flags.
  304. </p>
  305. <p>Possible values:
  306. </p><dl compact="compact">
  307. <dt><span>&lsquo;<samp>crccheck</samp>&rsquo;</span></dt>
  308. <dd><p>verify embedded CRCs
  309. </p></dd>
  310. <dt><span>&lsquo;<samp>bitstream</samp>&rsquo;</span></dt>
  311. <dd><p>detect bitstream specification deviations
  312. </p></dd>
  313. <dt><span>&lsquo;<samp>buffer</samp>&rsquo;</span></dt>
  314. <dd><p>detect improper bitstream length
  315. </p></dd>
  316. <dt><span>&lsquo;<samp>explode</samp>&rsquo;</span></dt>
  317. <dd><p>abort decoding on minor error detection
  318. </p></dd>
  319. <dt><span>&lsquo;<samp>ignore_err</samp>&rsquo;</span></dt>
  320. <dd><p>ignore decoding errors, and continue decoding.
  321. This is useful if you want to analyze the content of a video and thus want
  322. everything to be decoded no matter what. This option will not result in a video
  323. that is pleasing to watch in case of errors.
  324. </p></dd>
  325. <dt><span>&lsquo;<samp>careful</samp>&rsquo;</span></dt>
  326. <dd><p>consider things that violate the spec and have not been seen in the wild as errors
  327. </p></dd>
  328. <dt><span>&lsquo;<samp>compliant</samp>&rsquo;</span></dt>
  329. <dd><p>consider all spec non compliancies as errors
  330. </p></dd>
  331. <dt><span>&lsquo;<samp>aggressive</samp>&rsquo;</span></dt>
  332. <dd><p>consider things that a sane encoder should not do as an error
  333. </p></dd>
  334. </dl>
  335. </dd>
  336. <dt><span><samp>has_b_frames <var>integer</var></samp></span></dt>
  337. <dt><span><samp>block_align <var>integer</var></samp></span></dt>
  338. <dt><span><samp>mpeg_quant <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  339. <dd><p>Use MPEG quantizers instead of H.263.
  340. </p>
  341. </dd>
  342. <dt><span><samp>rc_override_count <var>integer</var></samp></span></dt>
  343. <dt><span><samp>maxrate <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  344. <dd><p>Set max bitrate tolerance (in bits/s). Requires bufsize to be set.
  345. </p>
  346. </dd>
  347. <dt><span><samp>minrate <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  348. <dd><p>Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR
  349. encode. It is of little use elsewise.
  350. </p>
  351. </dd>
  352. <dt><span><samp>bufsize <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  353. <dd><p>Set ratecontrol buffer size (in bits).
  354. </p>
  355. </dd>
  356. <dt><span><samp>i_qfactor <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  357. <dd><p>Set QP factor between P and I frames.
  358. </p>
  359. </dd>
  360. <dt><span><samp>i_qoffset <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  361. <dd><p>Set QP offset between P and I frames.
  362. </p>
  363. </dd>
  364. <dt><span><samp>dct <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  365. <dd><p>Set DCT algorithm.
  366. </p>
  367. <p>Possible values:
  368. </p><dl compact="compact">
  369. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  370. <dd><p>autoselect a good one (default)
  371. </p></dd>
  372. <dt><span>&lsquo;<samp>fastint</samp>&rsquo;</span></dt>
  373. <dd><p>fast integer
  374. </p></dd>
  375. <dt><span>&lsquo;<samp>int</samp>&rsquo;</span></dt>
  376. <dd><p>accurate integer
  377. </p></dd>
  378. <dt><span>&lsquo;<samp>mmx</samp>&rsquo;</span></dt>
  379. <dt><span>&lsquo;<samp>altivec</samp>&rsquo;</span></dt>
  380. <dt><span>&lsquo;<samp>faan</samp>&rsquo;</span></dt>
  381. <dd><p>floating point AAN DCT
  382. </p></dd>
  383. </dl>
  384. </dd>
  385. <dt><span><samp>lumi_mask <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  386. <dd><p>Compress bright areas stronger than medium ones.
  387. </p>
  388. </dd>
  389. <dt><span><samp>tcplx_mask <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  390. <dd><p>Set temporal complexity masking.
  391. </p>
  392. </dd>
  393. <dt><span><samp>scplx_mask <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  394. <dd><p>Set spatial complexity masking.
  395. </p>
  396. </dd>
  397. <dt><span><samp>p_mask <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  398. <dd><p>Set inter masking.
  399. </p>
  400. </dd>
  401. <dt><span><samp>dark_mask <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  402. <dd><p>Compress dark areas stronger than medium ones.
  403. </p>
  404. </dd>
  405. <dt><span><samp>idct <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  406. <dd><p>Select IDCT implementation.
  407. </p>
  408. <p>Possible values:
  409. </p><dl compact="compact">
  410. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  411. <dt><span>&lsquo;<samp>int</samp>&rsquo;</span></dt>
  412. <dt><span>&lsquo;<samp>simple</samp>&rsquo;</span></dt>
  413. <dt><span>&lsquo;<samp>simplemmx</samp>&rsquo;</span></dt>
  414. <dt><span>&lsquo;<samp>simpleauto</samp>&rsquo;</span></dt>
  415. <dd><p>Automatically pick a IDCT compatible with the simple one
  416. </p>
  417. </dd>
  418. <dt><span>&lsquo;<samp>arm</samp>&rsquo;</span></dt>
  419. <dt><span>&lsquo;<samp>altivec</samp>&rsquo;</span></dt>
  420. <dt><span>&lsquo;<samp>sh4</samp>&rsquo;</span></dt>
  421. <dt><span>&lsquo;<samp>simplearm</samp>&rsquo;</span></dt>
  422. <dt><span>&lsquo;<samp>simplearmv5te</samp>&rsquo;</span></dt>
  423. <dt><span>&lsquo;<samp>simplearmv6</samp>&rsquo;</span></dt>
  424. <dt><span>&lsquo;<samp>simpleneon</samp>&rsquo;</span></dt>
  425. <dt><span>&lsquo;<samp>xvid</samp>&rsquo;</span></dt>
  426. <dt><span>&lsquo;<samp>faani</samp>&rsquo;</span></dt>
  427. <dd><p>floating point AAN IDCT
  428. </p></dd>
  429. </dl>
  430. </dd>
  431. <dt><span><samp>slice_count <var>integer</var></samp></span></dt>
  432. <dt><span><samp>ec <var>flags</var> (<em>decoding,video</em>)</samp></span></dt>
  433. <dd><p>Set error concealment strategy.
  434. </p>
  435. <p>Possible values:
  436. </p><dl compact="compact">
  437. <dt><span>&lsquo;<samp>guess_mvs</samp>&rsquo;</span></dt>
  438. <dd><p>iterative motion vector (MV) search (slow)
  439. </p></dd>
  440. <dt><span>&lsquo;<samp>deblock</samp>&rsquo;</span></dt>
  441. <dd><p>use strong deblock filter for damaged MBs
  442. </p></dd>
  443. <dt><span>&lsquo;<samp>favor_inter</samp>&rsquo;</span></dt>
  444. <dd><p>favor predicting from the previous frame instead of the current
  445. </p></dd>
  446. </dl>
  447. </dd>
  448. <dt><span><samp>bits_per_coded_sample <var>integer</var></samp></span></dt>
  449. <dt><span><samp>pred <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  450. <dd><p>Set prediction method.
  451. </p>
  452. <p>Possible values:
  453. </p><dl compact="compact">
  454. <dt><span>&lsquo;<samp>left</samp>&rsquo;</span></dt>
  455. <dt><span>&lsquo;<samp>plane</samp>&rsquo;</span></dt>
  456. <dt><span>&lsquo;<samp>median</samp>&rsquo;</span></dt>
  457. </dl>
  458. </dd>
  459. <dt><span><samp>aspect <var>rational number</var> (<em>encoding,video</em>)</samp></span></dt>
  460. <dd><p>Set sample aspect ratio.
  461. </p>
  462. </dd>
  463. <dt><span><samp>sar <var>rational number</var> (<em>encoding,video</em>)</samp></span></dt>
  464. <dd><p>Set sample aspect ratio. Alias to <var>aspect</var>.
  465. </p>
  466. </dd>
  467. <dt><span><samp>debug <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></span></dt>
  468. <dd><p>Print specific debug info.
  469. </p>
  470. <p>Possible values:
  471. </p><dl compact="compact">
  472. <dt><span>&lsquo;<samp>pict</samp>&rsquo;</span></dt>
  473. <dd><p>picture info
  474. </p></dd>
  475. <dt><span>&lsquo;<samp>rc</samp>&rsquo;</span></dt>
  476. <dd><p>rate control
  477. </p></dd>
  478. <dt><span>&lsquo;<samp>bitstream</samp>&rsquo;</span></dt>
  479. <dt><span>&lsquo;<samp>mb_type</samp>&rsquo;</span></dt>
  480. <dd><p>macroblock (MB) type
  481. </p></dd>
  482. <dt><span>&lsquo;<samp>qp</samp>&rsquo;</span></dt>
  483. <dd><p>per-block quantization parameter (QP)
  484. </p></dd>
  485. <dt><span>&lsquo;<samp>dct_coeff</samp>&rsquo;</span></dt>
  486. <dt><span>&lsquo;<samp>green_metadata</samp>&rsquo;</span></dt>
  487. <dd><p>display complexity metadata for the upcoming frame, GoP or for a given duration.
  488. </p>
  489. </dd>
  490. <dt><span>&lsquo;<samp>skip</samp>&rsquo;</span></dt>
  491. <dt><span>&lsquo;<samp>startcode</samp>&rsquo;</span></dt>
  492. <dt><span>&lsquo;<samp>er</samp>&rsquo;</span></dt>
  493. <dd><p>error recognition
  494. </p></dd>
  495. <dt><span>&lsquo;<samp>mmco</samp>&rsquo;</span></dt>
  496. <dd><p>memory management control operations (H.264)
  497. </p></dd>
  498. <dt><span>&lsquo;<samp>bugs</samp>&rsquo;</span></dt>
  499. <dt><span>&lsquo;<samp>buffers</samp>&rsquo;</span></dt>
  500. <dd><p>picture buffer allocations
  501. </p></dd>
  502. <dt><span>&lsquo;<samp>thread_ops</samp>&rsquo;</span></dt>
  503. <dd><p>threading operations
  504. </p></dd>
  505. <dt><span>&lsquo;<samp>nomc</samp>&rsquo;</span></dt>
  506. <dd><p>skip motion compensation
  507. </p></dd>
  508. </dl>
  509. </dd>
  510. <dt><span><samp>cmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  511. <dd><p>Set full pel me compare function.
  512. </p>
  513. <p>Possible values:
  514. </p><dl compact="compact">
  515. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  516. <dd><p>sum of absolute differences, fast (default)
  517. </p></dd>
  518. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  519. <dd><p>sum of squared errors
  520. </p></dd>
  521. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  522. <dd><p>sum of absolute Hadamard transformed differences
  523. </p></dd>
  524. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  525. <dd><p>sum of absolute DCT transformed differences
  526. </p></dd>
  527. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  528. <dd><p>sum of squared quantization errors (avoid, low quality)
  529. </p></dd>
  530. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  531. <dd><p>number of bits needed for the block
  532. </p></dd>
  533. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  534. <dd><p>rate distortion optimal, slow
  535. </p></dd>
  536. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  537. <dd><p>0
  538. </p></dd>
  539. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  540. <dd><p>sum of absolute vertical differences
  541. </p></dd>
  542. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  543. <dd><p>sum of squared vertical differences
  544. </p></dd>
  545. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  546. <dd><p>noise preserving sum of squared differences
  547. </p></dd>
  548. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  549. <dd><p>5/3 wavelet, only used in snow
  550. </p></dd>
  551. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  552. <dd><p>9/7 wavelet, only used in snow
  553. </p></dd>
  554. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  555. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  556. </dl>
  557. </dd>
  558. <dt><span><samp>subcmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  559. <dd><p>Set sub pel me compare function.
  560. </p>
  561. <p>Possible values:
  562. </p><dl compact="compact">
  563. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  564. <dd><p>sum of absolute differences, fast (default)
  565. </p></dd>
  566. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  567. <dd><p>sum of squared errors
  568. </p></dd>
  569. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  570. <dd><p>sum of absolute Hadamard transformed differences
  571. </p></dd>
  572. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  573. <dd><p>sum of absolute DCT transformed differences
  574. </p></dd>
  575. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  576. <dd><p>sum of squared quantization errors (avoid, low quality)
  577. </p></dd>
  578. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  579. <dd><p>number of bits needed for the block
  580. </p></dd>
  581. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  582. <dd><p>rate distortion optimal, slow
  583. </p></dd>
  584. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  585. <dd><p>0
  586. </p></dd>
  587. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  588. <dd><p>sum of absolute vertical differences
  589. </p></dd>
  590. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  591. <dd><p>sum of squared vertical differences
  592. </p></dd>
  593. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  594. <dd><p>noise preserving sum of squared differences
  595. </p></dd>
  596. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  597. <dd><p>5/3 wavelet, only used in snow
  598. </p></dd>
  599. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  600. <dd><p>9/7 wavelet, only used in snow
  601. </p></dd>
  602. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  603. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  604. </dl>
  605. </dd>
  606. <dt><span><samp>mbcmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  607. <dd><p>Set macroblock compare function.
  608. </p>
  609. <p>Possible values:
  610. </p><dl compact="compact">
  611. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  612. <dd><p>sum of absolute differences, fast (default)
  613. </p></dd>
  614. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  615. <dd><p>sum of squared errors
  616. </p></dd>
  617. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  618. <dd><p>sum of absolute Hadamard transformed differences
  619. </p></dd>
  620. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  621. <dd><p>sum of absolute DCT transformed differences
  622. </p></dd>
  623. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  624. <dd><p>sum of squared quantization errors (avoid, low quality)
  625. </p></dd>
  626. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  627. <dd><p>number of bits needed for the block
  628. </p></dd>
  629. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  630. <dd><p>rate distortion optimal, slow
  631. </p></dd>
  632. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  633. <dd><p>0
  634. </p></dd>
  635. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  636. <dd><p>sum of absolute vertical differences
  637. </p></dd>
  638. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  639. <dd><p>sum of squared vertical differences
  640. </p></dd>
  641. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  642. <dd><p>noise preserving sum of squared differences
  643. </p></dd>
  644. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  645. <dd><p>5/3 wavelet, only used in snow
  646. </p></dd>
  647. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  648. <dd><p>9/7 wavelet, only used in snow
  649. </p></dd>
  650. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  651. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  652. </dl>
  653. </dd>
  654. <dt><span><samp>ildctcmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  655. <dd><p>Set interlaced dct compare function.
  656. </p>
  657. <p>Possible values:
  658. </p><dl compact="compact">
  659. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  660. <dd><p>sum of absolute differences, fast (default)
  661. </p></dd>
  662. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  663. <dd><p>sum of squared errors
  664. </p></dd>
  665. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  666. <dd><p>sum of absolute Hadamard transformed differences
  667. </p></dd>
  668. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  669. <dd><p>sum of absolute DCT transformed differences
  670. </p></dd>
  671. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  672. <dd><p>sum of squared quantization errors (avoid, low quality)
  673. </p></dd>
  674. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  675. <dd><p>number of bits needed for the block
  676. </p></dd>
  677. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  678. <dd><p>rate distortion optimal, slow
  679. </p></dd>
  680. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  681. <dd><p>0
  682. </p></dd>
  683. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  684. <dd><p>sum of absolute vertical differences
  685. </p></dd>
  686. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  687. <dd><p>sum of squared vertical differences
  688. </p></dd>
  689. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  690. <dd><p>noise preserving sum of squared differences
  691. </p></dd>
  692. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  693. <dd><p>5/3 wavelet, only used in snow
  694. </p></dd>
  695. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  696. <dd><p>9/7 wavelet, only used in snow
  697. </p></dd>
  698. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  699. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  700. </dl>
  701. </dd>
  702. <dt><span><samp>dia_size <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  703. <dd><p>Set diamond type &amp; size for motion estimation.
  704. </p><dl compact="compact">
  705. <dt><span>&lsquo;<samp>(1024, INT_MAX)</samp>&rsquo;</span></dt>
  706. <dd><p>full motion estimation(slowest)
  707. </p></dd>
  708. <dt><span>&lsquo;<samp>(768, 1024]</samp>&rsquo;</span></dt>
  709. <dd><p>umh motion estimation
  710. </p></dd>
  711. <dt><span>&lsquo;<samp>(512, 768]</samp>&rsquo;</span></dt>
  712. <dd><p>hex motion estimation
  713. </p></dd>
  714. <dt><span>&lsquo;<samp>(256, 512]</samp>&rsquo;</span></dt>
  715. <dd><p>l2s diamond motion estimation
  716. </p></dd>
  717. <dt><span>&lsquo;<samp>[2,256]</samp>&rsquo;</span></dt>
  718. <dd><p>var diamond motion estimation
  719. </p></dd>
  720. <dt><span>&lsquo;<samp>(-1, 2)</samp>&rsquo;</span></dt>
  721. <dd><p>small diamond motion estimation
  722. </p></dd>
  723. <dt><span>&lsquo;<samp>-1</samp>&rsquo;</span></dt>
  724. <dd><p>funny diamond motion estimation
  725. </p></dd>
  726. <dt><span>&lsquo;<samp>(INT_MIN, -1)</samp>&rsquo;</span></dt>
  727. <dd><p>sab diamond motion estimation
  728. </p></dd>
  729. </dl>
  730. </dd>
  731. <dt><span><samp>last_pred <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  732. <dd><p>Set amount of motion predictors from the previous frame.
  733. </p>
  734. </dd>
  735. <dt><span><samp>preme <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  736. <dd><p>Set pre motion estimation.
  737. </p>
  738. </dd>
  739. <dt><span><samp>precmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  740. <dd><p>Set pre motion estimation compare function.
  741. </p>
  742. <p>Possible values:
  743. </p><dl compact="compact">
  744. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  745. <dd><p>sum of absolute differences, fast (default)
  746. </p></dd>
  747. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  748. <dd><p>sum of squared errors
  749. </p></dd>
  750. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  751. <dd><p>sum of absolute Hadamard transformed differences
  752. </p></dd>
  753. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  754. <dd><p>sum of absolute DCT transformed differences
  755. </p></dd>
  756. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  757. <dd><p>sum of squared quantization errors (avoid, low quality)
  758. </p></dd>
  759. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  760. <dd><p>number of bits needed for the block
  761. </p></dd>
  762. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  763. <dd><p>rate distortion optimal, slow
  764. </p></dd>
  765. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  766. <dd><p>0
  767. </p></dd>
  768. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  769. <dd><p>sum of absolute vertical differences
  770. </p></dd>
  771. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  772. <dd><p>sum of squared vertical differences
  773. </p></dd>
  774. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  775. <dd><p>noise preserving sum of squared differences
  776. </p></dd>
  777. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  778. <dd><p>5/3 wavelet, only used in snow
  779. </p></dd>
  780. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  781. <dd><p>9/7 wavelet, only used in snow
  782. </p></dd>
  783. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  784. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  785. </dl>
  786. </dd>
  787. <dt><span><samp>pre_dia_size <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  788. <dd><p>Set diamond type &amp; size for motion estimation pre-pass.
  789. </p>
  790. </dd>
  791. <dt><span><samp>subq <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  792. <dd><p>Set sub pel motion estimation quality.
  793. </p>
  794. </dd>
  795. <dt><span><samp>me_range <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  796. <dd><p>Set limit motion vectors range (1023 for DivX player).
  797. </p>
  798. </dd>
  799. <dt><span><samp>global_quality <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  800. <dt><span><samp>coder <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  801. <dd>
  802. <p>Possible values:
  803. </p><dl compact="compact">
  804. <dt><span>&lsquo;<samp>vlc</samp>&rsquo;</span></dt>
  805. <dd><p>variable length coder / huffman coder
  806. </p></dd>
  807. <dt><span>&lsquo;<samp>ac</samp>&rsquo;</span></dt>
  808. <dd><p>arithmetic coder
  809. </p></dd>
  810. <dt><span>&lsquo;<samp>raw</samp>&rsquo;</span></dt>
  811. <dd><p>raw (no encoding)
  812. </p></dd>
  813. <dt><span>&lsquo;<samp>rle</samp>&rsquo;</span></dt>
  814. <dd><p>run-length coder
  815. </p></dd>
  816. </dl>
  817. </dd>
  818. <dt><span><samp>context <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  819. <dd><p>Set context model.
  820. </p>
  821. </dd>
  822. <dt><span><samp>slice_flags <var>integer</var></samp></span></dt>
  823. <dt><span><samp>mbd <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  824. <dd><p>Set macroblock decision algorithm (high quality mode).
  825. </p>
  826. <p>Possible values:
  827. </p><dl compact="compact">
  828. <dt><span>&lsquo;<samp>simple</samp>&rsquo;</span></dt>
  829. <dd><p>use mbcmp (default)
  830. </p></dd>
  831. <dt><span>&lsquo;<samp>bits</samp>&rsquo;</span></dt>
  832. <dd><p>use fewest bits
  833. </p></dd>
  834. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  835. <dd><p>use best rate distortion
  836. </p></dd>
  837. </dl>
  838. </dd>
  839. <dt><span><samp>sc_threshold <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  840. <dd><p>Set scene change threshold.
  841. </p>
  842. </dd>
  843. <dt><span><samp>nr <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  844. <dd><p>Set noise reduction.
  845. </p>
  846. </dd>
  847. <dt><span><samp>rc_init_occupancy <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  848. <dd><p>Set number of bits which should be loaded into the rc buffer before
  849. decoding starts.
  850. </p>
  851. </dd>
  852. <dt><span><samp>flags2 <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></span></dt>
  853. <dd>
  854. <p>Possible values:
  855. </p><dl compact="compact">
  856. <dt><span>&lsquo;<samp>fast</samp>&rsquo;</span></dt>
  857. <dd><p>Allow non spec compliant speedup tricks.
  858. </p></dd>
  859. <dt><span>&lsquo;<samp>noout</samp>&rsquo;</span></dt>
  860. <dd><p>Skip bitstream encoding.
  861. </p></dd>
  862. <dt><span>&lsquo;<samp>ignorecrop</samp>&rsquo;</span></dt>
  863. <dd><p>Ignore cropping information from sps.
  864. </p></dd>
  865. <dt><span>&lsquo;<samp>local_header</samp>&rsquo;</span></dt>
  866. <dd><p>Place global headers at every keyframe instead of in extradata.
  867. </p></dd>
  868. <dt><span>&lsquo;<samp>chunks</samp>&rsquo;</span></dt>
  869. <dd><p>Frame data might be split into multiple chunks.
  870. </p></dd>
  871. <dt><span>&lsquo;<samp>showall</samp>&rsquo;</span></dt>
  872. <dd><p>Show all frames before the first keyframe.
  873. </p></dd>
  874. <dt><span>&lsquo;<samp>export_mvs</samp>&rsquo;</span></dt>
  875. <dd><p>Export motion vectors into frame side-data (see <code>AV_FRAME_DATA_MOTION_VECTORS</code>)
  876. for codecs that support it. See also <samp>doc/examples/export_mvs.c</samp>.
  877. </p></dd>
  878. <dt><span>&lsquo;<samp>skip_manual</samp>&rsquo;</span></dt>
  879. <dd><p>Do not skip samples and export skip information as frame side data.
  880. </p></dd>
  881. <dt><span>&lsquo;<samp>ass_ro_flush_noop</samp>&rsquo;</span></dt>
  882. <dd><p>Do not reset ASS ReadOrder field on flush.
  883. </p></dd>
  884. </dl>
  885. </dd>
  886. <dt><span><samp>export_side_data <var>flags</var> (<em>decoding/encoding,audio,video,subtitles</em>)</samp></span></dt>
  887. <dd>
  888. <p>Possible values:
  889. </p><dl compact="compact">
  890. <dt><span>&lsquo;<samp>mvs</samp>&rsquo;</span></dt>
  891. <dd><p>Export motion vectors into frame side-data (see <code>AV_FRAME_DATA_MOTION_VECTORS</code>)
  892. for codecs that support it. See also <samp>doc/examples/export_mvs.c</samp>.
  893. </p></dd>
  894. <dt><span>&lsquo;<samp>prft</samp>&rsquo;</span></dt>
  895. <dd><p>Export encoder Producer Reference Time into packet side-data (see <code>AV_PKT_DATA_PRFT</code>)
  896. for codecs that support it.
  897. </p></dd>
  898. <dt><span>&lsquo;<samp>venc_params</samp>&rsquo;</span></dt>
  899. <dd><p>Export video encoding parameters through frame side data (see <code>AV_FRAME_DATA_VIDEO_ENC_PARAMS</code>)
  900. for codecs that support it. At present, those are H.264 and VP9.
  901. </p></dd>
  902. <dt><span>&lsquo;<samp>film_grain</samp>&rsquo;</span></dt>
  903. <dd><p>Export film grain parameters through frame side data (see <code>AV_FRAME_DATA_FILM_GRAIN_PARAMS</code>).
  904. Supported at present by AV1 decoders.
  905. </p></dd>
  906. </dl>
  907. </dd>
  908. <dt><span><samp>threads <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  909. <dd><p>Set the number of threads to be used, in case the selected codec
  910. implementation supports multi-threading.
  911. </p>
  912. <p>Possible values:
  913. </p><dl compact="compact">
  914. <dt><span>&lsquo;<samp>auto, 0</samp>&rsquo;</span></dt>
  915. <dd><p>automatically select the number of threads to set
  916. </p></dd>
  917. </dl>
  918. <p>Default value is &lsquo;<samp>auto</samp>&rsquo;.
  919. </p>
  920. </dd>
  921. <dt><span><samp>dc <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  922. <dd><p>Set intra_dc_precision.
  923. </p>
  924. </dd>
  925. <dt><span><samp>nssew <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  926. <dd><p>Set nsse weight.
  927. </p>
  928. </dd>
  929. <dt><span><samp>skip_top <var>integer</var> (<em>decoding,video</em>)</samp></span></dt>
  930. <dd><p>Set number of macroblock rows at the top which are skipped.
  931. </p>
  932. </dd>
  933. <dt><span><samp>skip_bottom <var>integer</var> (<em>decoding,video</em>)</samp></span></dt>
  934. <dd><p>Set number of macroblock rows at the bottom which are skipped.
  935. </p>
  936. </dd>
  937. <dt><span><samp>profile <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  938. <dd>
  939. <p>Set encoder codec profile. Default value is &lsquo;<samp>unknown</samp>&rsquo;. Encoder specific
  940. profiles are documented in the relevant encoder documentation.
  941. </p>
  942. </dd>
  943. <dt><span><samp>level <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  944. <dd>
  945. <p>Possible values:
  946. </p><dl compact="compact">
  947. <dt><span>&lsquo;<samp>unknown</samp>&rsquo;</span></dt>
  948. </dl>
  949. </dd>
  950. <dt><span><samp>lowres <var>integer</var> (<em>decoding,audio,video</em>)</samp></span></dt>
  951. <dd><p>Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions.
  952. </p>
  953. </dd>
  954. <dt><span><samp>skip_threshold <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  955. <dd><p>Set frame skip threshold.
  956. </p>
  957. </dd>
  958. <dt><span><samp>skip_factor <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  959. <dd><p>Set frame skip factor.
  960. </p>
  961. </dd>
  962. <dt><span><samp>skip_exp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  963. <dd><p>Set frame skip exponent.
  964. Negative values behave identical to the corresponding positive ones, except
  965. that the score is normalized.
  966. Positive values exist primarily for compatibility reasons and are not so useful.
  967. </p>
  968. </dd>
  969. <dt><span><samp>skipcmp <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  970. <dd><p>Set frame skip compare function.
  971. </p>
  972. <p>Possible values:
  973. </p><dl compact="compact">
  974. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  975. <dd><p>sum of absolute differences, fast (default)
  976. </p></dd>
  977. <dt><span>&lsquo;<samp>sse</samp>&rsquo;</span></dt>
  978. <dd><p>sum of squared errors
  979. </p></dd>
  980. <dt><span>&lsquo;<samp>satd</samp>&rsquo;</span></dt>
  981. <dd><p>sum of absolute Hadamard transformed differences
  982. </p></dd>
  983. <dt><span>&lsquo;<samp>dct</samp>&rsquo;</span></dt>
  984. <dd><p>sum of absolute DCT transformed differences
  985. </p></dd>
  986. <dt><span>&lsquo;<samp>psnr</samp>&rsquo;</span></dt>
  987. <dd><p>sum of squared quantization errors (avoid, low quality)
  988. </p></dd>
  989. <dt><span>&lsquo;<samp>bit</samp>&rsquo;</span></dt>
  990. <dd><p>number of bits needed for the block
  991. </p></dd>
  992. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  993. <dd><p>rate distortion optimal, slow
  994. </p></dd>
  995. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  996. <dd><p>0
  997. </p></dd>
  998. <dt><span>&lsquo;<samp>vsad</samp>&rsquo;</span></dt>
  999. <dd><p>sum of absolute vertical differences
  1000. </p></dd>
  1001. <dt><span>&lsquo;<samp>vsse</samp>&rsquo;</span></dt>
  1002. <dd><p>sum of squared vertical differences
  1003. </p></dd>
  1004. <dt><span>&lsquo;<samp>nsse</samp>&rsquo;</span></dt>
  1005. <dd><p>noise preserving sum of squared differences
  1006. </p></dd>
  1007. <dt><span>&lsquo;<samp>w53</samp>&rsquo;</span></dt>
  1008. <dd><p>5/3 wavelet, only used in snow
  1009. </p></dd>
  1010. <dt><span>&lsquo;<samp>w97</samp>&rsquo;</span></dt>
  1011. <dd><p>9/7 wavelet, only used in snow
  1012. </p></dd>
  1013. <dt><span>&lsquo;<samp>dctmax</samp>&rsquo;</span></dt>
  1014. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  1015. </dl>
  1016. </dd>
  1017. <dt><span><samp>mblmin <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1018. <dd><p>Set min macroblock lagrange factor (VBR).
  1019. </p>
  1020. </dd>
  1021. <dt><span><samp>mblmax <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1022. <dd><p>Set max macroblock lagrange factor (VBR).
  1023. </p>
  1024. </dd>
  1025. <dt><span><samp>mepc <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1026. <dd><p>Set motion estimation bitrate penalty compensation (1.0 = 256).
  1027. </p>
  1028. </dd>
  1029. <dt><span><samp>skip_loop_filter <var>integer</var> (<em>decoding,video</em>)</samp></span></dt>
  1030. <dt><span><samp>skip_idct <var>integer</var> (<em>decoding,video</em>)</samp></span></dt>
  1031. <dt><span><samp>skip_frame <var>integer</var> (<em>decoding,video</em>)</samp></span></dt>
  1032. <dd>
  1033. <p>Make decoder discard processing depending on the frame type selected
  1034. by the option value.
  1035. </p>
  1036. <p><samp>skip_loop_filter</samp> skips frame loop filtering, <samp>skip_idct</samp>
  1037. skips frame IDCT/dequantization, <samp>skip_frame</samp> skips decoding.
  1038. </p>
  1039. <p>Possible values:
  1040. </p><dl compact="compact">
  1041. <dt><span>&lsquo;<samp>none</samp>&rsquo;</span></dt>
  1042. <dd><p>Discard no frame.
  1043. </p>
  1044. </dd>
  1045. <dt><span>&lsquo;<samp>default</samp>&rsquo;</span></dt>
  1046. <dd><p>Discard useless frames like 0-sized frames.
  1047. </p>
  1048. </dd>
  1049. <dt><span>&lsquo;<samp>noref</samp>&rsquo;</span></dt>
  1050. <dd><p>Discard all non-reference frames.
  1051. </p>
  1052. </dd>
  1053. <dt><span>&lsquo;<samp>bidir</samp>&rsquo;</span></dt>
  1054. <dd><p>Discard all bidirectional frames.
  1055. </p>
  1056. </dd>
  1057. <dt><span>&lsquo;<samp>nokey</samp>&rsquo;</span></dt>
  1058. <dd><p>Discard all frames excepts keyframes.
  1059. </p>
  1060. </dd>
  1061. <dt><span>&lsquo;<samp>nointra</samp>&rsquo;</span></dt>
  1062. <dd><p>Discard all frames except I frames.
  1063. </p>
  1064. </dd>
  1065. <dt><span>&lsquo;<samp>all</samp>&rsquo;</span></dt>
  1066. <dd><p>Discard all frames.
  1067. </p></dd>
  1068. </dl>
  1069. <p>Default value is &lsquo;<samp>default</samp>&rsquo;.
  1070. </p>
  1071. </dd>
  1072. <dt><span><samp>bidir_refine <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1073. <dd><p>Refine the two motion vectors used in bidirectional macroblocks.
  1074. </p>
  1075. </dd>
  1076. <dt><span><samp>brd_scale <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1077. <dd><p>Downscale frames for dynamic B-frame decision.
  1078. </p>
  1079. </dd>
  1080. <dt><span><samp>keyint_min <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1081. <dd><p>Set minimum interval between IDR-frames.
  1082. </p>
  1083. </dd>
  1084. <dt><span><samp>refs <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1085. <dd><p>Set reference frames to consider for motion compensation.
  1086. </p>
  1087. </dd>
  1088. <dt><span><samp>chromaoffset <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1089. <dd><p>Set chroma qp offset from luma.
  1090. </p>
  1091. </dd>
  1092. <dt><span><samp>trellis <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  1093. <dd><p>Set rate-distortion optimal quantization.
  1094. </p>
  1095. </dd>
  1096. <dt><span><samp>mv0_threshold <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1097. <dt><span><samp>b_sensitivity <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1098. <dd><p>Adjust sensitivity of b_frame_strategy 1.
  1099. </p>
  1100. </dd>
  1101. <dt><span><samp>compression_level <var>integer</var> (<em>encoding,audio,video</em>)</samp></span></dt>
  1102. <dt><span><samp>min_prediction_order <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  1103. <dt><span><samp>max_prediction_order <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  1104. <dt><span><samp>timecode_frame_start <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1105. <dd><p>Set GOP timecode frame start number, in non drop frame format.
  1106. </p>
  1107. </dd>
  1108. <dt><span><samp>bits_per_raw_sample <var>integer</var></samp></span></dt>
  1109. <dt><span><samp>channel_layout <var>integer</var> (<em>decoding/encoding,audio</em>)</samp></span></dt>
  1110. <dd>
  1111. <p>Possible values:
  1112. </p></dd>
  1113. <dt><span><samp>request_channel_layout <var>integer</var> (<em>decoding,audio</em>)</samp></span></dt>
  1114. <dd>
  1115. <p>Possible values:
  1116. </p></dd>
  1117. <dt><span><samp>rc_max_vbv_use <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  1118. <dt><span><samp>rc_min_vbv_use <var>float</var> (<em>encoding,video</em>)</samp></span></dt>
  1119. <dt><span><samp>ticks_per_frame <var>integer</var> (<em>decoding/encoding,audio,video</em>)</samp></span></dt>
  1120. <dt><span><samp>color_primaries <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1121. <dd><p>Possible values:
  1122. </p><dl compact="compact">
  1123. <dt><span>&lsquo;<samp>bt709</samp>&rsquo;</span></dt>
  1124. <dd><p>BT.709
  1125. </p></dd>
  1126. <dt><span>&lsquo;<samp>bt470m</samp>&rsquo;</span></dt>
  1127. <dd><p>BT.470 M
  1128. </p></dd>
  1129. <dt><span>&lsquo;<samp>bt470bg</samp>&rsquo;</span></dt>
  1130. <dd><p>BT.470 BG
  1131. </p></dd>
  1132. <dt><span>&lsquo;<samp>smpte170m</samp>&rsquo;</span></dt>
  1133. <dd><p>SMPTE 170 M
  1134. </p></dd>
  1135. <dt><span>&lsquo;<samp>smpte240m</samp>&rsquo;</span></dt>
  1136. <dd><p>SMPTE 240 M
  1137. </p></dd>
  1138. <dt><span>&lsquo;<samp>film</samp>&rsquo;</span></dt>
  1139. <dd><p>Film
  1140. </p></dd>
  1141. <dt><span>&lsquo;<samp>bt2020</samp>&rsquo;</span></dt>
  1142. <dd><p>BT.2020
  1143. </p></dd>
  1144. <dt><span>&lsquo;<samp>smpte428</samp>&rsquo;</span></dt>
  1145. <dt><span>&lsquo;<samp>smpte428_1</samp>&rsquo;</span></dt>
  1146. <dd><p>SMPTE ST 428-1
  1147. </p></dd>
  1148. <dt><span>&lsquo;<samp>smpte431</samp>&rsquo;</span></dt>
  1149. <dd><p>SMPTE 431-2
  1150. </p></dd>
  1151. <dt><span>&lsquo;<samp>smpte432</samp>&rsquo;</span></dt>
  1152. <dd><p>SMPTE 432-1
  1153. </p></dd>
  1154. <dt><span>&lsquo;<samp>jedec-p22</samp>&rsquo;</span></dt>
  1155. <dd><p>JEDEC P22
  1156. </p></dd>
  1157. </dl>
  1158. </dd>
  1159. <dt><span><samp>color_trc <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1160. <dd><p>Possible values:
  1161. </p><dl compact="compact">
  1162. <dt><span>&lsquo;<samp>bt709</samp>&rsquo;</span></dt>
  1163. <dd><p>BT.709
  1164. </p></dd>
  1165. <dt><span>&lsquo;<samp>gamma22</samp>&rsquo;</span></dt>
  1166. <dd><p>BT.470 M
  1167. </p></dd>
  1168. <dt><span>&lsquo;<samp>gamma28</samp>&rsquo;</span></dt>
  1169. <dd><p>BT.470 BG
  1170. </p></dd>
  1171. <dt><span>&lsquo;<samp>smpte170m</samp>&rsquo;</span></dt>
  1172. <dd><p>SMPTE 170 M
  1173. </p></dd>
  1174. <dt><span>&lsquo;<samp>smpte240m</samp>&rsquo;</span></dt>
  1175. <dd><p>SMPTE 240 M
  1176. </p></dd>
  1177. <dt><span>&lsquo;<samp>linear</samp>&rsquo;</span></dt>
  1178. <dd><p>Linear
  1179. </p></dd>
  1180. <dt><span>&lsquo;<samp>log</samp>&rsquo;</span></dt>
  1181. <dt><span>&lsquo;<samp>log100</samp>&rsquo;</span></dt>
  1182. <dd><p>Log
  1183. </p></dd>
  1184. <dt><span>&lsquo;<samp>log_sqrt</samp>&rsquo;</span></dt>
  1185. <dt><span>&lsquo;<samp>log316</samp>&rsquo;</span></dt>
  1186. <dd><p>Log square root
  1187. </p></dd>
  1188. <dt><span>&lsquo;<samp>iec61966_2_4</samp>&rsquo;</span></dt>
  1189. <dt><span>&lsquo;<samp>iec61966-2-4</samp>&rsquo;</span></dt>
  1190. <dd><p>IEC 61966-2-4
  1191. </p></dd>
  1192. <dt><span>&lsquo;<samp>bt1361</samp>&rsquo;</span></dt>
  1193. <dt><span>&lsquo;<samp>bt1361e</samp>&rsquo;</span></dt>
  1194. <dd><p>BT.1361
  1195. </p></dd>
  1196. <dt><span>&lsquo;<samp>iec61966_2_1</samp>&rsquo;</span></dt>
  1197. <dt><span>&lsquo;<samp>iec61966-2-1</samp>&rsquo;</span></dt>
  1198. <dd><p>IEC 61966-2-1
  1199. </p></dd>
  1200. <dt><span>&lsquo;<samp>bt2020_10</samp>&rsquo;</span></dt>
  1201. <dt><span>&lsquo;<samp>bt2020_10bit</samp>&rsquo;</span></dt>
  1202. <dd><p>BT.2020 - 10 bit
  1203. </p></dd>
  1204. <dt><span>&lsquo;<samp>bt2020_12</samp>&rsquo;</span></dt>
  1205. <dt><span>&lsquo;<samp>bt2020_12bit</samp>&rsquo;</span></dt>
  1206. <dd><p>BT.2020 - 12 bit
  1207. </p></dd>
  1208. <dt><span>&lsquo;<samp>smpte2084</samp>&rsquo;</span></dt>
  1209. <dd><p>SMPTE ST 2084
  1210. </p></dd>
  1211. <dt><span>&lsquo;<samp>smpte428</samp>&rsquo;</span></dt>
  1212. <dt><span>&lsquo;<samp>smpte428_1</samp>&rsquo;</span></dt>
  1213. <dd><p>SMPTE ST 428-1
  1214. </p></dd>
  1215. <dt><span>&lsquo;<samp>arib-std-b67</samp>&rsquo;</span></dt>
  1216. <dd><p>ARIB STD-B67
  1217. </p></dd>
  1218. </dl>
  1219. </dd>
  1220. <dt><span><samp>colorspace <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1221. <dd><p>Possible values:
  1222. </p><dl compact="compact">
  1223. <dt><span>&lsquo;<samp>rgb</samp>&rsquo;</span></dt>
  1224. <dd><p>RGB
  1225. </p></dd>
  1226. <dt><span>&lsquo;<samp>bt709</samp>&rsquo;</span></dt>
  1227. <dd><p>BT.709
  1228. </p></dd>
  1229. <dt><span>&lsquo;<samp>fcc</samp>&rsquo;</span></dt>
  1230. <dd><p>FCC
  1231. </p></dd>
  1232. <dt><span>&lsquo;<samp>bt470bg</samp>&rsquo;</span></dt>
  1233. <dd><p>BT.470 BG
  1234. </p></dd>
  1235. <dt><span>&lsquo;<samp>smpte170m</samp>&rsquo;</span></dt>
  1236. <dd><p>SMPTE 170 M
  1237. </p></dd>
  1238. <dt><span>&lsquo;<samp>smpte240m</samp>&rsquo;</span></dt>
  1239. <dd><p>SMPTE 240 M
  1240. </p></dd>
  1241. <dt><span>&lsquo;<samp>ycocg</samp>&rsquo;</span></dt>
  1242. <dd><p>YCOCG
  1243. </p></dd>
  1244. <dt><span>&lsquo;<samp>bt2020nc</samp>&rsquo;</span></dt>
  1245. <dt><span>&lsquo;<samp>bt2020_ncl</samp>&rsquo;</span></dt>
  1246. <dd><p>BT.2020 NCL
  1247. </p></dd>
  1248. <dt><span>&lsquo;<samp>bt2020c</samp>&rsquo;</span></dt>
  1249. <dt><span>&lsquo;<samp>bt2020_cl</samp>&rsquo;</span></dt>
  1250. <dd><p>BT.2020 CL
  1251. </p></dd>
  1252. <dt><span>&lsquo;<samp>smpte2085</samp>&rsquo;</span></dt>
  1253. <dd><p>SMPTE 2085
  1254. </p></dd>
  1255. <dt><span>&lsquo;<samp>chroma-derived-nc</samp>&rsquo;</span></dt>
  1256. <dd><p>Chroma-derived NCL
  1257. </p></dd>
  1258. <dt><span>&lsquo;<samp>chroma-derived-c</samp>&rsquo;</span></dt>
  1259. <dd><p>Chroma-derived CL
  1260. </p></dd>
  1261. <dt><span>&lsquo;<samp>ictcp</samp>&rsquo;</span></dt>
  1262. <dd><p>ICtCp
  1263. </p></dd>
  1264. </dl>
  1265. </dd>
  1266. <dt><span><samp>color_range <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1267. <dd><p>If used as input parameter, it serves as a hint to the decoder, which
  1268. color_range the input has.
  1269. Possible values:
  1270. </p><dl compact="compact">
  1271. <dt><span>&lsquo;<samp>tv</samp>&rsquo;</span></dt>
  1272. <dt><span>&lsquo;<samp>mpeg</samp>&rsquo;</span></dt>
  1273. <dd><p>MPEG (219*2^(n-8))
  1274. </p></dd>
  1275. <dt><span>&lsquo;<samp>pc</samp>&rsquo;</span></dt>
  1276. <dt><span>&lsquo;<samp>jpeg</samp>&rsquo;</span></dt>
  1277. <dd><p>JPEG (2^n-1)
  1278. </p></dd>
  1279. </dl>
  1280. </dd>
  1281. <dt><span><samp>chroma_sample_location <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1282. <dd><p>Possible values:
  1283. </p><dl compact="compact">
  1284. <dt><span>&lsquo;<samp>left</samp>&rsquo;</span></dt>
  1285. <dt><span>&lsquo;<samp>center</samp>&rsquo;</span></dt>
  1286. <dt><span>&lsquo;<samp>topleft</samp>&rsquo;</span></dt>
  1287. <dt><span>&lsquo;<samp>top</samp>&rsquo;</span></dt>
  1288. <dt><span>&lsquo;<samp>bottomleft</samp>&rsquo;</span></dt>
  1289. <dt><span>&lsquo;<samp>bottom</samp>&rsquo;</span></dt>
  1290. </dl>
  1291. </dd>
  1292. <dt><span><samp>log_level_offset <var>integer</var></samp></span></dt>
  1293. <dd><p>Set the log level offset.
  1294. </p>
  1295. </dd>
  1296. <dt><span><samp>slices <var>integer</var> (<em>encoding,video</em>)</samp></span></dt>
  1297. <dd><p>Number of slices, used in parallelized encoding.
  1298. </p>
  1299. </dd>
  1300. <dt><span><samp>thread_type <var>flags</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1301. <dd><p>Select which multithreading methods to use.
  1302. </p>
  1303. <p>Use of &lsquo;<samp>frame</samp>&rsquo; will increase decoding delay by one frame per
  1304. thread, so clients which cannot provide future frames should not use
  1305. it.
  1306. </p>
  1307. <p>Possible values:
  1308. </p><dl compact="compact">
  1309. <dt><span>&lsquo;<samp>slice</samp>&rsquo;</span></dt>
  1310. <dd><p>Decode more than one part of a single frame at once.
  1311. </p>
  1312. <p>Multithreading using slices works only when the video was encoded with
  1313. slices.
  1314. </p>
  1315. </dd>
  1316. <dt><span>&lsquo;<samp>frame</samp>&rsquo;</span></dt>
  1317. <dd><p>Decode more than one frame at once.
  1318. </p></dd>
  1319. </dl>
  1320. <p>Default value is &lsquo;<samp>slice+frame</samp>&rsquo;.
  1321. </p>
  1322. </dd>
  1323. <dt><span><samp>audio_service_type <var>integer</var> (<em>encoding,audio</em>)</samp></span></dt>
  1324. <dd><p>Set audio service type.
  1325. </p>
  1326. <p>Possible values:
  1327. </p><dl compact="compact">
  1328. <dt><span>&lsquo;<samp>ma</samp>&rsquo;</span></dt>
  1329. <dd><p>Main Audio Service
  1330. </p></dd>
  1331. <dt><span>&lsquo;<samp>ef</samp>&rsquo;</span></dt>
  1332. <dd><p>Effects
  1333. </p></dd>
  1334. <dt><span>&lsquo;<samp>vi</samp>&rsquo;</span></dt>
  1335. <dd><p>Visually Impaired
  1336. </p></dd>
  1337. <dt><span>&lsquo;<samp>hi</samp>&rsquo;</span></dt>
  1338. <dd><p>Hearing Impaired
  1339. </p></dd>
  1340. <dt><span>&lsquo;<samp>di</samp>&rsquo;</span></dt>
  1341. <dd><p>Dialogue
  1342. </p></dd>
  1343. <dt><span>&lsquo;<samp>co</samp>&rsquo;</span></dt>
  1344. <dd><p>Commentary
  1345. </p></dd>
  1346. <dt><span>&lsquo;<samp>em</samp>&rsquo;</span></dt>
  1347. <dd><p>Emergency
  1348. </p></dd>
  1349. <dt><span>&lsquo;<samp>vo</samp>&rsquo;</span></dt>
  1350. <dd><p>Voice Over
  1351. </p></dd>
  1352. <dt><span>&lsquo;<samp>ka</samp>&rsquo;</span></dt>
  1353. <dd><p>Karaoke
  1354. </p></dd>
  1355. </dl>
  1356. </dd>
  1357. <dt><span><samp>request_sample_fmt <var>sample_fmt</var> (<em>decoding,audio</em>)</samp></span></dt>
  1358. <dd><p>Set sample format audio decoders should prefer. Default value is
  1359. <code>none</code>.
  1360. </p>
  1361. </dd>
  1362. <dt><span><samp>pkt_timebase <var>rational number</var></samp></span></dt>
  1363. <dt><span><samp>sub_charenc <var>encoding</var> (<em>decoding,subtitles</em>)</samp></span></dt>
  1364. <dd><p>Set the input subtitles character encoding.
  1365. </p>
  1366. </dd>
  1367. <dt><span><samp>field_order <var>field_order</var> (<em>video</em>)</samp></span></dt>
  1368. <dd><p>Set/override the field order of the video.
  1369. Possible values:
  1370. </p><dl compact="compact">
  1371. <dt><span>&lsquo;<samp>progressive</samp>&rsquo;</span></dt>
  1372. <dd><p>Progressive video
  1373. </p></dd>
  1374. <dt><span>&lsquo;<samp>tt</samp>&rsquo;</span></dt>
  1375. <dd><p>Interlaced video, top field coded and displayed first
  1376. </p></dd>
  1377. <dt><span>&lsquo;<samp>bb</samp>&rsquo;</span></dt>
  1378. <dd><p>Interlaced video, bottom field coded and displayed first
  1379. </p></dd>
  1380. <dt><span>&lsquo;<samp>tb</samp>&rsquo;</span></dt>
  1381. <dd><p>Interlaced video, top coded first, bottom displayed first
  1382. </p></dd>
  1383. <dt><span>&lsquo;<samp>bt</samp>&rsquo;</span></dt>
  1384. <dd><p>Interlaced video, bottom coded first, top displayed first
  1385. </p></dd>
  1386. </dl>
  1387. </dd>
  1388. <dt><span><samp>skip_alpha <var>bool</var> (<em>decoding,video</em>)</samp></span></dt>
  1389. <dd><p>Set to 1 to disable processing alpha (transparency). This works like the
  1390. &lsquo;<samp>gray</samp>&rsquo; flag in the <samp>flags</samp> option which skips chroma information
  1391. instead of alpha. Default is 0.
  1392. </p>
  1393. </dd>
  1394. <dt><span><samp>codec_whitelist <var>list</var> (<em>input</em>)</samp></span></dt>
  1395. <dd><p>&quot;,&quot; separated list of allowed decoders. By default all are allowed.
  1396. </p>
  1397. </dd>
  1398. <dt><span><samp>dump_separator <var>string</var> (<em>input</em>)</samp></span></dt>
  1399. <dd><p>Separator used to separate the fields printed on the command line about the
  1400. Stream parameters.
  1401. For example, to separate the fields with newlines and indentation:
  1402. </p><div class="example">
  1403. <pre class="example">ffprobe -dump_separator &quot;
  1404. &quot; -i ~/videos/matrixbench_mpeg2.mpg
  1405. </pre></div>
  1406. </dd>
  1407. <dt><span><samp>max_pixels <var>integer</var> (<em>decoding/encoding,video</em>)</samp></span></dt>
  1408. <dd><p>Maximum number of pixels per image. This value can be used to avoid out of
  1409. memory failures due to large images.
  1410. </p>
  1411. </dd>
  1412. <dt><span><samp>apply_cropping <var>bool</var> (<em>decoding,video</em>)</samp></span></dt>
  1413. <dd><p>Enable cropping if cropping parameters are multiples of the required
  1414. alignment for the left and top parameters. If the alignment is not met the
  1415. cropping will be partially applied to maintain alignment.
  1416. Default is 1 (enabled).
  1417. Note: The required alignment depends on if <code>AV_CODEC_FLAG_UNALIGNED</code> is set and the
  1418. CPU. <code>AV_CODEC_FLAG_UNALIGNED</code> cannot be changed from the command line. Also hardware
  1419. decoders will not apply left/top Cropping.
  1420. </p>
  1421. </dd>
  1422. </dl>
  1423. <a name="Decoders"></a>
  1424. <h2 class="chapter">3 Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Decoders" aria-hidden="true">TOC</a></span></h2>
  1425. <p>Decoders are configured elements in FFmpeg which allow the decoding of
  1426. multimedia streams.
  1427. </p>
  1428. <p>When you configure your FFmpeg build, all the supported native decoders
  1429. are enabled by default. Decoders requiring an external library must be enabled
  1430. manually via the corresponding <code>--enable-lib</code> option. You can list all
  1431. available decoders using the configure option <code>--list-decoders</code>.
  1432. </p>
  1433. <p>You can disable all the decoders with the configure option
  1434. <code>--disable-decoders</code> and selectively enable / disable single decoders
  1435. with the options <code>--enable-decoder=<var>DECODER</var></code> /
  1436. <code>--disable-decoder=<var>DECODER</var></code>.
  1437. </p>
  1438. <p>The option <code>-decoders</code> of the ff* tools will display the list of
  1439. enabled decoders.
  1440. </p>
  1441. <a name="Video-Decoders"></a>
  1442. <h2 class="chapter">4 Video Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Decoders" aria-hidden="true">TOC</a></span></h2>
  1443. <p>A description of some of the currently available video decoders
  1444. follows.
  1445. </p>
  1446. <a name="av1"></a>
  1447. <h3 class="section">4.1 av1<span class="pull-right"><a class="anchor hidden-xs" href="#av1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-av1" aria-hidden="true">TOC</a></span></h3>
  1448. <p>AOMedia Video 1 (AV1) decoder.
  1449. </p>
  1450. <a name="Options"></a>
  1451. <h4 class="subsection">4.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options" aria-hidden="true">TOC</a></span></h4>
  1452. <dl compact="compact">
  1453. <dt><span><samp>operating_point</samp></span></dt>
  1454. <dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Default is 0.
  1455. </p>
  1456. </dd>
  1457. </dl>
  1458. <a name="rawvideo"></a>
  1459. <h3 class="section">4.2 rawvideo<span class="pull-right"><a class="anchor hidden-xs" href="#rawvideo" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rawvideo" aria-hidden="true">TOC</a></span></h3>
  1460. <p>Raw video decoder.
  1461. </p>
  1462. <p>This decoder decodes rawvideo streams.
  1463. </p>
  1464. <a name="Options-1"></a>
  1465. <h4 class="subsection">4.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-1" aria-hidden="true">TOC</a></span></h4>
  1466. <dl compact="compact">
  1467. <dt><span><samp>top <var>top_field_first</var></samp></span></dt>
  1468. <dd><p>Specify the assumed field type of the input video.
  1469. </p><dl compact="compact">
  1470. <dt><span><samp>-1</samp></span></dt>
  1471. <dd><p>the video is assumed to be progressive (default)
  1472. </p></dd>
  1473. <dt><span><samp>0</samp></span></dt>
  1474. <dd><p>bottom-field-first is assumed
  1475. </p></dd>
  1476. <dt><span><samp>1</samp></span></dt>
  1477. <dd><p>top-field-first is assumed
  1478. </p></dd>
  1479. </dl>
  1480. </dd>
  1481. </dl>
  1482. <a name="libdav1d"></a>
  1483. <h3 class="section">4.3 libdav1d<span class="pull-right"><a class="anchor hidden-xs" href="#libdav1d" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libdav1d" aria-hidden="true">TOC</a></span></h3>
  1484. <p>dav1d AV1 decoder.
  1485. </p>
  1486. <p>libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec.
  1487. Requires the presence of the libdav1d headers and library during configuration.
  1488. You need to explicitly configure the build with <code>--enable-libdav1d</code>.
  1489. </p>
  1490. <a name="Options-2"></a>
  1491. <h4 class="subsection">4.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-2" aria-hidden="true">TOC</a></span></h4>
  1492. <p>The following options are supported by the libdav1d wrapper.
  1493. </p>
  1494. <dl compact="compact">
  1495. <dt><span><samp>framethreads</samp></span></dt>
  1496. <dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
  1497. </p>
  1498. </dd>
  1499. <dt><span><samp>tilethreads</samp></span></dt>
  1500. <dd><p>Set amount of tile threads to use during decoding. The default value is 0 (autodetect).
  1501. </p>
  1502. </dd>
  1503. <dt><span><samp>filmgrain</samp></span></dt>
  1504. <dd><p>Apply film grain to the decoded video if present in the bitstream. Defaults to the
  1505. internal default of the library.
  1506. </p>
  1507. </dd>
  1508. <dt><span><samp>oppoint</samp></span></dt>
  1509. <dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the
  1510. internal default of the library.
  1511. </p>
  1512. </dd>
  1513. <dt><span><samp>alllayers</samp></span></dt>
  1514. <dd><p>Output all spatial layers of a scalable AV1 bitstream. The default value is false.
  1515. </p>
  1516. </dd>
  1517. </dl>
  1518. <a name="libdavs2"></a>
  1519. <h3 class="section">4.4 libdavs2<span class="pull-right"><a class="anchor hidden-xs" href="#libdavs2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libdavs2" aria-hidden="true">TOC</a></span></h3>
  1520. <p>AVS2-P2/IEEE1857.4 video decoder wrapper.
  1521. </p>
  1522. <p>This decoder allows libavcodec to decode AVS2 streams with davs2 library.
  1523. </p>
  1524. <a name="libuavs3d"></a>
  1525. <h3 class="section">4.5 libuavs3d<span class="pull-right"><a class="anchor hidden-xs" href="#libuavs3d" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libuavs3d" aria-hidden="true">TOC</a></span></h3>
  1526. <p>AVS3-P2/IEEE1857.10 video decoder.
  1527. </p>
  1528. <p>libuavs3d allows libavcodec to decode AVS3 streams.
  1529. Requires the presence of the libuavs3d headers and library during configuration.
  1530. You need to explicitly configure the build with <code>--enable-libuavs3d</code>.
  1531. </p>
  1532. <a name="Options-3"></a>
  1533. <h4 class="subsection">4.5.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-3" aria-hidden="true">TOC</a></span></h4>
  1534. <p>The following option is supported by the libuavs3d wrapper.
  1535. </p>
  1536. <dl compact="compact">
  1537. <dt><span><samp>frame_threads</samp></span></dt>
  1538. <dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
  1539. </p>
  1540. </dd>
  1541. </dl>
  1542. <a name="Audio-Decoders"></a>
  1543. <h2 class="chapter">5 Audio Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Decoders" aria-hidden="true">TOC</a></span></h2>
  1544. <p>A description of some of the currently available audio decoders
  1545. follows.
  1546. </p>
  1547. <a name="ac3"></a>
  1548. <h3 class="section">5.1 ac3<span class="pull-right"><a class="anchor hidden-xs" href="#ac3" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ac3" aria-hidden="true">TOC</a></span></h3>
  1549. <p>AC-3 audio decoder.
  1550. </p>
  1551. <p>This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  1552. the undocumented RealAudio 3 (a.k.a. dnet).
  1553. </p>
  1554. <a name="AC_002d3-Decoder-Options"></a>
  1555. <h4 class="subsection">5.1.1 AC-3 Decoder Options<span class="pull-right"><a class="anchor hidden-xs" href="#AC_002d3-Decoder-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-AC_002d3-Decoder-Options" aria-hidden="true">TOC</a></span></h4>
  1556. <dl compact="compact">
  1557. <dt><span><samp>-drc_scale <var>value</var></samp></span></dt>
  1558. <dd><p>Dynamic Range Scale Factor. The factor to apply to dynamic range values
  1559. from the AC-3 stream. This factor is applied exponentially. The default value is 1.
  1560. There are 3 notable scale factor ranges:
  1561. </p><dl compact="compact">
  1562. <dt><span><samp>drc_scale == 0</samp></span></dt>
  1563. <dd><p>DRC disabled. Produces full range audio.
  1564. </p></dd>
  1565. <dt><span><samp>0 &lt; drc_scale &lt;= 1</samp></span></dt>
  1566. <dd><p>DRC enabled. Applies a fraction of the stream DRC value.
  1567. Audio reproduction is between full range and full compression.
  1568. </p></dd>
  1569. <dt><span><samp>drc_scale &gt; 1</samp></span></dt>
  1570. <dd><p>DRC enabled. Applies drc_scale asymmetrically.
  1571. Loud sounds are fully compressed. Soft sounds are enhanced.
  1572. </p></dd>
  1573. </dl>
  1574. </dd>
  1575. </dl>
  1576. <a name="flac-1"></a>
  1577. <h3 class="section">5.2 flac<span class="pull-right"><a class="anchor hidden-xs" href="#flac-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flac-1" aria-hidden="true">TOC</a></span></h3>
  1578. <p>FLAC audio decoder.
  1579. </p>
  1580. <p>This decoder aims to implement the complete FLAC specification from Xiph.
  1581. </p>
  1582. <a name="FLAC-Decoder-options"></a>
  1583. <h4 class="subsection">5.2.1 FLAC Decoder options<span class="pull-right"><a class="anchor hidden-xs" href="#FLAC-Decoder-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-FLAC-Decoder-options" aria-hidden="true">TOC</a></span></h4>
  1584. <dl compact="compact">
  1585. <dt><span><samp>-use_buggy_lpc</samp></span></dt>
  1586. <dd><p>The lavc FLAC encoder used to produce buggy streams with high lpc values
  1587. (like the default value). This option makes it possible to decode such streams
  1588. correctly by using lavc&rsquo;s old buggy lpc logic for decoding.
  1589. </p>
  1590. </dd>
  1591. </dl>
  1592. <a name="ffwavesynth"></a>
  1593. <h3 class="section">5.3 ffwavesynth<span class="pull-right"><a class="anchor hidden-xs" href="#ffwavesynth" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ffwavesynth" aria-hidden="true">TOC</a></span></h3>
  1594. <p>Internal wave synthesizer.
  1595. </p>
  1596. <p>This decoder generates wave patterns according to predefined sequences. Its
  1597. use is purely internal and the format of the data it accepts is not publicly
  1598. documented.
  1599. </p>
  1600. <a name="libcelt"></a>
  1601. <h3 class="section">5.4 libcelt<span class="pull-right"><a class="anchor hidden-xs" href="#libcelt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libcelt" aria-hidden="true">TOC</a></span></h3>
  1602. <p>libcelt decoder wrapper.
  1603. </p>
  1604. <p>libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec.
  1605. Requires the presence of the libcelt headers and library during configuration.
  1606. You need to explicitly configure the build with <code>--enable-libcelt</code>.
  1607. </p>
  1608. <a name="libgsm"></a>
  1609. <h3 class="section">5.5 libgsm<span class="pull-right"><a class="anchor hidden-xs" href="#libgsm" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libgsm" aria-hidden="true">TOC</a></span></h3>
  1610. <p>libgsm decoder wrapper.
  1611. </p>
  1612. <p>libgsm allows libavcodec to decode the GSM full rate audio codec. Requires
  1613. the presence of the libgsm headers and library during configuration. You need
  1614. to explicitly configure the build with <code>--enable-libgsm</code>.
  1615. </p>
  1616. <p>This decoder supports both the ordinary GSM and the Microsoft variant.
  1617. </p>
  1618. <a name="libilbc"></a>
  1619. <h3 class="section">5.6 libilbc<span class="pull-right"><a class="anchor hidden-xs" href="#libilbc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libilbc" aria-hidden="true">TOC</a></span></h3>
  1620. <p>libilbc decoder wrapper.
  1621. </p>
  1622. <p>libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC)
  1623. audio codec. Requires the presence of the libilbc headers and library during
  1624. configuration. You need to explicitly configure the build with
  1625. <code>--enable-libilbc</code>.
  1626. </p>
  1627. <a name="Options-4"></a>
  1628. <h4 class="subsection">5.6.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-4" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-4" aria-hidden="true">TOC</a></span></h4>
  1629. <p>The following option is supported by the libilbc wrapper.
  1630. </p>
  1631. <dl compact="compact">
  1632. <dt><span><samp>enhance</samp></span></dt>
  1633. <dd>
  1634. <p>Enable the enhancement of the decoded audio when set to 1. The default
  1635. value is 0 (disabled).
  1636. </p>
  1637. </dd>
  1638. </dl>
  1639. <a name="libopencore_002damrnb"></a>
  1640. <h3 class="section">5.7 libopencore-amrnb<span class="pull-right"><a class="anchor hidden-xs" href="#libopencore_002damrnb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopencore_002damrnb" aria-hidden="true">TOC</a></span></h3>
  1641. <p>libopencore-amrnb decoder wrapper.
  1642. </p>
  1643. <p>libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate
  1644. Narrowband audio codec. Using it requires the presence of the
  1645. libopencore-amrnb headers and library during configuration. You need to
  1646. explicitly configure the build with <code>--enable-libopencore-amrnb</code>.
  1647. </p>
  1648. <p>An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB
  1649. without this library.
  1650. </p>
  1651. <a name="libopencore_002damrwb"></a>
  1652. <h3 class="section">5.8 libopencore-amrwb<span class="pull-right"><a class="anchor hidden-xs" href="#libopencore_002damrwb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopencore_002damrwb" aria-hidden="true">TOC</a></span></h3>
  1653. <p>libopencore-amrwb decoder wrapper.
  1654. </p>
  1655. <p>libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate
  1656. Wideband audio codec. Using it requires the presence of the
  1657. libopencore-amrwb headers and library during configuration. You need to
  1658. explicitly configure the build with <code>--enable-libopencore-amrwb</code>.
  1659. </p>
  1660. <p>An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB
  1661. without this library.
  1662. </p>
  1663. <a name="libopus"></a>
  1664. <h3 class="section">5.9 libopus<span class="pull-right"><a class="anchor hidden-xs" href="#libopus" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopus" aria-hidden="true">TOC</a></span></h3>
  1665. <p>libopus decoder wrapper.
  1666. </p>
  1667. <p>libopus allows libavcodec to decode the Opus Interactive Audio Codec.
  1668. Requires the presence of the libopus headers and library during
  1669. configuration. You need to explicitly configure the build with
  1670. <code>--enable-libopus</code>.
  1671. </p>
  1672. <p>An FFmpeg native decoder for Opus exists, so users can decode Opus
  1673. without this library.
  1674. </p>
  1675. <a name="Subtitles-Decoders"></a>
  1676. <h2 class="chapter">6 Subtitles Decoders<span class="pull-right"><a class="anchor hidden-xs" href="#Subtitles-Decoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Subtitles-Decoders" aria-hidden="true">TOC</a></span></h2>
  1677. <a name="libaribb24"></a>
  1678. <h3 class="section">6.1 libaribb24<span class="pull-right"><a class="anchor hidden-xs" href="#libaribb24" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libaribb24" aria-hidden="true">TOC</a></span></h3>
  1679. <p>ARIB STD-B24 caption decoder.
  1680. </p>
  1681. <p>Implements profiles A and C of the ARIB STD-B24 standard.
  1682. </p>
  1683. <a name="libaribb24-Decoder-Options"></a>
  1684. <h4 class="subsection">6.1.1 libaribb24 Decoder Options<span class="pull-right"><a class="anchor hidden-xs" href="#libaribb24-Decoder-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libaribb24-Decoder-Options" aria-hidden="true">TOC</a></span></h4>
  1685. <dl compact="compact">
  1686. <dt><span><samp>-aribb24-base-path <var>path</var></samp></span></dt>
  1687. <dd><p>Sets the base path for the libaribb24 library. This is utilized for reading of
  1688. configuration files (for custom unicode conversions), and for dumping of
  1689. non-text symbols as images under that location.
  1690. </p>
  1691. <p>Unset by default.
  1692. </p>
  1693. </dd>
  1694. <dt><span><samp>-aribb24-skip-ruby-text <var>boolean</var></samp></span></dt>
  1695. <dd><p>Tells the decoder wrapper to skip text blocks that contain half-height ruby
  1696. text.
  1697. </p>
  1698. <p>Enabled by default.
  1699. </p>
  1700. </dd>
  1701. </dl>
  1702. <a name="dvbsub"></a>
  1703. <h3 class="section">6.2 dvbsub<span class="pull-right"><a class="anchor hidden-xs" href="#dvbsub" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dvbsub" aria-hidden="true">TOC</a></span></h3>
  1704. <a name="Options-5"></a>
  1705. <h4 class="subsection">6.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-5" aria-hidden="true">TOC</a></span></h4>
  1706. <dl compact="compact">
  1707. <dt><span><samp>compute_clut</samp></span></dt>
  1708. <dd><dl compact="compact">
  1709. <dt><span><samp>-1</samp></span></dt>
  1710. <dd><p>Compute clut if no matching CLUT is in the stream.
  1711. </p></dd>
  1712. <dt><span><samp>0</samp></span></dt>
  1713. <dd><p>Never compute CLUT
  1714. </p></dd>
  1715. <dt><span><samp>1</samp></span></dt>
  1716. <dd><p>Always compute CLUT and override the one provided in the stream.
  1717. </p></dd>
  1718. </dl>
  1719. </dd>
  1720. <dt><span><samp>dvb_substream</samp></span></dt>
  1721. <dd><p>Selects the dvb substream, or all substreams if -1 which is default.
  1722. </p>
  1723. </dd>
  1724. </dl>
  1725. <a name="dvdsub"></a>
  1726. <h3 class="section">6.3 dvdsub<span class="pull-right"><a class="anchor hidden-xs" href="#dvdsub" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dvdsub" aria-hidden="true">TOC</a></span></h3>
  1727. <p>This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
  1728. also be found in VobSub file pairs and in some Matroska files.
  1729. </p>
  1730. <a name="Options-6"></a>
  1731. <h4 class="subsection">6.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-6" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-6" aria-hidden="true">TOC</a></span></h4>
  1732. <dl compact="compact">
  1733. <dt><span><samp>palette</samp></span></dt>
  1734. <dd><p>Specify the global palette used by the bitmaps. When stored in VobSub, the
  1735. palette is normally specified in the index file; in Matroska, the palette is
  1736. stored in the codec extra-data in the same format as in VobSub. In DVDs, the
  1737. palette is stored in the IFO file, and therefore not available when reading
  1738. from dumped VOB files.
  1739. </p>
  1740. <p>The format for this option is a string containing 16 24-bits hexadecimal
  1741. numbers (without 0x prefix) separated by commas, for example <code>0d00ee,
  1742. ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
  1743. 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
  1744. </p>
  1745. </dd>
  1746. <dt><span><samp>ifo_palette</samp></span></dt>
  1747. <dd><p>Specify the IFO file from which the global palette is obtained.
  1748. (experimental)
  1749. </p>
  1750. </dd>
  1751. <dt><span><samp>forced_subs_only</samp></span></dt>
  1752. <dd><p>Only decode subtitle entries marked as forced. Some titles have forced
  1753. and non-forced subtitles in the same track. Setting this flag to <code>1</code>
  1754. will only keep the forced subtitles. Default value is <code>0</code>.
  1755. </p></dd>
  1756. </dl>
  1757. <a name="libzvbi_002dteletext"></a>
  1758. <h3 class="section">6.4 libzvbi-teletext<span class="pull-right"><a class="anchor hidden-xs" href="#libzvbi_002dteletext" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libzvbi_002dteletext" aria-hidden="true">TOC</a></span></h3>
  1759. <p>Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext
  1760. subtitles. Requires the presence of the libzvbi headers and library during
  1761. configuration. You need to explicitly configure the build with
  1762. <code>--enable-libzvbi</code>.
  1763. </p>
  1764. <a name="Options-7"></a>
  1765. <h4 class="subsection">6.4.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-7" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-7" aria-hidden="true">TOC</a></span></h4>
  1766. <dl compact="compact">
  1767. <dt><span><samp>txt_page</samp></span></dt>
  1768. <dd><p>List of teletext page numbers to decode. Pages that do not match the specified
  1769. list are dropped. You may use the special <code>*</code> string to match all pages,
  1770. or <code>subtitle</code> to match all subtitle pages.
  1771. Default value is *.
  1772. </p></dd>
  1773. <dt><span><samp>txt_default_region</samp></span></dt>
  1774. <dd><p>Set default character set used for decoding, a value between 0 and 87 (see
  1775. ETS 300 706, Section 15, Table 32). Default value is -1, which does not
  1776. override the libzvbi default. This option is needed for some legacy level 1.0
  1777. transmissions which cannot signal the proper charset.
  1778. </p></dd>
  1779. <dt><span><samp>txt_chop_top</samp></span></dt>
  1780. <dd><p>Discards the top teletext line. Default value is 1.
  1781. </p></dd>
  1782. <dt><span><samp>txt_format</samp></span></dt>
  1783. <dd><p>Specifies the format of the decoded subtitles.
  1784. </p><dl compact="compact">
  1785. <dt><span><samp>bitmap</samp></span></dt>
  1786. <dd><p>The default format, you should use this for teletext pages, because certain
  1787. graphics and colors cannot be expressed in simple text or even ASS.
  1788. </p></dd>
  1789. <dt><span><samp>text</samp></span></dt>
  1790. <dd><p>Simple text based output without formatting.
  1791. </p></dd>
  1792. <dt><span><samp>ass</samp></span></dt>
  1793. <dd><p>Formatted ASS output, subtitle pages and teletext pages are returned in
  1794. different styles, subtitle pages are stripped down to text, but an effort is
  1795. made to keep the text alignment and the formatting.
  1796. </p></dd>
  1797. </dl>
  1798. </dd>
  1799. <dt><span><samp>txt_left</samp></span></dt>
  1800. <dd><p>X offset of generated bitmaps, default is 0.
  1801. </p></dd>
  1802. <dt><span><samp>txt_top</samp></span></dt>
  1803. <dd><p>Y offset of generated bitmaps, default is 0.
  1804. </p></dd>
  1805. <dt><span><samp>txt_chop_spaces</samp></span></dt>
  1806. <dd><p>Chops leading and trailing spaces and removes empty lines from the generated
  1807. text. This option is useful for teletext based subtitles where empty spaces may
  1808. be present at the start or at the end of the lines or empty lines may be
  1809. present between the subtitle lines because of double-sized teletext characters.
  1810. Default value is 1.
  1811. </p></dd>
  1812. <dt><span><samp>txt_duration</samp></span></dt>
  1813. <dd><p>Sets the display duration of the decoded teletext pages or subtitles in
  1814. milliseconds. Default value is -1 which means infinity or until the next
  1815. subtitle event comes.
  1816. </p></dd>
  1817. <dt><span><samp>txt_transparent</samp></span></dt>
  1818. <dd><p>Force transparent background of the generated teletext bitmaps. Default value
  1819. is 0 which means an opaque background.
  1820. </p></dd>
  1821. <dt><span><samp>txt_opacity</samp></span></dt>
  1822. <dd><p>Sets the opacity (0-255) of the teletext background. If
  1823. <samp>txt_transparent</samp> is not set, it only affects characters between a start
  1824. box and an end box, typically subtitles. Default value is 0 if
  1825. <samp>txt_transparent</samp> is set, 255 otherwise.
  1826. </p>
  1827. </dd>
  1828. </dl>
  1829. <a name="Encoders"></a>
  1830. <h2 class="chapter">7 Encoders<span class="pull-right"><a class="anchor hidden-xs" href="#Encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Encoders" aria-hidden="true">TOC</a></span></h2>
  1831. <p>Encoders are configured elements in FFmpeg which allow the encoding of
  1832. multimedia streams.
  1833. </p>
  1834. <p>When you configure your FFmpeg build, all the supported native encoders
  1835. are enabled by default. Encoders requiring an external library must be enabled
  1836. manually via the corresponding <code>--enable-lib</code> option. You can list all
  1837. available encoders using the configure option <code>--list-encoders</code>.
  1838. </p>
  1839. <p>You can disable all the encoders with the configure option
  1840. <code>--disable-encoders</code> and selectively enable / disable single encoders
  1841. with the options <code>--enable-encoder=<var>ENCODER</var></code> /
  1842. <code>--disable-encoder=<var>ENCODER</var></code>.
  1843. </p>
  1844. <p>The option <code>-encoders</code> of the ff* tools will display the list of
  1845. enabled encoders.
  1846. </p>
  1847. <a name="Audio-Encoders"></a>
  1848. <h2 class="chapter">8 Audio Encoders<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Encoders" aria-hidden="true">TOC</a></span></h2>
  1849. <p>A description of some of the currently available audio encoders
  1850. follows.
  1851. </p>
  1852. <span id="aacenc"></span><a name="aac"></a>
  1853. <h3 class="section">8.1 aac<span class="pull-right"><a class="anchor hidden-xs" href="#aac" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-aac" aria-hidden="true">TOC</a></span></h3>
  1854. <p>Advanced Audio Coding (AAC) encoder.
  1855. </p>
  1856. <p>This encoder is the default AAC encoder, natively implemented into FFmpeg.
  1857. </p>
  1858. <a name="Options-8"></a>
  1859. <h4 class="subsection">8.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-8" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-8" aria-hidden="true">TOC</a></span></h4>
  1860. <dl compact="compact">
  1861. <dt><span><samp>b</samp></span></dt>
  1862. <dd><p>Set bit rate in bits/s. Setting this automatically activates constant bit rate
  1863. (CBR) mode. If this option is unspecified it is set to 128kbps.
  1864. </p>
  1865. </dd>
  1866. <dt><span><samp>q</samp></span></dt>
  1867. <dd><p>Set quality for variable bit rate (VBR) mode. This option is valid only using
  1868. the <code>ffmpeg</code> command-line tool. For library interface users, use
  1869. <samp>global_quality</samp>.
  1870. </p>
  1871. </dd>
  1872. <dt><span><samp>cutoff</samp></span></dt>
  1873. <dd><p>Set cutoff frequency. If unspecified will allow the encoder to dynamically
  1874. adjust the cutoff to improve clarity on low bitrates.
  1875. </p>
  1876. </dd>
  1877. <dt><span><samp>aac_coder</samp></span></dt>
  1878. <dd><p>Set AAC encoder coding method. Possible values:
  1879. </p>
  1880. <dl compact="compact">
  1881. <dt><span>&lsquo;<samp>twoloop</samp>&rsquo;</span></dt>
  1882. <dd><p>Two loop searching (TLS) method.
  1883. </p>
  1884. <p>This method first sets quantizers depending on band thresholds and then tries
  1885. to find an optimal combination by adding or subtracting a specific value from
  1886. all quantizers and adjusting some individual quantizer a little. Will tune
  1887. itself based on whether <samp>aac_is</samp>, <samp>aac_ms</samp> and <samp>aac_pns</samp>
  1888. are enabled.
  1889. </p>
  1890. </dd>
  1891. <dt><span>&lsquo;<samp>anmr</samp>&rsquo;</span></dt>
  1892. <dd><p>Average noise to mask ratio (ANMR) trellis-based solution.
  1893. </p>
  1894. <p>This is an experimental coder which currently produces a lower quality, is more
  1895. unstable and is slower than the default twoloop coder but has potential.
  1896. Currently has no support for the <samp>aac_is</samp> or <samp>aac_pns</samp> options.
  1897. Not currently recommended.
  1898. </p>
  1899. </dd>
  1900. <dt><span>&lsquo;<samp>fast</samp>&rsquo;</span></dt>
  1901. <dd><p>Constant quantizer method.
  1902. </p>
  1903. <p>Uses a cheaper version of twoloop algorithm that doesn&rsquo;t try to do as many
  1904. clever adjustments. Worse with low bitrates (less than 64kbps), but is better
  1905. and much faster at higher bitrates.
  1906. This is the default choice for a coder
  1907. </p>
  1908. </dd>
  1909. </dl>
  1910. </dd>
  1911. <dt><span><samp>aac_ms</samp></span></dt>
  1912. <dd><p>Sets mid/side coding mode. The default value of &quot;auto&quot; will automatically use
  1913. M/S with bands which will benefit from such coding. Can be forced for all bands
  1914. using the value &quot;enable&quot;, which is mainly useful for debugging or disabled using
  1915. &quot;disable&quot;.
  1916. </p>
  1917. </dd>
  1918. <dt><span><samp>aac_is</samp></span></dt>
  1919. <dd><p>Sets intensity stereo coding tool usage. By default, it&rsquo;s enabled and will
  1920. automatically toggle IS for similar pairs of stereo bands if it&rsquo;s beneficial.
  1921. Can be disabled for debugging by setting the value to &quot;disable&quot;.
  1922. </p>
  1923. </dd>
  1924. <dt><span><samp>aac_pns</samp></span></dt>
  1925. <dd><p>Uses perceptual noise substitution to replace low entropy high frequency bands
  1926. with imperceptible white noise during the decoding process. By default, it&rsquo;s
  1927. enabled, but can be disabled for debugging purposes by using &quot;disable&quot;.
  1928. </p>
  1929. </dd>
  1930. <dt><span><samp>aac_tns</samp></span></dt>
  1931. <dd><p>Enables the use of a multitap FIR filter which spans through the high frequency
  1932. bands to hide quantization noise during the encoding process and is reverted
  1933. by the decoder. As well as decreasing unpleasant artifacts in the high range
  1934. this also reduces the entropy in the high bands and allows for more bits to
  1935. be used by the mid-low bands. By default it&rsquo;s enabled but can be disabled for
  1936. debugging by setting the option to &quot;disable&quot;.
  1937. </p>
  1938. </dd>
  1939. <dt><span><samp>aac_ltp</samp></span></dt>
  1940. <dd><p>Enables the use of the long term prediction extension which increases coding
  1941. efficiency in very low bandwidth situations such as encoding of voice or
  1942. solo piano music by extending constant harmonic peaks in bands throughout
  1943. frames. This option is implied by profile:a aac_low and is incompatible with
  1944. aac_pred. Use in conjunction with <samp>-ar</samp> to decrease the samplerate.
  1945. </p>
  1946. </dd>
  1947. <dt><span><samp>aac_pred</samp></span></dt>
  1948. <dd><p>Enables the use of a more traditional style of prediction where the spectral
  1949. coefficients transmitted are replaced by the difference of the current
  1950. coefficients minus the previous &quot;predicted&quot; coefficients. In theory and sometimes
  1951. in practice this can improve quality for low to mid bitrate audio.
  1952. This option implies the aac_main profile and is incompatible with aac_ltp.
  1953. </p>
  1954. </dd>
  1955. <dt><span><samp>profile</samp></span></dt>
  1956. <dd><p>Sets the encoding profile, possible values:
  1957. </p>
  1958. <dl compact="compact">
  1959. <dt><span>&lsquo;<samp>aac_low</samp>&rsquo;</span></dt>
  1960. <dd><p>The default, AAC &quot;Low-complexity&quot; profile. Is the most compatible and produces
  1961. decent quality.
  1962. </p>
  1963. </dd>
  1964. <dt><span>&lsquo;<samp>mpeg2_aac_low</samp>&rsquo;</span></dt>
  1965. <dd><p>Equivalent to <code>-profile:a aac_low -aac_pns 0</code>. PNS was introduced with the
  1966. MPEG4 specifications.
  1967. </p>
  1968. </dd>
  1969. <dt><span>&lsquo;<samp>aac_ltp</samp>&rsquo;</span></dt>
  1970. <dd><p>Long term prediction profile, is enabled by and will enable the <samp>aac_ltp</samp>
  1971. option. Introduced in MPEG4.
  1972. </p>
  1973. </dd>
  1974. <dt><span>&lsquo;<samp>aac_main</samp>&rsquo;</span></dt>
  1975. <dd><p>Main-type prediction profile, is enabled by and will enable the <samp>aac_pred</samp>
  1976. option. Introduced in MPEG2.
  1977. </p>
  1978. </dd>
  1979. </dl>
  1980. <p>If this option is unspecified it is set to &lsquo;<samp>aac_low</samp>&rsquo;.
  1981. </p></dd>
  1982. </dl>
  1983. <a name="ac3-and-ac3_005ffixed"></a>
  1984. <h3 class="section">8.2 ac3 and ac3_fixed<span class="pull-right"><a class="anchor hidden-xs" href="#ac3-and-ac3_005ffixed" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ac3-and-ac3_005ffixed" aria-hidden="true">TOC</a></span></h3>
  1985. <p>AC-3 audio encoders.
  1986. </p>
  1987. <p>These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  1988. the undocumented RealAudio 3 (a.k.a. dnet).
  1989. </p>
  1990. <p>The <var>ac3</var> encoder uses floating-point math, while the <var>ac3_fixed</var>
  1991. encoder only uses fixed-point integer math. This does not mean that one is
  1992. always faster, just that one or the other may be better suited to a
  1993. particular system. The <var>ac3_fixed</var> encoder is not the default codec for
  1994. any of the output formats, so it must be specified explicitly using the option
  1995. <code>-acodec ac3_fixed</code> in order to use it.
  1996. </p>
  1997. <a name="AC_002d3-Metadata"></a>
  1998. <h4 class="subsection">8.2.1 AC-3 Metadata<span class="pull-right"><a class="anchor hidden-xs" href="#AC_002d3-Metadata" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-AC_002d3-Metadata" aria-hidden="true">TOC</a></span></h4>
  1999. <p>The AC-3 metadata options are used to set parameters that describe the audio,
  2000. but in most cases do not affect the audio encoding itself. Some of the options
  2001. do directly affect or influence the decoding and playback of the resulting
  2002. bitstream, while others are just for informational purposes. A few of the
  2003. options will add bits to the output stream that could otherwise be used for
  2004. audio data, and will thus affect the quality of the output. Those will be
  2005. indicated accordingly with a note in the option list below.
  2006. </p>
  2007. <p>These parameters are described in detail in several publicly-available
  2008. documents.
  2009. </p><ul>
  2010. <li> <a href="http://www.atsc.org/cms/standards/a_52-2010.pdf">A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard</a>
  2011. </li><li> <a href="http://www.atsc.org/cms/standards/a_54a_with_corr_1.pdf">A/54 - Guide to the Use of the ATSC Digital Television Standard</a>
  2012. </li><li> <a href="http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf">Dolby Metadata Guide</a>
  2013. </li><li> <a href="http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf">Dolby Digital Professional Encoding Guidelines</a>
  2014. </li></ul>
  2015. <a name="Metadata-Control-Options"></a>
  2016. <h4 class="subsubsection">8.2.1.1 Metadata Control Options<span class="pull-right"><a class="anchor hidden-xs" href="#Metadata-Control-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Metadata-Control-Options" aria-hidden="true">TOC</a></span></h4>
  2017. <dl compact="compact">
  2018. <dt><span><samp>-per_frame_metadata <var>boolean</var></samp></span></dt>
  2019. <dd><p>Allow Per-Frame Metadata. Specifies if the encoder should check for changing
  2020. metadata for each frame.
  2021. </p><dl compact="compact">
  2022. <dt><span><samp>0</samp></span></dt>
  2023. <dd><p>The metadata values set at initialization will be used for every frame in the
  2024. stream. (default)
  2025. </p></dd>
  2026. <dt><span><samp>1</samp></span></dt>
  2027. <dd><p>Metadata values can be changed before encoding each frame.
  2028. </p></dd>
  2029. </dl>
  2030. </dd>
  2031. </dl>
  2032. <a name="Downmix-Levels"></a>
  2033. <h4 class="subsubsection">8.2.1.2 Downmix Levels<span class="pull-right"><a class="anchor hidden-xs" href="#Downmix-Levels" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Downmix-Levels" aria-hidden="true">TOC</a></span></h4>
  2034. <dl compact="compact">
  2035. <dt><span><samp>-center_mixlev <var>level</var></samp></span></dt>
  2036. <dd><p>Center Mix Level. The amount of gain the decoder should apply to the center
  2037. channel when downmixing to stereo. This field will only be written to the
  2038. bitstream if a center channel is present. The value is specified as a scale
  2039. factor. There are 3 valid values:
  2040. </p><dl compact="compact">
  2041. <dt><span><samp>0.707</samp></span></dt>
  2042. <dd><p>Apply -3dB gain
  2043. </p></dd>
  2044. <dt><span><samp>0.595</samp></span></dt>
  2045. <dd><p>Apply -4.5dB gain (default)
  2046. </p></dd>
  2047. <dt><span><samp>0.500</samp></span></dt>
  2048. <dd><p>Apply -6dB gain
  2049. </p></dd>
  2050. </dl>
  2051. </dd>
  2052. <dt><span><samp>-surround_mixlev <var>level</var></samp></span></dt>
  2053. <dd><p>Surround Mix Level. The amount of gain the decoder should apply to the surround
  2054. channel(s) when downmixing to stereo. This field will only be written to the
  2055. bitstream if one or more surround channels are present. The value is specified
  2056. as a scale factor. There are 3 valid values:
  2057. </p><dl compact="compact">
  2058. <dt><span><samp>0.707</samp></span></dt>
  2059. <dd><p>Apply -3dB gain
  2060. </p></dd>
  2061. <dt><span><samp>0.500</samp></span></dt>
  2062. <dd><p>Apply -6dB gain (default)
  2063. </p></dd>
  2064. <dt><span><samp>0.000</samp></span></dt>
  2065. <dd><p>Silence Surround Channel(s)
  2066. </p></dd>
  2067. </dl>
  2068. </dd>
  2069. </dl>
  2070. <a name="Audio-Production-Information"></a>
  2071. <h4 class="subsubsection">8.2.1.3 Audio Production Information<span class="pull-right"><a class="anchor hidden-xs" href="#Audio-Production-Information" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Audio-Production-Information" aria-hidden="true">TOC</a></span></h4>
  2072. <p>Audio Production Information is optional information describing the mixing
  2073. environment. Either none or both of the fields are written to the bitstream.
  2074. </p>
  2075. <dl compact="compact">
  2076. <dt><span><samp>-mixing_level <var>number</var></samp></span></dt>
  2077. <dd><p>Mixing Level. Specifies peak sound pressure level (SPL) in the production
  2078. environment when the mix was mastered. Valid values are 80 to 111, or -1 for
  2079. unknown or not indicated. The default value is -1, but that value cannot be
  2080. used if the Audio Production Information is written to the bitstream. Therefore,
  2081. if the <code>room_type</code> option is not the default value, the <code>mixing_level</code>
  2082. option must not be -1.
  2083. </p>
  2084. </dd>
  2085. <dt><span><samp>-room_type <var>type</var></samp></span></dt>
  2086. <dd><p>Room Type. Describes the equalization used during the final mixing session at
  2087. the studio or on the dubbing stage. A large room is a dubbing stage with the
  2088. industry standard X-curve equalization; a small room has flat equalization.
  2089. This field will not be written to the bitstream if both the <code>mixing_level</code>
  2090. option and the <code>room_type</code> option have the default values.
  2091. </p><dl compact="compact">
  2092. <dt><span><samp>0</samp></span></dt>
  2093. <dt><span><samp>notindicated</samp></span></dt>
  2094. <dd><p>Not Indicated (default)
  2095. </p></dd>
  2096. <dt><span><samp>1</samp></span></dt>
  2097. <dt><span><samp>large</samp></span></dt>
  2098. <dd><p>Large Room
  2099. </p></dd>
  2100. <dt><span><samp>2</samp></span></dt>
  2101. <dt><span><samp>small</samp></span></dt>
  2102. <dd><p>Small Room
  2103. </p></dd>
  2104. </dl>
  2105. </dd>
  2106. </dl>
  2107. <a name="Other-Metadata-Options"></a>
  2108. <h4 class="subsubsection">8.2.1.4 Other Metadata Options<span class="pull-right"><a class="anchor hidden-xs" href="#Other-Metadata-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Other-Metadata-Options" aria-hidden="true">TOC</a></span></h4>
  2109. <dl compact="compact">
  2110. <dt><span><samp>-copyright <var>boolean</var></samp></span></dt>
  2111. <dd><p>Copyright Indicator. Specifies whether a copyright exists for this audio.
  2112. </p><dl compact="compact">
  2113. <dt><span><samp>0</samp></span></dt>
  2114. <dt><span><samp>off</samp></span></dt>
  2115. <dd><p>No Copyright Exists (default)
  2116. </p></dd>
  2117. <dt><span><samp>1</samp></span></dt>
  2118. <dt><span><samp>on</samp></span></dt>
  2119. <dd><p>Copyright Exists
  2120. </p></dd>
  2121. </dl>
  2122. </dd>
  2123. <dt><span><samp>-dialnorm <var>value</var></samp></span></dt>
  2124. <dd><p>Dialogue Normalization. Indicates how far the average dialogue level of the
  2125. program is below digital 100% full scale (0 dBFS). This parameter determines a
  2126. level shift during audio reproduction that sets the average volume of the
  2127. dialogue to a preset level. The goal is to match volume level between program
  2128. sources. A value of -31dB will result in no volume level change, relative to
  2129. the source volume, during audio reproduction. Valid values are whole numbers in
  2130. the range -31 to -1, with -31 being the default.
  2131. </p>
  2132. </dd>
  2133. <dt><span><samp>-dsur_mode <var>mode</var></samp></span></dt>
  2134. <dd><p>Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
  2135. (Pro Logic). This field will only be written to the bitstream if the audio
  2136. stream is stereo. Using this option does <b>NOT</b> mean the encoder will actually
  2137. apply Dolby Surround processing.
  2138. </p><dl compact="compact">
  2139. <dt><span><samp>0</samp></span></dt>
  2140. <dt><span><samp>notindicated</samp></span></dt>
  2141. <dd><p>Not Indicated (default)
  2142. </p></dd>
  2143. <dt><span><samp>1</samp></span></dt>
  2144. <dt><span><samp>off</samp></span></dt>
  2145. <dd><p>Not Dolby Surround Encoded
  2146. </p></dd>
  2147. <dt><span><samp>2</samp></span></dt>
  2148. <dt><span><samp>on</samp></span></dt>
  2149. <dd><p>Dolby Surround Encoded
  2150. </p></dd>
  2151. </dl>
  2152. </dd>
  2153. <dt><span><samp>-original <var>boolean</var></samp></span></dt>
  2154. <dd><p>Original Bit Stream Indicator. Specifies whether this audio is from the
  2155. original source and not a copy.
  2156. </p><dl compact="compact">
  2157. <dt><span><samp>0</samp></span></dt>
  2158. <dt><span><samp>off</samp></span></dt>
  2159. <dd><p>Not Original Source
  2160. </p></dd>
  2161. <dt><span><samp>1</samp></span></dt>
  2162. <dt><span><samp>on</samp></span></dt>
  2163. <dd><p>Original Source (default)
  2164. </p></dd>
  2165. </dl>
  2166. </dd>
  2167. </dl>
  2168. <a name="Extended-Bitstream-Information"></a>
  2169. <h4 class="subsection">8.2.2 Extended Bitstream Information<span class="pull-right"><a class="anchor hidden-xs" href="#Extended-Bitstream-Information" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Extended-Bitstream-Information" aria-hidden="true">TOC</a></span></h4>
  2170. <p>The extended bitstream options are part of the Alternate Bit Stream Syntax as
  2171. specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
  2172. If any one parameter in a group is specified, all values in that group will be
  2173. written to the bitstream. Default values are used for those that are written
  2174. but have not been specified. If the mixing levels are written, the decoder
  2175. will use these values instead of the ones specified in the <code>center_mixlev</code>
  2176. and <code>surround_mixlev</code> options if it supports the Alternate Bit Stream
  2177. Syntax.
  2178. </p>
  2179. <a name="Extended-Bitstream-Information-_002d-Part-1"></a>
  2180. <h4 class="subsubsection">8.2.2.1 Extended Bitstream Information - Part 1<span class="pull-right"><a class="anchor hidden-xs" href="#Extended-Bitstream-Information-_002d-Part-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Extended-Bitstream-Information-_002d-Part-1" aria-hidden="true">TOC</a></span></h4>
  2181. <dl compact="compact">
  2182. <dt><span><samp>-dmix_mode <var>mode</var></samp></span></dt>
  2183. <dd><p>Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
  2184. (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
  2185. </p><dl compact="compact">
  2186. <dt><span><samp>0</samp></span></dt>
  2187. <dt><span><samp>notindicated</samp></span></dt>
  2188. <dd><p>Not Indicated (default)
  2189. </p></dd>
  2190. <dt><span><samp>1</samp></span></dt>
  2191. <dt><span><samp>ltrt</samp></span></dt>
  2192. <dd><p>Lt/Rt Downmix Preferred
  2193. </p></dd>
  2194. <dt><span><samp>2</samp></span></dt>
  2195. <dt><span><samp>loro</samp></span></dt>
  2196. <dd><p>Lo/Ro Downmix Preferred
  2197. </p></dd>
  2198. </dl>
  2199. </dd>
  2200. <dt><span><samp>-ltrt_cmixlev <var>level</var></samp></span></dt>
  2201. <dd><p>Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
  2202. center channel when downmixing to stereo in Lt/Rt mode.
  2203. </p><dl compact="compact">
  2204. <dt><span><samp>1.414</samp></span></dt>
  2205. <dd><p>Apply +3dB gain
  2206. </p></dd>
  2207. <dt><span><samp>1.189</samp></span></dt>
  2208. <dd><p>Apply +1.5dB gain
  2209. </p></dd>
  2210. <dt><span><samp>1.000</samp></span></dt>
  2211. <dd><p>Apply 0dB gain
  2212. </p></dd>
  2213. <dt><span><samp>0.841</samp></span></dt>
  2214. <dd><p>Apply -1.5dB gain
  2215. </p></dd>
  2216. <dt><span><samp>0.707</samp></span></dt>
  2217. <dd><p>Apply -3.0dB gain
  2218. </p></dd>
  2219. <dt><span><samp>0.595</samp></span></dt>
  2220. <dd><p>Apply -4.5dB gain (default)
  2221. </p></dd>
  2222. <dt><span><samp>0.500</samp></span></dt>
  2223. <dd><p>Apply -6.0dB gain
  2224. </p></dd>
  2225. <dt><span><samp>0.000</samp></span></dt>
  2226. <dd><p>Silence Center Channel
  2227. </p></dd>
  2228. </dl>
  2229. </dd>
  2230. <dt><span><samp>-ltrt_surmixlev <var>level</var></samp></span></dt>
  2231. <dd><p>Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
  2232. surround channel(s) when downmixing to stereo in Lt/Rt mode.
  2233. </p><dl compact="compact">
  2234. <dt><span><samp>0.841</samp></span></dt>
  2235. <dd><p>Apply -1.5dB gain
  2236. </p></dd>
  2237. <dt><span><samp>0.707</samp></span></dt>
  2238. <dd><p>Apply -3.0dB gain
  2239. </p></dd>
  2240. <dt><span><samp>0.595</samp></span></dt>
  2241. <dd><p>Apply -4.5dB gain
  2242. </p></dd>
  2243. <dt><span><samp>0.500</samp></span></dt>
  2244. <dd><p>Apply -6.0dB gain (default)
  2245. </p></dd>
  2246. <dt><span><samp>0.000</samp></span></dt>
  2247. <dd><p>Silence Surround Channel(s)
  2248. </p></dd>
  2249. </dl>
  2250. </dd>
  2251. <dt><span><samp>-loro_cmixlev <var>level</var></samp></span></dt>
  2252. <dd><p>Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
  2253. center channel when downmixing to stereo in Lo/Ro mode.
  2254. </p><dl compact="compact">
  2255. <dt><span><samp>1.414</samp></span></dt>
  2256. <dd><p>Apply +3dB gain
  2257. </p></dd>
  2258. <dt><span><samp>1.189</samp></span></dt>
  2259. <dd><p>Apply +1.5dB gain
  2260. </p></dd>
  2261. <dt><span><samp>1.000</samp></span></dt>
  2262. <dd><p>Apply 0dB gain
  2263. </p></dd>
  2264. <dt><span><samp>0.841</samp></span></dt>
  2265. <dd><p>Apply -1.5dB gain
  2266. </p></dd>
  2267. <dt><span><samp>0.707</samp></span></dt>
  2268. <dd><p>Apply -3.0dB gain
  2269. </p></dd>
  2270. <dt><span><samp>0.595</samp></span></dt>
  2271. <dd><p>Apply -4.5dB gain (default)
  2272. </p></dd>
  2273. <dt><span><samp>0.500</samp></span></dt>
  2274. <dd><p>Apply -6.0dB gain
  2275. </p></dd>
  2276. <dt><span><samp>0.000</samp></span></dt>
  2277. <dd><p>Silence Center Channel
  2278. </p></dd>
  2279. </dl>
  2280. </dd>
  2281. <dt><span><samp>-loro_surmixlev <var>level</var></samp></span></dt>
  2282. <dd><p>Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
  2283. surround channel(s) when downmixing to stereo in Lo/Ro mode.
  2284. </p><dl compact="compact">
  2285. <dt><span><samp>0.841</samp></span></dt>
  2286. <dd><p>Apply -1.5dB gain
  2287. </p></dd>
  2288. <dt><span><samp>0.707</samp></span></dt>
  2289. <dd><p>Apply -3.0dB gain
  2290. </p></dd>
  2291. <dt><span><samp>0.595</samp></span></dt>
  2292. <dd><p>Apply -4.5dB gain
  2293. </p></dd>
  2294. <dt><span><samp>0.500</samp></span></dt>
  2295. <dd><p>Apply -6.0dB gain (default)
  2296. </p></dd>
  2297. <dt><span><samp>0.000</samp></span></dt>
  2298. <dd><p>Silence Surround Channel(s)
  2299. </p></dd>
  2300. </dl>
  2301. </dd>
  2302. </dl>
  2303. <a name="Extended-Bitstream-Information-_002d-Part-2"></a>
  2304. <h4 class="subsubsection">8.2.2.2 Extended Bitstream Information - Part 2<span class="pull-right"><a class="anchor hidden-xs" href="#Extended-Bitstream-Information-_002d-Part-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Extended-Bitstream-Information-_002d-Part-2" aria-hidden="true">TOC</a></span></h4>
  2305. <dl compact="compact">
  2306. <dt><span><samp>-dsurex_mode <var>mode</var></samp></span></dt>
  2307. <dd><p>Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
  2308. (7.1 matrixed to 5.1). Using this option does <b>NOT</b> mean the encoder will actually
  2309. apply Dolby Surround EX processing.
  2310. </p><dl compact="compact">
  2311. <dt><span><samp>0</samp></span></dt>
  2312. <dt><span><samp>notindicated</samp></span></dt>
  2313. <dd><p>Not Indicated (default)
  2314. </p></dd>
  2315. <dt><span><samp>1</samp></span></dt>
  2316. <dt><span><samp>on</samp></span></dt>
  2317. <dd><p>Dolby Surround EX Off
  2318. </p></dd>
  2319. <dt><span><samp>2</samp></span></dt>
  2320. <dt><span><samp>off</samp></span></dt>
  2321. <dd><p>Dolby Surround EX On
  2322. </p></dd>
  2323. </dl>
  2324. </dd>
  2325. <dt><span><samp>-dheadphone_mode <var>mode</var></samp></span></dt>
  2326. <dd><p>Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
  2327. encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
  2328. option does <b>NOT</b> mean the encoder will actually apply Dolby Headphone
  2329. processing.
  2330. </p><dl compact="compact">
  2331. <dt><span><samp>0</samp></span></dt>
  2332. <dt><span><samp>notindicated</samp></span></dt>
  2333. <dd><p>Not Indicated (default)
  2334. </p></dd>
  2335. <dt><span><samp>1</samp></span></dt>
  2336. <dt><span><samp>on</samp></span></dt>
  2337. <dd><p>Dolby Headphone Off
  2338. </p></dd>
  2339. <dt><span><samp>2</samp></span></dt>
  2340. <dt><span><samp>off</samp></span></dt>
  2341. <dd><p>Dolby Headphone On
  2342. </p></dd>
  2343. </dl>
  2344. </dd>
  2345. <dt><span><samp>-ad_conv_type <var>type</var></samp></span></dt>
  2346. <dd><p>A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
  2347. conversion.
  2348. </p><dl compact="compact">
  2349. <dt><span><samp>0</samp></span></dt>
  2350. <dt><span><samp>standard</samp></span></dt>
  2351. <dd><p>Standard A/D Converter (default)
  2352. </p></dd>
  2353. <dt><span><samp>1</samp></span></dt>
  2354. <dt><span><samp>hdcd</samp></span></dt>
  2355. <dd><p>HDCD A/D Converter
  2356. </p></dd>
  2357. </dl>
  2358. </dd>
  2359. </dl>
  2360. <a name="Other-AC_002d3-Encoding-Options"></a>
  2361. <h4 class="subsection">8.2.3 Other AC-3 Encoding Options<span class="pull-right"><a class="anchor hidden-xs" href="#Other-AC_002d3-Encoding-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Other-AC_002d3-Encoding-Options" aria-hidden="true">TOC</a></span></h4>
  2362. <dl compact="compact">
  2363. <dt><span><samp>-stereo_rematrixing <var>boolean</var></samp></span></dt>
  2364. <dd><p>Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
  2365. is an optional AC-3 feature that increases quality by selectively encoding
  2366. the left/right channels as mid/side. This option is enabled by default, and it
  2367. is highly recommended that it be left as enabled except for testing purposes.
  2368. </p>
  2369. </dd>
  2370. <dt><span><samp>cutoff <var>frequency</var></samp></span></dt>
  2371. <dd><p>Set lowpass cutoff frequency. If unspecified, the encoder selects a default
  2372. determined by various other encoding parameters.
  2373. </p>
  2374. </dd>
  2375. </dl>
  2376. <a name="Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options"></a>
  2377. <h4 class="subsection">8.2.4 Floating-Point-Only AC-3 Encoding Options<span class="pull-right"><a class="anchor hidden-xs" href="#Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options" aria-hidden="true">TOC</a></span></h4>
  2378. <p>These options are only valid for the floating-point encoder and do not exist
  2379. for the fixed-point encoder due to the corresponding features not being
  2380. implemented in fixed-point.
  2381. </p>
  2382. <dl compact="compact">
  2383. <dt><span><samp>-channel_coupling <var>boolean</var></samp></span></dt>
  2384. <dd><p>Enables/Disables use of channel coupling, which is an optional AC-3 feature
  2385. that increases quality by combining high frequency information from multiple
  2386. channels into a single channel. The per-channel high frequency information is
  2387. sent with less accuracy in both the frequency and time domains. This allows
  2388. more bits to be used for lower frequencies while preserving enough information
  2389. to reconstruct the high frequencies. This option is enabled by default for the
  2390. floating-point encoder and should generally be left as enabled except for
  2391. testing purposes or to increase encoding speed.
  2392. </p><dl compact="compact">
  2393. <dt><span><samp>-1</samp></span></dt>
  2394. <dt><span><samp>auto</samp></span></dt>
  2395. <dd><p>Selected by Encoder (default)
  2396. </p></dd>
  2397. <dt><span><samp>0</samp></span></dt>
  2398. <dt><span><samp>off</samp></span></dt>
  2399. <dd><p>Disable Channel Coupling
  2400. </p></dd>
  2401. <dt><span><samp>1</samp></span></dt>
  2402. <dt><span><samp>on</samp></span></dt>
  2403. <dd><p>Enable Channel Coupling
  2404. </p></dd>
  2405. </dl>
  2406. </dd>
  2407. <dt><span><samp>-cpl_start_band <var>number</var></samp></span></dt>
  2408. <dd><p>Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
  2409. value higher than the bandwidth is used, it will be reduced to 1 less than the
  2410. coupling end band. If <var>auto</var> is used, the start band will be determined by
  2411. the encoder based on the bit rate, sample rate, and channel layout. This option
  2412. has no effect if channel coupling is disabled.
  2413. </p><dl compact="compact">
  2414. <dt><span><samp>-1</samp></span></dt>
  2415. <dt><span><samp>auto</samp></span></dt>
  2416. <dd><p>Selected by Encoder (default)
  2417. </p></dd>
  2418. </dl>
  2419. </dd>
  2420. </dl>
  2421. <span id="flac"></span><a name="flac-2"></a>
  2422. <h3 class="section">8.3 flac<span class="pull-right"><a class="anchor hidden-xs" href="#flac-2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-flac-2" aria-hidden="true">TOC</a></span></h3>
  2423. <p>FLAC (Free Lossless Audio Codec) Encoder
  2424. </p>
  2425. <a name="Options-9"></a>
  2426. <h4 class="subsection">8.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-9" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-9" aria-hidden="true">TOC</a></span></h4>
  2427. <p>The following options are supported by FFmpeg&rsquo;s flac encoder.
  2428. </p>
  2429. <dl compact="compact">
  2430. <dt><span><samp>compression_level</samp></span></dt>
  2431. <dd><p>Sets the compression level, which chooses defaults for many other options
  2432. if they are not set explicitly. Valid values are from 0 to 12, 5 is the
  2433. default.
  2434. </p>
  2435. </dd>
  2436. <dt><span><samp>frame_size</samp></span></dt>
  2437. <dd><p>Sets the size of the frames in samples per channel.
  2438. </p>
  2439. </dd>
  2440. <dt><span><samp>lpc_coeff_precision</samp></span></dt>
  2441. <dd><p>Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the
  2442. default.
  2443. </p>
  2444. </dd>
  2445. <dt><span><samp>lpc_type</samp></span></dt>
  2446. <dd><p>Sets the first stage LPC algorithm
  2447. </p><dl compact="compact">
  2448. <dt><span>&lsquo;<samp>none</samp>&rsquo;</span></dt>
  2449. <dd><p>LPC is not used
  2450. </p>
  2451. </dd>
  2452. <dt><span>&lsquo;<samp>fixed</samp>&rsquo;</span></dt>
  2453. <dd><p>fixed LPC coefficients
  2454. </p>
  2455. </dd>
  2456. <dt><span>&lsquo;<samp>levinson</samp>&rsquo;</span></dt>
  2457. <dt><span>&lsquo;<samp>cholesky</samp>&rsquo;</span></dt>
  2458. </dl>
  2459. </dd>
  2460. <dt><span><samp>lpc_passes</samp></span></dt>
  2461. <dd><p>Number of passes to use for Cholesky factorization during LPC analysis
  2462. </p>
  2463. </dd>
  2464. <dt><span><samp>min_partition_order</samp></span></dt>
  2465. <dd><p>The minimum partition order
  2466. </p>
  2467. </dd>
  2468. <dt><span><samp>max_partition_order</samp></span></dt>
  2469. <dd><p>The maximum partition order
  2470. </p>
  2471. </dd>
  2472. <dt><span><samp>prediction_order_method</samp></span></dt>
  2473. <dd><dl compact="compact">
  2474. <dt><span>&lsquo;<samp>estimation</samp>&rsquo;</span></dt>
  2475. <dt><span>&lsquo;<samp>2level</samp>&rsquo;</span></dt>
  2476. <dt><span>&lsquo;<samp>4level</samp>&rsquo;</span></dt>
  2477. <dt><span>&lsquo;<samp>8level</samp>&rsquo;</span></dt>
  2478. <dt><span>&lsquo;<samp>search</samp>&rsquo;</span></dt>
  2479. <dd><p>Bruteforce search
  2480. </p></dd>
  2481. <dt><span>&lsquo;<samp>log</samp>&rsquo;</span></dt>
  2482. </dl>
  2483. </dd>
  2484. <dt><span><samp>ch_mode</samp></span></dt>
  2485. <dd><p>Channel mode
  2486. </p><dl compact="compact">
  2487. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  2488. <dd><p>The mode is chosen automatically for each frame
  2489. </p></dd>
  2490. <dt><span>&lsquo;<samp>indep</samp>&rsquo;</span></dt>
  2491. <dd><p>Channels are independently coded
  2492. </p></dd>
  2493. <dt><span>&lsquo;<samp>left_side</samp>&rsquo;</span></dt>
  2494. <dt><span>&lsquo;<samp>right_side</samp>&rsquo;</span></dt>
  2495. <dt><span>&lsquo;<samp>mid_side</samp>&rsquo;</span></dt>
  2496. </dl>
  2497. </dd>
  2498. <dt><span><samp>exact_rice_parameters</samp></span></dt>
  2499. <dd><p>Chooses if rice parameters are calculated exactly or approximately.
  2500. if set to 1 then they are chosen exactly, which slows the code down slightly and
  2501. improves compression slightly.
  2502. </p>
  2503. </dd>
  2504. <dt><span><samp>multi_dim_quant</samp></span></dt>
  2505. <dd><p>Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is
  2506. applied after the first stage to finetune the coefficients. This is quite slow
  2507. and slightly improves compression.
  2508. </p>
  2509. </dd>
  2510. </dl>
  2511. <span id="opusenc"></span><a name="opus"></a>
  2512. <h3 class="section">8.4 opus<span class="pull-right"><a class="anchor hidden-xs" href="#opus" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-opus" aria-hidden="true">TOC</a></span></h3>
  2513. <p>Opus encoder.
  2514. </p>
  2515. <p>This is a native FFmpeg encoder for the Opus format. Currently its in development and
  2516. only implements the CELT part of the codec. Its quality is usually worse and at best
  2517. is equal to the libopus encoder.
  2518. </p>
  2519. <a name="Options-10"></a>
  2520. <h4 class="subsection">8.4.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-10" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-10" aria-hidden="true">TOC</a></span></h4>
  2521. <dl compact="compact">
  2522. <dt><span><samp>b</samp></span></dt>
  2523. <dd><p>Set bit rate in bits/s. If unspecified it uses the number of channels and the layout
  2524. to make a good guess.
  2525. </p>
  2526. </dd>
  2527. <dt><span><samp>opus_delay</samp></span></dt>
  2528. <dd><p>Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly
  2529. decrease quality.
  2530. </p></dd>
  2531. </dl>
  2532. <span id="libfdk_002daac_002denc"></span><a name="libfdk_005faac"></a>
  2533. <h3 class="section">8.5 libfdk_aac<span class="pull-right"><a class="anchor hidden-xs" href="#libfdk_005faac" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libfdk_005faac" aria-hidden="true">TOC</a></span></h3>
  2534. <p>libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
  2535. </p>
  2536. <p>The libfdk-aac library is based on the Fraunhofer FDK AAC code from
  2537. the Android project.
  2538. </p>
  2539. <p>Requires the presence of the libfdk-aac headers and library during
  2540. configuration. You need to explicitly configure the build with
  2541. <code>--enable-libfdk-aac</code>. The library is also incompatible with GPL,
  2542. so if you allow the use of GPL, you should configure with
  2543. <code>--enable-gpl --enable-nonfree --enable-libfdk-aac</code>.
  2544. </p>
  2545. <p>This encoder has support for the AAC-HE profiles.
  2546. </p>
  2547. <p>VBR encoding, enabled through the <samp>vbr</samp> or <samp>flags
  2548. +qscale</samp> options, is experimental and only works with some
  2549. combinations of parameters.
  2550. </p>
  2551. <p>Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or
  2552. higher.
  2553. </p>
  2554. <p>For more information see the fdk-aac project at
  2555. <a href="http://sourceforge.net/p/opencore-amr/fdk-aac/">http://sourceforge.net/p/opencore-amr/fdk-aac/</a>.
  2556. </p>
  2557. <a name="Options-11"></a>
  2558. <h4 class="subsection">8.5.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-11" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-11" aria-hidden="true">TOC</a></span></h4>
  2559. <p>The following options are mapped on the shared FFmpeg codec options.
  2560. </p>
  2561. <dl compact="compact">
  2562. <dt><span><samp>b</samp></span></dt>
  2563. <dd><p>Set bit rate in bits/s. If the bitrate is not explicitly specified, it
  2564. is automatically set to a suitable value depending on the selected
  2565. profile.
  2566. </p>
  2567. <p>In case VBR mode is enabled the option is ignored.
  2568. </p>
  2569. </dd>
  2570. <dt><span><samp>ar</samp></span></dt>
  2571. <dd><p>Set audio sampling rate (in Hz).
  2572. </p>
  2573. </dd>
  2574. <dt><span><samp>channels</samp></span></dt>
  2575. <dd><p>Set the number of audio channels.
  2576. </p>
  2577. </dd>
  2578. <dt><span><samp>flags +qscale</samp></span></dt>
  2579. <dd><p>Enable fixed quality, VBR (Variable Bit Rate) mode.
  2580. Note that VBR is implicitly enabled when the <samp>vbr</samp> value is
  2581. positive.
  2582. </p>
  2583. </dd>
  2584. <dt><span><samp>cutoff</samp></span></dt>
  2585. <dd><p>Set cutoff frequency. If not specified (or explicitly set to 0) it
  2586. will use a value automatically computed by the library. Default value
  2587. is 0.
  2588. </p>
  2589. </dd>
  2590. <dt><span><samp>profile</samp></span></dt>
  2591. <dd><p>Set audio profile.
  2592. </p>
  2593. <p>The following profiles are recognized:
  2594. </p><dl compact="compact">
  2595. <dt><span>&lsquo;<samp>aac_low</samp>&rsquo;</span></dt>
  2596. <dd><p>Low Complexity AAC (LC)
  2597. </p>
  2598. </dd>
  2599. <dt><span>&lsquo;<samp>aac_he</samp>&rsquo;</span></dt>
  2600. <dd><p>High Efficiency AAC (HE-AAC)
  2601. </p>
  2602. </dd>
  2603. <dt><span>&lsquo;<samp>aac_he_v2</samp>&rsquo;</span></dt>
  2604. <dd><p>High Efficiency AAC version 2 (HE-AACv2)
  2605. </p>
  2606. </dd>
  2607. <dt><span>&lsquo;<samp>aac_ld</samp>&rsquo;</span></dt>
  2608. <dd><p>Low Delay AAC (LD)
  2609. </p>
  2610. </dd>
  2611. <dt><span>&lsquo;<samp>aac_eld</samp>&rsquo;</span></dt>
  2612. <dd><p>Enhanced Low Delay AAC (ELD)
  2613. </p></dd>
  2614. </dl>
  2615. <p>If not specified it is set to &lsquo;<samp>aac_low</samp>&rsquo;.
  2616. </p></dd>
  2617. </dl>
  2618. <p>The following are private options of the libfdk_aac encoder.
  2619. </p>
  2620. <dl compact="compact">
  2621. <dt><span><samp>afterburner</samp></span></dt>
  2622. <dd><p>Enable afterburner feature if set to 1, disabled if set to 0. This
  2623. improves the quality but also the required processing power.
  2624. </p>
  2625. <p>Default value is 1.
  2626. </p>
  2627. </dd>
  2628. <dt><span><samp>eld_sbr</samp></span></dt>
  2629. <dd><p>Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
  2630. if set to 0.
  2631. </p>
  2632. <p>Default value is 0.
  2633. </p>
  2634. </dd>
  2635. <dt><span><samp>eld_v2</samp></span></dt>
  2636. <dd><p>Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1,
  2637. disabled if set to 0.
  2638. </p>
  2639. <p>Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) &gt; (4.0.0).
  2640. </p>
  2641. <p>Default value is 0.
  2642. </p>
  2643. </dd>
  2644. <dt><span><samp>signaling</samp></span></dt>
  2645. <dd><p>Set SBR/PS signaling style.
  2646. </p>
  2647. <p>It can assume one of the following values:
  2648. </p><dl compact="compact">
  2649. <dt><span>&lsquo;<samp>default</samp>&rsquo;</span></dt>
  2650. <dd><p>choose signaling implicitly (explicit hierarchical by default,
  2651. implicit if global header is disabled)
  2652. </p>
  2653. </dd>
  2654. <dt><span>&lsquo;<samp>implicit</samp>&rsquo;</span></dt>
  2655. <dd><p>implicit backwards compatible signaling
  2656. </p>
  2657. </dd>
  2658. <dt><span>&lsquo;<samp>explicit_sbr</samp>&rsquo;</span></dt>
  2659. <dd><p>explicit SBR, implicit PS signaling
  2660. </p>
  2661. </dd>
  2662. <dt><span>&lsquo;<samp>explicit_hierarchical</samp>&rsquo;</span></dt>
  2663. <dd><p>explicit hierarchical signaling
  2664. </p></dd>
  2665. </dl>
  2666. <p>Default value is &lsquo;<samp>default</samp>&rsquo;.
  2667. </p>
  2668. </dd>
  2669. <dt><span><samp>latm</samp></span></dt>
  2670. <dd><p>Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
  2671. </p>
  2672. <p>Default value is 0.
  2673. </p>
  2674. </dd>
  2675. <dt><span><samp>header_period</samp></span></dt>
  2676. <dd><p>Set StreamMuxConfig and PCE repetition period (in frames) for sending
  2677. in-band configuration buffers within LATM/LOAS transport layer.
  2678. </p>
  2679. <p>Must be a 16-bits non-negative integer.
  2680. </p>
  2681. <p>Default value is 0.
  2682. </p>
  2683. </dd>
  2684. <dt><span><samp>vbr</samp></span></dt>
  2685. <dd><p>Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
  2686. good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
  2687. (Constant Bit Rate) is enabled.
  2688. </p>
  2689. <p>Currently only the &lsquo;<samp>aac_low</samp>&rsquo; profile supports VBR encoding.
  2690. </p>
  2691. <p>VBR modes 1-5 correspond to roughly the following average bit rates:
  2692. </p>
  2693. <dl compact="compact">
  2694. <dt><span>&lsquo;<samp>1</samp>&rsquo;</span></dt>
  2695. <dd><p>32 kbps/channel
  2696. </p></dd>
  2697. <dt><span>&lsquo;<samp>2</samp>&rsquo;</span></dt>
  2698. <dd><p>40 kbps/channel
  2699. </p></dd>
  2700. <dt><span>&lsquo;<samp>3</samp>&rsquo;</span></dt>
  2701. <dd><p>48-56 kbps/channel
  2702. </p></dd>
  2703. <dt><span>&lsquo;<samp>4</samp>&rsquo;</span></dt>
  2704. <dd><p>64 kbps/channel
  2705. </p></dd>
  2706. <dt><span>&lsquo;<samp>5</samp>&rsquo;</span></dt>
  2707. <dd><p>about 80-96 kbps/channel
  2708. </p></dd>
  2709. </dl>
  2710. <p>Default value is 0.
  2711. </p></dd>
  2712. </dl>
  2713. <a name="Examples"></a>
  2714. <h4 class="subsection">8.5.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples" aria-hidden="true">TOC</a></span></h4>
  2715. <ul>
  2716. <li> Use <code>ffmpeg</code> to convert an audio file to VBR AAC in an M4A (MP4)
  2717. container:
  2718. <div class="example">
  2719. <pre class="example">ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
  2720. </pre></div>
  2721. </li><li> Use <code>ffmpeg</code> to convert an audio file to CBR 64k kbps AAC, using the
  2722. High-Efficiency AAC profile:
  2723. <div class="example">
  2724. <pre class="example">ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
  2725. </pre></div>
  2726. </li></ul>
  2727. <span id="libmp3lame"></span><a name="libmp3lame-1"></a>
  2728. <h3 class="section">8.6 libmp3lame<span class="pull-right"><a class="anchor hidden-xs" href="#libmp3lame-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libmp3lame-1" aria-hidden="true">TOC</a></span></h3>
  2729. <p>LAME (Lame Ain&rsquo;t an MP3 Encoder) MP3 encoder wrapper.
  2730. </p>
  2731. <p>Requires the presence of the libmp3lame headers and library during
  2732. configuration. You need to explicitly configure the build with
  2733. <code>--enable-libmp3lame</code>.
  2734. </p>
  2735. <p>See <a href="#libshine">libshine</a> for a fixed-point MP3 encoder, although with a
  2736. lower quality.
  2737. </p>
  2738. <a name="Options-12"></a>
  2739. <h4 class="subsection">8.6.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-12" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-12" aria-hidden="true">TOC</a></span></h4>
  2740. <p>The following options are supported by the libmp3lame wrapper. The
  2741. <code>lame</code>-equivalent of the options are listed in parentheses.
  2742. </p>
  2743. <dl compact="compact">
  2744. <dt><span><samp>b (<em>-b</em>)</samp></span></dt>
  2745. <dd><p>Set bitrate expressed in bits/s for CBR or ABR. LAME <code>bitrate</code> is
  2746. expressed in kilobits/s.
  2747. </p>
  2748. </dd>
  2749. <dt><span><samp>q (<em>-V</em>)</samp></span></dt>
  2750. <dd><p>Set constant quality setting for VBR. This option is valid only
  2751. using the <code>ffmpeg</code> command-line tool. For library interface
  2752. users, use <samp>global_quality</samp>.
  2753. </p>
  2754. </dd>
  2755. <dt><span><samp>compression_level (<em>-q</em>)</samp></span></dt>
  2756. <dd><p>Set algorithm quality. Valid arguments are integers in the 0-9 range,
  2757. with 0 meaning highest quality but slowest, and 9 meaning fastest
  2758. while producing the worst quality.
  2759. </p>
  2760. </dd>
  2761. <dt><span><samp>cutoff (<em>--lowpass</em>)</samp></span></dt>
  2762. <dd><p>Set lowpass cutoff frequency. If unspecified, the encoder dynamically
  2763. adjusts the cutoff.
  2764. </p>
  2765. </dd>
  2766. <dt><span><samp>reservoir</samp></span></dt>
  2767. <dd><p>Enable use of bit reservoir when set to 1. Default value is 1. LAME
  2768. has this enabled by default, but can be overridden by use
  2769. <samp>--nores</samp> option.
  2770. </p>
  2771. </dd>
  2772. <dt><span><samp>joint_stereo (<em>-m j</em>)</samp></span></dt>
  2773. <dd><p>Enable the encoder to use (on a frame by frame basis) either L/R
  2774. stereo or mid/side stereo. Default value is 1.
  2775. </p>
  2776. </dd>
  2777. <dt><span><samp>abr (<em>--abr</em>)</samp></span></dt>
  2778. <dd><p>Enable the encoder to use ABR when set to 1. The <code>lame</code>
  2779. <samp>--abr</samp> sets the target bitrate, while this options only
  2780. tells FFmpeg to use ABR still relies on <samp>b</samp> to set bitrate.
  2781. </p>
  2782. </dd>
  2783. </dl>
  2784. <a name="libopencore_002damrnb-1"></a>
  2785. <h3 class="section">8.7 libopencore-amrnb<span class="pull-right"><a class="anchor hidden-xs" href="#libopencore_002damrnb-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopencore_002damrnb-1" aria-hidden="true">TOC</a></span></h3>
  2786. <p>OpenCORE Adaptive Multi-Rate Narrowband encoder.
  2787. </p>
  2788. <p>Requires the presence of the libopencore-amrnb headers and library during
  2789. configuration. You need to explicitly configure the build with
  2790. <code>--enable-libopencore-amrnb --enable-version3</code>.
  2791. </p>
  2792. <p>This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
  2793. but you can override it by setting <samp>strict</samp> to &lsquo;<samp>unofficial</samp>&rsquo; or
  2794. lower.
  2795. </p>
  2796. <a name="Options-13"></a>
  2797. <h4 class="subsection">8.7.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-13" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-13" aria-hidden="true">TOC</a></span></h4>
  2798. <dl compact="compact">
  2799. <dt><span><samp>b</samp></span></dt>
  2800. <dd><p>Set bitrate in bits per second. Only the following bitrates are supported,
  2801. otherwise libavcodec will round to the nearest valid bitrate.
  2802. </p>
  2803. <dl compact="compact">
  2804. <dt><span><samp>4750</samp></span></dt>
  2805. <dt><span><samp>5150</samp></span></dt>
  2806. <dt><span><samp>5900</samp></span></dt>
  2807. <dt><span><samp>6700</samp></span></dt>
  2808. <dt><span><samp>7400</samp></span></dt>
  2809. <dt><span><samp>7950</samp></span></dt>
  2810. <dt><span><samp>10200</samp></span></dt>
  2811. <dt><span><samp>12200</samp></span></dt>
  2812. </dl>
  2813. </dd>
  2814. <dt><span><samp>dtx</samp></span></dt>
  2815. <dd><p>Allow discontinuous transmission (generate comfort noise) when set to 1. The
  2816. default value is 0 (disabled).
  2817. </p>
  2818. </dd>
  2819. </dl>
  2820. <a name="libopus-1"></a>
  2821. <h3 class="section">8.8 libopus<span class="pull-right"><a class="anchor hidden-xs" href="#libopus-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopus-1" aria-hidden="true">TOC</a></span></h3>
  2822. <p>libopus Opus Interactive Audio Codec encoder wrapper.
  2823. </p>
  2824. <p>Requires the presence of the libopus headers and library during
  2825. configuration. You need to explicitly configure the build with
  2826. <code>--enable-libopus</code>.
  2827. </p>
  2828. <a name="Option-Mapping"></a>
  2829. <h4 class="subsection">8.8.1 Option Mapping<span class="pull-right"><a class="anchor hidden-xs" href="#Option-Mapping" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Option-Mapping" aria-hidden="true">TOC</a></span></h4>
  2830. <p>Most libopus options are modelled after the <code>opusenc</code> utility from
  2831. opus-tools. The following is an option mapping chart describing options
  2832. supported by the libopus wrapper, and their <code>opusenc</code>-equivalent
  2833. in parentheses.
  2834. </p>
  2835. <dl compact="compact">
  2836. <dt><span><samp>b (<em>bitrate</em>)</samp></span></dt>
  2837. <dd><p>Set the bit rate in bits/s. FFmpeg&rsquo;s <samp>b</samp> option is
  2838. expressed in bits/s, while <code>opusenc</code>&rsquo;s <samp>bitrate</samp> in
  2839. kilobits/s.
  2840. </p>
  2841. </dd>
  2842. <dt><span><samp>vbr (<em>vbr</em>, <em>hard-cbr</em>, and <em>cvbr</em>)</samp></span></dt>
  2843. <dd><p>Set VBR mode. The FFmpeg <samp>vbr</samp> option has the following
  2844. valid arguments, with the <code>opusenc</code> equivalent options
  2845. in parentheses:
  2846. </p>
  2847. <dl compact="compact">
  2848. <dt><span>&lsquo;<samp>off (<em>hard-cbr</em>)</samp>&rsquo;</span></dt>
  2849. <dd><p>Use constant bit rate encoding.
  2850. </p>
  2851. </dd>
  2852. <dt><span>&lsquo;<samp>on (<em>vbr</em>)</samp>&rsquo;</span></dt>
  2853. <dd><p>Use variable bit rate encoding (the default).
  2854. </p>
  2855. </dd>
  2856. <dt><span>&lsquo;<samp>constrained (<em>cvbr</em>)</samp>&rsquo;</span></dt>
  2857. <dd><p>Use constrained variable bit rate encoding.
  2858. </p></dd>
  2859. </dl>
  2860. </dd>
  2861. <dt><span><samp>compression_level (<em>comp</em>)</samp></span></dt>
  2862. <dd><p>Set encoding algorithm complexity. Valid options are integers in
  2863. the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
  2864. gives the highest quality but slowest encoding. The default is 10.
  2865. </p>
  2866. </dd>
  2867. <dt><span><samp>frame_duration (<em>framesize</em>)</samp></span></dt>
  2868. <dd><p>Set maximum frame size, or duration of a frame in milliseconds. The
  2869. argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
  2870. frame sizes achieve lower latency but less quality at a given bitrate.
  2871. Sizes greater than 20ms are only interesting at fairly low bitrates.
  2872. The default is 20ms.
  2873. </p>
  2874. </dd>
  2875. <dt><span><samp>packet_loss (<em>expect-loss</em>)</samp></span></dt>
  2876. <dd><p>Set expected packet loss percentage. The default is 0.
  2877. </p>
  2878. </dd>
  2879. <dt><span><samp>fec (<em>n/a</em>)</samp></span></dt>
  2880. <dd><p>Enable inband forward error correction. <samp>packet_loss</samp> must be non-zero
  2881. to take advantage - frequency of FEC &rsquo;side-data&rsquo; is proportional to expected packet loss.
  2882. Default is disabled.
  2883. </p>
  2884. </dd>
  2885. <dt><span><samp>application (N.A.)</samp></span></dt>
  2886. <dd><p>Set intended application type. Valid options are listed below:
  2887. </p>
  2888. <dl compact="compact">
  2889. <dt><span>&lsquo;<samp>voip</samp>&rsquo;</span></dt>
  2890. <dd><p>Favor improved speech intelligibility.
  2891. </p></dd>
  2892. <dt><span>&lsquo;<samp>audio</samp>&rsquo;</span></dt>
  2893. <dd><p>Favor faithfulness to the input (the default).
  2894. </p></dd>
  2895. <dt><span>&lsquo;<samp>lowdelay</samp>&rsquo;</span></dt>
  2896. <dd><p>Restrict to only the lowest delay modes.
  2897. </p></dd>
  2898. </dl>
  2899. </dd>
  2900. <dt><span><samp>cutoff (N.A.)</samp></span></dt>
  2901. <dd><p>Set cutoff bandwidth in Hz. The argument must be exactly one of the
  2902. following: 4000, 6000, 8000, 12000, or 20000, corresponding to
  2903. narrowband, mediumband, wideband, super wideband, and fullband
  2904. respectively. The default is 0 (cutoff disabled).
  2905. </p>
  2906. </dd>
  2907. <dt><span><samp>mapping_family (<em>mapping_family</em>)</samp></span></dt>
  2908. <dd><p>Set channel mapping family to be used by the encoder. The default value of -1
  2909. uses mapping family 0 for mono and stereo inputs, and mapping family 1
  2910. otherwise. The default also disables the surround masking and LFE bandwidth
  2911. optimzations in libopus, and requires that the input contains 8 channels or
  2912. fewer.
  2913. </p>
  2914. <p>Other values include 0 for mono and stereo, 1 for surround sound with masking
  2915. and LFE bandwidth optimizations, and 255 for independent streams with an
  2916. unspecified channel layout.
  2917. </p>
  2918. </dd>
  2919. <dt><span><samp>apply_phase_inv (N.A.) (requires libopus &gt;= 1.2)</samp></span></dt>
  2920. <dd><p>If set to 0, disables the use of phase inversion for intensity stereo,
  2921. improving the quality of mono downmixes, but slightly reducing normal stereo
  2922. quality. The default is 1 (phase inversion enabled).
  2923. </p>
  2924. </dd>
  2925. </dl>
  2926. <span id="libshine"></span><a name="libshine-1"></a>
  2927. <h3 class="section">8.9 libshine<span class="pull-right"><a class="anchor hidden-xs" href="#libshine-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libshine-1" aria-hidden="true">TOC</a></span></h3>
  2928. <p>Shine Fixed-Point MP3 encoder wrapper.
  2929. </p>
  2930. <p>Shine is a fixed-point MP3 encoder. It has a far better performance on
  2931. platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
  2932. However, as it is more targeted on performance than quality, it is not on par
  2933. with LAME and other production-grade encoders quality-wise. Also, according to
  2934. the project&rsquo;s homepage, this encoder may not be free of bugs as the code was
  2935. written a long time ago and the project was dead for at least 5 years.
  2936. </p>
  2937. <p>This encoder only supports stereo and mono input. This is also CBR-only.
  2938. </p>
  2939. <p>The original project (last updated in early 2007) is at
  2940. <a href="http://sourceforge.net/projects/libshine-fxp/">http://sourceforge.net/projects/libshine-fxp/</a>. We only support the
  2941. updated fork by the Savonet/Liquidsoap project at <a href="https://github.com/savonet/shine">https://github.com/savonet/shine</a>.
  2942. </p>
  2943. <p>Requires the presence of the libshine headers and library during
  2944. configuration. You need to explicitly configure the build with
  2945. <code>--enable-libshine</code>.
  2946. </p>
  2947. <p>See also <a href="#libmp3lame">libmp3lame</a>.
  2948. </p>
  2949. <a name="Options-14"></a>
  2950. <h4 class="subsection">8.9.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-14" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-14" aria-hidden="true">TOC</a></span></h4>
  2951. <p>The following options are supported by the libshine wrapper. The
  2952. <code>shineenc</code>-equivalent of the options are listed in parentheses.
  2953. </p>
  2954. <dl compact="compact">
  2955. <dt><span><samp>b (<em>-b</em>)</samp></span></dt>
  2956. <dd><p>Set bitrate expressed in bits/s for CBR. <code>shineenc</code> <samp>-b</samp> option
  2957. is expressed in kilobits/s.
  2958. </p>
  2959. </dd>
  2960. </dl>
  2961. <a name="libtwolame"></a>
  2962. <h3 class="section">8.10 libtwolame<span class="pull-right"><a class="anchor hidden-xs" href="#libtwolame" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libtwolame" aria-hidden="true">TOC</a></span></h3>
  2963. <p>TwoLAME MP2 encoder wrapper.
  2964. </p>
  2965. <p>Requires the presence of the libtwolame headers and library during
  2966. configuration. You need to explicitly configure the build with
  2967. <code>--enable-libtwolame</code>.
  2968. </p>
  2969. <a name="Options-15"></a>
  2970. <h4 class="subsection">8.10.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-15" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-15" aria-hidden="true">TOC</a></span></h4>
  2971. <p>The following options are supported by the libtwolame wrapper. The
  2972. <code>twolame</code>-equivalent options follow the FFmpeg ones and are in
  2973. parentheses.
  2974. </p>
  2975. <dl compact="compact">
  2976. <dt><span><samp>b (<em>-b</em>)</samp></span></dt>
  2977. <dd><p>Set bitrate expressed in bits/s for CBR. <code>twolame</code> <samp>b</samp>
  2978. option is expressed in kilobits/s. Default value is 128k.
  2979. </p>
  2980. </dd>
  2981. <dt><span><samp>q (<em>-V</em>)</samp></span></dt>
  2982. <dd><p>Set quality for experimental VBR support. Maximum value range is
  2983. from -50 to 50, useful range is from -10 to 10. The higher the
  2984. value, the better the quality. This option is valid only using the
  2985. <code>ffmpeg</code> command-line tool. For library interface users,
  2986. use <samp>global_quality</samp>.
  2987. </p>
  2988. </dd>
  2989. <dt><span><samp>mode (<em>--mode</em>)</samp></span></dt>
  2990. <dd><p>Set the mode of the resulting audio. Possible values:
  2991. </p>
  2992. <dl compact="compact">
  2993. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  2994. <dd><p>Choose mode automatically based on the input. This is the default.
  2995. </p></dd>
  2996. <dt><span>&lsquo;<samp>stereo</samp>&rsquo;</span></dt>
  2997. <dd><p>Stereo
  2998. </p></dd>
  2999. <dt><span>&lsquo;<samp>joint_stereo</samp>&rsquo;</span></dt>
  3000. <dd><p>Joint stereo
  3001. </p></dd>
  3002. <dt><span>&lsquo;<samp>dual_channel</samp>&rsquo;</span></dt>
  3003. <dd><p>Dual channel
  3004. </p></dd>
  3005. <dt><span>&lsquo;<samp>mono</samp>&rsquo;</span></dt>
  3006. <dd><p>Mono
  3007. </p></dd>
  3008. </dl>
  3009. </dd>
  3010. <dt><span><samp>psymodel (<em>--psyc-mode</em>)</samp></span></dt>
  3011. <dd><p>Set psychoacoustic model to use in encoding. The argument must be
  3012. an integer between -1 and 4, inclusive. The higher the value, the
  3013. better the quality. The default value is 3.
  3014. </p>
  3015. </dd>
  3016. <dt><span><samp>energy_levels (<em>--energy</em>)</samp></span></dt>
  3017. <dd><p>Enable energy levels extensions when set to 1. The default value is
  3018. 0 (disabled).
  3019. </p>
  3020. </dd>
  3021. <dt><span><samp>error_protection (<em>--protect</em>)</samp></span></dt>
  3022. <dd><p>Enable CRC error protection when set to 1. The default value is 0
  3023. (disabled).
  3024. </p>
  3025. </dd>
  3026. <dt><span><samp>copyright (<em>--copyright</em>)</samp></span></dt>
  3027. <dd><p>Set MPEG audio copyright flag when set to 1. The default value is 0
  3028. (disabled).
  3029. </p>
  3030. </dd>
  3031. <dt><span><samp>original (<em>--original</em>)</samp></span></dt>
  3032. <dd><p>Set MPEG audio original flag when set to 1. The default value is 0
  3033. (disabled).
  3034. </p>
  3035. </dd>
  3036. </dl>
  3037. <a name="libvo_002damrwbenc"></a>
  3038. <h3 class="section">8.11 libvo-amrwbenc<span class="pull-right"><a class="anchor hidden-xs" href="#libvo_002damrwbenc" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libvo_002damrwbenc" aria-hidden="true">TOC</a></span></h3>
  3039. <p>VisualOn Adaptive Multi-Rate Wideband encoder.
  3040. </p>
  3041. <p>Requires the presence of the libvo-amrwbenc headers and library during
  3042. configuration. You need to explicitly configure the build with
  3043. <code>--enable-libvo-amrwbenc --enable-version3</code>.
  3044. </p>
  3045. <p>This is a mono-only encoder. Officially it only supports 16000Hz sample
  3046. rate, but you can override it by setting <samp>strict</samp> to
  3047. &lsquo;<samp>unofficial</samp>&rsquo; or lower.
  3048. </p>
  3049. <a name="Options-16"></a>
  3050. <h4 class="subsection">8.11.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-16" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-16" aria-hidden="true">TOC</a></span></h4>
  3051. <dl compact="compact">
  3052. <dt><span><samp>b</samp></span></dt>
  3053. <dd><p>Set bitrate in bits/s. Only the following bitrates are supported, otherwise
  3054. libavcodec will round to the nearest valid bitrate.
  3055. </p>
  3056. <dl compact="compact">
  3057. <dt><span>&lsquo;<samp>6600</samp>&rsquo;</span></dt>
  3058. <dt><span>&lsquo;<samp>8850</samp>&rsquo;</span></dt>
  3059. <dt><span>&lsquo;<samp>12650</samp>&rsquo;</span></dt>
  3060. <dt><span>&lsquo;<samp>14250</samp>&rsquo;</span></dt>
  3061. <dt><span>&lsquo;<samp>15850</samp>&rsquo;</span></dt>
  3062. <dt><span>&lsquo;<samp>18250</samp>&rsquo;</span></dt>
  3063. <dt><span>&lsquo;<samp>19850</samp>&rsquo;</span></dt>
  3064. <dt><span>&lsquo;<samp>23050</samp>&rsquo;</span></dt>
  3065. <dt><span>&lsquo;<samp>23850</samp>&rsquo;</span></dt>
  3066. </dl>
  3067. </dd>
  3068. <dt><span><samp>dtx</samp></span></dt>
  3069. <dd><p>Allow discontinuous transmission (generate comfort noise) when set to 1. The
  3070. default value is 0 (disabled).
  3071. </p>
  3072. </dd>
  3073. </dl>
  3074. <a name="libvorbis"></a>
  3075. <h3 class="section">8.12 libvorbis<span class="pull-right"><a class="anchor hidden-xs" href="#libvorbis" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libvorbis" aria-hidden="true">TOC</a></span></h3>
  3076. <p>libvorbis encoder wrapper.
  3077. </p>
  3078. <p>Requires the presence of the libvorbisenc headers and library during
  3079. configuration. You need to explicitly configure the build with
  3080. <code>--enable-libvorbis</code>.
  3081. </p>
  3082. <a name="Options-17"></a>
  3083. <h4 class="subsection">8.12.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-17" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-17" aria-hidden="true">TOC</a></span></h4>
  3084. <p>The following options are supported by the libvorbis wrapper. The
  3085. <code>oggenc</code>-equivalent of the options are listed in parentheses.
  3086. </p>
  3087. <p>To get a more accurate and extensive documentation of the libvorbis
  3088. options, consult the libvorbisenc&rsquo;s and <code>oggenc</code>&rsquo;s documentations.
  3089. See <a href="http://xiph.org/vorbis/">http://xiph.org/vorbis/</a>,
  3090. <a href="http://wiki.xiph.org/Vorbis-tools">http://wiki.xiph.org/Vorbis-tools</a>, and oggenc(1).
  3091. </p>
  3092. <dl compact="compact">
  3093. <dt><span><samp>b (<em>-b</em>)</samp></span></dt>
  3094. <dd><p>Set bitrate expressed in bits/s for ABR. <code>oggenc</code> <samp>-b</samp> is
  3095. expressed in kilobits/s.
  3096. </p>
  3097. </dd>
  3098. <dt><span><samp>q (<em>-q</em>)</samp></span></dt>
  3099. <dd><p>Set constant quality setting for VBR. The value should be a float
  3100. number in the range of -1.0 to 10.0. The higher the value, the better
  3101. the quality. The default value is &lsquo;<samp>3.0</samp>&rsquo;.
  3102. </p>
  3103. <p>This option is valid only using the <code>ffmpeg</code> command-line tool.
  3104. For library interface users, use <samp>global_quality</samp>.
  3105. </p>
  3106. </dd>
  3107. <dt><span><samp>cutoff (<em>--advanced-encode-option lowpass_frequency=N</em>)</samp></span></dt>
  3108. <dd><p>Set cutoff bandwidth in Hz, a value of 0 disables cutoff. <code>oggenc</code>&rsquo;s
  3109. related option is expressed in kHz. The default value is &lsquo;<samp>0</samp>&rsquo; (cutoff
  3110. disabled).
  3111. </p>
  3112. </dd>
  3113. <dt><span><samp>minrate (<em>-m</em>)</samp></span></dt>
  3114. <dd><p>Set minimum bitrate expressed in bits/s. <code>oggenc</code> <samp>-m</samp> is
  3115. expressed in kilobits/s.
  3116. </p>
  3117. </dd>
  3118. <dt><span><samp>maxrate (<em>-M</em>)</samp></span></dt>
  3119. <dd><p>Set maximum bitrate expressed in bits/s. <code>oggenc</code> <samp>-M</samp> is
  3120. expressed in kilobits/s. This only has effect on ABR mode.
  3121. </p>
  3122. </dd>
  3123. <dt><span><samp>iblock (<em>--advanced-encode-option impulse_noisetune=N</em>)</samp></span></dt>
  3124. <dd><p>Set noise floor bias for impulse blocks. The value is a float number from
  3125. -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
  3126. to the crispness of transients in the encoded audio. The tradeoff for better
  3127. transient response is a higher bitrate.
  3128. </p>
  3129. </dd>
  3130. </dl>
  3131. <span id="mjpegenc"></span><a name="mjpeg"></a>
  3132. <h3 class="section">8.13 mjpeg<span class="pull-right"><a class="anchor hidden-xs" href="#mjpeg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mjpeg" aria-hidden="true">TOC</a></span></h3>
  3133. <p>Motion JPEG encoder.
  3134. </p>
  3135. <a name="Options-18"></a>
  3136. <h4 class="subsection">8.13.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-18" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-18" aria-hidden="true">TOC</a></span></h4>
  3137. <dl compact="compact">
  3138. <dt><span><samp>huffman</samp></span></dt>
  3139. <dd><p>Set the huffman encoding strategy. Possible values:
  3140. </p>
  3141. <dl compact="compact">
  3142. <dt><span>&lsquo;<samp>default</samp>&rsquo;</span></dt>
  3143. <dd><p>Use the default huffman tables. This is the default strategy.
  3144. </p>
  3145. </dd>
  3146. <dt><span>&lsquo;<samp>optimal</samp>&rsquo;</span></dt>
  3147. <dd><p>Compute and use optimal huffman tables.
  3148. </p>
  3149. </dd>
  3150. </dl>
  3151. </dd>
  3152. </dl>
  3153. <span id="wavpackenc"></span><a name="wavpack"></a>
  3154. <h3 class="section">8.14 wavpack<span class="pull-right"><a class="anchor hidden-xs" href="#wavpack" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-wavpack" aria-hidden="true">TOC</a></span></h3>
  3155. <p>WavPack lossless audio encoder.
  3156. </p>
  3157. <a name="Options-19"></a>
  3158. <h4 class="subsection">8.14.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-19" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-19" aria-hidden="true">TOC</a></span></h4>
  3159. <p>The equivalent options for <code>wavpack</code> command line utility are listed in
  3160. parentheses.
  3161. </p>
  3162. <a name="Shared-options"></a>
  3163. <h4 class="subsubsection">8.14.1.1 Shared options<span class="pull-right"><a class="anchor hidden-xs" href="#Shared-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Shared-options" aria-hidden="true">TOC</a></span></h4>
  3164. <p>The following shared options are effective for this encoder. Only special notes
  3165. about this particular encoder will be documented here. For the general meaning
  3166. of the options, see <a href="#codec_002doptions">the Codec Options chapter</a>.
  3167. </p>
  3168. <dl compact="compact">
  3169. <dt><span><samp>frame_size (<em>--blocksize</em>)</samp></span></dt>
  3170. <dd><p>For this encoder, the range for this option is between 128 and 131072. Default
  3171. is automatically decided based on sample rate and number of channel.
  3172. </p>
  3173. <p>For the complete formula of calculating default, see
  3174. <samp>libavcodec/wavpackenc.c</samp>.
  3175. </p>
  3176. </dd>
  3177. <dt><span><samp>compression_level (<em>-f</em>, <em>-h</em>, <em>-hh</em>, and <em>-x</em>)</samp></span></dt>
  3178. </dl>
  3179. <a name="Private-options"></a>
  3180. <h4 class="subsubsection">8.14.1.2 Private options<span class="pull-right"><a class="anchor hidden-xs" href="#Private-options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Private-options" aria-hidden="true">TOC</a></span></h4>
  3181. <dl compact="compact">
  3182. <dt><span><samp>joint_stereo (<em>-j</em>)</samp></span></dt>
  3183. <dd><p>Set whether to enable joint stereo. Valid values are:
  3184. </p>
  3185. <dl compact="compact">
  3186. <dt><span>&lsquo;<samp>on (<em>1</em>)</samp>&rsquo;</span></dt>
  3187. <dd><p>Force mid/side audio encoding.
  3188. </p></dd>
  3189. <dt><span>&lsquo;<samp>off (<em>0</em>)</samp>&rsquo;</span></dt>
  3190. <dd><p>Force left/right audio encoding.
  3191. </p></dd>
  3192. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  3193. <dd><p>Let the encoder decide automatically.
  3194. </p></dd>
  3195. </dl>
  3196. </dd>
  3197. <dt><span><samp>optimize_mono</samp></span></dt>
  3198. <dd><p>Set whether to enable optimization for mono. This option is only effective for
  3199. non-mono streams. Available values:
  3200. </p>
  3201. <dl compact="compact">
  3202. <dt><span>&lsquo;<samp>on</samp>&rsquo;</span></dt>
  3203. <dd><p>enabled
  3204. </p></dd>
  3205. <dt><span>&lsquo;<samp>off</samp>&rsquo;</span></dt>
  3206. <dd><p>disabled
  3207. </p></dd>
  3208. </dl>
  3209. </dd>
  3210. </dl>
  3211. <a name="Video-Encoders"></a>
  3212. <h2 class="chapter">9 Video Encoders<span class="pull-right"><a class="anchor hidden-xs" href="#Video-Encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Video-Encoders" aria-hidden="true">TOC</a></span></h2>
  3213. <p>A description of some of the currently available video encoders
  3214. follows.
  3215. </p>
  3216. <a name="GIF"></a>
  3217. <h3 class="section">9.1 GIF<span class="pull-right"><a class="anchor hidden-xs" href="#GIF" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-GIF" aria-hidden="true">TOC</a></span></h3>
  3218. <p>GIF image/animation encoder.
  3219. </p>
  3220. <a name="Options-20"></a>
  3221. <h4 class="subsection">9.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-20" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-20" aria-hidden="true">TOC</a></span></h4>
  3222. <dl compact="compact">
  3223. <dt><span><samp>gifflags <var>integer</var></samp></span></dt>
  3224. <dd><p>Sets the flags used for GIF encoding.
  3225. </p>
  3226. <dl compact="compact">
  3227. <dt><span><samp>offsetting</samp></span></dt>
  3228. <dd><p>Enables picture offsetting.
  3229. </p>
  3230. <p>Default is enabled.
  3231. </p>
  3232. </dd>
  3233. <dt><span><samp>transdiff</samp></span></dt>
  3234. <dd><p>Enables transparency detection between frames.
  3235. </p>
  3236. <p>Default is enabled.
  3237. </p>
  3238. </dd>
  3239. </dl>
  3240. </dd>
  3241. <dt><span><samp>gifimage <var>integer</var></samp></span></dt>
  3242. <dd><p>Enables encoding one full GIF image per frame, rather than an animated GIF.
  3243. </p>
  3244. <p>Default value is <samp>0</samp>.
  3245. </p>
  3246. </dd>
  3247. <dt><span><samp>global_palette <var>integer</var></samp></span></dt>
  3248. <dd><p>Writes a palette to the global GIF header where feasible.
  3249. </p>
  3250. <p>If disabled, every frame will always have a palette written, even if there
  3251. is a global palette supplied.
  3252. </p>
  3253. <p>Default value is <samp>1</samp>.
  3254. </p>
  3255. </dd>
  3256. </dl>
  3257. <a name="Hap"></a>
  3258. <h3 class="section">9.2 Hap<span class="pull-right"><a class="anchor hidden-xs" href="#Hap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Hap" aria-hidden="true">TOC</a></span></h3>
  3259. <p>Vidvox Hap video encoder.
  3260. </p>
  3261. <a name="Options-21"></a>
  3262. <h4 class="subsection">9.2.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-21" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-21" aria-hidden="true">TOC</a></span></h4>
  3263. <dl compact="compact">
  3264. <dt><span><samp>format <var>integer</var></samp></span></dt>
  3265. <dd><p>Specifies the Hap format to encode.
  3266. </p>
  3267. <dl compact="compact">
  3268. <dt><span><samp>hap</samp></span></dt>
  3269. <dt><span><samp>hap_alpha</samp></span></dt>
  3270. <dt><span><samp>hap_q</samp></span></dt>
  3271. </dl>
  3272. <p>Default value is <samp>hap</samp>.
  3273. </p>
  3274. </dd>
  3275. <dt><span><samp>chunks <var>integer</var></samp></span></dt>
  3276. <dd><p>Specifies the number of chunks to split frames into, between 1 and 64. This
  3277. permits multithreaded decoding of large frames, potentially at the cost of
  3278. data-rate. The encoder may modify this value to divide frames evenly.
  3279. </p>
  3280. <p>Default value is <var>1</var>.
  3281. </p>
  3282. </dd>
  3283. <dt><span><samp>compressor <var>integer</var></samp></span></dt>
  3284. <dd><p>Specifies the second-stage compressor to use. If set to <samp>none</samp>,
  3285. <samp>chunks</samp> will be limited to 1, as chunked uncompressed frames offer no
  3286. benefit.
  3287. </p>
  3288. <dl compact="compact">
  3289. <dt><span><samp>none</samp></span></dt>
  3290. <dt><span><samp>snappy</samp></span></dt>
  3291. </dl>
  3292. <p>Default value is <samp>snappy</samp>.
  3293. </p>
  3294. </dd>
  3295. </dl>
  3296. <a name="jpeg2000"></a>
  3297. <h3 class="section">9.3 jpeg2000<span class="pull-right"><a class="anchor hidden-xs" href="#jpeg2000" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-jpeg2000" aria-hidden="true">TOC</a></span></h3>
  3298. <p>The native jpeg 2000 encoder is lossy by default, the <code>-q:v</code>
  3299. option can be used to set the encoding quality. Lossless encoding
  3300. can be selected with <code>-pred 1</code>.
  3301. </p>
  3302. <a name="Options-22"></a>
  3303. <h4 class="subsection">9.3.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-22" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-22" aria-hidden="true">TOC</a></span></h4>
  3304. <dl compact="compact">
  3305. <dt><span><samp>format <var>integer</var></samp></span></dt>
  3306. <dd><p>Can be set to either <code>j2k</code> or <code>jp2</code> (the default) that
  3307. makes it possible to store non-rgb pix_fmts.
  3308. </p>
  3309. </dd>
  3310. <dt><span><samp>tile_width <var>integer</var></samp></span></dt>
  3311. <dd><p>Sets tile width. Range is 1 to 1073741824. Default is 256.
  3312. </p>
  3313. </dd>
  3314. <dt><span><samp>tile_height <var>integer</var></samp></span></dt>
  3315. <dd><p>Sets tile height. Range is 1 to 1073741824. Default is 256.
  3316. </p>
  3317. </dd>
  3318. <dt><span><samp>pred <var>integer</var></samp></span></dt>
  3319. <dd><p>Allows setting the discrete wavelet transform (DWT) type
  3320. </p><dl compact="compact">
  3321. <dt><span><samp>dwt97int (Lossy)</samp></span></dt>
  3322. <dt><span><samp>dwt53 (Lossless)</samp></span></dt>
  3323. </dl>
  3324. <p>Default is <code>dwt97int</code>
  3325. </p>
  3326. </dd>
  3327. <dt><span><samp>sop <var>boolean</var></samp></span></dt>
  3328. <dd><p>Enable this to add SOP marker at the start of each packet. Disabled by default.
  3329. </p>
  3330. </dd>
  3331. <dt><span><samp>eph <var>boolean</var></samp></span></dt>
  3332. <dd><p>Enable this to add EPH marker at the end of each packet header. Disabled by default.
  3333. </p>
  3334. </dd>
  3335. <dt><span><samp>prog <var>integer</var></samp></span></dt>
  3336. <dd><p>Sets the progression order to be used by the encoder.
  3337. Possible values are:
  3338. </p><dl compact="compact">
  3339. <dt><span><samp>lrcp</samp></span></dt>
  3340. <dt><span><samp>rlcp</samp></span></dt>
  3341. <dt><span><samp>rpcl</samp></span></dt>
  3342. <dt><span><samp>pcrl</samp></span></dt>
  3343. <dt><span><samp>cprl</samp></span></dt>
  3344. </dl>
  3345. <p>Set to <code>lrcp</code> by default.
  3346. </p>
  3347. </dd>
  3348. <dt><span><samp>layer_rates <var>string</var></samp></span></dt>
  3349. <dd><p>By default, when this option is not used, compression is done using the quality metric.
  3350. This option allows for compression using compression ratio. The compression ratio for each
  3351. level could be specified. The compression ratio of a layer <code>l</code> species the what ratio of
  3352. total file size is contained in the first <code>l</code> layers.
  3353. </p>
  3354. <p>Example usage:
  3355. </p>
  3356. <div class="example">
  3357. <pre class="example">ffmpeg -i input.bmp -c:v jpeg2000 -layer_rates &quot;100,10,1&quot; output.j2k
  3358. </pre></div>
  3359. <p>This would compress the image to contain 3 layers, where the data contained in the
  3360. first layer would be compressed by 1000 times, compressed by 100 in the first two layers,
  3361. and shall contain all data while using all 3 layers.
  3362. </p>
  3363. </dd>
  3364. </dl>
  3365. <a name="librav1e"></a>
  3366. <h3 class="section">9.4 librav1e<span class="pull-right"><a class="anchor hidden-xs" href="#librav1e" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-librav1e" aria-hidden="true">TOC</a></span></h3>
  3367. <p>rav1e AV1 encoder wrapper.
  3368. </p>
  3369. <p>Requires the presence of the rav1e headers and library during configuration.
  3370. You need to explicitly configure the build with <code>--enable-librav1e</code>.
  3371. </p>
  3372. <a name="Options-23"></a>
  3373. <h4 class="subsection">9.4.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-23" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-23" aria-hidden="true">TOC</a></span></h4>
  3374. <dl compact="compact">
  3375. <dt><span><samp>qmax</samp></span></dt>
  3376. <dd><p>Sets the maximum quantizer to use when using bitrate mode.
  3377. </p>
  3378. </dd>
  3379. <dt><span><samp>qmin</samp></span></dt>
  3380. <dd><p>Sets the minimum quantizer to use when using bitrate mode.
  3381. </p>
  3382. </dd>
  3383. <dt><span><samp>qp</samp></span></dt>
  3384. <dd><p>Uses quantizer mode to encode at the given quantizer (0-255).
  3385. </p>
  3386. </dd>
  3387. <dt><span><samp>speed</samp></span></dt>
  3388. <dd><p>Selects the speed preset (0-10) to encode with.
  3389. </p>
  3390. </dd>
  3391. <dt><span><samp>tiles</samp></span></dt>
  3392. <dd><p>Selects how many tiles to encode with.
  3393. </p>
  3394. </dd>
  3395. <dt><span><samp>tile-rows</samp></span></dt>
  3396. <dd><p>Selects how many rows of tiles to encode with.
  3397. </p>
  3398. </dd>
  3399. <dt><span><samp>tile-columns</samp></span></dt>
  3400. <dd><p>Selects how many columns of tiles to encode with.
  3401. </p>
  3402. </dd>
  3403. <dt><span><samp>rav1e-params</samp></span></dt>
  3404. <dd><p>Set rav1e options using a list of <var>key</var>=<var>value</var> pairs separated
  3405. by &quot;:&quot;. See <code>rav1e --help</code> for a list of options.
  3406. </p>
  3407. <p>For example to specify librav1e encoding options with <samp>-rav1e-params</samp>:
  3408. </p>
  3409. <div class="example">
  3410. <pre class="example">ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
  3411. </pre></div>
  3412. </dd>
  3413. </dl>
  3414. <a name="libaom_002dav1"></a>
  3415. <h3 class="section">9.5 libaom-av1<span class="pull-right"><a class="anchor hidden-xs" href="#libaom_002dav1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libaom_002dav1" aria-hidden="true">TOC</a></span></h3>
  3416. <p>libaom AV1 encoder wrapper.
  3417. </p>
  3418. <p>Requires the presence of the libaom headers and library during
  3419. configuration. You need to explicitly configure the build with
  3420. <code>--enable-libaom</code>.
  3421. </p>
  3422. <a name="Options-24"></a>
  3423. <h4 class="subsection">9.5.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-24" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-24" aria-hidden="true">TOC</a></span></h4>
  3424. <p>The wrapper supports the following standard libavcodec options:
  3425. </p>
  3426. <dl compact="compact">
  3427. <dt><span><samp>b</samp></span></dt>
  3428. <dd><p>Set bitrate target in bits/second. By default this will use
  3429. variable-bitrate mode. If <samp>maxrate</samp> and <samp>minrate</samp> are
  3430. also set to the same value then it will use constant-bitrate mode,
  3431. otherwise if <samp>crf</samp> is set as well then it will use
  3432. constrained-quality mode.
  3433. </p>
  3434. </dd>
  3435. <dt><span><samp>g keyint_min</samp></span></dt>
  3436. <dd><p>Set key frame placement. The GOP size sets the maximum distance between
  3437. key frames; if zero the output stream will be intra-only. The minimum
  3438. distance is ignored unless it is the same as the GOP size, in which case
  3439. key frames will always appear at a fixed interval. Not set by default,
  3440. so without this option the library has completely free choice about
  3441. where to place key frames.
  3442. </p>
  3443. </dd>
  3444. <dt><span><samp>qmin qmax</samp></span></dt>
  3445. <dd><p>Set minimum/maximum quantisation values. Valid range is from 0 to 63
  3446. (warning: this does not match the quantiser values actually used by AV1
  3447. - divide by four to map real quantiser values to this range). Defaults
  3448. to min/max (no constraint).
  3449. </p>
  3450. </dd>
  3451. <dt><span><samp>minrate maxrate bufsize rc_init_occupancy</samp></span></dt>
  3452. <dd><p>Set rate control buffering parameters. Not used if not set - defaults
  3453. to unconstrained variable bitrate.
  3454. </p>
  3455. </dd>
  3456. <dt><span><samp>threads</samp></span></dt>
  3457. <dd><p>Set the number of threads to use while encoding. This may require the
  3458. <samp>tiles</samp> or <samp>row-mt</samp> options to also be set to actually
  3459. use the specified number of threads fully. Defaults to the number of
  3460. hardware threads supported by the host machine.
  3461. </p>
  3462. </dd>
  3463. <dt><span><samp>profile</samp></span></dt>
  3464. <dd><p>Set the encoding profile. Defaults to using the profile which matches
  3465. the bit depth and chroma subsampling of the input.
  3466. </p>
  3467. </dd>
  3468. </dl>
  3469. <p>The wrapper also has some specific options:
  3470. </p>
  3471. <dl compact="compact">
  3472. <dt><span><samp>cpu-used</samp></span></dt>
  3473. <dd><p>Set the quality/encoding speed tradeoff. Valid range is from 0 to 8,
  3474. higher numbers indicating greater speed and lower quality. The default
  3475. value is 1, which will be slow and high quality.
  3476. </p>
  3477. </dd>
  3478. <dt><span><samp>auto-alt-ref</samp></span></dt>
  3479. <dd><p>Enable use of alternate reference frames. Defaults to the internal
  3480. default of the library.
  3481. </p>
  3482. </dd>
  3483. <dt><span><samp>arnr-max-frames (<em>frames</em>)</samp></span></dt>
  3484. <dd><p>Set altref noise reduction max frame count. Default is -1.
  3485. </p>
  3486. </dd>
  3487. <dt><span><samp>arnr-strength (<em>strength</em>)</samp></span></dt>
  3488. <dd><p>Set altref noise reduction filter strength. Range is -1 to 6. Default is -1.
  3489. </p>
  3490. </dd>
  3491. <dt><span><samp>aq-mode (<em>aq-mode</em>)</samp></span></dt>
  3492. <dd><p>Set adaptive quantization mode. Possible values:
  3493. </p>
  3494. <dl compact="compact">
  3495. <dt><span>&lsquo;<samp>none (<em>0</em>)</samp>&rsquo;</span></dt>
  3496. <dd><p>Disabled.
  3497. </p>
  3498. </dd>
  3499. <dt><span>&lsquo;<samp>variance (<em>1</em>)</samp>&rsquo;</span></dt>
  3500. <dd><p>Variance-based.
  3501. </p>
  3502. </dd>
  3503. <dt><span>&lsquo;<samp>complexity (<em>2</em>)</samp>&rsquo;</span></dt>
  3504. <dd><p>Complexity-based.
  3505. </p>
  3506. </dd>
  3507. <dt><span>&lsquo;<samp>cyclic (<em>3</em>)</samp>&rsquo;</span></dt>
  3508. <dd><p>Cyclic refresh.
  3509. </p></dd>
  3510. </dl>
  3511. </dd>
  3512. <dt><span><samp>tune (<em>tune</em>)</samp></span></dt>
  3513. <dd><p>Set the distortion metric the encoder is tuned with. Default is <code>psnr</code>.
  3514. </p>
  3515. <dl compact="compact">
  3516. <dt><span>&lsquo;<samp>psnr (<em>0</em>)</samp>&rsquo;</span></dt>
  3517. <dt><span>&lsquo;<samp>ssim (<em>1</em>)</samp>&rsquo;</span></dt>
  3518. </dl>
  3519. </dd>
  3520. <dt><span><samp>lag-in-frames</samp></span></dt>
  3521. <dd><p>Set the maximum number of frames which the encoder may keep in flight
  3522. at any one time for lookahead purposes. Defaults to the internal
  3523. default of the library.
  3524. </p>
  3525. </dd>
  3526. <dt><span><samp>error-resilience</samp></span></dt>
  3527. <dd><p>Enable error resilience features:
  3528. </p><dl compact="compact">
  3529. <dt><span><samp>default</samp></span></dt>
  3530. <dd><p>Improve resilience against losses of whole frames.
  3531. </p></dd>
  3532. </dl>
  3533. <p>Not enabled by default.
  3534. </p>
  3535. </dd>
  3536. <dt><span><samp>crf</samp></span></dt>
  3537. <dd><p>Set the quality/size tradeoff for constant-quality (no bitrate target)
  3538. and constrained-quality (with maximum bitrate target) modes. Valid
  3539. range is 0 to 63, higher numbers indicating lower quality and smaller
  3540. output size. Only used if set; by default only the bitrate target is
  3541. used.
  3542. </p>
  3543. </dd>
  3544. <dt><span><samp>static-thresh</samp></span></dt>
  3545. <dd><p>Set a change threshold on blocks below which they will be skipped by
  3546. the encoder. Defined in arbitrary units as a nonnegative integer,
  3547. defaulting to zero (no blocks are skipped).
  3548. </p>
  3549. </dd>
  3550. <dt><span><samp>drop-threshold</samp></span></dt>
  3551. <dd><p>Set a threshold for dropping frames when close to rate control bounds.
  3552. Defined as a percentage of the target buffer - when the rate control
  3553. buffer falls below this percentage, frames will be dropped until it
  3554. has refilled above the threshold. Defaults to zero (no frames are
  3555. dropped).
  3556. </p>
  3557. </dd>
  3558. <dt><span><samp>denoise-noise-level (<em>level</em>)</samp></span></dt>
  3559. <dd><p>Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if
  3560. this option is not set or set to 0.
  3561. </p>
  3562. </dd>
  3563. <dt><span><samp>denoise-block-size (<em>pixels</em>)</samp></span></dt>
  3564. <dd><p>Block size used for denoising for grain synthesis. If not set, AV1 codec
  3565. uses the default value of 32.
  3566. </p>
  3567. </dd>
  3568. <dt><span><samp>undershoot-pct (<em>pct</em>)</samp></span></dt>
  3569. <dd><p>Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100.
  3570. Default is -1.
  3571. </p>
  3572. </dd>
  3573. <dt><span><samp>overshoot-pct (<em>pct</em>)</samp></span></dt>
  3574. <dd><p>Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000.
  3575. Default is -1.
  3576. </p>
  3577. </dd>
  3578. <dt><span><samp>minsection-pct (<em>pct</em>)</samp></span></dt>
  3579. <dd><p>Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct
  3580. is not set, the libaomenc wrapper computes it as follows: <code>(minrate * 100 / bitrate)</code>.
  3581. Range is -1 to 100. Default is -1 (unset).
  3582. </p>
  3583. </dd>
  3584. <dt><span><samp>maxsection-pct (<em>pct</em>)</samp></span></dt>
  3585. <dd><p>Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct
  3586. is not set, the libaomenc wrapper computes it as follows: <code>(maxrate * 100 / bitrate)</code>.
  3587. Range is -1 to 5000. Default is -1 (unset).
  3588. </p>
  3589. </dd>
  3590. <dt><span><samp>frame-parallel (<em>boolean</em>)</samp></span></dt>
  3591. <dd><p>Enable frame parallel decodability features. Default is true.
  3592. </p>
  3593. </dd>
  3594. <dt><span><samp>tiles</samp></span></dt>
  3595. <dd><p>Set the number of tiles to encode the input video with, as columns x
  3596. rows. Larger numbers allow greater parallelism in both encoding and
  3597. decoding, but may decrease coding efficiency. Defaults to the minimum
  3598. number of tiles required by the size of the input video (this is 1x1
  3599. (that is, a single tile) for sizes up to and including 4K).
  3600. </p>
  3601. </dd>
  3602. <dt><span><samp>tile-columns tile-rows</samp></span></dt>
  3603. <dd><p>Set the number of tiles as log2 of the number of tile rows and columns.
  3604. Provided for compatibility with libvpx/VP9.
  3605. </p>
  3606. </dd>
  3607. <dt><span><samp>row-mt (Requires libaom &gt;= 1.0.0-759-g90a15f4f2)</samp></span></dt>
  3608. <dd><p>Enable row based multi-threading. Disabled by default.
  3609. </p>
  3610. </dd>
  3611. <dt><span><samp>enable-cdef (<em>boolean</em>)</samp></span></dt>
  3612. <dd><p>Enable Constrained Directional Enhancement Filter. The libaom-av1
  3613. encoder enables CDEF by default.
  3614. </p>
  3615. </dd>
  3616. <dt><span><samp>enable-restoration (<em>boolean</em>)</samp></span></dt>
  3617. <dd><p>Enable Loop Restoration Filter. Default is true for libaom-av1.
  3618. </p>
  3619. </dd>
  3620. <dt><span><samp>enable-global-motion (<em>boolean</em>)</samp></span></dt>
  3621. <dd><p>Enable the use of global motion for block prediction. Default is true.
  3622. </p>
  3623. </dd>
  3624. <dt><span><samp>enable-intrabc (<em>boolean</em>)</samp></span></dt>
  3625. <dd><p>Enable block copy mode for intra block prediction. This mode is
  3626. useful for screen content. Default is true.
  3627. </p>
  3628. </dd>
  3629. <dt><span><samp>enable-rect-partitions (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3630. <dd><p>Enable rectangular partitions. Default is true.
  3631. </p>
  3632. </dd>
  3633. <dt><span><samp>enable-1to4-partitions (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3634. <dd><p>Enable 1:4/4:1 partitions. Default is true.
  3635. </p>
  3636. </dd>
  3637. <dt><span><samp>enable-ab-partitions (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3638. <dd><p>Enable AB shape partitions. Default is true.
  3639. </p>
  3640. </dd>
  3641. <dt><span><samp>enable-angle-delta (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3642. <dd><p>Enable angle delta intra prediction. Default is true.
  3643. </p>
  3644. </dd>
  3645. <dt><span><samp>enable-cfl-intra (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3646. <dd><p>Enable chroma predicted from luma intra prediction. Default is true.
  3647. </p>
  3648. </dd>
  3649. <dt><span><samp>enable-filter-intra (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3650. <dd><p>Enable filter intra predictor. Default is true.
  3651. </p>
  3652. </dd>
  3653. <dt><span><samp>enable-intra-edge-filter (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3654. <dd><p>Enable intra edge filter. Default is true.
  3655. </p>
  3656. </dd>
  3657. <dt><span><samp>enable-smooth-intra (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3658. <dd><p>Enable smooth intra prediction mode. Default is true.
  3659. </p>
  3660. </dd>
  3661. <dt><span><samp>enable-paeth-intra (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3662. <dd><p>Enable paeth predictor in intra prediction. Default is true.
  3663. </p>
  3664. </dd>
  3665. <dt><span><samp>enable-palette (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3666. <dd><p>Enable palette prediction mode. Default is true.
  3667. </p>
  3668. </dd>
  3669. <dt><span><samp>enable-flip-idtx (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3670. <dd><p>Enable extended transform type, including FLIPADST_DCT, DCT_FLIPADST,
  3671. FLIPADST_FLIPADST, ADST_FLIPADST, FLIPADST_ADST, IDTX, V_DCT, H_DCT,
  3672. V_ADST, H_ADST, V_FLIPADST, H_FLIPADST. Default is true.
  3673. </p>
  3674. </dd>
  3675. <dt><span><samp>enable-tx64 (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3676. <dd><p>Enable 64-pt transform. Default is true.
  3677. </p>
  3678. </dd>
  3679. <dt><span><samp>reduced-tx-type-set (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3680. <dd><p>Use reduced set of transform types. Default is false.
  3681. </p>
  3682. </dd>
  3683. <dt><span><samp>use-intra-dct-only (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3684. <dd><p>Use DCT only for INTRA modes. Default is false.
  3685. </p>
  3686. </dd>
  3687. <dt><span><samp>use-inter-dct-only (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3688. <dd><p>Use DCT only for INTER modes. Default is false.
  3689. </p>
  3690. </dd>
  3691. <dt><span><samp>use-intra-default-tx-only (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3692. <dd><p>Use Default-transform only for INTRA modes. Default is false.
  3693. </p>
  3694. </dd>
  3695. <dt><span><samp>enable-ref-frame-mvs (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3696. <dd><p>Enable temporal mv prediction. Default is true.
  3697. </p>
  3698. </dd>
  3699. <dt><span><samp>enable-reduced-reference-set (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3700. <dd><p>Use reduced set of single and compound references. Default is false.
  3701. </p>
  3702. </dd>
  3703. <dt><span><samp>enable-obmc (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3704. <dd><p>Enable obmc. Default is true.
  3705. </p>
  3706. </dd>
  3707. <dt><span><samp>enable-dual-filter (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3708. <dd><p>Enable dual filter. Default is true.
  3709. </p>
  3710. </dd>
  3711. <dt><span><samp>enable-diff-wtd-comp (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3712. <dd><p>Enable difference-weighted compound. Default is true.
  3713. </p>
  3714. </dd>
  3715. <dt><span><samp>enable-dist-wtd-comp (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3716. <dd><p>Enable distance-weighted compound. Default is true.
  3717. </p>
  3718. </dd>
  3719. <dt><span><samp>enable-onesided-comp (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3720. <dd><p>Enable one sided compound. Default is true.
  3721. </p>
  3722. </dd>
  3723. <dt><span><samp>enable-interinter-wedge (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3724. <dd><p>Enable interinter wedge compound. Default is true.
  3725. </p>
  3726. </dd>
  3727. <dt><span><samp>enable-interintra-wedge (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3728. <dd><p>Enable interintra wedge compound. Default is true.
  3729. </p>
  3730. </dd>
  3731. <dt><span><samp>enable-masked-comp (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3732. <dd><p>Enable masked compound. Default is true.
  3733. </p>
  3734. </dd>
  3735. <dt><span><samp>enable-interintra-comp (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3736. <dd><p>Enable interintra compound. Default is true.
  3737. </p>
  3738. </dd>
  3739. <dt><span><samp>enable-smooth-interintra (<em>boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></span></dt>
  3740. <dd><p>Enable smooth interintra mode. Default is true.
  3741. </p>
  3742. </dd>
  3743. <dt><span><samp>aom-params</samp></span></dt>
  3744. <dd><p>Set libaom options using a list of <var>key</var>=<var>value</var> pairs separated
  3745. by &quot;:&quot;. For a list of supported options, see <code>aomenc --help</code> under the
  3746. section &quot;AV1 Specific Options&quot;.
  3747. </p>
  3748. <p>For example to specify libaom encoding options with <samp>-aom-params</samp>:
  3749. </p>
  3750. <div class="example">
  3751. <pre class="example">ffmpeg -i input -c:v libaom-av1 -b:v 500K -aom-params tune=psnr:enable-tpl-model=1 output.mp4
  3752. </pre></div>
  3753. </dd>
  3754. </dl>
  3755. <a name="libsvtav1"></a>
  3756. <h3 class="section">9.6 libsvtav1<span class="pull-right"><a class="anchor hidden-xs" href="#libsvtav1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libsvtav1" aria-hidden="true">TOC</a></span></h3>
  3757. <p>SVT-AV1 encoder wrapper.
  3758. </p>
  3759. <p>Requires the presence of the SVT-AV1 headers and library during configuration.
  3760. You need to explicitly configure the build with <code>--enable-libsvtav1</code>.
  3761. </p>
  3762. <a name="Options-25"></a>
  3763. <h4 class="subsection">9.6.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-25" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-25" aria-hidden="true">TOC</a></span></h4>
  3764. <dl compact="compact">
  3765. <dt><span><samp>profile</samp></span></dt>
  3766. <dd><p>Set the encoding profile.
  3767. </p>
  3768. </dd>
  3769. <dt><span><samp>level</samp></span></dt>
  3770. <dd><p>Set the operating point level.
  3771. </p>
  3772. </dd>
  3773. <dt><span><samp>tier</samp></span></dt>
  3774. <dd><p>Set the operating point tier.
  3775. </p>
  3776. </dd>
  3777. <dt><span><samp>rc</samp></span></dt>
  3778. <dd><p>Set the rate control mode to use.
  3779. </p>
  3780. <p>Possible modes:
  3781. </p><dl compact="compact">
  3782. <dt><span><samp>cqp</samp></span></dt>
  3783. <dd><p>Constant quantizer: use fixed values of qindex (dependent on the frame type)
  3784. throughout the stream. This mode is the default.
  3785. </p>
  3786. </dd>
  3787. <dt><span><samp>vbr</samp></span></dt>
  3788. <dd><p>Variable bitrate: use a target bitrate for the whole stream.
  3789. </p>
  3790. </dd>
  3791. <dt><span><samp>cvbr</samp></span></dt>
  3792. <dd><p>Constrained variable bitrate: use a target bitrate for each GOP.
  3793. </p></dd>
  3794. </dl>
  3795. </dd>
  3796. <dt><span><samp>qmax</samp></span></dt>
  3797. <dd><p>Set the maximum quantizer to use when using a bitrate mode.
  3798. </p>
  3799. </dd>
  3800. <dt><span><samp>qmin</samp></span></dt>
  3801. <dd><p>Set the minimum quantizer to use when using a bitrate mode.
  3802. </p>
  3803. </dd>
  3804. <dt><span><samp>qp</samp></span></dt>
  3805. <dd><p>Set the quantizer used in cqp rate control mode (0-63).
  3806. </p>
  3807. </dd>
  3808. <dt><span><samp>sc_detection</samp></span></dt>
  3809. <dd><p>Enable scene change detection.
  3810. </p>
  3811. </dd>
  3812. <dt><span><samp>la_depth</samp></span></dt>
  3813. <dd><p>Set number of frames to look ahead (0-120).
  3814. </p>
  3815. </dd>
  3816. <dt><span><samp>preset</samp></span></dt>
  3817. <dd><p>Set the quality-speed tradeoff, in the range 0 to 8. Higher values are
  3818. faster but lower quality. Defaults to 8 (highest speed).
  3819. </p>
  3820. </dd>
  3821. <dt><span><samp>tile_rows</samp></span></dt>
  3822. <dd><p>Set log2 of the number of rows of tiles to use (0-6).
  3823. </p>
  3824. </dd>
  3825. <dt><span><samp>tile_columns</samp></span></dt>
  3826. <dd><p>Set log2 of the number of columns of tiles to use (0-4).
  3827. </p>
  3828. </dd>
  3829. </dl>
  3830. <a name="libkvazaar"></a>
  3831. <h3 class="section">9.7 libkvazaar<span class="pull-right"><a class="anchor hidden-xs" href="#libkvazaar" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libkvazaar" aria-hidden="true">TOC</a></span></h3>
  3832. <p>Kvazaar H.265/HEVC encoder.
  3833. </p>
  3834. <p>Requires the presence of the libkvazaar headers and library during
  3835. configuration. You need to explicitly configure the build with
  3836. <samp>--enable-libkvazaar</samp>.
  3837. </p>
  3838. <a name="Options-26"></a>
  3839. <h4 class="subsection">9.7.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-26" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-26" aria-hidden="true">TOC</a></span></h4>
  3840. <dl compact="compact">
  3841. <dt><span><samp>b</samp></span></dt>
  3842. <dd><p>Set target video bitrate in bit/s and enable rate control.
  3843. </p>
  3844. </dd>
  3845. <dt><span><samp>kvazaar-params</samp></span></dt>
  3846. <dd><p>Set kvazaar parameters as a list of <var>name</var>=<var>value</var> pairs separated
  3847. by commas (,). See kvazaar documentation for a list of options.
  3848. </p>
  3849. </dd>
  3850. </dl>
  3851. <a name="libopenh264"></a>
  3852. <h3 class="section">9.8 libopenh264<span class="pull-right"><a class="anchor hidden-xs" href="#libopenh264" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libopenh264" aria-hidden="true">TOC</a></span></h3>
  3853. <p>Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
  3854. </p>
  3855. <p>This encoder requires the presence of the libopenh264 headers and
  3856. library during configuration. You need to explicitly configure the
  3857. build with <code>--enable-libopenh264</code>. The library is detected using
  3858. <code>pkg-config</code>.
  3859. </p>
  3860. <p>For more information about the library see
  3861. <a href="http://www.openh264.org">http://www.openh264.org</a>.
  3862. </p>
  3863. <a name="Options-27"></a>
  3864. <h4 class="subsection">9.8.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-27" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-27" aria-hidden="true">TOC</a></span></h4>
  3865. <p>The following FFmpeg global options affect the configurations of the
  3866. libopenh264 encoder.
  3867. </p>
  3868. <dl compact="compact">
  3869. <dt><span><samp>b</samp></span></dt>
  3870. <dd><p>Set the bitrate (as a number of bits per second).
  3871. </p>
  3872. </dd>
  3873. <dt><span><samp>g</samp></span></dt>
  3874. <dd><p>Set the GOP size.
  3875. </p>
  3876. </dd>
  3877. <dt><span><samp>maxrate</samp></span></dt>
  3878. <dd><p>Set the max bitrate (as a number of bits per second).
  3879. </p>
  3880. </dd>
  3881. <dt><span><samp>flags +global_header</samp></span></dt>
  3882. <dd><p>Set global header in the bitstream.
  3883. </p>
  3884. </dd>
  3885. <dt><span><samp>slices</samp></span></dt>
  3886. <dd><p>Set the number of slices, used in parallelized encoding. Default value
  3887. is 0. This is only used when <samp>slice_mode</samp> is set to
  3888. &lsquo;<samp>fixed</samp>&rsquo;.
  3889. </p>
  3890. </dd>
  3891. <dt><span><samp>slice_mode</samp></span></dt>
  3892. <dd><p>Set slice mode. Can assume one of the following possible values:
  3893. </p>
  3894. <dl compact="compact">
  3895. <dt><span>&lsquo;<samp>fixed</samp>&rsquo;</span></dt>
  3896. <dd><p>a fixed number of slices
  3897. </p></dd>
  3898. <dt><span>&lsquo;<samp>rowmb</samp>&rsquo;</span></dt>
  3899. <dd><p>one slice per row of macroblocks
  3900. </p></dd>
  3901. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  3902. <dd><p>automatic number of slices according to number of threads
  3903. </p></dd>
  3904. <dt><span>&lsquo;<samp>dyn</samp>&rsquo;</span></dt>
  3905. <dd><p>dynamic slicing
  3906. </p></dd>
  3907. </dl>
  3908. <p>Default value is &lsquo;<samp>auto</samp>&rsquo;.
  3909. </p>
  3910. </dd>
  3911. <dt><span><samp>loopfilter</samp></span></dt>
  3912. <dd><p>Enable loop filter, if set to 1 (automatically enabled). To disable
  3913. set a value of 0.
  3914. </p>
  3915. </dd>
  3916. <dt><span><samp>profile</samp></span></dt>
  3917. <dd><p>Set profile restrictions. If set to the value of &lsquo;<samp>main</samp>&rsquo; enable
  3918. CABAC (set the <code>SEncParamExt.iEntropyCodingModeFlag</code> flag to 1).
  3919. </p>
  3920. </dd>
  3921. <dt><span><samp>max_nal_size</samp></span></dt>
  3922. <dd><p>Set maximum NAL size in bytes.
  3923. </p>
  3924. </dd>
  3925. <dt><span><samp>allow_skip_frames</samp></span></dt>
  3926. <dd><p>Allow skipping frames to hit the target bitrate if set to 1.
  3927. </p></dd>
  3928. </dl>
  3929. <a name="libtheora"></a>
  3930. <h3 class="section">9.9 libtheora<span class="pull-right"><a class="anchor hidden-xs" href="#libtheora" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libtheora" aria-hidden="true">TOC</a></span></h3>
  3931. <p>libtheora Theora encoder wrapper.
  3932. </p>
  3933. <p>Requires the presence of the libtheora headers and library during
  3934. configuration. You need to explicitly configure the build with
  3935. <code>--enable-libtheora</code>.
  3936. </p>
  3937. <p>For more information about the libtheora project see
  3938. <a href="http://www.theora.org/">http://www.theora.org/</a>.
  3939. </p>
  3940. <a name="Options-28"></a>
  3941. <h4 class="subsection">9.9.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-28" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-28" aria-hidden="true">TOC</a></span></h4>
  3942. <p>The following global options are mapped to internal libtheora options
  3943. which affect the quality and the bitrate of the encoded stream.
  3944. </p>
  3945. <dl compact="compact">
  3946. <dt><span><samp>b</samp></span></dt>
  3947. <dd><p>Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode. In
  3948. case VBR (Variable Bit Rate) mode is enabled this option is ignored.
  3949. </p>
  3950. </dd>
  3951. <dt><span><samp>flags</samp></span></dt>
  3952. <dd><p>Used to enable constant quality mode (VBR) encoding through the
  3953. <samp>qscale</samp> flag, and to enable the <code>pass1</code> and <code>pass2</code>
  3954. modes.
  3955. </p>
  3956. </dd>
  3957. <dt><span><samp>g</samp></span></dt>
  3958. <dd><p>Set the GOP size.
  3959. </p>
  3960. </dd>
  3961. <dt><span><samp>global_quality</samp></span></dt>
  3962. <dd><p>Set the global quality as an integer in lambda units.
  3963. </p>
  3964. <p>Only relevant when VBR mode is enabled with <code>flags +qscale</code>. The
  3965. value is converted to QP units by dividing it by <code>FF_QP2LAMBDA</code>,
  3966. clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
  3967. value in the native libtheora range [0-63]. A higher value corresponds
  3968. to a higher quality.
  3969. </p>
  3970. </dd>
  3971. <dt><span><samp>q</samp></span></dt>
  3972. <dd><p>Enable VBR mode when set to a non-negative value, and set constant
  3973. quality value as a double floating point value in QP units.
  3974. </p>
  3975. <p>The value is clipped in the [0-10] range, and then multiplied by 6.3
  3976. to get a value in the native libtheora range [0-63].
  3977. </p>
  3978. <p>This option is valid only using the <code>ffmpeg</code> command-line
  3979. tool. For library interface users, use <samp>global_quality</samp>.
  3980. </p></dd>
  3981. </dl>
  3982. <a name="Examples-1"></a>
  3983. <h4 class="subsection">9.9.2 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-1" aria-hidden="true">TOC</a></span></h4>
  3984. <ul>
  3985. <li> Set maximum constant quality (VBR) encoding with <code>ffmpeg</code>:
  3986. <div class="example">
  3987. <pre class="example">ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
  3988. </pre></div>
  3989. </li><li> Use <code>ffmpeg</code> to convert a CBR 1000 kbps Theora video stream:
  3990. <div class="example">
  3991. <pre class="example">ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
  3992. </pre></div>
  3993. </li></ul>
  3994. <a name="libvpx"></a>
  3995. <h3 class="section">9.10 libvpx<span class="pull-right"><a class="anchor hidden-xs" href="#libvpx" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libvpx" aria-hidden="true">TOC</a></span></h3>
  3996. <p>VP8/VP9 format supported through libvpx.
  3997. </p>
  3998. <p>Requires the presence of the libvpx headers and library during configuration.
  3999. You need to explicitly configure the build with <code>--enable-libvpx</code>.
  4000. </p>
  4001. <a name="Options-29"></a>
  4002. <h4 class="subsection">9.10.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-29" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-29" aria-hidden="true">TOC</a></span></h4>
  4003. <p>The following options are supported by the libvpx wrapper. The
  4004. <code>vpxenc</code>-equivalent options or values are listed in parentheses
  4005. for easy migration.
  4006. </p>
  4007. <p>To reduce the duplication of documentation, only the private options
  4008. and some others requiring special attention are documented here. For
  4009. the documentation of the undocumented generic options, see
  4010. <a href="#codec_002doptions">the Codec Options chapter</a>.
  4011. </p>
  4012. <p>To get more documentation of the libvpx options, invoke the command
  4013. <code>ffmpeg -h encoder=libvpx</code>, <code>ffmpeg -h encoder=libvpx-vp9</code> or
  4014. <code>vpxenc --help</code>. Further information is available in the libvpx API
  4015. documentation.
  4016. </p>
  4017. <dl compact="compact">
  4018. <dt><span><samp>b (<em>target-bitrate</em>)</samp></span></dt>
  4019. <dd><p>Set bitrate in bits/s. Note that FFmpeg&rsquo;s <samp>b</samp> option is
  4020. expressed in bits/s, while <code>vpxenc</code>&rsquo;s <samp>target-bitrate</samp> is in
  4021. kilobits/s.
  4022. </p>
  4023. </dd>
  4024. <dt><span><samp>g (<em>kf-max-dist</em>)</samp></span></dt>
  4025. <dt><span><samp>keyint_min (<em>kf-min-dist</em>)</samp></span></dt>
  4026. <dt><span><samp>qmin (<em>min-q</em>)</samp></span></dt>
  4027. <dt><span><samp>qmax (<em>max-q</em>)</samp></span></dt>
  4028. <dt><span><samp>bufsize (<em>buf-sz</em>, <em>buf-optimal-sz</em>)</samp></span></dt>
  4029. <dd><p>Set ratecontrol buffer size (in bits). Note <code>vpxenc</code>&rsquo;s options are
  4030. specified in milliseconds, the libvpx wrapper converts this value as follows:
  4031. <code>buf-sz = bufsize * 1000 / bitrate</code>,
  4032. <code>buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6</code>.
  4033. </p>
  4034. </dd>
  4035. <dt><span><samp>rc_init_occupancy (<em>buf-initial-sz</em>)</samp></span></dt>
  4036. <dd><p>Set number of bits which should be loaded into the rc buffer before decoding
  4037. starts. Note <code>vpxenc</code>&rsquo;s option is specified in milliseconds, the libvpx
  4038. wrapper converts this value as follows:
  4039. <code>rc_init_occupancy * 1000 / bitrate</code>.
  4040. </p>
  4041. </dd>
  4042. <dt><span><samp>undershoot-pct</samp></span></dt>
  4043. <dd><p>Set datarate undershoot (min) percentage of the target bitrate.
  4044. </p>
  4045. </dd>
  4046. <dt><span><samp>overshoot-pct</samp></span></dt>
  4047. <dd><p>Set datarate overshoot (max) percentage of the target bitrate.
  4048. </p>
  4049. </dd>
  4050. <dt><span><samp>skip_threshold (<em>drop-frame</em>)</samp></span></dt>
  4051. <dt><span><samp>qcomp (<em>bias-pct</em>)</samp></span></dt>
  4052. <dt><span><samp>maxrate (<em>maxsection-pct</em>)</samp></span></dt>
  4053. <dd><p>Set GOP max bitrate in bits/s. Note <code>vpxenc</code>&rsquo;s option is specified as a
  4054. percentage of the target bitrate, the libvpx wrapper converts this value as
  4055. follows: <code>(maxrate * 100 / bitrate)</code>.
  4056. </p>
  4057. </dd>
  4058. <dt><span><samp>minrate (<em>minsection-pct</em>)</samp></span></dt>
  4059. <dd><p>Set GOP min bitrate in bits/s. Note <code>vpxenc</code>&rsquo;s option is specified as a
  4060. percentage of the target bitrate, the libvpx wrapper converts this value as
  4061. follows: <code>(minrate * 100 / bitrate)</code>.
  4062. </p>
  4063. </dd>
  4064. <dt><span><samp>minrate, maxrate, b <em>end-usage=cbr</em></samp></span></dt>
  4065. <dd><p><code>(minrate == maxrate == bitrate)</code>.
  4066. </p>
  4067. </dd>
  4068. <dt><span><samp>crf (<em>end-usage=cq</em>, <em>cq-level</em>)</samp></span></dt>
  4069. <dt><span><samp>tune (<em>tune</em>)</samp></span></dt>
  4070. <dd><dl compact="compact">
  4071. <dt><span>&lsquo;<samp>psnr (<em>psnr</em>)</samp>&rsquo;</span></dt>
  4072. <dt><span>&lsquo;<samp>ssim (<em>ssim</em>)</samp>&rsquo;</span></dt>
  4073. </dl>
  4074. </dd>
  4075. <dt><span><samp>quality, deadline (<em>deadline</em>)</samp></span></dt>
  4076. <dd><dl compact="compact">
  4077. <dt><span>&lsquo;<samp>best</samp>&rsquo;</span></dt>
  4078. <dd><p>Use best quality deadline. Poorly named and quite slow, this option should be
  4079. avoided as it may give worse quality output than good.
  4080. </p></dd>
  4081. <dt><span>&lsquo;<samp>good</samp>&rsquo;</span></dt>
  4082. <dd><p>Use good quality deadline. This is a good trade-off between speed and quality
  4083. when used with the <samp>cpu-used</samp> option.
  4084. </p></dd>
  4085. <dt><span>&lsquo;<samp>realtime</samp>&rsquo;</span></dt>
  4086. <dd><p>Use realtime quality deadline.
  4087. </p></dd>
  4088. </dl>
  4089. </dd>
  4090. <dt><span><samp>speed, cpu-used (<em>cpu-used</em>)</samp></span></dt>
  4091. <dd><p>Set quality/speed ratio modifier. Higher values speed up the encode at the cost
  4092. of quality.
  4093. </p>
  4094. </dd>
  4095. <dt><span><samp>nr (<em>noise-sensitivity</em>)</samp></span></dt>
  4096. <dt><span><samp>static-thresh</samp></span></dt>
  4097. <dd><p>Set a change threshold on blocks below which they will be skipped by the
  4098. encoder.
  4099. </p>
  4100. </dd>
  4101. <dt><span><samp>slices (<em>token-parts</em>)</samp></span></dt>
  4102. <dd><p>Note that FFmpeg&rsquo;s <samp>slices</samp> option gives the total number of partitions,
  4103. while <code>vpxenc</code>&rsquo;s <samp>token-parts</samp> is given as
  4104. <code>log2(partitions)</code>.
  4105. </p>
  4106. </dd>
  4107. <dt><span><samp>max-intra-rate</samp></span></dt>
  4108. <dd><p>Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
  4109. means unlimited.
  4110. </p>
  4111. </dd>
  4112. <dt><span><samp>force_key_frames</samp></span></dt>
  4113. <dd><p><code>VPX_EFLAG_FORCE_KF</code>
  4114. </p>
  4115. </dd>
  4116. <dt><span><samp>Alternate reference frame related</samp></span></dt>
  4117. <dd><dl compact="compact">
  4118. <dt><span><samp>auto-alt-ref</samp></span></dt>
  4119. <dd><p>Enable use of alternate reference frames (2-pass only).
  4120. Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
  4121. </p></dd>
  4122. <dt><span><samp>arnr-maxframes</samp></span></dt>
  4123. <dd><p>Set altref noise reduction max frame count.
  4124. </p></dd>
  4125. <dt><span><samp>arnr-type</samp></span></dt>
  4126. <dd><p>Set altref noise reduction filter type: backward, forward, centered.
  4127. </p></dd>
  4128. <dt><span><samp>arnr-strength</samp></span></dt>
  4129. <dd><p>Set altref noise reduction filter strength.
  4130. </p></dd>
  4131. <dt><span><samp>rc-lookahead, lag-in-frames (<em>lag-in-frames</em>)</samp></span></dt>
  4132. <dd><p>Set number of frames to look ahead for frametype and ratecontrol.
  4133. </p></dd>
  4134. </dl>
  4135. </dd>
  4136. <dt><span><samp>error-resilient</samp></span></dt>
  4137. <dd><p>Enable error resiliency features.
  4138. </p>
  4139. </dd>
  4140. <dt><span><samp>sharpness <var>integer</var></samp></span></dt>
  4141. <dd><p>Increase sharpness at the expense of lower PSNR.
  4142. The valid range is [0, 7].
  4143. </p>
  4144. </dd>
  4145. <dt><span><samp>ts-parameters</samp></span></dt>
  4146. <dd><p>Sets the temporal scalability configuration using a :-separated list of
  4147. key=value pairs. For example, to specify temporal scalability parameters
  4148. with <code>ffmpeg</code>:
  4149. </p><div class="example">
  4150. <pre class="example">ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
  4151. ts_target_bitrate=250,500,1000:ts_rate_decimator=4,2,1:\
  4152. ts_periodicity=4:ts_layer_id=0,2,1,2:ts_layering_mode=3 OUTPUT
  4153. </pre></div>
  4154. <p>Below is a brief explanation of each of the parameters, please
  4155. refer to <code>struct vpx_codec_enc_cfg</code> in <code>vpx/vpx_encoder.h</code> for more
  4156. details.
  4157. </p><dl compact="compact">
  4158. <dt><span><samp>ts_number_layers</samp></span></dt>
  4159. <dd><p>Number of temporal coding layers.
  4160. </p></dd>
  4161. <dt><span><samp>ts_target_bitrate</samp></span></dt>
  4162. <dd><p>Target bitrate for each temporal layer (in kbps).
  4163. (bitrate should be inclusive of the lower temporal layer).
  4164. </p></dd>
  4165. <dt><span><samp>ts_rate_decimator</samp></span></dt>
  4166. <dd><p>Frame rate decimation factor for each temporal layer.
  4167. </p></dd>
  4168. <dt><span><samp>ts_periodicity</samp></span></dt>
  4169. <dd><p>Length of the sequence defining frame temporal layer membership.
  4170. </p></dd>
  4171. <dt><span><samp>ts_layer_id</samp></span></dt>
  4172. <dd><p>Template defining the membership of frames to temporal layers.
  4173. </p></dd>
  4174. <dt><span><samp>ts_layering_mode</samp></span></dt>
  4175. <dd><p>(optional) Selecting the temporal structure from a set of pre-defined temporal layering modes.
  4176. Currently supports the following options.
  4177. </p><dl compact="compact">
  4178. <dt><span><samp>0</samp></span></dt>
  4179. <dd><p>No temporal layering flags are provided internally,
  4180. relies on flags being passed in using <code>metadata</code> field in <code>AVFrame</code>
  4181. with following keys.
  4182. </p><dl compact="compact">
  4183. <dt><span><samp>vp8-flags</samp></span></dt>
  4184. <dd><p>Sets the flags passed into the encoder to indicate the referencing scheme for
  4185. the current frame.
  4186. Refer to function <code>vpx_codec_encode</code> in <code>vpx/vpx_encoder.h</code> for more
  4187. details.
  4188. </p></dd>
  4189. <dt><span><samp>temporal_id</samp></span></dt>
  4190. <dd><p>Explicitly sets the temporal id of the current frame to encode.
  4191. </p></dd>
  4192. </dl>
  4193. </dd>
  4194. <dt><span><samp>2</samp></span></dt>
  4195. <dd><p>Two temporal layers. 0-1...
  4196. </p></dd>
  4197. <dt><span><samp>3</samp></span></dt>
  4198. <dd><p>Three temporal layers. 0-2-1-2...; with single reference frame.
  4199. </p></dd>
  4200. <dt><span><samp>4</samp></span></dt>
  4201. <dd><p>Same as option &quot;3&quot;, except there is a dependency between
  4202. the two temporal layer 2 frames within the temporal period.
  4203. </p></dd>
  4204. </dl>
  4205. </dd>
  4206. </dl>
  4207. </dd>
  4208. <dt><span><samp>VP9-specific options</samp></span></dt>
  4209. <dd><dl compact="compact">
  4210. <dt><span><samp>lossless</samp></span></dt>
  4211. <dd><p>Enable lossless mode.
  4212. </p></dd>
  4213. <dt><span><samp>tile-columns</samp></span></dt>
  4214. <dd><p>Set number of tile columns to use. Note this is given as
  4215. <code>log2(tile_columns)</code>. For example, 8 tile columns would be requested by
  4216. setting the <samp>tile-columns</samp> option to 3.
  4217. </p></dd>
  4218. <dt><span><samp>tile-rows</samp></span></dt>
  4219. <dd><p>Set number of tile rows to use. Note this is given as <code>log2(tile_rows)</code>.
  4220. For example, 4 tile rows would be requested by setting the <samp>tile-rows</samp>
  4221. option to 2.
  4222. </p></dd>
  4223. <dt><span><samp>frame-parallel</samp></span></dt>
  4224. <dd><p>Enable frame parallel decodability features.
  4225. </p></dd>
  4226. <dt><span><samp>aq-mode</samp></span></dt>
  4227. <dd><p>Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
  4228. cyclic refresh, 4: equator360).
  4229. </p></dd>
  4230. <dt><span><samp>colorspace <em>color-space</em></samp></span></dt>
  4231. <dd><p>Set input color space. The VP9 bitstream supports signaling the following
  4232. colorspaces:
  4233. </p><dl compact="compact">
  4234. <dt><span><samp>&lsquo;<samp>rgb</samp>&rsquo; <em>sRGB</em></samp></span></dt>
  4235. <dt><span><samp>&lsquo;<samp>bt709</samp>&rsquo; <em>bt709</em></samp></span></dt>
  4236. <dt><span><samp>&lsquo;<samp>unspecified</samp>&rsquo; <em>unknown</em></samp></span></dt>
  4237. <dt><span><samp>&lsquo;<samp>bt470bg</samp>&rsquo; <em>bt601</em></samp></span></dt>
  4238. <dt><span><samp>&lsquo;<samp>smpte170m</samp>&rsquo; <em>smpte170</em></samp></span></dt>
  4239. <dt><span><samp>&lsquo;<samp>smpte240m</samp>&rsquo; <em>smpte240</em></samp></span></dt>
  4240. <dt><span><samp>&lsquo;<samp>bt2020_ncl</samp>&rsquo; <em>bt2020</em></samp></span></dt>
  4241. </dl>
  4242. </dd>
  4243. <dt><span><samp>row-mt <var>boolean</var></samp></span></dt>
  4244. <dd><p>Enable row based multi-threading.
  4245. </p></dd>
  4246. <dt><span><samp>tune-content</samp></span></dt>
  4247. <dd><p>Set content type: default (0), screen (1), film (2).
  4248. </p></dd>
  4249. <dt><span><samp>corpus-complexity</samp></span></dt>
  4250. <dd><p>Corpus VBR mode is a variant of standard VBR where the complexity distribution
  4251. midpoint is passed in rather than calculated for a specific clip or chunk.
  4252. </p>
  4253. <p>The valid range is [0, 10000]. 0 (default) uses standard VBR.
  4254. </p></dd>
  4255. <dt><span><samp>enable-tpl <var>boolean</var></samp></span></dt>
  4256. <dd><p>Enable temporal dependency model.
  4257. </p></dd>
  4258. <dt><span><samp>ref-frame-config</samp></span></dt>
  4259. <dd><p>Using per-frame metadata, set members of the structure <code>vpx_svc_ref_frame_config_t</code> in <code>vpx/vp8cx.h</code> to fine-control referencing schemes and frame buffer management.
  4260. <br>Use a :-separated list of key=value pairs.
  4261. For example,
  4262. </p><div class="example">
  4263. <pre class="example">av_dict_set(&amp;av_frame-&gt;metadata, &quot;ref-frame-config&quot;, \
  4264. &quot;rfc_update_buffer_slot=7:rfc_lst_fb_idx=0:rfc_gld_fb_idx=1:rfc_alt_fb_idx=2:rfc_reference_last=0:rfc_reference_golden=0:rfc_reference_alt_ref=0&quot;);
  4265. </pre></div>
  4266. <dl compact="compact">
  4267. <dt><span><samp>rfc_update_buffer_slot</samp></span></dt>
  4268. <dd><p>Indicates the buffer slot number to update
  4269. </p></dd>
  4270. <dt><span><samp>rfc_update_last</samp></span></dt>
  4271. <dd><p>Indicates whether to update the LAST frame
  4272. </p></dd>
  4273. <dt><span><samp>rfc_update_golden</samp></span></dt>
  4274. <dd><p>Indicates whether to update GOLDEN frame
  4275. </p></dd>
  4276. <dt><span><samp>rfc_update_alt_ref</samp></span></dt>
  4277. <dd><p>Indicates whether to update ALT_REF frame
  4278. </p></dd>
  4279. <dt><span><samp>rfc_lst_fb_idx</samp></span></dt>
  4280. <dd><p>LAST frame buffer index
  4281. </p></dd>
  4282. <dt><span><samp>rfc_gld_fb_idx</samp></span></dt>
  4283. <dd><p>GOLDEN frame buffer index
  4284. </p></dd>
  4285. <dt><span><samp>rfc_alt_fb_idx</samp></span></dt>
  4286. <dd><p>ALT_REF frame buffer index
  4287. </p></dd>
  4288. <dt><span><samp>rfc_reference_last</samp></span></dt>
  4289. <dd><p>Indicates whether to reference LAST frame
  4290. </p></dd>
  4291. <dt><span><samp>rfc_reference_golden</samp></span></dt>
  4292. <dd><p>Indicates whether to reference GOLDEN frame
  4293. </p></dd>
  4294. <dt><span><samp>rfc_reference_alt_ref</samp></span></dt>
  4295. <dd><p>Indicates whether to reference ALT_REF frame
  4296. </p></dd>
  4297. <dt><span><samp>rfc_reference_duration</samp></span></dt>
  4298. <dd><p>Indicates frame duration
  4299. </p></dd>
  4300. </dl>
  4301. </dd>
  4302. </dl>
  4303. </dd>
  4304. </dl>
  4305. <p>For more information about libvpx see:
  4306. <a href="http://www.webmproject.org/">http://www.webmproject.org/</a>
  4307. </p>
  4308. <a name="libwebp"></a>
  4309. <h3 class="section">9.11 libwebp<span class="pull-right"><a class="anchor hidden-xs" href="#libwebp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libwebp" aria-hidden="true">TOC</a></span></h3>
  4310. <p>libwebp WebP Image encoder wrapper
  4311. </p>
  4312. <p>libwebp is Google&rsquo;s official encoder for WebP images. It can encode in either
  4313. lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
  4314. frame. Lossless images are a separate codec developed by Google.
  4315. </p>
  4316. <a name="Pixel-Format"></a>
  4317. <h4 class="subsection">9.11.1 Pixel Format<span class="pull-right"><a class="anchor hidden-xs" href="#Pixel-Format" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Pixel-Format" aria-hidden="true">TOC</a></span></h4>
  4318. <p>Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
  4319. to limitations of the format and libwebp. Alpha is supported for either mode.
  4320. Because of API limitations, if RGB is passed in when encoding lossy or YUV is
  4321. passed in for encoding lossless, the pixel format will automatically be
  4322. converted using functions from libwebp. This is not ideal and is done only for
  4323. convenience.
  4324. </p>
  4325. <a name="Options-30"></a>
  4326. <h4 class="subsection">9.11.2 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-30" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-30" aria-hidden="true">TOC</a></span></h4>
  4327. <dl compact="compact">
  4328. <dt><span><samp>-lossless <var>boolean</var></samp></span></dt>
  4329. <dd><p>Enables/Disables use of lossless mode. Default is 0.
  4330. </p>
  4331. </dd>
  4332. <dt><span><samp>-compression_level <var>integer</var></samp></span></dt>
  4333. <dd><p>For lossy, this is a quality/speed tradeoff. Higher values give better quality
  4334. for a given size at the cost of increased encoding time. For lossless, this is
  4335. a size/speed tradeoff. Higher values give smaller size at the cost of increased
  4336. encoding time. More specifically, it controls the number of extra algorithms
  4337. and compression tools used, and varies the combination of these tools. This
  4338. maps to the <var>method</var> option in libwebp. The valid range is 0 to 6.
  4339. Default is 4.
  4340. </p>
  4341. </dd>
  4342. <dt><span><samp>-qscale <var>float</var></samp></span></dt>
  4343. <dd><p>For lossy encoding, this controls image quality, 0 to 100. For lossless
  4344. encoding, this controls the effort and time spent at compressing more. The
  4345. default value is 75. Note that for usage via libavcodec, this option is called
  4346. <var>global_quality</var> and must be multiplied by <var>FF_QP2LAMBDA</var>.
  4347. </p>
  4348. </dd>
  4349. <dt><span><samp>-preset <var>type</var></samp></span></dt>
  4350. <dd><p>Configuration preset. This does some automatic settings based on the general
  4351. type of the image.
  4352. </p><dl compact="compact">
  4353. <dt><span><samp>none</samp></span></dt>
  4354. <dd><p>Do not use a preset.
  4355. </p></dd>
  4356. <dt><span><samp>default</samp></span></dt>
  4357. <dd><p>Use the encoder default.
  4358. </p></dd>
  4359. <dt><span><samp>picture</samp></span></dt>
  4360. <dd><p>Digital picture, like portrait, inner shot
  4361. </p></dd>
  4362. <dt><span><samp>photo</samp></span></dt>
  4363. <dd><p>Outdoor photograph, with natural lighting
  4364. </p></dd>
  4365. <dt><span><samp>drawing</samp></span></dt>
  4366. <dd><p>Hand or line drawing, with high-contrast details
  4367. </p></dd>
  4368. <dt><span><samp>icon</samp></span></dt>
  4369. <dd><p>Small-sized colorful images
  4370. </p></dd>
  4371. <dt><span><samp>text</samp></span></dt>
  4372. <dd><p>Text-like
  4373. </p></dd>
  4374. </dl>
  4375. </dd>
  4376. </dl>
  4377. <a name="libx264_002c-libx264rgb"></a>
  4378. <h3 class="section">9.12 libx264, libx264rgb<span class="pull-right"><a class="anchor hidden-xs" href="#libx264_002c-libx264rgb" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libx264_002c-libx264rgb" aria-hidden="true">TOC</a></span></h3>
  4379. <p>x264 H.264/MPEG-4 AVC encoder wrapper.
  4380. </p>
  4381. <p>This encoder requires the presence of the libx264 headers and library
  4382. during configuration. You need to explicitly configure the build with
  4383. <code>--enable-libx264</code>.
  4384. </p>
  4385. <p>libx264 supports an impressive number of features, including 8x8 and
  4386. 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
  4387. entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
  4388. for detail retention (adaptive quantization, psy-RD, psy-trellis).
  4389. </p>
  4390. <p>Many libx264 encoder options are mapped to FFmpeg global codec
  4391. options, while unique encoder options are provided through private
  4392. options. Additionally the <samp>x264opts</samp> and <samp>x264-params</samp>
  4393. private options allows one to pass a list of key=value tuples as accepted
  4394. by the libx264 <code>x264_param_parse</code> function.
  4395. </p>
  4396. <p>The x264 project website is at
  4397. <a href="http://www.videolan.org/developers/x264.html">http://www.videolan.org/developers/x264.html</a>.
  4398. </p>
  4399. <p>The libx264rgb encoder is the same as libx264, except it accepts packed RGB
  4400. pixel formats as input instead of YUV.
  4401. </p>
  4402. <a name="Supported-Pixel-Formats"></a>
  4403. <h4 class="subsection">9.12.1 Supported Pixel Formats<span class="pull-right"><a class="anchor hidden-xs" href="#Supported-Pixel-Formats" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Supported-Pixel-Formats" aria-hidden="true">TOC</a></span></h4>
  4404. <p>x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
  4405. x264&rsquo;s configure time.
  4406. </p>
  4407. <a name="Options-31"></a>
  4408. <h4 class="subsection">9.12.2 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-31" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-31" aria-hidden="true">TOC</a></span></h4>
  4409. <p>The following options are supported by the libx264 wrapper. The
  4410. <code>x264</code>-equivalent options or values are listed in parentheses
  4411. for easy migration.
  4412. </p>
  4413. <p>To reduce the duplication of documentation, only the private options
  4414. and some others requiring special attention are documented here. For
  4415. the documentation of the undocumented generic options, see
  4416. <a href="#codec_002doptions">the Codec Options chapter</a>.
  4417. </p>
  4418. <p>To get a more accurate and extensive documentation of the libx264
  4419. options, invoke the command <code>x264 --fullhelp</code> or consult
  4420. the libx264 documentation.
  4421. </p>
  4422. <dl compact="compact">
  4423. <dt><span><samp>b (<em>bitrate</em>)</samp></span></dt>
  4424. <dd><p>Set bitrate in bits/s. Note that FFmpeg&rsquo;s <samp>b</samp> option is
  4425. expressed in bits/s, while <code>x264</code>&rsquo;s <samp>bitrate</samp> is in
  4426. kilobits/s.
  4427. </p>
  4428. </dd>
  4429. <dt><span><samp>bf (<em>bframes</em>)</samp></span></dt>
  4430. <dt><span><samp>g (<em>keyint</em>)</samp></span></dt>
  4431. <dt><span><samp>qmin (<em>qpmin</em>)</samp></span></dt>
  4432. <dd><p>Minimum quantizer scale.
  4433. </p>
  4434. </dd>
  4435. <dt><span><samp>qmax (<em>qpmax</em>)</samp></span></dt>
  4436. <dd><p>Maximum quantizer scale.
  4437. </p>
  4438. </dd>
  4439. <dt><span><samp>qdiff (<em>qpstep</em>)</samp></span></dt>
  4440. <dd><p>Maximum difference between quantizer scales.
  4441. </p>
  4442. </dd>
  4443. <dt><span><samp>qblur (<em>qblur</em>)</samp></span></dt>
  4444. <dd><p>Quantizer curve blur
  4445. </p>
  4446. </dd>
  4447. <dt><span><samp>qcomp (<em>qcomp</em>)</samp></span></dt>
  4448. <dd><p>Quantizer curve compression factor
  4449. </p>
  4450. </dd>
  4451. <dt><span><samp>refs (<em>ref</em>)</samp></span></dt>
  4452. <dd><p>Number of reference frames each P-frame can use. The range is from <var>0-16</var>.
  4453. </p>
  4454. </dd>
  4455. <dt><span><samp>sc_threshold (<em>scenecut</em>)</samp></span></dt>
  4456. <dd><p>Sets the threshold for the scene change detection.
  4457. </p>
  4458. </dd>
  4459. <dt><span><samp>trellis (<em>trellis</em>)</samp></span></dt>
  4460. <dd><p>Performs Trellis quantization to increase efficiency. Enabled by default.
  4461. </p>
  4462. </dd>
  4463. <dt><span><samp>nr (<em>nr</em>)</samp></span></dt>
  4464. <dt><span><samp>me_range (<em>merange</em>)</samp></span></dt>
  4465. <dd><p>Maximum range of the motion search in pixels.
  4466. </p>
  4467. </dd>
  4468. <dt><span><samp>me_method (<em>me</em>)</samp></span></dt>
  4469. <dd><p>Set motion estimation method. Possible values in the decreasing order
  4470. of speed:
  4471. </p>
  4472. <dl compact="compact">
  4473. <dt><span>&lsquo;<samp>dia (<em>dia</em>)</samp>&rsquo;</span></dt>
  4474. <dt><span>&lsquo;<samp>epzs (<em>dia</em>)</samp>&rsquo;</span></dt>
  4475. <dd><p>Diamond search with radius 1 (fastest). &lsquo;<samp>epzs</samp>&rsquo; is an alias for
  4476. &lsquo;<samp>dia</samp>&rsquo;.
  4477. </p></dd>
  4478. <dt><span>&lsquo;<samp>hex (<em>hex</em>)</samp>&rsquo;</span></dt>
  4479. <dd><p>Hexagonal search with radius 2.
  4480. </p></dd>
  4481. <dt><span>&lsquo;<samp>umh (<em>umh</em>)</samp>&rsquo;</span></dt>
  4482. <dd><p>Uneven multi-hexagon search.
  4483. </p></dd>
  4484. <dt><span>&lsquo;<samp>esa (<em>esa</em>)</samp>&rsquo;</span></dt>
  4485. <dd><p>Exhaustive search.
  4486. </p></dd>
  4487. <dt><span>&lsquo;<samp>tesa (<em>tesa</em>)</samp>&rsquo;</span></dt>
  4488. <dd><p>Hadamard exhaustive search (slowest).
  4489. </p></dd>
  4490. </dl>
  4491. </dd>
  4492. <dt><span><samp>forced-idr</samp></span></dt>
  4493. <dd><p>Normally, when forcing a I-frame type, the encoder can select any type
  4494. of I-frame. This option forces it to choose an IDR-frame.
  4495. </p>
  4496. </dd>
  4497. <dt><span><samp>subq (<em>subme</em>)</samp></span></dt>
  4498. <dd><p>Sub-pixel motion estimation method.
  4499. </p>
  4500. </dd>
  4501. <dt><span><samp>b_strategy (<em>b-adapt</em>)</samp></span></dt>
  4502. <dd><p>Adaptive B-frame placement decision algorithm. Use only on first-pass.
  4503. </p>
  4504. </dd>
  4505. <dt><span><samp>keyint_min (<em>min-keyint</em>)</samp></span></dt>
  4506. <dd><p>Minimum GOP size.
  4507. </p>
  4508. </dd>
  4509. <dt><span><samp>coder</samp></span></dt>
  4510. <dd><p>Set entropy encoder. Possible values:
  4511. </p>
  4512. <dl compact="compact">
  4513. <dt><span>&lsquo;<samp>ac</samp>&rsquo;</span></dt>
  4514. <dd><p>Enable CABAC.
  4515. </p>
  4516. </dd>
  4517. <dt><span>&lsquo;<samp>vlc</samp>&rsquo;</span></dt>
  4518. <dd><p>Enable CAVLC and disable CABAC. It generates the same effect as
  4519. <code>x264</code>&rsquo;s <samp>--no-cabac</samp> option.
  4520. </p></dd>
  4521. </dl>
  4522. </dd>
  4523. <dt><span><samp>cmp</samp></span></dt>
  4524. <dd><p>Set full pixel motion estimation comparison algorithm. Possible values:
  4525. </p>
  4526. <dl compact="compact">
  4527. <dt><span>&lsquo;<samp>chroma</samp>&rsquo;</span></dt>
  4528. <dd><p>Enable chroma in motion estimation.
  4529. </p>
  4530. </dd>
  4531. <dt><span>&lsquo;<samp>sad</samp>&rsquo;</span></dt>
  4532. <dd><p>Ignore chroma in motion estimation. It generates the same effect as
  4533. <code>x264</code>&rsquo;s <samp>--no-chroma-me</samp> option.
  4534. </p></dd>
  4535. </dl>
  4536. </dd>
  4537. <dt><span><samp>threads (<em>threads</em>)</samp></span></dt>
  4538. <dd><p>Number of encoding threads.
  4539. </p>
  4540. </dd>
  4541. <dt><span><samp>thread_type</samp></span></dt>
  4542. <dd><p>Set multithreading technique. Possible values:
  4543. </p>
  4544. <dl compact="compact">
  4545. <dt><span>&lsquo;<samp>slice</samp>&rsquo;</span></dt>
  4546. <dd><p>Slice-based multithreading. It generates the same effect as
  4547. <code>x264</code>&rsquo;s <samp>--sliced-threads</samp> option.
  4548. </p></dd>
  4549. <dt><span>&lsquo;<samp>frame</samp>&rsquo;</span></dt>
  4550. <dd><p>Frame-based multithreading.
  4551. </p></dd>
  4552. </dl>
  4553. </dd>
  4554. <dt><span><samp>flags</samp></span></dt>
  4555. <dd><p>Set encoding flags. It can be used to disable closed GOP and enable
  4556. open GOP by setting it to <code>-cgop</code>. The result is similar to
  4557. the behavior of <code>x264</code>&rsquo;s <samp>--open-gop</samp> option.
  4558. </p>
  4559. </dd>
  4560. <dt><span><samp>rc_init_occupancy (<em>vbv-init</em>)</samp></span></dt>
  4561. <dt><span><samp>preset (<em>preset</em>)</samp></span></dt>
  4562. <dd><p>Set the encoding preset.
  4563. </p>
  4564. </dd>
  4565. <dt><span><samp>tune (<em>tune</em>)</samp></span></dt>
  4566. <dd><p>Set tuning of the encoding params.
  4567. </p>
  4568. </dd>
  4569. <dt><span><samp>profile (<em>profile</em>)</samp></span></dt>
  4570. <dd><p>Set profile restrictions.
  4571. </p>
  4572. </dd>
  4573. <dt><span><samp>fastfirstpass</samp></span></dt>
  4574. <dd><p>Enable fast settings when encoding first pass, when set to 1. When set
  4575. to 0, it has the same effect of <code>x264</code>&rsquo;s
  4576. <samp>--slow-firstpass</samp> option.
  4577. </p>
  4578. </dd>
  4579. <dt><span><samp>crf (<em>crf</em>)</samp></span></dt>
  4580. <dd><p>Set the quality for constant quality mode.
  4581. </p>
  4582. </dd>
  4583. <dt><span><samp>crf_max (<em>crf-max</em>)</samp></span></dt>
  4584. <dd><p>In CRF mode, prevents VBV from lowering quality beyond this point.
  4585. </p>
  4586. </dd>
  4587. <dt><span><samp>qp (<em>qp</em>)</samp></span></dt>
  4588. <dd><p>Set constant quantization rate control method parameter.
  4589. </p>
  4590. </dd>
  4591. <dt><span><samp>aq-mode (<em>aq-mode</em>)</samp></span></dt>
  4592. <dd><p>Set AQ method. Possible values:
  4593. </p>
  4594. <dl compact="compact">
  4595. <dt><span>&lsquo;<samp>none (<em>0</em>)</samp>&rsquo;</span></dt>
  4596. <dd><p>Disabled.
  4597. </p>
  4598. </dd>
  4599. <dt><span>&lsquo;<samp>variance (<em>1</em>)</samp>&rsquo;</span></dt>
  4600. <dd><p>Variance AQ (complexity mask).
  4601. </p>
  4602. </dd>
  4603. <dt><span>&lsquo;<samp>autovariance (<em>2</em>)</samp>&rsquo;</span></dt>
  4604. <dd><p>Auto-variance AQ (experimental).
  4605. </p></dd>
  4606. </dl>
  4607. </dd>
  4608. <dt><span><samp>aq-strength (<em>aq-strength</em>)</samp></span></dt>
  4609. <dd><p>Set AQ strength, reduce blocking and blurring in flat and textured areas.
  4610. </p>
  4611. </dd>
  4612. <dt><span><samp>psy</samp></span></dt>
  4613. <dd><p>Use psychovisual optimizations when set to 1. When set to 0, it has the
  4614. same effect as <code>x264</code>&rsquo;s <samp>--no-psy</samp> option.
  4615. </p>
  4616. </dd>
  4617. <dt><span><samp>psy-rd (<em>psy-rd</em>)</samp></span></dt>
  4618. <dd><p>Set strength of psychovisual optimization, in
  4619. <var>psy-rd</var>:<var>psy-trellis</var> format.
  4620. </p>
  4621. </dd>
  4622. <dt><span><samp>rc-lookahead (<em>rc-lookahead</em>)</samp></span></dt>
  4623. <dd><p>Set number of frames to look ahead for frametype and ratecontrol.
  4624. </p>
  4625. </dd>
  4626. <dt><span><samp>weightb</samp></span></dt>
  4627. <dd><p>Enable weighted prediction for B-frames when set to 1. When set to 0,
  4628. it has the same effect as <code>x264</code>&rsquo;s <samp>--no-weightb</samp> option.
  4629. </p>
  4630. </dd>
  4631. <dt><span><samp>weightp (<em>weightp</em>)</samp></span></dt>
  4632. <dd><p>Set weighted prediction method for P-frames. Possible values:
  4633. </p>
  4634. <dl compact="compact">
  4635. <dt><span>&lsquo;<samp>none (<em>0</em>)</samp>&rsquo;</span></dt>
  4636. <dd><p>Disabled
  4637. </p></dd>
  4638. <dt><span>&lsquo;<samp>simple (<em>1</em>)</samp>&rsquo;</span></dt>
  4639. <dd><p>Enable only weighted refs
  4640. </p></dd>
  4641. <dt><span>&lsquo;<samp>smart (<em>2</em>)</samp>&rsquo;</span></dt>
  4642. <dd><p>Enable both weighted refs and duplicates
  4643. </p></dd>
  4644. </dl>
  4645. </dd>
  4646. <dt><span><samp>ssim (<em>ssim</em>)</samp></span></dt>
  4647. <dd><p>Enable calculation and printing SSIM stats after the encoding.
  4648. </p>
  4649. </dd>
  4650. <dt><span><samp>intra-refresh (<em>intra-refresh</em>)</samp></span></dt>
  4651. <dd><p>Enable the use of Periodic Intra Refresh instead of IDR frames when set
  4652. to 1.
  4653. </p>
  4654. </dd>
  4655. <dt><span><samp>avcintra-class (<em>class</em>)</samp></span></dt>
  4656. <dd><p>Configure the encoder to generate AVC-Intra.
  4657. Valid values are 50,100 and 200
  4658. </p>
  4659. </dd>
  4660. <dt><span><samp>bluray-compat (<em>bluray-compat</em>)</samp></span></dt>
  4661. <dd><p>Configure the encoder to be compatible with the bluray standard.
  4662. It is a shorthand for setting &quot;bluray-compat=1 force-cfr=1&quot;.
  4663. </p>
  4664. </dd>
  4665. <dt><span><samp>b-bias (<em>b-bias</em>)</samp></span></dt>
  4666. <dd><p>Set the influence on how often B-frames are used.
  4667. </p>
  4668. </dd>
  4669. <dt><span><samp>b-pyramid (<em>b-pyramid</em>)</samp></span></dt>
  4670. <dd><p>Set method for keeping of some B-frames as references. Possible values:
  4671. </p>
  4672. <dl compact="compact">
  4673. <dt><span>&lsquo;<samp>none (<em>none</em>)</samp>&rsquo;</span></dt>
  4674. <dd><p>Disabled.
  4675. </p></dd>
  4676. <dt><span>&lsquo;<samp>strict (<em>strict</em>)</samp>&rsquo;</span></dt>
  4677. <dd><p>Strictly hierarchical pyramid.
  4678. </p></dd>
  4679. <dt><span>&lsquo;<samp>normal (<em>normal</em>)</samp>&rsquo;</span></dt>
  4680. <dd><p>Non-strict (not Blu-ray compatible).
  4681. </p></dd>
  4682. </dl>
  4683. </dd>
  4684. <dt><span><samp>mixed-refs</samp></span></dt>
  4685. <dd><p>Enable the use of one reference per partition, as opposed to one
  4686. reference per macroblock when set to 1. When set to 0, it has the
  4687. same effect as <code>x264</code>&rsquo;s <samp>--no-mixed-refs</samp> option.
  4688. </p>
  4689. </dd>
  4690. <dt><span><samp>8x8dct</samp></span></dt>
  4691. <dd><p>Enable adaptive spatial transform (high profile 8x8 transform)
  4692. when set to 1. When set to 0, it has the same effect as
  4693. <code>x264</code>&rsquo;s <samp>--no-8x8dct</samp> option.
  4694. </p>
  4695. </dd>
  4696. <dt><span><samp>fast-pskip</samp></span></dt>
  4697. <dd><p>Enable early SKIP detection on P-frames when set to 1. When set
  4698. to 0, it has the same effect as <code>x264</code>&rsquo;s
  4699. <samp>--no-fast-pskip</samp> option.
  4700. </p>
  4701. </dd>
  4702. <dt><span><samp>aud (<em>aud</em>)</samp></span></dt>
  4703. <dd><p>Enable use of access unit delimiters when set to 1.
  4704. </p>
  4705. </dd>
  4706. <dt><span><samp>mbtree</samp></span></dt>
  4707. <dd><p>Enable use macroblock tree ratecontrol when set to 1. When set
  4708. to 0, it has the same effect as <code>x264</code>&rsquo;s
  4709. <samp>--no-mbtree</samp> option.
  4710. </p>
  4711. </dd>
  4712. <dt><span><samp>deblock (<em>deblock</em>)</samp></span></dt>
  4713. <dd><p>Set loop filter parameters, in <var>alpha</var>:<var>beta</var> form.
  4714. </p>
  4715. </dd>
  4716. <dt><span><samp>cplxblur (<em>cplxblur</em>)</samp></span></dt>
  4717. <dd><p>Set fluctuations reduction in QP (before curve compression).
  4718. </p>
  4719. </dd>
  4720. <dt><span><samp>partitions (<em>partitions</em>)</samp></span></dt>
  4721. <dd><p>Set partitions to consider as a comma-separated list of. Possible
  4722. values in the list:
  4723. </p>
  4724. <dl compact="compact">
  4725. <dt><span>&lsquo;<samp>p8x8</samp>&rsquo;</span></dt>
  4726. <dd><p>8x8 P-frame partition.
  4727. </p></dd>
  4728. <dt><span>&lsquo;<samp>p4x4</samp>&rsquo;</span></dt>
  4729. <dd><p>4x4 P-frame partition.
  4730. </p></dd>
  4731. <dt><span>&lsquo;<samp>b8x8</samp>&rsquo;</span></dt>
  4732. <dd><p>4x4 B-frame partition.
  4733. </p></dd>
  4734. <dt><span>&lsquo;<samp>i8x8</samp>&rsquo;</span></dt>
  4735. <dd><p>8x8 I-frame partition.
  4736. </p></dd>
  4737. <dt><span>&lsquo;<samp>i4x4</samp>&rsquo;</span></dt>
  4738. <dd><p>4x4 I-frame partition.
  4739. (Enabling &lsquo;<samp>p4x4</samp>&rsquo; requires &lsquo;<samp>p8x8</samp>&rsquo; to be enabled. Enabling
  4740. &lsquo;<samp>i8x8</samp>&rsquo; requires adaptive spatial transform (<samp>8x8dct</samp>
  4741. option) to be enabled.)
  4742. </p></dd>
  4743. <dt><span>&lsquo;<samp>none (<em>none</em>)</samp>&rsquo;</span></dt>
  4744. <dd><p>Do not consider any partitions.
  4745. </p></dd>
  4746. <dt><span>&lsquo;<samp>all (<em>all</em>)</samp>&rsquo;</span></dt>
  4747. <dd><p>Consider every partition.
  4748. </p></dd>
  4749. </dl>
  4750. </dd>
  4751. <dt><span><samp>direct-pred (<em>direct</em>)</samp></span></dt>
  4752. <dd><p>Set direct MV prediction mode. Possible values:
  4753. </p>
  4754. <dl compact="compact">
  4755. <dt><span>&lsquo;<samp>none (<em>none</em>)</samp>&rsquo;</span></dt>
  4756. <dd><p>Disable MV prediction.
  4757. </p></dd>
  4758. <dt><span>&lsquo;<samp>spatial (<em>spatial</em>)</samp>&rsquo;</span></dt>
  4759. <dd><p>Enable spatial predicting.
  4760. </p></dd>
  4761. <dt><span>&lsquo;<samp>temporal (<em>temporal</em>)</samp>&rsquo;</span></dt>
  4762. <dd><p>Enable temporal predicting.
  4763. </p></dd>
  4764. <dt><span>&lsquo;<samp>auto (<em>auto</em>)</samp>&rsquo;</span></dt>
  4765. <dd><p>Automatically decided.
  4766. </p></dd>
  4767. </dl>
  4768. </dd>
  4769. <dt><span><samp>slice-max-size (<em>slice-max-size</em>)</samp></span></dt>
  4770. <dd><p>Set the limit of the size of each slice in bytes. If not specified
  4771. but RTP payload size (<samp>ps</samp>) is specified, that is used.
  4772. </p>
  4773. </dd>
  4774. <dt><span><samp>stats (<em>stats</em>)</samp></span></dt>
  4775. <dd><p>Set the file name for multi-pass stats.
  4776. </p>
  4777. </dd>
  4778. <dt><span><samp>nal-hrd (<em>nal-hrd</em>)</samp></span></dt>
  4779. <dd><p>Set signal HRD information (requires <samp>vbv-bufsize</samp> to be set).
  4780. Possible values:
  4781. </p>
  4782. <dl compact="compact">
  4783. <dt><span>&lsquo;<samp>none (<em>none</em>)</samp>&rsquo;</span></dt>
  4784. <dd><p>Disable HRD information signaling.
  4785. </p></dd>
  4786. <dt><span>&lsquo;<samp>vbr (<em>vbr</em>)</samp>&rsquo;</span></dt>
  4787. <dd><p>Variable bit rate.
  4788. </p></dd>
  4789. <dt><span>&lsquo;<samp>cbr (<em>cbr</em>)</samp>&rsquo;</span></dt>
  4790. <dd><p>Constant bit rate (not allowed in MP4 container).
  4791. </p></dd>
  4792. </dl>
  4793. </dd>
  4794. <dt><span><samp>x264opts (N.A.)</samp></span></dt>
  4795. <dd><p>Set any x264 option, see <code>x264 --fullhelp</code> for a list.
  4796. </p>
  4797. <p>Argument is a list of <var>key</var>=<var>value</var> couples separated by
  4798. &quot;:&quot;. In <var>filter</var> and <var>psy-rd</var> options that use &quot;:&quot; as a separator
  4799. themselves, use &quot;,&quot; instead. They accept it as well since long ago but this
  4800. is kept undocumented for some reason.
  4801. </p>
  4802. <p>For example to specify libx264 encoding options with <code>ffmpeg</code>:
  4803. </p><div class="example">
  4804. <pre class="example">ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
  4805. </pre></div>
  4806. </dd>
  4807. <dt><span><samp>a53cc <var>boolean</var></samp></span></dt>
  4808. <dd><p>Import closed captions (which must be ATSC compatible format) into output.
  4809. Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
  4810. </p>
  4811. </dd>
  4812. <dt><span><samp>x264-params (N.A.)</samp></span></dt>
  4813. <dd><p>Override the x264 configuration using a :-separated list of key=value
  4814. parameters.
  4815. </p>
  4816. <p>This option is functionally the same as the <samp>x264opts</samp>, but is
  4817. duplicated for compatibility with the Libav fork.
  4818. </p>
  4819. <p>For example to specify libx264 encoding options with <code>ffmpeg</code>:
  4820. </p><div class="example">
  4821. <pre class="example">ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
  4822. cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
  4823. no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
  4824. </pre></div>
  4825. </dd>
  4826. </dl>
  4827. <p>Encoding ffpresets for common usages are provided so they can be used with the
  4828. general presets system (e.g. passing the <samp>pre</samp> option).
  4829. </p>
  4830. <a name="libx265"></a>
  4831. <h3 class="section">9.13 libx265<span class="pull-right"><a class="anchor hidden-xs" href="#libx265" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libx265" aria-hidden="true">TOC</a></span></h3>
  4832. <p>x265 H.265/HEVC encoder wrapper.
  4833. </p>
  4834. <p>This encoder requires the presence of the libx265 headers and library
  4835. during configuration. You need to explicitly configure the build with
  4836. <samp>--enable-libx265</samp>.
  4837. </p>
  4838. <a name="Options-32"></a>
  4839. <h4 class="subsection">9.13.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-32" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-32" aria-hidden="true">TOC</a></span></h4>
  4840. <dl compact="compact">
  4841. <dt><span><samp>b</samp></span></dt>
  4842. <dd><p>Sets target video bitrate.
  4843. </p>
  4844. </dd>
  4845. <dt><span><samp>bf</samp></span></dt>
  4846. <dt><span><samp>g</samp></span></dt>
  4847. <dd><p>Set the GOP size.
  4848. </p>
  4849. </dd>
  4850. <dt><span><samp>keyint_min</samp></span></dt>
  4851. <dd><p>Minimum GOP size.
  4852. </p>
  4853. </dd>
  4854. <dt><span><samp>refs</samp></span></dt>
  4855. <dd><p>Number of reference frames each P-frame can use. The range is from <var>1-16</var>.
  4856. </p>
  4857. </dd>
  4858. <dt><span><samp>preset</samp></span></dt>
  4859. <dd><p>Set the x265 preset.
  4860. </p>
  4861. </dd>
  4862. <dt><span><samp>tune</samp></span></dt>
  4863. <dd><p>Set the x265 tune parameter.
  4864. </p>
  4865. </dd>
  4866. <dt><span><samp>profile</samp></span></dt>
  4867. <dd><p>Set profile restrictions.
  4868. </p>
  4869. </dd>
  4870. <dt><span><samp>crf</samp></span></dt>
  4871. <dd><p>Set the quality for constant quality mode.
  4872. </p>
  4873. </dd>
  4874. <dt><span><samp>qp</samp></span></dt>
  4875. <dd><p>Set constant quantization rate control method parameter.
  4876. </p>
  4877. </dd>
  4878. <dt><span><samp>qmin</samp></span></dt>
  4879. <dd><p>Minimum quantizer scale.
  4880. </p>
  4881. </dd>
  4882. <dt><span><samp>qmax</samp></span></dt>
  4883. <dd><p>Maximum quantizer scale.
  4884. </p>
  4885. </dd>
  4886. <dt><span><samp>qdiff</samp></span></dt>
  4887. <dd><p>Maximum difference between quantizer scales.
  4888. </p>
  4889. </dd>
  4890. <dt><span><samp>qblur</samp></span></dt>
  4891. <dd><p>Quantizer curve blur
  4892. </p>
  4893. </dd>
  4894. <dt><span><samp>qcomp</samp></span></dt>
  4895. <dd><p>Quantizer curve compression factor
  4896. </p>
  4897. </dd>
  4898. <dt><span><samp>i_qfactor</samp></span></dt>
  4899. <dt><span><samp>b_qfactor</samp></span></dt>
  4900. <dt><span><samp>forced-idr</samp></span></dt>
  4901. <dd><p>Normally, when forcing a I-frame type, the encoder can select any type
  4902. of I-frame. This option forces it to choose an IDR-frame.
  4903. </p>
  4904. </dd>
  4905. <dt><span><samp>x265-params</samp></span></dt>
  4906. <dd><p>Set x265 options using a list of <var>key</var>=<var>value</var> couples separated
  4907. by &quot;:&quot;. See <code>x265 --help</code> for a list of options.
  4908. </p>
  4909. <p>For example to specify libx265 encoding options with <samp>-x265-params</samp>:
  4910. </p>
  4911. <div class="example">
  4912. <pre class="example">ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
  4913. </pre></div>
  4914. </dd>
  4915. </dl>
  4916. <a name="libxavs2"></a>
  4917. <h3 class="section">9.14 libxavs2<span class="pull-right"><a class="anchor hidden-xs" href="#libxavs2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libxavs2" aria-hidden="true">TOC</a></span></h3>
  4918. <p>xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
  4919. </p>
  4920. <p>This encoder requires the presence of the libxavs2 headers and library
  4921. during configuration. You need to explicitly configure the build with
  4922. <samp>--enable-libxavs2</samp>.
  4923. </p>
  4924. <p>The following standard libavcodec options are used:
  4925. </p><ul>
  4926. <li> <samp>b</samp> / <samp>bit_rate</samp>
  4927. </li><li> <samp>g</samp> / <samp>gop_size</samp>
  4928. </li><li> <samp>bf</samp> / <samp>max_b_frames</samp>
  4929. </li></ul>
  4930. <p>The encoder also has its own specific options:
  4931. </p><a name="Options-33"></a>
  4932. <h4 class="subsection">9.14.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-33" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-33" aria-hidden="true">TOC</a></span></h4>
  4933. <dl compact="compact">
  4934. <dt><span><samp>lcu_row_threads</samp></span></dt>
  4935. <dd><p>Set the number of parallel threads for rows from 1 to 8 (default 5).
  4936. </p>
  4937. </dd>
  4938. <dt><span><samp>initial_qp</samp></span></dt>
  4939. <dd><p>Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  4940. used to set the initial qp for the first frame.
  4941. </p>
  4942. </dd>
  4943. <dt><span><samp>qp</samp></span></dt>
  4944. <dd><p>Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  4945. used to set the qp value under constant-QP mode.
  4946. </p>
  4947. </dd>
  4948. <dt><span><samp>max_qp</samp></span></dt>
  4949. <dd><p>Set the max qp for rate control from 1 to 63 (default 55).
  4950. </p>
  4951. </dd>
  4952. <dt><span><samp>min_qp</samp></span></dt>
  4953. <dd><p>Set the min qp for rate control from 1 to 63 (default 20).
  4954. </p>
  4955. </dd>
  4956. <dt><span><samp>speed_level</samp></span></dt>
  4957. <dd><p>Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
  4958. </p>
  4959. </dd>
  4960. <dt><span><samp>log_level</samp></span></dt>
  4961. <dd><p>Set the log level from -1 to 3 (default 0). -1: none, 0: error,
  4962. 1: warning, 2: info, 3: debug.
  4963. </p>
  4964. </dd>
  4965. <dt><span><samp>xavs2-params</samp></span></dt>
  4966. <dd><p>Set xavs2 options using a list of <var>key</var>=<var>value</var> couples separated
  4967. by &quot;:&quot;.
  4968. </p>
  4969. <p>For example to specify libxavs2 encoding options with <samp>-xavs2-params</samp>:
  4970. </p>
  4971. <div class="example">
  4972. <pre class="example">ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
  4973. </pre></div>
  4974. </dd>
  4975. </dl>
  4976. <a name="libxvid"></a>
  4977. <h3 class="section">9.15 libxvid<span class="pull-right"><a class="anchor hidden-xs" href="#libxvid" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libxvid" aria-hidden="true">TOC</a></span></h3>
  4978. <p>Xvid MPEG-4 Part 2 encoder wrapper.
  4979. </p>
  4980. <p>This encoder requires the presence of the libxvidcore headers and library
  4981. during configuration. You need to explicitly configure the build with
  4982. <code>--enable-libxvid --enable-gpl</code>.
  4983. </p>
  4984. <p>The native <code>mpeg4</code> encoder supports the MPEG-4 Part 2 format, so
  4985. users can encode to this format without this library.
  4986. </p>
  4987. <a name="Options-34"></a>
  4988. <h4 class="subsection">9.15.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-34" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-34" aria-hidden="true">TOC</a></span></h4>
  4989. <p>The following options are supported by the libxvid wrapper. Some of
  4990. the following options are listed but are not documented, and
  4991. correspond to shared codec options. See <a href="#codec_002doptions">the Codec
  4992. Options chapter</a> for their documentation. The other shared options
  4993. which are not listed have no effect for the libxvid encoder.
  4994. </p>
  4995. <dl compact="compact">
  4996. <dt><span><samp>b</samp></span></dt>
  4997. <dt><span><samp>g</samp></span></dt>
  4998. <dt><span><samp>qmin</samp></span></dt>
  4999. <dt><span><samp>qmax</samp></span></dt>
  5000. <dt><span><samp>mpeg_quant</samp></span></dt>
  5001. <dt><span><samp>threads</samp></span></dt>
  5002. <dt><span><samp>bf</samp></span></dt>
  5003. <dt><span><samp>b_qfactor</samp></span></dt>
  5004. <dt><span><samp>b_qoffset</samp></span></dt>
  5005. <dt><span><samp>flags</samp></span></dt>
  5006. <dd><p>Set specific encoding flags. Possible values:
  5007. </p>
  5008. <dl compact="compact">
  5009. <dt><span>&lsquo;<samp>mv4</samp>&rsquo;</span></dt>
  5010. <dd><p>Use four motion vector by macroblock.
  5011. </p>
  5012. </dd>
  5013. <dt><span>&lsquo;<samp>aic</samp>&rsquo;</span></dt>
  5014. <dd><p>Enable high quality AC prediction.
  5015. </p>
  5016. </dd>
  5017. <dt><span>&lsquo;<samp>gray</samp>&rsquo;</span></dt>
  5018. <dd><p>Only encode grayscale.
  5019. </p>
  5020. </dd>
  5021. <dt><span>&lsquo;<samp>gmc</samp>&rsquo;</span></dt>
  5022. <dd><p>Enable the use of global motion compensation (GMC).
  5023. </p>
  5024. </dd>
  5025. <dt><span>&lsquo;<samp>qpel</samp>&rsquo;</span></dt>
  5026. <dd><p>Enable quarter-pixel motion compensation.
  5027. </p>
  5028. </dd>
  5029. <dt><span>&lsquo;<samp>cgop</samp>&rsquo;</span></dt>
  5030. <dd><p>Enable closed GOP.
  5031. </p>
  5032. </dd>
  5033. <dt><span>&lsquo;<samp>global_header</samp>&rsquo;</span></dt>
  5034. <dd><p>Place global headers in extradata instead of every keyframe.
  5035. </p>
  5036. </dd>
  5037. </dl>
  5038. </dd>
  5039. <dt><span><samp>trellis</samp></span></dt>
  5040. <dt><span><samp>me_method</samp></span></dt>
  5041. <dd><p>Set motion estimation method. Possible values in decreasing order of
  5042. speed and increasing order of quality:
  5043. </p>
  5044. <dl compact="compact">
  5045. <dt><span>&lsquo;<samp>zero</samp>&rsquo;</span></dt>
  5046. <dd><p>Use no motion estimation (default).
  5047. </p>
  5048. </dd>
  5049. <dt><span>&lsquo;<samp>phods</samp>&rsquo;</span></dt>
  5050. <dt><span>&lsquo;<samp>x1</samp>&rsquo;</span></dt>
  5051. <dt><span>&lsquo;<samp>log</samp>&rsquo;</span></dt>
  5052. <dd><p>Enable advanced diamond zonal search for 16x16 blocks and half-pixel
  5053. refinement for 16x16 blocks. &lsquo;<samp>x1</samp>&rsquo; and &lsquo;<samp>log</samp>&rsquo; are aliases for
  5054. &lsquo;<samp>phods</samp>&rsquo;.
  5055. </p>
  5056. </dd>
  5057. <dt><span>&lsquo;<samp>epzs</samp>&rsquo;</span></dt>
  5058. <dd><p>Enable all of the things described above, plus advanced diamond zonal
  5059. search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
  5060. estimation on chroma planes.
  5061. </p>
  5062. </dd>
  5063. <dt><span>&lsquo;<samp>full</samp>&rsquo;</span></dt>
  5064. <dd><p>Enable all of the things described above, plus extended 16x16 and 8x8
  5065. blocks search.
  5066. </p></dd>
  5067. </dl>
  5068. </dd>
  5069. <dt><span><samp>mbd</samp></span></dt>
  5070. <dd><p>Set macroblock decision algorithm. Possible values in the increasing
  5071. order of quality:
  5072. </p>
  5073. <dl compact="compact">
  5074. <dt><span>&lsquo;<samp>simple</samp>&rsquo;</span></dt>
  5075. <dd><p>Use macroblock comparing function algorithm (default).
  5076. </p>
  5077. </dd>
  5078. <dt><span>&lsquo;<samp>bits</samp>&rsquo;</span></dt>
  5079. <dd><p>Enable rate distortion-based half pixel and quarter pixel refinement for
  5080. 16x16 blocks.
  5081. </p>
  5082. </dd>
  5083. <dt><span>&lsquo;<samp>rd</samp>&rsquo;</span></dt>
  5084. <dd><p>Enable all of the things described above, plus rate distortion-based
  5085. half pixel and quarter pixel refinement for 8x8 blocks, and rate
  5086. distortion-based search using square pattern.
  5087. </p></dd>
  5088. </dl>
  5089. </dd>
  5090. <dt><span><samp>lumi_aq</samp></span></dt>
  5091. <dd><p>Enable lumi masking adaptive quantization when set to 1. Default is 0
  5092. (disabled).
  5093. </p>
  5094. </dd>
  5095. <dt><span><samp>variance_aq</samp></span></dt>
  5096. <dd><p>Enable variance adaptive quantization when set to 1. Default is 0
  5097. (disabled).
  5098. </p>
  5099. <p>When combined with <samp>lumi_aq</samp>, the resulting quality will not
  5100. be better than any of the two specified individually. In other
  5101. words, the resulting quality will be the worse one of the two
  5102. effects.
  5103. </p>
  5104. </dd>
  5105. <dt><span><samp>ssim</samp></span></dt>
  5106. <dd><p>Set structural similarity (SSIM) displaying method. Possible values:
  5107. </p>
  5108. <dl compact="compact">
  5109. <dt><span>&lsquo;<samp>off</samp>&rsquo;</span></dt>
  5110. <dd><p>Disable displaying of SSIM information.
  5111. </p>
  5112. </dd>
  5113. <dt><span>&lsquo;<samp>avg</samp>&rsquo;</span></dt>
  5114. <dd><p>Output average SSIM at the end of encoding to stdout. The format of
  5115. showing the average SSIM is:
  5116. </p>
  5117. <div class="example">
  5118. <pre class="example">Average SSIM: %f
  5119. </pre></div>
  5120. <p>For users who are not familiar with C, %f means a float number, or
  5121. a decimal (e.g. 0.939232).
  5122. </p>
  5123. </dd>
  5124. <dt><span>&lsquo;<samp>frame</samp>&rsquo;</span></dt>
  5125. <dd><p>Output both per-frame SSIM data during encoding and average SSIM at
  5126. the end of encoding to stdout. The format of per-frame information
  5127. is:
  5128. </p>
  5129. <div class="example">
  5130. <pre class="example"> SSIM: avg: %1.3f min: %1.3f max: %1.3f
  5131. </pre></div>
  5132. <p>For users who are not familiar with C, %1.3f means a float number
  5133. rounded to 3 digits after the dot (e.g. 0.932).
  5134. </p>
  5135. </dd>
  5136. </dl>
  5137. </dd>
  5138. <dt><span><samp>ssim_acc</samp></span></dt>
  5139. <dd><p>Set SSIM accuracy. Valid options are integers within the range of
  5140. 0-4, while 0 gives the most accurate result and 4 computes the
  5141. fastest.
  5142. </p>
  5143. </dd>
  5144. </dl>
  5145. <a name="MediaFoundation"></a>
  5146. <h3 class="section">9.16 MediaFoundation<span class="pull-right"><a class="anchor hidden-xs" href="#MediaFoundation" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-MediaFoundation" aria-hidden="true">TOC</a></span></h3>
  5147. <p>This provides wrappers to encoders (both audio and video) in the
  5148. MediaFoundation framework. It can access both SW and HW encoders.
  5149. Video encoders can take input in either of nv12 or yuv420p form
  5150. (some encoders support both, some support only either - in practice,
  5151. nv12 is the safer choice, especially among HW encoders).
  5152. </p>
  5153. <a name="mpeg2"></a>
  5154. <h3 class="section">9.17 mpeg2<span class="pull-right"><a class="anchor hidden-xs" href="#mpeg2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mpeg2" aria-hidden="true">TOC</a></span></h3>
  5155. <p>MPEG-2 video encoder.
  5156. </p>
  5157. <a name="Options-35"></a>
  5158. <h4 class="subsection">9.17.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-35" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-35" aria-hidden="true">TOC</a></span></h4>
  5159. <dl compact="compact">
  5160. <dt><span><samp>profile</samp></span></dt>
  5161. <dd><p>Select the mpeg2 profile to encode:
  5162. </p>
  5163. <dl compact="compact">
  5164. <dt><span>&lsquo;<samp>422</samp>&rsquo;</span></dt>
  5165. <dt><span>&lsquo;<samp>high</samp>&rsquo;</span></dt>
  5166. <dt><span>&lsquo;<samp>ss</samp>&rsquo;</span></dt>
  5167. <dd><p>Spatially Scalable
  5168. </p></dd>
  5169. <dt><span>&lsquo;<samp>snr</samp>&rsquo;</span></dt>
  5170. <dd><p>SNR Scalable
  5171. </p></dd>
  5172. <dt><span>&lsquo;<samp>main</samp>&rsquo;</span></dt>
  5173. <dt><span>&lsquo;<samp>simple</samp>&rsquo;</span></dt>
  5174. </dl>
  5175. </dd>
  5176. <dt><span><samp>level</samp></span></dt>
  5177. <dd><p>Select the mpeg2 level to encode:
  5178. </p>
  5179. <dl compact="compact">
  5180. <dt><span>&lsquo;<samp>high</samp>&rsquo;</span></dt>
  5181. <dt><span>&lsquo;<samp>high1440</samp>&rsquo;</span></dt>
  5182. <dt><span>&lsquo;<samp>main</samp>&rsquo;</span></dt>
  5183. <dt><span>&lsquo;<samp>low</samp>&rsquo;</span></dt>
  5184. </dl>
  5185. </dd>
  5186. <dt><span><samp>seq_disp_ext <var>integer</var></samp></span></dt>
  5187. <dd><p>Specifies if the encoder should write a sequence_display_extension to the
  5188. output.
  5189. </p><dl compact="compact">
  5190. <dt><span><samp>-1</samp></span></dt>
  5191. <dt><span><samp>auto</samp></span></dt>
  5192. <dd><p>Decide automatically to write it or not (this is the default) by checking if
  5193. the data to be written is different from the default or unspecified values.
  5194. </p></dd>
  5195. <dt><span><samp>0</samp></span></dt>
  5196. <dt><span><samp>never</samp></span></dt>
  5197. <dd><p>Never write it.
  5198. </p></dd>
  5199. <dt><span><samp>1</samp></span></dt>
  5200. <dt><span><samp>always</samp></span></dt>
  5201. <dd><p>Always write it.
  5202. </p></dd>
  5203. </dl>
  5204. </dd>
  5205. <dt><span><samp>video_format <var>integer</var></samp></span></dt>
  5206. <dd><p>Specifies the video_format written into the sequence display extension
  5207. indicating the source of the video pictures. The default is &lsquo;<samp>unspecified</samp>&rsquo;,
  5208. can be &lsquo;<samp>component</samp>&rsquo;, &lsquo;<samp>pal</samp>&rsquo;, &lsquo;<samp>ntsc</samp>&rsquo;, &lsquo;<samp>secam</samp>&rsquo; or &lsquo;<samp>mac</samp>&rsquo;.
  5209. For maximum compatibility, use &lsquo;<samp>component</samp>&rsquo;.
  5210. </p></dd>
  5211. <dt><span><samp>a53cc <var>boolean</var></samp></span></dt>
  5212. <dd><p>Import closed captions (which must be ATSC compatible format) into output.
  5213. Default is 1 (on).
  5214. </p></dd>
  5215. </dl>
  5216. <a name="png"></a>
  5217. <h3 class="section">9.18 png<span class="pull-right"><a class="anchor hidden-xs" href="#png" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-png" aria-hidden="true">TOC</a></span></h3>
  5218. <p>PNG image encoder.
  5219. </p>
  5220. <a name="Private-options-1"></a>
  5221. <h4 class="subsection">9.18.1 Private options<span class="pull-right"><a class="anchor hidden-xs" href="#Private-options-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Private-options-1" aria-hidden="true">TOC</a></span></h4>
  5222. <dl compact="compact">
  5223. <dt><span><samp>dpi <var>integer</var></samp></span></dt>
  5224. <dd><p>Set physical density of pixels, in dots per inch, unset by default
  5225. </p></dd>
  5226. <dt><span><samp>dpm <var>integer</var></samp></span></dt>
  5227. <dd><p>Set physical density of pixels, in dots per meter, unset by default
  5228. </p></dd>
  5229. </dl>
  5230. <a name="ProRes"></a>
  5231. <h3 class="section">9.19 ProRes<span class="pull-right"><a class="anchor hidden-xs" href="#ProRes" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ProRes" aria-hidden="true">TOC</a></span></h3>
  5232. <p>Apple ProRes encoder.
  5233. </p>
  5234. <p>FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
  5235. The used encoder can be chosen with the <code>-vcodec</code> option.
  5236. </p>
  5237. <a name="Private-Options-for-prores_002dks"></a>
  5238. <h4 class="subsection">9.19.1 Private Options for prores-ks<span class="pull-right"><a class="anchor hidden-xs" href="#Private-Options-for-prores_002dks" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Private-Options-for-prores_002dks" aria-hidden="true">TOC</a></span></h4>
  5239. <dl compact="compact">
  5240. <dt><span><samp>profile <var>integer</var></samp></span></dt>
  5241. <dd><p>Select the ProRes profile to encode
  5242. </p><dl compact="compact">
  5243. <dt><span>&lsquo;<samp>proxy</samp>&rsquo;</span></dt>
  5244. <dt><span>&lsquo;<samp>lt</samp>&rsquo;</span></dt>
  5245. <dt><span>&lsquo;<samp>standard</samp>&rsquo;</span></dt>
  5246. <dt><span>&lsquo;<samp>hq</samp>&rsquo;</span></dt>
  5247. <dt><span>&lsquo;<samp>4444</samp>&rsquo;</span></dt>
  5248. <dt><span>&lsquo;<samp>4444xq</samp>&rsquo;</span></dt>
  5249. </dl>
  5250. </dd>
  5251. <dt><span><samp>quant_mat <var>integer</var></samp></span></dt>
  5252. <dd><p>Select quantization matrix.
  5253. </p><dl compact="compact">
  5254. <dt><span>&lsquo;<samp>auto</samp>&rsquo;</span></dt>
  5255. <dt><span>&lsquo;<samp>default</samp>&rsquo;</span></dt>
  5256. <dt><span>&lsquo;<samp>proxy</samp>&rsquo;</span></dt>
  5257. <dt><span>&lsquo;<samp>lt</samp>&rsquo;</span></dt>
  5258. <dt><span>&lsquo;<samp>standard</samp>&rsquo;</span></dt>
  5259. <dt><span>&lsquo;<samp>hq</samp>&rsquo;</span></dt>
  5260. </dl>
  5261. <p>If set to <var>auto</var>, the matrix matching the profile will be picked.
  5262. If not set, the matrix providing the highest quality, <var>default</var>, will be
  5263. picked.
  5264. </p>
  5265. </dd>
  5266. <dt><span><samp>bits_per_mb <var>integer</var></samp></span></dt>
  5267. <dd><p>How many bits to allot for coding one macroblock. Different profiles use
  5268. between 200 and 2400 bits per macroblock, the maximum is 8000.
  5269. </p>
  5270. </dd>
  5271. <dt><span><samp>mbs_per_slice <var>integer</var></samp></span></dt>
  5272. <dd><p>Number of macroblocks in each slice (1-8); the default value (8)
  5273. should be good in almost all situations.
  5274. </p>
  5275. </dd>
  5276. <dt><span><samp>vendor <var>string</var></samp></span></dt>
  5277. <dd><p>Override the 4-byte vendor ID.
  5278. A custom vendor ID like <var>apl0</var> would claim the stream was produced by
  5279. the Apple encoder.
  5280. </p>
  5281. </dd>
  5282. <dt><span><samp>alpha_bits <var>integer</var></samp></span></dt>
  5283. <dd><p>Specify number of bits for alpha component.
  5284. Possible values are <var>0</var>, <var>8</var> and <var>16</var>.
  5285. Use <var>0</var> to disable alpha plane coding.
  5286. </p>
  5287. </dd>
  5288. </dl>
  5289. <a name="Speed-considerations"></a>
  5290. <h4 class="subsection">9.19.2 Speed considerations<span class="pull-right"><a class="anchor hidden-xs" href="#Speed-considerations" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Speed-considerations" aria-hidden="true">TOC</a></span></h4>
  5291. <p>In the default mode of operation the encoder has to honor frame constraints
  5292. (i.e. not produce frames with size bigger than requested) while still making
  5293. output picture as good as possible.
  5294. A frame containing a lot of small details is harder to compress and the encoder
  5295. would spend more time searching for appropriate quantizers for each slice.
  5296. </p>
  5297. <p>Setting a higher <samp>bits_per_mb</samp> limit will improve the speed.
  5298. </p>
  5299. <p>For the fastest encoding speed set the <samp>qscale</samp> parameter (4 is the
  5300. recommended value) and do not set a size constraint.
  5301. </p>
  5302. <a name="QSV-encoders"></a>
  5303. <h3 class="section">9.20 QSV encoders<span class="pull-right"><a class="anchor hidden-xs" href="#QSV-encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-QSV-encoders" aria-hidden="true">TOC</a></span></h3>
  5304. <p>The family of Intel QuickSync Video encoders (MPEG-2, H.264, HEVC, JPEG/MJPEG and VP9)
  5305. </p>
  5306. <p>The ratecontrol method is selected as follows:
  5307. </p>
  5308. <ul>
  5309. <li> When <samp>global_quality</samp> is specified, a quality-based mode is used.
  5310. Specifically this means either
  5311. <ul class="no-bullet">
  5312. <li>- <var>CQP</var> - constant quantizer scale, when the <samp>qscale</samp> codec flag is
  5313. also set (the <samp>-qscale</samp> ffmpeg option).
  5314. </li><li>- <var>LA_ICQ</var> - intelligent constant quality with lookahead, when the
  5315. <samp>look_ahead</samp> option is also set.
  5316. </li><li>- <var>ICQ</var> &ndash; intelligent constant quality otherwise.
  5317. </li></ul>
  5318. </li><li> Otherwise, a bitrate-based mode is used. For all of those, you should specify at
  5319. least the desired average bitrate with the <samp>b</samp> option.
  5320. <ul class="no-bullet">
  5321. <li>- <var>LA</var> - VBR with lookahead, when the <samp>look_ahead</samp> option is specified.
  5322. </li><li>- <var>VCM</var> - video conferencing mode, when the <samp>vcm</samp> option is set.
  5323. </li><li>- <var>CBR</var> - constant bitrate, when <samp>maxrate</samp> is specified and equal to
  5324. the average bitrate.
  5325. </li><li>- <var>VBR</var> - variable bitrate, when <samp>maxrate</samp> is specified, but is higher
  5326. than the average bitrate.
  5327. </li><li>- <var>AVBR</var> - average VBR mode, when <samp>maxrate</samp> is not specified. This mode
  5328. is further configured by the <samp>avbr_accuracy</samp> and
  5329. <samp>avbr_convergence</samp> options.
  5330. </li></ul>
  5331. </li></ul>
  5332. <p>Note that depending on your system, a different mode than the one you specified
  5333. may be selected by the encoder. Set the verbosity level to <var>verbose</var> or
  5334. higher to see the actual settings used by the QSV runtime.
  5335. </p>
  5336. <p>Additional libavcodec global options are mapped to MSDK options as follows:
  5337. </p>
  5338. <ul>
  5339. <li> <samp>g/gop_size</samp> -&gt; <samp>GopPicSize</samp>
  5340. </li><li> <samp>bf/max_b_frames</samp>+1 -&gt; <samp>GopRefDist</samp>
  5341. </li><li> <samp>rc_init_occupancy/rc_initial_buffer_occupancy</samp> -&gt;
  5342. <samp>InitialDelayInKB</samp>
  5343. </li><li> <samp>slices</samp> -&gt; <samp>NumSlice</samp>
  5344. </li><li> <samp>refs</samp> -&gt; <samp>NumRefFrame</samp>
  5345. </li><li> <samp>b_strategy/b_frame_strategy</samp> -&gt; <samp>BRefType</samp>
  5346. </li><li> <samp>cgop/CLOSED_GOP</samp> codec flag -&gt; <samp>GopOptFlag</samp>
  5347. </li><li> For the <var>CQP</var> mode, the <samp>i_qfactor/i_qoffset</samp> and
  5348. <samp>b_qfactor/b_qoffset</samp> set the difference between <var>QPP</var> and <var>QPI</var>,
  5349. and <var>QPP</var> and <var>QPB</var> respectively.
  5350. </li><li> Setting the <samp>coder</samp> option to the value <var>vlc</var> will make the H.264
  5351. encoder use CAVLC instead of CABAC.
  5352. </li></ul>
  5353. <a name="snow"></a>
  5354. <h3 class="section">9.21 snow<span class="pull-right"><a class="anchor hidden-xs" href="#snow" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-snow" aria-hidden="true">TOC</a></span></h3>
  5355. <a name="Options-36"></a>
  5356. <h4 class="subsection">9.21.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-36" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-36" aria-hidden="true">TOC</a></span></h4>
  5357. <dl compact="compact">
  5358. <dt><span><samp>iterative_dia_size</samp></span></dt>
  5359. <dd><p>dia size for the iterative motion estimation
  5360. </p></dd>
  5361. </dl>
  5362. <a name="VAAPI-encoders"></a>
  5363. <h3 class="section">9.22 VAAPI encoders<span class="pull-right"><a class="anchor hidden-xs" href="#VAAPI-encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-VAAPI-encoders" aria-hidden="true">TOC</a></span></h3>
  5364. <p>Wrappers for hardware encoders accessible via VAAPI.
  5365. </p>
  5366. <p>These encoders only accept input in VAAPI hardware surfaces. If you have input
  5367. in software frames, use the <samp>hwupload</samp> filter to upload them to the GPU.
  5368. </p>
  5369. <p>The following standard libavcodec options are used:
  5370. </p><ul>
  5371. <li> <samp>g</samp> / <samp>gop_size</samp>
  5372. </li><li> <samp>bf</samp> / <samp>max_b_frames</samp>
  5373. </li><li> <samp>profile</samp>
  5374. <p>If not set, this will be determined automatically from the format of the input
  5375. frames and the profiles supported by the driver.
  5376. </p></li><li> <samp>level</samp>
  5377. </li><li> <samp>b</samp> / <samp>bit_rate</samp>
  5378. </li><li> <samp>maxrate</samp> / <samp>rc_max_rate</samp>
  5379. </li><li> <samp>bufsize</samp> / <samp>rc_buffer_size</samp>
  5380. </li><li> <samp>rc_init_occupancy</samp> / <samp>rc_initial_buffer_occupancy</samp>
  5381. </li><li> <samp>compression_level</samp>
  5382. <p>Speed / quality tradeoff: higher values are faster / worse quality.
  5383. </p></li><li> <samp>q</samp> / <samp>global_quality</samp>
  5384. <p>Size / quality tradeoff: higher values are smaller / worse quality.
  5385. </p></li><li> <samp>qmin</samp>
  5386. </li><li> <samp>qmax</samp>
  5387. </li><li> <samp>i_qfactor</samp> / <samp>i_quant_factor</samp>
  5388. </li><li> <samp>i_qoffset</samp> / <samp>i_quant_offset</samp>
  5389. </li><li> <samp>b_qfactor</samp> / <samp>b_quant_factor</samp>
  5390. </li><li> <samp>b_qoffset</samp> / <samp>b_quant_offset</samp>
  5391. </li><li> <samp>slices</samp>
  5392. </li></ul>
  5393. <p>All encoders support the following options:
  5394. </p><dl compact="compact">
  5395. <dt><span><samp>low_power</samp></span></dt>
  5396. <dd><p>Some drivers/platforms offer a second encoder for some codecs intended to use
  5397. less power than the default encoder; setting this option will attempt to use
  5398. that encoder. Note that it may support a reduced feature set, so some other
  5399. options may not be available in this mode.
  5400. </p>
  5401. </dd>
  5402. <dt><span><samp>idr_interval</samp></span></dt>
  5403. <dd><p>Set the number of normal intra frames between full-refresh (IDR) frames in
  5404. open-GOP mode. The intra frames are still IRAPs, but will not include global
  5405. headers and may have non-decodable leading pictures.
  5406. </p>
  5407. </dd>
  5408. <dt><span><samp>b_depth</samp></span></dt>
  5409. <dd><p>Set the B-frame reference depth. When set to one (the default), all B-frames
  5410. will refer only to P- or I-frames. When set to greater values multiple layers
  5411. of B-frames will be present, frames in each layer only referring to frames in
  5412. higher layers.
  5413. </p>
  5414. </dd>
  5415. <dt><span><samp>rc_mode</samp></span></dt>
  5416. <dd><p>Set the rate control mode to use. A given driver may only support a subset of
  5417. modes.
  5418. </p>
  5419. <p>Possible modes:
  5420. </p><dl compact="compact">
  5421. <dt><span><samp>auto</samp></span></dt>
  5422. <dd><p>Choose the mode automatically based on driver support and the other options.
  5423. This is the default.
  5424. </p></dd>
  5425. <dt><span><samp>CQP</samp></span></dt>
  5426. <dd><p>Constant-quality.
  5427. </p></dd>
  5428. <dt><span><samp>CBR</samp></span></dt>
  5429. <dd><p>Constant-bitrate.
  5430. </p></dd>
  5431. <dt><span><samp>VBR</samp></span></dt>
  5432. <dd><p>Variable-bitrate.
  5433. </p></dd>
  5434. <dt><span><samp>ICQ</samp></span></dt>
  5435. <dd><p>Intelligent constant-quality.
  5436. </p></dd>
  5437. <dt><span><samp>QVBR</samp></span></dt>
  5438. <dd><p>Quality-defined variable-bitrate.
  5439. </p></dd>
  5440. <dt><span><samp>AVBR</samp></span></dt>
  5441. <dd><p>Average variable bitrate.
  5442. </p></dd>
  5443. </dl>
  5444. </dd>
  5445. </dl>
  5446. <p>Each encoder also has its own specific options:
  5447. </p><dl compact="compact">
  5448. <dt><span><samp>h264_vaapi</samp></span></dt>
  5449. <dd><p><samp>profile</samp> sets the value of <em>profile_idc</em> and the <em>constraint_set*_flag</em>s.
  5450. <samp>level</samp> sets the value of <em>level_idc</em>.
  5451. </p>
  5452. <dl compact="compact">
  5453. <dt><span><samp>coder</samp></span></dt>
  5454. <dd><p>Set entropy encoder (default is <em>cabac</em>). Possible values:
  5455. </p>
  5456. <dl compact="compact">
  5457. <dt><span>&lsquo;<samp>ac</samp>&rsquo;</span></dt>
  5458. <dt><span>&lsquo;<samp>cabac</samp>&rsquo;</span></dt>
  5459. <dd><p>Use CABAC.
  5460. </p>
  5461. </dd>
  5462. <dt><span>&lsquo;<samp>vlc</samp>&rsquo;</span></dt>
  5463. <dt><span>&lsquo;<samp>cavlc</samp>&rsquo;</span></dt>
  5464. <dd><p>Use CAVLC.
  5465. </p></dd>
  5466. </dl>
  5467. </dd>
  5468. <dt><span><samp>aud</samp></span></dt>
  5469. <dd><p>Include access unit delimiters in the stream (not included by default).
  5470. </p>
  5471. </dd>
  5472. <dt><span><samp>sei</samp></span></dt>
  5473. <dd><p>Set SEI message types to include.
  5474. Some combination of the following values:
  5475. </p><dl compact="compact">
  5476. <dt><span>&lsquo;<samp>identifier</samp>&rsquo;</span></dt>
  5477. <dd><p>Include a <em>user_data_unregistered</em> message containing information about
  5478. the encoder.
  5479. </p></dd>
  5480. <dt><span>&lsquo;<samp>timing</samp>&rsquo;</span></dt>
  5481. <dd><p>Include picture timing parameters (<em>buffering_period</em> and
  5482. <em>pic_timing</em> messages).
  5483. </p></dd>
  5484. <dt><span>&lsquo;<samp>recovery_point</samp>&rsquo;</span></dt>
  5485. <dd><p>Include recovery points where appropriate (<em>recovery_point</em> messages).
  5486. </p></dd>
  5487. </dl>
  5488. </dd>
  5489. </dl>
  5490. </dd>
  5491. <dt><span><samp>hevc_vaapi</samp></span></dt>
  5492. <dd><p><samp>profile</samp> and <samp>level</samp> set the values of
  5493. <em>general_profile_idc</em> and <em>general_level_idc</em> respectively.
  5494. </p>
  5495. <dl compact="compact">
  5496. <dt><span><samp>aud</samp></span></dt>
  5497. <dd><p>Include access unit delimiters in the stream (not included by default).
  5498. </p>
  5499. </dd>
  5500. <dt><span><samp>tier</samp></span></dt>
  5501. <dd><p>Set <em>general_tier_flag</em>. This may affect the level chosen for the stream
  5502. if it is not explicitly specified.
  5503. </p>
  5504. </dd>
  5505. <dt><span><samp>sei</samp></span></dt>
  5506. <dd><p>Set SEI message types to include.
  5507. Some combination of the following values:
  5508. </p><dl compact="compact">
  5509. <dt><span>&lsquo;<samp>hdr</samp>&rsquo;</span></dt>
  5510. <dd><p>Include HDR metadata if the input frames have it
  5511. (<em>mastering_display_colour_volume</em> and <em>content_light_level</em>
  5512. messages).
  5513. </p></dd>
  5514. </dl>
  5515. </dd>
  5516. <dt><span><samp>tiles</samp></span></dt>
  5517. <dd><p>Set the number of tiles to encode the input video with, as columns x rows.
  5518. Larger numbers allow greater parallelism in both encoding and decoding, but
  5519. may decrease coding efficiency.
  5520. </p>
  5521. </dd>
  5522. </dl>
  5523. </dd>
  5524. <dt><span><samp>mjpeg_vaapi</samp></span></dt>
  5525. <dd><p>Only baseline DCT encoding is supported. The encoder always uses the standard
  5526. quantisation and huffman tables - <samp>global_quality</samp> scales the standard
  5527. quantisation table (range 1-100).
  5528. </p>
  5529. <p>For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported. RGB is also
  5530. supported, and will create an RGB JPEG.
  5531. </p>
  5532. <dl compact="compact">
  5533. <dt><span><samp>jfif</samp></span></dt>
  5534. <dd><p>Include JFIF header in each frame (not included by default).
  5535. </p></dd>
  5536. <dt><span><samp>huffman</samp></span></dt>
  5537. <dd><p>Include standard huffman tables (on by default). Turning this off will save
  5538. a few hundred bytes in each output frame, but may lose compatibility with some
  5539. JPEG decoders which don&rsquo;t fully handle MJPEG.
  5540. </p></dd>
  5541. </dl>
  5542. </dd>
  5543. <dt><span><samp>mpeg2_vaapi</samp></span></dt>
  5544. <dd><p><samp>profile</samp> and <samp>level</samp> set the value of <em>profile_and_level_indication</em>.
  5545. </p>
  5546. </dd>
  5547. <dt><span><samp>vp8_vaapi</samp></span></dt>
  5548. <dd><p>B-frames are not supported.
  5549. </p>
  5550. <p><samp>global_quality</samp> sets the <em>q_idx</em> used for non-key frames (range 0-127).
  5551. </p>
  5552. <dl compact="compact">
  5553. <dt><span><samp>loop_filter_level</samp></span></dt>
  5554. <dt><span><samp>loop_filter_sharpness</samp></span></dt>
  5555. <dd><p>Manually set the loop filter parameters.
  5556. </p></dd>
  5557. </dl>
  5558. </dd>
  5559. <dt><span><samp>vp9_vaapi</samp></span></dt>
  5560. <dd><p><samp>global_quality</samp> sets the <em>q_idx</em> used for P-frames (range 0-255).
  5561. </p>
  5562. <dl compact="compact">
  5563. <dt><span><samp>loop_filter_level</samp></span></dt>
  5564. <dt><span><samp>loop_filter_sharpness</samp></span></dt>
  5565. <dd><p>Manually set the loop filter parameters.
  5566. </p></dd>
  5567. </dl>
  5568. <p>B-frames are supported, but the output stream is always in encode order rather than display
  5569. order. If B-frames are enabled, it may be necessary to use the <samp>vp9_raw_reorder</samp>
  5570. bitstream filter to modify the output stream to display frames in the correct order.
  5571. </p>
  5572. <p>Only normal frames are produced - the <samp>vp9_superframe</samp> bitstream filter may be
  5573. required to produce a stream usable with all decoders.
  5574. </p>
  5575. </dd>
  5576. </dl>
  5577. <a name="vc2"></a>
  5578. <h3 class="section">9.23 vc2<span class="pull-right"><a class="anchor hidden-xs" href="#vc2" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-vc2" aria-hidden="true">TOC</a></span></h3>
  5579. <p>SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
  5580. professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
  5581. 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
  5582. other tasks which require low overhead and low compression (like screen
  5583. recording).
  5584. </p>
  5585. <a name="Options-37"></a>
  5586. <h4 class="subsection">9.23.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-37" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-37" aria-hidden="true">TOC</a></span></h4>
  5587. <dl compact="compact">
  5588. <dt><span><samp>b</samp></span></dt>
  5589. <dd><p>Sets target video bitrate. Usually that&rsquo;s around 1:6 of the uncompressed
  5590. video bitrate (e.g. for 1920x1080 50fps yuv422p10 that&rsquo;s around 400Mbps). Higher
  5591. values (close to the uncompressed bitrate) turn on lossless compression mode.
  5592. </p>
  5593. </dd>
  5594. <dt><span><samp>field_order</samp></span></dt>
  5595. <dd><p>Enables field coding when set (e.g. to tt - top field first) for interlaced
  5596. inputs. Should increase compression with interlaced content as it splits the
  5597. fields and encodes each separately.
  5598. </p>
  5599. </dd>
  5600. <dt><span><samp>wavelet_depth</samp></span></dt>
  5601. <dd><p>Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
  5602. Lower values reduce compression and quality. Less capable decoders may not be
  5603. able to handle values of <samp>wavelet_depth</samp> over 3.
  5604. </p>
  5605. </dd>
  5606. <dt><span><samp>wavelet_type</samp></span></dt>
  5607. <dd><p>Sets the transform type. Currently only <var>5_3</var> (LeGall) and <var>9_7</var>
  5608. (Deslauriers-Dubuc)
  5609. are implemented, with 9_7 being the one with better compression and thus
  5610. is the default.
  5611. </p>
  5612. </dd>
  5613. <dt><span><samp>slice_width</samp></span></dt>
  5614. <dt><span><samp>slice_height</samp></span></dt>
  5615. <dd><p>Sets the slice size for each slice. Larger values result in better compression.
  5616. For compatibility with other more limited decoders use <samp>slice_width</samp> of
  5617. 32 and <samp>slice_height</samp> of 8.
  5618. </p>
  5619. </dd>
  5620. <dt><span><samp>tolerance</samp></span></dt>
  5621. <dd><p>Sets the undershoot tolerance of the rate control system in percent. This is
  5622. to prevent an expensive search from being run.
  5623. </p>
  5624. </dd>
  5625. <dt><span><samp>qm</samp></span></dt>
  5626. <dd><p>Sets the quantization matrix preset to use by default or when <samp>wavelet_depth</samp>
  5627. is set to 5
  5628. </p><ul class="no-bullet">
  5629. <li>- <var>default</var>
  5630. Uses the default quantization matrix from the specifications, extended with
  5631. values for the fifth level. This provides a good balance between keeping detail
  5632. and omitting artifacts.
  5633. </li><li>- <var>flat</var>
  5634. Use a completely zeroed out quantization matrix. This increases PSNR but might
  5635. reduce perception. Use in bogus benchmarks.
  5636. </li><li>- <var>color</var>
  5637. Reduces detail but attempts to preserve color at extremely low bitrates.
  5638. </li></ul>
  5639. </dd>
  5640. </dl>
  5641. <a name="Subtitles-Encoders"></a>
  5642. <h2 class="chapter">10 Subtitles Encoders<span class="pull-right"><a class="anchor hidden-xs" href="#Subtitles-Encoders" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Subtitles-Encoders" aria-hidden="true">TOC</a></span></h2>
  5643. <a name="dvdsub-1"></a>
  5644. <h3 class="section">10.1 dvdsub<span class="pull-right"><a class="anchor hidden-xs" href="#dvdsub-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-dvdsub-1" aria-hidden="true">TOC</a></span></h3>
  5645. <p>This codec encodes the bitmap subtitle format that is used in DVDs.
  5646. Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
  5647. and they can also be used in Matroska files.
  5648. </p>
  5649. <a name="Options-38"></a>
  5650. <h4 class="subsection">10.1.1 Options<span class="pull-right"><a class="anchor hidden-xs" href="#Options-38" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Options-38" aria-hidden="true">TOC</a></span></h4>
  5651. <dl compact="compact">
  5652. <dt><span><samp>palette</samp></span></dt>
  5653. <dd><p>Specify the global palette used by the bitmaps.
  5654. </p>
  5655. <p>The format for this option is a string containing 16 24-bits hexadecimal
  5656. numbers (without 0x prefix) separated by commas, for example <code>0d00ee,
  5657. ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
  5658. 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
  5659. </p>
  5660. </dd>
  5661. <dt><span><samp>even_rows_fix</samp></span></dt>
  5662. <dd><p>When set to 1, enable a work-around that makes the number of pixel rows
  5663. even in all subtitles. This fixes a problem with some players that
  5664. cut off the bottom row if the number is odd. The work-around just adds
  5665. a fully transparent row if needed. The overhead is low, typically
  5666. one byte per subtitle on average.
  5667. </p>
  5668. <p>By default, this work-around is disabled.
  5669. </p></dd>
  5670. </dl>
  5671. <a name="See-Also"></a>
  5672. <h2 class="chapter">11 See Also<span class="pull-right"><a class="anchor hidden-xs" href="#See-Also" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-See-Also" aria-hidden="true">TOC</a></span></h2>
  5673. <p><a href="ffmpeg.html">ffmpeg</a>, <a href="ffplay.html">ffplay</a>, <a href="ffprobe.html">ffprobe</a>,
  5674. <a href="libavcodec.html">libavcodec</a>
  5675. </p>
  5676. <a name="Authors"></a>
  5677. <h2 class="chapter">12 Authors<span class="pull-right"><a class="anchor hidden-xs" href="#Authors" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Authors" aria-hidden="true">TOC</a></span></h2>
  5678. <p>The FFmpeg developers.
  5679. </p>
  5680. <p>For details about the authorship, see the Git history of the project
  5681. (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
  5682. <code>git log</code> in the FFmpeg source directory, or browsing the
  5683. online repository at <a href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
  5684. </p>
  5685. <p>Maintainers for the specific components are listed in the file
  5686. <samp>MAINTAINERS</samp> in the source code tree.
  5687. </p>
  5688. </body>
  5689. </html>