controls.xml 212 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478
  1. <section id="control">
  2. <title>User Controls</title>
  3. <para>Devices typically have a number of user-settable controls
  4. such as brightness, saturation and so on, which would be presented to
  5. the user on a graphical user interface. But, different devices
  6. will have different controls available, and furthermore, the range of
  7. possible values, and the default value will vary from device to
  8. device. The control ioctls provide the information and a mechanism to
  9. create a nice user interface for these controls that will work
  10. correctly with any device.</para>
  11. <para>All controls are accessed using an ID value. V4L2 defines
  12. several IDs for specific purposes. Drivers can also implement their
  13. own custom controls using <constant>V4L2_CID_PRIVATE_BASE</constant>
  14. <footnote><para>The use of <constant>V4L2_CID_PRIVATE_BASE</constant>
  15. is problematic because different drivers may use the same
  16. <constant>V4L2_CID_PRIVATE_BASE</constant> ID for different controls.
  17. This makes it hard to programatically set such controls since the meaning
  18. of the control with that ID is driver dependent. In order to resolve this
  19. drivers use unique IDs and the <constant>V4L2_CID_PRIVATE_BASE</constant>
  20. IDs are mapped to those unique IDs by the kernel. Consider these
  21. <constant>V4L2_CID_PRIVATE_BASE</constant> IDs as aliases to the real
  22. IDs.</para>
  23. <para>Many applications today still use the <constant>V4L2_CID_PRIVATE_BASE</constant>
  24. IDs instead of using &VIDIOC-QUERYCTRL; with the <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>
  25. flag to enumerate all IDs, so support for <constant>V4L2_CID_PRIVATE_BASE</constant>
  26. is still around.</para></footnote>
  27. and higher values. The pre-defined control IDs have the prefix
  28. <constant>V4L2_CID_</constant>, and are listed in <xref
  29. linkend="control-id" />. The ID is used when querying the attributes of
  30. a control, and when getting or setting the current value.</para>
  31. <para>Generally applications should present controls to the user
  32. without assumptions about their purpose. Each control comes with a
  33. name string the user is supposed to understand. When the purpose is
  34. non-intuitive the driver writer should provide a user manual, a user
  35. interface plug-in or a driver specific panel application. Predefined
  36. IDs were introduced to change a few controls programmatically, for
  37. example to mute a device during a channel switch.</para>
  38. <para>Drivers may enumerate different controls after switching
  39. the current video input or output, tuner or modulator, or audio input
  40. or output. Different in the sense of other bounds, another default and
  41. current value, step size or other menu items. A control with a certain
  42. <emphasis>custom</emphasis> ID can also change name and
  43. type.</para>
  44. <para>If a control is not applicable to the current configuration
  45. of the device (for example, it doesn't apply to the current video input)
  46. drivers set the <constant>V4L2_CTRL_FLAG_INACTIVE</constant> flag.</para>
  47. <para>Control values are stored globally, they do not
  48. change when switching except to stay within the reported bounds. They
  49. also do not change &eg; when the device is opened or closed, when the
  50. tuner radio frequency is changed or generally never without
  51. application request.</para>
  52. <para>V4L2 specifies an event mechanism to notify applications
  53. when controls change value (see &VIDIOC-SUBSCRIBE-EVENT;, event
  54. <constant>V4L2_EVENT_CTRL</constant>), panel applications might want to make
  55. use of that in order to always reflect the correct control value.</para>
  56. <para>
  57. All controls use machine endianness.
  58. </para>
  59. <table pgwide="1" frame="none" id="control-id">
  60. <title>Control IDs</title>
  61. <tgroup cols="3">
  62. &cs-def;
  63. <thead>
  64. <row>
  65. <entry>ID</entry>
  66. <entry>Type</entry>
  67. <entry>Description</entry>
  68. </row>
  69. </thead>
  70. <tbody valign="top">
  71. <row>
  72. <entry><constant>V4L2_CID_BASE</constant></entry>
  73. <entry></entry>
  74. <entry>First predefined ID, equal to
  75. <constant>V4L2_CID_BRIGHTNESS</constant>.</entry>
  76. </row>
  77. <row>
  78. <entry><constant>V4L2_CID_USER_BASE</constant></entry>
  79. <entry></entry>
  80. <entry>Synonym of <constant>V4L2_CID_BASE</constant>.</entry>
  81. </row>
  82. <row>
  83. <entry><constant>V4L2_CID_BRIGHTNESS</constant></entry>
  84. <entry>integer</entry>
  85. <entry>Picture brightness, or more precisely, the black
  86. level.</entry>
  87. </row>
  88. <row>
  89. <entry><constant>V4L2_CID_CONTRAST</constant></entry>
  90. <entry>integer</entry>
  91. <entry>Picture contrast or luma gain.</entry>
  92. </row>
  93. <row>
  94. <entry><constant>V4L2_CID_SATURATION</constant></entry>
  95. <entry>integer</entry>
  96. <entry>Picture color saturation or chroma gain.</entry>
  97. </row>
  98. <row>
  99. <entry><constant>V4L2_CID_HUE</constant></entry>
  100. <entry>integer</entry>
  101. <entry>Hue or color balance.</entry>
  102. </row>
  103. <row>
  104. <entry><constant>V4L2_CID_AUDIO_VOLUME</constant></entry>
  105. <entry>integer</entry>
  106. <entry>Overall audio volume. Note some drivers also
  107. provide an OSS or ALSA mixer interface.</entry>
  108. </row>
  109. <row>
  110. <entry><constant>V4L2_CID_AUDIO_BALANCE</constant></entry>
  111. <entry>integer</entry>
  112. <entry>Audio stereo balance. Minimum corresponds to all
  113. the way left, maximum to right.</entry>
  114. </row>
  115. <row>
  116. <entry><constant>V4L2_CID_AUDIO_BASS</constant></entry>
  117. <entry>integer</entry>
  118. <entry>Audio bass adjustment.</entry>
  119. </row>
  120. <row>
  121. <entry><constant>V4L2_CID_AUDIO_TREBLE</constant></entry>
  122. <entry>integer</entry>
  123. <entry>Audio treble adjustment.</entry>
  124. </row>
  125. <row>
  126. <entry><constant>V4L2_CID_AUDIO_MUTE</constant></entry>
  127. <entry>boolean</entry>
  128. <entry>Mute audio, &ie; set the volume to zero, however
  129. without affecting <constant>V4L2_CID_AUDIO_VOLUME</constant>. Like
  130. ALSA drivers, V4L2 drivers must mute at load time to avoid excessive
  131. noise. Actually the entire device should be reset to a low power
  132. consumption state.</entry>
  133. </row>
  134. <row>
  135. <entry><constant>V4L2_CID_AUDIO_LOUDNESS</constant></entry>
  136. <entry>boolean</entry>
  137. <entry>Loudness mode (bass boost).</entry>
  138. </row>
  139. <row>
  140. <entry><constant>V4L2_CID_BLACK_LEVEL</constant></entry>
  141. <entry>integer</entry>
  142. <entry>Another name for brightness (not a synonym of
  143. <constant>V4L2_CID_BRIGHTNESS</constant>). This control is deprecated
  144. and should not be used in new drivers and applications.</entry>
  145. </row>
  146. <row>
  147. <entry><constant>V4L2_CID_AUTO_WHITE_BALANCE</constant></entry>
  148. <entry>boolean</entry>
  149. <entry>Automatic white balance (cameras).</entry>
  150. </row>
  151. <row>
  152. <entry><constant>V4L2_CID_DO_WHITE_BALANCE</constant></entry>
  153. <entry>button</entry>
  154. <entry>This is an action control. When set (the value is
  155. ignored), the device will do a white balance and then hold the current
  156. setting. Contrast this with the boolean
  157. <constant>V4L2_CID_AUTO_WHITE_BALANCE</constant>, which, when
  158. activated, keeps adjusting the white balance.</entry>
  159. </row>
  160. <row>
  161. <entry><constant>V4L2_CID_RED_BALANCE</constant></entry>
  162. <entry>integer</entry>
  163. <entry>Red chroma balance.</entry>
  164. </row>
  165. <row>
  166. <entry><constant>V4L2_CID_BLUE_BALANCE</constant></entry>
  167. <entry>integer</entry>
  168. <entry>Blue chroma balance.</entry>
  169. </row>
  170. <row>
  171. <entry><constant>V4L2_CID_GAMMA</constant></entry>
  172. <entry>integer</entry>
  173. <entry>Gamma adjust.</entry>
  174. </row>
  175. <row>
  176. <entry><constant>V4L2_CID_WHITENESS</constant></entry>
  177. <entry>integer</entry>
  178. <entry>Whiteness for grey-scale devices. This is a synonym
  179. for <constant>V4L2_CID_GAMMA</constant>. This control is deprecated
  180. and should not be used in new drivers and applications.</entry>
  181. </row>
  182. <row>
  183. <entry><constant>V4L2_CID_EXPOSURE</constant></entry>
  184. <entry>integer</entry>
  185. <entry>Exposure (cameras). [Unit?]</entry>
  186. </row>
  187. <row>
  188. <entry><constant>V4L2_CID_AUTOGAIN</constant></entry>
  189. <entry>boolean</entry>
  190. <entry>Automatic gain/exposure control.</entry>
  191. </row>
  192. <row>
  193. <entry><constant>V4L2_CID_GAIN</constant></entry>
  194. <entry>integer</entry>
  195. <entry>Gain control.</entry>
  196. </row>
  197. <row>
  198. <entry><constant>V4L2_CID_HFLIP</constant></entry>
  199. <entry>boolean</entry>
  200. <entry>Mirror the picture horizontally.</entry>
  201. </row>
  202. <row>
  203. <entry><constant>V4L2_CID_VFLIP</constant></entry>
  204. <entry>boolean</entry>
  205. <entry>Mirror the picture vertically.</entry>
  206. </row>
  207. <row id="v4l2-power-line-frequency">
  208. <entry><constant>V4L2_CID_POWER_LINE_FREQUENCY</constant></entry>
  209. <entry>enum</entry>
  210. <entry>Enables a power line frequency filter to avoid
  211. flicker. Possible values for <constant>enum v4l2_power_line_frequency</constant> are:
  212. <constant>V4L2_CID_POWER_LINE_FREQUENCY_DISABLED</constant> (0),
  213. <constant>V4L2_CID_POWER_LINE_FREQUENCY_50HZ</constant> (1),
  214. <constant>V4L2_CID_POWER_LINE_FREQUENCY_60HZ</constant> (2) and
  215. <constant>V4L2_CID_POWER_LINE_FREQUENCY_AUTO</constant> (3).</entry>
  216. </row>
  217. <row>
  218. <entry><constant>V4L2_CID_HUE_AUTO</constant></entry>
  219. <entry>boolean</entry>
  220. <entry>Enables automatic hue control by the device. The
  221. effect of setting <constant>V4L2_CID_HUE</constant> while automatic
  222. hue control is enabled is undefined, drivers should ignore such
  223. request.</entry>
  224. </row>
  225. <row>
  226. <entry><constant>V4L2_CID_WHITE_BALANCE_TEMPERATURE</constant></entry>
  227. <entry>integer</entry>
  228. <entry>This control specifies the white balance settings
  229. as a color temperature in Kelvin. A driver should have a minimum of
  230. 2800 (incandescent) to 6500 (daylight). For more information about
  231. color temperature see <ulink
  232. url="http://en.wikipedia.org/wiki/Color_temperature">Wikipedia</ulink>.</entry>
  233. </row>
  234. <row>
  235. <entry><constant>V4L2_CID_SHARPNESS</constant></entry>
  236. <entry>integer</entry>
  237. <entry>Adjusts the sharpness filters in a camera. The
  238. minimum value disables the filters, higher values give a sharper
  239. picture.</entry>
  240. </row>
  241. <row>
  242. <entry><constant>V4L2_CID_BACKLIGHT_COMPENSATION</constant></entry>
  243. <entry>integer</entry>
  244. <entry>Adjusts the backlight compensation in a camera. The
  245. minimum value disables backlight compensation.</entry>
  246. </row>
  247. <row>
  248. <entry><constant>V4L2_CID_CHROMA_AGC</constant></entry>
  249. <entry>boolean</entry>
  250. <entry>Chroma automatic gain control.</entry>
  251. </row>
  252. <row>
  253. <entry><constant>V4L2_CID_CHROMA_GAIN</constant></entry>
  254. <entry>integer</entry>
  255. <entry>Adjusts the Chroma gain control (for use when chroma AGC
  256. is disabled).</entry>
  257. </row>
  258. <row>
  259. <entry><constant>V4L2_CID_COLOR_KILLER</constant></entry>
  260. <entry>boolean</entry>
  261. <entry>Enable the color killer (&ie; force a black &amp; white image in case of a weak video signal).</entry>
  262. </row>
  263. <row id="v4l2-colorfx">
  264. <entry><constant>V4L2_CID_COLORFX</constant></entry>
  265. <entry>enum</entry>
  266. <entry>Selects a color effect. The following values are defined:
  267. </entry>
  268. </row><row>
  269. <entry></entry>
  270. <entry></entry>
  271. <entrytbl spanname="descr" cols="2">
  272. <tbody valign="top">
  273. <row>
  274. <entry><constant>V4L2_COLORFX_NONE</constant>&nbsp;</entry>
  275. <entry>Color effect is disabled.</entry>
  276. </row>
  277. <row>
  278. <entry><constant>V4L2_COLORFX_ANTIQUE</constant>&nbsp;</entry>
  279. <entry>An aging (old photo) effect.</entry>
  280. </row>
  281. <row>
  282. <entry><constant>V4L2_COLORFX_ART_FREEZE</constant>&nbsp;</entry>
  283. <entry>Frost color effect.</entry>
  284. </row>
  285. <row>
  286. <entry><constant>V4L2_COLORFX_AQUA</constant>&nbsp;</entry>
  287. <entry>Water color, cool tone.</entry>
  288. </row>
  289. <row>
  290. <entry><constant>V4L2_COLORFX_BW</constant>&nbsp;</entry>
  291. <entry>Black and white.</entry>
  292. </row>
  293. <row>
  294. <entry><constant>V4L2_COLORFX_EMBOSS</constant>&nbsp;</entry>
  295. <entry>Emboss, the highlights and shadows replace light/dark boundaries
  296. and low contrast areas are set to a gray background.</entry>
  297. </row>
  298. <row>
  299. <entry><constant>V4L2_COLORFX_GRASS_GREEN</constant>&nbsp;</entry>
  300. <entry>Grass green.</entry>
  301. </row>
  302. <row>
  303. <entry><constant>V4L2_COLORFX_NEGATIVE</constant>&nbsp;</entry>
  304. <entry>Negative.</entry>
  305. </row>
  306. <row>
  307. <entry><constant>V4L2_COLORFX_SEPIA</constant>&nbsp;</entry>
  308. <entry>Sepia tone.</entry>
  309. </row>
  310. <row>
  311. <entry><constant>V4L2_COLORFX_SKETCH</constant>&nbsp;</entry>
  312. <entry>Sketch.</entry>
  313. </row>
  314. <row>
  315. <entry><constant>V4L2_COLORFX_SKIN_WHITEN</constant>&nbsp;</entry>
  316. <entry>Skin whiten.</entry>
  317. </row>
  318. <row>
  319. <entry><constant>V4L2_COLORFX_SKY_BLUE</constant>&nbsp;</entry>
  320. <entry>Sky blue.</entry>
  321. </row>
  322. <row>
  323. <entry><constant>V4L2_COLORFX_SOLARIZATION</constant>&nbsp;</entry>
  324. <entry>Solarization, the image is partially reversed in tone,
  325. only color values above or below a certain threshold are inverted.
  326. </entry>
  327. </row>
  328. <row>
  329. <entry><constant>V4L2_COLORFX_SILHOUETTE</constant>&nbsp;</entry>
  330. <entry>Silhouette (outline).</entry>
  331. </row>
  332. <row>
  333. <entry><constant>V4L2_COLORFX_VIVID</constant>&nbsp;</entry>
  334. <entry>Vivid colors.</entry>
  335. </row>
  336. <row>
  337. <entry><constant>V4L2_COLORFX_SET_CBCR</constant>&nbsp;</entry>
  338. <entry>The Cb and Cr chroma components are replaced by fixed
  339. coefficients determined by <constant>V4L2_CID_COLORFX_CBCR</constant>
  340. control.</entry>
  341. </row>
  342. </tbody>
  343. </entrytbl>
  344. </row>
  345. <row>
  346. <entry><constant>V4L2_CID_COLORFX_CBCR</constant></entry>
  347. <entry>integer</entry>
  348. <entry>Determines the Cb and Cr coefficients for <constant>V4L2_COLORFX_SET_CBCR</constant>
  349. color effect. Bits [7:0] of the supplied 32 bit value are interpreted as
  350. Cr component, bits [15:8] as Cb component and bits [31:16] must be zero.
  351. </entry>
  352. </row>
  353. <row>
  354. <entry><constant>V4L2_CID_AUTOBRIGHTNESS</constant></entry>
  355. <entry>boolean</entry>
  356. <entry>Enable Automatic Brightness.</entry>
  357. </row>
  358. <row>
  359. <entry><constant>V4L2_CID_ROTATE</constant></entry>
  360. <entry>integer</entry>
  361. <entry>Rotates the image by specified angle. Common angles are 90,
  362. 270 and 180. Rotating the image to 90 and 270 will reverse the height
  363. and width of the display window. It is necessary to set the new height and
  364. width of the picture using the &VIDIOC-S-FMT; ioctl according to
  365. the rotation angle selected.</entry>
  366. </row>
  367. <row>
  368. <entry><constant>V4L2_CID_BG_COLOR</constant></entry>
  369. <entry>integer</entry>
  370. <entry>Sets the background color on the current output device.
  371. Background color needs to be specified in the RGB24 format. The
  372. supplied 32 bit value is interpreted as bits 0-7 Red color information,
  373. bits 8-15 Green color information, bits 16-23 Blue color
  374. information and bits 24-31 must be zero.</entry>
  375. </row>
  376. <row>
  377. <entry><constant>V4L2_CID_ILLUMINATORS_1</constant>
  378. <constant>V4L2_CID_ILLUMINATORS_2</constant></entry>
  379. <entry>boolean</entry>
  380. <entry>Switch on or off the illuminator 1 or 2 of the device
  381. (usually a microscope).</entry>
  382. </row>
  383. <row>
  384. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry>
  385. <entry>integer</entry>
  386. <entry>This is a read-only control that can be read by the application
  387. and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS.
  388. The value is the minimum number of CAPTURE buffers that is necessary for hardware
  389. to work.</entry>
  390. </row>
  391. <row>
  392. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_OUTPUT</constant></entry>
  393. <entry>integer</entry>
  394. <entry>This is a read-only control that can be read by the application
  395. and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS.
  396. The value is the minimum number of OUTPUT buffers that is necessary for hardware
  397. to work.</entry>
  398. </row>
  399. <row id="v4l2-alpha-component">
  400. <entry><constant>V4L2_CID_ALPHA_COMPONENT</constant></entry>
  401. <entry>integer</entry>
  402. <entry>Sets the alpha color component. When a capture device (or
  403. capture queue of a mem-to-mem device) produces a frame format that
  404. includes an alpha component
  405. (e.g. <link linkend="rgb-formats">packed RGB image formats</link>)
  406. and the alpha value is not defined by the device or the mem-to-mem
  407. input data this control lets you select the alpha component value of
  408. all pixels. When an output device (or output queue of a mem-to-mem
  409. device) consumes a frame format that doesn't include an alpha
  410. component and the device supports alpha channel processing this
  411. control lets you set the alpha component value of all pixels for
  412. further processing in the device.
  413. </entry>
  414. </row>
  415. <row>
  416. <entry><constant>V4L2_CID_LASTP1</constant></entry>
  417. <entry></entry>
  418. <entry>End of the predefined control IDs (currently
  419. <constant>V4L2_CID_ALPHA_COMPONENT</constant> + 1).</entry>
  420. </row>
  421. <row>
  422. <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry>
  423. <entry></entry>
  424. <entry>ID of the first custom (driver specific) control.
  425. Applications depending on particular custom controls should check the
  426. driver name and version, see <xref linkend="querycap" />.</entry>
  427. </row>
  428. </tbody>
  429. </tgroup>
  430. </table>
  431. <para>Applications can enumerate the available controls with the
  432. &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls, get and set a
  433. control value with the &VIDIOC-G-CTRL; and &VIDIOC-S-CTRL; ioctls.
  434. Drivers must implement <constant>VIDIOC_QUERYCTRL</constant>,
  435. <constant>VIDIOC_G_CTRL</constant> and
  436. <constant>VIDIOC_S_CTRL</constant> when the device has one or more
  437. controls, <constant>VIDIOC_QUERYMENU</constant> when it has one or
  438. more menu type controls.</para>
  439. <example id="enum_all_controls">
  440. <title>Enumerating all user controls</title>
  441. <programlisting>
  442. &v4l2-queryctrl; queryctrl;
  443. &v4l2-querymenu; querymenu;
  444. static void enumerate_menu(void)
  445. {
  446. printf(" Menu items:\n");
  447. memset(&amp;querymenu, 0, sizeof(querymenu));
  448. querymenu.id = queryctrl.id;
  449. for (querymenu.index = queryctrl.minimum;
  450. querymenu.index &lt;= queryctrl.maximum;
  451. querymenu.index++) {
  452. if (0 == ioctl(fd, &VIDIOC-QUERYMENU;, &amp;querymenu)) {
  453. printf(" %s\n", querymenu.name);
  454. }
  455. }
  456. }
  457. memset(&amp;queryctrl, 0, sizeof(queryctrl));
  458. for (queryctrl.id = V4L2_CID_BASE;
  459. queryctrl.id &lt; V4L2_CID_LASTP1;
  460. queryctrl.id++) {
  461. if (0 == ioctl(fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  462. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  463. continue;
  464. printf("Control %s\n", queryctrl.name);
  465. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  466. enumerate_menu();
  467. } else {
  468. if (errno == EINVAL)
  469. continue;
  470. perror("VIDIOC_QUERYCTRL");
  471. exit(EXIT_FAILURE);
  472. }
  473. }
  474. for (queryctrl.id = V4L2_CID_PRIVATE_BASE;;
  475. queryctrl.id++) {
  476. if (0 == ioctl(fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  477. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  478. continue;
  479. printf("Control %s\n", queryctrl.name);
  480. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  481. enumerate_menu();
  482. } else {
  483. if (errno == EINVAL)
  484. break;
  485. perror("VIDIOC_QUERYCTRL");
  486. exit(EXIT_FAILURE);
  487. }
  488. }
  489. </programlisting>
  490. </example>
  491. <example>
  492. <title>Enumerating all user controls (alternative)</title>
  493. <programlisting>
  494. memset(&amp;queryctrl, 0, sizeof(queryctrl));
  495. queryctrl.id = V4L2_CTRL_CLASS_USER | V4L2_CTRL_FLAG_NEXT_CTRL;
  496. while (0 == ioctl(fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  497. if (V4L2_CTRL_ID2CLASS(queryctrl.id) != V4L2_CTRL_CLASS_USER)
  498. break;
  499. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  500. continue;
  501. printf("Control %s\n", queryctrl.name);
  502. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  503. enumerate_menu();
  504. queryctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  505. }
  506. if (errno != EINVAL) {
  507. perror("VIDIOC_QUERYCTRL");
  508. exit(EXIT_FAILURE);
  509. }
  510. </programlisting>
  511. </example>
  512. <example>
  513. <title>Changing controls</title>
  514. <programlisting>
  515. &v4l2-queryctrl; queryctrl;
  516. &v4l2-control; control;
  517. memset(&amp;queryctrl, 0, sizeof(queryctrl));
  518. queryctrl.id = V4L2_CID_BRIGHTNESS;
  519. if (-1 == ioctl(fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  520. if (errno != EINVAL) {
  521. perror("VIDIOC_QUERYCTRL");
  522. exit(EXIT_FAILURE);
  523. } else {
  524. printf("V4L2_CID_BRIGHTNESS is not supported\n");
  525. }
  526. } else if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED) {
  527. printf("V4L2_CID_BRIGHTNESS is not supported\n");
  528. } else {
  529. memset(&amp;control, 0, sizeof (control));
  530. control.id = V4L2_CID_BRIGHTNESS;
  531. control.value = queryctrl.default_value;
  532. if (-1 == ioctl(fd, &VIDIOC-S-CTRL;, &amp;control)) {
  533. perror("VIDIOC_S_CTRL");
  534. exit(EXIT_FAILURE);
  535. }
  536. }
  537. memset(&amp;control, 0, sizeof(control));
  538. control.id = V4L2_CID_CONTRAST;
  539. if (0 == ioctl(fd, &VIDIOC-G-CTRL;, &amp;control)) {
  540. control.value += 1;
  541. /* The driver may clamp the value or return ERANGE, ignored here */
  542. if (-1 == ioctl(fd, &VIDIOC-S-CTRL;, &amp;control)
  543. &amp;&amp; errno != ERANGE) {
  544. perror("VIDIOC_S_CTRL");
  545. exit(EXIT_FAILURE);
  546. }
  547. /* Ignore if V4L2_CID_CONTRAST is unsupported */
  548. } else if (errno != EINVAL) {
  549. perror("VIDIOC_G_CTRL");
  550. exit(EXIT_FAILURE);
  551. }
  552. control.id = V4L2_CID_AUDIO_MUTE;
  553. control.value = 1; /* silence */
  554. /* Errors ignored */
  555. ioctl(fd, VIDIOC_S_CTRL, &amp;control);
  556. </programlisting>
  557. </example>
  558. </section>
  559. <section id="extended-controls">
  560. <title>Extended Controls</title>
  561. <section>
  562. <title>Introduction</title>
  563. <para>The control mechanism as originally designed was meant
  564. to be used for user settings (brightness, saturation, etc). However,
  565. it turned out to be a very useful model for implementing more
  566. complicated driver APIs where each driver implements only a subset of
  567. a larger API.</para>
  568. <para>The MPEG encoding API was the driving force behind
  569. designing and implementing this extended control mechanism: the MPEG
  570. standard is quite large and the currently supported hardware MPEG
  571. encoders each only implement a subset of this standard. Further more,
  572. many parameters relating to how the video is encoded into an MPEG
  573. stream are specific to the MPEG encoding chip since the MPEG standard
  574. only defines the format of the resulting MPEG stream, not how the
  575. video is actually encoded into that format.</para>
  576. <para>Unfortunately, the original control API lacked some
  577. features needed for these new uses and so it was extended into the
  578. (not terribly originally named) extended control API.</para>
  579. <para>Even though the MPEG encoding API was the first effort
  580. to use the Extended Control API, nowadays there are also other classes
  581. of Extended Controls, such as Camera Controls and FM Transmitter Controls.
  582. The Extended Controls API as well as all Extended Controls classes are
  583. described in the following text.</para>
  584. </section>
  585. <section>
  586. <title>The Extended Control API</title>
  587. <para>Three new ioctls are available: &VIDIOC-G-EXT-CTRLS;,
  588. &VIDIOC-S-EXT-CTRLS; and &VIDIOC-TRY-EXT-CTRLS;. These ioctls act on
  589. arrays of controls (as opposed to the &VIDIOC-G-CTRL; and
  590. &VIDIOC-S-CTRL; ioctls that act on a single control). This is needed
  591. since it is often required to atomically change several controls at
  592. once.</para>
  593. <para>Each of the new ioctls expects a pointer to a
  594. &v4l2-ext-controls;. This structure contains a pointer to the control
  595. array, a count of the number of controls in that array and a control
  596. class. Control classes are used to group similar controls into a
  597. single class. For example, control class
  598. <constant>V4L2_CTRL_CLASS_USER</constant> contains all user controls
  599. (&ie; all controls that can also be set using the old
  600. <constant>VIDIOC_S_CTRL</constant> ioctl). Control class
  601. <constant>V4L2_CTRL_CLASS_MPEG</constant> contains all controls
  602. relating to MPEG encoding, etc.</para>
  603. <para>All controls in the control array must belong to the
  604. specified control class. An error is returned if this is not the
  605. case.</para>
  606. <para>It is also possible to use an empty control array (count
  607. == 0) to check whether the specified control class is
  608. supported.</para>
  609. <para>The control array is a &v4l2-ext-control; array. The
  610. <structname>v4l2_ext_control</structname> structure is very similar to
  611. &v4l2-control;, except for the fact that it also allows for 64-bit
  612. values and pointers to be passed.</para>
  613. <para>Since the &v4l2-ext-control; supports pointers it is now
  614. also possible to have controls with compound types such as N-dimensional arrays
  615. and/or structures. You need to specify the <constant>V4L2_CTRL_FLAG_NEXT_COMPOUND</constant>
  616. when enumerating controls to actually be able to see such compound controls.
  617. In other words, these controls with compound types should only be used
  618. programmatically.</para>
  619. <para>Since such compound controls need to expose more information
  620. about themselves than is possible with &VIDIOC-QUERYCTRL; the
  621. &VIDIOC-QUERY-EXT-CTRL; ioctl was added. In particular, this ioctl gives
  622. the dimensions of the N-dimensional array if this control consists of more than
  623. one element.</para>
  624. <para>It is important to realize that due to the flexibility of
  625. controls it is necessary to check whether the control you want to set
  626. actually is supported in the driver and what the valid range of values
  627. is. So use the &VIDIOC-QUERYCTRL; (or &VIDIOC-QUERY-EXT-CTRL;) and
  628. &VIDIOC-QUERYMENU; ioctls to check this. Also note that it is possible
  629. that some of the menu indices in a control of type
  630. <constant>V4L2_CTRL_TYPE_MENU</constant> may not be supported
  631. (<constant>VIDIOC_QUERYMENU</constant> will return an error). A good
  632. example is the list of supported MPEG audio bitrates. Some drivers only
  633. support one or two bitrates, others support a wider range.</para>
  634. <para>
  635. All controls use machine endianness.
  636. </para>
  637. </section>
  638. <section>
  639. <title>Enumerating Extended Controls</title>
  640. <para>The recommended way to enumerate over the extended
  641. controls is by using &VIDIOC-QUERYCTRL; in combination with the
  642. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag:</para>
  643. <informalexample>
  644. <programlisting>
  645. &v4l2-queryctrl; qctrl;
  646. qctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL;
  647. while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  648. /* ... */
  649. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  650. }
  651. </programlisting>
  652. </informalexample>
  653. <para>The initial control ID is set to 0 ORed with the
  654. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag. The
  655. <constant>VIDIOC_QUERYCTRL</constant> ioctl will return the first
  656. control with a higher ID than the specified one. When no such controls
  657. are found an error is returned.</para>
  658. <para>If you want to get all controls within a specific control
  659. class, then you can set the initial
  660. <structfield>qctrl.id</structfield> value to the control class and add
  661. an extra check to break out of the loop when a control of another
  662. control class is found:</para>
  663. <informalexample>
  664. <programlisting>
  665. qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;
  666. while (0 == ioctl(fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  667. if (V4L2_CTRL_ID2CLASS(qctrl.id) != V4L2_CTRL_CLASS_MPEG)
  668. break;
  669. /* ... */
  670. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  671. }
  672. </programlisting>
  673. </informalexample>
  674. <para>The 32-bit <structfield>qctrl.id</structfield> value is
  675. subdivided into three bit ranges: the top 4 bits are reserved for
  676. flags (&eg; <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>) and are not
  677. actually part of the ID. The remaining 28 bits form the control ID, of
  678. which the most significant 12 bits define the control class and the
  679. least significant 16 bits identify the control within the control
  680. class. It is guaranteed that these last 16 bits are always non-zero
  681. for controls. The range of 0x1000 and up are reserved for
  682. driver-specific controls. The macro
  683. <constant>V4L2_CTRL_ID2CLASS(id)</constant> returns the control class
  684. ID based on a control ID.</para>
  685. <para>If the driver does not support extended controls, then
  686. <constant>VIDIOC_QUERYCTRL</constant> will fail when used in
  687. combination with <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>. In
  688. that case the old method of enumerating control should be used (see
  689. <xref linkend="enum_all_controls" />). But if it is supported, then it is guaranteed to enumerate over
  690. all controls, including driver-private controls.</para>
  691. </section>
  692. <section>
  693. <title>Creating Control Panels</title>
  694. <para>It is possible to create control panels for a graphical
  695. user interface where the user can select the various controls.
  696. Basically you will have to iterate over all controls using the method
  697. described above. Each control class starts with a control of type
  698. <constant>V4L2_CTRL_TYPE_CTRL_CLASS</constant>.
  699. <constant>VIDIOC_QUERYCTRL</constant> will return the name of this
  700. control class which can be used as the title of a tab page within a
  701. control panel.</para>
  702. <para>The flags field of &v4l2-queryctrl; also contains hints on
  703. the behavior of the control. See the &VIDIOC-QUERYCTRL; documentation
  704. for more details.</para>
  705. </section>
  706. <section id="mpeg-controls">
  707. <title>Codec Control Reference</title>
  708. <para>Below all controls within the Codec control class are
  709. described. First the generic controls, then controls specific for
  710. certain hardware.</para>
  711. <para>Note: These controls are applicable to all codecs and
  712. not just MPEG. The defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG
  713. as the controls were originally made for MPEG codecs and later
  714. extended to cover all encoding formats.</para>
  715. <section>
  716. <title>Generic Codec Controls</title>
  717. <table pgwide="1" frame="none" id="mpeg-control-id">
  718. <title>Codec Control IDs</title>
  719. <tgroup cols="4">
  720. <colspec colname="c1" colwidth="1*" />
  721. <colspec colname="c2" colwidth="6*" />
  722. <colspec colname="c3" colwidth="2*" />
  723. <colspec colname="c4" colwidth="6*" />
  724. <spanspec namest="c1" nameend="c2" spanname="id" />
  725. <spanspec namest="c2" nameend="c4" spanname="descr" />
  726. <thead>
  727. <row>
  728. <entry spanname="id" align="left">ID</entry>
  729. <entry align="left">Type</entry>
  730. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  731. </row>
  732. </thead>
  733. <tbody valign="top">
  734. <row><entry></entry></row>
  735. <row>
  736. <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant>&nbsp;</entry>
  737. <entry>class</entry>
  738. </row><row><entry spanname="descr">The Codec class
  739. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  740. description of this control class. This description can be used as the
  741. caption of a Tab page in a GUI, for example.</entry>
  742. </row>
  743. <row><entry></entry></row>
  744. <row id="v4l2-mpeg-stream-type">
  745. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant>&nbsp;</entry>
  746. <entry>enum&nbsp;v4l2_mpeg_stream_type</entry>
  747. </row><row><entry spanname="descr">The MPEG-1, -2 or -4
  748. output stream type. One cannot assume anything here. Each hardware
  749. MPEG encoder tends to support different subsets of the available MPEG
  750. stream types. This control is specific to multiplexed MPEG streams.
  751. The currently defined stream types are:</entry>
  752. </row>
  753. <row>
  754. <entrytbl spanname="descr" cols="2">
  755. <tbody valign="top">
  756. <row>
  757. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_PS</constant>&nbsp;</entry>
  758. <entry>MPEG-2 program stream</entry>
  759. </row>
  760. <row>
  761. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_TS</constant>&nbsp;</entry>
  762. <entry>MPEG-2 transport stream</entry>
  763. </row>
  764. <row>
  765. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_SS</constant>&nbsp;</entry>
  766. <entry>MPEG-1 system stream</entry>
  767. </row>
  768. <row>
  769. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_DVD</constant>&nbsp;</entry>
  770. <entry>MPEG-2 DVD-compatible stream</entry>
  771. </row>
  772. <row>
  773. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_VCD</constant>&nbsp;</entry>
  774. <entry>MPEG-1 VCD-compatible stream</entry>
  775. </row>
  776. <row>
  777. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD</constant>&nbsp;</entry>
  778. <entry>MPEG-2 SVCD-compatible stream</entry>
  779. </row>
  780. </tbody>
  781. </entrytbl>
  782. </row>
  783. <row><entry></entry></row>
  784. <row>
  785. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PMT</constant>&nbsp;</entry>
  786. <entry>integer</entry>
  787. </row><row><entry spanname="descr">Program Map Table
  788. Packet ID for the MPEG transport stream (default 16)</entry>
  789. </row>
  790. <row><entry></entry></row>
  791. <row>
  792. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_AUDIO</constant>&nbsp;</entry>
  793. <entry>integer</entry>
  794. </row><row><entry spanname="descr">Audio Packet ID for
  795. the MPEG transport stream (default 256)</entry>
  796. </row>
  797. <row><entry></entry></row>
  798. <row>
  799. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_VIDEO</constant>&nbsp;</entry>
  800. <entry>integer</entry>
  801. </row><row><entry spanname="descr">Video Packet ID for
  802. the MPEG transport stream (default 260)</entry>
  803. </row>
  804. <row><entry></entry></row>
  805. <row>
  806. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PCR</constant>&nbsp;</entry>
  807. <entry>integer</entry>
  808. </row><row><entry spanname="descr">Packet ID for the
  809. MPEG transport stream carrying PCR fields (default 259)</entry>
  810. </row>
  811. <row><entry></entry></row>
  812. <row>
  813. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_AUDIO</constant>&nbsp;</entry>
  814. <entry>integer</entry>
  815. </row><row><entry spanname="descr">Audio ID for MPEG
  816. PES</entry>
  817. </row>
  818. <row><entry></entry></row>
  819. <row>
  820. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_VIDEO</constant>&nbsp;</entry>
  821. <entry>integer</entry>
  822. </row><row><entry spanname="descr">Video ID for MPEG
  823. PES</entry>
  824. </row>
  825. <row><entry></entry></row>
  826. <row id="v4l2-mpeg-stream-vbi-fmt">
  827. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant>&nbsp;</entry>
  828. <entry>enum&nbsp;v4l2_mpeg_stream_vbi_fmt</entry>
  829. </row><row><entry spanname="descr">Some cards can embed
  830. VBI data (&eg; Closed Caption, Teletext) into the MPEG stream. This
  831. control selects whether VBI data should be embedded, and if so, what
  832. embedding method should be used. The list of possible VBI formats
  833. depends on the driver. The currently defined VBI format types
  834. are:</entry>
  835. </row>
  836. <row>
  837. <entrytbl spanname="descr" cols="2">
  838. <tbody valign="top">
  839. <row>
  840. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_NONE</constant>&nbsp;</entry>
  841. <entry>No VBI in the MPEG stream</entry>
  842. </row>
  843. <row>
  844. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_IVTV</constant>&nbsp;</entry>
  845. <entry>VBI in private packets, IVTV format (documented
  846. in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.vbi</filename>)</entry>
  847. </row>
  848. </tbody>
  849. </entrytbl>
  850. </row>
  851. <row><entry></entry></row>
  852. <row id="v4l2-mpeg-audio-sampling-freq">
  853. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant>&nbsp;</entry>
  854. <entry>enum&nbsp;v4l2_mpeg_audio_sampling_freq</entry>
  855. </row><row><entry spanname="descr">MPEG Audio sampling
  856. frequency. Possible values are:</entry>
  857. </row>
  858. <row>
  859. <entrytbl spanname="descr" cols="2">
  860. <tbody valign="top">
  861. <row>
  862. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100</constant>&nbsp;</entry>
  863. <entry>44.1 kHz</entry>
  864. </row>
  865. <row>
  866. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000</constant>&nbsp;</entry>
  867. <entry>48 kHz</entry>
  868. </row>
  869. <row>
  870. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000</constant>&nbsp;</entry>
  871. <entry>32 kHz</entry>
  872. </row>
  873. </tbody>
  874. </entrytbl>
  875. </row>
  876. <row><entry></entry></row>
  877. <row id="v4l2-mpeg-audio-encoding">
  878. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant>&nbsp;</entry>
  879. <entry>enum&nbsp;v4l2_mpeg_audio_encoding</entry>
  880. </row><row><entry spanname="descr">MPEG Audio encoding.
  881. This control is specific to multiplexed MPEG streams.
  882. Possible values are:</entry>
  883. </row>
  884. <row>
  885. <entrytbl spanname="descr" cols="2">
  886. <tbody valign="top">
  887. <row>
  888. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_1</constant>&nbsp;</entry>
  889. <entry>MPEG-1/2 Layer I encoding</entry>
  890. </row>
  891. <row>
  892. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_2</constant>&nbsp;</entry>
  893. <entry>MPEG-1/2 Layer II encoding</entry>
  894. </row>
  895. <row>
  896. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_3</constant>&nbsp;</entry>
  897. <entry>MPEG-1/2 Layer III encoding</entry>
  898. </row>
  899. <row>
  900. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AAC</constant>&nbsp;</entry>
  901. <entry>MPEG-2/4 AAC (Advanced Audio Coding)</entry>
  902. </row>
  903. <row>
  904. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AC3</constant>&nbsp;</entry>
  905. <entry>AC-3 aka ATSC A/52 encoding</entry>
  906. </row>
  907. </tbody>
  908. </entrytbl>
  909. </row>
  910. <row><entry></entry></row>
  911. <row id="v4l2-mpeg-audio-l1-bitrate">
  912. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant>&nbsp;</entry>
  913. <entry>enum&nbsp;v4l2_mpeg_audio_l1_bitrate</entry>
  914. </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate.
  915. Possible values are:</entry>
  916. </row>
  917. <row>
  918. <entrytbl spanname="descr" cols="2">
  919. <tbody valign="top">
  920. <row>
  921. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_32K</constant>&nbsp;</entry>
  922. <entry>32 kbit/s</entry></row>
  923. <row>
  924. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_64K</constant>&nbsp;</entry>
  925. <entry>64 kbit/s</entry>
  926. </row>
  927. <row>
  928. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_96K</constant>&nbsp;</entry>
  929. <entry>96 kbit/s</entry>
  930. </row>
  931. <row>
  932. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_128K</constant>&nbsp;</entry>
  933. <entry>128 kbit/s</entry>
  934. </row>
  935. <row>
  936. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_160K</constant>&nbsp;</entry>
  937. <entry>160 kbit/s</entry>
  938. </row>
  939. <row>
  940. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_192K</constant>&nbsp;</entry>
  941. <entry>192 kbit/s</entry>
  942. </row>
  943. <row>
  944. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_224K</constant>&nbsp;</entry>
  945. <entry>224 kbit/s</entry>
  946. </row>
  947. <row>
  948. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_256K</constant>&nbsp;</entry>
  949. <entry>256 kbit/s</entry>
  950. </row>
  951. <row>
  952. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_288K</constant>&nbsp;</entry>
  953. <entry>288 kbit/s</entry>
  954. </row>
  955. <row>
  956. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_320K</constant>&nbsp;</entry>
  957. <entry>320 kbit/s</entry>
  958. </row>
  959. <row>
  960. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_352K</constant>&nbsp;</entry>
  961. <entry>352 kbit/s</entry>
  962. </row>
  963. <row>
  964. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_384K</constant>&nbsp;</entry>
  965. <entry>384 kbit/s</entry>
  966. </row>
  967. <row>
  968. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_416K</constant>&nbsp;</entry>
  969. <entry>416 kbit/s</entry>
  970. </row>
  971. <row>
  972. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_448K</constant>&nbsp;</entry>
  973. <entry>448 kbit/s</entry>
  974. </row>
  975. </tbody>
  976. </entrytbl>
  977. </row>
  978. <row><entry></entry></row>
  979. <row id="v4l2-mpeg-audio-l2-bitrate">
  980. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant>&nbsp;</entry>
  981. <entry>enum&nbsp;v4l2_mpeg_audio_l2_bitrate</entry>
  982. </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate.
  983. Possible values are:</entry>
  984. </row>
  985. <row>
  986. <entrytbl spanname="descr" cols="2">
  987. <tbody valign="top">
  988. <row>
  989. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_32K</constant>&nbsp;</entry>
  990. <entry>32 kbit/s</entry>
  991. </row>
  992. <row>
  993. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_48K</constant>&nbsp;</entry>
  994. <entry>48 kbit/s</entry>
  995. </row>
  996. <row>
  997. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_56K</constant>&nbsp;</entry>
  998. <entry>56 kbit/s</entry>
  999. </row>
  1000. <row>
  1001. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_64K</constant>&nbsp;</entry>
  1002. <entry>64 kbit/s</entry>
  1003. </row>
  1004. <row>
  1005. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_80K</constant>&nbsp;</entry>
  1006. <entry>80 kbit/s</entry>
  1007. </row>
  1008. <row>
  1009. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_96K</constant>&nbsp;</entry>
  1010. <entry>96 kbit/s</entry>
  1011. </row>
  1012. <row>
  1013. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_112K</constant>&nbsp;</entry>
  1014. <entry>112 kbit/s</entry>
  1015. </row>
  1016. <row>
  1017. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_128K</constant>&nbsp;</entry>
  1018. <entry>128 kbit/s</entry>
  1019. </row>
  1020. <row>
  1021. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_160K</constant>&nbsp;</entry>
  1022. <entry>160 kbit/s</entry>
  1023. </row>
  1024. <row>
  1025. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_192K</constant>&nbsp;</entry>
  1026. <entry>192 kbit/s</entry>
  1027. </row>
  1028. <row>
  1029. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_224K</constant>&nbsp;</entry>
  1030. <entry>224 kbit/s</entry>
  1031. </row>
  1032. <row>
  1033. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_256K</constant>&nbsp;</entry>
  1034. <entry>256 kbit/s</entry>
  1035. </row>
  1036. <row>
  1037. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_320K</constant>&nbsp;</entry>
  1038. <entry>320 kbit/s</entry>
  1039. </row>
  1040. <row>
  1041. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_384K</constant>&nbsp;</entry>
  1042. <entry>384 kbit/s</entry>
  1043. </row>
  1044. </tbody>
  1045. </entrytbl>
  1046. </row>
  1047. <row><entry></entry></row>
  1048. <row id="v4l2-mpeg-audio-l3-bitrate">
  1049. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant>&nbsp;</entry>
  1050. <entry>enum&nbsp;v4l2_mpeg_audio_l3_bitrate</entry>
  1051. </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate.
  1052. Possible values are:</entry>
  1053. </row>
  1054. <row>
  1055. <entrytbl spanname="descr" cols="2">
  1056. <tbody valign="top">
  1057. <row>
  1058. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_32K</constant>&nbsp;</entry>
  1059. <entry>32 kbit/s</entry>
  1060. </row>
  1061. <row>
  1062. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_40K</constant>&nbsp;</entry>
  1063. <entry>40 kbit/s</entry>
  1064. </row>
  1065. <row>
  1066. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_48K</constant>&nbsp;</entry>
  1067. <entry>48 kbit/s</entry>
  1068. </row>
  1069. <row>
  1070. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_56K</constant>&nbsp;</entry>
  1071. <entry>56 kbit/s</entry>
  1072. </row>
  1073. <row>
  1074. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_64K</constant>&nbsp;</entry>
  1075. <entry>64 kbit/s</entry>
  1076. </row>
  1077. <row>
  1078. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_80K</constant>&nbsp;</entry>
  1079. <entry>80 kbit/s</entry>
  1080. </row>
  1081. <row>
  1082. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_96K</constant>&nbsp;</entry>
  1083. <entry>96 kbit/s</entry>
  1084. </row>
  1085. <row>
  1086. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_112K</constant>&nbsp;</entry>
  1087. <entry>112 kbit/s</entry>
  1088. </row>
  1089. <row>
  1090. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_128K</constant>&nbsp;</entry>
  1091. <entry>128 kbit/s</entry>
  1092. </row>
  1093. <row>
  1094. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_160K</constant>&nbsp;</entry>
  1095. <entry>160 kbit/s</entry>
  1096. </row>
  1097. <row>
  1098. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_192K</constant>&nbsp;</entry>
  1099. <entry>192 kbit/s</entry>
  1100. </row>
  1101. <row>
  1102. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_224K</constant>&nbsp;</entry>
  1103. <entry>224 kbit/s</entry>
  1104. </row>
  1105. <row>
  1106. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_256K</constant>&nbsp;</entry>
  1107. <entry>256 kbit/s</entry>
  1108. </row>
  1109. <row>
  1110. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_320K</constant>&nbsp;</entry>
  1111. <entry>320 kbit/s</entry>
  1112. </row>
  1113. </tbody>
  1114. </entrytbl>
  1115. </row>
  1116. <row><entry></entry></row>
  1117. <row>
  1118. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AAC_BITRATE</constant>&nbsp;</entry>
  1119. <entry>integer</entry>
  1120. </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry>
  1121. </row>
  1122. <row><entry></entry></row>
  1123. <row id="v4l2-mpeg-audio-ac3-bitrate">
  1124. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant>&nbsp;</entry>
  1125. <entry>enum&nbsp;v4l2_mpeg_audio_ac3_bitrate</entry>
  1126. </row><row><entry spanname="descr">AC-3 bitrate.
  1127. Possible values are:</entry>
  1128. </row>
  1129. <row>
  1130. <entrytbl spanname="descr" cols="2">
  1131. <tbody valign="top">
  1132. <row>
  1133. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_32K</constant>&nbsp;</entry>
  1134. <entry>32 kbit/s</entry>
  1135. </row>
  1136. <row>
  1137. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_40K</constant>&nbsp;</entry>
  1138. <entry>40 kbit/s</entry>
  1139. </row>
  1140. <row>
  1141. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_48K</constant>&nbsp;</entry>
  1142. <entry>48 kbit/s</entry>
  1143. </row>
  1144. <row>
  1145. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_56K</constant>&nbsp;</entry>
  1146. <entry>56 kbit/s</entry>
  1147. </row>
  1148. <row>
  1149. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_64K</constant>&nbsp;</entry>
  1150. <entry>64 kbit/s</entry>
  1151. </row>
  1152. <row>
  1153. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_80K</constant>&nbsp;</entry>
  1154. <entry>80 kbit/s</entry>
  1155. </row>
  1156. <row>
  1157. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_96K</constant>&nbsp;</entry>
  1158. <entry>96 kbit/s</entry>
  1159. </row>
  1160. <row>
  1161. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_112K</constant>&nbsp;</entry>
  1162. <entry>112 kbit/s</entry>
  1163. </row>
  1164. <row>
  1165. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_128K</constant>&nbsp;</entry>
  1166. <entry>128 kbit/s</entry>
  1167. </row>
  1168. <row>
  1169. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_160K</constant>&nbsp;</entry>
  1170. <entry>160 kbit/s</entry>
  1171. </row>
  1172. <row>
  1173. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_192K</constant>&nbsp;</entry>
  1174. <entry>192 kbit/s</entry>
  1175. </row>
  1176. <row>
  1177. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_224K</constant>&nbsp;</entry>
  1178. <entry>224 kbit/s</entry>
  1179. </row>
  1180. <row>
  1181. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_256K</constant>&nbsp;</entry>
  1182. <entry>256 kbit/s</entry>
  1183. </row>
  1184. <row>
  1185. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_320K</constant>&nbsp;</entry>
  1186. <entry>320 kbit/s</entry>
  1187. </row>
  1188. <row>
  1189. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_384K</constant>&nbsp;</entry>
  1190. <entry>384 kbit/s</entry>
  1191. </row>
  1192. <row>
  1193. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_448K</constant>&nbsp;</entry>
  1194. <entry>448 kbit/s</entry>
  1195. </row>
  1196. <row>
  1197. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_512K</constant>&nbsp;</entry>
  1198. <entry>512 kbit/s</entry>
  1199. </row>
  1200. <row>
  1201. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_576K</constant>&nbsp;</entry>
  1202. <entry>576 kbit/s</entry>
  1203. </row>
  1204. <row>
  1205. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_640K</constant>&nbsp;</entry>
  1206. <entry>640 kbit/s</entry>
  1207. </row>
  1208. </tbody>
  1209. </entrytbl>
  1210. </row>
  1211. <row><entry></entry></row>
  1212. <row id="v4l2-mpeg-audio-mode">
  1213. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant>&nbsp;</entry>
  1214. <entry>enum&nbsp;v4l2_mpeg_audio_mode</entry>
  1215. </row><row><entry spanname="descr">MPEG Audio mode.
  1216. Possible values are:</entry>
  1217. </row>
  1218. <row>
  1219. <entrytbl spanname="descr" cols="2">
  1220. <tbody valign="top">
  1221. <row>
  1222. <entry><constant>V4L2_MPEG_AUDIO_MODE_STEREO</constant>&nbsp;</entry>
  1223. <entry>Stereo</entry>
  1224. </row>
  1225. <row>
  1226. <entry><constant>V4L2_MPEG_AUDIO_MODE_JOINT_STEREO</constant>&nbsp;</entry>
  1227. <entry>Joint Stereo</entry>
  1228. </row>
  1229. <row>
  1230. <entry><constant>V4L2_MPEG_AUDIO_MODE_DUAL</constant>&nbsp;</entry>
  1231. <entry>Bilingual</entry>
  1232. </row>
  1233. <row>
  1234. <entry><constant>V4L2_MPEG_AUDIO_MODE_MONO</constant>&nbsp;</entry>
  1235. <entry>Mono</entry>
  1236. </row>
  1237. </tbody>
  1238. </entrytbl>
  1239. </row>
  1240. <row><entry></entry></row>
  1241. <row id="v4l2-mpeg-audio-mode-extension">
  1242. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant>&nbsp;</entry>
  1243. <entry>enum&nbsp;v4l2_mpeg_audio_mode_extension</entry>
  1244. </row><row><entry spanname="descr">Joint Stereo
  1245. audio mode extension. In Layer I and II they indicate which subbands
  1246. are in intensity stereo. All other subbands are coded in stereo. Layer
  1247. III is not (yet) supported. Possible values
  1248. are:</entry>
  1249. </row>
  1250. <row>
  1251. <entrytbl spanname="descr" cols="2">
  1252. <tbody valign="top">
  1253. <row>
  1254. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4</constant>&nbsp;</entry>
  1255. <entry>Subbands 4-31 in intensity stereo</entry>
  1256. </row>
  1257. <row>
  1258. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8</constant>&nbsp;</entry>
  1259. <entry>Subbands 8-31 in intensity stereo</entry>
  1260. </row>
  1261. <row>
  1262. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12</constant>&nbsp;</entry>
  1263. <entry>Subbands 12-31 in intensity stereo</entry>
  1264. </row>
  1265. <row>
  1266. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16</constant>&nbsp;</entry>
  1267. <entry>Subbands 16-31 in intensity stereo</entry>
  1268. </row>
  1269. </tbody>
  1270. </entrytbl>
  1271. </row>
  1272. <row><entry></entry></row>
  1273. <row id="v4l2-mpeg-audio-emphasis">
  1274. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant>&nbsp;</entry>
  1275. <entry>enum&nbsp;v4l2_mpeg_audio_emphasis</entry>
  1276. </row><row><entry spanname="descr">Audio Emphasis.
  1277. Possible values are:</entry>
  1278. </row>
  1279. <row>
  1280. <entrytbl spanname="descr" cols="2">
  1281. <tbody valign="top">
  1282. <row>
  1283. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_NONE</constant>&nbsp;</entry>
  1284. <entry>None</entry>
  1285. </row>
  1286. <row>
  1287. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS</constant>&nbsp;</entry>
  1288. <entry>50/15 microsecond emphasis</entry>
  1289. </row>
  1290. <row>
  1291. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17</constant>&nbsp;</entry>
  1292. <entry>CCITT J.17</entry>
  1293. </row>
  1294. </tbody>
  1295. </entrytbl>
  1296. </row>
  1297. <row><entry></entry></row>
  1298. <row id="v4l2-mpeg-audio-crc">
  1299. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant>&nbsp;</entry>
  1300. <entry>enum&nbsp;v4l2_mpeg_audio_crc</entry>
  1301. </row><row><entry spanname="descr">CRC method. Possible
  1302. values are:</entry>
  1303. </row>
  1304. <row>
  1305. <entrytbl spanname="descr" cols="2">
  1306. <tbody valign="top">
  1307. <row>
  1308. <entry><constant>V4L2_MPEG_AUDIO_CRC_NONE</constant>&nbsp;</entry>
  1309. <entry>None</entry>
  1310. </row>
  1311. <row>
  1312. <entry><constant>V4L2_MPEG_AUDIO_CRC_CRC16</constant>&nbsp;</entry>
  1313. <entry>16 bit parity check</entry>
  1314. </row>
  1315. </tbody>
  1316. </entrytbl>
  1317. </row>
  1318. <row><entry></entry></row>
  1319. <row>
  1320. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant>&nbsp;</entry>
  1321. <entry>boolean</entry>
  1322. </row><row><entry spanname="descr">Mutes the audio when
  1323. capturing. This is not done by muting audio hardware, which can still
  1324. produce a slight hiss, but in the encoder itself, guaranteeing a fixed
  1325. and reproducible audio bitstream. 0 = unmuted, 1 = muted.</entry>
  1326. </row>
  1327. <row><entry></entry></row>
  1328. <row id="v4l2-mpeg-audio-dec-playback">
  1329. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK</constant>&nbsp;</entry>
  1330. <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
  1331. </row><row><entry spanname="descr">Determines how monolingual audio should be played back.
  1332. Possible values are:</entry>
  1333. </row>
  1334. <row>
  1335. <entrytbl spanname="descr" cols="2">
  1336. <tbody valign="top">
  1337. <row>
  1338. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO</constant>&nbsp;</entry>
  1339. <entry>Automatically determines the best playback mode.</entry>
  1340. </row>
  1341. <row>
  1342. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO</constant>&nbsp;</entry>
  1343. <entry>Stereo playback.</entry>
  1344. </row>
  1345. <row>
  1346. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT</constant>&nbsp;</entry>
  1347. <entry>Left channel playback.</entry>
  1348. </row>
  1349. <row>
  1350. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT</constant>&nbsp;</entry>
  1351. <entry>Right channel playback.</entry>
  1352. </row>
  1353. <row>
  1354. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO</constant>&nbsp;</entry>
  1355. <entry>Mono playback.</entry>
  1356. </row>
  1357. <row>
  1358. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO</constant>&nbsp;</entry>
  1359. <entry>Stereo playback with swapped left and right channels.</entry>
  1360. </row>
  1361. </tbody>
  1362. </entrytbl>
  1363. </row>
  1364. <row><entry></entry></row>
  1365. <row id="v4l2-mpeg-audio-dec-multilingual-playback">
  1366. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK</constant>&nbsp;</entry>
  1367. <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
  1368. </row><row><entry spanname="descr">Determines how multilingual audio should be played back.</entry>
  1369. </row>
  1370. <row><entry></entry></row>
  1371. <row id="v4l2-mpeg-video-encoding">
  1372. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant>&nbsp;</entry>
  1373. <entry>enum&nbsp;v4l2_mpeg_video_encoding</entry>
  1374. </row><row><entry spanname="descr">MPEG Video encoding
  1375. method. This control is specific to multiplexed MPEG streams.
  1376. Possible values are:</entry>
  1377. </row>
  1378. <row>
  1379. <entrytbl spanname="descr" cols="2">
  1380. <tbody valign="top">
  1381. <row>
  1382. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_1</constant>&nbsp;</entry>
  1383. <entry>MPEG-1 Video encoding</entry>
  1384. </row>
  1385. <row>
  1386. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_2</constant>&nbsp;</entry>
  1387. <entry>MPEG-2 Video encoding</entry>
  1388. </row>
  1389. <row>
  1390. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC</constant>&nbsp;</entry>
  1391. <entry>MPEG-4 AVC (H.264) Video encoding</entry>
  1392. </row>
  1393. </tbody>
  1394. </entrytbl>
  1395. </row>
  1396. <row><entry></entry></row>
  1397. <row id="v4l2-mpeg-video-aspect">
  1398. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant>&nbsp;</entry>
  1399. <entry>enum&nbsp;v4l2_mpeg_video_aspect</entry>
  1400. </row><row><entry spanname="descr">Video aspect.
  1401. Possible values are:</entry>
  1402. </row>
  1403. <row>
  1404. <entrytbl spanname="descr" cols="2">
  1405. <tbody valign="top">
  1406. <row>
  1407. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_1x1</constant>&nbsp;</entry>
  1408. </row>
  1409. <row>
  1410. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_4x3</constant>&nbsp;</entry>
  1411. </row>
  1412. <row>
  1413. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_16x9</constant>&nbsp;</entry>
  1414. </row>
  1415. <row>
  1416. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_221x100</constant>&nbsp;</entry>
  1417. </row>
  1418. </tbody>
  1419. </entrytbl>
  1420. </row>
  1421. <row><entry></entry></row>
  1422. <row>
  1423. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_B_FRAMES</constant>&nbsp;</entry>
  1424. <entry>integer</entry>
  1425. </row><row><entry spanname="descr">Number of B-Frames
  1426. (default 2)</entry>
  1427. </row>
  1428. <row><entry></entry></row>
  1429. <row>
  1430. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_SIZE</constant>&nbsp;</entry>
  1431. <entry>integer</entry>
  1432. </row><row><entry spanname="descr">GOP size (default
  1433. 12)</entry>
  1434. </row>
  1435. <row><entry></entry></row>
  1436. <row>
  1437. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant>&nbsp;</entry>
  1438. <entry>boolean</entry>
  1439. </row><row><entry spanname="descr">GOP closure (default
  1440. 1)</entry>
  1441. </row>
  1442. <row><entry></entry></row>
  1443. <row>
  1444. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant>&nbsp;</entry>
  1445. <entry>boolean</entry>
  1446. </row><row><entry spanname="descr">Enable 3:2 pulldown
  1447. (default 0)</entry>
  1448. </row>
  1449. <row><entry></entry></row>
  1450. <row id="v4l2-mpeg-video-bitrate-mode">
  1451. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant>&nbsp;</entry>
  1452. <entry>enum&nbsp;v4l2_mpeg_video_bitrate_mode</entry>
  1453. </row><row><entry spanname="descr">Video bitrate mode.
  1454. Possible values are:</entry>
  1455. </row>
  1456. <row>
  1457. <entrytbl spanname="descr" cols="2">
  1458. <tbody valign="top">
  1459. <row>
  1460. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_VBR</constant>&nbsp;</entry>
  1461. <entry>Variable bitrate</entry>
  1462. </row>
  1463. <row>
  1464. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_CBR</constant>&nbsp;</entry>
  1465. <entry>Constant bitrate</entry>
  1466. </row>
  1467. </tbody>
  1468. </entrytbl>
  1469. </row>
  1470. <row><entry></entry></row>
  1471. <row>
  1472. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE</constant>&nbsp;</entry>
  1473. <entry>integer</entry>
  1474. </row><row><entry spanname="descr">Video bitrate in bits
  1475. per second.</entry>
  1476. </row>
  1477. <row><entry></entry></row>
  1478. <row>
  1479. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_PEAK</constant>&nbsp;</entry>
  1480. <entry>integer</entry>
  1481. </row><row><entry spanname="descr">Peak video bitrate in
  1482. bits per second. Must be larger or equal to the average video bitrate.
  1483. It is ignored if the video bitrate mode is set to constant
  1484. bitrate.</entry>
  1485. </row>
  1486. <row><entry></entry></row>
  1487. <row>
  1488. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION</constant>&nbsp;</entry>
  1489. <entry>integer</entry>
  1490. </row><row><entry spanname="descr">For every captured
  1491. frame, skip this many subsequent frames (default 0).</entry>
  1492. </row>
  1493. <row><entry></entry></row>
  1494. <row>
  1495. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant>&nbsp;</entry>
  1496. <entry>boolean</entry>
  1497. </row>
  1498. <row><entry spanname="descr">"Mutes" the video to a
  1499. fixed color when capturing. This is useful for testing, to produce a
  1500. fixed video bitstream. 0 = unmuted, 1 = muted.</entry>
  1501. </row>
  1502. <row><entry></entry></row>
  1503. <row>
  1504. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE_YUV</constant>&nbsp;</entry>
  1505. <entry>integer</entry>
  1506. </row><row><entry spanname="descr">Sets the "mute" color
  1507. of the video. The supplied 32-bit integer is interpreted as follows (bit
  1508. 0 = least significant bit):</entry>
  1509. </row>
  1510. <row>
  1511. <entrytbl spanname="descr" cols="2">
  1512. <tbody valign="top">
  1513. <row>
  1514. <entry>Bit 0:7</entry>
  1515. <entry>V chrominance information</entry>
  1516. </row>
  1517. <row>
  1518. <entry>Bit 8:15</entry>
  1519. <entry>U chrominance information</entry>
  1520. </row>
  1521. <row>
  1522. <entry>Bit 16:23</entry>
  1523. <entry>Y luminance information</entry>
  1524. </row>
  1525. <row>
  1526. <entry>Bit 24:31</entry>
  1527. <entry>Must be zero.</entry>
  1528. </row>
  1529. </tbody>
  1530. </entrytbl>
  1531. </row>
  1532. <row><entry></entry></row>
  1533. <row id="v4l2-mpeg-video-dec-pts">
  1534. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_PTS</constant>&nbsp;</entry>
  1535. <entry>integer64</entry>
  1536. </row><row><entry spanname="descr">This read-only control returns the
  1537. 33-bit video Presentation Time Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of
  1538. the currently displayed frame. This is the same PTS as is used in &VIDIOC-DECODER-CMD;.</entry>
  1539. </row>
  1540. <row><entry></entry></row>
  1541. <row id="v4l2-mpeg-video-dec-frame">
  1542. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_FRAME</constant>&nbsp;</entry>
  1543. <entry>integer64</entry>
  1544. </row><row><entry spanname="descr">This read-only control returns the
  1545. frame counter of the frame that is currently displayed (decoded). This value is reset to 0 whenever
  1546. the decoder is started.</entry>
  1547. </row>
  1548. <row><entry></entry></row>
  1549. <row>
  1550. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE</constant>&nbsp;</entry>
  1551. <entry>boolean</entry>
  1552. </row>
  1553. <row><entry spanname="descr">If enabled the decoder expects to receive a single slice per buffer, otherwise
  1554. the decoder expects a single frame in per buffer. Applicable to the decoder, all codecs.
  1555. </entry>
  1556. </row>
  1557. <row><entry></entry></row>
  1558. <row>
  1559. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE</constant>&nbsp;</entry>
  1560. <entry>boolean</entry>
  1561. </row>
  1562. <row><entry spanname="descr">Enable writing sample aspect ratio in the Video Usability Information.
  1563. Applicable to the H264 encoder.</entry>
  1564. </row>
  1565. <row><entry></entry></row>
  1566. <row id="v4l2-mpeg-video-h264-vui-sar-idc">
  1567. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC</constant>&nbsp;</entry>
  1568. <entry>enum&nbsp;v4l2_mpeg_video_h264_vui_sar_idc</entry>
  1569. </row>
  1570. <row><entry spanname="descr">VUI sample aspect ratio indicator for H.264 encoding. The value
  1571. is defined in the table E-1 in the standard. Applicable to the H264 encoder.</entry>
  1572. </row>
  1573. <row>
  1574. <entrytbl spanname="descr" cols="2">
  1575. <tbody valign="top">
  1576. <row>
  1577. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED</constant>&nbsp;</entry>
  1578. <entry>Unspecified</entry>
  1579. </row>
  1580. <row>
  1581. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1</constant>&nbsp;</entry>
  1582. <entry>1x1</entry>
  1583. </row>
  1584. <row>
  1585. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11</constant>&nbsp;</entry>
  1586. <entry>12x11</entry>
  1587. </row>
  1588. <row>
  1589. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11</constant>&nbsp;</entry>
  1590. <entry>10x11</entry>
  1591. </row>
  1592. <row>
  1593. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11</constant>&nbsp;</entry>
  1594. <entry>16x11</entry>
  1595. </row>
  1596. <row>
  1597. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33</constant>&nbsp;</entry>
  1598. <entry>40x33</entry>
  1599. </row>
  1600. <row>
  1601. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11</constant>&nbsp;</entry>
  1602. <entry>24x11</entry>
  1603. </row>
  1604. <row>
  1605. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11</constant>&nbsp;</entry>
  1606. <entry>20x11</entry>
  1607. </row>
  1608. <row>
  1609. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11</constant>&nbsp;</entry>
  1610. <entry>32x11</entry>
  1611. </row>
  1612. <row>
  1613. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33</constant>&nbsp;</entry>
  1614. <entry>80x33</entry>
  1615. </row>
  1616. <row>
  1617. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11</constant>&nbsp;</entry>
  1618. <entry>18x11</entry>
  1619. </row>
  1620. <row>
  1621. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11</constant>&nbsp;</entry>
  1622. <entry>15x11</entry>
  1623. </row>
  1624. <row>
  1625. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33</constant>&nbsp;</entry>
  1626. <entry>64x33</entry>
  1627. </row>
  1628. <row>
  1629. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99</constant>&nbsp;</entry>
  1630. <entry>160x99</entry>
  1631. </row>
  1632. <row>
  1633. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3</constant>&nbsp;</entry>
  1634. <entry>4x3</entry>
  1635. </row>
  1636. <row>
  1637. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2</constant>&nbsp;</entry>
  1638. <entry>3x2</entry>
  1639. </row>
  1640. <row>
  1641. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1</constant>&nbsp;</entry>
  1642. <entry>2x1</entry>
  1643. </row>
  1644. <row>
  1645. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED</constant>&nbsp;</entry>
  1646. <entry>Extended SAR</entry>
  1647. </row>
  1648. </tbody>
  1649. </entrytbl>
  1650. </row>
  1651. <row><entry></entry></row>
  1652. <row>
  1653. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH</constant>&nbsp;</entry>
  1654. <entry>integer</entry>
  1655. </row>
  1656. <row><entry spanname="descr">Extended sample aspect ratio width for H.264 VUI encoding.
  1657. Applicable to the H264 encoder.</entry>
  1658. </row>
  1659. <row><entry></entry></row>
  1660. <row>
  1661. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT</constant>&nbsp;</entry>
  1662. <entry>integer</entry>
  1663. </row>
  1664. <row><entry spanname="descr">Extended sample aspect ratio height for H.264 VUI encoding.
  1665. Applicable to the H264 encoder.</entry>
  1666. </row>
  1667. <row><entry></entry></row>
  1668. <row id="v4l2-mpeg-video-h264-level">
  1669. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LEVEL</constant>&nbsp;</entry>
  1670. <entry>enum&nbsp;v4l2_mpeg_video_h264_level</entry>
  1671. </row>
  1672. <row><entry spanname="descr">The level information for the H264 video elementary stream.
  1673. Applicable to the H264 encoder.
  1674. Possible values are:</entry>
  1675. </row>
  1676. <row>
  1677. <entrytbl spanname="descr" cols="2">
  1678. <tbody valign="top">
  1679. <row>
  1680. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_0</constant>&nbsp;</entry>
  1681. <entry>Level 1.0</entry>
  1682. </row>
  1683. <row>
  1684. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1B</constant>&nbsp;</entry>
  1685. <entry>Level 1B</entry>
  1686. </row>
  1687. <row>
  1688. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_1</constant>&nbsp;</entry>
  1689. <entry>Level 1.1</entry>
  1690. </row>
  1691. <row>
  1692. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_2</constant>&nbsp;</entry>
  1693. <entry>Level 1.2</entry>
  1694. </row>
  1695. <row>
  1696. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_3</constant>&nbsp;</entry>
  1697. <entry>Level 1.3</entry>
  1698. </row>
  1699. <row>
  1700. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_0</constant>&nbsp;</entry>
  1701. <entry>Level 2.0</entry>
  1702. </row>
  1703. <row>
  1704. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_1</constant>&nbsp;</entry>
  1705. <entry>Level 2.1</entry>
  1706. </row>
  1707. <row>
  1708. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_2</constant>&nbsp;</entry>
  1709. <entry>Level 2.2</entry>
  1710. </row>
  1711. <row>
  1712. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_0</constant>&nbsp;</entry>
  1713. <entry>Level 3.0</entry>
  1714. </row>
  1715. <row>
  1716. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_1</constant>&nbsp;</entry>
  1717. <entry>Level 3.1</entry>
  1718. </row>
  1719. <row>
  1720. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_2</constant>&nbsp;</entry>
  1721. <entry>Level 3.2</entry>
  1722. </row>
  1723. <row>
  1724. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_0</constant>&nbsp;</entry>
  1725. <entry>Level 4.0</entry>
  1726. </row>
  1727. <row>
  1728. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_1</constant>&nbsp;</entry>
  1729. <entry>Level 4.1</entry>
  1730. </row>
  1731. <row>
  1732. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_2</constant>&nbsp;</entry>
  1733. <entry>Level 4.2</entry>
  1734. </row>
  1735. <row>
  1736. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_0</constant>&nbsp;</entry>
  1737. <entry>Level 5.0</entry>
  1738. </row>
  1739. <row>
  1740. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_1</constant>&nbsp;</entry>
  1741. <entry>Level 5.1</entry>
  1742. </row>
  1743. </tbody>
  1744. </entrytbl>
  1745. </row>
  1746. <row><entry></entry></row>
  1747. <row id="v4l2-mpeg-video-mpeg4-level">
  1748. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL</constant>&nbsp;</entry>
  1749. <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_level</entry>
  1750. </row>
  1751. <row><entry spanname="descr">The level information for the MPEG4 elementary stream.
  1752. Applicable to the MPEG4 encoder.
  1753. Possible values are:</entry>
  1754. </row>
  1755. <row>
  1756. <entrytbl spanname="descr" cols="2">
  1757. <tbody valign="top">
  1758. <row>
  1759. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0</constant>&nbsp;</entry>
  1760. <entry>Level 0</entry>
  1761. </row>
  1762. <row>
  1763. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0B</constant>&nbsp;</entry>
  1764. <entry>Level 0b</entry>
  1765. </row>
  1766. <row>
  1767. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_1</constant>&nbsp;</entry>
  1768. <entry>Level 1</entry>
  1769. </row>
  1770. <row>
  1771. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_2</constant>&nbsp;</entry>
  1772. <entry>Level 2</entry>
  1773. </row>
  1774. <row>
  1775. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3</constant>&nbsp;</entry>
  1776. <entry>Level 3</entry>
  1777. </row>
  1778. <row>
  1779. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3B</constant>&nbsp;</entry>
  1780. <entry>Level 3b</entry>
  1781. </row>
  1782. <row>
  1783. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_4</constant>&nbsp;</entry>
  1784. <entry>Level 4</entry>
  1785. </row>
  1786. <row>
  1787. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_5</constant>&nbsp;</entry>
  1788. <entry>Level 5</entry>
  1789. </row>
  1790. </tbody>
  1791. </entrytbl>
  1792. </row>
  1793. <row><entry></entry></row>
  1794. <row id="v4l2-mpeg-video-h264-profile">
  1795. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_PROFILE</constant>&nbsp;</entry>
  1796. <entry>enum&nbsp;v4l2_mpeg_video_h264_profile</entry>
  1797. </row>
  1798. <row><entry spanname="descr">The profile information for H264.
  1799. Applicable to the H264 encoder.
  1800. Possible values are:</entry>
  1801. </row>
  1802. <row>
  1803. <entrytbl spanname="descr" cols="2">
  1804. <tbody valign="top">
  1805. <row>
  1806. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE</constant>&nbsp;</entry>
  1807. <entry>Baseline profile</entry>
  1808. </row>
  1809. <row>
  1810. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE</constant>&nbsp;</entry>
  1811. <entry>Constrained Baseline profile</entry>
  1812. </row>
  1813. <row>
  1814. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MAIN</constant>&nbsp;</entry>
  1815. <entry>Main profile</entry>
  1816. </row>
  1817. <row>
  1818. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED</constant>&nbsp;</entry>
  1819. <entry>Extended profile</entry>
  1820. </row>
  1821. <row>
  1822. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH</constant>&nbsp;</entry>
  1823. <entry>High profile</entry>
  1824. </row>
  1825. <row>
  1826. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10</constant>&nbsp;</entry>
  1827. <entry>High 10 profile</entry>
  1828. </row>
  1829. <row>
  1830. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422</constant>&nbsp;</entry>
  1831. <entry>High 422 profile</entry>
  1832. </row>
  1833. <row>
  1834. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE</constant>&nbsp;</entry>
  1835. <entry>High 444 Predictive profile</entry>
  1836. </row>
  1837. <row>
  1838. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA</constant>&nbsp;</entry>
  1839. <entry>High 10 Intra profile</entry>
  1840. </row>
  1841. <row>
  1842. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA</constant>&nbsp;</entry>
  1843. <entry>High 422 Intra profile</entry>
  1844. </row>
  1845. <row>
  1846. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA</constant>&nbsp;</entry>
  1847. <entry>High 444 Intra profile</entry>
  1848. </row>
  1849. <row>
  1850. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA</constant>&nbsp;</entry>
  1851. <entry>CAVLC 444 Intra profile</entry>
  1852. </row>
  1853. <row>
  1854. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE</constant>&nbsp;</entry>
  1855. <entry>Scalable Baseline profile</entry>
  1856. </row>
  1857. <row>
  1858. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH</constant>&nbsp;</entry>
  1859. <entry>Scalable High profile</entry>
  1860. </row>
  1861. <row>
  1862. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA</constant>&nbsp;</entry>
  1863. <entry>Scalable High Intra profile</entry>
  1864. </row>
  1865. <row>
  1866. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH</constant>&nbsp;</entry>
  1867. <entry>Stereo High profile</entry>
  1868. </row>
  1869. <row>
  1870. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH</constant>&nbsp;</entry>
  1871. <entry>Multiview High profile</entry>
  1872. </row>
  1873. </tbody>
  1874. </entrytbl>
  1875. </row>
  1876. <row><entry></entry></row>
  1877. <row id="v4l2-mpeg-video-mpeg4-profile">
  1878. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE</constant>&nbsp;</entry>
  1879. <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_profile</entry>
  1880. </row>
  1881. <row><entry spanname="descr">The profile information for MPEG4.
  1882. Applicable to the MPEG4 encoder.
  1883. Possible values are:</entry>
  1884. </row>
  1885. <row>
  1886. <entrytbl spanname="descr" cols="2">
  1887. <tbody valign="top">
  1888. <row>
  1889. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE</constant>&nbsp;</entry>
  1890. <entry>Simple profile</entry>
  1891. </row>
  1892. <row>
  1893. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_SIMPLE</constant>&nbsp;</entry>
  1894. <entry>Advanced Simple profile</entry>
  1895. </row>
  1896. <row>
  1897. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_CORE</constant>&nbsp;</entry>
  1898. <entry>Core profile</entry>
  1899. </row>
  1900. <row>
  1901. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE_SCALABLE</constant>&nbsp;</entry>
  1902. <entry>Simple Scalable profile</entry>
  1903. </row>
  1904. <row>
  1905. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_CODING_EFFICIENCY</constant>&nbsp;</entry>
  1906. <entry></entry>
  1907. </row>
  1908. </tbody>
  1909. </entrytbl>
  1910. </row>
  1911. <row><entry></entry></row>
  1912. <row>
  1913. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MAX_REF_PIC</constant>&nbsp;</entry>
  1914. <entry>integer</entry>
  1915. </row>
  1916. <row><entry spanname="descr">The maximum number of reference pictures used for encoding.
  1917. Applicable to the encoder.
  1918. </entry>
  1919. </row>
  1920. <row><entry></entry></row>
  1921. <row id="v4l2-mpeg-video-multi-slice-mode">
  1922. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant>&nbsp;</entry>
  1923. <entry>enum&nbsp;v4l2_mpeg_video_multi_slice_mode</entry>
  1924. </row>
  1925. <row><entry spanname="descr">Determines how the encoder should handle division of frame into slices.
  1926. Applicable to the encoder.
  1927. Possible values are:</entry>
  1928. </row>
  1929. <row>
  1930. <entrytbl spanname="descr" cols="2">
  1931. <tbody valign="top">
  1932. <row>
  1933. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE</constant>&nbsp;</entry>
  1934. <entry>Single slice per frame.</entry>
  1935. </row>
  1936. <row>
  1937. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>&nbsp;</entry>
  1938. <entry>Multiple slices with set maximum number of macroblocks per slice.</entry>
  1939. </row>
  1940. <row>
  1941. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>&nbsp;</entry>
  1942. <entry>Multiple slice with set maximum size in bytes per slice.</entry>
  1943. </row>
  1944. </tbody>
  1945. </entrytbl>
  1946. </row>
  1947. <row><entry></entry></row>
  1948. <row>
  1949. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB</constant>&nbsp;</entry>
  1950. <entry>integer</entry>
  1951. </row>
  1952. <row><entry spanname="descr">The maximum number of macroblocks in a slice. Used when
  1953. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>.
  1954. Applicable to the encoder.</entry>
  1955. </row>
  1956. <row><entry></entry></row>
  1957. <row>
  1958. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES</constant>&nbsp;</entry>
  1959. <entry>integer</entry>
  1960. </row>
  1961. <row><entry spanname="descr">The maximum size of a slice in bytes. Used when
  1962. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>.
  1963. Applicable to the encoder.</entry>
  1964. </row>
  1965. <row><entry></entry></row>
  1966. <row id="v4l2-mpeg-video-h264-loop-filter-mode">
  1967. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE</constant>&nbsp;</entry>
  1968. <entry>enum&nbsp;v4l2_mpeg_video_h264_loop_filter_mode</entry>
  1969. </row>
  1970. <row><entry spanname="descr">Loop filter mode for H264 encoder.
  1971. Possible values are:</entry>
  1972. </row>
  1973. <row>
  1974. <entrytbl spanname="descr" cols="2">
  1975. <tbody valign="top">
  1976. <row>
  1977. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED</constant>&nbsp;</entry>
  1978. <entry>Loop filter is enabled.</entry>
  1979. </row>
  1980. <row>
  1981. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED</constant>&nbsp;</entry>
  1982. <entry>Loop filter is disabled.</entry>
  1983. </row>
  1984. <row>
  1985. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY</constant>&nbsp;</entry>
  1986. <entry>Loop filter is disabled at the slice boundary.</entry>
  1987. </row>
  1988. </tbody>
  1989. </entrytbl>
  1990. </row>
  1991. <row><entry></entry></row>
  1992. <row>
  1993. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA</constant>&nbsp;</entry>
  1994. <entry>integer</entry>
  1995. </row>
  1996. <row><entry spanname="descr">Loop filter alpha coefficient, defined in the H264 standard.
  1997. Applicable to the H264 encoder.</entry>
  1998. </row>
  1999. <row><entry></entry></row>
  2000. <row>
  2001. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA</constant>&nbsp;</entry>
  2002. <entry>integer</entry>
  2003. </row>
  2004. <row><entry spanname="descr">Loop filter beta coefficient, defined in the H264 standard.
  2005. Applicable to the H264 encoder.</entry>
  2006. </row>
  2007. <row><entry></entry></row>
  2008. <row id="v4l2-mpeg-video-h264-entropy-mode">
  2009. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE</constant>&nbsp;</entry>
  2010. <entry>enum&nbsp;v4l2_mpeg_video_h264_entropy_mode</entry>
  2011. </row>
  2012. <row><entry spanname="descr">Entropy coding mode for H264 - CABAC/CAVALC.
  2013. Applicable to the H264 encoder.
  2014. Possible values are:</entry>
  2015. </row>
  2016. <row>
  2017. <entrytbl spanname="descr" cols="2">
  2018. <tbody valign="top">
  2019. <row>
  2020. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC</constant>&nbsp;</entry>
  2021. <entry>Use CAVLC entropy coding.</entry>
  2022. </row>
  2023. <row>
  2024. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC</constant>&nbsp;</entry>
  2025. <entry>Use CABAC entropy coding.</entry>
  2026. </row>
  2027. </tbody>
  2028. </entrytbl>
  2029. </row>
  2030. <row><entry></entry></row>
  2031. <row>
  2032. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM</constant>&nbsp;</entry>
  2033. <entry>boolean</entry>
  2034. </row>
  2035. <row><entry spanname="descr">Enable 8X8 transform for H264. Applicable to the H264 encoder.</entry>
  2036. </row>
  2037. <row><entry></entry></row>
  2038. <row>
  2039. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB</constant>&nbsp;</entry>
  2040. <entry>integer</entry>
  2041. </row>
  2042. <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks
  2043. refreshed every frame. Each frame a successive set of macroblocks is refreshed until the cycle completes and starts from the
  2044. top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry>
  2045. </row>
  2046. <row><entry></entry></row>
  2047. <row>
  2048. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE</constant>&nbsp;</entry>
  2049. <entry>boolean</entry>
  2050. </row>
  2051. <row><entry spanname="descr">Frame level rate control enable.
  2052. If this control is disabled then the quantization parameter for each frame type is constant and set with appropriate controls
  2053. (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>).
  2054. If frame rate control is enabled then quantization parameter is adjusted to meet the chosen bitrate. Minimum and maximum value
  2055. for the quantization parameter can be set with appropriate controls (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>).
  2056. Applicable to encoders.</entry>
  2057. </row>
  2058. <row><entry></entry></row>
  2059. <row>
  2060. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>&nbsp;</entry>
  2061. <entry>boolean</entry>
  2062. </row>
  2063. <row><entry spanname="descr">Macroblock level rate control enable.
  2064. Applicable to the MPEG4 and H264 encoders.</entry>
  2065. </row>
  2066. <row><entry></entry></row>
  2067. <row>
  2068. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_QPEL</constant>&nbsp;</entry>
  2069. <entry>boolean</entry>
  2070. </row>
  2071. <row><entry spanname="descr">Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2072. </row>
  2073. <row><entry></entry></row>
  2074. <row>
  2075. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>&nbsp;</entry>
  2076. <entry>integer</entry>
  2077. </row>
  2078. <row><entry spanname="descr">Quantization parameter for an I frame for H263. Valid range: from 1 to 31.</entry>
  2079. </row>
  2080. <row><entry></entry></row>
  2081. <row>
  2082. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>&nbsp;</entry>
  2083. <entry>integer</entry>
  2084. </row>
  2085. <row><entry spanname="descr">Minimum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  2086. </row>
  2087. <row><entry></entry></row>
  2088. <row>
  2089. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MAX_QP</constant>&nbsp;</entry>
  2090. <entry>integer</entry>
  2091. </row>
  2092. <row><entry spanname="descr">Maximum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  2093. </row>
  2094. <row><entry></entry></row>
  2095. <row>
  2096. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP</constant>&nbsp;</entry>
  2097. <entry>integer</entry>
  2098. </row>
  2099. <row><entry spanname="descr">Quantization parameter for an P frame for H263. Valid range: from 1 to 31.</entry>
  2100. </row>
  2101. <row><entry></entry></row>
  2102. <row>
  2103. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP</constant>&nbsp;</entry>
  2104. <entry>integer</entry>
  2105. </row>
  2106. <row><entry spanname="descr">Quantization parameter for an B frame for H263. Valid range: from 1 to 31.</entry>
  2107. </row>
  2108. <row><entry></entry></row>
  2109. <row>
  2110. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP</constant>&nbsp;</entry>
  2111. <entry>integer</entry>
  2112. </row>
  2113. <row><entry spanname="descr">Quantization parameter for an I frame for H264. Valid range: from 0 to 51.</entry>
  2114. </row>
  2115. <row><entry></entry></row>
  2116. <row>
  2117. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MIN_QP</constant>&nbsp;</entry>
  2118. <entry>integer</entry>
  2119. </row>
  2120. <row><entry spanname="descr">Minimum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  2121. </row>
  2122. <row><entry></entry></row>
  2123. <row>
  2124. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MAX_QP</constant>&nbsp;</entry>
  2125. <entry>integer</entry>
  2126. </row>
  2127. <row><entry spanname="descr">Maximum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  2128. </row>
  2129. <row><entry></entry></row>
  2130. <row>
  2131. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP</constant>&nbsp;</entry>
  2132. <entry>integer</entry>
  2133. </row>
  2134. <row><entry spanname="descr">Quantization parameter for an P frame for H264. Valid range: from 0 to 51.</entry>
  2135. </row>
  2136. <row><entry></entry></row>
  2137. <row>
  2138. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP</constant>&nbsp;</entry>
  2139. <entry>integer</entry>
  2140. </row>
  2141. <row><entry spanname="descr">Quantization parameter for an B frame for H264. Valid range: from 0 to 51.</entry>
  2142. </row>
  2143. <row><entry></entry></row>
  2144. <row>
  2145. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP</constant>&nbsp;</entry>
  2146. <entry>integer</entry>
  2147. </row>
  2148. <row><entry spanname="descr">Quantization parameter for an I frame for MPEG4. Valid range: from 1 to 31.</entry>
  2149. </row>
  2150. <row><entry></entry></row>
  2151. <row>
  2152. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP</constant>&nbsp;</entry>
  2153. <entry>integer</entry>
  2154. </row>
  2155. <row><entry spanname="descr">Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  2156. </row>
  2157. <row><entry></entry></row>
  2158. <row>
  2159. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP</constant>&nbsp;</entry>
  2160. <entry>integer</entry>
  2161. </row>
  2162. <row><entry spanname="descr">Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  2163. </row>
  2164. <row><entry></entry></row>
  2165. <row>
  2166. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP</constant>&nbsp;</entry>
  2167. <entry>integer</entry>
  2168. </row>
  2169. <row><entry spanname="descr">Quantization parameter for an P frame for MPEG4. Valid range: from 1 to 31.</entry>
  2170. </row>
  2171. <row><entry></entry></row>
  2172. <row>
  2173. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP</constant>&nbsp;</entry>
  2174. <entry>integer</entry>
  2175. </row>
  2176. <row><entry spanname="descr">Quantization parameter for an B frame for MPEG4. Valid range: from 1 to 31.</entry>
  2177. </row>
  2178. <row><entry></entry></row>
  2179. <row>
  2180. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_SIZE</constant>&nbsp;</entry>
  2181. <entry>integer</entry>
  2182. </row>
  2183. <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip.
  2184. The VBV is defined in the standard as a mean to verify that the produced stream will be successfully decoded.
  2185. The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the
  2186. output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an
  2187. encoder or editing process may produce.".
  2188. Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry>
  2189. </row>
  2190. <row><entry></entry></row>
  2191. <row id="v4l2-mpeg-video-vbv-delay">
  2192. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_DELAY</constant>&nbsp;</entry>
  2193. <entry>integer</entry>
  2194. </row><row><entry spanname="descr">Sets the initial delay in milliseconds for
  2195. VBV buffer control.</entry>
  2196. </row>
  2197. <row><entry></entry></row>
  2198. <row id="v4l2-mpeg-video-hor-search-range">
  2199. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE</constant>&nbsp;</entry>
  2200. <entry>integer</entry>
  2201. </row>
  2202. <row><entry spanname="descr">Horizontal search range defines maximum horizontal search area in pixels
  2203. to search and match for the present Macroblock (MB) in the reference picture. This V4L2 control macro is used to set
  2204. horizontal search range for motion estimation module in video encoder.</entry>
  2205. </row>
  2206. <row><entry></entry></row>
  2207. <row id="v4l2-mpeg-video-vert-search-range">
  2208. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE</constant>&nbsp;</entry>
  2209. <entry>integer</entry>
  2210. </row>
  2211. <row><entry spanname="descr">Vertical search range defines maximum vertical search area in pixels
  2212. to search and match for the present Macroblock (MB) in the reference picture. This V4L2 control macro is used to set
  2213. vertical search range for motion estimation module in video encoder.</entry>
  2214. </row>
  2215. <row><entry></entry></row>
  2216. <row>
  2217. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE</constant>&nbsp;</entry>
  2218. <entry>integer</entry>
  2219. </row>
  2220. <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip.
  2221. The CPB is defined in the H264 standard as a mean to verify that the produced stream will be successfully decoded.
  2222. Applicable to the H264 encoder.</entry>
  2223. </row>
  2224. <row><entry></entry></row>
  2225. <row>
  2226. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_PERIOD</constant>&nbsp;</entry>
  2227. <entry>integer</entry>
  2228. </row>
  2229. <row><entry spanname="descr">Period between I-frames in the open GOP for H264. In case of an open GOP
  2230. this is the period between two I-frames. The period between IDR (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE control.
  2231. An IDR frame, which stands for Instantaneous Decoding Refresh is an I-frame after which no prior frames are
  2232. referenced. This means that a stream can be restarted from an IDR frame without the need to store or decode any
  2233. previous frames. Applicable to the H264 encoder.</entry>
  2234. </row>
  2235. <row><entry></entry></row>
  2236. <row id="v4l2-mpeg-video-header-mode">
  2237. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_HEADER_MODE</constant>&nbsp;</entry>
  2238. <entry>enum&nbsp;v4l2_mpeg_video_header_mode</entry>
  2239. </row>
  2240. <row><entry spanname="descr">Determines whether the header is returned as the first buffer or is
  2241. it returned together with the first frame. Applicable to encoders.
  2242. Possible values are:</entry>
  2243. </row>
  2244. <row>
  2245. <entrytbl spanname="descr" cols="2">
  2246. <tbody valign="top">
  2247. <row>
  2248. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE</constant>&nbsp;</entry>
  2249. <entry>The stream header is returned separately in the first buffer.</entry>
  2250. </row>
  2251. <row>
  2252. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME</constant>&nbsp;</entry>
  2253. <entry>The stream header is returned together with the first encoded frame.</entry>
  2254. </row>
  2255. </tbody>
  2256. </entrytbl>
  2257. </row>
  2258. <row><entry></entry></row>
  2259. <row>
  2260. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER</constant>&nbsp;</entry>
  2261. <entry>boolean</entry>
  2262. </row><row><entry spanname="descr">Repeat the video sequence headers. Repeating these
  2263. headers makes random access to the video stream easier. Applicable to the MPEG1, 2 and 4 encoder.</entry>
  2264. </row>
  2265. <row>
  2266. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER</constant>&nbsp;</entry>
  2267. <entry>boolean</entry>
  2268. </row><row><entry spanname="descr">Enabled the deblocking post processing filter for MPEG4 decoder.
  2269. Applicable to the MPEG4 decoder.</entry>
  2270. </row>
  2271. <row><entry></entry></row>
  2272. <row>
  2273. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES</constant>&nbsp;</entry>
  2274. <entry>integer</entry>
  2275. </row><row><entry spanname="descr">vop_time_increment_resolution value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2276. </row>
  2277. <row><entry></entry></row>
  2278. <row>
  2279. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC</constant>&nbsp;</entry>
  2280. <entry>integer</entry>
  2281. </row><row><entry spanname="descr">vop_time_increment value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2282. </row>
  2283. <row><entry></entry></row>
  2284. <row>
  2285. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING</constant>&nbsp;</entry>
  2286. <entry>boolean</entry>
  2287. </row>
  2288. <row><entry spanname="descr">Enable generation of frame packing supplemental enhancement information in the encoded bitstream.
  2289. The frame packing SEI message contains the arrangement of L and R planes for 3D viewing. Applicable to the H264 encoder.</entry>
  2290. </row>
  2291. <row><entry></entry></row>
  2292. <row>
  2293. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0</constant>&nbsp;</entry>
  2294. <entry>boolean</entry>
  2295. </row>
  2296. <row><entry spanname="descr">Sets current frame as frame0 in frame packing SEI.
  2297. Applicable to the H264 encoder.</entry>
  2298. </row>
  2299. <row><entry></entry></row>
  2300. <row id="v4l2-mpeg-video-h264-sei-fp-arrangement-type">
  2301. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE</constant>&nbsp;</entry>
  2302. <entry>enum&nbsp;v4l2_mpeg_video_h264_sei_fp_arrangement_type</entry>
  2303. </row>
  2304. <row><entry spanname="descr">Frame packing arrangement type for H264 SEI.
  2305. Applicable to the H264 encoder.
  2306. Possible values are:</entry>
  2307. </row>
  2308. <row>
  2309. <entrytbl spanname="descr" cols="2">
  2310. <tbody valign="top">
  2311. <row>
  2312. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD</constant>&nbsp;</entry>
  2313. <entry>Pixels are alternatively from L and R.</entry>
  2314. </row>
  2315. <row>
  2316. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN</constant>&nbsp;</entry>
  2317. <entry>L and R are interlaced by column.</entry>
  2318. </row>
  2319. <row>
  2320. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW</constant>&nbsp;</entry>
  2321. <entry>L and R are interlaced by row.</entry>
  2322. </row>
  2323. <row>
  2324. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE</constant>&nbsp;</entry>
  2325. <entry>L is on the left, R on the right.</entry>
  2326. </row>
  2327. <row>
  2328. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM</constant>&nbsp;</entry>
  2329. <entry>L is on top, R on bottom.</entry>
  2330. </row>
  2331. <row>
  2332. <entry><constant>V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL</constant>&nbsp;</entry>
  2333. <entry>One view per frame.</entry>
  2334. </row>
  2335. </tbody>
  2336. </entrytbl>
  2337. </row>
  2338. <row><entry></entry></row>
  2339. <row>
  2340. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO</constant>&nbsp;</entry>
  2341. <entry>boolean</entry>
  2342. </row>
  2343. <row><entry spanname="descr">Enables flexible macroblock ordering in the encoded bitstream. It is a technique
  2344. used for restructuring the ordering of macroblocks in pictures. Applicable to the H264 encoder.</entry>
  2345. </row>
  2346. <row><entry></entry></row>
  2347. <row id="v4l2-mpeg-video-h264-fmo-map-type">
  2348. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE</constant>&nbsp;</entry>
  2349. <entry>enum&nbsp;v4l2_mpeg_video_h264_fmo_map_type</entry>
  2350. </row>
  2351. <row><entry spanname="descr">When using FMO, the map type divides the image in different scan patterns of macroblocks.
  2352. Applicable to the H264 encoder.
  2353. Possible values are:</entry>
  2354. </row>
  2355. <row>
  2356. <entrytbl spanname="descr" cols="2">
  2357. <tbody valign="top">
  2358. <row>
  2359. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES</constant>&nbsp;</entry>
  2360. <entry>Slices are interleaved one after other with macroblocks in run length order.</entry>
  2361. </row>
  2362. <row>
  2363. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES</constant>&nbsp;</entry>
  2364. <entry>Scatters the macroblocks based on a mathematical function known to both encoder and decoder.</entry>
  2365. </row>
  2366. <row>
  2367. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER</constant>&nbsp;</entry>
  2368. <entry>Macroblocks arranged in rectangular areas or regions of interest.</entry>
  2369. </row>
  2370. <row>
  2371. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT</constant>&nbsp;</entry>
  2372. <entry>Slice groups grow in a cyclic way from centre to outwards.</entry>
  2373. </row>
  2374. <row>
  2375. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN</constant>&nbsp;</entry>
  2376. <entry>Slice groups grow in raster scan pattern from left to right.</entry>
  2377. </row>
  2378. <row>
  2379. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN</constant>&nbsp;</entry>
  2380. <entry>Slice groups grow in wipe scan pattern from top to bottom.</entry>
  2381. </row>
  2382. <row>
  2383. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT</constant>&nbsp;</entry>
  2384. <entry>User defined map type.</entry>
  2385. </row>
  2386. </tbody>
  2387. </entrytbl>
  2388. </row>
  2389. <row><entry></entry></row>
  2390. <row>
  2391. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP</constant>&nbsp;</entry>
  2392. <entry>integer</entry>
  2393. </row>
  2394. <row><entry spanname="descr">Number of slice groups in FMO.
  2395. Applicable to the H264 encoder.</entry>
  2396. </row>
  2397. <row><entry></entry></row>
  2398. <row id="v4l2-mpeg-video-h264-fmo-change-direction">
  2399. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION</constant>&nbsp;</entry>
  2400. <entry>enum&nbsp;v4l2_mpeg_video_h264_fmo_change_dir</entry>
  2401. </row>
  2402. <row><entry spanname="descr">Specifies a direction of the slice group change for raster and wipe maps.
  2403. Applicable to the H264 encoder.
  2404. Possible values are:</entry>
  2405. </row>
  2406. <row>
  2407. <entrytbl spanname="descr" cols="2">
  2408. <tbody valign="top">
  2409. <row>
  2410. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT</constant>&nbsp;</entry>
  2411. <entry>Raster scan or wipe right.</entry>
  2412. </row>
  2413. <row>
  2414. <entry><constant>V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT</constant>&nbsp;</entry>
  2415. <entry>Reverse raster scan or wipe left.</entry>
  2416. </row>
  2417. </tbody>
  2418. </entrytbl>
  2419. </row>
  2420. <row><entry></entry></row>
  2421. <row>
  2422. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE</constant>&nbsp;</entry>
  2423. <entry>integer</entry>
  2424. </row>
  2425. <row><entry spanname="descr">Specifies the size of the first slice group for raster and wipe map.
  2426. Applicable to the H264 encoder.</entry>
  2427. </row>
  2428. <row><entry></entry></row>
  2429. <row>
  2430. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH</constant>&nbsp;</entry>
  2431. <entry>integer</entry>
  2432. </row>
  2433. <row><entry spanname="descr">Specifies the number of consecutive macroblocks for the interleaved map.
  2434. Applicable to the H264 encoder.</entry>
  2435. </row>
  2436. <row><entry></entry></row>
  2437. <row>
  2438. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ASO</constant>&nbsp;</entry>
  2439. <entry>boolean</entry>
  2440. </row>
  2441. <row><entry spanname="descr">Enables arbitrary slice ordering in encoded bitstream.
  2442. Applicable to the H264 encoder.</entry>
  2443. </row>
  2444. <row><entry></entry></row>
  2445. <row>
  2446. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER</constant>&nbsp;</entry>
  2447. <entry>integer</entry>
  2448. </row><row><entry spanname="descr">Specifies the slice order in ASO. Applicable to the H264 encoder.
  2449. The supplied 32-bit integer is interpreted as follows (bit
  2450. 0 = least significant bit):</entry>
  2451. </row>
  2452. <row>
  2453. <entrytbl spanname="descr" cols="2">
  2454. <tbody valign="top">
  2455. <row>
  2456. <entry>Bit 0:15</entry>
  2457. <entry>Slice ID</entry>
  2458. </row>
  2459. <row>
  2460. <entry>Bit 16:32</entry>
  2461. <entry>Slice position or order</entry>
  2462. </row>
  2463. </tbody>
  2464. </entrytbl>
  2465. </row>
  2466. <row><entry></entry></row>
  2467. <row>
  2468. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING</constant>&nbsp;</entry>
  2469. <entry>boolean</entry>
  2470. </row>
  2471. <row><entry spanname="descr">Enables H264 hierarchical coding.
  2472. Applicable to the H264 encoder.</entry>
  2473. </row>
  2474. <row><entry></entry></row>
  2475. <row id="v4l2-mpeg-video-h264-hierarchical-coding-type">
  2476. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE</constant>&nbsp;</entry>
  2477. <entry>enum&nbsp;v4l2_mpeg_video_h264_hierarchical_coding_type</entry>
  2478. </row>
  2479. <row><entry spanname="descr">Specifies the hierarchical coding type.
  2480. Applicable to the H264 encoder.
  2481. Possible values are:</entry>
  2482. </row>
  2483. <row>
  2484. <entrytbl spanname="descr" cols="2">
  2485. <tbody valign="top">
  2486. <row>
  2487. <entry><constant>V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B</constant>&nbsp;</entry>
  2488. <entry>Hierarchical B coding.</entry>
  2489. </row>
  2490. <row>
  2491. <entry><constant>V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P</constant>&nbsp;</entry>
  2492. <entry>Hierarchical P coding.</entry>
  2493. </row>
  2494. </tbody>
  2495. </entrytbl>
  2496. </row>
  2497. <row><entry></entry></row>
  2498. <row>
  2499. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER</constant>&nbsp;</entry>
  2500. <entry>integer</entry>
  2501. </row>
  2502. <row><entry spanname="descr">Specifies the number of hierarchical coding layers.
  2503. Applicable to the H264 encoder.</entry>
  2504. </row>
  2505. <row><entry></entry></row>
  2506. <row>
  2507. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP</constant>&nbsp;</entry>
  2508. <entry>integer</entry>
  2509. </row><row><entry spanname="descr">Specifies a user defined QP for each layer. Applicable to the H264 encoder.
  2510. The supplied 32-bit integer is interpreted as follows (bit
  2511. 0 = least significant bit):</entry>
  2512. </row>
  2513. <row>
  2514. <entrytbl spanname="descr" cols="2">
  2515. <tbody valign="top">
  2516. <row>
  2517. <entry>Bit 0:15</entry>
  2518. <entry>QP value</entry>
  2519. </row>
  2520. <row>
  2521. <entry>Bit 16:32</entry>
  2522. <entry>Layer number</entry>
  2523. </row>
  2524. </tbody>
  2525. </entrytbl>
  2526. </row>
  2527. </tbody>
  2528. </tgroup>
  2529. </table>
  2530. </section>
  2531. <section>
  2532. <title>MFC 5.1 MPEG Controls</title>
  2533. <para>The following MPEG class controls deal with MPEG
  2534. decoding and encoding settings that are specific to the Multi Format Codec 5.1 device present
  2535. in the S5P family of SoCs by Samsung.
  2536. </para>
  2537. <table pgwide="1" frame="none" id="mfc51-control-id">
  2538. <title>MFC 5.1 Control IDs</title>
  2539. <tgroup cols="4">
  2540. <colspec colname="c1" colwidth="1*" />
  2541. <colspec colname="c2" colwidth="6*" />
  2542. <colspec colname="c3" colwidth="2*" />
  2543. <colspec colname="c4" colwidth="6*" />
  2544. <spanspec namest="c1" nameend="c2" spanname="id" />
  2545. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2546. <thead>
  2547. <row>
  2548. <entry spanname="id" align="left">ID</entry>
  2549. <entry align="left">Type</entry>
  2550. </row><row><entry spanname="descr" align="left">Description</entry>
  2551. </row>
  2552. </thead>
  2553. <tbody valign="top">
  2554. <row><entry></entry></row>
  2555. <row>
  2556. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant>&nbsp;</entry>
  2557. <entry>boolean</entry>
  2558. </row><row><entry spanname="descr">If the display delay is enabled then the decoder is forced to return a
  2559. CAPTURE buffer (decoded frame) after processing a certain number of OUTPUT buffers. The delay can be set through
  2560. <constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>. This feature can be used for example
  2561. for generating thumbnails of videos. Applicable to the H264 decoder.
  2562. </entry>
  2563. </row>
  2564. <row><entry></entry></row>
  2565. <row>
  2566. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>&nbsp;</entry>
  2567. <entry>integer</entry>
  2568. </row><row><entry spanname="descr">Display delay value for H264 decoder.
  2569. The decoder is forced to return a decoded frame after the set 'display delay' number of frames. If this number is
  2570. low it may result in frames returned out of dispaly order, in addition the hardware may still be using the returned buffer
  2571. as a reference picture for subsequent frames.
  2572. </entry>
  2573. </row>
  2574. <row><entry></entry></row>
  2575. <row>
  2576. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P</constant>&nbsp;</entry>
  2577. <entry>integer</entry>
  2578. </row><row><entry spanname="descr">The number of reference pictures used for encoding a P picture.
  2579. Applicable to the H264 encoder.</entry>
  2580. </row>
  2581. <row><entry></entry></row>
  2582. <row>
  2583. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING</constant>&nbsp;</entry>
  2584. <entry>boolean</entry>
  2585. </row><row><entry spanname="descr">Padding enable in the encoder - use a color instead of repeating border pixels.
  2586. Applicable to encoders.</entry>
  2587. </row>
  2588. <row><entry></entry></row>
  2589. <row>
  2590. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV</constant>&nbsp;</entry>
  2591. <entry>integer</entry>
  2592. </row><row><entry spanname="descr">Padding color in the encoder. Applicable to encoders. The supplied 32-bit integer is interpreted as follows (bit
  2593. 0 = least significant bit):</entry>
  2594. </row>
  2595. <row>
  2596. <entrytbl spanname="descr" cols="2">
  2597. <tbody valign="top">
  2598. <row>
  2599. <entry>Bit 0:7</entry>
  2600. <entry>V chrominance information</entry>
  2601. </row>
  2602. <row>
  2603. <entry>Bit 8:15</entry>
  2604. <entry>U chrominance information</entry>
  2605. </row>
  2606. <row>
  2607. <entry>Bit 16:23</entry>
  2608. <entry>Y luminance information</entry>
  2609. </row>
  2610. <row>
  2611. <entry>Bit 24:31</entry>
  2612. <entry>Must be zero.</entry>
  2613. </row>
  2614. </tbody>
  2615. </entrytbl>
  2616. </row>
  2617. <row><entry></entry></row>
  2618. <row>
  2619. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF</constant>&nbsp;</entry>
  2620. <entry>integer</entry>
  2621. </row><row><entry spanname="descr">Reaction coefficient for MFC rate control. Applicable to encoders.
  2622. <para>Note 1: Valid only when the frame level RC is enabled.</para>
  2623. <para>Note 2: For tight CBR, this field must be small (ex. 2 ~ 10).
  2624. For VBR, this field must be large (ex. 100 ~ 1000).</para>
  2625. <para>Note 3: It is not recommended to use the greater number than FRAME_RATE * (10^9 / BIT_RATE).</para>
  2626. </entry>
  2627. </row>
  2628. <row><entry></entry></row>
  2629. <row>
  2630. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK</constant>&nbsp;</entry>
  2631. <entry>boolean</entry>
  2632. </row><row><entry spanname="descr">Adaptive rate control for dark region.
  2633. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2634. Applicable to the H264 encoder.</entry>
  2635. </row>
  2636. <row><entry></entry></row>
  2637. <row>
  2638. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH</constant>&nbsp;</entry>
  2639. <entry>boolean</entry>
  2640. </row><row><entry spanname="descr">Adaptive rate control for smooth region.
  2641. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2642. Applicable to the H264 encoder.</entry>
  2643. </row>
  2644. <row><entry></entry></row>
  2645. <row>
  2646. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC</constant>&nbsp;</entry>
  2647. <entry>boolean</entry>
  2648. </row><row><entry spanname="descr">Adaptive rate control for static region.
  2649. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2650. Applicable to the H264 encoder.</entry>
  2651. </row>
  2652. <row><entry></entry></row>
  2653. <row>
  2654. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY</constant>&nbsp;</entry>
  2655. <entry>boolean</entry>
  2656. </row><row><entry spanname="descr">Adaptive rate control for activity region.
  2657. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2658. Applicable to the H264 encoder.</entry>
  2659. </row>
  2660. <row><entry></entry></row>
  2661. <row id="v4l2-mpeg-mfc51-video-frame-skip-mode">
  2662. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE</constant>&nbsp;</entry>
  2663. <entry>enum&nbsp;v4l2_mpeg_mfc51_video_frame_skip_mode</entry>
  2664. </row>
  2665. <row><entry spanname="descr">
  2666. Indicates in what conditions the encoder should skip frames. If encoding a frame would cause the encoded stream to be larger then
  2667. a chosen data limit then the frame will be skipped.
  2668. Possible values are:</entry>
  2669. </row>
  2670. <row>
  2671. <entrytbl spanname="descr" cols="2">
  2672. <tbody valign="top">
  2673. <row>
  2674. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED</constant>&nbsp;</entry>
  2675. <entry>Frame skip mode is disabled.</entry>
  2676. </row>
  2677. <row>
  2678. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT</constant>&nbsp;</entry>
  2679. <entry>Frame skip mode enabled and buffer limit is set by the chosen level and is defined by the standard.</entry>
  2680. </row>
  2681. <row>
  2682. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT</constant>&nbsp;</entry>
  2683. <entry>Frame skip mode enabled and buffer limit is set by the VBV (MPEG1/2/4) or CPB (H264) buffer size control.</entry>
  2684. </row>
  2685. </tbody>
  2686. </entrytbl>
  2687. </row>
  2688. <row><entry></entry></row>
  2689. <row>
  2690. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT</constant>&nbsp;</entry>
  2691. <entry>integer</entry>
  2692. </row><row><entry spanname="descr">Enable rate-control with fixed target bit.
  2693. If this setting is enabled, then the rate control logic of the encoder will calculate the average bitrate
  2694. for a GOP and keep it below or equal the set bitrate target. Otherwise the rate control logic calculates the
  2695. overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case
  2696. the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the
  2697. average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that
  2698. the stream will meet tight bandwidth contraints. Applicable to encoders.
  2699. </entry>
  2700. </row>
  2701. <row><entry></entry></row>
  2702. <row id="v4l2-mpeg-mfc51-video-force-frame-type">
  2703. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE</constant>&nbsp;</entry>
  2704. <entry>enum&nbsp;v4l2_mpeg_mfc51_video_force_frame_type</entry>
  2705. </row>
  2706. <row><entry spanname="descr">Force a frame type for the next queued buffer. Applicable to encoders.
  2707. Possible values are:</entry>
  2708. </row>
  2709. <row>
  2710. <entrytbl spanname="descr" cols="2">
  2711. <tbody valign="top">
  2712. <row>
  2713. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED</constant>&nbsp;</entry>
  2714. <entry>Forcing a specific frame type disabled.</entry>
  2715. </row>
  2716. <row>
  2717. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME</constant>&nbsp;</entry>
  2718. <entry>Force an I-frame.</entry>
  2719. </row>
  2720. <row>
  2721. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED</constant>&nbsp;</entry>
  2722. <entry>Force a non-coded frame.</entry>
  2723. </row>
  2724. </tbody>
  2725. </entrytbl>
  2726. </row>
  2727. </tbody>
  2728. </tgroup>
  2729. </table>
  2730. </section>
  2731. <section>
  2732. <title>CX2341x MPEG Controls</title>
  2733. <para>The following MPEG class controls deal with MPEG
  2734. encoding settings that are specific to the Conexant CX23415 and
  2735. CX23416 MPEG encoding chips.</para>
  2736. <table pgwide="1" frame="none" id="cx2341x-control-id">
  2737. <title>CX2341x Control IDs</title>
  2738. <tgroup cols="4">
  2739. <colspec colname="c1" colwidth="1*" />
  2740. <colspec colname="c2" colwidth="6*" />
  2741. <colspec colname="c3" colwidth="2*" />
  2742. <colspec colname="c4" colwidth="6*" />
  2743. <spanspec namest="c1" nameend="c2" spanname="id" />
  2744. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2745. <thead>
  2746. <row>
  2747. <entry spanname="id" align="left">ID</entry>
  2748. <entry align="left">Type</entry>
  2749. </row><row><entry spanname="descr" align="left">Description</entry>
  2750. </row>
  2751. </thead>
  2752. <tbody valign="top">
  2753. <row><entry></entry></row>
  2754. <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode">
  2755. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant>&nbsp;</entry>
  2756. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry>
  2757. </row><row><entry spanname="descr">Sets the Spatial
  2758. Filter mode (default <constant>MANUAL</constant>). Possible values
  2759. are:</entry>
  2760. </row>
  2761. <row>
  2762. <entrytbl spanname="descr" cols="2">
  2763. <tbody valign="top">
  2764. <row>
  2765. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2766. <entry>Choose the filter manually</entry>
  2767. </row>
  2768. <row>
  2769. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2770. <entry>Choose the filter automatically</entry>
  2771. </row>
  2772. </tbody>
  2773. </entrytbl>
  2774. </row>
  2775. <row><entry></entry></row>
  2776. <row>
  2777. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER</constant>&nbsp;</entry>
  2778. <entry>integer&nbsp;(0-15)</entry>
  2779. </row><row><entry spanname="descr">The setting for the
  2780. Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry>
  2781. </row>
  2782. <row><entry></entry></row>
  2783. <row id="luma-spatial-filter-type">
  2784. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2785. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry>
  2786. </row><row><entry spanname="descr">Select the algorithm
  2787. to use for the Luma Spatial Filter (default
  2788. <constant>1D_HOR</constant>). Possible values:</entry>
  2789. </row>
  2790. <row>
  2791. <entrytbl spanname="descr" cols="2">
  2792. <tbody valign="top">
  2793. <row>
  2794. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2795. <entry>No filter</entry>
  2796. </row>
  2797. <row>
  2798. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2799. <entry>One-dimensional horizontal</entry>
  2800. </row>
  2801. <row>
  2802. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT</constant>&nbsp;</entry>
  2803. <entry>One-dimensional vertical</entry>
  2804. </row>
  2805. <row>
  2806. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE</constant>&nbsp;</entry>
  2807. <entry>Two-dimensional separable</entry>
  2808. </row>
  2809. <row>
  2810. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE</constant>&nbsp;</entry>
  2811. <entry>Two-dimensional symmetrical
  2812. non-separable</entry>
  2813. </row>
  2814. </tbody>
  2815. </entrytbl>
  2816. </row>
  2817. <row><entry></entry></row>
  2818. <row id="chroma-spatial-filter-type">
  2819. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2820. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry>
  2821. </row><row><entry spanname="descr">Select the algorithm
  2822. for the Chroma Spatial Filter (default <constant>1D_HOR</constant>).
  2823. Possible values are:</entry>
  2824. </row>
  2825. <row>
  2826. <entrytbl spanname="descr" cols="2">
  2827. <tbody valign="top">
  2828. <row>
  2829. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2830. <entry>No filter</entry>
  2831. </row>
  2832. <row>
  2833. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2834. <entry>One-dimensional horizontal</entry>
  2835. </row>
  2836. </tbody>
  2837. </entrytbl>
  2838. </row>
  2839. <row><entry></entry></row>
  2840. <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode">
  2841. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant>&nbsp;</entry>
  2842. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry>
  2843. </row><row><entry spanname="descr">Sets the Temporal
  2844. Filter mode (default <constant>MANUAL</constant>). Possible values
  2845. are:</entry>
  2846. </row>
  2847. <row>
  2848. <entrytbl spanname="descr" cols="2">
  2849. <tbody valign="top">
  2850. <row>
  2851. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2852. <entry>Choose the filter manually</entry>
  2853. </row>
  2854. <row>
  2855. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2856. <entry>Choose the filter automatically</entry>
  2857. </row>
  2858. </tbody>
  2859. </entrytbl>
  2860. </row>
  2861. <row><entry></entry></row>
  2862. <row>
  2863. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER</constant>&nbsp;</entry>
  2864. <entry>integer&nbsp;(0-31)</entry>
  2865. </row><row><entry spanname="descr">The setting for the
  2866. Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale
  2867. capturing and 0 for scaled capturing.)</entry>
  2868. </row>
  2869. <row><entry></entry></row>
  2870. <row id="v4l2-mpeg-cx2341x-video-median-filter-type">
  2871. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant>&nbsp;</entry>
  2872. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_median_filter_type</entry>
  2873. </row><row><entry spanname="descr">Median Filter Type
  2874. (default <constant>OFF</constant>). Possible values are:</entry>
  2875. </row>
  2876. <row>
  2877. <entrytbl spanname="descr" cols="2">
  2878. <tbody valign="top">
  2879. <row>
  2880. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2881. <entry>No filter</entry>
  2882. </row>
  2883. <row>
  2884. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR</constant>&nbsp;</entry>
  2885. <entry>Horizontal filter</entry>
  2886. </row>
  2887. <row>
  2888. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT</constant>&nbsp;</entry>
  2889. <entry>Vertical filter</entry>
  2890. </row>
  2891. <row>
  2892. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT</constant>&nbsp;</entry>
  2893. <entry>Horizontal and vertical filter</entry>
  2894. </row>
  2895. <row>
  2896. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG</constant>&nbsp;</entry>
  2897. <entry>Diagonal filter</entry>
  2898. </row>
  2899. </tbody>
  2900. </entrytbl>
  2901. </row>
  2902. <row><entry></entry></row>
  2903. <row>
  2904. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2905. <entry>integer&nbsp;(0-255)</entry>
  2906. </row><row><entry spanname="descr">Threshold above which
  2907. the luminance median filter is enabled (default 0)</entry>
  2908. </row>
  2909. <row><entry></entry></row>
  2910. <row>
  2911. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2912. <entry>integer&nbsp;(0-255)</entry>
  2913. </row><row><entry spanname="descr">Threshold below which
  2914. the luminance median filter is enabled (default 255)</entry>
  2915. </row>
  2916. <row><entry></entry></row>
  2917. <row>
  2918. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2919. <entry>integer&nbsp;(0-255)</entry>
  2920. </row><row><entry spanname="descr">Threshold above which
  2921. the chroma median filter is enabled (default 0)</entry>
  2922. </row>
  2923. <row><entry></entry></row>
  2924. <row>
  2925. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2926. <entry>integer&nbsp;(0-255)</entry>
  2927. </row><row><entry spanname="descr">Threshold below which
  2928. the chroma median filter is enabled (default 255)</entry>
  2929. </row>
  2930. <row><entry></entry></row>
  2931. <row>
  2932. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant>&nbsp;</entry>
  2933. <entry>boolean</entry>
  2934. </row>
  2935. <row><entry spanname="descr">The CX2341X MPEG encoder
  2936. can insert one empty MPEG-2 PES packet into the stream between every
  2937. four video frames. The packet size is 2048 bytes, including the
  2938. packet_start_code_prefix and stream_id fields. The stream_id is 0xBF
  2939. (private stream 2). The payload consists of 0x00 bytes, to be filled
  2940. in by the application. 0 = do not insert, 1 = insert packets.</entry>
  2941. </row>
  2942. </tbody>
  2943. </tgroup>
  2944. </table>
  2945. </section>
  2946. <section>
  2947. <title>VPX Control Reference</title>
  2948. <para>The VPX controls include controls for encoding parameters
  2949. of VPx video codec.</para>
  2950. <table pgwide="1" frame="none" id="vpx-control-id">
  2951. <title>VPX Control IDs</title>
  2952. <tgroup cols="4">
  2953. <colspec colname="c1" colwidth="1*" />
  2954. <colspec colname="c2" colwidth="6*" />
  2955. <colspec colname="c3" colwidth="2*" />
  2956. <colspec colname="c4" colwidth="6*" />
  2957. <spanspec namest="c1" nameend="c2" spanname="id" />
  2958. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2959. <thead>
  2960. <row>
  2961. <entry spanname="id" align="left">ID</entry>
  2962. <entry align="left">Type</entry>
  2963. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  2964. </row>
  2965. </thead>
  2966. <tbody valign="top">
  2967. <row><entry></entry></row>
  2968. <row><entry></entry></row>
  2969. <row id="v4l2-vpx-num-partitions">
  2970. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS</constant></entry>
  2971. <entry>enum v4l2_vp8_num_partitions</entry>
  2972. </row>
  2973. <row><entry spanname="descr">The number of token partitions to use in VP8 encoder.
  2974. Possible values are:</entry>
  2975. </row>
  2976. <row>
  2977. <entrytbl spanname="descr" cols="2">
  2978. <tbody valign="top">
  2979. <row>
  2980. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION</constant></entry>
  2981. <entry>1 coefficient partition</entry>
  2982. </row>
  2983. <row>
  2984. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS</constant></entry>
  2985. <entry>2 coefficient partitions</entry>
  2986. </row>
  2987. <row>
  2988. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS</constant></entry>
  2989. <entry>4 coefficient partitions</entry>
  2990. </row>
  2991. <row>
  2992. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS</constant></entry>
  2993. <entry>8 coefficient partitions</entry>
  2994. </row>
  2995. </tbody>
  2996. </entrytbl>
  2997. </row>
  2998. <row><entry></entry></row>
  2999. <row>
  3000. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4</constant></entry>
  3001. <entry>boolean</entry>
  3002. </row>
  3003. <row><entry spanname="descr">Setting this prevents intra 4x4 mode in the intra mode decision.</entry>
  3004. </row>
  3005. <row><entry></entry></row>
  3006. <row id="v4l2-vpx-num-ref-frames">
  3007. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES</constant></entry>
  3008. <entry>enum v4l2_vp8_num_ref_frames</entry>
  3009. </row>
  3010. <row><entry spanname="descr">The number of reference pictures for encoding P frames.
  3011. Possible values are:</entry>
  3012. </row>
  3013. <row>
  3014. <entrytbl spanname="descr" cols="2">
  3015. <tbody valign="top">
  3016. <row>
  3017. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME</constant></entry>
  3018. <entry>Last encoded frame will be searched</entry>
  3019. </row>
  3020. <row>
  3021. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME</constant></entry>
  3022. <entry>Two frames will be searched among the last encoded frame, the golden frame
  3023. and the alternate reference (altref) frame. The encoder implementation will decide which two are chosen.</entry>
  3024. </row>
  3025. <row>
  3026. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME</constant></entry>
  3027. <entry>The last encoded frame, the golden frame and the altref frame will be searched.</entry>
  3028. </row>
  3029. </tbody>
  3030. </entrytbl>
  3031. </row>
  3032. <row><entry></entry></row>
  3033. <row>
  3034. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL</constant></entry>
  3035. <entry>integer</entry>
  3036. </row>
  3037. <row><entry spanname="descr">Indicates the loop filter level. The adjustment of the loop
  3038. filter level is done via a delta value against a baseline loop filter value.</entry>
  3039. </row>
  3040. <row><entry></entry></row>
  3041. <row>
  3042. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS</constant></entry>
  3043. <entry>integer</entry>
  3044. </row>
  3045. <row><entry spanname="descr">This parameter affects the loop filter. Anything above
  3046. zero weakens the deblocking effect on the loop filter.</entry>
  3047. </row>
  3048. <row><entry></entry></row>
  3049. <row>
  3050. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD</constant></entry>
  3051. <entry>integer</entry>
  3052. </row>
  3053. <row><entry spanname="descr">Sets the refresh period for the golden frame. The period is defined
  3054. in number of frames. For a value of 'n', every nth frame starting from the first key frame will be taken as a golden frame.
  3055. For eg. for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden frame refresh period is set as 4, the frames
  3056. 0, 4, 8 etc will be taken as the golden frames as frame 0 is always a key frame.</entry>
  3057. </row>
  3058. <row><entry></entry></row>
  3059. <row id="v4l2-vpx-golden-frame-sel">
  3060. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL</constant></entry>
  3061. <entry>enum v4l2_vp8_golden_frame_sel</entry>
  3062. </row>
  3063. <row><entry spanname="descr">Selects the golden frame for encoding.
  3064. Possible values are:</entry>
  3065. </row>
  3066. <row>
  3067. <entrytbl spanname="descr" cols="2">
  3068. <tbody valign="top">
  3069. <row>
  3070. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV</constant></entry>
  3071. <entry>Use the (n-2)th frame as a golden frame, current frame index being 'n'.</entry>
  3072. </row>
  3073. <row>
  3074. <entry><constant>V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD</constant></entry>
  3075. <entry>Use the previous specific frame indicated by
  3076. V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD as a golden frame.</entry>
  3077. </row>
  3078. </tbody>
  3079. </entrytbl>
  3080. </row>
  3081. <row><entry></entry></row>
  3082. <row>
  3083. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_MIN_QP</constant></entry>
  3084. <entry>integer</entry>
  3085. </row>
  3086. <row><entry spanname="descr">Minimum quantization parameter for VP8.</entry>
  3087. </row>
  3088. <row><entry></entry></row>
  3089. <row>
  3090. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_MAX_QP</constant></entry>
  3091. <entry>integer</entry>
  3092. </row>
  3093. <row><entry spanname="descr">Maximum quantization parameter for VP8.</entry>
  3094. </row>
  3095. <row><entry></entry></row>
  3096. <row>
  3097. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP</constant>&nbsp;</entry>
  3098. <entry>integer</entry>
  3099. </row>
  3100. <row><entry spanname="descr">Quantization parameter for an I frame for VP8.</entry>
  3101. </row>
  3102. <row><entry></entry></row>
  3103. <row>
  3104. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP</constant>&nbsp;</entry>
  3105. <entry>integer</entry>
  3106. </row>
  3107. <row><entry spanname="descr">Quantization parameter for a P frame for VP8.</entry>
  3108. </row>
  3109. <row><entry></entry></row>
  3110. <row>
  3111. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VPX_PROFILE</constant>&nbsp;</entry>
  3112. <entry>integer</entry>
  3113. </row>
  3114. <row><entry spanname="descr">Select the desired profile for VPx encoder.
  3115. Acceptable values are 0, 1, 2 and 3 corresponding to encoder profiles 0, 1, 2 and 3.</entry>
  3116. </row>
  3117. <row><entry></entry></row>
  3118. </tbody>
  3119. </tgroup>
  3120. </table>
  3121. </section>
  3122. </section>
  3123. <section id="camera-controls">
  3124. <title>Camera Control Reference</title>
  3125. <para>The Camera class includes controls for mechanical (or
  3126. equivalent digital) features of a device such as controllable lenses
  3127. or sensors.</para>
  3128. <table pgwide="1" frame="none" id="camera-control-id">
  3129. <title>Camera Control IDs</title>
  3130. <tgroup cols="4">
  3131. <colspec colname="c1" colwidth="1*" />
  3132. <colspec colname="c2" colwidth="6*" />
  3133. <colspec colname="c3" colwidth="2*" />
  3134. <colspec colname="c4" colwidth="6*" />
  3135. <spanspec namest="c1" nameend="c2" spanname="id" />
  3136. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3137. <thead>
  3138. <row>
  3139. <entry spanname="id" align="left">ID</entry>
  3140. <entry align="left">Type</entry>
  3141. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3142. </row>
  3143. </thead>
  3144. <tbody valign="top">
  3145. <row><entry></entry></row>
  3146. <row>
  3147. <entry spanname="id"><constant>V4L2_CID_CAMERA_CLASS</constant>&nbsp;</entry>
  3148. <entry>class</entry>
  3149. </row><row><entry spanname="descr">The Camera class
  3150. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  3151. description of this control class.</entry>
  3152. </row>
  3153. <row><entry></entry></row>
  3154. <row id="v4l2-exposure-auto-type">
  3155. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant>&nbsp;</entry>
  3156. <entry>enum&nbsp;v4l2_exposure_auto_type</entry>
  3157. </row><row><entry spanname="descr">Enables automatic
  3158. adjustments of the exposure time and/or iris aperture. The effect of
  3159. manual changes of the exposure time or iris aperture while these
  3160. features are enabled is undefined, drivers should ignore such
  3161. requests. Possible values are:</entry>
  3162. </row>
  3163. <row>
  3164. <entrytbl spanname="descr" cols="2">
  3165. <tbody valign="top">
  3166. <row>
  3167. <entry><constant>V4L2_EXPOSURE_AUTO</constant>&nbsp;</entry>
  3168. <entry>Automatic exposure time, automatic iris
  3169. aperture.</entry>
  3170. </row>
  3171. <row>
  3172. <entry><constant>V4L2_EXPOSURE_MANUAL</constant>&nbsp;</entry>
  3173. <entry>Manual exposure time, manual iris.</entry>
  3174. </row>
  3175. <row>
  3176. <entry><constant>V4L2_EXPOSURE_SHUTTER_PRIORITY</constant>&nbsp;</entry>
  3177. <entry>Manual exposure time, auto iris.</entry>
  3178. </row>
  3179. <row>
  3180. <entry><constant>V4L2_EXPOSURE_APERTURE_PRIORITY</constant>&nbsp;</entry>
  3181. <entry>Auto exposure time, manual iris.</entry>
  3182. </row>
  3183. </tbody>
  3184. </entrytbl>
  3185. </row>
  3186. <row><entry></entry></row>
  3187. <row>
  3188. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_ABSOLUTE</constant>&nbsp;</entry>
  3189. <entry>integer</entry>
  3190. </row><row><entry spanname="descr">Determines the exposure
  3191. time of the camera sensor. The exposure time is limited by the frame
  3192. interval. Drivers should interpret the values as 100 &micro;s units,
  3193. where the value 1 stands for 1/10000th of a second, 10000 for 1 second
  3194. and 100000 for 10 seconds.</entry>
  3195. </row>
  3196. <row><entry></entry></row>
  3197. <row>
  3198. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO_PRIORITY</constant>&nbsp;</entry>
  3199. <entry>boolean</entry>
  3200. </row><row><entry spanname="descr">When
  3201. <constant>V4L2_CID_EXPOSURE_AUTO</constant> is set to
  3202. <constant>AUTO</constant> or <constant>APERTURE_PRIORITY</constant>,
  3203. this control determines if the device may dynamically vary the frame
  3204. rate. By default this feature is disabled (0) and the frame rate must
  3205. remain constant.</entry>
  3206. </row>
  3207. <row><entry></entry></row>
  3208. <row>
  3209. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_BIAS</constant>&nbsp;</entry>
  3210. <entry>integer menu</entry>
  3211. </row><row><entry spanname="descr"> Determines the automatic
  3212. exposure compensation, it is effective only when <constant>V4L2_CID_EXPOSURE_AUTO</constant>
  3213. control is set to <constant>AUTO</constant>, <constant>SHUTTER_PRIORITY </constant>
  3214. or <constant>APERTURE_PRIORITY</constant>.
  3215. It is expressed in terms of EV, drivers should interpret the values as 0.001 EV
  3216. units, where the value 1000 stands for +1 EV.
  3217. <para>Increasing the exposure compensation value is equivalent to decreasing
  3218. the exposure value (EV) and will increase the amount of light at the image
  3219. sensor. The camera performs the exposure compensation by adjusting absolute
  3220. exposure time and/or aperture.</para></entry>
  3221. </row>
  3222. <row><entry></entry></row>
  3223. <row id="v4l2-exposure-metering">
  3224. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_METERING</constant>&nbsp;</entry>
  3225. <entry>enum&nbsp;v4l2_exposure_metering</entry>
  3226. </row><row><entry spanname="descr">Determines how the camera measures
  3227. the amount of light available for the frame exposure. Possible values are:</entry>
  3228. </row>
  3229. <row>
  3230. <entrytbl spanname="descr" cols="2">
  3231. <tbody valign="top">
  3232. <row>
  3233. <entry><constant>V4L2_EXPOSURE_METERING_AVERAGE</constant>&nbsp;</entry>
  3234. <entry>Use the light information coming from the entire frame
  3235. and average giving no weighting to any particular portion of the metered area.
  3236. </entry>
  3237. </row>
  3238. <row>
  3239. <entry><constant>V4L2_EXPOSURE_METERING_CENTER_WEIGHTED</constant>&nbsp;</entry>
  3240. <entry>Average the light information coming from the entire frame
  3241. giving priority to the center of the metered area.</entry>
  3242. </row>
  3243. <row>
  3244. <entry><constant>V4L2_EXPOSURE_METERING_SPOT</constant>&nbsp;</entry>
  3245. <entry>Measure only very small area at the center of the frame.</entry>
  3246. </row>
  3247. <row>
  3248. <entry><constant>V4L2_EXPOSURE_METERING_MATRIX</constant>&nbsp;</entry>
  3249. <entry>A multi-zone metering. The light intensity is measured
  3250. in several points of the frame and the results are combined. The
  3251. algorithm of the zones selection and their significance in calculating the
  3252. final value is device dependent.</entry>
  3253. </row>
  3254. </tbody>
  3255. </entrytbl>
  3256. </row>
  3257. <row><entry></entry></row>
  3258. <row>
  3259. <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant>&nbsp;</entry>
  3260. <entry>integer</entry>
  3261. </row><row><entry spanname="descr">This control turns the
  3262. camera horizontally by the specified amount. The unit is undefined. A
  3263. positive value moves the camera to the right (clockwise when viewed
  3264. from above), a negative value to the left. A value of zero does not
  3265. cause motion. This is a write-only control.</entry>
  3266. </row>
  3267. <row><entry></entry></row>
  3268. <row>
  3269. <entry spanname="id"><constant>V4L2_CID_TILT_RELATIVE</constant>&nbsp;</entry>
  3270. <entry>integer</entry>
  3271. </row><row><entry spanname="descr">This control turns the
  3272. camera vertically by the specified amount. The unit is undefined. A
  3273. positive value moves the camera up, a negative value down. A value of
  3274. zero does not cause motion. This is a write-only control.</entry>
  3275. </row>
  3276. <row><entry></entry></row>
  3277. <row>
  3278. <entry spanname="id"><constant>V4L2_CID_PAN_RESET</constant>&nbsp;</entry>
  3279. <entry>button</entry>
  3280. </row><row><entry spanname="descr">When this control is set,
  3281. the camera moves horizontally to the default position.</entry>
  3282. </row>
  3283. <row><entry></entry></row>
  3284. <row>
  3285. <entry spanname="id"><constant>V4L2_CID_TILT_RESET</constant>&nbsp;</entry>
  3286. <entry>button</entry>
  3287. </row><row><entry spanname="descr">When this control is set,
  3288. the camera moves vertically to the default position.</entry>
  3289. </row>
  3290. <row><entry></entry></row>
  3291. <row>
  3292. <entry spanname="id"><constant>V4L2_CID_PAN_ABSOLUTE</constant>&nbsp;</entry>
  3293. <entry>integer</entry>
  3294. </row><row><entry spanname="descr">This control
  3295. turns the camera horizontally to the specified position. Positive
  3296. values move the camera to the right (clockwise when viewed from above),
  3297. negative values to the left. Drivers should interpret the values as arc
  3298. seconds, with valid values between -180 * 3600 and +180 * 3600
  3299. inclusive.</entry>
  3300. </row>
  3301. <row><entry></entry></row>
  3302. <row>
  3303. <entry spanname="id"><constant>V4L2_CID_TILT_ABSOLUTE</constant>&nbsp;</entry>
  3304. <entry>integer</entry>
  3305. </row><row><entry spanname="descr">This control
  3306. turns the camera vertically to the specified position. Positive values
  3307. move the camera up, negative values down. Drivers should interpret the
  3308. values as arc seconds, with valid values between -180 * 3600 and +180
  3309. * 3600 inclusive.</entry>
  3310. </row>
  3311. <row><entry></entry></row>
  3312. <row>
  3313. <entry spanname="id"><constant>V4L2_CID_FOCUS_ABSOLUTE</constant>&nbsp;</entry>
  3314. <entry>integer</entry>
  3315. </row><row><entry spanname="descr">This control sets the
  3316. focal point of the camera to the specified position. The unit is
  3317. undefined. Positive values set the focus closer to the camera,
  3318. negative values towards infinity.</entry>
  3319. </row>
  3320. <row><entry></entry></row>
  3321. <row>
  3322. <entry spanname="id"><constant>V4L2_CID_FOCUS_RELATIVE</constant>&nbsp;</entry>
  3323. <entry>integer</entry>
  3324. </row><row><entry spanname="descr">This control moves the
  3325. focal point of the camera by the specified amount. The unit is
  3326. undefined. Positive values move the focus closer to the camera,
  3327. negative values towards infinity. This is a write-only control.</entry>
  3328. </row>
  3329. <row><entry></entry></row>
  3330. <row>
  3331. <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
  3332. <entry>boolean</entry>
  3333. </row><row><entry spanname="descr">Enables continuous automatic
  3334. focus adjustments. The effect of manual focus adjustments while this feature
  3335. is enabled is undefined, drivers should ignore such requests.</entry>
  3336. </row>
  3337. <row><entry></entry></row>
  3338. <row>
  3339. <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_START</constant>&nbsp;</entry>
  3340. <entry>button</entry>
  3341. </row><row><entry spanname="descr">Starts single auto focus process.
  3342. The effect of setting this control when <constant>V4L2_CID_FOCUS_AUTO</constant>
  3343. is set to <constant>TRUE</constant> (1) is undefined, drivers should ignore
  3344. such requests.</entry>
  3345. </row>
  3346. <row><entry></entry></row>
  3347. <row>
  3348. <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_STOP</constant>&nbsp;</entry>
  3349. <entry>button</entry>
  3350. </row><row><entry spanname="descr">Aborts automatic focusing
  3351. started with <constant>V4L2_CID_AUTO_FOCUS_START</constant> control. It is
  3352. effective only when the continuous autofocus is disabled, that is when
  3353. <constant>V4L2_CID_FOCUS_AUTO</constant> control is set to <constant>FALSE
  3354. </constant> (0).</entry>
  3355. </row>
  3356. <row><entry></entry></row>
  3357. <row id="v4l2-auto-focus-status">
  3358. <entry spanname="id">
  3359. <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>&nbsp;</entry>
  3360. <entry>bitmask</entry>
  3361. </row>
  3362. <row><entry spanname="descr">The automatic focus status. This is a read-only
  3363. control.</entry>
  3364. </row>
  3365. <row>
  3366. <entrytbl spanname="descr" cols="2">
  3367. <tbody valign="top">
  3368. <row>
  3369. <entry><constant>V4L2_AUTO_FOCUS_STATUS_IDLE</constant>&nbsp;</entry>
  3370. <entry>Automatic focus is not active.</entry>
  3371. </row>
  3372. <row>
  3373. <entry><constant>V4L2_AUTO_FOCUS_STATUS_BUSY</constant>&nbsp;</entry>
  3374. <entry>Automatic focusing is in progress.</entry>
  3375. </row>
  3376. <row>
  3377. <entry><constant>V4L2_AUTO_FOCUS_STATUS_REACHED</constant>&nbsp;</entry>
  3378. <entry>Focus has been reached.</entry>
  3379. </row>
  3380. <row>
  3381. <entry><constant>V4L2_AUTO_FOCUS_STATUS_FAILED</constant>&nbsp;</entry>
  3382. <entry>Automatic focus has failed, the driver will not
  3383. transition from this state until another action is
  3384. performed by an application.</entry>
  3385. </row>
  3386. </tbody>
  3387. </entrytbl>
  3388. </row>
  3389. <row><entry spanname="descr">
  3390. Setting <constant>V4L2_LOCK_FOCUS</constant> lock bit of the <constant>V4L2_CID_3A_LOCK
  3391. </constant> control may stop updates of the <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>
  3392. control value.</entry>
  3393. </row>
  3394. <row><entry></entry></row>
  3395. <row id="v4l2-auto-focus-range">
  3396. <entry spanname="id">
  3397. <constant>V4L2_CID_AUTO_FOCUS_RANGE</constant>&nbsp;</entry>
  3398. <entry>enum&nbsp;v4l2_auto_focus_range</entry>
  3399. </row>
  3400. <row><entry spanname="descr">Determines auto focus distance range
  3401. for which lens may be adjusted. </entry>
  3402. </row>
  3403. <row>
  3404. <entrytbl spanname="descr" cols="2">
  3405. <tbody valign="top">
  3406. <row>
  3407. <entry><constant>V4L2_AUTO_FOCUS_RANGE_AUTO</constant>&nbsp;</entry>
  3408. <entry>The camera automatically selects the focus range.</entry>
  3409. </row>
  3410. <row>
  3411. <entry><constant>V4L2_AUTO_FOCUS_RANGE_NORMAL</constant>&nbsp;</entry>
  3412. <entry>Normal distance range, limited for best automatic focus
  3413. performance.</entry>
  3414. </row>
  3415. <row>
  3416. <entry><constant>V4L2_AUTO_FOCUS_RANGE_MACRO</constant>&nbsp;</entry>
  3417. <entry>Macro (close-up) auto focus. The camera will
  3418. use its minimum possible distance for auto focus.</entry>
  3419. </row>
  3420. <row>
  3421. <entry><constant>V4L2_AUTO_FOCUS_RANGE_INFINITY</constant>&nbsp;</entry>
  3422. <entry>The lens is set to focus on an object at infinite distance.</entry>
  3423. </row>
  3424. </tbody>
  3425. </entrytbl>
  3426. </row>
  3427. <row><entry></entry></row>
  3428. <row>
  3429. <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry>
  3430. <entry>integer</entry>
  3431. </row><row><entry spanname="descr">Specify the objective lens
  3432. focal length as an absolute value. The zoom unit is driver-specific and its
  3433. value should be a positive integer.</entry>
  3434. </row>
  3435. <row><entry></entry></row>
  3436. <row>
  3437. <entry spanname="id"><constant>V4L2_CID_ZOOM_RELATIVE</constant>&nbsp;</entry>
  3438. <entry>integer</entry>
  3439. </row><row><entry spanname="descr">Specify the objective lens
  3440. focal length relatively to the current value. Positive values move the zoom
  3441. lens group towards the telephoto direction, negative values towards the
  3442. wide-angle direction. The zoom unit is driver-specific. This is a write-only control.</entry>
  3443. </row>
  3444. <row><entry></entry></row>
  3445. <row>
  3446. <entry spanname="id"><constant>V4L2_CID_ZOOM_CONTINUOUS</constant>&nbsp;</entry>
  3447. <entry>integer</entry>
  3448. </row><row><entry spanname="descr">Move the objective lens group
  3449. at the specified speed until it reaches physical device limits or until an
  3450. explicit request to stop the movement. A positive value moves the zoom lens
  3451. group towards the telephoto direction. A value of zero stops the zoom lens
  3452. group movement. A negative value moves the zoom lens group towards the
  3453. wide-angle direction. The zoom speed unit is driver-specific.</entry>
  3454. </row>
  3455. <row><entry></entry></row>
  3456. <row>
  3457. <entry spanname="id"><constant>V4L2_CID_IRIS_ABSOLUTE</constant>&nbsp;</entry>
  3458. <entry>integer</entry>
  3459. </row><row><entry spanname="descr">This control sets the
  3460. camera's aperture to the specified value. The unit is undefined.
  3461. Larger values open the iris wider, smaller values close it.</entry>
  3462. </row>
  3463. <row><entry></entry></row>
  3464. <row>
  3465. <entry spanname="id"><constant>V4L2_CID_IRIS_RELATIVE</constant>&nbsp;</entry>
  3466. <entry>integer</entry>
  3467. </row><row><entry spanname="descr">This control modifies the
  3468. camera's aperture by the specified amount. The unit is undefined.
  3469. Positive values open the iris one step further, negative values close
  3470. it one step further. This is a write-only control.</entry>
  3471. </row>
  3472. <row><entry></entry></row>
  3473. <row>
  3474. <entry spanname="id"><constant>V4L2_CID_PRIVACY</constant>&nbsp;</entry>
  3475. <entry>boolean</entry>
  3476. </row><row><entry spanname="descr">Prevent video from being acquired
  3477. by the camera. When this control is set to <constant>TRUE</constant> (1), no
  3478. image can be captured by the camera. Common means to enforce privacy are
  3479. mechanical obturation of the sensor and firmware image processing, but the
  3480. device is not restricted to these methods. Devices that implement the privacy
  3481. control must support read access and may support write access.</entry>
  3482. </row>
  3483. <row>
  3484. <entry spanname="id"><constant>V4L2_CID_BAND_STOP_FILTER</constant>&nbsp;</entry>
  3485. <entry>integer</entry>
  3486. </row><row><entry spanname="descr">Switch the band-stop filter of a
  3487. camera sensor on or off, or specify its strength. Such band-stop filters can
  3488. be used, for example, to filter out the fluorescent light component.</entry>
  3489. </row>
  3490. <row><entry></entry></row>
  3491. <row id="v4l2-auto-n-preset-white-balance">
  3492. <entry spanname="id"><constant>V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE</constant>&nbsp;</entry>
  3493. <entry>enum&nbsp;v4l2_auto_n_preset_white_balance</entry>
  3494. </row><row><entry spanname="descr">Sets white balance to automatic,
  3495. manual or a preset. The presets determine color temperature of the light as
  3496. a hint to the camera for white balance adjustments resulting in most accurate
  3497. color representation. The following white balance presets are listed in order
  3498. of increasing color temperature.</entry>
  3499. </row>
  3500. <row>
  3501. <entrytbl spanname="descr" cols="2">
  3502. <tbody valign="top">
  3503. <row>
  3504. <entry><constant>V4L2_WHITE_BALANCE_MANUAL</constant>&nbsp;</entry>
  3505. <entry>Manual white balance.</entry>
  3506. </row>
  3507. <row>
  3508. <entry><constant>V4L2_WHITE_BALANCE_AUTO</constant>&nbsp;</entry>
  3509. <entry>Automatic white balance adjustments.</entry>
  3510. </row>
  3511. <row>
  3512. <entry><constant>V4L2_WHITE_BALANCE_INCANDESCENT</constant>&nbsp;</entry>
  3513. <entry>White balance setting for incandescent (tungsten) lighting.
  3514. It generally cools down the colors and corresponds approximately to 2500...3500 K
  3515. color temperature range.</entry>
  3516. </row>
  3517. <row>
  3518. <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT</constant>&nbsp;</entry>
  3519. <entry>White balance preset for fluorescent lighting.
  3520. It corresponds approximately to 4000...5000 K color temperature.</entry>
  3521. </row>
  3522. <row>
  3523. <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT_H</constant>&nbsp;</entry>
  3524. <entry>With this setting the camera will compensate for
  3525. fluorescent H lighting.</entry>
  3526. </row>
  3527. <row>
  3528. <entry><constant>V4L2_WHITE_BALANCE_HORIZON</constant>&nbsp;</entry>
  3529. <entry>White balance setting for horizon daylight.
  3530. It corresponds approximately to 5000 K color temperature.</entry>
  3531. </row>
  3532. <row>
  3533. <entry><constant>V4L2_WHITE_BALANCE_DAYLIGHT</constant>&nbsp;</entry>
  3534. <entry>White balance preset for daylight (with clear sky).
  3535. It corresponds approximately to 5000...6500 K color temperature.</entry>
  3536. </row>
  3537. <row>
  3538. <entry><constant>V4L2_WHITE_BALANCE_FLASH</constant>&nbsp;</entry>
  3539. <entry>With this setting the camera will compensate for the flash
  3540. light. It slightly warms up the colors and corresponds roughly to 5000...5500 K
  3541. color temperature.</entry>
  3542. </row>
  3543. <row>
  3544. <entry><constant>V4L2_WHITE_BALANCE_CLOUDY</constant>&nbsp;</entry>
  3545. <entry>White balance preset for moderately overcast sky.
  3546. This option corresponds approximately to 6500...8000 K color temperature
  3547. range.</entry>
  3548. </row>
  3549. <row>
  3550. <entry><constant>V4L2_WHITE_BALANCE_SHADE</constant>&nbsp;</entry>
  3551. <entry>White balance preset for shade or heavily overcast
  3552. sky. It corresponds approximately to 9000...10000 K color temperature.
  3553. </entry>
  3554. </row>
  3555. </tbody>
  3556. </entrytbl>
  3557. </row>
  3558. <row><entry></entry></row>
  3559. <row id="v4l2-wide-dynamic-range">
  3560. <entry spanname="id"><constant>V4L2_CID_WIDE_DYNAMIC_RANGE</constant></entry>
  3561. <entry>boolean</entry>
  3562. </row>
  3563. <row>
  3564. <entry spanname="descr">Enables or disables the camera's wide dynamic
  3565. range feature. This feature allows to obtain clear images in situations where
  3566. intensity of the illumination varies significantly throughout the scene, i.e.
  3567. there are simultaneously very dark and very bright areas. It is most commonly
  3568. realized in cameras by combining two subsequent frames with different exposure
  3569. times. <footnote id="ctypeconv"><para> This control may be changed to a menu
  3570. control in the future, if more options are required.</para></footnote></entry>
  3571. </row>
  3572. <row><entry></entry></row>
  3573. <row id="v4l2-image-stabilization">
  3574. <entry spanname="id"><constant>V4L2_CID_IMAGE_STABILIZATION</constant></entry>
  3575. <entry>boolean</entry>
  3576. </row>
  3577. <row>
  3578. <entry spanname="descr">Enables or disables image stabilization.
  3579. <footnoteref linkend="ctypeconv"/></entry>
  3580. </row>
  3581. <row><entry></entry></row>
  3582. <row>
  3583. <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY</constant>&nbsp;</entry>
  3584. <entry>integer menu</entry>
  3585. </row><row><entry spanname="descr">Determines ISO equivalent of an
  3586. image sensor indicating the sensor's sensitivity to light. The numbers are
  3587. expressed in arithmetic scale, as per <xref linkend="iso12232" /> standard,
  3588. where doubling the sensor sensitivity is represented by doubling the numerical
  3589. ISO value. Applications should interpret the values as standard ISO values
  3590. multiplied by 1000, e.g. control value 800 stands for ISO 0.8. Drivers will
  3591. usually support only a subset of standard ISO values. The effect of setting
  3592. this control while the <constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>
  3593. control is set to a value other than <constant>V4L2_CID_ISO_SENSITIVITY_MANUAL
  3594. </constant> is undefined, drivers should ignore such requests.</entry>
  3595. </row>
  3596. <row><entry></entry></row>
  3597. <row id="v4l2-iso-sensitivity-auto-type">
  3598. <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
  3599. <entry>enum&nbsp;v4l2_iso_sensitivity_type</entry>
  3600. </row><row><entry spanname="descr">Enables or disables automatic ISO
  3601. sensitivity adjustments.</entry>
  3602. </row>
  3603. <row>
  3604. <entrytbl spanname="descr" cols="2">
  3605. <tbody valign="top">
  3606. <row>
  3607. <entry><constant>V4L2_CID_ISO_SENSITIVITY_MANUAL</constant>&nbsp;</entry>
  3608. <entry>Manual ISO sensitivity.</entry>
  3609. </row>
  3610. <row>
  3611. <entry><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
  3612. <entry>Automatic ISO sensitivity adjustments.</entry>
  3613. </row>
  3614. </tbody>
  3615. </entrytbl>
  3616. </row>
  3617. <row><entry></entry></row>
  3618. <row id="v4l2-scene-mode">
  3619. <entry spanname="id"><constant>V4L2_CID_SCENE_MODE</constant>&nbsp;</entry>
  3620. <entry>enum&nbsp;v4l2_scene_mode</entry>
  3621. </row><row><entry spanname="descr">This control allows to select
  3622. scene programs as the camera automatic modes optimized for common shooting
  3623. scenes. Within these modes the camera determines best exposure, aperture,
  3624. focusing, light metering, white balance and equivalent sensitivity. The
  3625. controls of those parameters are influenced by the scene mode control.
  3626. An exact behavior in each mode is subject to the camera specification.
  3627. <para>When the scene mode feature is not used, this control should be set to
  3628. <constant>V4L2_SCENE_MODE_NONE</constant> to make sure the other possibly
  3629. related controls are accessible. The following scene programs are defined:
  3630. </para>
  3631. </entry>
  3632. </row>
  3633. <row>
  3634. <entrytbl spanname="descr" cols="2">
  3635. <tbody valign="top">
  3636. <row>
  3637. <entry><constant>V4L2_SCENE_MODE_NONE</constant>&nbsp;</entry>
  3638. <entry>The scene mode feature is disabled.</entry>
  3639. </row>
  3640. <row>
  3641. <entry><constant>V4L2_SCENE_MODE_BACKLIGHT</constant>&nbsp;</entry>
  3642. <entry>Backlight. Compensates for dark shadows when light is
  3643. coming from behind a subject, also by automatically turning
  3644. on the flash.</entry>
  3645. </row>
  3646. <row>
  3647. <entry><constant>V4L2_SCENE_MODE_BEACH_SNOW</constant>&nbsp;</entry>
  3648. <entry>Beach and snow. This mode compensates for all-white or
  3649. bright scenes, which tend to look gray and low contrast, when camera's automatic
  3650. exposure is based on an average scene brightness. To compensate, this mode
  3651. automatically slightly overexposes the frames. The white balance may also be
  3652. adjusted to compensate for the fact that reflected snow looks bluish rather
  3653. than white.</entry>
  3654. </row>
  3655. <row>
  3656. <entry><constant>V4L2_SCENE_MODE_CANDLELIGHT</constant>&nbsp;</entry>
  3657. <entry>Candle light. The camera generally raises the ISO
  3658. sensitivity and lowers the shutter speed. This mode compensates for relatively
  3659. close subject in the scene. The flash is disabled in order to preserve the
  3660. ambiance of the light.</entry>
  3661. </row>
  3662. <row>
  3663. <entry><constant>V4L2_SCENE_MODE_DAWN_DUSK</constant>&nbsp;</entry>
  3664. <entry>Dawn and dusk. Preserves the colors seen in low
  3665. natural light before dusk and after down. The camera may turn off the flash,
  3666. and automatically focus at infinity. It will usually boost saturation and
  3667. lower the shutter speed.</entry>
  3668. </row>
  3669. <row>
  3670. <entry><constant>V4L2_SCENE_MODE_FALL_COLORS</constant>&nbsp;</entry>
  3671. <entry>Fall colors. Increases saturation and adjusts white
  3672. balance for color enhancement. Pictures of autumn leaves get saturated reds
  3673. and yellows.</entry>
  3674. </row>
  3675. <row>
  3676. <entry><constant>V4L2_SCENE_MODE_FIREWORKS</constant>&nbsp;</entry>
  3677. <entry>Fireworks. Long exposure times are used to capture
  3678. the expanding burst of light from a firework. The camera may invoke image
  3679. stabilization.</entry>
  3680. </row>
  3681. <row>
  3682. <entry><constant>V4L2_SCENE_MODE_LANDSCAPE</constant>&nbsp;</entry>
  3683. <entry>Landscape. The camera may choose a small aperture to
  3684. provide deep depth of field and long exposure duration to help capture detail
  3685. in dim light conditions. The focus is fixed at infinity. Suitable for distant
  3686. and wide scenery.</entry>
  3687. </row>
  3688. <row>
  3689. <entry><constant>V4L2_SCENE_MODE_NIGHT</constant>&nbsp;</entry>
  3690. <entry>Night, also known as Night Landscape. Designed for low
  3691. light conditions, it preserves detail in the dark areas without blowing out bright
  3692. objects. The camera generally sets itself to a medium-to-high ISO sensitivity,
  3693. with a relatively long exposure time, and turns flash off. As such, there will be
  3694. increased image noise and the possibility of blurred image.</entry>
  3695. </row>
  3696. <row>
  3697. <entry><constant>V4L2_SCENE_MODE_PARTY_INDOOR</constant>&nbsp;</entry>
  3698. <entry>Party and indoor. Designed to capture indoor scenes
  3699. that are lit by indoor background lighting as well as the flash. The camera
  3700. usually increases ISO sensitivity, and adjusts exposure for the low light
  3701. conditions.</entry>
  3702. </row>
  3703. <row>
  3704. <entry><constant>V4L2_SCENE_MODE_PORTRAIT</constant>&nbsp;</entry>
  3705. <entry>Portrait. The camera adjusts the aperture so that the
  3706. depth of field is reduced, which helps to isolate the subject against a smooth
  3707. background. Most cameras recognize the presence of faces in the scene and focus
  3708. on them. The color hue is adjusted to enhance skin tones. The intensity of the
  3709. flash is often reduced.</entry>
  3710. </row>
  3711. <row>
  3712. <entry><constant>V4L2_SCENE_MODE_SPORTS</constant>&nbsp;</entry>
  3713. <entry>Sports. Significantly increases ISO and uses a fast
  3714. shutter speed to freeze motion of rapidly-moving subjects. Increased image
  3715. noise may be seen in this mode.</entry>
  3716. </row>
  3717. <row>
  3718. <entry><constant>V4L2_SCENE_MODE_SUNSET</constant>&nbsp;</entry>
  3719. <entry>Sunset. Preserves deep hues seen in sunsets and
  3720. sunrises. It bumps up the saturation.</entry>
  3721. </row>
  3722. <row>
  3723. <entry><constant>V4L2_SCENE_MODE_TEXT</constant>&nbsp;</entry>
  3724. <entry>Text. It applies extra contrast and sharpness, it is
  3725. typically a black-and-white mode optimized for readability. Automatic focus
  3726. may be switched to close-up mode and this setting may also involve some
  3727. lens-distortion correction.</entry>
  3728. </row>
  3729. </tbody>
  3730. </entrytbl>
  3731. </row>
  3732. <row><entry></entry></row>
  3733. <row>
  3734. <entry spanname="id"><constant>V4L2_CID_3A_LOCK</constant></entry>
  3735. <entry>bitmask</entry>
  3736. </row>
  3737. <row>
  3738. <entry spanname="descr">This control locks or unlocks the automatic
  3739. focus, exposure and white balance. The automatic adjustments can be paused
  3740. independently by setting the corresponding lock bit to 1. The camera then retains
  3741. the settings until the lock bit is cleared. The following lock bits are defined:
  3742. </entry>
  3743. </row>
  3744. <row>
  3745. <entrytbl spanname="descr" cols="2">
  3746. <tbody valign="top">
  3747. <row>
  3748. <entry><constant>V4L2_LOCK_EXPOSURE</constant></entry>
  3749. <entry>Automatic exposure adjustments lock.</entry>
  3750. </row>
  3751. <row>
  3752. <entry><constant>V4L2_LOCK_WHITE_BALANCE</constant></entry>
  3753. <entry>Automatic white balance adjustments lock.</entry>
  3754. </row>
  3755. <row>
  3756. <entry><constant>V4L2_LOCK_FOCUS</constant></entry>
  3757. <entry>Automatic focus lock.</entry>
  3758. </row>
  3759. </tbody>
  3760. </entrytbl>
  3761. </row>
  3762. <row><entry spanname="descr">
  3763. When a given algorithm is not enabled, drivers should ignore requests
  3764. to lock it and should return no error. An example might be an application
  3765. setting bit <constant>V4L2_LOCK_WHITE_BALANCE</constant> when the
  3766. <constant>V4L2_CID_AUTO_WHITE_BALANCE</constant> control is set to
  3767. <constant>FALSE</constant>. The value of this control may be changed
  3768. by exposure, white balance or focus controls.</entry>
  3769. </row>
  3770. <row><entry></entry></row>
  3771. <row>
  3772. <entry spanname="id"><constant>V4L2_CID_PAN_SPEED</constant>&nbsp;</entry>
  3773. <entry>integer</entry>
  3774. </row><row><entry spanname="descr">This control turns the
  3775. camera horizontally at the specific speed. The unit is undefined. A
  3776. positive value moves the camera to the right (clockwise when viewed
  3777. from above), a negative value to the left. A value of zero stops the motion
  3778. if one is in progress and has no effect otherwise.</entry>
  3779. </row>
  3780. <row><entry></entry></row>
  3781. <row>
  3782. <entry spanname="id"><constant>V4L2_CID_TILT_SPEED</constant>&nbsp;</entry>
  3783. <entry>integer</entry>
  3784. </row><row><entry spanname="descr">This control turns the
  3785. camera vertically at the specified speed. The unit is undefined. A
  3786. positive value moves the camera up, a negative value down. A value of zero
  3787. stops the motion if one is in progress and has no effect otherwise.</entry>
  3788. </row>
  3789. <row><entry></entry></row>
  3790. </tbody>
  3791. </tgroup>
  3792. </table>
  3793. </section>
  3794. <section id="fm-tx-controls">
  3795. <title>FM Transmitter Control Reference</title>
  3796. <para>The FM Transmitter (FM_TX) class includes controls for common features of
  3797. FM transmissions capable devices. Currently this class includes parameters for audio
  3798. compression, pilot tone generation, audio deviation limiter, RDS transmission and
  3799. tuning power features.</para>
  3800. <table pgwide="1" frame="none" id="fm-tx-control-id">
  3801. <title>FM_TX Control IDs</title>
  3802. <tgroup cols="4">
  3803. <colspec colname="c1" colwidth="1*" />
  3804. <colspec colname="c2" colwidth="6*" />
  3805. <colspec colname="c3" colwidth="2*" />
  3806. <colspec colname="c4" colwidth="6*" />
  3807. <spanspec namest="c1" nameend="c2" spanname="id" />
  3808. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3809. <thead>
  3810. <row>
  3811. <entry spanname="id" align="left">ID</entry>
  3812. <entry align="left">Type</entry>
  3813. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3814. </row>
  3815. </thead>
  3816. <tbody valign="top">
  3817. <row><entry></entry></row>
  3818. <row>
  3819. <entry spanname="id"><constant>V4L2_CID_FM_TX_CLASS</constant>&nbsp;</entry>
  3820. <entry>class</entry>
  3821. </row><row><entry spanname="descr">The FM_TX class
  3822. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  3823. description of this control class.</entry>
  3824. </row>
  3825. <row>
  3826. <entry spanname="id"><constant>V4L2_CID_RDS_TX_DEVIATION</constant>&nbsp;</entry>
  3827. <entry>integer</entry>
  3828. </row>
  3829. <row><entry spanname="descr">Configures RDS signal frequency deviation level in Hz.
  3830. The range and step are driver-specific.</entry>
  3831. </row>
  3832. <row>
  3833. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PI</constant>&nbsp;</entry>
  3834. <entry>integer</entry>
  3835. </row>
  3836. <row><entry spanname="descr">Sets the RDS Programme Identification field
  3837. for transmission.</entry>
  3838. </row>
  3839. <row>
  3840. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PTY</constant>&nbsp;</entry>
  3841. <entry>integer</entry>
  3842. </row>
  3843. <row><entry spanname="descr">Sets the RDS Programme Type field for transmission.
  3844. This encodes up to 31 pre-defined programme types.</entry>
  3845. </row>
  3846. <row>
  3847. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PS_NAME</constant>&nbsp;</entry>
  3848. <entry>string</entry>
  3849. </row>
  3850. <row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission.
  3851. It is intended for static display on a receiver. It is the primary aid to listeners in programme service
  3852. identification and selection. In Annex E of <xref linkend="iec62106" />, the RDS specification,
  3853. there is a full description of the correct character encoding for Programme Service name strings.
  3854. Also from RDS specification, PS is usually a single eight character text. However, it is also possible
  3855. to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
  3856. with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry>
  3857. </row>
  3858. <row>
  3859. <entry spanname="id"><constant>V4L2_CID_RDS_TX_RADIO_TEXT</constant>&nbsp;</entry>
  3860. <entry>string</entry>
  3861. </row>
  3862. <row><entry spanname="descr">Sets the Radio Text info for transmission. It is a textual description of
  3863. what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
  3864. programme-related information or any other text. In these cases, RadioText should be used in addition to
  3865. <constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
  3866. in Annex E of <xref linkend="iec62106" />. The length of Radio Text strings depends on which RDS Block is being
  3867. used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
  3868. to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
  3869. with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
  3870. </row>
  3871. <row>
  3872. <entry spanname="id"><constant>V4L2_CID_RDS_TX_MONO_STEREO</constant>&nbsp;</entry>
  3873. <entry>boolean</entry>
  3874. </row>
  3875. <row><entry spanname="descr">Sets the Mono/Stereo bit of the Decoder Identification code. If set,
  3876. then the audio was recorded as stereo.</entry>
  3877. </row>
  3878. <row>
  3879. <entry spanname="id"><constant>V4L2_CID_RDS_TX_ARTIFICIAL_HEAD</constant>&nbsp;</entry>
  3880. <entry>boolean</entry>
  3881. </row>
  3882. <row><entry spanname="descr">Sets the
  3883. <ulink url="http://en.wikipedia.org/wiki/Artificial_head">Artificial Head</ulink> bit of the Decoder
  3884. Identification code. If set, then the audio was recorded using an artificial head.</entry>
  3885. </row>
  3886. <row>
  3887. <entry spanname="id"><constant>V4L2_CID_RDS_TX_COMPRESSED</constant>&nbsp;</entry>
  3888. <entry>boolean</entry>
  3889. </row>
  3890. <row><entry spanname="descr">Sets the Compressed bit of the Decoder Identification code. If set,
  3891. then the audio is compressed.</entry>
  3892. </row>
  3893. <row>
  3894. <entry spanname="id"><constant>V4L2_CID_RDS_TX_DYNAMIC_PTY</constant>&nbsp;</entry>
  3895. <entry>boolean</entry>
  3896. </row>
  3897. <row><entry spanname="descr">Sets the Dynamic PTY bit of the Decoder Identification code. If set,
  3898. then the PTY code is dynamically switched.</entry>
  3899. </row>
  3900. <row>
  3901. <entry spanname="id"><constant>V4L2_CID_RDS_TX_TRAFFIC_ANNOUNCEMENT</constant>&nbsp;</entry>
  3902. <entry>boolean</entry>
  3903. </row>
  3904. <row><entry spanname="descr">If set, then a traffic announcement is in progress.</entry>
  3905. </row>
  3906. <row>
  3907. <entry spanname="id"><constant>V4L2_CID_RDS_TX_TRAFFIC_PROGRAM</constant>&nbsp;</entry>
  3908. <entry>boolean</entry>
  3909. </row>
  3910. <row><entry spanname="descr">If set, then the tuned programme carries traffic announcements.</entry>
  3911. </row>
  3912. <row>
  3913. <entry spanname="id"><constant>V4L2_CID_RDS_TX_MUSIC_SPEECH</constant>&nbsp;</entry>
  3914. <entry>boolean</entry>
  3915. </row>
  3916. <row><entry spanname="descr">If set, then this channel broadcasts music. If cleared, then it
  3917. broadcasts speech. If the transmitter doesn't make this distinction, then it should be set.</entry>
  3918. </row>
  3919. <row>
  3920. <entry spanname="id"><constant>V4L2_CID_RDS_TX_ALT_FREQS_ENABLE</constant>&nbsp;</entry>
  3921. <entry>boolean</entry>
  3922. </row>
  3923. <row><entry spanname="descr">If set, then transmit alternate frequencies.</entry>
  3924. </row>
  3925. <row>
  3926. <entry spanname="id"><constant>V4L2_CID_RDS_TX_ALT_FREQS</constant>&nbsp;</entry>
  3927. <entry>__u32 array</entry>
  3928. </row>
  3929. <row><entry spanname="descr">The alternate frequencies in kHz units. The RDS standard allows
  3930. for up to 25 frequencies to be defined. Drivers may support fewer frequencies so check
  3931. the array size.</entry>
  3932. </row>
  3933. <row>
  3934. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant>&nbsp;</entry>
  3935. <entry>boolean</entry>
  3936. </row>
  3937. <row><entry spanname="descr">Enables or disables the audio deviation limiter feature.
  3938. The limiter is useful when trying to maximize the audio volume, minimize receiver-generated
  3939. distortion and prevent overmodulation.
  3940. </entry>
  3941. </row>
  3942. <row>
  3943. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_RELEASE_TIME</constant>&nbsp;</entry>
  3944. <entry>integer</entry>
  3945. </row>
  3946. <row><entry spanname="descr">Sets the audio deviation limiter feature release time.
  3947. Unit is in useconds. Step and range are driver-specific.</entry>
  3948. </row>
  3949. <row>
  3950. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_DEVIATION</constant>&nbsp;</entry>
  3951. <entry>integer</entry>
  3952. </row>
  3953. <row><entry spanname="descr">Configures audio frequency deviation level in Hz.
  3954. The range and step are driver-specific.</entry>
  3955. </row>
  3956. <row>
  3957. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ENABLED</constant>&nbsp;</entry>
  3958. <entry>boolean</entry>
  3959. </row>
  3960. <row><entry spanname="descr">Enables or disables the audio compression feature.
  3961. This feature amplifies signals below the threshold by a fixed gain and compresses audio
  3962. signals above the threshold by the ratio of Threshold/(Gain + Threshold).</entry>
  3963. </row>
  3964. <row>
  3965. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_GAIN</constant>&nbsp;</entry>
  3966. <entry>integer</entry>
  3967. </row>
  3968. <row><entry spanname="descr">Sets the gain for audio compression feature. It is
  3969. a dB value. The range and step are driver-specific.</entry>
  3970. </row>
  3971. <row>
  3972. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_THRESHOLD</constant>&nbsp;</entry>
  3973. <entry>integer</entry>
  3974. </row>
  3975. <row><entry spanname="descr">Sets the threshold level for audio compression freature.
  3976. It is a dB value. The range and step are driver-specific.</entry>
  3977. </row>
  3978. <row>
  3979. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME</constant>&nbsp;</entry>
  3980. <entry>integer</entry>
  3981. </row>
  3982. <row><entry spanname="descr">Sets the attack time for audio compression feature.
  3983. It is a useconds value. The range and step are driver-specific.</entry>
  3984. </row>
  3985. <row>
  3986. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME</constant>&nbsp;</entry>
  3987. <entry>integer</entry>
  3988. </row>
  3989. <row><entry spanname="descr">Sets the release time for audio compression feature.
  3990. It is a useconds value. The range and step are driver-specific.</entry>
  3991. </row>
  3992. <row>
  3993. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_ENABLED</constant>&nbsp;</entry>
  3994. <entry>boolean</entry>
  3995. </row>
  3996. <row><entry spanname="descr">Enables or disables the pilot tone generation feature.</entry>
  3997. </row>
  3998. <row>
  3999. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_DEVIATION</constant>&nbsp;</entry>
  4000. <entry>integer</entry>
  4001. </row>
  4002. <row><entry spanname="descr">Configures pilot tone frequency deviation level. Unit is
  4003. in Hz. The range and step are driver-specific.</entry>
  4004. </row>
  4005. <row>
  4006. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_FREQUENCY</constant>&nbsp;</entry>
  4007. <entry>integer</entry>
  4008. </row>
  4009. <row><entry spanname="descr">Configures pilot tone frequency value. Unit is
  4010. in Hz. The range and step are driver-specific.</entry>
  4011. </row>
  4012. <row>
  4013. <entry spanname="id"><constant>V4L2_CID_TUNE_PREEMPHASIS</constant>&nbsp;</entry>
  4014. <entry>enum v4l2_preemphasis</entry>
  4015. </row>
  4016. <row id="v4l2-preemphasis"><entry spanname="descr">Configures the pre-emphasis value for broadcasting.
  4017. A pre-emphasis filter is applied to the broadcast to accentuate the high audio frequencies.
  4018. Depending on the region, a time constant of either 50 or 75 useconds is used. The enum&nbsp;v4l2_preemphasis
  4019. defines possible values for pre-emphasis. Here they are:</entry>
  4020. </row><row>
  4021. <entrytbl spanname="descr" cols="2">
  4022. <tbody valign="top">
  4023. <row>
  4024. <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant>&nbsp;</entry>
  4025. <entry>No pre-emphasis is applied.</entry>
  4026. </row>
  4027. <row>
  4028. <entry><constant>V4L2_PREEMPHASIS_50_uS</constant>&nbsp;</entry>
  4029. <entry>A pre-emphasis of 50 uS is used.</entry>
  4030. </row>
  4031. <row>
  4032. <entry><constant>V4L2_PREEMPHASIS_75_uS</constant>&nbsp;</entry>
  4033. <entry>A pre-emphasis of 75 uS is used.</entry>
  4034. </row>
  4035. </tbody>
  4036. </entrytbl>
  4037. </row>
  4038. <row>
  4039. <entry spanname="id"><constant>V4L2_CID_TUNE_POWER_LEVEL</constant>&nbsp;</entry>
  4040. <entry>integer</entry>
  4041. </row>
  4042. <row><entry spanname="descr">Sets the output power level for signal transmission.
  4043. Unit is in dBuV. Range and step are driver-specific.</entry>
  4044. </row>
  4045. <row>
  4046. <entry spanname="id"><constant>V4L2_CID_TUNE_ANTENNA_CAPACITOR</constant>&nbsp;</entry>
  4047. <entry>integer</entry>
  4048. </row>
  4049. <row><entry spanname="descr">This selects the value of antenna tuning capacitor
  4050. manually or automatically if set to zero. Unit, range and step are driver-specific.</entry>
  4051. </row>
  4052. <row><entry></entry></row>
  4053. </tbody>
  4054. </tgroup>
  4055. </table>
  4056. <para>For more details about RDS specification, refer to
  4057. <xref linkend="iec62106" /> document, from CENELEC.</para>
  4058. </section>
  4059. <section id="flash-controls">
  4060. <title>Flash Control Reference</title>
  4061. <note>
  4062. <title>Experimental</title>
  4063. <para>This is an <link linkend="experimental">experimental</link>
  4064. interface and may change in the future.</para>
  4065. </note>
  4066. <para>
  4067. The V4L2 flash controls are intended to provide generic access
  4068. to flash controller devices. Flash controller devices are
  4069. typically used in digital cameras.
  4070. </para>
  4071. <para>
  4072. The interface can support both LED and xenon flash devices. As
  4073. of writing this, there is no xenon flash driver using this
  4074. interface.
  4075. </para>
  4076. <section id="flash-controls-use-cases">
  4077. <title>Supported use cases</title>
  4078. <section>
  4079. <title>Unsynchronised LED flash (software strobe)</title>
  4080. <para>
  4081. Unsynchronised LED flash is controlled directly by the
  4082. host as the sensor. The flash must be enabled by the host
  4083. before the exposure of the image starts and disabled once
  4084. it ends. The host is fully responsible for the timing of
  4085. the flash.
  4086. </para>
  4087. <para>Example of such device: Nokia N900.</para>
  4088. </section>
  4089. <section>
  4090. <title>Synchronised LED flash (hardware strobe)</title>
  4091. <para>
  4092. The synchronised LED flash is pre-programmed by the host
  4093. (power and timeout) but controlled by the sensor through a
  4094. strobe signal from the sensor to the flash.
  4095. </para>
  4096. <para>
  4097. The sensor controls the flash duration and timing. This
  4098. information typically must be made available to the
  4099. sensor.
  4100. </para>
  4101. </section>
  4102. <section>
  4103. <title>LED flash as torch</title>
  4104. <para>
  4105. LED flash may be used as torch in conjunction with another
  4106. use case involving camera or individually.
  4107. </para>
  4108. <table pgwide="1" frame="none" id="flash-control-id">
  4109. <title>Flash Control IDs</title>
  4110. <tgroup cols="4">
  4111. <colspec colname="c1" colwidth="1*" />
  4112. <colspec colname="c2" colwidth="6*" />
  4113. <colspec colname="c3" colwidth="2*" />
  4114. <colspec colname="c4" colwidth="6*" />
  4115. <spanspec namest="c1" nameend="c2" spanname="id" />
  4116. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4117. <thead>
  4118. <row>
  4119. <entry spanname="id" align="left">ID</entry>
  4120. <entry align="left">Type</entry>
  4121. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4122. </row>
  4123. </thead>
  4124. <tbody valign="top">
  4125. <row><entry></entry></row>
  4126. <row>
  4127. <entry spanname="id"><constant>V4L2_CID_FLASH_CLASS</constant></entry>
  4128. <entry>class</entry>
  4129. </row>
  4130. <row>
  4131. <entry spanname="descr">The FLASH class descriptor.</entry>
  4132. </row>
  4133. <row>
  4134. <entry spanname="id"><constant>V4L2_CID_FLASH_LED_MODE</constant></entry>
  4135. <entry>menu</entry>
  4136. </row>
  4137. <row id="v4l2-flash-led-mode">
  4138. <entry spanname="descr">Defines the mode of the flash LED,
  4139. the high-power white LED attached to the flash controller.
  4140. Setting this control may not be possible in presence of
  4141. some faults. See V4L2_CID_FLASH_FAULT.</entry>
  4142. </row>
  4143. <row>
  4144. <entrytbl spanname="descr" cols="2">
  4145. <tbody valign="top">
  4146. <row>
  4147. <entry><constant>V4L2_FLASH_LED_MODE_NONE</constant></entry>
  4148. <entry>Off.</entry>
  4149. </row>
  4150. <row>
  4151. <entry><constant>V4L2_FLASH_LED_MODE_FLASH</constant></entry>
  4152. <entry>Flash mode.</entry>
  4153. </row>
  4154. <row>
  4155. <entry><constant>V4L2_FLASH_LED_MODE_TORCH</constant></entry>
  4156. <entry>Torch mode. See V4L2_CID_FLASH_TORCH_INTENSITY.</entry>
  4157. </row>
  4158. </tbody>
  4159. </entrytbl>
  4160. </row>
  4161. <row>
  4162. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_SOURCE</constant></entry>
  4163. <entry>menu</entry>
  4164. </row>
  4165. <row id="v4l2-flash-strobe-source"><entry
  4166. spanname="descr">Defines the source of the flash LED
  4167. strobe.</entry>
  4168. </row>
  4169. <row>
  4170. <entrytbl spanname="descr" cols="2">
  4171. <tbody valign="top">
  4172. <row>
  4173. <entry><constant>V4L2_FLASH_STROBE_SOURCE_SOFTWARE</constant></entry>
  4174. <entry>The flash strobe is triggered by using
  4175. the V4L2_CID_FLASH_STROBE control.</entry>
  4176. </row>
  4177. <row>
  4178. <entry><constant>V4L2_FLASH_STROBE_SOURCE_EXTERNAL</constant></entry>
  4179. <entry>The flash strobe is triggered by an
  4180. external source. Typically this is a sensor,
  4181. which makes it possible to synchronises the
  4182. flash strobe start to exposure start.</entry>
  4183. </row>
  4184. </tbody>
  4185. </entrytbl>
  4186. </row>
  4187. <row>
  4188. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE</constant></entry>
  4189. <entry>button</entry>
  4190. </row>
  4191. <row>
  4192. <entry spanname="descr">Strobe flash. Valid when
  4193. V4L2_CID_FLASH_LED_MODE is set to
  4194. V4L2_FLASH_LED_MODE_FLASH and V4L2_CID_FLASH_STROBE_SOURCE
  4195. is set to V4L2_FLASH_STROBE_SOURCE_SOFTWARE. Setting this
  4196. control may not be possible in presence of some faults.
  4197. See V4L2_CID_FLASH_FAULT.</entry>
  4198. </row>
  4199. <row>
  4200. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STOP</constant></entry>
  4201. <entry>button</entry>
  4202. </row>
  4203. <row><entry spanname="descr">Stop flash strobe immediately.</entry>
  4204. </row>
  4205. <row>
  4206. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STATUS</constant></entry>
  4207. <entry>boolean</entry>
  4208. </row>
  4209. <row>
  4210. <entry spanname="descr">Strobe status: whether the flash
  4211. is strobing at the moment or not. This is a read-only
  4212. control.</entry>
  4213. </row>
  4214. <row>
  4215. <entry spanname="id"><constant>V4L2_CID_FLASH_TIMEOUT</constant></entry>
  4216. <entry>integer</entry>
  4217. </row>
  4218. <row>
  4219. <entry spanname="descr">Hardware timeout for flash. The
  4220. flash strobe is stopped after this period of time has
  4221. passed from the start of the strobe.</entry>
  4222. </row>
  4223. <row>
  4224. <entry spanname="id"><constant>V4L2_CID_FLASH_INTENSITY</constant></entry>
  4225. <entry>integer</entry>
  4226. </row>
  4227. <row>
  4228. <entry spanname="descr">Intensity of the flash strobe when
  4229. the flash LED is in flash mode
  4230. (V4L2_FLASH_LED_MODE_FLASH). The unit should be milliamps
  4231. (mA) if possible.</entry>
  4232. </row>
  4233. <row>
  4234. <entry spanname="id"><constant>V4L2_CID_FLASH_TORCH_INTENSITY</constant></entry>
  4235. <entry>integer</entry>
  4236. </row>
  4237. <row>
  4238. <entry spanname="descr">Intensity of the flash LED in
  4239. torch mode (V4L2_FLASH_LED_MODE_TORCH). The unit should be
  4240. milliamps (mA) if possible. Setting this control may not
  4241. be possible in presence of some faults. See
  4242. V4L2_CID_FLASH_FAULT.</entry>
  4243. </row>
  4244. <row>
  4245. <entry spanname="id"><constant>V4L2_CID_FLASH_INDICATOR_INTENSITY</constant></entry>
  4246. <entry>integer</entry>
  4247. </row>
  4248. <row>
  4249. <entry spanname="descr">Intensity of the indicator LED.
  4250. The indicator LED may be fully independent of the flash
  4251. LED. The unit should be microamps (uA) if possible.</entry>
  4252. </row>
  4253. <row>
  4254. <entry spanname="id"><constant>V4L2_CID_FLASH_FAULT</constant></entry>
  4255. <entry>bitmask</entry>
  4256. </row>
  4257. <row>
  4258. <entry spanname="descr">Faults related to the flash. The
  4259. faults tell about specific problems in the flash chip
  4260. itself or the LEDs attached to it. Faults may prevent
  4261. further use of some of the flash controls. In particular,
  4262. V4L2_CID_FLASH_LED_MODE is set to V4L2_FLASH_LED_MODE_NONE
  4263. if the fault affects the flash LED. Exactly which faults
  4264. have such an effect is chip dependent. Reading the faults
  4265. resets the control and returns the chip to a usable state
  4266. if possible.</entry>
  4267. </row>
  4268. <row>
  4269. <entrytbl spanname="descr" cols="2">
  4270. <tbody valign="top">
  4271. <row>
  4272. <entry><constant>V4L2_FLASH_FAULT_OVER_VOLTAGE</constant></entry>
  4273. <entry>Flash controller voltage to the flash LED
  4274. has exceeded the limit specific to the flash
  4275. controller.</entry>
  4276. </row>
  4277. <row>
  4278. <entry><constant>V4L2_FLASH_FAULT_TIMEOUT</constant></entry>
  4279. <entry>The flash strobe was still on when
  4280. the timeout set by the user ---
  4281. V4L2_CID_FLASH_TIMEOUT control --- has expired.
  4282. Not all flash controllers may set this in all
  4283. such conditions.</entry>
  4284. </row>
  4285. <row>
  4286. <entry><constant>V4L2_FLASH_FAULT_OVER_TEMPERATURE</constant></entry>
  4287. <entry>The flash controller has overheated.</entry>
  4288. </row>
  4289. <row>
  4290. <entry><constant>V4L2_FLASH_FAULT_SHORT_CIRCUIT</constant></entry>
  4291. <entry>The short circuit protection of the flash
  4292. controller has been triggered.</entry>
  4293. </row>
  4294. <row>
  4295. <entry><constant>V4L2_FLASH_FAULT_OVER_CURRENT</constant></entry>
  4296. <entry>Current in the LED power supply has exceeded the limit
  4297. specific to the flash controller.</entry>
  4298. </row>
  4299. <row>
  4300. <entry><constant>V4L2_FLASH_FAULT_INDICATOR</constant></entry>
  4301. <entry>The flash controller has detected a short or open
  4302. circuit condition on the indicator LED.</entry>
  4303. </row>
  4304. <row>
  4305. <entry><constant>V4L2_FLASH_FAULT_UNDER_VOLTAGE</constant></entry>
  4306. <entry>Flash controller voltage to the flash LED
  4307. has been below the minimum limit specific to the flash
  4308. controller.</entry>
  4309. </row>
  4310. <row>
  4311. <entry><constant>V4L2_FLASH_FAULT_INPUT_VOLTAGE</constant></entry>
  4312. <entry>The input voltage of the flash controller is below
  4313. the limit under which strobing the flash at full current
  4314. will not be possible.The condition persists until this flag
  4315. is no longer set.</entry>
  4316. </row>
  4317. <row>
  4318. <entry><constant>V4L2_FLASH_FAULT_LED_OVER_TEMPERATURE</constant></entry>
  4319. <entry>The temperature of the LED has exceeded its
  4320. allowed upper limit.</entry>
  4321. </row>
  4322. </tbody>
  4323. </entrytbl>
  4324. </row>
  4325. <row>
  4326. <entry spanname="id"><constant>V4L2_CID_FLASH_CHARGE</constant></entry>
  4327. <entry>boolean</entry>
  4328. </row>
  4329. <row><entry spanname="descr">Enable or disable charging of the xenon
  4330. flash capacitor.</entry>
  4331. </row>
  4332. <row>
  4333. <entry spanname="id"><constant>V4L2_CID_FLASH_READY</constant></entry>
  4334. <entry>boolean</entry>
  4335. </row>
  4336. <row>
  4337. <entry spanname="descr">Is the flash ready to strobe?
  4338. Xenon flashes require their capacitors charged before
  4339. strobing. LED flashes often require a cooldown period
  4340. after strobe during which another strobe will not be
  4341. possible. This is a read-only control.</entry>
  4342. </row>
  4343. <row><entry></entry></row>
  4344. </tbody>
  4345. </tgroup>
  4346. </table>
  4347. </section>
  4348. </section>
  4349. </section>
  4350. <section id="jpeg-controls">
  4351. <title>JPEG Control Reference</title>
  4352. <para>The JPEG class includes controls for common features of JPEG
  4353. encoders and decoders. Currently it includes features for codecs
  4354. implementing progressive baseline DCT compression process with
  4355. Huffman entrophy coding.</para>
  4356. <table pgwide="1" frame="none" id="jpeg-control-id">
  4357. <title>JPEG Control IDs</title>
  4358. <tgroup cols="4">
  4359. <colspec colname="c1" colwidth="1*" />
  4360. <colspec colname="c2" colwidth="6*" />
  4361. <colspec colname="c3" colwidth="2*" />
  4362. <colspec colname="c4" colwidth="6*" />
  4363. <spanspec namest="c1" nameend="c2" spanname="id" />
  4364. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4365. <thead>
  4366. <row>
  4367. <entry spanname="id" align="left">ID</entry>
  4368. <entry align="left">Type</entry>
  4369. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4370. </row>
  4371. </thead>
  4372. <tbody valign="top">
  4373. <row><entry></entry></row>
  4374. <row>
  4375. <entry spanname="id"><constant>V4L2_CID_JPEG_CLASS</constant>&nbsp;</entry>
  4376. <entry>class</entry>
  4377. </row><row><entry spanname="descr">The JPEG class descriptor. Calling
  4378. &VIDIOC-QUERYCTRL; for this control will return a description of this
  4379. control class.
  4380. </entry>
  4381. </row>
  4382. <row>
  4383. <entry spanname="id"><constant>V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant></entry>
  4384. <entry>menu</entry>
  4385. </row>
  4386. <row id="v4l2-jpeg-chroma-subsampling">
  4387. <entry spanname="descr">The chroma subsampling factors describe how
  4388. each component of an input image is sampled, in respect to maximum
  4389. sample rate in each spatial dimension. See <xref linkend="itu-t81"/>,
  4390. clause A.1.1. for more details. The <constant>
  4391. V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant> control determines how
  4392. Cb and Cr components are downsampled after coverting an input image
  4393. from RGB to Y'CbCr color space.
  4394. </entry>
  4395. </row>
  4396. <row>
  4397. <entrytbl spanname="descr" cols="2">
  4398. <tbody valign="top">
  4399. <row>
  4400. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_444</constant>
  4401. </entry><entry>No chroma subsampling, each pixel has
  4402. Y, Cr and Cb values.</entry>
  4403. </row>
  4404. <row>
  4405. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_422</constant>
  4406. </entry><entry>Horizontally subsample Cr, Cb components
  4407. by a factor of 2.</entry>
  4408. </row>
  4409. <row>
  4410. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_420</constant>
  4411. </entry><entry>Subsample Cr, Cb components horizontally
  4412. and vertically by 2.</entry>
  4413. </row>
  4414. <row>
  4415. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_411</constant>
  4416. </entry><entry>Horizontally subsample Cr, Cb components
  4417. by a factor of 4.</entry>
  4418. </row>
  4419. <row>
  4420. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_410</constant>
  4421. </entry><entry>Subsample Cr, Cb components horizontally
  4422. by 4 and vertically by 2.</entry>
  4423. </row>
  4424. <row>
  4425. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_GRAY</constant>
  4426. </entry><entry>Use only luminance component.</entry>
  4427. </row>
  4428. </tbody>
  4429. </entrytbl>
  4430. </row>
  4431. <row>
  4432. <entry spanname="id"><constant>V4L2_CID_JPEG_RESTART_INTERVAL</constant>
  4433. </entry><entry>integer</entry>
  4434. </row>
  4435. <row><entry spanname="descr">
  4436. The restart interval determines an interval of inserting RSTm
  4437. markers (m = 0..7). The purpose of these markers is to additionally
  4438. reinitialize the encoder process, in order to process blocks of
  4439. an image independently.
  4440. For the lossy compression processes the restart interval unit is
  4441. MCU (Minimum Coded Unit) and its value is contained in DRI
  4442. (Define Restart Interval) marker. If <constant>
  4443. V4L2_CID_JPEG_RESTART_INTERVAL</constant> control is set to 0,
  4444. DRI and RSTm markers will not be inserted.
  4445. </entry>
  4446. </row>
  4447. <row id="jpeg-quality-control">
  4448. <entry spanname="id"><constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant></entry>
  4449. <entry>integer</entry>
  4450. </row>
  4451. <row>
  4452. <entry spanname="descr">
  4453. <constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control
  4454. determines trade-off between image quality and size.
  4455. It provides simpler method for applications to control image quality,
  4456. without a need for direct reconfiguration of luminance and chrominance
  4457. quantization tables.
  4458. In cases where a driver uses quantization tables configured directly
  4459. by an application, using interfaces defined elsewhere, <constant>
  4460. V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control should be set
  4461. by driver to 0.
  4462. <para>The value range of this control is driver-specific. Only
  4463. positive, non-zero values are meaningful. The recommended range
  4464. is 1 - 100, where larger values correspond to better image quality.
  4465. </para>
  4466. </entry>
  4467. </row>
  4468. <row id="jpeg-active-marker-control">
  4469. <entry spanname="id"><constant>V4L2_CID_JPEG_ACTIVE_MARKER</constant></entry>
  4470. <entry>bitmask</entry>
  4471. </row>
  4472. <row>
  4473. <entry spanname="descr">Specify which JPEG markers are included
  4474. in compressed stream. This control is valid only for encoders.
  4475. </entry>
  4476. </row>
  4477. <row>
  4478. <entrytbl spanname="descr" cols="2">
  4479. <tbody valign="top">
  4480. <row>
  4481. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP0</constant></entry>
  4482. <entry>Application data segment APP<subscript>0</subscript>.</entry>
  4483. </row><row>
  4484. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP1</constant></entry>
  4485. <entry>Application data segment APP<subscript>1</subscript>.</entry>
  4486. </row><row>
  4487. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_COM</constant></entry>
  4488. <entry>Comment segment.</entry>
  4489. </row><row>
  4490. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DQT</constant></entry>
  4491. <entry>Quantization tables segment.</entry>
  4492. </row><row>
  4493. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DHT</constant></entry>
  4494. <entry>Huffman tables segment.</entry>
  4495. </row>
  4496. </tbody>
  4497. </entrytbl>
  4498. </row>
  4499. <row><entry></entry></row>
  4500. </tbody>
  4501. </tgroup>
  4502. </table>
  4503. <para>For more details about JPEG specification, refer
  4504. to <xref linkend="itu-t81"/>, <xref linkend="jfif"/>,
  4505. <xref linkend="w3c-jpeg-jfif"/>.</para>
  4506. </section>
  4507. <section id="image-source-controls">
  4508. <title>Image Source Control Reference</title>
  4509. <note>
  4510. <title>Experimental</title>
  4511. <para>This is an <link
  4512. linkend="experimental">experimental</link> interface and may
  4513. change in the future.</para>
  4514. </note>
  4515. <para>
  4516. The Image Source control class is intended for low-level
  4517. control of image source devices such as image sensors. The
  4518. devices feature an analogue to digital converter and a bus
  4519. transmitter to transmit the image data out of the device.
  4520. </para>
  4521. <table pgwide="1" frame="none" id="image-source-control-id">
  4522. <title>Image Source Control IDs</title>
  4523. <tgroup cols="4">
  4524. <colspec colname="c1" colwidth="1*" />
  4525. <colspec colname="c2" colwidth="6*" />
  4526. <colspec colname="c3" colwidth="2*" />
  4527. <colspec colname="c4" colwidth="6*" />
  4528. <spanspec namest="c1" nameend="c2" spanname="id" />
  4529. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4530. <thead>
  4531. <row>
  4532. <entry spanname="id" align="left">ID</entry>
  4533. <entry align="left">Type</entry>
  4534. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4535. </row>
  4536. </thead>
  4537. <tbody valign="top">
  4538. <row><entry></entry></row>
  4539. <row>
  4540. <entry spanname="id"><constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant></entry>
  4541. <entry>class</entry>
  4542. </row>
  4543. <row>
  4544. <entry spanname="descr">The IMAGE_SOURCE class descriptor.</entry>
  4545. </row>
  4546. <row>
  4547. <entry spanname="id"><constant>V4L2_CID_VBLANK</constant></entry>
  4548. <entry>integer</entry>
  4549. </row>
  4550. <row>
  4551. <entry spanname="descr">Vertical blanking. The idle period
  4552. after every frame during which no image data is produced.
  4553. The unit of vertical blanking is a line. Every line has
  4554. length of the image width plus horizontal blanking at the
  4555. pixel rate defined by
  4556. <constant>V4L2_CID_PIXEL_RATE</constant> control in the
  4557. same sub-device.</entry>
  4558. </row>
  4559. <row>
  4560. <entry spanname="id"><constant>V4L2_CID_HBLANK</constant></entry>
  4561. <entry>integer</entry>
  4562. </row>
  4563. <row>
  4564. <entry spanname="descr">Horizontal blanking. The idle
  4565. period after every line of image data during which no
  4566. image data is produced. The unit of horizontal blanking is
  4567. pixels.</entry>
  4568. </row>
  4569. <row>
  4570. <entry spanname="id"><constant>V4L2_CID_ANALOGUE_GAIN</constant></entry>
  4571. <entry>integer</entry>
  4572. </row>
  4573. <row>
  4574. <entry spanname="descr">Analogue gain is gain affecting
  4575. all colour components in the pixel matrix. The gain
  4576. operation is performed in the analogue domain before A/D
  4577. conversion.
  4578. </entry>
  4579. </row>
  4580. <row>
  4581. <entry spanname="id"><constant>V4L2_CID_TEST_PATTERN_RED</constant></entry>
  4582. <entry>integer</entry>
  4583. </row>
  4584. <row>
  4585. <entry spanname="descr">Test pattern red colour component.
  4586. </entry>
  4587. </row>
  4588. <row>
  4589. <entry spanname="id"><constant>V4L2_CID_TEST_PATTERN_GREENR</constant></entry>
  4590. <entry>integer</entry>
  4591. </row>
  4592. <row>
  4593. <entry spanname="descr">Test pattern green (next to red)
  4594. colour component.
  4595. </entry>
  4596. </row>
  4597. <row>
  4598. <entry spanname="id"><constant>V4L2_CID_TEST_PATTERN_BLUE</constant></entry>
  4599. <entry>integer</entry>
  4600. </row>
  4601. <row>
  4602. <entry spanname="descr">Test pattern blue colour component.
  4603. </entry>
  4604. </row>
  4605. <row>
  4606. <entry spanname="id"><constant>V4L2_CID_TEST_PATTERN_GREENB</constant></entry>
  4607. <entry>integer</entry>
  4608. </row>
  4609. <row>
  4610. <entry spanname="descr">Test pattern green (next to blue)
  4611. colour component.
  4612. </entry>
  4613. </row>
  4614. <row><entry></entry></row>
  4615. </tbody>
  4616. </tgroup>
  4617. </table>
  4618. </section>
  4619. <section id="image-process-controls">
  4620. <title>Image Process Control Reference</title>
  4621. <note>
  4622. <title>Experimental</title>
  4623. <para>This is an <link
  4624. linkend="experimental">experimental</link> interface and may
  4625. change in the future.</para>
  4626. </note>
  4627. <para>
  4628. The Image Process control class is intended for low-level control of
  4629. image processing functions. Unlike
  4630. <constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant>, the controls in
  4631. this class affect processing the image, and do not control capturing
  4632. of it.
  4633. </para>
  4634. <table pgwide="1" frame="none" id="image-process-control-id">
  4635. <title>Image Process Control IDs</title>
  4636. <tgroup cols="4">
  4637. <colspec colname="c1" colwidth="1*" />
  4638. <colspec colname="c2" colwidth="6*" />
  4639. <colspec colname="c3" colwidth="2*" />
  4640. <colspec colname="c4" colwidth="6*" />
  4641. <spanspec namest="c1" nameend="c2" spanname="id" />
  4642. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4643. <thead>
  4644. <row>
  4645. <entry spanname="id" align="left">ID</entry>
  4646. <entry align="left">Type</entry>
  4647. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4648. </row>
  4649. </thead>
  4650. <tbody valign="top">
  4651. <row><entry></entry></row>
  4652. <row>
  4653. <entry spanname="id"><constant>V4L2_CID_IMAGE_PROC_CLASS</constant></entry>
  4654. <entry>class</entry>
  4655. </row>
  4656. <row>
  4657. <entry spanname="descr">The IMAGE_PROC class descriptor.</entry>
  4658. </row>
  4659. <row>
  4660. <entry spanname="id"><constant>V4L2_CID_LINK_FREQ</constant></entry>
  4661. <entry>integer menu</entry>
  4662. </row>
  4663. <row>
  4664. <entry spanname="descr">Data bus frequency. Together with the
  4665. media bus pixel code, bus type (clock cycles per sample), the
  4666. data bus frequency defines the pixel rate
  4667. (<constant>V4L2_CID_PIXEL_RATE</constant>) in the
  4668. pixel array (or possibly elsewhere, if the device is not an
  4669. image sensor). The frame rate can be calculated from the pixel
  4670. clock, image width and height and horizontal and vertical
  4671. blanking. While the pixel rate control may be defined elsewhere
  4672. than in the subdev containing the pixel array, the frame rate
  4673. cannot be obtained from that information. This is because only
  4674. on the pixel array it can be assumed that the vertical and
  4675. horizontal blanking information is exact: no other blanking is
  4676. allowed in the pixel array. The selection of frame rate is
  4677. performed by selecting the desired horizontal and vertical
  4678. blanking. The unit of this control is Hz. </entry>
  4679. </row>
  4680. <row>
  4681. <entry spanname="id"><constant>V4L2_CID_PIXEL_RATE</constant></entry>
  4682. <entry>64-bit integer</entry>
  4683. </row>
  4684. <row>
  4685. <entry spanname="descr">Pixel rate in the source pads of
  4686. the subdev. This control is read-only and its unit is
  4687. pixels / second.
  4688. </entry>
  4689. </row>
  4690. <row>
  4691. <entry spanname="id"><constant>V4L2_CID_TEST_PATTERN</constant></entry>
  4692. <entry>menu</entry>
  4693. </row>
  4694. <row id="v4l2-test-pattern">
  4695. <entry spanname="descr"> Some capture/display/sensor devices have
  4696. the capability to generate test pattern images. These hardware
  4697. specific test patterns can be used to test if a device is working
  4698. properly.</entry>
  4699. </row>
  4700. <row><entry></entry></row>
  4701. </tbody>
  4702. </tgroup>
  4703. </table>
  4704. </section>
  4705. <section id="dv-controls">
  4706. <title>Digital Video Control Reference</title>
  4707. <note>
  4708. <title>Experimental</title>
  4709. <para>This is an <link
  4710. linkend="experimental">experimental</link> interface and may
  4711. change in the future.</para>
  4712. </note>
  4713. <para>
  4714. The Digital Video control class is intended to control receivers
  4715. and transmitters for <ulink url="http://en.wikipedia.org/wiki/Vga">VGA</ulink>,
  4716. <ulink url="http://en.wikipedia.org/wiki/Digital_Visual_Interface">DVI</ulink>
  4717. (Digital Visual Interface), HDMI (<xref linkend="hdmi" />) and DisplayPort (<xref linkend="dp" />).
  4718. These controls are generally expected to be private to the receiver or transmitter
  4719. subdevice that implements them, so they are only exposed on the
  4720. <filename>/dev/v4l-subdev*</filename> device node.
  4721. </para>
  4722. <para>Note that these devices can have multiple input or output pads which are
  4723. hooked up to e.g. HDMI connectors. Even though the subdevice will receive or
  4724. transmit video from/to only one of those pads, the other pads can still be
  4725. active when it comes to EDID (Extended Display Identification Data,
  4726. <xref linkend="vesaedid" />) and HDCP (High-bandwidth Digital Content
  4727. Protection System, <xref linkend="hdcp" />) processing, allowing the device
  4728. to do the fairly slow EDID/HDCP handling in advance. This allows for quick
  4729. switching between connectors.</para>
  4730. <para>These pads appear in several of the controls in this section as
  4731. bitmasks, one bit for each pad. Bit 0 corresponds to pad 0, bit 1 to pad 1,
  4732. etc. The maximum value of the control is the set of valid pads.</para>
  4733. <table pgwide="1" frame="none" id="dv-control-id">
  4734. <title>Digital Video Control IDs</title>
  4735. <tgroup cols="4">
  4736. <colspec colname="c1" colwidth="1*" />
  4737. <colspec colname="c2" colwidth="6*" />
  4738. <colspec colname="c3" colwidth="2*" />
  4739. <colspec colname="c4" colwidth="6*" />
  4740. <spanspec namest="c1" nameend="c2" spanname="id" />
  4741. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4742. <thead>
  4743. <row>
  4744. <entry spanname="id" align="left">ID</entry>
  4745. <entry align="left">Type</entry>
  4746. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4747. </row>
  4748. </thead>
  4749. <tbody valign="top">
  4750. <row><entry></entry></row>
  4751. <row>
  4752. <entry spanname="id"><constant>V4L2_CID_DV_CLASS</constant></entry>
  4753. <entry>class</entry>
  4754. </row>
  4755. <row>
  4756. <entry spanname="descr">The Digital Video class descriptor.</entry>
  4757. </row>
  4758. <row>
  4759. <entry spanname="id"><constant>V4L2_CID_DV_TX_HOTPLUG</constant></entry>
  4760. <entry>bitmask</entry>
  4761. </row>
  4762. <row>
  4763. <entry spanname="descr">Many connectors have a hotplug pin which is high
  4764. if EDID information is available from the source. This control shows the
  4765. state of the hotplug pin as seen by the transmitter.
  4766. Each bit corresponds to an output pad on the transmitter. If an output pad
  4767. does not have an associated hotplug pin, then the bit for that pad will be 0.
  4768. This read-only control is applicable to DVI-D, HDMI and DisplayPort connectors.
  4769. </entry>
  4770. </row>
  4771. <row>
  4772. <entry spanname="id"><constant>V4L2_CID_DV_TX_RXSENSE</constant></entry>
  4773. <entry>bitmask</entry>
  4774. </row>
  4775. <row>
  4776. <entry spanname="descr">Rx Sense is the detection of pull-ups on the TMDS
  4777. clock lines. This normally means that the sink has left/entered standby (i.e.
  4778. the transmitter can sense that the receiver is ready to receive video).
  4779. Each bit corresponds to an output pad on the transmitter. If an output pad
  4780. does not have an associated Rx Sense, then the bit for that pad will be 0.
  4781. This read-only control is applicable to DVI-D and HDMI devices.
  4782. </entry>
  4783. </row>
  4784. <row>
  4785. <entry spanname="id"><constant>V4L2_CID_DV_TX_EDID_PRESENT</constant></entry>
  4786. <entry>bitmask</entry>
  4787. </row>
  4788. <row>
  4789. <entry spanname="descr">When the transmitter sees the hotplug signal from the
  4790. receiver it will attempt to read the EDID. If set, then the transmitter has read
  4791. at least the first block (= 128 bytes).
  4792. Each bit corresponds to an output pad on the transmitter. If an output pad
  4793. does not support EDIDs, then the bit for that pad will be 0.
  4794. This read-only control is applicable to VGA, DVI-A/D, HDMI and DisplayPort connectors.
  4795. </entry>
  4796. </row>
  4797. <row>
  4798. <entry spanname="id"><constant>V4L2_CID_DV_TX_MODE</constant></entry>
  4799. <entry id="v4l2-dv-tx-mode">enum v4l2_dv_tx_mode</entry>
  4800. </row>
  4801. <row>
  4802. <entry spanname="descr">HDMI transmitters can transmit in DVI-D mode (just video)
  4803. or in HDMI mode (video + audio + auxiliary data). This control selects which mode
  4804. to use: V4L2_DV_TX_MODE_DVI_D or V4L2_DV_TX_MODE_HDMI.
  4805. This control is applicable to HDMI connectors.
  4806. </entry>
  4807. </row>
  4808. <row>
  4809. <entry spanname="id"><constant>V4L2_CID_DV_TX_RGB_RANGE</constant></entry>
  4810. <entry id="v4l2-dv-rgb-range">enum v4l2_dv_rgb_range</entry>
  4811. </row>
  4812. <row>
  4813. <entry spanname="descr">Select the quantization range for RGB output. V4L2_DV_RANGE_AUTO
  4814. follows the RGB quantization range specified in the standard for the video interface
  4815. (ie. <xref linkend="cea861" /> for HDMI). V4L2_DV_RANGE_LIMITED and V4L2_DV_RANGE_FULL override the standard
  4816. to be compatible with sinks that have not implemented the standard correctly
  4817. (unfortunately quite common for HDMI and DVI-D). Full range allows all possible values to be
  4818. used whereas limited range sets the range to (16 &lt;&lt; (N-8)) - (235 &lt;&lt; (N-8))
  4819. where N is the number of bits per component.
  4820. This control is applicable to VGA, DVI-A/D, HDMI and DisplayPort connectors.
  4821. </entry>
  4822. </row>
  4823. <row>
  4824. <entry spanname="id"><constant>V4L2_CID_DV_RX_POWER_PRESENT</constant></entry>
  4825. <entry>bitmask</entry>
  4826. </row>
  4827. <row>
  4828. <entry spanname="descr">Detects whether the receiver receives power from the source
  4829. (e.g. HDMI carries 5V on one of the pins). This is often used to power an eeprom
  4830. which contains EDID information, such that the source can read the EDID even if
  4831. the sink is in standby/power off.
  4832. Each bit corresponds to an input pad on the transmitter. If an input pad
  4833. cannot detect whether power is present, then the bit for that pad will be 0.
  4834. This read-only control is applicable to DVI-D, HDMI and DisplayPort connectors.
  4835. </entry>
  4836. </row>
  4837. <row>
  4838. <entry spanname="id"><constant>V4L2_CID_DV_RX_RGB_RANGE</constant></entry>
  4839. <entry>enum v4l2_dv_rgb_range</entry>
  4840. </row>
  4841. <row>
  4842. <entry spanname="descr">Select the quantization range for RGB input. V4L2_DV_RANGE_AUTO
  4843. follows the RGB quantization range specified in the standard for the video interface
  4844. (ie. <xref linkend="cea861" /> for HDMI). V4L2_DV_RANGE_LIMITED and V4L2_DV_RANGE_FULL override the standard
  4845. to be compatible with sources that have not implemented the standard correctly
  4846. (unfortunately quite common for HDMI and DVI-D). Full range allows all possible values to be
  4847. used whereas limited range sets the range to (16 &lt;&lt; (N-8)) - (235 &lt;&lt; (N-8))
  4848. where N is the number of bits per component.
  4849. This control is applicable to VGA, DVI-A/D, HDMI and DisplayPort connectors.
  4850. </entry>
  4851. </row>
  4852. <row><entry></entry></row>
  4853. </tbody>
  4854. </tgroup>
  4855. </table>
  4856. </section>
  4857. <section id="fm-rx-controls">
  4858. <title>FM Receiver Control Reference</title>
  4859. <para>The FM Receiver (FM_RX) class includes controls for common features of
  4860. FM Reception capable devices.</para>
  4861. <table pgwide="1" frame="none" id="fm-rx-control-id">
  4862. <title>FM_RX Control IDs</title>
  4863. <tgroup cols="4">
  4864. <colspec colname="c1" colwidth="1*" />
  4865. <colspec colname="c2" colwidth="6*" />
  4866. <colspec colname="c3" colwidth="2*" />
  4867. <colspec colname="c4" colwidth="6*" />
  4868. <spanspec namest="c1" nameend="c2" spanname="id" />
  4869. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4870. <thead>
  4871. <row>
  4872. <entry spanname="id" align="left">ID</entry>
  4873. <entry align="left">Type</entry>
  4874. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4875. </row>
  4876. </thead>
  4877. <tbody valign="top">
  4878. <row><entry></entry></row>
  4879. <row>
  4880. <entry spanname="id"><constant>V4L2_CID_FM_RX_CLASS</constant>&nbsp;</entry>
  4881. <entry>class</entry>
  4882. </row><row><entry spanname="descr">The FM_RX class
  4883. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  4884. description of this control class.</entry>
  4885. </row>
  4886. <row>
  4887. <entry spanname="id"><constant>V4L2_CID_RDS_RECEPTION</constant>&nbsp;</entry>
  4888. <entry>boolean</entry>
  4889. </row><row><entry spanname="descr">Enables/disables RDS
  4890. reception by the radio tuner</entry>
  4891. </row>
  4892. <row>
  4893. <entry spanname="id"><constant>V4L2_CID_RDS_RX_PTY</constant>&nbsp;</entry>
  4894. <entry>integer</entry>
  4895. </row>
  4896. <row><entry spanname="descr">Gets RDS Programme Type field.
  4897. This encodes up to 31 pre-defined programme types.</entry>
  4898. </row>
  4899. <row>
  4900. <entry spanname="id"><constant>V4L2_CID_RDS_RX_PS_NAME</constant>&nbsp;</entry>
  4901. <entry>string</entry>
  4902. </row>
  4903. <row><entry spanname="descr">Gets the Programme Service name (PS_NAME).
  4904. It is intended for static display on a receiver. It is the primary aid to listeners in programme service
  4905. identification and selection. In Annex E of <xref linkend="iec62106" />, the RDS specification,
  4906. there is a full description of the correct character encoding for Programme Service name strings.
  4907. Also from RDS specification, PS is usually a single eight character text. However, it is also possible
  4908. to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
  4909. with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry>
  4910. </row>
  4911. <row>
  4912. <entry spanname="id"><constant>V4L2_CID_RDS_RX_RADIO_TEXT</constant>&nbsp;</entry>
  4913. <entry>string</entry>
  4914. </row>
  4915. <row><entry spanname="descr">Gets the Radio Text info. It is a textual description of
  4916. what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
  4917. programme-related information or any other text. In these cases, RadioText can be used in addition to
  4918. <constant>V4L2_CID_RDS_RX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
  4919. in Annex E of <xref linkend="iec62106" />. The length of Radio Text strings depends on which RDS Block is being
  4920. used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
  4921. to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
  4922. with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
  4923. </row>
  4924. <row>
  4925. <entry spanname="id"><constant>V4L2_CID_RDS_RX_TRAFFIC_ANNOUNCEMENT</constant>&nbsp;</entry>
  4926. <entry>boolean</entry>
  4927. </row>
  4928. <row><entry spanname="descr">If set, then a traffic announcement is in progress.</entry>
  4929. </row>
  4930. <row>
  4931. <entry spanname="id"><constant>V4L2_CID_RDS_RX_TRAFFIC_PROGRAM</constant>&nbsp;</entry>
  4932. <entry>boolean</entry>
  4933. </row>
  4934. <row><entry spanname="descr">If set, then the tuned programme carries traffic announcements.</entry>
  4935. </row>
  4936. <row>
  4937. <entry spanname="id"><constant>V4L2_CID_RDS_RX_MUSIC_SPEECH</constant>&nbsp;</entry>
  4938. <entry>boolean</entry>
  4939. </row>
  4940. <row><entry spanname="descr">If set, then this channel broadcasts music. If cleared, then it
  4941. broadcasts speech. If the transmitter doesn't make this distinction, then it will be set.</entry>
  4942. </row>
  4943. <row>
  4944. <entry spanname="id"><constant>V4L2_CID_TUNE_DEEMPHASIS</constant>&nbsp;</entry>
  4945. <entry>enum v4l2_deemphasis</entry>
  4946. </row>
  4947. <row id="v4l2-deemphasis"><entry spanname="descr">Configures the de-emphasis value for reception.
  4948. A de-emphasis filter is applied to the broadcast to accentuate the high audio frequencies.
  4949. Depending on the region, a time constant of either 50 or 75 useconds is used. The enum&nbsp;v4l2_deemphasis
  4950. defines possible values for de-emphasis. Here they are:</entry>
  4951. </row><row>
  4952. <entrytbl spanname="descr" cols="2">
  4953. <tbody valign="top">
  4954. <row>
  4955. <entry><constant>V4L2_DEEMPHASIS_DISABLED</constant>&nbsp;</entry>
  4956. <entry>No de-emphasis is applied.</entry>
  4957. </row>
  4958. <row>
  4959. <entry><constant>V4L2_DEEMPHASIS_50_uS</constant>&nbsp;</entry>
  4960. <entry>A de-emphasis of 50 uS is used.</entry>
  4961. </row>
  4962. <row>
  4963. <entry><constant>V4L2_DEEMPHASIS_75_uS</constant>&nbsp;</entry>
  4964. <entry>A de-emphasis of 75 uS is used.</entry>
  4965. </row>
  4966. </tbody>
  4967. </entrytbl>
  4968. </row>
  4969. <row><entry></entry></row>
  4970. </tbody>
  4971. </tgroup>
  4972. </table>
  4973. </section>
  4974. <section id="detect-controls">
  4975. <title>Detect Control Reference</title>
  4976. <para>The Detect class includes controls for common features of
  4977. various motion or object detection capable devices.</para>
  4978. <table pgwide="1" frame="none" id="detect-control-id">
  4979. <title>Detect Control IDs</title>
  4980. <tgroup cols="4">
  4981. <colspec colname="c1" colwidth="1*" />
  4982. <colspec colname="c2" colwidth="6*" />
  4983. <colspec colname="c3" colwidth="2*" />
  4984. <colspec colname="c4" colwidth="6*" />
  4985. <spanspec namest="c1" nameend="c2" spanname="id" />
  4986. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4987. <thead>
  4988. <row>
  4989. <entry spanname="id" align="left">ID</entry>
  4990. <entry align="left">Type</entry>
  4991. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4992. </row>
  4993. </thead>
  4994. <tbody valign="top">
  4995. <row><entry></entry></row>
  4996. <row>
  4997. <entry spanname="id"><constant>V4L2_CID_DETECT_CLASS</constant>&nbsp;</entry>
  4998. <entry>class</entry>
  4999. </row><row><entry spanname="descr">The Detect class
  5000. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  5001. description of this control class.</entry>
  5002. </row>
  5003. <row>
  5004. <entry spanname="id"><constant>V4L2_CID_DETECT_MD_MODE</constant>&nbsp;</entry>
  5005. <entry>menu</entry>
  5006. </row><row><entry spanname="descr">Sets the motion detection mode.</entry>
  5007. </row>
  5008. <row>
  5009. <entrytbl spanname="descr" cols="2">
  5010. <tbody valign="top">
  5011. <row>
  5012. <entry><constant>V4L2_DETECT_MD_MODE_DISABLED</constant>
  5013. </entry><entry>Disable motion detection.</entry>
  5014. </row>
  5015. <row>
  5016. <entry><constant>V4L2_DETECT_MD_MODE_GLOBAL</constant>
  5017. </entry><entry>Use a single motion detection threshold.</entry>
  5018. </row>
  5019. <row>
  5020. <entry><constant>V4L2_DETECT_MD_MODE_THRESHOLD_GRID</constant>
  5021. </entry><entry>The image is divided into a grid, each cell with its own
  5022. motion detection threshold. These thresholds are set through the
  5023. <constant>V4L2_CID_DETECT_MD_THRESHOLD_GRID</constant> matrix control.</entry>
  5024. </row>
  5025. <row>
  5026. <entry><constant>V4L2_DETECT_MD_MODE_REGION_GRID</constant>
  5027. </entry><entry>The image is divided into a grid, each cell with its own
  5028. region value that specifies which per-region motion detection thresholds
  5029. should be used. Each region has its own thresholds. How these per-region
  5030. thresholds are set up is driver-specific. The region values for the grid are set
  5031. through the <constant>V4L2_CID_DETECT_MD_REGION_GRID</constant> matrix
  5032. control.</entry>
  5033. </row>
  5034. </tbody>
  5035. </entrytbl>
  5036. </row>
  5037. <row>
  5038. <entry spanname="id"><constant>V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD</constant>&nbsp;</entry>
  5039. <entry>integer</entry>
  5040. </row>
  5041. <row><entry spanname="descr">Sets the global motion detection threshold to be
  5042. used with the <constant>V4L2_DETECT_MD_MODE_GLOBAL</constant> motion detection mode.</entry>
  5043. </row>
  5044. <row>
  5045. <entry spanname="id"><constant>V4L2_CID_DETECT_MD_THRESHOLD_GRID</constant>&nbsp;</entry>
  5046. <entry>__u16 matrix</entry>
  5047. </row>
  5048. <row><entry spanname="descr">Sets the motion detection thresholds for each cell in the grid.
  5049. To be used with the <constant>V4L2_DETECT_MD_MODE_THRESHOLD_GRID</constant>
  5050. motion detection mode. Matrix element (0, 0) represents the cell at the top-left of the
  5051. grid.</entry>
  5052. </row>
  5053. <row>
  5054. <entry spanname="id"><constant>V4L2_CID_DETECT_MD_REGION_GRID</constant>&nbsp;</entry>
  5055. <entry>__u8 matrix</entry>
  5056. </row>
  5057. <row><entry spanname="descr">Sets the motion detection region value for each cell in the grid.
  5058. To be used with the <constant>V4L2_DETECT_MD_MODE_REGION_GRID</constant>
  5059. motion detection mode. Matrix element (0, 0) represents the cell at the top-left of the
  5060. grid.</entry>
  5061. </row>
  5062. </tbody>
  5063. </tgroup>
  5064. </table>
  5065. </section>
  5066. <section id="rf-tuner-controls">
  5067. <title>RF Tuner Control Reference</title>
  5068. <para>
  5069. The RF Tuner (RF_TUNER) class includes controls for common features of devices
  5070. having RF tuner.
  5071. </para>
  5072. <para>
  5073. In this context, RF tuner is radio receiver circuit between antenna and
  5074. demodulator. It receives radio frequency (RF) from the antenna and converts that
  5075. received signal to lower intermediate frequency (IF) or baseband frequency (BB).
  5076. Tuners that could do baseband output are often called Zero-IF tuners. Older
  5077. tuners were typically simple PLL tuners inside a metal box, whilst newer ones
  5078. are highly integrated chips without a metal box "silicon tuners". These controls
  5079. are mostly applicable for new feature rich silicon tuners, just because older
  5080. tuners does not have much adjustable features.
  5081. </para>
  5082. <para>
  5083. For more information about RF tuners see
  5084. <ulink url="http://en.wikipedia.org/wiki/Tuner_%28radio%29">Tuner (radio)</ulink>
  5085. and
  5086. <ulink url="http://en.wikipedia.org/wiki/RF_front_end">RF front end</ulink>
  5087. from Wikipedia.
  5088. </para>
  5089. <table pgwide="1" frame="none" id="rf-tuner-control-id">
  5090. <title>RF_TUNER Control IDs</title>
  5091. <tgroup cols="4">
  5092. <colspec colname="c1" colwidth="1*" />
  5093. <colspec colname="c2" colwidth="6*" />
  5094. <colspec colname="c3" colwidth="2*" />
  5095. <colspec colname="c4" colwidth="6*" />
  5096. <spanspec namest="c1" nameend="c2" spanname="id" />
  5097. <spanspec namest="c2" nameend="c4" spanname="descr" />
  5098. <thead>
  5099. <row>
  5100. <entry spanname="id" align="left">ID</entry>
  5101. <entry align="left">Type</entry>
  5102. </row>
  5103. <row rowsep="1">
  5104. <entry spanname="descr" align="left">Description</entry>
  5105. </row>
  5106. </thead>
  5107. <tbody valign="top">
  5108. <row><entry></entry></row>
  5109. <row>
  5110. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_CLASS</constant>&nbsp;</entry>
  5111. <entry>class</entry>
  5112. </row><row><entry spanname="descr">The RF_TUNER class
  5113. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  5114. description of this control class.</entry>
  5115. </row>
  5116. <row>
  5117. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_BANDWIDTH_AUTO</constant>&nbsp;</entry>
  5118. <entry>boolean</entry>
  5119. </row>
  5120. <row>
  5121. <entry spanname="descr">Enables/disables tuner radio channel
  5122. bandwidth configuration. In automatic mode bandwidth configuration is performed
  5123. by the driver.</entry>
  5124. </row>
  5125. <row>
  5126. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_BANDWIDTH</constant>&nbsp;</entry>
  5127. <entry>integer</entry>
  5128. </row>
  5129. <row>
  5130. <entry spanname="descr">Filter(s) on tuner signal path are used to
  5131. filter signal according to receiving party needs. Driver configures filters to
  5132. fulfill desired bandwidth requirement. Used when V4L2_CID_RF_TUNER_BANDWIDTH_AUTO is not
  5133. set. Unit is in Hz. The range and step are driver-specific.</entry>
  5134. </row>
  5135. <row>
  5136. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_LNA_GAIN_AUTO</constant>&nbsp;</entry>
  5137. <entry>boolean</entry>
  5138. </row>
  5139. <row>
  5140. <entry spanname="descr">Enables/disables LNA automatic gain control (AGC)</entry>
  5141. </row>
  5142. <row>
  5143. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO</constant>&nbsp;</entry>
  5144. <entry>boolean</entry>
  5145. </row>
  5146. <row>
  5147. <entry spanname="descr">Enables/disables mixer automatic gain control (AGC)</entry>
  5148. </row>
  5149. <row>
  5150. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_IF_GAIN_AUTO</constant>&nbsp;</entry>
  5151. <entry>boolean</entry>
  5152. </row>
  5153. <row>
  5154. <entry spanname="descr">Enables/disables IF automatic gain control (AGC)</entry>
  5155. </row>
  5156. <row>
  5157. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_RF_GAIN</constant>&nbsp;</entry>
  5158. <entry>integer</entry>
  5159. </row>
  5160. <row>
  5161. <entry spanname="descr">The RF amplifier is the very first
  5162. amplifier on the receiver signal path, just right after the antenna input.
  5163. The difference between the LNA gain and the RF gain in this document is that
  5164. the LNA gain is integrated in the tuner chip while the RF gain is a separate
  5165. chip. There may be both RF and LNA gain controls in the same device.
  5166. The range and step are driver-specific.</entry>
  5167. </row>
  5168. <row>
  5169. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_LNA_GAIN</constant>&nbsp;</entry>
  5170. <entry>integer</entry>
  5171. </row>
  5172. <row>
  5173. <entry spanname="descr">LNA (low noise amplifier) gain is first
  5174. gain stage on the RF tuner signal path. It is located very close to tuner
  5175. antenna input. Used when <constant>V4L2_CID_RF_TUNER_LNA_GAIN_AUTO</constant> is not set.
  5176. See <constant>V4L2_CID_RF_TUNER_RF_GAIN</constant> to understand how RF gain
  5177. and LNA gain differs from the each others.
  5178. The range and step are driver-specific.</entry>
  5179. </row>
  5180. <row>
  5181. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_MIXER_GAIN</constant>&nbsp;</entry>
  5182. <entry>integer</entry>
  5183. </row>
  5184. <row>
  5185. <entry spanname="descr">Mixer gain is second gain stage on the RF
  5186. tuner signal path. It is located inside mixer block, where RF signal is
  5187. down-converted by the mixer. Used when <constant>V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO</constant>
  5188. is not set. The range and step are driver-specific.</entry>
  5189. </row>
  5190. <row>
  5191. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_IF_GAIN</constant>&nbsp;</entry>
  5192. <entry>integer</entry>
  5193. </row>
  5194. <row>
  5195. <entry spanname="descr">IF gain is last gain stage on the RF tuner
  5196. signal path. It is located on output of RF tuner. It controls signal level of
  5197. intermediate frequency output or baseband output. Used when
  5198. <constant>V4L2_CID_RF_TUNER_IF_GAIN_AUTO</constant> is not set. The range and step are
  5199. driver-specific.</entry>
  5200. </row>
  5201. <row>
  5202. <entry spanname="id"><constant>V4L2_CID_RF_TUNER_PLL_LOCK</constant>&nbsp;</entry>
  5203. <entry>boolean</entry>
  5204. </row>
  5205. <row>
  5206. <entry spanname="descr">Is synthesizer PLL locked? RF tuner is
  5207. receiving given frequency when that control is set. This is a read-only control.
  5208. </entry>
  5209. </row>
  5210. </tbody>
  5211. </tgroup>
  5212. </table>
  5213. </section>
  5214. </section>