avcodec.h 213 KB

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