avcodec.h 143 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457
  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. * external API header
  25. */
  26. #include <errno.h>
  27. #include "libavutil/samplefmt.h"
  28. #include "libavutil/avutil.h"
  29. #include "libavutil/cpu.h"
  30. #include "libavutil/dict.h"
  31. #include "libavutil/log.h"
  32. #include "libavutil/pixfmt.h"
  33. #include "libavutil/rational.h"
  34. #include "libavcodec/version.h"
  35. /**
  36. * Identify the syntax and semantics of the bitstream.
  37. * The principle is roughly:
  38. * Two decoders with the same ID can decode the same streams.
  39. * Two encoders with the same ID can encode compatible streams.
  40. * There may be slight deviations from the principle due to implementation
  41. * details.
  42. *
  43. * If you add a codec ID to this list, add it so that
  44. * 1. no value of a existing codec ID changes (that would break ABI),
  45. * 2. it is as close as possible to similar codecs.
  46. */
  47. enum CodecID {
  48. CODEC_ID_NONE,
  49. /* video codecs */
  50. CODEC_ID_MPEG1VIDEO,
  51. CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  52. CODEC_ID_MPEG2VIDEO_XVMC,
  53. CODEC_ID_H261,
  54. CODEC_ID_H263,
  55. CODEC_ID_RV10,
  56. CODEC_ID_RV20,
  57. CODEC_ID_MJPEG,
  58. CODEC_ID_MJPEGB,
  59. CODEC_ID_LJPEG,
  60. CODEC_ID_SP5X,
  61. CODEC_ID_JPEGLS,
  62. CODEC_ID_MPEG4,
  63. CODEC_ID_RAWVIDEO,
  64. CODEC_ID_MSMPEG4V1,
  65. CODEC_ID_MSMPEG4V2,
  66. CODEC_ID_MSMPEG4V3,
  67. CODEC_ID_WMV1,
  68. CODEC_ID_WMV2,
  69. CODEC_ID_H263P,
  70. CODEC_ID_H263I,
  71. CODEC_ID_FLV1,
  72. CODEC_ID_SVQ1,
  73. CODEC_ID_SVQ3,
  74. CODEC_ID_DVVIDEO,
  75. CODEC_ID_HUFFYUV,
  76. CODEC_ID_CYUV,
  77. CODEC_ID_H264,
  78. CODEC_ID_INDEO3,
  79. CODEC_ID_VP3,
  80. CODEC_ID_THEORA,
  81. CODEC_ID_ASV1,
  82. CODEC_ID_ASV2,
  83. CODEC_ID_FFV1,
  84. CODEC_ID_4XM,
  85. CODEC_ID_VCR1,
  86. CODEC_ID_CLJR,
  87. CODEC_ID_MDEC,
  88. CODEC_ID_ROQ,
  89. CODEC_ID_INTERPLAY_VIDEO,
  90. CODEC_ID_XAN_WC3,
  91. CODEC_ID_XAN_WC4,
  92. CODEC_ID_RPZA,
  93. CODEC_ID_CINEPAK,
  94. CODEC_ID_WS_VQA,
  95. CODEC_ID_MSRLE,
  96. CODEC_ID_MSVIDEO1,
  97. CODEC_ID_IDCIN,
  98. CODEC_ID_8BPS,
  99. CODEC_ID_SMC,
  100. CODEC_ID_FLIC,
  101. CODEC_ID_TRUEMOTION1,
  102. CODEC_ID_VMDVIDEO,
  103. CODEC_ID_MSZH,
  104. CODEC_ID_ZLIB,
  105. CODEC_ID_QTRLE,
  106. CODEC_ID_SNOW,
  107. CODEC_ID_TSCC,
  108. CODEC_ID_ULTI,
  109. CODEC_ID_QDRAW,
  110. CODEC_ID_VIXL,
  111. CODEC_ID_QPEG,
  112. CODEC_ID_PNG,
  113. CODEC_ID_PPM,
  114. CODEC_ID_PBM,
  115. CODEC_ID_PGM,
  116. CODEC_ID_PGMYUV,
  117. CODEC_ID_PAM,
  118. CODEC_ID_FFVHUFF,
  119. CODEC_ID_RV30,
  120. CODEC_ID_RV40,
  121. CODEC_ID_VC1,
  122. CODEC_ID_WMV3,
  123. CODEC_ID_LOCO,
  124. CODEC_ID_WNV1,
  125. CODEC_ID_AASC,
  126. CODEC_ID_INDEO2,
  127. CODEC_ID_FRAPS,
  128. CODEC_ID_TRUEMOTION2,
  129. CODEC_ID_BMP,
  130. CODEC_ID_CSCD,
  131. CODEC_ID_MMVIDEO,
  132. CODEC_ID_ZMBV,
  133. CODEC_ID_AVS,
  134. CODEC_ID_SMACKVIDEO,
  135. CODEC_ID_NUV,
  136. CODEC_ID_KMVC,
  137. CODEC_ID_FLASHSV,
  138. CODEC_ID_CAVS,
  139. CODEC_ID_JPEG2000,
  140. CODEC_ID_VMNC,
  141. CODEC_ID_VP5,
  142. CODEC_ID_VP6,
  143. CODEC_ID_VP6F,
  144. CODEC_ID_TARGA,
  145. CODEC_ID_DSICINVIDEO,
  146. CODEC_ID_TIERTEXSEQVIDEO,
  147. CODEC_ID_TIFF,
  148. CODEC_ID_GIF,
  149. CODEC_ID_FFH264,
  150. CODEC_ID_DXA,
  151. CODEC_ID_DNXHD,
  152. CODEC_ID_THP,
  153. CODEC_ID_SGI,
  154. CODEC_ID_C93,
  155. CODEC_ID_BETHSOFTVID,
  156. CODEC_ID_PTX,
  157. CODEC_ID_TXD,
  158. CODEC_ID_VP6A,
  159. CODEC_ID_AMV,
  160. CODEC_ID_VB,
  161. CODEC_ID_PCX,
  162. CODEC_ID_SUNRAST,
  163. CODEC_ID_INDEO4,
  164. CODEC_ID_INDEO5,
  165. CODEC_ID_MIMIC,
  166. CODEC_ID_RL2,
  167. CODEC_ID_8SVX_EXP,
  168. CODEC_ID_8SVX_FIB,
  169. CODEC_ID_ESCAPE124,
  170. CODEC_ID_DIRAC,
  171. CODEC_ID_BFI,
  172. CODEC_ID_CMV,
  173. CODEC_ID_MOTIONPIXELS,
  174. CODEC_ID_TGV,
  175. CODEC_ID_TGQ,
  176. CODEC_ID_TQI,
  177. CODEC_ID_AURA,
  178. CODEC_ID_AURA2,
  179. CODEC_ID_V210X,
  180. CODEC_ID_TMV,
  181. CODEC_ID_V210,
  182. CODEC_ID_DPX,
  183. CODEC_ID_MAD,
  184. CODEC_ID_FRWU,
  185. CODEC_ID_FLASHSV2,
  186. CODEC_ID_CDGRAPHICS,
  187. CODEC_ID_R210,
  188. CODEC_ID_ANM,
  189. CODEC_ID_BINKVIDEO,
  190. CODEC_ID_IFF_ILBM,
  191. CODEC_ID_IFF_BYTERUN1,
  192. CODEC_ID_KGV1,
  193. CODEC_ID_YOP,
  194. CODEC_ID_VP8,
  195. CODEC_ID_PICTOR,
  196. CODEC_ID_ANSI,
  197. CODEC_ID_A64_MULTI,
  198. CODEC_ID_A64_MULTI5,
  199. CODEC_ID_R10K,
  200. CODEC_ID_MXPEG,
  201. CODEC_ID_LAGARITH,
  202. CODEC_ID_PRORES,
  203. CODEC_ID_JV,
  204. CODEC_ID_DFA,
  205. CODEC_ID_WMV3IMAGE,
  206. CODEC_ID_VC1IMAGE,
  207. CODEC_ID_8SVX_RAW,
  208. CODEC_ID_G2M,
  209. CODEC_ID_UTVIDEO = 0x800,
  210. /* various PCM "codecs" */
  211. CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
  212. CODEC_ID_PCM_S16LE= 0x10000,
  213. CODEC_ID_PCM_S16BE,
  214. CODEC_ID_PCM_U16LE,
  215. CODEC_ID_PCM_U16BE,
  216. CODEC_ID_PCM_S8,
  217. CODEC_ID_PCM_U8,
  218. CODEC_ID_PCM_MULAW,
  219. CODEC_ID_PCM_ALAW,
  220. CODEC_ID_PCM_S32LE,
  221. CODEC_ID_PCM_S32BE,
  222. CODEC_ID_PCM_U32LE,
  223. CODEC_ID_PCM_U32BE,
  224. CODEC_ID_PCM_S24LE,
  225. CODEC_ID_PCM_S24BE,
  226. CODEC_ID_PCM_U24LE,
  227. CODEC_ID_PCM_U24BE,
  228. CODEC_ID_PCM_S24DAUD,
  229. CODEC_ID_PCM_ZORK,
  230. CODEC_ID_PCM_S16LE_PLANAR,
  231. CODEC_ID_PCM_DVD,
  232. CODEC_ID_PCM_F32BE,
  233. CODEC_ID_PCM_F32LE,
  234. CODEC_ID_PCM_F64BE,
  235. CODEC_ID_PCM_F64LE,
  236. CODEC_ID_PCM_BLURAY,
  237. CODEC_ID_PCM_LXF,
  238. CODEC_ID_S302M,
  239. /* various ADPCM codecs */
  240. CODEC_ID_ADPCM_IMA_QT= 0x11000,
  241. CODEC_ID_ADPCM_IMA_WAV,
  242. CODEC_ID_ADPCM_IMA_DK3,
  243. CODEC_ID_ADPCM_IMA_DK4,
  244. CODEC_ID_ADPCM_IMA_WS,
  245. CODEC_ID_ADPCM_IMA_SMJPEG,
  246. CODEC_ID_ADPCM_MS,
  247. CODEC_ID_ADPCM_4XM,
  248. CODEC_ID_ADPCM_XA,
  249. CODEC_ID_ADPCM_ADX,
  250. CODEC_ID_ADPCM_EA,
  251. CODEC_ID_ADPCM_G726,
  252. CODEC_ID_ADPCM_CT,
  253. CODEC_ID_ADPCM_SWF,
  254. CODEC_ID_ADPCM_YAMAHA,
  255. CODEC_ID_ADPCM_SBPRO_4,
  256. CODEC_ID_ADPCM_SBPRO_3,
  257. CODEC_ID_ADPCM_SBPRO_2,
  258. CODEC_ID_ADPCM_THP,
  259. CODEC_ID_ADPCM_IMA_AMV,
  260. CODEC_ID_ADPCM_EA_R1,
  261. CODEC_ID_ADPCM_EA_R3,
  262. CODEC_ID_ADPCM_EA_R2,
  263. CODEC_ID_ADPCM_IMA_EA_SEAD,
  264. CODEC_ID_ADPCM_IMA_EA_EACS,
  265. CODEC_ID_ADPCM_EA_XAS,
  266. CODEC_ID_ADPCM_EA_MAXIS_XA,
  267. CODEC_ID_ADPCM_IMA_ISS,
  268. CODEC_ID_ADPCM_G722,
  269. /* AMR */
  270. CODEC_ID_AMR_NB= 0x12000,
  271. CODEC_ID_AMR_WB,
  272. /* RealAudio codecs*/
  273. CODEC_ID_RA_144= 0x13000,
  274. CODEC_ID_RA_288,
  275. /* various DPCM codecs */
  276. CODEC_ID_ROQ_DPCM= 0x14000,
  277. CODEC_ID_INTERPLAY_DPCM,
  278. CODEC_ID_XAN_DPCM,
  279. CODEC_ID_SOL_DPCM,
  280. /* audio codecs */
  281. CODEC_ID_MP2= 0x15000,
  282. CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
  283. CODEC_ID_AAC,
  284. CODEC_ID_AC3,
  285. CODEC_ID_DTS,
  286. CODEC_ID_VORBIS,
  287. CODEC_ID_DVAUDIO,
  288. CODEC_ID_WMAV1,
  289. CODEC_ID_WMAV2,
  290. CODEC_ID_MACE3,
  291. CODEC_ID_MACE6,
  292. CODEC_ID_VMDAUDIO,
  293. CODEC_ID_SONIC,
  294. CODEC_ID_SONIC_LS,
  295. CODEC_ID_FLAC,
  296. CODEC_ID_MP3ADU,
  297. CODEC_ID_MP3ON4,
  298. CODEC_ID_SHORTEN,
  299. CODEC_ID_ALAC,
  300. CODEC_ID_WESTWOOD_SND1,
  301. CODEC_ID_GSM, ///< as in Berlin toast format
  302. CODEC_ID_QDM2,
  303. CODEC_ID_COOK,
  304. CODEC_ID_TRUESPEECH,
  305. CODEC_ID_TTA,
  306. CODEC_ID_SMACKAUDIO,
  307. CODEC_ID_QCELP,
  308. CODEC_ID_WAVPACK,
  309. CODEC_ID_DSICINAUDIO,
  310. CODEC_ID_IMC,
  311. CODEC_ID_MUSEPACK7,
  312. CODEC_ID_MLP,
  313. CODEC_ID_GSM_MS, /* as found in WAV */
  314. CODEC_ID_ATRAC3,
  315. CODEC_ID_VOXWARE,
  316. CODEC_ID_APE,
  317. CODEC_ID_NELLYMOSER,
  318. CODEC_ID_MUSEPACK8,
  319. CODEC_ID_SPEEX,
  320. CODEC_ID_WMAVOICE,
  321. CODEC_ID_WMAPRO,
  322. CODEC_ID_WMALOSSLESS,
  323. CODEC_ID_ATRAC3P,
  324. CODEC_ID_EAC3,
  325. CODEC_ID_SIPR,
  326. CODEC_ID_MP1,
  327. CODEC_ID_TWINVQ,
  328. CODEC_ID_TRUEHD,
  329. CODEC_ID_MP4ALS,
  330. CODEC_ID_ATRAC1,
  331. CODEC_ID_BINKAUDIO_RDFT,
  332. CODEC_ID_BINKAUDIO_DCT,
  333. CODEC_ID_AAC_LATM,
  334. CODEC_ID_QDMC,
  335. CODEC_ID_CELT,
  336. CODEC_ID_G729 = 0x15800,
  337. CODEC_ID_G723_1= 0x15801,
  338. /* subtitle codecs */
  339. CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
  340. CODEC_ID_DVD_SUBTITLE= 0x17000,
  341. CODEC_ID_DVB_SUBTITLE,
  342. CODEC_ID_TEXT, ///< raw UTF-8 text
  343. CODEC_ID_XSUB,
  344. CODEC_ID_SSA,
  345. CODEC_ID_MOV_TEXT,
  346. CODEC_ID_HDMV_PGS_SUBTITLE,
  347. CODEC_ID_DVB_TELETEXT,
  348. CODEC_ID_SRT,
  349. CODEC_ID_MICRODVD,
  350. /* other specific kind of codecs (generally used for attachments) */
  351. CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
  352. CODEC_ID_TTF= 0x18000,
  353. CODEC_ID_BINTEXT,
  354. CODEC_ID_XBIN,
  355. CODEC_ID_IDF,
  356. CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
  357. CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
  358. * stream (only used by libavformat) */
  359. CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
  360. };
  361. #if FF_API_OLD_SAMPLE_FMT
  362. #define SampleFormat AVSampleFormat
  363. #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
  364. #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
  365. #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
  366. #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
  367. #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
  368. #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
  369. #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
  370. #endif
  371. #if FF_API_OLD_AUDIOCONVERT
  372. #include "libavutil/audioconvert.h"
  373. /* Audio channel masks */
  374. #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
  375. #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
  376. #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
  377. #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
  378. #define CH_BACK_LEFT AV_CH_BACK_LEFT
  379. #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
  380. #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
  381. #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
  382. #define CH_BACK_CENTER AV_CH_BACK_CENTER
  383. #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
  384. #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
  385. #define CH_TOP_CENTER AV_CH_TOP_CENTER
  386. #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
  387. #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
  388. #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
  389. #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
  390. #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
  391. #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
  392. #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
  393. #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
  394. /** Channel mask value used for AVCodecContext.request_channel_layout
  395. to indicate that the user requests the channel order of the decoder output
  396. to be the native codec channel order. */
  397. #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
  398. /* Audio channel convenience macros */
  399. #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
  400. #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
  401. #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
  402. #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
  403. #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
  404. #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
  405. #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
  406. #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
  407. #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
  408. #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
  409. #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
  410. #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
  411. #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
  412. #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
  413. #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
  414. #endif
  415. /* in bytes */
  416. #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
  417. /**
  418. * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
  419. * This is mainly needed because some optimized bitstream readers read
  420. * 32 or 64 bit at once and could read over the end.<br>
  421. * Note: If the first 23 bits of the additional bytes are not 0, then damaged
  422. * MPEG bitstreams could cause overread and segfault.
  423. */
  424. #define FF_INPUT_BUFFER_PADDING_SIZE 16
  425. /**
  426. * minimum encoding buffer size
  427. * Used to avoid some checks during header writing.
  428. */
  429. #define FF_MIN_BUFFER_SIZE 16384
  430. /**
  431. * motion estimation type.
  432. */
  433. enum Motion_Est_ID {
  434. ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
  435. ME_FULL,
  436. ME_LOG,
  437. ME_PHODS,
  438. ME_EPZS, ///< enhanced predictive zonal search
  439. ME_X1, ///< reserved for experiments
  440. ME_HEX, ///< hexagon based search
  441. ME_UMH, ///< uneven multi-hexagon search
  442. ME_ITER, ///< iterative search
  443. ME_TESA, ///< transformed exhaustive search algorithm
  444. };
  445. enum AVDiscard{
  446. /* We leave some space between them for extensions (drop some
  447. * keyframes for intra-only or drop just some bidir frames). */
  448. AVDISCARD_NONE =-16, ///< discard nothing
  449. AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
  450. AVDISCARD_NONREF = 8, ///< discard all non reference
  451. AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
  452. AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
  453. AVDISCARD_ALL = 48, ///< discard all
  454. };
  455. enum AVColorPrimaries{
  456. AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
  457. AVCOL_PRI_UNSPECIFIED=2,
  458. AVCOL_PRI_BT470M =4,
  459. AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
  460. AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
  461. AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
  462. AVCOL_PRI_FILM =8,
  463. AVCOL_PRI_NB , ///< Not part of ABI
  464. };
  465. enum AVColorTransferCharacteristic{
  466. AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
  467. AVCOL_TRC_UNSPECIFIED=2,
  468. AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
  469. AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
  470. AVCOL_TRC_NB , ///< Not part of ABI
  471. };
  472. enum AVColorSpace{
  473. AVCOL_SPC_RGB =0,
  474. AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
  475. AVCOL_SPC_UNSPECIFIED=2,
  476. AVCOL_SPC_FCC =4,
  477. AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
  478. AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
  479. AVCOL_SPC_SMPTE240M =7,
  480. AVCOL_SPC_NB , ///< Not part of ABI
  481. };
  482. enum AVColorRange{
  483. AVCOL_RANGE_UNSPECIFIED=0,
  484. AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
  485. AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
  486. AVCOL_RANGE_NB , ///< Not part of ABI
  487. };
  488. /**
  489. * X X 3 4 X X are luma samples,
  490. * 1 2 1-6 are possible chroma positions
  491. * X X 5 6 X 0 is undefined/unknown position
  492. */
  493. enum AVChromaLocation{
  494. AVCHROMA_LOC_UNSPECIFIED=0,
  495. AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
  496. AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
  497. AVCHROMA_LOC_TOPLEFT =3, ///< DV
  498. AVCHROMA_LOC_TOP =4,
  499. AVCHROMA_LOC_BOTTOMLEFT =5,
  500. AVCHROMA_LOC_BOTTOM =6,
  501. AVCHROMA_LOC_NB , ///< Not part of ABI
  502. };
  503. #if FF_API_FLAC_GLOBAL_OPTS
  504. /**
  505. * LPC analysis type
  506. */
  507. attribute_deprecated enum AVLPCType {
  508. AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
  509. AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
  510. AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
  511. AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
  512. AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
  513. AV_LPC_TYPE_NB , ///< Not part of ABI
  514. };
  515. #endif
  516. enum AVAudioServiceType {
  517. AV_AUDIO_SERVICE_TYPE_MAIN = 0,
  518. AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
  519. AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
  520. AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
  521. AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
  522. AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
  523. AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
  524. AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
  525. AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
  526. AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
  527. };
  528. typedef struct RcOverride{
  529. int start_frame;
  530. int end_frame;
  531. int qscale; // If this is 0 then quality_factor will be used instead.
  532. float quality_factor;
  533. } RcOverride;
  534. #define FF_MAX_B_FRAMES 16
  535. /* encoding support
  536. These flags can be passed in AVCodecContext.flags before initialization.
  537. Note: Not everything is supported yet.
  538. */
  539. #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
  540. #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
  541. #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
  542. #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
  543. #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
  544. /**
  545. * The parent program guarantees that the input for B-frames containing
  546. * streams is not written to for at least s->max_b_frames+1 frames, if
  547. * this is not set the input will be copied.
  548. */
  549. #define CODEC_FLAG_INPUT_PRESERVED 0x0100
  550. #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
  551. #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
  552. #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
  553. #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
  554. #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
  555. #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
  556. location instead of only at frame boundaries. */
  557. #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
  558. #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
  559. #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
  560. #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
  561. #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
  562. /* Fx : Flag for h263+ extra options */
  563. #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
  564. #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
  565. #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
  566. #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
  567. #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
  568. #define CODEC_FLAG_CLOSED_GOP 0x80000000
  569. #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
  570. #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
  571. #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
  572. #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
  573. #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
  574. #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
  575. #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
  576. /**
  577. * @defgroup deprecated_flags Deprecated codec flags
  578. * Use corresponding private codec options instead.
  579. * @{
  580. */
  581. #if FF_API_MPEGVIDEO_GLOBAL_OPTS
  582. #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
  583. #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
  584. #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
  585. #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
  586. #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
  587. #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
  588. #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
  589. #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
  590. #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
  591. #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
  592. #endif
  593. #if FF_API_MJPEG_GLOBAL_OPTS
  594. #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
  595. #endif
  596. #if FF_API_X264_GLOBAL_OPTS
  597. #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
  598. #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
  599. #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
  600. #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
  601. #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
  602. #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
  603. #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
  604. #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
  605. #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
  606. #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
  607. #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
  608. #endif
  609. #if FF_API_SNOW_GLOBAL_OPTS
  610. #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
  611. #endif
  612. #if FF_API_LAME_GLOBAL_OPTS
  613. #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
  614. #endif
  615. /**
  616. * @}
  617. */
  618. /* Unsupported options :
  619. * Syntax Arithmetic coding (SAC)
  620. * Reference Picture Selection
  621. * Independent Segment Decoding */
  622. /* /Fx */
  623. /* codec capabilities */
  624. #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
  625. /**
  626. * Codec uses get_buffer() for allocating buffers and supports custom allocators.
  627. * If not set, it might not use get_buffer() at all or use operations that
  628. * assume the buffer was allocated by avcodec_default_get_buffer.
  629. */
  630. #define CODEC_CAP_DR1 0x0002
  631. /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
  632. #define CODEC_CAP_PARSE_ONLY 0x0004
  633. #define CODEC_CAP_TRUNCATED 0x0008
  634. /* Codec can export data for HW decoding (XvMC). */
  635. #define CODEC_CAP_HWACCEL 0x0010
  636. /**
  637. * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
  638. * If this is not set, the codec is guaranteed to never be fed with NULL data.
  639. */
  640. #define CODEC_CAP_DELAY 0x0020
  641. /**
  642. * Codec can be fed a final frame with a smaller size.
  643. * This can be used to prevent truncation of the last audio samples.
  644. */
  645. #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
  646. /**
  647. * Codec can export data for HW decoding (VDPAU).
  648. */
  649. #define CODEC_CAP_HWACCEL_VDPAU 0x0080
  650. /**
  651. * Codec can output multiple frames per AVPacket
  652. * Normally demuxers return one frame at a time, demuxers which do not do
  653. * are connected to a parser to split what they return into proper frames.
  654. * This flag is reserved to the very rare category of codecs which have a
  655. * bitstream that cannot be split into frames without timeconsuming
  656. * operations like full decoding. Demuxers carring such bitstreams thus
  657. * may return multiple frames in a packet. This has many disadvantages like
  658. * prohibiting stream copy in many cases thus it should only be considered
  659. * as a last resort.
  660. */
  661. #define CODEC_CAP_SUBFRAMES 0x0100
  662. /**
  663. * Codec is experimental and is thus avoided in favor of non experimental
  664. * encoders
  665. */
  666. #define CODEC_CAP_EXPERIMENTAL 0x0200
  667. /**
  668. * Codec should fill in channel configuration and samplerate instead of container
  669. */
  670. #define CODEC_CAP_CHANNEL_CONF 0x0400
  671. /**
  672. * Codec is able to deal with negative linesizes
  673. */
  674. #define CODEC_CAP_NEG_LINESIZES 0x0800
  675. /**
  676. * Codec supports frame-level multithreading.
  677. */
  678. #define CODEC_CAP_FRAME_THREADS 0x1000
  679. /**
  680. * Codec supports slice-based (or partition-based) multithreading.
  681. */
  682. #define CODEC_CAP_SLICE_THREADS 0x2000
  683. /**
  684. * Codec is lossless.
  685. */
  686. #define CODEC_CAP_LOSSLESS 0x80000000
  687. //The following defines may change, don't expect compatibility if you use them.
  688. #define MB_TYPE_INTRA4x4 0x0001
  689. #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
  690. #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
  691. #define MB_TYPE_16x16 0x0008
  692. #define MB_TYPE_16x8 0x0010
  693. #define MB_TYPE_8x16 0x0020
  694. #define MB_TYPE_8x8 0x0040
  695. #define MB_TYPE_INTERLACED 0x0080
  696. #define MB_TYPE_DIRECT2 0x0100 //FIXME
  697. #define MB_TYPE_ACPRED 0x0200
  698. #define MB_TYPE_GMC 0x0400
  699. #define MB_TYPE_SKIP 0x0800
  700. #define MB_TYPE_P0L0 0x1000
  701. #define MB_TYPE_P1L0 0x2000
  702. #define MB_TYPE_P0L1 0x4000
  703. #define MB_TYPE_P1L1 0x8000
  704. #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
  705. #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
  706. #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
  707. #define MB_TYPE_QUANT 0x00010000
  708. #define MB_TYPE_CBP 0x00020000
  709. //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
  710. /**
  711. * Pan Scan area.
  712. * This specifies the area which should be displayed.
  713. * Note there may be multiple such areas for one frame.
  714. */
  715. typedef struct AVPanScan{
  716. /**
  717. * id
  718. * - encoding: Set by user.
  719. * - decoding: Set by libavcodec.
  720. */
  721. int id;
  722. /**
  723. * width and height in 1/16 pel
  724. * - encoding: Set by user.
  725. * - decoding: Set by libavcodec.
  726. */
  727. int width;
  728. int height;
  729. /**
  730. * position of the top left corner in 1/16 pel for up to 3 fields/frames
  731. * - encoding: Set by user.
  732. * - decoding: Set by libavcodec.
  733. */
  734. int16_t position[3][2];
  735. }AVPanScan;
  736. #define FF_QSCALE_TYPE_MPEG1 0
  737. #define FF_QSCALE_TYPE_MPEG2 1
  738. #define FF_QSCALE_TYPE_H264 2
  739. #define FF_QSCALE_TYPE_VP56 3
  740. #define FF_BUFFER_TYPE_INTERNAL 1
  741. #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
  742. #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
  743. #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
  744. #if FF_API_OLD_FF_PICT_TYPES
  745. /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
  746. #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
  747. #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
  748. #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
  749. #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
  750. #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
  751. #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
  752. #define FF_BI_TYPE AV_PICTURE_TYPE_BI
  753. #endif
  754. #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
  755. #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
  756. #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
  757. #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
  758. enum AVPacketSideDataType {
  759. AV_PKT_DATA_PALETTE,
  760. };
  761. typedef struct AVPacket {
  762. /**
  763. * Presentation timestamp in AVStream->time_base units; the time at which
  764. * the decompressed packet will be presented to the user.
  765. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  766. * pts MUST be larger or equal to dts as presentation cannot happen before
  767. * decompression, unless one wants to view hex dumps. Some formats misuse
  768. * the terms dts and pts/cts to mean something different. Such timestamps
  769. * must be converted to true pts/dts before they are stored in AVPacket.
  770. */
  771. int64_t pts;
  772. /**
  773. * Decompression timestamp in AVStream->time_base units; the time at which
  774. * the packet is decompressed.
  775. * Can be AV_NOPTS_VALUE if it is not stored in the file.
  776. */
  777. int64_t dts;
  778. uint8_t *data;
  779. int size;
  780. int stream_index;
  781. /**
  782. * A combination of AV_PKT_FLAG values
  783. */
  784. int flags;
  785. /**
  786. * Additional packet data that can be provided by the container.
  787. * Packet can contain several types of side information.
  788. */
  789. struct {
  790. uint8_t *data;
  791. int size;
  792. enum AVPacketSideDataType type;
  793. } *side_data;
  794. int side_data_elems;
  795. /**
  796. * Duration of this packet in AVStream->time_base units, 0 if unknown.
  797. * Equals next_pts - this_pts in presentation order.
  798. */
  799. int duration;
  800. void (*destruct)(struct AVPacket *);
  801. void *priv;
  802. int64_t pos; ///< byte position in stream, -1 if unknown
  803. /**
  804. * Time difference in AVStream->time_base units from the pts of this
  805. * packet to the point at which the output from the decoder has converged
  806. * independent from the availability of previous frames. That is, the
  807. * frames are virtually identical no matter if decoding started from
  808. * the very first frame or from this keyframe.
  809. * Is AV_NOPTS_VALUE if unknown.
  810. * This field is not the display duration of the current packet.
  811. * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
  812. * set.
  813. *
  814. * The purpose of this field is to allow seeking in streams that have no
  815. * keyframes in the conventional sense. It corresponds to the
  816. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  817. * essential for some types of subtitle streams to ensure that all
  818. * subtitles are correctly displayed after seeking.
  819. */
  820. int64_t convergence_duration;
  821. } AVPacket;
  822. #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
  823. #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
  824. /**
  825. * Audio Video Frame.
  826. * New fields can be added to the end of AVFRAME with minor version
  827. * bumps. Removal, reordering and changes to existing fields require
  828. * a major version bump.
  829. * sizeof(AVFrame) must not be used outside libav*.
  830. */
  831. typedef struct AVFrame {
  832. /**
  833. * pointer to the picture planes.
  834. * This might be different from the first allocated byte
  835. * - encoding:
  836. * - decoding:
  837. */
  838. uint8_t *data[4];
  839. int linesize[4];
  840. /**
  841. * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
  842. * This isn't used by libavcodec unless the default get/release_buffer() is used.
  843. * - encoding:
  844. * - decoding:
  845. */
  846. uint8_t *base[4];
  847. /**
  848. * 1 -> keyframe, 0-> not
  849. * - encoding: Set by libavcodec.
  850. * - decoding: Set by libavcodec.
  851. */
  852. int key_frame;
  853. /**
  854. * Picture type of the frame, see ?_TYPE below.
  855. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
  856. * - decoding: Set by libavcodec.
  857. */
  858. enum AVPictureType pict_type;
  859. /**
  860. * presentation timestamp in time_base units (time when frame should be shown to user)
  861. * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
  862. * - encoding: MUST be set by user.
  863. * - decoding: Set by libavcodec.
  864. */
  865. int64_t pts;
  866. /**
  867. * picture number in bitstream order
  868. * - encoding: set by
  869. * - decoding: Set by libavcodec.
  870. */
  871. int coded_picture_number;
  872. /**
  873. * picture number in display order
  874. * - encoding: set by
  875. * - decoding: Set by libavcodec.
  876. */
  877. int display_picture_number;
  878. /**
  879. * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
  880. * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
  881. * - decoding: Set by libavcodec.
  882. */
  883. int quality;
  884. /**
  885. * buffer age (1->was last buffer and dint change, 2->..., ...).
  886. * Set to INT_MAX if the buffer has not been used yet.
  887. * - encoding: unused
  888. * - decoding: MUST be set by get_buffer().
  889. */
  890. int age;
  891. /**
  892. * is this picture used as reference
  893. * The values for this are the same as the MpegEncContext.picture_structure
  894. * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
  895. * Set to 4 for delayed, non-reference frames.
  896. * - encoding: unused
  897. * - decoding: Set by libavcodec. (before get_buffer() call)).
  898. */
  899. int reference;
  900. /**
  901. * QP table
  902. * - encoding: unused
  903. * - decoding: Set by libavcodec.
  904. */
  905. int8_t *qscale_table;
  906. /**
  907. * QP store stride
  908. * - encoding: unused
  909. * - decoding: Set by libavcodec.
  910. */
  911. int qstride;
  912. /**
  913. * mbskip_table[mb]>=1 if MB didn't change
  914. * stride= mb_width = (width+15)>>4
  915. * - encoding: unused
  916. * - decoding: Set by libavcodec.
  917. */
  918. uint8_t *mbskip_table;
  919. /**
  920. * motion vector table
  921. * @code
  922. * example:
  923. * int mv_sample_log2= 4 - motion_subsample_log2;
  924. * int mb_width= (width+15)>>4;
  925. * int mv_stride= (mb_width << mv_sample_log2) + 1;
  926. * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
  927. * @endcode
  928. * - encoding: Set by user.
  929. * - decoding: Set by libavcodec.
  930. */
  931. int16_t (*motion_val[2])[2];
  932. /**
  933. * macroblock type table
  934. * mb_type_base + mb_width + 2
  935. * - encoding: Set by user.
  936. * - decoding: Set by libavcodec.
  937. */
  938. uint32_t *mb_type;
  939. /**
  940. * log2 of the size of the block which a single vector in motion_val represents:
  941. * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
  942. * - encoding: unused
  943. * - decoding: Set by libavcodec.
  944. */
  945. uint8_t motion_subsample_log2;
  946. /**
  947. * for some private data of the user
  948. * - encoding: unused
  949. * - decoding: Set by user.
  950. */
  951. void *opaque;
  952. /**
  953. * error
  954. * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
  955. * - decoding: unused
  956. */
  957. uint64_t error[4];
  958. /**
  959. * type of the buffer (to keep track of who has to deallocate data[*])
  960. * - encoding: Set by the one who allocates it.
  961. * - decoding: Set by the one who allocates it.
  962. * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
  963. */
  964. int type;
  965. /**
  966. * When decoding, this signals how much the picture must be delayed.
  967. * extra_delay = repeat_pict / (2*fps)
  968. * - encoding: unused
  969. * - decoding: Set by libavcodec.
  970. */
  971. int repeat_pict;
  972. /**
  973. *
  974. */
  975. int qscale_type;
  976. /**
  977. * The content of the picture is interlaced.
  978. * - encoding: Set by user.
  979. * - decoding: Set by libavcodec. (default 0)
  980. */
  981. int interlaced_frame;
  982. /**
  983. * If the content is interlaced, is top field displayed first.
  984. * - encoding: Set by user.
  985. * - decoding: Set by libavcodec.
  986. */
  987. int top_field_first;
  988. /**
  989. * Pan scan.
  990. * - encoding: Set by user.
  991. * - decoding: Set by libavcodec.
  992. */
  993. AVPanScan *pan_scan;
  994. /**
  995. * Tell user application that palette has changed from previous frame.
  996. * - encoding: ??? (no palette-enabled encoder yet)
  997. * - decoding: Set by libavcodec. (default 0).
  998. */
  999. int palette_has_changed;
  1000. /**
  1001. * codec suggestion on buffer type if != 0
  1002. * - encoding: unused
  1003. * - decoding: Set by libavcodec. (before get_buffer() call)).
  1004. */
  1005. int buffer_hints;
  1006. /**
  1007. * DCT coefficients
  1008. * - encoding: unused
  1009. * - decoding: Set by libavcodec.
  1010. */
  1011. short *dct_coeff;
  1012. /**
  1013. * motion reference frame index
  1014. * the order in which these are stored can depend on the codec.
  1015. * - encoding: Set by user.
  1016. * - decoding: Set by libavcodec.
  1017. */
  1018. int8_t *ref_index[2];
  1019. /**
  1020. * reordered opaque 64bit (generally an integer or a double precision float
  1021. * PTS but can be anything).
  1022. * The user sets AVCodecContext.reordered_opaque to represent the input at
  1023. * that time,
  1024. * the decoder reorders values as needed and sets AVFrame.reordered_opaque
  1025. * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
  1026. * @deprecated in favor of pkt_pts
  1027. * - encoding: unused
  1028. * - decoding: Read by user.
  1029. */
  1030. int64_t reordered_opaque;
  1031. /**
  1032. * hardware accelerator private data (FFmpeg-allocated)
  1033. * - encoding: unused
  1034. * - decoding: Set by libavcodec
  1035. */
  1036. void *hwaccel_picture_private;
  1037. /**
  1038. * reordered pts from the last AVPacket that has been input into the decoder
  1039. * - encoding: unused
  1040. * - decoding: Read by user.
  1041. */
  1042. int64_t pkt_pts;
  1043. /**
  1044. * dts from the last AVPacket that has been input into the decoder
  1045. * - encoding: unused
  1046. * - decoding: Read by user.
  1047. */
  1048. int64_t pkt_dts;
  1049. /**
  1050. * the AVCodecContext which ff_thread_get_buffer() was last called on
  1051. * - encoding: Set by libavcodec.
  1052. * - decoding: Set by libavcodec.
  1053. */
  1054. struct AVCodecContext *owner;
  1055. /**
  1056. * used by multithreading to store frame-specific info
  1057. * - encoding: Set by libavcodec.
  1058. * - decoding: Set by libavcodec.
  1059. */
  1060. void *thread_opaque;
  1061. /**
  1062. * frame timestamp estimated using various heuristics, in stream time base
  1063. * - encoding: unused
  1064. * - decoding: set by libavcodec, read by user.
  1065. */
  1066. int64_t best_effort_timestamp;
  1067. /**
  1068. * reordered pos from the last AVPacket that has been input into the decoder
  1069. * - encoding: unused
  1070. * - decoding: Read by user.
  1071. */
  1072. int64_t pkt_pos;
  1073. /**
  1074. * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
  1075. * - encoding: unused
  1076. * - decoding: Read by user.
  1077. */
  1078. AVRational sample_aspect_ratio;
  1079. /**
  1080. * width and height of the video frame
  1081. * - encoding: unused
  1082. * - decoding: Read by user.
  1083. */
  1084. int width, height;
  1085. /**
  1086. * format of the frame, -1 if unknown or unset
  1087. * It should be cast to the corresponding enum (enum PixelFormat
  1088. * for video, enum AVSampleFormat for audio)
  1089. * - encoding: unused
  1090. * - decoding: Read by user.
  1091. */
  1092. int format;
  1093. } AVFrame;
  1094. /**
  1095. * main external API structure.
  1096. * New fields can be added to the end with minor version bumps.
  1097. * Removal, reordering and changes to existing fields require a major
  1098. * version bump.
  1099. * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
  1100. * applications.
  1101. * sizeof(AVCodecContext) must not be used outside libav*.
  1102. */
  1103. typedef struct AVCodecContext {
  1104. /**
  1105. * information on struct for av_log
  1106. * - set by avcodec_alloc_context
  1107. */
  1108. const AVClass *av_class;
  1109. /**
  1110. * the average bitrate
  1111. * - encoding: Set by user; unused for constant quantizer encoding.
  1112. * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
  1113. */
  1114. int bit_rate;
  1115. /**
  1116. * number of bits the bitstream is allowed to diverge from the reference.
  1117. * the reference can be CBR (for CBR pass1) or VBR (for pass2)
  1118. * - encoding: Set by user; unused for constant quantizer encoding.
  1119. * - decoding: unused
  1120. */
  1121. int bit_rate_tolerance;
  1122. /**
  1123. * CODEC_FLAG_*.
  1124. * - encoding: Set by user.
  1125. * - decoding: Set by user.
  1126. */
  1127. int flags;
  1128. /**
  1129. * Some codecs need additional format info. It is stored here.
  1130. * If any muxer uses this then ALL demuxers/parsers AND encoders for the
  1131. * specific codec MUST set it correctly otherwise stream copy breaks.
  1132. * In general use of this field by muxers is not recommanded.
  1133. * - encoding: Set by libavcodec.
  1134. * - decoding: Set by libavcodec. (FIXME: Is this OK?)
  1135. */
  1136. int sub_id;
  1137. /**
  1138. * Motion estimation algorithm used for video coding.
  1139. * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
  1140. * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
  1141. * - encoding: MUST be set by user.
  1142. * - decoding: unused
  1143. */
  1144. int me_method;
  1145. /**
  1146. * some codecs need / can use extradata like Huffman tables.
  1147. * mjpeg: Huffman tables
  1148. * rv10: additional flags
  1149. * mpeg4: global headers (they can be in the bitstream or here)
  1150. * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
  1151. * than extradata_size to avoid prolems if it is read with the bitstream reader.
  1152. * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
  1153. * - encoding: Set/allocated/freed by libavcodec.
  1154. * - decoding: Set/allocated/freed by user.
  1155. */
  1156. uint8_t *extradata;
  1157. int extradata_size;
  1158. /**
  1159. * This is the fundamental unit of time (in seconds) in terms
  1160. * of which frame timestamps are represented. For fixed-fps content,
  1161. * timebase should be 1/framerate and timestamp increments should be
  1162. * identically 1.
  1163. * - encoding: MUST be set by user.
  1164. * - decoding: Set by libavcodec.
  1165. */
  1166. AVRational time_base;
  1167. /* video only */
  1168. /**
  1169. * picture width / height.
  1170. * - encoding: MUST be set by user.
  1171. * - decoding: Set by libavcodec.
  1172. * Note: For compatibility it is possible to set this instead of
  1173. * coded_width/height before decoding.
  1174. */
  1175. int width, height;
  1176. #define FF_ASPECT_EXTENDED 15
  1177. /**
  1178. * the number of pictures in a group of pictures, or 0 for intra_only
  1179. * - encoding: Set by user.
  1180. * - decoding: unused
  1181. */
  1182. int gop_size;
  1183. /**
  1184. * Pixel format, see PIX_FMT_xxx.
  1185. * May be set by the demuxer if known from headers.
  1186. * May be overriden by the decoder if it knows better.
  1187. * - encoding: Set by user.
  1188. * - decoding: Set by user if known, overridden by libavcodec if known
  1189. */
  1190. enum PixelFormat pix_fmt;
  1191. /**
  1192. * If non NULL, 'draw_horiz_band' is called by the libavcodec
  1193. * decoder to draw a horizontal band. It improves cache usage. Not
  1194. * all codecs can do that. You must check the codec capabilities
  1195. * beforehand.
  1196. * When multithreading is used, it may be called from multiple threads
  1197. * at the same time; threads might draw different parts of the same AVFrame,
  1198. * or multiple AVFrames, and there is no guarantee that slices will be drawn
  1199. * in order.
  1200. * The function is also used by hardware acceleration APIs.
  1201. * It is called at least once during frame decoding to pass
  1202. * the data needed for hardware render.
  1203. * In that mode instead of pixel data, AVFrame points to
  1204. * a structure specific to the acceleration API. The application
  1205. * reads the structure and can change some fields to indicate progress
  1206. * or mark state.
  1207. * - encoding: unused
  1208. * - decoding: Set by user.
  1209. * @param height the height of the slice
  1210. * @param y the y position of the slice
  1211. * @param type 1->top field, 2->bottom field, 3->frame
  1212. * @param offset offset into the AVFrame.data from which the slice should be read
  1213. */
  1214. void (*draw_horiz_band)(struct AVCodecContext *s,
  1215. const AVFrame *src, int offset[4],
  1216. int y, int type, int height);
  1217. /* audio only */
  1218. int sample_rate; ///< samples per second
  1219. int channels; ///< number of audio channels
  1220. /**
  1221. * audio sample format
  1222. * - encoding: Set by user.
  1223. * - decoding: Set by libavcodec.
  1224. */
  1225. enum AVSampleFormat sample_fmt; ///< sample format
  1226. /* The following data should not be initialized. */
  1227. /**
  1228. * Samples per packet, initialized when calling 'init'.
  1229. */
  1230. int frame_size;
  1231. int frame_number; ///< audio or video frame number
  1232. /**
  1233. * Number of frames the decoded output will be delayed relative to
  1234. * the encoded input.
  1235. * - encoding: Set by libavcodec.
  1236. * - decoding: unused
  1237. */
  1238. int delay;
  1239. /* - encoding parameters */
  1240. float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
  1241. float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
  1242. /**
  1243. * minimum quantizer
  1244. * - encoding: Set by user.
  1245. * - decoding: unused
  1246. */
  1247. int qmin;
  1248. /**
  1249. * maximum quantizer
  1250. * - encoding: Set by user.
  1251. * - decoding: unused
  1252. */
  1253. int qmax;
  1254. /**
  1255. * maximum quantizer difference between frames
  1256. * - encoding: Set by user.
  1257. * - decoding: unused
  1258. */
  1259. int max_qdiff;
  1260. /**
  1261. * maximum number of B-frames between non-B-frames
  1262. * Note: The output will be delayed by max_b_frames+1 relative to the input.
  1263. * - encoding: Set by user.
  1264. * - decoding: unused
  1265. */
  1266. int max_b_frames;
  1267. /**
  1268. * qscale factor between IP and B-frames
  1269. * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
  1270. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1271. * - encoding: Set by user.
  1272. * - decoding: unused
  1273. */
  1274. float b_quant_factor;
  1275. /** obsolete FIXME remove */
  1276. int rc_strategy;
  1277. #define FF_RC_STRATEGY_XVID 1
  1278. int b_frame_strategy;
  1279. struct AVCodec *codec;
  1280. void *priv_data;
  1281. int rtp_payload_size; /* The size of the RTP payload: the coder will */
  1282. /* do its best to deliver a chunk with size */
  1283. /* below rtp_payload_size, the chunk will start */
  1284. /* with a start code on some codecs like H.263. */
  1285. /* This doesn't take account of any particular */
  1286. /* headers inside the transmitted RTP payload. */
  1287. /* The RTP callback: This function is called */
  1288. /* every time the encoder has a packet to send. */
  1289. /* It depends on the encoder if the data starts */
  1290. /* with a Start Code (it should). H.263 does. */
  1291. /* mb_nb contains the number of macroblocks */
  1292. /* encoded in the RTP payload. */
  1293. void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
  1294. /* statistics, used for 2-pass encoding */
  1295. int mv_bits;
  1296. int header_bits;
  1297. int i_tex_bits;
  1298. int p_tex_bits;
  1299. int i_count;
  1300. int p_count;
  1301. int skip_count;
  1302. int misc_bits;
  1303. /**
  1304. * number of bits used for the previously encoded frame
  1305. * - encoding: Set by libavcodec.
  1306. * - decoding: unused
  1307. */
  1308. int frame_bits;
  1309. /**
  1310. * Private data of the user, can be used to carry app specific stuff.
  1311. * - encoding: Set by user.
  1312. * - decoding: Set by user.
  1313. */
  1314. void *opaque;
  1315. char codec_name[32];
  1316. enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
  1317. enum CodecID codec_id; /* see CODEC_ID_xxx */
  1318. /**
  1319. * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1320. * This is used to work around some encoder bugs.
  1321. * A demuxer should set this to what is stored in the field used to identify the codec.
  1322. * If there are multiple such fields in a container then the demuxer should choose the one
  1323. * which maximizes the information about the used codec.
  1324. * If the codec tag field in a container is larger than 32 bits then the demuxer should
  1325. * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
  1326. * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
  1327. * first.
  1328. * - encoding: Set by user, if not then the default based on codec_id will be used.
  1329. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1330. */
  1331. unsigned int codec_tag;
  1332. /**
  1333. * Work around bugs in encoders which sometimes cannot be detected automatically.
  1334. * - encoding: Set by user
  1335. * - decoding: Set by user
  1336. */
  1337. int workaround_bugs;
  1338. #define FF_BUG_AUTODETECT 1 ///< autodetection
  1339. #define FF_BUG_OLD_MSMPEG4 2
  1340. #define FF_BUG_XVID_ILACE 4
  1341. #define FF_BUG_UMP4 8
  1342. #define FF_BUG_NO_PADDING 16
  1343. #define FF_BUG_AMV 32
  1344. #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
  1345. #define FF_BUG_QPEL_CHROMA 64
  1346. #define FF_BUG_STD_QPEL 128
  1347. #define FF_BUG_QPEL_CHROMA2 256
  1348. #define FF_BUG_DIRECT_BLOCKSIZE 512
  1349. #define FF_BUG_EDGE 1024
  1350. #define FF_BUG_HPEL_CHROMA 2048
  1351. #define FF_BUG_DC_CLIP 4096
  1352. #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
  1353. #define FF_BUG_TRUNCATED 16384
  1354. //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
  1355. /**
  1356. * luma single coefficient elimination threshold
  1357. * - encoding: Set by user.
  1358. * - decoding: unused
  1359. */
  1360. int luma_elim_threshold;
  1361. /**
  1362. * chroma single coeff elimination threshold
  1363. * - encoding: Set by user.
  1364. * - decoding: unused
  1365. */
  1366. int chroma_elim_threshold;
  1367. /**
  1368. * strictly follow the standard (MPEG4, ...).
  1369. * - encoding: Set by user.
  1370. * - decoding: Set by user.
  1371. * Setting this to STRICT or higher means the encoder and decoder will
  1372. * generally do stupid things, whereas setting it to unofficial or lower
  1373. * will mean the encoder might produce output that is not supported by all
  1374. * spec-compliant decoders. Decoders don't differentiate between normal,
  1375. * unofficial and experimental (that is, they always try to decode things
  1376. * when they can) unless they are explicitly asked to behave stupidly
  1377. * (=strictly conform to the specs)
  1378. */
  1379. int strict_std_compliance;
  1380. #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
  1381. #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
  1382. #define FF_COMPLIANCE_NORMAL 0
  1383. #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
  1384. #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
  1385. /**
  1386. * qscale offset between IP and B-frames
  1387. * - encoding: Set by user.
  1388. * - decoding: unused
  1389. */
  1390. float b_quant_offset;
  1391. #if FF_API_ER
  1392. /**
  1393. * Error recognition; higher values will detect more errors but may
  1394. * misdetect some more or less valid parts as errors.
  1395. * - encoding: unused
  1396. * - decoding: Set by user.
  1397. */
  1398. attribute_deprecated int error_recognition;
  1399. #define FF_ER_CAREFUL 1
  1400. #define FF_ER_COMPLIANT 2
  1401. #define FF_ER_AGGRESSIVE 3
  1402. #define FF_ER_VERY_AGGRESSIVE 4
  1403. #define FF_ER_EXPLODE 5
  1404. #endif /* FF_API_ER */
  1405. /**
  1406. * Called at the beginning of each frame to get a buffer for it.
  1407. * If pic.reference is set then the frame will be read later by libavcodec.
  1408. * avcodec_align_dimensions2() should be used to find the required width and
  1409. * height, as they normally need to be rounded up to the next multiple of 16.
  1410. * if CODEC_CAP_DR1 is not set then get_buffer() must call
  1411. * avcodec_default_get_buffer() instead of providing buffers allocated by
  1412. * some other means.
  1413. * If frame multithreading is used and thread_safe_callbacks is set,
  1414. * it may be called from a different thread, but not from more than one at once.
  1415. * Does not need to be reentrant.
  1416. * - encoding: unused
  1417. * - decoding: Set by libavcodec, user can override.
  1418. */
  1419. int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1420. /**
  1421. * Called to release buffers which were allocated with get_buffer.
  1422. * A released buffer can be reused in get_buffer().
  1423. * pic.data[*] must be set to NULL.
  1424. * May be called from a different thread if frame multithreading is used,
  1425. * but not by more than one thread at once, so does not need to be reentrant.
  1426. * - encoding: unused
  1427. * - decoding: Set by libavcodec, user can override.
  1428. */
  1429. void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1430. /**
  1431. * Size of the frame reordering buffer in the decoder.
  1432. * For MPEG-2 it is 1 IPB or 0 low delay IP.
  1433. * - encoding: Set by libavcodec.
  1434. * - decoding: Set by libavcodec.
  1435. */
  1436. int has_b_frames;
  1437. /**
  1438. * number of bytes per packet if constant and known or 0
  1439. * Used by some WAV based audio codecs.
  1440. */
  1441. int block_align;
  1442. int parse_only; /* - decoding only: If true, only parsing is done
  1443. (function avcodec_parse_frame()). The frame
  1444. data is returned. Only MPEG codecs support this now. */
  1445. /**
  1446. * 0-> h263 quant 1-> mpeg quant
  1447. * - encoding: Set by user.
  1448. * - decoding: unused
  1449. */
  1450. int mpeg_quant;
  1451. /**
  1452. * pass1 encoding statistics output buffer
  1453. * - encoding: Set by libavcodec.
  1454. * - decoding: unused
  1455. */
  1456. char *stats_out;
  1457. /**
  1458. * pass2 encoding statistics input buffer
  1459. * Concatenated stuff from stats_out of pass1 should be placed here.
  1460. * - encoding: Allocated/set/freed by user.
  1461. * - decoding: unused
  1462. */
  1463. char *stats_in;
  1464. /**
  1465. * ratecontrol qmin qmax limiting method
  1466. * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
  1467. * - encoding: Set by user.
  1468. * - decoding: unused
  1469. */
  1470. float rc_qsquish;
  1471. float rc_qmod_amp;
  1472. int rc_qmod_freq;
  1473. /**
  1474. * ratecontrol override, see RcOverride
  1475. * - encoding: Allocated/set/freed by user.
  1476. * - decoding: unused
  1477. */
  1478. RcOverride *rc_override;
  1479. int rc_override_count;
  1480. /**
  1481. * rate control equation
  1482. * - encoding: Set by user
  1483. * - decoding: unused
  1484. */
  1485. const char *rc_eq;
  1486. /**
  1487. * maximum bitrate
  1488. * - encoding: Set by user.
  1489. * - decoding: unused
  1490. */
  1491. int rc_max_rate;
  1492. /**
  1493. * minimum bitrate
  1494. * - encoding: Set by user.
  1495. * - decoding: unused
  1496. */
  1497. int rc_min_rate;
  1498. /**
  1499. * decoder bitstream buffer size
  1500. * - encoding: Set by user.
  1501. * - decoding: unused
  1502. */
  1503. int rc_buffer_size;
  1504. float rc_buffer_aggressivity;
  1505. /**
  1506. * qscale factor between P and I-frames
  1507. * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
  1508. * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
  1509. * - encoding: Set by user.
  1510. * - decoding: unused
  1511. */
  1512. float i_quant_factor;
  1513. /**
  1514. * qscale offset between P and I-frames
  1515. * - encoding: Set by user.
  1516. * - decoding: unused
  1517. */
  1518. float i_quant_offset;
  1519. /**
  1520. * initial complexity for pass1 ratecontrol
  1521. * - encoding: Set by user.
  1522. * - decoding: unused
  1523. */
  1524. float rc_initial_cplx;
  1525. /**
  1526. * DCT algorithm, see FF_DCT_* below
  1527. * - encoding: Set by user.
  1528. * - decoding: unused
  1529. */
  1530. int dct_algo;
  1531. #define FF_DCT_AUTO 0
  1532. #define FF_DCT_FASTINT 1
  1533. #define FF_DCT_INT 2
  1534. #define FF_DCT_MMX 3
  1535. #define FF_DCT_MLIB 4
  1536. #define FF_DCT_ALTIVEC 5
  1537. #define FF_DCT_FAAN 6
  1538. /**
  1539. * luminance masking (0-> disabled)
  1540. * - encoding: Set by user.
  1541. * - decoding: unused
  1542. */
  1543. float lumi_masking;
  1544. /**
  1545. * temporary complexity masking (0-> disabled)
  1546. * - encoding: Set by user.
  1547. * - decoding: unused
  1548. */
  1549. float temporal_cplx_masking;
  1550. /**
  1551. * spatial complexity masking (0-> disabled)
  1552. * - encoding: Set by user.
  1553. * - decoding: unused
  1554. */
  1555. float spatial_cplx_masking;
  1556. /**
  1557. * p block masking (0-> disabled)
  1558. * - encoding: Set by user.
  1559. * - decoding: unused
  1560. */
  1561. float p_masking;
  1562. /**
  1563. * darkness masking (0-> disabled)
  1564. * - encoding: Set by user.
  1565. * - decoding: unused
  1566. */
  1567. float dark_masking;
  1568. /**
  1569. * IDCT algorithm, see FF_IDCT_* below.
  1570. * - encoding: Set by user.
  1571. * - decoding: Set by user.
  1572. */
  1573. int idct_algo;
  1574. #define FF_IDCT_AUTO 0
  1575. #define FF_IDCT_INT 1
  1576. #define FF_IDCT_SIMPLE 2
  1577. #define FF_IDCT_SIMPLEMMX 3
  1578. #define FF_IDCT_LIBMPEG2MMX 4
  1579. #define FF_IDCT_PS2 5
  1580. #define FF_IDCT_MLIB 6
  1581. #define FF_IDCT_ARM 7
  1582. #define FF_IDCT_ALTIVEC 8
  1583. #define FF_IDCT_SH4 9
  1584. #define FF_IDCT_SIMPLEARM 10
  1585. #define FF_IDCT_H264 11
  1586. #define FF_IDCT_VP3 12
  1587. #define FF_IDCT_IPP 13
  1588. #define FF_IDCT_XVIDMMX 14
  1589. #define FF_IDCT_CAVS 15
  1590. #define FF_IDCT_SIMPLEARMV5TE 16
  1591. #define FF_IDCT_SIMPLEARMV6 17
  1592. #define FF_IDCT_SIMPLEVIS 18
  1593. #define FF_IDCT_WMV2 19
  1594. #define FF_IDCT_FAAN 20
  1595. #define FF_IDCT_EA 21
  1596. #define FF_IDCT_SIMPLENEON 22
  1597. #define FF_IDCT_SIMPLEALPHA 23
  1598. #define FF_IDCT_BINK 24
  1599. /**
  1600. * slice count
  1601. * - encoding: Set by libavcodec.
  1602. * - decoding: Set by user (or 0).
  1603. */
  1604. int slice_count;
  1605. /**
  1606. * slice offsets in the frame in bytes
  1607. * - encoding: Set/allocated by libavcodec.
  1608. * - decoding: Set/allocated by user (or NULL).
  1609. */
  1610. int *slice_offset;
  1611. /**
  1612. * error concealment flags
  1613. * - encoding: unused
  1614. * - decoding: Set by user.
  1615. */
  1616. int error_concealment;
  1617. #define FF_EC_GUESS_MVS 1
  1618. #define FF_EC_DEBLOCK 2
  1619. /**
  1620. * dsp_mask could be add used to disable unwanted CPU features
  1621. * CPU features (i.e. MMX, SSE. ...)
  1622. *
  1623. * With the FORCE flag you may instead enable given CPU features.
  1624. * (Dangerous: Usable in case of misdetection, improper usage however will
  1625. * result into program crash.)
  1626. */
  1627. unsigned dsp_mask;
  1628. /**
  1629. * bits per sample/pixel from the demuxer (needed for huffyuv).
  1630. * - encoding: Set by libavcodec.
  1631. * - decoding: Set by user.
  1632. */
  1633. int bits_per_coded_sample;
  1634. /**
  1635. * prediction method (needed for huffyuv)
  1636. * - encoding: Set by user.
  1637. * - decoding: unused
  1638. */
  1639. int prediction_method;
  1640. #define FF_PRED_LEFT 0
  1641. #define FF_PRED_PLANE 1
  1642. #define FF_PRED_MEDIAN 2
  1643. /**
  1644. * sample aspect ratio (0 if unknown)
  1645. * That is the width of a pixel divided by the height of the pixel.
  1646. * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
  1647. * - encoding: Set by user.
  1648. * - decoding: Set by libavcodec.
  1649. */
  1650. AVRational sample_aspect_ratio;
  1651. /**
  1652. * the picture in the bitstream
  1653. * - encoding: Set by libavcodec.
  1654. * - decoding: Set by libavcodec.
  1655. */
  1656. AVFrame *coded_frame;
  1657. /**
  1658. * debug
  1659. * - encoding: Set by user.
  1660. * - decoding: Set by user.
  1661. */
  1662. int debug;
  1663. #define FF_DEBUG_PICT_INFO 1
  1664. #define FF_DEBUG_RC 2
  1665. #define FF_DEBUG_BITSTREAM 4
  1666. #define FF_DEBUG_MB_TYPE 8
  1667. #define FF_DEBUG_QP 16
  1668. #define FF_DEBUG_MV 32
  1669. #define FF_DEBUG_DCT_COEFF 0x00000040
  1670. #define FF_DEBUG_SKIP 0x00000080
  1671. #define FF_DEBUG_STARTCODE 0x00000100
  1672. #define FF_DEBUG_PTS 0x00000200
  1673. #define FF_DEBUG_ER 0x00000400
  1674. #define FF_DEBUG_MMCO 0x00000800
  1675. #define FF_DEBUG_BUGS 0x00001000
  1676. #define FF_DEBUG_VIS_QP 0x00002000
  1677. #define FF_DEBUG_VIS_MB_TYPE 0x00004000
  1678. #define FF_DEBUG_BUFFERS 0x00008000
  1679. #define FF_DEBUG_THREADS 0x00010000
  1680. /**
  1681. * debug
  1682. * - encoding: Set by user.
  1683. * - decoding: Set by user.
  1684. */
  1685. int debug_mv;
  1686. #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
  1687. #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
  1688. #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
  1689. /**
  1690. * error
  1691. * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
  1692. * - decoding: unused
  1693. */
  1694. uint64_t error[4];
  1695. /**
  1696. * motion estimation comparison function
  1697. * - encoding: Set by user.
  1698. * - decoding: unused
  1699. */
  1700. int me_cmp;
  1701. /**
  1702. * subpixel motion estimation comparison function
  1703. * - encoding: Set by user.
  1704. * - decoding: unused
  1705. */
  1706. int me_sub_cmp;
  1707. /**
  1708. * macroblock comparison function (not supported yet)
  1709. * - encoding: Set by user.
  1710. * - decoding: unused
  1711. */
  1712. int mb_cmp;
  1713. /**
  1714. * interlaced DCT comparison function
  1715. * - encoding: Set by user.
  1716. * - decoding: unused
  1717. */
  1718. int ildct_cmp;
  1719. #define FF_CMP_SAD 0
  1720. #define FF_CMP_SSE 1
  1721. #define FF_CMP_SATD 2
  1722. #define FF_CMP_DCT 3
  1723. #define FF_CMP_PSNR 4
  1724. #define FF_CMP_BIT 5
  1725. #define FF_CMP_RD 6
  1726. #define FF_CMP_ZERO 7
  1727. #define FF_CMP_VSAD 8
  1728. #define FF_CMP_VSSE 9
  1729. #define FF_CMP_NSSE 10
  1730. #define FF_CMP_W53 11
  1731. #define FF_CMP_W97 12
  1732. #define FF_CMP_DCTMAX 13
  1733. #define FF_CMP_DCT264 14
  1734. #define FF_CMP_CHROMA 256
  1735. /**
  1736. * ME diamond size & shape
  1737. * - encoding: Set by user.
  1738. * - decoding: unused
  1739. */
  1740. int dia_size;
  1741. /**
  1742. * amount of previous MV predictors (2a+1 x 2a+1 square)
  1743. * - encoding: Set by user.
  1744. * - decoding: unused
  1745. */
  1746. int last_predictor_count;
  1747. /**
  1748. * prepass for motion estimation
  1749. * - encoding: Set by user.
  1750. * - decoding: unused
  1751. */
  1752. int pre_me;
  1753. /**
  1754. * motion estimation prepass comparison function
  1755. * - encoding: Set by user.
  1756. * - decoding: unused
  1757. */
  1758. int me_pre_cmp;
  1759. /**
  1760. * ME prepass diamond size & shape
  1761. * - encoding: Set by user.
  1762. * - decoding: unused
  1763. */
  1764. int pre_dia_size;
  1765. /**
  1766. * subpel ME quality
  1767. * - encoding: Set by user.
  1768. * - decoding: unused
  1769. */
  1770. int me_subpel_quality;
  1771. /**
  1772. * callback to negotiate the pixelFormat
  1773. * @param fmt is the list of formats which are supported by the codec,
  1774. * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
  1775. * The first is always the native one.
  1776. * @return the chosen format
  1777. * - encoding: unused
  1778. * - decoding: Set by user, if not set the native format will be chosen.
  1779. */
  1780. enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
  1781. /**
  1782. * DTG active format information (additional aspect ratio
  1783. * information only used in DVB MPEG-2 transport streams)
  1784. * 0 if not set.
  1785. *
  1786. * - encoding: unused
  1787. * - decoding: Set by decoder.
  1788. */
  1789. int dtg_active_format;
  1790. #define FF_DTG_AFD_SAME 8
  1791. #define FF_DTG_AFD_4_3 9
  1792. #define FF_DTG_AFD_16_9 10
  1793. #define FF_DTG_AFD_14_9 11
  1794. #define FF_DTG_AFD_4_3_SP_14_9 13
  1795. #define FF_DTG_AFD_16_9_SP_14_9 14
  1796. #define FF_DTG_AFD_SP_4_3 15
  1797. /**
  1798. * maximum motion estimation search range in subpel units
  1799. * If 0 then no limit.
  1800. *
  1801. * - encoding: Set by user.
  1802. * - decoding: unused
  1803. */
  1804. int me_range;
  1805. /**
  1806. * intra quantizer bias
  1807. * - encoding: Set by user.
  1808. * - decoding: unused
  1809. */
  1810. int intra_quant_bias;
  1811. #define FF_DEFAULT_QUANT_BIAS 999999
  1812. /**
  1813. * inter quantizer bias
  1814. * - encoding: Set by user.
  1815. * - decoding: unused
  1816. */
  1817. int inter_quant_bias;
  1818. /**
  1819. * color table ID
  1820. * - encoding: unused
  1821. * - decoding: Which clrtable should be used for 8bit RGB images.
  1822. * Tables have to be stored somewhere. FIXME
  1823. */
  1824. int color_table_id;
  1825. /**
  1826. * internal_buffer count
  1827. * Don't touch, used by libavcodec default_get_buffer().
  1828. */
  1829. int internal_buffer_count;
  1830. /**
  1831. * internal_buffers
  1832. * Don't touch, used by libavcodec default_get_buffer().
  1833. */
  1834. void *internal_buffer;
  1835. /**
  1836. * Global quality for codecs which cannot change it per frame.
  1837. * This should be proportional to MPEG-1/2/4 qscale.
  1838. * - encoding: Set by user.
  1839. * - decoding: unused
  1840. */
  1841. int global_quality;
  1842. #define FF_CODER_TYPE_VLC 0
  1843. #define FF_CODER_TYPE_AC 1
  1844. #define FF_CODER_TYPE_RAW 2
  1845. #define FF_CODER_TYPE_RLE 3
  1846. #define FF_CODER_TYPE_DEFLATE 4
  1847. /**
  1848. * coder type
  1849. * - encoding: Set by user.
  1850. * - decoding: unused
  1851. */
  1852. int coder_type;
  1853. /**
  1854. * context model
  1855. * - encoding: Set by user.
  1856. * - decoding: unused
  1857. */
  1858. int context_model;
  1859. #if 0
  1860. /**
  1861. *
  1862. * - encoding: unused
  1863. * - decoding: Set by user.
  1864. */
  1865. uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
  1866. #endif
  1867. /**
  1868. * slice flags
  1869. * - encoding: unused
  1870. * - decoding: Set by user.
  1871. */
  1872. int slice_flags;
  1873. #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
  1874. #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
  1875. #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
  1876. /**
  1877. * XVideo Motion Acceleration
  1878. * - encoding: forbidden
  1879. * - decoding: set by decoder
  1880. */
  1881. int xvmc_acceleration;
  1882. /**
  1883. * macroblock decision mode
  1884. * - encoding: Set by user.
  1885. * - decoding: unused
  1886. */
  1887. int mb_decision;
  1888. #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
  1889. #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
  1890. #define FF_MB_DECISION_RD 2 ///< rate distortion
  1891. /**
  1892. * custom intra quantization matrix
  1893. * - encoding: Set by user, can be NULL.
  1894. * - decoding: Set by libavcodec.
  1895. */
  1896. uint16_t *intra_matrix;
  1897. /**
  1898. * custom inter quantization matrix
  1899. * - encoding: Set by user, can be NULL.
  1900. * - decoding: Set by libavcodec.
  1901. */
  1902. uint16_t *inter_matrix;
  1903. /**
  1904. * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
  1905. * This is used to work around some encoder bugs.
  1906. * - encoding: unused
  1907. * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
  1908. */
  1909. unsigned int stream_codec_tag;
  1910. /**
  1911. * scene change detection threshold
  1912. * 0 is default, larger means fewer detected scene changes.
  1913. * - encoding: Set by user.
  1914. * - decoding: unused
  1915. */
  1916. int scenechange_threshold;
  1917. /**
  1918. * minimum Lagrange multipler
  1919. * - encoding: Set by user.
  1920. * - decoding: unused
  1921. */
  1922. int lmin;
  1923. /**
  1924. * maximum Lagrange multipler
  1925. * - encoding: Set by user.
  1926. * - decoding: unused
  1927. */
  1928. int lmax;
  1929. #if FF_API_PALETTE_CONTROL
  1930. /**
  1931. * palette control structure
  1932. * - encoding: ??? (no palette-enabled encoder yet)
  1933. * - decoding: Set by user.
  1934. */
  1935. struct AVPaletteControl *palctrl;
  1936. #endif
  1937. /**
  1938. * noise reduction strength
  1939. * - encoding: Set by user.
  1940. * - decoding: unused
  1941. */
  1942. int noise_reduction;
  1943. /**
  1944. * Called at the beginning of a frame to get cr buffer for it.
  1945. * Buffer type (size, hints) must be the same. libavcodec won't check it.
  1946. * libavcodec will pass previous buffer in pic, function should return
  1947. * same buffer or new buffer with old frame "painted" into it.
  1948. * If pic.data[0] == NULL must behave like get_buffer().
  1949. * if CODEC_CAP_DR1 is not set then reget_buffer() must call
  1950. * avcodec_default_reget_buffer() instead of providing buffers allocated by
  1951. * some other means.
  1952. * - encoding: unused
  1953. * - decoding: Set by libavcodec, user can override.
  1954. */
  1955. int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
  1956. /**
  1957. * Number of bits which should be loaded into the rc buffer before decoding starts.
  1958. * - encoding: Set by user.
  1959. * - decoding: unused
  1960. */
  1961. int rc_initial_buffer_occupancy;
  1962. /**
  1963. *
  1964. * - encoding: Set by user.
  1965. * - decoding: unused
  1966. */
  1967. int inter_threshold;
  1968. /**
  1969. * CODEC_FLAG2_*
  1970. * - encoding: Set by user.
  1971. * - decoding: Set by user.
  1972. */
  1973. int flags2;
  1974. /**
  1975. * Simulates errors in the bitstream to test error concealment.
  1976. * - encoding: Set by user.
  1977. * - decoding: unused
  1978. */
  1979. int error_rate;
  1980. #if FF_API_ANTIALIAS_ALGO
  1981. /**
  1982. * MP3 antialias algorithm, see FF_AA_* below.
  1983. * - encoding: unused
  1984. * - decoding: Set by user.
  1985. */
  1986. attribute_deprecated int antialias_algo;
  1987. #define FF_AA_AUTO 0
  1988. #define FF_AA_FASTINT 1 //not implemented yet
  1989. #define FF_AA_INT 2
  1990. #define FF_AA_FLOAT 3
  1991. #endif
  1992. /**
  1993. * quantizer noise shaping
  1994. * - encoding: Set by user.
  1995. * - decoding: unused
  1996. */
  1997. int quantizer_noise_shaping;
  1998. /**
  1999. * thread count
  2000. * is used to decide how many independent tasks should be passed to execute()
  2001. * - encoding: Set by user.
  2002. * - decoding: Set by user.
  2003. */
  2004. int thread_count;
  2005. /**
  2006. * The codec may call this to execute several independent things.
  2007. * It will return only after finishing all tasks.
  2008. * The user may replace this with some multithreaded implementation,
  2009. * the default implementation will execute the parts serially.
  2010. * @param count the number of things to execute
  2011. * - encoding: Set by libavcodec, user can override.
  2012. * - decoding: Set by libavcodec, user can override.
  2013. */
  2014. int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
  2015. /**
  2016. * thread opaque
  2017. * Can be used by execute() to store some per AVCodecContext stuff.
  2018. * - encoding: set by execute()
  2019. * - decoding: set by execute()
  2020. */
  2021. void *thread_opaque;
  2022. /**
  2023. * Motion estimation threshold below which no motion estimation is
  2024. * performed, but instead the user specified motion vectors are used.
  2025. *
  2026. * - encoding: Set by user.
  2027. * - decoding: unused
  2028. */
  2029. int me_threshold;
  2030. /**
  2031. * Macroblock threshold below which the user specified macroblock types will be used.
  2032. * - encoding: Set by user.
  2033. * - decoding: unused
  2034. */
  2035. int mb_threshold;
  2036. /**
  2037. * precision of the intra DC coefficient - 8
  2038. * - encoding: Set by user.
  2039. * - decoding: unused
  2040. */
  2041. int intra_dc_precision;
  2042. /**
  2043. * noise vs. sse weight for the nsse comparsion function
  2044. * - encoding: Set by user.
  2045. * - decoding: unused
  2046. */
  2047. int nsse_weight;
  2048. /**
  2049. * Number of macroblock rows at the top which are skipped.
  2050. * - encoding: unused
  2051. * - decoding: Set by user.
  2052. */
  2053. int skip_top;
  2054. /**
  2055. * Number of macroblock rows at the bottom which are skipped.
  2056. * - encoding: unused
  2057. * - decoding: Set by user.
  2058. */
  2059. int skip_bottom;
  2060. /**
  2061. * profile
  2062. * - encoding: Set by user.
  2063. * - decoding: Set by libavcodec.
  2064. */
  2065. int profile;
  2066. #define FF_PROFILE_UNKNOWN -99
  2067. #define FF_PROFILE_RESERVED -100
  2068. #define FF_PROFILE_AAC_MAIN 0
  2069. #define FF_PROFILE_AAC_LOW 1
  2070. #define FF_PROFILE_AAC_SSR 2
  2071. #define FF_PROFILE_AAC_LTP 3
  2072. #define FF_PROFILE_DTS 20
  2073. #define FF_PROFILE_DTS_ES 30
  2074. #define FF_PROFILE_DTS_96_24 40
  2075. #define FF_PROFILE_DTS_HD_HRA 50
  2076. #define FF_PROFILE_DTS_HD_MA 60
  2077. #define FF_PROFILE_MPEG2_422 0
  2078. #define FF_PROFILE_MPEG2_HIGH 1
  2079. #define FF_PROFILE_MPEG2_SS 2
  2080. #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
  2081. #define FF_PROFILE_MPEG2_MAIN 4
  2082. #define FF_PROFILE_MPEG2_SIMPLE 5
  2083. #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
  2084. #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
  2085. #define FF_PROFILE_H264_BASELINE 66
  2086. #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
  2087. #define FF_PROFILE_H264_MAIN 77
  2088. #define FF_PROFILE_H264_EXTENDED 88
  2089. #define FF_PROFILE_H264_HIGH 100
  2090. #define FF_PROFILE_H264_HIGH_10 110
  2091. #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
  2092. #define FF_PROFILE_H264_HIGH_422 122
  2093. #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
  2094. #define FF_PROFILE_H264_HIGH_444 144
  2095. #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
  2096. #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
  2097. #define FF_PROFILE_H264_CAVLC_444 44
  2098. #define FF_PROFILE_VC1_SIMPLE 0
  2099. #define FF_PROFILE_VC1_MAIN 1
  2100. #define FF_PROFILE_VC1_COMPLEX 2
  2101. #define FF_PROFILE_VC1_ADVANCED 3
  2102. #define FF_PROFILE_MPEG4_SIMPLE 0
  2103. #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
  2104. #define FF_PROFILE_MPEG4_CORE 2
  2105. #define FF_PROFILE_MPEG4_MAIN 3
  2106. #define FF_PROFILE_MPEG4_N_BIT 4
  2107. #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
  2108. #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
  2109. #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
  2110. #define FF_PROFILE_MPEG4_HYBRID 8
  2111. #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
  2112. #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
  2113. #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
  2114. #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
  2115. #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
  2116. #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
  2117. #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
  2118. /**
  2119. * level
  2120. * - encoding: Set by user.
  2121. * - decoding: Set by libavcodec.
  2122. */
  2123. int level;
  2124. #define FF_LEVEL_UNKNOWN -99
  2125. /**
  2126. * low resolution decoding, 1-> 1/2 size, 2->1/4 size
  2127. * - encoding: unused
  2128. * - decoding: Set by user.
  2129. */
  2130. int lowres;
  2131. /**
  2132. * Bitstream width / height, may be different from width/height if lowres enabled.
  2133. * - encoding: unused
  2134. * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
  2135. */
  2136. int coded_width, coded_height;
  2137. /**
  2138. * frame skip threshold
  2139. * - encoding: Set by user.
  2140. * - decoding: unused
  2141. */
  2142. int frame_skip_threshold;
  2143. /**
  2144. * frame skip factor
  2145. * - encoding: Set by user.
  2146. * - decoding: unused
  2147. */
  2148. int frame_skip_factor;
  2149. /**
  2150. * frame skip exponent
  2151. * - encoding: Set by user.
  2152. * - decoding: unused
  2153. */
  2154. int frame_skip_exp;
  2155. /**
  2156. * frame skip comparison function
  2157. * - encoding: Set by user.
  2158. * - decoding: unused
  2159. */
  2160. int frame_skip_cmp;
  2161. /**
  2162. * Border processing masking, raises the quantizer for mbs on the borders
  2163. * of the picture.
  2164. * - encoding: Set by user.
  2165. * - decoding: unused
  2166. */
  2167. float border_masking;
  2168. /**
  2169. * minimum MB lagrange multipler
  2170. * - encoding: Set by user.
  2171. * - decoding: unused
  2172. */
  2173. int mb_lmin;
  2174. /**
  2175. * maximum MB lagrange multipler
  2176. * - encoding: Set by user.
  2177. * - decoding: unused
  2178. */
  2179. int mb_lmax;
  2180. /**
  2181. *
  2182. * - encoding: Set by user.
  2183. * - decoding: unused
  2184. */
  2185. int me_penalty_compensation;
  2186. /**
  2187. *
  2188. * - encoding: unused
  2189. * - decoding: Set by user.
  2190. */
  2191. enum AVDiscard skip_loop_filter;
  2192. /**
  2193. *
  2194. * - encoding: unused
  2195. * - decoding: Set by user.
  2196. */
  2197. enum AVDiscard skip_idct;
  2198. /**
  2199. *
  2200. * - encoding: unused
  2201. * - decoding: Set by user.
  2202. */
  2203. enum AVDiscard skip_frame;
  2204. /**
  2205. *
  2206. * - encoding: Set by user.
  2207. * - decoding: unused
  2208. */
  2209. int bidir_refine;
  2210. /**
  2211. *
  2212. * - encoding: Set by user.
  2213. * - decoding: unused
  2214. */
  2215. int brd_scale;
  2216. #if FF_API_X264_GLOBAL_OPTS
  2217. /**
  2218. * constant rate factor - quality-based VBR - values ~correspond to qps
  2219. * - encoding: Set by user.
  2220. * - decoding: unused
  2221. * @deprecated use 'crf' libx264 private option
  2222. */
  2223. attribute_deprecated float crf;
  2224. /**
  2225. * constant quantization parameter rate control method
  2226. * - encoding: Set by user.
  2227. * - decoding: unused
  2228. * @deprecated use 'cqp' libx264 private option
  2229. */
  2230. attribute_deprecated int cqp;
  2231. #endif
  2232. /**
  2233. * minimum GOP size
  2234. * - encoding: Set by user.
  2235. * - decoding: unused
  2236. */
  2237. int keyint_min;
  2238. /**
  2239. * number of reference frames
  2240. * - encoding: Set by user.
  2241. * - decoding: Set by lavc.
  2242. */
  2243. int refs;
  2244. /**
  2245. * chroma qp offset from luma
  2246. * - encoding: Set by user.
  2247. * - decoding: unused
  2248. */
  2249. int chromaoffset;
  2250. #if FF_API_X264_GLOBAL_OPTS
  2251. /**
  2252. * Influences how often B-frames are used.
  2253. * - encoding: Set by user.
  2254. * - decoding: unused
  2255. */
  2256. attribute_deprecated int bframebias;
  2257. #endif
  2258. /**
  2259. * trellis RD quantization
  2260. * - encoding: Set by user.
  2261. * - decoding: unused
  2262. */
  2263. int trellis;
  2264. #if FF_API_X264_GLOBAL_OPTS
  2265. /**
  2266. * Reduce fluctuations in qp (before curve compression).
  2267. * - encoding: Set by user.
  2268. * - decoding: unused
  2269. */
  2270. attribute_deprecated float complexityblur;
  2271. /**
  2272. * in-loop deblocking filter alphac0 parameter
  2273. * alpha is in the range -6...6
  2274. * - encoding: Set by user.
  2275. * - decoding: unused
  2276. */
  2277. attribute_deprecated int deblockalpha;
  2278. /**
  2279. * in-loop deblocking filter beta parameter
  2280. * beta is in the range -6...6
  2281. * - encoding: Set by user.
  2282. * - decoding: unused
  2283. */
  2284. attribute_deprecated int deblockbeta;
  2285. /**
  2286. * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
  2287. * - encoding: Set by user.
  2288. * - decoding: unused
  2289. */
  2290. attribute_deprecated int partitions;
  2291. #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
  2292. #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
  2293. #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
  2294. #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
  2295. #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
  2296. /**
  2297. * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
  2298. * - encoding: Set by user.
  2299. * - decoding: unused
  2300. */
  2301. attribute_deprecated int directpred;
  2302. #endif
  2303. /**
  2304. * Audio cutoff bandwidth (0 means "automatic")
  2305. * - encoding: Set by user.
  2306. * - decoding: unused
  2307. */
  2308. int cutoff;
  2309. /**
  2310. * Multiplied by qscale for each frame and added to scene_change_score.
  2311. * - encoding: Set by user.
  2312. * - decoding: unused
  2313. */
  2314. int scenechange_factor;
  2315. /**
  2316. *
  2317. * Note: Value depends upon the compare function used for fullpel ME.
  2318. * - encoding: Set by user.
  2319. * - decoding: unused
  2320. */
  2321. int mv0_threshold;
  2322. /**
  2323. * Adjusts sensitivity of b_frame_strategy 1.
  2324. * - encoding: Set by user.
  2325. * - decoding: unused
  2326. */
  2327. int b_sensitivity;
  2328. /**
  2329. * - encoding: Set by user.
  2330. * - decoding: unused
  2331. */
  2332. int compression_level;
  2333. #define FF_COMPRESSION_DEFAULT -1
  2334. /**
  2335. * - encoding: Set by user.
  2336. * - decoding: unused
  2337. */
  2338. int min_prediction_order;
  2339. /**
  2340. * - encoding: Set by user.
  2341. * - decoding: unused
  2342. */
  2343. int max_prediction_order;
  2344. #if FF_API_FLAC_GLOBAL_OPTS
  2345. /**
  2346. * @name FLAC options
  2347. * @deprecated Use FLAC encoder private options instead.
  2348. * @{
  2349. */
  2350. /**
  2351. * LPC coefficient precision - used by FLAC encoder
  2352. * - encoding: Set by user.
  2353. * - decoding: unused
  2354. */
  2355. attribute_deprecated int lpc_coeff_precision;
  2356. /**
  2357. * search method for selecting prediction order
  2358. * - encoding: Set by user.
  2359. * - decoding: unused
  2360. */
  2361. attribute_deprecated int prediction_order_method;
  2362. /**
  2363. * - encoding: Set by user.
  2364. * - decoding: unused
  2365. */
  2366. attribute_deprecated int min_partition_order;
  2367. /**
  2368. * - encoding: Set by user.
  2369. * - decoding: unused
  2370. */
  2371. attribute_deprecated int max_partition_order;
  2372. /**
  2373. * @}
  2374. */
  2375. #endif
  2376. /**
  2377. * GOP timecode frame start number, in non drop frame format
  2378. * - encoding: Set by user.
  2379. * - decoding: unused
  2380. */
  2381. int64_t timecode_frame_start;
  2382. #if FF_API_REQUEST_CHANNELS
  2383. /**
  2384. * Decoder should decode to this many channels if it can (0 for default)
  2385. * - encoding: unused
  2386. * - decoding: Set by user.
  2387. * @deprecated Deprecated in favor of request_channel_layout.
  2388. */
  2389. int request_channels;
  2390. #endif
  2391. #if FF_API_DRC_SCALE
  2392. /**
  2393. * Percentage of dynamic range compression to be applied by the decoder.
  2394. * The default value is 1.0, corresponding to full compression.
  2395. * - encoding: unused
  2396. * - decoding: Set by user.
  2397. * @deprecated use AC3 decoder private option instead.
  2398. */
  2399. attribute_deprecated float drc_scale;
  2400. #endif
  2401. /**
  2402. * opaque 64bit number (generally a PTS) that will be reordered and
  2403. * output in AVFrame.reordered_opaque
  2404. * @deprecated in favor of pkt_pts
  2405. * - encoding: unused
  2406. * - decoding: Set by user.
  2407. */
  2408. int64_t reordered_opaque;
  2409. /**
  2410. * Bits per sample/pixel of internal libavcodec pixel/sample format.
  2411. * - encoding: set by user.
  2412. * - decoding: set by libavcodec.
  2413. */
  2414. int bits_per_raw_sample;
  2415. /**
  2416. * Audio channel layout.
  2417. * - encoding: set by user.
  2418. * - decoding: set by user, may be overwritten by libavcodec.
  2419. */
  2420. int64_t channel_layout;
  2421. /**
  2422. * Request decoder to use this channel layout if it can (0 for default)
  2423. * - encoding: unused
  2424. * - decoding: Set by user.
  2425. */
  2426. int64_t request_channel_layout;
  2427. /**
  2428. * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
  2429. * - encoding: Set by user.
  2430. * - decoding: unused.
  2431. */
  2432. float rc_max_available_vbv_use;
  2433. /**
  2434. * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
  2435. * - encoding: Set by user.
  2436. * - decoding: unused.
  2437. */
  2438. float rc_min_vbv_overflow_use;
  2439. /**
  2440. * Hardware accelerator in use
  2441. * - encoding: unused.
  2442. * - decoding: Set by libavcodec
  2443. */
  2444. struct AVHWAccel *hwaccel;
  2445. /**
  2446. * For some codecs, the time base is closer to the field rate than the frame rate.
  2447. * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
  2448. * if no telecine is used ...
  2449. *
  2450. * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
  2451. */
  2452. int ticks_per_frame;
  2453. /**
  2454. * Hardware accelerator context.
  2455. * For some hardware accelerators, a global context needs to be
  2456. * provided by the user. In that case, this holds display-dependent
  2457. * data FFmpeg cannot instantiate itself. Please refer to the
  2458. * FFmpeg HW accelerator documentation to know how to fill this
  2459. * is. e.g. for VA API, this is a struct vaapi_context.
  2460. * - encoding: unused
  2461. * - decoding: Set by user
  2462. */
  2463. void *hwaccel_context;
  2464. /**
  2465. * Chromaticity coordinates of the source primaries.
  2466. * - encoding: Set by user
  2467. * - decoding: Set by libavcodec
  2468. */
  2469. enum AVColorPrimaries color_primaries;
  2470. /**
  2471. * Color Transfer Characteristic.
  2472. * - encoding: Set by user
  2473. * - decoding: Set by libavcodec
  2474. */
  2475. enum AVColorTransferCharacteristic color_trc;
  2476. /**
  2477. * YUV colorspace type.
  2478. * - encoding: Set by user
  2479. * - decoding: Set by libavcodec
  2480. */
  2481. enum AVColorSpace colorspace;
  2482. /**
  2483. * MPEG vs JPEG YUV range.
  2484. * - encoding: Set by user
  2485. * - decoding: Set by libavcodec
  2486. */
  2487. enum AVColorRange color_range;
  2488. /**
  2489. * This defines the location of chroma samples.
  2490. * - encoding: Set by user
  2491. * - decoding: Set by libavcodec
  2492. */
  2493. enum AVChromaLocation chroma_sample_location;
  2494. /**
  2495. * The codec may call this to execute several independent things.
  2496. * It will return only after finishing all tasks.
  2497. * The user may replace this with some multithreaded implementation,
  2498. * the default implementation will execute the parts serially.
  2499. * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
  2500. * @param c context passed also to func
  2501. * @param count the number of things to execute
  2502. * @param arg2 argument passed unchanged to func
  2503. * @param ret return values of executed functions, must have space for "count" values. May be NULL.
  2504. * @param func function that will be called count times, with jobnr from 0 to count-1.
  2505. * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
  2506. * two instances of func executing at the same time will have the same threadnr.
  2507. * @return always 0 currently, but code should handle a future improvement where when any call to func
  2508. * returns < 0 no further calls to func may be done and < 0 is returned.
  2509. * - encoding: Set by libavcodec, user can override.
  2510. * - decoding: Set by libavcodec, user can override.
  2511. */
  2512. int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
  2513. #if FF_API_X264_GLOBAL_OPTS
  2514. /**
  2515. * explicit P-frame weighted prediction analysis method
  2516. * 0: off
  2517. * 1: fast blind weighting (one reference duplicate with -1 offset)
  2518. * 2: smart weighting (full fade detection analysis)
  2519. * - encoding: Set by user.
  2520. * - decoding: unused
  2521. */
  2522. attribute_deprecated int weighted_p_pred;
  2523. /**
  2524. * AQ mode
  2525. * 0: Disabled
  2526. * 1: Variance AQ (complexity mask)
  2527. * 2: Auto-variance AQ (experimental)
  2528. * - encoding: Set by user
  2529. * - decoding: unused
  2530. */
  2531. attribute_deprecated int aq_mode;
  2532. /**
  2533. * AQ strength
  2534. * Reduces blocking and blurring in flat and textured areas.
  2535. * - encoding: Set by user
  2536. * - decoding: unused
  2537. */
  2538. attribute_deprecated float aq_strength;
  2539. /**
  2540. * PSY RD
  2541. * Strength of psychovisual optimization
  2542. * - encoding: Set by user
  2543. * - decoding: unused
  2544. */
  2545. attribute_deprecated float psy_rd;
  2546. /**
  2547. * PSY trellis
  2548. * Strength of psychovisual optimization
  2549. * - encoding: Set by user
  2550. * - decoding: unused
  2551. */
  2552. attribute_deprecated float psy_trellis;
  2553. /**
  2554. * RC lookahead
  2555. * Number of frames for frametype and ratecontrol lookahead
  2556. * - encoding: Set by user
  2557. * - decoding: unused
  2558. */
  2559. attribute_deprecated int rc_lookahead;
  2560. /**
  2561. * Constant rate factor maximum
  2562. * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
  2563. * than crf_max, even if doing so would violate VBV restrictions.
  2564. * - encoding: Set by user.
  2565. * - decoding: unused
  2566. */
  2567. attribute_deprecated float crf_max;
  2568. #endif
  2569. int log_level_offset;
  2570. #if FF_API_FLAC_GLOBAL_OPTS
  2571. /**
  2572. * Determines which LPC analysis algorithm to use.
  2573. * - encoding: Set by user
  2574. * - decoding: unused
  2575. */
  2576. attribute_deprecated enum AVLPCType lpc_type;
  2577. /**
  2578. * Number of passes to use for Cholesky factorization during LPC analysis
  2579. * - encoding: Set by user
  2580. * - decoding: unused
  2581. */
  2582. attribute_deprecated int lpc_passes;
  2583. #endif
  2584. /**
  2585. * Number of slices.
  2586. * Indicates number of picture subdivisions. Used for parallelized
  2587. * decoding.
  2588. * - encoding: Set by user
  2589. * - decoding: unused
  2590. */
  2591. int slices;
  2592. /**
  2593. * Header containing style information for text subtitles.
  2594. * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
  2595. * [Script Info] and [V4+ Styles] section, plus the [Events] line and
  2596. * the Format line following. It shouldn't include any Dialogue line.
  2597. * - encoding: Set/allocated/freed by user (before avcodec_open())
  2598. * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
  2599. */
  2600. uint8_t *subtitle_header;
  2601. int subtitle_header_size;
  2602. /**
  2603. * Current packet as passed into the decoder, to avoid having
  2604. * to pass the packet into every function. Currently only valid
  2605. * inside lavc and get/release_buffer callbacks.
  2606. * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
  2607. * - encoding: unused
  2608. */
  2609. AVPacket *pkt;
  2610. /**
  2611. * Whether this is a copy of the context which had init() called on it.
  2612. * This is used by multithreading - shared tables and picture pointers
  2613. * should be freed from the original context only.
  2614. * - encoding: Set by libavcodec.
  2615. * - decoding: Set by libavcodec.
  2616. */
  2617. int is_copy;
  2618. /**
  2619. * Which multithreading methods to use.
  2620. * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
  2621. * so clients which cannot provide future frames should not use it.
  2622. *
  2623. * - encoding: Set by user, otherwise the default is used.
  2624. * - decoding: Set by user, otherwise the default is used.
  2625. */
  2626. int thread_type;
  2627. #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
  2628. #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
  2629. /**
  2630. * Which multithreading methods are in use by the codec.
  2631. * - encoding: Set by libavcodec.
  2632. * - decoding: Set by libavcodec.
  2633. */
  2634. int active_thread_type;
  2635. /**
  2636. * Set by the client if its custom get_buffer() callback can be called
  2637. * from another thread, which allows faster multithreaded decoding.
  2638. * draw_horiz_band() will be called from other threads regardless of this setting.
  2639. * Ignored if the default get_buffer() is used.
  2640. * - encoding: Set by user.
  2641. * - decoding: Set by user.
  2642. */
  2643. int thread_safe_callbacks;
  2644. /**
  2645. * VBV delay coded in the last frame (in periods of a 27 MHz clock).
  2646. * Used for compliant TS muxing.
  2647. * - encoding: Set by libavcodec.
  2648. * - decoding: unused.
  2649. */
  2650. uint64_t vbv_delay;
  2651. /**
  2652. * Type of service that the audio stream conveys.
  2653. * - encoding: Set by user.
  2654. * - decoding: Set by libavcodec.
  2655. */
  2656. enum AVAudioServiceType audio_service_type;
  2657. /**
  2658. * desired sample format
  2659. * - encoding: Not used.
  2660. * - decoding: Set by user.
  2661. * Decoder will decode to this format if it can.
  2662. */
  2663. enum AVSampleFormat request_sample_fmt;
  2664. /**
  2665. * Error recognition; may misdetect some more or less valid parts as errors.
  2666. * - encoding: unused
  2667. * - decoding: Set by user.
  2668. */
  2669. #if FF_API_ER
  2670. int error_recognition2;
  2671. #else
  2672. int error_recognition;
  2673. #endif /* FF_API_ER */
  2674. #define AV_ER_CRCCHECK (1<<0)
  2675. #define AV_ER_BITSTREAM (1<<1)
  2676. #define AV_ER_AGGRESSIVE (1<<2)
  2677. #define AV_ER_EXPLODE (1<<3)
  2678. /**
  2679. * Current statistics for PTS correction.
  2680. * - decoding: maintained and used by libavcodec, not intended to be used by user apps
  2681. * - encoding: unused
  2682. */
  2683. int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
  2684. int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
  2685. int64_t pts_correction_last_pts; /// PTS of the last frame
  2686. int64_t pts_correction_last_dts; /// DTS of the last frame
  2687. } AVCodecContext;
  2688. /**
  2689. * AVProfile.
  2690. */
  2691. typedef struct AVProfile {
  2692. int profile;
  2693. const char *name; ///< short name for the profile
  2694. } AVProfile;
  2695. typedef struct AVCodecDefault AVCodecDefault;
  2696. /**
  2697. * AVCodec.
  2698. */
  2699. typedef struct AVCodec {
  2700. /**
  2701. * Name of the codec implementation.
  2702. * The name is globally unique among encoders and among decoders (but an
  2703. * encoder and a decoder can share the same name).
  2704. * This is the primary way to find a codec from the user perspective.
  2705. */
  2706. const char *name;
  2707. enum AVMediaType type;
  2708. enum CodecID id;
  2709. int priv_data_size;
  2710. int (*init)(AVCodecContext *);
  2711. int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
  2712. int (*close)(AVCodecContext *);
  2713. int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
  2714. /**
  2715. * Codec capabilities.
  2716. * see CODEC_CAP_*
  2717. */
  2718. int capabilities;
  2719. struct AVCodec *next;
  2720. /**
  2721. * Flush buffers.
  2722. * Will be called when seeking
  2723. */
  2724. void (*flush)(AVCodecContext *);
  2725. const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
  2726. const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
  2727. /**
  2728. * Descriptive name for the codec, meant to be more human readable than name.
  2729. * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
  2730. */
  2731. const char *long_name;
  2732. const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
  2733. const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
  2734. const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
  2735. uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
  2736. const AVClass *priv_class; ///< AVClass for the private context
  2737. const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
  2738. /**
  2739. * @name Frame-level threading support functions
  2740. * @{
  2741. */
  2742. /**
  2743. * If defined, called on thread contexts when they are created.
  2744. * If the codec allocates writable tables in init(), re-allocate them here.
  2745. * priv_data will be set to a copy of the original.
  2746. */
  2747. int (*init_thread_copy)(AVCodecContext *);
  2748. /**
  2749. * Copy necessary context variables from a previous thread context to the current one.
  2750. * If not defined, the next thread will start automatically; otherwise, the codec
  2751. * must call ff_thread_finish_setup().
  2752. *
  2753. * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
  2754. */
  2755. int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
  2756. /** @} */
  2757. /**
  2758. * Private codec-specific defaults.
  2759. */
  2760. const AVCodecDefault *defaults;
  2761. /**
  2762. * Initialize codec static data, called from avcodec_register().
  2763. */
  2764. void (*init_static_data)(struct AVCodec *codec);
  2765. } AVCodec;
  2766. /**
  2767. * AVHWAccel.
  2768. */
  2769. typedef struct AVHWAccel {
  2770. /**
  2771. * Name of the hardware accelerated codec.
  2772. * The name is globally unique among encoders and among decoders (but an
  2773. * encoder and a decoder can share the same name).
  2774. */
  2775. const char *name;
  2776. /**
  2777. * Type of codec implemented by the hardware accelerator.
  2778. *
  2779. * See AVMEDIA_TYPE_xxx
  2780. */
  2781. enum AVMediaType type;
  2782. /**
  2783. * Codec implemented by the hardware accelerator.
  2784. *
  2785. * See CODEC_ID_xxx
  2786. */
  2787. enum CodecID id;
  2788. /**
  2789. * Supported pixel format.
  2790. *
  2791. * Only hardware accelerated formats are supported here.
  2792. */
  2793. enum PixelFormat pix_fmt;
  2794. /**
  2795. * Hardware accelerated codec capabilities.
  2796. * see FF_HWACCEL_CODEC_CAP_*
  2797. */
  2798. int capabilities;
  2799. struct AVHWAccel *next;
  2800. /**
  2801. * Called at the beginning of each frame or field picture.
  2802. *
  2803. * Meaningful frame information (codec specific) is guaranteed to
  2804. * be parsed at this point. This function is mandatory.
  2805. *
  2806. * Note that buf can be NULL along with buf_size set to 0.
  2807. * Otherwise, this means the whole frame is available at this point.
  2808. *
  2809. * @param avctx the codec context
  2810. * @param buf the frame data buffer base
  2811. * @param buf_size the size of the frame in bytes
  2812. * @return zero if successful, a negative value otherwise
  2813. */
  2814. int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2815. /**
  2816. * Callback for each slice.
  2817. *
  2818. * Meaningful slice information (codec specific) is guaranteed to
  2819. * be parsed at this point. This function is mandatory.
  2820. *
  2821. * @param avctx the codec context
  2822. * @param buf the slice data buffer base
  2823. * @param buf_size the size of the slice in bytes
  2824. * @return zero if successful, a negative value otherwise
  2825. */
  2826. int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
  2827. /**
  2828. * Called at the end of each frame or field picture.
  2829. *
  2830. * The whole picture is parsed at this point and can now be sent
  2831. * to the hardware accelerator. This function is mandatory.
  2832. *
  2833. * @param avctx the codec context
  2834. * @return zero if successful, a negative value otherwise
  2835. */
  2836. int (*end_frame)(AVCodecContext *avctx);
  2837. /**
  2838. * Size of HW accelerator private data.
  2839. *
  2840. * Private data is allocated with av_mallocz() before
  2841. * AVCodecContext.get_buffer() and deallocated after
  2842. * AVCodecContext.release_buffer().
  2843. */
  2844. int priv_data_size;
  2845. } AVHWAccel;
  2846. /**
  2847. * four components are given, that's all.
  2848. * the last component is alpha
  2849. */
  2850. typedef struct AVPicture {
  2851. uint8_t *data[4];
  2852. int linesize[4]; ///< number of bytes per line
  2853. } AVPicture;
  2854. #define AVPALETTE_SIZE 1024
  2855. #define AVPALETTE_COUNT 256
  2856. #if FF_API_PALETTE_CONTROL
  2857. /**
  2858. * AVPaletteControl
  2859. * This structure defines a method for communicating palette changes
  2860. * between and demuxer and a decoder.
  2861. *
  2862. * @deprecated Use AVPacket to send palette changes instead.
  2863. * This is totally broken.
  2864. */
  2865. typedef struct AVPaletteControl {
  2866. /* Demuxer sets this to 1 to indicate the palette has changed;
  2867. * decoder resets to 0. */
  2868. int palette_changed;
  2869. /* 4-byte ARGB palette entries, stored in native byte order; note that
  2870. * the individual palette components should be on a 8-bit scale; if
  2871. * the palette data comes from an IBM VGA native format, the component
  2872. * data is probably 6 bits in size and needs to be scaled. */
  2873. unsigned int palette[AVPALETTE_COUNT];
  2874. } AVPaletteControl attribute_deprecated;
  2875. #endif
  2876. enum AVSubtitleType {
  2877. SUBTITLE_NONE,
  2878. SUBTITLE_BITMAP, ///< A bitmap, pict will be set
  2879. /**
  2880. * Plain text, the text field must be set by the decoder and is
  2881. * authoritative. ass and pict fields may contain approximations.
  2882. */
  2883. SUBTITLE_TEXT,
  2884. /**
  2885. * Formatted text, the ass field must be set by the decoder and is
  2886. * authoritative. pict and text fields may contain approximations.
  2887. */
  2888. SUBTITLE_ASS,
  2889. };
  2890. typedef struct AVSubtitleRect {
  2891. int x; ///< top left corner of pict, undefined when pict is not set
  2892. int y; ///< top left corner of pict, undefined when pict is not set
  2893. int w; ///< width of pict, undefined when pict is not set
  2894. int h; ///< height of pict, undefined when pict is not set
  2895. int nb_colors; ///< number of colors in pict, undefined when pict is not set
  2896. /**
  2897. * data+linesize for the bitmap of this subtitle.
  2898. * can be set for text/ass as well once they where rendered
  2899. */
  2900. AVPicture pict;
  2901. enum AVSubtitleType type;
  2902. char *text; ///< 0 terminated plain UTF-8 text
  2903. /**
  2904. * 0 terminated ASS/SSA compatible event line.
  2905. * The pressentation of this is unaffected by the other values in this
  2906. * struct.
  2907. */
  2908. char *ass;
  2909. } AVSubtitleRect;
  2910. typedef struct AVSubtitle {
  2911. uint16_t format; /* 0 = graphics */
  2912. uint32_t start_display_time; /* relative to packet pts, in ms */
  2913. uint32_t end_display_time; /* relative to packet pts, in ms */
  2914. unsigned num_rects;
  2915. AVSubtitleRect **rects;
  2916. int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
  2917. } AVSubtitle;
  2918. /* packet functions */
  2919. /**
  2920. * @deprecated use NULL instead
  2921. */
  2922. attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
  2923. /**
  2924. * Default packet destructor.
  2925. */
  2926. void av_destruct_packet(AVPacket *pkt);
  2927. /**
  2928. * Initialize optional fields of a packet with default values.
  2929. *
  2930. * @param pkt packet
  2931. */
  2932. void av_init_packet(AVPacket *pkt);
  2933. /**
  2934. * Allocate the payload of a packet and initialize its fields with
  2935. * default values.
  2936. *
  2937. * @param pkt packet
  2938. * @param size wanted payload size
  2939. * @return 0 if OK, AVERROR_xxx otherwise
  2940. */
  2941. int av_new_packet(AVPacket *pkt, int size);
  2942. /**
  2943. * Reduce packet size, correctly zeroing padding
  2944. *
  2945. * @param pkt packet
  2946. * @param size new size
  2947. */
  2948. void av_shrink_packet(AVPacket *pkt, int size);
  2949. /**
  2950. * Increase packet size, correctly zeroing padding
  2951. *
  2952. * @param pkt packet
  2953. * @param grow_by number of bytes by which to increase the size of the packet
  2954. */
  2955. int av_grow_packet(AVPacket *pkt, int grow_by);
  2956. /**
  2957. * @warning This is a hack - the packet memory allocation stuff is broken. The
  2958. * packet is allocated if it was not really allocated.
  2959. */
  2960. int av_dup_packet(AVPacket *pkt);
  2961. /**
  2962. * Free a packet.
  2963. *
  2964. * @param pkt packet to free
  2965. */
  2966. void av_free_packet(AVPacket *pkt);
  2967. /**
  2968. * Allocate new information of a packet.
  2969. *
  2970. * @param pkt packet
  2971. * @param type side information type
  2972. * @param size side information size
  2973. * @return pointer to fresh allocated data or NULL otherwise
  2974. */
  2975. uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  2976. int size);
  2977. /**
  2978. * Get side information from packet.
  2979. *
  2980. * @param pkt packet
  2981. * @param type desired side information type
  2982. * @param size pointer for side information size to store (optional)
  2983. * @return pointer to data if present or NULL otherwise
  2984. */
  2985. uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
  2986. int *size);
  2987. int av_packet_merge_side_data(AVPacket *pkt);
  2988. int av_packet_split_side_data(AVPacket *pkt);
  2989. /* resample.c */
  2990. struct ReSampleContext;
  2991. struct AVResampleContext;
  2992. typedef struct ReSampleContext ReSampleContext;
  2993. /**
  2994. * Initialize audio resampling context.
  2995. *
  2996. * @param output_channels number of output channels
  2997. * @param input_channels number of input channels
  2998. * @param output_rate output sample rate
  2999. * @param input_rate input sample rate
  3000. * @param sample_fmt_out requested output sample format
  3001. * @param sample_fmt_in input sample format
  3002. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
  3003. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  3004. * @param linear if 1 then the used FIR filter will be linearly interpolated
  3005. between the 2 closest, if 0 the closest will be used
  3006. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  3007. * @return allocated ReSampleContext, NULL if error occured
  3008. */
  3009. ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
  3010. int output_rate, int input_rate,
  3011. enum AVSampleFormat sample_fmt_out,
  3012. enum AVSampleFormat sample_fmt_in,
  3013. int filter_length, int log2_phase_count,
  3014. int linear, double cutoff);
  3015. int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
  3016. /**
  3017. * Free resample context.
  3018. *
  3019. * @param s a non-NULL pointer to a resample context previously
  3020. * created with av_audio_resample_init()
  3021. */
  3022. void audio_resample_close(ReSampleContext *s);
  3023. /**
  3024. * Initialize an audio resampler.
  3025. * Note, if either rate is not an integer then simply scale both rates up so they are.
  3026. * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
  3027. * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
  3028. * @param linear If 1 then the used FIR filter will be linearly interpolated
  3029. between the 2 closest, if 0 the closest will be used
  3030. * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
  3031. */
  3032. struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
  3033. /**
  3034. * Resample an array of samples using a previously configured context.
  3035. * @param src an array of unconsumed samples
  3036. * @param consumed the number of samples of src which have been consumed are returned here
  3037. * @param src_size the number of unconsumed samples available
  3038. * @param dst_size the amount of space in samples available in dst
  3039. * @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.
  3040. * @return the number of samples written in dst or -1 if an error occurred
  3041. */
  3042. int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
  3043. /**
  3044. * Compensate samplerate/timestamp drift. The compensation is done by changing
  3045. * the resampler parameters, so no audible clicks or similar distortions occur
  3046. * @param compensation_distance distance in output samples over which the compensation should be performed
  3047. * @param sample_delta number of output samples which should be output less
  3048. *
  3049. * example: av_resample_compensate(c, 10, 500)
  3050. * here instead of 510 samples only 500 samples would be output
  3051. *
  3052. * note, due to rounding the actual compensation might be slightly different,
  3053. * especially if the compensation_distance is large and the in_rate used during init is small
  3054. */
  3055. void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
  3056. void av_resample_close(struct AVResampleContext *c);
  3057. /**
  3058. * Allocate memory for a picture. Call avpicture_free() to free it.
  3059. *
  3060. * @see avpicture_fill()
  3061. *
  3062. * @param picture the picture to be filled in
  3063. * @param pix_fmt the format of the picture
  3064. * @param width the width of the picture
  3065. * @param height the height of the picture
  3066. * @return zero if successful, a negative value if not
  3067. */
  3068. int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
  3069. /**
  3070. * Free a picture previously allocated by avpicture_alloc().
  3071. * The data buffer used by the AVPicture is freed, but the AVPicture structure
  3072. * itself is not.
  3073. *
  3074. * @param picture the AVPicture to be freed
  3075. */
  3076. void avpicture_free(AVPicture *picture);
  3077. /**
  3078. * Fill in the AVPicture fields.
  3079. * The fields of the given AVPicture are filled in by using the 'ptr' address
  3080. * which points to the image data buffer. Depending on the specified picture
  3081. * format, one or multiple image data pointers and line sizes will be set.
  3082. * If a planar format is specified, several pointers will be set pointing to
  3083. * the different picture planes and the line sizes of the different planes
  3084. * will be stored in the lines_sizes array.
  3085. * Call with ptr == NULL to get the required size for the ptr buffer.
  3086. *
  3087. * To allocate the buffer and fill in the AVPicture fields in one call,
  3088. * use avpicture_alloc().
  3089. *
  3090. * @param picture AVPicture whose fields are to be filled in
  3091. * @param ptr Buffer which will contain or contains the actual image data
  3092. * @param pix_fmt The format in which the picture data is stored.
  3093. * @param width the width of the image in pixels
  3094. * @param height the height of the image in pixels
  3095. * @return size of the image data in bytes
  3096. */
  3097. int avpicture_fill(AVPicture *picture, uint8_t *ptr,
  3098. enum PixelFormat pix_fmt, int width, int height);
  3099. /**
  3100. * Copy pixel data from an AVPicture into a buffer.
  3101. * The data is stored compactly, without any gaps for alignment or padding
  3102. * which may be applied by avpicture_fill().
  3103. *
  3104. * @see avpicture_get_size()
  3105. *
  3106. * @param[in] src AVPicture containing image data
  3107. * @param[in] pix_fmt The format in which the picture data is stored.
  3108. * @param[in] width the width of the image in pixels.
  3109. * @param[in] height the height of the image in pixels.
  3110. * @param[out] dest A buffer into which picture data will be copied.
  3111. * @param[in] dest_size The size of 'dest'.
  3112. * @return The number of bytes written to dest, or a negative value (error code) on error.
  3113. */
  3114. int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
  3115. unsigned char *dest, int dest_size);
  3116. /**
  3117. * Calculate the size in bytes that a picture of the given width and height
  3118. * would occupy if stored in the given picture format.
  3119. * Note that this returns the size of a compact representation as generated
  3120. * by avpicture_layout(), which can be smaller than the size required for e.g.
  3121. * avpicture_fill().
  3122. *
  3123. * @param pix_fmt the given picture format
  3124. * @param width the width of the image
  3125. * @param height the height of the image
  3126. * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
  3127. */
  3128. int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
  3129. void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
  3130. /**
  3131. * Get the name of a codec.
  3132. * @return a static string identifying the codec; never NULL
  3133. */
  3134. const char *avcodec_get_name(enum CodecID id);
  3135. #if FF_API_GET_PIX_FMT_NAME
  3136. /**
  3137. * Return the short name for a pixel format.
  3138. *
  3139. * \see av_get_pix_fmt(), av_get_pix_fmt_string().
  3140. * @deprecated Deprecated in favor of av_get_pix_fmt_name().
  3141. */
  3142. attribute_deprecated
  3143. const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
  3144. #endif
  3145. void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
  3146. /**
  3147. * Return a value representing the fourCC code associated to the
  3148. * pixel format pix_fmt, or 0 if no associated fourCC code can be
  3149. * found.
  3150. */
  3151. unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
  3152. /**
  3153. * Put a string representing the codec tag codec_tag in buf.
  3154. *
  3155. * @param buf_size size in bytes of buf
  3156. * @return the length of the string that would have been generated if
  3157. * enough space had been available, excluding the trailing null
  3158. */
  3159. size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
  3160. #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
  3161. #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
  3162. #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
  3163. #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
  3164. #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
  3165. #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
  3166. /**
  3167. * Compute what kind of losses will occur when converting from one specific
  3168. * pixel format to another.
  3169. * When converting from one pixel format to another, information loss may occur.
  3170. * For example, when converting from RGB24 to GRAY, the color information will
  3171. * be lost. Similarly, other losses occur when converting from some formats to
  3172. * other formats. These losses can involve loss of chroma, but also loss of
  3173. * resolution, loss of color depth, loss due to the color space conversion, loss
  3174. * of the alpha bits or loss due to color quantization.
  3175. * avcodec_get_fix_fmt_loss() informs you about the various types of losses
  3176. * which will occur when converting from one pixel format to another.
  3177. *
  3178. * @param[in] dst_pix_fmt destination pixel format
  3179. * @param[in] src_pix_fmt source pixel format
  3180. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3181. * @return Combination of flags informing you what kind of losses will occur
  3182. * (maximum loss for an invalid dst_pix_fmt).
  3183. */
  3184. int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
  3185. int has_alpha);
  3186. /**
  3187. * Find the best pixel format to convert to given a certain source pixel
  3188. * format. When converting from one pixel format to another, information loss
  3189. * may occur. For example, when converting from RGB24 to GRAY, the color
  3190. * information will be lost. Similarly, other losses occur when converting from
  3191. * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
  3192. * the given pixel formats should be used to suffer the least amount of loss.
  3193. * The pixel formats from which it chooses one, are determined by the
  3194. * pix_fmt_mask parameter.
  3195. *
  3196. * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
  3197. *
  3198. * @code
  3199. * src_pix_fmt = PIX_FMT_YUV420P;
  3200. * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
  3201. * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
  3202. * @endcode
  3203. *
  3204. * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
  3205. * @param[in] src_pix_fmt source pixel format
  3206. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3207. * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
  3208. * @return The best pixel format to convert to or -1 if none was found.
  3209. */
  3210. enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
  3211. int has_alpha, int *loss_ptr);
  3212. /**
  3213. * Find the best pixel format to convert to given a certain source pixel
  3214. * format and a selection of two destination pixel formats. When converting from
  3215. * one pixel format to another, information loss may occur. For example, when converting
  3216. * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
  3217. * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
  3218. * the given pixel formats should be used to suffer the least amount of loss.
  3219. *
  3220. * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
  3221. * returned.
  3222. *
  3223. * @code
  3224. * src_pix_fmt = PIX_FMT_YUV420P;
  3225. * dst_pix_fmt1= PIX_FMT_RGB24;
  3226. * dst_pix_fmt2= PIX_FMT_GRAY8;
  3227. * dst_pix_fmt3= PIX_FMT_RGB8;
  3228. * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
  3229. * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
  3230. * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
  3231. * @endcode
  3232. *
  3233. * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
  3234. * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
  3235. * @param[in] src_pix_fmt Source pixel format
  3236. * @param[in] has_alpha Whether the source pixel format alpha channel is used.
  3237. * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
  3238. * NULL or value of zero means we care about all losses. Out: the loss
  3239. * that occurs when converting from src to selected dst pixel format.
  3240. * @return The best pixel format to convert to or -1 if none was found.
  3241. */
  3242. enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
  3243. enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
  3244. #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
  3245. #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
  3246. /**
  3247. * Tell if an image really has transparent alpha values.
  3248. * @return ored mask of FF_ALPHA_xxx constants
  3249. */
  3250. int img_get_alpha_info(const AVPicture *src,
  3251. enum PixelFormat pix_fmt, int width, int height);
  3252. /* deinterlace a picture */
  3253. /* deinterlace - if not supported return -1 */
  3254. int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
  3255. enum PixelFormat pix_fmt, int width, int height);
  3256. /* external high level API */
  3257. /**
  3258. * If c is NULL, returns the first registered codec,
  3259. * if c is non-NULL, returns the next registered codec after c,
  3260. * or NULL if c is the last one.
  3261. */
  3262. AVCodec *av_codec_next(AVCodec *c);
  3263. /**
  3264. * Return the LIBAVCODEC_VERSION_INT constant.
  3265. */
  3266. unsigned avcodec_version(void);
  3267. /**
  3268. * Return the libavcodec build-time configuration.
  3269. */
  3270. const char *avcodec_configuration(void);
  3271. /**
  3272. * Return the libavcodec license.
  3273. */
  3274. const char *avcodec_license(void);
  3275. #if FF_API_AVCODEC_INIT
  3276. /**
  3277. * @deprecated this function is called automatically from avcodec_register()
  3278. * and avcodec_register_all(), there is no need to call it manually
  3279. */
  3280. attribute_deprecated
  3281. void avcodec_init(void);
  3282. #endif
  3283. /**
  3284. * Register the codec codec and initialize libavcodec.
  3285. *
  3286. * @warning either this function or avcodec_register_all() must be called
  3287. * before any other libavcodec functions.
  3288. *
  3289. * @see avcodec_register_all()
  3290. */
  3291. void avcodec_register(AVCodec *codec);
  3292. /**
  3293. * Find a registered encoder with a matching codec ID.
  3294. *
  3295. * @param id CodecID of the requested encoder
  3296. * @return An encoder if one was found, NULL otherwise.
  3297. */
  3298. AVCodec *avcodec_find_encoder(enum CodecID id);
  3299. /**
  3300. * Find a registered encoder with the specified name.
  3301. *
  3302. * @param name name of the requested encoder
  3303. * @return An encoder if one was found, NULL otherwise.
  3304. */
  3305. AVCodec *avcodec_find_encoder_by_name(const char *name);
  3306. /**
  3307. * Find a registered decoder with a matching codec ID.
  3308. *
  3309. * @param id CodecID of the requested decoder
  3310. * @return A decoder if one was found, NULL otherwise.
  3311. */
  3312. AVCodec *avcodec_find_decoder(enum CodecID id);
  3313. /**
  3314. * Find a registered decoder with the specified name.
  3315. *
  3316. * @param name name of the requested decoder
  3317. * @return A decoder if one was found, NULL otherwise.
  3318. */
  3319. AVCodec *avcodec_find_decoder_by_name(const char *name);
  3320. void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
  3321. /**
  3322. * Return a name for the specified profile, if available.
  3323. *
  3324. * @param codec the codec that is searched for the given profile
  3325. * @param profile the profile value for which a name is requested
  3326. * @return A name for the profile if found, NULL otherwise.
  3327. */
  3328. const char *av_get_profile_name(const AVCodec *codec, int profile);
  3329. /**
  3330. * Set the fields of the given AVCodecContext to default values.
  3331. *
  3332. * @param s The AVCodecContext of which the fields should be set to default values.
  3333. */
  3334. void avcodec_get_context_defaults(AVCodecContext *s);
  3335. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  3336. * we WILL change its arguments and name a few times! */
  3337. void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
  3338. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  3339. * we WILL change its arguments and name a few times! */
  3340. int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
  3341. #if FF_API_ALLOC_CONTEXT
  3342. /**
  3343. * Allocate an AVCodecContext and set its fields to default values. The
  3344. * resulting struct can be deallocated by simply calling av_free().
  3345. *
  3346. * @return An AVCodecContext filled with default values or NULL on failure.
  3347. * @see avcodec_get_context_defaults
  3348. *
  3349. * @deprecated use avcodec_alloc_context3()
  3350. */
  3351. attribute_deprecated
  3352. AVCodecContext *avcodec_alloc_context(void);
  3353. /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
  3354. * we WILL change its arguments and name a few times! */
  3355. attribute_deprecated
  3356. AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
  3357. #endif
  3358. /**
  3359. * Allocate an AVCodecContext and set its fields to default values. The
  3360. * resulting struct can be deallocated by simply calling av_free().
  3361. *
  3362. * @param codec if non-NULL, allocate private data and initialize defaults
  3363. * for the given codec. It is illegal to then call avcodec_open()
  3364. * with a different codec.
  3365. *
  3366. * @return An AVCodecContext filled with default values or NULL on failure.
  3367. * @see avcodec_get_context_defaults
  3368. */
  3369. AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
  3370. /**
  3371. * Copy the settings of the source AVCodecContext into the destination
  3372. * AVCodecContext. The resulting destination codec context will be
  3373. * unopened, i.e. you are required to call avcodec_open() before you
  3374. * can use this AVCodecContext to decode/encode video/audio data.
  3375. *
  3376. * @param dest target codec context, should be initialized with
  3377. * avcodec_alloc_context3(), but otherwise uninitialized
  3378. * @param src source codec context
  3379. * @return AVERROR() on error (e.g. memory allocation error), 0 on success
  3380. */
  3381. int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
  3382. /**
  3383. * Set the fields of the given AVFrame to default values.
  3384. *
  3385. * @param pic The AVFrame of which the fields should be set to default values.
  3386. */
  3387. void avcodec_get_frame_defaults(AVFrame *pic);
  3388. /**
  3389. * Allocate an AVFrame and set its fields to default values. The resulting
  3390. * struct can be deallocated by simply calling av_free().
  3391. *
  3392. * @return An AVFrame filled with default values or NULL on failure.
  3393. * @see avcodec_get_frame_defaults
  3394. */
  3395. AVFrame *avcodec_alloc_frame(void);
  3396. int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
  3397. void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
  3398. int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
  3399. /**
  3400. * Return the amount of padding in pixels which the get_buffer callback must
  3401. * provide around the edge of the image for codecs which do not have the
  3402. * CODEC_FLAG_EMU_EDGE flag.
  3403. *
  3404. * @return Required padding in pixels.
  3405. */
  3406. unsigned avcodec_get_edge_width(void);
  3407. /**
  3408. * Modify width and height values so that they will result in a memory
  3409. * buffer that is acceptable for the codec if you do not use any horizontal
  3410. * padding.
  3411. *
  3412. * May only be used if a codec with CODEC_CAP_DR1 has been opened.
  3413. * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
  3414. * according to avcodec_get_edge_width() before.
  3415. */
  3416. void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
  3417. /**
  3418. * Modify width and height values so that they will result in a memory
  3419. * buffer that is acceptable for the codec if you also ensure that all
  3420. * line sizes are a multiple of the respective linesize_align[i].
  3421. *
  3422. * May only be used if a codec with CODEC_CAP_DR1 has been opened.
  3423. * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
  3424. * according to avcodec_get_edge_width() before.
  3425. */
  3426. void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
  3427. int linesize_align[4]);
  3428. enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
  3429. #if FF_API_THREAD_INIT
  3430. /**
  3431. * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
  3432. */
  3433. attribute_deprecated
  3434. int avcodec_thread_init(AVCodecContext *s, int thread_count);
  3435. #endif
  3436. int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
  3437. int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
  3438. //FIXME func typedef
  3439. #if FF_API_AVCODEC_OPEN
  3440. /**
  3441. * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
  3442. * function the context has to be allocated.
  3443. *
  3444. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  3445. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  3446. * retrieving a codec.
  3447. *
  3448. * @warning This function is not thread safe!
  3449. *
  3450. * @code
  3451. * avcodec_register_all();
  3452. * codec = avcodec_find_decoder(CODEC_ID_H264);
  3453. * if (!codec)
  3454. * exit(1);
  3455. *
  3456. * context = avcodec_alloc_context3(codec);
  3457. *
  3458. * if (avcodec_open(context, codec) < 0)
  3459. * exit(1);
  3460. * @endcode
  3461. *
  3462. * @param avctx The context which will be set up to use the given codec.
  3463. * @param codec The codec to use within the context.
  3464. * @return zero on success, a negative value on error
  3465. * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
  3466. *
  3467. * @deprecated use avcodec_open2
  3468. */
  3469. attribute_deprecated
  3470. int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
  3471. #endif
  3472. /**
  3473. * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
  3474. * function the context has to be allocated with avcodec_alloc_context().
  3475. *
  3476. * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
  3477. * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
  3478. * retrieving a codec.
  3479. *
  3480. * @warning This function is not thread safe!
  3481. *
  3482. * @code
  3483. * avcodec_register_all();
  3484. * av_dict_set(&opts, "b", "2.5M", 0);
  3485. * codec = avcodec_find_decoder(CODEC_ID_H264);
  3486. * if (!codec)
  3487. * exit(1);
  3488. *
  3489. * context = avcodec_alloc_context();
  3490. *
  3491. * if (avcodec_open(context, codec, opts) < 0)
  3492. * exit(1);
  3493. * @endcode
  3494. *
  3495. * @param avctx The context to initialize.
  3496. * @param options A dictionary filled with AVCodecContext and codec-private options.
  3497. * On return this object will be filled with options that were not found.
  3498. *
  3499. * @return zero on success, a negative value on error
  3500. * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
  3501. * av_dict_set(), av_opt_find().
  3502. */
  3503. int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
  3504. /**
  3505. * Decode the audio frame of size avpkt->size from avpkt->data into samples.
  3506. * Some decoders may support multiple frames in a single AVPacket, such
  3507. * decoders would then just decode the first frame. In this case,
  3508. * avcodec_decode_audio3 has to be called again with an AVPacket that contains
  3509. * the remaining data in order to decode the second frame etc.
  3510. * If no frame
  3511. * could be outputted, frame_size_ptr is zero. Otherwise, it is the
  3512. * decompressed frame size in bytes.
  3513. *
  3514. * @warning You must set frame_size_ptr to the allocated size of the
  3515. * output buffer before calling avcodec_decode_audio3().
  3516. *
  3517. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  3518. * the actual read bytes because some optimized bitstream readers read 32 or 64
  3519. * bits at once and could read over the end.
  3520. *
  3521. * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
  3522. * no overreading happens for damaged MPEG streams.
  3523. *
  3524. * @note You might have to align the input buffer avpkt->data and output buffer
  3525. * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
  3526. * necessary at all, on others it won't work at all if not aligned and on others
  3527. * it will work but it will have an impact on performance.
  3528. *
  3529. * In practice, avpkt->data should have 4 byte alignment at minimum and
  3530. * samples should be 16 byte aligned unless the CPU doesn't need it
  3531. * (AltiVec and SSE do).
  3532. *
  3533. * @param avctx the codec context
  3534. * @param[out] samples the output buffer, sample type in avctx->sample_fmt
  3535. * @param[in,out] frame_size_ptr the output buffer size in bytes
  3536. * @param[in] avpkt The input AVPacket containing the input buffer.
  3537. * You can create such packet with av_init_packet() and by then setting
  3538. * data and size, some decoders might in addition need other fields.
  3539. * All decoders are designed to use the least fields possible though.
  3540. * @return On error a negative value is returned, otherwise the number of bytes
  3541. * used or zero if no frame data was decompressed (used) from the input AVPacket.
  3542. */
  3543. int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
  3544. int *frame_size_ptr,
  3545. AVPacket *avpkt);
  3546. /**
  3547. * Decode the video frame of size avpkt->size from avpkt->data into picture.
  3548. * Some decoders may support multiple frames in a single AVPacket, such
  3549. * decoders would then just decode the first frame.
  3550. *
  3551. * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
  3552. * the actual read bytes because some optimized bitstream readers read 32 or 64
  3553. * bits at once and could read over the end.
  3554. *
  3555. * @warning The end of the input buffer buf should be set to 0 to ensure that
  3556. * no overreading happens for damaged MPEG streams.
  3557. *
  3558. * @note You might have to align the input buffer avpkt->data.
  3559. * The alignment requirements depend on the CPU: on some CPUs it isn't
  3560. * necessary at all, on others it won't work at all if not aligned and on others
  3561. * it will work but it will have an impact on performance.
  3562. *
  3563. * In practice, avpkt->data should have 4 byte alignment at minimum.
  3564. *
  3565. * @note Some codecs have a delay between input and output, these need to be
  3566. * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
  3567. *
  3568. * @param avctx the codec context
  3569. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
  3570. * Use avcodec_alloc_frame to get an AVFrame, the codec will
  3571. * allocate memory for the actual bitmap.
  3572. * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
  3573. * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
  3574. * decodes and the decoder tells the user once it does not need the data anymore,
  3575. * the user app can at this point free/reuse/keep the memory as it sees fit.
  3576. *
  3577. * @param[in] avpkt The input AVpacket containing the input buffer.
  3578. * You can create such packet with av_init_packet() and by then setting
  3579. * data and size, some decoders might in addition need other fields like
  3580. * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
  3581. * fields possible.
  3582. * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
  3583. * @return On error a negative value is returned, otherwise the number of bytes
  3584. * used or zero if no frame could be decompressed.
  3585. */
  3586. int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
  3587. int *got_picture_ptr,
  3588. AVPacket *avpkt);
  3589. /**
  3590. * Decode a subtitle message.
  3591. * Return a negative value on error, otherwise return the number of bytes used.
  3592. * If no subtitle could be decompressed, got_sub_ptr is zero.
  3593. * Otherwise, the subtitle is stored in *sub.
  3594. * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
  3595. * simplicity, because the performance difference is expect to be negligible
  3596. * and reusing a get_buffer written for video codecs would probably perform badly
  3597. * due to a potentially very different allocation pattern.
  3598. *
  3599. * @param avctx the codec context
  3600. * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
  3601. freed with avsubtitle_free if *got_sub_ptr is set.
  3602. * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
  3603. * @param[in] avpkt The input AVPacket containing the input buffer.
  3604. */
  3605. int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
  3606. int *got_sub_ptr,
  3607. AVPacket *avpkt);
  3608. /**
  3609. * Frees all allocated data in the given subtitle struct.
  3610. *
  3611. * @param sub AVSubtitle to free.
  3612. */
  3613. void avsubtitle_free(AVSubtitle *sub);
  3614. int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
  3615. int *data_size_ptr,
  3616. uint8_t *buf, int buf_size);
  3617. /**
  3618. * Encode an audio frame from samples into buf.
  3619. *
  3620. * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
  3621. * However, for PCM audio the user will know how much space is needed
  3622. * because it depends on the value passed in buf_size as described
  3623. * below. In that case a lower value can be used.
  3624. *
  3625. * @param avctx the codec context
  3626. * @param[out] buf the output buffer
  3627. * @param[in] buf_size the output buffer size
  3628. * @param[in] samples the input buffer containing the samples
  3629. * The number of samples read from this buffer is frame_size*channels,
  3630. * both of which are defined in avctx.
  3631. * For PCM audio the number of samples read from samples is equal to
  3632. * buf_size * input_sample_size / output_sample_size.
  3633. * @return On error a negative value is returned, on success zero or the number
  3634. * of bytes used to encode the data read from the input buffer.
  3635. */
  3636. int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3637. const short *samples);
  3638. /**
  3639. * Encode a video frame from pict into buf.
  3640. * The input picture should be
  3641. * stored using a specific format, namely avctx.pix_fmt.
  3642. *
  3643. * @param avctx the codec context
  3644. * @param[out] buf the output buffer for the bitstream of encoded frame
  3645. * @param[in] buf_size the size of the output buffer in bytes
  3646. * @param[in] pict the input picture to encode
  3647. * @return On error a negative value is returned, on success zero or the number
  3648. * of bytes used from the output buffer.
  3649. */
  3650. int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3651. const AVFrame *pict);
  3652. int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
  3653. const AVSubtitle *sub);
  3654. int avcodec_close(AVCodecContext *avctx);
  3655. /**
  3656. * Register all the codecs, parsers and bitstream filters which were enabled at
  3657. * configuration time. If you do not call this function you can select exactly
  3658. * which formats you want to support, by using the individual registration
  3659. * functions.
  3660. *
  3661. * @see avcodec_register
  3662. * @see av_register_codec_parser
  3663. * @see av_register_bitstream_filter
  3664. */
  3665. void avcodec_register_all(void);
  3666. /**
  3667. * Flush buffers, should be called when seeking or when switching to a different stream.
  3668. */
  3669. void avcodec_flush_buffers(AVCodecContext *avctx);
  3670. void avcodec_default_free_buffers(AVCodecContext *s);
  3671. /* misc useful functions */
  3672. #if FF_API_OLD_FF_PICT_TYPES
  3673. /**
  3674. * Return a single letter to describe the given picture type pict_type.
  3675. *
  3676. * @param[in] pict_type the picture type
  3677. * @return A single character representing the picture type.
  3678. * @deprecated Use av_get_picture_type_char() instead.
  3679. */
  3680. attribute_deprecated
  3681. char av_get_pict_type_char(int pict_type);
  3682. #endif
  3683. /**
  3684. * Return codec bits per sample.
  3685. *
  3686. * @param[in] codec_id the codec
  3687. * @return Number of bits per sample or zero if unknown for the given codec.
  3688. */
  3689. int av_get_bits_per_sample(enum CodecID codec_id);
  3690. #if FF_API_OLD_SAMPLE_FMT
  3691. /**
  3692. * @deprecated Use av_get_bytes_per_sample() instead.
  3693. */
  3694. attribute_deprecated
  3695. int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
  3696. #endif
  3697. /* frame parsing */
  3698. typedef struct AVCodecParserContext {
  3699. void *priv_data;
  3700. struct AVCodecParser *parser;
  3701. int64_t frame_offset; /* offset of the current frame */
  3702. int64_t cur_offset; /* current offset
  3703. (incremented by each av_parser_parse()) */
  3704. int64_t next_frame_offset; /* offset of the next frame */
  3705. /* video info */
  3706. int pict_type; /* XXX: Put it back in AVCodecContext. */
  3707. /**
  3708. * This field is used for proper frame duration computation in lavf.
  3709. * It signals, how much longer the frame duration of the current frame
  3710. * is compared to normal frame duration.
  3711. *
  3712. * frame_duration = (1 + repeat_pict) * time_base
  3713. *
  3714. * It is used by codecs like H.264 to display telecined material.
  3715. */
  3716. int repeat_pict; /* XXX: Put it back in AVCodecContext. */
  3717. int64_t pts; /* pts of the current frame */
  3718. int64_t dts; /* dts of the current frame */
  3719. /* private data */
  3720. int64_t last_pts;
  3721. int64_t last_dts;
  3722. int fetch_timestamp;
  3723. #define AV_PARSER_PTS_NB 4
  3724. int cur_frame_start_index;
  3725. int64_t cur_frame_offset[AV_PARSER_PTS_NB];
  3726. int64_t cur_frame_pts[AV_PARSER_PTS_NB];
  3727. int64_t cur_frame_dts[AV_PARSER_PTS_NB];
  3728. int flags;
  3729. #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
  3730. #define PARSER_FLAG_ONCE 0x0002
  3731. /// Set if the parser has a valid file offset
  3732. #define PARSER_FLAG_FETCHED_OFFSET 0x0004
  3733. int64_t offset; ///< byte offset from starting packet start
  3734. int64_t cur_frame_end[AV_PARSER_PTS_NB];
  3735. /**
  3736. * Set by parser to 1 for key frames and 0 for non-key frames.
  3737. * It is initialized to -1, so if the parser doesn't set this flag,
  3738. * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
  3739. * will be used.
  3740. */
  3741. int key_frame;
  3742. /**
  3743. * Time difference in stream time base units from the pts of this
  3744. * packet to the point at which the output from the decoder has converged
  3745. * independent from the availability of previous frames. That is, the
  3746. * frames are virtually identical no matter if decoding started from
  3747. * the very first frame or from this keyframe.
  3748. * Is AV_NOPTS_VALUE if unknown.
  3749. * This field is not the display duration of the current frame.
  3750. * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
  3751. * set.
  3752. *
  3753. * The purpose of this field is to allow seeking in streams that have no
  3754. * keyframes in the conventional sense. It corresponds to the
  3755. * recovery point SEI in H.264 and match_time_delta in NUT. It is also
  3756. * essential for some types of subtitle streams to ensure that all
  3757. * subtitles are correctly displayed after seeking.
  3758. */
  3759. int64_t convergence_duration;
  3760. // Timestamp generation support:
  3761. /**
  3762. * Synchronization point for start of timestamp generation.
  3763. *
  3764. * Set to >0 for sync point, 0 for no sync point and <0 for undefined
  3765. * (default).
  3766. *
  3767. * For example, this corresponds to presence of H.264 buffering period
  3768. * SEI message.
  3769. */
  3770. int dts_sync_point;
  3771. /**
  3772. * Offset of the current timestamp against last timestamp sync point in
  3773. * units of AVCodecContext.time_base.
  3774. *
  3775. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3776. * contain a valid timestamp offset.
  3777. *
  3778. * Note that the timestamp of sync point has usually a nonzero
  3779. * dts_ref_dts_delta, which refers to the previous sync point. Offset of
  3780. * the next frame after timestamp sync point will be usually 1.
  3781. *
  3782. * For example, this corresponds to H.264 cpb_removal_delay.
  3783. */
  3784. int dts_ref_dts_delta;
  3785. /**
  3786. * Presentation delay of current frame in units of AVCodecContext.time_base.
  3787. *
  3788. * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
  3789. * contain valid non-negative timestamp delta (presentation time of a frame
  3790. * must not lie in the past).
  3791. *
  3792. * This delay represents the difference between decoding and presentation
  3793. * time of the frame.
  3794. *
  3795. * For example, this corresponds to H.264 dpb_output_delay.
  3796. */
  3797. int pts_dts_delta;
  3798. /**
  3799. * Position of the packet in file.
  3800. *
  3801. * Analogous to cur_frame_pts/dts
  3802. */
  3803. int64_t cur_frame_pos[AV_PARSER_PTS_NB];
  3804. /**
  3805. * Byte position of currently parsed frame in stream.
  3806. */
  3807. int64_t pos;
  3808. /**
  3809. * Previous frame byte position.
  3810. */
  3811. int64_t last_pos;
  3812. } AVCodecParserContext;
  3813. typedef struct AVCodecParser {
  3814. int codec_ids[5]; /* several codec IDs are permitted */
  3815. int priv_data_size;
  3816. int (*parser_init)(AVCodecParserContext *s);
  3817. int (*parser_parse)(AVCodecParserContext *s,
  3818. AVCodecContext *avctx,
  3819. const uint8_t **poutbuf, int *poutbuf_size,
  3820. const uint8_t *buf, int buf_size);
  3821. void (*parser_close)(AVCodecParserContext *s);
  3822. int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
  3823. struct AVCodecParser *next;
  3824. } AVCodecParser;
  3825. AVCodecParser *av_parser_next(AVCodecParser *c);
  3826. void av_register_codec_parser(AVCodecParser *parser);
  3827. AVCodecParserContext *av_parser_init(int codec_id);
  3828. /**
  3829. * Parse a packet.
  3830. *
  3831. * @param s parser context.
  3832. * @param avctx codec context.
  3833. * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
  3834. * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
  3835. * @param buf input buffer.
  3836. * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
  3837. * @param pts input presentation timestamp.
  3838. * @param dts input decoding timestamp.
  3839. * @param pos input byte position in stream.
  3840. * @return the number of bytes of the input bitstream used.
  3841. *
  3842. * Example:
  3843. * @code
  3844. * while(in_len){
  3845. * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
  3846. * in_data, in_len,
  3847. * pts, dts, pos);
  3848. * in_data += len;
  3849. * in_len -= len;
  3850. *
  3851. * if(size)
  3852. * decode_frame(data, size);
  3853. * }
  3854. * @endcode
  3855. */
  3856. int av_parser_parse2(AVCodecParserContext *s,
  3857. AVCodecContext *avctx,
  3858. uint8_t **poutbuf, int *poutbuf_size,
  3859. const uint8_t *buf, int buf_size,
  3860. int64_t pts, int64_t dts,
  3861. int64_t pos);
  3862. int av_parser_change(AVCodecParserContext *s,
  3863. AVCodecContext *avctx,
  3864. uint8_t **poutbuf, int *poutbuf_size,
  3865. const uint8_t *buf, int buf_size, int keyframe);
  3866. void av_parser_close(AVCodecParserContext *s);
  3867. typedef struct AVBitStreamFilterContext {
  3868. void *priv_data;
  3869. struct AVBitStreamFilter *filter;
  3870. AVCodecParserContext *parser;
  3871. struct AVBitStreamFilterContext *next;
  3872. } AVBitStreamFilterContext;
  3873. typedef struct AVBitStreamFilter {
  3874. const char *name;
  3875. int priv_data_size;
  3876. int (*filter)(AVBitStreamFilterContext *bsfc,
  3877. AVCodecContext *avctx, const char *args,
  3878. uint8_t **poutbuf, int *poutbuf_size,
  3879. const uint8_t *buf, int buf_size, int keyframe);
  3880. void (*close)(AVBitStreamFilterContext *bsfc);
  3881. struct AVBitStreamFilter *next;
  3882. } AVBitStreamFilter;
  3883. void av_register_bitstream_filter(AVBitStreamFilter *bsf);
  3884. AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
  3885. int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
  3886. AVCodecContext *avctx, const char *args,
  3887. uint8_t **poutbuf, int *poutbuf_size,
  3888. const uint8_t *buf, int buf_size, int keyframe);
  3889. void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
  3890. AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
  3891. /* memory */
  3892. /**
  3893. * Reallocate the given block if it is not large enough, otherwise do nothing.
  3894. *
  3895. * @see av_realloc
  3896. */
  3897. void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
  3898. /**
  3899. * Allocate a buffer, reusing the given one if large enough.
  3900. *
  3901. * Contrary to av_fast_realloc the current buffer contents might not be
  3902. * preserved and on error the old buffer is freed, thus no special
  3903. * handling to avoid memleaks is necessary.
  3904. *
  3905. * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
  3906. * @param size size of the buffer *ptr points to
  3907. * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
  3908. * *size 0 if an error occurred.
  3909. */
  3910. void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
  3911. /**
  3912. * Copy image src to dst. Wraps av_picture_data_copy() above.
  3913. */
  3914. void av_picture_copy(AVPicture *dst, const AVPicture *src,
  3915. enum PixelFormat pix_fmt, int width, int height);
  3916. /**
  3917. * Crop image top and left side.
  3918. */
  3919. int av_picture_crop(AVPicture *dst, const AVPicture *src,
  3920. enum PixelFormat pix_fmt, int top_band, int left_band);
  3921. /**
  3922. * Pad image.
  3923. */
  3924. int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
  3925. int padtop, int padbottom, int padleft, int padright, int *color);
  3926. /**
  3927. * Encode extradata length to a buffer. Used by xiph codecs.
  3928. *
  3929. * @param s buffer to write to; must be at least (v/255+1) bytes long
  3930. * @param v size of extradata in bytes
  3931. * @return number of bytes written to the buffer.
  3932. */
  3933. unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
  3934. /**
  3935. * Logs a generic warning message about a missing feature. This function is
  3936. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  3937. * only, and would normally not be used by applications.
  3938. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  3939. * a pointer to an AVClass struct
  3940. * @param[in] feature string containing the name of the missing feature
  3941. * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
  3942. * If want_sample is non-zero, additional verbage will be added to the log
  3943. * message which tells the user how to report samples to the development
  3944. * mailing list.
  3945. */
  3946. void av_log_missing_feature(void *avc, const char *feature, int want_sample);
  3947. /**
  3948. * Log a generic warning message asking for a sample. This function is
  3949. * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
  3950. * only, and would normally not be used by applications.
  3951. * @param[in] avc a pointer to an arbitrary struct of which the first field is
  3952. * a pointer to an AVClass struct
  3953. * @param[in] msg string containing an optional message, or NULL if no message
  3954. */
  3955. void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
  3956. /**
  3957. * Register the hardware accelerator hwaccel.
  3958. */
  3959. void av_register_hwaccel(AVHWAccel *hwaccel);
  3960. /**
  3961. * If hwaccel is NULL, returns the first registered hardware accelerator,
  3962. * if hwaccel is non-NULL, returns the next registered hardware accelerator
  3963. * after hwaccel, or NULL if hwaccel is the last one.
  3964. */
  3965. AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
  3966. /**
  3967. * Lock operation used by lockmgr
  3968. */
  3969. enum AVLockOp {
  3970. AV_LOCK_CREATE, ///< Create a mutex
  3971. AV_LOCK_OBTAIN, ///< Lock the mutex
  3972. AV_LOCK_RELEASE, ///< Unlock the mutex
  3973. AV_LOCK_DESTROY, ///< Free mutex resources
  3974. };
  3975. /**
  3976. * Register a user provided lock manager supporting the operations
  3977. * specified by AVLockOp. mutex points to a (void *) where the
  3978. * lockmgr should store/get a pointer to a user allocated mutex. It's
  3979. * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
  3980. *
  3981. * @param cb User defined callback. Note: FFmpeg may invoke calls to this
  3982. * callback during the call to av_lockmgr_register().
  3983. * Thus, the application must be prepared to handle that.
  3984. * If cb is set to NULL the lockmgr will be unregistered.
  3985. * Also note that during unregistration the previously registered
  3986. * lockmgr callback may also be invoked.
  3987. */
  3988. int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
  3989. /**
  3990. * Get the type of the given codec.
  3991. */
  3992. enum AVMediaType avcodec_get_type(enum CodecID codec_id);
  3993. /**
  3994. * Get the AVClass for AVCodecContext. It can be used in combination with
  3995. * AV_OPT_SEARCH_FAKE_OBJ for examining options.
  3996. *
  3997. * @see av_opt_find().
  3998. */
  3999. const AVClass *avcodec_get_class(void);
  4000. #endif /* AVCODEC_AVCODEC_H */