ffmpeg-codecs.html 285 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Created by , GNU Texinfo 7.1 -->
  4. <head>
  5. <meta charset="utf-8">
  6. <title>
  7. FFmpeg Codecs Documentation
  8. </title>
  9. <meta name="viewport" content="width=device-width,initial-scale=1.0">
  10. <link rel="stylesheet" type="text/css" href="bootstrap.min.css">
  11. <link rel="stylesheet" type="text/css" href="style.min.css">
  12. </head>
  13. <body>
  14. <div class="container">
  15. <h1>
  16. FFmpeg Codecs Documentation
  17. </h1>
  18. <div class="top-level-extent" id="SEC_Top">
  19. <div class="element-contents" id="SEC_Contents">
  20. <h2 class="contents-heading">Table of Contents</h2>
  21. <div class="contents">
  22. <ul class="toc-numbered-mark">
  23. <li><a id="toc-Description" href="#Description">1 Description</a></li>
  24. <li><a id="toc-Codec-Options" href="#Codec-Options">2 Codec Options</a></li>
  25. <li><a id="toc-Decoders" href="#Decoders">3 Decoders</a></li>
  26. <li><a id="toc-Video-Decoders" href="#Video-Decoders">4 Video Decoders</a>
  27. <ul class="toc-numbered-mark">
  28. <li><a id="toc-av1" href="#av1">4.1 av1</a>
  29. <ul class="toc-numbered-mark">
  30. <li><a id="toc-Options" href="#Options">4.1.1 Options</a></li>
  31. </ul></li>
  32. <li><a id="toc-rawvideo" href="#rawvideo">4.2 rawvideo</a>
  33. <ul class="toc-numbered-mark">
  34. <li><a id="toc-Options-1" href="#Options-1">4.2.1 Options</a></li>
  35. </ul></li>
  36. <li><a id="toc-libdav1d" href="#libdav1d">4.3 libdav1d</a>
  37. <ul class="toc-numbered-mark">
  38. <li><a id="toc-Options-2" href="#Options-2">4.3.1 Options</a></li>
  39. </ul></li>
  40. <li><a id="toc-libdavs2" href="#libdavs2">4.4 libdavs2</a></li>
  41. <li><a id="toc-libuavs3d" href="#libuavs3d">4.5 libuavs3d</a>
  42. <ul class="toc-numbered-mark">
  43. <li><a id="toc-Options-3" href="#Options-3">4.5.1 Options</a></li>
  44. </ul></li>
  45. <li><a id="toc-QSV-Decoders" href="#QSV-Decoders">4.6 QSV Decoders</a>
  46. <ul class="toc-numbered-mark">
  47. <li><a id="toc-Common-Options" href="#Common-Options">4.6.1 Common Options</a></li>
  48. <li><a id="toc-HEVC-Options" href="#HEVC-Options">4.6.2 HEVC Options</a></li>
  49. </ul></li>
  50. <li><a id="toc-v210" href="#v210">4.7 v210</a>
  51. <ul class="toc-numbered-mark">
  52. <li><a id="toc-Options-4" href="#Options-4">4.7.1 Options</a></li>
  53. </ul></li>
  54. </ul></li>
  55. <li><a id="toc-Audio-Decoders" href="#Audio-Decoders">5 Audio Decoders</a>
  56. <ul class="toc-numbered-mark">
  57. <li><a id="toc-ac3" href="#ac3">5.1 ac3</a>
  58. <ul class="toc-numbered-mark">
  59. <li><a id="toc-AC_002d3-Decoder-Options" href="#AC_002d3-Decoder-Options">5.1.1 AC-3 Decoder Options</a></li>
  60. </ul></li>
  61. <li><a id="toc-flac-1" href="#flac-1">5.2 flac</a>
  62. <ul class="toc-numbered-mark">
  63. <li><a id="toc-FLAC-Decoder-options" href="#FLAC-Decoder-options">5.2.1 FLAC Decoder options</a></li>
  64. </ul></li>
  65. <li><a id="toc-ffwavesynth" href="#ffwavesynth">5.3 ffwavesynth</a></li>
  66. <li><a id="toc-libcelt" href="#libcelt">5.4 libcelt</a></li>
  67. <li><a id="toc-libgsm" href="#libgsm">5.5 libgsm</a></li>
  68. <li><a id="toc-libilbc" href="#libilbc">5.6 libilbc</a>
  69. <ul class="toc-numbered-mark">
  70. <li><a id="toc-Options-5" href="#Options-5">5.6.1 Options</a></li>
  71. </ul></li>
  72. <li><a id="toc-libopencore_002damrnb" href="#libopencore_002damrnb">5.7 libopencore-amrnb</a></li>
  73. <li><a id="toc-libopencore_002damrwb" href="#libopencore_002damrwb">5.8 libopencore-amrwb</a></li>
  74. <li><a id="toc-libopus" href="#libopus">5.9 libopus</a></li>
  75. </ul></li>
  76. <li><a id="toc-Subtitles-Decoders" href="#Subtitles-Decoders">6 Subtitles Decoders</a>
  77. <ul class="toc-numbered-mark">
  78. <li><a id="toc-libaribb24" href="#libaribb24">6.1 libaribb24</a>
  79. <ul class="toc-numbered-mark">
  80. <li><a id="toc-libaribb24-Decoder-Options" href="#libaribb24-Decoder-Options">6.1.1 libaribb24 Decoder Options</a></li>
  81. </ul></li>
  82. <li><a id="toc-dvbsub" href="#dvbsub">6.2 dvbsub</a>
  83. <ul class="toc-numbered-mark">
  84. <li><a id="toc-Options-6" href="#Options-6">6.2.1 Options</a></li>
  85. </ul></li>
  86. <li><a id="toc-dvdsub" href="#dvdsub">6.3 dvdsub</a>
  87. <ul class="toc-numbered-mark">
  88. <li><a id="toc-Options-7" href="#Options-7">6.3.1 Options</a></li>
  89. </ul></li>
  90. <li><a id="toc-libzvbi_002dteletext" href="#libzvbi_002dteletext">6.4 libzvbi-teletext</a>
  91. <ul class="toc-numbered-mark">
  92. <li><a id="toc-Options-8" href="#Options-8">6.4.1 Options</a></li>
  93. </ul></li>
  94. </ul></li>
  95. <li><a id="toc-Encoders" href="#Encoders">7 Encoders</a></li>
  96. <li><a id="toc-Audio-Encoders" href="#Audio-Encoders">8 Audio Encoders</a>
  97. <ul class="toc-numbered-mark">
  98. <li><a id="toc-aac" href="#aac">8.1 aac</a>
  99. <ul class="toc-numbered-mark">
  100. <li><a id="toc-Options-9" href="#Options-9">8.1.1 Options</a></li>
  101. </ul></li>
  102. <li><a id="toc-ac3-and-ac3_005ffixed" href="#ac3-and-ac3_005ffixed">8.2 ac3 and ac3_fixed</a>
  103. <ul class="toc-numbered-mark">
  104. <li><a id="toc-AC_002d3-Metadata" href="#AC_002d3-Metadata">8.2.1 AC-3 Metadata</a>
  105. <ul class="toc-numbered-mark">
  106. <li><a id="toc-Metadata-Control-Options" href="#Metadata-Control-Options">8.2.1.1 Metadata Control Options</a></li>
  107. <li><a id="toc-Downmix-Levels" href="#Downmix-Levels">8.2.1.2 Downmix Levels</a></li>
  108. <li><a id="toc-Audio-Production-Information" href="#Audio-Production-Information">8.2.1.3 Audio Production Information</a></li>
  109. <li><a id="toc-Other-Metadata-Options" href="#Other-Metadata-Options">8.2.1.4 Other Metadata Options</a></li>
  110. </ul></li>
  111. <li><a id="toc-Extended-Bitstream-Information" href="#Extended-Bitstream-Information">8.2.2 Extended Bitstream Information</a>
  112. <ul class="toc-numbered-mark">
  113. <li><a id="toc-Extended-Bitstream-Information-_002d-Part-1" href="#Extended-Bitstream-Information-_002d-Part-1">8.2.2.1 Extended Bitstream Information - Part 1</a></li>
  114. <li><a id="toc-Extended-Bitstream-Information-_002d-Part-2" href="#Extended-Bitstream-Information-_002d-Part-2">8.2.2.2 Extended Bitstream Information - Part 2</a></li>
  115. </ul></li>
  116. <li><a id="toc-Other-AC_002d3-Encoding-Options" href="#Other-AC_002d3-Encoding-Options">8.2.3 Other AC-3 Encoding Options</a></li>
  117. <li><a id="toc-Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options" href="#Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options">8.2.4 Floating-Point-Only AC-3 Encoding Options</a></li>
  118. </ul></li>
  119. <li><a id="toc-flac-2" href="#flac-2">8.3 flac</a>
  120. <ul class="toc-numbered-mark">
  121. <li><a id="toc-Options-10" href="#Options-10">8.3.1 Options</a></li>
  122. </ul></li>
  123. <li><a id="toc-opus" href="#opus">8.4 opus</a>
  124. <ul class="toc-numbered-mark">
  125. <li><a id="toc-Options-11" href="#Options-11">8.4.1 Options</a></li>
  126. </ul></li>
  127. <li><a id="toc-libfdk_005faac" href="#libfdk_005faac">8.5 libfdk_aac</a>
  128. <ul class="toc-numbered-mark">
  129. <li><a id="toc-Options-12" href="#Options-12">8.5.1 Options</a></li>
  130. <li><a id="toc-Examples" href="#Examples">8.5.2 Examples</a></li>
  131. </ul></li>
  132. <li><a id="toc-libmp3lame-1" href="#libmp3lame-1">8.6 libmp3lame</a>
  133. <ul class="toc-numbered-mark">
  134. <li><a id="toc-Options-13" href="#Options-13">8.6.1 Options</a></li>
  135. </ul></li>
  136. <li><a id="toc-libopencore_002damrnb-1" href="#libopencore_002damrnb-1">8.7 libopencore-amrnb</a>
  137. <ul class="toc-numbered-mark">
  138. <li><a id="toc-Options-14" href="#Options-14">8.7.1 Options</a></li>
  139. </ul></li>
  140. <li><a id="toc-libopus-1" href="#libopus-1">8.8 libopus</a>
  141. <ul class="toc-numbered-mark">
  142. <li><a id="toc-Option-Mapping" href="#Option-Mapping">8.8.1 Option Mapping</a></li>
  143. </ul></li>
  144. <li><a id="toc-libshine-1" href="#libshine-1">8.9 libshine</a>
  145. <ul class="toc-numbered-mark">
  146. <li><a id="toc-Options-15" href="#Options-15">8.9.1 Options</a></li>
  147. </ul></li>
  148. <li><a id="toc-libtwolame" href="#libtwolame">8.10 libtwolame</a>
  149. <ul class="toc-numbered-mark">
  150. <li><a id="toc-Options-16" href="#Options-16">8.10.1 Options</a></li>
  151. </ul></li>
  152. <li><a id="toc-libvo_002damrwbenc" href="#libvo_002damrwbenc">8.11 libvo-amrwbenc</a>
  153. <ul class="toc-numbered-mark">
  154. <li><a id="toc-Options-17" href="#Options-17">8.11.1 Options</a></li>
  155. </ul></li>
  156. <li><a id="toc-libvorbis" href="#libvorbis">8.12 libvorbis</a>
  157. <ul class="toc-numbered-mark">
  158. <li><a id="toc-Options-18" href="#Options-18">8.12.1 Options</a></li>
  159. </ul></li>
  160. <li><a id="toc-mjpeg" href="#mjpeg">8.13 mjpeg</a>
  161. <ul class="toc-numbered-mark">
  162. <li><a id="toc-Options-19" href="#Options-19">8.13.1 Options</a></li>
  163. </ul></li>
  164. <li><a id="toc-wavpack" href="#wavpack">8.14 wavpack</a>
  165. <ul class="toc-numbered-mark">
  166. <li><a id="toc-Options-20" href="#Options-20">8.14.1 Options</a>
  167. <ul class="toc-numbered-mark">
  168. <li><a id="toc-Shared-options" href="#Shared-options">8.14.1.1 Shared options</a></li>
  169. <li><a id="toc-Private-options" href="#Private-options">8.14.1.2 Private options</a></li>
  170. </ul></li>
  171. </ul></li>
  172. </ul></li>
  173. <li><a id="toc-Video-Encoders" href="#Video-Encoders">9 Video Encoders</a>
  174. <ul class="toc-numbered-mark">
  175. <li><a id="toc-a64_005fmulti_002c-a64_005fmulti5" href="#a64_005fmulti_002c-a64_005fmulti5">9.1 a64_multi, a64_multi5</a></li>
  176. <li><a id="toc-Cinepak" href="#Cinepak">9.2 Cinepak</a>
  177. <ul class="toc-numbered-mark">
  178. <li><a id="toc-Options-21" href="#Options-21">9.2.1 Options</a></li>
  179. </ul></li>
  180. <li><a id="toc-GIF" href="#GIF">9.3 GIF</a>
  181. <ul class="toc-numbered-mark">
  182. <li><a id="toc-Options-22" href="#Options-22">9.3.1 Options</a></li>
  183. </ul></li>
  184. <li><a id="toc-Hap" href="#Hap">9.4 Hap</a>
  185. <ul class="toc-numbered-mark">
  186. <li><a id="toc-Options-23" href="#Options-23">9.4.1 Options</a></li>
  187. </ul></li>
  188. <li><a id="toc-jpeg2000" href="#jpeg2000">9.5 jpeg2000</a>
  189. <ul class="toc-numbered-mark">
  190. <li><a id="toc-Options-24" href="#Options-24">9.5.1 Options</a></li>
  191. </ul></li>
  192. <li><a id="toc-librav1e" href="#librav1e">9.6 librav1e</a>
  193. <ul class="toc-numbered-mark">
  194. <li><a id="toc-Options-25" href="#Options-25">9.6.1 Options</a></li>
  195. </ul></li>
  196. <li><a id="toc-libaom_002dav1" href="#libaom_002dav1">9.7 libaom-av1</a>
  197. <ul class="toc-numbered-mark">
  198. <li><a id="toc-Options-26" href="#Options-26">9.7.1 Options</a></li>
  199. </ul></li>
  200. <li><a id="toc-libsvtav1" href="#libsvtav1">9.8 libsvtav1</a>
  201. <ul class="toc-numbered-mark">
  202. <li><a id="toc-Options-27" href="#Options-27">9.8.1 Options</a></li>
  203. </ul></li>
  204. <li><a id="toc-libjxl" href="#libjxl">9.9 libjxl</a>
  205. <ul class="toc-numbered-mark">
  206. <li><a id="toc-Options-28" href="#Options-28">9.9.1 Options</a></li>
  207. </ul></li>
  208. <li><a id="toc-libkvazaar" href="#libkvazaar">9.10 libkvazaar</a>
  209. <ul class="toc-numbered-mark">
  210. <li><a id="toc-Options-29" href="#Options-29">9.10.1 Options</a></li>
  211. </ul></li>
  212. <li><a id="toc-libopenh264" href="#libopenh264">9.11 libopenh264</a>
  213. <ul class="toc-numbered-mark">
  214. <li><a id="toc-Options-30" href="#Options-30">9.11.1 Options</a></li>
  215. </ul></li>
  216. <li><a id="toc-libtheora" href="#libtheora">9.12 libtheora</a>
  217. <ul class="toc-numbered-mark">
  218. <li><a id="toc-Options-31" href="#Options-31">9.12.1 Options</a></li>
  219. <li><a id="toc-Examples-1" href="#Examples-1">9.12.2 Examples</a></li>
  220. </ul></li>
  221. <li><a id="toc-libvpx" href="#libvpx">9.13 libvpx</a>
  222. <ul class="toc-numbered-mark">
  223. <li><a id="toc-Options-32" href="#Options-32">9.13.1 Options</a></li>
  224. </ul></li>
  225. <li><a id="toc-libwebp" href="#libwebp">9.14 libwebp</a>
  226. <ul class="toc-numbered-mark">
  227. <li><a id="toc-Pixel-Format" href="#Pixel-Format">9.14.1 Pixel Format</a></li>
  228. <li><a id="toc-Options-33" href="#Options-33">9.14.2 Options</a></li>
  229. </ul></li>
  230. <li><a id="toc-libx264_002c-libx264rgb" href="#libx264_002c-libx264rgb">9.15 libx264, libx264rgb</a>
  231. <ul class="toc-numbered-mark">
  232. <li><a id="toc-Supported-Pixel-Formats" href="#Supported-Pixel-Formats">9.15.1 Supported Pixel Formats</a></li>
  233. <li><a id="toc-Options-34" href="#Options-34">9.15.2 Options</a></li>
  234. </ul></li>
  235. <li><a id="toc-libx265" href="#libx265">9.16 libx265</a>
  236. <ul class="toc-numbered-mark">
  237. <li><a id="toc-Options-35" href="#Options-35">9.16.1 Options</a></li>
  238. </ul></li>
  239. <li><a id="toc-libxavs2" href="#libxavs2">9.17 libxavs2</a>
  240. <ul class="toc-numbered-mark">
  241. <li><a id="toc-Options-36" href="#Options-36">9.17.1 Options</a></li>
  242. </ul></li>
  243. <li><a id="toc-libxvid" href="#libxvid">9.18 libxvid</a>
  244. <ul class="toc-numbered-mark">
  245. <li><a id="toc-Options-37" href="#Options-37">9.18.1 Options</a></li>
  246. </ul></li>
  247. <li><a id="toc-MediaFoundation" href="#MediaFoundation">9.19 MediaFoundation</a></li>
  248. <li><a id="toc-mpeg2" href="#mpeg2">9.20 mpeg2</a>
  249. <ul class="toc-numbered-mark">
  250. <li><a id="toc-Options-38" href="#Options-38">9.20.1 Options</a></li>
  251. </ul></li>
  252. <li><a id="toc-png" href="#png">9.21 png</a>
  253. <ul class="toc-numbered-mark">
  254. <li><a id="toc-Private-options-1" href="#Private-options-1">9.21.1 Private options</a></li>
  255. </ul></li>
  256. <li><a id="toc-ProRes" href="#ProRes">9.22 ProRes</a>
  257. <ul class="toc-numbered-mark">
  258. <li><a id="toc-Private-Options-for-prores_002dks" href="#Private-Options-for-prores_002dks">9.22.1 Private Options for prores-ks</a></li>
  259. <li><a id="toc-Speed-considerations" href="#Speed-considerations">9.22.2 Speed considerations</a></li>
  260. </ul></li>
  261. <li><a id="toc-QSV-Encoders" href="#QSV-Encoders">9.23 QSV Encoders</a>
  262. <ul class="toc-numbered-mark">
  263. <li><a id="toc-Ratecontrol-Method" href="#Ratecontrol-Method">9.23.1 Ratecontrol Method</a></li>
  264. <li><a id="toc-Global-Options-_002d_003e-MSDK-Options" href="#Global-Options-_002d_003e-MSDK-Options">9.23.2 Global Options -&gt; MSDK Options</a></li>
  265. <li><a id="toc-Common-Options-1" href="#Common-Options-1">9.23.3 Common Options</a></li>
  266. <li><a id="toc-Runtime-Options" href="#Runtime-Options">9.23.4 Runtime Options</a></li>
  267. <li><a id="toc-H264-options" href="#H264-options">9.23.5 H264 options</a></li>
  268. <li><a id="toc-HEVC-Options-1" href="#HEVC-Options-1">9.23.6 HEVC Options</a></li>
  269. <li><a id="toc-MPEG2-Options" href="#MPEG2-Options">9.23.7 MPEG2 Options</a></li>
  270. <li><a id="toc-VP9-Options" href="#VP9-Options">9.23.8 VP9 Options</a></li>
  271. </ul></li>
  272. <li><a id="toc-snow" href="#snow">9.24 snow</a>
  273. <ul class="toc-numbered-mark">
  274. <li><a id="toc-Options-39" href="#Options-39">9.24.1 Options</a></li>
  275. </ul></li>
  276. <li><a id="toc-VAAPI-encoders" href="#VAAPI-encoders">9.25 VAAPI encoders</a></li>
  277. <li><a id="toc-vbn" href="#vbn">9.26 vbn</a>
  278. <ul class="toc-numbered-mark">
  279. <li><a id="toc-Options-40" href="#Options-40">9.26.1 Options</a></li>
  280. </ul></li>
  281. <li><a id="toc-vc2" href="#vc2">9.27 vc2</a>
  282. <ul class="toc-numbered-mark">
  283. <li><a id="toc-Options-41" href="#Options-41">9.27.1 Options</a></li>
  284. </ul></li>
  285. </ul></li>
  286. <li><a id="toc-Subtitles-Encoders" href="#Subtitles-Encoders">10 Subtitles Encoders</a>
  287. <ul class="toc-numbered-mark">
  288. <li><a id="toc-dvdsub-1" href="#dvdsub-1">10.1 dvdsub</a>
  289. <ul class="toc-numbered-mark">
  290. <li><a id="toc-Options-42" href="#Options-42">10.1.1 Options</a></li>
  291. </ul></li>
  292. </ul></li>
  293. <li><a id="toc-See-Also" href="#See-Also">11 See Also</a></li>
  294. <li><a id="toc-Authors" href="#Authors">12 Authors</a></li>
  295. </ul>
  296. </div>
  297. </div>
  298. <ul class="mini-toc">
  299. <li><a href="#Description" accesskey="1">Description</a></li>
  300. <li><a href="#Codec-Options" accesskey="2">Codec Options</a></li>
  301. <li><a href="#Decoders" accesskey="3">Decoders</a></li>
  302. <li><a href="#Video-Decoders" accesskey="4">Video Decoders</a></li>
  303. <li><a href="#Audio-Decoders" accesskey="5">Audio Decoders</a></li>
  304. <li><a href="#Subtitles-Decoders" accesskey="6">Subtitles Decoders</a></li>
  305. <li><a href="#Encoders" accesskey="7">Encoders</a></li>
  306. <li><a href="#Audio-Encoders" accesskey="8">Audio Encoders</a></li>
  307. <li><a href="#Video-Encoders" accesskey="9">Video Encoders</a></li>
  308. <li><a href="#Subtitles-Encoders">Subtitles Encoders</a></li>
  309. <li><a href="#See-Also">See Also</a></li>
  310. <li><a href="#Authors">Authors</a></li>
  311. </ul>
  312. <div class="chapter-level-extent" id="Description">
  313. <h2 class="chapter"><span>1 Description<a class="copiable-link" href="#Description"> &para;</a></span></h2>
  314. <p>This document describes the codecs (decoders and encoders) provided by
  315. the libavcodec library.
  316. </p>
  317. <a class="anchor" id="codec_002doptions"></a></div>
  318. <div class="chapter-level-extent" id="Codec-Options">
  319. <h2 class="chapter"><span>2 Codec Options<a class="copiable-link" href="#Codec-Options"> &para;</a></span></h2>
  320. <p>libavcodec provides some generic global options, which can be set on
  321. all the encoders and decoders. In addition each codec may support
  322. so-called private options, which are specific for a given codec.
  323. </p>
  324. <p>Sometimes, a global option may only affect a specific kind of codec,
  325. and may be nonsensical or ignored by another, so you need to be aware
  326. of the meaning of the specified options. Also some options are
  327. meant only for decoding or encoding.
  328. </p>
  329. <p>Options may be set by specifying -<var class="var">option</var> <var class="var">value</var> in the
  330. FFmpeg tools, or by setting the value explicitly in the
  331. <code class="code">AVCodecContext</code> options or using the <samp class="file">libavutil/opt.h</samp> API
  332. for programmatic use.
  333. </p>
  334. <p>The list of supported options follow:
  335. </p>
  336. <dl class="table">
  337. <dt><samp class="option">b <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  338. <dd><p>Set bitrate in bits/s. Default value is 200K.
  339. </p>
  340. </dd>
  341. <dt><samp class="option">ab <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
  342. <dd><p>Set audio bitrate (in bits/s). Default value is 128K.
  343. </p>
  344. </dd>
  345. <dt><samp class="option">bt <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  346. <dd><p>Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate
  347. tolerance specifies how far ratecontrol is willing to deviate from the
  348. target average bitrate value. This is not related to min/max
  349. bitrate. Lowering tolerance too much has an adverse effect on quality.
  350. </p>
  351. </dd>
  352. <dt><samp class="option">flags <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
  353. <dd><p>Set generic flags.
  354. </p>
  355. <p>Possible values:
  356. </p><dl class="table">
  357. <dt>&lsquo;<samp class="samp">mv4</samp>&rsquo;</dt>
  358. <dd><p>Use four motion vector by macroblock (mpeg4).
  359. </p></dd>
  360. <dt>&lsquo;<samp class="samp">qpel</samp>&rsquo;</dt>
  361. <dd><p>Use 1/4 pel motion compensation.
  362. </p></dd>
  363. <dt>&lsquo;<samp class="samp">loop</samp>&rsquo;</dt>
  364. <dd><p>Use loop filter.
  365. </p></dd>
  366. <dt>&lsquo;<samp class="samp">qscale</samp>&rsquo;</dt>
  367. <dd><p>Use fixed qscale.
  368. </p></dd>
  369. <dt>&lsquo;<samp class="samp">pass1</samp>&rsquo;</dt>
  370. <dd><p>Use internal 2pass ratecontrol in first pass mode.
  371. </p></dd>
  372. <dt>&lsquo;<samp class="samp">pass2</samp>&rsquo;</dt>
  373. <dd><p>Use internal 2pass ratecontrol in second pass mode.
  374. </p></dd>
  375. <dt>&lsquo;<samp class="samp">gray</samp>&rsquo;</dt>
  376. <dd><p>Only decode/encode grayscale.
  377. </p></dd>
  378. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  379. <dd><p>Set error[?] variables during encoding.
  380. </p></dd>
  381. <dt>&lsquo;<samp class="samp">truncated</samp>&rsquo;</dt>
  382. <dd><p>Input bitstream might be randomly truncated.
  383. </p></dd>
  384. <dt>&lsquo;<samp class="samp">drop_changed</samp>&rsquo;</dt>
  385. <dd><p>Don&rsquo;t output frames whose parameters differ from first decoded frame in stream.
  386. Error AVERROR_INPUT_CHANGED is returned when a frame is dropped.
  387. </p>
  388. </dd>
  389. <dt>&lsquo;<samp class="samp">ildct</samp>&rsquo;</dt>
  390. <dd><p>Use interlaced DCT.
  391. </p></dd>
  392. <dt>&lsquo;<samp class="samp">low_delay</samp>&rsquo;</dt>
  393. <dd><p>Force low delay.
  394. </p></dd>
  395. <dt>&lsquo;<samp class="samp">global_header</samp>&rsquo;</dt>
  396. <dd><p>Place global headers in extradata instead of every keyframe.
  397. </p></dd>
  398. <dt>&lsquo;<samp class="samp">bitexact</samp>&rsquo;</dt>
  399. <dd><p>Only write platform-, build- and time-independent data. (except (I)DCT).
  400. This ensures that file and data checksums are reproducible and match between
  401. platforms. Its primary use is for regression testing.
  402. </p></dd>
  403. <dt>&lsquo;<samp class="samp">aic</samp>&rsquo;</dt>
  404. <dd><p>Apply H263 advanced intra coding / mpeg4 ac prediction.
  405. </p></dd>
  406. <dt>&lsquo;<samp class="samp">ilme</samp>&rsquo;</dt>
  407. <dd><p>Apply interlaced motion estimation.
  408. </p></dd>
  409. <dt>&lsquo;<samp class="samp">cgop</samp>&rsquo;</dt>
  410. <dd><p>Use closed gop.
  411. </p></dd>
  412. <dt>&lsquo;<samp class="samp">output_corrupt</samp>&rsquo;</dt>
  413. <dd><p>Output even potentially corrupted frames.
  414. </p></dd>
  415. </dl>
  416. </dd>
  417. <dt><samp class="option">time_base <var class="var">rational number</var></samp></dt>
  418. <dd><p>Set codec time base.
  419. </p>
  420. <p>It is the fundamental unit of time (in seconds) in terms of which
  421. frame timestamps are represented. For fixed-fps content, timebase
  422. should be <code class="code">1 / frame_rate</code> and timestamp increments should be
  423. identically 1.
  424. </p>
  425. </dd>
  426. <dt><samp class="option">g <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  427. <dd><p>Set the group of picture (GOP) size. Default value is 12.
  428. </p>
  429. </dd>
  430. <dt><samp class="option">ar <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
  431. <dd><p>Set audio sampling rate (in Hz).
  432. </p>
  433. </dd>
  434. <dt><samp class="option">ac <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
  435. <dd><p>Set number of audio channels.
  436. </p>
  437. </dd>
  438. <dt><samp class="option">cutoff <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
  439. <dd><p>Set cutoff bandwidth. (Supported only by selected encoders, see
  440. their respective documentation sections.)
  441. </p>
  442. </dd>
  443. <dt><samp class="option">frame_size <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
  444. <dd><p>Set audio frame size.
  445. </p>
  446. <p>Each submitted frame except the last must contain exactly frame_size
  447. samples per channel. May be 0 when the codec has
  448. CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not
  449. restricted. It is set by some decoders to indicate constant frame
  450. size.
  451. </p>
  452. </dd>
  453. <dt><samp class="option">frame_number <var class="var">integer</var></samp></dt>
  454. <dd><p>Set the frame number.
  455. </p>
  456. </dd>
  457. <dt><samp class="option">delay <var class="var">integer</var></samp></dt>
  458. <dt><samp class="option">qcomp <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  459. <dd><p>Set video quantizer scale compression (VBR). It is used as a constant
  460. in the ratecontrol equation. Recommended range for default rc_eq:
  461. 0.0-1.0.
  462. </p>
  463. </dd>
  464. <dt><samp class="option">qblur <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  465. <dd><p>Set video quantizer scale blur (VBR).
  466. </p>
  467. </dd>
  468. <dt><samp class="option">qmin <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  469. <dd><p>Set min video quantizer scale (VBR). Must be included between -1 and
  470. 69, default value is 2.
  471. </p>
  472. </dd>
  473. <dt><samp class="option">qmax <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  474. <dd><p>Set max video quantizer scale (VBR). Must be included between -1 and
  475. 1024, default value is 31.
  476. </p>
  477. </dd>
  478. <dt><samp class="option">qdiff <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  479. <dd><p>Set max difference between the quantizer scale (VBR).
  480. </p>
  481. </dd>
  482. <dt><samp class="option">bf <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  483. <dd><p>Set max number of B frames between non-B-frames.
  484. </p>
  485. <p>Must be an integer between -1 and 16. 0 means that B-frames are
  486. disabled. If a value of -1 is used, it will choose an automatic value
  487. depending on the encoder.
  488. </p>
  489. <p>Default value is 0.
  490. </p>
  491. </dd>
  492. <dt><samp class="option">b_qfactor <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  493. <dd><p>Set qp factor between P and B frames.
  494. </p>
  495. </dd>
  496. <dt><samp class="option">codec_tag <var class="var">integer</var></samp></dt>
  497. <dt><samp class="option">bug <var class="var">flags</var> (<em class="emph">decoding,video</em>)</samp></dt>
  498. <dd><p>Workaround not auto detected encoder bugs.
  499. </p>
  500. <p>Possible values:
  501. </p><dl class="table">
  502. <dt>&lsquo;<samp class="samp">autodetect</samp>&rsquo;</dt>
  503. <dt>&lsquo;<samp class="samp">xvid_ilace</samp>&rsquo;</dt>
  504. <dd><p>Xvid interlacing bug (autodetected if fourcc==XVIX)
  505. </p></dd>
  506. <dt>&lsquo;<samp class="samp">ump4</samp>&rsquo;</dt>
  507. <dd><p>(autodetected if fourcc==UMP4)
  508. </p></dd>
  509. <dt>&lsquo;<samp class="samp">no_padding</samp>&rsquo;</dt>
  510. <dd><p>padding bug (autodetected)
  511. </p></dd>
  512. <dt>&lsquo;<samp class="samp">amv</samp>&rsquo;</dt>
  513. <dt>&lsquo;<samp class="samp">qpel_chroma</samp>&rsquo;</dt>
  514. <dt>&lsquo;<samp class="samp">std_qpel</samp>&rsquo;</dt>
  515. <dd><p>old standard qpel (autodetected per fourcc/version)
  516. </p></dd>
  517. <dt>&lsquo;<samp class="samp">qpel_chroma2</samp>&rsquo;</dt>
  518. <dt>&lsquo;<samp class="samp">direct_blocksize</samp>&rsquo;</dt>
  519. <dd><p>direct-qpel-blocksize bug (autodetected per fourcc/version)
  520. </p></dd>
  521. <dt>&lsquo;<samp class="samp">edge</samp>&rsquo;</dt>
  522. <dd><p>edge padding bug (autodetected per fourcc/version)
  523. </p></dd>
  524. <dt>&lsquo;<samp class="samp">hpel_chroma</samp>&rsquo;</dt>
  525. <dt>&lsquo;<samp class="samp">dc_clip</samp>&rsquo;</dt>
  526. <dt>&lsquo;<samp class="samp">ms</samp>&rsquo;</dt>
  527. <dd><p>Workaround various bugs in microsoft broken decoders.
  528. </p></dd>
  529. <dt>&lsquo;<samp class="samp">trunc</samp>&rsquo;</dt>
  530. <dd><p>trancated frames
  531. </p></dd>
  532. </dl>
  533. </dd>
  534. <dt><samp class="option">strict <var class="var">integer</var> (<em class="emph">decoding/encoding,audio,video</em>)</samp></dt>
  535. <dd><p>Specify how strictly to follow the standards.
  536. </p>
  537. <p>Possible values:
  538. </p><dl class="table">
  539. <dt>&lsquo;<samp class="samp">very</samp>&rsquo;</dt>
  540. <dd><p>strictly conform to an older more strict version of the spec or reference software
  541. </p></dd>
  542. <dt>&lsquo;<samp class="samp">strict</samp>&rsquo;</dt>
  543. <dd><p>strictly conform to all the things in the spec no matter what consequences
  544. </p></dd>
  545. <dt>&lsquo;<samp class="samp">normal</samp>&rsquo;</dt>
  546. <dt>&lsquo;<samp class="samp">unofficial</samp>&rsquo;</dt>
  547. <dd><p>allow unofficial extensions
  548. </p></dd>
  549. <dt>&lsquo;<samp class="samp">experimental</samp>&rsquo;</dt>
  550. <dd><p>allow non standardized experimental things, experimental
  551. (unfinished/work in progress/not well tested) decoders and encoders.
  552. Note: experimental decoders can pose a security risk, do not use this for
  553. decoding untrusted input.
  554. </p></dd>
  555. </dl>
  556. </dd>
  557. <dt><samp class="option">b_qoffset <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  558. <dd><p>Set QP offset between P and B frames.
  559. </p>
  560. </dd>
  561. <dt><samp class="option">err_detect <var class="var">flags</var> (<em class="emph">decoding,audio,video</em>)</samp></dt>
  562. <dd><p>Set error detection flags.
  563. </p>
  564. <p>Possible values:
  565. </p><dl class="table">
  566. <dt>&lsquo;<samp class="samp">crccheck</samp>&rsquo;</dt>
  567. <dd><p>verify embedded CRCs
  568. </p></dd>
  569. <dt>&lsquo;<samp class="samp">bitstream</samp>&rsquo;</dt>
  570. <dd><p>detect bitstream specification deviations
  571. </p></dd>
  572. <dt>&lsquo;<samp class="samp">buffer</samp>&rsquo;</dt>
  573. <dd><p>detect improper bitstream length
  574. </p></dd>
  575. <dt>&lsquo;<samp class="samp">explode</samp>&rsquo;</dt>
  576. <dd><p>abort decoding on minor error detection
  577. </p></dd>
  578. <dt>&lsquo;<samp class="samp">ignore_err</samp>&rsquo;</dt>
  579. <dd><p>ignore decoding errors, and continue decoding.
  580. This is useful if you want to analyze the content of a video and thus want
  581. everything to be decoded no matter what. This option will not result in a video
  582. that is pleasing to watch in case of errors.
  583. </p></dd>
  584. <dt>&lsquo;<samp class="samp">careful</samp>&rsquo;</dt>
  585. <dd><p>consider things that violate the spec and have not been seen in the wild as errors
  586. </p></dd>
  587. <dt>&lsquo;<samp class="samp">compliant</samp>&rsquo;</dt>
  588. <dd><p>consider all spec non compliancies as errors
  589. </p></dd>
  590. <dt>&lsquo;<samp class="samp">aggressive</samp>&rsquo;</dt>
  591. <dd><p>consider things that a sane encoder should not do as an error
  592. </p></dd>
  593. </dl>
  594. </dd>
  595. <dt><samp class="option">has_b_frames <var class="var">integer</var></samp></dt>
  596. <dt><samp class="option">block_align <var class="var">integer</var></samp></dt>
  597. <dt><samp class="option">rc_override_count <var class="var">integer</var></samp></dt>
  598. <dt><samp class="option">maxrate <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  599. <dd><p>Set max bitrate tolerance (in bits/s). Requires bufsize to be set.
  600. </p>
  601. </dd>
  602. <dt><samp class="option">minrate <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  603. <dd><p>Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR
  604. encode. It is of little use elsewise.
  605. </p>
  606. </dd>
  607. <dt><samp class="option">bufsize <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  608. <dd><p>Set ratecontrol buffer size (in bits).
  609. </p>
  610. </dd>
  611. <dt><samp class="option">i_qfactor <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  612. <dd><p>Set QP factor between P and I frames.
  613. </p>
  614. </dd>
  615. <dt><samp class="option">i_qoffset <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  616. <dd><p>Set QP offset between P and I frames.
  617. </p>
  618. </dd>
  619. <dt><samp class="option">dct <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  620. <dd><p>Set DCT algorithm.
  621. </p>
  622. <p>Possible values:
  623. </p><dl class="table">
  624. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  625. <dd><p>autoselect a good one (default)
  626. </p></dd>
  627. <dt>&lsquo;<samp class="samp">fastint</samp>&rsquo;</dt>
  628. <dd><p>fast integer
  629. </p></dd>
  630. <dt>&lsquo;<samp class="samp">int</samp>&rsquo;</dt>
  631. <dd><p>accurate integer
  632. </p></dd>
  633. <dt>&lsquo;<samp class="samp">mmx</samp>&rsquo;</dt>
  634. <dt>&lsquo;<samp class="samp">altivec</samp>&rsquo;</dt>
  635. <dt>&lsquo;<samp class="samp">faan</samp>&rsquo;</dt>
  636. <dd><p>floating point AAN DCT
  637. </p></dd>
  638. </dl>
  639. </dd>
  640. <dt><samp class="option">lumi_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  641. <dd><p>Compress bright areas stronger than medium ones.
  642. </p>
  643. </dd>
  644. <dt><samp class="option">tcplx_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  645. <dd><p>Set temporal complexity masking.
  646. </p>
  647. </dd>
  648. <dt><samp class="option">scplx_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  649. <dd><p>Set spatial complexity masking.
  650. </p>
  651. </dd>
  652. <dt><samp class="option">p_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  653. <dd><p>Set inter masking.
  654. </p>
  655. </dd>
  656. <dt><samp class="option">dark_mask <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  657. <dd><p>Compress dark areas stronger than medium ones.
  658. </p>
  659. </dd>
  660. <dt><samp class="option">idct <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  661. <dd><p>Select IDCT implementation.
  662. </p>
  663. <p>Possible values:
  664. </p><dl class="table">
  665. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  666. <dt>&lsquo;<samp class="samp">int</samp>&rsquo;</dt>
  667. <dt>&lsquo;<samp class="samp">simple</samp>&rsquo;</dt>
  668. <dt>&lsquo;<samp class="samp">simplemmx</samp>&rsquo;</dt>
  669. <dt>&lsquo;<samp class="samp">simpleauto</samp>&rsquo;</dt>
  670. <dd><p>Automatically pick a IDCT compatible with the simple one
  671. </p>
  672. </dd>
  673. <dt>&lsquo;<samp class="samp">arm</samp>&rsquo;</dt>
  674. <dt>&lsquo;<samp class="samp">altivec</samp>&rsquo;</dt>
  675. <dt>&lsquo;<samp class="samp">sh4</samp>&rsquo;</dt>
  676. <dt>&lsquo;<samp class="samp">simplearm</samp>&rsquo;</dt>
  677. <dt>&lsquo;<samp class="samp">simplearmv5te</samp>&rsquo;</dt>
  678. <dt>&lsquo;<samp class="samp">simplearmv6</samp>&rsquo;</dt>
  679. <dt>&lsquo;<samp class="samp">simpleneon</samp>&rsquo;</dt>
  680. <dt>&lsquo;<samp class="samp">xvid</samp>&rsquo;</dt>
  681. <dt>&lsquo;<samp class="samp">faani</samp>&rsquo;</dt>
  682. <dd><p>floating point AAN IDCT
  683. </p></dd>
  684. </dl>
  685. </dd>
  686. <dt><samp class="option">slice_count <var class="var">integer</var></samp></dt>
  687. <dt><samp class="option">ec <var class="var">flags</var> (<em class="emph">decoding,video</em>)</samp></dt>
  688. <dd><p>Set error concealment strategy.
  689. </p>
  690. <p>Possible values:
  691. </p><dl class="table">
  692. <dt>&lsquo;<samp class="samp">guess_mvs</samp>&rsquo;</dt>
  693. <dd><p>iterative motion vector (MV) search (slow)
  694. </p></dd>
  695. <dt>&lsquo;<samp class="samp">deblock</samp>&rsquo;</dt>
  696. <dd><p>use strong deblock filter for damaged MBs
  697. </p></dd>
  698. <dt>&lsquo;<samp class="samp">favor_inter</samp>&rsquo;</dt>
  699. <dd><p>favor predicting from the previous frame instead of the current
  700. </p></dd>
  701. </dl>
  702. </dd>
  703. <dt><samp class="option">bits_per_coded_sample <var class="var">integer</var></samp></dt>
  704. <dt><samp class="option">aspect <var class="var">rational number</var> (<em class="emph">encoding,video</em>)</samp></dt>
  705. <dd><p>Set sample aspect ratio.
  706. </p>
  707. </dd>
  708. <dt><samp class="option">sar <var class="var">rational number</var> (<em class="emph">encoding,video</em>)</samp></dt>
  709. <dd><p>Set sample aspect ratio. Alias to <var class="var">aspect</var>.
  710. </p>
  711. </dd>
  712. <dt><samp class="option">debug <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
  713. <dd><p>Print specific debug info.
  714. </p>
  715. <p>Possible values:
  716. </p><dl class="table">
  717. <dt>&lsquo;<samp class="samp">pict</samp>&rsquo;</dt>
  718. <dd><p>picture info
  719. </p></dd>
  720. <dt>&lsquo;<samp class="samp">rc</samp>&rsquo;</dt>
  721. <dd><p>rate control
  722. </p></dd>
  723. <dt>&lsquo;<samp class="samp">bitstream</samp>&rsquo;</dt>
  724. <dt>&lsquo;<samp class="samp">mb_type</samp>&rsquo;</dt>
  725. <dd><p>macroblock (MB) type
  726. </p></dd>
  727. <dt>&lsquo;<samp class="samp">qp</samp>&rsquo;</dt>
  728. <dd><p>per-block quantization parameter (QP)
  729. </p></dd>
  730. <dt>&lsquo;<samp class="samp">dct_coeff</samp>&rsquo;</dt>
  731. <dt>&lsquo;<samp class="samp">green_metadata</samp>&rsquo;</dt>
  732. <dd><p>display complexity metadata for the upcoming frame, GoP or for a given duration.
  733. </p>
  734. </dd>
  735. <dt>&lsquo;<samp class="samp">skip</samp>&rsquo;</dt>
  736. <dt>&lsquo;<samp class="samp">startcode</samp>&rsquo;</dt>
  737. <dt>&lsquo;<samp class="samp">er</samp>&rsquo;</dt>
  738. <dd><p>error recognition
  739. </p></dd>
  740. <dt>&lsquo;<samp class="samp">mmco</samp>&rsquo;</dt>
  741. <dd><p>memory management control operations (H.264)
  742. </p></dd>
  743. <dt>&lsquo;<samp class="samp">bugs</samp>&rsquo;</dt>
  744. <dt>&lsquo;<samp class="samp">buffers</samp>&rsquo;</dt>
  745. <dd><p>picture buffer allocations
  746. </p></dd>
  747. <dt>&lsquo;<samp class="samp">thread_ops</samp>&rsquo;</dt>
  748. <dd><p>threading operations
  749. </p></dd>
  750. <dt>&lsquo;<samp class="samp">nomc</samp>&rsquo;</dt>
  751. <dd><p>skip motion compensation
  752. </p></dd>
  753. </dl>
  754. </dd>
  755. <dt><samp class="option">cmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  756. <dd><p>Set full pel me compare function.
  757. </p>
  758. <p>Possible values:
  759. </p><dl class="table">
  760. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  761. <dd><p>sum of absolute differences, fast (default)
  762. </p></dd>
  763. <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
  764. <dd><p>sum of squared errors
  765. </p></dd>
  766. <dt>&lsquo;<samp class="samp">satd</samp>&rsquo;</dt>
  767. <dd><p>sum of absolute Hadamard transformed differences
  768. </p></dd>
  769. <dt>&lsquo;<samp class="samp">dct</samp>&rsquo;</dt>
  770. <dd><p>sum of absolute DCT transformed differences
  771. </p></dd>
  772. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  773. <dd><p>sum of squared quantization errors (avoid, low quality)
  774. </p></dd>
  775. <dt>&lsquo;<samp class="samp">bit</samp>&rsquo;</dt>
  776. <dd><p>number of bits needed for the block
  777. </p></dd>
  778. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  779. <dd><p>rate distortion optimal, slow
  780. </p></dd>
  781. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  782. <dd><p>0
  783. </p></dd>
  784. <dt>&lsquo;<samp class="samp">vsad</samp>&rsquo;</dt>
  785. <dd><p>sum of absolute vertical differences
  786. </p></dd>
  787. <dt>&lsquo;<samp class="samp">vsse</samp>&rsquo;</dt>
  788. <dd><p>sum of squared vertical differences
  789. </p></dd>
  790. <dt>&lsquo;<samp class="samp">nsse</samp>&rsquo;</dt>
  791. <dd><p>noise preserving sum of squared differences
  792. </p></dd>
  793. <dt>&lsquo;<samp class="samp">w53</samp>&rsquo;</dt>
  794. <dd><p>5/3 wavelet, only used in snow
  795. </p></dd>
  796. <dt>&lsquo;<samp class="samp">w97</samp>&rsquo;</dt>
  797. <dd><p>9/7 wavelet, only used in snow
  798. </p></dd>
  799. <dt>&lsquo;<samp class="samp">dctmax</samp>&rsquo;</dt>
  800. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  801. </dl>
  802. </dd>
  803. <dt><samp class="option">subcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  804. <dd><p>Set sub pel me compare function.
  805. </p>
  806. <p>Possible values:
  807. </p><dl class="table">
  808. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  809. <dd><p>sum of absolute differences, fast (default)
  810. </p></dd>
  811. <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
  812. <dd><p>sum of squared errors
  813. </p></dd>
  814. <dt>&lsquo;<samp class="samp">satd</samp>&rsquo;</dt>
  815. <dd><p>sum of absolute Hadamard transformed differences
  816. </p></dd>
  817. <dt>&lsquo;<samp class="samp">dct</samp>&rsquo;</dt>
  818. <dd><p>sum of absolute DCT transformed differences
  819. </p></dd>
  820. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  821. <dd><p>sum of squared quantization errors (avoid, low quality)
  822. </p></dd>
  823. <dt>&lsquo;<samp class="samp">bit</samp>&rsquo;</dt>
  824. <dd><p>number of bits needed for the block
  825. </p></dd>
  826. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  827. <dd><p>rate distortion optimal, slow
  828. </p></dd>
  829. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  830. <dd><p>0
  831. </p></dd>
  832. <dt>&lsquo;<samp class="samp">vsad</samp>&rsquo;</dt>
  833. <dd><p>sum of absolute vertical differences
  834. </p></dd>
  835. <dt>&lsquo;<samp class="samp">vsse</samp>&rsquo;</dt>
  836. <dd><p>sum of squared vertical differences
  837. </p></dd>
  838. <dt>&lsquo;<samp class="samp">nsse</samp>&rsquo;</dt>
  839. <dd><p>noise preserving sum of squared differences
  840. </p></dd>
  841. <dt>&lsquo;<samp class="samp">w53</samp>&rsquo;</dt>
  842. <dd><p>5/3 wavelet, only used in snow
  843. </p></dd>
  844. <dt>&lsquo;<samp class="samp">w97</samp>&rsquo;</dt>
  845. <dd><p>9/7 wavelet, only used in snow
  846. </p></dd>
  847. <dt>&lsquo;<samp class="samp">dctmax</samp>&rsquo;</dt>
  848. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  849. </dl>
  850. </dd>
  851. <dt><samp class="option">mbcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  852. <dd><p>Set macroblock compare function.
  853. </p>
  854. <p>Possible values:
  855. </p><dl class="table">
  856. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  857. <dd><p>sum of absolute differences, fast (default)
  858. </p></dd>
  859. <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
  860. <dd><p>sum of squared errors
  861. </p></dd>
  862. <dt>&lsquo;<samp class="samp">satd</samp>&rsquo;</dt>
  863. <dd><p>sum of absolute Hadamard transformed differences
  864. </p></dd>
  865. <dt>&lsquo;<samp class="samp">dct</samp>&rsquo;</dt>
  866. <dd><p>sum of absolute DCT transformed differences
  867. </p></dd>
  868. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  869. <dd><p>sum of squared quantization errors (avoid, low quality)
  870. </p></dd>
  871. <dt>&lsquo;<samp class="samp">bit</samp>&rsquo;</dt>
  872. <dd><p>number of bits needed for the block
  873. </p></dd>
  874. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  875. <dd><p>rate distortion optimal, slow
  876. </p></dd>
  877. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  878. <dd><p>0
  879. </p></dd>
  880. <dt>&lsquo;<samp class="samp">vsad</samp>&rsquo;</dt>
  881. <dd><p>sum of absolute vertical differences
  882. </p></dd>
  883. <dt>&lsquo;<samp class="samp">vsse</samp>&rsquo;</dt>
  884. <dd><p>sum of squared vertical differences
  885. </p></dd>
  886. <dt>&lsquo;<samp class="samp">nsse</samp>&rsquo;</dt>
  887. <dd><p>noise preserving sum of squared differences
  888. </p></dd>
  889. <dt>&lsquo;<samp class="samp">w53</samp>&rsquo;</dt>
  890. <dd><p>5/3 wavelet, only used in snow
  891. </p></dd>
  892. <dt>&lsquo;<samp class="samp">w97</samp>&rsquo;</dt>
  893. <dd><p>9/7 wavelet, only used in snow
  894. </p></dd>
  895. <dt>&lsquo;<samp class="samp">dctmax</samp>&rsquo;</dt>
  896. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  897. </dl>
  898. </dd>
  899. <dt><samp class="option">ildctcmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  900. <dd><p>Set interlaced dct compare function.
  901. </p>
  902. <p>Possible values:
  903. </p><dl class="table">
  904. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  905. <dd><p>sum of absolute differences, fast (default)
  906. </p></dd>
  907. <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
  908. <dd><p>sum of squared errors
  909. </p></dd>
  910. <dt>&lsquo;<samp class="samp">satd</samp>&rsquo;</dt>
  911. <dd><p>sum of absolute Hadamard transformed differences
  912. </p></dd>
  913. <dt>&lsquo;<samp class="samp">dct</samp>&rsquo;</dt>
  914. <dd><p>sum of absolute DCT transformed differences
  915. </p></dd>
  916. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  917. <dd><p>sum of squared quantization errors (avoid, low quality)
  918. </p></dd>
  919. <dt>&lsquo;<samp class="samp">bit</samp>&rsquo;</dt>
  920. <dd><p>number of bits needed for the block
  921. </p></dd>
  922. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  923. <dd><p>rate distortion optimal, slow
  924. </p></dd>
  925. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  926. <dd><p>0
  927. </p></dd>
  928. <dt>&lsquo;<samp class="samp">vsad</samp>&rsquo;</dt>
  929. <dd><p>sum of absolute vertical differences
  930. </p></dd>
  931. <dt>&lsquo;<samp class="samp">vsse</samp>&rsquo;</dt>
  932. <dd><p>sum of squared vertical differences
  933. </p></dd>
  934. <dt>&lsquo;<samp class="samp">nsse</samp>&rsquo;</dt>
  935. <dd><p>noise preserving sum of squared differences
  936. </p></dd>
  937. <dt>&lsquo;<samp class="samp">w53</samp>&rsquo;</dt>
  938. <dd><p>5/3 wavelet, only used in snow
  939. </p></dd>
  940. <dt>&lsquo;<samp class="samp">w97</samp>&rsquo;</dt>
  941. <dd><p>9/7 wavelet, only used in snow
  942. </p></dd>
  943. <dt>&lsquo;<samp class="samp">dctmax</samp>&rsquo;</dt>
  944. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  945. </dl>
  946. </dd>
  947. <dt><samp class="option">dia_size <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  948. <dd><p>Set diamond type &amp; size for motion estimation.
  949. </p><dl class="table">
  950. <dt>&lsquo;<samp class="samp">(1024, INT_MAX)</samp>&rsquo;</dt>
  951. <dd><p>full motion estimation(slowest)
  952. </p></dd>
  953. <dt>&lsquo;<samp class="samp">(768, 1024]</samp>&rsquo;</dt>
  954. <dd><p>umh motion estimation
  955. </p></dd>
  956. <dt>&lsquo;<samp class="samp">(512, 768]</samp>&rsquo;</dt>
  957. <dd><p>hex motion estimation
  958. </p></dd>
  959. <dt>&lsquo;<samp class="samp">(256, 512]</samp>&rsquo;</dt>
  960. <dd><p>l2s diamond motion estimation
  961. </p></dd>
  962. <dt>&lsquo;<samp class="samp">[2,256]</samp>&rsquo;</dt>
  963. <dd><p>var diamond motion estimation
  964. </p></dd>
  965. <dt>&lsquo;<samp class="samp">(-1, 2)</samp>&rsquo;</dt>
  966. <dd><p>small diamond motion estimation
  967. </p></dd>
  968. <dt>&lsquo;<samp class="samp">-1</samp>&rsquo;</dt>
  969. <dd><p>funny diamond motion estimation
  970. </p></dd>
  971. <dt>&lsquo;<samp class="samp">(INT_MIN, -1)</samp>&rsquo;</dt>
  972. <dd><p>sab diamond motion estimation
  973. </p></dd>
  974. </dl>
  975. </dd>
  976. <dt><samp class="option">last_pred <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  977. <dd><p>Set amount of motion predictors from the previous frame.
  978. </p>
  979. </dd>
  980. <dt><samp class="option">precmp <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  981. <dd><p>Set pre motion estimation compare function.
  982. </p>
  983. <p>Possible values:
  984. </p><dl class="table">
  985. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  986. <dd><p>sum of absolute differences, fast (default)
  987. </p></dd>
  988. <dt>&lsquo;<samp class="samp">sse</samp>&rsquo;</dt>
  989. <dd><p>sum of squared errors
  990. </p></dd>
  991. <dt>&lsquo;<samp class="samp">satd</samp>&rsquo;</dt>
  992. <dd><p>sum of absolute Hadamard transformed differences
  993. </p></dd>
  994. <dt>&lsquo;<samp class="samp">dct</samp>&rsquo;</dt>
  995. <dd><p>sum of absolute DCT transformed differences
  996. </p></dd>
  997. <dt>&lsquo;<samp class="samp">psnr</samp>&rsquo;</dt>
  998. <dd><p>sum of squared quantization errors (avoid, low quality)
  999. </p></dd>
  1000. <dt>&lsquo;<samp class="samp">bit</samp>&rsquo;</dt>
  1001. <dd><p>number of bits needed for the block
  1002. </p></dd>
  1003. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  1004. <dd><p>rate distortion optimal, slow
  1005. </p></dd>
  1006. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  1007. <dd><p>0
  1008. </p></dd>
  1009. <dt>&lsquo;<samp class="samp">vsad</samp>&rsquo;</dt>
  1010. <dd><p>sum of absolute vertical differences
  1011. </p></dd>
  1012. <dt>&lsquo;<samp class="samp">vsse</samp>&rsquo;</dt>
  1013. <dd><p>sum of squared vertical differences
  1014. </p></dd>
  1015. <dt>&lsquo;<samp class="samp">nsse</samp>&rsquo;</dt>
  1016. <dd><p>noise preserving sum of squared differences
  1017. </p></dd>
  1018. <dt>&lsquo;<samp class="samp">w53</samp>&rsquo;</dt>
  1019. <dd><p>5/3 wavelet, only used in snow
  1020. </p></dd>
  1021. <dt>&lsquo;<samp class="samp">w97</samp>&rsquo;</dt>
  1022. <dd><p>9/7 wavelet, only used in snow
  1023. </p></dd>
  1024. <dt>&lsquo;<samp class="samp">dctmax</samp>&rsquo;</dt>
  1025. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  1026. </dl>
  1027. </dd>
  1028. <dt><samp class="option">pre_dia_size <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1029. <dd><p>Set diamond type &amp; size for motion estimation pre-pass.
  1030. </p>
  1031. </dd>
  1032. <dt><samp class="option">subq <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1033. <dd><p>Set sub pel motion estimation quality.
  1034. </p>
  1035. </dd>
  1036. <dt><samp class="option">me_range <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1037. <dd><p>Set limit motion vectors range (1023 for DivX player).
  1038. </p>
  1039. </dd>
  1040. <dt><samp class="option">global_quality <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  1041. <dt><samp class="option">slice_flags <var class="var">integer</var></samp></dt>
  1042. <dt><samp class="option">mbd <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1043. <dd><p>Set macroblock decision algorithm (high quality mode).
  1044. </p>
  1045. <p>Possible values:
  1046. </p><dl class="table">
  1047. <dt>&lsquo;<samp class="samp">simple</samp>&rsquo;</dt>
  1048. <dd><p>use mbcmp (default)
  1049. </p></dd>
  1050. <dt>&lsquo;<samp class="samp">bits</samp>&rsquo;</dt>
  1051. <dd><p>use fewest bits
  1052. </p></dd>
  1053. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  1054. <dd><p>use best rate distortion
  1055. </p></dd>
  1056. </dl>
  1057. </dd>
  1058. <dt><samp class="option">rc_init_occupancy <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1059. <dd><p>Set number of bits which should be loaded into the rc buffer before
  1060. decoding starts.
  1061. </p>
  1062. </dd>
  1063. <dt><samp class="option">flags2 <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
  1064. <dd>
  1065. <p>Possible values:
  1066. </p><dl class="table">
  1067. <dt>&lsquo;<samp class="samp">fast</samp>&rsquo;</dt>
  1068. <dd><p>Allow non spec compliant speedup tricks.
  1069. </p></dd>
  1070. <dt>&lsquo;<samp class="samp">noout</samp>&rsquo;</dt>
  1071. <dd><p>Skip bitstream encoding.
  1072. </p></dd>
  1073. <dt>&lsquo;<samp class="samp">ignorecrop</samp>&rsquo;</dt>
  1074. <dd><p>Ignore cropping information from sps.
  1075. </p></dd>
  1076. <dt>&lsquo;<samp class="samp">local_header</samp>&rsquo;</dt>
  1077. <dd><p>Place global headers at every keyframe instead of in extradata.
  1078. </p></dd>
  1079. <dt>&lsquo;<samp class="samp">chunks</samp>&rsquo;</dt>
  1080. <dd><p>Frame data might be split into multiple chunks.
  1081. </p></dd>
  1082. <dt>&lsquo;<samp class="samp">showall</samp>&rsquo;</dt>
  1083. <dd><p>Show all frames before the first keyframe.
  1084. </p></dd>
  1085. <dt>&lsquo;<samp class="samp">export_mvs</samp>&rsquo;</dt>
  1086. <dd><p>Export motion vectors into frame side-data (see <code class="code">AV_FRAME_DATA_MOTION_VECTORS</code>)
  1087. for codecs that support it. See also <samp class="file">doc/examples/export_mvs.c</samp>.
  1088. </p></dd>
  1089. <dt>&lsquo;<samp class="samp">skip_manual</samp>&rsquo;</dt>
  1090. <dd><p>Do not skip samples and export skip information as frame side data.
  1091. </p></dd>
  1092. <dt>&lsquo;<samp class="samp">ass_ro_flush_noop</samp>&rsquo;</dt>
  1093. <dd><p>Do not reset ASS ReadOrder field on flush.
  1094. </p></dd>
  1095. </dl>
  1096. </dd>
  1097. <dt><samp class="option">export_side_data <var class="var">flags</var> (<em class="emph">decoding/encoding,audio,video,subtitles</em>)</samp></dt>
  1098. <dd>
  1099. <p>Possible values:
  1100. </p><dl class="table">
  1101. <dt>&lsquo;<samp class="samp">mvs</samp>&rsquo;</dt>
  1102. <dd><p>Export motion vectors into frame side-data (see <code class="code">AV_FRAME_DATA_MOTION_VECTORS</code>)
  1103. for codecs that support it. See also <samp class="file">doc/examples/export_mvs.c</samp>.
  1104. </p></dd>
  1105. <dt>&lsquo;<samp class="samp">prft</samp>&rsquo;</dt>
  1106. <dd><p>Export encoder Producer Reference Time into packet side-data (see <code class="code">AV_PKT_DATA_PRFT</code>)
  1107. for codecs that support it.
  1108. </p></dd>
  1109. <dt>&lsquo;<samp class="samp">venc_params</samp>&rsquo;</dt>
  1110. <dd><p>Export video encoding parameters through frame side data (see <code class="code">AV_FRAME_DATA_VIDEO_ENC_PARAMS</code>)
  1111. for codecs that support it. At present, those are H.264 and VP9.
  1112. </p></dd>
  1113. <dt>&lsquo;<samp class="samp">film_grain</samp>&rsquo;</dt>
  1114. <dd><p>Export film grain parameters through frame side data (see <code class="code">AV_FRAME_DATA_FILM_GRAIN_PARAMS</code>).
  1115. Supported at present by AV1 decoders.
  1116. </p></dd>
  1117. </dl>
  1118. </dd>
  1119. <dt><samp class="option">threads <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1120. <dd><p>Set the number of threads to be used, in case the selected codec
  1121. implementation supports multi-threading.
  1122. </p>
  1123. <p>Possible values:
  1124. </p><dl class="table">
  1125. <dt>&lsquo;<samp class="samp">auto, 0</samp>&rsquo;</dt>
  1126. <dd><p>automatically select the number of threads to set
  1127. </p></dd>
  1128. </dl>
  1129. <p>Default value is &lsquo;<samp class="samp">auto</samp>&rsquo;.
  1130. </p>
  1131. </dd>
  1132. <dt><samp class="option">dc <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1133. <dd><p>Set intra_dc_precision.
  1134. </p>
  1135. </dd>
  1136. <dt><samp class="option">nssew <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1137. <dd><p>Set nsse weight.
  1138. </p>
  1139. </dd>
  1140. <dt><samp class="option">skip_top <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1141. <dd><p>Set number of macroblock rows at the top which are skipped.
  1142. </p>
  1143. </dd>
  1144. <dt><samp class="option">skip_bottom <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1145. <dd><p>Set number of macroblock rows at the bottom which are skipped.
  1146. </p>
  1147. </dd>
  1148. <dt><samp class="option">profile <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  1149. <dd>
  1150. <p>Set encoder codec profile. Default value is &lsquo;<samp class="samp">unknown</samp>&rsquo;. Encoder specific
  1151. profiles are documented in the relevant encoder documentation.
  1152. </p>
  1153. </dd>
  1154. <dt><samp class="option">level <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  1155. <dd>
  1156. <p>Possible values:
  1157. </p><dl class="table">
  1158. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  1159. </dl>
  1160. </dd>
  1161. <dt><samp class="option">lowres <var class="var">integer</var> (<em class="emph">decoding,audio,video</em>)</samp></dt>
  1162. <dd><p>Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions.
  1163. </p>
  1164. </dd>
  1165. <dt><samp class="option">mblmin <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1166. <dd><p>Set min macroblock lagrange factor (VBR).
  1167. </p>
  1168. </dd>
  1169. <dt><samp class="option">mblmax <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1170. <dd><p>Set max macroblock lagrange factor (VBR).
  1171. </p>
  1172. </dd>
  1173. <dt><samp class="option">skip_loop_filter <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1174. <dt><samp class="option">skip_idct <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1175. <dt><samp class="option">skip_frame <var class="var">integer</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1176. <dd>
  1177. <p>Make decoder discard processing depending on the frame type selected
  1178. by the option value.
  1179. </p>
  1180. <p><samp class="option">skip_loop_filter</samp> skips frame loop filtering, <samp class="option">skip_idct</samp>
  1181. skips frame IDCT/dequantization, <samp class="option">skip_frame</samp> skips decoding.
  1182. </p>
  1183. <p>Possible values:
  1184. </p><dl class="table">
  1185. <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
  1186. <dd><p>Discard no frame.
  1187. </p>
  1188. </dd>
  1189. <dt>&lsquo;<samp class="samp">default</samp>&rsquo;</dt>
  1190. <dd><p>Discard useless frames like 0-sized frames.
  1191. </p>
  1192. </dd>
  1193. <dt>&lsquo;<samp class="samp">noref</samp>&rsquo;</dt>
  1194. <dd><p>Discard all non-reference frames.
  1195. </p>
  1196. </dd>
  1197. <dt>&lsquo;<samp class="samp">bidir</samp>&rsquo;</dt>
  1198. <dd><p>Discard all bidirectional frames.
  1199. </p>
  1200. </dd>
  1201. <dt>&lsquo;<samp class="samp">nokey</samp>&rsquo;</dt>
  1202. <dd><p>Discard all frames excepts keyframes.
  1203. </p>
  1204. </dd>
  1205. <dt>&lsquo;<samp class="samp">nointra</samp>&rsquo;</dt>
  1206. <dd><p>Discard all frames except I frames.
  1207. </p>
  1208. </dd>
  1209. <dt>&lsquo;<samp class="samp">all</samp>&rsquo;</dt>
  1210. <dd><p>Discard all frames.
  1211. </p></dd>
  1212. </dl>
  1213. <p>Default value is &lsquo;<samp class="samp">default</samp>&rsquo;.
  1214. </p>
  1215. </dd>
  1216. <dt><samp class="option">bidir_refine <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1217. <dd><p>Refine the two motion vectors used in bidirectional macroblocks.
  1218. </p>
  1219. </dd>
  1220. <dt><samp class="option">keyint_min <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1221. <dd><p>Set minimum interval between IDR-frames.
  1222. </p>
  1223. </dd>
  1224. <dt><samp class="option">refs <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1225. <dd><p>Set reference frames to consider for motion compensation.
  1226. </p>
  1227. </dd>
  1228. <dt><samp class="option">trellis <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  1229. <dd><p>Set rate-distortion optimal quantization.
  1230. </p>
  1231. </dd>
  1232. <dt><samp class="option">mv0_threshold <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1233. <dt><samp class="option">compression_level <var class="var">integer</var> (<em class="emph">encoding,audio,video</em>)</samp></dt>
  1234. <dt><samp class="option">bits_per_raw_sample <var class="var">integer</var></samp></dt>
  1235. <dt><samp class="option">channel_layout <var class="var">integer</var> (<em class="emph">decoding/encoding,audio</em>)</samp></dt>
  1236. <dd>
  1237. <p>Possible values:
  1238. </p></dd>
  1239. <dt><samp class="option">request_channel_layout <var class="var">integer</var> (<em class="emph">decoding,audio</em>)</samp></dt>
  1240. <dd>
  1241. <p>Possible values:
  1242. </p></dd>
  1243. <dt><samp class="option">rc_max_vbv_use <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1244. <dt><samp class="option">rc_min_vbv_use <var class="var">float</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1245. <dt><samp class="option">ticks_per_frame <var class="var">integer</var> (<em class="emph">decoding/encoding,audio,video</em>)</samp></dt>
  1246. <dt><samp class="option">color_primaries <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1247. <dd><p>Possible values:
  1248. </p><dl class="table">
  1249. <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
  1250. <dd><p>BT.709
  1251. </p></dd>
  1252. <dt>&lsquo;<samp class="samp">bt470m</samp>&rsquo;</dt>
  1253. <dd><p>BT.470 M
  1254. </p></dd>
  1255. <dt>&lsquo;<samp class="samp">bt470bg</samp>&rsquo;</dt>
  1256. <dd><p>BT.470 BG
  1257. </p></dd>
  1258. <dt>&lsquo;<samp class="samp">smpte170m</samp>&rsquo;</dt>
  1259. <dd><p>SMPTE 170 M
  1260. </p></dd>
  1261. <dt>&lsquo;<samp class="samp">smpte240m</samp>&rsquo;</dt>
  1262. <dd><p>SMPTE 240 M
  1263. </p></dd>
  1264. <dt>&lsquo;<samp class="samp">film</samp>&rsquo;</dt>
  1265. <dd><p>Film
  1266. </p></dd>
  1267. <dt>&lsquo;<samp class="samp">bt2020</samp>&rsquo;</dt>
  1268. <dd><p>BT.2020
  1269. </p></dd>
  1270. <dt>&lsquo;<samp class="samp">smpte428</samp>&rsquo;</dt>
  1271. <dt>&lsquo;<samp class="samp">smpte428_1</samp>&rsquo;</dt>
  1272. <dd><p>SMPTE ST 428-1
  1273. </p></dd>
  1274. <dt>&lsquo;<samp class="samp">smpte431</samp>&rsquo;</dt>
  1275. <dd><p>SMPTE 431-2
  1276. </p></dd>
  1277. <dt>&lsquo;<samp class="samp">smpte432</samp>&rsquo;</dt>
  1278. <dd><p>SMPTE 432-1
  1279. </p></dd>
  1280. <dt>&lsquo;<samp class="samp">jedec-p22</samp>&rsquo;</dt>
  1281. <dd><p>JEDEC P22
  1282. </p></dd>
  1283. </dl>
  1284. </dd>
  1285. <dt><samp class="option">color_trc <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1286. <dd><p>Possible values:
  1287. </p><dl class="table">
  1288. <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
  1289. <dd><p>BT.709
  1290. </p></dd>
  1291. <dt>&lsquo;<samp class="samp">gamma22</samp>&rsquo;</dt>
  1292. <dd><p>BT.470 M
  1293. </p></dd>
  1294. <dt>&lsquo;<samp class="samp">gamma28</samp>&rsquo;</dt>
  1295. <dd><p>BT.470 BG
  1296. </p></dd>
  1297. <dt>&lsquo;<samp class="samp">smpte170m</samp>&rsquo;</dt>
  1298. <dd><p>SMPTE 170 M
  1299. </p></dd>
  1300. <dt>&lsquo;<samp class="samp">smpte240m</samp>&rsquo;</dt>
  1301. <dd><p>SMPTE 240 M
  1302. </p></dd>
  1303. <dt>&lsquo;<samp class="samp">linear</samp>&rsquo;</dt>
  1304. <dd><p>Linear
  1305. </p></dd>
  1306. <dt>&lsquo;<samp class="samp">log</samp>&rsquo;</dt>
  1307. <dt>&lsquo;<samp class="samp">log100</samp>&rsquo;</dt>
  1308. <dd><p>Log
  1309. </p></dd>
  1310. <dt>&lsquo;<samp class="samp">log_sqrt</samp>&rsquo;</dt>
  1311. <dt>&lsquo;<samp class="samp">log316</samp>&rsquo;</dt>
  1312. <dd><p>Log square root
  1313. </p></dd>
  1314. <dt>&lsquo;<samp class="samp">iec61966_2_4</samp>&rsquo;</dt>
  1315. <dt>&lsquo;<samp class="samp">iec61966-2-4</samp>&rsquo;</dt>
  1316. <dd><p>IEC 61966-2-4
  1317. </p></dd>
  1318. <dt>&lsquo;<samp class="samp">bt1361</samp>&rsquo;</dt>
  1319. <dt>&lsquo;<samp class="samp">bt1361e</samp>&rsquo;</dt>
  1320. <dd><p>BT.1361
  1321. </p></dd>
  1322. <dt>&lsquo;<samp class="samp">iec61966_2_1</samp>&rsquo;</dt>
  1323. <dt>&lsquo;<samp class="samp">iec61966-2-1</samp>&rsquo;</dt>
  1324. <dd><p>IEC 61966-2-1
  1325. </p></dd>
  1326. <dt>&lsquo;<samp class="samp">bt2020_10</samp>&rsquo;</dt>
  1327. <dt>&lsquo;<samp class="samp">bt2020_10bit</samp>&rsquo;</dt>
  1328. <dd><p>BT.2020 - 10 bit
  1329. </p></dd>
  1330. <dt>&lsquo;<samp class="samp">bt2020_12</samp>&rsquo;</dt>
  1331. <dt>&lsquo;<samp class="samp">bt2020_12bit</samp>&rsquo;</dt>
  1332. <dd><p>BT.2020 - 12 bit
  1333. </p></dd>
  1334. <dt>&lsquo;<samp class="samp">smpte2084</samp>&rsquo;</dt>
  1335. <dd><p>SMPTE ST 2084
  1336. </p></dd>
  1337. <dt>&lsquo;<samp class="samp">smpte428</samp>&rsquo;</dt>
  1338. <dt>&lsquo;<samp class="samp">smpte428_1</samp>&rsquo;</dt>
  1339. <dd><p>SMPTE ST 428-1
  1340. </p></dd>
  1341. <dt>&lsquo;<samp class="samp">arib-std-b67</samp>&rsquo;</dt>
  1342. <dd><p>ARIB STD-B67
  1343. </p></dd>
  1344. </dl>
  1345. </dd>
  1346. <dt><samp class="option">colorspace <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1347. <dd><p>Possible values:
  1348. </p><dl class="table">
  1349. <dt>&lsquo;<samp class="samp">rgb</samp>&rsquo;</dt>
  1350. <dd><p>RGB
  1351. </p></dd>
  1352. <dt>&lsquo;<samp class="samp">bt709</samp>&rsquo;</dt>
  1353. <dd><p>BT.709
  1354. </p></dd>
  1355. <dt>&lsquo;<samp class="samp">fcc</samp>&rsquo;</dt>
  1356. <dd><p>FCC
  1357. </p></dd>
  1358. <dt>&lsquo;<samp class="samp">bt470bg</samp>&rsquo;</dt>
  1359. <dd><p>BT.470 BG
  1360. </p></dd>
  1361. <dt>&lsquo;<samp class="samp">smpte170m</samp>&rsquo;</dt>
  1362. <dd><p>SMPTE 170 M
  1363. </p></dd>
  1364. <dt>&lsquo;<samp class="samp">smpte240m</samp>&rsquo;</dt>
  1365. <dd><p>SMPTE 240 M
  1366. </p></dd>
  1367. <dt>&lsquo;<samp class="samp">ycocg</samp>&rsquo;</dt>
  1368. <dd><p>YCOCG
  1369. </p></dd>
  1370. <dt>&lsquo;<samp class="samp">bt2020nc</samp>&rsquo;</dt>
  1371. <dt>&lsquo;<samp class="samp">bt2020_ncl</samp>&rsquo;</dt>
  1372. <dd><p>BT.2020 NCL
  1373. </p></dd>
  1374. <dt>&lsquo;<samp class="samp">bt2020c</samp>&rsquo;</dt>
  1375. <dt>&lsquo;<samp class="samp">bt2020_cl</samp>&rsquo;</dt>
  1376. <dd><p>BT.2020 CL
  1377. </p></dd>
  1378. <dt>&lsquo;<samp class="samp">smpte2085</samp>&rsquo;</dt>
  1379. <dd><p>SMPTE 2085
  1380. </p></dd>
  1381. <dt>&lsquo;<samp class="samp">chroma-derived-nc</samp>&rsquo;</dt>
  1382. <dd><p>Chroma-derived NCL
  1383. </p></dd>
  1384. <dt>&lsquo;<samp class="samp">chroma-derived-c</samp>&rsquo;</dt>
  1385. <dd><p>Chroma-derived CL
  1386. </p></dd>
  1387. <dt>&lsquo;<samp class="samp">ictcp</samp>&rsquo;</dt>
  1388. <dd><p>ICtCp
  1389. </p></dd>
  1390. </dl>
  1391. </dd>
  1392. <dt><samp class="option">color_range <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1393. <dd><p>If used as input parameter, it serves as a hint to the decoder, which
  1394. color_range the input has.
  1395. Possible values:
  1396. </p><dl class="table">
  1397. <dt>&lsquo;<samp class="samp">tv</samp>&rsquo;</dt>
  1398. <dt>&lsquo;<samp class="samp">mpeg</samp>&rsquo;</dt>
  1399. <dd><p>MPEG (219*2^(n-8))
  1400. </p></dd>
  1401. <dt>&lsquo;<samp class="samp">pc</samp>&rsquo;</dt>
  1402. <dt>&lsquo;<samp class="samp">jpeg</samp>&rsquo;</dt>
  1403. <dd><p>JPEG (2^n-1)
  1404. </p></dd>
  1405. </dl>
  1406. </dd>
  1407. <dt><samp class="option">chroma_sample_location <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1408. <dd><p>Possible values:
  1409. </p><dl class="table">
  1410. <dt>&lsquo;<samp class="samp">left</samp>&rsquo;</dt>
  1411. <dt>&lsquo;<samp class="samp">center</samp>&rsquo;</dt>
  1412. <dt>&lsquo;<samp class="samp">topleft</samp>&rsquo;</dt>
  1413. <dt>&lsquo;<samp class="samp">top</samp>&rsquo;</dt>
  1414. <dt>&lsquo;<samp class="samp">bottomleft</samp>&rsquo;</dt>
  1415. <dt>&lsquo;<samp class="samp">bottom</samp>&rsquo;</dt>
  1416. </dl>
  1417. </dd>
  1418. <dt><samp class="option">log_level_offset <var class="var">integer</var></samp></dt>
  1419. <dd><p>Set the log level offset.
  1420. </p>
  1421. </dd>
  1422. <dt><samp class="option">slices <var class="var">integer</var> (<em class="emph">encoding,video</em>)</samp></dt>
  1423. <dd><p>Number of slices, used in parallelized encoding.
  1424. </p>
  1425. </dd>
  1426. <dt><samp class="option">thread_type <var class="var">flags</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1427. <dd><p>Select which multithreading methods to use.
  1428. </p>
  1429. <p>Use of &lsquo;<samp class="samp">frame</samp>&rsquo; will increase decoding delay by one frame per
  1430. thread, so clients which cannot provide future frames should not use
  1431. it.
  1432. </p>
  1433. <p>Possible values:
  1434. </p><dl class="table">
  1435. <dt>&lsquo;<samp class="samp">slice</samp>&rsquo;</dt>
  1436. <dd><p>Decode more than one part of a single frame at once.
  1437. </p>
  1438. <p>Multithreading using slices works only when the video was encoded with
  1439. slices.
  1440. </p>
  1441. </dd>
  1442. <dt>&lsquo;<samp class="samp">frame</samp>&rsquo;</dt>
  1443. <dd><p>Decode more than one frame at once.
  1444. </p></dd>
  1445. </dl>
  1446. <p>Default value is &lsquo;<samp class="samp">slice+frame</samp>&rsquo;.
  1447. </p>
  1448. </dd>
  1449. <dt><samp class="option">audio_service_type <var class="var">integer</var> (<em class="emph">encoding,audio</em>)</samp></dt>
  1450. <dd><p>Set audio service type.
  1451. </p>
  1452. <p>Possible values:
  1453. </p><dl class="table">
  1454. <dt>&lsquo;<samp class="samp">ma</samp>&rsquo;</dt>
  1455. <dd><p>Main Audio Service
  1456. </p></dd>
  1457. <dt>&lsquo;<samp class="samp">ef</samp>&rsquo;</dt>
  1458. <dd><p>Effects
  1459. </p></dd>
  1460. <dt>&lsquo;<samp class="samp">vi</samp>&rsquo;</dt>
  1461. <dd><p>Visually Impaired
  1462. </p></dd>
  1463. <dt>&lsquo;<samp class="samp">hi</samp>&rsquo;</dt>
  1464. <dd><p>Hearing Impaired
  1465. </p></dd>
  1466. <dt>&lsquo;<samp class="samp">di</samp>&rsquo;</dt>
  1467. <dd><p>Dialogue
  1468. </p></dd>
  1469. <dt>&lsquo;<samp class="samp">co</samp>&rsquo;</dt>
  1470. <dd><p>Commentary
  1471. </p></dd>
  1472. <dt>&lsquo;<samp class="samp">em</samp>&rsquo;</dt>
  1473. <dd><p>Emergency
  1474. </p></dd>
  1475. <dt>&lsquo;<samp class="samp">vo</samp>&rsquo;</dt>
  1476. <dd><p>Voice Over
  1477. </p></dd>
  1478. <dt>&lsquo;<samp class="samp">ka</samp>&rsquo;</dt>
  1479. <dd><p>Karaoke
  1480. </p></dd>
  1481. </dl>
  1482. </dd>
  1483. <dt><samp class="option">request_sample_fmt <var class="var">sample_fmt</var> (<em class="emph">decoding,audio</em>)</samp></dt>
  1484. <dd><p>Set sample format audio decoders should prefer. Default value is
  1485. <code class="code">none</code>.
  1486. </p>
  1487. </dd>
  1488. <dt><samp class="option">pkt_timebase <var class="var">rational number</var></samp></dt>
  1489. <dt><samp class="option">sub_charenc <var class="var">encoding</var> (<em class="emph">decoding,subtitles</em>)</samp></dt>
  1490. <dd><p>Set the input subtitles character encoding.
  1491. </p>
  1492. </dd>
  1493. <dt><samp class="option">field_order <var class="var">field_order</var> (<em class="emph">video</em>)</samp></dt>
  1494. <dd><p>Set/override the field order of the video.
  1495. Possible values:
  1496. </p><dl class="table">
  1497. <dt>&lsquo;<samp class="samp">progressive</samp>&rsquo;</dt>
  1498. <dd><p>Progressive video
  1499. </p></dd>
  1500. <dt>&lsquo;<samp class="samp">tt</samp>&rsquo;</dt>
  1501. <dd><p>Interlaced video, top field coded and displayed first
  1502. </p></dd>
  1503. <dt>&lsquo;<samp class="samp">bb</samp>&rsquo;</dt>
  1504. <dd><p>Interlaced video, bottom field coded and displayed first
  1505. </p></dd>
  1506. <dt>&lsquo;<samp class="samp">tb</samp>&rsquo;</dt>
  1507. <dd><p>Interlaced video, top coded first, bottom displayed first
  1508. </p></dd>
  1509. <dt>&lsquo;<samp class="samp">bt</samp>&rsquo;</dt>
  1510. <dd><p>Interlaced video, bottom coded first, top displayed first
  1511. </p></dd>
  1512. </dl>
  1513. </dd>
  1514. <dt><samp class="option">skip_alpha <var class="var">bool</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1515. <dd><p>Set to 1 to disable processing alpha (transparency). This works like the
  1516. &lsquo;<samp class="samp">gray</samp>&rsquo; flag in the <samp class="option">flags</samp> option which skips chroma information
  1517. instead of alpha. Default is 0.
  1518. </p>
  1519. </dd>
  1520. <dt><samp class="option">codec_whitelist <var class="var">list</var> (<em class="emph">input</em>)</samp></dt>
  1521. <dd><p>&quot;,&quot; separated list of allowed decoders. By default all are allowed.
  1522. </p>
  1523. </dd>
  1524. <dt><samp class="option">dump_separator <var class="var">string</var> (<em class="emph">input</em>)</samp></dt>
  1525. <dd><p>Separator used to separate the fields printed on the command line about the
  1526. Stream parameters.
  1527. For example, to separate the fields with newlines and indentation:
  1528. </p><div class="example">
  1529. <pre class="example-preformatted">ffprobe -dump_separator &quot;
  1530. &quot; -i ~/videos/matrixbench_mpeg2.mpg
  1531. </pre></div>
  1532. </dd>
  1533. <dt><samp class="option">max_pixels <var class="var">integer</var> (<em class="emph">decoding/encoding,video</em>)</samp></dt>
  1534. <dd><p>Maximum number of pixels per image. This value can be used to avoid out of
  1535. memory failures due to large images.
  1536. </p>
  1537. </dd>
  1538. <dt><samp class="option">apply_cropping <var class="var">bool</var> (<em class="emph">decoding,video</em>)</samp></dt>
  1539. <dd><p>Enable cropping if cropping parameters are multiples of the required
  1540. alignment for the left and top parameters. If the alignment is not met the
  1541. cropping will be partially applied to maintain alignment.
  1542. Default is 1 (enabled).
  1543. Note: The required alignment depends on if <code class="code">AV_CODEC_FLAG_UNALIGNED</code> is set and the
  1544. CPU. <code class="code">AV_CODEC_FLAG_UNALIGNED</code> cannot be changed from the command line. Also hardware
  1545. decoders will not apply left/top Cropping.
  1546. </p>
  1547. </dd>
  1548. </dl>
  1549. </div>
  1550. <div class="chapter-level-extent" id="Decoders">
  1551. <h2 class="chapter"><span>3 Decoders<a class="copiable-link" href="#Decoders"> &para;</a></span></h2>
  1552. <p>Decoders are configured elements in FFmpeg which allow the decoding of
  1553. multimedia streams.
  1554. </p>
  1555. <p>When you configure your FFmpeg build, all the supported native decoders
  1556. are enabled by default. Decoders requiring an external library must be enabled
  1557. manually via the corresponding <code class="code">--enable-lib</code> option. You can list all
  1558. available decoders using the configure option <code class="code">--list-decoders</code>.
  1559. </p>
  1560. <p>You can disable all the decoders with the configure option
  1561. <code class="code">--disable-decoders</code> and selectively enable / disable single decoders
  1562. with the options <code class="code">--enable-decoder=<var class="var">DECODER</var></code> /
  1563. <code class="code">--disable-decoder=<var class="var">DECODER</var></code>.
  1564. </p>
  1565. <p>The option <code class="code">-decoders</code> of the ff* tools will display the list of
  1566. enabled decoders.
  1567. </p>
  1568. </div>
  1569. <div class="chapter-level-extent" id="Video-Decoders">
  1570. <h2 class="chapter"><span>4 Video Decoders<a class="copiable-link" href="#Video-Decoders"> &para;</a></span></h2>
  1571. <p>A description of some of the currently available video decoders
  1572. follows.
  1573. </p>
  1574. <ul class="mini-toc">
  1575. <li><a href="#av1" accesskey="1">av1</a></li>
  1576. <li><a href="#rawvideo" accesskey="2">rawvideo</a></li>
  1577. <li><a href="#libdav1d" accesskey="3">libdav1d</a></li>
  1578. <li><a href="#libdavs2" accesskey="4">libdavs2</a></li>
  1579. <li><a href="#libuavs3d" accesskey="5">libuavs3d</a></li>
  1580. <li><a href="#QSV-Decoders" accesskey="6">QSV Decoders</a></li>
  1581. <li><a href="#v210" accesskey="7">v210</a></li>
  1582. </ul>
  1583. <div class="section-level-extent" id="av1">
  1584. <h3 class="section"><span>4.1 av1<a class="copiable-link" href="#av1"> &para;</a></span></h3>
  1585. <p>AOMedia Video 1 (AV1) decoder.
  1586. </p>
  1587. <ul class="mini-toc">
  1588. <li><a href="#Options" accesskey="1">Options</a></li>
  1589. </ul>
  1590. <div class="subsection-level-extent" id="Options">
  1591. <h4 class="subsection"><span>4.1.1 Options<a class="copiable-link" href="#Options"> &para;</a></span></h4>
  1592. <dl class="table">
  1593. <dt><samp class="option">operating_point</samp></dt>
  1594. <dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Default is 0.
  1595. </p>
  1596. </dd>
  1597. </dl>
  1598. </div>
  1599. </div>
  1600. <div class="section-level-extent" id="rawvideo">
  1601. <h3 class="section"><span>4.2 rawvideo<a class="copiable-link" href="#rawvideo"> &para;</a></span></h3>
  1602. <p>Raw video decoder.
  1603. </p>
  1604. <p>This decoder decodes rawvideo streams.
  1605. </p>
  1606. <ul class="mini-toc">
  1607. <li><a href="#Options-1" accesskey="1">Options</a></li>
  1608. </ul>
  1609. <div class="subsection-level-extent" id="Options-1">
  1610. <h4 class="subsection"><span>4.2.1 Options<a class="copiable-link" href="#Options-1"> &para;</a></span></h4>
  1611. <dl class="table">
  1612. <dt><samp class="option">top <var class="var">top_field_first</var></samp></dt>
  1613. <dd><p>Specify the assumed field type of the input video.
  1614. </p><dl class="table">
  1615. <dt><samp class="option">-1</samp></dt>
  1616. <dd><p>the video is assumed to be progressive (default)
  1617. </p></dd>
  1618. <dt><samp class="option">0</samp></dt>
  1619. <dd><p>bottom-field-first is assumed
  1620. </p></dd>
  1621. <dt><samp class="option">1</samp></dt>
  1622. <dd><p>top-field-first is assumed
  1623. </p></dd>
  1624. </dl>
  1625. </dd>
  1626. </dl>
  1627. </div>
  1628. </div>
  1629. <div class="section-level-extent" id="libdav1d">
  1630. <h3 class="section"><span>4.3 libdav1d<a class="copiable-link" href="#libdav1d"> &para;</a></span></h3>
  1631. <p>dav1d AV1 decoder.
  1632. </p>
  1633. <p>libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec.
  1634. Requires the presence of the libdav1d headers and library during configuration.
  1635. You need to explicitly configure the build with <code class="code">--enable-libdav1d</code>.
  1636. </p>
  1637. <ul class="mini-toc">
  1638. <li><a href="#Options-2" accesskey="1">Options</a></li>
  1639. </ul>
  1640. <div class="subsection-level-extent" id="Options-2">
  1641. <h4 class="subsection"><span>4.3.1 Options<a class="copiable-link" href="#Options-2"> &para;</a></span></h4>
  1642. <p>The following options are supported by the libdav1d wrapper.
  1643. </p>
  1644. <dl class="table">
  1645. <dt><samp class="option">framethreads</samp></dt>
  1646. <dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
  1647. This option is deprecated for libdav1d &gt;= 1.0 and will be removed in the future. Use the
  1648. global option <code class="code">threads</code> instead.
  1649. </p>
  1650. </dd>
  1651. <dt><samp class="option">tilethreads</samp></dt>
  1652. <dd><p>Set amount of tile threads to use during decoding. The default value is 0 (autodetect).
  1653. This option is deprecated for libdav1d &gt;= 1.0 and will be removed in the future. Use the
  1654. global option <code class="code">threads</code> instead.
  1655. </p>
  1656. </dd>
  1657. <dt><samp class="option">filmgrain</samp></dt>
  1658. <dd><p>Apply film grain to the decoded video if present in the bitstream. Defaults to the
  1659. internal default of the library.
  1660. This option is deprecated and will be removed in the future. See the global option
  1661. <code class="code">export_side_data</code> to export Film Grain parameters instead of applying it.
  1662. </p>
  1663. </dd>
  1664. <dt><samp class="option">oppoint</samp></dt>
  1665. <dd><p>Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the
  1666. internal default of the library.
  1667. </p>
  1668. </dd>
  1669. <dt><samp class="option">alllayers</samp></dt>
  1670. <dd><p>Output all spatial layers of a scalable AV1 bitstream. The default value is false.
  1671. </p>
  1672. </dd>
  1673. </dl>
  1674. </div>
  1675. </div>
  1676. <div class="section-level-extent" id="libdavs2">
  1677. <h3 class="section"><span>4.4 libdavs2<a class="copiable-link" href="#libdavs2"> &para;</a></span></h3>
  1678. <p>AVS2-P2/IEEE1857.4 video decoder wrapper.
  1679. </p>
  1680. <p>This decoder allows libavcodec to decode AVS2 streams with davs2 library.
  1681. </p>
  1682. </div>
  1683. <div class="section-level-extent" id="libuavs3d">
  1684. <h3 class="section"><span>4.5 libuavs3d<a class="copiable-link" href="#libuavs3d"> &para;</a></span></h3>
  1685. <p>AVS3-P2/IEEE1857.10 video decoder.
  1686. </p>
  1687. <p>libuavs3d allows libavcodec to decode AVS3 streams.
  1688. Requires the presence of the libuavs3d headers and library during configuration.
  1689. You need to explicitly configure the build with <code class="code">--enable-libuavs3d</code>.
  1690. </p>
  1691. <ul class="mini-toc">
  1692. <li><a href="#Options-3" accesskey="1">Options</a></li>
  1693. </ul>
  1694. <div class="subsection-level-extent" id="Options-3">
  1695. <h4 class="subsection"><span>4.5.1 Options<a class="copiable-link" href="#Options-3"> &para;</a></span></h4>
  1696. <p>The following option is supported by the libuavs3d wrapper.
  1697. </p>
  1698. <dl class="table">
  1699. <dt><samp class="option">frame_threads</samp></dt>
  1700. <dd><p>Set amount of frame threads to use during decoding. The default value is 0 (autodetect).
  1701. </p>
  1702. </dd>
  1703. </dl>
  1704. </div>
  1705. </div>
  1706. <div class="section-level-extent" id="QSV-Decoders">
  1707. <h3 class="section"><span>4.6 QSV Decoders<a class="copiable-link" href="#QSV-Decoders"> &para;</a></span></h3>
  1708. <p>The family of Intel QuickSync Video decoders (VC1, MPEG-2, H.264, HEVC,
  1709. JPEG/MJPEG, VP8, VP9, AV1).
  1710. </p>
  1711. <ul class="mini-toc">
  1712. <li><a href="#Common-Options" accesskey="1">Common Options</a></li>
  1713. <li><a href="#HEVC-Options" accesskey="2">HEVC Options</a></li>
  1714. </ul>
  1715. <div class="subsection-level-extent" id="Common-Options">
  1716. <h4 class="subsection"><span>4.6.1 Common Options<a class="copiable-link" href="#Common-Options"> &para;</a></span></h4>
  1717. <p>The following options are supported by all qsv decoders.
  1718. </p>
  1719. <dl class="table">
  1720. <dt><samp class="option"><var class="var">async_depth</var></samp></dt>
  1721. <dd><p>Internal parallelization depth, the higher the value the higher the latency.
  1722. </p>
  1723. </dd>
  1724. <dt><samp class="option"><var class="var">gpu_copy</var></samp></dt>
  1725. <dd><p>A GPU-accelerated copy between video and system memory
  1726. </p><dl class="table">
  1727. <dt>&lsquo;<samp class="samp">default</samp>&rsquo;</dt>
  1728. <dt>&lsquo;<samp class="samp">on</samp>&rsquo;</dt>
  1729. <dt>&lsquo;<samp class="samp">off</samp>&rsquo;</dt>
  1730. </dl>
  1731. </dd>
  1732. </dl>
  1733. </div>
  1734. <div class="subsection-level-extent" id="HEVC-Options">
  1735. <h4 class="subsection"><span>4.6.2 HEVC Options<a class="copiable-link" href="#HEVC-Options"> &para;</a></span></h4>
  1736. <p>Extra options for hevc_qsv.
  1737. </p>
  1738. <dl class="table">
  1739. <dt><samp class="option"><var class="var">load_plugin</var></samp></dt>
  1740. <dd><p>A user plugin to load in an internal session
  1741. </p><dl class="table">
  1742. <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
  1743. <dt>&lsquo;<samp class="samp">hevc_sw</samp>&rsquo;</dt>
  1744. <dt>&lsquo;<samp class="samp">hevc_hw</samp>&rsquo;</dt>
  1745. </dl>
  1746. </dd>
  1747. <dt><samp class="option"><var class="var">load_plugins</var></samp></dt>
  1748. <dd><p>A :-separate list of hexadecimal plugin UIDs to load in an internal session
  1749. </p>
  1750. </dd>
  1751. </dl>
  1752. </div>
  1753. </div>
  1754. <div class="section-level-extent" id="v210">
  1755. <h3 class="section"><span>4.7 v210<a class="copiable-link" href="#v210"> &para;</a></span></h3>
  1756. <p>Uncompressed 4:2:2 10-bit decoder.
  1757. </p>
  1758. <ul class="mini-toc">
  1759. <li><a href="#Options-4" accesskey="1">Options</a></li>
  1760. </ul>
  1761. <div class="subsection-level-extent" id="Options-4">
  1762. <h4 class="subsection"><span>4.7.1 Options<a class="copiable-link" href="#Options-4"> &para;</a></span></h4>
  1763. <dl class="table">
  1764. <dt><samp class="option">custom_stride</samp></dt>
  1765. <dd><p>Set the line size of the v210 data in bytes. The default value is 0
  1766. (autodetect). You can use the special -1 value for a strideless v210 as seen in
  1767. BOXX files.
  1768. </p>
  1769. </dd>
  1770. </dl>
  1771. </div>
  1772. </div>
  1773. </div>
  1774. <div class="chapter-level-extent" id="Audio-Decoders">
  1775. <h2 class="chapter"><span>5 Audio Decoders<a class="copiable-link" href="#Audio-Decoders"> &para;</a></span></h2>
  1776. <p>A description of some of the currently available audio decoders
  1777. follows.
  1778. </p>
  1779. <ul class="mini-toc">
  1780. <li><a href="#ac3" accesskey="1">ac3</a></li>
  1781. <li><a href="#flac-1" accesskey="2">flac</a></li>
  1782. <li><a href="#ffwavesynth" accesskey="3">ffwavesynth</a></li>
  1783. <li><a href="#libcelt" accesskey="4">libcelt</a></li>
  1784. <li><a href="#libgsm" accesskey="5">libgsm</a></li>
  1785. <li><a href="#libilbc" accesskey="6">libilbc</a></li>
  1786. <li><a href="#libopencore_002damrnb" accesskey="7">libopencore-amrnb</a></li>
  1787. <li><a href="#libopencore_002damrwb" accesskey="8">libopencore-amrwb</a></li>
  1788. <li><a href="#libopus" accesskey="9">libopus</a></li>
  1789. </ul>
  1790. <div class="section-level-extent" id="ac3">
  1791. <h3 class="section"><span>5.1 ac3<a class="copiable-link" href="#ac3"> &para;</a></span></h3>
  1792. <p>AC-3 audio decoder.
  1793. </p>
  1794. <p>This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  1795. the undocumented RealAudio 3 (a.k.a. dnet).
  1796. </p>
  1797. <ul class="mini-toc">
  1798. <li><a href="#AC_002d3-Decoder-Options" accesskey="1">AC-3 Decoder Options</a></li>
  1799. </ul>
  1800. <div class="subsection-level-extent" id="AC_002d3-Decoder-Options">
  1801. <h4 class="subsection"><span>5.1.1 AC-3 Decoder Options<a class="copiable-link" href="#AC_002d3-Decoder-Options"> &para;</a></span></h4>
  1802. <dl class="table">
  1803. <dt><samp class="option">-drc_scale <var class="var">value</var></samp></dt>
  1804. <dd><p>Dynamic Range Scale Factor. The factor to apply to dynamic range values
  1805. from the AC-3 stream. This factor is applied exponentially. The default value is 1.
  1806. There are 3 notable scale factor ranges:
  1807. </p><dl class="table">
  1808. <dt><samp class="option">drc_scale == 0</samp></dt>
  1809. <dd><p>DRC disabled. Produces full range audio.
  1810. </p></dd>
  1811. <dt><samp class="option">0 &lt; drc_scale &lt;= 1</samp></dt>
  1812. <dd><p>DRC enabled. Applies a fraction of the stream DRC value.
  1813. Audio reproduction is between full range and full compression.
  1814. </p></dd>
  1815. <dt><samp class="option">drc_scale &gt; 1</samp></dt>
  1816. <dd><p>DRC enabled. Applies drc_scale asymmetrically.
  1817. Loud sounds are fully compressed. Soft sounds are enhanced.
  1818. </p></dd>
  1819. </dl>
  1820. </dd>
  1821. </dl>
  1822. </div>
  1823. </div>
  1824. <div class="section-level-extent" id="flac-1">
  1825. <h3 class="section"><span>5.2 flac<a class="copiable-link" href="#flac-1"> &para;</a></span></h3>
  1826. <p>FLAC audio decoder.
  1827. </p>
  1828. <p>This decoder aims to implement the complete FLAC specification from Xiph.
  1829. </p>
  1830. <ul class="mini-toc">
  1831. <li><a href="#FLAC-Decoder-options" accesskey="1">FLAC Decoder options</a></li>
  1832. </ul>
  1833. <div class="subsection-level-extent" id="FLAC-Decoder-options">
  1834. <h4 class="subsection"><span>5.2.1 FLAC Decoder options<a class="copiable-link" href="#FLAC-Decoder-options"> &para;</a></span></h4>
  1835. <dl class="table">
  1836. <dt><samp class="option">-use_buggy_lpc</samp></dt>
  1837. <dd><p>The lavc FLAC encoder used to produce buggy streams with high lpc values
  1838. (like the default value). This option makes it possible to decode such streams
  1839. correctly by using lavc&rsquo;s old buggy lpc logic for decoding.
  1840. </p>
  1841. </dd>
  1842. </dl>
  1843. </div>
  1844. </div>
  1845. <div class="section-level-extent" id="ffwavesynth">
  1846. <h3 class="section"><span>5.3 ffwavesynth<a class="copiable-link" href="#ffwavesynth"> &para;</a></span></h3>
  1847. <p>Internal wave synthesizer.
  1848. </p>
  1849. <p>This decoder generates wave patterns according to predefined sequences. Its
  1850. use is purely internal and the format of the data it accepts is not publicly
  1851. documented.
  1852. </p>
  1853. </div>
  1854. <div class="section-level-extent" id="libcelt">
  1855. <h3 class="section"><span>5.4 libcelt<a class="copiable-link" href="#libcelt"> &para;</a></span></h3>
  1856. <p>libcelt decoder wrapper.
  1857. </p>
  1858. <p>libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec.
  1859. Requires the presence of the libcelt headers and library during configuration.
  1860. You need to explicitly configure the build with <code class="code">--enable-libcelt</code>.
  1861. </p>
  1862. </div>
  1863. <div class="section-level-extent" id="libgsm">
  1864. <h3 class="section"><span>5.5 libgsm<a class="copiable-link" href="#libgsm"> &para;</a></span></h3>
  1865. <p>libgsm decoder wrapper.
  1866. </p>
  1867. <p>libgsm allows libavcodec to decode the GSM full rate audio codec. Requires
  1868. the presence of the libgsm headers and library during configuration. You need
  1869. to explicitly configure the build with <code class="code">--enable-libgsm</code>.
  1870. </p>
  1871. <p>This decoder supports both the ordinary GSM and the Microsoft variant.
  1872. </p>
  1873. </div>
  1874. <div class="section-level-extent" id="libilbc">
  1875. <h3 class="section"><span>5.6 libilbc<a class="copiable-link" href="#libilbc"> &para;</a></span></h3>
  1876. <p>libilbc decoder wrapper.
  1877. </p>
  1878. <p>libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC)
  1879. audio codec. Requires the presence of the libilbc headers and library during
  1880. configuration. You need to explicitly configure the build with
  1881. <code class="code">--enable-libilbc</code>.
  1882. </p>
  1883. <ul class="mini-toc">
  1884. <li><a href="#Options-5" accesskey="1">Options</a></li>
  1885. </ul>
  1886. <div class="subsection-level-extent" id="Options-5">
  1887. <h4 class="subsection"><span>5.6.1 Options<a class="copiable-link" href="#Options-5"> &para;</a></span></h4>
  1888. <p>The following option is supported by the libilbc wrapper.
  1889. </p>
  1890. <dl class="table">
  1891. <dt><samp class="option">enhance</samp></dt>
  1892. <dd>
  1893. <p>Enable the enhancement of the decoded audio when set to 1. The default
  1894. value is 0 (disabled).
  1895. </p>
  1896. </dd>
  1897. </dl>
  1898. </div>
  1899. </div>
  1900. <div class="section-level-extent" id="libopencore_002damrnb">
  1901. <h3 class="section"><span>5.7 libopencore-amrnb<a class="copiable-link" href="#libopencore_002damrnb"> &para;</a></span></h3>
  1902. <p>libopencore-amrnb decoder wrapper.
  1903. </p>
  1904. <p>libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate
  1905. Narrowband audio codec. Using it requires the presence of the
  1906. libopencore-amrnb headers and library during configuration. You need to
  1907. explicitly configure the build with <code class="code">--enable-libopencore-amrnb</code>.
  1908. </p>
  1909. <p>An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB
  1910. without this library.
  1911. </p>
  1912. </div>
  1913. <div class="section-level-extent" id="libopencore_002damrwb">
  1914. <h3 class="section"><span>5.8 libopencore-amrwb<a class="copiable-link" href="#libopencore_002damrwb"> &para;</a></span></h3>
  1915. <p>libopencore-amrwb decoder wrapper.
  1916. </p>
  1917. <p>libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate
  1918. Wideband audio codec. Using it requires the presence of the
  1919. libopencore-amrwb headers and library during configuration. You need to
  1920. explicitly configure the build with <code class="code">--enable-libopencore-amrwb</code>.
  1921. </p>
  1922. <p>An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB
  1923. without this library.
  1924. </p>
  1925. </div>
  1926. <div class="section-level-extent" id="libopus">
  1927. <h3 class="section"><span>5.9 libopus<a class="copiable-link" href="#libopus"> &para;</a></span></h3>
  1928. <p>libopus decoder wrapper.
  1929. </p>
  1930. <p>libopus allows libavcodec to decode the Opus Interactive Audio Codec.
  1931. Requires the presence of the libopus headers and library during
  1932. configuration. You need to explicitly configure the build with
  1933. <code class="code">--enable-libopus</code>.
  1934. </p>
  1935. <p>An FFmpeg native decoder for Opus exists, so users can decode Opus
  1936. without this library.
  1937. </p>
  1938. </div>
  1939. </div>
  1940. <div class="chapter-level-extent" id="Subtitles-Decoders">
  1941. <h2 class="chapter"><span>6 Subtitles Decoders<a class="copiable-link" href="#Subtitles-Decoders"> &para;</a></span></h2>
  1942. <ul class="mini-toc">
  1943. <li><a href="#libaribb24" accesskey="1">libaribb24</a></li>
  1944. <li><a href="#dvbsub" accesskey="2">dvbsub</a></li>
  1945. <li><a href="#dvdsub" accesskey="3">dvdsub</a></li>
  1946. <li><a href="#libzvbi_002dteletext" accesskey="4">libzvbi-teletext</a></li>
  1947. </ul>
  1948. <div class="section-level-extent" id="libaribb24">
  1949. <h3 class="section"><span>6.1 libaribb24<a class="copiable-link" href="#libaribb24"> &para;</a></span></h3>
  1950. <p>ARIB STD-B24 caption decoder.
  1951. </p>
  1952. <p>Implements profiles A and C of the ARIB STD-B24 standard.
  1953. </p>
  1954. <ul class="mini-toc">
  1955. <li><a href="#libaribb24-Decoder-Options" accesskey="1">libaribb24 Decoder Options</a></li>
  1956. </ul>
  1957. <div class="subsection-level-extent" id="libaribb24-Decoder-Options">
  1958. <h4 class="subsection"><span>6.1.1 libaribb24 Decoder Options<a class="copiable-link" href="#libaribb24-Decoder-Options"> &para;</a></span></h4>
  1959. <dl class="table">
  1960. <dt><samp class="option">-aribb24-base-path <var class="var">path</var></samp></dt>
  1961. <dd><p>Sets the base path for the libaribb24 library. This is utilized for reading of
  1962. configuration files (for custom unicode conversions), and for dumping of
  1963. non-text symbols as images under that location.
  1964. </p>
  1965. <p>Unset by default.
  1966. </p>
  1967. </dd>
  1968. <dt><samp class="option">-aribb24-skip-ruby-text <var class="var">boolean</var></samp></dt>
  1969. <dd><p>Tells the decoder wrapper to skip text blocks that contain half-height ruby
  1970. text.
  1971. </p>
  1972. <p>Enabled by default.
  1973. </p>
  1974. </dd>
  1975. </dl>
  1976. </div>
  1977. </div>
  1978. <div class="section-level-extent" id="dvbsub">
  1979. <h3 class="section"><span>6.2 dvbsub<a class="copiable-link" href="#dvbsub"> &para;</a></span></h3>
  1980. <ul class="mini-toc">
  1981. <li><a href="#Options-6" accesskey="1">Options</a></li>
  1982. </ul>
  1983. <div class="subsection-level-extent" id="Options-6">
  1984. <h4 class="subsection"><span>6.2.1 Options<a class="copiable-link" href="#Options-6"> &para;</a></span></h4>
  1985. <dl class="table">
  1986. <dt><samp class="option">compute_clut</samp></dt>
  1987. <dd><dl class="table">
  1988. <dt><samp class="option">-2</samp></dt>
  1989. <dd><p>Compute clut once if no matching CLUT is in the stream.
  1990. </p></dd>
  1991. <dt><samp class="option">-1</samp></dt>
  1992. <dd><p>Compute clut if no matching CLUT is in the stream.
  1993. </p></dd>
  1994. <dt><samp class="option">0</samp></dt>
  1995. <dd><p>Never compute CLUT
  1996. </p></dd>
  1997. <dt><samp class="option">1</samp></dt>
  1998. <dd><p>Always compute CLUT and override the one provided in the stream.
  1999. </p></dd>
  2000. </dl>
  2001. </dd>
  2002. <dt><samp class="option">dvb_substream</samp></dt>
  2003. <dd><p>Selects the dvb substream, or all substreams if -1 which is default.
  2004. </p>
  2005. </dd>
  2006. </dl>
  2007. </div>
  2008. </div>
  2009. <div class="section-level-extent" id="dvdsub">
  2010. <h3 class="section"><span>6.3 dvdsub<a class="copiable-link" href="#dvdsub"> &para;</a></span></h3>
  2011. <p>This codec decodes the bitmap subtitles used in DVDs; the same subtitles can
  2012. also be found in VobSub file pairs and in some Matroska files.
  2013. </p>
  2014. <ul class="mini-toc">
  2015. <li><a href="#Options-7" accesskey="1">Options</a></li>
  2016. </ul>
  2017. <div class="subsection-level-extent" id="Options-7">
  2018. <h4 class="subsection"><span>6.3.1 Options<a class="copiable-link" href="#Options-7"> &para;</a></span></h4>
  2019. <dl class="table">
  2020. <dt><samp class="option">palette</samp></dt>
  2021. <dd><p>Specify the global palette used by the bitmaps. When stored in VobSub, the
  2022. palette is normally specified in the index file; in Matroska, the palette is
  2023. stored in the codec extra-data in the same format as in VobSub. In DVDs, the
  2024. palette is stored in the IFO file, and therefore not available when reading
  2025. from dumped VOB files.
  2026. </p>
  2027. <p>The format for this option is a string containing 16 24-bits hexadecimal
  2028. numbers (without 0x prefix) separated by commas, for example <code class="code">0d00ee,
  2029. ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
  2030. 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
  2031. </p>
  2032. </dd>
  2033. <dt><samp class="option">ifo_palette</samp></dt>
  2034. <dd><p>Specify the IFO file from which the global palette is obtained.
  2035. (experimental)
  2036. </p>
  2037. </dd>
  2038. <dt><samp class="option">forced_subs_only</samp></dt>
  2039. <dd><p>Only decode subtitle entries marked as forced. Some titles have forced
  2040. and non-forced subtitles in the same track. Setting this flag to <code class="code">1</code>
  2041. will only keep the forced subtitles. Default value is <code class="code">0</code>.
  2042. </p></dd>
  2043. </dl>
  2044. </div>
  2045. </div>
  2046. <div class="section-level-extent" id="libzvbi_002dteletext">
  2047. <h3 class="section"><span>6.4 libzvbi-teletext<a class="copiable-link" href="#libzvbi_002dteletext"> &para;</a></span></h3>
  2048. <p>Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext
  2049. subtitles. Requires the presence of the libzvbi headers and library during
  2050. configuration. You need to explicitly configure the build with
  2051. <code class="code">--enable-libzvbi</code>.
  2052. </p>
  2053. <ul class="mini-toc">
  2054. <li><a href="#Options-8" accesskey="1">Options</a></li>
  2055. </ul>
  2056. <div class="subsection-level-extent" id="Options-8">
  2057. <h4 class="subsection"><span>6.4.1 Options<a class="copiable-link" href="#Options-8"> &para;</a></span></h4>
  2058. <dl class="table">
  2059. <dt><samp class="option">txt_page</samp></dt>
  2060. <dd><p>List of teletext page numbers to decode. Pages that do not match the specified
  2061. list are dropped. You may use the special <code class="code">*</code> string to match all pages,
  2062. or <code class="code">subtitle</code> to match all subtitle pages.
  2063. Default value is *.
  2064. </p></dd>
  2065. <dt><samp class="option">txt_default_region</samp></dt>
  2066. <dd><p>Set default character set used for decoding, a value between 0 and 87 (see
  2067. ETS 300 706, Section 15, Table 32). Default value is -1, which does not
  2068. override the libzvbi default. This option is needed for some legacy level 1.0
  2069. transmissions which cannot signal the proper charset.
  2070. </p></dd>
  2071. <dt><samp class="option">txt_chop_top</samp></dt>
  2072. <dd><p>Discards the top teletext line. Default value is 1.
  2073. </p></dd>
  2074. <dt><samp class="option">txt_format</samp></dt>
  2075. <dd><p>Specifies the format of the decoded subtitles.
  2076. </p><dl class="table">
  2077. <dt><samp class="option">bitmap</samp></dt>
  2078. <dd><p>The default format, you should use this for teletext pages, because certain
  2079. graphics and colors cannot be expressed in simple text or even ASS.
  2080. </p></dd>
  2081. <dt><samp class="option">text</samp></dt>
  2082. <dd><p>Simple text based output without formatting.
  2083. </p></dd>
  2084. <dt><samp class="option">ass</samp></dt>
  2085. <dd><p>Formatted ASS output, subtitle pages and teletext pages are returned in
  2086. different styles, subtitle pages are stripped down to text, but an effort is
  2087. made to keep the text alignment and the formatting.
  2088. </p></dd>
  2089. </dl>
  2090. </dd>
  2091. <dt><samp class="option">txt_left</samp></dt>
  2092. <dd><p>X offset of generated bitmaps, default is 0.
  2093. </p></dd>
  2094. <dt><samp class="option">txt_top</samp></dt>
  2095. <dd><p>Y offset of generated bitmaps, default is 0.
  2096. </p></dd>
  2097. <dt><samp class="option">txt_chop_spaces</samp></dt>
  2098. <dd><p>Chops leading and trailing spaces and removes empty lines from the generated
  2099. text. This option is useful for teletext based subtitles where empty spaces may
  2100. be present at the start or at the end of the lines or empty lines may be
  2101. present between the subtitle lines because of double-sized teletext characters.
  2102. Default value is 1.
  2103. </p></dd>
  2104. <dt><samp class="option">txt_duration</samp></dt>
  2105. <dd><p>Sets the display duration of the decoded teletext pages or subtitles in
  2106. milliseconds. Default value is -1 which means infinity or until the next
  2107. subtitle event comes.
  2108. </p></dd>
  2109. <dt><samp class="option">txt_transparent</samp></dt>
  2110. <dd><p>Force transparent background of the generated teletext bitmaps. Default value
  2111. is 0 which means an opaque background.
  2112. </p></dd>
  2113. <dt><samp class="option">txt_opacity</samp></dt>
  2114. <dd><p>Sets the opacity (0-255) of the teletext background. If
  2115. <samp class="option">txt_transparent</samp> is not set, it only affects characters between a start
  2116. box and an end box, typically subtitles. Default value is 0 if
  2117. <samp class="option">txt_transparent</samp> is set, 255 otherwise.
  2118. </p>
  2119. </dd>
  2120. </dl>
  2121. </div>
  2122. </div>
  2123. </div>
  2124. <div class="chapter-level-extent" id="Encoders">
  2125. <h2 class="chapter"><span>7 Encoders<a class="copiable-link" href="#Encoders"> &para;</a></span></h2>
  2126. <p>Encoders are configured elements in FFmpeg which allow the encoding of
  2127. multimedia streams.
  2128. </p>
  2129. <p>When you configure your FFmpeg build, all the supported native encoders
  2130. are enabled by default. Encoders requiring an external library must be enabled
  2131. manually via the corresponding <code class="code">--enable-lib</code> option. You can list all
  2132. available encoders using the configure option <code class="code">--list-encoders</code>.
  2133. </p>
  2134. <p>You can disable all the encoders with the configure option
  2135. <code class="code">--disable-encoders</code> and selectively enable / disable single encoders
  2136. with the options <code class="code">--enable-encoder=<var class="var">ENCODER</var></code> /
  2137. <code class="code">--disable-encoder=<var class="var">ENCODER</var></code>.
  2138. </p>
  2139. <p>The option <code class="code">-encoders</code> of the ff* tools will display the list of
  2140. enabled encoders.
  2141. </p>
  2142. </div>
  2143. <div class="chapter-level-extent" id="Audio-Encoders">
  2144. <h2 class="chapter"><span>8 Audio Encoders<a class="copiable-link" href="#Audio-Encoders"> &para;</a></span></h2>
  2145. <p>A description of some of the currently available audio encoders
  2146. follows.
  2147. </p>
  2148. <a class="anchor" id="aacenc"></a><ul class="mini-toc">
  2149. <li><a href="#aac" accesskey="1">aac</a></li>
  2150. <li><a href="#ac3-and-ac3_005ffixed" accesskey="2">ac3 and ac3_fixed</a></li>
  2151. <li><a href="#flac-2" accesskey="3">flac</a></li>
  2152. <li><a href="#opus" accesskey="4">opus</a></li>
  2153. <li><a href="#libfdk_005faac" accesskey="5">libfdk_aac</a></li>
  2154. <li><a href="#libmp3lame-1" accesskey="6">libmp3lame</a></li>
  2155. <li><a href="#libopencore_002damrnb-1" accesskey="7">libopencore-amrnb</a></li>
  2156. <li><a href="#libopus-1" accesskey="8">libopus</a></li>
  2157. <li><a href="#libshine-1" accesskey="9">libshine</a></li>
  2158. <li><a href="#libtwolame">libtwolame</a></li>
  2159. <li><a href="#libvo_002damrwbenc">libvo-amrwbenc</a></li>
  2160. <li><a href="#libvorbis">libvorbis</a></li>
  2161. <li><a href="#mjpeg">mjpeg</a></li>
  2162. <li><a href="#wavpack">wavpack</a></li>
  2163. </ul>
  2164. <div class="section-level-extent" id="aac">
  2165. <h3 class="section"><span>8.1 aac<a class="copiable-link" href="#aac"> &para;</a></span></h3>
  2166. <p>Advanced Audio Coding (AAC) encoder.
  2167. </p>
  2168. <p>This encoder is the default AAC encoder, natively implemented into FFmpeg.
  2169. </p>
  2170. <ul class="mini-toc">
  2171. <li><a href="#Options-9" accesskey="1">Options</a></li>
  2172. </ul>
  2173. <div class="subsection-level-extent" id="Options-9">
  2174. <h4 class="subsection"><span>8.1.1 Options<a class="copiable-link" href="#Options-9"> &para;</a></span></h4>
  2175. <dl class="table">
  2176. <dt><samp class="option">b</samp></dt>
  2177. <dd><p>Set bit rate in bits/s. Setting this automatically activates constant bit rate
  2178. (CBR) mode. If this option is unspecified it is set to 128kbps.
  2179. </p>
  2180. </dd>
  2181. <dt><samp class="option">q</samp></dt>
  2182. <dd><p>Set quality for variable bit rate (VBR) mode. This option is valid only using
  2183. the <code class="command">ffmpeg</code> command-line tool. For library interface users, use
  2184. <samp class="option">global_quality</samp>.
  2185. </p>
  2186. </dd>
  2187. <dt><samp class="option">cutoff</samp></dt>
  2188. <dd><p>Set cutoff frequency. If unspecified will allow the encoder to dynamically
  2189. adjust the cutoff to improve clarity on low bitrates.
  2190. </p>
  2191. </dd>
  2192. <dt><samp class="option">aac_coder</samp></dt>
  2193. <dd><p>Set AAC encoder coding method. Possible values:
  2194. </p>
  2195. <dl class="table">
  2196. <dt>&lsquo;<samp class="samp">twoloop</samp>&rsquo;</dt>
  2197. <dd><p>Two loop searching (TLS) method. This is the default method.
  2198. </p>
  2199. <p>This method first sets quantizers depending on band thresholds and then tries
  2200. to find an optimal combination by adding or subtracting a specific value from
  2201. all quantizers and adjusting some individual quantizer a little. Will tune
  2202. itself based on whether <samp class="option">aac_is</samp>, <samp class="option">aac_ms</samp> and <samp class="option">aac_pns</samp>
  2203. are enabled.
  2204. </p>
  2205. </dd>
  2206. <dt>&lsquo;<samp class="samp">anmr</samp>&rsquo;</dt>
  2207. <dd><p>Average noise to mask ratio (ANMR) trellis-based solution.
  2208. </p>
  2209. <p>This is an experimental coder which currently produces a lower quality, is more
  2210. unstable and is slower than the default twoloop coder but has potential.
  2211. Currently has no support for the <samp class="option">aac_is</samp> or <samp class="option">aac_pns</samp> options.
  2212. Not currently recommended.
  2213. </p>
  2214. </dd>
  2215. <dt>&lsquo;<samp class="samp">fast</samp>&rsquo;</dt>
  2216. <dd><p>Constant quantizer method.
  2217. </p>
  2218. <p>Uses a cheaper version of twoloop algorithm that doesn&rsquo;t try to do as many
  2219. clever adjustments. Worse with low bitrates (less than 64kbps), but is better
  2220. and much faster at higher bitrates.
  2221. </p>
  2222. </dd>
  2223. </dl>
  2224. </dd>
  2225. <dt><samp class="option">aac_ms</samp></dt>
  2226. <dd><p>Sets mid/side coding mode. The default value of &quot;auto&quot; will automatically use
  2227. M/S with bands which will benefit from such coding. Can be forced for all bands
  2228. using the value &quot;enable&quot;, which is mainly useful for debugging or disabled using
  2229. &quot;disable&quot;.
  2230. </p>
  2231. </dd>
  2232. <dt><samp class="option">aac_is</samp></dt>
  2233. <dd><p>Sets intensity stereo coding tool usage. By default, it&rsquo;s enabled and will
  2234. automatically toggle IS for similar pairs of stereo bands if it&rsquo;s beneficial.
  2235. Can be disabled for debugging by setting the value to &quot;disable&quot;.
  2236. </p>
  2237. </dd>
  2238. <dt><samp class="option">aac_pns</samp></dt>
  2239. <dd><p>Uses perceptual noise substitution to replace low entropy high frequency bands
  2240. with imperceptible white noise during the decoding process. By default, it&rsquo;s
  2241. enabled, but can be disabled for debugging purposes by using &quot;disable&quot;.
  2242. </p>
  2243. </dd>
  2244. <dt><samp class="option">aac_tns</samp></dt>
  2245. <dd><p>Enables the use of a multitap FIR filter which spans through the high frequency
  2246. bands to hide quantization noise during the encoding process and is reverted
  2247. by the decoder. As well as decreasing unpleasant artifacts in the high range
  2248. this also reduces the entropy in the high bands and allows for more bits to
  2249. be used by the mid-low bands. By default it&rsquo;s enabled but can be disabled for
  2250. debugging by setting the option to &quot;disable&quot;.
  2251. </p>
  2252. </dd>
  2253. <dt><samp class="option">aac_ltp</samp></dt>
  2254. <dd><p>Enables the use of the long term prediction extension which increases coding
  2255. efficiency in very low bandwidth situations such as encoding of voice or
  2256. solo piano music by extending constant harmonic peaks in bands throughout
  2257. frames. This option is implied by profile:a aac_low and is incompatible with
  2258. aac_pred. Use in conjunction with <samp class="option">-ar</samp> to decrease the samplerate.
  2259. </p>
  2260. </dd>
  2261. <dt><samp class="option">aac_pred</samp></dt>
  2262. <dd><p>Enables the use of a more traditional style of prediction where the spectral
  2263. coefficients transmitted are replaced by the difference of the current
  2264. coefficients minus the previous &quot;predicted&quot; coefficients. In theory and sometimes
  2265. in practice this can improve quality for low to mid bitrate audio.
  2266. This option implies the aac_main profile and is incompatible with aac_ltp.
  2267. </p>
  2268. </dd>
  2269. <dt><samp class="option">profile</samp></dt>
  2270. <dd><p>Sets the encoding profile, possible values:
  2271. </p>
  2272. <dl class="table">
  2273. <dt>&lsquo;<samp class="samp">aac_low</samp>&rsquo;</dt>
  2274. <dd><p>The default, AAC &quot;Low-complexity&quot; profile. Is the most compatible and produces
  2275. decent quality.
  2276. </p>
  2277. </dd>
  2278. <dt>&lsquo;<samp class="samp">mpeg2_aac_low</samp>&rsquo;</dt>
  2279. <dd><p>Equivalent to <code class="code">-profile:a aac_low -aac_pns 0</code>. PNS was introduced with the
  2280. MPEG4 specifications.
  2281. </p>
  2282. </dd>
  2283. <dt>&lsquo;<samp class="samp">aac_ltp</samp>&rsquo;</dt>
  2284. <dd><p>Long term prediction profile, is enabled by and will enable the <samp class="option">aac_ltp</samp>
  2285. option. Introduced in MPEG4.
  2286. </p>
  2287. </dd>
  2288. <dt>&lsquo;<samp class="samp">aac_main</samp>&rsquo;</dt>
  2289. <dd><p>Main-type prediction profile, is enabled by and will enable the <samp class="option">aac_pred</samp>
  2290. option. Introduced in MPEG2.
  2291. </p>
  2292. </dd>
  2293. </dl>
  2294. <p>If this option is unspecified it is set to &lsquo;<samp class="samp">aac_low</samp>&rsquo;.
  2295. </p></dd>
  2296. </dl>
  2297. </div>
  2298. </div>
  2299. <div class="section-level-extent" id="ac3-and-ac3_005ffixed">
  2300. <h3 class="section"><span>8.2 ac3 and ac3_fixed<a class="copiable-link" href="#ac3-and-ac3_005ffixed"> &para;</a></span></h3>
  2301. <p>AC-3 audio encoders.
  2302. </p>
  2303. <p>These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as
  2304. the undocumented RealAudio 3 (a.k.a. dnet).
  2305. </p>
  2306. <p>The <var class="var">ac3</var> encoder uses floating-point math, while the <var class="var">ac3_fixed</var>
  2307. encoder only uses fixed-point integer math. This does not mean that one is
  2308. always faster, just that one or the other may be better suited to a
  2309. particular system. The <var class="var">ac3_fixed</var> encoder is not the default codec for
  2310. any of the output formats, so it must be specified explicitly using the option
  2311. <code class="code">-acodec ac3_fixed</code> in order to use it.
  2312. </p>
  2313. <ul class="mini-toc">
  2314. <li><a href="#AC_002d3-Metadata" accesskey="1">AC-3 Metadata</a></li>
  2315. <li><a href="#Extended-Bitstream-Information" accesskey="2">Extended Bitstream Information</a></li>
  2316. <li><a href="#Other-AC_002d3-Encoding-Options" accesskey="3">Other AC-3 Encoding Options</a></li>
  2317. <li><a href="#Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options" accesskey="4">Floating-Point-Only AC-3 Encoding Options</a></li>
  2318. </ul>
  2319. <div class="subsection-level-extent" id="AC_002d3-Metadata">
  2320. <h4 class="subsection"><span>8.2.1 AC-3 Metadata<a class="copiable-link" href="#AC_002d3-Metadata"> &para;</a></span></h4>
  2321. <p>The AC-3 metadata options are used to set parameters that describe the audio,
  2322. but in most cases do not affect the audio encoding itself. Some of the options
  2323. do directly affect or influence the decoding and playback of the resulting
  2324. bitstream, while others are just for informational purposes. A few of the
  2325. options will add bits to the output stream that could otherwise be used for
  2326. audio data, and will thus affect the quality of the output. Those will be
  2327. indicated accordingly with a note in the option list below.
  2328. </p>
  2329. <p>These parameters are described in detail in several publicly-available
  2330. documents.
  2331. </p><ul class="itemize mark-bullet">
  2332. <li><a class="uref" href="http://www.atsc.org/cms/standards/a_52-2010.pdf">A/52:2010 - Digital Audio Compression (AC-3) (E-AC-3) Standard</a>
  2333. </li><li><a class="uref" 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>
  2334. </li><li><a class="uref" href="http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/18_Metadata.Guide.pdf">Dolby Metadata Guide</a>
  2335. </li><li><a class="uref" href="http://www.dolby.com/uploadedFiles/zz-_Shared_Assets/English_PDFs/Professional/46_DDEncodingGuidelines.pdf">Dolby Digital Professional Encoding Guidelines</a>
  2336. </li></ul>
  2337. <ul class="mini-toc">
  2338. <li><a href="#Metadata-Control-Options" accesskey="1">Metadata Control Options</a></li>
  2339. <li><a href="#Downmix-Levels" accesskey="2">Downmix Levels</a></li>
  2340. <li><a href="#Audio-Production-Information" accesskey="3">Audio Production Information</a></li>
  2341. <li><a href="#Other-Metadata-Options" accesskey="4">Other Metadata Options</a></li>
  2342. </ul>
  2343. <div class="subsubsection-level-extent" id="Metadata-Control-Options">
  2344. <h4 class="subsubsection"><span>8.2.1.1 Metadata Control Options<a class="copiable-link" href="#Metadata-Control-Options"> &para;</a></span></h4>
  2345. <dl class="table">
  2346. <dt><samp class="option">-per_frame_metadata <var class="var">boolean</var></samp></dt>
  2347. <dd><p>Allow Per-Frame Metadata. Specifies if the encoder should check for changing
  2348. metadata for each frame.
  2349. </p><dl class="table">
  2350. <dt><samp class="option">0</samp></dt>
  2351. <dd><p>The metadata values set at initialization will be used for every frame in the
  2352. stream. (default)
  2353. </p></dd>
  2354. <dt><samp class="option">1</samp></dt>
  2355. <dd><p>Metadata values can be changed before encoding each frame.
  2356. </p></dd>
  2357. </dl>
  2358. </dd>
  2359. </dl>
  2360. </div>
  2361. <div class="subsubsection-level-extent" id="Downmix-Levels">
  2362. <h4 class="subsubsection"><span>8.2.1.2 Downmix Levels<a class="copiable-link" href="#Downmix-Levels"> &para;</a></span></h4>
  2363. <dl class="table">
  2364. <dt><samp class="option">-center_mixlev <var class="var">level</var></samp></dt>
  2365. <dd><p>Center Mix Level. The amount of gain the decoder should apply to the center
  2366. channel when downmixing to stereo. This field will only be written to the
  2367. bitstream if a center channel is present. The value is specified as a scale
  2368. factor. There are 3 valid values:
  2369. </p><dl class="table">
  2370. <dt><samp class="option">0.707</samp></dt>
  2371. <dd><p>Apply -3dB gain
  2372. </p></dd>
  2373. <dt><samp class="option">0.595</samp></dt>
  2374. <dd><p>Apply -4.5dB gain (default)
  2375. </p></dd>
  2376. <dt><samp class="option">0.500</samp></dt>
  2377. <dd><p>Apply -6dB gain
  2378. </p></dd>
  2379. </dl>
  2380. </dd>
  2381. <dt><samp class="option">-surround_mixlev <var class="var">level</var></samp></dt>
  2382. <dd><p>Surround Mix Level. The amount of gain the decoder should apply to the surround
  2383. channel(s) when downmixing to stereo. This field will only be written to the
  2384. bitstream if one or more surround channels are present. The value is specified
  2385. as a scale factor. There are 3 valid values:
  2386. </p><dl class="table">
  2387. <dt><samp class="option">0.707</samp></dt>
  2388. <dd><p>Apply -3dB gain
  2389. </p></dd>
  2390. <dt><samp class="option">0.500</samp></dt>
  2391. <dd><p>Apply -6dB gain (default)
  2392. </p></dd>
  2393. <dt><samp class="option">0.000</samp></dt>
  2394. <dd><p>Silence Surround Channel(s)
  2395. </p></dd>
  2396. </dl>
  2397. </dd>
  2398. </dl>
  2399. </div>
  2400. <div class="subsubsection-level-extent" id="Audio-Production-Information">
  2401. <h4 class="subsubsection"><span>8.2.1.3 Audio Production Information<a class="copiable-link" href="#Audio-Production-Information"> &para;</a></span></h4>
  2402. <p>Audio Production Information is optional information describing the mixing
  2403. environment. Either none or both of the fields are written to the bitstream.
  2404. </p>
  2405. <dl class="table">
  2406. <dt><samp class="option">-mixing_level <var class="var">number</var></samp></dt>
  2407. <dd><p>Mixing Level. Specifies peak sound pressure level (SPL) in the production
  2408. environment when the mix was mastered. Valid values are 80 to 111, or -1 for
  2409. unknown or not indicated. The default value is -1, but that value cannot be
  2410. used if the Audio Production Information is written to the bitstream. Therefore,
  2411. if the <code class="code">room_type</code> option is not the default value, the <code class="code">mixing_level</code>
  2412. option must not be -1.
  2413. </p>
  2414. </dd>
  2415. <dt><samp class="option">-room_type <var class="var">type</var></samp></dt>
  2416. <dd><p>Room Type. Describes the equalization used during the final mixing session at
  2417. the studio or on the dubbing stage. A large room is a dubbing stage with the
  2418. industry standard X-curve equalization; a small room has flat equalization.
  2419. This field will not be written to the bitstream if both the <code class="code">mixing_level</code>
  2420. option and the <code class="code">room_type</code> option have the default values.
  2421. </p><dl class="table">
  2422. <dt><samp class="option">0</samp></dt>
  2423. <dt><samp class="option">notindicated</samp></dt>
  2424. <dd><p>Not Indicated (default)
  2425. </p></dd>
  2426. <dt><samp class="option">1</samp></dt>
  2427. <dt><samp class="option">large</samp></dt>
  2428. <dd><p>Large Room
  2429. </p></dd>
  2430. <dt><samp class="option">2</samp></dt>
  2431. <dt><samp class="option">small</samp></dt>
  2432. <dd><p>Small Room
  2433. </p></dd>
  2434. </dl>
  2435. </dd>
  2436. </dl>
  2437. </div>
  2438. <div class="subsubsection-level-extent" id="Other-Metadata-Options">
  2439. <h4 class="subsubsection"><span>8.2.1.4 Other Metadata Options<a class="copiable-link" href="#Other-Metadata-Options"> &para;</a></span></h4>
  2440. <dl class="table">
  2441. <dt><samp class="option">-copyright <var class="var">boolean</var></samp></dt>
  2442. <dd><p>Copyright Indicator. Specifies whether a copyright exists for this audio.
  2443. </p><dl class="table">
  2444. <dt><samp class="option">0</samp></dt>
  2445. <dt><samp class="option">off</samp></dt>
  2446. <dd><p>No Copyright Exists (default)
  2447. </p></dd>
  2448. <dt><samp class="option">1</samp></dt>
  2449. <dt><samp class="option">on</samp></dt>
  2450. <dd><p>Copyright Exists
  2451. </p></dd>
  2452. </dl>
  2453. </dd>
  2454. <dt><samp class="option">-dialnorm <var class="var">value</var></samp></dt>
  2455. <dd><p>Dialogue Normalization. Indicates how far the average dialogue level of the
  2456. program is below digital 100% full scale (0 dBFS). This parameter determines a
  2457. level shift during audio reproduction that sets the average volume of the
  2458. dialogue to a preset level. The goal is to match volume level between program
  2459. sources. A value of -31dB will result in no volume level change, relative to
  2460. the source volume, during audio reproduction. Valid values are whole numbers in
  2461. the range -31 to -1, with -31 being the default.
  2462. </p>
  2463. </dd>
  2464. <dt><samp class="option">-dsur_mode <var class="var">mode</var></samp></dt>
  2465. <dd><p>Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround
  2466. (Pro Logic). This field will only be written to the bitstream if the audio
  2467. stream is stereo. Using this option does <b class="b">NOT</b> mean the encoder will actually
  2468. apply Dolby Surround processing.
  2469. </p><dl class="table">
  2470. <dt><samp class="option">0</samp></dt>
  2471. <dt><samp class="option">notindicated</samp></dt>
  2472. <dd><p>Not Indicated (default)
  2473. </p></dd>
  2474. <dt><samp class="option">1</samp></dt>
  2475. <dt><samp class="option">off</samp></dt>
  2476. <dd><p>Not Dolby Surround Encoded
  2477. </p></dd>
  2478. <dt><samp class="option">2</samp></dt>
  2479. <dt><samp class="option">on</samp></dt>
  2480. <dd><p>Dolby Surround Encoded
  2481. </p></dd>
  2482. </dl>
  2483. </dd>
  2484. <dt><samp class="option">-original <var class="var">boolean</var></samp></dt>
  2485. <dd><p>Original Bit Stream Indicator. Specifies whether this audio is from the
  2486. original source and not a copy.
  2487. </p><dl class="table">
  2488. <dt><samp class="option">0</samp></dt>
  2489. <dt><samp class="option">off</samp></dt>
  2490. <dd><p>Not Original Source
  2491. </p></dd>
  2492. <dt><samp class="option">1</samp></dt>
  2493. <dt><samp class="option">on</samp></dt>
  2494. <dd><p>Original Source (default)
  2495. </p></dd>
  2496. </dl>
  2497. </dd>
  2498. </dl>
  2499. </div>
  2500. </div>
  2501. <div class="subsection-level-extent" id="Extended-Bitstream-Information">
  2502. <h4 class="subsection"><span>8.2.2 Extended Bitstream Information<a class="copiable-link" href="#Extended-Bitstream-Information"> &para;</a></span></h4>
  2503. <p>The extended bitstream options are part of the Alternate Bit Stream Syntax as
  2504. specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts.
  2505. If any one parameter in a group is specified, all values in that group will be
  2506. written to the bitstream. Default values are used for those that are written
  2507. but have not been specified. If the mixing levels are written, the decoder
  2508. will use these values instead of the ones specified in the <code class="code">center_mixlev</code>
  2509. and <code class="code">surround_mixlev</code> options if it supports the Alternate Bit Stream
  2510. Syntax.
  2511. </p>
  2512. <ul class="mini-toc">
  2513. <li><a href="#Extended-Bitstream-Information-_002d-Part-1" accesskey="1">Extended Bitstream Information - Part 1</a></li>
  2514. <li><a href="#Extended-Bitstream-Information-_002d-Part-2" accesskey="2">Extended Bitstream Information - Part 2</a></li>
  2515. </ul>
  2516. <div class="subsubsection-level-extent" id="Extended-Bitstream-Information-_002d-Part-1">
  2517. <h4 class="subsubsection"><span>8.2.2.1 Extended Bitstream Information - Part 1<a class="copiable-link" href="#Extended-Bitstream-Information-_002d-Part-1"> &para;</a></span></h4>
  2518. <dl class="table">
  2519. <dt><samp class="option">-dmix_mode <var class="var">mode</var></samp></dt>
  2520. <dd><p>Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt
  2521. (Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode.
  2522. </p><dl class="table">
  2523. <dt><samp class="option">0</samp></dt>
  2524. <dt><samp class="option">notindicated</samp></dt>
  2525. <dd><p>Not Indicated (default)
  2526. </p></dd>
  2527. <dt><samp class="option">1</samp></dt>
  2528. <dt><samp class="option">ltrt</samp></dt>
  2529. <dd><p>Lt/Rt Downmix Preferred
  2530. </p></dd>
  2531. <dt><samp class="option">2</samp></dt>
  2532. <dt><samp class="option">loro</samp></dt>
  2533. <dd><p>Lo/Ro Downmix Preferred
  2534. </p></dd>
  2535. </dl>
  2536. </dd>
  2537. <dt><samp class="option">-ltrt_cmixlev <var class="var">level</var></samp></dt>
  2538. <dd><p>Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the
  2539. center channel when downmixing to stereo in Lt/Rt mode.
  2540. </p><dl class="table">
  2541. <dt><samp class="option">1.414</samp></dt>
  2542. <dd><p>Apply +3dB gain
  2543. </p></dd>
  2544. <dt><samp class="option">1.189</samp></dt>
  2545. <dd><p>Apply +1.5dB gain
  2546. </p></dd>
  2547. <dt><samp class="option">1.000</samp></dt>
  2548. <dd><p>Apply 0dB gain
  2549. </p></dd>
  2550. <dt><samp class="option">0.841</samp></dt>
  2551. <dd><p>Apply -1.5dB gain
  2552. </p></dd>
  2553. <dt><samp class="option">0.707</samp></dt>
  2554. <dd><p>Apply -3.0dB gain
  2555. </p></dd>
  2556. <dt><samp class="option">0.595</samp></dt>
  2557. <dd><p>Apply -4.5dB gain (default)
  2558. </p></dd>
  2559. <dt><samp class="option">0.500</samp></dt>
  2560. <dd><p>Apply -6.0dB gain
  2561. </p></dd>
  2562. <dt><samp class="option">0.000</samp></dt>
  2563. <dd><p>Silence Center Channel
  2564. </p></dd>
  2565. </dl>
  2566. </dd>
  2567. <dt><samp class="option">-ltrt_surmixlev <var class="var">level</var></samp></dt>
  2568. <dd><p>Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the
  2569. surround channel(s) when downmixing to stereo in Lt/Rt mode.
  2570. </p><dl class="table">
  2571. <dt><samp class="option">0.841</samp></dt>
  2572. <dd><p>Apply -1.5dB gain
  2573. </p></dd>
  2574. <dt><samp class="option">0.707</samp></dt>
  2575. <dd><p>Apply -3.0dB gain
  2576. </p></dd>
  2577. <dt><samp class="option">0.595</samp></dt>
  2578. <dd><p>Apply -4.5dB gain
  2579. </p></dd>
  2580. <dt><samp class="option">0.500</samp></dt>
  2581. <dd><p>Apply -6.0dB gain (default)
  2582. </p></dd>
  2583. <dt><samp class="option">0.000</samp></dt>
  2584. <dd><p>Silence Surround Channel(s)
  2585. </p></dd>
  2586. </dl>
  2587. </dd>
  2588. <dt><samp class="option">-loro_cmixlev <var class="var">level</var></samp></dt>
  2589. <dd><p>Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the
  2590. center channel when downmixing to stereo in Lo/Ro mode.
  2591. </p><dl class="table">
  2592. <dt><samp class="option">1.414</samp></dt>
  2593. <dd><p>Apply +3dB gain
  2594. </p></dd>
  2595. <dt><samp class="option">1.189</samp></dt>
  2596. <dd><p>Apply +1.5dB gain
  2597. </p></dd>
  2598. <dt><samp class="option">1.000</samp></dt>
  2599. <dd><p>Apply 0dB gain
  2600. </p></dd>
  2601. <dt><samp class="option">0.841</samp></dt>
  2602. <dd><p>Apply -1.5dB gain
  2603. </p></dd>
  2604. <dt><samp class="option">0.707</samp></dt>
  2605. <dd><p>Apply -3.0dB gain
  2606. </p></dd>
  2607. <dt><samp class="option">0.595</samp></dt>
  2608. <dd><p>Apply -4.5dB gain (default)
  2609. </p></dd>
  2610. <dt><samp class="option">0.500</samp></dt>
  2611. <dd><p>Apply -6.0dB gain
  2612. </p></dd>
  2613. <dt><samp class="option">0.000</samp></dt>
  2614. <dd><p>Silence Center Channel
  2615. </p></dd>
  2616. </dl>
  2617. </dd>
  2618. <dt><samp class="option">-loro_surmixlev <var class="var">level</var></samp></dt>
  2619. <dd><p>Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the
  2620. surround channel(s) when downmixing to stereo in Lo/Ro mode.
  2621. </p><dl class="table">
  2622. <dt><samp class="option">0.841</samp></dt>
  2623. <dd><p>Apply -1.5dB gain
  2624. </p></dd>
  2625. <dt><samp class="option">0.707</samp></dt>
  2626. <dd><p>Apply -3.0dB gain
  2627. </p></dd>
  2628. <dt><samp class="option">0.595</samp></dt>
  2629. <dd><p>Apply -4.5dB gain
  2630. </p></dd>
  2631. <dt><samp class="option">0.500</samp></dt>
  2632. <dd><p>Apply -6.0dB gain (default)
  2633. </p></dd>
  2634. <dt><samp class="option">0.000</samp></dt>
  2635. <dd><p>Silence Surround Channel(s)
  2636. </p></dd>
  2637. </dl>
  2638. </dd>
  2639. </dl>
  2640. </div>
  2641. <div class="subsubsection-level-extent" id="Extended-Bitstream-Information-_002d-Part-2">
  2642. <h4 class="subsubsection"><span>8.2.2.2 Extended Bitstream Information - Part 2<a class="copiable-link" href="#Extended-Bitstream-Information-_002d-Part-2"> &para;</a></span></h4>
  2643. <dl class="table">
  2644. <dt><samp class="option">-dsurex_mode <var class="var">mode</var></samp></dt>
  2645. <dd><p>Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX
  2646. (7.1 matrixed to 5.1). Using this option does <b class="b">NOT</b> mean the encoder will actually
  2647. apply Dolby Surround EX processing.
  2648. </p><dl class="table">
  2649. <dt><samp class="option">0</samp></dt>
  2650. <dt><samp class="option">notindicated</samp></dt>
  2651. <dd><p>Not Indicated (default)
  2652. </p></dd>
  2653. <dt><samp class="option">1</samp></dt>
  2654. <dt><samp class="option">on</samp></dt>
  2655. <dd><p>Dolby Surround EX Off
  2656. </p></dd>
  2657. <dt><samp class="option">2</samp></dt>
  2658. <dt><samp class="option">off</samp></dt>
  2659. <dd><p>Dolby Surround EX On
  2660. </p></dd>
  2661. </dl>
  2662. </dd>
  2663. <dt><samp class="option">-dheadphone_mode <var class="var">mode</var></samp></dt>
  2664. <dd><p>Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone
  2665. encoding (multi-channel matrixed to 2.0 for use with headphones). Using this
  2666. option does <b class="b">NOT</b> mean the encoder will actually apply Dolby Headphone
  2667. processing.
  2668. </p><dl class="table">
  2669. <dt><samp class="option">0</samp></dt>
  2670. <dt><samp class="option">notindicated</samp></dt>
  2671. <dd><p>Not Indicated (default)
  2672. </p></dd>
  2673. <dt><samp class="option">1</samp></dt>
  2674. <dt><samp class="option">on</samp></dt>
  2675. <dd><p>Dolby Headphone Off
  2676. </p></dd>
  2677. <dt><samp class="option">2</samp></dt>
  2678. <dt><samp class="option">off</samp></dt>
  2679. <dd><p>Dolby Headphone On
  2680. </p></dd>
  2681. </dl>
  2682. </dd>
  2683. <dt><samp class="option">-ad_conv_type <var class="var">type</var></samp></dt>
  2684. <dd><p>A/D Converter Type. Indicates whether the audio has passed through HDCD A/D
  2685. conversion.
  2686. </p><dl class="table">
  2687. <dt><samp class="option">0</samp></dt>
  2688. <dt><samp class="option">standard</samp></dt>
  2689. <dd><p>Standard A/D Converter (default)
  2690. </p></dd>
  2691. <dt><samp class="option">1</samp></dt>
  2692. <dt><samp class="option">hdcd</samp></dt>
  2693. <dd><p>HDCD A/D Converter
  2694. </p></dd>
  2695. </dl>
  2696. </dd>
  2697. </dl>
  2698. </div>
  2699. </div>
  2700. <div class="subsection-level-extent" id="Other-AC_002d3-Encoding-Options">
  2701. <h4 class="subsection"><span>8.2.3 Other AC-3 Encoding Options<a class="copiable-link" href="#Other-AC_002d3-Encoding-Options"> &para;</a></span></h4>
  2702. <dl class="table">
  2703. <dt><samp class="option">-stereo_rematrixing <var class="var">boolean</var></samp></dt>
  2704. <dd><p>Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This
  2705. is an optional AC-3 feature that increases quality by selectively encoding
  2706. the left/right channels as mid/side. This option is enabled by default, and it
  2707. is highly recommended that it be left as enabled except for testing purposes.
  2708. </p>
  2709. </dd>
  2710. <dt><samp class="option">cutoff <var class="var">frequency</var></samp></dt>
  2711. <dd><p>Set lowpass cutoff frequency. If unspecified, the encoder selects a default
  2712. determined by various other encoding parameters.
  2713. </p>
  2714. </dd>
  2715. </dl>
  2716. </div>
  2717. <div class="subsection-level-extent" id="Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options">
  2718. <h4 class="subsection"><span>8.2.4 Floating-Point-Only AC-3 Encoding Options<a class="copiable-link" href="#Floating_002dPoint_002dOnly-AC_002d3-Encoding-Options"> &para;</a></span></h4>
  2719. <p>These options are only valid for the floating-point encoder and do not exist
  2720. for the fixed-point encoder due to the corresponding features not being
  2721. implemented in fixed-point.
  2722. </p>
  2723. <dl class="table">
  2724. <dt><samp class="option">-channel_coupling <var class="var">boolean</var></samp></dt>
  2725. <dd><p>Enables/Disables use of channel coupling, which is an optional AC-3 feature
  2726. that increases quality by combining high frequency information from multiple
  2727. channels into a single channel. The per-channel high frequency information is
  2728. sent with less accuracy in both the frequency and time domains. This allows
  2729. more bits to be used for lower frequencies while preserving enough information
  2730. to reconstruct the high frequencies. This option is enabled by default for the
  2731. floating-point encoder and should generally be left as enabled except for
  2732. testing purposes or to increase encoding speed.
  2733. </p><dl class="table">
  2734. <dt><samp class="option">-1</samp></dt>
  2735. <dt><samp class="option">auto</samp></dt>
  2736. <dd><p>Selected by Encoder (default)
  2737. </p></dd>
  2738. <dt><samp class="option">0</samp></dt>
  2739. <dt><samp class="option">off</samp></dt>
  2740. <dd><p>Disable Channel Coupling
  2741. </p></dd>
  2742. <dt><samp class="option">1</samp></dt>
  2743. <dt><samp class="option">on</samp></dt>
  2744. <dd><p>Enable Channel Coupling
  2745. </p></dd>
  2746. </dl>
  2747. </dd>
  2748. <dt><samp class="option">-cpl_start_band <var class="var">number</var></samp></dt>
  2749. <dd><p>Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a
  2750. value higher than the bandwidth is used, it will be reduced to 1 less than the
  2751. coupling end band. If <var class="var">auto</var> is used, the start band will be determined by
  2752. the encoder based on the bit rate, sample rate, and channel layout. This option
  2753. has no effect if channel coupling is disabled.
  2754. </p><dl class="table">
  2755. <dt><samp class="option">-1</samp></dt>
  2756. <dt><samp class="option">auto</samp></dt>
  2757. <dd><p>Selected by Encoder (default)
  2758. </p></dd>
  2759. </dl>
  2760. </dd>
  2761. </dl>
  2762. <a class="anchor" id="flac"></a></div>
  2763. </div>
  2764. <div class="section-level-extent" id="flac-2">
  2765. <h3 class="section"><span>8.3 flac<a class="copiable-link" href="#flac-2"> &para;</a></span></h3>
  2766. <p>FLAC (Free Lossless Audio Codec) Encoder
  2767. </p>
  2768. <ul class="mini-toc">
  2769. <li><a href="#Options-10" accesskey="1">Options</a></li>
  2770. </ul>
  2771. <div class="subsection-level-extent" id="Options-10">
  2772. <h4 class="subsection"><span>8.3.1 Options<a class="copiable-link" href="#Options-10"> &para;</a></span></h4>
  2773. <p>The following options are supported by FFmpeg&rsquo;s flac encoder.
  2774. </p>
  2775. <dl class="table">
  2776. <dt><samp class="option">compression_level</samp></dt>
  2777. <dd><p>Sets the compression level, which chooses defaults for many other options
  2778. if they are not set explicitly. Valid values are from 0 to 12, 5 is the
  2779. default.
  2780. </p>
  2781. </dd>
  2782. <dt><samp class="option">frame_size</samp></dt>
  2783. <dd><p>Sets the size of the frames in samples per channel.
  2784. </p>
  2785. </dd>
  2786. <dt><samp class="option">lpc_coeff_precision</samp></dt>
  2787. <dd><p>Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the
  2788. default.
  2789. </p>
  2790. </dd>
  2791. <dt><samp class="option">lpc_type</samp></dt>
  2792. <dd><p>Sets the first stage LPC algorithm
  2793. </p><dl class="table">
  2794. <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
  2795. <dd><p>LPC is not used
  2796. </p>
  2797. </dd>
  2798. <dt>&lsquo;<samp class="samp">fixed</samp>&rsquo;</dt>
  2799. <dd><p>fixed LPC coefficients
  2800. </p>
  2801. </dd>
  2802. <dt>&lsquo;<samp class="samp">levinson</samp>&rsquo;</dt>
  2803. <dt>&lsquo;<samp class="samp">cholesky</samp>&rsquo;</dt>
  2804. </dl>
  2805. </dd>
  2806. <dt><samp class="option">lpc_passes</samp></dt>
  2807. <dd><p>Number of passes to use for Cholesky factorization during LPC analysis
  2808. </p>
  2809. </dd>
  2810. <dt><samp class="option">min_partition_order</samp></dt>
  2811. <dd><p>The minimum partition order
  2812. </p>
  2813. </dd>
  2814. <dt><samp class="option">max_partition_order</samp></dt>
  2815. <dd><p>The maximum partition order
  2816. </p>
  2817. </dd>
  2818. <dt><samp class="option">prediction_order_method</samp></dt>
  2819. <dd><dl class="table">
  2820. <dt>&lsquo;<samp class="samp">estimation</samp>&rsquo;</dt>
  2821. <dt>&lsquo;<samp class="samp">2level</samp>&rsquo;</dt>
  2822. <dt>&lsquo;<samp class="samp">4level</samp>&rsquo;</dt>
  2823. <dt>&lsquo;<samp class="samp">8level</samp>&rsquo;</dt>
  2824. <dt>&lsquo;<samp class="samp">search</samp>&rsquo;</dt>
  2825. <dd><p>Bruteforce search
  2826. </p></dd>
  2827. <dt>&lsquo;<samp class="samp">log</samp>&rsquo;</dt>
  2828. </dl>
  2829. </dd>
  2830. <dt><samp class="option">ch_mode</samp></dt>
  2831. <dd><p>Channel mode
  2832. </p><dl class="table">
  2833. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  2834. <dd><p>The mode is chosen automatically for each frame
  2835. </p></dd>
  2836. <dt>&lsquo;<samp class="samp">indep</samp>&rsquo;</dt>
  2837. <dd><p>Channels are independently coded
  2838. </p></dd>
  2839. <dt>&lsquo;<samp class="samp">left_side</samp>&rsquo;</dt>
  2840. <dt>&lsquo;<samp class="samp">right_side</samp>&rsquo;</dt>
  2841. <dt>&lsquo;<samp class="samp">mid_side</samp>&rsquo;</dt>
  2842. </dl>
  2843. </dd>
  2844. <dt><samp class="option">exact_rice_parameters</samp></dt>
  2845. <dd><p>Chooses if rice parameters are calculated exactly or approximately.
  2846. if set to 1 then they are chosen exactly, which slows the code down slightly and
  2847. improves compression slightly.
  2848. </p>
  2849. </dd>
  2850. <dt><samp class="option">multi_dim_quant</samp></dt>
  2851. <dd><p>Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is
  2852. applied after the first stage to finetune the coefficients. This is quite slow
  2853. and slightly improves compression.
  2854. </p>
  2855. </dd>
  2856. </dl>
  2857. <a class="anchor" id="opusenc"></a></div>
  2858. </div>
  2859. <div class="section-level-extent" id="opus">
  2860. <h3 class="section"><span>8.4 opus<a class="copiable-link" href="#opus"> &para;</a></span></h3>
  2861. <p>Opus encoder.
  2862. </p>
  2863. <p>This is a native FFmpeg encoder for the Opus format. Currently its in development and
  2864. only implements the CELT part of the codec. Its quality is usually worse and at best
  2865. is equal to the libopus encoder.
  2866. </p>
  2867. <ul class="mini-toc">
  2868. <li><a href="#Options-11" accesskey="1">Options</a></li>
  2869. </ul>
  2870. <div class="subsection-level-extent" id="Options-11">
  2871. <h4 class="subsection"><span>8.4.1 Options<a class="copiable-link" href="#Options-11"> &para;</a></span></h4>
  2872. <dl class="table">
  2873. <dt><samp class="option">b</samp></dt>
  2874. <dd><p>Set bit rate in bits/s. If unspecified it uses the number of channels and the layout
  2875. to make a good guess.
  2876. </p>
  2877. </dd>
  2878. <dt><samp class="option">opus_delay</samp></dt>
  2879. <dd><p>Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly
  2880. decrease quality.
  2881. </p></dd>
  2882. </dl>
  2883. <a class="anchor" id="libfdk_002daac_002denc"></a></div>
  2884. </div>
  2885. <div class="section-level-extent" id="libfdk_005faac">
  2886. <h3 class="section"><span>8.5 libfdk_aac<a class="copiable-link" href="#libfdk_005faac"> &para;</a></span></h3>
  2887. <p>libfdk-aac AAC (Advanced Audio Coding) encoder wrapper.
  2888. </p>
  2889. <p>The libfdk-aac library is based on the Fraunhofer FDK AAC code from
  2890. the Android project.
  2891. </p>
  2892. <p>Requires the presence of the libfdk-aac headers and library during
  2893. configuration. You need to explicitly configure the build with
  2894. <code class="code">--enable-libfdk-aac</code>. The library is also incompatible with GPL,
  2895. so if you allow the use of GPL, you should configure with
  2896. <code class="code">--enable-gpl --enable-nonfree --enable-libfdk-aac</code>.
  2897. </p>
  2898. <p>This encoder has support for the AAC-HE profiles.
  2899. </p>
  2900. <p>VBR encoding, enabled through the <samp class="option">vbr</samp> or <samp class="option">flags
  2901. +qscale</samp> options, is experimental and only works with some
  2902. combinations of parameters.
  2903. </p>
  2904. <p>Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or
  2905. higher.
  2906. </p>
  2907. <p>For more information see the fdk-aac project at
  2908. <a class="url" href="http://sourceforge.net/p/opencore-amr/fdk-aac/">http://sourceforge.net/p/opencore-amr/fdk-aac/</a>.
  2909. </p>
  2910. <ul class="mini-toc">
  2911. <li><a href="#Options-12" accesskey="1">Options</a></li>
  2912. <li><a href="#Examples" accesskey="2">Examples</a></li>
  2913. </ul>
  2914. <div class="subsection-level-extent" id="Options-12">
  2915. <h4 class="subsection"><span>8.5.1 Options<a class="copiable-link" href="#Options-12"> &para;</a></span></h4>
  2916. <p>The following options are mapped on the shared FFmpeg codec options.
  2917. </p>
  2918. <dl class="table">
  2919. <dt><samp class="option">b</samp></dt>
  2920. <dd><p>Set bit rate in bits/s. If the bitrate is not explicitly specified, it
  2921. is automatically set to a suitable value depending on the selected
  2922. profile.
  2923. </p>
  2924. <p>In case VBR mode is enabled the option is ignored.
  2925. </p>
  2926. </dd>
  2927. <dt><samp class="option">ar</samp></dt>
  2928. <dd><p>Set audio sampling rate (in Hz).
  2929. </p>
  2930. </dd>
  2931. <dt><samp class="option">channels</samp></dt>
  2932. <dd><p>Set the number of audio channels.
  2933. </p>
  2934. </dd>
  2935. <dt><samp class="option">flags +qscale</samp></dt>
  2936. <dd><p>Enable fixed quality, VBR (Variable Bit Rate) mode.
  2937. Note that VBR is implicitly enabled when the <samp class="option">vbr</samp> value is
  2938. positive.
  2939. </p>
  2940. </dd>
  2941. <dt><samp class="option">cutoff</samp></dt>
  2942. <dd><p>Set cutoff frequency. If not specified (or explicitly set to 0) it
  2943. will use a value automatically computed by the library. Default value
  2944. is 0.
  2945. </p>
  2946. </dd>
  2947. <dt><samp class="option">profile</samp></dt>
  2948. <dd><p>Set audio profile.
  2949. </p>
  2950. <p>The following profiles are recognized:
  2951. </p><dl class="table">
  2952. <dt>&lsquo;<samp class="samp">aac_low</samp>&rsquo;</dt>
  2953. <dd><p>Low Complexity AAC (LC)
  2954. </p>
  2955. </dd>
  2956. <dt>&lsquo;<samp class="samp">aac_he</samp>&rsquo;</dt>
  2957. <dd><p>High Efficiency AAC (HE-AAC)
  2958. </p>
  2959. </dd>
  2960. <dt>&lsquo;<samp class="samp">aac_he_v2</samp>&rsquo;</dt>
  2961. <dd><p>High Efficiency AAC version 2 (HE-AACv2)
  2962. </p>
  2963. </dd>
  2964. <dt>&lsquo;<samp class="samp">aac_ld</samp>&rsquo;</dt>
  2965. <dd><p>Low Delay AAC (LD)
  2966. </p>
  2967. </dd>
  2968. <dt>&lsquo;<samp class="samp">aac_eld</samp>&rsquo;</dt>
  2969. <dd><p>Enhanced Low Delay AAC (ELD)
  2970. </p></dd>
  2971. </dl>
  2972. <p>If not specified it is set to &lsquo;<samp class="samp">aac_low</samp>&rsquo;.
  2973. </p></dd>
  2974. </dl>
  2975. <p>The following are private options of the libfdk_aac encoder.
  2976. </p>
  2977. <dl class="table">
  2978. <dt><samp class="option">afterburner</samp></dt>
  2979. <dd><p>Enable afterburner feature if set to 1, disabled if set to 0. This
  2980. improves the quality but also the required processing power.
  2981. </p>
  2982. <p>Default value is 1.
  2983. </p>
  2984. </dd>
  2985. <dt><samp class="option">eld_sbr</samp></dt>
  2986. <dd><p>Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled
  2987. if set to 0.
  2988. </p>
  2989. <p>Default value is 0.
  2990. </p>
  2991. </dd>
  2992. <dt><samp class="option">eld_v2</samp></dt>
  2993. <dd><p>Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1,
  2994. disabled if set to 0.
  2995. </p>
  2996. <p>Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) &gt; (4.0.0).
  2997. </p>
  2998. <p>Default value is 0.
  2999. </p>
  3000. </dd>
  3001. <dt><samp class="option">signaling</samp></dt>
  3002. <dd><p>Set SBR/PS signaling style.
  3003. </p>
  3004. <p>It can assume one of the following values:
  3005. </p><dl class="table">
  3006. <dt>&lsquo;<samp class="samp">default</samp>&rsquo;</dt>
  3007. <dd><p>choose signaling implicitly (explicit hierarchical by default,
  3008. implicit if global header is disabled)
  3009. </p>
  3010. </dd>
  3011. <dt>&lsquo;<samp class="samp">implicit</samp>&rsquo;</dt>
  3012. <dd><p>implicit backwards compatible signaling
  3013. </p>
  3014. </dd>
  3015. <dt>&lsquo;<samp class="samp">explicit_sbr</samp>&rsquo;</dt>
  3016. <dd><p>explicit SBR, implicit PS signaling
  3017. </p>
  3018. </dd>
  3019. <dt>&lsquo;<samp class="samp">explicit_hierarchical</samp>&rsquo;</dt>
  3020. <dd><p>explicit hierarchical signaling
  3021. </p></dd>
  3022. </dl>
  3023. <p>Default value is &lsquo;<samp class="samp">default</samp>&rsquo;.
  3024. </p>
  3025. </dd>
  3026. <dt><samp class="option">latm</samp></dt>
  3027. <dd><p>Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0.
  3028. </p>
  3029. <p>Default value is 0.
  3030. </p>
  3031. </dd>
  3032. <dt><samp class="option">header_period</samp></dt>
  3033. <dd><p>Set StreamMuxConfig and PCE repetition period (in frames) for sending
  3034. in-band configuration buffers within LATM/LOAS transport layer.
  3035. </p>
  3036. <p>Must be a 16-bits non-negative integer.
  3037. </p>
  3038. <p>Default value is 0.
  3039. </p>
  3040. </dd>
  3041. <dt><samp class="option">vbr</samp></dt>
  3042. <dd><p>Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty
  3043. good) and 5 is highest quality. A value of 0 will disable VBR, and CBR
  3044. (Constant Bit Rate) is enabled.
  3045. </p>
  3046. <p>Currently only the &lsquo;<samp class="samp">aac_low</samp>&rsquo; profile supports VBR encoding.
  3047. </p>
  3048. <p>VBR modes 1-5 correspond to roughly the following average bit rates:
  3049. </p>
  3050. <dl class="table">
  3051. <dt>&lsquo;<samp class="samp">1</samp>&rsquo;</dt>
  3052. <dd><p>32 kbps/channel
  3053. </p></dd>
  3054. <dt>&lsquo;<samp class="samp">2</samp>&rsquo;</dt>
  3055. <dd><p>40 kbps/channel
  3056. </p></dd>
  3057. <dt>&lsquo;<samp class="samp">3</samp>&rsquo;</dt>
  3058. <dd><p>48-56 kbps/channel
  3059. </p></dd>
  3060. <dt>&lsquo;<samp class="samp">4</samp>&rsquo;</dt>
  3061. <dd><p>64 kbps/channel
  3062. </p></dd>
  3063. <dt>&lsquo;<samp class="samp">5</samp>&rsquo;</dt>
  3064. <dd><p>about 80-96 kbps/channel
  3065. </p></dd>
  3066. </dl>
  3067. <p>Default value is 0.
  3068. </p></dd>
  3069. </dl>
  3070. </div>
  3071. <div class="subsection-level-extent" id="Examples">
  3072. <h4 class="subsection"><span>8.5.2 Examples<a class="copiable-link" href="#Examples"> &para;</a></span></h4>
  3073. <ul class="itemize mark-bullet">
  3074. <li>Use <code class="command">ffmpeg</code> to convert an audio file to VBR AAC in an M4A (MP4)
  3075. container:
  3076. <div class="example">
  3077. <pre class="example-preformatted">ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
  3078. </pre></div>
  3079. </li><li>Use <code class="command">ffmpeg</code> to convert an audio file to CBR 64k kbps AAC, using the
  3080. High-Efficiency AAC profile:
  3081. <div class="example">
  3082. <pre class="example-preformatted">ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
  3083. </pre></div>
  3084. </li></ul>
  3085. <a class="anchor" id="libmp3lame"></a></div>
  3086. </div>
  3087. <div class="section-level-extent" id="libmp3lame-1">
  3088. <h3 class="section"><span>8.6 libmp3lame<a class="copiable-link" href="#libmp3lame-1"> &para;</a></span></h3>
  3089. <p>LAME (Lame Ain&rsquo;t an MP3 Encoder) MP3 encoder wrapper.
  3090. </p>
  3091. <p>Requires the presence of the libmp3lame headers and library during
  3092. configuration. You need to explicitly configure the build with
  3093. <code class="code">--enable-libmp3lame</code>.
  3094. </p>
  3095. <p>See <a class="ref" href="#libshine">libshine</a> for a fixed-point MP3 encoder, although with a
  3096. lower quality.
  3097. </p>
  3098. <ul class="mini-toc">
  3099. <li><a href="#Options-13" accesskey="1">Options</a></li>
  3100. </ul>
  3101. <div class="subsection-level-extent" id="Options-13">
  3102. <h4 class="subsection"><span>8.6.1 Options<a class="copiable-link" href="#Options-13"> &para;</a></span></h4>
  3103. <p>The following options are supported by the libmp3lame wrapper. The
  3104. <code class="command">lame</code>-equivalent of the options are listed in parentheses.
  3105. </p>
  3106. <dl class="table">
  3107. <dt><samp class="option">b (<em class="emph">-b</em>)</samp></dt>
  3108. <dd><p>Set bitrate expressed in bits/s for CBR or ABR. LAME <code class="code">bitrate</code> is
  3109. expressed in kilobits/s.
  3110. </p>
  3111. </dd>
  3112. <dt><samp class="option">q (<em class="emph">-V</em>)</samp></dt>
  3113. <dd><p>Set constant quality setting for VBR. This option is valid only
  3114. using the <code class="command">ffmpeg</code> command-line tool. For library interface
  3115. users, use <samp class="option">global_quality</samp>.
  3116. </p>
  3117. </dd>
  3118. <dt><samp class="option">compression_level (<em class="emph">-q</em>)</samp></dt>
  3119. <dd><p>Set algorithm quality. Valid arguments are integers in the 0-9 range,
  3120. with 0 meaning highest quality but slowest, and 9 meaning fastest
  3121. while producing the worst quality.
  3122. </p>
  3123. </dd>
  3124. <dt><samp class="option">cutoff (<em class="emph">--lowpass</em>)</samp></dt>
  3125. <dd><p>Set lowpass cutoff frequency. If unspecified, the encoder dynamically
  3126. adjusts the cutoff.
  3127. </p>
  3128. </dd>
  3129. <dt><samp class="option">reservoir</samp></dt>
  3130. <dd><p>Enable use of bit reservoir when set to 1. Default value is 1. LAME
  3131. has this enabled by default, but can be overridden by use
  3132. <samp class="option">--nores</samp> option.
  3133. </p>
  3134. </dd>
  3135. <dt><samp class="option">joint_stereo (<em class="emph">-m j</em>)</samp></dt>
  3136. <dd><p>Enable the encoder to use (on a frame by frame basis) either L/R
  3137. stereo or mid/side stereo. Default value is 1.
  3138. </p>
  3139. </dd>
  3140. <dt><samp class="option">abr (<em class="emph">--abr</em>)</samp></dt>
  3141. <dd><p>Enable the encoder to use ABR when set to 1. The <code class="command">lame</code>
  3142. <samp class="option">--abr</samp> sets the target bitrate, while this options only
  3143. tells FFmpeg to use ABR still relies on <samp class="option">b</samp> to set bitrate.
  3144. </p>
  3145. </dd>
  3146. </dl>
  3147. </div>
  3148. </div>
  3149. <div class="section-level-extent" id="libopencore_002damrnb-1">
  3150. <h3 class="section"><span>8.7 libopencore-amrnb<a class="copiable-link" href="#libopencore_002damrnb-1"> &para;</a></span></h3>
  3151. <p>OpenCORE Adaptive Multi-Rate Narrowband encoder.
  3152. </p>
  3153. <p>Requires the presence of the libopencore-amrnb headers and library during
  3154. configuration. You need to explicitly configure the build with
  3155. <code class="code">--enable-libopencore-amrnb --enable-version3</code>.
  3156. </p>
  3157. <p>This is a mono-only encoder. Officially it only supports 8000Hz sample rate,
  3158. but you can override it by setting <samp class="option">strict</samp> to &lsquo;<samp class="samp">unofficial</samp>&rsquo; or
  3159. lower.
  3160. </p>
  3161. <ul class="mini-toc">
  3162. <li><a href="#Options-14" accesskey="1">Options</a></li>
  3163. </ul>
  3164. <div class="subsection-level-extent" id="Options-14">
  3165. <h4 class="subsection"><span>8.7.1 Options<a class="copiable-link" href="#Options-14"> &para;</a></span></h4>
  3166. <dl class="table">
  3167. <dt><samp class="option">b</samp></dt>
  3168. <dd><p>Set bitrate in bits per second. Only the following bitrates are supported,
  3169. otherwise libavcodec will round to the nearest valid bitrate.
  3170. </p>
  3171. <dl class="table">
  3172. <dt><samp class="option">4750</samp></dt>
  3173. <dt><samp class="option">5150</samp></dt>
  3174. <dt><samp class="option">5900</samp></dt>
  3175. <dt><samp class="option">6700</samp></dt>
  3176. <dt><samp class="option">7400</samp></dt>
  3177. <dt><samp class="option">7950</samp></dt>
  3178. <dt><samp class="option">10200</samp></dt>
  3179. <dt><samp class="option">12200</samp></dt>
  3180. </dl>
  3181. </dd>
  3182. <dt><samp class="option">dtx</samp></dt>
  3183. <dd><p>Allow discontinuous transmission (generate comfort noise) when set to 1. The
  3184. default value is 0 (disabled).
  3185. </p>
  3186. </dd>
  3187. </dl>
  3188. </div>
  3189. </div>
  3190. <div class="section-level-extent" id="libopus-1">
  3191. <h3 class="section"><span>8.8 libopus<a class="copiable-link" href="#libopus-1"> &para;</a></span></h3>
  3192. <p>libopus Opus Interactive Audio Codec encoder wrapper.
  3193. </p>
  3194. <p>Requires the presence of the libopus headers and library during
  3195. configuration. You need to explicitly configure the build with
  3196. <code class="code">--enable-libopus</code>.
  3197. </p>
  3198. <ul class="mini-toc">
  3199. <li><a href="#Option-Mapping" accesskey="1">Option Mapping</a></li>
  3200. </ul>
  3201. <div class="subsection-level-extent" id="Option-Mapping">
  3202. <h4 class="subsection"><span>8.8.1 Option Mapping<a class="copiable-link" href="#Option-Mapping"> &para;</a></span></h4>
  3203. <p>Most libopus options are modelled after the <code class="command">opusenc</code> utility from
  3204. opus-tools. The following is an option mapping chart describing options
  3205. supported by the libopus wrapper, and their <code class="command">opusenc</code>-equivalent
  3206. in parentheses.
  3207. </p>
  3208. <dl class="table">
  3209. <dt><samp class="option">b (<em class="emph">bitrate</em>)</samp></dt>
  3210. <dd><p>Set the bit rate in bits/s. FFmpeg&rsquo;s <samp class="option">b</samp> option is
  3211. expressed in bits/s, while <code class="command">opusenc</code>&rsquo;s <samp class="option">bitrate</samp> in
  3212. kilobits/s.
  3213. </p>
  3214. </dd>
  3215. <dt><samp class="option">vbr (<em class="emph">vbr</em>, <em class="emph">hard-cbr</em>, and <em class="emph">cvbr</em>)</samp></dt>
  3216. <dd><p>Set VBR mode. The FFmpeg <samp class="option">vbr</samp> option has the following
  3217. valid arguments, with the <code class="command">opusenc</code> equivalent options
  3218. in parentheses:
  3219. </p>
  3220. <dl class="table">
  3221. <dt>&lsquo;<samp class="samp">off (<em class="emph">hard-cbr</em>)</samp>&rsquo;</dt>
  3222. <dd><p>Use constant bit rate encoding.
  3223. </p>
  3224. </dd>
  3225. <dt>&lsquo;<samp class="samp">on (<em class="emph">vbr</em>)</samp>&rsquo;</dt>
  3226. <dd><p>Use variable bit rate encoding (the default).
  3227. </p>
  3228. </dd>
  3229. <dt>&lsquo;<samp class="samp">constrained (<em class="emph">cvbr</em>)</samp>&rsquo;</dt>
  3230. <dd><p>Use constrained variable bit rate encoding.
  3231. </p></dd>
  3232. </dl>
  3233. </dd>
  3234. <dt><samp class="option">compression_level (<em class="emph">comp</em>)</samp></dt>
  3235. <dd><p>Set encoding algorithm complexity. Valid options are integers in
  3236. the 0-10 range. 0 gives the fastest encodes but lower quality, while 10
  3237. gives the highest quality but slowest encoding. The default is 10.
  3238. </p>
  3239. </dd>
  3240. <dt><samp class="option">frame_duration (<em class="emph">framesize</em>)</samp></dt>
  3241. <dd><p>Set maximum frame size, or duration of a frame in milliseconds. The
  3242. argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller
  3243. frame sizes achieve lower latency but less quality at a given bitrate.
  3244. Sizes greater than 20ms are only interesting at fairly low bitrates.
  3245. The default is 20ms.
  3246. </p>
  3247. </dd>
  3248. <dt><samp class="option">packet_loss (<em class="emph">expect-loss</em>)</samp></dt>
  3249. <dd><p>Set expected packet loss percentage. The default is 0.
  3250. </p>
  3251. </dd>
  3252. <dt><samp class="option">fec (<em class="emph">n/a</em>)</samp></dt>
  3253. <dd><p>Enable inband forward error correction. <samp class="option">packet_loss</samp> must be non-zero
  3254. to take advantage - frequency of FEC &rsquo;side-data&rsquo; is proportional to expected packet loss.
  3255. Default is disabled.
  3256. </p>
  3257. </dd>
  3258. <dt><samp class="option">application (N.A.)</samp></dt>
  3259. <dd><p>Set intended application type. Valid options are listed below:
  3260. </p>
  3261. <dl class="table">
  3262. <dt>&lsquo;<samp class="samp">voip</samp>&rsquo;</dt>
  3263. <dd><p>Favor improved speech intelligibility.
  3264. </p></dd>
  3265. <dt>&lsquo;<samp class="samp">audio</samp>&rsquo;</dt>
  3266. <dd><p>Favor faithfulness to the input (the default).
  3267. </p></dd>
  3268. <dt>&lsquo;<samp class="samp">lowdelay</samp>&rsquo;</dt>
  3269. <dd><p>Restrict to only the lowest delay modes.
  3270. </p></dd>
  3271. </dl>
  3272. </dd>
  3273. <dt><samp class="option">cutoff (N.A.)</samp></dt>
  3274. <dd><p>Set cutoff bandwidth in Hz. The argument must be exactly one of the
  3275. following: 4000, 6000, 8000, 12000, or 20000, corresponding to
  3276. narrowband, mediumband, wideband, super wideband, and fullband
  3277. respectively. The default is 0 (cutoff disabled).
  3278. </p>
  3279. </dd>
  3280. <dt><samp class="option">mapping_family (<em class="emph">mapping_family</em>)</samp></dt>
  3281. <dd><p>Set channel mapping family to be used by the encoder. The default value of -1
  3282. uses mapping family 0 for mono and stereo inputs, and mapping family 1
  3283. otherwise. The default also disables the surround masking and LFE bandwidth
  3284. optimzations in libopus, and requires that the input contains 8 channels or
  3285. fewer.
  3286. </p>
  3287. <p>Other values include 0 for mono and stereo, 1 for surround sound with masking
  3288. and LFE bandwidth optimizations, and 255 for independent streams with an
  3289. unspecified channel layout.
  3290. </p>
  3291. </dd>
  3292. <dt><samp class="option">apply_phase_inv (N.A.) (requires libopus &gt;= 1.2)</samp></dt>
  3293. <dd><p>If set to 0, disables the use of phase inversion for intensity stereo,
  3294. improving the quality of mono downmixes, but slightly reducing normal stereo
  3295. quality. The default is 1 (phase inversion enabled).
  3296. </p>
  3297. </dd>
  3298. </dl>
  3299. <a class="anchor" id="libshine"></a></div>
  3300. </div>
  3301. <div class="section-level-extent" id="libshine-1">
  3302. <h3 class="section"><span>8.9 libshine<a class="copiable-link" href="#libshine-1"> &para;</a></span></h3>
  3303. <p>Shine Fixed-Point MP3 encoder wrapper.
  3304. </p>
  3305. <p>Shine is a fixed-point MP3 encoder. It has a far better performance on
  3306. platforms without an FPU, e.g. armel CPUs, and some phones and tablets.
  3307. However, as it is more targeted on performance than quality, it is not on par
  3308. with LAME and other production-grade encoders quality-wise. Also, according to
  3309. the project&rsquo;s homepage, this encoder may not be free of bugs as the code was
  3310. written a long time ago and the project was dead for at least 5 years.
  3311. </p>
  3312. <p>This encoder only supports stereo and mono input. This is also CBR-only.
  3313. </p>
  3314. <p>The original project (last updated in early 2007) is at
  3315. <a class="url" href="http://sourceforge.net/projects/libshine-fxp/">http://sourceforge.net/projects/libshine-fxp/</a>. We only support the
  3316. updated fork by the Savonet/Liquidsoap project at <a class="url" href="https://github.com/savonet/shine">https://github.com/savonet/shine</a>.
  3317. </p>
  3318. <p>Requires the presence of the libshine headers and library during
  3319. configuration. You need to explicitly configure the build with
  3320. <code class="code">--enable-libshine</code>.
  3321. </p>
  3322. <p>See also <a class="ref" href="#libmp3lame">libmp3lame</a>.
  3323. </p>
  3324. <ul class="mini-toc">
  3325. <li><a href="#Options-15" accesskey="1">Options</a></li>
  3326. </ul>
  3327. <div class="subsection-level-extent" id="Options-15">
  3328. <h4 class="subsection"><span>8.9.1 Options<a class="copiable-link" href="#Options-15"> &para;</a></span></h4>
  3329. <p>The following options are supported by the libshine wrapper. The
  3330. <code class="command">shineenc</code>-equivalent of the options are listed in parentheses.
  3331. </p>
  3332. <dl class="table">
  3333. <dt><samp class="option">b (<em class="emph">-b</em>)</samp></dt>
  3334. <dd><p>Set bitrate expressed in bits/s for CBR. <code class="command">shineenc</code> <samp class="option">-b</samp> option
  3335. is expressed in kilobits/s.
  3336. </p>
  3337. </dd>
  3338. </dl>
  3339. </div>
  3340. </div>
  3341. <div class="section-level-extent" id="libtwolame">
  3342. <h3 class="section"><span>8.10 libtwolame<a class="copiable-link" href="#libtwolame"> &para;</a></span></h3>
  3343. <p>TwoLAME MP2 encoder wrapper.
  3344. </p>
  3345. <p>Requires the presence of the libtwolame headers and library during
  3346. configuration. You need to explicitly configure the build with
  3347. <code class="code">--enable-libtwolame</code>.
  3348. </p>
  3349. <ul class="mini-toc">
  3350. <li><a href="#Options-16" accesskey="1">Options</a></li>
  3351. </ul>
  3352. <div class="subsection-level-extent" id="Options-16">
  3353. <h4 class="subsection"><span>8.10.1 Options<a class="copiable-link" href="#Options-16"> &para;</a></span></h4>
  3354. <p>The following options are supported by the libtwolame wrapper. The
  3355. <code class="command">twolame</code>-equivalent options follow the FFmpeg ones and are in
  3356. parentheses.
  3357. </p>
  3358. <dl class="table">
  3359. <dt><samp class="option">b (<em class="emph">-b</em>)</samp></dt>
  3360. <dd><p>Set bitrate expressed in bits/s for CBR. <code class="command">twolame</code> <samp class="option">b</samp>
  3361. option is expressed in kilobits/s. Default value is 128k.
  3362. </p>
  3363. </dd>
  3364. <dt><samp class="option">q (<em class="emph">-V</em>)</samp></dt>
  3365. <dd><p>Set quality for experimental VBR support. Maximum value range is
  3366. from -50 to 50, useful range is from -10 to 10. The higher the
  3367. value, the better the quality. This option is valid only using the
  3368. <code class="command">ffmpeg</code> command-line tool. For library interface users,
  3369. use <samp class="option">global_quality</samp>.
  3370. </p>
  3371. </dd>
  3372. <dt><samp class="option">mode (<em class="emph">--mode</em>)</samp></dt>
  3373. <dd><p>Set the mode of the resulting audio. Possible values:
  3374. </p>
  3375. <dl class="table">
  3376. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  3377. <dd><p>Choose mode automatically based on the input. This is the default.
  3378. </p></dd>
  3379. <dt>&lsquo;<samp class="samp">stereo</samp>&rsquo;</dt>
  3380. <dd><p>Stereo
  3381. </p></dd>
  3382. <dt>&lsquo;<samp class="samp">joint_stereo</samp>&rsquo;</dt>
  3383. <dd><p>Joint stereo
  3384. </p></dd>
  3385. <dt>&lsquo;<samp class="samp">dual_channel</samp>&rsquo;</dt>
  3386. <dd><p>Dual channel
  3387. </p></dd>
  3388. <dt>&lsquo;<samp class="samp">mono</samp>&rsquo;</dt>
  3389. <dd><p>Mono
  3390. </p></dd>
  3391. </dl>
  3392. </dd>
  3393. <dt><samp class="option">psymodel (<em class="emph">--psyc-mode</em>)</samp></dt>
  3394. <dd><p>Set psychoacoustic model to use in encoding. The argument must be
  3395. an integer between -1 and 4, inclusive. The higher the value, the
  3396. better the quality. The default value is 3.
  3397. </p>
  3398. </dd>
  3399. <dt><samp class="option">energy_levels (<em class="emph">--energy</em>)</samp></dt>
  3400. <dd><p>Enable energy levels extensions when set to 1. The default value is
  3401. 0 (disabled).
  3402. </p>
  3403. </dd>
  3404. <dt><samp class="option">error_protection (<em class="emph">--protect</em>)</samp></dt>
  3405. <dd><p>Enable CRC error protection when set to 1. The default value is 0
  3406. (disabled).
  3407. </p>
  3408. </dd>
  3409. <dt><samp class="option">copyright (<em class="emph">--copyright</em>)</samp></dt>
  3410. <dd><p>Set MPEG audio copyright flag when set to 1. The default value is 0
  3411. (disabled).
  3412. </p>
  3413. </dd>
  3414. <dt><samp class="option">original (<em class="emph">--original</em>)</samp></dt>
  3415. <dd><p>Set MPEG audio original flag when set to 1. The default value is 0
  3416. (disabled).
  3417. </p>
  3418. </dd>
  3419. </dl>
  3420. </div>
  3421. </div>
  3422. <div class="section-level-extent" id="libvo_002damrwbenc">
  3423. <h3 class="section"><span>8.11 libvo-amrwbenc<a class="copiable-link" href="#libvo_002damrwbenc"> &para;</a></span></h3>
  3424. <p>VisualOn Adaptive Multi-Rate Wideband encoder.
  3425. </p>
  3426. <p>Requires the presence of the libvo-amrwbenc headers and library during
  3427. configuration. You need to explicitly configure the build with
  3428. <code class="code">--enable-libvo-amrwbenc --enable-version3</code>.
  3429. </p>
  3430. <p>This is a mono-only encoder. Officially it only supports 16000Hz sample
  3431. rate, but you can override it by setting <samp class="option">strict</samp> to
  3432. &lsquo;<samp class="samp">unofficial</samp>&rsquo; or lower.
  3433. </p>
  3434. <ul class="mini-toc">
  3435. <li><a href="#Options-17" accesskey="1">Options</a></li>
  3436. </ul>
  3437. <div class="subsection-level-extent" id="Options-17">
  3438. <h4 class="subsection"><span>8.11.1 Options<a class="copiable-link" href="#Options-17"> &para;</a></span></h4>
  3439. <dl class="table">
  3440. <dt><samp class="option">b</samp></dt>
  3441. <dd><p>Set bitrate in bits/s. Only the following bitrates are supported, otherwise
  3442. libavcodec will round to the nearest valid bitrate.
  3443. </p>
  3444. <dl class="table">
  3445. <dt>&lsquo;<samp class="samp">6600</samp>&rsquo;</dt>
  3446. <dt>&lsquo;<samp class="samp">8850</samp>&rsquo;</dt>
  3447. <dt>&lsquo;<samp class="samp">12650</samp>&rsquo;</dt>
  3448. <dt>&lsquo;<samp class="samp">14250</samp>&rsquo;</dt>
  3449. <dt>&lsquo;<samp class="samp">15850</samp>&rsquo;</dt>
  3450. <dt>&lsquo;<samp class="samp">18250</samp>&rsquo;</dt>
  3451. <dt>&lsquo;<samp class="samp">19850</samp>&rsquo;</dt>
  3452. <dt>&lsquo;<samp class="samp">23050</samp>&rsquo;</dt>
  3453. <dt>&lsquo;<samp class="samp">23850</samp>&rsquo;</dt>
  3454. </dl>
  3455. </dd>
  3456. <dt><samp class="option">dtx</samp></dt>
  3457. <dd><p>Allow discontinuous transmission (generate comfort noise) when set to 1. The
  3458. default value is 0 (disabled).
  3459. </p>
  3460. </dd>
  3461. </dl>
  3462. </div>
  3463. </div>
  3464. <div class="section-level-extent" id="libvorbis">
  3465. <h3 class="section"><span>8.12 libvorbis<a class="copiable-link" href="#libvorbis"> &para;</a></span></h3>
  3466. <p>libvorbis encoder wrapper.
  3467. </p>
  3468. <p>Requires the presence of the libvorbisenc headers and library during
  3469. configuration. You need to explicitly configure the build with
  3470. <code class="code">--enable-libvorbis</code>.
  3471. </p>
  3472. <ul class="mini-toc">
  3473. <li><a href="#Options-18" accesskey="1">Options</a></li>
  3474. </ul>
  3475. <div class="subsection-level-extent" id="Options-18">
  3476. <h4 class="subsection"><span>8.12.1 Options<a class="copiable-link" href="#Options-18"> &para;</a></span></h4>
  3477. <p>The following options are supported by the libvorbis wrapper. The
  3478. <code class="command">oggenc</code>-equivalent of the options are listed in parentheses.
  3479. </p>
  3480. <p>To get a more accurate and extensive documentation of the libvorbis
  3481. options, consult the libvorbisenc&rsquo;s and <code class="command">oggenc</code>&rsquo;s documentations.
  3482. See <a class="url" href="http://xiph.org/vorbis/">http://xiph.org/vorbis/</a>,
  3483. <a class="url" href="http://wiki.xiph.org/Vorbis-tools">http://wiki.xiph.org/Vorbis-tools</a>, and oggenc(1).
  3484. </p>
  3485. <dl class="table">
  3486. <dt><samp class="option">b (<em class="emph">-b</em>)</samp></dt>
  3487. <dd><p>Set bitrate expressed in bits/s for ABR. <code class="command">oggenc</code> <samp class="option">-b</samp> is
  3488. expressed in kilobits/s.
  3489. </p>
  3490. </dd>
  3491. <dt><samp class="option">q (<em class="emph">-q</em>)</samp></dt>
  3492. <dd><p>Set constant quality setting for VBR. The value should be a float
  3493. number in the range of -1.0 to 10.0. The higher the value, the better
  3494. the quality. The default value is &lsquo;<samp class="samp">3.0</samp>&rsquo;.
  3495. </p>
  3496. <p>This option is valid only using the <code class="command">ffmpeg</code> command-line tool.
  3497. For library interface users, use <samp class="option">global_quality</samp>.
  3498. </p>
  3499. </dd>
  3500. <dt><samp class="option">cutoff (<em class="emph">--advanced-encode-option lowpass_frequency=N</em>)</samp></dt>
  3501. <dd><p>Set cutoff bandwidth in Hz, a value of 0 disables cutoff. <code class="command">oggenc</code>&rsquo;s
  3502. related option is expressed in kHz. The default value is &lsquo;<samp class="samp">0</samp>&rsquo; (cutoff
  3503. disabled).
  3504. </p>
  3505. </dd>
  3506. <dt><samp class="option">minrate (<em class="emph">-m</em>)</samp></dt>
  3507. <dd><p>Set minimum bitrate expressed in bits/s. <code class="command">oggenc</code> <samp class="option">-m</samp> is
  3508. expressed in kilobits/s.
  3509. </p>
  3510. </dd>
  3511. <dt><samp class="option">maxrate (<em class="emph">-M</em>)</samp></dt>
  3512. <dd><p>Set maximum bitrate expressed in bits/s. <code class="command">oggenc</code> <samp class="option">-M</samp> is
  3513. expressed in kilobits/s. This only has effect on ABR mode.
  3514. </p>
  3515. </dd>
  3516. <dt><samp class="option">iblock (<em class="emph">--advanced-encode-option impulse_noisetune=N</em>)</samp></dt>
  3517. <dd><p>Set noise floor bias for impulse blocks. The value is a float number from
  3518. -15.0 to 0.0. A negative bias instructs the encoder to pay special attention
  3519. to the crispness of transients in the encoded audio. The tradeoff for better
  3520. transient response is a higher bitrate.
  3521. </p>
  3522. </dd>
  3523. </dl>
  3524. <a class="anchor" id="mjpegenc"></a></div>
  3525. </div>
  3526. <div class="section-level-extent" id="mjpeg">
  3527. <h3 class="section"><span>8.13 mjpeg<a class="copiable-link" href="#mjpeg"> &para;</a></span></h3>
  3528. <p>Motion JPEG encoder.
  3529. </p>
  3530. <ul class="mini-toc">
  3531. <li><a href="#Options-19" accesskey="1">Options</a></li>
  3532. </ul>
  3533. <div class="subsection-level-extent" id="Options-19">
  3534. <h4 class="subsection"><span>8.13.1 Options<a class="copiable-link" href="#Options-19"> &para;</a></span></h4>
  3535. <dl class="table">
  3536. <dt><samp class="option">huffman</samp></dt>
  3537. <dd><p>Set the huffman encoding strategy. Possible values:
  3538. </p>
  3539. <dl class="table">
  3540. <dt>&lsquo;<samp class="samp">default</samp>&rsquo;</dt>
  3541. <dd><p>Use the default huffman tables. This is the default strategy.
  3542. </p>
  3543. </dd>
  3544. <dt>&lsquo;<samp class="samp">optimal</samp>&rsquo;</dt>
  3545. <dd><p>Compute and use optimal huffman tables.
  3546. </p>
  3547. </dd>
  3548. </dl>
  3549. </dd>
  3550. </dl>
  3551. <a class="anchor" id="wavpackenc"></a></div>
  3552. </div>
  3553. <div class="section-level-extent" id="wavpack">
  3554. <h3 class="section"><span>8.14 wavpack<a class="copiable-link" href="#wavpack"> &para;</a></span></h3>
  3555. <p>WavPack lossless audio encoder.
  3556. </p>
  3557. <ul class="mini-toc">
  3558. <li><a href="#Options-20" accesskey="1">Options</a></li>
  3559. </ul>
  3560. <div class="subsection-level-extent" id="Options-20">
  3561. <h4 class="subsection"><span>8.14.1 Options<a class="copiable-link" href="#Options-20"> &para;</a></span></h4>
  3562. <p>The equivalent options for <code class="command">wavpack</code> command line utility are listed in
  3563. parentheses.
  3564. </p>
  3565. <ul class="mini-toc">
  3566. <li><a href="#Shared-options" accesskey="1">Shared options</a></li>
  3567. <li><a href="#Private-options" accesskey="2">Private options</a></li>
  3568. </ul>
  3569. <div class="subsubsection-level-extent" id="Shared-options">
  3570. <h4 class="subsubsection"><span>8.14.1.1 Shared options<a class="copiable-link" href="#Shared-options"> &para;</a></span></h4>
  3571. <p>The following shared options are effective for this encoder. Only special notes
  3572. about this particular encoder will be documented here. For the general meaning
  3573. of the options, see <a class="ref" href="#codec_002doptions">the Codec Options chapter</a>.
  3574. </p>
  3575. <dl class="table">
  3576. <dt><samp class="option">frame_size (<em class="emph">--blocksize</em>)</samp></dt>
  3577. <dd><p>For this encoder, the range for this option is between 128 and 131072. Default
  3578. is automatically decided based on sample rate and number of channel.
  3579. </p>
  3580. <p>For the complete formula of calculating default, see
  3581. <samp class="file">libavcodec/wavpackenc.c</samp>.
  3582. </p>
  3583. </dd>
  3584. <dt><samp class="option">compression_level (<em class="emph">-f</em>, <em class="emph">-h</em>, <em class="emph">-hh</em>, and <em class="emph">-x</em>)</samp></dt>
  3585. </dl>
  3586. </div>
  3587. <div class="subsubsection-level-extent" id="Private-options">
  3588. <h4 class="subsubsection"><span>8.14.1.2 Private options<a class="copiable-link" href="#Private-options"> &para;</a></span></h4>
  3589. <dl class="table">
  3590. <dt><samp class="option">joint_stereo (<em class="emph">-j</em>)</samp></dt>
  3591. <dd><p>Set whether to enable joint stereo. Valid values are:
  3592. </p>
  3593. <dl class="table">
  3594. <dt>&lsquo;<samp class="samp">on (<em class="emph">1</em>)</samp>&rsquo;</dt>
  3595. <dd><p>Force mid/side audio encoding.
  3596. </p></dd>
  3597. <dt>&lsquo;<samp class="samp">off (<em class="emph">0</em>)</samp>&rsquo;</dt>
  3598. <dd><p>Force left/right audio encoding.
  3599. </p></dd>
  3600. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  3601. <dd><p>Let the encoder decide automatically.
  3602. </p></dd>
  3603. </dl>
  3604. </dd>
  3605. <dt><samp class="option">optimize_mono</samp></dt>
  3606. <dd><p>Set whether to enable optimization for mono. This option is only effective for
  3607. non-mono streams. Available values:
  3608. </p>
  3609. <dl class="table">
  3610. <dt>&lsquo;<samp class="samp">on</samp>&rsquo;</dt>
  3611. <dd><p>enabled
  3612. </p></dd>
  3613. <dt>&lsquo;<samp class="samp">off</samp>&rsquo;</dt>
  3614. <dd><p>disabled
  3615. </p></dd>
  3616. </dl>
  3617. </dd>
  3618. </dl>
  3619. </div>
  3620. </div>
  3621. </div>
  3622. </div>
  3623. <div class="chapter-level-extent" id="Video-Encoders">
  3624. <h2 class="chapter"><span>9 Video Encoders<a class="copiable-link" href="#Video-Encoders"> &para;</a></span></h2>
  3625. <p>A description of some of the currently available video encoders
  3626. follows.
  3627. </p>
  3628. <ul class="mini-toc">
  3629. <li><a href="#a64_005fmulti_002c-a64_005fmulti5" accesskey="1">a64_multi, a64_multi5</a></li>
  3630. <li><a href="#Cinepak" accesskey="2">Cinepak</a></li>
  3631. <li><a href="#GIF" accesskey="3">GIF</a></li>
  3632. <li><a href="#Hap" accesskey="4">Hap</a></li>
  3633. <li><a href="#jpeg2000" accesskey="5">jpeg2000</a></li>
  3634. <li><a href="#librav1e" accesskey="6">librav1e</a></li>
  3635. <li><a href="#libaom_002dav1" accesskey="7">libaom-av1</a></li>
  3636. <li><a href="#libsvtav1" accesskey="8">libsvtav1</a></li>
  3637. <li><a href="#libjxl" accesskey="9">libjxl</a></li>
  3638. <li><a href="#libkvazaar">libkvazaar</a></li>
  3639. <li><a href="#libopenh264">libopenh264</a></li>
  3640. <li><a href="#libtheora">libtheora</a></li>
  3641. <li><a href="#libvpx">libvpx</a></li>
  3642. <li><a href="#libwebp">libwebp</a></li>
  3643. <li><a href="#libx264_002c-libx264rgb">libx264, libx264rgb</a></li>
  3644. <li><a href="#libx265">libx265</a></li>
  3645. <li><a href="#libxavs2">libxavs2</a></li>
  3646. <li><a href="#libxvid">libxvid</a></li>
  3647. <li><a href="#MediaFoundation">MediaFoundation</a></li>
  3648. <li><a href="#mpeg2">mpeg2</a></li>
  3649. <li><a href="#png">png</a></li>
  3650. <li><a href="#ProRes">ProRes</a></li>
  3651. <li><a href="#QSV-Encoders">QSV Encoders</a></li>
  3652. <li><a href="#snow">snow</a></li>
  3653. <li><a href="#VAAPI-encoders">VAAPI encoders</a></li>
  3654. <li><a href="#vbn">vbn</a></li>
  3655. <li><a href="#vc2">vc2</a></li>
  3656. </ul>
  3657. <div class="section-level-extent" id="a64_005fmulti_002c-a64_005fmulti5">
  3658. <h3 class="section"><span>9.1 a64_multi, a64_multi5<a class="copiable-link" href="#a64_005fmulti_002c-a64_005fmulti5"> &para;</a></span></h3>
  3659. <p>A64 / Commodore 64 multicolor charset encoder. <code class="code">a64_multi5</code> is extended with 5th color (colram).
  3660. </p>
  3661. </div>
  3662. <div class="section-level-extent" id="Cinepak">
  3663. <h3 class="section"><span>9.2 Cinepak<a class="copiable-link" href="#Cinepak"> &para;</a></span></h3>
  3664. <p>Cinepak aka CVID encoder.
  3665. Compatible with Windows 3.1 and vintage MacOS.
  3666. </p>
  3667. <ul class="mini-toc">
  3668. <li><a href="#Options-21" accesskey="1">Options</a></li>
  3669. </ul>
  3670. <div class="subsection-level-extent" id="Options-21">
  3671. <h4 class="subsection"><span>9.2.1 Options<a class="copiable-link" href="#Options-21"> &para;</a></span></h4>
  3672. <dl class="table">
  3673. <dt><samp class="option">g <var class="var">integer</var></samp></dt>
  3674. <dd><p>Keyframe interval.
  3675. A keyframe is inserted at least every <code class="code">-g</code> frames, sometimes sooner.
  3676. </p>
  3677. </dd>
  3678. <dt><samp class="option">q:v <var class="var">integer</var></samp></dt>
  3679. <dd><p>Quality factor. Lower is better. Higher gives lower bitrate.
  3680. The following table lists bitrates when encoding akiyo_cif.y4m for various values of <code class="code">-q:v</code> with <code class="code">-g 100</code>:
  3681. </p>
  3682. <dl class="table">
  3683. <dt><samp class="option"><code class="code">-q:v 1</code> 1918 kb/s</samp></dt>
  3684. <dt><samp class="option"><code class="code">-q:v 2</code> 1735 kb/s</samp></dt>
  3685. <dt><samp class="option"><code class="code">-q:v 4</code> 1500 kb/s</samp></dt>
  3686. <dt><samp class="option"><code class="code">-q:v 10</code> 1041 kb/s</samp></dt>
  3687. <dt><samp class="option"><code class="code">-q:v 20</code> 826 kb/s</samp></dt>
  3688. <dt><samp class="option"><code class="code">-q:v 40</code> 553 kb/s</samp></dt>
  3689. <dt><samp class="option"><code class="code">-q:v 100</code> 394 kb/s</samp></dt>
  3690. <dt><samp class="option"><code class="code">-q:v 200</code> 312 kb/s</samp></dt>
  3691. <dt><samp class="option"><code class="code">-q:v 400</code> 266 kb/s</samp></dt>
  3692. <dt><samp class="option"><code class="code">-q:v 1000</code> 237 kb/s</samp></dt>
  3693. </dl>
  3694. </dd>
  3695. <dt><samp class="option">max_extra_cb_iterations <var class="var">integer</var></samp></dt>
  3696. <dd><p>Max extra codebook recalculation passes, more is better and slower.
  3697. </p>
  3698. </dd>
  3699. <dt><samp class="option">skip_empty_cb <var class="var">boolean</var></samp></dt>
  3700. <dd><p>Avoid wasting bytes, ignore vintage MacOS decoder.
  3701. </p>
  3702. </dd>
  3703. <dt><samp class="option">max_strips <var class="var">integer</var></samp></dt>
  3704. <dt><samp class="option">min_strips <var class="var">integer</var></samp></dt>
  3705. <dd><p>The minimum and maximum number of strips to use.
  3706. Wider range sometimes improves quality.
  3707. More strips is generally better quality but costs more bits.
  3708. Fewer strips tend to yield more keyframes.
  3709. Vintage compatible is 1..3.
  3710. </p>
  3711. </dd>
  3712. <dt><samp class="option">strip_number_adaptivity <var class="var">integer</var></samp></dt>
  3713. <dd><p>How much number of strips is allowed to change between frames.
  3714. Higher is better but slower.
  3715. </p>
  3716. </dd>
  3717. </dl>
  3718. </div>
  3719. </div>
  3720. <div class="section-level-extent" id="GIF">
  3721. <h3 class="section"><span>9.3 GIF<a class="copiable-link" href="#GIF"> &para;</a></span></h3>
  3722. <p>GIF image/animation encoder.
  3723. </p>
  3724. <ul class="mini-toc">
  3725. <li><a href="#Options-22" accesskey="1">Options</a></li>
  3726. </ul>
  3727. <div class="subsection-level-extent" id="Options-22">
  3728. <h4 class="subsection"><span>9.3.1 Options<a class="copiable-link" href="#Options-22"> &para;</a></span></h4>
  3729. <dl class="table">
  3730. <dt><samp class="option">gifflags <var class="var">integer</var></samp></dt>
  3731. <dd><p>Sets the flags used for GIF encoding.
  3732. </p>
  3733. <dl class="table">
  3734. <dt><samp class="option">offsetting</samp></dt>
  3735. <dd><p>Enables picture offsetting.
  3736. </p>
  3737. <p>Default is enabled.
  3738. </p>
  3739. </dd>
  3740. <dt><samp class="option">transdiff</samp></dt>
  3741. <dd><p>Enables transparency detection between frames.
  3742. </p>
  3743. <p>Default is enabled.
  3744. </p>
  3745. </dd>
  3746. </dl>
  3747. </dd>
  3748. <dt><samp class="option">gifimage <var class="var">integer</var></samp></dt>
  3749. <dd><p>Enables encoding one full GIF image per frame, rather than an animated GIF.
  3750. </p>
  3751. <p>Default value is <samp class="option">0</samp>.
  3752. </p>
  3753. </dd>
  3754. <dt><samp class="option">global_palette <var class="var">integer</var></samp></dt>
  3755. <dd><p>Writes a palette to the global GIF header where feasible.
  3756. </p>
  3757. <p>If disabled, every frame will always have a palette written, even if there
  3758. is a global palette supplied.
  3759. </p>
  3760. <p>Default value is <samp class="option">1</samp>.
  3761. </p>
  3762. </dd>
  3763. </dl>
  3764. </div>
  3765. </div>
  3766. <div class="section-level-extent" id="Hap">
  3767. <h3 class="section"><span>9.4 Hap<a class="copiable-link" href="#Hap"> &para;</a></span></h3>
  3768. <p>Vidvox Hap video encoder.
  3769. </p>
  3770. <ul class="mini-toc">
  3771. <li><a href="#Options-23" accesskey="1">Options</a></li>
  3772. </ul>
  3773. <div class="subsection-level-extent" id="Options-23">
  3774. <h4 class="subsection"><span>9.4.1 Options<a class="copiable-link" href="#Options-23"> &para;</a></span></h4>
  3775. <dl class="table">
  3776. <dt><samp class="option">format <var class="var">integer</var></samp></dt>
  3777. <dd><p>Specifies the Hap format to encode.
  3778. </p>
  3779. <dl class="table">
  3780. <dt><samp class="option">hap</samp></dt>
  3781. <dt><samp class="option">hap_alpha</samp></dt>
  3782. <dt><samp class="option">hap_q</samp></dt>
  3783. </dl>
  3784. <p>Default value is <samp class="option">hap</samp>.
  3785. </p>
  3786. </dd>
  3787. <dt><samp class="option">chunks <var class="var">integer</var></samp></dt>
  3788. <dd><p>Specifies the number of chunks to split frames into, between 1 and 64. This
  3789. permits multithreaded decoding of large frames, potentially at the cost of
  3790. data-rate. The encoder may modify this value to divide frames evenly.
  3791. </p>
  3792. <p>Default value is <var class="var">1</var>.
  3793. </p>
  3794. </dd>
  3795. <dt><samp class="option">compressor <var class="var">integer</var></samp></dt>
  3796. <dd><p>Specifies the second-stage compressor to use. If set to <samp class="option">none</samp>,
  3797. <samp class="option">chunks</samp> will be limited to 1, as chunked uncompressed frames offer no
  3798. benefit.
  3799. </p>
  3800. <dl class="table">
  3801. <dt><samp class="option">none</samp></dt>
  3802. <dt><samp class="option">snappy</samp></dt>
  3803. </dl>
  3804. <p>Default value is <samp class="option">snappy</samp>.
  3805. </p>
  3806. </dd>
  3807. </dl>
  3808. </div>
  3809. </div>
  3810. <div class="section-level-extent" id="jpeg2000">
  3811. <h3 class="section"><span>9.5 jpeg2000<a class="copiable-link" href="#jpeg2000"> &para;</a></span></h3>
  3812. <p>The native jpeg 2000 encoder is lossy by default, the <code class="code">-q:v</code>
  3813. option can be used to set the encoding quality. Lossless encoding
  3814. can be selected with <code class="code">-pred 1</code>.
  3815. </p>
  3816. <ul class="mini-toc">
  3817. <li><a href="#Options-24" accesskey="1">Options</a></li>
  3818. </ul>
  3819. <div class="subsection-level-extent" id="Options-24">
  3820. <h4 class="subsection"><span>9.5.1 Options<a class="copiable-link" href="#Options-24"> &para;</a></span></h4>
  3821. <dl class="table">
  3822. <dt><samp class="option">format <var class="var">integer</var></samp></dt>
  3823. <dd><p>Can be set to either <code class="code">j2k</code> or <code class="code">jp2</code> (the default) that
  3824. makes it possible to store non-rgb pix_fmts.
  3825. </p>
  3826. </dd>
  3827. <dt><samp class="option">tile_width <var class="var">integer</var></samp></dt>
  3828. <dd><p>Sets tile width. Range is 1 to 1073741824. Default is 256.
  3829. </p>
  3830. </dd>
  3831. <dt><samp class="option">tile_height <var class="var">integer</var></samp></dt>
  3832. <dd><p>Sets tile height. Range is 1 to 1073741824. Default is 256.
  3833. </p>
  3834. </dd>
  3835. <dt><samp class="option">pred <var class="var">integer</var></samp></dt>
  3836. <dd><p>Allows setting the discrete wavelet transform (DWT) type
  3837. </p><dl class="table">
  3838. <dt><samp class="option">dwt97int (Lossy)</samp></dt>
  3839. <dt><samp class="option">dwt53 (Lossless)</samp></dt>
  3840. </dl>
  3841. <p>Default is <code class="code">dwt97int</code>
  3842. </p>
  3843. </dd>
  3844. <dt><samp class="option">sop <var class="var">boolean</var></samp></dt>
  3845. <dd><p>Enable this to add SOP marker at the start of each packet. Disabled by default.
  3846. </p>
  3847. </dd>
  3848. <dt><samp class="option">eph <var class="var">boolean</var></samp></dt>
  3849. <dd><p>Enable this to add EPH marker at the end of each packet header. Disabled by default.
  3850. </p>
  3851. </dd>
  3852. <dt><samp class="option">prog <var class="var">integer</var></samp></dt>
  3853. <dd><p>Sets the progression order to be used by the encoder.
  3854. Possible values are:
  3855. </p><dl class="table">
  3856. <dt><samp class="option">lrcp</samp></dt>
  3857. <dt><samp class="option">rlcp</samp></dt>
  3858. <dt><samp class="option">rpcl</samp></dt>
  3859. <dt><samp class="option">pcrl</samp></dt>
  3860. <dt><samp class="option">cprl</samp></dt>
  3861. </dl>
  3862. <p>Set to <code class="code">lrcp</code> by default.
  3863. </p>
  3864. </dd>
  3865. <dt><samp class="option">layer_rates <var class="var">string</var></samp></dt>
  3866. <dd><p>By default, when this option is not used, compression is done using the quality metric.
  3867. This option allows for compression using compression ratio. The compression ratio for each
  3868. level could be specified. The compression ratio of a layer <code class="code">l</code> species the what ratio of
  3869. total file size is contained in the first <code class="code">l</code> layers.
  3870. </p>
  3871. <p>Example usage:
  3872. </p>
  3873. <div class="example">
  3874. <pre class="example-preformatted">ffmpeg -i input.bmp -c:v jpeg2000 -layer_rates &quot;100,10,1&quot; output.j2k
  3875. </pre></div>
  3876. <p>This would compress the image to contain 3 layers, where the data contained in the
  3877. first layer would be compressed by 1000 times, compressed by 100 in the first two layers,
  3878. and shall contain all data while using all 3 layers.
  3879. </p>
  3880. </dd>
  3881. </dl>
  3882. </div>
  3883. </div>
  3884. <div class="section-level-extent" id="librav1e">
  3885. <h3 class="section"><span>9.6 librav1e<a class="copiable-link" href="#librav1e"> &para;</a></span></h3>
  3886. <p>rav1e AV1 encoder wrapper.
  3887. </p>
  3888. <p>Requires the presence of the rav1e headers and library during configuration.
  3889. You need to explicitly configure the build with <code class="code">--enable-librav1e</code>.
  3890. </p>
  3891. <ul class="mini-toc">
  3892. <li><a href="#Options-25" accesskey="1">Options</a></li>
  3893. </ul>
  3894. <div class="subsection-level-extent" id="Options-25">
  3895. <h4 class="subsection"><span>9.6.1 Options<a class="copiable-link" href="#Options-25"> &para;</a></span></h4>
  3896. <dl class="table">
  3897. <dt><samp class="option">qmax</samp></dt>
  3898. <dd><p>Sets the maximum quantizer to use when using bitrate mode.
  3899. </p>
  3900. </dd>
  3901. <dt><samp class="option">qmin</samp></dt>
  3902. <dd><p>Sets the minimum quantizer to use when using bitrate mode.
  3903. </p>
  3904. </dd>
  3905. <dt><samp class="option">qp</samp></dt>
  3906. <dd><p>Uses quantizer mode to encode at the given quantizer (0-255).
  3907. </p>
  3908. </dd>
  3909. <dt><samp class="option">speed</samp></dt>
  3910. <dd><p>Selects the speed preset (0-10) to encode with.
  3911. </p>
  3912. </dd>
  3913. <dt><samp class="option">tiles</samp></dt>
  3914. <dd><p>Selects how many tiles to encode with.
  3915. </p>
  3916. </dd>
  3917. <dt><samp class="option">tile-rows</samp></dt>
  3918. <dd><p>Selects how many rows of tiles to encode with.
  3919. </p>
  3920. </dd>
  3921. <dt><samp class="option">tile-columns</samp></dt>
  3922. <dd><p>Selects how many columns of tiles to encode with.
  3923. </p>
  3924. </dd>
  3925. <dt><samp class="option">rav1e-params</samp></dt>
  3926. <dd><p>Set rav1e options using a list of <var class="var">key</var>=<var class="var">value</var> pairs separated
  3927. by &quot;:&quot;. See <code class="command">rav1e --help</code> for a list of options.
  3928. </p>
  3929. <p>For example to specify librav1e encoding options with <samp class="option">-rav1e-params</samp>:
  3930. </p>
  3931. <div class="example">
  3932. <pre class="example-preformatted">ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
  3933. </pre></div>
  3934. </dd>
  3935. </dl>
  3936. </div>
  3937. </div>
  3938. <div class="section-level-extent" id="libaom_002dav1">
  3939. <h3 class="section"><span>9.7 libaom-av1<a class="copiable-link" href="#libaom_002dav1"> &para;</a></span></h3>
  3940. <p>libaom AV1 encoder wrapper.
  3941. </p>
  3942. <p>Requires the presence of the libaom headers and library during
  3943. configuration. You need to explicitly configure the build with
  3944. <code class="code">--enable-libaom</code>.
  3945. </p>
  3946. <ul class="mini-toc">
  3947. <li><a href="#Options-26" accesskey="1">Options</a></li>
  3948. </ul>
  3949. <div class="subsection-level-extent" id="Options-26">
  3950. <h4 class="subsection"><span>9.7.1 Options<a class="copiable-link" href="#Options-26"> &para;</a></span></h4>
  3951. <p>The wrapper supports the following standard libavcodec options:
  3952. </p>
  3953. <dl class="table">
  3954. <dt><samp class="option">b</samp></dt>
  3955. <dd><p>Set bitrate target in bits/second. By default this will use
  3956. variable-bitrate mode. If <samp class="option">maxrate</samp> and <samp class="option">minrate</samp> are
  3957. also set to the same value then it will use constant-bitrate mode,
  3958. otherwise if <samp class="option">crf</samp> is set as well then it will use
  3959. constrained-quality mode.
  3960. </p>
  3961. </dd>
  3962. <dt><samp class="option">g keyint_min</samp></dt>
  3963. <dd><p>Set key frame placement. The GOP size sets the maximum distance between
  3964. key frames; if zero the output stream will be intra-only. The minimum
  3965. distance is ignored unless it is the same as the GOP size, in which case
  3966. key frames will always appear at a fixed interval. Not set by default,
  3967. so without this option the library has completely free choice about
  3968. where to place key frames.
  3969. </p>
  3970. </dd>
  3971. <dt><samp class="option">qmin qmax</samp></dt>
  3972. <dd><p>Set minimum/maximum quantisation values. Valid range is from 0 to 63
  3973. (warning: this does not match the quantiser values actually used by AV1
  3974. - divide by four to map real quantiser values to this range). Defaults
  3975. to min/max (no constraint).
  3976. </p>
  3977. </dd>
  3978. <dt><samp class="option">minrate maxrate bufsize rc_init_occupancy</samp></dt>
  3979. <dd><p>Set rate control buffering parameters. Not used if not set - defaults
  3980. to unconstrained variable bitrate.
  3981. </p>
  3982. </dd>
  3983. <dt><samp class="option">threads</samp></dt>
  3984. <dd><p>Set the number of threads to use while encoding. This may require the
  3985. <samp class="option">tiles</samp> or <samp class="option">row-mt</samp> options to also be set to actually
  3986. use the specified number of threads fully. Defaults to the number of
  3987. hardware threads supported by the host machine.
  3988. </p>
  3989. </dd>
  3990. <dt><samp class="option">profile</samp></dt>
  3991. <dd><p>Set the encoding profile. Defaults to using the profile which matches
  3992. the bit depth and chroma subsampling of the input.
  3993. </p>
  3994. </dd>
  3995. </dl>
  3996. <p>The wrapper also has some specific options:
  3997. </p>
  3998. <dl class="table">
  3999. <dt><samp class="option">cpu-used</samp></dt>
  4000. <dd><p>Set the quality/encoding speed tradeoff. Valid range is from 0 to 8,
  4001. higher numbers indicating greater speed and lower quality. The default
  4002. value is 1, which will be slow and high quality.
  4003. </p>
  4004. </dd>
  4005. <dt><samp class="option">auto-alt-ref</samp></dt>
  4006. <dd><p>Enable use of alternate reference frames. Defaults to the internal
  4007. default of the library.
  4008. </p>
  4009. </dd>
  4010. <dt><samp class="option">arnr-max-frames (<em class="emph">frames</em>)</samp></dt>
  4011. <dd><p>Set altref noise reduction max frame count. Default is -1.
  4012. </p>
  4013. </dd>
  4014. <dt><samp class="option">arnr-strength (<em class="emph">strength</em>)</samp></dt>
  4015. <dd><p>Set altref noise reduction filter strength. Range is -1 to 6. Default is -1.
  4016. </p>
  4017. </dd>
  4018. <dt><samp class="option">aq-mode (<em class="emph">aq-mode</em>)</samp></dt>
  4019. <dd><p>Set adaptive quantization mode. Possible values:
  4020. </p>
  4021. <dl class="table">
  4022. <dt>&lsquo;<samp class="samp">none (<em class="emph">0</em>)</samp>&rsquo;</dt>
  4023. <dd><p>Disabled.
  4024. </p>
  4025. </dd>
  4026. <dt>&lsquo;<samp class="samp">variance (<em class="emph">1</em>)</samp>&rsquo;</dt>
  4027. <dd><p>Variance-based.
  4028. </p>
  4029. </dd>
  4030. <dt>&lsquo;<samp class="samp">complexity (<em class="emph">2</em>)</samp>&rsquo;</dt>
  4031. <dd><p>Complexity-based.
  4032. </p>
  4033. </dd>
  4034. <dt>&lsquo;<samp class="samp">cyclic (<em class="emph">3</em>)</samp>&rsquo;</dt>
  4035. <dd><p>Cyclic refresh.
  4036. </p></dd>
  4037. </dl>
  4038. </dd>
  4039. <dt><samp class="option">tune (<em class="emph">tune</em>)</samp></dt>
  4040. <dd><p>Set the distortion metric the encoder is tuned with. Default is <code class="code">psnr</code>.
  4041. </p>
  4042. <dl class="table">
  4043. <dt>&lsquo;<samp class="samp">psnr (<em class="emph">0</em>)</samp>&rsquo;</dt>
  4044. <dt>&lsquo;<samp class="samp">ssim (<em class="emph">1</em>)</samp>&rsquo;</dt>
  4045. </dl>
  4046. </dd>
  4047. <dt><samp class="option">lag-in-frames</samp></dt>
  4048. <dd><p>Set the maximum number of frames which the encoder may keep in flight
  4049. at any one time for lookahead purposes. Defaults to the internal
  4050. default of the library.
  4051. </p>
  4052. </dd>
  4053. <dt><samp class="option">error-resilience</samp></dt>
  4054. <dd><p>Enable error resilience features:
  4055. </p><dl class="table">
  4056. <dt><samp class="option">default</samp></dt>
  4057. <dd><p>Improve resilience against losses of whole frames.
  4058. </p></dd>
  4059. </dl>
  4060. <p>Not enabled by default.
  4061. </p>
  4062. </dd>
  4063. <dt><samp class="option">crf</samp></dt>
  4064. <dd><p>Set the quality/size tradeoff for constant-quality (no bitrate target)
  4065. and constrained-quality (with maximum bitrate target) modes. Valid
  4066. range is 0 to 63, higher numbers indicating lower quality and smaller
  4067. output size. Only used if set; by default only the bitrate target is
  4068. used.
  4069. </p>
  4070. </dd>
  4071. <dt><samp class="option">static-thresh</samp></dt>
  4072. <dd><p>Set a change threshold on blocks below which they will be skipped by
  4073. the encoder. Defined in arbitrary units as a nonnegative integer,
  4074. defaulting to zero (no blocks are skipped).
  4075. </p>
  4076. </dd>
  4077. <dt><samp class="option">drop-threshold</samp></dt>
  4078. <dd><p>Set a threshold for dropping frames when close to rate control bounds.
  4079. Defined as a percentage of the target buffer - when the rate control
  4080. buffer falls below this percentage, frames will be dropped until it
  4081. has refilled above the threshold. Defaults to zero (no frames are
  4082. dropped).
  4083. </p>
  4084. </dd>
  4085. <dt><samp class="option">denoise-noise-level (<em class="emph">level</em>)</samp></dt>
  4086. <dd><p>Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if
  4087. this option is not set or set to 0.
  4088. </p>
  4089. </dd>
  4090. <dt><samp class="option">denoise-block-size (<em class="emph">pixels</em>)</samp></dt>
  4091. <dd><p>Block size used for denoising for grain synthesis. If not set, AV1 codec
  4092. uses the default value of 32.
  4093. </p>
  4094. </dd>
  4095. <dt><samp class="option">undershoot-pct (<em class="emph">pct</em>)</samp></dt>
  4096. <dd><p>Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100.
  4097. Default is -1.
  4098. </p>
  4099. </dd>
  4100. <dt><samp class="option">overshoot-pct (<em class="emph">pct</em>)</samp></dt>
  4101. <dd><p>Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000.
  4102. Default is -1.
  4103. </p>
  4104. </dd>
  4105. <dt><samp class="option">minsection-pct (<em class="emph">pct</em>)</samp></dt>
  4106. <dd><p>Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct
  4107. is not set, the libaomenc wrapper computes it as follows: <code class="code">(minrate * 100 / bitrate)</code>.
  4108. Range is -1 to 100. Default is -1 (unset).
  4109. </p>
  4110. </dd>
  4111. <dt><samp class="option">maxsection-pct (<em class="emph">pct</em>)</samp></dt>
  4112. <dd><p>Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct
  4113. is not set, the libaomenc wrapper computes it as follows: <code class="code">(maxrate * 100 / bitrate)</code>.
  4114. Range is -1 to 5000. Default is -1 (unset).
  4115. </p>
  4116. </dd>
  4117. <dt><samp class="option">frame-parallel (<em class="emph">boolean</em>)</samp></dt>
  4118. <dd><p>Enable frame parallel decodability features. Default is true.
  4119. </p>
  4120. </dd>
  4121. <dt><samp class="option">tiles</samp></dt>
  4122. <dd><p>Set the number of tiles to encode the input video with, as columns x
  4123. rows. Larger numbers allow greater parallelism in both encoding and
  4124. decoding, but may decrease coding efficiency. Defaults to the minimum
  4125. number of tiles required by the size of the input video (this is 1x1
  4126. (that is, a single tile) for sizes up to and including 4K).
  4127. </p>
  4128. </dd>
  4129. <dt><samp class="option">tile-columns tile-rows</samp></dt>
  4130. <dd><p>Set the number of tiles as log2 of the number of tile rows and columns.
  4131. Provided for compatibility with libvpx/VP9.
  4132. </p>
  4133. </dd>
  4134. <dt><samp class="option">row-mt (Requires libaom &gt;= 1.0.0-759-g90a15f4f2)</samp></dt>
  4135. <dd><p>Enable row based multi-threading. Disabled by default.
  4136. </p>
  4137. </dd>
  4138. <dt><samp class="option">enable-cdef (<em class="emph">boolean</em>)</samp></dt>
  4139. <dd><p>Enable Constrained Directional Enhancement Filter. The libaom-av1
  4140. encoder enables CDEF by default.
  4141. </p>
  4142. </dd>
  4143. <dt><samp class="option">enable-restoration (<em class="emph">boolean</em>)</samp></dt>
  4144. <dd><p>Enable Loop Restoration Filter. Default is true for libaom-av1.
  4145. </p>
  4146. </dd>
  4147. <dt><samp class="option">enable-global-motion (<em class="emph">boolean</em>)</samp></dt>
  4148. <dd><p>Enable the use of global motion for block prediction. Default is true.
  4149. </p>
  4150. </dd>
  4151. <dt><samp class="option">enable-intrabc (<em class="emph">boolean</em>)</samp></dt>
  4152. <dd><p>Enable block copy mode for intra block prediction. This mode is
  4153. useful for screen content. Default is true.
  4154. </p>
  4155. </dd>
  4156. <dt><samp class="option">enable-rect-partitions (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4157. <dd><p>Enable rectangular partitions. Default is true.
  4158. </p>
  4159. </dd>
  4160. <dt><samp class="option">enable-1to4-partitions (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4161. <dd><p>Enable 1:4/4:1 partitions. Default is true.
  4162. </p>
  4163. </dd>
  4164. <dt><samp class="option">enable-ab-partitions (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4165. <dd><p>Enable AB shape partitions. Default is true.
  4166. </p>
  4167. </dd>
  4168. <dt><samp class="option">enable-angle-delta (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4169. <dd><p>Enable angle delta intra prediction. Default is true.
  4170. </p>
  4171. </dd>
  4172. <dt><samp class="option">enable-cfl-intra (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4173. <dd><p>Enable chroma predicted from luma intra prediction. Default is true.
  4174. </p>
  4175. </dd>
  4176. <dt><samp class="option">enable-filter-intra (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4177. <dd><p>Enable filter intra predictor. Default is true.
  4178. </p>
  4179. </dd>
  4180. <dt><samp class="option">enable-intra-edge-filter (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4181. <dd><p>Enable intra edge filter. Default is true.
  4182. </p>
  4183. </dd>
  4184. <dt><samp class="option">enable-smooth-intra (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4185. <dd><p>Enable smooth intra prediction mode. Default is true.
  4186. </p>
  4187. </dd>
  4188. <dt><samp class="option">enable-paeth-intra (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4189. <dd><p>Enable paeth predictor in intra prediction. Default is true.
  4190. </p>
  4191. </dd>
  4192. <dt><samp class="option">enable-palette (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4193. <dd><p>Enable palette prediction mode. Default is true.
  4194. </p>
  4195. </dd>
  4196. <dt><samp class="option">enable-flip-idtx (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4197. <dd><p>Enable extended transform type, including FLIPADST_DCT, DCT_FLIPADST,
  4198. FLIPADST_FLIPADST, ADST_FLIPADST, FLIPADST_ADST, IDTX, V_DCT, H_DCT,
  4199. V_ADST, H_ADST, V_FLIPADST, H_FLIPADST. Default is true.
  4200. </p>
  4201. </dd>
  4202. <dt><samp class="option">enable-tx64 (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4203. <dd><p>Enable 64-pt transform. Default is true.
  4204. </p>
  4205. </dd>
  4206. <dt><samp class="option">reduced-tx-type-set (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4207. <dd><p>Use reduced set of transform types. Default is false.
  4208. </p>
  4209. </dd>
  4210. <dt><samp class="option">use-intra-dct-only (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4211. <dd><p>Use DCT only for INTRA modes. Default is false.
  4212. </p>
  4213. </dd>
  4214. <dt><samp class="option">use-inter-dct-only (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4215. <dd><p>Use DCT only for INTER modes. Default is false.
  4216. </p>
  4217. </dd>
  4218. <dt><samp class="option">use-intra-default-tx-only (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4219. <dd><p>Use Default-transform only for INTRA modes. Default is false.
  4220. </p>
  4221. </dd>
  4222. <dt><samp class="option">enable-ref-frame-mvs (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4223. <dd><p>Enable temporal mv prediction. Default is true.
  4224. </p>
  4225. </dd>
  4226. <dt><samp class="option">enable-reduced-reference-set (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4227. <dd><p>Use reduced set of single and compound references. Default is false.
  4228. </p>
  4229. </dd>
  4230. <dt><samp class="option">enable-obmc (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4231. <dd><p>Enable obmc. Default is true.
  4232. </p>
  4233. </dd>
  4234. <dt><samp class="option">enable-dual-filter (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4235. <dd><p>Enable dual filter. Default is true.
  4236. </p>
  4237. </dd>
  4238. <dt><samp class="option">enable-diff-wtd-comp (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4239. <dd><p>Enable difference-weighted compound. Default is true.
  4240. </p>
  4241. </dd>
  4242. <dt><samp class="option">enable-dist-wtd-comp (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4243. <dd><p>Enable distance-weighted compound. Default is true.
  4244. </p>
  4245. </dd>
  4246. <dt><samp class="option">enable-onesided-comp (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4247. <dd><p>Enable one sided compound. Default is true.
  4248. </p>
  4249. </dd>
  4250. <dt><samp class="option">enable-interinter-wedge (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4251. <dd><p>Enable interinter wedge compound. Default is true.
  4252. </p>
  4253. </dd>
  4254. <dt><samp class="option">enable-interintra-wedge (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4255. <dd><p>Enable interintra wedge compound. Default is true.
  4256. </p>
  4257. </dd>
  4258. <dt><samp class="option">enable-masked-comp (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4259. <dd><p>Enable masked compound. Default is true.
  4260. </p>
  4261. </dd>
  4262. <dt><samp class="option">enable-interintra-comp (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4263. <dd><p>Enable interintra compound. Default is true.
  4264. </p>
  4265. </dd>
  4266. <dt><samp class="option">enable-smooth-interintra (<em class="emph">boolean</em>) (Requires libaom &gt;= v2.0.0)</samp></dt>
  4267. <dd><p>Enable smooth interintra mode. Default is true.
  4268. </p>
  4269. </dd>
  4270. <dt><samp class="option">aom-params</samp></dt>
  4271. <dd><p>Set libaom options using a list of <var class="var">key</var>=<var class="var">value</var> pairs separated
  4272. by &quot;:&quot;. For a list of supported options, see <code class="command">aomenc --help</code> under the
  4273. section &quot;AV1 Specific Options&quot;.
  4274. </p>
  4275. <p>For example to specify libaom encoding options with <samp class="option">-aom-params</samp>:
  4276. </p>
  4277. <div class="example">
  4278. <pre class="example-preformatted">ffmpeg -i input -c:v libaom-av1 -b:v 500K -aom-params tune=psnr:enable-tpl-model=1 output.mp4
  4279. </pre></div>
  4280. </dd>
  4281. </dl>
  4282. </div>
  4283. </div>
  4284. <div class="section-level-extent" id="libsvtav1">
  4285. <h3 class="section"><span>9.8 libsvtav1<a class="copiable-link" href="#libsvtav1"> &para;</a></span></h3>
  4286. <p>SVT-AV1 encoder wrapper.
  4287. </p>
  4288. <p>Requires the presence of the SVT-AV1 headers and library during configuration.
  4289. You need to explicitly configure the build with <code class="code">--enable-libsvtav1</code>.
  4290. </p>
  4291. <ul class="mini-toc">
  4292. <li><a href="#Options-27" accesskey="1">Options</a></li>
  4293. </ul>
  4294. <div class="subsection-level-extent" id="Options-27">
  4295. <h4 class="subsection"><span>9.8.1 Options<a class="copiable-link" href="#Options-27"> &para;</a></span></h4>
  4296. <dl class="table">
  4297. <dt><samp class="option">profile</samp></dt>
  4298. <dd><p>Set the encoding profile.
  4299. </p><dl class="table">
  4300. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  4301. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  4302. <dt>&lsquo;<samp class="samp">professional</samp>&rsquo;</dt>
  4303. </dl>
  4304. </dd>
  4305. <dt><samp class="option">level</samp></dt>
  4306. <dd><p>Set the operating point level. For example: &rsquo;4.0&rsquo;
  4307. </p>
  4308. </dd>
  4309. <dt><samp class="option">hielevel</samp></dt>
  4310. <dd><p>Set the Hierarchical prediction levels.
  4311. </p><dl class="table">
  4312. <dt>&lsquo;<samp class="samp">3level</samp>&rsquo;</dt>
  4313. <dt>&lsquo;<samp class="samp">4level</samp>&rsquo;</dt>
  4314. <dd><p>This is the default.
  4315. </p></dd>
  4316. </dl>
  4317. </dd>
  4318. <dt><samp class="option">tier</samp></dt>
  4319. <dd><p>Set the operating point tier.
  4320. </p><dl class="table">
  4321. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  4322. <dd><p>This is the default.
  4323. </p></dd>
  4324. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  4325. </dl>
  4326. </dd>
  4327. <dt><samp class="option">qmax</samp></dt>
  4328. <dd><p>Set the maximum quantizer to use when using a bitrate mode.
  4329. </p>
  4330. </dd>
  4331. <dt><samp class="option">qmin</samp></dt>
  4332. <dd><p>Set the minimum quantizer to use when using a bitrate mode.
  4333. </p>
  4334. </dd>
  4335. <dt><samp class="option">crf</samp></dt>
  4336. <dd><p>Constant rate factor value used in crf rate control mode (0-63).
  4337. </p>
  4338. </dd>
  4339. <dt><samp class="option">qp</samp></dt>
  4340. <dd><p>Set the quantizer used in cqp rate control mode (0-63).
  4341. </p>
  4342. </dd>
  4343. <dt><samp class="option">sc_detection</samp></dt>
  4344. <dd><p>Enable scene change detection.
  4345. </p>
  4346. </dd>
  4347. <dt><samp class="option">la_depth</samp></dt>
  4348. <dd><p>Set number of frames to look ahead (0-120).
  4349. </p>
  4350. </dd>
  4351. <dt><samp class="option">preset</samp></dt>
  4352. <dd><p>Set the quality-speed tradeoff, in the range 0 to 13. Higher values are
  4353. faster but lower quality.
  4354. </p>
  4355. </dd>
  4356. <dt><samp class="option">tile_rows</samp></dt>
  4357. <dd><p>Set log2 of the number of rows of tiles to use (0-6).
  4358. </p>
  4359. </dd>
  4360. <dt><samp class="option">tile_columns</samp></dt>
  4361. <dd><p>Set log2 of the number of columns of tiles to use (0-4).
  4362. </p>
  4363. </dd>
  4364. <dt><samp class="option">svtav1-params</samp></dt>
  4365. <dd><p>Set SVT-AV1 options using a list of <var class="var">key</var>=<var class="var">value</var> pairs separated
  4366. by &quot;:&quot;. See the SVT-AV1 encoder user guide for a list of accepted parameters.
  4367. </p>
  4368. </dd>
  4369. </dl>
  4370. </div>
  4371. </div>
  4372. <div class="section-level-extent" id="libjxl">
  4373. <h3 class="section"><span>9.9 libjxl<a class="copiable-link" href="#libjxl"> &para;</a></span></h3>
  4374. <p>libjxl JPEG XL encoder wrapper.
  4375. </p>
  4376. <p>Requires the presence of the libjxl headers and library during
  4377. configuration. You need to explicitly configure the build with
  4378. <code class="code">--enable-libjxl</code>.
  4379. </p>
  4380. <ul class="mini-toc">
  4381. <li><a href="#Options-28" accesskey="1">Options</a></li>
  4382. </ul>
  4383. <div class="subsection-level-extent" id="Options-28">
  4384. <h4 class="subsection"><span>9.9.1 Options<a class="copiable-link" href="#Options-28"> &para;</a></span></h4>
  4385. <p>The libjxl wrapper supports the following options:
  4386. </p>
  4387. <dl class="table">
  4388. <dt><samp class="option">distance</samp></dt>
  4389. <dd><p>Set the target Butteraugli distance. This is a quality setting: lower
  4390. distance yields higher quality, with distance=1.0 roughly comparable to
  4391. libjpeg Quality 90 for photographic content. Setting distance=0.0 yields
  4392. true lossless encoding. Valid values range between 0.0 and 15.0, and sane
  4393. values rarely exceed 5.0. Setting distance=0.1 usually attains
  4394. transparency for most input. The default is 1.0.
  4395. </p>
  4396. </dd>
  4397. <dt><samp class="option">effort</samp></dt>
  4398. <dd><p>Set the encoding effort used. Higher effort values produce more consistent
  4399. quality and usually produces a better quality/bpp curve, at the cost of
  4400. more CPU time required. Valid values range from 1 to 9, and the default is 7.
  4401. </p>
  4402. </dd>
  4403. <dt><samp class="option">modular</samp></dt>
  4404. <dd><p>Force the encoder to use Modular mode instead of choosing automatically. The
  4405. default is to use VarDCT for lossy encoding and Modular for lossless. VarDCT
  4406. is generally superior to Modular for lossy encoding but does not support
  4407. lossless encoding.
  4408. </p>
  4409. </dd>
  4410. </dl>
  4411. </div>
  4412. </div>
  4413. <div class="section-level-extent" id="libkvazaar">
  4414. <h3 class="section"><span>9.10 libkvazaar<a class="copiable-link" href="#libkvazaar"> &para;</a></span></h3>
  4415. <p>Kvazaar H.265/HEVC encoder.
  4416. </p>
  4417. <p>Requires the presence of the libkvazaar headers and library during
  4418. configuration. You need to explicitly configure the build with
  4419. <samp class="option">--enable-libkvazaar</samp>.
  4420. </p>
  4421. <ul class="mini-toc">
  4422. <li><a href="#Options-29" accesskey="1">Options</a></li>
  4423. </ul>
  4424. <div class="subsection-level-extent" id="Options-29">
  4425. <h4 class="subsection"><span>9.10.1 Options<a class="copiable-link" href="#Options-29"> &para;</a></span></h4>
  4426. <dl class="table">
  4427. <dt><samp class="option">b</samp></dt>
  4428. <dd><p>Set target video bitrate in bit/s and enable rate control.
  4429. </p>
  4430. </dd>
  4431. <dt><samp class="option">kvazaar-params</samp></dt>
  4432. <dd><p>Set kvazaar parameters as a list of <var class="var">name</var>=<var class="var">value</var> pairs separated
  4433. by commas (,). See kvazaar documentation for a list of options.
  4434. </p>
  4435. </dd>
  4436. </dl>
  4437. </div>
  4438. </div>
  4439. <div class="section-level-extent" id="libopenh264">
  4440. <h3 class="section"><span>9.11 libopenh264<a class="copiable-link" href="#libopenh264"> &para;</a></span></h3>
  4441. <p>Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper.
  4442. </p>
  4443. <p>This encoder requires the presence of the libopenh264 headers and
  4444. library during configuration. You need to explicitly configure the
  4445. build with <code class="code">--enable-libopenh264</code>. The library is detected using
  4446. <code class="command">pkg-config</code>.
  4447. </p>
  4448. <p>For more information about the library see
  4449. <a class="url" href="http://www.openh264.org">http://www.openh264.org</a>.
  4450. </p>
  4451. <ul class="mini-toc">
  4452. <li><a href="#Options-30" accesskey="1">Options</a></li>
  4453. </ul>
  4454. <div class="subsection-level-extent" id="Options-30">
  4455. <h4 class="subsection"><span>9.11.1 Options<a class="copiable-link" href="#Options-30"> &para;</a></span></h4>
  4456. <p>The following FFmpeg global options affect the configurations of the
  4457. libopenh264 encoder.
  4458. </p>
  4459. <dl class="table">
  4460. <dt><samp class="option">b</samp></dt>
  4461. <dd><p>Set the bitrate (as a number of bits per second).
  4462. </p>
  4463. </dd>
  4464. <dt><samp class="option">g</samp></dt>
  4465. <dd><p>Set the GOP size.
  4466. </p>
  4467. </dd>
  4468. <dt><samp class="option">maxrate</samp></dt>
  4469. <dd><p>Set the max bitrate (as a number of bits per second).
  4470. </p>
  4471. </dd>
  4472. <dt><samp class="option">flags +global_header</samp></dt>
  4473. <dd><p>Set global header in the bitstream.
  4474. </p>
  4475. </dd>
  4476. <dt><samp class="option">slices</samp></dt>
  4477. <dd><p>Set the number of slices, used in parallelized encoding. Default value
  4478. is 0. This is only used when <samp class="option">slice_mode</samp> is set to
  4479. &lsquo;<samp class="samp">fixed</samp>&rsquo;.
  4480. </p>
  4481. </dd>
  4482. <dt><samp class="option">slice_mode</samp></dt>
  4483. <dd><p>Set slice mode. Can assume one of the following possible values:
  4484. </p>
  4485. <dl class="table">
  4486. <dt>&lsquo;<samp class="samp">fixed</samp>&rsquo;</dt>
  4487. <dd><p>a fixed number of slices
  4488. </p></dd>
  4489. <dt>&lsquo;<samp class="samp">rowmb</samp>&rsquo;</dt>
  4490. <dd><p>one slice per row of macroblocks
  4491. </p></dd>
  4492. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  4493. <dd><p>automatic number of slices according to number of threads
  4494. </p></dd>
  4495. <dt>&lsquo;<samp class="samp">dyn</samp>&rsquo;</dt>
  4496. <dd><p>dynamic slicing
  4497. </p></dd>
  4498. </dl>
  4499. <p>Default value is &lsquo;<samp class="samp">auto</samp>&rsquo;.
  4500. </p>
  4501. </dd>
  4502. <dt><samp class="option">loopfilter</samp></dt>
  4503. <dd><p>Enable loop filter, if set to 1 (automatically enabled). To disable
  4504. set a value of 0.
  4505. </p>
  4506. </dd>
  4507. <dt><samp class="option">profile</samp></dt>
  4508. <dd><p>Set profile restrictions. If set to the value of &lsquo;<samp class="samp">main</samp>&rsquo; enable
  4509. CABAC (set the <code class="code">SEncParamExt.iEntropyCodingModeFlag</code> flag to 1).
  4510. </p>
  4511. </dd>
  4512. <dt><samp class="option">max_nal_size</samp></dt>
  4513. <dd><p>Set maximum NAL size in bytes.
  4514. </p>
  4515. </dd>
  4516. <dt><samp class="option">allow_skip_frames</samp></dt>
  4517. <dd><p>Allow skipping frames to hit the target bitrate if set to 1.
  4518. </p></dd>
  4519. </dl>
  4520. </div>
  4521. </div>
  4522. <div class="section-level-extent" id="libtheora">
  4523. <h3 class="section"><span>9.12 libtheora<a class="copiable-link" href="#libtheora"> &para;</a></span></h3>
  4524. <p>libtheora Theora encoder wrapper.
  4525. </p>
  4526. <p>Requires the presence of the libtheora headers and library during
  4527. configuration. You need to explicitly configure the build with
  4528. <code class="code">--enable-libtheora</code>.
  4529. </p>
  4530. <p>For more information about the libtheora project see
  4531. <a class="url" href="http://www.theora.org/">http://www.theora.org/</a>.
  4532. </p>
  4533. <ul class="mini-toc">
  4534. <li><a href="#Options-31" accesskey="1">Options</a></li>
  4535. <li><a href="#Examples-1" accesskey="2">Examples</a></li>
  4536. </ul>
  4537. <div class="subsection-level-extent" id="Options-31">
  4538. <h4 class="subsection"><span>9.12.1 Options<a class="copiable-link" href="#Options-31"> &para;</a></span></h4>
  4539. <p>The following global options are mapped to internal libtheora options
  4540. which affect the quality and the bitrate of the encoded stream.
  4541. </p>
  4542. <dl class="table">
  4543. <dt><samp class="option">b</samp></dt>
  4544. <dd><p>Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode. In
  4545. case VBR (Variable Bit Rate) mode is enabled this option is ignored.
  4546. </p>
  4547. </dd>
  4548. <dt><samp class="option">flags</samp></dt>
  4549. <dd><p>Used to enable constant quality mode (VBR) encoding through the
  4550. <samp class="option">qscale</samp> flag, and to enable the <code class="code">pass1</code> and <code class="code">pass2</code>
  4551. modes.
  4552. </p>
  4553. </dd>
  4554. <dt><samp class="option">g</samp></dt>
  4555. <dd><p>Set the GOP size.
  4556. </p>
  4557. </dd>
  4558. <dt><samp class="option">global_quality</samp></dt>
  4559. <dd><p>Set the global quality as an integer in lambda units.
  4560. </p>
  4561. <p>Only relevant when VBR mode is enabled with <code class="code">flags +qscale</code>. The
  4562. value is converted to QP units by dividing it by <code class="code">FF_QP2LAMBDA</code>,
  4563. clipped in the [0 - 10] range, and then multiplied by 6.3 to get a
  4564. value in the native libtheora range [0-63]. A higher value corresponds
  4565. to a higher quality.
  4566. </p>
  4567. </dd>
  4568. <dt><samp class="option">q</samp></dt>
  4569. <dd><p>Enable VBR mode when set to a non-negative value, and set constant
  4570. quality value as a double floating point value in QP units.
  4571. </p>
  4572. <p>The value is clipped in the [0-10] range, and then multiplied by 6.3
  4573. to get a value in the native libtheora range [0-63].
  4574. </p>
  4575. <p>This option is valid only using the <code class="command">ffmpeg</code> command-line
  4576. tool. For library interface users, use <samp class="option">global_quality</samp>.
  4577. </p></dd>
  4578. </dl>
  4579. </div>
  4580. <div class="subsection-level-extent" id="Examples-1">
  4581. <h4 class="subsection"><span>9.12.2 Examples<a class="copiable-link" href="#Examples-1"> &para;</a></span></h4>
  4582. <ul class="itemize mark-bullet">
  4583. <li>Set maximum constant quality (VBR) encoding with <code class="command">ffmpeg</code>:
  4584. <div class="example">
  4585. <pre class="example-preformatted">ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
  4586. </pre></div>
  4587. </li><li>Use <code class="command">ffmpeg</code> to convert a CBR 1000 kbps Theora video stream:
  4588. <div class="example">
  4589. <pre class="example-preformatted">ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
  4590. </pre></div>
  4591. </li></ul>
  4592. </div>
  4593. </div>
  4594. <div class="section-level-extent" id="libvpx">
  4595. <h3 class="section"><span>9.13 libvpx<a class="copiable-link" href="#libvpx"> &para;</a></span></h3>
  4596. <p>VP8/VP9 format supported through libvpx.
  4597. </p>
  4598. <p>Requires the presence of the libvpx headers and library during configuration.
  4599. You need to explicitly configure the build with <code class="code">--enable-libvpx</code>.
  4600. </p>
  4601. <ul class="mini-toc">
  4602. <li><a href="#Options-32" accesskey="1">Options</a></li>
  4603. </ul>
  4604. <div class="subsection-level-extent" id="Options-32">
  4605. <h4 class="subsection"><span>9.13.1 Options<a class="copiable-link" href="#Options-32"> &para;</a></span></h4>
  4606. <p>The following options are supported by the libvpx wrapper. The
  4607. <code class="command">vpxenc</code>-equivalent options or values are listed in parentheses
  4608. for easy migration.
  4609. </p>
  4610. <p>To reduce the duplication of documentation, only the private options
  4611. and some others requiring special attention are documented here. For
  4612. the documentation of the undocumented generic options, see
  4613. <a class="ref" href="#codec_002doptions">the Codec Options chapter</a>.
  4614. </p>
  4615. <p>To get more documentation of the libvpx options, invoke the command
  4616. <code class="command">ffmpeg -h encoder=libvpx</code>, <code class="command">ffmpeg -h encoder=libvpx-vp9</code> or
  4617. <code class="command">vpxenc --help</code>. Further information is available in the libvpx API
  4618. documentation.
  4619. </p>
  4620. <dl class="table">
  4621. <dt><samp class="option">b (<em class="emph">target-bitrate</em>)</samp></dt>
  4622. <dd><p>Set bitrate in bits/s. Note that FFmpeg&rsquo;s <samp class="option">b</samp> option is
  4623. expressed in bits/s, while <code class="command">vpxenc</code>&rsquo;s <samp class="option">target-bitrate</samp> is in
  4624. kilobits/s.
  4625. </p>
  4626. </dd>
  4627. <dt><samp class="option">g (<em class="emph">kf-max-dist</em>)</samp></dt>
  4628. <dt><samp class="option">keyint_min (<em class="emph">kf-min-dist</em>)</samp></dt>
  4629. <dt><samp class="option">qmin (<em class="emph">min-q</em>)</samp></dt>
  4630. <dd><p>Minimum (Best Quality) Quantizer.
  4631. </p>
  4632. </dd>
  4633. <dt><samp class="option">qmax (<em class="emph">max-q</em>)</samp></dt>
  4634. <dd><p>Maximum (Worst Quality) Quantizer.
  4635. Can be changed per-frame.
  4636. </p>
  4637. </dd>
  4638. <dt><samp class="option">bufsize (<em class="emph">buf-sz</em>, <em class="emph">buf-optimal-sz</em>)</samp></dt>
  4639. <dd><p>Set ratecontrol buffer size (in bits). Note <code class="command">vpxenc</code>&rsquo;s options are
  4640. specified in milliseconds, the libvpx wrapper converts this value as follows:
  4641. <code class="code">buf-sz = bufsize * 1000 / bitrate</code>,
  4642. <code class="code">buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6</code>.
  4643. </p>
  4644. </dd>
  4645. <dt><samp class="option">rc_init_occupancy (<em class="emph">buf-initial-sz</em>)</samp></dt>
  4646. <dd><p>Set number of bits which should be loaded into the rc buffer before decoding
  4647. starts. Note <code class="command">vpxenc</code>&rsquo;s option is specified in milliseconds, the libvpx
  4648. wrapper converts this value as follows:
  4649. <code class="code">rc_init_occupancy * 1000 / bitrate</code>.
  4650. </p>
  4651. </dd>
  4652. <dt><samp class="option">undershoot-pct</samp></dt>
  4653. <dd><p>Set datarate undershoot (min) percentage of the target bitrate.
  4654. </p>
  4655. </dd>
  4656. <dt><samp class="option">overshoot-pct</samp></dt>
  4657. <dd><p>Set datarate overshoot (max) percentage of the target bitrate.
  4658. </p>
  4659. </dd>
  4660. <dt><samp class="option">skip_threshold (<em class="emph">drop-frame</em>)</samp></dt>
  4661. <dt><samp class="option">qcomp (<em class="emph">bias-pct</em>)</samp></dt>
  4662. <dt><samp class="option">maxrate (<em class="emph">maxsection-pct</em>)</samp></dt>
  4663. <dd><p>Set GOP max bitrate in bits/s. Note <code class="command">vpxenc</code>&rsquo;s option is specified as a
  4664. percentage of the target bitrate, the libvpx wrapper converts this value as
  4665. follows: <code class="code">(maxrate * 100 / bitrate)</code>.
  4666. </p>
  4667. </dd>
  4668. <dt><samp class="option">minrate (<em class="emph">minsection-pct</em>)</samp></dt>
  4669. <dd><p>Set GOP min bitrate in bits/s. Note <code class="command">vpxenc</code>&rsquo;s option is specified as a
  4670. percentage of the target bitrate, the libvpx wrapper converts this value as
  4671. follows: <code class="code">(minrate * 100 / bitrate)</code>.
  4672. </p>
  4673. </dd>
  4674. <dt><samp class="option">minrate, maxrate, b <em class="emph">end-usage=cbr</em></samp></dt>
  4675. <dd><p><code class="code">(minrate == maxrate == bitrate)</code>.
  4676. </p>
  4677. </dd>
  4678. <dt><samp class="option">crf (<em class="emph">end-usage=cq</em>, <em class="emph">cq-level</em>)</samp></dt>
  4679. <dt><samp class="option">tune (<em class="emph">tune</em>)</samp></dt>
  4680. <dd><dl class="table">
  4681. <dt>&lsquo;<samp class="samp">psnr (<em class="emph">psnr</em>)</samp>&rsquo;</dt>
  4682. <dt>&lsquo;<samp class="samp">ssim (<em class="emph">ssim</em>)</samp>&rsquo;</dt>
  4683. </dl>
  4684. </dd>
  4685. <dt><samp class="option">quality, deadline (<em class="emph">deadline</em>)</samp></dt>
  4686. <dd><dl class="table">
  4687. <dt>&lsquo;<samp class="samp">best</samp>&rsquo;</dt>
  4688. <dd><p>Use best quality deadline. Poorly named and quite slow, this option should be
  4689. avoided as it may give worse quality output than good.
  4690. </p></dd>
  4691. <dt>&lsquo;<samp class="samp">good</samp>&rsquo;</dt>
  4692. <dd><p>Use good quality deadline. This is a good trade-off between speed and quality
  4693. when used with the <samp class="option">cpu-used</samp> option.
  4694. </p></dd>
  4695. <dt>&lsquo;<samp class="samp">realtime</samp>&rsquo;</dt>
  4696. <dd><p>Use realtime quality deadline.
  4697. </p></dd>
  4698. </dl>
  4699. </dd>
  4700. <dt><samp class="option">speed, cpu-used (<em class="emph">cpu-used</em>)</samp></dt>
  4701. <dd><p>Set quality/speed ratio modifier. Higher values speed up the encode at the cost
  4702. of quality.
  4703. </p>
  4704. </dd>
  4705. <dt><samp class="option">nr (<em class="emph">noise-sensitivity</em>)</samp></dt>
  4706. <dt><samp class="option">static-thresh</samp></dt>
  4707. <dd><p>Set a change threshold on blocks below which they will be skipped by the
  4708. encoder.
  4709. </p>
  4710. </dd>
  4711. <dt><samp class="option">slices (<em class="emph">token-parts</em>)</samp></dt>
  4712. <dd><p>Note that FFmpeg&rsquo;s <samp class="option">slices</samp> option gives the total number of partitions,
  4713. while <code class="command">vpxenc</code>&rsquo;s <samp class="option">token-parts</samp> is given as
  4714. <code class="code">log2(partitions)</code>.
  4715. </p>
  4716. </dd>
  4717. <dt><samp class="option">max-intra-rate</samp></dt>
  4718. <dd><p>Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0
  4719. means unlimited.
  4720. </p>
  4721. </dd>
  4722. <dt><samp class="option">force_key_frames</samp></dt>
  4723. <dd><p><code class="code">VPX_EFLAG_FORCE_KF</code>
  4724. </p>
  4725. </dd>
  4726. <dt><samp class="option">Alternate reference frame related</samp></dt>
  4727. <dd><dl class="table">
  4728. <dt><samp class="option">auto-alt-ref</samp></dt>
  4729. <dd><p>Enable use of alternate reference frames (2-pass only).
  4730. Values greater than 1 enable multi-layer alternate reference frames (VP9 only).
  4731. </p></dd>
  4732. <dt><samp class="option">arnr-maxframes</samp></dt>
  4733. <dd><p>Set altref noise reduction max frame count.
  4734. </p></dd>
  4735. <dt><samp class="option">arnr-type</samp></dt>
  4736. <dd><p>Set altref noise reduction filter type: backward, forward, centered.
  4737. </p></dd>
  4738. <dt><samp class="option">arnr-strength</samp></dt>
  4739. <dd><p>Set altref noise reduction filter strength.
  4740. </p></dd>
  4741. <dt><samp class="option">rc-lookahead, lag-in-frames (<em class="emph">lag-in-frames</em>)</samp></dt>
  4742. <dd><p>Set number of frames to look ahead for frametype and ratecontrol.
  4743. </p></dd>
  4744. </dl>
  4745. </dd>
  4746. <dt><samp class="option">error-resilient</samp></dt>
  4747. <dd><p>Enable error resiliency features.
  4748. </p>
  4749. </dd>
  4750. <dt><samp class="option">sharpness <var class="var">integer</var></samp></dt>
  4751. <dd><p>Increase sharpness at the expense of lower PSNR.
  4752. The valid range is [0, 7].
  4753. </p>
  4754. </dd>
  4755. <dt><samp class="option">ts-parameters</samp></dt>
  4756. <dd><p>Sets the temporal scalability configuration using a :-separated list of
  4757. key=value pairs. For example, to specify temporal scalability parameters
  4758. with <code class="code">ffmpeg</code>:
  4759. </p><div class="example">
  4760. <pre class="example-preformatted">ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
  4761. ts_target_bitrate=250,500,1000:ts_rate_decimator=4,2,1:\
  4762. ts_periodicity=4:ts_layer_id=0,2,1,2:ts_layering_mode=3 OUTPUT
  4763. </pre></div>
  4764. <p>Below is a brief explanation of each of the parameters, please
  4765. refer to <code class="code">struct vpx_codec_enc_cfg</code> in <code class="code">vpx/vpx_encoder.h</code> for more
  4766. details.
  4767. </p><dl class="table">
  4768. <dt><samp class="option">ts_number_layers</samp></dt>
  4769. <dd><p>Number of temporal coding layers.
  4770. </p></dd>
  4771. <dt><samp class="option">ts_target_bitrate</samp></dt>
  4772. <dd><p>Target bitrate for each temporal layer (in kbps).
  4773. (bitrate should be inclusive of the lower temporal layer).
  4774. </p></dd>
  4775. <dt><samp class="option">ts_rate_decimator</samp></dt>
  4776. <dd><p>Frame rate decimation factor for each temporal layer.
  4777. </p></dd>
  4778. <dt><samp class="option">ts_periodicity</samp></dt>
  4779. <dd><p>Length of the sequence defining frame temporal layer membership.
  4780. </p></dd>
  4781. <dt><samp class="option">ts_layer_id</samp></dt>
  4782. <dd><p>Template defining the membership of frames to temporal layers.
  4783. </p></dd>
  4784. <dt><samp class="option">ts_layering_mode</samp></dt>
  4785. <dd><p>(optional) Selecting the temporal structure from a set of pre-defined temporal layering modes.
  4786. Currently supports the following options.
  4787. </p><dl class="table">
  4788. <dt><samp class="option">0</samp></dt>
  4789. <dd><p>No temporal layering flags are provided internally,
  4790. relies on flags being passed in using <code class="code">metadata</code> field in <code class="code">AVFrame</code>
  4791. with following keys.
  4792. </p><dl class="table">
  4793. <dt><samp class="option">vp8-flags</samp></dt>
  4794. <dd><p>Sets the flags passed into the encoder to indicate the referencing scheme for
  4795. the current frame.
  4796. Refer to function <code class="code">vpx_codec_encode</code> in <code class="code">vpx/vpx_encoder.h</code> for more
  4797. details.
  4798. </p></dd>
  4799. <dt><samp class="option">temporal_id</samp></dt>
  4800. <dd><p>Explicitly sets the temporal id of the current frame to encode.
  4801. </p></dd>
  4802. </dl>
  4803. </dd>
  4804. <dt><samp class="option">2</samp></dt>
  4805. <dd><p>Two temporal layers. 0-1...
  4806. </p></dd>
  4807. <dt><samp class="option">3</samp></dt>
  4808. <dd><p>Three temporal layers. 0-2-1-2...; with single reference frame.
  4809. </p></dd>
  4810. <dt><samp class="option">4</samp></dt>
  4811. <dd><p>Same as option &quot;3&quot;, except there is a dependency between
  4812. the two temporal layer 2 frames within the temporal period.
  4813. </p></dd>
  4814. </dl>
  4815. </dd>
  4816. </dl>
  4817. </dd>
  4818. <dt><samp class="option">VP9-specific options</samp></dt>
  4819. <dd><dl class="table">
  4820. <dt><samp class="option">lossless</samp></dt>
  4821. <dd><p>Enable lossless mode.
  4822. </p></dd>
  4823. <dt><samp class="option">tile-columns</samp></dt>
  4824. <dd><p>Set number of tile columns to use. Note this is given as
  4825. <code class="code">log2(tile_columns)</code>. For example, 8 tile columns would be requested by
  4826. setting the <samp class="option">tile-columns</samp> option to 3.
  4827. </p></dd>
  4828. <dt><samp class="option">tile-rows</samp></dt>
  4829. <dd><p>Set number of tile rows to use. Note this is given as <code class="code">log2(tile_rows)</code>.
  4830. For example, 4 tile rows would be requested by setting the <samp class="option">tile-rows</samp>
  4831. option to 2.
  4832. </p></dd>
  4833. <dt><samp class="option">frame-parallel</samp></dt>
  4834. <dd><p>Enable frame parallel decodability features.
  4835. </p></dd>
  4836. <dt><samp class="option">aq-mode</samp></dt>
  4837. <dd><p>Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3:
  4838. cyclic refresh, 4: equator360).
  4839. </p></dd>
  4840. <dt><samp class="option">colorspace <em class="emph">color-space</em></samp></dt>
  4841. <dd><p>Set input color space. The VP9 bitstream supports signaling the following
  4842. colorspaces:
  4843. </p><dl class="table">
  4844. <dt><samp class="option">&lsquo;<samp class="samp">rgb</samp>&rsquo; <em class="emph">sRGB</em></samp></dt>
  4845. <dt><samp class="option">&lsquo;<samp class="samp">bt709</samp>&rsquo; <em class="emph">bt709</em></samp></dt>
  4846. <dt><samp class="option">&lsquo;<samp class="samp">unspecified</samp>&rsquo; <em class="emph">unknown</em></samp></dt>
  4847. <dt><samp class="option">&lsquo;<samp class="samp">bt470bg</samp>&rsquo; <em class="emph">bt601</em></samp></dt>
  4848. <dt><samp class="option">&lsquo;<samp class="samp">smpte170m</samp>&rsquo; <em class="emph">smpte170</em></samp></dt>
  4849. <dt><samp class="option">&lsquo;<samp class="samp">smpte240m</samp>&rsquo; <em class="emph">smpte240</em></samp></dt>
  4850. <dt><samp class="option">&lsquo;<samp class="samp">bt2020_ncl</samp>&rsquo; <em class="emph">bt2020</em></samp></dt>
  4851. </dl>
  4852. </dd>
  4853. <dt><samp class="option">row-mt <var class="var">boolean</var></samp></dt>
  4854. <dd><p>Enable row based multi-threading.
  4855. </p></dd>
  4856. <dt><samp class="option">tune-content</samp></dt>
  4857. <dd><p>Set content type: default (0), screen (1), film (2).
  4858. </p></dd>
  4859. <dt><samp class="option">corpus-complexity</samp></dt>
  4860. <dd><p>Corpus VBR mode is a variant of standard VBR where the complexity distribution
  4861. midpoint is passed in rather than calculated for a specific clip or chunk.
  4862. </p>
  4863. <p>The valid range is [0, 10000]. 0 (default) uses standard VBR.
  4864. </p></dd>
  4865. <dt><samp class="option">enable-tpl <var class="var">boolean</var></samp></dt>
  4866. <dd><p>Enable temporal dependency model.
  4867. </p></dd>
  4868. <dt><samp class="option">ref-frame-config</samp></dt>
  4869. <dd><p>Using per-frame metadata, set members of the structure <code class="code">vpx_svc_ref_frame_config_t</code> in <code class="code">vpx/vp8cx.h</code> to fine-control referencing schemes and frame buffer management.
  4870. <br>Use a :-separated list of key=value pairs.
  4871. For example,
  4872. </p><div class="example">
  4873. <pre class="example-preformatted">av_dict_set(&amp;av_frame-&gt;metadata, &quot;ref-frame-config&quot;, \
  4874. &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;);
  4875. </pre></div>
  4876. <dl class="table">
  4877. <dt><samp class="option">rfc_update_buffer_slot</samp></dt>
  4878. <dd><p>Indicates the buffer slot number to update
  4879. </p></dd>
  4880. <dt><samp class="option">rfc_update_last</samp></dt>
  4881. <dd><p>Indicates whether to update the LAST frame
  4882. </p></dd>
  4883. <dt><samp class="option">rfc_update_golden</samp></dt>
  4884. <dd><p>Indicates whether to update GOLDEN frame
  4885. </p></dd>
  4886. <dt><samp class="option">rfc_update_alt_ref</samp></dt>
  4887. <dd><p>Indicates whether to update ALT_REF frame
  4888. </p></dd>
  4889. <dt><samp class="option">rfc_lst_fb_idx</samp></dt>
  4890. <dd><p>LAST frame buffer index
  4891. </p></dd>
  4892. <dt><samp class="option">rfc_gld_fb_idx</samp></dt>
  4893. <dd><p>GOLDEN frame buffer index
  4894. </p></dd>
  4895. <dt><samp class="option">rfc_alt_fb_idx</samp></dt>
  4896. <dd><p>ALT_REF frame buffer index
  4897. </p></dd>
  4898. <dt><samp class="option">rfc_reference_last</samp></dt>
  4899. <dd><p>Indicates whether to reference LAST frame
  4900. </p></dd>
  4901. <dt><samp class="option">rfc_reference_golden</samp></dt>
  4902. <dd><p>Indicates whether to reference GOLDEN frame
  4903. </p></dd>
  4904. <dt><samp class="option">rfc_reference_alt_ref</samp></dt>
  4905. <dd><p>Indicates whether to reference ALT_REF frame
  4906. </p></dd>
  4907. <dt><samp class="option">rfc_reference_duration</samp></dt>
  4908. <dd><p>Indicates frame duration
  4909. </p></dd>
  4910. </dl>
  4911. </dd>
  4912. </dl>
  4913. </dd>
  4914. </dl>
  4915. <p>For more information about libvpx see:
  4916. <a class="url" href="http://www.webmproject.org/">http://www.webmproject.org/</a>
  4917. </p>
  4918. </div>
  4919. </div>
  4920. <div class="section-level-extent" id="libwebp">
  4921. <h3 class="section"><span>9.14 libwebp<a class="copiable-link" href="#libwebp"> &para;</a></span></h3>
  4922. <p>libwebp WebP Image encoder wrapper
  4923. </p>
  4924. <p>libwebp is Google&rsquo;s official encoder for WebP images. It can encode in either
  4925. lossy or lossless mode. Lossy images are essentially a wrapper around a VP8
  4926. frame. Lossless images are a separate codec developed by Google.
  4927. </p>
  4928. <ul class="mini-toc">
  4929. <li><a href="#Pixel-Format" accesskey="1">Pixel Format</a></li>
  4930. <li><a href="#Options-33" accesskey="2">Options</a></li>
  4931. </ul>
  4932. <div class="subsection-level-extent" id="Pixel-Format">
  4933. <h4 class="subsection"><span>9.14.1 Pixel Format<a class="copiable-link" href="#Pixel-Format"> &para;</a></span></h4>
  4934. <p>Currently, libwebp only supports YUV420 for lossy and RGB for lossless due
  4935. to limitations of the format and libwebp. Alpha is supported for either mode.
  4936. Because of API limitations, if RGB is passed in when encoding lossy or YUV is
  4937. passed in for encoding lossless, the pixel format will automatically be
  4938. converted using functions from libwebp. This is not ideal and is done only for
  4939. convenience.
  4940. </p>
  4941. </div>
  4942. <div class="subsection-level-extent" id="Options-33">
  4943. <h4 class="subsection"><span>9.14.2 Options<a class="copiable-link" href="#Options-33"> &para;</a></span></h4>
  4944. <dl class="table">
  4945. <dt><samp class="option">-lossless <var class="var">boolean</var></samp></dt>
  4946. <dd><p>Enables/Disables use of lossless mode. Default is 0.
  4947. </p>
  4948. </dd>
  4949. <dt><samp class="option">-compression_level <var class="var">integer</var></samp></dt>
  4950. <dd><p>For lossy, this is a quality/speed tradeoff. Higher values give better quality
  4951. for a given size at the cost of increased encoding time. For lossless, this is
  4952. a size/speed tradeoff. Higher values give smaller size at the cost of increased
  4953. encoding time. More specifically, it controls the number of extra algorithms
  4954. and compression tools used, and varies the combination of these tools. This
  4955. maps to the <var class="var">method</var> option in libwebp. The valid range is 0 to 6.
  4956. Default is 4.
  4957. </p>
  4958. </dd>
  4959. <dt><samp class="option">-quality <var class="var">float</var></samp></dt>
  4960. <dd><p>For lossy encoding, this controls image quality. For lossless encoding, this
  4961. controls the effort and time spent in compression.
  4962. Range is 0 to 100. Default is 75.
  4963. </p>
  4964. </dd>
  4965. <dt><samp class="option">-preset <var class="var">type</var></samp></dt>
  4966. <dd><p>Configuration preset. This does some automatic settings based on the general
  4967. type of the image.
  4968. </p><dl class="table">
  4969. <dt><samp class="option">none</samp></dt>
  4970. <dd><p>Do not use a preset.
  4971. </p></dd>
  4972. <dt><samp class="option">default</samp></dt>
  4973. <dd><p>Use the encoder default.
  4974. </p></dd>
  4975. <dt><samp class="option">picture</samp></dt>
  4976. <dd><p>Digital picture, like portrait, inner shot
  4977. </p></dd>
  4978. <dt><samp class="option">photo</samp></dt>
  4979. <dd><p>Outdoor photograph, with natural lighting
  4980. </p></dd>
  4981. <dt><samp class="option">drawing</samp></dt>
  4982. <dd><p>Hand or line drawing, with high-contrast details
  4983. </p></dd>
  4984. <dt><samp class="option">icon</samp></dt>
  4985. <dd><p>Small-sized colorful images
  4986. </p></dd>
  4987. <dt><samp class="option">text</samp></dt>
  4988. <dd><p>Text-like
  4989. </p></dd>
  4990. </dl>
  4991. </dd>
  4992. </dl>
  4993. </div>
  4994. </div>
  4995. <div class="section-level-extent" id="libx264_002c-libx264rgb">
  4996. <h3 class="section"><span>9.15 libx264, libx264rgb<a class="copiable-link" href="#libx264_002c-libx264rgb"> &para;</a></span></h3>
  4997. <p>x264 H.264/MPEG-4 AVC encoder wrapper.
  4998. </p>
  4999. <p>This encoder requires the presence of the libx264 headers and library
  5000. during configuration. You need to explicitly configure the build with
  5001. <code class="code">--enable-libx264</code>.
  5002. </p>
  5003. <p>libx264 supports an impressive number of features, including 8x8 and
  5004. 4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC
  5005. entropy coding, interlacing (MBAFF), lossless mode, psy optimizations
  5006. for detail retention (adaptive quantization, psy-RD, psy-trellis).
  5007. </p>
  5008. <p>Many libx264 encoder options are mapped to FFmpeg global codec
  5009. options, while unique encoder options are provided through private
  5010. options. Additionally the <samp class="option">x264opts</samp> and <samp class="option">x264-params</samp>
  5011. private options allows one to pass a list of key=value tuples as accepted
  5012. by the libx264 <code class="code">x264_param_parse</code> function.
  5013. </p>
  5014. <p>The x264 project website is at
  5015. <a class="url" href="http://www.videolan.org/developers/x264.html">http://www.videolan.org/developers/x264.html</a>.
  5016. </p>
  5017. <p>The libx264rgb encoder is the same as libx264, except it accepts packed RGB
  5018. pixel formats as input instead of YUV.
  5019. </p>
  5020. <ul class="mini-toc">
  5021. <li><a href="#Supported-Pixel-Formats" accesskey="1">Supported Pixel Formats</a></li>
  5022. <li><a href="#Options-34" accesskey="2">Options</a></li>
  5023. </ul>
  5024. <div class="subsection-level-extent" id="Supported-Pixel-Formats">
  5025. <h4 class="subsection"><span>9.15.1 Supported Pixel Formats<a class="copiable-link" href="#Supported-Pixel-Formats"> &para;</a></span></h4>
  5026. <p>x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at
  5027. x264&rsquo;s configure time.
  5028. </p>
  5029. </div>
  5030. <div class="subsection-level-extent" id="Options-34">
  5031. <h4 class="subsection"><span>9.15.2 Options<a class="copiable-link" href="#Options-34"> &para;</a></span></h4>
  5032. <p>The following options are supported by the libx264 wrapper. The
  5033. <code class="command">x264</code>-equivalent options or values are listed in parentheses
  5034. for easy migration.
  5035. </p>
  5036. <p>To reduce the duplication of documentation, only the private options
  5037. and some others requiring special attention are documented here. For
  5038. the documentation of the undocumented generic options, see
  5039. <a class="ref" href="#codec_002doptions">the Codec Options chapter</a>.
  5040. </p>
  5041. <p>To get a more accurate and extensive documentation of the libx264
  5042. options, invoke the command <code class="command">x264 --fullhelp</code> or consult
  5043. the libx264 documentation.
  5044. </p>
  5045. <dl class="table">
  5046. <dt><samp class="option">b (<em class="emph">bitrate</em>)</samp></dt>
  5047. <dd><p>Set bitrate in bits/s. Note that FFmpeg&rsquo;s <samp class="option">b</samp> option is
  5048. expressed in bits/s, while <code class="command">x264</code>&rsquo;s <samp class="option">bitrate</samp> is in
  5049. kilobits/s.
  5050. </p>
  5051. </dd>
  5052. <dt><samp class="option">bf (<em class="emph">bframes</em>)</samp></dt>
  5053. <dt><samp class="option">g (<em class="emph">keyint</em>)</samp></dt>
  5054. <dt><samp class="option">qmin (<em class="emph">qpmin</em>)</samp></dt>
  5055. <dd><p>Minimum quantizer scale.
  5056. </p>
  5057. </dd>
  5058. <dt><samp class="option">qmax (<em class="emph">qpmax</em>)</samp></dt>
  5059. <dd><p>Maximum quantizer scale.
  5060. </p>
  5061. </dd>
  5062. <dt><samp class="option">qdiff (<em class="emph">qpstep</em>)</samp></dt>
  5063. <dd><p>Maximum difference between quantizer scales.
  5064. </p>
  5065. </dd>
  5066. <dt><samp class="option">qblur (<em class="emph">qblur</em>)</samp></dt>
  5067. <dd><p>Quantizer curve blur
  5068. </p>
  5069. </dd>
  5070. <dt><samp class="option">qcomp (<em class="emph">qcomp</em>)</samp></dt>
  5071. <dd><p>Quantizer curve compression factor
  5072. </p>
  5073. </dd>
  5074. <dt><samp class="option">refs (<em class="emph">ref</em>)</samp></dt>
  5075. <dd><p>Number of reference frames each P-frame can use. The range is from <var class="var">0-16</var>.
  5076. </p>
  5077. </dd>
  5078. <dt><samp class="option">sc_threshold (<em class="emph">scenecut</em>)</samp></dt>
  5079. <dd><p>Sets the threshold for the scene change detection.
  5080. </p>
  5081. </dd>
  5082. <dt><samp class="option">trellis (<em class="emph">trellis</em>)</samp></dt>
  5083. <dd><p>Performs Trellis quantization to increase efficiency. Enabled by default.
  5084. </p>
  5085. </dd>
  5086. <dt><samp class="option">nr (<em class="emph">nr</em>)</samp></dt>
  5087. <dt><samp class="option">me_range (<em class="emph">merange</em>)</samp></dt>
  5088. <dd><p>Maximum range of the motion search in pixels.
  5089. </p>
  5090. </dd>
  5091. <dt><samp class="option">me_method (<em class="emph">me</em>)</samp></dt>
  5092. <dd><p>Set motion estimation method. Possible values in the decreasing order
  5093. of speed:
  5094. </p>
  5095. <dl class="table">
  5096. <dt>&lsquo;<samp class="samp">dia (<em class="emph">dia</em>)</samp>&rsquo;</dt>
  5097. <dt>&lsquo;<samp class="samp">epzs (<em class="emph">dia</em>)</samp>&rsquo;</dt>
  5098. <dd><p>Diamond search with radius 1 (fastest). &lsquo;<samp class="samp">epzs</samp>&rsquo; is an alias for
  5099. &lsquo;<samp class="samp">dia</samp>&rsquo;.
  5100. </p></dd>
  5101. <dt>&lsquo;<samp class="samp">hex (<em class="emph">hex</em>)</samp>&rsquo;</dt>
  5102. <dd><p>Hexagonal search with radius 2.
  5103. </p></dd>
  5104. <dt>&lsquo;<samp class="samp">umh (<em class="emph">umh</em>)</samp>&rsquo;</dt>
  5105. <dd><p>Uneven multi-hexagon search.
  5106. </p></dd>
  5107. <dt>&lsquo;<samp class="samp">esa (<em class="emph">esa</em>)</samp>&rsquo;</dt>
  5108. <dd><p>Exhaustive search.
  5109. </p></dd>
  5110. <dt>&lsquo;<samp class="samp">tesa (<em class="emph">tesa</em>)</samp>&rsquo;</dt>
  5111. <dd><p>Hadamard exhaustive search (slowest).
  5112. </p></dd>
  5113. </dl>
  5114. </dd>
  5115. <dt><samp class="option">forced-idr</samp></dt>
  5116. <dd><p>Normally, when forcing a I-frame type, the encoder can select any type
  5117. of I-frame. This option forces it to choose an IDR-frame.
  5118. </p>
  5119. </dd>
  5120. <dt><samp class="option">subq (<em class="emph">subme</em>)</samp></dt>
  5121. <dd><p>Sub-pixel motion estimation method.
  5122. </p>
  5123. </dd>
  5124. <dt><samp class="option">b_strategy (<em class="emph">b-adapt</em>)</samp></dt>
  5125. <dd><p>Adaptive B-frame placement decision algorithm. Use only on first-pass.
  5126. </p>
  5127. </dd>
  5128. <dt><samp class="option">keyint_min (<em class="emph">min-keyint</em>)</samp></dt>
  5129. <dd><p>Minimum GOP size.
  5130. </p>
  5131. </dd>
  5132. <dt><samp class="option">coder</samp></dt>
  5133. <dd><p>Set entropy encoder. Possible values:
  5134. </p>
  5135. <dl class="table">
  5136. <dt>&lsquo;<samp class="samp">ac</samp>&rsquo;</dt>
  5137. <dd><p>Enable CABAC.
  5138. </p>
  5139. </dd>
  5140. <dt>&lsquo;<samp class="samp">vlc</samp>&rsquo;</dt>
  5141. <dd><p>Enable CAVLC and disable CABAC. It generates the same effect as
  5142. <code class="command">x264</code>&rsquo;s <samp class="option">--no-cabac</samp> option.
  5143. </p></dd>
  5144. </dl>
  5145. </dd>
  5146. <dt><samp class="option">cmp</samp></dt>
  5147. <dd><p>Set full pixel motion estimation comparison algorithm. Possible values:
  5148. </p>
  5149. <dl class="table">
  5150. <dt>&lsquo;<samp class="samp">chroma</samp>&rsquo;</dt>
  5151. <dd><p>Enable chroma in motion estimation.
  5152. </p>
  5153. </dd>
  5154. <dt>&lsquo;<samp class="samp">sad</samp>&rsquo;</dt>
  5155. <dd><p>Ignore chroma in motion estimation. It generates the same effect as
  5156. <code class="command">x264</code>&rsquo;s <samp class="option">--no-chroma-me</samp> option.
  5157. </p></dd>
  5158. </dl>
  5159. </dd>
  5160. <dt><samp class="option">threads (<em class="emph">threads</em>)</samp></dt>
  5161. <dd><p>Number of encoding threads.
  5162. </p>
  5163. </dd>
  5164. <dt><samp class="option">thread_type</samp></dt>
  5165. <dd><p>Set multithreading technique. Possible values:
  5166. </p>
  5167. <dl class="table">
  5168. <dt>&lsquo;<samp class="samp">slice</samp>&rsquo;</dt>
  5169. <dd><p>Slice-based multithreading. It generates the same effect as
  5170. <code class="command">x264</code>&rsquo;s <samp class="option">--sliced-threads</samp> option.
  5171. </p></dd>
  5172. <dt>&lsquo;<samp class="samp">frame</samp>&rsquo;</dt>
  5173. <dd><p>Frame-based multithreading.
  5174. </p></dd>
  5175. </dl>
  5176. </dd>
  5177. <dt><samp class="option">flags</samp></dt>
  5178. <dd><p>Set encoding flags. It can be used to disable closed GOP and enable
  5179. open GOP by setting it to <code class="code">-cgop</code>. The result is similar to
  5180. the behavior of <code class="command">x264</code>&rsquo;s <samp class="option">--open-gop</samp> option.
  5181. </p>
  5182. </dd>
  5183. <dt><samp class="option">rc_init_occupancy (<em class="emph">vbv-init</em>)</samp></dt>
  5184. <dt><samp class="option">preset (<em class="emph">preset</em>)</samp></dt>
  5185. <dd><p>Set the encoding preset.
  5186. </p>
  5187. </dd>
  5188. <dt><samp class="option">tune (<em class="emph">tune</em>)</samp></dt>
  5189. <dd><p>Set tuning of the encoding params.
  5190. </p>
  5191. </dd>
  5192. <dt><samp class="option">profile (<em class="emph">profile</em>)</samp></dt>
  5193. <dd><p>Set profile restrictions.
  5194. </p>
  5195. </dd>
  5196. <dt><samp class="option">fastfirstpass</samp></dt>
  5197. <dd><p>Enable fast settings when encoding first pass, when set to 1. When set
  5198. to 0, it has the same effect of <code class="command">x264</code>&rsquo;s
  5199. <samp class="option">--slow-firstpass</samp> option.
  5200. </p>
  5201. </dd>
  5202. <dt><samp class="option">crf (<em class="emph">crf</em>)</samp></dt>
  5203. <dd><p>Set the quality for constant quality mode.
  5204. </p>
  5205. </dd>
  5206. <dt><samp class="option">crf_max (<em class="emph">crf-max</em>)</samp></dt>
  5207. <dd><p>In CRF mode, prevents VBV from lowering quality beyond this point.
  5208. </p>
  5209. </dd>
  5210. <dt><samp class="option">qp (<em class="emph">qp</em>)</samp></dt>
  5211. <dd><p>Set constant quantization rate control method parameter.
  5212. </p>
  5213. </dd>
  5214. <dt><samp class="option">aq-mode (<em class="emph">aq-mode</em>)</samp></dt>
  5215. <dd><p>Set AQ method. Possible values:
  5216. </p>
  5217. <dl class="table">
  5218. <dt>&lsquo;<samp class="samp">none (<em class="emph">0</em>)</samp>&rsquo;</dt>
  5219. <dd><p>Disabled.
  5220. </p>
  5221. </dd>
  5222. <dt>&lsquo;<samp class="samp">variance (<em class="emph">1</em>)</samp>&rsquo;</dt>
  5223. <dd><p>Variance AQ (complexity mask).
  5224. </p>
  5225. </dd>
  5226. <dt>&lsquo;<samp class="samp">autovariance (<em class="emph">2</em>)</samp>&rsquo;</dt>
  5227. <dd><p>Auto-variance AQ (experimental).
  5228. </p></dd>
  5229. </dl>
  5230. </dd>
  5231. <dt><samp class="option">aq-strength (<em class="emph">aq-strength</em>)</samp></dt>
  5232. <dd><p>Set AQ strength, reduce blocking and blurring in flat and textured areas.
  5233. </p>
  5234. </dd>
  5235. <dt><samp class="option">psy</samp></dt>
  5236. <dd><p>Use psychovisual optimizations when set to 1. When set to 0, it has the
  5237. same effect as <code class="command">x264</code>&rsquo;s <samp class="option">--no-psy</samp> option.
  5238. </p>
  5239. </dd>
  5240. <dt><samp class="option">psy-rd (<em class="emph">psy-rd</em>)</samp></dt>
  5241. <dd><p>Set strength of psychovisual optimization, in
  5242. <var class="var">psy-rd</var>:<var class="var">psy-trellis</var> format.
  5243. </p>
  5244. </dd>
  5245. <dt><samp class="option">rc-lookahead (<em class="emph">rc-lookahead</em>)</samp></dt>
  5246. <dd><p>Set number of frames to look ahead for frametype and ratecontrol.
  5247. </p>
  5248. </dd>
  5249. <dt><samp class="option">weightb</samp></dt>
  5250. <dd><p>Enable weighted prediction for B-frames when set to 1. When set to 0,
  5251. it has the same effect as <code class="command">x264</code>&rsquo;s <samp class="option">--no-weightb</samp> option.
  5252. </p>
  5253. </dd>
  5254. <dt><samp class="option">weightp (<em class="emph">weightp</em>)</samp></dt>
  5255. <dd><p>Set weighted prediction method for P-frames. Possible values:
  5256. </p>
  5257. <dl class="table">
  5258. <dt>&lsquo;<samp class="samp">none (<em class="emph">0</em>)</samp>&rsquo;</dt>
  5259. <dd><p>Disabled
  5260. </p></dd>
  5261. <dt>&lsquo;<samp class="samp">simple (<em class="emph">1</em>)</samp>&rsquo;</dt>
  5262. <dd><p>Enable only weighted refs
  5263. </p></dd>
  5264. <dt>&lsquo;<samp class="samp">smart (<em class="emph">2</em>)</samp>&rsquo;</dt>
  5265. <dd><p>Enable both weighted refs and duplicates
  5266. </p></dd>
  5267. </dl>
  5268. </dd>
  5269. <dt><samp class="option">ssim (<em class="emph">ssim</em>)</samp></dt>
  5270. <dd><p>Enable calculation and printing SSIM stats after the encoding.
  5271. </p>
  5272. </dd>
  5273. <dt><samp class="option">intra-refresh (<em class="emph">intra-refresh</em>)</samp></dt>
  5274. <dd><p>Enable the use of Periodic Intra Refresh instead of IDR frames when set
  5275. to 1.
  5276. </p>
  5277. </dd>
  5278. <dt><samp class="option">avcintra-class (<em class="emph">class</em>)</samp></dt>
  5279. <dd><p>Configure the encoder to generate AVC-Intra.
  5280. Valid values are 50,100 and 200
  5281. </p>
  5282. </dd>
  5283. <dt><samp class="option">bluray-compat (<em class="emph">bluray-compat</em>)</samp></dt>
  5284. <dd><p>Configure the encoder to be compatible with the bluray standard.
  5285. It is a shorthand for setting &quot;bluray-compat=1 force-cfr=1&quot;.
  5286. </p>
  5287. </dd>
  5288. <dt><samp class="option">b-bias (<em class="emph">b-bias</em>)</samp></dt>
  5289. <dd><p>Set the influence on how often B-frames are used.
  5290. </p>
  5291. </dd>
  5292. <dt><samp class="option">b-pyramid (<em class="emph">b-pyramid</em>)</samp></dt>
  5293. <dd><p>Set method for keeping of some B-frames as references. Possible values:
  5294. </p>
  5295. <dl class="table">
  5296. <dt>&lsquo;<samp class="samp">none (<em class="emph">none</em>)</samp>&rsquo;</dt>
  5297. <dd><p>Disabled.
  5298. </p></dd>
  5299. <dt>&lsquo;<samp class="samp">strict (<em class="emph">strict</em>)</samp>&rsquo;</dt>
  5300. <dd><p>Strictly hierarchical pyramid.
  5301. </p></dd>
  5302. <dt>&lsquo;<samp class="samp">normal (<em class="emph">normal</em>)</samp>&rsquo;</dt>
  5303. <dd><p>Non-strict (not Blu-ray compatible).
  5304. </p></dd>
  5305. </dl>
  5306. </dd>
  5307. <dt><samp class="option">mixed-refs</samp></dt>
  5308. <dd><p>Enable the use of one reference per partition, as opposed to one
  5309. reference per macroblock when set to 1. When set to 0, it has the
  5310. same effect as <code class="command">x264</code>&rsquo;s <samp class="option">--no-mixed-refs</samp> option.
  5311. </p>
  5312. </dd>
  5313. <dt><samp class="option">8x8dct</samp></dt>
  5314. <dd><p>Enable adaptive spatial transform (high profile 8x8 transform)
  5315. when set to 1. When set to 0, it has the same effect as
  5316. <code class="command">x264</code>&rsquo;s <samp class="option">--no-8x8dct</samp> option.
  5317. </p>
  5318. </dd>
  5319. <dt><samp class="option">fast-pskip</samp></dt>
  5320. <dd><p>Enable early SKIP detection on P-frames when set to 1. When set
  5321. to 0, it has the same effect as <code class="command">x264</code>&rsquo;s
  5322. <samp class="option">--no-fast-pskip</samp> option.
  5323. </p>
  5324. </dd>
  5325. <dt><samp class="option">aud (<em class="emph">aud</em>)</samp></dt>
  5326. <dd><p>Enable use of access unit delimiters when set to 1.
  5327. </p>
  5328. </dd>
  5329. <dt><samp class="option">mbtree</samp></dt>
  5330. <dd><p>Enable use macroblock tree ratecontrol when set to 1. When set
  5331. to 0, it has the same effect as <code class="command">x264</code>&rsquo;s
  5332. <samp class="option">--no-mbtree</samp> option.
  5333. </p>
  5334. </dd>
  5335. <dt><samp class="option">deblock (<em class="emph">deblock</em>)</samp></dt>
  5336. <dd><p>Set loop filter parameters, in <var class="var">alpha</var>:<var class="var">beta</var> form.
  5337. </p>
  5338. </dd>
  5339. <dt><samp class="option">cplxblur (<em class="emph">cplxblur</em>)</samp></dt>
  5340. <dd><p>Set fluctuations reduction in QP (before curve compression).
  5341. </p>
  5342. </dd>
  5343. <dt><samp class="option">partitions (<em class="emph">partitions</em>)</samp></dt>
  5344. <dd><p>Set partitions to consider as a comma-separated list of. Possible
  5345. values in the list:
  5346. </p>
  5347. <dl class="table">
  5348. <dt>&lsquo;<samp class="samp">p8x8</samp>&rsquo;</dt>
  5349. <dd><p>8x8 P-frame partition.
  5350. </p></dd>
  5351. <dt>&lsquo;<samp class="samp">p4x4</samp>&rsquo;</dt>
  5352. <dd><p>4x4 P-frame partition.
  5353. </p></dd>
  5354. <dt>&lsquo;<samp class="samp">b8x8</samp>&rsquo;</dt>
  5355. <dd><p>4x4 B-frame partition.
  5356. </p></dd>
  5357. <dt>&lsquo;<samp class="samp">i8x8</samp>&rsquo;</dt>
  5358. <dd><p>8x8 I-frame partition.
  5359. </p></dd>
  5360. <dt>&lsquo;<samp class="samp">i4x4</samp>&rsquo;</dt>
  5361. <dd><p>4x4 I-frame partition.
  5362. (Enabling &lsquo;<samp class="samp">p4x4</samp>&rsquo; requires &lsquo;<samp class="samp">p8x8</samp>&rsquo; to be enabled. Enabling
  5363. &lsquo;<samp class="samp">i8x8</samp>&rsquo; requires adaptive spatial transform (<samp class="option">8x8dct</samp>
  5364. option) to be enabled.)
  5365. </p></dd>
  5366. <dt>&lsquo;<samp class="samp">none (<em class="emph">none</em>)</samp>&rsquo;</dt>
  5367. <dd><p>Do not consider any partitions.
  5368. </p></dd>
  5369. <dt>&lsquo;<samp class="samp">all (<em class="emph">all</em>)</samp>&rsquo;</dt>
  5370. <dd><p>Consider every partition.
  5371. </p></dd>
  5372. </dl>
  5373. </dd>
  5374. <dt><samp class="option">direct-pred (<em class="emph">direct</em>)</samp></dt>
  5375. <dd><p>Set direct MV prediction mode. Possible values:
  5376. </p>
  5377. <dl class="table">
  5378. <dt>&lsquo;<samp class="samp">none (<em class="emph">none</em>)</samp>&rsquo;</dt>
  5379. <dd><p>Disable MV prediction.
  5380. </p></dd>
  5381. <dt>&lsquo;<samp class="samp">spatial (<em class="emph">spatial</em>)</samp>&rsquo;</dt>
  5382. <dd><p>Enable spatial predicting.
  5383. </p></dd>
  5384. <dt>&lsquo;<samp class="samp">temporal (<em class="emph">temporal</em>)</samp>&rsquo;</dt>
  5385. <dd><p>Enable temporal predicting.
  5386. </p></dd>
  5387. <dt>&lsquo;<samp class="samp">auto (<em class="emph">auto</em>)</samp>&rsquo;</dt>
  5388. <dd><p>Automatically decided.
  5389. </p></dd>
  5390. </dl>
  5391. </dd>
  5392. <dt><samp class="option">slice-max-size (<em class="emph">slice-max-size</em>)</samp></dt>
  5393. <dd><p>Set the limit of the size of each slice in bytes. If not specified
  5394. but RTP payload size (<samp class="option">ps</samp>) is specified, that is used.
  5395. </p>
  5396. </dd>
  5397. <dt><samp class="option">stats (<em class="emph">stats</em>)</samp></dt>
  5398. <dd><p>Set the file name for multi-pass stats.
  5399. </p>
  5400. </dd>
  5401. <dt><samp class="option">nal-hrd (<em class="emph">nal-hrd</em>)</samp></dt>
  5402. <dd><p>Set signal HRD information (requires <samp class="option">vbv-bufsize</samp> to be set).
  5403. Possible values:
  5404. </p>
  5405. <dl class="table">
  5406. <dt>&lsquo;<samp class="samp">none (<em class="emph">none</em>)</samp>&rsquo;</dt>
  5407. <dd><p>Disable HRD information signaling.
  5408. </p></dd>
  5409. <dt>&lsquo;<samp class="samp">vbr (<em class="emph">vbr</em>)</samp>&rsquo;</dt>
  5410. <dd><p>Variable bit rate.
  5411. </p></dd>
  5412. <dt>&lsquo;<samp class="samp">cbr (<em class="emph">cbr</em>)</samp>&rsquo;</dt>
  5413. <dd><p>Constant bit rate (not allowed in MP4 container).
  5414. </p></dd>
  5415. </dl>
  5416. </dd>
  5417. <dt><samp class="option">x264opts (N.A.)</samp></dt>
  5418. <dd><p>Set any x264 option, see <code class="command">x264 --fullhelp</code> for a list.
  5419. </p>
  5420. <p>Argument is a list of <var class="var">key</var>=<var class="var">value</var> couples separated by
  5421. &quot;:&quot;. In <var class="var">filter</var> and <var class="var">psy-rd</var> options that use &quot;:&quot; as a separator
  5422. themselves, use &quot;,&quot; instead. They accept it as well since long ago but this
  5423. is kept undocumented for some reason.
  5424. </p>
  5425. <p>For example to specify libx264 encoding options with <code class="command">ffmpeg</code>:
  5426. </p><div class="example">
  5427. <pre class="example-preformatted">ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
  5428. </pre></div>
  5429. </dd>
  5430. <dt><samp class="option">a53cc <var class="var">boolean</var></samp></dt>
  5431. <dd><p>Import closed captions (which must be ATSC compatible format) into output.
  5432. Only the mpeg2 and h264 decoders provide these. Default is 1 (on).
  5433. </p>
  5434. </dd>
  5435. <dt><samp class="option">udu_sei <var class="var">boolean</var></samp></dt>
  5436. <dd><p>Import user data unregistered SEI if available into output. Default is 0 (off).
  5437. </p>
  5438. </dd>
  5439. <dt><samp class="option">x264-params (N.A.)</samp></dt>
  5440. <dd><p>Override the x264 configuration using a :-separated list of key=value
  5441. parameters.
  5442. </p>
  5443. <p>This option is functionally the same as the <samp class="option">x264opts</samp>, but is
  5444. duplicated for compatibility with the Libav fork.
  5445. </p>
  5446. <p>For example to specify libx264 encoding options with <code class="command">ffmpeg</code>:
  5447. </p><div class="example">
  5448. <pre class="example-preformatted">ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
  5449. cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
  5450. no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
  5451. </pre></div>
  5452. </dd>
  5453. </dl>
  5454. <p>Encoding ffpresets for common usages are provided so they can be used with the
  5455. general presets system (e.g. passing the <samp class="option">pre</samp> option).
  5456. </p>
  5457. </div>
  5458. </div>
  5459. <div class="section-level-extent" id="libx265">
  5460. <h3 class="section"><span>9.16 libx265<a class="copiable-link" href="#libx265"> &para;</a></span></h3>
  5461. <p>x265 H.265/HEVC encoder wrapper.
  5462. </p>
  5463. <p>This encoder requires the presence of the libx265 headers and library
  5464. during configuration. You need to explicitly configure the build with
  5465. <samp class="option">--enable-libx265</samp>.
  5466. </p>
  5467. <ul class="mini-toc">
  5468. <li><a href="#Options-35" accesskey="1">Options</a></li>
  5469. </ul>
  5470. <div class="subsection-level-extent" id="Options-35">
  5471. <h4 class="subsection"><span>9.16.1 Options<a class="copiable-link" href="#Options-35"> &para;</a></span></h4>
  5472. <dl class="table">
  5473. <dt><samp class="option">b</samp></dt>
  5474. <dd><p>Sets target video bitrate.
  5475. </p>
  5476. </dd>
  5477. <dt><samp class="option">bf</samp></dt>
  5478. <dt><samp class="option">g</samp></dt>
  5479. <dd><p>Set the GOP size.
  5480. </p>
  5481. </dd>
  5482. <dt><samp class="option">keyint_min</samp></dt>
  5483. <dd><p>Minimum GOP size.
  5484. </p>
  5485. </dd>
  5486. <dt><samp class="option">refs</samp></dt>
  5487. <dd><p>Number of reference frames each P-frame can use. The range is from <var class="var">1-16</var>.
  5488. </p>
  5489. </dd>
  5490. <dt><samp class="option">preset</samp></dt>
  5491. <dd><p>Set the x265 preset.
  5492. </p>
  5493. </dd>
  5494. <dt><samp class="option">tune</samp></dt>
  5495. <dd><p>Set the x265 tune parameter.
  5496. </p>
  5497. </dd>
  5498. <dt><samp class="option">profile</samp></dt>
  5499. <dd><p>Set profile restrictions.
  5500. </p>
  5501. </dd>
  5502. <dt><samp class="option">crf</samp></dt>
  5503. <dd><p>Set the quality for constant quality mode.
  5504. </p>
  5505. </dd>
  5506. <dt><samp class="option">qp</samp></dt>
  5507. <dd><p>Set constant quantization rate control method parameter.
  5508. </p>
  5509. </dd>
  5510. <dt><samp class="option">qmin</samp></dt>
  5511. <dd><p>Minimum quantizer scale.
  5512. </p>
  5513. </dd>
  5514. <dt><samp class="option">qmax</samp></dt>
  5515. <dd><p>Maximum quantizer scale.
  5516. </p>
  5517. </dd>
  5518. <dt><samp class="option">qdiff</samp></dt>
  5519. <dd><p>Maximum difference between quantizer scales.
  5520. </p>
  5521. </dd>
  5522. <dt><samp class="option">qblur</samp></dt>
  5523. <dd><p>Quantizer curve blur
  5524. </p>
  5525. </dd>
  5526. <dt><samp class="option">qcomp</samp></dt>
  5527. <dd><p>Quantizer curve compression factor
  5528. </p>
  5529. </dd>
  5530. <dt><samp class="option">i_qfactor</samp></dt>
  5531. <dt><samp class="option">b_qfactor</samp></dt>
  5532. <dt><samp class="option">forced-idr</samp></dt>
  5533. <dd><p>Normally, when forcing a I-frame type, the encoder can select any type
  5534. of I-frame. This option forces it to choose an IDR-frame.
  5535. </p>
  5536. </dd>
  5537. <dt><samp class="option">udu_sei <var class="var">boolean</var></samp></dt>
  5538. <dd><p>Import user data unregistered SEI if available into output. Default is 0 (off).
  5539. </p>
  5540. </dd>
  5541. <dt><samp class="option">x265-params</samp></dt>
  5542. <dd><p>Set x265 options using a list of <var class="var">key</var>=<var class="var">value</var> couples separated
  5543. by &quot;:&quot;. See <code class="command">x265 --help</code> for a list of options.
  5544. </p>
  5545. <p>For example to specify libx265 encoding options with <samp class="option">-x265-params</samp>:
  5546. </p>
  5547. <div class="example">
  5548. <pre class="example-preformatted">ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
  5549. </pre></div>
  5550. </dd>
  5551. </dl>
  5552. </div>
  5553. </div>
  5554. <div class="section-level-extent" id="libxavs2">
  5555. <h3 class="section"><span>9.17 libxavs2<a class="copiable-link" href="#libxavs2"> &para;</a></span></h3>
  5556. <p>xavs2 AVS2-P2/IEEE1857.4 encoder wrapper.
  5557. </p>
  5558. <p>This encoder requires the presence of the libxavs2 headers and library
  5559. during configuration. You need to explicitly configure the build with
  5560. <samp class="option">--enable-libxavs2</samp>.
  5561. </p>
  5562. <p>The following standard libavcodec options are used:
  5563. </p><ul class="itemize mark-bullet">
  5564. <li><samp class="option">b</samp> / <samp class="option">bit_rate</samp>
  5565. </li><li><samp class="option">g</samp> / <samp class="option">gop_size</samp>
  5566. </li><li><samp class="option">bf</samp> / <samp class="option">max_b_frames</samp>
  5567. </li></ul>
  5568. <p>The encoder also has its own specific options:
  5569. </p><ul class="mini-toc">
  5570. <li><a href="#Options-36" accesskey="1">Options</a></li>
  5571. </ul>
  5572. <div class="subsection-level-extent" id="Options-36">
  5573. <h4 class="subsection"><span>9.17.1 Options<a class="copiable-link" href="#Options-36"> &para;</a></span></h4>
  5574. <dl class="table">
  5575. <dt><samp class="option">lcu_row_threads</samp></dt>
  5576. <dd><p>Set the number of parallel threads for rows from 1 to 8 (default 5).
  5577. </p>
  5578. </dd>
  5579. <dt><samp class="option">initial_qp</samp></dt>
  5580. <dd><p>Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  5581. used to set the initial qp for the first frame.
  5582. </p>
  5583. </dd>
  5584. <dt><samp class="option">qp</samp></dt>
  5585. <dd><p>Set the xavs2 quantization parameter from 1 to 63 (default 34). This is
  5586. used to set the qp value under constant-QP mode.
  5587. </p>
  5588. </dd>
  5589. <dt><samp class="option">max_qp</samp></dt>
  5590. <dd><p>Set the max qp for rate control from 1 to 63 (default 55).
  5591. </p>
  5592. </dd>
  5593. <dt><samp class="option">min_qp</samp></dt>
  5594. <dd><p>Set the min qp for rate control from 1 to 63 (default 20).
  5595. </p>
  5596. </dd>
  5597. <dt><samp class="option">speed_level</samp></dt>
  5598. <dd><p>Set the Speed level from 0 to 9 (default 0). Higher is better but slower.
  5599. </p>
  5600. </dd>
  5601. <dt><samp class="option">log_level</samp></dt>
  5602. <dd><p>Set the log level from -1 to 3 (default 0). -1: none, 0: error,
  5603. 1: warning, 2: info, 3: debug.
  5604. </p>
  5605. </dd>
  5606. <dt><samp class="option">xavs2-params</samp></dt>
  5607. <dd><p>Set xavs2 options using a list of <var class="var">key</var>=<var class="var">value</var> couples separated
  5608. by &quot;:&quot;.
  5609. </p>
  5610. <p>For example to specify libxavs2 encoding options with <samp class="option">-xavs2-params</samp>:
  5611. </p>
  5612. <div class="example">
  5613. <pre class="example-preformatted">ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
  5614. </pre></div>
  5615. </dd>
  5616. </dl>
  5617. </div>
  5618. </div>
  5619. <div class="section-level-extent" id="libxvid">
  5620. <h3 class="section"><span>9.18 libxvid<a class="copiable-link" href="#libxvid"> &para;</a></span></h3>
  5621. <p>Xvid MPEG-4 Part 2 encoder wrapper.
  5622. </p>
  5623. <p>This encoder requires the presence of the libxvidcore headers and library
  5624. during configuration. You need to explicitly configure the build with
  5625. <code class="code">--enable-libxvid --enable-gpl</code>.
  5626. </p>
  5627. <p>The native <code class="code">mpeg4</code> encoder supports the MPEG-4 Part 2 format, so
  5628. users can encode to this format without this library.
  5629. </p>
  5630. <ul class="mini-toc">
  5631. <li><a href="#Options-37" accesskey="1">Options</a></li>
  5632. </ul>
  5633. <div class="subsection-level-extent" id="Options-37">
  5634. <h4 class="subsection"><span>9.18.1 Options<a class="copiable-link" href="#Options-37"> &para;</a></span></h4>
  5635. <p>The following options are supported by the libxvid wrapper. Some of
  5636. the following options are listed but are not documented, and
  5637. correspond to shared codec options. See <a class="ref" href="#codec_002doptions">the Codec
  5638. Options chapter</a> for their documentation. The other shared options
  5639. which are not listed have no effect for the libxvid encoder.
  5640. </p>
  5641. <dl class="table">
  5642. <dt><samp class="option">b</samp></dt>
  5643. <dt><samp class="option">g</samp></dt>
  5644. <dt><samp class="option">qmin</samp></dt>
  5645. <dt><samp class="option">qmax</samp></dt>
  5646. <dt><samp class="option">mpeg_quant</samp></dt>
  5647. <dt><samp class="option">threads</samp></dt>
  5648. <dt><samp class="option">bf</samp></dt>
  5649. <dt><samp class="option">b_qfactor</samp></dt>
  5650. <dt><samp class="option">b_qoffset</samp></dt>
  5651. <dt><samp class="option">flags</samp></dt>
  5652. <dd><p>Set specific encoding flags. Possible values:
  5653. </p>
  5654. <dl class="table">
  5655. <dt>&lsquo;<samp class="samp">mv4</samp>&rsquo;</dt>
  5656. <dd><p>Use four motion vector by macroblock.
  5657. </p>
  5658. </dd>
  5659. <dt>&lsquo;<samp class="samp">aic</samp>&rsquo;</dt>
  5660. <dd><p>Enable high quality AC prediction.
  5661. </p>
  5662. </dd>
  5663. <dt>&lsquo;<samp class="samp">gray</samp>&rsquo;</dt>
  5664. <dd><p>Only encode grayscale.
  5665. </p>
  5666. </dd>
  5667. <dt>&lsquo;<samp class="samp">gmc</samp>&rsquo;</dt>
  5668. <dd><p>Enable the use of global motion compensation (GMC).
  5669. </p>
  5670. </dd>
  5671. <dt>&lsquo;<samp class="samp">qpel</samp>&rsquo;</dt>
  5672. <dd><p>Enable quarter-pixel motion compensation.
  5673. </p>
  5674. </dd>
  5675. <dt>&lsquo;<samp class="samp">cgop</samp>&rsquo;</dt>
  5676. <dd><p>Enable closed GOP.
  5677. </p>
  5678. </dd>
  5679. <dt>&lsquo;<samp class="samp">global_header</samp>&rsquo;</dt>
  5680. <dd><p>Place global headers in extradata instead of every keyframe.
  5681. </p>
  5682. </dd>
  5683. </dl>
  5684. </dd>
  5685. <dt><samp class="option">trellis</samp></dt>
  5686. <dt><samp class="option">me_method</samp></dt>
  5687. <dd><p>Set motion estimation method. Possible values in decreasing order of
  5688. speed and increasing order of quality:
  5689. </p>
  5690. <dl class="table">
  5691. <dt>&lsquo;<samp class="samp">zero</samp>&rsquo;</dt>
  5692. <dd><p>Use no motion estimation (default).
  5693. </p>
  5694. </dd>
  5695. <dt>&lsquo;<samp class="samp">phods</samp>&rsquo;</dt>
  5696. <dt>&lsquo;<samp class="samp">x1</samp>&rsquo;</dt>
  5697. <dt>&lsquo;<samp class="samp">log</samp>&rsquo;</dt>
  5698. <dd><p>Enable advanced diamond zonal search for 16x16 blocks and half-pixel
  5699. refinement for 16x16 blocks. &lsquo;<samp class="samp">x1</samp>&rsquo; and &lsquo;<samp class="samp">log</samp>&rsquo; are aliases for
  5700. &lsquo;<samp class="samp">phods</samp>&rsquo;.
  5701. </p>
  5702. </dd>
  5703. <dt>&lsquo;<samp class="samp">epzs</samp>&rsquo;</dt>
  5704. <dd><p>Enable all of the things described above, plus advanced diamond zonal
  5705. search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion
  5706. estimation on chroma planes.
  5707. </p>
  5708. </dd>
  5709. <dt>&lsquo;<samp class="samp">full</samp>&rsquo;</dt>
  5710. <dd><p>Enable all of the things described above, plus extended 16x16 and 8x8
  5711. blocks search.
  5712. </p></dd>
  5713. </dl>
  5714. </dd>
  5715. <dt><samp class="option">mbd</samp></dt>
  5716. <dd><p>Set macroblock decision algorithm. Possible values in the increasing
  5717. order of quality:
  5718. </p>
  5719. <dl class="table">
  5720. <dt>&lsquo;<samp class="samp">simple</samp>&rsquo;</dt>
  5721. <dd><p>Use macroblock comparing function algorithm (default).
  5722. </p>
  5723. </dd>
  5724. <dt>&lsquo;<samp class="samp">bits</samp>&rsquo;</dt>
  5725. <dd><p>Enable rate distortion-based half pixel and quarter pixel refinement for
  5726. 16x16 blocks.
  5727. </p>
  5728. </dd>
  5729. <dt>&lsquo;<samp class="samp">rd</samp>&rsquo;</dt>
  5730. <dd><p>Enable all of the things described above, plus rate distortion-based
  5731. half pixel and quarter pixel refinement for 8x8 blocks, and rate
  5732. distortion-based search using square pattern.
  5733. </p></dd>
  5734. </dl>
  5735. </dd>
  5736. <dt><samp class="option">lumi_aq</samp></dt>
  5737. <dd><p>Enable lumi masking adaptive quantization when set to 1. Default is 0
  5738. (disabled).
  5739. </p>
  5740. </dd>
  5741. <dt><samp class="option">variance_aq</samp></dt>
  5742. <dd><p>Enable variance adaptive quantization when set to 1. Default is 0
  5743. (disabled).
  5744. </p>
  5745. <p>When combined with <samp class="option">lumi_aq</samp>, the resulting quality will not
  5746. be better than any of the two specified individually. In other
  5747. words, the resulting quality will be the worse one of the two
  5748. effects.
  5749. </p>
  5750. </dd>
  5751. <dt><samp class="option">ssim</samp></dt>
  5752. <dd><p>Set structural similarity (SSIM) displaying method. Possible values:
  5753. </p>
  5754. <dl class="table">
  5755. <dt>&lsquo;<samp class="samp">off</samp>&rsquo;</dt>
  5756. <dd><p>Disable displaying of SSIM information.
  5757. </p>
  5758. </dd>
  5759. <dt>&lsquo;<samp class="samp">avg</samp>&rsquo;</dt>
  5760. <dd><p>Output average SSIM at the end of encoding to stdout. The format of
  5761. showing the average SSIM is:
  5762. </p>
  5763. <div class="example">
  5764. <pre class="example-preformatted">Average SSIM: %f
  5765. </pre></div>
  5766. <p>For users who are not familiar with C, %f means a float number, or
  5767. a decimal (e.g. 0.939232).
  5768. </p>
  5769. </dd>
  5770. <dt>&lsquo;<samp class="samp">frame</samp>&rsquo;</dt>
  5771. <dd><p>Output both per-frame SSIM data during encoding and average SSIM at
  5772. the end of encoding to stdout. The format of per-frame information
  5773. is:
  5774. </p>
  5775. <div class="example">
  5776. <pre class="example-preformatted"> SSIM: avg: %1.3f min: %1.3f max: %1.3f
  5777. </pre></div>
  5778. <p>For users who are not familiar with C, %1.3f means a float number
  5779. rounded to 3 digits after the dot (e.g. 0.932).
  5780. </p>
  5781. </dd>
  5782. </dl>
  5783. </dd>
  5784. <dt><samp class="option">ssim_acc</samp></dt>
  5785. <dd><p>Set SSIM accuracy. Valid options are integers within the range of
  5786. 0-4, while 0 gives the most accurate result and 4 computes the
  5787. fastest.
  5788. </p>
  5789. </dd>
  5790. </dl>
  5791. </div>
  5792. </div>
  5793. <div class="section-level-extent" id="MediaFoundation">
  5794. <h3 class="section"><span>9.19 MediaFoundation<a class="copiable-link" href="#MediaFoundation"> &para;</a></span></h3>
  5795. <p>This provides wrappers to encoders (both audio and video) in the
  5796. MediaFoundation framework. It can access both SW and HW encoders.
  5797. Video encoders can take input in either of nv12 or yuv420p form
  5798. (some encoders support both, some support only either - in practice,
  5799. nv12 is the safer choice, especially among HW encoders).
  5800. </p>
  5801. </div>
  5802. <div class="section-level-extent" id="mpeg2">
  5803. <h3 class="section"><span>9.20 mpeg2<a class="copiable-link" href="#mpeg2"> &para;</a></span></h3>
  5804. <p>MPEG-2 video encoder.
  5805. </p>
  5806. <ul class="mini-toc">
  5807. <li><a href="#Options-38" accesskey="1">Options</a></li>
  5808. </ul>
  5809. <div class="subsection-level-extent" id="Options-38">
  5810. <h4 class="subsection"><span>9.20.1 Options<a class="copiable-link" href="#Options-38"> &para;</a></span></h4>
  5811. <dl class="table">
  5812. <dt><samp class="option">profile</samp></dt>
  5813. <dd><p>Select the mpeg2 profile to encode:
  5814. </p>
  5815. <dl class="table">
  5816. <dt>&lsquo;<samp class="samp">422</samp>&rsquo;</dt>
  5817. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  5818. <dt>&lsquo;<samp class="samp">ss</samp>&rsquo;</dt>
  5819. <dd><p>Spatially Scalable
  5820. </p></dd>
  5821. <dt>&lsquo;<samp class="samp">snr</samp>&rsquo;</dt>
  5822. <dd><p>SNR Scalable
  5823. </p></dd>
  5824. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  5825. <dt>&lsquo;<samp class="samp">simple</samp>&rsquo;</dt>
  5826. </dl>
  5827. </dd>
  5828. <dt><samp class="option">level</samp></dt>
  5829. <dd><p>Select the mpeg2 level to encode:
  5830. </p>
  5831. <dl class="table">
  5832. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  5833. <dt>&lsquo;<samp class="samp">high1440</samp>&rsquo;</dt>
  5834. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  5835. <dt>&lsquo;<samp class="samp">low</samp>&rsquo;</dt>
  5836. </dl>
  5837. </dd>
  5838. <dt><samp class="option">seq_disp_ext <var class="var">integer</var></samp></dt>
  5839. <dd><p>Specifies if the encoder should write a sequence_display_extension to the
  5840. output.
  5841. </p><dl class="table">
  5842. <dt><samp class="option">-1</samp></dt>
  5843. <dt><samp class="option">auto</samp></dt>
  5844. <dd><p>Decide automatically to write it or not (this is the default) by checking if
  5845. the data to be written is different from the default or unspecified values.
  5846. </p></dd>
  5847. <dt><samp class="option">0</samp></dt>
  5848. <dt><samp class="option">never</samp></dt>
  5849. <dd><p>Never write it.
  5850. </p></dd>
  5851. <dt><samp class="option">1</samp></dt>
  5852. <dt><samp class="option">always</samp></dt>
  5853. <dd><p>Always write it.
  5854. </p></dd>
  5855. </dl>
  5856. </dd>
  5857. <dt><samp class="option">video_format <var class="var">integer</var></samp></dt>
  5858. <dd><p>Specifies the video_format written into the sequence display extension
  5859. indicating the source of the video pictures. The default is &lsquo;<samp class="samp">unspecified</samp>&rsquo;,
  5860. can be &lsquo;<samp class="samp">component</samp>&rsquo;, &lsquo;<samp class="samp">pal</samp>&rsquo;, &lsquo;<samp class="samp">ntsc</samp>&rsquo;, &lsquo;<samp class="samp">secam</samp>&rsquo; or &lsquo;<samp class="samp">mac</samp>&rsquo;.
  5861. For maximum compatibility, use &lsquo;<samp class="samp">component</samp>&rsquo;.
  5862. </p></dd>
  5863. <dt><samp class="option">a53cc <var class="var">boolean</var></samp></dt>
  5864. <dd><p>Import closed captions (which must be ATSC compatible format) into output.
  5865. Default is 1 (on).
  5866. </p></dd>
  5867. </dl>
  5868. </div>
  5869. </div>
  5870. <div class="section-level-extent" id="png">
  5871. <h3 class="section"><span>9.21 png<a class="copiable-link" href="#png"> &para;</a></span></h3>
  5872. <p>PNG image encoder.
  5873. </p>
  5874. <ul class="mini-toc">
  5875. <li><a href="#Private-options-1" accesskey="1">Private options</a></li>
  5876. </ul>
  5877. <div class="subsection-level-extent" id="Private-options-1">
  5878. <h4 class="subsection"><span>9.21.1 Private options<a class="copiable-link" href="#Private-options-1"> &para;</a></span></h4>
  5879. <dl class="table">
  5880. <dt><samp class="option">dpi <var class="var">integer</var></samp></dt>
  5881. <dd><p>Set physical density of pixels, in dots per inch, unset by default
  5882. </p></dd>
  5883. <dt><samp class="option">dpm <var class="var">integer</var></samp></dt>
  5884. <dd><p>Set physical density of pixels, in dots per meter, unset by default
  5885. </p></dd>
  5886. </dl>
  5887. </div>
  5888. </div>
  5889. <div class="section-level-extent" id="ProRes">
  5890. <h3 class="section"><span>9.22 ProRes<a class="copiable-link" href="#ProRes"> &para;</a></span></h3>
  5891. <p>Apple ProRes encoder.
  5892. </p>
  5893. <p>FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder.
  5894. The used encoder can be chosen with the <code class="code">-vcodec</code> option.
  5895. </p>
  5896. <ul class="mini-toc">
  5897. <li><a href="#Private-Options-for-prores_002dks" accesskey="1">Private Options for prores-ks</a></li>
  5898. <li><a href="#Speed-considerations" accesskey="2">Speed considerations</a></li>
  5899. </ul>
  5900. <div class="subsection-level-extent" id="Private-Options-for-prores_002dks">
  5901. <h4 class="subsection"><span>9.22.1 Private Options for prores-ks<a class="copiable-link" href="#Private-Options-for-prores_002dks"> &para;</a></span></h4>
  5902. <dl class="table">
  5903. <dt><samp class="option">profile <var class="var">integer</var></samp></dt>
  5904. <dd><p>Select the ProRes profile to encode
  5905. </p><dl class="table">
  5906. <dt>&lsquo;<samp class="samp">proxy</samp>&rsquo;</dt>
  5907. <dt>&lsquo;<samp class="samp">lt</samp>&rsquo;</dt>
  5908. <dt>&lsquo;<samp class="samp">standard</samp>&rsquo;</dt>
  5909. <dt>&lsquo;<samp class="samp">hq</samp>&rsquo;</dt>
  5910. <dt>&lsquo;<samp class="samp">4444</samp>&rsquo;</dt>
  5911. <dt>&lsquo;<samp class="samp">4444xq</samp>&rsquo;</dt>
  5912. </dl>
  5913. </dd>
  5914. <dt><samp class="option">quant_mat <var class="var">integer</var></samp></dt>
  5915. <dd><p>Select quantization matrix.
  5916. </p><dl class="table">
  5917. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  5918. <dt>&lsquo;<samp class="samp">default</samp>&rsquo;</dt>
  5919. <dt>&lsquo;<samp class="samp">proxy</samp>&rsquo;</dt>
  5920. <dt>&lsquo;<samp class="samp">lt</samp>&rsquo;</dt>
  5921. <dt>&lsquo;<samp class="samp">standard</samp>&rsquo;</dt>
  5922. <dt>&lsquo;<samp class="samp">hq</samp>&rsquo;</dt>
  5923. </dl>
  5924. <p>If set to <var class="var">auto</var>, the matrix matching the profile will be picked.
  5925. If not set, the matrix providing the highest quality, <var class="var">default</var>, will be
  5926. picked.
  5927. </p>
  5928. </dd>
  5929. <dt><samp class="option">bits_per_mb <var class="var">integer</var></samp></dt>
  5930. <dd><p>How many bits to allot for coding one macroblock. Different profiles use
  5931. between 200 and 2400 bits per macroblock, the maximum is 8000.
  5932. </p>
  5933. </dd>
  5934. <dt><samp class="option">mbs_per_slice <var class="var">integer</var></samp></dt>
  5935. <dd><p>Number of macroblocks in each slice (1-8); the default value (8)
  5936. should be good in almost all situations.
  5937. </p>
  5938. </dd>
  5939. <dt><samp class="option">vendor <var class="var">string</var></samp></dt>
  5940. <dd><p>Override the 4-byte vendor ID.
  5941. A custom vendor ID like <var class="var">apl0</var> would claim the stream was produced by
  5942. the Apple encoder.
  5943. </p>
  5944. </dd>
  5945. <dt><samp class="option">alpha_bits <var class="var">integer</var></samp></dt>
  5946. <dd><p>Specify number of bits for alpha component.
  5947. Possible values are <var class="var">0</var>, <var class="var">8</var> and <var class="var">16</var>.
  5948. Use <var class="var">0</var> to disable alpha plane coding.
  5949. </p>
  5950. </dd>
  5951. </dl>
  5952. </div>
  5953. <div class="subsection-level-extent" id="Speed-considerations">
  5954. <h4 class="subsection"><span>9.22.2 Speed considerations<a class="copiable-link" href="#Speed-considerations"> &para;</a></span></h4>
  5955. <p>In the default mode of operation the encoder has to honor frame constraints
  5956. (i.e. not produce frames with size bigger than requested) while still making
  5957. output picture as good as possible.
  5958. A frame containing a lot of small details is harder to compress and the encoder
  5959. would spend more time searching for appropriate quantizers for each slice.
  5960. </p>
  5961. <p>Setting a higher <samp class="option">bits_per_mb</samp> limit will improve the speed.
  5962. </p>
  5963. <p>For the fastest encoding speed set the <samp class="option">qscale</samp> parameter (4 is the
  5964. recommended value) and do not set a size constraint.
  5965. </p>
  5966. </div>
  5967. </div>
  5968. <div class="section-level-extent" id="QSV-Encoders">
  5969. <h3 class="section"><span>9.23 QSV Encoders<a class="copiable-link" href="#QSV-Encoders"> &para;</a></span></h3>
  5970. <p>The family of Intel QuickSync Video encoders (MPEG-2, H.264, HEVC, JPEG/MJPEG
  5971. and VP9)
  5972. </p>
  5973. <ul class="mini-toc">
  5974. <li><a href="#Ratecontrol-Method" accesskey="1">Ratecontrol Method</a></li>
  5975. <li><a href="#Global-Options-_002d_003e-MSDK-Options" accesskey="2">Global Options -&gt; MSDK Options</a></li>
  5976. <li><a href="#Common-Options-1" accesskey="3">Common Options</a></li>
  5977. <li><a href="#Runtime-Options" accesskey="4">Runtime Options</a></li>
  5978. <li><a href="#H264-options" accesskey="5">H264 options</a></li>
  5979. <li><a href="#HEVC-Options-1" accesskey="6">HEVC Options</a></li>
  5980. <li><a href="#MPEG2-Options" accesskey="7">MPEG2 Options</a></li>
  5981. <li><a href="#VP9-Options" accesskey="8">VP9 Options</a></li>
  5982. </ul>
  5983. <div class="subsection-level-extent" id="Ratecontrol-Method">
  5984. <h4 class="subsection"><span>9.23.1 Ratecontrol Method<a class="copiable-link" href="#Ratecontrol-Method"> &para;</a></span></h4>
  5985. <p>The ratecontrol method is selected as follows:
  5986. </p><ul class="itemize mark-bullet">
  5987. <li>When <samp class="option">global_quality</samp> is specified, a quality-based mode is used.
  5988. Specifically this means either
  5989. <ul class="itemize mark-minus">
  5990. <li><var class="var">CQP</var> - constant quantizer scale, when the <samp class="option">qscale</samp> codec flag is
  5991. also set (the <samp class="option">-qscale</samp> ffmpeg option).
  5992. </li><li><var class="var">LA_ICQ</var> - intelligent constant quality with lookahead, when the
  5993. <samp class="option">look_ahead</samp> option is also set.
  5994. </li><li><var class="var">ICQ</var> &ndash; intelligent constant quality otherwise. For the ICQ modes, global
  5995. quality range is 1 to 51, with 1 being the best quality.
  5996. </li></ul>
  5997. </li><li>Otherwise, a bitrate-based mode is used. For all of those, you should specify at
  5998. least the desired average bitrate with the <samp class="option">b</samp> option.
  5999. <ul class="itemize mark-minus">
  6000. <li><var class="var">LA</var> - VBR with lookahead, when the <samp class="option">look_ahead</samp> option is specified.
  6001. </li><li><var class="var">VCM</var> - video conferencing mode, when the <samp class="option">vcm</samp> option is set.
  6002. </li><li><var class="var">CBR</var> - constant bitrate, when <samp class="option">maxrate</samp> is specified and equal to
  6003. the average bitrate.
  6004. </li><li><var class="var">VBR</var> - variable bitrate, when <samp class="option">maxrate</samp> is specified, but is higher
  6005. than the average bitrate.
  6006. </li><li><var class="var">AVBR</var> - average VBR mode, when <samp class="option">maxrate</samp> is not specified. This mode
  6007. is further configured by the <samp class="option">avbr_accuracy</samp> and
  6008. <samp class="option">avbr_convergence</samp> options.
  6009. </li></ul>
  6010. </li></ul>
  6011. <p>Note that depending on your system, a different mode than the one you specified
  6012. may be selected by the encoder. Set the verbosity level to <var class="var">verbose</var> or
  6013. higher to see the actual settings used by the QSV runtime.
  6014. </p>
  6015. </div>
  6016. <div class="subsection-level-extent" id="Global-Options-_002d_003e-MSDK-Options">
  6017. <h4 class="subsection"><span>9.23.2 Global Options -&gt; MSDK Options<a class="copiable-link" href="#Global-Options-_002d_003e-MSDK-Options"> &para;</a></span></h4>
  6018. <p>Additional libavcodec global options are mapped to MSDK options as follows:
  6019. </p>
  6020. <ul class="itemize mark-bullet">
  6021. <li><samp class="option">g/gop_size</samp> -&gt; <samp class="option">GopPicSize</samp>
  6022. </li><li><samp class="option">bf/max_b_frames</samp>+1 -&gt; <samp class="option">GopRefDist</samp>
  6023. </li><li><samp class="option">rc_init_occupancy/rc_initial_buffer_occupancy</samp> -&gt;
  6024. <samp class="option">InitialDelayInKB</samp>
  6025. </li><li><samp class="option">slices</samp> -&gt; <samp class="option">NumSlice</samp>
  6026. </li><li><samp class="option">refs</samp> -&gt; <samp class="option">NumRefFrame</samp>
  6027. </li><li><samp class="option">b_strategy/b_frame_strategy</samp> -&gt; <samp class="option">BRefType</samp>
  6028. </li><li><samp class="option">cgop/CLOSED_GOP</samp> codec flag -&gt; <samp class="option">GopOptFlag</samp>
  6029. </li><li>For the <var class="var">CQP</var> mode, the <samp class="option">i_qfactor/i_qoffset</samp> and
  6030. <samp class="option">b_qfactor/b_qoffset</samp> set the difference between <var class="var">QPP</var> and <var class="var">QPI</var>,
  6031. and <var class="var">QPP</var> and <var class="var">QPB</var> respectively.
  6032. </li><li>Setting the <samp class="option">coder</samp> option to the value <var class="var">vlc</var> will make the H.264
  6033. encoder use CAVLC instead of CABAC.
  6034. </li></ul>
  6035. </div>
  6036. <div class="subsection-level-extent" id="Common-Options-1">
  6037. <h4 class="subsection"><span>9.23.3 Common Options<a class="copiable-link" href="#Common-Options-1"> &para;</a></span></h4>
  6038. <p>Following options are used by all qsv encoders.
  6039. </p>
  6040. <dl class="table">
  6041. <dt><samp class="option"><var class="var">async_depth</var></samp></dt>
  6042. <dd><p>Specifies how many asynchronous operations an application performs
  6043. before the application explicitly synchronizes the result. If zero,
  6044. the value is not specified.
  6045. </p>
  6046. </dd>
  6047. <dt><samp class="option"><var class="var">avbr_accuracy</var></samp></dt>
  6048. <dd><p>Accuracy of the AVBR ratecontrol (unit of tenth of percent).
  6049. </p>
  6050. </dd>
  6051. <dt><samp class="option"><var class="var">avbr_convergence</var></samp></dt>
  6052. <dd><p>Convergence of the AVBR ratecontrol (unit of 100 frames)
  6053. </p>
  6054. <p>The parameters <var class="var">avbr_accuracy</var> and <var class="var">avbr_convergence</var> are for the
  6055. average variable bitrate control (AVBR) algorithm.
  6056. The algorithm focuses on overall encoding quality while meeting the specified
  6057. bitrate, <var class="var">target_bitrate</var>, within the accuracy range <var class="var">avbr_accuracy</var>,
  6058. after a <var class="var">avbr_Convergence</var> period. This method does not follow HRD and the
  6059. instant bitrate is not capped or padded.
  6060. </p>
  6061. </dd>
  6062. <dt><samp class="option"><var class="var">preset</var></samp></dt>
  6063. <dd><p>This option itemizes a range of choices from veryfast (best speed) to veryslow
  6064. (best quality).
  6065. </p><dl class="table">
  6066. <dt>&lsquo;<samp class="samp">veryfast</samp>&rsquo;</dt>
  6067. <dt>&lsquo;<samp class="samp">faster</samp>&rsquo;</dt>
  6068. <dt>&lsquo;<samp class="samp">fast</samp>&rsquo;</dt>
  6069. <dt>&lsquo;<samp class="samp">medium</samp>&rsquo;</dt>
  6070. <dt>&lsquo;<samp class="samp">slow</samp>&rsquo;</dt>
  6071. <dt>&lsquo;<samp class="samp">slower</samp>&rsquo;</dt>
  6072. <dt>&lsquo;<samp class="samp">veryslow</samp>&rsquo;</dt>
  6073. </dl>
  6074. </dd>
  6075. <dt><samp class="option"><var class="var">forced_idr</var></samp></dt>
  6076. <dd><p>Forcing I frames as IDR frames.
  6077. </p>
  6078. </dd>
  6079. <dt><samp class="option"><var class="var">low_power</var></samp></dt>
  6080. <dd><p>For encoders set this flag to ON to reduce power consumption and GPU usage.
  6081. </p></dd>
  6082. </dl>
  6083. </div>
  6084. <div class="subsection-level-extent" id="Runtime-Options">
  6085. <h4 class="subsection"><span>9.23.4 Runtime Options<a class="copiable-link" href="#Runtime-Options"> &para;</a></span></h4>
  6086. <p>Following options can be used durning qsv encoding.
  6087. </p>
  6088. <dl class="table">
  6089. <dt><samp class="option"><var class="var">qsv_config_qp</var></samp></dt>
  6090. <dd><p>Supported in h264_qsv and hevc_qsv.
  6091. This option can be set in per-frame metadata. QP parameter can be dynamically
  6092. changed when encoding in CQP mode.
  6093. </p></dd>
  6094. </dl>
  6095. </div>
  6096. <div class="subsection-level-extent" id="H264-options">
  6097. <h4 class="subsection"><span>9.23.5 H264 options<a class="copiable-link" href="#H264-options"> &para;</a></span></h4>
  6098. <p>These options are used by h264_qsv
  6099. </p>
  6100. <dl class="table">
  6101. <dt><samp class="option"><var class="var">extbrc</var></samp></dt>
  6102. <dd><p>Extended bitrate control.
  6103. </p>
  6104. </dd>
  6105. <dt><samp class="option"><var class="var">recovery_point_sei</var></samp></dt>
  6106. <dd><p>Set this flag to insert the recovery point SEI message at the beginning of every
  6107. intra refresh cycle.
  6108. </p>
  6109. </dd>
  6110. <dt><samp class="option"><var class="var">rdo</var></samp></dt>
  6111. <dd><p>Enable rate distortion optimization.
  6112. </p>
  6113. </dd>
  6114. <dt><samp class="option"><var class="var">max_frame_size</var></samp></dt>
  6115. <dd><p>Maximum encoded frame size in bytes.
  6116. </p>
  6117. </dd>
  6118. <dt><samp class="option"><var class="var">max_frame_size_i</var></samp></dt>
  6119. <dd><p>Maximum encoded frame size for I frames in bytes. If this value is set as larger
  6120. than zero, then for I frames the value set by max_frame_size is ignored.
  6121. </p>
  6122. </dd>
  6123. <dt><samp class="option"><var class="var">max_frame_size_p</var></samp></dt>
  6124. <dd><p>Maximum encoded frame size for P frames in bytes. If this value is set as larger
  6125. than zero, then for P frames the value set by max_frame_size is ignored.
  6126. </p>
  6127. </dd>
  6128. <dt><samp class="option"><var class="var">max_slice_size</var></samp></dt>
  6129. <dd><p>Maximum encoded slice size in bytes.
  6130. </p>
  6131. </dd>
  6132. <dt><samp class="option"><var class="var">bitrate_limit</var></samp></dt>
  6133. <dd><p>Toggle bitrate limitations.
  6134. Modifies bitrate to be in the range imposed by the QSV encoder. Setting this
  6135. flag off may lead to violation of HRD conformance. Mind that specifying bitrate
  6136. below the QSV encoder range might significantly affect quality. If on this
  6137. option takes effect in non CQP modes: if bitrate is not in the range imposed
  6138. by the QSV encoder, it will be changed to be in the range.
  6139. </p>
  6140. </dd>
  6141. <dt><samp class="option"><var class="var">mbbrc</var></samp></dt>
  6142. <dd><p>Setting this flag enables macroblock level bitrate control that generally
  6143. improves subjective visual quality. Enabling this flag may have negative impact
  6144. on performance and objective visual quality metric.
  6145. </p>
  6146. </dd>
  6147. <dt><samp class="option"><var class="var">low_delay_brc</var></samp></dt>
  6148. <dd><p>Setting this flag turns on or off LowDelayBRC feautre in qsv plugin, which provides
  6149. more accurate bitrate control to minimize the variance of bitstream size frame
  6150. by frame. Value: -1-default 0-off 1-on
  6151. </p>
  6152. </dd>
  6153. <dt><samp class="option"><var class="var">adaptive_i</var></samp></dt>
  6154. <dd><p>This flag controls insertion of I frames by the QSV encoder. Turn ON this flag
  6155. to allow changing of frame type from P and B to I.
  6156. </p>
  6157. </dd>
  6158. <dt><samp class="option"><var class="var">adaptive_b</var></samp></dt>
  6159. <dd><p>This flag controls changing of frame type from B to P.
  6160. </p>
  6161. </dd>
  6162. <dt><samp class="option"><var class="var">p_strategy</var></samp></dt>
  6163. <dd><p>Enable P-pyramid: 0-default 1-simple 2-pyramid(bf need to be set to 0).
  6164. </p>
  6165. </dd>
  6166. <dt><samp class="option"><var class="var">b_strategy</var></samp></dt>
  6167. <dd><p>This option controls usage of B frames as reference.
  6168. </p>
  6169. </dd>
  6170. <dt><samp class="option"><var class="var">dblk_idc</var></samp></dt>
  6171. <dd><p>This option disable deblocking. It has value in range 0~2.
  6172. </p>
  6173. </dd>
  6174. <dt><samp class="option"><var class="var">cavlc</var></samp></dt>
  6175. <dd><p>If set, CAVLC is used; if unset, CABAC is used for encoding.
  6176. </p>
  6177. </dd>
  6178. <dt><samp class="option"><var class="var">vcm</var></samp></dt>
  6179. <dd><p>Video conferencing mode, please see ratecontrol method.
  6180. </p>
  6181. </dd>
  6182. <dt><samp class="option"><var class="var">idr_interval</var></samp></dt>
  6183. <dd><p>Distance (in I-frames) between IDR frames.
  6184. </p>
  6185. </dd>
  6186. <dt><samp class="option"><var class="var">pic_timing_sei</var></samp></dt>
  6187. <dd><p>Insert picture timing SEI with pic_struct_syntax element.
  6188. </p>
  6189. </dd>
  6190. <dt><samp class="option"><var class="var">single_sei_nal_unit</var></samp></dt>
  6191. <dd><p>Put all the SEI messages into one NALU.
  6192. </p>
  6193. </dd>
  6194. <dt><samp class="option"><var class="var">max_dec_frame_buffering</var></samp></dt>
  6195. <dd><p>Maximum number of frames buffered in the DPB.
  6196. </p>
  6197. </dd>
  6198. <dt><samp class="option"><var class="var">look_ahead</var></samp></dt>
  6199. <dd><p>Use VBR algorithm with look ahead.
  6200. </p>
  6201. </dd>
  6202. <dt><samp class="option"><var class="var">look_ahead_depth</var></samp></dt>
  6203. <dd><p>Depth of look ahead in number frames.
  6204. </p>
  6205. </dd>
  6206. <dt><samp class="option"><var class="var">look_ahead_downsampling</var></samp></dt>
  6207. <dd><p>Downscaling factor for the frames saved for the lookahead analysis.
  6208. </p><dl class="table">
  6209. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  6210. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  6211. <dt>&lsquo;<samp class="samp">off</samp>&rsquo;</dt>
  6212. <dt>&lsquo;<samp class="samp">2x</samp>&rsquo;</dt>
  6213. <dt>&lsquo;<samp class="samp">4x</samp>&rsquo;</dt>
  6214. </dl>
  6215. </dd>
  6216. <dt><samp class="option"><var class="var">int_ref_type</var></samp></dt>
  6217. <dd><p>Specifies intra refresh type. The major goal of intra refresh is improvement of
  6218. error resilience without significant impact on encoded bitstream size caused by
  6219. I frames. The SDK encoder achieves this by encoding part of each frame in
  6220. refresh cycle using intra MBs. <var class="var">none</var> means no refresh. <var class="var">vertical</var> means
  6221. vertical refresh, by column of MBs. To enable intra refresh, B frame should be
  6222. set to 0.
  6223. </p>
  6224. </dd>
  6225. <dt><samp class="option"><var class="var">int_ref_cycle_size</var></samp></dt>
  6226. <dd><p>Specifies number of pictures within refresh cycle starting from 2. 0 and 1 are
  6227. invalid values.
  6228. </p>
  6229. </dd>
  6230. <dt><samp class="option"><var class="var">int_ref_qp_delta</var></samp></dt>
  6231. <dd><p>Specifies QP difference for inserted intra MBs. This is signed value in
  6232. [-51, 51] range if target encoding bit-depth for luma samples is 8 and this
  6233. range is [-63, 63] for 10 bit-depth or [-75, 75] for 12 bit-depth respectively.
  6234. </p>
  6235. </dd>
  6236. <dt><samp class="option"><var class="var">int_ref_cycle_dist</var></samp></dt>
  6237. <dd><p>Distance between the beginnings of the intra-refresh cycles in frames.
  6238. </p>
  6239. </dd>
  6240. <dt><samp class="option"><var class="var">profile</var></samp></dt>
  6241. <dd><dl class="table">
  6242. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  6243. <dt>&lsquo;<samp class="samp">baseline</samp>&rsquo;</dt>
  6244. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  6245. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  6246. </dl>
  6247. </dd>
  6248. <dt><samp class="option"><var class="var">a53cc</var></samp></dt>
  6249. <dd><p>Use A53 Closed Captions (if available).
  6250. </p>
  6251. </dd>
  6252. <dt><samp class="option"><var class="var">aud</var></samp></dt>
  6253. <dd><p>Insert the Access Unit Delimiter NAL.
  6254. </p>
  6255. </dd>
  6256. <dt><samp class="option"><var class="var">mfmode</var></samp></dt>
  6257. <dd><p>Multi-Frame Mode.
  6258. </p><dl class="table">
  6259. <dt>&lsquo;<samp class="samp">off</samp>&rsquo;</dt>
  6260. <dt>&lsquo;<samp class="samp">auto</samp>&rsquo;</dt>
  6261. </dl>
  6262. </dd>
  6263. <dt><samp class="option"><var class="var">repeat_pps</var></samp></dt>
  6264. <dd><p>Repeat pps for every frame.
  6265. </p>
  6266. </dd>
  6267. <dt><samp class="option"><var class="var">max_qp_i</var></samp></dt>
  6268. <dd><p>Maximum video quantizer scale for I frame.
  6269. </p>
  6270. </dd>
  6271. <dt><samp class="option"><var class="var">min_qp_i</var></samp></dt>
  6272. <dd><p>Minimum video quantizer scale for I frame.
  6273. </p>
  6274. </dd>
  6275. <dt><samp class="option"><var class="var">max_qp_p</var></samp></dt>
  6276. <dd><p>Maximum video quantizer scale for P frame.
  6277. </p>
  6278. </dd>
  6279. <dt><samp class="option"><var class="var">min_qp_p</var></samp></dt>
  6280. <dd><p>Minimum video quantizer scale for P frame.
  6281. </p>
  6282. </dd>
  6283. <dt><samp class="option"><var class="var">max_qp_b</var></samp></dt>
  6284. <dd><p>Maximum video quantizer scale for B frame.
  6285. </p>
  6286. </dd>
  6287. <dt><samp class="option"><var class="var">min_qp_b</var></samp></dt>
  6288. <dd><p>Minimum video quantizer scale for B frame.
  6289. </p></dd>
  6290. </dl>
  6291. </div>
  6292. <div class="subsection-level-extent" id="HEVC-Options-1">
  6293. <h4 class="subsection"><span>9.23.6 HEVC Options<a class="copiable-link" href="#HEVC-Options-1"> &para;</a></span></h4>
  6294. <p>These options are used by hevc_qsv
  6295. </p>
  6296. <dl class="table">
  6297. <dt><samp class="option"><var class="var">extbrc</var></samp></dt>
  6298. <dd><p>Extended bitrate control.
  6299. </p>
  6300. </dd>
  6301. <dt><samp class="option"><var class="var">recovery_point_sei</var></samp></dt>
  6302. <dd><p>Set this flag to insert the recovery point SEI message at the beginning of every
  6303. intra refresh cycle.
  6304. </p>
  6305. </dd>
  6306. <dt><samp class="option"><var class="var">rdo</var></samp></dt>
  6307. <dd><p>Enable rate distortion optimization.
  6308. </p>
  6309. </dd>
  6310. <dt><samp class="option"><var class="var">max_frame_size</var></samp></dt>
  6311. <dd><p>Maximum encoded frame size in bytes.
  6312. </p>
  6313. </dd>
  6314. <dt><samp class="option"><var class="var">max_frame_size_i</var></samp></dt>
  6315. <dd><p>Maximum encoded frame size for I frames in bytes. If this value is set as larger
  6316. than zero, then for I frames the value set by max_frame_size is ignored.
  6317. </p>
  6318. </dd>
  6319. <dt><samp class="option"><var class="var">max_frame_size_p</var></samp></dt>
  6320. <dd><p>Maximum encoded frame size for P frames in bytes. If this value is set as larger
  6321. than zero, then for P frames the value set by max_frame_size is ignored.
  6322. </p>
  6323. </dd>
  6324. <dt><samp class="option"><var class="var">max_slice_size</var></samp></dt>
  6325. <dd><p>Maximum encoded slice size in bytes.
  6326. </p>
  6327. </dd>
  6328. <dt><samp class="option"><var class="var">mbbrc</var></samp></dt>
  6329. <dd><p>Setting this flag enables macroblock level bitrate control that generally
  6330. improves subjective visual quality. Enabling this flag may have negative impact
  6331. on performance and objective visual quality metric.
  6332. </p>
  6333. </dd>
  6334. <dt><samp class="option"><var class="var">low_delay_brc</var></samp></dt>
  6335. <dd><p>Setting this flag turns on or off LowDelayBRC feautre in qsv plugin, which provides
  6336. more accurate bitrate control to minimize the variance of bitstream size frame
  6337. by frame. Value: -1-default 0-off 1-on
  6338. </p>
  6339. </dd>
  6340. <dt><samp class="option"><var class="var">p_strategy</var></samp></dt>
  6341. <dd><p>Enable P-pyramid: 0-default 1-simple 2-pyramid(bf need to be set to 0).
  6342. </p>
  6343. </dd>
  6344. <dt><samp class="option"><var class="var">b_strategy</var></samp></dt>
  6345. <dd><p>This option controls usage of B frames as reference.
  6346. </p>
  6347. </dd>
  6348. <dt><samp class="option"><var class="var">dblk_idc</var></samp></dt>
  6349. <dd><p>This option disable deblocking. It has value in range 0~2.
  6350. </p>
  6351. </dd>
  6352. <dt><samp class="option"><var class="var">idr_interval</var></samp></dt>
  6353. <dd><p>Distance (in I-frames) between IDR frames.
  6354. </p><dl class="table">
  6355. <dt>&lsquo;<samp class="samp">begin_only</samp>&rsquo;</dt>
  6356. <dd><p>Output an IDR-frame only at the beginning of the stream.
  6357. </p></dd>
  6358. </dl>
  6359. </dd>
  6360. <dt><samp class="option"><var class="var">load_plugin</var></samp></dt>
  6361. <dd><p>A user plugin to load in an internal session.
  6362. </p><dl class="table">
  6363. <dt>&lsquo;<samp class="samp">none</samp>&rsquo;</dt>
  6364. <dt>&lsquo;<samp class="samp">hevc_sw</samp>&rsquo;</dt>
  6365. <dt>&lsquo;<samp class="samp">hevc_hw</samp>&rsquo;</dt>
  6366. </dl>
  6367. </dd>
  6368. <dt><samp class="option"><var class="var">load_plugins</var></samp></dt>
  6369. <dd><p>A :-separate list of hexadecimal plugin UIDs to load in
  6370. an internal session.
  6371. </p>
  6372. </dd>
  6373. <dt><samp class="option"><var class="var">look_ahead_depth</var></samp></dt>
  6374. <dd><p>Depth of look ahead in number frames, available when extbrc option is enabled.
  6375. </p>
  6376. </dd>
  6377. <dt><samp class="option"><var class="var">profile</var></samp></dt>
  6378. <dd><p>Set the encoding profile (scc requires libmfx &gt;= 1.32).
  6379. </p>
  6380. <dl class="table">
  6381. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  6382. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  6383. <dt>&lsquo;<samp class="samp">main10</samp>&rsquo;</dt>
  6384. <dt>&lsquo;<samp class="samp">mainsp</samp>&rsquo;</dt>
  6385. <dt>&lsquo;<samp class="samp">rext</samp>&rsquo;</dt>
  6386. <dt>&lsquo;<samp class="samp">scc</samp>&rsquo;</dt>
  6387. </dl>
  6388. </dd>
  6389. <dt><samp class="option"><var class="var">gpb</var></samp></dt>
  6390. <dd><p>1: GPB (generalized P/B frame)
  6391. </p>
  6392. <p>0: regular P frame.
  6393. </p>
  6394. </dd>
  6395. <dt><samp class="option"><var class="var">tile_cols</var></samp></dt>
  6396. <dd><p>Number of columns for tiled encoding.
  6397. </p>
  6398. </dd>
  6399. <dt><samp class="option"><var class="var">tile_rows</var></samp></dt>
  6400. <dd><p>Number of rows for tiled encoding.
  6401. </p>
  6402. </dd>
  6403. <dt><samp class="option"><var class="var">aud</var></samp></dt>
  6404. <dd><p>Insert the Access Unit Delimiter NAL.
  6405. </p>
  6406. </dd>
  6407. <dt><samp class="option"><var class="var">pic_timing_sei</var></samp></dt>
  6408. <dd><p>Insert picture timing SEI with pic_struct_syntax element.
  6409. </p>
  6410. </dd>
  6411. <dt><samp class="option"><var class="var">transform_skip</var></samp></dt>
  6412. <dd><p>Turn this option ON to enable transformskip. It is supported on platform equal
  6413. or newer than ICL.
  6414. </p>
  6415. </dd>
  6416. <dt><samp class="option"><var class="var">int_ref_type</var></samp></dt>
  6417. <dd><p>Specifies intra refresh type. The major goal of intra refresh is improvement of
  6418. error resilience without significant impact on encoded bitstream size caused by
  6419. I frames. The SDK encoder achieves this by encoding part of each frame in
  6420. refresh cycle using intra MBs. <var class="var">none</var> means no refresh. <var class="var">vertical</var> means
  6421. vertical refresh, by column of MBs. To enable intra refresh, B frame should be
  6422. set to 0.
  6423. </p>
  6424. </dd>
  6425. <dt><samp class="option"><var class="var">int_ref_cycle_size</var></samp></dt>
  6426. <dd><p>Specifies number of pictures within refresh cycle starting from 2. 0 and 1 are
  6427. invalid values.
  6428. </p>
  6429. </dd>
  6430. <dt><samp class="option"><var class="var">int_ref_qp_delta</var></samp></dt>
  6431. <dd><p>Specifies QP difference for inserted intra MBs. This is signed value in
  6432. [-51, 51] range if target encoding bit-depth for luma samples is 8 and this
  6433. range is [-63, 63] for 10 bit-depth or [-75, 75] for 12 bit-depth respectively.
  6434. </p>
  6435. </dd>
  6436. <dt><samp class="option"><var class="var">int_ref_cycle_dist</var></samp></dt>
  6437. <dd><p>Distance between the beginnings of the intra-refresh cycles in frames.
  6438. </p>
  6439. </dd>
  6440. <dt><samp class="option"><var class="var">max_qp_i</var></samp></dt>
  6441. <dd><p>Maximum video quantizer scale for I frame.
  6442. </p>
  6443. </dd>
  6444. <dt><samp class="option"><var class="var">min_qp_i</var></samp></dt>
  6445. <dd><p>Minimum video quantizer scale for I frame.
  6446. </p>
  6447. </dd>
  6448. <dt><samp class="option"><var class="var">max_qp_p</var></samp></dt>
  6449. <dd><p>Maximum video quantizer scale for P frame.
  6450. </p>
  6451. </dd>
  6452. <dt><samp class="option"><var class="var">min_qp_p</var></samp></dt>
  6453. <dd><p>Minimum video quantizer scale for P frame.
  6454. </p>
  6455. </dd>
  6456. <dt><samp class="option"><var class="var">max_qp_b</var></samp></dt>
  6457. <dd><p>Maximum video quantizer scale for B frame.
  6458. </p>
  6459. </dd>
  6460. <dt><samp class="option"><var class="var">min_qp_b</var></samp></dt>
  6461. <dd><p>Minimum video quantizer scale for B frame.
  6462. </p></dd>
  6463. </dl>
  6464. </div>
  6465. <div class="subsection-level-extent" id="MPEG2-Options">
  6466. <h4 class="subsection"><span>9.23.7 MPEG2 Options<a class="copiable-link" href="#MPEG2-Options"> &para;</a></span></h4>
  6467. <p>These options are used by mpeg2_qsv
  6468. </p><dl class="table">
  6469. <dt><samp class="option"><var class="var">profile</var></samp></dt>
  6470. <dd><dl class="table">
  6471. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  6472. <dt>&lsquo;<samp class="samp">simple</samp>&rsquo;</dt>
  6473. <dt>&lsquo;<samp class="samp">main</samp>&rsquo;</dt>
  6474. <dt>&lsquo;<samp class="samp">high</samp>&rsquo;</dt>
  6475. </dl>
  6476. </dd>
  6477. </dl>
  6478. </div>
  6479. <div class="subsection-level-extent" id="VP9-Options">
  6480. <h4 class="subsection"><span>9.23.8 VP9 Options<a class="copiable-link" href="#VP9-Options"> &para;</a></span></h4>
  6481. <p>These options are used by vp9_qsv
  6482. </p><dl class="table">
  6483. <dt><samp class="option"><var class="var">profile</var></samp></dt>
  6484. <dd><dl class="table">
  6485. <dt>&lsquo;<samp class="samp">unknown</samp>&rsquo;</dt>
  6486. <dt>&lsquo;<samp class="samp">profile0</samp>&rsquo;</dt>
  6487. <dt>&lsquo;<samp class="samp">profile1</samp>&rsquo;</dt>
  6488. <dt>&lsquo;<samp class="samp">profile2</samp>&rsquo;</dt>
  6489. <dt>&lsquo;<samp class="samp">profile3</samp>&rsquo;</dt>
  6490. </dl>
  6491. </dd>
  6492. <dt><samp class="option"><var class="var">tile_cols</var></samp></dt>
  6493. <dd><p>Number of columns for tiled encoding (requires libmfx &gt;= 1.29).
  6494. </p>
  6495. </dd>
  6496. <dt><samp class="option"><var class="var">tile_rows</var></samp></dt>
  6497. <dd><p>Number of rows for tiled encoding (requires libmfx &gt;= 1.29).
  6498. </p></dd>
  6499. </dl>
  6500. </div>
  6501. </div>
  6502. <div class="section-level-extent" id="snow">
  6503. <h3 class="section"><span>9.24 snow<a class="copiable-link" href="#snow"> &para;</a></span></h3>
  6504. <ul class="mini-toc">
  6505. <li><a href="#Options-39" accesskey="1">Options</a></li>
  6506. </ul>
  6507. <div class="subsection-level-extent" id="Options-39">
  6508. <h4 class="subsection"><span>9.24.1 Options<a class="copiable-link" href="#Options-39"> &para;</a></span></h4>
  6509. <dl class="table">
  6510. <dt><samp class="option">iterative_dia_size</samp></dt>
  6511. <dd><p>dia size for the iterative motion estimation
  6512. </p></dd>
  6513. </dl>
  6514. </div>
  6515. </div>
  6516. <div class="section-level-extent" id="VAAPI-encoders">
  6517. <h3 class="section"><span>9.25 VAAPI encoders<a class="copiable-link" href="#VAAPI-encoders"> &para;</a></span></h3>
  6518. <p>Wrappers for hardware encoders accessible via VAAPI.
  6519. </p>
  6520. <p>These encoders only accept input in VAAPI hardware surfaces. If you have input
  6521. in software frames, use the <samp class="option">hwupload</samp> filter to upload them to the GPU.
  6522. </p>
  6523. <p>The following standard libavcodec options are used:
  6524. </p><ul class="itemize mark-bullet">
  6525. <li><samp class="option">g</samp> / <samp class="option">gop_size</samp>
  6526. </li><li><samp class="option">bf</samp> / <samp class="option">max_b_frames</samp>
  6527. </li><li><samp class="option">profile</samp>
  6528. <p>If not set, this will be determined automatically from the format of the input
  6529. frames and the profiles supported by the driver.
  6530. </p></li><li><samp class="option">level</samp>
  6531. </li><li><samp class="option">b</samp> / <samp class="option">bit_rate</samp>
  6532. </li><li><samp class="option">maxrate</samp> / <samp class="option">rc_max_rate</samp>
  6533. </li><li><samp class="option">bufsize</samp> / <samp class="option">rc_buffer_size</samp>
  6534. </li><li><samp class="option">rc_init_occupancy</samp> / <samp class="option">rc_initial_buffer_occupancy</samp>
  6535. </li><li><samp class="option">compression_level</samp>
  6536. <p>Speed / quality tradeoff: higher values are faster / worse quality.
  6537. </p></li><li><samp class="option">q</samp> / <samp class="option">global_quality</samp>
  6538. <p>Size / quality tradeoff: higher values are smaller / worse quality.
  6539. </p></li><li><samp class="option">qmin</samp>
  6540. </li><li><samp class="option">qmax</samp>
  6541. </li><li><samp class="option">i_qfactor</samp> / <samp class="option">i_quant_factor</samp>
  6542. </li><li><samp class="option">i_qoffset</samp> / <samp class="option">i_quant_offset</samp>
  6543. </li><li><samp class="option">b_qfactor</samp> / <samp class="option">b_quant_factor</samp>
  6544. </li><li><samp class="option">b_qoffset</samp> / <samp class="option">b_quant_offset</samp>
  6545. </li><li><samp class="option">slices</samp>
  6546. </li></ul>
  6547. <p>All encoders support the following options:
  6548. </p><dl class="table">
  6549. <dt><samp class="option">low_power</samp></dt>
  6550. <dd><p>Some drivers/platforms offer a second encoder for some codecs intended to use
  6551. less power than the default encoder; setting this option will attempt to use
  6552. that encoder. Note that it may support a reduced feature set, so some other
  6553. options may not be available in this mode.
  6554. </p>
  6555. </dd>
  6556. <dt><samp class="option">idr_interval</samp></dt>
  6557. <dd><p>Set the number of normal intra frames between full-refresh (IDR) frames in
  6558. open-GOP mode. The intra frames are still IRAPs, but will not include global
  6559. headers and may have non-decodable leading pictures.
  6560. </p>
  6561. </dd>
  6562. <dt><samp class="option">b_depth</samp></dt>
  6563. <dd><p>Set the B-frame reference depth. When set to one (the default), all B-frames
  6564. will refer only to P- or I-frames. When set to greater values multiple layers
  6565. of B-frames will be present, frames in each layer only referring to frames in
  6566. higher layers.
  6567. </p>
  6568. </dd>
  6569. <dt><samp class="option">async_depth</samp></dt>
  6570. <dd><p>Maximum processing parallelism. Increase this to improve single channel
  6571. performance. This option doesn&rsquo;t work if driver doesn&rsquo;t implement vaSyncBuffer
  6572. function. Please make sure there are enough hw_frames allocated if a large
  6573. number of async_depth is used.
  6574. </p>
  6575. </dd>
  6576. <dt><samp class="option">max_frame_size</samp></dt>
  6577. <dd><p>Set the allowed max size in bytes for each frame. If the frame size exceeds
  6578. the limitation, encoder will adjust the QP value to control the frame size.
  6579. Invalid in CQP rate control mode.
  6580. </p>
  6581. </dd>
  6582. <dt><samp class="option">rc_mode</samp></dt>
  6583. <dd><p>Set the rate control mode to use. A given driver may only support a subset of
  6584. modes.
  6585. </p>
  6586. <p>Possible modes:
  6587. </p><dl class="table">
  6588. <dt><samp class="option">auto</samp></dt>
  6589. <dd><p>Choose the mode automatically based on driver support and the other options.
  6590. This is the default.
  6591. </p></dd>
  6592. <dt><samp class="option">CQP</samp></dt>
  6593. <dd><p>Constant-quality.
  6594. </p></dd>
  6595. <dt><samp class="option">CBR</samp></dt>
  6596. <dd><p>Constant-bitrate.
  6597. </p></dd>
  6598. <dt><samp class="option">VBR</samp></dt>
  6599. <dd><p>Variable-bitrate.
  6600. </p></dd>
  6601. <dt><samp class="option">ICQ</samp></dt>
  6602. <dd><p>Intelligent constant-quality.
  6603. </p></dd>
  6604. <dt><samp class="option">QVBR</samp></dt>
  6605. <dd><p>Quality-defined variable-bitrate.
  6606. </p></dd>
  6607. <dt><samp class="option">AVBR</samp></dt>
  6608. <dd><p>Average variable bitrate.
  6609. </p></dd>
  6610. </dl>
  6611. </dd>
  6612. </dl>
  6613. <p>Each encoder also has its own specific options:
  6614. </p><dl class="table">
  6615. <dt><samp class="option">h264_vaapi</samp></dt>
  6616. <dd><p><samp class="option">profile</samp> sets the value of <em class="emph">profile_idc</em> and the <em class="emph">constraint_set*_flag</em>s.
  6617. <samp class="option">level</samp> sets the value of <em class="emph">level_idc</em>.
  6618. </p>
  6619. <dl class="table">
  6620. <dt><samp class="option">coder</samp></dt>
  6621. <dd><p>Set entropy encoder (default is <em class="emph">cabac</em>). Possible values:
  6622. </p>
  6623. <dl class="table">
  6624. <dt>&lsquo;<samp class="samp">ac</samp>&rsquo;</dt>
  6625. <dt>&lsquo;<samp class="samp">cabac</samp>&rsquo;</dt>
  6626. <dd><p>Use CABAC.
  6627. </p>
  6628. </dd>
  6629. <dt>&lsquo;<samp class="samp">vlc</samp>&rsquo;</dt>
  6630. <dt>&lsquo;<samp class="samp">cavlc</samp>&rsquo;</dt>
  6631. <dd><p>Use CAVLC.
  6632. </p></dd>
  6633. </dl>
  6634. </dd>
  6635. <dt><samp class="option">aud</samp></dt>
  6636. <dd><p>Include access unit delimiters in the stream (not included by default).
  6637. </p>
  6638. </dd>
  6639. <dt><samp class="option">sei</samp></dt>
  6640. <dd><p>Set SEI message types to include.
  6641. Some combination of the following values:
  6642. </p><dl class="table">
  6643. <dt>&lsquo;<samp class="samp">identifier</samp>&rsquo;</dt>
  6644. <dd><p>Include a <em class="emph">user_data_unregistered</em> message containing information about
  6645. the encoder.
  6646. </p></dd>
  6647. <dt>&lsquo;<samp class="samp">timing</samp>&rsquo;</dt>
  6648. <dd><p>Include picture timing parameters (<em class="emph">buffering_period</em> and
  6649. <em class="emph">pic_timing</em> messages).
  6650. </p></dd>
  6651. <dt>&lsquo;<samp class="samp">recovery_point</samp>&rsquo;</dt>
  6652. <dd><p>Include recovery points where appropriate (<em class="emph">recovery_point</em> messages).
  6653. </p></dd>
  6654. </dl>
  6655. </dd>
  6656. </dl>
  6657. </dd>
  6658. <dt><samp class="option">hevc_vaapi</samp></dt>
  6659. <dd><p><samp class="option">profile</samp> and <samp class="option">level</samp> set the values of
  6660. <em class="emph">general_profile_idc</em> and <em class="emph">general_level_idc</em> respectively.
  6661. </p>
  6662. <dl class="table">
  6663. <dt><samp class="option">aud</samp></dt>
  6664. <dd><p>Include access unit delimiters in the stream (not included by default).
  6665. </p>
  6666. </dd>
  6667. <dt><samp class="option">tier</samp></dt>
  6668. <dd><p>Set <em class="emph">general_tier_flag</em>. This may affect the level chosen for the stream
  6669. if it is not explicitly specified.
  6670. </p>
  6671. </dd>
  6672. <dt><samp class="option">sei</samp></dt>
  6673. <dd><p>Set SEI message types to include.
  6674. Some combination of the following values:
  6675. </p><dl class="table">
  6676. <dt>&lsquo;<samp class="samp">hdr</samp>&rsquo;</dt>
  6677. <dd><p>Include HDR metadata if the input frames have it
  6678. (<em class="emph">mastering_display_colour_volume</em> and <em class="emph">content_light_level</em>
  6679. messages).
  6680. </p></dd>
  6681. </dl>
  6682. </dd>
  6683. <dt><samp class="option">tiles</samp></dt>
  6684. <dd><p>Set the number of tiles to encode the input video with, as columns x rows.
  6685. Larger numbers allow greater parallelism in both encoding and decoding, but
  6686. may decrease coding efficiency.
  6687. </p>
  6688. </dd>
  6689. </dl>
  6690. </dd>
  6691. <dt><samp class="option">mjpeg_vaapi</samp></dt>
  6692. <dd><p>Only baseline DCT encoding is supported. The encoder always uses the standard
  6693. quantisation and huffman tables - <samp class="option">global_quality</samp> scales the standard
  6694. quantisation table (range 1-100).
  6695. </p>
  6696. <p>For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported. RGB is also
  6697. supported, and will create an RGB JPEG.
  6698. </p>
  6699. <dl class="table">
  6700. <dt><samp class="option">jfif</samp></dt>
  6701. <dd><p>Include JFIF header in each frame (not included by default).
  6702. </p></dd>
  6703. <dt><samp class="option">huffman</samp></dt>
  6704. <dd><p>Include standard huffman tables (on by default). Turning this off will save
  6705. a few hundred bytes in each output frame, but may lose compatibility with some
  6706. JPEG decoders which don&rsquo;t fully handle MJPEG.
  6707. </p></dd>
  6708. </dl>
  6709. </dd>
  6710. <dt><samp class="option">mpeg2_vaapi</samp></dt>
  6711. <dd><p><samp class="option">profile</samp> and <samp class="option">level</samp> set the value of <em class="emph">profile_and_level_indication</em>.
  6712. </p>
  6713. </dd>
  6714. <dt><samp class="option">vp8_vaapi</samp></dt>
  6715. <dd><p>B-frames are not supported.
  6716. </p>
  6717. <p><samp class="option">global_quality</samp> sets the <em class="emph">q_idx</em> used for non-key frames (range 0-127).
  6718. </p>
  6719. <dl class="table">
  6720. <dt><samp class="option">loop_filter_level</samp></dt>
  6721. <dt><samp class="option">loop_filter_sharpness</samp></dt>
  6722. <dd><p>Manually set the loop filter parameters.
  6723. </p></dd>
  6724. </dl>
  6725. </dd>
  6726. <dt><samp class="option">vp9_vaapi</samp></dt>
  6727. <dd><p><samp class="option">global_quality</samp> sets the <em class="emph">q_idx</em> used for P-frames (range 0-255).
  6728. </p>
  6729. <dl class="table">
  6730. <dt><samp class="option">loop_filter_level</samp></dt>
  6731. <dt><samp class="option">loop_filter_sharpness</samp></dt>
  6732. <dd><p>Manually set the loop filter parameters.
  6733. </p></dd>
  6734. </dl>
  6735. <p>B-frames are supported, but the output stream is always in encode order rather than display
  6736. order. If B-frames are enabled, it may be necessary to use the <samp class="option">vp9_raw_reorder</samp>
  6737. bitstream filter to modify the output stream to display frames in the correct order.
  6738. </p>
  6739. <p>Only normal frames are produced - the <samp class="option">vp9_superframe</samp> bitstream filter may be
  6740. required to produce a stream usable with all decoders.
  6741. </p>
  6742. </dd>
  6743. </dl>
  6744. </div>
  6745. <div class="section-level-extent" id="vbn">
  6746. <h3 class="section"><span>9.26 vbn<a class="copiable-link" href="#vbn"> &para;</a></span></h3>
  6747. <p>Vizrt Binary Image encoder.
  6748. </p>
  6749. <p>This format is used by the broadcast vendor Vizrt for quick texture streaming.
  6750. Advanced features of the format such as LZW compression of texture data or
  6751. generation of mipmaps are not supported.
  6752. </p>
  6753. <ul class="mini-toc">
  6754. <li><a href="#Options-40" accesskey="1">Options</a></li>
  6755. </ul>
  6756. <div class="subsection-level-extent" id="Options-40">
  6757. <h4 class="subsection"><span>9.26.1 Options<a class="copiable-link" href="#Options-40"> &para;</a></span></h4>
  6758. <dl class="table">
  6759. <dt><samp class="option">format <var class="var">string</var></samp></dt>
  6760. <dd><p>Sets the texture compression used by the VBN file. Can be <var class="var">dxt1</var>,
  6761. <var class="var">dxt5</var> or <var class="var">raw</var>. Default is <var class="var">dxt5</var>.
  6762. </p></dd>
  6763. </dl>
  6764. </div>
  6765. </div>
  6766. <div class="section-level-extent" id="vc2">
  6767. <h3 class="section"><span>9.27 vc2<a class="copiable-link" href="#vc2"> &para;</a></span></h3>
  6768. <p>SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at
  6769. professional broadcasting but since it supports yuv420, yuv422 and yuv444 at
  6770. 8 (limited range or full range), 10 or 12 bits, this makes it suitable for
  6771. other tasks which require low overhead and low compression (like screen
  6772. recording).
  6773. </p>
  6774. <ul class="mini-toc">
  6775. <li><a href="#Options-41" accesskey="1">Options</a></li>
  6776. </ul>
  6777. <div class="subsection-level-extent" id="Options-41">
  6778. <h4 class="subsection"><span>9.27.1 Options<a class="copiable-link" href="#Options-41"> &para;</a></span></h4>
  6779. <dl class="table">
  6780. <dt><samp class="option">b</samp></dt>
  6781. <dd><p>Sets target video bitrate. Usually that&rsquo;s around 1:6 of the uncompressed
  6782. video bitrate (e.g. for 1920x1080 50fps yuv422p10 that&rsquo;s around 400Mbps). Higher
  6783. values (close to the uncompressed bitrate) turn on lossless compression mode.
  6784. </p>
  6785. </dd>
  6786. <dt><samp class="option">field_order</samp></dt>
  6787. <dd><p>Enables field coding when set (e.g. to tt - top field first) for interlaced
  6788. inputs. Should increase compression with interlaced content as it splits the
  6789. fields and encodes each separately.
  6790. </p>
  6791. </dd>
  6792. <dt><samp class="option">wavelet_depth</samp></dt>
  6793. <dd><p>Sets the total amount of wavelet transforms to apply, between 1 and 5 (default).
  6794. Lower values reduce compression and quality. Less capable decoders may not be
  6795. able to handle values of <samp class="option">wavelet_depth</samp> over 3.
  6796. </p>
  6797. </dd>
  6798. <dt><samp class="option">wavelet_type</samp></dt>
  6799. <dd><p>Sets the transform type. Currently only <var class="var">5_3</var> (LeGall) and <var class="var">9_7</var>
  6800. (Deslauriers-Dubuc)
  6801. are implemented, with 9_7 being the one with better compression and thus
  6802. is the default.
  6803. </p>
  6804. </dd>
  6805. <dt><samp class="option">slice_width</samp></dt>
  6806. <dt><samp class="option">slice_height</samp></dt>
  6807. <dd><p>Sets the slice size for each slice. Larger values result in better compression.
  6808. For compatibility with other more limited decoders use <samp class="option">slice_width</samp> of
  6809. 32 and <samp class="option">slice_height</samp> of 8.
  6810. </p>
  6811. </dd>
  6812. <dt><samp class="option">tolerance</samp></dt>
  6813. <dd><p>Sets the undershoot tolerance of the rate control system in percent. This is
  6814. to prevent an expensive search from being run.
  6815. </p>
  6816. </dd>
  6817. <dt><samp class="option">qm</samp></dt>
  6818. <dd><p>Sets the quantization matrix preset to use by default or when <samp class="option">wavelet_depth</samp>
  6819. is set to 5
  6820. </p><ul class="itemize mark-minus">
  6821. <li><var class="var">default</var>
  6822. Uses the default quantization matrix from the specifications, extended with
  6823. values for the fifth level. This provides a good balance between keeping detail
  6824. and omitting artifacts.
  6825. </li><li><var class="var">flat</var>
  6826. Use a completely zeroed out quantization matrix. This increases PSNR but might
  6827. reduce perception. Use in bogus benchmarks.
  6828. </li><li><var class="var">color</var>
  6829. Reduces detail but attempts to preserve color at extremely low bitrates.
  6830. </li></ul>
  6831. </dd>
  6832. </dl>
  6833. </div>
  6834. </div>
  6835. </div>
  6836. <div class="chapter-level-extent" id="Subtitles-Encoders">
  6837. <h2 class="chapter"><span>10 Subtitles Encoders<a class="copiable-link" href="#Subtitles-Encoders"> &para;</a></span></h2>
  6838. <ul class="mini-toc">
  6839. <li><a href="#dvdsub-1" accesskey="1">dvdsub</a></li>
  6840. </ul>
  6841. <div class="section-level-extent" id="dvdsub-1">
  6842. <h3 class="section"><span>10.1 dvdsub<a class="copiable-link" href="#dvdsub-1"> &para;</a></span></h3>
  6843. <p>This codec encodes the bitmap subtitle format that is used in DVDs.
  6844. Typically they are stored in VOBSUB file pairs (*.idx + *.sub),
  6845. and they can also be used in Matroska files.
  6846. </p>
  6847. <ul class="mini-toc">
  6848. <li><a href="#Options-42" accesskey="1">Options</a></li>
  6849. </ul>
  6850. <div class="subsection-level-extent" id="Options-42">
  6851. <h4 class="subsection"><span>10.1.1 Options<a class="copiable-link" href="#Options-42"> &para;</a></span></h4>
  6852. <dl class="table">
  6853. <dt><samp class="option">palette</samp></dt>
  6854. <dd><p>Specify the global palette used by the bitmaps.
  6855. </p>
  6856. <p>The format for this option is a string containing 16 24-bits hexadecimal
  6857. numbers (without 0x prefix) separated by commas, for example <code class="code">0d00ee,
  6858. ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1,
  6859. 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b</code>.
  6860. </p>
  6861. </dd>
  6862. <dt><samp class="option">even_rows_fix</samp></dt>
  6863. <dd><p>When set to 1, enable a work-around that makes the number of pixel rows
  6864. even in all subtitles. This fixes a problem with some players that
  6865. cut off the bottom row if the number is odd. The work-around just adds
  6866. a fully transparent row if needed. The overhead is low, typically
  6867. one byte per subtitle on average.
  6868. </p>
  6869. <p>By default, this work-around is disabled.
  6870. </p></dd>
  6871. </dl>
  6872. </div>
  6873. </div>
  6874. </div>
  6875. <div class="chapter-level-extent" id="See-Also">
  6876. <h2 class="chapter"><span>11 See Also<a class="copiable-link" href="#See-Also"> &para;</a></span></h2>
  6877. <p><a class="url" href="ffmpeg.html">ffmpeg</a>, <a class="url" href="ffplay.html">ffplay</a>, <a class="url" href="ffprobe.html">ffprobe</a>,
  6878. <a class="url" href="libavcodec.html">libavcodec</a>
  6879. </p>
  6880. </div>
  6881. <div class="chapter-level-extent" id="Authors">
  6882. <h2 class="chapter"><span>12 Authors<a class="copiable-link" href="#Authors"> &para;</a></span></h2>
  6883. <p>The FFmpeg developers.
  6884. </p>
  6885. <p>For details about the authorship, see the Git history of the project
  6886. (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
  6887. <code class="command">git log</code> in the FFmpeg source directory, or browsing the
  6888. online repository at <a class="url" href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.
  6889. </p>
  6890. <p>Maintainers for the specific components are listed in the file
  6891. <samp class="file">MAINTAINERS</samp> in the source code tree.
  6892. </p>
  6893. </div>
  6894. </div>
  6895. <p style="font-size: small;">
  6896. This document was generated using <a class="uref" href="https://www.gnu.org/software/texinfo/"><em class="emph">makeinfo</em></a>.
  6897. </p>
  6898. </div>
  6899. </body>
  6900. </html>