avcodec.h 209 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228
  1. /*
  2. * copyright (c) 2001 Fabrice Bellard
  3. *
  4. * This file is part of FFmpeg.
  5. *
  6. * FFmpeg is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Lesser General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2.1 of the License, or (at your option) any later version.
  10. *
  11. * FFmpeg is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Lesser General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Lesser General Public
  17. * License along with FFmpeg; if not, write to the Free Software
  18. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19. */
  20. #ifndef AVCODEC_AVCODEC_H
  21. #define AVCODEC_AVCODEC_H
  22. /**
  23. * @file
  24. * @ingroup libavc
  25. * Libavcodec external API header
  26. */
  27. #include <errno.h>
  28. #include "libavutil/samplefmt.h"
  29. #include "libavutil/attributes.h"
  30. #include "libavutil/avutil.h"
  31. #include "libavutil/buffer.h"
  32. #include "libavutil/cpu.h"
  33. #include "libavutil/channel_layout.h"
  34. #include "libavutil/dict.h"
  35. #include "libavutil/frame.h"
  36. #include "libavutil/hwcontext.h"
  37. #include "libavutil/log.h"
  38. #include "libavutil/pixfmt.h"
  39. #include "libavutil/rational.h"
  40. #include "version.h"
  41. /**
  42. * @defgroup libavc libavcodec
  43. * Encoding/Decoding Library
  44. *
  45. * @{
  46. *
  47. * @defgroup lavc_decoding Decoding
  48. * @{
  49. * @}
  50. *
  51. * @defgroup lavc_encoding Encoding
  52. * @{
  53. * @}
  54. *
  55. * @defgroup lavc_codec Codecs
  56. * @{
  57. * @defgroup lavc_codec_native Native Codecs
  58. * @{
  59. * @}
  60. * @defgroup lavc_codec_wrappers External library wrappers
  61. * @{
  62. * @}
  63. * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
  64. * @{
  65. * @}
  66. * @}
  67. * @defgroup lavc_internal Internal
  68. * @{
  69. * @}
  70. * @}
  71. */
  72. /**
  73. * @ingroup libavc
  74. * @defgroup lavc_encdec send/receive encoding and decoding API overview
  75. * @{
  76. *
  77. * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
  78. * avcodec_receive_packet() functions provide an encode/decode API, which
  79. * decouples input and output.
  80. *
  81. * The API is very similar for encoding/decoding and audio/video, and works as
  82. * follows:
  83. * - Set up and open the AVCodecContext as usual.
  84. * - Send valid input:
  85. * - For decoding, call avcodec_send_packet() to give the decoder raw
  86. * compressed data in an AVPacket.
  87. * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
  88. * containing uncompressed audio or video.
  89. * In both cases, it is recommended that AVPackets and AVFrames are
  90. * refcounted, or libavcodec might have to copy the input data. (libavformat
  91. * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
  92. * refcounted AVFrames.)
  93. * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
  94. * functions and process their output:
  95. * - For decoding, call avcodec_receive_frame(). On success, it will return
  96. * an AVFrame containing uncompressed audio or video data.
  97. * - For encoding, call avcodec_receive_packet(). On success, it will return
  98. * an AVPacket with a compressed frame.
  99. * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
  100. * AVERROR(EAGAIN) return value means that new input data is required to
  101. * return new output. In this case, continue with sending input. For each
  102. * input frame/packet, the codec will typically return 1 output frame/packet,
  103. * but it can also be 0 or more than 1.
  104. *
  105. * At the beginning of decoding or encoding, the codec might accept multiple
  106. * input frames/packets without returning a frame, until its internal buffers
  107. * are filled. This situation is handled transparently if you follow the steps
  108. * outlined above.
  109. *
  110. * In theory, sending input can result in EAGAIN - this should happen only if
  111. * not all output was received. You can use this to structure alternative decode
  112. * or encode loops other than the one suggested above. For example, you could
  113. * try sending new input on each iteration, and try to receive output if that
  114. * returns EAGAIN.
  115. *
  116. * End of stream situations. These require "flushing" (aka draining) the codec,
  117. * as the codec might buffer multiple frames or packets internally for
  118. * performance or out of necessity (consider B-frames).
  119. * This is handled as follows:
  120. * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
  121. * or avcodec_send_frame() (encoding) functions. This will enter draining
  122. * mode.
  123. * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
  124. * (encoding) in a loop until AVERROR_EOF is returned. The functions will
  125. * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
  126. * - Before decoding can be resumed again, the codec has to be reset with
  127. * avcodec_flush_buffers().
  128. *
  129. * Using the API as outlined above is highly recommended. But it is also
  130. * possible to call functions outside of this rigid schema. For example, you can
  131. * call avcodec_send_packet() repeatedly without calling
  132. * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
  133. * until the codec's internal buffer has been filled up (which is typically of
  134. * size 1 per output frame, after initial input), and then reject input with
  135. * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
  136. * read at least some output.
  137. *
  138. * Not all codecs will follow a rigid and predictable dataflow; the only
  139. * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
  140. * one end implies that a receive/send call on the other end will succeed, or
  141. * at least will not fail with AVERROR(EAGAIN). In general, no codec will
  142. * permit unlimited buffering of input or output.
  143. *
  144. * This API replaces the following legacy functions:
  145. * - avcodec_decode_video2() and avcodec_decode_audio4():
  146. * Use avcodec_send_packet() to feed input to the decoder, then use
  147. * avcodec_receive_frame() to receive decoded frames after each packet.
  148. * Unlike with the old video decoding API, multiple frames might result from
  149. * a packet. For audio, splitting the input packet into frames by partially
  150. * decoding packets becomes transparent to the API user. You never need to
  151. * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
  152. * no data was read from the packet).
  153. * Additionally, sending a flush/draining packet is required only once.
  154. * - avcodec_encode_video2()/avcodec_encode_audio2():
  155. * Use avcodec_send_frame() to feed input to the encoder, then use
  156. * avcodec_receive_packet() to receive encoded packets.
  157. * Providing user-allocated buffers for avcodec_receive_packet() is not
  158. * possible.
  159. * - The new API does not handle subtitles yet.
  160. *
  161. * Mixing new and old function calls on the same AVCodecContext is not allowed,
  162. * and will result in undefined behavior.
  163. *
  164. * Some codecs might require using the new API; using the old API will return
  165. * an error when calling it. All codecs support the new API.
  166. *
  167. * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
  168. * would be an invalid state, which could put the codec user into an endless
  169. * loop. The API has no concept of time either: it cannot happen that trying to
  170. * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
  171. * later accepts the packet (with no other receive/flush API calls involved).
  172. * The API is a strict state machine, and the passage of time is not supposed
  173. * to influence it. Some timing-dependent behavior might still be deemed
  174. * acceptable in certain cases. But it must never result in both send/receive
  175. * returning EAGAIN at the same time at any point. It must also absolutely be
  176. * avoided that the current state is "unstable" and can "flip-flop" between
  177. * the send/receive APIs allowing progress. For example, it's not allowed that
  178. * the codec randomly decides that it actually wants to consume a packet now
  179. * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
  180. * avcodec_send_packet() call.
  181. * @}
  182. */
  183. /**
  184. * @defgroup lavc_core Core functions/structures.
  185. * @ingroup libavc
  186. *
  187. * Basic definitions, functions for querying libavcodec capabilities,
  188. * allocating core structures, etc.
  189. * @{
  190. */
  191. /**
  192. * Identify the syntax and semantics of the bitstream.
  193. * The principle is roughly:
  194. * Two decoders with the same ID can decode the same streams.
  195. * Two encoders with the same ID can encode compatible streams.
  196. * There may be slight deviations from the principle due to implementation
  197. * details.
  198. *
  199. * If you add a codec ID to this list, add it so that
  200. * 1. no value of an existing codec ID changes (that would break ABI),
  201. * 2. it is as close as possible to similar codecs
  202. *
  203. * After adding new codec IDs, do not forget to add an entry to the codec
  204. * descriptor list and bump libavcodec minor version.
  205. */
  206. enum AVCodecID {
  207. AV_CODEC_ID_NONE,
  208. /* video codecs */
  209. AV_CODEC_ID_MPEG1VIDEO,
  210. AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  211. AV_CODEC_ID_H261,
  212. AV_CODEC_ID_H263,
  213. AV_CODEC_ID_RV10,
  214. AV_CODEC_ID_RV20,
  215. AV_CODEC_ID_MJPEG,
  216. AV_CODEC_ID_MJPEGB,
  217. AV_CODEC_ID_LJPEG,
  218. AV_CODEC_ID_SP5X,
  219. AV_CODEC_ID_JPEGLS,
  220. AV_CODEC_ID_MPEG4,
  221. AV_CODEC_ID_RAWVIDEO,
  222. AV_CODEC_ID_MSMPEG4V1,
  223. AV_CODEC_ID_MSMPEG4V2,
  224. AV_CODEC_ID_MSMPEG4V3,
  225. AV_CODEC_ID_WMV1,
  226. AV_CODEC_ID_WMV2,
  227. AV_CODEC_ID_H263P,
  228. AV_CODEC_ID_H263I,
  229. AV_CODEC_ID_FLV1,
  230. AV_CODEC_ID_SVQ1,
  231. AV_CODEC_ID_SVQ3,
  232. AV_CODEC_ID_DVVIDEO,
  233. AV_CODEC_ID_HUFFYUV,
  234. AV_CODEC_ID_CYUV,
  235. AV_CODEC_ID_H264,
  236. AV_CODEC_ID_INDEO3,
  237. AV_CODEC_ID_VP3,
  238. AV_CODEC_ID_THEORA,
  239. AV_CODEC_ID_ASV1,
  240. AV_CODEC_ID_ASV2,
  241. AV_CODEC_ID_FFV1,
  242. AV_CODEC_ID_4XM,
  243. AV_CODEC_ID_VCR1,
  244. AV_CODEC_ID_CLJR,
  245. AV_CODEC_ID_MDEC,
  246. AV_CODEC_ID_ROQ,
  247. AV_CODEC_ID_INTERPLAY_VIDEO,
  248. AV_CODEC_ID_XAN_WC3,
  249. AV_CODEC_ID_XAN_WC4,
  250. AV_CODEC_ID_RPZA,
  251. AV_CODEC_ID_CINEPAK,
  252. AV_CODEC_ID_WS_VQA,
  253. AV_CODEC_ID_MSRLE,
  254. AV_CODEC_ID_MSVIDEO1,
  255. AV_CODEC_ID_IDCIN,
  256. AV_CODEC_ID_8BPS,
  257. AV_CODEC_ID_SMC,
  258. AV_CODEC_ID_FLIC,
  259. AV_CODEC_ID_TRUEMOTION1,
  260. AV_CODEC_ID_VMDVIDEO,
  261. AV_CODEC_ID_MSZH,
  262. AV_CODEC_ID_ZLIB,
  263. AV_CODEC_ID_QTRLE,
  264. AV_CODEC_ID_TSCC,
  265. AV_CODEC_ID_ULTI,
  266. AV_CODEC_ID_QDRAW,
  267. AV_CODEC_ID_VIXL,
  268. AV_CODEC_ID_QPEG,
  269. AV_CODEC_ID_PNG,
  270. AV_CODEC_ID_PPM,
  271. AV_CODEC_ID_PBM,
  272. AV_CODEC_ID_PGM,
  273. AV_CODEC_ID_PGMYUV,
  274. AV_CODEC_ID_PAM,
  275. AV_CODEC_ID_FFVHUFF,
  276. AV_CODEC_ID_RV30,
  277. AV_CODEC_ID_RV40,
  278. AV_CODEC_ID_VC1,
  279. AV_CODEC_ID_WMV3,
  280. AV_CODEC_ID_LOCO,
  281. AV_CODEC_ID_WNV1,
  282. AV_CODEC_ID_AASC,
  283. AV_CODEC_ID_INDEO2,
  284. AV_CODEC_ID_FRAPS,
  285. AV_CODEC_ID_TRUEMOTION2,
  286. AV_CODEC_ID_BMP,
  287. AV_CODEC_ID_CSCD,
  288. AV_CODEC_ID_MMVIDEO,
  289. AV_CODEC_ID_ZMBV,
  290. AV_CODEC_ID_AVS,
  291. AV_CODEC_ID_SMACKVIDEO,
  292. AV_CODEC_ID_NUV,
  293. AV_CODEC_ID_KMVC,
  294. AV_CODEC_ID_FLASHSV,
  295. AV_CODEC_ID_CAVS,
  296. AV_CODEC_ID_JPEG2000,
  297. AV_CODEC_ID_VMNC,
  298. AV_CODEC_ID_VP5,
  299. AV_CODEC_ID_VP6,
  300. AV_CODEC_ID_VP6F,
  301. AV_CODEC_ID_TARGA,
  302. AV_CODEC_ID_DSICINVIDEO,
  303. AV_CODEC_ID_TIERTEXSEQVIDEO,
  304. AV_CODEC_ID_TIFF,
  305. AV_CODEC_ID_GIF,
  306. AV_CODEC_ID_DXA,
  307. AV_CODEC_ID_DNXHD,
  308. AV_CODEC_ID_THP,
  309. AV_CODEC_ID_SGI,
  310. AV_CODEC_ID_C93,
  311. AV_CODEC_ID_BETHSOFTVID,
  312. AV_CODEC_ID_PTX,
  313. AV_CODEC_ID_TXD,
  314. AV_CODEC_ID_VP6A,
  315. AV_CODEC_ID_AMV,
  316. AV_CODEC_ID_VB,
  317. AV_CODEC_ID_PCX,
  318. AV_CODEC_ID_SUNRAST,
  319. AV_CODEC_ID_INDEO4,
  320. AV_CODEC_ID_INDEO5,
  321. AV_CODEC_ID_MIMIC,
  322. AV_CODEC_ID_RL2,
  323. AV_CODEC_ID_ESCAPE124,
  324. AV_CODEC_ID_DIRAC,
  325. AV_CODEC_ID_BFI,
  326. AV_CODEC_ID_CMV,
  327. AV_CODEC_ID_MOTIONPIXELS,
  328. AV_CODEC_ID_TGV,
  329. AV_CODEC_ID_TGQ,
  330. AV_CODEC_ID_TQI,
  331. AV_CODEC_ID_AURA,
  332. AV_CODEC_ID_AURA2,
  333. AV_CODEC_ID_V210X,
  334. AV_CODEC_ID_TMV,
  335. AV_CODEC_ID_V210,
  336. AV_CODEC_ID_DPX,
  337. AV_CODEC_ID_MAD,
  338. AV_CODEC_ID_FRWU,
  339. AV_CODEC_ID_FLASHSV2,
  340. AV_CODEC_ID_CDGRAPHICS,
  341. AV_CODEC_ID_R210,
  342. AV_CODEC_ID_ANM,
  343. AV_CODEC_ID_BINKVIDEO,
  344. AV_CODEC_ID_IFF_ILBM,
  345. #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
  346. AV_CODEC_ID_KGV1,
  347. AV_CODEC_ID_YOP,
  348. AV_CODEC_ID_VP8,
  349. AV_CODEC_ID_PICTOR,
  350. AV_CODEC_ID_ANSI,
  351. AV_CODEC_ID_A64_MULTI,
  352. AV_CODEC_ID_A64_MULTI5,
  353. AV_CODEC_ID_R10K,
  354. AV_CODEC_ID_MXPEG,
  355. AV_CODEC_ID_LAGARITH,
  356. AV_CODEC_ID_PRORES,
  357. AV_CODEC_ID_JV,
  358. AV_CODEC_ID_DFA,
  359. AV_CODEC_ID_WMV3IMAGE,
  360. AV_CODEC_ID_VC1IMAGE,
  361. AV_CODEC_ID_UTVIDEO,
  362. AV_CODEC_ID_BMV_VIDEO,
  363. AV_CODEC_ID_VBLE,
  364. AV_CODEC_ID_DXTORY,
  365. AV_CODEC_ID_V410,
  366. AV_CODEC_ID_XWD,
  367. AV_CODEC_ID_CDXL,
  368. AV_CODEC_ID_XBM,
  369. AV_CODEC_ID_ZEROCODEC,
  370. AV_CODEC_ID_MSS1,
  371. AV_CODEC_ID_MSA1,
  372. AV_CODEC_ID_TSCC2,
  373. AV_CODEC_ID_MTS2,
  374. AV_CODEC_ID_CLLC,
  375. AV_CODEC_ID_MSS2,
  376. AV_CODEC_ID_VP9,
  377. AV_CODEC_ID_AIC,
  378. AV_CODEC_ID_ESCAPE130,
  379. AV_CODEC_ID_G2M,
  380. AV_CODEC_ID_WEBP,
  381. AV_CODEC_ID_HNM4_VIDEO,
  382. AV_CODEC_ID_HEVC,
  383. #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
  384. AV_CODEC_ID_FIC,
  385. AV_CODEC_ID_ALIAS_PIX,
  386. AV_CODEC_ID_BRENDER_PIX,
  387. AV_CODEC_ID_PAF_VIDEO,
  388. AV_CODEC_ID_EXR,
  389. AV_CODEC_ID_VP7,
  390. AV_CODEC_ID_SANM,
  391. AV_CODEC_ID_SGIRLE,
  392. AV_CODEC_ID_MVC1,
  393. AV_CODEC_ID_MVC2,
  394. AV_CODEC_ID_HQX,
  395. AV_CODEC_ID_TDSC,
  396. AV_CODEC_ID_HQ_HQA,
  397. AV_CODEC_ID_HAP,
  398. AV_CODEC_ID_DDS,
  399. AV_CODEC_ID_DXV,
  400. AV_CODEC_ID_SCREENPRESSO,
  401. AV_CODEC_ID_RSCC,
  402. AV_CODEC_ID_AVS2,
  403. AV_CODEC_ID_Y41P = 0x8000,
  404. AV_CODEC_ID_AVRP,
  405. AV_CODEC_ID_012V,
  406. AV_CODEC_ID_AVUI,
  407. AV_CODEC_ID_AYUV,
  408. AV_CODEC_ID_TARGA_Y216,
  409. AV_CODEC_ID_V308,
  410. AV_CODEC_ID_V408,
  411. AV_CODEC_ID_YUV4,
  412. AV_CODEC_ID_AVRN,
  413. AV_CODEC_ID_CPIA,
  414. AV_CODEC_ID_XFACE,
  415. AV_CODEC_ID_SNOW,
  416. AV_CODEC_ID_SMVJPEG,
  417. AV_CODEC_ID_APNG,
  418. AV_CODEC_ID_DAALA,
  419. AV_CODEC_ID_CFHD,
  420. AV_CODEC_ID_TRUEMOTION2RT,
  421. AV_CODEC_ID_M101,
  422. AV_CODEC_ID_MAGICYUV,
  423. AV_CODEC_ID_SHEERVIDEO,
  424. AV_CODEC_ID_YLC,
  425. AV_CODEC_ID_PSD,
  426. AV_CODEC_ID_PIXLET,
  427. AV_CODEC_ID_SPEEDHQ,
  428. AV_CODEC_ID_FMVC,
  429. AV_CODEC_ID_SCPR,
  430. AV_CODEC_ID_CLEARVIDEO,
  431. AV_CODEC_ID_XPM,
  432. AV_CODEC_ID_AV1,
  433. AV_CODEC_ID_BITPACKED,
  434. AV_CODEC_ID_MSCC,
  435. AV_CODEC_ID_SRGC,
  436. AV_CODEC_ID_SVG,
  437. AV_CODEC_ID_GDV,
  438. AV_CODEC_ID_FITS,
  439. AV_CODEC_ID_IMM4,
  440. AV_CODEC_ID_PROSUMER,
  441. AV_CODEC_ID_MWSC,
  442. AV_CODEC_ID_WCMV,
  443. AV_CODEC_ID_RASC,
  444. AV_CODEC_ID_HYMT,
  445. AV_CODEC_ID_ARBC,
  446. AV_CODEC_ID_AGM,
  447. AV_CODEC_ID_LSCR,
  448. AV_CODEC_ID_VP4,
  449. /* various PCM "codecs" */
  450. AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
  451. AV_CODEC_ID_PCM_S16LE = 0x10000,
  452. AV_CODEC_ID_PCM_S16BE,
  453. AV_CODEC_ID_PCM_U16LE,
  454. AV_CODEC_ID_PCM_U16BE,
  455. AV_CODEC_ID_PCM_S8,
  456. AV_CODEC_ID_PCM_U8,
  457. AV_CODEC_ID_PCM_MULAW,
  458. AV_CODEC_ID_PCM_ALAW,
  459. AV_CODEC_ID_PCM_S32LE,
  460. AV_CODEC_ID_PCM_S32BE,
  461. AV_CODEC_ID_PCM_U32LE,
  462. AV_CODEC_ID_PCM_U32BE,
  463. AV_CODEC_ID_PCM_S24LE,
  464. AV_CODEC_ID_PCM_S24BE,
  465. AV_CODEC_ID_PCM_U24LE,
  466. AV_CODEC_ID_PCM_U24BE,
  467. AV_CODEC_ID_PCM_S24DAUD,
  468. AV_CODEC_ID_PCM_ZORK,
  469. AV_CODEC_ID_PCM_S16LE_PLANAR,
  470. AV_CODEC_ID_PCM_DVD,
  471. AV_CODEC_ID_PCM_F32BE,
  472. AV_CODEC_ID_PCM_F32LE,
  473. AV_CODEC_ID_PCM_F64BE,
  474. AV_CODEC_ID_PCM_F64LE,
  475. AV_CODEC_ID_PCM_BLURAY,
  476. AV_CODEC_ID_PCM_LXF,
  477. AV_CODEC_ID_S302M,
  478. AV_CODEC_ID_PCM_S8_PLANAR,
  479. AV_CODEC_ID_PCM_S24LE_PLANAR,
  480. AV_CODEC_ID_PCM_S32LE_PLANAR,
  481. AV_CODEC_ID_PCM_S16BE_PLANAR,
  482. AV_CODEC_ID_PCM_S64LE = 0x10800,
  483. AV_CODEC_ID_PCM_S64BE,
  484. AV_CODEC_ID_PCM_F16LE,
  485. AV_CODEC_ID_PCM_F24LE,
  486. AV_CODEC_ID_PCM_VIDC,
  487. /* various ADPCM codecs */
  488. AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
  489. AV_CODEC_ID_ADPCM_IMA_WAV,
  490. AV_CODEC_ID_ADPCM_IMA_DK3,
  491. AV_CODEC_ID_ADPCM_IMA_DK4,
  492. AV_CODEC_ID_ADPCM_IMA_WS,
  493. AV_CODEC_ID_ADPCM_IMA_SMJPEG,
  494. AV_CODEC_ID_ADPCM_MS,
  495. AV_CODEC_ID_ADPCM_4XM,
  496. AV_CODEC_ID_ADPCM_XA,
  497. AV_CODEC_ID_ADPCM_ADX,
  498. AV_CODEC_ID_ADPCM_EA,
  499. AV_CODEC_ID_ADPCM_G726,
  500. AV_CODEC_ID_ADPCM_CT,
  501. AV_CODEC_ID_ADPCM_SWF,
  502. AV_CODEC_ID_ADPCM_YAMAHA,
  503. AV_CODEC_ID_ADPCM_SBPRO_4,
  504. AV_CODEC_ID_ADPCM_SBPRO_3,
  505. AV_CODEC_ID_ADPCM_SBPRO_2,
  506. AV_CODEC_ID_ADPCM_THP,
  507. AV_CODEC_ID_ADPCM_IMA_AMV,
  508. AV_CODEC_ID_ADPCM_EA_R1,
  509. AV_CODEC_ID_ADPCM_EA_R3,
  510. AV_CODEC_ID_ADPCM_EA_R2,
  511. AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
  512. AV_CODEC_ID_ADPCM_IMA_EA_EACS,
  513. AV_CODEC_ID_ADPCM_EA_XAS,
  514. AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
  515. AV_CODEC_ID_ADPCM_IMA_ISS,
  516. AV_CODEC_ID_ADPCM_G722,
  517. AV_CODEC_ID_ADPCM_IMA_APC,
  518. AV_CODEC_ID_ADPCM_VIMA,
  519. AV_CODEC_ID_ADPCM_AFC = 0x11800,
  520. AV_CODEC_ID_ADPCM_IMA_OKI,
  521. AV_CODEC_ID_ADPCM_DTK,
  522. AV_CODEC_ID_ADPCM_IMA_RAD,
  523. AV_CODEC_ID_ADPCM_G726LE,
  524. AV_CODEC_ID_ADPCM_THP_LE,
  525. AV_CODEC_ID_ADPCM_PSX,
  526. AV_CODEC_ID_ADPCM_AICA,
  527. AV_CODEC_ID_ADPCM_IMA_DAT4,
  528. AV_CODEC_ID_ADPCM_MTAF,
  529. AV_CODEC_ID_ADPCM_AGM,
  530. /* AMR */
  531. AV_CODEC_ID_AMR_NB = 0x12000,
  532. AV_CODEC_ID_AMR_WB,
  533. /* RealAudio codecs*/
  534. AV_CODEC_ID_RA_144 = 0x13000,
  535. AV_CODEC_ID_RA_288,
  536. /* various DPCM codecs */
  537. AV_CODEC_ID_ROQ_DPCM = 0x14000,
  538. AV_CODEC_ID_INTERPLAY_DPCM,
  539. AV_CODEC_ID_XAN_DPCM,
  540. AV_CODEC_ID_SOL_DPCM,
  541. AV_CODEC_ID_SDX2_DPCM = 0x14800,
  542. AV_CODEC_ID_GREMLIN_DPCM,
  543. /* audio codecs */
  544. AV_CODEC_ID_MP2 = 0x15000,
  545. AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  546. AV_CODEC_ID_AAC,
  547. AV_CODEC_ID_AC3,
  548. AV_CODEC_ID_DTS,
  549. AV_CODEC_ID_VORBIS,
  550. AV_CODEC_ID_DVAUDIO,
  551. AV_CODEC_ID_WMAV1,
  552. AV_CODEC_ID_WMAV2,
  553. AV_CODEC_ID_MACE3,
  554. AV_CODEC_ID_MACE6,
  555. AV_CODEC_ID_VMDAUDIO,
  556. AV_CODEC_ID_FLAC,
  557. AV_CODEC_ID_MP3ADU,
  558. AV_CODEC_ID_MP3ON4,
  559. AV_CODEC_ID_SHORTEN,
  560. AV_CODEC_ID_ALAC,
  561. AV_CODEC_ID_WESTWOOD_SND1,
  562. AV_CODEC_ID_GSM, ///< as in Berlin toast format
  563. AV_CODEC_ID_QDM2,
  564. AV_CODEC_ID_COOK,
  565. AV_CODEC_ID_TRUESPEECH,
  566. AV_CODEC_ID_TTA,
  567. AV_CODEC_ID_SMACKAUDIO,
  568. AV_CODEC_ID_QCELP,
  569. AV_CODEC_ID_WAVPACK,
  570. AV_CODEC_ID_DSICINAUDIO,
  571. AV_CODEC_ID_IMC,
  572. AV_CODEC_ID_MUSEPACK7,
  573. AV_CODEC_ID_MLP,
  574. AV_CODEC_ID_GSM_MS, /* as found in WAV */
  575. AV_CODEC_ID_ATRAC3,
  576. AV_CODEC_ID_APE,
  577. AV_CODEC_ID_NELLYMOSER,
  578. AV_CODEC_ID_MUSEPACK8,
  579. AV_CODEC_ID_SPEEX,
  580. AV_CODEC_ID_WMAVOICE,
  581. AV_CODEC_ID_WMAPRO,
  582. AV_CODEC_ID_WMALOSSLESS,
  583. AV_CODEC_ID_ATRAC3P,
  584. AV_CODEC_ID_EAC3,
  585. AV_CODEC_ID_SIPR,
  586. AV_CODEC_ID_MP1,
  587. AV_CODEC_ID_TWINVQ,
  588. AV_CODEC_ID_TRUEHD,
  589. AV_CODEC_ID_MP4ALS,
  590. AV_CODEC_ID_ATRAC1,
  591. AV_CODEC_ID_BINKAUDIO_RDFT,
  592. AV_CODEC_ID_BINKAUDIO_DCT,
  593. AV_CODEC_ID_AAC_LATM,
  594. AV_CODEC_ID_QDMC,
  595. AV_CODEC_ID_CELT,
  596. AV_CODEC_ID_G723_1,
  597. AV_CODEC_ID_G729,
  598. AV_CODEC_ID_8SVX_EXP,
  599. AV_CODEC_ID_8SVX_FIB,
  600. AV_CODEC_ID_BMV_AUDIO,
  601. AV_CODEC_ID_RALF,
  602. AV_CODEC_ID_IAC,
  603. AV_CODEC_ID_ILBC,
  604. AV_CODEC_ID_OPUS,
  605. AV_CODEC_ID_COMFORT_NOISE,
  606. AV_CODEC_ID_TAK,
  607. AV_CODEC_ID_METASOUND,
  608. AV_CODEC_ID_PAF_AUDIO,
  609. AV_CODEC_ID_ON2AVC,
  610. AV_CODEC_ID_DSS_SP,
  611. AV_CODEC_ID_CODEC2,
  612. AV_CODEC_ID_FFWAVESYNTH = 0x15800,
  613. AV_CODEC_ID_SONIC,
  614. AV_CODEC_ID_SONIC_LS,
  615. AV_CODEC_ID_EVRC,
  616. AV_CODEC_ID_SMV,
  617. AV_CODEC_ID_DSD_LSBF,
  618. AV_CODEC_ID_DSD_MSBF,
  619. AV_CODEC_ID_DSD_LSBF_PLANAR,
  620. AV_CODEC_ID_DSD_MSBF_PLANAR,
  621. AV_CODEC_ID_4GV,
  622. AV_CODEC_ID_INTERPLAY_ACM,
  623. AV_CODEC_ID_XMA1,
  624. AV_CODEC_ID_XMA2,
  625. AV_CODEC_ID_DST,
  626. AV_CODEC_ID_ATRAC3AL,
  627. AV_CODEC_ID_ATRAC3PAL,
  628. AV_CODEC_ID_DOLBY_E,
  629. AV_CODEC_ID_APTX,
  630. AV_CODEC_ID_APTX_HD,
  631. AV_CODEC_ID_SBC,
  632. AV_CODEC_ID_ATRAC9,
  633. AV_CODEC_ID_HCOM,
  634. /* subtitle codecs */
  635. AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
  636. AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
  637. AV_CODEC_ID_DVB_SUBTITLE,
  638. AV_CODEC_ID_TEXT, ///< raw UTF-8 text
  639. AV_CODEC_ID_XSUB,
  640. AV_CODEC_ID_SSA,
  641. AV_CODEC_ID_MOV_TEXT,
  642. AV_CODEC_ID_HDMV_PGS_SUBTITLE,
  643. AV_CODEC_ID_DVB_TELETEXT,
  644. AV_CODEC_ID_SRT,
  645. AV_CODEC_ID_MICRODVD = 0x17800,
  646. AV_CODEC_ID_EIA_608,
  647. AV_CODEC_ID_JACOSUB,
  648. AV_CODEC_ID_SAMI,
  649. AV_CODEC_ID_REALTEXT,
  650. AV_CODEC_ID_STL,
  651. AV_CODEC_ID_SUBVIEWER1,
  652. AV_CODEC_ID_SUBVIEWER,
  653. AV_CODEC_ID_SUBRIP,
  654. AV_CODEC_ID_WEBVTT,
  655. AV_CODEC_ID_MPL2,
  656. AV_CODEC_ID_VPLAYER,
  657. AV_CODEC_ID_PJS,
  658. AV_CODEC_ID_ASS,
  659. AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
  660. AV_CODEC_ID_TTML,
  661. AV_CODEC_ID_ARIB_CAPTION,
  662. /* other specific kind of codecs (generally used for attachments) */
  663. AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
  664. AV_CODEC_ID_TTF = 0x18000,
  665. AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
  666. AV_CODEC_ID_BINTEXT = 0x18800,
  667. AV_CODEC_ID_XBIN,
  668. AV_CODEC_ID_IDF,
  669. AV_CODEC_ID_OTF,
  670. AV_CODEC_ID_SMPTE_KLV,
  671. AV_CODEC_ID_DVD_NAV,
  672. AV_CODEC_ID_TIMED_ID3,
  673. AV_CODEC_ID_BIN_DATA,
  674. AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
  675. AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  676. * stream (only used by libavformat) */
  677. AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
  678. * stream (only used by libavformat) */
  679. AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
  680. AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
  681. };
  682. /**
  683. * This struct describes the properties of a single codec described by an
  684. * AVCodecID.
  685. * @see avcodec_descriptor_get()
  686. */
  687. typedef struct AVCodecDescriptor {
  688. enum AVCodecID id;
  689. enum AVMediaType type;
  690. /**
  691. * Name of the codec described by this descriptor. It is non-empty and
  692. * unique for each codec descriptor. It should contain alphanumeric
  693. * characters and '_' only.
  694. */
  695. const char *name;
  696. /**
  697. * A more descriptive name for this codec. May be NULL.
  698. */
  699. const char *long_name;
  700. /**
  701. * Codec properties, a combination of AV_CODEC_PROP_* flags.
  702. */
  703. int props;
  704. /**
  705. * MIME type(s) associated with the codec.
  706. * May be NULL; if not, a NULL-terminated array of MIME types.
  707. * The first item is always non-NULL and is the preferred MIME type.
  708. */
  709. const char *const *mime_types;
  710. /**
  711. * If non-NULL, an array of profiles recognized for this codec.
  712. * Terminated with FF_PROFILE_UNKNOWN.
  713. */
  714. const struct AVProfile *profiles;
  715. } AVCodecDescriptor;
  716. /**
  717. * Codec uses only intra compression.
  718. * Video and audio codecs only.
  719. */
  720. #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
  721. /**
  722. * Codec supports lossy compression. Audio and video codecs only.
  723. * @note a codec may support both lossy and lossless
  724. * compression modes
  725. */
  726. #define AV_CODEC_PROP_LOSSY (1 << 1)
  727. /**
  728. * Codec supports lossless compression. Audio and video codecs only.
  729. */
  730. #define AV_CODEC_PROP_LOSSLESS (1 << 2)
  731. /**
  732. * Codec supports frame reordering. That is, the coded order (the order in which
  733. * the encoded packets are output by the encoders / stored / input to the
  734. * decoders) may be different from the presentation order of the corresponding
  735. * frames.
  736. *
  737. * For codecs that do not have this property set, PTS and DTS should always be
  738. * equal.
  739. */
  740. #define AV_CODEC_PROP_REORDER (1 << 3)
  741. /**
  742. * Subtitle codec is bitmap based
  743. * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
  744. */
  745. #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
  746. /**
  747. * Subtitle codec is text based.
  748. * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
  749. */
  750. #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
  751. /**
  752. * @ingroup lavc_decoding
  753. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  754. * This is mainly needed because some optimized bitstream readers read
  755. * 32 or 64 bit at once and could read over the end.<br>
  756. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  757. * MPEG bitstreams could cause overread and segfault.
  758. */
  759. #define AV_INPUT_BUFFER_PADDING_SIZE 64
  760. /**
  761. * @ingroup lavc_encoding
  762. * minimum encoding buffer size
  763. * Used to avoid some checks during header writing.
  764. */
  765. #define AV_INPUT_BUFFER_MIN_SIZE 16384
  766. /**
  767. * @ingroup lavc_decoding
  768. */
  769. enum AVDiscard{
  770. /* We leave some space between them for extensions (drop some
  771. * keyframes for intra-only or drop just some bidir frames). */
  772. AVDISCARD_NONE =-16, ///< discard nothing
  773. AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
  774. AVDISCARD_NONREF = 8, ///< discard all non reference
  775. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  776. AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
  777. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  778. AVDISCARD_ALL = 48, ///< discard all
  779. };
  780. enum AVAudioServiceType {
  781. AV_AUDIO_SERVICE_TYPE_MAIN = 0,
  782. AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
  783. AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
  784. AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
  785. AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
  786. AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
  787. AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
  788. AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
  789. AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
  790. AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
  791. };
  792. /**
  793. * @ingroup lavc_encoding
  794. */
  795. typedef struct RcOverride{
  796. int start_frame;
  797. int end_frame;
  798. int qscale; // If this is 0 then quality_factor will be used instead.
  799. float quality_factor;
  800. } RcOverride;
  801. /* encoding support
  802. These flags can be passed in AVCodecContext.flags before initialization.
  803. Note: Not everything is supported yet.
  804. */
  805. /**
  806. * Allow decoders to produce frames with data planes that are not aligned
  807. * to CPU requirements (e.g. due to cropping).
  808. */
  809. #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
  810. /**
  811. * Use fixed qscale.
  812. */
  813. #define AV_CODEC_FLAG_QSCALE (1 << 1)
  814. /**
  815. * 4 MV per MB allowed / advanced prediction for H.263.
  816. */
  817. #define AV_CODEC_FLAG_4MV (1 << 2)
  818. /**
  819. * Output even those frames that might be corrupted.
  820. */
  821. #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
  822. /**
  823. * Use qpel MC.
  824. */
  825. #define AV_CODEC_FLAG_QPEL (1 << 4)
  826. /**
  827. * Don't output frames whose parameters differ from first
  828. * decoded frame in stream.
  829. */
  830. #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
  831. /**
  832. * Use internal 2pass ratecontrol in first pass mode.
  833. */
  834. #define AV_CODEC_FLAG_PASS1 (1 << 9)
  835. /**
  836. * Use internal 2pass ratecontrol in second pass mode.
  837. */
  838. #define AV_CODEC_FLAG_PASS2 (1 << 10)
  839. /**
  840. * loop filter.
  841. */
  842. #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
  843. /**
  844. * Only decode/encode grayscale.
  845. */
  846. #define AV_CODEC_FLAG_GRAY (1 << 13)
  847. /**
  848. * error[?] variables will be set during encoding.
  849. */
  850. #define AV_CODEC_FLAG_PSNR (1 << 15)
  851. /**
  852. * Input bitstream might be truncated at a random location
  853. * instead of only at frame boundaries.
  854. */
  855. #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
  856. /**
  857. * Use interlaced DCT.
  858. */
  859. #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
  860. /**
  861. * Force low delay.
  862. */
  863. #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
  864. /**
  865. * Place global headers in extradata instead of every keyframe.
  866. */
  867. #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
  868. /**
  869. * Use only bitexact stuff (except (I)DCT).
  870. */
  871. #define AV_CODEC_FLAG_BITEXACT (1 << 23)
  872. /* Fx : Flag for H.263+ extra options */
  873. /**
  874. * H.263 advanced intra coding / MPEG-4 AC prediction
  875. */
  876. #define AV_CODEC_FLAG_AC_PRED (1 << 24)
  877. /**
  878. * interlaced motion estimation
  879. */
  880. #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
  881. #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
  882. /**
  883. * Allow non spec compliant speedup tricks.
  884. */
  885. #define AV_CODEC_FLAG2_FAST (1 << 0)
  886. /**
  887. * Skip bitstream encoding.
  888. */
  889. #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
  890. /**
  891. * Place global headers at every keyframe instead of in extradata.
  892. */
  893. #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
  894. /**
  895. * timecode is in drop frame format. DEPRECATED!!!!
  896. */
  897. #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
  898. /**
  899. * Input bitstream might be truncated at a packet boundaries
  900. * instead of only at frame boundaries.
  901. */
  902. #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
  903. /**
  904. * Discard cropping information from SPS.
  905. */
  906. #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
  907. /**
  908. * Show all frames before the first keyframe
  909. */
  910. #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
  911. /**
  912. * Export motion vectors through frame side data
  913. */
  914. #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
  915. /**
  916. * Do not skip samples and export skip information as frame side data
  917. */
  918. #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
  919. /**
  920. * Do not reset ASS ReadOrder field on flush (subtitles decoding)
  921. */
  922. #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
  923. /* Unsupported options :
  924. * Syntax Arithmetic coding (SAC)
  925. * Reference Picture Selection
  926. * Independent Segment Decoding */
  927. /* /Fx */
  928. /* codec capabilities */
  929. /**
  930. * Decoder can use draw_horiz_band callback.
  931. */
  932. #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
  933. /**
  934. * Codec uses get_buffer() for allocating buffers and supports custom allocators.
  935. * If not set, it might not use get_buffer() at all or use operations that
  936. * assume the buffer was allocated by avcodec_default_get_buffer.
  937. */
  938. #define AV_CODEC_CAP_DR1 (1 << 1)
  939. #define AV_CODEC_CAP_TRUNCATED (1 << 3)
  940. /**
  941. * Encoder or decoder requires flushing with NULL input at the end in order to
  942. * give the complete and correct output.
  943. *
  944. * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
  945. * with NULL data. The user can still send NULL data to the public encode
  946. * or decode function, but libavcodec will not pass it along to the codec
  947. * unless this flag is set.
  948. *
  949. * Decoders:
  950. * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
  951. * avpkt->size=0 at the end to get the delayed data until the decoder no longer
  952. * returns frames.
  953. *
  954. * Encoders:
  955. * The encoder needs to be fed with NULL data at the end of encoding until the
  956. * encoder no longer returns data.
  957. *
  958. * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
  959. * flag also means that the encoder must set the pts and duration for
  960. * each output packet. If this flag is not set, the pts and duration will
  961. * be determined by libavcodec from the input frame.
  962. */
  963. #define AV_CODEC_CAP_DELAY (1 << 5)
  964. /**
  965. * Codec can be fed a final frame with a smaller size.
  966. * This can be used to prevent truncation of the last audio samples.
  967. */
  968. #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
  969. /**
  970. * Codec can output multiple frames per AVPacket
  971. * Normally demuxers return one frame at a time, demuxers which do not do
  972. * are connected to a parser to split what they return into proper frames.
  973. * This flag is reserved to the very rare category of codecs which have a
  974. * bitstream that cannot be split into frames without timeconsuming
  975. * operations like full decoding. Demuxers carrying such bitstreams thus
  976. * may return multiple frames in a packet. This has many disadvantages like
  977. * prohibiting stream copy in many cases thus it should only be considered
  978. * as a last resort.
  979. */
  980. #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
  981. /**
  982. * Codec is experimental and is thus avoided in favor of non experimental
  983. * encoders
  984. */
  985. #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
  986. /**
  987. * Codec should fill in channel configuration and samplerate instead of container
  988. */
  989. #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
  990. /**
  991. * Codec supports frame-level multithreading.
  992. */
  993. #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
  994. /**
  995. * Codec supports slice-based (or partition-based) multithreading.
  996. */
  997. #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
  998. /**
  999. * Codec supports changed parameters at any point.
  1000. */
  1001. #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
  1002. /**
  1003. * Codec supports avctx->thread_count == 0 (auto).
  1004. */
  1005. #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
  1006. /**
  1007. * Audio encoder supports receiving a different number of samples in each call.
  1008. */
  1009. #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
  1010. /**
  1011. * Decoder is not a preferred choice for probing.
  1012. * This indicates that the decoder is not a good choice for probing.
  1013. * It could for example be an expensive to spin up hardware decoder,
  1014. * or it could simply not provide a lot of useful information about
  1015. * the stream.
  1016. * A decoder marked with this flag should only be used as last resort
  1017. * choice for probing.
  1018. */
  1019. #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
  1020. /**
  1021. * Codec is intra only.
  1022. */
  1023. #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
  1024. /**
  1025. * Codec is lossless.
  1026. */
  1027. #define AV_CODEC_CAP_LOSSLESS 0x80000000
  1028. /**
  1029. * Codec is backed by a hardware implementation. Typically used to
  1030. * identify a non-hwaccel hardware decoder. For information about hwaccels, use
  1031. * avcodec_get_hw_config() instead.
  1032. */
  1033. #define AV_CODEC_CAP_HARDWARE (1 << 18)
  1034. /**
  1035. * Codec is potentially backed by a hardware implementation, but not
  1036. * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
  1037. * implementation provides some sort of internal fallback.
  1038. */
  1039. #define AV_CODEC_CAP_HYBRID (1 << 19)
  1040. /**
  1041. * This codec takes the reordered_opaque field from input AVFrames
  1042. * and returns it in the corresponding field in AVCodecContext after
  1043. * encoding.
  1044. */
  1045. #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
  1046. /**
  1047. * Pan Scan area.
  1048. * This specifies the area which should be displayed.
  1049. * Note there may be multiple such areas for one frame.
  1050. */
  1051. typedef struct AVPanScan {
  1052. /**
  1053. * id
  1054. * - encoding: Set by user.
  1055. * - decoding: Set by libavcodec.
  1056. */
  1057. int id;
  1058. /**
  1059. * width and height in 1/16 pel
  1060. * - encoding: Set by user.
  1061. * - decoding: Set by libavcodec.
  1062. */
  1063. int width;
  1064. int height;
  1065. /**
  1066. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  1067. * - encoding: Set by user.
  1068. * - decoding: Set by libavcodec.
  1069. */
  1070. int16_t position[3][2];
  1071. } AVPanScan;
  1072. /**
  1073. * This structure describes the bitrate properties of an encoded bitstream. It
  1074. * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
  1075. * parameters for H.264/HEVC.
  1076. */
  1077. typedef struct AVCPBProperties {
  1078. /**
  1079. * Maximum bitrate of the stream, in bits per second.
  1080. * Zero if unknown or unspecified.
  1081. */
  1082. #if FF_API_UNSANITIZED_BITRATES
  1083. int max_bitrate;
  1084. #else
  1085. int64_t max_bitrate;
  1086. #endif
  1087. /**
  1088. * Minimum bitrate of the stream, in bits per second.
  1089. * Zero if unknown or unspecified.
  1090. */
  1091. #if FF_API_UNSANITIZED_BITRATES
  1092. int min_bitrate;
  1093. #else
  1094. int64_t min_bitrate;
  1095. #endif
  1096. /**
  1097. * Average bitrate of the stream, in bits per second.
  1098. * Zero if unknown or unspecified.
  1099. */
  1100. #if FF_API_UNSANITIZED_BITRATES
  1101. int avg_bitrate;
  1102. #else
  1103. int64_t avg_bitrate;
  1104. #endif
  1105. /**
  1106. * The size of the buffer to which the ratecontrol is applied, in bits.
  1107. * Zero if unknown or unspecified.
  1108. */
  1109. int buffer_size;
  1110. /**
  1111. * The delay between the time the packet this structure is associated with
  1112. * is received and the time when it should be decoded, in periods of a 27MHz
  1113. * clock.
  1114. *
  1115. * UINT64_MAX when unknown or unspecified.
  1116. */
  1117. uint64_t vbv_delay;
  1118. } AVCPBProperties;
  1119. /**
  1120. * The decoder will keep a reference to the frame and may reuse it later.
  1121. */
  1122. #define AV_GET_BUFFER_FLAG_REF (1 << 0)
  1123. /**
  1124. * @defgroup lavc_packet AVPacket
  1125. *
  1126. * Types and functions for working with AVPacket.
  1127. * @{
  1128. */
  1129. enum AVPacketSideDataType {
  1130. /**
  1131. * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
  1132. * bytes worth of palette. This side data signals that a new palette is
  1133. * present.
  1134. */
  1135. AV_PKT_DATA_PALETTE,
  1136. /**
  1137. * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
  1138. * that the extradata buffer was changed and the receiving side should
  1139. * act upon it appropriately. The new extradata is embedded in the side
  1140. * data buffer and should be immediately used for processing the current
  1141. * frame or packet.
  1142. */
  1143. AV_PKT_DATA_NEW_EXTRADATA,
  1144. /**
  1145. * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
  1146. * @code
  1147. * u32le param_flags
  1148. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
  1149. * s32le channel_count
  1150. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
  1151. * u64le channel_layout
  1152. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
  1153. * s32le sample_rate
  1154. * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
  1155. * s32le width
  1156. * s32le height
  1157. * @endcode
  1158. */
  1159. AV_PKT_DATA_PARAM_CHANGE,
  1160. /**
  1161. * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
  1162. * structures with info about macroblocks relevant to splitting the
  1163. * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
  1164. * That is, it does not necessarily contain info about all macroblocks,
  1165. * as long as the distance between macroblocks in the info is smaller
  1166. * than the target payload size.
  1167. * Each MB info structure is 12 bytes, and is laid out as follows:
  1168. * @code
  1169. * u32le bit offset from the start of the packet
  1170. * u8 current quantizer at the start of the macroblock
  1171. * u8 GOB number
  1172. * u16le macroblock address within the GOB
  1173. * u8 horizontal MV predictor
  1174. * u8 vertical MV predictor
  1175. * u8 horizontal MV predictor for block number 3
  1176. * u8 vertical MV predictor for block number 3
  1177. * @endcode
  1178. */
  1179. AV_PKT_DATA_H263_MB_INFO,
  1180. /**
  1181. * This side data should be associated with an audio stream and contains
  1182. * ReplayGain information in form of the AVReplayGain struct.
  1183. */
  1184. AV_PKT_DATA_REPLAYGAIN,
  1185. /**
  1186. * This side data contains a 3x3 transformation matrix describing an affine
  1187. * transformation that needs to be applied to the decoded video frames for
  1188. * correct presentation.
  1189. *
  1190. * See libavutil/display.h for a detailed description of the data.
  1191. */
  1192. AV_PKT_DATA_DISPLAYMATRIX,
  1193. /**
  1194. * This side data should be associated with a video stream and contains
  1195. * Stereoscopic 3D information in form of the AVStereo3D struct.
  1196. */
  1197. AV_PKT_DATA_STEREO3D,
  1198. /**
  1199. * This side data should be associated with an audio stream and corresponds
  1200. * to enum AVAudioServiceType.
  1201. */
  1202. AV_PKT_DATA_AUDIO_SERVICE_TYPE,
  1203. /**
  1204. * This side data contains quality related information from the encoder.
  1205. * @code
  1206. * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
  1207. * u8 picture type
  1208. * u8 error count
  1209. * u16 reserved
  1210. * u64le[error count] sum of squared differences between encoder in and output
  1211. * @endcode
  1212. */
  1213. AV_PKT_DATA_QUALITY_STATS,
  1214. /**
  1215. * This side data contains an integer value representing the stream index
  1216. * of a "fallback" track. A fallback track indicates an alternate
  1217. * track to use when the current track can not be decoded for some reason.
  1218. * e.g. no decoder available for codec.
  1219. */
  1220. AV_PKT_DATA_FALLBACK_TRACK,
  1221. /**
  1222. * This side data corresponds to the AVCPBProperties struct.
  1223. */
  1224. AV_PKT_DATA_CPB_PROPERTIES,
  1225. /**
  1226. * Recommmends skipping the specified number of samples
  1227. * @code
  1228. * u32le number of samples to skip from start of this packet
  1229. * u32le number of samples to skip from end of this packet
  1230. * u8 reason for start skip
  1231. * u8 reason for end skip (0=padding silence, 1=convergence)
  1232. * @endcode
  1233. */
  1234. AV_PKT_DATA_SKIP_SAMPLES,
  1235. /**
  1236. * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
  1237. * the packet may contain "dual mono" audio specific to Japanese DTV
  1238. * and if it is true, recommends only the selected channel to be used.
  1239. * @code
  1240. * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
  1241. * @endcode
  1242. */
  1243. AV_PKT_DATA_JP_DUALMONO,
  1244. /**
  1245. * A list of zero terminated key/value strings. There is no end marker for
  1246. * the list, so it is required to rely on the side data size to stop.
  1247. */
  1248. AV_PKT_DATA_STRINGS_METADATA,
  1249. /**
  1250. * Subtitle event position
  1251. * @code
  1252. * u32le x1
  1253. * u32le y1
  1254. * u32le x2
  1255. * u32le y2
  1256. * @endcode
  1257. */
  1258. AV_PKT_DATA_SUBTITLE_POSITION,
  1259. /**
  1260. * Data found in BlockAdditional element of matroska container. There is
  1261. * no end marker for the data, so it is required to rely on the side data
  1262. * size to recognize the end. 8 byte id (as found in BlockAddId) followed
  1263. * by data.
  1264. */
  1265. AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
  1266. /**
  1267. * The optional first identifier line of a WebVTT cue.
  1268. */
  1269. AV_PKT_DATA_WEBVTT_IDENTIFIER,
  1270. /**
  1271. * The optional settings (rendering instructions) that immediately
  1272. * follow the timestamp specifier of a WebVTT cue.
  1273. */
  1274. AV_PKT_DATA_WEBVTT_SETTINGS,
  1275. /**
  1276. * A list of zero terminated key/value strings. There is no end marker for
  1277. * the list, so it is required to rely on the side data size to stop. This
  1278. * side data includes updated metadata which appeared in the stream.
  1279. */
  1280. AV_PKT_DATA_METADATA_UPDATE,
  1281. /**
  1282. * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
  1283. * information from the demuxer to the corresponding muxer.
  1284. */
  1285. AV_PKT_DATA_MPEGTS_STREAM_ID,
  1286. /**
  1287. * Mastering display metadata (based on SMPTE-2086:2014). This metadata
  1288. * should be associated with a video stream and contains data in the form
  1289. * of the AVMasteringDisplayMetadata struct.
  1290. */
  1291. AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
  1292. /**
  1293. * This side data should be associated with a video stream and corresponds
  1294. * to the AVSphericalMapping structure.
  1295. */
  1296. AV_PKT_DATA_SPHERICAL,
  1297. /**
  1298. * Content light level (based on CTA-861.3). This metadata should be
  1299. * associated with a video stream and contains data in the form of the
  1300. * AVContentLightMetadata struct.
  1301. */
  1302. AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
  1303. /**
  1304. * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
  1305. * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
  1306. * The number of bytes of CC data is AVPacketSideData.size.
  1307. */
  1308. AV_PKT_DATA_A53_CC,
  1309. /**
  1310. * This side data is encryption initialization data.
  1311. * The format is not part of ABI, use av_encryption_init_info_* methods to
  1312. * access.
  1313. */
  1314. AV_PKT_DATA_ENCRYPTION_INIT_INFO,
  1315. /**
  1316. * This side data contains encryption info for how to decrypt the packet.
  1317. * The format is not part of ABI, use av_encryption_info_* methods to access.
  1318. */
  1319. AV_PKT_DATA_ENCRYPTION_INFO,
  1320. /**
  1321. * Active Format Description data consisting of a single byte as specified
  1322. * in ETSI TS 101 154 using AVActiveFormatDescription enum.
  1323. */
  1324. AV_PKT_DATA_AFD,
  1325. /**
  1326. * The number of side data types.
  1327. * This is not part of the public API/ABI in the sense that it may
  1328. * change when new side data types are added.
  1329. * This must stay the last enum value.
  1330. * If its value becomes huge, some code using it
  1331. * needs to be updated as it assumes it to be smaller than other limits.
  1332. */
  1333. AV_PKT_DATA_NB
  1334. };
  1335. #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
  1336. typedef struct AVPacketSideData {
  1337. uint8_t *data;
  1338. int size;
  1339. enum AVPacketSideDataType type;
  1340. } AVPacketSideData;
  1341. /**
  1342. * This structure stores compressed data. It is typically exported by demuxers
  1343. * and then passed as input to decoders, or received as output from encoders and
  1344. * then passed to muxers.
  1345. *
  1346. * For video, it should typically contain one compressed frame. For audio it may
  1347. * contain several compressed frames. Encoders are allowed to output empty
  1348. * packets, with no compressed data, containing only side data
  1349. * (e.g. to update some stream parameters at the end of encoding).
  1350. *
  1351. * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
  1352. * ABI. Thus it may be allocated on stack and no new fields can be added to it
  1353. * without libavcodec and libavformat major bump.
  1354. *
  1355. * The semantics of data ownership depends on the buf field.
  1356. * If it is set, the packet data is dynamically allocated and is
  1357. * valid indefinitely until a call to av_packet_unref() reduces the
  1358. * reference count to 0.
  1359. *
  1360. * If the buf field is not set av_packet_ref() would make a copy instead
  1361. * of increasing the reference count.
  1362. *
  1363. * The side data is always allocated with av_malloc(), copied by
  1364. * av_packet_ref() and freed by av_packet_unref().
  1365. *
  1366. * @see av_packet_ref
  1367. * @see av_packet_unref
  1368. */
  1369. typedef struct AVPacket {
  1370. /**
  1371. * A reference to the reference-counted buffer where the packet data is
  1372. * stored.
  1373. * May be NULL, then the packet data is not reference-counted.
  1374. */
  1375. AVBufferRef *buf;
  1376. /**
  1377. * Presentation timestamp in AVStream->time_base units; the time at which
  1378. * the decompressed packet will be presented to the user.
  1379. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  1380. * pts MUST be larger or equal to dts as presentation cannot happen before
  1381. * decompression, unless one wants to view hex dumps. Some formats misuse
  1382. * the terms dts and pts/cts to mean something different. Such timestamps
  1383. * must be converted to true pts/dts before they are stored in AVPacket.
  1384. */
  1385. int64_t pts;
  1386. /**
  1387. * Decompression timestamp in AVStream->time_base units; the time at which
  1388. * the packet is decompressed.
  1389. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  1390. */
  1391. int64_t dts;
  1392. uint8_t *data;
  1393. int size;
  1394. int stream_index;
  1395. /**
  1396. * A combination of AV_PKT_FLAG values
  1397. */
  1398. int flags;
  1399. /**
  1400. * Additional packet data that can be provided by the container.
  1401. * Packet can contain several types of side information.
  1402. */
  1403. AVPacketSideData *side_data;
  1404. int side_data_elems;
  1405. /**
  1406. * Duration of this packet in AVStream->time_base units, 0 if unknown.
  1407. * Equals next_pts - this_pts in presentation order.
  1408. */
  1409. int64_t duration;
  1410. int64_t pos; ///< byte position in stream, -1 if unknown
  1411. #if FF_API_CONVERGENCE_DURATION
  1412. /**
  1413. * @deprecated Same as the duration field, but as int64_t. This was required
  1414. * for Matroska subtitles, whose duration values could overflow when the
  1415. * duration field was still an int.
  1416. */
  1417. attribute_deprecated
  1418. int64_t convergence_duration;
  1419. #endif
  1420. } AVPacket;
  1421. #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
  1422. #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
  1423. /**
  1424. * Flag is used to discard packets which are required to maintain valid
  1425. * decoder state but are not required for output and should be dropped
  1426. * after decoding.
  1427. **/
  1428. #define AV_PKT_FLAG_DISCARD 0x0004
  1429. /**
  1430. * The packet comes from a trusted source.
  1431. *
  1432. * Otherwise-unsafe constructs such as arbitrary pointers to data
  1433. * outside the packet may be followed.
  1434. */
  1435. #define AV_PKT_FLAG_TRUSTED 0x0008
  1436. /**
  1437. * Flag is used to indicate packets that contain frames that can
  1438. * be discarded by the decoder. I.e. Non-reference frames.
  1439. */
  1440. #define AV_PKT_FLAG_DISPOSABLE 0x0010
  1441. enum AVSideDataParamChangeFlags {
  1442. AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
  1443. AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
  1444. AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
  1445. AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
  1446. };
  1447. /**
  1448. * @}
  1449. */
  1450. struct AVCodecInternal;
  1451. enum AVFieldOrder {
  1452. AV_FIELD_UNKNOWN,
  1453. AV_FIELD_PROGRESSIVE,
  1454. AV_FIELD_TT, //< Top coded_first, top displayed first
  1455. AV_FIELD_BB, //< Bottom coded first, bottom displayed first
  1456. AV_FIELD_TB, //< Top coded first, bottom displayed first
  1457. AV_FIELD_BT, //< Bottom coded first, top displayed first
  1458. };
  1459. /**
  1460. * main external API structure.
  1461. * New fields can be added to the end with minor version bumps.
  1462. * Removal, reordering and changes to existing fields require a major
  1463. * version bump.
  1464. * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
  1465. * applications.
  1466. * The name string for AVOptions options matches the associated command line
  1467. * parameter name and can be found in libavcodec/options_table.h
  1468. * The AVOption/command line parameter names differ in some cases from the C
  1469. * structure field names for historic reasons or brevity.
  1470. * sizeof(AVCodecContext) must not be used outside libav*.
  1471. */
  1472. typedef struct AVCodecContext {
  1473. /**
  1474. * information on struct for av_log
  1475. * - set by avcodec_alloc_context3
  1476. */
  1477. const AVClass *av_class;
  1478. int log_level_offset;
  1479. enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
  1480. const struct AVCodec *codec;
  1481. enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
  1482. /**
  1483. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1484. * This is used to work around some encoder bugs.
  1485. * A demuxer should set this to what is stored in the field used to identify the codec.
  1486. * If there are multiple such fields in a container then the demuxer should choose the one
  1487. * which maximizes the information about the used codec.
  1488. * If the codec tag field in a container is larger than 32 bits then the demuxer should
  1489. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  1490. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  1491. * first.
  1492. * - encoding: Set by user, if not then the default based on codec_id will be used.
  1493. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1494. */
  1495. unsigned int codec_tag;
  1496. void *priv_data;
  1497. /**
  1498. * Private context used for internal data.
  1499. *
  1500. * Unlike priv_data, this is not codec-specific. It is used in general
  1501. * libavcodec functions.
  1502. */
  1503. struct AVCodecInternal *internal;
  1504. /**
  1505. * Private data of the user, can be used to carry app specific stuff.
  1506. * - encoding: Set by user.
  1507. * - decoding: Set by user.
  1508. */
  1509. void *opaque;
  1510. /**
  1511. * the average bitrate
  1512. * - encoding: Set by user; unused for constant quantizer encoding.
  1513. * - decoding: Set by user, may be overwritten by libavcodec
  1514. * if this info is available in the stream
  1515. */
  1516. int64_t bit_rate;
  1517. /**
  1518. * number of bits the bitstream is allowed to diverge from the reference.
  1519. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  1520. * - encoding: Set by user; unused for constant quantizer encoding.
  1521. * - decoding: unused
  1522. */
  1523. int bit_rate_tolerance;
  1524. /**
  1525. * Global quality for codecs which cannot change it per frame.
  1526. * This should be proportional to MPEG-1/2/4 qscale.
  1527. * - encoding: Set by user.
  1528. * - decoding: unused
  1529. */
  1530. int global_quality;
  1531. /**
  1532. * - encoding: Set by user.
  1533. * - decoding: unused
  1534. */
  1535. int compression_level;
  1536. #define FF_COMPRESSION_DEFAULT -1
  1537. /**
  1538. * AV_CODEC_FLAG_*.
  1539. * - encoding: Set by user.
  1540. * - decoding: Set by user.
  1541. */
  1542. int flags;
  1543. /**
  1544. * AV_CODEC_FLAG2_*
  1545. * - encoding: Set by user.
  1546. * - decoding: Set by user.
  1547. */
  1548. int flags2;
  1549. /**
  1550. * some codecs need / can use extradata like Huffman tables.
  1551. * MJPEG: Huffman tables
  1552. * rv10: additional flags
  1553. * MPEG-4: global headers (they can be in the bitstream or here)
  1554. * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
  1555. * than extradata_size to avoid problems if it is read with the bitstream reader.
  1556. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  1557. * Must be allocated with the av_malloc() family of functions.
  1558. * - encoding: Set/allocated/freed by libavcodec.
  1559. * - decoding: Set/allocated/freed by user.
  1560. */
  1561. uint8_t *extradata;
  1562. int extradata_size;
  1563. /**
  1564. * This is the fundamental unit of time (in seconds) in terms
  1565. * of which frame timestamps are represented. For fixed-fps content,
  1566. * timebase should be 1/framerate and timestamp increments should be
  1567. * identically 1.
  1568. * This often, but not always is the inverse of the frame rate or field rate
  1569. * for video. 1/time_base is not the average frame rate if the frame rate is not
  1570. * constant.
  1571. *
  1572. * Like containers, elementary streams also can store timestamps, 1/time_base
  1573. * is the unit in which these timestamps are specified.
  1574. * As example of such codec time base see ISO/IEC 14496-2:2001(E)
  1575. * vop_time_increment_resolution and fixed_vop_rate
  1576. * (fixed_vop_rate == 0 implies that it is different from the framerate)
  1577. *
  1578. * - encoding: MUST be set by user.
  1579. * - decoding: the use of this field for decoding is deprecated.
  1580. * Use framerate instead.
  1581. */
  1582. AVRational time_base;
  1583. /**
  1584. * For some codecs, the time base is closer to the field rate than the frame rate.
  1585. * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
  1586. * if no telecine is used ...
  1587. *
  1588. * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
  1589. */
  1590. int ticks_per_frame;
  1591. /**
  1592. * Codec delay.
  1593. *
  1594. * Encoding: Number of frames delay there will be from the encoder input to
  1595. * the decoder output. (we assume the decoder matches the spec)
  1596. * Decoding: Number of frames delay in addition to what a standard decoder
  1597. * as specified in the spec would produce.
  1598. *
  1599. * Video:
  1600. * Number of frames the decoded output will be delayed relative to the
  1601. * encoded input.
  1602. *
  1603. * Audio:
  1604. * For encoding, this field is unused (see initial_padding).
  1605. *
  1606. * For decoding, this is the number of samples the decoder needs to
  1607. * output before the decoder's output is valid. When seeking, you should
  1608. * start decoding this many samples prior to your desired seek point.
  1609. *
  1610. * - encoding: Set by libavcodec.
  1611. * - decoding: Set by libavcodec.
  1612. */
  1613. int delay;
  1614. /* video only */
  1615. /**
  1616. * picture width / height.
  1617. *
  1618. * @note Those fields may not match the values of the last
  1619. * AVFrame output by avcodec_decode_video2 due frame
  1620. * reordering.
  1621. *
  1622. * - encoding: MUST be set by user.
  1623. * - decoding: May be set by the user before opening the decoder if known e.g.
  1624. * from the container. Some decoders will require the dimensions
  1625. * to be set by the caller. During decoding, the decoder may
  1626. * overwrite those values as required while parsing the data.
  1627. */
  1628. int width, height;
  1629. /**
  1630. * Bitstream width / height, may be different from width/height e.g. when
  1631. * the decoded frame is cropped before being output or lowres is enabled.
  1632. *
  1633. * @note Those field may not match the value of the last
  1634. * AVFrame output by avcodec_receive_frame() due frame
  1635. * reordering.
  1636. *
  1637. * - encoding: unused
  1638. * - decoding: May be set by the user before opening the decoder if known
  1639. * e.g. from the container. During decoding, the decoder may
  1640. * overwrite those values as required while parsing the data.
  1641. */
  1642. int coded_width, coded_height;
  1643. /**
  1644. * the number of pictures in a group of pictures, or 0 for intra_only
  1645. * - encoding: Set by user.
  1646. * - decoding: unused
  1647. */
  1648. int gop_size;
  1649. /**
  1650. * Pixel format, see AV_PIX_FMT_xxx.
  1651. * May be set by the demuxer if known from headers.
  1652. * May be overridden by the decoder if it knows better.
  1653. *
  1654. * @note This field may not match the value of the last
  1655. * AVFrame output by avcodec_receive_frame() due frame
  1656. * reordering.
  1657. *
  1658. * - encoding: Set by user.
  1659. * - decoding: Set by user if known, overridden by libavcodec while
  1660. * parsing the data.
  1661. */
  1662. enum AVPixelFormat pix_fmt;
  1663. /**
  1664. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  1665. * decoder to draw a horizontal band. It improves cache usage. Not
  1666. * all codecs can do that. You must check the codec capabilities
  1667. * beforehand.
  1668. * When multithreading is used, it may be called from multiple threads
  1669. * at the same time; threads might draw different parts of the same AVFrame,
  1670. * or multiple AVFrames, and there is no guarantee that slices will be drawn
  1671. * in order.
  1672. * The function is also used by hardware acceleration APIs.
  1673. * It is called at least once during frame decoding to pass
  1674. * the data needed for hardware render.
  1675. * In that mode instead of pixel data, AVFrame points to
  1676. * a structure specific to the acceleration API. The application
  1677. * reads the structure and can change some fields to indicate progress
  1678. * or mark state.
  1679. * - encoding: unused
  1680. * - decoding: Set by user.
  1681. * @param height the height of the slice
  1682. * @param y the y position of the slice
  1683. * @param type 1->top field, 2->bottom field, 3->frame
  1684. * @param offset offset into the AVFrame.data from which the slice should be read
  1685. */
  1686. void (*draw_horiz_band)(struct AVCodecContext *s,
  1687. const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
  1688. int y, int type, int height);
  1689. /**
  1690. * callback to negotiate the pixelFormat
  1691. * @param fmt is the list of formats which are supported by the codec,
  1692. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1693. * The first is always the native one.
  1694. * @note The callback may be called again immediately if initialization for
  1695. * the selected (hardware-accelerated) pixel format failed.
  1696. * @warning Behavior is undefined if the callback returns a value not
  1697. * in the fmt list of formats.
  1698. * @return the chosen format
  1699. * - encoding: unused
  1700. * - decoding: Set by user, if not set the native format will be chosen.
  1701. */
  1702. enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
  1703. /**
  1704. * maximum number of B-frames between non-B-frames
  1705. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  1706. * - encoding: Set by user.
  1707. * - decoding: unused
  1708. */
  1709. int max_b_frames;
  1710. /**
  1711. * qscale factor between IP and B-frames
  1712. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  1713. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1714. * - encoding: Set by user.
  1715. * - decoding: unused
  1716. */
  1717. float b_quant_factor;
  1718. #if FF_API_PRIVATE_OPT
  1719. /** @deprecated use encoder private options instead */
  1720. attribute_deprecated
  1721. int b_frame_strategy;
  1722. #endif
  1723. /**
  1724. * qscale offset between IP and B-frames
  1725. * - encoding: Set by user.
  1726. * - decoding: unused
  1727. */
  1728. float b_quant_offset;
  1729. /**
  1730. * Size of the frame reordering buffer in the decoder.
  1731. * For MPEG-2 it is 1 IPB or 0 low delay IP.
  1732. * - encoding: Set by libavcodec.
  1733. * - decoding: Set by libavcodec.
  1734. */
  1735. int has_b_frames;
  1736. #if FF_API_PRIVATE_OPT
  1737. /** @deprecated use encoder private options instead */
  1738. attribute_deprecated
  1739. int mpeg_quant;
  1740. #endif
  1741. /**
  1742. * qscale factor between P- and I-frames
  1743. * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
  1744. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1745. * - encoding: Set by user.
  1746. * - decoding: unused
  1747. */
  1748. float i_quant_factor;
  1749. /**
  1750. * qscale offset between P and I-frames
  1751. * - encoding: Set by user.
  1752. * - decoding: unused
  1753. */
  1754. float i_quant_offset;
  1755. /**
  1756. * luminance masking (0-> disabled)
  1757. * - encoding: Set by user.
  1758. * - decoding: unused
  1759. */
  1760. float lumi_masking;
  1761. /**
  1762. * temporary complexity masking (0-> disabled)
  1763. * - encoding: Set by user.
  1764. * - decoding: unused
  1765. */
  1766. float temporal_cplx_masking;
  1767. /**
  1768. * spatial complexity masking (0-> disabled)
  1769. * - encoding: Set by user.
  1770. * - decoding: unused
  1771. */
  1772. float spatial_cplx_masking;
  1773. /**
  1774. * p block masking (0-> disabled)
  1775. * - encoding: Set by user.
  1776. * - decoding: unused
  1777. */
  1778. float p_masking;
  1779. /**
  1780. * darkness masking (0-> disabled)
  1781. * - encoding: Set by user.
  1782. * - decoding: unused
  1783. */
  1784. float dark_masking;
  1785. /**
  1786. * slice count
  1787. * - encoding: Set by libavcodec.
  1788. * - decoding: Set by user (or 0).
  1789. */
  1790. int slice_count;
  1791. #if FF_API_PRIVATE_OPT
  1792. /** @deprecated use encoder private options instead */
  1793. attribute_deprecated
  1794. int prediction_method;
  1795. #define FF_PRED_LEFT 0
  1796. #define FF_PRED_PLANE 1
  1797. #define FF_PRED_MEDIAN 2
  1798. #endif
  1799. /**
  1800. * slice offsets in the frame in bytes
  1801. * - encoding: Set/allocated by libavcodec.
  1802. * - decoding: Set/allocated by user (or NULL).
  1803. */
  1804. int *slice_offset;
  1805. /**
  1806. * sample aspect ratio (0 if unknown)
  1807. * That is the width of a pixel divided by the height of the pixel.
  1808. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1809. * - encoding: Set by user.
  1810. * - decoding: Set by libavcodec.
  1811. */
  1812. AVRational sample_aspect_ratio;
  1813. /**
  1814. * motion estimation comparison function
  1815. * - encoding: Set by user.
  1816. * - decoding: unused
  1817. */
  1818. int me_cmp;
  1819. /**
  1820. * subpixel motion estimation comparison function
  1821. * - encoding: Set by user.
  1822. * - decoding: unused
  1823. */
  1824. int me_sub_cmp;
  1825. /**
  1826. * macroblock comparison function (not supported yet)
  1827. * - encoding: Set by user.
  1828. * - decoding: unused
  1829. */
  1830. int mb_cmp;
  1831. /**
  1832. * interlaced DCT comparison function
  1833. * - encoding: Set by user.
  1834. * - decoding: unused
  1835. */
  1836. int ildct_cmp;
  1837. #define FF_CMP_SAD 0
  1838. #define FF_CMP_SSE 1
  1839. #define FF_CMP_SATD 2
  1840. #define FF_CMP_DCT 3
  1841. #define FF_CMP_PSNR 4
  1842. #define FF_CMP_BIT 5
  1843. #define FF_CMP_RD 6
  1844. #define FF_CMP_ZERO 7
  1845. #define FF_CMP_VSAD 8
  1846. #define FF_CMP_VSSE 9
  1847. #define FF_CMP_NSSE 10
  1848. #define FF_CMP_W53 11
  1849. #define FF_CMP_W97 12
  1850. #define FF_CMP_DCTMAX 13
  1851. #define FF_CMP_DCT264 14
  1852. #define FF_CMP_MEDIAN_SAD 15
  1853. #define FF_CMP_CHROMA 256
  1854. /**
  1855. * ME diamond size & shape
  1856. * - encoding: Set by user.
  1857. * - decoding: unused
  1858. */
  1859. int dia_size;
  1860. /**
  1861. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1862. * - encoding: Set by user.
  1863. * - decoding: unused
  1864. */
  1865. int last_predictor_count;
  1866. #if FF_API_PRIVATE_OPT
  1867. /** @deprecated use encoder private options instead */
  1868. attribute_deprecated
  1869. int pre_me;
  1870. #endif
  1871. /**
  1872. * motion estimation prepass comparison function
  1873. * - encoding: Set by user.
  1874. * - decoding: unused
  1875. */
  1876. int me_pre_cmp;
  1877. /**
  1878. * ME prepass diamond size & shape
  1879. * - encoding: Set by user.
  1880. * - decoding: unused
  1881. */
  1882. int pre_dia_size;
  1883. /**
  1884. * subpel ME quality
  1885. * - encoding: Set by user.
  1886. * - decoding: unused
  1887. */
  1888. int me_subpel_quality;
  1889. /**
  1890. * maximum motion estimation search range in subpel units
  1891. * If 0 then no limit.
  1892. *
  1893. * - encoding: Set by user.
  1894. * - decoding: unused
  1895. */
  1896. int me_range;
  1897. /**
  1898. * slice flags
  1899. * - encoding: unused
  1900. * - decoding: Set by user.
  1901. */
  1902. int slice_flags;
  1903. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1904. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
  1905. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1906. /**
  1907. * macroblock decision mode
  1908. * - encoding: Set by user.
  1909. * - decoding: unused
  1910. */
  1911. int mb_decision;
  1912. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1913. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1914. #define FF_MB_DECISION_RD 2 ///< rate distortion
  1915. /**
  1916. * custom intra quantization matrix
  1917. * Must be allocated with the av_malloc() family of functions, and will be freed in
  1918. * avcodec_free_context().
  1919. * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
  1920. * - decoding: Set/allocated/freed by libavcodec.
  1921. */
  1922. uint16_t *intra_matrix;
  1923. /**
  1924. * custom inter quantization matrix
  1925. * Must be allocated with the av_malloc() family of functions, and will be freed in
  1926. * avcodec_free_context().
  1927. * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
  1928. * - decoding: Set/allocated/freed by libavcodec.
  1929. */
  1930. uint16_t *inter_matrix;
  1931. #if FF_API_PRIVATE_OPT
  1932. /** @deprecated use encoder private options instead */
  1933. attribute_deprecated
  1934. int scenechange_threshold;
  1935. /** @deprecated use encoder private options instead */
  1936. attribute_deprecated
  1937. int noise_reduction;
  1938. #endif
  1939. /**
  1940. * precision of the intra DC coefficient - 8
  1941. * - encoding: Set by user.
  1942. * - decoding: Set by libavcodec
  1943. */
  1944. int intra_dc_precision;
  1945. /**
  1946. * Number of macroblock rows at the top which are skipped.
  1947. * - encoding: unused
  1948. * - decoding: Set by user.
  1949. */
  1950. int skip_top;
  1951. /**
  1952. * Number of macroblock rows at the bottom which are skipped.
  1953. * - encoding: unused
  1954. * - decoding: Set by user.
  1955. */
  1956. int skip_bottom;
  1957. /**
  1958. * minimum MB Lagrange multiplier
  1959. * - encoding: Set by user.
  1960. * - decoding: unused
  1961. */
  1962. int mb_lmin;
  1963. /**
  1964. * maximum MB Lagrange multiplier
  1965. * - encoding: Set by user.
  1966. * - decoding: unused
  1967. */
  1968. int mb_lmax;
  1969. #if FF_API_PRIVATE_OPT
  1970. /**
  1971. * @deprecated use encoder private options instead
  1972. */
  1973. attribute_deprecated
  1974. int me_penalty_compensation;
  1975. #endif
  1976. /**
  1977. * - encoding: Set by user.
  1978. * - decoding: unused
  1979. */
  1980. int bidir_refine;
  1981. #if FF_API_PRIVATE_OPT
  1982. /** @deprecated use encoder private options instead */
  1983. attribute_deprecated
  1984. int brd_scale;
  1985. #endif
  1986. /**
  1987. * minimum GOP size
  1988. * - encoding: Set by user.
  1989. * - decoding: unused
  1990. */
  1991. int keyint_min;
  1992. /**
  1993. * number of reference frames
  1994. * - encoding: Set by user.
  1995. * - decoding: Set by lavc.
  1996. */
  1997. int refs;
  1998. #if FF_API_PRIVATE_OPT
  1999. /** @deprecated use encoder private options instead */
  2000. attribute_deprecated
  2001. int chromaoffset;
  2002. #endif
  2003. /**
  2004. * Note: Value depends upon the compare function used for fullpel ME.
  2005. * - encoding: Set by user.
  2006. * - decoding: unused
  2007. */
  2008. int mv0_threshold;
  2009. #if FF_API_PRIVATE_OPT
  2010. /** @deprecated use encoder private options instead */
  2011. attribute_deprecated
  2012. int b_sensitivity;
  2013. #endif
  2014. /**
  2015. * Chromaticity coordinates of the source primaries.
  2016. * - encoding: Set by user
  2017. * - decoding: Set by libavcodec
  2018. */
  2019. enum AVColorPrimaries color_primaries;
  2020. /**
  2021. * Color Transfer Characteristic.
  2022. * - encoding: Set by user
  2023. * - decoding: Set by libavcodec
  2024. */
  2025. enum AVColorTransferCharacteristic color_trc;
  2026. /**
  2027. * YUV colorspace type.
  2028. * - encoding: Set by user
  2029. * - decoding: Set by libavcodec
  2030. */
  2031. enum AVColorSpace colorspace;
  2032. /**
  2033. * MPEG vs JPEG YUV range.
  2034. * - encoding: Set by user
  2035. * - decoding: Set by libavcodec
  2036. */
  2037. enum AVColorRange color_range;
  2038. /**
  2039. * This defines the location of chroma samples.
  2040. * - encoding: Set by user
  2041. * - decoding: Set by libavcodec
  2042. */
  2043. enum AVChromaLocation chroma_sample_location;
  2044. /**
  2045. * Number of slices.
  2046. * Indicates number of picture subdivisions. Used for parallelized
  2047. * decoding.
  2048. * - encoding: Set by user
  2049. * - decoding: unused
  2050. */
  2051. int slices;
  2052. /** Field order
  2053. * - encoding: set by libavcodec
  2054. * - decoding: Set by user.
  2055. */
  2056. enum AVFieldOrder field_order;
  2057. /* audio only */
  2058. int sample_rate; ///< samples per second
  2059. int channels; ///< number of audio channels
  2060. /**
  2061. * audio sample format
  2062. * - encoding: Set by user.
  2063. * - decoding: Set by libavcodec.
  2064. */
  2065. enum AVSampleFormat sample_fmt; ///< sample format
  2066. /* The following data should not be initialized. */
  2067. /**
  2068. * Number of samples per channel in an audio frame.
  2069. *
  2070. * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
  2071. * except the last must contain exactly frame_size samples per channel.
  2072. * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
  2073. * frame size is not restricted.
  2074. * - decoding: may be set by some decoders to indicate constant frame size
  2075. */
  2076. int frame_size;
  2077. /**
  2078. * Frame counter, set by libavcodec.
  2079. *
  2080. * - decoding: total number of frames returned from the decoder so far.
  2081. * - encoding: total number of frames passed to the encoder so far.
  2082. *
  2083. * @note the counter is not incremented if encoding/decoding resulted in
  2084. * an error.
  2085. */
  2086. int frame_number;
  2087. /**
  2088. * number of bytes per packet if constant and known or 0
  2089. * Used by some WAV based audio codecs.
  2090. */
  2091. int block_align;
  2092. /**
  2093. * Audio cutoff bandwidth (0 means "automatic")
  2094. * - encoding: Set by user.
  2095. * - decoding: unused
  2096. */
  2097. int cutoff;
  2098. /**
  2099. * Audio channel layout.
  2100. * - encoding: set by user.
  2101. * - decoding: set by user, may be overwritten by libavcodec.
  2102. */
  2103. uint64_t channel_layout;
  2104. /**
  2105. * Request decoder to use this channel layout if it can (0 for default)
  2106. * - encoding: unused
  2107. * - decoding: Set by user.
  2108. */
  2109. uint64_t request_channel_layout;
  2110. /**
  2111. * Type of service that the audio stream conveys.
  2112. * - encoding: Set by user.
  2113. * - decoding: Set by libavcodec.
  2114. */
  2115. enum AVAudioServiceType audio_service_type;
  2116. /**
  2117. * desired sample format
  2118. * - encoding: Not used.
  2119. * - decoding: Set by user.
  2120. * Decoder will decode to this format if it can.
  2121. */
  2122. enum AVSampleFormat request_sample_fmt;
  2123. /**
  2124. * This callback is called at the beginning of each frame to get data
  2125. * buffer(s) for it. There may be one contiguous buffer for all the data or
  2126. * there may be a buffer per each data plane or anything in between. What
  2127. * this means is, you may set however many entries in buf[] you feel necessary.
  2128. * Each buffer must be reference-counted using the AVBuffer API (see description
  2129. * of buf[] below).
  2130. *
  2131. * The following fields will be set in the frame before this callback is
  2132. * called:
  2133. * - format
  2134. * - width, height (video only)
  2135. * - sample_rate, channel_layout, nb_samples (audio only)
  2136. * Their values may differ from the corresponding values in
  2137. * AVCodecContext. This callback must use the frame values, not the codec
  2138. * context values, to calculate the required buffer size.
  2139. *
  2140. * This callback must fill the following fields in the frame:
  2141. * - data[]
  2142. * - linesize[]
  2143. * - extended_data:
  2144. * * if the data is planar audio with more than 8 channels, then this
  2145. * callback must allocate and fill extended_data to contain all pointers
  2146. * to all data planes. data[] must hold as many pointers as it can.
  2147. * extended_data must be allocated with av_malloc() and will be freed in
  2148. * av_frame_unref().
  2149. * * otherwise extended_data must point to data
  2150. * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
  2151. * the frame's data and extended_data pointers must be contained in these. That
  2152. * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
  2153. * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
  2154. * and av_buffer_ref().
  2155. * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
  2156. * this callback and filled with the extra buffers if there are more
  2157. * buffers than buf[] can hold. extended_buf will be freed in
  2158. * av_frame_unref().
  2159. *
  2160. * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
  2161. * avcodec_default_get_buffer2() instead of providing buffers allocated by
  2162. * some other means.
  2163. *
  2164. * Each data plane must be aligned to the maximum required by the target
  2165. * CPU.
  2166. *
  2167. * @see avcodec_default_get_buffer2()
  2168. *
  2169. * Video:
  2170. *
  2171. * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
  2172. * (read and/or written to if it is writable) later by libavcodec.
  2173. *
  2174. * avcodec_align_dimensions2() should be used to find the required width and
  2175. * height, as they normally need to be rounded up to the next multiple of 16.
  2176. *
  2177. * Some decoders do not support linesizes changing between frames.
  2178. *
  2179. * If frame multithreading is used and thread_safe_callbacks is set,
  2180. * this callback may be called from a different thread, but not from more
  2181. * than one at once. Does not need to be reentrant.
  2182. *
  2183. * @see avcodec_align_dimensions2()
  2184. *
  2185. * Audio:
  2186. *
  2187. * Decoders request a buffer of a particular size by setting
  2188. * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
  2189. * however, utilize only part of the buffer by setting AVFrame.nb_samples
  2190. * to a smaller value in the output frame.
  2191. *
  2192. * As a convenience, av_samples_get_buffer_size() and
  2193. * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
  2194. * functions to find the required data size and to fill data pointers and
  2195. * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
  2196. * since all planes must be the same size.
  2197. *
  2198. * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
  2199. *
  2200. * - encoding: unused
  2201. * - decoding: Set by libavcodec, user can override.
  2202. */
  2203. int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
  2204. /**
  2205. * If non-zero, the decoded audio and video frames returned from
  2206. * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
  2207. * and are valid indefinitely. The caller must free them with
  2208. * av_frame_unref() when they are not needed anymore.
  2209. * Otherwise, the decoded frames must not be freed by the caller and are
  2210. * only valid until the next decode call.
  2211. *
  2212. * This is always automatically enabled if avcodec_receive_frame() is used.
  2213. *
  2214. * - encoding: unused
  2215. * - decoding: set by the caller before avcodec_open2().
  2216. */
  2217. attribute_deprecated
  2218. int refcounted_frames;
  2219. /* - encoding parameters */
  2220. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  2221. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  2222. /**
  2223. * minimum quantizer
  2224. * - encoding: Set by user.
  2225. * - decoding: unused
  2226. */
  2227. int qmin;
  2228. /**
  2229. * maximum quantizer
  2230. * - encoding: Set by user.
  2231. * - decoding: unused
  2232. */
  2233. int qmax;
  2234. /**
  2235. * maximum quantizer difference between frames
  2236. * - encoding: Set by user.
  2237. * - decoding: unused
  2238. */
  2239. int max_qdiff;
  2240. /**
  2241. * decoder bitstream buffer size
  2242. * - encoding: Set by user.
  2243. * - decoding: unused
  2244. */
  2245. int rc_buffer_size;
  2246. /**
  2247. * ratecontrol override, see RcOverride
  2248. * - encoding: Allocated/set/freed by user.
  2249. * - decoding: unused
  2250. */
  2251. int rc_override_count;
  2252. RcOverride *rc_override;
  2253. /**
  2254. * maximum bitrate
  2255. * - encoding: Set by user.
  2256. * - decoding: Set by user, may be overwritten by libavcodec.
  2257. */
  2258. int64_t rc_max_rate;
  2259. /**
  2260. * minimum bitrate
  2261. * - encoding: Set by user.
  2262. * - decoding: unused
  2263. */
  2264. int64_t rc_min_rate;
  2265. /**
  2266. * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
  2267. * - encoding: Set by user.
  2268. * - decoding: unused.
  2269. */
  2270. float rc_max_available_vbv_use;
  2271. /**
  2272. * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
  2273. * - encoding: Set by user.
  2274. * - decoding: unused.
  2275. */
  2276. float rc_min_vbv_overflow_use;
  2277. /**
  2278. * Number of bits which should be loaded into the rc buffer before decoding starts.
  2279. * - encoding: Set by user.
  2280. * - decoding: unused
  2281. */
  2282. int rc_initial_buffer_occupancy;
  2283. #if FF_API_CODER_TYPE
  2284. #define FF_CODER_TYPE_VLC 0
  2285. #define FF_CODER_TYPE_AC 1
  2286. #define FF_CODER_TYPE_RAW 2
  2287. #define FF_CODER_TYPE_RLE 3
  2288. /**
  2289. * @deprecated use encoder private options instead
  2290. */
  2291. attribute_deprecated
  2292. int coder_type;
  2293. #endif /* FF_API_CODER_TYPE */
  2294. #if FF_API_PRIVATE_OPT
  2295. /** @deprecated use encoder private options instead */
  2296. attribute_deprecated
  2297. int context_model;
  2298. #endif
  2299. #if FF_API_PRIVATE_OPT
  2300. /** @deprecated use encoder private options instead */
  2301. attribute_deprecated
  2302. int frame_skip_threshold;
  2303. /** @deprecated use encoder private options instead */
  2304. attribute_deprecated
  2305. int frame_skip_factor;
  2306. /** @deprecated use encoder private options instead */
  2307. attribute_deprecated
  2308. int frame_skip_exp;
  2309. /** @deprecated use encoder private options instead */
  2310. attribute_deprecated
  2311. int frame_skip_cmp;
  2312. #endif /* FF_API_PRIVATE_OPT */
  2313. /**
  2314. * trellis RD quantization
  2315. * - encoding: Set by user.
  2316. * - decoding: unused
  2317. */
  2318. int trellis;
  2319. #if FF_API_PRIVATE_OPT
  2320. /** @deprecated use encoder private options instead */
  2321. attribute_deprecated
  2322. int min_prediction_order;
  2323. /** @deprecated use encoder private options instead */
  2324. attribute_deprecated
  2325. int max_prediction_order;
  2326. /** @deprecated use encoder private options instead */
  2327. attribute_deprecated
  2328. int64_t timecode_frame_start;
  2329. #endif
  2330. #if FF_API_RTP_CALLBACK
  2331. /**
  2332. * @deprecated unused
  2333. */
  2334. /* The RTP callback: This function is called */
  2335. /* every time the encoder has a packet to send. */
  2336. /* It depends on the encoder if the data starts */
  2337. /* with a Start Code (it should). H.263 does. */
  2338. /* mb_nb contains the number of macroblocks */
  2339. /* encoded in the RTP payload. */
  2340. attribute_deprecated
  2341. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  2342. #endif
  2343. #if FF_API_PRIVATE_OPT
  2344. /** @deprecated use encoder private options instead */
  2345. attribute_deprecated
  2346. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  2347. /* do its best to deliver a chunk with size */
  2348. /* below rtp_payload_size, the chunk will start */
  2349. /* with a start code on some codecs like H.263. */
  2350. /* This doesn't take account of any particular */
  2351. /* headers inside the transmitted RTP payload. */
  2352. #endif
  2353. #if FF_API_STAT_BITS
  2354. /* statistics, used for 2-pass encoding */
  2355. attribute_deprecated
  2356. int mv_bits;
  2357. attribute_deprecated
  2358. int header_bits;
  2359. attribute_deprecated
  2360. int i_tex_bits;
  2361. attribute_deprecated
  2362. int p_tex_bits;
  2363. attribute_deprecated
  2364. int i_count;
  2365. attribute_deprecated
  2366. int p_count;
  2367. attribute_deprecated
  2368. int skip_count;
  2369. attribute_deprecated
  2370. int misc_bits;
  2371. /** @deprecated this field is unused */
  2372. attribute_deprecated
  2373. int frame_bits;
  2374. #endif
  2375. /**
  2376. * pass1 encoding statistics output buffer
  2377. * - encoding: Set by libavcodec.
  2378. * - decoding: unused
  2379. */
  2380. char *stats_out;
  2381. /**
  2382. * pass2 encoding statistics input buffer
  2383. * Concatenated stuff from stats_out of pass1 should be placed here.
  2384. * - encoding: Allocated/set/freed by user.
  2385. * - decoding: unused
  2386. */
  2387. char *stats_in;
  2388. /**
  2389. * Work around bugs in encoders which sometimes cannot be detected automatically.
  2390. * - encoding: Set by user
  2391. * - decoding: Set by user
  2392. */
  2393. int workaround_bugs;
  2394. #define FF_BUG_AUTODETECT 1 ///< autodetection
  2395. #define FF_BUG_XVID_ILACE 4
  2396. #define FF_BUG_UMP4 8
  2397. #define FF_BUG_NO_PADDING 16
  2398. #define FF_BUG_AMV 32
  2399. #define FF_BUG_QPEL_CHROMA 64
  2400. #define FF_BUG_STD_QPEL 128
  2401. #define FF_BUG_QPEL_CHROMA2 256
  2402. #define FF_BUG_DIRECT_BLOCKSIZE 512
  2403. #define FF_BUG_EDGE 1024
  2404. #define FF_BUG_HPEL_CHROMA 2048
  2405. #define FF_BUG_DC_CLIP 4096
  2406. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  2407. #define FF_BUG_TRUNCATED 16384
  2408. #define FF_BUG_IEDGE 32768
  2409. /**
  2410. * strictly follow the standard (MPEG-4, ...).
  2411. * - encoding: Set by user.
  2412. * - decoding: Set by user.
  2413. * Setting this to STRICT or higher means the encoder and decoder will
  2414. * generally do stupid things, whereas setting it to unofficial or lower
  2415. * will mean the encoder might produce output that is not supported by all
  2416. * spec-compliant decoders. Decoders don't differentiate between normal,
  2417. * unofficial and experimental (that is, they always try to decode things
  2418. * when they can) unless they are explicitly asked to behave stupidly
  2419. * (=strictly conform to the specs)
  2420. */
  2421. int strict_std_compliance;
  2422. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
  2423. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  2424. #define FF_COMPLIANCE_NORMAL 0
  2425. #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
  2426. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  2427. /**
  2428. * error concealment flags
  2429. * - encoding: unused
  2430. * - decoding: Set by user.
  2431. */
  2432. int error_concealment;
  2433. #define FF_EC_GUESS_MVS 1
  2434. #define FF_EC_DEBLOCK 2
  2435. #define FF_EC_FAVOR_INTER 256
  2436. /**
  2437. * debug
  2438. * - encoding: Set by user.
  2439. * - decoding: Set by user.
  2440. */
  2441. int debug;
  2442. #define FF_DEBUG_PICT_INFO 1
  2443. #define FF_DEBUG_RC 2
  2444. #define FF_DEBUG_BITSTREAM 4
  2445. #define FF_DEBUG_MB_TYPE 8
  2446. #define FF_DEBUG_QP 16
  2447. #if FF_API_DEBUG_MV
  2448. /**
  2449. * @deprecated this option does nothing
  2450. */
  2451. #define FF_DEBUG_MV 32
  2452. #endif
  2453. #define FF_DEBUG_DCT_COEFF 0x00000040
  2454. #define FF_DEBUG_SKIP 0x00000080
  2455. #define FF_DEBUG_STARTCODE 0x00000100
  2456. #define FF_DEBUG_ER 0x00000400
  2457. #define FF_DEBUG_MMCO 0x00000800
  2458. #define FF_DEBUG_BUGS 0x00001000
  2459. #if FF_API_DEBUG_MV
  2460. #define FF_DEBUG_VIS_QP 0x00002000
  2461. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  2462. #endif
  2463. #define FF_DEBUG_BUFFERS 0x00008000
  2464. #define FF_DEBUG_THREADS 0x00010000
  2465. #define FF_DEBUG_GREEN_MD 0x00800000
  2466. #define FF_DEBUG_NOMC 0x01000000
  2467. #if FF_API_DEBUG_MV
  2468. /**
  2469. * debug
  2470. * - encoding: Set by user.
  2471. * - decoding: Set by user.
  2472. */
  2473. int debug_mv;
  2474. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
  2475. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
  2476. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
  2477. #endif
  2478. /**
  2479. * Error recognition; may misdetect some more or less valid parts as errors.
  2480. * - encoding: unused
  2481. * - decoding: Set by user.
  2482. */
  2483. int err_recognition;
  2484. /**
  2485. * Verify checksums embedded in the bitstream (could be of either encoded or
  2486. * decoded data, depending on the codec) and print an error message on mismatch.
  2487. * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
  2488. * decoder returning an error.
  2489. */
  2490. #define AV_EF_CRCCHECK (1<<0)
  2491. #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
  2492. #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
  2493. #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
  2494. #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
  2495. #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
  2496. #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
  2497. #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
  2498. /**
  2499. * opaque 64-bit number (generally a PTS) that will be reordered and
  2500. * output in AVFrame.reordered_opaque
  2501. * - encoding: Set by libavcodec to the reordered_opaque of the input
  2502. * frame corresponding to the last returned packet. Only
  2503. * supported by encoders with the
  2504. * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
  2505. * - decoding: Set by user.
  2506. */
  2507. int64_t reordered_opaque;
  2508. /**
  2509. * Hardware accelerator in use
  2510. * - encoding: unused.
  2511. * - decoding: Set by libavcodec
  2512. */
  2513. const struct AVHWAccel *hwaccel;
  2514. /**
  2515. * Hardware accelerator context.
  2516. * For some hardware accelerators, a global context needs to be
  2517. * provided by the user. In that case, this holds display-dependent
  2518. * data FFmpeg cannot instantiate itself. Please refer to the
  2519. * FFmpeg HW accelerator documentation to know how to fill this
  2520. * is. e.g. for VA API, this is a struct vaapi_context.
  2521. * - encoding: unused
  2522. * - decoding: Set by user
  2523. */
  2524. void *hwaccel_context;
  2525. /**
  2526. * error
  2527. * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
  2528. * - decoding: unused
  2529. */
  2530. uint64_t error[AV_NUM_DATA_POINTERS];
  2531. /**
  2532. * DCT algorithm, see FF_DCT_* below
  2533. * - encoding: Set by user.
  2534. * - decoding: unused
  2535. */
  2536. int dct_algo;
  2537. #define FF_DCT_AUTO 0
  2538. #define FF_DCT_FASTINT 1
  2539. #define FF_DCT_INT 2
  2540. #define FF_DCT_MMX 3
  2541. #define FF_DCT_ALTIVEC 5
  2542. #define FF_DCT_FAAN 6
  2543. /**
  2544. * IDCT algorithm, see FF_IDCT_* below.
  2545. * - encoding: Set by user.
  2546. * - decoding: Set by user.
  2547. */
  2548. int idct_algo;
  2549. #define FF_IDCT_AUTO 0
  2550. #define FF_IDCT_INT 1
  2551. #define FF_IDCT_SIMPLE 2
  2552. #define FF_IDCT_SIMPLEMMX 3
  2553. #define FF_IDCT_ARM 7
  2554. #define FF_IDCT_ALTIVEC 8
  2555. #define FF_IDCT_SIMPLEARM 10
  2556. #define FF_IDCT_XVID 14
  2557. #define FF_IDCT_SIMPLEARMV5TE 16
  2558. #define FF_IDCT_SIMPLEARMV6 17
  2559. #define FF_IDCT_FAAN 20
  2560. #define FF_IDCT_SIMPLENEON 22
  2561. #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
  2562. #define FF_IDCT_SIMPLEAUTO 128
  2563. /**
  2564. * bits per sample/pixel from the demuxer (needed for huffyuv).
  2565. * - encoding: Set by libavcodec.
  2566. * - decoding: Set by user.
  2567. */
  2568. int bits_per_coded_sample;
  2569. /**
  2570. * Bits per sample/pixel of internal libavcodec pixel/sample format.
  2571. * - encoding: set by user.
  2572. * - decoding: set by libavcodec.
  2573. */
  2574. int bits_per_raw_sample;
  2575. #if FF_API_LOWRES
  2576. /**
  2577. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  2578. * - encoding: unused
  2579. * - decoding: Set by user.
  2580. */
  2581. int lowres;
  2582. #endif
  2583. #if FF_API_CODED_FRAME
  2584. /**
  2585. * the picture in the bitstream
  2586. * - encoding: Set by libavcodec.
  2587. * - decoding: unused
  2588. *
  2589. * @deprecated use the quality factor packet side data instead
  2590. */
  2591. attribute_deprecated AVFrame *coded_frame;
  2592. #endif
  2593. /**
  2594. * thread count
  2595. * is used to decide how many independent tasks should be passed to execute()
  2596. * - encoding: Set by user.
  2597. * - decoding: Set by user.
  2598. */
  2599. int thread_count;
  2600. /**
  2601. * Which multithreading methods to use.
  2602. * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
  2603. * so clients which cannot provide future frames should not use it.
  2604. *
  2605. * - encoding: Set by user, otherwise the default is used.
  2606. * - decoding: Set by user, otherwise the default is used.
  2607. */
  2608. int thread_type;
  2609. #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
  2610. #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
  2611. /**
  2612. * Which multithreading methods are in use by the codec.
  2613. * - encoding: Set by libavcodec.
  2614. * - decoding: Set by libavcodec.
  2615. */
  2616. int active_thread_type;
  2617. /**
  2618. * Set by the client if its custom get_buffer() callback can be called
  2619. * synchronously from another thread, which allows faster multithreaded decoding.
  2620. * draw_horiz_band() will be called from other threads regardless of this setting.
  2621. * Ignored if the default get_buffer() is used.
  2622. * - encoding: Set by user.
  2623. * - decoding: Set by user.
  2624. */
  2625. int thread_safe_callbacks;
  2626. /**
  2627. * The codec may call this to execute several independent things.
  2628. * It will return only after finishing all tasks.
  2629. * The user may replace this with some multithreaded implementation,
  2630. * the default implementation will execute the parts serially.
  2631. * @param count the number of things to execute
  2632. * - encoding: Set by libavcodec, user can override.
  2633. * - decoding: Set by libavcodec, user can override.
  2634. */
  2635. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
  2636. /**
  2637. * The codec may call this to execute several independent things.
  2638. * It will return only after finishing all tasks.
  2639. * The user may replace this with some multithreaded implementation,
  2640. * the default implementation will execute the parts serially.
  2641. * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
  2642. * @param c context passed also to func
  2643. * @param count the number of things to execute
  2644. * @param arg2 argument passed unchanged to func
  2645. * @param ret return values of executed functions, must have space for "count" values. May be NULL.
  2646. * @param func function that will be called count times, with jobnr from 0 to count-1.
  2647. * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
  2648. * two instances of func executing at the same time will have the same threadnr.
  2649. * @return always 0 currently, but code should handle a future improvement where when any call to func
  2650. * returns < 0 no further calls to func may be done and < 0 is returned.
  2651. * - encoding: Set by libavcodec, user can override.
  2652. * - decoding: Set by libavcodec, user can override.
  2653. */
  2654. int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
  2655. /**
  2656. * noise vs. sse weight for the nsse comparison function
  2657. * - encoding: Set by user.
  2658. * - decoding: unused
  2659. */
  2660. int nsse_weight;
  2661. /**
  2662. * profile
  2663. * - encoding: Set by user.
  2664. * - decoding: Set by libavcodec.
  2665. */
  2666. int profile;
  2667. #define FF_PROFILE_UNKNOWN -99
  2668. #define FF_PROFILE_RESERVED -100
  2669. #define FF_PROFILE_AAC_MAIN 0
  2670. #define FF_PROFILE_AAC_LOW 1
  2671. #define FF_PROFILE_AAC_SSR 2
  2672. #define FF_PROFILE_AAC_LTP 3
  2673. #define FF_PROFILE_AAC_HE 4
  2674. #define FF_PROFILE_AAC_HE_V2 28
  2675. #define FF_PROFILE_AAC_LD 22
  2676. #define FF_PROFILE_AAC_ELD 38
  2677. #define FF_PROFILE_MPEG2_AAC_LOW 128
  2678. #define FF_PROFILE_MPEG2_AAC_HE 131
  2679. #define FF_PROFILE_DNXHD 0
  2680. #define FF_PROFILE_DNXHR_LB 1
  2681. #define FF_PROFILE_DNXHR_SQ 2
  2682. #define FF_PROFILE_DNXHR_HQ 3
  2683. #define FF_PROFILE_DNXHR_HQX 4
  2684. #define FF_PROFILE_DNXHR_444 5
  2685. #define FF_PROFILE_DTS 20
  2686. #define FF_PROFILE_DTS_ES 30
  2687. #define FF_PROFILE_DTS_96_24 40
  2688. #define FF_PROFILE_DTS_HD_HRA 50
  2689. #define FF_PROFILE_DTS_HD_MA 60
  2690. #define FF_PROFILE_DTS_EXPRESS 70
  2691. #define FF_PROFILE_MPEG2_422 0
  2692. #define FF_PROFILE_MPEG2_HIGH 1
  2693. #define FF_PROFILE_MPEG2_SS 2
  2694. #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
  2695. #define FF_PROFILE_MPEG2_MAIN 4
  2696. #define FF_PROFILE_MPEG2_SIMPLE 5
  2697. #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
  2698. #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
  2699. #define FF_PROFILE_H264_BASELINE 66
  2700. #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
  2701. #define FF_PROFILE_H264_MAIN 77
  2702. #define FF_PROFILE_H264_EXTENDED 88
  2703. #define FF_PROFILE_H264_HIGH 100
  2704. #define FF_PROFILE_H264_HIGH_10 110
  2705. #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
  2706. #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
  2707. #define FF_PROFILE_H264_HIGH_422 122
  2708. #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
  2709. #define FF_PROFILE_H264_STEREO_HIGH 128
  2710. #define FF_PROFILE_H264_HIGH_444 144
  2711. #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
  2712. #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
  2713. #define FF_PROFILE_H264_CAVLC_444 44
  2714. #define FF_PROFILE_VC1_SIMPLE 0
  2715. #define FF_PROFILE_VC1_MAIN 1
  2716. #define FF_PROFILE_VC1_COMPLEX 2
  2717. #define FF_PROFILE_VC1_ADVANCED 3
  2718. #define FF_PROFILE_MPEG4_SIMPLE 0
  2719. #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
  2720. #define FF_PROFILE_MPEG4_CORE 2
  2721. #define FF_PROFILE_MPEG4_MAIN 3
  2722. #define FF_PROFILE_MPEG4_N_BIT 4
  2723. #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
  2724. #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
  2725. #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
  2726. #define FF_PROFILE_MPEG4_HYBRID 8
  2727. #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
  2728. #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
  2729. #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
  2730. #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
  2731. #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
  2732. #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
  2733. #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
  2734. #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
  2735. #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
  2736. #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
  2737. #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
  2738. #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
  2739. #define FF_PROFILE_VP9_0 0
  2740. #define FF_PROFILE_VP9_1 1
  2741. #define FF_PROFILE_VP9_2 2
  2742. #define FF_PROFILE_VP9_3 3
  2743. #define FF_PROFILE_HEVC_MAIN 1
  2744. #define FF_PROFILE_HEVC_MAIN_10 2
  2745. #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
  2746. #define FF_PROFILE_HEVC_REXT 4
  2747. #define FF_PROFILE_AV1_MAIN 0
  2748. #define FF_PROFILE_AV1_HIGH 1
  2749. #define FF_PROFILE_AV1_PROFESSIONAL 2
  2750. #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
  2751. #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
  2752. #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
  2753. #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
  2754. #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
  2755. #define FF_PROFILE_SBC_MSBC 1
  2756. #define FF_PROFILE_PRORES_PROXY 0
  2757. #define FF_PROFILE_PRORES_LT 1
  2758. #define FF_PROFILE_PRORES_STANDARD 2
  2759. #define FF_PROFILE_PRORES_HQ 3
  2760. #define FF_PROFILE_PRORES_4444 4
  2761. #define FF_PROFILE_PRORES_XQ 5
  2762. #define FF_PROFILE_ARIB_PROFILE_A 0
  2763. #define FF_PROFILE_ARIB_PROFILE_C 1
  2764. /**
  2765. * level
  2766. * - encoding: Set by user.
  2767. * - decoding: Set by libavcodec.
  2768. */
  2769. int level;
  2770. #define FF_LEVEL_UNKNOWN -99
  2771. /**
  2772. * Skip loop filtering for selected frames.
  2773. * - encoding: unused
  2774. * - decoding: Set by user.
  2775. */
  2776. enum AVDiscard skip_loop_filter;
  2777. /**
  2778. * Skip IDCT/dequantization for selected frames.
  2779. * - encoding: unused
  2780. * - decoding: Set by user.
  2781. */
  2782. enum AVDiscard skip_idct;
  2783. /**
  2784. * Skip decoding for selected frames.
  2785. * - encoding: unused
  2786. * - decoding: Set by user.
  2787. */
  2788. enum AVDiscard skip_frame;
  2789. /**
  2790. * Header containing style information for text subtitles.
  2791. * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
  2792. * [Script Info] and [V4+ Styles] section, plus the [Events] line and
  2793. * the Format line following. It shouldn't include any Dialogue line.
  2794. * - encoding: Set/allocated/freed by user (before avcodec_open2())
  2795. * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
  2796. */
  2797. uint8_t *subtitle_header;
  2798. int subtitle_header_size;
  2799. #if FF_API_VBV_DELAY
  2800. /**
  2801. * VBV delay coded in the last frame (in periods of a 27 MHz clock).
  2802. * Used for compliant TS muxing.
  2803. * - encoding: Set by libavcodec.
  2804. * - decoding: unused.
  2805. * @deprecated this value is now exported as a part of
  2806. * AV_PKT_DATA_CPB_PROPERTIES packet side data
  2807. */
  2808. attribute_deprecated
  2809. uint64_t vbv_delay;
  2810. #endif
  2811. #if FF_API_SIDEDATA_ONLY_PKT
  2812. /**
  2813. * Encoding only and set by default. Allow encoders to output packets
  2814. * that do not contain any encoded data, only side data.
  2815. *
  2816. * Some encoders need to output such packets, e.g. to update some stream
  2817. * parameters at the end of encoding.
  2818. *
  2819. * @deprecated this field disables the default behaviour and
  2820. * it is kept only for compatibility.
  2821. */
  2822. attribute_deprecated
  2823. int side_data_only_packets;
  2824. #endif
  2825. /**
  2826. * Audio only. The number of "priming" samples (padding) inserted by the
  2827. * encoder at the beginning of the audio. I.e. this number of leading
  2828. * decoded samples must be discarded by the caller to get the original audio
  2829. * without leading padding.
  2830. *
  2831. * - decoding: unused
  2832. * - encoding: Set by libavcodec. The timestamps on the output packets are
  2833. * adjusted by the encoder so that they always refer to the
  2834. * first sample of the data actually contained in the packet,
  2835. * including any added padding. E.g. if the timebase is
  2836. * 1/samplerate and the timestamp of the first input sample is
  2837. * 0, the timestamp of the first output packet will be
  2838. * -initial_padding.
  2839. */
  2840. int initial_padding;
  2841. /**
  2842. * - decoding: For codecs that store a framerate value in the compressed
  2843. * bitstream, the decoder may export it here. { 0, 1} when
  2844. * unknown.
  2845. * - encoding: May be used to signal the framerate of CFR content to an
  2846. * encoder.
  2847. */
  2848. AVRational framerate;
  2849. /**
  2850. * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
  2851. * - encoding: unused.
  2852. * - decoding: Set by libavcodec before calling get_format()
  2853. */
  2854. enum AVPixelFormat sw_pix_fmt;
  2855. /**
  2856. * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
  2857. * - encoding unused.
  2858. * - decoding set by user.
  2859. */
  2860. AVRational pkt_timebase;
  2861. /**
  2862. * AVCodecDescriptor
  2863. * - encoding: unused.
  2864. * - decoding: set by libavcodec.
  2865. */
  2866. const AVCodecDescriptor *codec_descriptor;
  2867. #if !FF_API_LOWRES
  2868. /**
  2869. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  2870. * - encoding: unused
  2871. * - decoding: Set by user.
  2872. */
  2873. int lowres;
  2874. #endif
  2875. /**
  2876. * Current statistics for PTS correction.
  2877. * - decoding: maintained and used by libavcodec, not intended to be used by user apps
  2878. * - encoding: unused
  2879. */
  2880. int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
  2881. int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
  2882. int64_t pts_correction_last_pts; /// PTS of the last frame
  2883. int64_t pts_correction_last_dts; /// DTS of the last frame
  2884. /**
  2885. * Character encoding of the input subtitles file.
  2886. * - decoding: set by user
  2887. * - encoding: unused
  2888. */
  2889. char *sub_charenc;
  2890. /**
  2891. * Subtitles character encoding mode. Formats or codecs might be adjusting
  2892. * this setting (if they are doing the conversion themselves for instance).
  2893. * - decoding: set by libavcodec
  2894. * - encoding: unused
  2895. */
  2896. int sub_charenc_mode;
  2897. #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
  2898. #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
  2899. #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
  2900. #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
  2901. /**
  2902. * Skip processing alpha if supported by codec.
  2903. * Note that if the format uses pre-multiplied alpha (common with VP6,
  2904. * and recommended due to better video quality/compression)
  2905. * the image will look as if alpha-blended onto a black background.
  2906. * However for formats that do not use pre-multiplied alpha
  2907. * there might be serious artefacts (though e.g. libswscale currently
  2908. * assumes pre-multiplied alpha anyway).
  2909. *
  2910. * - decoding: set by user
  2911. * - encoding: unused
  2912. */
  2913. int skip_alpha;
  2914. /**
  2915. * Number of samples to skip after a discontinuity
  2916. * - decoding: unused
  2917. * - encoding: set by libavcodec
  2918. */
  2919. int seek_preroll;
  2920. #if !FF_API_DEBUG_MV
  2921. /**
  2922. * debug motion vectors
  2923. * - encoding: Set by user.
  2924. * - decoding: Set by user.
  2925. */
  2926. int debug_mv;
  2927. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  2928. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  2929. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  2930. #endif
  2931. /**
  2932. * custom intra quantization matrix
  2933. * - encoding: Set by user, can be NULL.
  2934. * - decoding: unused.
  2935. */
  2936. uint16_t *chroma_intra_matrix;
  2937. /**
  2938. * dump format separator.
  2939. * can be ", " or "\n " or anything else
  2940. * - encoding: Set by user.
  2941. * - decoding: Set by user.
  2942. */
  2943. uint8_t *dump_separator;
  2944. /**
  2945. * ',' separated list of allowed decoders.
  2946. * If NULL then all are allowed
  2947. * - encoding: unused
  2948. * - decoding: set by user
  2949. */
  2950. char *codec_whitelist;
  2951. /**
  2952. * Properties of the stream that gets decoded
  2953. * - encoding: unused
  2954. * - decoding: set by libavcodec
  2955. */
  2956. unsigned properties;
  2957. #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
  2958. #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
  2959. /**
  2960. * Additional data associated with the entire coded stream.
  2961. *
  2962. * - decoding: unused
  2963. * - encoding: may be set by libavcodec after avcodec_open2().
  2964. */
  2965. AVPacketSideData *coded_side_data;
  2966. int nb_coded_side_data;
  2967. /**
  2968. * A reference to the AVHWFramesContext describing the input (for encoding)
  2969. * or output (decoding) frames. The reference is set by the caller and
  2970. * afterwards owned (and freed) by libavcodec - it should never be read by
  2971. * the caller after being set.
  2972. *
  2973. * - decoding: This field should be set by the caller from the get_format()
  2974. * callback. The previous reference (if any) will always be
  2975. * unreffed by libavcodec before the get_format() call.
  2976. *
  2977. * If the default get_buffer2() is used with a hwaccel pixel
  2978. * format, then this AVHWFramesContext will be used for
  2979. * allocating the frame buffers.
  2980. *
  2981. * - encoding: For hardware encoders configured to use a hwaccel pixel
  2982. * format, this field should be set by the caller to a reference
  2983. * to the AVHWFramesContext describing input frames.
  2984. * AVHWFramesContext.format must be equal to
  2985. * AVCodecContext.pix_fmt.
  2986. *
  2987. * This field should be set before avcodec_open2() is called.
  2988. */
  2989. AVBufferRef *hw_frames_ctx;
  2990. /**
  2991. * Control the form of AVSubtitle.rects[N]->ass
  2992. * - decoding: set by user
  2993. * - encoding: unused
  2994. */
  2995. int sub_text_format;
  2996. #define FF_SUB_TEXT_FMT_ASS 0
  2997. #if FF_API_ASS_TIMING
  2998. #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
  2999. #endif
  3000. /**
  3001. * Audio only. The amount of padding (in samples) appended by the encoder to
  3002. * the end of the audio. I.e. this number of decoded samples must be
  3003. * discarded by the caller from the end of the stream to get the original
  3004. * audio without any trailing padding.
  3005. *
  3006. * - decoding: unused
  3007. * - encoding: unused
  3008. */
  3009. int trailing_padding;
  3010. /**
  3011. * The number of pixels per image to maximally accept.
  3012. *
  3013. * - decoding: set by user
  3014. * - encoding: set by user
  3015. */
  3016. int64_t max_pixels;
  3017. /**
  3018. * A reference to the AVHWDeviceContext describing the device which will
  3019. * be used by a hardware encoder/decoder. The reference is set by the
  3020. * caller and afterwards owned (and freed) by libavcodec.
  3021. *
  3022. * This should be used if either the codec device does not require
  3023. * hardware frames or any that are used are to be allocated internally by
  3024. * libavcodec. If the user wishes to supply any of the frames used as
  3025. * encoder input or decoder output then hw_frames_ctx should be used
  3026. * instead. When hw_frames_ctx is set in get_format() for a decoder, this
  3027. * field will be ignored while decoding the associated stream segment, but
  3028. * may again be used on a following one after another get_format() call.
  3029. *
  3030. * For both encoders and decoders this field should be set before
  3031. * avcodec_open2() is called and must not be written to thereafter.
  3032. *
  3033. * Note that some decoders may require this field to be set initially in
  3034. * order to support hw_frames_ctx at all - in that case, all frames
  3035. * contexts used must be created on the same device.
  3036. */
  3037. AVBufferRef *hw_device_ctx;
  3038. /**
  3039. * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
  3040. * decoding (if active).
  3041. * - encoding: unused
  3042. * - decoding: Set by user (either before avcodec_open2(), or in the
  3043. * AVCodecContext.get_format callback)
  3044. */
  3045. int hwaccel_flags;
  3046. /**
  3047. * Video decoding only. Certain video codecs support cropping, meaning that
  3048. * only a sub-rectangle of the decoded frame is intended for display. This
  3049. * option controls how cropping is handled by libavcodec.
  3050. *
  3051. * When set to 1 (the default), libavcodec will apply cropping internally.
  3052. * I.e. it will modify the output frame width/height fields and offset the
  3053. * data pointers (only by as much as possible while preserving alignment, or
  3054. * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
  3055. * the frames output by the decoder refer only to the cropped area. The
  3056. * crop_* fields of the output frames will be zero.
  3057. *
  3058. * When set to 0, the width/height fields of the output frames will be set
  3059. * to the coded dimensions and the crop_* fields will describe the cropping
  3060. * rectangle. Applying the cropping is left to the caller.
  3061. *
  3062. * @warning When hardware acceleration with opaque output frames is used,
  3063. * libavcodec is unable to apply cropping from the top/left border.
  3064. *
  3065. * @note when this option is set to zero, the width/height fields of the
  3066. * AVCodecContext and output AVFrames have different meanings. The codec
  3067. * context fields store display dimensions (with the coded dimensions in
  3068. * coded_width/height), while the frame fields store the coded dimensions
  3069. * (with the display dimensions being determined by the crop_* fields).
  3070. */
  3071. int apply_cropping;
  3072. /*
  3073. * Video decoding only. Sets the number of extra hardware frames which
  3074. * the decoder will allocate for use by the caller. This must be set
  3075. * before avcodec_open2() is called.
  3076. *
  3077. * Some hardware decoders require all frames that they will use for
  3078. * output to be defined in advance before decoding starts. For such
  3079. * decoders, the hardware frame pool must therefore be of a fixed size.
  3080. * The extra frames set here are on top of any number that the decoder
  3081. * needs internally in order to operate normally (for example, frames
  3082. * used as reference pictures).
  3083. */
  3084. int extra_hw_frames;
  3085. /**
  3086. * The percentage of damaged samples to discard a frame.
  3087. *
  3088. * - decoding: set by user
  3089. * - encoding: unused
  3090. */
  3091. int discard_damaged_percentage;
  3092. } AVCodecContext;
  3093. #if FF_API_CODEC_GET_SET
  3094. /**
  3095. * Accessors for some AVCodecContext fields. These used to be provided for ABI
  3096. * compatibility, and do not need to be used anymore.
  3097. */
  3098. attribute_deprecated
  3099. AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
  3100. attribute_deprecated
  3101. void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
  3102. attribute_deprecated
  3103. const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
  3104. attribute_deprecated
  3105. void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
  3106. attribute_deprecated
  3107. unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
  3108. #if FF_API_LOWRES
  3109. attribute_deprecated
  3110. int av_codec_get_lowres(const AVCodecContext *avctx);
  3111. attribute_deprecated
  3112. void av_codec_set_lowres(AVCodecContext *avctx, int val);
  3113. #endif
  3114. attribute_deprecated
  3115. int av_codec_get_seek_preroll(const AVCodecContext *avctx);
  3116. attribute_deprecated
  3117. void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
  3118. attribute_deprecated
  3119. uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
  3120. attribute_deprecated
  3121. void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
  3122. #endif
  3123. /**
  3124. * AVProfile.
  3125. */
  3126. typedef struct AVProfile {
  3127. int profile;
  3128. const char *name; ///< short name for the profile
  3129. } AVProfile;
  3130. enum {
  3131. /**
  3132. * The codec supports this format via the hw_device_ctx interface.
  3133. *
  3134. * When selecting this format, AVCodecContext.hw_device_ctx should
  3135. * have been set to a device of the specified type before calling
  3136. * avcodec_open2().
  3137. */
  3138. AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
  3139. /**
  3140. * The codec supports this format via the hw_frames_ctx interface.
  3141. *
  3142. * When selecting this format for a decoder,
  3143. * AVCodecContext.hw_frames_ctx should be set to a suitable frames
  3144. * context inside the get_format() callback. The frames context
  3145. * must have been created on a device of the specified type.
  3146. */
  3147. AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
  3148. /**
  3149. * The codec supports this format by some internal method.
  3150. *
  3151. * This format can be selected without any additional configuration -
  3152. * no device or frames context is required.
  3153. */
  3154. AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
  3155. /**
  3156. * The codec supports this format by some ad-hoc method.
  3157. *
  3158. * Additional settings and/or function calls are required. See the
  3159. * codec-specific documentation for details. (Methods requiring
  3160. * this sort of configuration are deprecated and others should be
  3161. * used in preference.)
  3162. */
  3163. AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
  3164. };
  3165. typedef struct AVCodecHWConfig {
  3166. /**
  3167. * A hardware pixel format which the codec can use.
  3168. */
  3169. enum AVPixelFormat pix_fmt;
  3170. /**
  3171. * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
  3172. * setup methods which can be used with this configuration.
  3173. */
  3174. int methods;
  3175. /**
  3176. * The device type associated with the configuration.
  3177. *
  3178. * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
  3179. * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
  3180. */
  3181. enum AVHWDeviceType device_type;
  3182. } AVCodecHWConfig;
  3183. typedef struct AVCodecDefault AVCodecDefault;
  3184. struct AVSubtitle;
  3185. /**
  3186. * AVCodec.
  3187. */
  3188. typedef struct AVCodec {
  3189. /**
  3190. * Name of the codec implementation.
  3191. * The name is globally unique among encoders and among decoders (but an
  3192. * encoder and a decoder can share the same name).
  3193. * This is the primary way to find a codec from the user perspective.
  3194. */
  3195. const char *name;
  3196. /**
  3197. * Descriptive name for the codec, meant to be more human readable than name.
  3198. * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
  3199. */
  3200. const char *long_name;
  3201. enum AVMediaType type;
  3202. enum AVCodecID id;
  3203. /**
  3204. * Codec capabilities.
  3205. * see AV_CODEC_CAP_*
  3206. */
  3207. int capabilities;
  3208. const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
  3209. const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
  3210. const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
  3211. const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
  3212. const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
  3213. uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
  3214. const AVClass *priv_class; ///< AVClass for the private context
  3215. const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
  3216. /**
  3217. * Group name of the codec implementation.
  3218. * This is a short symbolic name of the wrapper backing this codec. A
  3219. * wrapper uses some kind of external implementation for the codec, such
  3220. * as an external library, or a codec implementation provided by the OS or
  3221. * the hardware.
  3222. * If this field is NULL, this is a builtin, libavcodec native codec.
  3223. * If non-NULL, this will be the suffix in AVCodec.name in most cases
  3224. * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
  3225. */
  3226. const char *wrapper_name;
  3227. /*****************************************************************
  3228. * No fields below this line are part of the public API. They
  3229. * may not be used outside of libavcodec and can be changed and
  3230. * removed at will.
  3231. * New public fields should be added right above.
  3232. *****************************************************************
  3233. */
  3234. int priv_data_size;
  3235. struct AVCodec *next;
  3236. /**
  3237. * @name Frame-level threading support functions
  3238. * @{
  3239. */
  3240. /**
  3241. * If defined, called on thread contexts when they are created.
  3242. * If the codec allocates writable tables in init(), re-allocate them here.
  3243. * priv_data will be set to a copy of the original.
  3244. */
  3245. int (*init_thread_copy)(AVCodecContext *);
  3246. /**
  3247. * Copy necessary context variables from a previous thread context to the current one.
  3248. * If not defined, the next thread will start automatically; otherwise, the codec
  3249. * must call ff_thread_finish_setup().
  3250. *
  3251. * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
  3252. */
  3253. int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
  3254. /** @} */
  3255. /**
  3256. * Private codec-specific defaults.
  3257. */
  3258. const AVCodecDefault *defaults;
  3259. /**
  3260. * Initialize codec static data, called from avcodec_register().
  3261. *
  3262. * This is not intended for time consuming operations as it is
  3263. * run for every codec regardless of that codec being used.
  3264. */
  3265. void (*init_static_data)(struct AVCodec *codec);
  3266. int (*init)(AVCodecContext *);
  3267. int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
  3268. const struct AVSubtitle *sub);
  3269. /**
  3270. * Encode data to an AVPacket.
  3271. *
  3272. * @param avctx codec context
  3273. * @param avpkt output AVPacket (may contain a user-provided buffer)
  3274. * @param[in] frame AVFrame containing the raw data to be encoded
  3275. * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
  3276. * non-empty packet was returned in avpkt.
  3277. * @return 0 on success, negative error code on failure
  3278. */
  3279. int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
  3280. int *got_packet_ptr);
  3281. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
  3282. int (*close)(AVCodecContext *);
  3283. /**
  3284. * Encode API with decoupled packet/frame dataflow. The API is the
  3285. * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
  3286. * that:
  3287. * - never called if the codec is closed or the wrong type,
  3288. * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
  3289. * - only one drain frame is ever passed down,
  3290. */
  3291. int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
  3292. int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
  3293. /**
  3294. * Decode API with decoupled packet/frame dataflow. This function is called
  3295. * to get one output frame. It should call ff_decode_get_packet() to obtain
  3296. * input data.
  3297. */
  3298. int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
  3299. /**
  3300. * Flush buffers.
  3301. * Will be called when seeking
  3302. */
  3303. void (*flush)(AVCodecContext *);
  3304. /**
  3305. * Internal codec capabilities.
  3306. * See FF_CODEC_CAP_* in internal.h
  3307. */
  3308. int caps_internal;
  3309. /**
  3310. * Decoding only, a comma-separated list of bitstream filters to apply to
  3311. * packets before decoding.
  3312. */
  3313. const char *bsfs;
  3314. /**
  3315. * Array of pointers to hardware configurations supported by the codec,
  3316. * or NULL if no hardware supported. The array is terminated by a NULL
  3317. * pointer.
  3318. *
  3319. * The user can only access this field via avcodec_get_hw_config().
  3320. */
  3321. const struct AVCodecHWConfigInternal **hw_configs;
  3322. } AVCodec;
  3323. #if FF_API_CODEC_GET_SET
  3324. attribute_deprecated
  3325. int av_codec_get_max_lowres(const AVCodec *codec);
  3326. #endif
  3327. struct MpegEncContext;
  3328. /**
  3329. * Retrieve supported hardware configurations for a codec.
  3330. *
  3331. * Values of index from zero to some maximum return the indexed configuration
  3332. * descriptor; all other values return NULL. If the codec does not support
  3333. * any hardware configurations then it will always return NULL.
  3334. */
  3335. const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
  3336. /**
  3337. * @defgroup lavc_hwaccel AVHWAccel
  3338. *
  3339. * @note Nothing in this structure should be accessed by the user. At some
  3340. * point in future it will not be externally visible at all.
  3341. *
  3342. * @{
  3343. */
  3344. typedef struct AVHWAccel {
  3345. /**
  3346. * Name of the hardware accelerated codec.
  3347. * The name is globally unique among encoders and among decoders (but an
  3348. * encoder and a decoder can share the same name).
  3349. */
  3350. const char *name;
  3351. /**
  3352. * Type of codec implemented by the hardware accelerator.
  3353. *
  3354. * See AVMEDIA_TYPE_xxx
  3355. */
  3356. enum AVMediaType type;
  3357. /**
  3358. * Codec implemented by the hardware accelerator.
  3359. *
  3360. * See AV_CODEC_ID_xxx
  3361. */
  3362. enum AVCodecID id;
  3363. /**
  3364. * Supported pixel format.
  3365. *
  3366. * Only hardware accelerated formats are supported here.
  3367. */
  3368. enum AVPixelFormat pix_fmt;
  3369. /**
  3370. * Hardware accelerated codec capabilities.
  3371. * see AV_HWACCEL_CODEC_CAP_*
  3372. */
  3373. int capabilities;
  3374. /*****************************************************************
  3375. * No fields below this line are part of the public API. They
  3376. * may not be used outside of libavcodec and can be changed and
  3377. * removed at will.
  3378. * New public fields should be added right above.
  3379. *****************************************************************
  3380. */
  3381. /**
  3382. * Allocate a custom buffer
  3383. */
  3384. int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
  3385. /**
  3386. * Called at the beginning of each frame or field picture.
  3387. *
  3388. * Meaningful frame information (codec specific) is guaranteed to
  3389. * be parsed at this point. This function is mandatory.
  3390. *
  3391. * Note that buf can be NULL along with buf_size set to 0.
  3392. * Otherwise, this means the whole frame is available at this point.
  3393. *
  3394. * @param avctx the codec context
  3395. * @param buf the frame data buffer base
  3396. * @param buf_size the size of the frame in bytes
  3397. * @return zero if successful, a negative value otherwise
  3398. */
  3399. int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  3400. /**
  3401. * Callback for parameter data (SPS/PPS/VPS etc).
  3402. *
  3403. * Useful for hardware decoders which keep persistent state about the
  3404. * video parameters, and need to receive any changes to update that state.
  3405. *
  3406. * @param avctx the codec context
  3407. * @param type the nal unit type
  3408. * @param buf the nal unit data buffer
  3409. * @param buf_size the size of the nal unit in bytes
  3410. * @return zero if successful, a negative value otherwise
  3411. */
  3412. int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
  3413. /**
  3414. * Callback for each slice.
  3415. *
  3416. * Meaningful slice information (codec specific) is guaranteed to
  3417. * be parsed at this point. This function is mandatory.
  3418. * The only exception is XvMC, that works on MB level.
  3419. *
  3420. * @param avctx the codec context
  3421. * @param buf the slice data buffer base
  3422. * @param buf_size the size of the slice in bytes
  3423. * @return zero if successful, a negative value otherwise
  3424. */
  3425. int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  3426. /**
  3427. * Called at the end of each frame or field picture.
  3428. *
  3429. * The whole picture is parsed at this point and can now be sent
  3430. * to the hardware accelerator. This function is mandatory.
  3431. *
  3432. * @param avctx the codec context
  3433. * @return zero if successful, a negative value otherwise
  3434. */
  3435. int (*end_frame)(AVCodecContext *avctx);
  3436. /**
  3437. * Size of per-frame hardware accelerator private data.
  3438. *
  3439. * Private data is allocated with av_mallocz() before
  3440. * AVCodecContext.get_buffer() and deallocated after
  3441. * AVCodecContext.release_buffer().
  3442. */
  3443. int frame_priv_data_size;
  3444. /**
  3445. * Called for every Macroblock in a slice.
  3446. *
  3447. * XvMC uses it to replace the ff_mpv_reconstruct_mb().
  3448. * Instead of decoding to raw picture, MB parameters are
  3449. * stored in an array provided by the video driver.
  3450. *
  3451. * @param s the mpeg context
  3452. */
  3453. void (*decode_mb)(struct MpegEncContext *s);
  3454. /**
  3455. * Initialize the hwaccel private data.
  3456. *
  3457. * This will be called from ff_get_format(), after hwaccel and
  3458. * hwaccel_context are set and the hwaccel private data in AVCodecInternal
  3459. * is allocated.
  3460. */
  3461. int (*init)(AVCodecContext *avctx);
  3462. /**
  3463. * Uninitialize the hwaccel private data.
  3464. *
  3465. * This will be called from get_format() or avcodec_close(), after hwaccel
  3466. * and hwaccel_context are already uninitialized.
  3467. */
  3468. int (*uninit)(AVCodecContext *avctx);
  3469. /**
  3470. * Size of the private data to allocate in
  3471. * AVCodecInternal.hwaccel_priv_data.
  3472. */
  3473. int priv_data_size;
  3474. /**
  3475. * Internal hwaccel capabilities.
  3476. */
  3477. int caps_internal;
  3478. /**
  3479. * Fill the given hw_frames context with current codec parameters. Called
  3480. * from get_format. Refer to avcodec_get_hw_frames_parameters() for
  3481. * details.
  3482. *
  3483. * This CAN be called before AVHWAccel.init is called, and you must assume
  3484. * that avctx->hwaccel_priv_data is invalid.
  3485. */
  3486. int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
  3487. } AVHWAccel;
  3488. /**
  3489. * HWAccel is experimental and is thus avoided in favor of non experimental
  3490. * codecs
  3491. */
  3492. #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
  3493. /**
  3494. * Hardware acceleration should be used for decoding even if the codec level
  3495. * used is unknown or higher than the maximum supported level reported by the
  3496. * hardware driver.
  3497. *
  3498. * It's generally a good idea to pass this flag unless you have a specific
  3499. * reason not to, as hardware tends to under-report supported levels.
  3500. */
  3501. #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
  3502. /**
  3503. * Hardware acceleration can output YUV pixel formats with a different chroma
  3504. * sampling than 4:2:0 and/or other than 8 bits per component.
  3505. */
  3506. #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
  3507. /**
  3508. * Hardware acceleration should still be attempted for decoding when the
  3509. * codec profile does not match the reported capabilities of the hardware.
  3510. *
  3511. * For example, this can be used to try to decode baseline profile H.264
  3512. * streams in hardware - it will often succeed, because many streams marked
  3513. * as baseline profile actually conform to constrained baseline profile.
  3514. *
  3515. * @warning If the stream is actually not supported then the behaviour is
  3516. * undefined, and may include returning entirely incorrect output
  3517. * while indicating success.
  3518. */
  3519. #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
  3520. /**
  3521. * @}
  3522. */
  3523. #if FF_API_AVPICTURE
  3524. /**
  3525. * @defgroup lavc_picture AVPicture
  3526. *
  3527. * Functions for working with AVPicture
  3528. * @{
  3529. */
  3530. /**
  3531. * Picture data structure.
  3532. *
  3533. * Up to four components can be stored into it, the last component is
  3534. * alpha.
  3535. * @deprecated use AVFrame or imgutils functions instead
  3536. */
  3537. typedef struct AVPicture {
  3538. attribute_deprecated
  3539. uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
  3540. attribute_deprecated
  3541. int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
  3542. } AVPicture;
  3543. /**
  3544. * @}
  3545. */
  3546. #endif
  3547. enum AVSubtitleType {
  3548. SUBTITLE_NONE,
  3549. SUBTITLE_BITMAP, ///< A bitmap, pict will be set
  3550. /**
  3551. * Plain text, the text field must be set by the decoder and is
  3552. * authoritative. ass and pict fields may contain approximations.
  3553. */
  3554. SUBTITLE_TEXT,
  3555. /**
  3556. * Formatted text, the ass field must be set by the decoder and is
  3557. * authoritative. pict and text fields may contain approximations.
  3558. */
  3559. SUBTITLE_ASS,
  3560. };
  3561. #define AV_SUBTITLE_FLAG_FORCED 0x00000001
  3562. typedef struct AVSubtitleRect {
  3563. int x; ///< top left corner of pict, undefined when pict is not set
  3564. int y; ///< top left corner of pict, undefined when pict is not set
  3565. int w; ///< width of pict, undefined when pict is not set
  3566. int h; ///< height of pict, undefined when pict is not set
  3567. int nb_colors; ///< number of colors in pict, undefined when pict is not set
  3568. #if FF_API_AVPICTURE
  3569. /**
  3570. * @deprecated unused
  3571. */
  3572. attribute_deprecated
  3573. AVPicture pict;
  3574. #endif
  3575. /**
  3576. * data+linesize for the bitmap of this subtitle.
  3577. * Can be set for text/ass as well once they are rendered.
  3578. */
  3579. uint8_t *data[4];
  3580. int linesize[4];
  3581. enum AVSubtitleType type;
  3582. char *text; ///< 0 terminated plain UTF-8 text
  3583. /**
  3584. * 0 terminated ASS/SSA compatible event line.
  3585. * The presentation of this is unaffected by the other values in this
  3586. * struct.
  3587. */
  3588. char *ass;
  3589. int flags;
  3590. } AVSubtitleRect;
  3591. typedef struct AVSubtitle {
  3592. uint16_t format; /* 0 = graphics */
  3593. uint32_t start_display_time; /* relative to packet pts, in ms */
  3594. uint32_t end_display_time; /* relative to packet pts, in ms */
  3595. unsigned num_rects;
  3596. AVSubtitleRect **rects;
  3597. int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
  3598. } AVSubtitle;
  3599. /**
  3600. * This struct describes the properties of an encoded stream.
  3601. *
  3602. * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
  3603. * be allocated with avcodec_parameters_alloc() and freed with
  3604. * avcodec_parameters_free().
  3605. */
  3606. typedef struct AVCodecParameters {
  3607. /**
  3608. * General type of the encoded data.
  3609. */
  3610. enum AVMediaType codec_type;
  3611. /**
  3612. * Specific type of the encoded data (the codec used).
  3613. */
  3614. enum AVCodecID codec_id;
  3615. /**
  3616. * Additional information about the codec (corresponds to the AVI FOURCC).
  3617. */
  3618. uint32_t codec_tag;
  3619. /**
  3620. * Extra binary data needed for initializing the decoder, codec-dependent.
  3621. *
  3622. * Must be allocated with av_malloc() and will be freed by
  3623. * avcodec_parameters_free(). The allocated size of extradata must be at
  3624. * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
  3625. * bytes zeroed.
  3626. */
  3627. uint8_t *extradata;
  3628. /**
  3629. * Size of the extradata content in bytes.
  3630. */
  3631. int extradata_size;
  3632. /**
  3633. * - video: the pixel format, the value corresponds to enum AVPixelFormat.
  3634. * - audio: the sample format, the value corresponds to enum AVSampleFormat.
  3635. */
  3636. int format;
  3637. /**
  3638. * The average bitrate of the encoded data (in bits per second).
  3639. */
  3640. int64_t bit_rate;
  3641. /**
  3642. * The number of bits per sample in the codedwords.
  3643. *
  3644. * This is basically the bitrate per sample. It is mandatory for a bunch of
  3645. * formats to actually decode them. It's the number of bits for one sample in
  3646. * the actual coded bitstream.
  3647. *
  3648. * This could be for example 4 for ADPCM
  3649. * For PCM formats this matches bits_per_raw_sample
  3650. * Can be 0
  3651. */
  3652. int bits_per_coded_sample;
  3653. /**
  3654. * This is the number of valid bits in each output sample. If the
  3655. * sample format has more bits, the least significant bits are additional
  3656. * padding bits, which are always 0. Use right shifts to reduce the sample
  3657. * to its actual size. For example, audio formats with 24 bit samples will
  3658. * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
  3659. * To get the original sample use "(int32_t)sample >> 8"."
  3660. *
  3661. * For ADPCM this might be 12 or 16 or similar
  3662. * Can be 0
  3663. */
  3664. int bits_per_raw_sample;
  3665. /**
  3666. * Codec-specific bitstream restrictions that the stream conforms to.
  3667. */
  3668. int profile;
  3669. int level;
  3670. /**
  3671. * Video only. The dimensions of the video frame in pixels.
  3672. */
  3673. int width;
  3674. int height;
  3675. /**
  3676. * Video only. The aspect ratio (width / height) which a single pixel
  3677. * should have when displayed.
  3678. *
  3679. * When the aspect ratio is unknown / undefined, the numerator should be
  3680. * set to 0 (the denominator may have any value).
  3681. */
  3682. AVRational sample_aspect_ratio;
  3683. /**
  3684. * Video only. The order of the fields in interlaced video.
  3685. */
  3686. enum AVFieldOrder field_order;
  3687. /**
  3688. * Video only. Additional colorspace characteristics.
  3689. */
  3690. enum AVColorRange color_range;
  3691. enum AVColorPrimaries color_primaries;
  3692. enum AVColorTransferCharacteristic color_trc;
  3693. enum AVColorSpace color_space;
  3694. enum AVChromaLocation chroma_location;
  3695. /**
  3696. * Video only. Number of delayed frames.
  3697. */
  3698. int video_delay;
  3699. /**
  3700. * Audio only. The channel layout bitmask. May be 0 if the channel layout is
  3701. * unknown or unspecified, otherwise the number of bits set must be equal to
  3702. * the channels field.
  3703. */
  3704. uint64_t channel_layout;
  3705. /**
  3706. * Audio only. The number of audio channels.
  3707. */
  3708. int channels;
  3709. /**
  3710. * Audio only. The number of audio samples per second.
  3711. */
  3712. int sample_rate;
  3713. /**
  3714. * Audio only. The number of bytes per coded audio frame, required by some
  3715. * formats.
  3716. *
  3717. * Corresponds to nBlockAlign in WAVEFORMATEX.
  3718. */
  3719. int block_align;
  3720. /**
  3721. * Audio only. Audio frame size, if known. Required by some formats to be static.
  3722. */
  3723. int frame_size;
  3724. /**
  3725. * Audio only. The amount of padding (in samples) inserted by the encoder at
  3726. * the beginning of the audio. I.e. this number of leading decoded samples
  3727. * must be discarded by the caller to get the original audio without leading
  3728. * padding.
  3729. */
  3730. int initial_padding;
  3731. /**
  3732. * Audio only. The amount of padding (in samples) appended by the encoder to
  3733. * the end of the audio. I.e. this number of decoded samples must be
  3734. * discarded by the caller from the end of the stream to get the original
  3735. * audio without any trailing padding.
  3736. */
  3737. int trailing_padding;
  3738. /**
  3739. * Audio only. Number of samples to skip after a discontinuity.
  3740. */
  3741. int seek_preroll;
  3742. } AVCodecParameters;
  3743. /**
  3744. * Iterate over all registered codecs.
  3745. *
  3746. * @param opaque a pointer where libavcodec will store the iteration state. Must
  3747. * point to NULL to start the iteration.
  3748. *
  3749. * @return the next registered codec or NULL when the iteration is
  3750. * finished
  3751. */
  3752. const AVCodec *av_codec_iterate(void **opaque);
  3753. #if FF_API_NEXT
  3754. /**
  3755. * If c is NULL, returns the first registered codec,
  3756. * if c is non-NULL, returns the next registered codec after c,
  3757. * or NULL if c is the last one.
  3758. */
  3759. attribute_deprecated
  3760. AVCodec *av_codec_next(const AVCodec *c);
  3761. #endif
  3762. /**
  3763. * Return the LIBAVCODEC_VERSION_INT constant.
  3764. */
  3765. unsigned avcodec_version(void);
  3766. /**
  3767. * Return the libavcodec build-time configuration.
  3768. */
  3769. const char *avcodec_configuration(void);
  3770. /**
  3771. * Return the libavcodec license.
  3772. */
  3773. const char *avcodec_license(void);
  3774. #if FF_API_NEXT
  3775. /**
  3776. * Register the codec codec and initialize libavcodec.
  3777. *
  3778. * @warning either this function or avcodec_register_all() must be called
  3779. * before any other libavcodec functions.
  3780. *
  3781. * @see avcodec_register_all()
  3782. */
  3783. attribute_deprecated
  3784. void avcodec_register(AVCodec *codec);
  3785. /**
  3786. * Register all the codecs, parsers and bitstream filters which were enabled at
  3787. * configuration time. If you do not call this function you can select exactly
  3788. * which formats you want to support, by using the individual registration
  3789. * functions.
  3790. *
  3791. * @see avcodec_register
  3792. * @see av_register_codec_parser
  3793. * @see av_register_bitstream_filter
  3794. */
  3795. attribute_deprecated
  3796. void avcodec_register_all(void);
  3797. #endif
  3798. /**
  3799. * Allocate an AVCodecContext and set its fields to default values. The
  3800. * resulting struct should be freed with avcodec_free_context().
  3801. *
  3802. * @param codec if non-NULL, allocate private data and initialize defaults
  3803. * for the given codec. It is illegal to then call avcodec_open2()
  3804. * with a different codec.
  3805. * If NULL, then the codec-specific defaults won't be initialized,
  3806. * which may result in suboptimal default settings (this is
  3807. * important mainly for encoders, e.g. libx264).
  3808. *
  3809. * @return An AVCodecContext filled with default values or NULL on failure.
  3810. */
  3811. AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
  3812. /**
  3813. * Free the codec context and everything associated with it and write NULL to
  3814. * the provided pointer.
  3815. */
  3816. void avcodec_free_context(AVCodecContext **avctx);
  3817. #if FF_API_GET_CONTEXT_DEFAULTS
  3818. /**
  3819. * @deprecated This function should not be used, as closing and opening a codec
  3820. * context multiple time is not supported. A new codec context should be
  3821. * allocated for each new use.
  3822. */
  3823. int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
  3824. #endif
  3825. /**
  3826. * Get the AVClass for AVCodecContext. It can be used in combination with
  3827. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  3828. *
  3829. * @see av_opt_find().
  3830. */
  3831. const AVClass *avcodec_get_class(void);
  3832. #if FF_API_COPY_CONTEXT
  3833. /**
  3834. * Get the AVClass for AVFrame. It can be used in combination with
  3835. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  3836. *
  3837. * @see av_opt_find().
  3838. */
  3839. const AVClass *avcodec_get_frame_class(void);
  3840. /**
  3841. * Get the AVClass for AVSubtitleRect. It can be used in combination with
  3842. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  3843. *
  3844. * @see av_opt_find().
  3845. */
  3846. const AVClass *avcodec_get_subtitle_rect_class(void);
  3847. /**
  3848. * Copy the settings of the source AVCodecContext into the destination
  3849. * AVCodecContext. The resulting destination codec context will be
  3850. * unopened, i.e. you are required to call avcodec_open2() before you
  3851. * can use this AVCodecContext to decode/encode video/audio data.
  3852. *
  3853. * @param dest target codec context, should be initialized with
  3854. * avcodec_alloc_context3(NULL), but otherwise uninitialized
  3855. * @param src source codec context
  3856. * @return AVERROR() on error (e.g. memory allocation error), 0 on success
  3857. *
  3858. * @deprecated The semantics of this function are ill-defined and it should not
  3859. * be used. If you need to transfer the stream parameters from one codec context
  3860. * to another, use an intermediate AVCodecParameters instance and the
  3861. * avcodec_parameters_from_context() / avcodec_parameters_to_context()
  3862. * functions.
  3863. */
  3864. attribute_deprecated
  3865. int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
  3866. #endif
  3867. /**
  3868. * Allocate a new AVCodecParameters and set its fields to default values
  3869. * (unknown/invalid/0). The returned struct must be freed with
  3870. * avcodec_parameters_free().
  3871. */
  3872. AVCodecParameters *avcodec_parameters_alloc(void);
  3873. /**
  3874. * Free an AVCodecParameters instance and everything associated with it and
  3875. * write NULL to the supplied pointer.
  3876. */
  3877. void avcodec_parameters_free(AVCodecParameters **par);
  3878. /**
  3879. * Copy the contents of src to dst. Any allocated fields in dst are freed and
  3880. * replaced with newly allocated duplicates of the corresponding fields in src.
  3881. *
  3882. * @return >= 0 on success, a negative AVERROR code on failure.
  3883. */
  3884. int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
  3885. /**
  3886. * Fill the parameters struct based on the values from the supplied codec
  3887. * context. Any allocated fields in par are freed and replaced with duplicates
  3888. * of the corresponding fields in codec.
  3889. *
  3890. * @return >= 0 on success, a negative AVERROR code on failure
  3891. */
  3892. int avcodec_parameters_from_context(AVCodecParameters *par,
  3893. const AVCodecContext *codec);
  3894. /**
  3895. * Fill the codec context based on the values from the supplied codec
  3896. * parameters. Any allocated fields in codec that have a corresponding field in
  3897. * par are freed and replaced with duplicates of the corresponding field in par.
  3898. * Fields in codec that do not have a counterpart in par are not touched.
  3899. *
  3900. * @return >= 0 on success, a negative AVERROR code on failure.
  3901. */
  3902. int avcodec_parameters_to_context(AVCodecContext *codec,
  3903. const AVCodecParameters *par);
  3904. /**
  3905. * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
  3906. * function the context has to be allocated with avcodec_alloc_context3().
  3907. *
  3908. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  3909. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  3910. * retrieving a codec.
  3911. *
  3912. * @warning This function is not thread safe!
  3913. *
  3914. * @note Always call this function before using decoding routines (such as
  3915. * @ref avcodec_receive_frame()).
  3916. *
  3917. * @code
  3918. * avcodec_register_all();
  3919. * av_dict_set(&opts, "b", "2.5M", 0);
  3920. * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
  3921. * if (!codec)
  3922. * exit(1);
  3923. *
  3924. * context = avcodec_alloc_context3(codec);
  3925. *
  3926. * if (avcodec_open2(context, codec, opts) < 0)
  3927. * exit(1);
  3928. * @endcode
  3929. *
  3930. * @param avctx The context to initialize.
  3931. * @param codec The codec to open this context for. If a non-NULL codec has been
  3932. * previously passed to avcodec_alloc_context3() or
  3933. * for this context, then this parameter MUST be either NULL or
  3934. * equal to the previously passed codec.
  3935. * @param options A dictionary filled with AVCodecContext and codec-private options.
  3936. * On return this object will be filled with options that were not found.
  3937. *
  3938. * @return zero on success, a negative value on error
  3939. * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
  3940. * av_dict_set(), av_opt_find().
  3941. */
  3942. int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
  3943. /**
  3944. * Close a given AVCodecContext and free all the data associated with it
  3945. * (but not the AVCodecContext itself).
  3946. *
  3947. * Calling this function on an AVCodecContext that hasn't been opened will free
  3948. * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
  3949. * codec. Subsequent calls will do nothing.
  3950. *
  3951. * @note Do not use this function. Use avcodec_free_context() to destroy a
  3952. * codec context (either open or closed). Opening and closing a codec context
  3953. * multiple times is not supported anymore -- use multiple codec contexts
  3954. * instead.
  3955. */
  3956. int avcodec_close(AVCodecContext *avctx);
  3957. /**
  3958. * Free all allocated data in the given subtitle struct.
  3959. *
  3960. * @param sub AVSubtitle to free.
  3961. */
  3962. void avsubtitle_free(AVSubtitle *sub);
  3963. /**
  3964. * @}
  3965. */
  3966. /**
  3967. * @addtogroup lavc_packet
  3968. * @{
  3969. */
  3970. /**
  3971. * Allocate an AVPacket and set its fields to default values. The resulting
  3972. * struct must be freed using av_packet_free().
  3973. *
  3974. * @return An AVPacket filled with default values or NULL on failure.
  3975. *
  3976. * @note this only allocates the AVPacket itself, not the data buffers. Those
  3977. * must be allocated through other means such as av_new_packet.
  3978. *
  3979. * @see av_new_packet
  3980. */
  3981. AVPacket *av_packet_alloc(void);
  3982. /**
  3983. * Create a new packet that references the same data as src.
  3984. *
  3985. * This is a shortcut for av_packet_alloc()+av_packet_ref().
  3986. *
  3987. * @return newly created AVPacket on success, NULL on error.
  3988. *
  3989. * @see av_packet_alloc
  3990. * @see av_packet_ref
  3991. */
  3992. AVPacket *av_packet_clone(const AVPacket *src);
  3993. /**
  3994. * Free the packet, if the packet is reference counted, it will be
  3995. * unreferenced first.
  3996. *
  3997. * @param pkt packet to be freed. The pointer will be set to NULL.
  3998. * @note passing NULL is a no-op.
  3999. */
  4000. void av_packet_free(AVPacket **pkt);
  4001. /**
  4002. * Initialize optional fields of a packet with default values.
  4003. *
  4004. * Note, this does not touch the data and size members, which have to be
  4005. * initialized separately.
  4006. *
  4007. * @param pkt packet
  4008. */
  4009. void av_init_packet(AVPacket *pkt);
  4010. /**
  4011. * Allocate the payload of a packet and initialize its fields with
  4012. * default values.
  4013. *
  4014. * @param pkt packet
  4015. * @param size wanted payload size
  4016. * @return 0 if OK, AVERROR_xxx otherwise
  4017. */
  4018. int av_new_packet(AVPacket *pkt, int size);
  4019. /**
  4020. * Reduce packet size, correctly zeroing padding
  4021. *
  4022. * @param pkt packet
  4023. * @param size new size
  4024. */
  4025. void av_shrink_packet(AVPacket *pkt, int size);
  4026. /**
  4027. * Increase packet size, correctly zeroing padding
  4028. *
  4029. * @param pkt packet
  4030. * @param grow_by number of bytes by which to increase the size of the packet
  4031. */
  4032. int av_grow_packet(AVPacket *pkt, int grow_by);
  4033. /**
  4034. * Initialize a reference-counted packet from av_malloc()ed data.
  4035. *
  4036. * @param pkt packet to be initialized. This function will set the data, size,
  4037. * and buf fields, all others are left untouched.
  4038. * @param data Data allocated by av_malloc() to be used as packet data. If this
  4039. * function returns successfully, the data is owned by the underlying AVBuffer.
  4040. * The caller may not access the data through other means.
  4041. * @param size size of data in bytes, without the padding. I.e. the full buffer
  4042. * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
  4043. *
  4044. * @return 0 on success, a negative AVERROR on error
  4045. */
  4046. int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
  4047. #if FF_API_AVPACKET_OLD_API
  4048. /**
  4049. * @warning This is a hack - the packet memory allocation stuff is broken. The
  4050. * packet is allocated if it was not really allocated.
  4051. *
  4052. * @deprecated Use av_packet_ref or av_packet_make_refcounted
  4053. */
  4054. attribute_deprecated
  4055. int av_dup_packet(AVPacket *pkt);
  4056. /**
  4057. * Copy packet, including contents
  4058. *
  4059. * @return 0 on success, negative AVERROR on fail
  4060. *
  4061. * @deprecated Use av_packet_ref
  4062. */
  4063. attribute_deprecated
  4064. int av_copy_packet(AVPacket *dst, const AVPacket *src);
  4065. /**
  4066. * Copy packet side data
  4067. *
  4068. * @return 0 on success, negative AVERROR on fail
  4069. *
  4070. * @deprecated Use av_packet_copy_props
  4071. */
  4072. attribute_deprecated
  4073. int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
  4074. /**
  4075. * Free a packet.
  4076. *
  4077. * @deprecated Use av_packet_unref
  4078. *
  4079. * @param pkt packet to free
  4080. */
  4081. attribute_deprecated
  4082. void av_free_packet(AVPacket *pkt);
  4083. #endif
  4084. /**
  4085. * Allocate new information of a packet.
  4086. *
  4087. * @param pkt packet
  4088. * @param type side information type
  4089. * @param size side information size
  4090. * @return pointer to fresh allocated data or NULL otherwise
  4091. */
  4092. uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  4093. int size);
  4094. /**
  4095. * Wrap an existing array as a packet side data.
  4096. *
  4097. * @param pkt packet
  4098. * @param type side information type
  4099. * @param data the side data array. It must be allocated with the av_malloc()
  4100. * family of functions. The ownership of the data is transferred to
  4101. * pkt.
  4102. * @param size side information size
  4103. * @return a non-negative number on success, a negative AVERROR code on
  4104. * failure. On failure, the packet is unchanged and the data remains
  4105. * owned by the caller.
  4106. */
  4107. int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  4108. uint8_t *data, size_t size);
  4109. /**
  4110. * Shrink the already allocated side data buffer
  4111. *
  4112. * @param pkt packet
  4113. * @param type side information type
  4114. * @param size new side information size
  4115. * @return 0 on success, < 0 on failure
  4116. */
  4117. int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  4118. int size);
  4119. /**
  4120. * Get side information from packet.
  4121. *
  4122. * @param pkt packet
  4123. * @param type desired side information type
  4124. * @param size pointer for side information size to store (optional)
  4125. * @return pointer to data if present or NULL otherwise
  4126. */
  4127. uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
  4128. int *size);
  4129. #if FF_API_MERGE_SD_API
  4130. attribute_deprecated
  4131. int av_packet_merge_side_data(AVPacket *pkt);
  4132. attribute_deprecated
  4133. int av_packet_split_side_data(AVPacket *pkt);
  4134. #endif
  4135. const char *av_packet_side_data_name(enum AVPacketSideDataType type);
  4136. /**
  4137. * Pack a dictionary for use in side_data.
  4138. *
  4139. * @param dict The dictionary to pack.
  4140. * @param size pointer to store the size of the returned data
  4141. * @return pointer to data if successful, NULL otherwise
  4142. */
  4143. uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
  4144. /**
  4145. * Unpack a dictionary from side_data.
  4146. *
  4147. * @param data data from side_data
  4148. * @param size size of the data
  4149. * @param dict the metadata storage dictionary
  4150. * @return 0 on success, < 0 on failure
  4151. */
  4152. int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
  4153. /**
  4154. * Convenience function to free all the side data stored.
  4155. * All the other fields stay untouched.
  4156. *
  4157. * @param pkt packet
  4158. */
  4159. void av_packet_free_side_data(AVPacket *pkt);
  4160. /**
  4161. * Setup a new reference to the data described by a given packet
  4162. *
  4163. * If src is reference-counted, setup dst as a new reference to the
  4164. * buffer in src. Otherwise allocate a new buffer in dst and copy the
  4165. * data from src into it.
  4166. *
  4167. * All the other fields are copied from src.
  4168. *
  4169. * @see av_packet_unref
  4170. *
  4171. * @param dst Destination packet
  4172. * @param src Source packet
  4173. *
  4174. * @return 0 on success, a negative AVERROR on error.
  4175. */
  4176. int av_packet_ref(AVPacket *dst, const AVPacket *src);
  4177. /**
  4178. * Wipe the packet.
  4179. *
  4180. * Unreference the buffer referenced by the packet and reset the
  4181. * remaining packet fields to their default values.
  4182. *
  4183. * @param pkt The packet to be unreferenced.
  4184. */
  4185. void av_packet_unref(AVPacket *pkt);
  4186. /**
  4187. * Move every field in src to dst and reset src.
  4188. *
  4189. * @see av_packet_unref
  4190. *
  4191. * @param src Source packet, will be reset
  4192. * @param dst Destination packet
  4193. */
  4194. void av_packet_move_ref(AVPacket *dst, AVPacket *src);
  4195. /**
  4196. * Copy only "properties" fields from src to dst.
  4197. *
  4198. * Properties for the purpose of this function are all the fields
  4199. * beside those related to the packet data (buf, data, size)
  4200. *
  4201. * @param dst Destination packet
  4202. * @param src Source packet
  4203. *
  4204. * @return 0 on success AVERROR on failure.
  4205. */
  4206. int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
  4207. /**
  4208. * Ensure the data described by a given packet is reference counted.
  4209. *
  4210. * @note This function does not ensure that the reference will be writable.
  4211. * Use av_packet_make_writable instead for that purpose.
  4212. *
  4213. * @see av_packet_ref
  4214. * @see av_packet_make_writable
  4215. *
  4216. * @param pkt packet whose data should be made reference counted.
  4217. *
  4218. * @return 0 on success, a negative AVERROR on error. On failure, the
  4219. * packet is unchanged.
  4220. */
  4221. int av_packet_make_refcounted(AVPacket *pkt);
  4222. /**
  4223. * Create a writable reference for the data described by a given packet,
  4224. * avoiding data copy if possible.
  4225. *
  4226. * @param pkt Packet whose data should be made writable.
  4227. *
  4228. * @return 0 on success, a negative AVERROR on failure. On failure, the
  4229. * packet is unchanged.
  4230. */
  4231. int av_packet_make_writable(AVPacket *pkt);
  4232. /**
  4233. * Convert valid timing fields (timestamps / durations) in a packet from one
  4234. * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
  4235. * ignored.
  4236. *
  4237. * @param pkt packet on which the conversion will be performed
  4238. * @param tb_src source timebase, in which the timing fields in pkt are
  4239. * expressed
  4240. * @param tb_dst destination timebase, to which the timing fields will be
  4241. * converted
  4242. */
  4243. void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
  4244. /**
  4245. * @}
  4246. */
  4247. /**
  4248. * @addtogroup lavc_decoding
  4249. * @{
  4250. */
  4251. /**
  4252. * Find a registered decoder with a matching codec ID.
  4253. *
  4254. * @param id AVCodecID of the requested decoder
  4255. * @return A decoder if one was found, NULL otherwise.
  4256. */
  4257. AVCodec *avcodec_find_decoder(enum AVCodecID id);
  4258. /**
  4259. * Find a registered decoder with the specified name.
  4260. *
  4261. * @param name name of the requested decoder
  4262. * @return A decoder if one was found, NULL otherwise.
  4263. */
  4264. AVCodec *avcodec_find_decoder_by_name(const char *name);
  4265. /**
  4266. * The default callback for AVCodecContext.get_buffer2(). It is made public so
  4267. * it can be called by custom get_buffer2() implementations for decoders without
  4268. * AV_CODEC_CAP_DR1 set.
  4269. */
  4270. int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
  4271. /**
  4272. * Modify width and height values so that they will result in a memory
  4273. * buffer that is acceptable for the codec if you do not use any horizontal
  4274. * padding.
  4275. *
  4276. * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
  4277. */
  4278. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  4279. /**
  4280. * Modify width and height values so that they will result in a memory
  4281. * buffer that is acceptable for the codec if you also ensure that all
  4282. * line sizes are a multiple of the respective linesize_align[i].
  4283. *
  4284. * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
  4285. */
  4286. void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
  4287. int linesize_align[AV_NUM_DATA_POINTERS]);
  4288. /**
  4289. * Converts AVChromaLocation to swscale x/y chroma position.
  4290. *
  4291. * The positions represent the chroma (0,0) position in a coordinates system
  4292. * with luma (0,0) representing the origin and luma(1,1) representing 256,256
  4293. *
  4294. * @param xpos horizontal chroma sample position
  4295. * @param ypos vertical chroma sample position
  4296. */
  4297. int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
  4298. /**
  4299. * Converts swscale x/y chroma position to AVChromaLocation.
  4300. *
  4301. * The positions represent the chroma (0,0) position in a coordinates system
  4302. * with luma (0,0) representing the origin and luma(1,1) representing 256,256
  4303. *
  4304. * @param xpos horizontal chroma sample position
  4305. * @param ypos vertical chroma sample position
  4306. */
  4307. enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
  4308. /**
  4309. * Decode the audio frame of size avpkt->size from avpkt->data into frame.
  4310. *
  4311. * Some decoders may support multiple frames in a single AVPacket. Such
  4312. * decoders would then just decode the first frame and the return value would be
  4313. * less than the packet size. In this case, avcodec_decode_audio4 has to be
  4314. * called again with an AVPacket containing the remaining data in order to
  4315. * decode the second frame, etc... Even if no frames are returned, the packet
  4316. * needs to be fed to the decoder with remaining data until it is completely
  4317. * consumed or an error occurs.
  4318. *
  4319. * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
  4320. * and output. This means that for some packets they will not immediately
  4321. * produce decoded output and need to be flushed at the end of decoding to get
  4322. * all the decoded data. Flushing is done by calling this function with packets
  4323. * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
  4324. * returning samples. It is safe to flush even those decoders that are not
  4325. * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
  4326. *
  4327. * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
  4328. * larger than the actual read bytes because some optimized bitstream
  4329. * readers read 32 or 64 bits at once and could read over the end.
  4330. *
  4331. * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
  4332. * before packets may be fed to the decoder.
  4333. *
  4334. * @param avctx the codec context
  4335. * @param[out] frame The AVFrame in which to store decoded audio samples.
  4336. * The decoder will allocate a buffer for the decoded frame by
  4337. * calling the AVCodecContext.get_buffer2() callback.
  4338. * When AVCodecContext.refcounted_frames is set to 1, the frame is
  4339. * reference counted and the returned reference belongs to the
  4340. * caller. The caller must release the frame using av_frame_unref()
  4341. * when the frame is no longer needed. The caller may safely write
  4342. * to the frame if av_frame_is_writable() returns 1.
  4343. * When AVCodecContext.refcounted_frames is set to 0, the returned
  4344. * reference belongs to the decoder and is valid only until the
  4345. * next call to this function or until closing or flushing the
  4346. * decoder. The caller may not write to it.
  4347. * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
  4348. * non-zero. Note that this field being set to zero
  4349. * does not mean that an error has occurred. For
  4350. * decoders with AV_CODEC_CAP_DELAY set, no given decode
  4351. * call is guaranteed to produce a frame.
  4352. * @param[in] avpkt The input AVPacket containing the input buffer.
  4353. * At least avpkt->data and avpkt->size should be set. Some
  4354. * decoders might also require additional fields to be set.
  4355. * @return A negative error code is returned if an error occurred during
  4356. * decoding, otherwise the number of bytes consumed from the input
  4357. * AVPacket is returned.
  4358. *
  4359. * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
  4360. */
  4361. attribute_deprecated
  4362. int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
  4363. int *got_frame_ptr, const AVPacket *avpkt);
  4364. /**
  4365. * Decode the video frame of size avpkt->size from avpkt->data into picture.
  4366. * Some decoders may support multiple frames in a single AVPacket, such
  4367. * decoders would then just decode the first frame.
  4368. *
  4369. * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
  4370. * the actual read bytes because some optimized bitstream readers read 32 or 64
  4371. * bits at once and could read over the end.
  4372. *
  4373. * @warning The end of the input buffer buf should be set to 0 to ensure that
  4374. * no overreading happens for damaged MPEG streams.
  4375. *
  4376. * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
  4377. * between input and output, these need to be fed with avpkt->data=NULL,
  4378. * avpkt->size=0 at the end to return the remaining frames.
  4379. *
  4380. * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
  4381. * before packets may be fed to the decoder.
  4382. *
  4383. * @param avctx the codec context
  4384. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  4385. * Use av_frame_alloc() to get an AVFrame. The codec will
  4386. * allocate memory for the actual bitmap by calling the
  4387. * AVCodecContext.get_buffer2() callback.
  4388. * When AVCodecContext.refcounted_frames is set to 1, the frame is
  4389. * reference counted and the returned reference belongs to the
  4390. * caller. The caller must release the frame using av_frame_unref()
  4391. * when the frame is no longer needed. The caller may safely write
  4392. * to the frame if av_frame_is_writable() returns 1.
  4393. * When AVCodecContext.refcounted_frames is set to 0, the returned
  4394. * reference belongs to the decoder and is valid only until the
  4395. * next call to this function or until closing or flushing the
  4396. * decoder. The caller may not write to it.
  4397. *
  4398. * @param[in] avpkt The input AVPacket containing the input buffer.
  4399. * You can create such packet with av_init_packet() and by then setting
  4400. * data and size, some decoders might in addition need other fields like
  4401. * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
  4402. * fields possible.
  4403. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  4404. * @return On error a negative value is returned, otherwise the number of bytes
  4405. * used or zero if no frame could be decompressed.
  4406. *
  4407. * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
  4408. */
  4409. attribute_deprecated
  4410. int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
  4411. int *got_picture_ptr,
  4412. const AVPacket *avpkt);
  4413. /**
  4414. * Decode a subtitle message.
  4415. * Return a negative value on error, otherwise return the number of bytes used.
  4416. * If no subtitle could be decompressed, got_sub_ptr is zero.
  4417. * Otherwise, the subtitle is stored in *sub.
  4418. * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
  4419. * simplicity, because the performance difference is expect to be negligible
  4420. * and reusing a get_buffer written for video codecs would probably perform badly
  4421. * due to a potentially very different allocation pattern.
  4422. *
  4423. * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
  4424. * and output. This means that for some packets they will not immediately
  4425. * produce decoded output and need to be flushed at the end of decoding to get
  4426. * all the decoded data. Flushing is done by calling this function with packets
  4427. * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
  4428. * returning subtitles. It is safe to flush even those decoders that are not
  4429. * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
  4430. *
  4431. * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
  4432. * before packets may be fed to the decoder.
  4433. *
  4434. * @param avctx the codec context
  4435. * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
  4436. * must be freed with avsubtitle_free if *got_sub_ptr is set.
  4437. * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
  4438. * @param[in] avpkt The input AVPacket containing the input buffer.
  4439. */
  4440. int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
  4441. int *got_sub_ptr,
  4442. AVPacket *avpkt);
  4443. /**
  4444. * Supply raw packet data as input to a decoder.
  4445. *
  4446. * Internally, this call will copy relevant AVCodecContext fields, which can
  4447. * influence decoding per-packet, and apply them when the packet is actually
  4448. * decoded. (For example AVCodecContext.skip_frame, which might direct the
  4449. * decoder to drop the frame contained by the packet sent with this function.)
  4450. *
  4451. * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
  4452. * larger than the actual read bytes because some optimized bitstream
  4453. * readers read 32 or 64 bits at once and could read over the end.
  4454. *
  4455. * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
  4456. * on the same AVCodecContext. It will return unexpected results now
  4457. * or in future libavcodec versions.
  4458. *
  4459. * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
  4460. * before packets may be fed to the decoder.
  4461. *
  4462. * @param avctx codec context
  4463. * @param[in] avpkt The input AVPacket. Usually, this will be a single video
  4464. * frame, or several complete audio frames.
  4465. * Ownership of the packet remains with the caller, and the
  4466. * decoder will not write to the packet. The decoder may create
  4467. * a reference to the packet data (or copy it if the packet is
  4468. * not reference-counted).
  4469. * Unlike with older APIs, the packet is always fully consumed,
  4470. * and if it contains multiple frames (e.g. some audio codecs),
  4471. * will require you to call avcodec_receive_frame() multiple
  4472. * times afterwards before you can send a new packet.
  4473. * It can be NULL (or an AVPacket with data set to NULL and
  4474. * size set to 0); in this case, it is considered a flush
  4475. * packet, which signals the end of the stream. Sending the
  4476. * first flush packet will return success. Subsequent ones are
  4477. * unnecessary and will return AVERROR_EOF. If the decoder
  4478. * still has frames buffered, it will return them after sending
  4479. * a flush packet.
  4480. *
  4481. * @return 0 on success, otherwise negative error code:
  4482. * AVERROR(EAGAIN): input is not accepted in the current state - user
  4483. * must read output with avcodec_receive_frame() (once
  4484. * all output is read, the packet should be resent, and
  4485. * the call will not fail with EAGAIN).
  4486. * AVERROR_EOF: the decoder has been flushed, and no new packets can
  4487. * be sent to it (also returned if more than 1 flush
  4488. * packet is sent)
  4489. * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
  4490. * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
  4491. * other errors: legitimate decoding errors
  4492. */
  4493. int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
  4494. /**
  4495. * Return decoded output data from a decoder.
  4496. *
  4497. * @param avctx codec context
  4498. * @param frame This will be set to a reference-counted video or audio
  4499. * frame (depending on the decoder type) allocated by the
  4500. * decoder. Note that the function will always call
  4501. * av_frame_unref(frame) before doing anything else.
  4502. *
  4503. * @return
  4504. * 0: success, a frame was returned
  4505. * AVERROR(EAGAIN): output is not available in this state - user must try
  4506. * to send new input
  4507. * AVERROR_EOF: the decoder has been fully flushed, and there will be
  4508. * no more output frames
  4509. * AVERROR(EINVAL): codec not opened, or it is an encoder
  4510. * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
  4511. * with respect to first decoded frame. Applicable
  4512. * when flag AV_CODEC_FLAG_DROPCHANGED is set.
  4513. * other negative values: legitimate decoding errors
  4514. */
  4515. int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
  4516. /**
  4517. * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
  4518. * to retrieve buffered output packets.
  4519. *
  4520. * @param avctx codec context
  4521. * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
  4522. * Ownership of the frame remains with the caller, and the
  4523. * encoder will not write to the frame. The encoder may create
  4524. * a reference to the frame data (or copy it if the frame is
  4525. * not reference-counted).
  4526. * It can be NULL, in which case it is considered a flush
  4527. * packet. This signals the end of the stream. If the encoder
  4528. * still has packets buffered, it will return them after this
  4529. * call. Once flushing mode has been entered, additional flush
  4530. * packets are ignored, and sending frames will return
  4531. * AVERROR_EOF.
  4532. *
  4533. * For audio:
  4534. * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
  4535. * can have any number of samples.
  4536. * If it is not set, frame->nb_samples must be equal to
  4537. * avctx->frame_size for all frames except the last.
  4538. * The final frame may be smaller than avctx->frame_size.
  4539. * @return 0 on success, otherwise negative error code:
  4540. * AVERROR(EAGAIN): input is not accepted in the current state - user
  4541. * must read output with avcodec_receive_packet() (once
  4542. * all output is read, the packet should be resent, and
  4543. * the call will not fail with EAGAIN).
  4544. * AVERROR_EOF: the encoder has been flushed, and no new frames can
  4545. * be sent to it
  4546. * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
  4547. * decoder, or requires flush
  4548. * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
  4549. * other errors: legitimate decoding errors
  4550. */
  4551. int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
  4552. /**
  4553. * Read encoded data from the encoder.
  4554. *
  4555. * @param avctx codec context
  4556. * @param avpkt This will be set to a reference-counted packet allocated by the
  4557. * encoder. Note that the function will always call
  4558. * av_frame_unref(frame) before doing anything else.
  4559. * @return 0 on success, otherwise negative error code:
  4560. * AVERROR(EAGAIN): output is not available in the current state - user
  4561. * must try to send input
  4562. * AVERROR_EOF: the encoder has been fully flushed, and there will be
  4563. * no more output packets
  4564. * AVERROR(EINVAL): codec not opened, or it is an encoder
  4565. * other errors: legitimate decoding errors
  4566. */
  4567. int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
  4568. /**
  4569. * Create and return a AVHWFramesContext with values adequate for hardware
  4570. * decoding. This is meant to get called from the get_format callback, and is
  4571. * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
  4572. * This API is for decoding with certain hardware acceleration modes/APIs only.
  4573. *
  4574. * The returned AVHWFramesContext is not initialized. The caller must do this
  4575. * with av_hwframe_ctx_init().
  4576. *
  4577. * Calling this function is not a requirement, but makes it simpler to avoid
  4578. * codec or hardware API specific details when manually allocating frames.
  4579. *
  4580. * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
  4581. * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
  4582. * it unnecessary to call this function or having to care about
  4583. * AVHWFramesContext initialization at all.
  4584. *
  4585. * There are a number of requirements for calling this function:
  4586. *
  4587. * - It must be called from get_format with the same avctx parameter that was
  4588. * passed to get_format. Calling it outside of get_format is not allowed, and
  4589. * can trigger undefined behavior.
  4590. * - The function is not always supported (see description of return values).
  4591. * Even if this function returns successfully, hwaccel initialization could
  4592. * fail later. (The degree to which implementations check whether the stream
  4593. * is actually supported varies. Some do this check only after the user's
  4594. * get_format callback returns.)
  4595. * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
  4596. * user decides to use a AVHWFramesContext prepared with this API function,
  4597. * the user must return the same hw_pix_fmt from get_format.
  4598. * - The device_ref passed to this function must support the given hw_pix_fmt.
  4599. * - After calling this API function, it is the user's responsibility to
  4600. * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
  4601. * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
  4602. * before returning from get_format (this is implied by the normal
  4603. * AVCodecContext.hw_frames_ctx API rules).
  4604. * - The AVHWFramesContext parameters may change every time time get_format is
  4605. * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
  4606. * you are inherently required to go through this process again on every
  4607. * get_format call.
  4608. * - It is perfectly possible to call this function without actually using
  4609. * the resulting AVHWFramesContext. One use-case might be trying to reuse a
  4610. * previously initialized AVHWFramesContext, and calling this API function
  4611. * only to test whether the required frame parameters have changed.
  4612. * - Fields that use dynamically allocated values of any kind must not be set
  4613. * by the user unless setting them is explicitly allowed by the documentation.
  4614. * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
  4615. * the new free callback must call the potentially set previous free callback.
  4616. * This API call may set any dynamically allocated fields, including the free
  4617. * callback.
  4618. *
  4619. * The function will set at least the following fields on AVHWFramesContext
  4620. * (potentially more, depending on hwaccel API):
  4621. *
  4622. * - All fields set by av_hwframe_ctx_alloc().
  4623. * - Set the format field to hw_pix_fmt.
  4624. * - Set the sw_format field to the most suited and most versatile format. (An
  4625. * implication is that this will prefer generic formats over opaque formats
  4626. * with arbitrary restrictions, if possible.)
  4627. * - Set the width/height fields to the coded frame size, rounded up to the
  4628. * API-specific minimum alignment.
  4629. * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
  4630. * field to the number of maximum reference surfaces possible with the codec,
  4631. * plus 1 surface for the user to work (meaning the user can safely reference
  4632. * at most 1 decoded surface at a time), plus additional buffering introduced
  4633. * by frame threading. If the hwaccel does not require pre-allocation, the
  4634. * field is left to 0, and the decoder will allocate new surfaces on demand
  4635. * during decoding.
  4636. * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
  4637. * hardware API.
  4638. *
  4639. * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
  4640. * with basic frame parameters set.
  4641. *
  4642. * The function is stateless, and does not change the AVCodecContext or the
  4643. * device_ref AVHWDeviceContext.
  4644. *
  4645. * @param avctx The context which is currently calling get_format, and which
  4646. * implicitly contains all state needed for filling the returned
  4647. * AVHWFramesContext properly.
  4648. * @param device_ref A reference to the AVHWDeviceContext describing the device
  4649. * which will be used by the hardware decoder.
  4650. * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
  4651. * @param out_frames_ref On success, set to a reference to an _uninitialized_
  4652. * AVHWFramesContext, created from the given device_ref.
  4653. * Fields will be set to values required for decoding.
  4654. * Not changed if an error is returned.
  4655. * @return zero on success, a negative value on error. The following error codes
  4656. * have special semantics:
  4657. * AVERROR(ENOENT): the decoder does not support this functionality. Setup
  4658. * is always manual, or it is a decoder which does not
  4659. * support setting AVCodecContext.hw_frames_ctx at all,
  4660. * or it is a software format.
  4661. * AVERROR(EINVAL): it is known that hardware decoding is not supported for
  4662. * this configuration, or the device_ref is not supported
  4663. * for the hwaccel referenced by hw_pix_fmt.
  4664. */
  4665. int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
  4666. AVBufferRef *device_ref,
  4667. enum AVPixelFormat hw_pix_fmt,
  4668. AVBufferRef **out_frames_ref);
  4669. /**
  4670. * @defgroup lavc_parsing Frame parsing
  4671. * @{
  4672. */
  4673. enum AVPictureStructure {
  4674. AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
  4675. AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
  4676. AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
  4677. AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
  4678. };
  4679. typedef struct AVCodecParserContext {
  4680. void *priv_data;
  4681. struct AVCodecParser *parser;
  4682. int64_t frame_offset; /* offset of the current frame */
  4683. int64_t cur_offset; /* current offset
  4684. (incremented by each av_parser_parse()) */
  4685. int64_t next_frame_offset; /* offset of the next frame */
  4686. /* video info */
  4687. int pict_type; /* XXX: Put it back in AVCodecContext. */
  4688. /**
  4689. * This field is used for proper frame duration computation in lavf.
  4690. * It signals, how much longer the frame duration of the current frame
  4691. * is compared to normal frame duration.
  4692. *
  4693. * frame_duration = (1 + repeat_pict) * time_base
  4694. *
  4695. * It is used by codecs like H.264 to display telecined material.
  4696. */
  4697. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  4698. int64_t pts; /* pts of the current frame */
  4699. int64_t dts; /* dts of the current frame */
  4700. /* private data */
  4701. int64_t last_pts;
  4702. int64_t last_dts;
  4703. int fetch_timestamp;
  4704. #define AV_PARSER_PTS_NB 4
  4705. int cur_frame_start_index;
  4706. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  4707. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  4708. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  4709. int flags;
  4710. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  4711. #define PARSER_FLAG_ONCE 0x0002
  4712. /// Set if the parser has a valid file offset
  4713. #define PARSER_FLAG_FETCHED_OFFSET 0x0004
  4714. #define PARSER_FLAG_USE_CODEC_TS 0x1000
  4715. int64_t offset; ///< byte offset from starting packet start
  4716. int64_t cur_frame_end[AV_PARSER_PTS_NB];
  4717. /**
  4718. * Set by parser to 1 for key frames and 0 for non-key frames.
  4719. * It is initialized to -1, so if the parser doesn't set this flag,
  4720. * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
  4721. * will be used.
  4722. */
  4723. int key_frame;
  4724. #if FF_API_CONVERGENCE_DURATION
  4725. /**
  4726. * @deprecated unused
  4727. */
  4728. attribute_deprecated
  4729. int64_t convergence_duration;
  4730. #endif
  4731. // Timestamp generation support:
  4732. /**
  4733. * Synchronization point for start of timestamp generation.
  4734. *
  4735. * Set to >0 for sync point, 0 for no sync point and <0 for undefined
  4736. * (default).
  4737. *
  4738. * For example, this corresponds to presence of H.264 buffering period
  4739. * SEI message.
  4740. */
  4741. int dts_sync_point;
  4742. /**
  4743. * Offset of the current timestamp against last timestamp sync point in
  4744. * units of AVCodecContext.time_base.
  4745. *
  4746. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  4747. * contain a valid timestamp offset.
  4748. *
  4749. * Note that the timestamp of sync point has usually a nonzero
  4750. * dts_ref_dts_delta, which refers to the previous sync point. Offset of
  4751. * the next frame after timestamp sync point will be usually 1.
  4752. *
  4753. * For example, this corresponds to H.264 cpb_removal_delay.
  4754. */
  4755. int dts_ref_dts_delta;
  4756. /**
  4757. * Presentation delay of current frame in units of AVCodecContext.time_base.
  4758. *
  4759. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  4760. * contain valid non-negative timestamp delta (presentation time of a frame
  4761. * must not lie in the past).
  4762. *
  4763. * This delay represents the difference between decoding and presentation
  4764. * time of the frame.
  4765. *
  4766. * For example, this corresponds to H.264 dpb_output_delay.
  4767. */
  4768. int pts_dts_delta;
  4769. /**
  4770. * Position of the packet in file.
  4771. *
  4772. * Analogous to cur_frame_pts/dts
  4773. */
  4774. int64_t cur_frame_pos[AV_PARSER_PTS_NB];
  4775. /**
  4776. * Byte position of currently parsed frame in stream.
  4777. */
  4778. int64_t pos;
  4779. /**
  4780. * Previous frame byte position.
  4781. */
  4782. int64_t last_pos;
  4783. /**
  4784. * Duration of the current frame.
  4785. * For audio, this is in units of 1 / AVCodecContext.sample_rate.
  4786. * For all other types, this is in units of AVCodecContext.time_base.
  4787. */
  4788. int duration;
  4789. enum AVFieldOrder field_order;
  4790. /**
  4791. * Indicate whether a picture is coded as a frame, top field or bottom field.
  4792. *
  4793. * For example, H.264 field_pic_flag equal to 0 corresponds to
  4794. * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
  4795. * equal to 1 and bottom_field_flag equal to 0 corresponds to
  4796. * AV_PICTURE_STRUCTURE_TOP_FIELD.
  4797. */
  4798. enum AVPictureStructure picture_structure;
  4799. /**
  4800. * Picture number incremented in presentation or output order.
  4801. * This field may be reinitialized at the first picture of a new sequence.
  4802. *
  4803. * For example, this corresponds to H.264 PicOrderCnt.
  4804. */
  4805. int output_picture_number;
  4806. /**
  4807. * Dimensions of the decoded video intended for presentation.
  4808. */
  4809. int width;
  4810. int height;
  4811. /**
  4812. * Dimensions of the coded video.
  4813. */
  4814. int coded_width;
  4815. int coded_height;
  4816. /**
  4817. * The format of the coded data, corresponds to enum AVPixelFormat for video
  4818. * and for enum AVSampleFormat for audio.
  4819. *
  4820. * Note that a decoder can have considerable freedom in how exactly it
  4821. * decodes the data, so the format reported here might be different from the
  4822. * one returned by a decoder.
  4823. */
  4824. int format;
  4825. } AVCodecParserContext;
  4826. typedef struct AVCodecParser {
  4827. int codec_ids[5]; /* several codec IDs are permitted */
  4828. int priv_data_size;
  4829. int (*parser_init)(AVCodecParserContext *s);
  4830. /* This callback never returns an error, a negative value means that
  4831. * the frame start was in a previous packet. */
  4832. int (*parser_parse)(AVCodecParserContext *s,
  4833. AVCodecContext *avctx,
  4834. const uint8_t **poutbuf, int *poutbuf_size,
  4835. const uint8_t *buf, int buf_size);
  4836. void (*parser_close)(AVCodecParserContext *s);
  4837. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  4838. struct AVCodecParser *next;
  4839. } AVCodecParser;
  4840. /**
  4841. * Iterate over all registered codec parsers.
  4842. *
  4843. * @param opaque a pointer where libavcodec will store the iteration state. Must
  4844. * point to NULL to start the iteration.
  4845. *
  4846. * @return the next registered codec parser or NULL when the iteration is
  4847. * finished
  4848. */
  4849. const AVCodecParser *av_parser_iterate(void **opaque);
  4850. attribute_deprecated
  4851. AVCodecParser *av_parser_next(const AVCodecParser *c);
  4852. attribute_deprecated
  4853. void av_register_codec_parser(AVCodecParser *parser);
  4854. AVCodecParserContext *av_parser_init(int codec_id);
  4855. /**
  4856. * Parse a packet.
  4857. *
  4858. * @param s parser context.
  4859. * @param avctx codec context.
  4860. * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
  4861. * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
  4862. * @param buf input buffer.
  4863. * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
  4864. size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
  4865. To signal EOF, this should be 0 (so that the last frame
  4866. can be output).
  4867. * @param pts input presentation timestamp.
  4868. * @param dts input decoding timestamp.
  4869. * @param pos input byte position in stream.
  4870. * @return the number of bytes of the input bitstream used.
  4871. *
  4872. * Example:
  4873. * @code
  4874. * while(in_len){
  4875. * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
  4876. * in_data, in_len,
  4877. * pts, dts, pos);
  4878. * in_data += len;
  4879. * in_len -= len;
  4880. *
  4881. * if(size)
  4882. * decode_frame(data, size);
  4883. * }
  4884. * @endcode
  4885. */
  4886. int av_parser_parse2(AVCodecParserContext *s,
  4887. AVCodecContext *avctx,
  4888. uint8_t **poutbuf, int *poutbuf_size,
  4889. const uint8_t *buf, int buf_size,
  4890. int64_t pts, int64_t dts,
  4891. int64_t pos);
  4892. /**
  4893. * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
  4894. * @deprecated use AVBitStreamFilter
  4895. */
  4896. int av_parser_change(AVCodecParserContext *s,
  4897. AVCodecContext *avctx,
  4898. uint8_t **poutbuf, int *poutbuf_size,
  4899. const uint8_t *buf, int buf_size, int keyframe);
  4900. void av_parser_close(AVCodecParserContext *s);
  4901. /**
  4902. * @}
  4903. * @}
  4904. */
  4905. /**
  4906. * @addtogroup lavc_encoding
  4907. * @{
  4908. */
  4909. /**
  4910. * Find a registered encoder with a matching codec ID.
  4911. *
  4912. * @param id AVCodecID of the requested encoder
  4913. * @return An encoder if one was found, NULL otherwise.
  4914. */
  4915. AVCodec *avcodec_find_encoder(enum AVCodecID id);
  4916. /**
  4917. * Find a registered encoder with the specified name.
  4918. *
  4919. * @param name name of the requested encoder
  4920. * @return An encoder if one was found, NULL otherwise.
  4921. */
  4922. AVCodec *avcodec_find_encoder_by_name(const char *name);
  4923. /**
  4924. * Encode a frame of audio.
  4925. *
  4926. * Takes input samples from frame and writes the next output packet, if
  4927. * available, to avpkt. The output packet does not necessarily contain data for
  4928. * the most recent frame, as encoders can delay, split, and combine input frames
  4929. * internally as needed.
  4930. *
  4931. * @param avctx codec context
  4932. * @param avpkt output AVPacket.
  4933. * The user can supply an output buffer by setting
  4934. * avpkt->data and avpkt->size prior to calling the
  4935. * function, but if the size of the user-provided data is not
  4936. * large enough, encoding will fail. If avpkt->data and
  4937. * avpkt->size are set, avpkt->destruct must also be set. All
  4938. * other AVPacket fields will be reset by the encoder using
  4939. * av_init_packet(). If avpkt->data is NULL, the encoder will
  4940. * allocate it. The encoder will set avpkt->size to the size
  4941. * of the output packet.
  4942. *
  4943. * If this function fails or produces no output, avpkt will be
  4944. * freed using av_packet_unref().
  4945. * @param[in] frame AVFrame containing the raw audio data to be encoded.
  4946. * May be NULL when flushing an encoder that has the
  4947. * AV_CODEC_CAP_DELAY capability set.
  4948. * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
  4949. * can have any number of samples.
  4950. * If it is not set, frame->nb_samples must be equal to
  4951. * avctx->frame_size for all frames except the last.
  4952. * The final frame may be smaller than avctx->frame_size.
  4953. * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
  4954. * output packet is non-empty, and to 0 if it is
  4955. * empty. If the function returns an error, the
  4956. * packet can be assumed to be invalid, and the
  4957. * value of got_packet_ptr is undefined and should
  4958. * not be used.
  4959. * @return 0 on success, negative error code on failure
  4960. *
  4961. * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
  4962. */
  4963. attribute_deprecated
  4964. int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
  4965. const AVFrame *frame, int *got_packet_ptr);
  4966. /**
  4967. * Encode a frame of video.
  4968. *
  4969. * Takes input raw video data from frame and writes the next output packet, if
  4970. * available, to avpkt. The output packet does not necessarily contain data for
  4971. * the most recent frame, as encoders can delay and reorder input frames
  4972. * internally as needed.
  4973. *
  4974. * @param avctx codec context
  4975. * @param avpkt output AVPacket.
  4976. * The user can supply an output buffer by setting
  4977. * avpkt->data and avpkt->size prior to calling the
  4978. * function, but if the size of the user-provided data is not
  4979. * large enough, encoding will fail. All other AVPacket fields
  4980. * will be reset by the encoder using av_init_packet(). If
  4981. * avpkt->data is NULL, the encoder will allocate it.
  4982. * The encoder will set avpkt->size to the size of the
  4983. * output packet. The returned data (if any) belongs to the
  4984. * caller, he is responsible for freeing it.
  4985. *
  4986. * If this function fails or produces no output, avpkt will be
  4987. * freed using av_packet_unref().
  4988. * @param[in] frame AVFrame containing the raw video data to be encoded.
  4989. * May be NULL when flushing an encoder that has the
  4990. * AV_CODEC_CAP_DELAY capability set.
  4991. * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
  4992. * output packet is non-empty, and to 0 if it is
  4993. * empty. If the function returns an error, the
  4994. * packet can be assumed to be invalid, and the
  4995. * value of got_packet_ptr is undefined and should
  4996. * not be used.
  4997. * @return 0 on success, negative error code on failure
  4998. *
  4999. * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
  5000. */
  5001. attribute_deprecated
  5002. int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
  5003. const AVFrame *frame, int *got_packet_ptr);
  5004. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  5005. const AVSubtitle *sub);
  5006. /**
  5007. * @}
  5008. */
  5009. #if FF_API_AVPICTURE
  5010. /**
  5011. * @addtogroup lavc_picture
  5012. * @{
  5013. */
  5014. /**
  5015. * @deprecated unused
  5016. */
  5017. attribute_deprecated
  5018. int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
  5019. /**
  5020. * @deprecated unused
  5021. */
  5022. attribute_deprecated
  5023. void avpicture_free(AVPicture *picture);
  5024. /**
  5025. * @deprecated use av_image_fill_arrays() instead.
  5026. */
  5027. attribute_deprecated
  5028. int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
  5029. enum AVPixelFormat pix_fmt, int width, int height);
  5030. /**
  5031. * @deprecated use av_image_copy_to_buffer() instead.
  5032. */
  5033. attribute_deprecated
  5034. int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
  5035. int width, int height,
  5036. unsigned char *dest, int dest_size);
  5037. /**
  5038. * @deprecated use av_image_get_buffer_size() instead.
  5039. */
  5040. attribute_deprecated
  5041. int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
  5042. /**
  5043. * @deprecated av_image_copy() instead.
  5044. */
  5045. attribute_deprecated
  5046. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  5047. enum AVPixelFormat pix_fmt, int width, int height);
  5048. /**
  5049. * @deprecated unused
  5050. */
  5051. attribute_deprecated
  5052. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  5053. enum AVPixelFormat pix_fmt, int top_band, int left_band);
  5054. /**
  5055. * @deprecated unused
  5056. */
  5057. attribute_deprecated
  5058. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
  5059. int padtop, int padbottom, int padleft, int padright, int *color);
  5060. /**
  5061. * @}
  5062. */
  5063. #endif
  5064. /**
  5065. * @defgroup lavc_misc Utility functions
  5066. * @ingroup libavc
  5067. *
  5068. * Miscellaneous utility functions related to both encoding and decoding
  5069. * (or neither).
  5070. * @{
  5071. */
  5072. /**
  5073. * @defgroup lavc_misc_pixfmt Pixel formats
  5074. *
  5075. * Functions for working with pixel formats.
  5076. * @{
  5077. */
  5078. #if FF_API_GETCHROMA
  5079. /**
  5080. * @deprecated Use av_pix_fmt_get_chroma_sub_sample
  5081. */
  5082. attribute_deprecated
  5083. void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
  5084. #endif
  5085. /**
  5086. * Return a value representing the fourCC code associated to the
  5087. * pixel format pix_fmt, or 0 if no associated fourCC code can be
  5088. * found.
  5089. */
  5090. unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
  5091. /**
  5092. * @deprecated see av_get_pix_fmt_loss()
  5093. */
  5094. int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
  5095. int has_alpha);
  5096. /**
  5097. * Find the best pixel format to convert to given a certain source pixel
  5098. * format. When converting from one pixel format to another, information loss
  5099. * may occur. For example, when converting from RGB24 to GRAY, the color
  5100. * information will be lost. Similarly, other losses occur when converting from
  5101. * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
  5102. * the given pixel formats should be used to suffer the least amount of loss.
  5103. * The pixel formats from which it chooses one, are determined by the
  5104. * pix_fmt_list parameter.
  5105. *
  5106. *
  5107. * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
  5108. * @param[in] src_pix_fmt source pixel format
  5109. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  5110. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  5111. * @return The best pixel format to convert to or -1 if none was found.
  5112. */
  5113. enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
  5114. enum AVPixelFormat src_pix_fmt,
  5115. int has_alpha, int *loss_ptr);
  5116. /**
  5117. * @deprecated see av_find_best_pix_fmt_of_2()
  5118. */
  5119. enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
  5120. enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
  5121. attribute_deprecated
  5122. enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
  5123. enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
  5124. enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
  5125. /**
  5126. * @}
  5127. */
  5128. #if FF_API_TAG_STRING
  5129. /**
  5130. * Put a string representing the codec tag codec_tag in buf.
  5131. *
  5132. * @param buf buffer to place codec tag in
  5133. * @param buf_size size in bytes of buf
  5134. * @param codec_tag codec tag to assign
  5135. * @return the length of the string that would have been generated if
  5136. * enough space had been available, excluding the trailing null
  5137. *
  5138. * @deprecated see av_fourcc_make_string() and av_fourcc2str().
  5139. */
  5140. attribute_deprecated
  5141. size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
  5142. #endif
  5143. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  5144. /**
  5145. * Return a name for the specified profile, if available.
  5146. *
  5147. * @param codec the codec that is searched for the given profile
  5148. * @param profile the profile value for which a name is requested
  5149. * @return A name for the profile if found, NULL otherwise.
  5150. */
  5151. const char *av_get_profile_name(const AVCodec *codec, int profile);
  5152. /**
  5153. * Return a name for the specified profile, if available.
  5154. *
  5155. * @param codec_id the ID of the codec to which the requested profile belongs
  5156. * @param profile the profile value for which a name is requested
  5157. * @return A name for the profile if found, NULL otherwise.
  5158. *
  5159. * @note unlike av_get_profile_name(), which searches a list of profiles
  5160. * supported by a specific decoder or encoder implementation, this
  5161. * function searches the list of profiles from the AVCodecDescriptor
  5162. */
  5163. const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
  5164. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  5165. int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
  5166. //FIXME func typedef
  5167. /**
  5168. * Fill AVFrame audio data and linesize pointers.
  5169. *
  5170. * The buffer buf must be a preallocated buffer with a size big enough
  5171. * to contain the specified samples amount. The filled AVFrame data
  5172. * pointers will point to this buffer.
  5173. *
  5174. * AVFrame extended_data channel pointers are allocated if necessary for
  5175. * planar audio.
  5176. *
  5177. * @param frame the AVFrame
  5178. * frame->nb_samples must be set prior to calling the
  5179. * function. This function fills in frame->data,
  5180. * frame->extended_data, frame->linesize[0].
  5181. * @param nb_channels channel count
  5182. * @param sample_fmt sample format
  5183. * @param buf buffer to use for frame data
  5184. * @param buf_size size of buffer
  5185. * @param align plane size sample alignment (0 = default)
  5186. * @return >=0 on success, negative error code on failure
  5187. * @todo return the size in bytes required to store the samples in
  5188. * case of success, at the next libavutil bump
  5189. */
  5190. int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
  5191. enum AVSampleFormat sample_fmt, const uint8_t *buf,
  5192. int buf_size, int align);
  5193. /**
  5194. * Reset the internal decoder state / flush internal buffers. Should be called
  5195. * e.g. when seeking or when switching to a different stream.
  5196. *
  5197. * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
  5198. * this invalidates the frames previously returned from the decoder. When
  5199. * refcounted frames are used, the decoder just releases any references it might
  5200. * keep internally, but the caller's reference remains valid.
  5201. */
  5202. void avcodec_flush_buffers(AVCodecContext *avctx);
  5203. /**
  5204. * Return codec bits per sample.
  5205. *
  5206. * @param[in] codec_id the codec
  5207. * @return Number of bits per sample or zero if unknown for the given codec.
  5208. */
  5209. int av_get_bits_per_sample(enum AVCodecID codec_id);
  5210. /**
  5211. * Return the PCM codec associated with a sample format.
  5212. * @param be endianness, 0 for little, 1 for big,
  5213. * -1 (or anything else) for native
  5214. * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
  5215. */
  5216. enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
  5217. /**
  5218. * Return codec bits per sample.
  5219. * Only return non-zero if the bits per sample is exactly correct, not an
  5220. * approximation.
  5221. *
  5222. * @param[in] codec_id the codec
  5223. * @return Number of bits per sample or zero if unknown for the given codec.
  5224. */
  5225. int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
  5226. /**
  5227. * Return audio frame duration.
  5228. *
  5229. * @param avctx codec context
  5230. * @param frame_bytes size of the frame, or 0 if unknown
  5231. * @return frame duration, in samples, if known. 0 if not able to
  5232. * determine.
  5233. */
  5234. int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
  5235. /**
  5236. * This function is the same as av_get_audio_frame_duration(), except it works
  5237. * with AVCodecParameters instead of an AVCodecContext.
  5238. */
  5239. int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
  5240. #if FF_API_OLD_BSF
  5241. typedef struct AVBitStreamFilterContext {
  5242. void *priv_data;
  5243. const struct AVBitStreamFilter *filter;
  5244. AVCodecParserContext *parser;
  5245. struct AVBitStreamFilterContext *next;
  5246. /**
  5247. * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
  5248. * Not for access by library users.
  5249. */
  5250. char *args;
  5251. } AVBitStreamFilterContext;
  5252. #endif
  5253. typedef struct AVBSFInternal AVBSFInternal;
  5254. /**
  5255. * The bitstream filter state.
  5256. *
  5257. * This struct must be allocated with av_bsf_alloc() and freed with
  5258. * av_bsf_free().
  5259. *
  5260. * The fields in the struct will only be changed (by the caller or by the
  5261. * filter) as described in their documentation, and are to be considered
  5262. * immutable otherwise.
  5263. */
  5264. typedef struct AVBSFContext {
  5265. /**
  5266. * A class for logging and AVOptions
  5267. */
  5268. const AVClass *av_class;
  5269. /**
  5270. * The bitstream filter this context is an instance of.
  5271. */
  5272. const struct AVBitStreamFilter *filter;
  5273. /**
  5274. * Opaque libavcodec internal data. Must not be touched by the caller in any
  5275. * way.
  5276. */
  5277. AVBSFInternal *internal;
  5278. /**
  5279. * Opaque filter-specific private data. If filter->priv_class is non-NULL,
  5280. * this is an AVOptions-enabled struct.
  5281. */
  5282. void *priv_data;
  5283. /**
  5284. * Parameters of the input stream. This field is allocated in
  5285. * av_bsf_alloc(), it needs to be filled by the caller before
  5286. * av_bsf_init().
  5287. */
  5288. AVCodecParameters *par_in;
  5289. /**
  5290. * Parameters of the output stream. This field is allocated in
  5291. * av_bsf_alloc(), it is set by the filter in av_bsf_init().
  5292. */
  5293. AVCodecParameters *par_out;
  5294. /**
  5295. * The timebase used for the timestamps of the input packets. Set by the
  5296. * caller before av_bsf_init().
  5297. */
  5298. AVRational time_base_in;
  5299. /**
  5300. * The timebase used for the timestamps of the output packets. Set by the
  5301. * filter in av_bsf_init().
  5302. */
  5303. AVRational time_base_out;
  5304. } AVBSFContext;
  5305. typedef struct AVBitStreamFilter {
  5306. const char *name;
  5307. /**
  5308. * A list of codec ids supported by the filter, terminated by
  5309. * AV_CODEC_ID_NONE.
  5310. * May be NULL, in that case the bitstream filter works with any codec id.
  5311. */
  5312. const enum AVCodecID *codec_ids;
  5313. /**
  5314. * A class for the private data, used to declare bitstream filter private
  5315. * AVOptions. This field is NULL for bitstream filters that do not declare
  5316. * any options.
  5317. *
  5318. * If this field is non-NULL, the first member of the filter private data
  5319. * must be a pointer to AVClass, which will be set by libavcodec generic
  5320. * code to this class.
  5321. */
  5322. const AVClass *priv_class;
  5323. /*****************************************************************
  5324. * No fields below this line are part of the public API. They
  5325. * may not be used outside of libavcodec and can be changed and
  5326. * removed at will.
  5327. * New public fields should be added right above.
  5328. *****************************************************************
  5329. */
  5330. int priv_data_size;
  5331. int (*init)(AVBSFContext *ctx);
  5332. int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
  5333. void (*close)(AVBSFContext *ctx);
  5334. void (*flush)(AVBSFContext *ctx);
  5335. } AVBitStreamFilter;
  5336. #if FF_API_OLD_BSF
  5337. /**
  5338. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
  5339. * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
  5340. */
  5341. attribute_deprecated
  5342. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  5343. /**
  5344. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
  5345. * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
  5346. * from the new bitstream filtering API (using AVBSFContext).
  5347. */
  5348. attribute_deprecated
  5349. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  5350. /**
  5351. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
  5352. * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
  5353. * new bitstream filtering API (using AVBSFContext).
  5354. */
  5355. attribute_deprecated
  5356. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  5357. AVCodecContext *avctx, const char *args,
  5358. uint8_t **poutbuf, int *poutbuf_size,
  5359. const uint8_t *buf, int buf_size, int keyframe);
  5360. /**
  5361. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
  5362. * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
  5363. * AVBSFContext).
  5364. */
  5365. attribute_deprecated
  5366. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  5367. /**
  5368. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
  5369. * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
  5370. * AVBSFContext).
  5371. */
  5372. attribute_deprecated
  5373. const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
  5374. #endif
  5375. /**
  5376. * @return a bitstream filter with the specified name or NULL if no such
  5377. * bitstream filter exists.
  5378. */
  5379. const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
  5380. /**
  5381. * Iterate over all registered bitstream filters.
  5382. *
  5383. * @param opaque a pointer where libavcodec will store the iteration state. Must
  5384. * point to NULL to start the iteration.
  5385. *
  5386. * @return the next registered bitstream filter or NULL when the iteration is
  5387. * finished
  5388. */
  5389. const AVBitStreamFilter *av_bsf_iterate(void **opaque);
  5390. #if FF_API_NEXT
  5391. attribute_deprecated
  5392. const AVBitStreamFilter *av_bsf_next(void **opaque);
  5393. #endif
  5394. /**
  5395. * Allocate a context for a given bitstream filter. The caller must fill in the
  5396. * context parameters as described in the documentation and then call
  5397. * av_bsf_init() before sending any data to the filter.
  5398. *
  5399. * @param filter the filter for which to allocate an instance.
  5400. * @param ctx a pointer into which the pointer to the newly-allocated context
  5401. * will be written. It must be freed with av_bsf_free() after the
  5402. * filtering is done.
  5403. *
  5404. * @return 0 on success, a negative AVERROR code on failure
  5405. */
  5406. int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
  5407. /**
  5408. * Prepare the filter for use, after all the parameters and options have been
  5409. * set.
  5410. */
  5411. int av_bsf_init(AVBSFContext *ctx);
  5412. /**
  5413. * Submit a packet for filtering.
  5414. *
  5415. * After sending each packet, the filter must be completely drained by calling
  5416. * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
  5417. * AVERROR_EOF.
  5418. *
  5419. * @param pkt the packet to filter. The bitstream filter will take ownership of
  5420. * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
  5421. * This parameter may be NULL, which signals the end of the stream (i.e. no more
  5422. * packets will be sent). That will cause the filter to output any packets it
  5423. * may have buffered internally.
  5424. *
  5425. * @return 0 on success, a negative AVERROR on error.
  5426. */
  5427. int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
  5428. /**
  5429. * Retrieve a filtered packet.
  5430. *
  5431. * @param[out] pkt this struct will be filled with the contents of the filtered
  5432. * packet. It is owned by the caller and must be freed using
  5433. * av_packet_unref() when it is no longer needed.
  5434. * This parameter should be "clean" (i.e. freshly allocated
  5435. * with av_packet_alloc() or unreffed with av_packet_unref())
  5436. * when this function is called. If this function returns
  5437. * successfully, the contents of pkt will be completely
  5438. * overwritten by the returned data. On failure, pkt is not
  5439. * touched.
  5440. *
  5441. * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
  5442. * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
  5443. * will be no further output from the filter. Another negative AVERROR value if
  5444. * an error occurs.
  5445. *
  5446. * @note one input packet may result in several output packets, so after sending
  5447. * a packet with av_bsf_send_packet(), this function needs to be called
  5448. * repeatedly until it stops returning 0. It is also possible for a filter to
  5449. * output fewer packets than were sent to it, so this function may return
  5450. * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
  5451. */
  5452. int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
  5453. /**
  5454. * Reset the internal bitstream filter state / flush internal buffers.
  5455. */
  5456. void av_bsf_flush(AVBSFContext *ctx);
  5457. /**
  5458. * Free a bitstream filter context and everything associated with it; write NULL
  5459. * into the supplied pointer.
  5460. */
  5461. void av_bsf_free(AVBSFContext **ctx);
  5462. /**
  5463. * Get the AVClass for AVBSFContext. It can be used in combination with
  5464. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  5465. *
  5466. * @see av_opt_find().
  5467. */
  5468. const AVClass *av_bsf_get_class(void);
  5469. /**
  5470. * Structure for chain/list of bitstream filters.
  5471. * Empty list can be allocated by av_bsf_list_alloc().
  5472. */
  5473. typedef struct AVBSFList AVBSFList;
  5474. /**
  5475. * Allocate empty list of bitstream filters.
  5476. * The list must be later freed by av_bsf_list_free()
  5477. * or finalized by av_bsf_list_finalize().
  5478. *
  5479. * @return Pointer to @ref AVBSFList on success, NULL in case of failure
  5480. */
  5481. AVBSFList *av_bsf_list_alloc(void);
  5482. /**
  5483. * Free list of bitstream filters.
  5484. *
  5485. * @param lst Pointer to pointer returned by av_bsf_list_alloc()
  5486. */
  5487. void av_bsf_list_free(AVBSFList **lst);
  5488. /**
  5489. * Append bitstream filter to the list of bitstream filters.
  5490. *
  5491. * @param lst List to append to
  5492. * @param bsf Filter context to be appended
  5493. *
  5494. * @return >=0 on success, negative AVERROR in case of failure
  5495. */
  5496. int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
  5497. /**
  5498. * Construct new bitstream filter context given it's name and options
  5499. * and append it to the list of bitstream filters.
  5500. *
  5501. * @param lst List to append to
  5502. * @param bsf_name Name of the bitstream filter
  5503. * @param options Options for the bitstream filter, can be set to NULL
  5504. *
  5505. * @return >=0 on success, negative AVERROR in case of failure
  5506. */
  5507. int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
  5508. /**
  5509. * Finalize list of bitstream filters.
  5510. *
  5511. * This function will transform @ref AVBSFList to single @ref AVBSFContext,
  5512. * so the whole chain of bitstream filters can be treated as single filter
  5513. * freshly allocated by av_bsf_alloc().
  5514. * If the call is successful, @ref AVBSFList structure is freed and lst
  5515. * will be set to NULL. In case of failure, caller is responsible for
  5516. * freeing the structure by av_bsf_list_free()
  5517. *
  5518. * @param lst Filter list structure to be transformed
  5519. * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
  5520. * representing the chain of bitstream filters
  5521. *
  5522. * @return >=0 on success, negative AVERROR in case of failure
  5523. */
  5524. int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
  5525. /**
  5526. * Parse string describing list of bitstream filters and create single
  5527. * @ref AVBSFContext describing the whole chain of bitstream filters.
  5528. * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
  5529. * allocated by av_bsf_alloc().
  5530. *
  5531. * @param str String describing chain of bitstream filters in format
  5532. * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
  5533. * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
  5534. * representing the chain of bitstream filters
  5535. *
  5536. * @return >=0 on success, negative AVERROR in case of failure
  5537. */
  5538. int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
  5539. /**
  5540. * Get null/pass-through bitstream filter.
  5541. *
  5542. * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
  5543. *
  5544. * @return
  5545. */
  5546. int av_bsf_get_null_filter(AVBSFContext **bsf);
  5547. /* memory */
  5548. /**
  5549. * Same behaviour av_fast_malloc but the buffer has additional
  5550. * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
  5551. *
  5552. * In addition the whole buffer will initially and after resizes
  5553. * be 0-initialized so that no uninitialized data will ever appear.
  5554. */
  5555. void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
  5556. /**
  5557. * Same behaviour av_fast_padded_malloc except that buffer will always
  5558. * be 0-initialized after call.
  5559. */
  5560. void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
  5561. /**
  5562. * Encode extradata length to a buffer. Used by xiph codecs.
  5563. *
  5564. * @param s buffer to write to; must be at least (v/255+1) bytes long
  5565. * @param v size of extradata in bytes
  5566. * @return number of bytes written to the buffer.
  5567. */
  5568. unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  5569. #if FF_API_USER_VISIBLE_AVHWACCEL
  5570. /**
  5571. * Register the hardware accelerator hwaccel.
  5572. *
  5573. * @deprecated This function doesn't do anything.
  5574. */
  5575. attribute_deprecated
  5576. void av_register_hwaccel(AVHWAccel *hwaccel);
  5577. /**
  5578. * If hwaccel is NULL, returns the first registered hardware accelerator,
  5579. * if hwaccel is non-NULL, returns the next registered hardware accelerator
  5580. * after hwaccel, or NULL if hwaccel is the last one.
  5581. *
  5582. * @deprecated AVHWaccel structures contain no user-serviceable parts, so
  5583. * this function should not be used.
  5584. */
  5585. attribute_deprecated
  5586. AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
  5587. #endif
  5588. #if FF_API_LOCKMGR
  5589. /**
  5590. * Lock operation used by lockmgr
  5591. *
  5592. * @deprecated Deprecated together with av_lockmgr_register().
  5593. */
  5594. enum AVLockOp {
  5595. AV_LOCK_CREATE, ///< Create a mutex
  5596. AV_LOCK_OBTAIN, ///< Lock the mutex
  5597. AV_LOCK_RELEASE, ///< Unlock the mutex
  5598. AV_LOCK_DESTROY, ///< Free mutex resources
  5599. };
  5600. /**
  5601. * Register a user provided lock manager supporting the operations
  5602. * specified by AVLockOp. The "mutex" argument to the function points
  5603. * to a (void *) where the lockmgr should store/get a pointer to a user
  5604. * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
  5605. * value left by the last call for all other ops. If the lock manager is
  5606. * unable to perform the op then it should leave the mutex in the same
  5607. * state as when it was called and return a non-zero value. However,
  5608. * when called with AV_LOCK_DESTROY the mutex will always be assumed to
  5609. * have been successfully destroyed. If av_lockmgr_register succeeds
  5610. * it will return a non-negative value, if it fails it will return a
  5611. * negative value and destroy all mutex and unregister all callbacks.
  5612. * av_lockmgr_register is not thread-safe, it must be called from a
  5613. * single thread before any calls which make use of locking are used.
  5614. *
  5615. * @param cb User defined callback. av_lockmgr_register invokes calls
  5616. * to this callback and the previously registered callback.
  5617. * The callback will be used to create more than one mutex
  5618. * each of which must be backed by its own underlying locking
  5619. * mechanism (i.e. do not use a single static object to
  5620. * implement your lock manager). If cb is set to NULL the
  5621. * lockmgr will be unregistered.
  5622. *
  5623. * @deprecated This function does nothing, and always returns 0. Be sure to
  5624. * build with thread support to get basic thread safety.
  5625. */
  5626. attribute_deprecated
  5627. int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
  5628. #endif
  5629. /**
  5630. * Get the type of the given codec.
  5631. */
  5632. enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
  5633. /**
  5634. * Get the name of a codec.
  5635. * @return a static string identifying the codec; never NULL
  5636. */
  5637. const char *avcodec_get_name(enum AVCodecID id);
  5638. /**
  5639. * @return a positive value if s is open (i.e. avcodec_open2() was called on it
  5640. * with no corresponding avcodec_close()), 0 otherwise.
  5641. */
  5642. int avcodec_is_open(AVCodecContext *s);
  5643. /**
  5644. * @return a non-zero number if codec is an encoder, zero otherwise
  5645. */
  5646. int av_codec_is_encoder(const AVCodec *codec);
  5647. /**
  5648. * @return a non-zero number if codec is a decoder, zero otherwise
  5649. */
  5650. int av_codec_is_decoder(const AVCodec *codec);
  5651. /**
  5652. * @return descriptor for given codec ID or NULL if no descriptor exists.
  5653. */
  5654. const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
  5655. /**
  5656. * Iterate over all codec descriptors known to libavcodec.
  5657. *
  5658. * @param prev previous descriptor. NULL to get the first descriptor.
  5659. *
  5660. * @return next descriptor or NULL after the last descriptor
  5661. */
  5662. const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
  5663. /**
  5664. * @return codec descriptor with the given name or NULL if no such descriptor
  5665. * exists.
  5666. */
  5667. const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
  5668. /**
  5669. * Allocate a CPB properties structure and initialize its fields to default
  5670. * values.
  5671. *
  5672. * @param size if non-NULL, the size of the allocated struct will be written
  5673. * here. This is useful for embedding it in side data.
  5674. *
  5675. * @return the newly allocated struct or NULL on failure
  5676. */
  5677. AVCPBProperties *av_cpb_properties_alloc(size_t *size);
  5678. /**
  5679. * @}
  5680. */
  5681. #endif /* AVCODEC_AVCODEC_H */