controls.xml 161 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272
  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. and higher values. The pre-defined control IDs have the prefix
  15. <constant>V4L2_CID_</constant>, and are listed in <xref
  16. linkend="control-id" />. The ID is used when querying the attributes of
  17. a control, and when getting or setting the current value.</para>
  18. <para>Generally applications should present controls to the user
  19. without assumptions about their purpose. Each control comes with a
  20. name string the user is supposed to understand. When the purpose is
  21. non-intuitive the driver writer should provide a user manual, a user
  22. interface plug-in or a driver specific panel application. Predefined
  23. IDs were introduced to change a few controls programmatically, for
  24. example to mute a device during a channel switch.</para>
  25. <para>Drivers may enumerate different controls after switching
  26. the current video input or output, tuner or modulator, or audio input
  27. or output. Different in the sense of other bounds, another default and
  28. current value, step size or other menu items. A control with a certain
  29. <emphasis>custom</emphasis> ID can also change name and
  30. type.<footnote>
  31. <para>It will be more convenient for applications if drivers
  32. make use of the <constant>V4L2_CTRL_FLAG_DISABLED</constant> flag, but
  33. that was never required.</para>
  34. </footnote> Control values are stored globally, they do not
  35. change when switching except to stay within the reported bounds. They
  36. also do not change &eg; when the device is opened or closed, when the
  37. tuner radio frequency is changed or generally never without
  38. application request. Since V4L2 specifies no event mechanism, panel
  39. applications intended to cooperate with other panel applications (be
  40. they built into a larger application, as a TV viewer) may need to
  41. regularly poll control values to update their user
  42. interface.<footnote>
  43. <para>Applications could call an ioctl to request events.
  44. After another process called &VIDIOC-S-CTRL; or another ioctl changing
  45. shared properties the &func-select; function would indicate
  46. readability until any ioctl (querying the properties) is
  47. called.</para>
  48. </footnote></para>
  49. <para>
  50. All controls use machine endianness.
  51. </para>
  52. <table pgwide="1" frame="none" id="control-id">
  53. <title>Control IDs</title>
  54. <tgroup cols="3">
  55. &cs-def;
  56. <thead>
  57. <row>
  58. <entry>ID</entry>
  59. <entry>Type</entry>
  60. <entry>Description</entry>
  61. </row>
  62. </thead>
  63. <tbody valign="top">
  64. <row>
  65. <entry><constant>V4L2_CID_BASE</constant></entry>
  66. <entry></entry>
  67. <entry>First predefined ID, equal to
  68. <constant>V4L2_CID_BRIGHTNESS</constant>.</entry>
  69. </row>
  70. <row>
  71. <entry><constant>V4L2_CID_USER_BASE</constant></entry>
  72. <entry></entry>
  73. <entry>Synonym of <constant>V4L2_CID_BASE</constant>.</entry>
  74. </row>
  75. <row>
  76. <entry><constant>V4L2_CID_BRIGHTNESS</constant></entry>
  77. <entry>integer</entry>
  78. <entry>Picture brightness, or more precisely, the black
  79. level.</entry>
  80. </row>
  81. <row>
  82. <entry><constant>V4L2_CID_CONTRAST</constant></entry>
  83. <entry>integer</entry>
  84. <entry>Picture contrast or luma gain.</entry>
  85. </row>
  86. <row>
  87. <entry><constant>V4L2_CID_SATURATION</constant></entry>
  88. <entry>integer</entry>
  89. <entry>Picture color saturation or chroma gain.</entry>
  90. </row>
  91. <row>
  92. <entry><constant>V4L2_CID_HUE</constant></entry>
  93. <entry>integer</entry>
  94. <entry>Hue or color balance.</entry>
  95. </row>
  96. <row>
  97. <entry><constant>V4L2_CID_AUDIO_VOLUME</constant></entry>
  98. <entry>integer</entry>
  99. <entry>Overall audio volume. Note some drivers also
  100. provide an OSS or ALSA mixer interface.</entry>
  101. </row>
  102. <row>
  103. <entry><constant>V4L2_CID_AUDIO_BALANCE</constant></entry>
  104. <entry>integer</entry>
  105. <entry>Audio stereo balance. Minimum corresponds to all
  106. the way left, maximum to right.</entry>
  107. </row>
  108. <row>
  109. <entry><constant>V4L2_CID_AUDIO_BASS</constant></entry>
  110. <entry>integer</entry>
  111. <entry>Audio bass adjustment.</entry>
  112. </row>
  113. <row>
  114. <entry><constant>V4L2_CID_AUDIO_TREBLE</constant></entry>
  115. <entry>integer</entry>
  116. <entry>Audio treble adjustment.</entry>
  117. </row>
  118. <row>
  119. <entry><constant>V4L2_CID_AUDIO_MUTE</constant></entry>
  120. <entry>boolean</entry>
  121. <entry>Mute audio, &ie; set the volume to zero, however
  122. without affecting <constant>V4L2_CID_AUDIO_VOLUME</constant>. Like
  123. ALSA drivers, V4L2 drivers must mute at load time to avoid excessive
  124. noise. Actually the entire device should be reset to a low power
  125. consumption state.</entry>
  126. </row>
  127. <row>
  128. <entry><constant>V4L2_CID_AUDIO_LOUDNESS</constant></entry>
  129. <entry>boolean</entry>
  130. <entry>Loudness mode (bass boost).</entry>
  131. </row>
  132. <row>
  133. <entry><constant>V4L2_CID_BLACK_LEVEL</constant></entry>
  134. <entry>integer</entry>
  135. <entry>Another name for brightness (not a synonym of
  136. <constant>V4L2_CID_BRIGHTNESS</constant>). This control is deprecated
  137. and should not be used in new drivers and applications.</entry>
  138. </row>
  139. <row>
  140. <entry><constant>V4L2_CID_AUTO_WHITE_BALANCE</constant></entry>
  141. <entry>boolean</entry>
  142. <entry>Automatic white balance (cameras).</entry>
  143. </row>
  144. <row>
  145. <entry><constant>V4L2_CID_DO_WHITE_BALANCE</constant></entry>
  146. <entry>button</entry>
  147. <entry>This is an action control. When set (the value is
  148. ignored), the device will do a white balance and then hold the current
  149. setting. Contrast this with the boolean
  150. <constant>V4L2_CID_AUTO_WHITE_BALANCE</constant>, which, when
  151. activated, keeps adjusting the white balance.</entry>
  152. </row>
  153. <row>
  154. <entry><constant>V4L2_CID_RED_BALANCE</constant></entry>
  155. <entry>integer</entry>
  156. <entry>Red chroma balance.</entry>
  157. </row>
  158. <row>
  159. <entry><constant>V4L2_CID_BLUE_BALANCE</constant></entry>
  160. <entry>integer</entry>
  161. <entry>Blue chroma balance.</entry>
  162. </row>
  163. <row>
  164. <entry><constant>V4L2_CID_GAMMA</constant></entry>
  165. <entry>integer</entry>
  166. <entry>Gamma adjust.</entry>
  167. </row>
  168. <row>
  169. <entry><constant>V4L2_CID_WHITENESS</constant></entry>
  170. <entry>integer</entry>
  171. <entry>Whiteness for grey-scale devices. This is a synonym
  172. for <constant>V4L2_CID_GAMMA</constant>. This control is deprecated
  173. and should not be used in new drivers and applications.</entry>
  174. </row>
  175. <row>
  176. <entry><constant>V4L2_CID_EXPOSURE</constant></entry>
  177. <entry>integer</entry>
  178. <entry>Exposure (cameras). [Unit?]</entry>
  179. </row>
  180. <row>
  181. <entry><constant>V4L2_CID_AUTOGAIN</constant></entry>
  182. <entry>boolean</entry>
  183. <entry>Automatic gain/exposure control.</entry>
  184. </row>
  185. <row>
  186. <entry><constant>V4L2_CID_GAIN</constant></entry>
  187. <entry>integer</entry>
  188. <entry>Gain control.</entry>
  189. </row>
  190. <row>
  191. <entry><constant>V4L2_CID_HFLIP</constant></entry>
  192. <entry>boolean</entry>
  193. <entry>Mirror the picture horizontally.</entry>
  194. </row>
  195. <row>
  196. <entry><constant>V4L2_CID_VFLIP</constant></entry>
  197. <entry>boolean</entry>
  198. <entry>Mirror the picture vertically.</entry>
  199. </row>
  200. <row>
  201. <entry><constant>V4L2_CID_HCENTER_DEPRECATED</constant> (formerly <constant>V4L2_CID_HCENTER</constant>)</entry>
  202. <entry>integer</entry>
  203. <entry>Horizontal image centering. This control is
  204. deprecated. New drivers and applications should use the <link
  205. linkend="camera-controls">Camera class controls</link>
  206. <constant>V4L2_CID_PAN_ABSOLUTE</constant>,
  207. <constant>V4L2_CID_PAN_RELATIVE</constant> and
  208. <constant>V4L2_CID_PAN_RESET</constant> instead.</entry>
  209. </row>
  210. <row>
  211. <entry><constant>V4L2_CID_VCENTER_DEPRECATED</constant>
  212. (formerly <constant>V4L2_CID_VCENTER</constant>)</entry>
  213. <entry>integer</entry>
  214. <entry>Vertical image centering. Centering is intended to
  215. <emphasis>physically</emphasis> adjust cameras. For image cropping see
  216. <xref linkend="crop" />, for clipping <xref linkend="overlay" />. This
  217. control is deprecated. New drivers and applications should use the
  218. <link linkend="camera-controls">Camera class controls</link>
  219. <constant>V4L2_CID_TILT_ABSOLUTE</constant>,
  220. <constant>V4L2_CID_TILT_RELATIVE</constant> and
  221. <constant>V4L2_CID_TILT_RESET</constant> instead.</entry>
  222. </row>
  223. <row id="v4l2-power-line-frequency">
  224. <entry><constant>V4L2_CID_POWER_LINE_FREQUENCY</constant></entry>
  225. <entry>enum</entry>
  226. <entry>Enables a power line frequency filter to avoid
  227. flicker. Possible values for <constant>enum v4l2_power_line_frequency</constant> are:
  228. <constant>V4L2_CID_POWER_LINE_FREQUENCY_DISABLED</constant> (0),
  229. <constant>V4L2_CID_POWER_LINE_FREQUENCY_50HZ</constant> (1),
  230. <constant>V4L2_CID_POWER_LINE_FREQUENCY_60HZ</constant> (2) and
  231. <constant>V4L2_CID_POWER_LINE_FREQUENCY_AUTO</constant> (3).</entry>
  232. </row>
  233. <row>
  234. <entry><constant>V4L2_CID_HUE_AUTO</constant></entry>
  235. <entry>boolean</entry>
  236. <entry>Enables automatic hue control by the device. The
  237. effect of setting <constant>V4L2_CID_HUE</constant> while automatic
  238. hue control is enabled is undefined, drivers should ignore such
  239. request.</entry>
  240. </row>
  241. <row>
  242. <entry><constant>V4L2_CID_WHITE_BALANCE_TEMPERATURE</constant></entry>
  243. <entry>integer</entry>
  244. <entry>This control specifies the white balance settings
  245. as a color temperature in Kelvin. A driver should have a minimum of
  246. 2800 (incandescent) to 6500 (daylight). For more information about
  247. color temperature see <ulink
  248. url="http://en.wikipedia.org/wiki/Color_temperature">Wikipedia</ulink>.</entry>
  249. </row>
  250. <row>
  251. <entry><constant>V4L2_CID_SHARPNESS</constant></entry>
  252. <entry>integer</entry>
  253. <entry>Adjusts the sharpness filters in a camera. The
  254. minimum value disables the filters, higher values give a sharper
  255. picture.</entry>
  256. </row>
  257. <row>
  258. <entry><constant>V4L2_CID_BACKLIGHT_COMPENSATION</constant></entry>
  259. <entry>integer</entry>
  260. <entry>Adjusts the backlight compensation in a camera. The
  261. minimum value disables backlight compensation.</entry>
  262. </row>
  263. <row>
  264. <entry><constant>V4L2_CID_CHROMA_AGC</constant></entry>
  265. <entry>boolean</entry>
  266. <entry>Chroma automatic gain control.</entry>
  267. </row>
  268. <row>
  269. <entry><constant>V4L2_CID_CHROMA_GAIN</constant></entry>
  270. <entry>integer</entry>
  271. <entry>Adjusts the Chroma gain control (for use when chroma AGC
  272. is disabled).</entry>
  273. </row>
  274. <row>
  275. <entry><constant>V4L2_CID_COLOR_KILLER</constant></entry>
  276. <entry>boolean</entry>
  277. <entry>Enable the color killer (&ie; force a black &amp; white image in case of a weak video signal).</entry>
  278. </row>
  279. <row id="v4l2-colorfx">
  280. <entry><constant>V4L2_CID_COLORFX</constant></entry>
  281. <entry>enum</entry>
  282. <entry>Selects a color effect. The following values are defined:
  283. </entry>
  284. </row><row>
  285. <entry></entry>
  286. <entry></entry>
  287. <entrytbl spanname="descr" cols="2">
  288. <tbody valign="top">
  289. <row>
  290. <entry><constant>V4L2_COLORFX_NONE</constant>&nbsp;</entry>
  291. <entry>Color effect is disabled.</entry>
  292. </row>
  293. <row>
  294. <entry><constant>V4L2_COLORFX_ANTIQUE</constant>&nbsp;</entry>
  295. <entry>An aging (old photo) effect.</entry>
  296. </row>
  297. <row>
  298. <entry><constant>V4L2_COLORFX_ART_FREEZE</constant>&nbsp;</entry>
  299. <entry>Frost color effect.</entry>
  300. </row>
  301. <row>
  302. <entry><constant>V4L2_COLORFX_AQUA</constant>&nbsp;</entry>
  303. <entry>Water color, cool tone.</entry>
  304. </row>
  305. <row>
  306. <entry><constant>V4L2_COLORFX_BW</constant>&nbsp;</entry>
  307. <entry>Black and white.</entry>
  308. </row>
  309. <row>
  310. <entry><constant>V4L2_COLORFX_EMBOSS</constant>&nbsp;</entry>
  311. <entry>Emboss, the highlights and shadows replace light/dark boundaries
  312. and low contrast areas are set to a gray background.</entry>
  313. </row>
  314. <row>
  315. <entry><constant>V4L2_COLORFX_GRASS_GREEN</constant>&nbsp;</entry>
  316. <entry>Grass green.</entry>
  317. </row>
  318. <row>
  319. <entry><constant>V4L2_COLORFX_NEGATIVE</constant>&nbsp;</entry>
  320. <entry>Negative.</entry>
  321. </row>
  322. <row>
  323. <entry><constant>V4L2_COLORFX_SEPIA</constant>&nbsp;</entry>
  324. <entry>Sepia tone.</entry>
  325. </row>
  326. <row>
  327. <entry><constant>V4L2_COLORFX_SKETCH</constant>&nbsp;</entry>
  328. <entry>Sketch.</entry>
  329. </row>
  330. <row>
  331. <entry><constant>V4L2_COLORFX_SKIN_WHITEN</constant>&nbsp;</entry>
  332. <entry>Skin whiten.</entry>
  333. </row>
  334. <row>
  335. <entry><constant>V4L2_COLORFX_SKY_BLUE</constant>&nbsp;</entry>
  336. <entry>Sky blue.</entry>
  337. </row>
  338. <row>
  339. <entry><constant>V4L2_COLORFX_SOLARIZATION</constant>&nbsp;</entry>
  340. <entry>Solarization, the image is partially reversed in tone,
  341. only color values above or below a certain threshold are inverted.
  342. </entry>
  343. </row>
  344. <row>
  345. <entry><constant>V4L2_COLORFX_SILHOUETTE</constant>&nbsp;</entry>
  346. <entry>Silhouette (outline).</entry>
  347. </row>
  348. <row>
  349. <entry><constant>V4L2_COLORFX_VIVID</constant>&nbsp;</entry>
  350. <entry>Vivid colors.</entry>
  351. </row>
  352. <row>
  353. <entry><constant>V4L2_COLORFX_SET_CBCR</constant>&nbsp;</entry>
  354. <entry>The Cb and Cr chroma components are replaced by fixed
  355. coefficients determined by <constant>V4L2_CID_COLORFX_CBCR</constant>
  356. control.</entry>
  357. </row>
  358. </tbody>
  359. </entrytbl>
  360. </row>
  361. <row>
  362. <entry><constant>V4L2_CID_COLORFX_CBCR</constant></entry>
  363. <entry>integer</entry>
  364. <entry>Determines the Cb and Cr coefficients for <constant>V4L2_COLORFX_SET_CBCR</constant>
  365. color effect. Bits [7:0] of the supplied 32 bit value are interpreted as
  366. Cr component, bits [15:8] as Cb component and bits [31:16] must be zero.
  367. </entry>
  368. </row>
  369. <row>
  370. <entry><constant>V4L2_CID_ROTATE</constant></entry>
  371. <entry>integer</entry>
  372. <entry>Rotates the image by specified angle. Common angles are 90,
  373. 270 and 180. Rotating the image to 90 and 270 will reverse the height
  374. and width of the display window. It is necessary to set the new height and
  375. width of the picture using the &VIDIOC-S-FMT; ioctl according to
  376. the rotation angle selected.</entry>
  377. </row>
  378. <row>
  379. <entry><constant>V4L2_CID_BG_COLOR</constant></entry>
  380. <entry>integer</entry>
  381. <entry>Sets the background color on the current output device.
  382. Background color needs to be specified in the RGB24 format. The
  383. supplied 32 bit value is interpreted as bits 0-7 Red color information,
  384. bits 8-15 Green color information, bits 16-23 Blue color
  385. information and bits 24-31 must be zero.</entry>
  386. </row>
  387. <row>
  388. <entry><constant>V4L2_CID_ILLUMINATORS_1</constant>
  389. <constant>V4L2_CID_ILLUMINATORS_2</constant></entry>
  390. <entry>boolean</entry>
  391. <entry>Switch on or off the illuminator 1 or 2 of the device
  392. (usually a microscope).</entry>
  393. </row>
  394. <row>
  395. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry>
  396. <entry>integer</entry>
  397. <entry>This is a read-only control that can be read by the application
  398. and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS.
  399. The value is the minimum number of CAPTURE buffers that is necessary for hardware
  400. to work.</entry>
  401. </row>
  402. <row>
  403. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_OUTPUT</constant></entry>
  404. <entry>integer</entry>
  405. <entry>This is a read-only control that can be read by the application
  406. and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS.
  407. The value is the minimum number of OUTPUT buffers that is necessary for hardware
  408. to work.</entry>
  409. </row>
  410. <row id="v4l2-alpha-component">
  411. <entry><constant>V4L2_CID_ALPHA_COMPONENT</constant></entry>
  412. <entry>integer</entry>
  413. <entry> Sets the alpha color component on the capture device or on
  414. the capture buffer queue of a mem-to-mem device. When a mem-to-mem
  415. device produces frame format that includes an alpha component
  416. (e.g. <link linkend="rgb-formats">packed RGB image formats</link>)
  417. and the alpha value is not defined by the mem-to-mem input data
  418. this control lets you select the alpha component value of all
  419. pixels. It is applicable to any pixel format that contains an alpha
  420. component.
  421. </entry>
  422. </row>
  423. <row>
  424. <entry><constant>V4L2_CID_LASTP1</constant></entry>
  425. <entry></entry>
  426. <entry>End of the predefined control IDs (currently
  427. <constant>V4L2_CID_ALPHA_COMPONENT</constant> + 1).</entry>
  428. </row>
  429. <row>
  430. <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry>
  431. <entry></entry>
  432. <entry>ID of the first custom (driver specific) control.
  433. Applications depending on particular custom controls should check the
  434. driver name and version, see <xref linkend="querycap" />.</entry>
  435. </row>
  436. </tbody>
  437. </tgroup>
  438. </table>
  439. <para>Applications can enumerate the available controls with the
  440. &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls, get and set a
  441. control value with the &VIDIOC-G-CTRL; and &VIDIOC-S-CTRL; ioctls.
  442. Drivers must implement <constant>VIDIOC_QUERYCTRL</constant>,
  443. <constant>VIDIOC_G_CTRL</constant> and
  444. <constant>VIDIOC_S_CTRL</constant> when the device has one or more
  445. controls, <constant>VIDIOC_QUERYMENU</constant> when it has one or
  446. more menu type controls.</para>
  447. <example>
  448. <title>Enumerating all controls</title>
  449. <programlisting>
  450. &v4l2-queryctrl; queryctrl;
  451. &v4l2-querymenu; querymenu;
  452. static void
  453. enumerate_menu (void)
  454. {
  455. printf (" Menu items:\n");
  456. memset (&amp;querymenu, 0, sizeof (querymenu));
  457. querymenu.id = queryctrl.id;
  458. for (querymenu.index = queryctrl.minimum;
  459. querymenu.index &lt;= queryctrl.maximum;
  460. querymenu.index++) {
  461. if (0 == ioctl (fd, &VIDIOC-QUERYMENU;, &amp;querymenu)) {
  462. printf (" %s\n", querymenu.name);
  463. }
  464. }
  465. }
  466. memset (&amp;queryctrl, 0, sizeof (queryctrl));
  467. for (queryctrl.id = V4L2_CID_BASE;
  468. queryctrl.id &lt; V4L2_CID_LASTP1;
  469. queryctrl.id++) {
  470. if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  471. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  472. continue;
  473. printf ("Control %s\n", queryctrl.name);
  474. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  475. enumerate_menu ();
  476. } else {
  477. if (errno == EINVAL)
  478. continue;
  479. perror ("VIDIOC_QUERYCTRL");
  480. exit (EXIT_FAILURE);
  481. }
  482. }
  483. for (queryctrl.id = V4L2_CID_PRIVATE_BASE;;
  484. queryctrl.id++) {
  485. if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  486. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  487. continue;
  488. printf ("Control %s\n", queryctrl.name);
  489. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  490. enumerate_menu ();
  491. } else {
  492. if (errno == EINVAL)
  493. break;
  494. perror ("VIDIOC_QUERYCTRL");
  495. exit (EXIT_FAILURE);
  496. }
  497. }
  498. </programlisting>
  499. </example>
  500. <example>
  501. <title>Changing controls</title>
  502. <programlisting>
  503. &v4l2-queryctrl; queryctrl;
  504. &v4l2-control; control;
  505. memset (&amp;queryctrl, 0, sizeof (queryctrl));
  506. queryctrl.id = V4L2_CID_BRIGHTNESS;
  507. if (-1 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  508. if (errno != EINVAL) {
  509. perror ("VIDIOC_QUERYCTRL");
  510. exit (EXIT_FAILURE);
  511. } else {
  512. printf ("V4L2_CID_BRIGHTNESS is not supported\n");
  513. }
  514. } else if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED) {
  515. printf ("V4L2_CID_BRIGHTNESS is not supported\n");
  516. } else {
  517. memset (&amp;control, 0, sizeof (control));
  518. control.id = V4L2_CID_BRIGHTNESS;
  519. control.value = queryctrl.default_value;
  520. if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)) {
  521. perror ("VIDIOC_S_CTRL");
  522. exit (EXIT_FAILURE);
  523. }
  524. }
  525. memset (&amp;control, 0, sizeof (control));
  526. control.id = V4L2_CID_CONTRAST;
  527. if (0 == ioctl (fd, &VIDIOC-G-CTRL;, &amp;control)) {
  528. control.value += 1;
  529. /* The driver may clamp the value or return ERANGE, ignored here */
  530. if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)
  531. &amp;&amp; errno != ERANGE) {
  532. perror ("VIDIOC_S_CTRL");
  533. exit (EXIT_FAILURE);
  534. }
  535. /* Ignore if V4L2_CID_CONTRAST is unsupported */
  536. } else if (errno != EINVAL) {
  537. perror ("VIDIOC_G_CTRL");
  538. exit (EXIT_FAILURE);
  539. }
  540. control.id = V4L2_CID_AUDIO_MUTE;
  541. control.value = TRUE; /* silence */
  542. /* Errors ignored */
  543. ioctl (fd, VIDIOC_S_CTRL, &amp;control);
  544. </programlisting>
  545. </example>
  546. </section>
  547. <section id="extended-controls">
  548. <title>Extended Controls</title>
  549. <section>
  550. <title>Introduction</title>
  551. <para>The control mechanism as originally designed was meant
  552. to be used for user settings (brightness, saturation, etc). However,
  553. it turned out to be a very useful model for implementing more
  554. complicated driver APIs where each driver implements only a subset of
  555. a larger API.</para>
  556. <para>The MPEG encoding API was the driving force behind
  557. designing and implementing this extended control mechanism: the MPEG
  558. standard is quite large and the currently supported hardware MPEG
  559. encoders each only implement a subset of this standard. Further more,
  560. many parameters relating to how the video is encoded into an MPEG
  561. stream are specific to the MPEG encoding chip since the MPEG standard
  562. only defines the format of the resulting MPEG stream, not how the
  563. video is actually encoded into that format.</para>
  564. <para>Unfortunately, the original control API lacked some
  565. features needed for these new uses and so it was extended into the
  566. (not terribly originally named) extended control API.</para>
  567. <para>Even though the MPEG encoding API was the first effort
  568. to use the Extended Control API, nowadays there are also other classes
  569. of Extended Controls, such as Camera Controls and FM Transmitter Controls.
  570. The Extended Controls API as well as all Extended Controls classes are
  571. described in the following text.</para>
  572. </section>
  573. <section>
  574. <title>The Extended Control API</title>
  575. <para>Three new ioctls are available: &VIDIOC-G-EXT-CTRLS;,
  576. &VIDIOC-S-EXT-CTRLS; and &VIDIOC-TRY-EXT-CTRLS;. These ioctls act on
  577. arrays of controls (as opposed to the &VIDIOC-G-CTRL; and
  578. &VIDIOC-S-CTRL; ioctls that act on a single control). This is needed
  579. since it is often required to atomically change several controls at
  580. once.</para>
  581. <para>Each of the new ioctls expects a pointer to a
  582. &v4l2-ext-controls;. This structure contains a pointer to the control
  583. array, a count of the number of controls in that array and a control
  584. class. Control classes are used to group similar controls into a
  585. single class. For example, control class
  586. <constant>V4L2_CTRL_CLASS_USER</constant> contains all user controls
  587. (&ie; all controls that can also be set using the old
  588. <constant>VIDIOC_S_CTRL</constant> ioctl). Control class
  589. <constant>V4L2_CTRL_CLASS_MPEG</constant> contains all controls
  590. relating to MPEG encoding, etc.</para>
  591. <para>All controls in the control array must belong to the
  592. specified control class. An error is returned if this is not the
  593. case.</para>
  594. <para>It is also possible to use an empty control array (count
  595. == 0) to check whether the specified control class is
  596. supported.</para>
  597. <para>The control array is a &v4l2-ext-control; array. The
  598. <structname>v4l2_ext_control</structname> structure is very similar to
  599. &v4l2-control;, except for the fact that it also allows for 64-bit
  600. values and pointers to be passed.</para>
  601. <para>It is important to realize that due to the flexibility of
  602. controls it is necessary to check whether the control you want to set
  603. actually is supported in the driver and what the valid range of values
  604. is. So use the &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls to
  605. check this. Also note that it is possible that some of the menu
  606. indices in a control of type <constant>V4L2_CTRL_TYPE_MENU</constant>
  607. may not be supported (<constant>VIDIOC_QUERYMENU</constant> will
  608. return an error). A good example is the list of supported MPEG audio
  609. bitrates. Some drivers only support one or two bitrates, others
  610. support a wider range.</para>
  611. <para>
  612. All controls use machine endianness.
  613. </para>
  614. </section>
  615. <section>
  616. <title>Enumerating Extended Controls</title>
  617. <para>The recommended way to enumerate over the extended
  618. controls is by using &VIDIOC-QUERYCTRL; in combination with the
  619. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag:</para>
  620. <informalexample>
  621. <programlisting>
  622. &v4l2-queryctrl; qctrl;
  623. qctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL;
  624. while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  625. /* ... */
  626. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  627. }
  628. </programlisting>
  629. </informalexample>
  630. <para>The initial control ID is set to 0 ORed with the
  631. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag. The
  632. <constant>VIDIOC_QUERYCTRL</constant> ioctl will return the first
  633. control with a higher ID than the specified one. When no such controls
  634. are found an error is returned.</para>
  635. <para>If you want to get all controls within a specific control
  636. class, then you can set the initial
  637. <structfield>qctrl.id</structfield> value to the control class and add
  638. an extra check to break out of the loop when a control of another
  639. control class is found:</para>
  640. <informalexample>
  641. <programlisting>
  642. qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;
  643. while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  644. if (V4L2_CTRL_ID2CLASS (qctrl.id) != V4L2_CTRL_CLASS_MPEG)
  645. break;
  646. /* ... */
  647. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  648. }
  649. </programlisting>
  650. </informalexample>
  651. <para>The 32-bit <structfield>qctrl.id</structfield> value is
  652. subdivided into three bit ranges: the top 4 bits are reserved for
  653. flags (&eg; <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>) and are not
  654. actually part of the ID. The remaining 28 bits form the control ID, of
  655. which the most significant 12 bits define the control class and the
  656. least significant 16 bits identify the control within the control
  657. class. It is guaranteed that these last 16 bits are always non-zero
  658. for controls. The range of 0x1000 and up are reserved for
  659. driver-specific controls. The macro
  660. <constant>V4L2_CTRL_ID2CLASS(id)</constant> returns the control class
  661. ID based on a control ID.</para>
  662. <para>If the driver does not support extended controls, then
  663. <constant>VIDIOC_QUERYCTRL</constant> will fail when used in
  664. combination with <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>. In
  665. that case the old method of enumerating control should be used (see
  666. 1.8). But if it is supported, then it is guaranteed to enumerate over
  667. all controls, including driver-private controls.</para>
  668. </section>
  669. <section>
  670. <title>Creating Control Panels</title>
  671. <para>It is possible to create control panels for a graphical
  672. user interface where the user can select the various controls.
  673. Basically you will have to iterate over all controls using the method
  674. described above. Each control class starts with a control of type
  675. <constant>V4L2_CTRL_TYPE_CTRL_CLASS</constant>.
  676. <constant>VIDIOC_QUERYCTRL</constant> will return the name of this
  677. control class which can be used as the title of a tab page within a
  678. control panel.</para>
  679. <para>The flags field of &v4l2-queryctrl; also contains hints on
  680. the behavior of the control. See the &VIDIOC-QUERYCTRL; documentation
  681. for more details.</para>
  682. </section>
  683. <section id="mpeg-controls">
  684. <title>MPEG Control Reference</title>
  685. <para>Below all controls within the MPEG control class are
  686. described. First the generic controls, then controls specific for
  687. certain hardware.</para>
  688. <section>
  689. <title>Generic MPEG Controls</title>
  690. <table pgwide="1" frame="none" id="mpeg-control-id">
  691. <title>MPEG Control IDs</title>
  692. <tgroup cols="4">
  693. <colspec colname="c1" colwidth="1*" />
  694. <colspec colname="c2" colwidth="6*" />
  695. <colspec colname="c3" colwidth="2*" />
  696. <colspec colname="c4" colwidth="6*" />
  697. <spanspec namest="c1" nameend="c2" spanname="id" />
  698. <spanspec namest="c2" nameend="c4" spanname="descr" />
  699. <thead>
  700. <row>
  701. <entry spanname="id" align="left">ID</entry>
  702. <entry align="left">Type</entry>
  703. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  704. </row>
  705. </thead>
  706. <tbody valign="top">
  707. <row><entry></entry></row>
  708. <row>
  709. <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant>&nbsp;</entry>
  710. <entry>class</entry>
  711. </row><row><entry spanname="descr">The MPEG class
  712. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  713. description of this control class. This description can be used as the
  714. caption of a Tab page in a GUI, for example.</entry>
  715. </row>
  716. <row><entry></entry></row>
  717. <row id="v4l2-mpeg-stream-type">
  718. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant>&nbsp;</entry>
  719. <entry>enum&nbsp;v4l2_mpeg_stream_type</entry>
  720. </row><row><entry spanname="descr">The MPEG-1, -2 or -4
  721. output stream type. One cannot assume anything here. Each hardware
  722. MPEG encoder tends to support different subsets of the available MPEG
  723. stream types. This control is specific to multiplexed MPEG streams.
  724. The currently defined stream types are:</entry>
  725. </row>
  726. <row>
  727. <entrytbl spanname="descr" cols="2">
  728. <tbody valign="top">
  729. <row>
  730. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_PS</constant>&nbsp;</entry>
  731. <entry>MPEG-2 program stream</entry>
  732. </row>
  733. <row>
  734. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_TS</constant>&nbsp;</entry>
  735. <entry>MPEG-2 transport stream</entry>
  736. </row>
  737. <row>
  738. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_SS</constant>&nbsp;</entry>
  739. <entry>MPEG-1 system stream</entry>
  740. </row>
  741. <row>
  742. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_DVD</constant>&nbsp;</entry>
  743. <entry>MPEG-2 DVD-compatible stream</entry>
  744. </row>
  745. <row>
  746. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_VCD</constant>&nbsp;</entry>
  747. <entry>MPEG-1 VCD-compatible stream</entry>
  748. </row>
  749. <row>
  750. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD</constant>&nbsp;</entry>
  751. <entry>MPEG-2 SVCD-compatible stream</entry>
  752. </row>
  753. </tbody>
  754. </entrytbl>
  755. </row>
  756. <row><entry></entry></row>
  757. <row>
  758. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PMT</constant>&nbsp;</entry>
  759. <entry>integer</entry>
  760. </row><row><entry spanname="descr">Program Map Table
  761. Packet ID for the MPEG transport stream (default 16)</entry>
  762. </row>
  763. <row><entry></entry></row>
  764. <row>
  765. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_AUDIO</constant>&nbsp;</entry>
  766. <entry>integer</entry>
  767. </row><row><entry spanname="descr">Audio Packet ID for
  768. the MPEG transport stream (default 256)</entry>
  769. </row>
  770. <row><entry></entry></row>
  771. <row>
  772. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_VIDEO</constant>&nbsp;</entry>
  773. <entry>integer</entry>
  774. </row><row><entry spanname="descr">Video Packet ID for
  775. the MPEG transport stream (default 260)</entry>
  776. </row>
  777. <row><entry></entry></row>
  778. <row>
  779. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PCR</constant>&nbsp;</entry>
  780. <entry>integer</entry>
  781. </row><row><entry spanname="descr">Packet ID for the
  782. MPEG transport stream carrying PCR fields (default 259)</entry>
  783. </row>
  784. <row><entry></entry></row>
  785. <row>
  786. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_AUDIO</constant>&nbsp;</entry>
  787. <entry>integer</entry>
  788. </row><row><entry spanname="descr">Audio ID for MPEG
  789. PES</entry>
  790. </row>
  791. <row><entry></entry></row>
  792. <row>
  793. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_VIDEO</constant>&nbsp;</entry>
  794. <entry>integer</entry>
  795. </row><row><entry spanname="descr">Video ID for MPEG
  796. PES</entry>
  797. </row>
  798. <row><entry></entry></row>
  799. <row id="v4l2-mpeg-stream-vbi-fmt">
  800. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant>&nbsp;</entry>
  801. <entry>enum&nbsp;v4l2_mpeg_stream_vbi_fmt</entry>
  802. </row><row><entry spanname="descr">Some cards can embed
  803. VBI data (&eg; Closed Caption, Teletext) into the MPEG stream. This
  804. control selects whether VBI data should be embedded, and if so, what
  805. embedding method should be used. The list of possible VBI formats
  806. depends on the driver. The currently defined VBI format types
  807. are:</entry>
  808. </row>
  809. <row>
  810. <entrytbl spanname="descr" cols="2">
  811. <tbody valign="top">
  812. <row>
  813. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_NONE</constant>&nbsp;</entry>
  814. <entry>No VBI in the MPEG stream</entry>
  815. </row>
  816. <row>
  817. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_IVTV</constant>&nbsp;</entry>
  818. <entry>VBI in private packets, IVTV format (documented
  819. in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.vbi</filename>)</entry>
  820. </row>
  821. </tbody>
  822. </entrytbl>
  823. </row>
  824. <row><entry></entry></row>
  825. <row id="v4l2-mpeg-audio-sampling-freq">
  826. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant>&nbsp;</entry>
  827. <entry>enum&nbsp;v4l2_mpeg_audio_sampling_freq</entry>
  828. </row><row><entry spanname="descr">MPEG Audio sampling
  829. frequency. Possible values are:</entry>
  830. </row>
  831. <row>
  832. <entrytbl spanname="descr" cols="2">
  833. <tbody valign="top">
  834. <row>
  835. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100</constant>&nbsp;</entry>
  836. <entry>44.1 kHz</entry>
  837. </row>
  838. <row>
  839. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000</constant>&nbsp;</entry>
  840. <entry>48 kHz</entry>
  841. </row>
  842. <row>
  843. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000</constant>&nbsp;</entry>
  844. <entry>32 kHz</entry>
  845. </row>
  846. </tbody>
  847. </entrytbl>
  848. </row>
  849. <row><entry></entry></row>
  850. <row id="v4l2-mpeg-audio-encoding">
  851. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant>&nbsp;</entry>
  852. <entry>enum&nbsp;v4l2_mpeg_audio_encoding</entry>
  853. </row><row><entry spanname="descr">MPEG Audio encoding.
  854. This control is specific to multiplexed MPEG streams.
  855. Possible values are:</entry>
  856. </row>
  857. <row>
  858. <entrytbl spanname="descr" cols="2">
  859. <tbody valign="top">
  860. <row>
  861. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_1</constant>&nbsp;</entry>
  862. <entry>MPEG-1/2 Layer I encoding</entry>
  863. </row>
  864. <row>
  865. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_2</constant>&nbsp;</entry>
  866. <entry>MPEG-1/2 Layer II encoding</entry>
  867. </row>
  868. <row>
  869. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_3</constant>&nbsp;</entry>
  870. <entry>MPEG-1/2 Layer III encoding</entry>
  871. </row>
  872. <row>
  873. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AAC</constant>&nbsp;</entry>
  874. <entry>MPEG-2/4 AAC (Advanced Audio Coding)</entry>
  875. </row>
  876. <row>
  877. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AC3</constant>&nbsp;</entry>
  878. <entry>AC-3 aka ATSC A/52 encoding</entry>
  879. </row>
  880. </tbody>
  881. </entrytbl>
  882. </row>
  883. <row><entry></entry></row>
  884. <row id="v4l2-mpeg-audio-l1-bitrate">
  885. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant>&nbsp;</entry>
  886. <entry>enum&nbsp;v4l2_mpeg_audio_l1_bitrate</entry>
  887. </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate.
  888. Possible values are:</entry>
  889. </row>
  890. <row>
  891. <entrytbl spanname="descr" cols="2">
  892. <tbody valign="top">
  893. <row>
  894. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_32K</constant>&nbsp;</entry>
  895. <entry>32 kbit/s</entry></row>
  896. <row>
  897. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_64K</constant>&nbsp;</entry>
  898. <entry>64 kbit/s</entry>
  899. </row>
  900. <row>
  901. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_96K</constant>&nbsp;</entry>
  902. <entry>96 kbit/s</entry>
  903. </row>
  904. <row>
  905. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_128K</constant>&nbsp;</entry>
  906. <entry>128 kbit/s</entry>
  907. </row>
  908. <row>
  909. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_160K</constant>&nbsp;</entry>
  910. <entry>160 kbit/s</entry>
  911. </row>
  912. <row>
  913. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_192K</constant>&nbsp;</entry>
  914. <entry>192 kbit/s</entry>
  915. </row>
  916. <row>
  917. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_224K</constant>&nbsp;</entry>
  918. <entry>224 kbit/s</entry>
  919. </row>
  920. <row>
  921. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_256K</constant>&nbsp;</entry>
  922. <entry>256 kbit/s</entry>
  923. </row>
  924. <row>
  925. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_288K</constant>&nbsp;</entry>
  926. <entry>288 kbit/s</entry>
  927. </row>
  928. <row>
  929. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_320K</constant>&nbsp;</entry>
  930. <entry>320 kbit/s</entry>
  931. </row>
  932. <row>
  933. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_352K</constant>&nbsp;</entry>
  934. <entry>352 kbit/s</entry>
  935. </row>
  936. <row>
  937. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_384K</constant>&nbsp;</entry>
  938. <entry>384 kbit/s</entry>
  939. </row>
  940. <row>
  941. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_416K</constant>&nbsp;</entry>
  942. <entry>416 kbit/s</entry>
  943. </row>
  944. <row>
  945. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_448K</constant>&nbsp;</entry>
  946. <entry>448 kbit/s</entry>
  947. </row>
  948. </tbody>
  949. </entrytbl>
  950. </row>
  951. <row><entry></entry></row>
  952. <row id="v4l2-mpeg-audio-l2-bitrate">
  953. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant>&nbsp;</entry>
  954. <entry>enum&nbsp;v4l2_mpeg_audio_l2_bitrate</entry>
  955. </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate.
  956. Possible values are:</entry>
  957. </row>
  958. <row>
  959. <entrytbl spanname="descr" cols="2">
  960. <tbody valign="top">
  961. <row>
  962. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_32K</constant>&nbsp;</entry>
  963. <entry>32 kbit/s</entry>
  964. </row>
  965. <row>
  966. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_48K</constant>&nbsp;</entry>
  967. <entry>48 kbit/s</entry>
  968. </row>
  969. <row>
  970. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_56K</constant>&nbsp;</entry>
  971. <entry>56 kbit/s</entry>
  972. </row>
  973. <row>
  974. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_64K</constant>&nbsp;</entry>
  975. <entry>64 kbit/s</entry>
  976. </row>
  977. <row>
  978. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_80K</constant>&nbsp;</entry>
  979. <entry>80 kbit/s</entry>
  980. </row>
  981. <row>
  982. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_96K</constant>&nbsp;</entry>
  983. <entry>96 kbit/s</entry>
  984. </row>
  985. <row>
  986. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_112K</constant>&nbsp;</entry>
  987. <entry>112 kbit/s</entry>
  988. </row>
  989. <row>
  990. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_128K</constant>&nbsp;</entry>
  991. <entry>128 kbit/s</entry>
  992. </row>
  993. <row>
  994. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_160K</constant>&nbsp;</entry>
  995. <entry>160 kbit/s</entry>
  996. </row>
  997. <row>
  998. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_192K</constant>&nbsp;</entry>
  999. <entry>192 kbit/s</entry>
  1000. </row>
  1001. <row>
  1002. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_224K</constant>&nbsp;</entry>
  1003. <entry>224 kbit/s</entry>
  1004. </row>
  1005. <row>
  1006. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_256K</constant>&nbsp;</entry>
  1007. <entry>256 kbit/s</entry>
  1008. </row>
  1009. <row>
  1010. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_320K</constant>&nbsp;</entry>
  1011. <entry>320 kbit/s</entry>
  1012. </row>
  1013. <row>
  1014. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_384K</constant>&nbsp;</entry>
  1015. <entry>384 kbit/s</entry>
  1016. </row>
  1017. </tbody>
  1018. </entrytbl>
  1019. </row>
  1020. <row><entry></entry></row>
  1021. <row id="v4l2-mpeg-audio-l3-bitrate">
  1022. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant>&nbsp;</entry>
  1023. <entry>enum&nbsp;v4l2_mpeg_audio_l3_bitrate</entry>
  1024. </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate.
  1025. Possible values are:</entry>
  1026. </row>
  1027. <row>
  1028. <entrytbl spanname="descr" cols="2">
  1029. <tbody valign="top">
  1030. <row>
  1031. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_32K</constant>&nbsp;</entry>
  1032. <entry>32 kbit/s</entry>
  1033. </row>
  1034. <row>
  1035. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_40K</constant>&nbsp;</entry>
  1036. <entry>40 kbit/s</entry>
  1037. </row>
  1038. <row>
  1039. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_48K</constant>&nbsp;</entry>
  1040. <entry>48 kbit/s</entry>
  1041. </row>
  1042. <row>
  1043. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_56K</constant>&nbsp;</entry>
  1044. <entry>56 kbit/s</entry>
  1045. </row>
  1046. <row>
  1047. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_64K</constant>&nbsp;</entry>
  1048. <entry>64 kbit/s</entry>
  1049. </row>
  1050. <row>
  1051. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_80K</constant>&nbsp;</entry>
  1052. <entry>80 kbit/s</entry>
  1053. </row>
  1054. <row>
  1055. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_96K</constant>&nbsp;</entry>
  1056. <entry>96 kbit/s</entry>
  1057. </row>
  1058. <row>
  1059. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_112K</constant>&nbsp;</entry>
  1060. <entry>112 kbit/s</entry>
  1061. </row>
  1062. <row>
  1063. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_128K</constant>&nbsp;</entry>
  1064. <entry>128 kbit/s</entry>
  1065. </row>
  1066. <row>
  1067. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_160K</constant>&nbsp;</entry>
  1068. <entry>160 kbit/s</entry>
  1069. </row>
  1070. <row>
  1071. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_192K</constant>&nbsp;</entry>
  1072. <entry>192 kbit/s</entry>
  1073. </row>
  1074. <row>
  1075. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_224K</constant>&nbsp;</entry>
  1076. <entry>224 kbit/s</entry>
  1077. </row>
  1078. <row>
  1079. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_256K</constant>&nbsp;</entry>
  1080. <entry>256 kbit/s</entry>
  1081. </row>
  1082. <row>
  1083. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_320K</constant>&nbsp;</entry>
  1084. <entry>320 kbit/s</entry>
  1085. </row>
  1086. </tbody>
  1087. </entrytbl>
  1088. </row>
  1089. <row><entry></entry></row>
  1090. <row>
  1091. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AAC_BITRATE</constant>&nbsp;</entry>
  1092. <entry>integer</entry>
  1093. </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry>
  1094. </row>
  1095. <row><entry></entry></row>
  1096. <row id="v4l2-mpeg-audio-ac3-bitrate">
  1097. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant>&nbsp;</entry>
  1098. <entry>enum&nbsp;v4l2_mpeg_audio_ac3_bitrate</entry>
  1099. </row><row><entry spanname="descr">AC-3 bitrate.
  1100. Possible values are:</entry>
  1101. </row>
  1102. <row>
  1103. <entrytbl spanname="descr" cols="2">
  1104. <tbody valign="top">
  1105. <row>
  1106. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_32K</constant>&nbsp;</entry>
  1107. <entry>32 kbit/s</entry>
  1108. </row>
  1109. <row>
  1110. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_40K</constant>&nbsp;</entry>
  1111. <entry>40 kbit/s</entry>
  1112. </row>
  1113. <row>
  1114. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_48K</constant>&nbsp;</entry>
  1115. <entry>48 kbit/s</entry>
  1116. </row>
  1117. <row>
  1118. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_56K</constant>&nbsp;</entry>
  1119. <entry>56 kbit/s</entry>
  1120. </row>
  1121. <row>
  1122. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_64K</constant>&nbsp;</entry>
  1123. <entry>64 kbit/s</entry>
  1124. </row>
  1125. <row>
  1126. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_80K</constant>&nbsp;</entry>
  1127. <entry>80 kbit/s</entry>
  1128. </row>
  1129. <row>
  1130. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_96K</constant>&nbsp;</entry>
  1131. <entry>96 kbit/s</entry>
  1132. </row>
  1133. <row>
  1134. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_112K</constant>&nbsp;</entry>
  1135. <entry>112 kbit/s</entry>
  1136. </row>
  1137. <row>
  1138. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_128K</constant>&nbsp;</entry>
  1139. <entry>128 kbit/s</entry>
  1140. </row>
  1141. <row>
  1142. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_160K</constant>&nbsp;</entry>
  1143. <entry>160 kbit/s</entry>
  1144. </row>
  1145. <row>
  1146. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_192K</constant>&nbsp;</entry>
  1147. <entry>192 kbit/s</entry>
  1148. </row>
  1149. <row>
  1150. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_224K</constant>&nbsp;</entry>
  1151. <entry>224 kbit/s</entry>
  1152. </row>
  1153. <row>
  1154. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_256K</constant>&nbsp;</entry>
  1155. <entry>256 kbit/s</entry>
  1156. </row>
  1157. <row>
  1158. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_320K</constant>&nbsp;</entry>
  1159. <entry>320 kbit/s</entry>
  1160. </row>
  1161. <row>
  1162. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_384K</constant>&nbsp;</entry>
  1163. <entry>384 kbit/s</entry>
  1164. </row>
  1165. <row>
  1166. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_448K</constant>&nbsp;</entry>
  1167. <entry>448 kbit/s</entry>
  1168. </row>
  1169. <row>
  1170. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_512K</constant>&nbsp;</entry>
  1171. <entry>512 kbit/s</entry>
  1172. </row>
  1173. <row>
  1174. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_576K</constant>&nbsp;</entry>
  1175. <entry>576 kbit/s</entry>
  1176. </row>
  1177. <row>
  1178. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_640K</constant>&nbsp;</entry>
  1179. <entry>640 kbit/s</entry>
  1180. </row>
  1181. </tbody>
  1182. </entrytbl>
  1183. </row>
  1184. <row><entry></entry></row>
  1185. <row id="v4l2-mpeg-audio-mode">
  1186. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant>&nbsp;</entry>
  1187. <entry>enum&nbsp;v4l2_mpeg_audio_mode</entry>
  1188. </row><row><entry spanname="descr">MPEG Audio mode.
  1189. Possible values are:</entry>
  1190. </row>
  1191. <row>
  1192. <entrytbl spanname="descr" cols="2">
  1193. <tbody valign="top">
  1194. <row>
  1195. <entry><constant>V4L2_MPEG_AUDIO_MODE_STEREO</constant>&nbsp;</entry>
  1196. <entry>Stereo</entry>
  1197. </row>
  1198. <row>
  1199. <entry><constant>V4L2_MPEG_AUDIO_MODE_JOINT_STEREO</constant>&nbsp;</entry>
  1200. <entry>Joint Stereo</entry>
  1201. </row>
  1202. <row>
  1203. <entry><constant>V4L2_MPEG_AUDIO_MODE_DUAL</constant>&nbsp;</entry>
  1204. <entry>Bilingual</entry>
  1205. </row>
  1206. <row>
  1207. <entry><constant>V4L2_MPEG_AUDIO_MODE_MONO</constant>&nbsp;</entry>
  1208. <entry>Mono</entry>
  1209. </row>
  1210. </tbody>
  1211. </entrytbl>
  1212. </row>
  1213. <row><entry></entry></row>
  1214. <row id="v4l2-mpeg-audio-mode-extension">
  1215. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant>&nbsp;</entry>
  1216. <entry>enum&nbsp;v4l2_mpeg_audio_mode_extension</entry>
  1217. </row><row><entry spanname="descr">Joint Stereo
  1218. audio mode extension. In Layer I and II they indicate which subbands
  1219. are in intensity stereo. All other subbands are coded in stereo. Layer
  1220. III is not (yet) supported. Possible values
  1221. are:</entry>
  1222. </row>
  1223. <row>
  1224. <entrytbl spanname="descr" cols="2">
  1225. <tbody valign="top">
  1226. <row>
  1227. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4</constant>&nbsp;</entry>
  1228. <entry>Subbands 4-31 in intensity stereo</entry>
  1229. </row>
  1230. <row>
  1231. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8</constant>&nbsp;</entry>
  1232. <entry>Subbands 8-31 in intensity stereo</entry>
  1233. </row>
  1234. <row>
  1235. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12</constant>&nbsp;</entry>
  1236. <entry>Subbands 12-31 in intensity stereo</entry>
  1237. </row>
  1238. <row>
  1239. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16</constant>&nbsp;</entry>
  1240. <entry>Subbands 16-31 in intensity stereo</entry>
  1241. </row>
  1242. </tbody>
  1243. </entrytbl>
  1244. </row>
  1245. <row><entry></entry></row>
  1246. <row id="v4l2-mpeg-audio-emphasis">
  1247. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant>&nbsp;</entry>
  1248. <entry>enum&nbsp;v4l2_mpeg_audio_emphasis</entry>
  1249. </row><row><entry spanname="descr">Audio Emphasis.
  1250. Possible values are:</entry>
  1251. </row>
  1252. <row>
  1253. <entrytbl spanname="descr" cols="2">
  1254. <tbody valign="top">
  1255. <row>
  1256. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_NONE</constant>&nbsp;</entry>
  1257. <entry>None</entry>
  1258. </row>
  1259. <row>
  1260. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS</constant>&nbsp;</entry>
  1261. <entry>50/15 microsecond emphasis</entry>
  1262. </row>
  1263. <row>
  1264. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17</constant>&nbsp;</entry>
  1265. <entry>CCITT J.17</entry>
  1266. </row>
  1267. </tbody>
  1268. </entrytbl>
  1269. </row>
  1270. <row><entry></entry></row>
  1271. <row id="v4l2-mpeg-audio-crc">
  1272. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant>&nbsp;</entry>
  1273. <entry>enum&nbsp;v4l2_mpeg_audio_crc</entry>
  1274. </row><row><entry spanname="descr">CRC method. Possible
  1275. values are:</entry>
  1276. </row>
  1277. <row>
  1278. <entrytbl spanname="descr" cols="2">
  1279. <tbody valign="top">
  1280. <row>
  1281. <entry><constant>V4L2_MPEG_AUDIO_CRC_NONE</constant>&nbsp;</entry>
  1282. <entry>None</entry>
  1283. </row>
  1284. <row>
  1285. <entry><constant>V4L2_MPEG_AUDIO_CRC_CRC16</constant>&nbsp;</entry>
  1286. <entry>16 bit parity check</entry>
  1287. </row>
  1288. </tbody>
  1289. </entrytbl>
  1290. </row>
  1291. <row><entry></entry></row>
  1292. <row>
  1293. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant>&nbsp;</entry>
  1294. <entry>boolean</entry>
  1295. </row><row><entry spanname="descr">Mutes the audio when
  1296. capturing. This is not done by muting audio hardware, which can still
  1297. produce a slight hiss, but in the encoder itself, guaranteeing a fixed
  1298. and reproducible audio bitstream. 0 = unmuted, 1 = muted.</entry>
  1299. </row>
  1300. <row><entry></entry></row>
  1301. <row id="v4l2-mpeg-audio-dec-playback">
  1302. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK</constant>&nbsp;</entry>
  1303. <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
  1304. </row><row><entry spanname="descr">Determines how monolingual audio should be played back.
  1305. Possible values are:</entry>
  1306. </row>
  1307. <row>
  1308. <entrytbl spanname="descr" cols="2">
  1309. <tbody valign="top">
  1310. <row>
  1311. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO</constant>&nbsp;</entry>
  1312. <entry>Automatically determines the best playback mode.</entry>
  1313. </row>
  1314. <row>
  1315. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO</constant>&nbsp;</entry>
  1316. <entry>Stereo playback.</entry>
  1317. </row>
  1318. <row>
  1319. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT</constant>&nbsp;</entry>
  1320. <entry>Left channel playback.</entry>
  1321. </row>
  1322. <row>
  1323. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT</constant>&nbsp;</entry>
  1324. <entry>Right channel playback.</entry>
  1325. </row>
  1326. <row>
  1327. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO</constant>&nbsp;</entry>
  1328. <entry>Mono playback.</entry>
  1329. </row>
  1330. <row>
  1331. <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO</constant>&nbsp;</entry>
  1332. <entry>Stereo playback with swapped left and right channels.</entry>
  1333. </row>
  1334. </tbody>
  1335. </entrytbl>
  1336. </row>
  1337. <row><entry></entry></row>
  1338. <row id="v4l2-mpeg-audio-dec-multilingual-playback">
  1339. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK</constant>&nbsp;</entry>
  1340. <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
  1341. </row><row><entry spanname="descr">Determines how multilingual audio should be played back.</entry>
  1342. </row>
  1343. <row><entry></entry></row>
  1344. <row id="v4l2-mpeg-video-encoding">
  1345. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant>&nbsp;</entry>
  1346. <entry>enum&nbsp;v4l2_mpeg_video_encoding</entry>
  1347. </row><row><entry spanname="descr">MPEG Video encoding
  1348. method. This control is specific to multiplexed MPEG streams.
  1349. Possible values are:</entry>
  1350. </row>
  1351. <row>
  1352. <entrytbl spanname="descr" cols="2">
  1353. <tbody valign="top">
  1354. <row>
  1355. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_1</constant>&nbsp;</entry>
  1356. <entry>MPEG-1 Video encoding</entry>
  1357. </row>
  1358. <row>
  1359. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_2</constant>&nbsp;</entry>
  1360. <entry>MPEG-2 Video encoding</entry>
  1361. </row>
  1362. <row>
  1363. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC</constant>&nbsp;</entry>
  1364. <entry>MPEG-4 AVC (H.264) Video encoding</entry>
  1365. </row>
  1366. </tbody>
  1367. </entrytbl>
  1368. </row>
  1369. <row><entry></entry></row>
  1370. <row id="v4l2-mpeg-video-aspect">
  1371. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant>&nbsp;</entry>
  1372. <entry>enum&nbsp;v4l2_mpeg_video_aspect</entry>
  1373. </row><row><entry spanname="descr">Video aspect.
  1374. Possible values are:</entry>
  1375. </row>
  1376. <row>
  1377. <entrytbl spanname="descr" cols="2">
  1378. <tbody valign="top">
  1379. <row>
  1380. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_1x1</constant>&nbsp;</entry>
  1381. </row>
  1382. <row>
  1383. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_4x3</constant>&nbsp;</entry>
  1384. </row>
  1385. <row>
  1386. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_16x9</constant>&nbsp;</entry>
  1387. </row>
  1388. <row>
  1389. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_221x100</constant>&nbsp;</entry>
  1390. </row>
  1391. </tbody>
  1392. </entrytbl>
  1393. </row>
  1394. <row><entry></entry></row>
  1395. <row>
  1396. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_B_FRAMES</constant>&nbsp;</entry>
  1397. <entry>integer</entry>
  1398. </row><row><entry spanname="descr">Number of B-Frames
  1399. (default 2)</entry>
  1400. </row>
  1401. <row><entry></entry></row>
  1402. <row>
  1403. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_SIZE</constant>&nbsp;</entry>
  1404. <entry>integer</entry>
  1405. </row><row><entry spanname="descr">GOP size (default
  1406. 12)</entry>
  1407. </row>
  1408. <row><entry></entry></row>
  1409. <row>
  1410. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant>&nbsp;</entry>
  1411. <entry>boolean</entry>
  1412. </row><row><entry spanname="descr">GOP closure (default
  1413. 1)</entry>
  1414. </row>
  1415. <row><entry></entry></row>
  1416. <row>
  1417. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant>&nbsp;</entry>
  1418. <entry>boolean</entry>
  1419. </row><row><entry spanname="descr">Enable 3:2 pulldown
  1420. (default 0)</entry>
  1421. </row>
  1422. <row><entry></entry></row>
  1423. <row id="v4l2-mpeg-video-bitrate-mode">
  1424. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant>&nbsp;</entry>
  1425. <entry>enum&nbsp;v4l2_mpeg_video_bitrate_mode</entry>
  1426. </row><row><entry spanname="descr">Video bitrate mode.
  1427. Possible values are:</entry>
  1428. </row>
  1429. <row>
  1430. <entrytbl spanname="descr" cols="2">
  1431. <tbody valign="top">
  1432. <row>
  1433. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_VBR</constant>&nbsp;</entry>
  1434. <entry>Variable bitrate</entry>
  1435. </row>
  1436. <row>
  1437. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_CBR</constant>&nbsp;</entry>
  1438. <entry>Constant bitrate</entry>
  1439. </row>
  1440. </tbody>
  1441. </entrytbl>
  1442. </row>
  1443. <row><entry></entry></row>
  1444. <row>
  1445. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE</constant>&nbsp;</entry>
  1446. <entry>integer</entry>
  1447. </row><row><entry spanname="descr">Video bitrate in bits
  1448. per second.</entry>
  1449. </row>
  1450. <row><entry></entry></row>
  1451. <row>
  1452. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_PEAK</constant>&nbsp;</entry>
  1453. <entry>integer</entry>
  1454. </row><row><entry spanname="descr">Peak video bitrate in
  1455. bits per second. Must be larger or equal to the average video bitrate.
  1456. It is ignored if the video bitrate mode is set to constant
  1457. bitrate.</entry>
  1458. </row>
  1459. <row><entry></entry></row>
  1460. <row>
  1461. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION</constant>&nbsp;</entry>
  1462. <entry>integer</entry>
  1463. </row><row><entry spanname="descr">For every captured
  1464. frame, skip this many subsequent frames (default 0).</entry>
  1465. </row>
  1466. <row><entry></entry></row>
  1467. <row>
  1468. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant>&nbsp;</entry>
  1469. <entry>boolean</entry>
  1470. </row>
  1471. <row><entry spanname="descr">"Mutes" the video to a
  1472. fixed color when capturing. This is useful for testing, to produce a
  1473. fixed video bitstream. 0 = unmuted, 1 = muted.</entry>
  1474. </row>
  1475. <row><entry></entry></row>
  1476. <row>
  1477. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE_YUV</constant>&nbsp;</entry>
  1478. <entry>integer</entry>
  1479. </row><row><entry spanname="descr">Sets the "mute" color
  1480. of the video. The supplied 32-bit integer is interpreted as follows (bit
  1481. 0 = least significant bit):</entry>
  1482. </row>
  1483. <row>
  1484. <entrytbl spanname="descr" cols="2">
  1485. <tbody valign="top">
  1486. <row>
  1487. <entry>Bit 0:7</entry>
  1488. <entry>V chrominance information</entry>
  1489. </row>
  1490. <row>
  1491. <entry>Bit 8:15</entry>
  1492. <entry>U chrominance information</entry>
  1493. </row>
  1494. <row>
  1495. <entry>Bit 16:23</entry>
  1496. <entry>Y luminance information</entry>
  1497. </row>
  1498. <row>
  1499. <entry>Bit 24:31</entry>
  1500. <entry>Must be zero.</entry>
  1501. </row>
  1502. </tbody>
  1503. </entrytbl>
  1504. </row>
  1505. <row><entry></entry></row>
  1506. <row id="v4l2-mpeg-video-dec-pts">
  1507. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_PTS</constant>&nbsp;</entry>
  1508. <entry>integer64</entry>
  1509. </row><row><entry spanname="descr">This read-only control returns the
  1510. 33-bit video Presentation Time Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of
  1511. the currently displayed frame. This is the same PTS as is used in &VIDIOC-DECODER-CMD;.</entry>
  1512. </row>
  1513. <row><entry></entry></row>
  1514. <row id="v4l2-mpeg-video-dec-frame">
  1515. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_FRAME</constant>&nbsp;</entry>
  1516. <entry>integer64</entry>
  1517. </row><row><entry spanname="descr">This read-only control returns the
  1518. frame counter of the frame that is currently displayed (decoded). This value is reset to 0 whenever
  1519. the decoder is started.</entry>
  1520. </row>
  1521. <row><entry></entry></row>
  1522. <row>
  1523. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE</constant>&nbsp;</entry>
  1524. <entry>boolean</entry>
  1525. </row>
  1526. <row><entry spanname="descr">If enabled the decoder expects to receive a single slice per buffer, otherwise
  1527. the decoder expects a single frame in per buffer. Applicable to the decoder, all codecs.
  1528. </entry>
  1529. </row>
  1530. <row><entry></entry></row>
  1531. <row>
  1532. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE</constant>&nbsp;</entry>
  1533. <entry>boolean</entry>
  1534. </row>
  1535. <row><entry spanname="descr">Enable writing sample aspect ratio in the Video Usability Information.
  1536. Applicable to the H264 encoder.</entry>
  1537. </row>
  1538. <row><entry></entry></row>
  1539. <row id="v4l2-mpeg-video-h264-vui-sar-idc">
  1540. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC</constant>&nbsp;</entry>
  1541. <entry>enum&nbsp;v4l2_mpeg_video_h264_vui_sar_idc</entry>
  1542. </row>
  1543. <row><entry spanname="descr">VUI sample aspect ratio indicator for H.264 encoding. The value
  1544. is defined in the table E-1 in the standard. Applicable to the H264 encoder.</entry>
  1545. </row>
  1546. <row>
  1547. <entrytbl spanname="descr" cols="2">
  1548. <tbody valign="top">
  1549. <row>
  1550. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED</constant>&nbsp;</entry>
  1551. <entry>Unspecified</entry>
  1552. </row>
  1553. <row>
  1554. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1</constant>&nbsp;</entry>
  1555. <entry>1x1</entry>
  1556. </row>
  1557. <row>
  1558. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11</constant>&nbsp;</entry>
  1559. <entry>12x11</entry>
  1560. </row>
  1561. <row>
  1562. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11</constant>&nbsp;</entry>
  1563. <entry>10x11</entry>
  1564. </row>
  1565. <row>
  1566. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11</constant>&nbsp;</entry>
  1567. <entry>16x11</entry>
  1568. </row>
  1569. <row>
  1570. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33</constant>&nbsp;</entry>
  1571. <entry>40x33</entry>
  1572. </row>
  1573. <row>
  1574. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11</constant>&nbsp;</entry>
  1575. <entry>24x11</entry>
  1576. </row>
  1577. <row>
  1578. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11</constant>&nbsp;</entry>
  1579. <entry>20x11</entry>
  1580. </row>
  1581. <row>
  1582. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11</constant>&nbsp;</entry>
  1583. <entry>32x11</entry>
  1584. </row>
  1585. <row>
  1586. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33</constant>&nbsp;</entry>
  1587. <entry>80x33</entry>
  1588. </row>
  1589. <row>
  1590. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11</constant>&nbsp;</entry>
  1591. <entry>18x11</entry>
  1592. </row>
  1593. <row>
  1594. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11</constant>&nbsp;</entry>
  1595. <entry>15x11</entry>
  1596. </row>
  1597. <row>
  1598. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33</constant>&nbsp;</entry>
  1599. <entry>64x33</entry>
  1600. </row>
  1601. <row>
  1602. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99</constant>&nbsp;</entry>
  1603. <entry>160x99</entry>
  1604. </row>
  1605. <row>
  1606. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3</constant>&nbsp;</entry>
  1607. <entry>4x3</entry>
  1608. </row>
  1609. <row>
  1610. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2</constant>&nbsp;</entry>
  1611. <entry>3x2</entry>
  1612. </row>
  1613. <row>
  1614. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1</constant>&nbsp;</entry>
  1615. <entry>2x1</entry>
  1616. </row>
  1617. <row>
  1618. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED</constant>&nbsp;</entry>
  1619. <entry>Extended SAR</entry>
  1620. </row>
  1621. </tbody>
  1622. </entrytbl>
  1623. </row>
  1624. <row><entry></entry></row>
  1625. <row>
  1626. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH</constant>&nbsp;</entry>
  1627. <entry>integer</entry>
  1628. </row>
  1629. <row><entry spanname="descr">Extended sample aspect ratio width for H.264 VUI encoding.
  1630. Applicable to the H264 encoder.</entry>
  1631. </row>
  1632. <row><entry></entry></row>
  1633. <row>
  1634. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT</constant>&nbsp;</entry>
  1635. <entry>integer</entry>
  1636. </row>
  1637. <row><entry spanname="descr">Extended sample aspect ratio height for H.264 VUI encoding.
  1638. Applicable to the H264 encoder.</entry>
  1639. </row>
  1640. <row><entry></entry></row>
  1641. <row id="v4l2-mpeg-video-h264-level">
  1642. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LEVEL</constant>&nbsp;</entry>
  1643. <entry>enum&nbsp;v4l2_mpeg_video_h264_level</entry>
  1644. </row>
  1645. <row><entry spanname="descr">The level information for the H264 video elementary stream.
  1646. Applicable to the H264 encoder.
  1647. Possible values are:</entry>
  1648. </row>
  1649. <row>
  1650. <entrytbl spanname="descr" cols="2">
  1651. <tbody valign="top">
  1652. <row>
  1653. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_0</constant>&nbsp;</entry>
  1654. <entry>Level 1.0</entry>
  1655. </row>
  1656. <row>
  1657. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1B</constant>&nbsp;</entry>
  1658. <entry>Level 1B</entry>
  1659. </row>
  1660. <row>
  1661. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_1</constant>&nbsp;</entry>
  1662. <entry>Level 1.1</entry>
  1663. </row>
  1664. <row>
  1665. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_2</constant>&nbsp;</entry>
  1666. <entry>Level 1.2</entry>
  1667. </row>
  1668. <row>
  1669. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_3</constant>&nbsp;</entry>
  1670. <entry>Level 1.3</entry>
  1671. </row>
  1672. <row>
  1673. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_0</constant>&nbsp;</entry>
  1674. <entry>Level 2.0</entry>
  1675. </row>
  1676. <row>
  1677. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_1</constant>&nbsp;</entry>
  1678. <entry>Level 2.1</entry>
  1679. </row>
  1680. <row>
  1681. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_2</constant>&nbsp;</entry>
  1682. <entry>Level 2.2</entry>
  1683. </row>
  1684. <row>
  1685. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_0</constant>&nbsp;</entry>
  1686. <entry>Level 3.0</entry>
  1687. </row>
  1688. <row>
  1689. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_1</constant>&nbsp;</entry>
  1690. <entry>Level 3.1</entry>
  1691. </row>
  1692. <row>
  1693. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_2</constant>&nbsp;</entry>
  1694. <entry>Level 3.2</entry>
  1695. </row>
  1696. <row>
  1697. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_0</constant>&nbsp;</entry>
  1698. <entry>Level 4.0</entry>
  1699. </row>
  1700. <row>
  1701. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_1</constant>&nbsp;</entry>
  1702. <entry>Level 4.1</entry>
  1703. </row>
  1704. <row>
  1705. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_2</constant>&nbsp;</entry>
  1706. <entry>Level 4.2</entry>
  1707. </row>
  1708. <row>
  1709. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_0</constant>&nbsp;</entry>
  1710. <entry>Level 5.0</entry>
  1711. </row>
  1712. <row>
  1713. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_1</constant>&nbsp;</entry>
  1714. <entry>Level 5.1</entry>
  1715. </row>
  1716. </tbody>
  1717. </entrytbl>
  1718. </row>
  1719. <row><entry></entry></row>
  1720. <row id="v4l2-mpeg-video-mpeg4-level">
  1721. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL</constant>&nbsp;</entry>
  1722. <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_level</entry>
  1723. </row>
  1724. <row><entry spanname="descr">The level information for the MPEG4 elementary stream.
  1725. Applicable to the MPEG4 encoder.
  1726. Possible values are:</entry>
  1727. </row>
  1728. <row>
  1729. <entrytbl spanname="descr" cols="2">
  1730. <tbody valign="top">
  1731. <row>
  1732. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0</constant>&nbsp;</entry>
  1733. <entry>Level 0</entry>
  1734. </row>
  1735. <row>
  1736. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0B</constant>&nbsp;</entry>
  1737. <entry>Level 0b</entry>
  1738. </row>
  1739. <row>
  1740. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_1</constant>&nbsp;</entry>
  1741. <entry>Level 1</entry>
  1742. </row>
  1743. <row>
  1744. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_2</constant>&nbsp;</entry>
  1745. <entry>Level 2</entry>
  1746. </row>
  1747. <row>
  1748. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3</constant>&nbsp;</entry>
  1749. <entry>Level 3</entry>
  1750. </row>
  1751. <row>
  1752. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3B</constant>&nbsp;</entry>
  1753. <entry>Level 3b</entry>
  1754. </row>
  1755. <row>
  1756. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_4</constant>&nbsp;</entry>
  1757. <entry>Level 4</entry>
  1758. </row>
  1759. <row>
  1760. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_5</constant>&nbsp;</entry>
  1761. <entry>Level 5</entry>
  1762. </row>
  1763. </tbody>
  1764. </entrytbl>
  1765. </row>
  1766. <row><entry></entry></row>
  1767. <row id="v4l2-mpeg-video-h264-profile">
  1768. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_PROFILE</constant>&nbsp;</entry>
  1769. <entry>enum&nbsp;v4l2_mpeg_video_h264_profile</entry>
  1770. </row>
  1771. <row><entry spanname="descr">The profile information for H264.
  1772. Applicable to the H264 encoder.
  1773. Possible values are:</entry>
  1774. </row>
  1775. <row>
  1776. <entrytbl spanname="descr" cols="2">
  1777. <tbody valign="top">
  1778. <row>
  1779. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE</constant>&nbsp;</entry>
  1780. <entry>Baseline profile</entry>
  1781. </row>
  1782. <row>
  1783. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE</constant>&nbsp;</entry>
  1784. <entry>Constrained Baseline profile</entry>
  1785. </row>
  1786. <row>
  1787. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MAIN</constant>&nbsp;</entry>
  1788. <entry>Main profile</entry>
  1789. </row>
  1790. <row>
  1791. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED</constant>&nbsp;</entry>
  1792. <entry>Extended profile</entry>
  1793. </row>
  1794. <row>
  1795. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH</constant>&nbsp;</entry>
  1796. <entry>High profile</entry>
  1797. </row>
  1798. <row>
  1799. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10</constant>&nbsp;</entry>
  1800. <entry>High 10 profile</entry>
  1801. </row>
  1802. <row>
  1803. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422</constant>&nbsp;</entry>
  1804. <entry>High 422 profile</entry>
  1805. </row>
  1806. <row>
  1807. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE</constant>&nbsp;</entry>
  1808. <entry>High 444 Predictive profile</entry>
  1809. </row>
  1810. <row>
  1811. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA</constant>&nbsp;</entry>
  1812. <entry>High 10 Intra profile</entry>
  1813. </row>
  1814. <row>
  1815. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA</constant>&nbsp;</entry>
  1816. <entry>High 422 Intra profile</entry>
  1817. </row>
  1818. <row>
  1819. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA</constant>&nbsp;</entry>
  1820. <entry>High 444 Intra profile</entry>
  1821. </row>
  1822. <row>
  1823. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA</constant>&nbsp;</entry>
  1824. <entry>CAVLC 444 Intra profile</entry>
  1825. </row>
  1826. <row>
  1827. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE</constant>&nbsp;</entry>
  1828. <entry>Scalable Baseline profile</entry>
  1829. </row>
  1830. <row>
  1831. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH</constant>&nbsp;</entry>
  1832. <entry>Scalable High profile</entry>
  1833. </row>
  1834. <row>
  1835. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA</constant>&nbsp;</entry>
  1836. <entry>Scalable High Intra profile</entry>
  1837. </row>
  1838. <row>
  1839. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH</constant>&nbsp;</entry>
  1840. <entry>Stereo High profile</entry>
  1841. </row>
  1842. <row>
  1843. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH</constant>&nbsp;</entry>
  1844. <entry>Multiview High profile</entry>
  1845. </row>
  1846. </tbody>
  1847. </entrytbl>
  1848. </row>
  1849. <row><entry></entry></row>
  1850. <row id="v4l2-mpeg-video-mpeg4-profile">
  1851. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE</constant>&nbsp;</entry>
  1852. <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_profile</entry>
  1853. </row>
  1854. <row><entry spanname="descr">The profile information for MPEG4.
  1855. Applicable to the MPEG4 encoder.
  1856. Possible values are:</entry>
  1857. </row>
  1858. <row>
  1859. <entrytbl spanname="descr" cols="2">
  1860. <tbody valign="top">
  1861. <row>
  1862. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE</constant>&nbsp;</entry>
  1863. <entry>Simple profile</entry>
  1864. </row>
  1865. <row>
  1866. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_SIMPLE</constant>&nbsp;</entry>
  1867. <entry>Advanced Simple profile</entry>
  1868. </row>
  1869. <row>
  1870. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_CORE</constant>&nbsp;</entry>
  1871. <entry>Core profile</entry>
  1872. </row>
  1873. <row>
  1874. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE_SCALABLE</constant>&nbsp;</entry>
  1875. <entry>Simple Scalable profile</entry>
  1876. </row>
  1877. <row>
  1878. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_CODING_EFFICIENCY</constant>&nbsp;</entry>
  1879. <entry></entry>
  1880. </row>
  1881. </tbody>
  1882. </entrytbl>
  1883. </row>
  1884. <row><entry></entry></row>
  1885. <row>
  1886. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MAX_REF_PIC</constant>&nbsp;</entry>
  1887. <entry>integer</entry>
  1888. </row>
  1889. <row><entry spanname="descr">The maximum number of reference pictures used for encoding.
  1890. Applicable to the encoder.
  1891. </entry>
  1892. </row>
  1893. <row><entry></entry></row>
  1894. <row id="v4l2-mpeg-video-multi-slice-mode">
  1895. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant>&nbsp;</entry>
  1896. <entry>enum&nbsp;v4l2_mpeg_video_multi_slice_mode</entry>
  1897. </row>
  1898. <row><entry spanname="descr">Determines how the encoder should handle division of frame into slices.
  1899. Applicable to the encoder.
  1900. Possible values are:</entry>
  1901. </row>
  1902. <row>
  1903. <entrytbl spanname="descr" cols="2">
  1904. <tbody valign="top">
  1905. <row>
  1906. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE</constant>&nbsp;</entry>
  1907. <entry>Single slice per frame.</entry>
  1908. </row>
  1909. <row>
  1910. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>&nbsp;</entry>
  1911. <entry>Multiple slices with set maximum number of macroblocks per slice.</entry>
  1912. </row>
  1913. <row>
  1914. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>&nbsp;</entry>
  1915. <entry>Multiple slice with set maximum size in bytes per slice.</entry>
  1916. </row>
  1917. </tbody>
  1918. </entrytbl>
  1919. </row>
  1920. <row><entry></entry></row>
  1921. <row>
  1922. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB</constant>&nbsp;</entry>
  1923. <entry>integer</entry>
  1924. </row>
  1925. <row><entry spanname="descr">The maximum number of macroblocks in a slice. Used when
  1926. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>.
  1927. Applicable to the encoder.</entry>
  1928. </row>
  1929. <row><entry></entry></row>
  1930. <row>
  1931. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES</constant>&nbsp;</entry>
  1932. <entry>integer</entry>
  1933. </row>
  1934. <row><entry spanname="descr">The maximum size of a slice in bytes. Used when
  1935. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>.
  1936. Applicable to the encoder.</entry>
  1937. </row>
  1938. <row><entry></entry></row>
  1939. <row id="v4l2-mpeg-video-h264-loop-filter-mode">
  1940. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE</constant>&nbsp;</entry>
  1941. <entry>enum&nbsp;v4l2_mpeg_video_h264_loop_filter_mode</entry>
  1942. </row>
  1943. <row><entry spanname="descr">Loop filter mode for H264 encoder.
  1944. Possible values are:</entry>
  1945. </row>
  1946. <row>
  1947. <entrytbl spanname="descr" cols="2">
  1948. <tbody valign="top">
  1949. <row>
  1950. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED</constant>&nbsp;</entry>
  1951. <entry>Loop filter is enabled.</entry>
  1952. </row>
  1953. <row>
  1954. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED</constant>&nbsp;</entry>
  1955. <entry>Loop filter is disabled.</entry>
  1956. </row>
  1957. <row>
  1958. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY</constant>&nbsp;</entry>
  1959. <entry>Loop filter is disabled at the slice boundary.</entry>
  1960. </row>
  1961. </tbody>
  1962. </entrytbl>
  1963. </row>
  1964. <row><entry></entry></row>
  1965. <row>
  1966. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA</constant>&nbsp;</entry>
  1967. <entry>integer</entry>
  1968. </row>
  1969. <row><entry spanname="descr">Loop filter alpha coefficient, defined in the H264 standard.
  1970. Applicable to the H264 encoder.</entry>
  1971. </row>
  1972. <row><entry></entry></row>
  1973. <row>
  1974. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA</constant>&nbsp;</entry>
  1975. <entry>integer</entry>
  1976. </row>
  1977. <row><entry spanname="descr">Loop filter beta coefficient, defined in the H264 standard.
  1978. Applicable to the H264 encoder.</entry>
  1979. </row>
  1980. <row><entry></entry></row>
  1981. <row id="v4l2-mpeg-video-h264-entropy-mode">
  1982. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE</constant>&nbsp;</entry>
  1983. <entry>enum&nbsp;v4l2_mpeg_video_h264_entropy_mode</entry>
  1984. </row>
  1985. <row><entry spanname="descr">Entropy coding mode for H264 - CABAC/CAVALC.
  1986. Applicable to the H264 encoder.
  1987. Possible values are:</entry>
  1988. </row>
  1989. <row>
  1990. <entrytbl spanname="descr" cols="2">
  1991. <tbody valign="top">
  1992. <row>
  1993. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC</constant>&nbsp;</entry>
  1994. <entry>Use CAVLC entropy coding.</entry>
  1995. </row>
  1996. <row>
  1997. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC</constant>&nbsp;</entry>
  1998. <entry>Use CABAC entropy coding.</entry>
  1999. </row>
  2000. </tbody>
  2001. </entrytbl>
  2002. </row>
  2003. <row><entry></entry></row>
  2004. <row>
  2005. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM</constant>&nbsp;</entry>
  2006. <entry>boolean</entry>
  2007. </row>
  2008. <row><entry spanname="descr">Enable 8X8 transform for H264. Applicable to the H264 encoder.</entry>
  2009. </row>
  2010. <row><entry></entry></row>
  2011. <row>
  2012. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB</constant>&nbsp;</entry>
  2013. <entry>integer</entry>
  2014. </row>
  2015. <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks
  2016. refreshed every frame. Each frame a successive set of macroblocks is refreshed until the cycle completes and starts from the
  2017. top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry>
  2018. </row>
  2019. <row><entry></entry></row>
  2020. <row>
  2021. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE</constant>&nbsp;</entry>
  2022. <entry>boolean</entry>
  2023. </row>
  2024. <row><entry spanname="descr">Frame level rate control enable.
  2025. If this control is disabled then the quantization parameter for each frame type is constant and set with appropriate controls
  2026. (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>).
  2027. If frame rate control is enabled then quantization parameter is adjusted to meet the chosen bitrate. Minimum and maximum value
  2028. for the quantization parameter can be set with appropriate controls (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>).
  2029. Applicable to encoders.</entry>
  2030. </row>
  2031. <row><entry></entry></row>
  2032. <row>
  2033. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>&nbsp;</entry>
  2034. <entry>boolean</entry>
  2035. </row>
  2036. <row><entry spanname="descr">Macroblock level rate control enable.
  2037. Applicable to the MPEG4 and H264 encoders.</entry>
  2038. </row>
  2039. <row><entry></entry></row>
  2040. <row>
  2041. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_QPEL</constant>&nbsp;</entry>
  2042. <entry>boolean</entry>
  2043. </row>
  2044. <row><entry spanname="descr">Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2045. </row>
  2046. <row><entry></entry></row>
  2047. <row>
  2048. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>&nbsp;</entry>
  2049. <entry>integer</entry>
  2050. </row>
  2051. <row><entry spanname="descr">Quantization parameter for an I frame for H263. Valid range: from 1 to 31.</entry>
  2052. </row>
  2053. <row><entry></entry></row>
  2054. <row>
  2055. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>&nbsp;</entry>
  2056. <entry>integer</entry>
  2057. </row>
  2058. <row><entry spanname="descr">Minimum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  2059. </row>
  2060. <row><entry></entry></row>
  2061. <row>
  2062. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MAX_QP</constant>&nbsp;</entry>
  2063. <entry>integer</entry>
  2064. </row>
  2065. <row><entry spanname="descr">Maximum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  2066. </row>
  2067. <row><entry></entry></row>
  2068. <row>
  2069. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP</constant>&nbsp;</entry>
  2070. <entry>integer</entry>
  2071. </row>
  2072. <row><entry spanname="descr">Quantization parameter for an P frame for H263. Valid range: from 1 to 31.</entry>
  2073. </row>
  2074. <row><entry></entry></row>
  2075. <row>
  2076. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP</constant>&nbsp;</entry>
  2077. <entry>integer</entry>
  2078. </row>
  2079. <row><entry spanname="descr">Quantization parameter for an B frame for H263. Valid range: from 1 to 31.</entry>
  2080. </row>
  2081. <row><entry></entry></row>
  2082. <row>
  2083. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP</constant>&nbsp;</entry>
  2084. <entry>integer</entry>
  2085. </row>
  2086. <row><entry spanname="descr">Quantization parameter for an I frame for H264. Valid range: from 0 to 51.</entry>
  2087. </row>
  2088. <row><entry></entry></row>
  2089. <row>
  2090. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MIN_QP</constant>&nbsp;</entry>
  2091. <entry>integer</entry>
  2092. </row>
  2093. <row><entry spanname="descr">Minimum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  2094. </row>
  2095. <row><entry></entry></row>
  2096. <row>
  2097. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MAX_QP</constant>&nbsp;</entry>
  2098. <entry>integer</entry>
  2099. </row>
  2100. <row><entry spanname="descr">Maximum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  2101. </row>
  2102. <row><entry></entry></row>
  2103. <row>
  2104. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP</constant>&nbsp;</entry>
  2105. <entry>integer</entry>
  2106. </row>
  2107. <row><entry spanname="descr">Quantization parameter for an P frame for H264. Valid range: from 0 to 51.</entry>
  2108. </row>
  2109. <row><entry></entry></row>
  2110. <row>
  2111. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP</constant>&nbsp;</entry>
  2112. <entry>integer</entry>
  2113. </row>
  2114. <row><entry spanname="descr">Quantization parameter for an B frame for H264. Valid range: from 0 to 51.</entry>
  2115. </row>
  2116. <row><entry></entry></row>
  2117. <row>
  2118. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP</constant>&nbsp;</entry>
  2119. <entry>integer</entry>
  2120. </row>
  2121. <row><entry spanname="descr">Quantization parameter for an I frame for MPEG4. Valid range: from 1 to 31.</entry>
  2122. </row>
  2123. <row><entry></entry></row>
  2124. <row>
  2125. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP</constant>&nbsp;</entry>
  2126. <entry>integer</entry>
  2127. </row>
  2128. <row><entry spanname="descr">Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  2129. </row>
  2130. <row><entry></entry></row>
  2131. <row>
  2132. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP</constant>&nbsp;</entry>
  2133. <entry>integer</entry>
  2134. </row>
  2135. <row><entry spanname="descr">Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  2136. </row>
  2137. <row><entry></entry></row>
  2138. <row>
  2139. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP</constant>&nbsp;</entry>
  2140. <entry>integer</entry>
  2141. </row>
  2142. <row><entry spanname="descr">Quantization parameter for an P frame for MPEG4. Valid range: from 1 to 31.</entry>
  2143. </row>
  2144. <row><entry></entry></row>
  2145. <row>
  2146. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP</constant>&nbsp;</entry>
  2147. <entry>integer</entry>
  2148. </row>
  2149. <row><entry spanname="descr">Quantization parameter for an B frame for MPEG4. Valid range: from 1 to 31.</entry>
  2150. </row>
  2151. <row><entry></entry></row>
  2152. <row>
  2153. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_SIZE</constant>&nbsp;</entry>
  2154. <entry>integer</entry>
  2155. </row>
  2156. <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip.
  2157. The VBV is defined in the standard as a mean to verify that the produced stream will be successfully decoded.
  2158. The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the
  2159. output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an
  2160. encoder or editing process may produce.".
  2161. Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry>
  2162. </row>
  2163. <row><entry></entry></row>
  2164. <row>
  2165. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE</constant>&nbsp;</entry>
  2166. <entry>integer</entry>
  2167. </row>
  2168. <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip.
  2169. The CPB is defined in the H264 standard as a mean to verify that the produced stream will be successfully decoded.
  2170. Applicable to the H264 encoder.</entry>
  2171. </row>
  2172. <row><entry></entry></row>
  2173. <row>
  2174. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_PERIOD</constant>&nbsp;</entry>
  2175. <entry>integer</entry>
  2176. </row>
  2177. <row><entry spanname="descr">Period between I-frames in the open GOP for H264. In case of an open GOP
  2178. this is the period between two I-frames. The period between IDR (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE control.
  2179. An IDR frame, which stands for Instantaneous Decoding Refresh is an I-frame after which no prior frames are
  2180. referenced. This means that a stream can be restarted from an IDR frame without the need to store or decode any
  2181. previous frames. Applicable to the H264 encoder.</entry>
  2182. </row>
  2183. <row><entry></entry></row>
  2184. <row id="v4l2-mpeg-video-header-mode">
  2185. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_HEADER_MODE</constant>&nbsp;</entry>
  2186. <entry>enum&nbsp;v4l2_mpeg_video_header_mode</entry>
  2187. </row>
  2188. <row><entry spanname="descr">Determines whether the header is returned as the first buffer or is
  2189. it returned together with the first frame. Applicable to encoders.
  2190. Possible values are:</entry>
  2191. </row>
  2192. <row>
  2193. <entrytbl spanname="descr" cols="2">
  2194. <tbody valign="top">
  2195. <row>
  2196. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE</constant>&nbsp;</entry>
  2197. <entry>The stream header is returned separately in the first buffer.</entry>
  2198. </row>
  2199. <row>
  2200. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME</constant>&nbsp;</entry>
  2201. <entry>The stream header is returned together with the first encoded frame.</entry>
  2202. </row>
  2203. </tbody>
  2204. </entrytbl>
  2205. </row>
  2206. <row><entry></entry></row>
  2207. <row>
  2208. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER</constant>&nbsp;</entry>
  2209. <entry>boolean</entry>
  2210. </row><row><entry spanname="descr">Enabled the deblocking post processing filter for MPEG4 decoder.
  2211. Applicable to the MPEG4 decoder.</entry>
  2212. </row>
  2213. <row><entry></entry></row>
  2214. <row>
  2215. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES</constant>&nbsp;</entry>
  2216. <entry>integer</entry>
  2217. </row><row><entry spanname="descr">vop_time_increment_resolution value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2218. </row>
  2219. <row><entry></entry></row>
  2220. <row>
  2221. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC</constant>&nbsp;</entry>
  2222. <entry>integer</entry>
  2223. </row><row><entry spanname="descr">vop_time_increment value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2224. </row>
  2225. </tbody>
  2226. </tgroup>
  2227. </table>
  2228. </section>
  2229. <section>
  2230. <title>MFC 5.1 MPEG Controls</title>
  2231. <para>The following MPEG class controls deal with MPEG
  2232. decoding and encoding settings that are specific to the Multi Format Codec 5.1 device present
  2233. in the S5P family of SoCs by Samsung.
  2234. </para>
  2235. <table pgwide="1" frame="none" id="mfc51-control-id">
  2236. <title>MFC 5.1 Control IDs</title>
  2237. <tgroup cols="4">
  2238. <colspec colname="c1" colwidth="1*" />
  2239. <colspec colname="c2" colwidth="6*" />
  2240. <colspec colname="c3" colwidth="2*" />
  2241. <colspec colname="c4" colwidth="6*" />
  2242. <spanspec namest="c1" nameend="c2" spanname="id" />
  2243. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2244. <thead>
  2245. <row>
  2246. <entry spanname="id" align="left">ID</entry>
  2247. <entry align="left">Type</entry>
  2248. </row><row><entry spanname="descr" align="left">Description</entry>
  2249. </row>
  2250. </thead>
  2251. <tbody valign="top">
  2252. <row><entry></entry></row>
  2253. <row>
  2254. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant>&nbsp;</entry>
  2255. <entry>integer</entry>
  2256. </row><row><entry spanname="descr">If the display delay is enabled then the decoder has to return a
  2257. CAPTURE buffer after processing a certain number of OUTPUT buffers. If this number is low, then it may result in
  2258. buffers not being dequeued in display order. In addition hardware may still use those buffers as reference, thus
  2259. application should not write to those buffers. This feature can be used for example for generating thumbnails of videos.
  2260. Applicable to the H264 decoder.
  2261. </entry>
  2262. </row>
  2263. <row><entry></entry></row>
  2264. <row>
  2265. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>&nbsp;</entry>
  2266. <entry>integer</entry>
  2267. </row><row><entry spanname="descr">Display delay value for H264 decoder.
  2268. The decoder is forced to return a decoded frame after the set 'display delay' number of frames. If this number is
  2269. low it may result in frames returned out of dispaly order, in addition the hardware may still be using the returned buffer
  2270. as a reference picture for subsequent frames.
  2271. </entry>
  2272. </row>
  2273. <row><entry></entry></row>
  2274. <row>
  2275. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P</constant>&nbsp;</entry>
  2276. <entry>integer</entry>
  2277. </row><row><entry spanname="descr">The number of reference pictures used for encoding a P picture.
  2278. Applicable to the H264 encoder.</entry>
  2279. </row>
  2280. <row><entry></entry></row>
  2281. <row>
  2282. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING</constant>&nbsp;</entry>
  2283. <entry>boolean</entry>
  2284. </row><row><entry spanname="descr">Padding enable in the encoder - use a color instead of repeating border pixels.
  2285. Applicable to encoders.</entry>
  2286. </row>
  2287. <row><entry></entry></row>
  2288. <row>
  2289. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV</constant>&nbsp;</entry>
  2290. <entry>integer</entry>
  2291. </row><row><entry spanname="descr">Padding color in the encoder. Applicable to encoders. The supplied 32-bit integer is interpreted as follows (bit
  2292. 0 = least significant bit):</entry>
  2293. </row>
  2294. <row>
  2295. <entrytbl spanname="descr" cols="2">
  2296. <tbody valign="top">
  2297. <row>
  2298. <entry>Bit 0:7</entry>
  2299. <entry>V chrominance information</entry>
  2300. </row>
  2301. <row>
  2302. <entry>Bit 8:15</entry>
  2303. <entry>U chrominance information</entry>
  2304. </row>
  2305. <row>
  2306. <entry>Bit 16:23</entry>
  2307. <entry>Y luminance information</entry>
  2308. </row>
  2309. <row>
  2310. <entry>Bit 24:31</entry>
  2311. <entry>Must be zero.</entry>
  2312. </row>
  2313. </tbody>
  2314. </entrytbl>
  2315. </row>
  2316. <row><entry></entry></row>
  2317. <row>
  2318. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF</constant>&nbsp;</entry>
  2319. <entry>integer</entry>
  2320. </row><row><entry spanname="descr">Reaction coefficient for MFC rate control. Applicable to encoders.
  2321. <para>Note 1: Valid only when the frame level RC is enabled.</para>
  2322. <para>Note 2: For tight CBR, this field must be small (ex. 2 ~ 10).
  2323. For VBR, this field must be large (ex. 100 ~ 1000).</para>
  2324. <para>Note 3: It is not recommended to use the greater number than FRAME_RATE * (10^9 / BIT_RATE).</para>
  2325. </entry>
  2326. </row>
  2327. <row><entry></entry></row>
  2328. <row>
  2329. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK</constant>&nbsp;</entry>
  2330. <entry>boolean</entry>
  2331. </row><row><entry spanname="descr">Adaptive rate control for dark region.
  2332. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2333. Applicable to the H264 encoder.</entry>
  2334. </row>
  2335. <row><entry></entry></row>
  2336. <row>
  2337. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH</constant>&nbsp;</entry>
  2338. <entry>boolean</entry>
  2339. </row><row><entry spanname="descr">Adaptive rate control for smooth region.
  2340. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2341. Applicable to the H264 encoder.</entry>
  2342. </row>
  2343. <row><entry></entry></row>
  2344. <row>
  2345. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC</constant>&nbsp;</entry>
  2346. <entry>boolean</entry>
  2347. </row><row><entry spanname="descr">Adaptive rate control for static region.
  2348. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2349. Applicable to the H264 encoder.</entry>
  2350. </row>
  2351. <row><entry></entry></row>
  2352. <row>
  2353. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY</constant>&nbsp;</entry>
  2354. <entry>boolean</entry>
  2355. </row><row><entry spanname="descr">Adaptive rate control for activity region.
  2356. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2357. Applicable to the H264 encoder.</entry>
  2358. </row>
  2359. <row><entry></entry></row>
  2360. <row id="v4l2-mpeg-mfc51-video-frame-skip-mode">
  2361. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE</constant>&nbsp;</entry>
  2362. <entry>enum&nbsp;v4l2_mpeg_mfc51_video_frame_skip_mode</entry>
  2363. </row>
  2364. <row><entry spanname="descr">
  2365. Indicates in what conditions the encoder should skip frames. If encoding a frame would cause the encoded stream to be larger then
  2366. a chosen data limit then the frame will be skipped.
  2367. Possible values are:</entry>
  2368. </row>
  2369. <row>
  2370. <entrytbl spanname="descr" cols="2">
  2371. <tbody valign="top">
  2372. <row>
  2373. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED</constant>&nbsp;</entry>
  2374. <entry>Frame skip mode is disabled.</entry>
  2375. </row>
  2376. <row>
  2377. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT</constant>&nbsp;</entry>
  2378. <entry>Frame skip mode enabled and buffer limit is set by the chosen level and is defined by the standard.</entry>
  2379. </row>
  2380. <row>
  2381. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT</constant>&nbsp;</entry>
  2382. <entry>Frame skip mode enabled and buffer limit is set by the VBV (MPEG1/2/4) or CPB (H264) buffer size control.</entry>
  2383. </row>
  2384. </tbody>
  2385. </entrytbl>
  2386. </row>
  2387. <row><entry></entry></row>
  2388. <row>
  2389. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT</constant>&nbsp;</entry>
  2390. <entry>integer</entry>
  2391. </row><row><entry spanname="descr">Enable rate-control with fixed target bit.
  2392. If this setting is enabled, then the rate control logic of the encoder will calculate the average bitrate
  2393. for a GOP and keep it below or equal the set bitrate target. Otherwise the rate control logic calculates the
  2394. overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case
  2395. the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the
  2396. average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that
  2397. the stream will meet tight bandwidth contraints. Applicable to encoders.
  2398. </entry>
  2399. </row>
  2400. <row><entry></entry></row>
  2401. <row id="v4l2-mpeg-mfc51-video-force-frame-type">
  2402. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE</constant>&nbsp;</entry>
  2403. <entry>enum&nbsp;v4l2_mpeg_mfc51_video_force_frame_type</entry>
  2404. </row>
  2405. <row><entry spanname="descr">Force a frame type for the next queued buffer. Applicable to encoders.
  2406. Possible values are:</entry>
  2407. </row>
  2408. <row>
  2409. <entrytbl spanname="descr" cols="2">
  2410. <tbody valign="top">
  2411. <row>
  2412. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED</constant>&nbsp;</entry>
  2413. <entry>Forcing a specific frame type disabled.</entry>
  2414. </row>
  2415. <row>
  2416. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME</constant>&nbsp;</entry>
  2417. <entry>Force an I-frame.</entry>
  2418. </row>
  2419. <row>
  2420. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED</constant>&nbsp;</entry>
  2421. <entry>Force a non-coded frame.</entry>
  2422. </row>
  2423. </tbody>
  2424. </entrytbl>
  2425. </row>
  2426. </tbody>
  2427. </tgroup>
  2428. </table>
  2429. </section>
  2430. <section>
  2431. <title>CX2341x MPEG Controls</title>
  2432. <para>The following MPEG class controls deal with MPEG
  2433. encoding settings that are specific to the Conexant CX23415 and
  2434. CX23416 MPEG encoding chips.</para>
  2435. <table pgwide="1" frame="none" id="cx2341x-control-id">
  2436. <title>CX2341x Control IDs</title>
  2437. <tgroup cols="4">
  2438. <colspec colname="c1" colwidth="1*" />
  2439. <colspec colname="c2" colwidth="6*" />
  2440. <colspec colname="c3" colwidth="2*" />
  2441. <colspec colname="c4" colwidth="6*" />
  2442. <spanspec namest="c1" nameend="c2" spanname="id" />
  2443. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2444. <thead>
  2445. <row>
  2446. <entry spanname="id" align="left">ID</entry>
  2447. <entry align="left">Type</entry>
  2448. </row><row><entry spanname="descr" align="left">Description</entry>
  2449. </row>
  2450. </thead>
  2451. <tbody valign="top">
  2452. <row><entry></entry></row>
  2453. <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode">
  2454. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant>&nbsp;</entry>
  2455. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry>
  2456. </row><row><entry spanname="descr">Sets the Spatial
  2457. Filter mode (default <constant>MANUAL</constant>). Possible values
  2458. are:</entry>
  2459. </row>
  2460. <row>
  2461. <entrytbl spanname="descr" cols="2">
  2462. <tbody valign="top">
  2463. <row>
  2464. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2465. <entry>Choose the filter manually</entry>
  2466. </row>
  2467. <row>
  2468. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2469. <entry>Choose the filter automatically</entry>
  2470. </row>
  2471. </tbody>
  2472. </entrytbl>
  2473. </row>
  2474. <row><entry></entry></row>
  2475. <row>
  2476. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER</constant>&nbsp;</entry>
  2477. <entry>integer&nbsp;(0-15)</entry>
  2478. </row><row><entry spanname="descr">The setting for the
  2479. Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry>
  2480. </row>
  2481. <row><entry></entry></row>
  2482. <row id="luma-spatial-filter-type">
  2483. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2484. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry>
  2485. </row><row><entry spanname="descr">Select the algorithm
  2486. to use for the Luma Spatial Filter (default
  2487. <constant>1D_HOR</constant>). Possible values:</entry>
  2488. </row>
  2489. <row>
  2490. <entrytbl spanname="descr" cols="2">
  2491. <tbody valign="top">
  2492. <row>
  2493. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2494. <entry>No filter</entry>
  2495. </row>
  2496. <row>
  2497. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2498. <entry>One-dimensional horizontal</entry>
  2499. </row>
  2500. <row>
  2501. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT</constant>&nbsp;</entry>
  2502. <entry>One-dimensional vertical</entry>
  2503. </row>
  2504. <row>
  2505. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE</constant>&nbsp;</entry>
  2506. <entry>Two-dimensional separable</entry>
  2507. </row>
  2508. <row>
  2509. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE</constant>&nbsp;</entry>
  2510. <entry>Two-dimensional symmetrical
  2511. non-separable</entry>
  2512. </row>
  2513. </tbody>
  2514. </entrytbl>
  2515. </row>
  2516. <row><entry></entry></row>
  2517. <row id="chroma-spatial-filter-type">
  2518. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2519. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry>
  2520. </row><row><entry spanname="descr">Select the algorithm
  2521. for the Chroma Spatial Filter (default <constant>1D_HOR</constant>).
  2522. Possible values are:</entry>
  2523. </row>
  2524. <row>
  2525. <entrytbl spanname="descr" cols="2">
  2526. <tbody valign="top">
  2527. <row>
  2528. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2529. <entry>No filter</entry>
  2530. </row>
  2531. <row>
  2532. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2533. <entry>One-dimensional horizontal</entry>
  2534. </row>
  2535. </tbody>
  2536. </entrytbl>
  2537. </row>
  2538. <row><entry></entry></row>
  2539. <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode">
  2540. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant>&nbsp;</entry>
  2541. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry>
  2542. </row><row><entry spanname="descr">Sets the Temporal
  2543. Filter mode (default <constant>MANUAL</constant>). Possible values
  2544. are:</entry>
  2545. </row>
  2546. <row>
  2547. <entrytbl spanname="descr" cols="2">
  2548. <tbody valign="top">
  2549. <row>
  2550. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2551. <entry>Choose the filter manually</entry>
  2552. </row>
  2553. <row>
  2554. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2555. <entry>Choose the filter automatically</entry>
  2556. </row>
  2557. </tbody>
  2558. </entrytbl>
  2559. </row>
  2560. <row><entry></entry></row>
  2561. <row>
  2562. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER</constant>&nbsp;</entry>
  2563. <entry>integer&nbsp;(0-31)</entry>
  2564. </row><row><entry spanname="descr">The setting for the
  2565. Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale
  2566. capturing and 0 for scaled capturing.)</entry>
  2567. </row>
  2568. <row><entry></entry></row>
  2569. <row id="v4l2-mpeg-cx2341x-video-median-filter-type">
  2570. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant>&nbsp;</entry>
  2571. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_median_filter_type</entry>
  2572. </row><row><entry spanname="descr">Median Filter Type
  2573. (default <constant>OFF</constant>). Possible values are:</entry>
  2574. </row>
  2575. <row>
  2576. <entrytbl spanname="descr" cols="2">
  2577. <tbody valign="top">
  2578. <row>
  2579. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2580. <entry>No filter</entry>
  2581. </row>
  2582. <row>
  2583. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR</constant>&nbsp;</entry>
  2584. <entry>Horizontal filter</entry>
  2585. </row>
  2586. <row>
  2587. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT</constant>&nbsp;</entry>
  2588. <entry>Vertical filter</entry>
  2589. </row>
  2590. <row>
  2591. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT</constant>&nbsp;</entry>
  2592. <entry>Horizontal and vertical filter</entry>
  2593. </row>
  2594. <row>
  2595. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG</constant>&nbsp;</entry>
  2596. <entry>Diagonal filter</entry>
  2597. </row>
  2598. </tbody>
  2599. </entrytbl>
  2600. </row>
  2601. <row><entry></entry></row>
  2602. <row>
  2603. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2604. <entry>integer&nbsp;(0-255)</entry>
  2605. </row><row><entry spanname="descr">Threshold above which
  2606. the luminance median filter is enabled (default 0)</entry>
  2607. </row>
  2608. <row><entry></entry></row>
  2609. <row>
  2610. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2611. <entry>integer&nbsp;(0-255)</entry>
  2612. </row><row><entry spanname="descr">Threshold below which
  2613. the luminance median filter is enabled (default 255)</entry>
  2614. </row>
  2615. <row><entry></entry></row>
  2616. <row>
  2617. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2618. <entry>integer&nbsp;(0-255)</entry>
  2619. </row><row><entry spanname="descr">Threshold above which
  2620. the chroma median filter is enabled (default 0)</entry>
  2621. </row>
  2622. <row><entry></entry></row>
  2623. <row>
  2624. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2625. <entry>integer&nbsp;(0-255)</entry>
  2626. </row><row><entry spanname="descr">Threshold below which
  2627. the chroma median filter is enabled (default 255)</entry>
  2628. </row>
  2629. <row><entry></entry></row>
  2630. <row>
  2631. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant>&nbsp;</entry>
  2632. <entry>boolean</entry>
  2633. </row>
  2634. <row><entry spanname="descr">The CX2341X MPEG encoder
  2635. can insert one empty MPEG-2 PES packet into the stream between every
  2636. four video frames. The packet size is 2048 bytes, including the
  2637. packet_start_code_prefix and stream_id fields. The stream_id is 0xBF
  2638. (private stream 2). The payload consists of 0x00 bytes, to be filled
  2639. in by the application. 0 = do not insert, 1 = insert packets.</entry>
  2640. </row>
  2641. </tbody>
  2642. </tgroup>
  2643. </table>
  2644. </section>
  2645. </section>
  2646. <section id="camera-controls">
  2647. <title>Camera Control Reference</title>
  2648. <para>The Camera class includes controls for mechanical (or
  2649. equivalent digital) features of a device such as controllable lenses
  2650. or sensors.</para>
  2651. <table pgwide="1" frame="none" id="camera-control-id">
  2652. <title>Camera Control IDs</title>
  2653. <tgroup cols="4">
  2654. <colspec colname="c1" colwidth="1*" />
  2655. <colspec colname="c2" colwidth="6*" />
  2656. <colspec colname="c3" colwidth="2*" />
  2657. <colspec colname="c4" colwidth="6*" />
  2658. <spanspec namest="c1" nameend="c2" spanname="id" />
  2659. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2660. <thead>
  2661. <row>
  2662. <entry spanname="id" align="left">ID</entry>
  2663. <entry align="left">Type</entry>
  2664. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  2665. </row>
  2666. </thead>
  2667. <tbody valign="top">
  2668. <row><entry></entry></row>
  2669. <row>
  2670. <entry spanname="id"><constant>V4L2_CID_CAMERA_CLASS</constant>&nbsp;</entry>
  2671. <entry>class</entry>
  2672. </row><row><entry spanname="descr">The Camera class
  2673. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  2674. description of this control class.</entry>
  2675. </row>
  2676. <row><entry></entry></row>
  2677. <row id="v4l2-exposure-auto-type">
  2678. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant>&nbsp;</entry>
  2679. <entry>enum&nbsp;v4l2_exposure_auto_type</entry>
  2680. </row><row><entry spanname="descr">Enables automatic
  2681. adjustments of the exposure time and/or iris aperture. The effect of
  2682. manual changes of the exposure time or iris aperture while these
  2683. features are enabled is undefined, drivers should ignore such
  2684. requests. Possible values are:</entry>
  2685. </row>
  2686. <row>
  2687. <entrytbl spanname="descr" cols="2">
  2688. <tbody valign="top">
  2689. <row>
  2690. <entry><constant>V4L2_EXPOSURE_AUTO</constant>&nbsp;</entry>
  2691. <entry>Automatic exposure time, automatic iris
  2692. aperture.</entry>
  2693. </row>
  2694. <row>
  2695. <entry><constant>V4L2_EXPOSURE_MANUAL</constant>&nbsp;</entry>
  2696. <entry>Manual exposure time, manual iris.</entry>
  2697. </row>
  2698. <row>
  2699. <entry><constant>V4L2_EXPOSURE_SHUTTER_PRIORITY</constant>&nbsp;</entry>
  2700. <entry>Manual exposure time, auto iris.</entry>
  2701. </row>
  2702. <row>
  2703. <entry><constant>V4L2_EXPOSURE_APERTURE_PRIORITY</constant>&nbsp;</entry>
  2704. <entry>Auto exposure time, manual iris.</entry>
  2705. </row>
  2706. </tbody>
  2707. </entrytbl>
  2708. </row>
  2709. <row><entry></entry></row>
  2710. <row>
  2711. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_ABSOLUTE</constant>&nbsp;</entry>
  2712. <entry>integer</entry>
  2713. </row><row><entry spanname="descr">Determines the exposure
  2714. time of the camera sensor. The exposure time is limited by the frame
  2715. interval. Drivers should interpret the values as 100 &micro;s units,
  2716. where the value 1 stands for 1/10000th of a second, 10000 for 1 second
  2717. and 100000 for 10 seconds.</entry>
  2718. </row>
  2719. <row><entry></entry></row>
  2720. <row>
  2721. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO_PRIORITY</constant>&nbsp;</entry>
  2722. <entry>boolean</entry>
  2723. </row><row><entry spanname="descr">When
  2724. <constant>V4L2_CID_EXPOSURE_AUTO</constant> is set to
  2725. <constant>AUTO</constant> or <constant>APERTURE_PRIORITY</constant>,
  2726. this control determines if the device may dynamically vary the frame
  2727. rate. By default this feature is disabled (0) and the frame rate must
  2728. remain constant.</entry>
  2729. </row>
  2730. <row><entry></entry></row>
  2731. <row>
  2732. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_BIAS</constant>&nbsp;</entry>
  2733. <entry>integer menu</entry>
  2734. </row><row><entry spanname="descr"> Determines the automatic
  2735. exposure compensation, it is effective only when <constant>V4L2_CID_EXPOSURE_AUTO</constant>
  2736. control is set to <constant>AUTO</constant>, <constant>SHUTTER_PRIORITY </constant>
  2737. or <constant>APERTURE_PRIORITY</constant>.
  2738. It is expressed in terms of EV, drivers should interpret the values as 0.001 EV
  2739. units, where the value 1000 stands for +1 EV.
  2740. <para>Increasing the exposure compensation value is equivalent to decreasing
  2741. the exposure value (EV) and will increase the amount of light at the image
  2742. sensor. The camera performs the exposure compensation by adjusting absolute
  2743. exposure time and/or aperture.</para></entry>
  2744. </row>
  2745. <row><entry></entry></row>
  2746. <row id="v4l2-exposure-metering">
  2747. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_METERING</constant>&nbsp;</entry>
  2748. <entry>enum&nbsp;v4l2_exposure_metering</entry>
  2749. </row><row><entry spanname="descr">Determines how the camera measures
  2750. the amount of light available for the frame exposure. Possible values are:</entry>
  2751. </row>
  2752. <row>
  2753. <entrytbl spanname="descr" cols="2">
  2754. <tbody valign="top">
  2755. <row>
  2756. <entry><constant>V4L2_EXPOSURE_METERING_AVERAGE</constant>&nbsp;</entry>
  2757. <entry>Use the light information coming from the entire frame
  2758. and average giving no weighting to any particular portion of the metered area.
  2759. </entry>
  2760. </row>
  2761. <row>
  2762. <entry><constant>V4L2_EXPOSURE_METERING_CENTER_WEIGHTED</constant>&nbsp;</entry>
  2763. <entry>Average the light information coming from the entire frame
  2764. giving priority to the center of the metered area.</entry>
  2765. </row>
  2766. <row>
  2767. <entry><constant>V4L2_EXPOSURE_METERING_SPOT</constant>&nbsp;</entry>
  2768. <entry>Measure only very small area at the center of the frame.</entry>
  2769. </row>
  2770. </tbody>
  2771. </entrytbl>
  2772. </row>
  2773. <row><entry></entry></row>
  2774. <row>
  2775. <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant>&nbsp;</entry>
  2776. <entry>integer</entry>
  2777. </row><row><entry spanname="descr">This control turns the
  2778. camera horizontally by the specified amount. The unit is undefined. A
  2779. positive value moves the camera to the right (clockwise when viewed
  2780. from above), a negative value to the left. A value of zero does not
  2781. cause motion. This is a write-only control.</entry>
  2782. </row>
  2783. <row><entry></entry></row>
  2784. <row>
  2785. <entry spanname="id"><constant>V4L2_CID_TILT_RELATIVE</constant>&nbsp;</entry>
  2786. <entry>integer</entry>
  2787. </row><row><entry spanname="descr">This control turns the
  2788. camera vertically by the specified amount. The unit is undefined. A
  2789. positive value moves the camera up, a negative value down. A value of
  2790. zero does not cause motion. This is a write-only control.</entry>
  2791. </row>
  2792. <row><entry></entry></row>
  2793. <row>
  2794. <entry spanname="id"><constant>V4L2_CID_PAN_RESET</constant>&nbsp;</entry>
  2795. <entry>button</entry>
  2796. </row><row><entry spanname="descr">When this control is set,
  2797. the camera moves horizontally to the default position.</entry>
  2798. </row>
  2799. <row><entry></entry></row>
  2800. <row>
  2801. <entry spanname="id"><constant>V4L2_CID_TILT_RESET</constant>&nbsp;</entry>
  2802. <entry>button</entry>
  2803. </row><row><entry spanname="descr">When this control is set,
  2804. the camera moves vertically to the default position.</entry>
  2805. </row>
  2806. <row><entry></entry></row>
  2807. <row>
  2808. <entry spanname="id"><constant>V4L2_CID_PAN_ABSOLUTE</constant>&nbsp;</entry>
  2809. <entry>integer</entry>
  2810. </row><row><entry spanname="descr">This control
  2811. turns the camera horizontally to the specified position. Positive
  2812. values move the camera to the right (clockwise when viewed from above),
  2813. negative values to the left. Drivers should interpret the values as arc
  2814. seconds, with valid values between -180 * 3600 and +180 * 3600
  2815. inclusive.</entry>
  2816. </row>
  2817. <row><entry></entry></row>
  2818. <row>
  2819. <entry spanname="id"><constant>V4L2_CID_TILT_ABSOLUTE</constant>&nbsp;</entry>
  2820. <entry>integer</entry>
  2821. </row><row><entry spanname="descr">This control
  2822. turns the camera vertically to the specified position. Positive values
  2823. move the camera up, negative values down. Drivers should interpret the
  2824. values as arc seconds, with valid values between -180 * 3600 and +180
  2825. * 3600 inclusive.</entry>
  2826. </row>
  2827. <row><entry></entry></row>
  2828. <row>
  2829. <entry spanname="id"><constant>V4L2_CID_FOCUS_ABSOLUTE</constant>&nbsp;</entry>
  2830. <entry>integer</entry>
  2831. </row><row><entry spanname="descr">This control sets the
  2832. focal point of the camera to the specified position. The unit is
  2833. undefined. Positive values set the focus closer to the camera,
  2834. negative values towards infinity.</entry>
  2835. </row>
  2836. <row><entry></entry></row>
  2837. <row>
  2838. <entry spanname="id"><constant>V4L2_CID_FOCUS_RELATIVE</constant>&nbsp;</entry>
  2839. <entry>integer</entry>
  2840. </row><row><entry spanname="descr">This control moves the
  2841. focal point of the camera by the specified amount. The unit is
  2842. undefined. Positive values move the focus closer to the camera,
  2843. negative values towards infinity. This is a write-only control.</entry>
  2844. </row>
  2845. <row><entry></entry></row>
  2846. <row>
  2847. <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
  2848. <entry>boolean</entry>
  2849. </row><row><entry spanname="descr">Enables continuous automatic
  2850. focus adjustments. The effect of manual focus adjustments while this feature
  2851. is enabled is undefined, drivers should ignore such requests.</entry>
  2852. </row>
  2853. <row><entry></entry></row>
  2854. <row>
  2855. <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_START</constant>&nbsp;</entry>
  2856. <entry>button</entry>
  2857. </row><row><entry spanname="descr">Starts single auto focus process.
  2858. The effect of setting this control when <constant>V4L2_CID_FOCUS_AUTO</constant>
  2859. is set to <constant>TRUE</constant> (1) is undefined, drivers should ignore
  2860. such requests.</entry>
  2861. </row>
  2862. <row><entry></entry></row>
  2863. <row>
  2864. <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_STOP</constant>&nbsp;</entry>
  2865. <entry>button</entry>
  2866. </row><row><entry spanname="descr">Aborts automatic focusing
  2867. started with <constant>V4L2_CID_AUTO_FOCUS_START</constant> control. It is
  2868. effective only when the continuous autofocus is disabled, that is when
  2869. <constant>V4L2_CID_FOCUS_AUTO</constant> control is set to <constant>FALSE
  2870. </constant> (0).</entry>
  2871. </row>
  2872. <row><entry></entry></row>
  2873. <row id="v4l2-auto-focus-status">
  2874. <entry spanname="id">
  2875. <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>&nbsp;</entry>
  2876. <entry>bitmask</entry>
  2877. </row>
  2878. <row><entry spanname="descr">The automatic focus status. This is a read-only
  2879. control.</entry>
  2880. </row>
  2881. <row>
  2882. <entrytbl spanname="descr" cols="2">
  2883. <tbody valign="top">
  2884. <row>
  2885. <entry><constant>V4L2_AUTO_FOCUS_STATUS_IDLE</constant>&nbsp;</entry>
  2886. <entry>Automatic focus is not active.</entry>
  2887. </row>
  2888. <row>
  2889. <entry><constant>V4L2_AUTO_FOCUS_STATUS_BUSY</constant>&nbsp;</entry>
  2890. <entry>Automatic focusing is in progress.</entry>
  2891. </row>
  2892. <row>
  2893. <entry><constant>V4L2_AUTO_FOCUS_STATUS_REACHED</constant>&nbsp;</entry>
  2894. <entry>Focus has been reached.</entry>
  2895. </row>
  2896. <row>
  2897. <entry><constant>V4L2_AUTO_FOCUS_STATUS_FAILED</constant>&nbsp;</entry>
  2898. <entry>Automatic focus has failed, the driver will not
  2899. transition from this state until another action is
  2900. performed by an application.</entry>
  2901. </row>
  2902. </tbody>
  2903. </entrytbl>
  2904. </row>
  2905. <row><entry spanname="descr">
  2906. Setting <constant>V4L2_LOCK_FOCUS</constant> lock bit of the <constant>V4L2_CID_3A_LOCK
  2907. </constant> control may stop updates of the <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>
  2908. control value.</entry>
  2909. </row>
  2910. <row><entry></entry></row>
  2911. <row id="v4l2-auto-focus-range">
  2912. <entry spanname="id">
  2913. <constant>V4L2_CID_AUTO_FOCUS_RANGE</constant>&nbsp;</entry>
  2914. <entry>enum&nbsp;v4l2_auto_focus_range</entry>
  2915. </row>
  2916. <row><entry spanname="descr">Determines auto focus distance range
  2917. for which lens may be adjusted. </entry>
  2918. </row>
  2919. <row>
  2920. <entrytbl spanname="descr" cols="2">
  2921. <tbody valign="top">
  2922. <row>
  2923. <entry><constant>V4L2_AUTO_FOCUS_RANGE_AUTO</constant>&nbsp;</entry>
  2924. <entry>The camera automatically selects the focus range.</entry>
  2925. </row>
  2926. <row>
  2927. <entry><constant>V4L2_AUTO_FOCUS_RANGE_NORMAL</constant>&nbsp;</entry>
  2928. <entry>Normal distance range, limited for best automatic focus
  2929. performance.</entry>
  2930. </row>
  2931. <row>
  2932. <entry><constant>V4L2_AUTO_FOCUS_RANGE_MACRO</constant>&nbsp;</entry>
  2933. <entry>Macro (close-up) auto focus. The camera will
  2934. use its minimum possible distance for auto focus.</entry>
  2935. </row>
  2936. <row>
  2937. <entry><constant>V4L2_AUTO_FOCUS_RANGE_INFINITY</constant>&nbsp;</entry>
  2938. <entry>The lens is set to focus on an object at infinite distance.</entry>
  2939. </row>
  2940. </tbody>
  2941. </entrytbl>
  2942. </row>
  2943. <row><entry></entry></row>
  2944. <row>
  2945. <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry>
  2946. <entry>integer</entry>
  2947. </row><row><entry spanname="descr">Specify the objective lens
  2948. focal length as an absolute value. The zoom unit is driver-specific and its
  2949. value should be a positive integer.</entry>
  2950. </row>
  2951. <row><entry></entry></row>
  2952. <row>
  2953. <entry spanname="id"><constant>V4L2_CID_ZOOM_RELATIVE</constant>&nbsp;</entry>
  2954. <entry>integer</entry>
  2955. </row><row><entry spanname="descr">Specify the objective lens
  2956. focal length relatively to the current value. Positive values move the zoom
  2957. lens group towards the telephoto direction, negative values towards the
  2958. wide-angle direction. The zoom unit is driver-specific. This is a write-only control.</entry>
  2959. </row>
  2960. <row><entry></entry></row>
  2961. <row>
  2962. <entry spanname="id"><constant>V4L2_CID_ZOOM_CONTINUOUS</constant>&nbsp;</entry>
  2963. <entry>integer</entry>
  2964. </row><row><entry spanname="descr">Move the objective lens group
  2965. at the specified speed until it reaches physical device limits or until an
  2966. explicit request to stop the movement. A positive value moves the zoom lens
  2967. group towards the telephoto direction. A value of zero stops the zoom lens
  2968. group movement. A negative value moves the zoom lens group towards the
  2969. wide-angle direction. The zoom speed unit is driver-specific.</entry>
  2970. </row>
  2971. <row><entry></entry></row>
  2972. <row>
  2973. <entry spanname="id"><constant>V4L2_CID_IRIS_ABSOLUTE</constant>&nbsp;</entry>
  2974. <entry>integer</entry>
  2975. </row><row><entry spanname="descr">This control sets the
  2976. camera's aperture to the specified value. The unit is undefined.
  2977. Larger values open the iris wider, smaller values close it.</entry>
  2978. </row>
  2979. <row><entry></entry></row>
  2980. <row>
  2981. <entry spanname="id"><constant>V4L2_CID_IRIS_RELATIVE</constant>&nbsp;</entry>
  2982. <entry>integer</entry>
  2983. </row><row><entry spanname="descr">This control modifies the
  2984. camera's aperture by the specified amount. The unit is undefined.
  2985. Positive values open the iris one step further, negative values close
  2986. it one step further. This is a write-only control.</entry>
  2987. </row>
  2988. <row><entry></entry></row>
  2989. <row>
  2990. <entry spanname="id"><constant>V4L2_CID_PRIVACY</constant>&nbsp;</entry>
  2991. <entry>boolean</entry>
  2992. </row><row><entry spanname="descr">Prevent video from being acquired
  2993. by the camera. When this control is set to <constant>TRUE</constant> (1), no
  2994. image can be captured by the camera. Common means to enforce privacy are
  2995. mechanical obturation of the sensor and firmware image processing, but the
  2996. device is not restricted to these methods. Devices that implement the privacy
  2997. control must support read access and may support write access.</entry>
  2998. </row>
  2999. <row>
  3000. <entry spanname="id"><constant>V4L2_CID_BAND_STOP_FILTER</constant>&nbsp;</entry>
  3001. <entry>integer</entry>
  3002. </row><row><entry spanname="descr">Switch the band-stop filter of a
  3003. camera sensor on or off, or specify its strength. Such band-stop filters can
  3004. be used, for example, to filter out the fluorescent light component.</entry>
  3005. </row>
  3006. <row><entry></entry></row>
  3007. <row id="v4l2-auto-n-preset-white-balance">
  3008. <entry spanname="id"><constant>V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE</constant>&nbsp;</entry>
  3009. <entry>enum&nbsp;v4l2_auto_n_preset_white_balance</entry>
  3010. </row><row><entry spanname="descr">Sets white balance to automatic,
  3011. manual or a preset. The presets determine color temperature of the light as
  3012. a hint to the camera for white balance adjustments resulting in most accurate
  3013. color representation. The following white balance presets are listed in order
  3014. of increasing color temperature.</entry>
  3015. </row>
  3016. <row>
  3017. <entrytbl spanname="descr" cols="2">
  3018. <tbody valign="top">
  3019. <row>
  3020. <entry><constant>V4L2_WHITE_BALANCE_MANUAL</constant>&nbsp;</entry>
  3021. <entry>Manual white balance.</entry>
  3022. </row>
  3023. <row>
  3024. <entry><constant>V4L2_WHITE_BALANCE_AUTO</constant>&nbsp;</entry>
  3025. <entry>Automatic white balance adjustments.</entry>
  3026. </row>
  3027. <row>
  3028. <entry><constant>V4L2_WHITE_BALANCE_INCANDESCENT</constant>&nbsp;</entry>
  3029. <entry>White balance setting for incandescent (tungsten) lighting.
  3030. It generally cools down the colors and corresponds approximately to 2500...3500 K
  3031. color temperature range.</entry>
  3032. </row>
  3033. <row>
  3034. <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT</constant>&nbsp;</entry>
  3035. <entry>White balance preset for fluorescent lighting.
  3036. It corresponds approximately to 4000...5000 K color temperature.</entry>
  3037. </row>
  3038. <row>
  3039. <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT_H</constant>&nbsp;</entry>
  3040. <entry>With this setting the camera will compensate for
  3041. fluorescent H lighting.</entry>
  3042. </row>
  3043. <row>
  3044. <entry><constant>V4L2_WHITE_BALANCE_HORIZON</constant>&nbsp;</entry>
  3045. <entry>White balance setting for horizon daylight.
  3046. It corresponds approximately to 5000 K color temperature.</entry>
  3047. </row>
  3048. <row>
  3049. <entry><constant>V4L2_WHITE_BALANCE_DAYLIGHT</constant>&nbsp;</entry>
  3050. <entry>White balance preset for daylight (with clear sky).
  3051. It corresponds approximately to 5000...6500 K color temperature.</entry>
  3052. </row>
  3053. <row>
  3054. <entry><constant>V4L2_WHITE_BALANCE_FLASH</constant>&nbsp;</entry>
  3055. <entry>With this setting the camera will compensate for the flash
  3056. light. It slightly warms up the colors and corresponds roughly to 5000...5500 K
  3057. color temperature.</entry>
  3058. </row>
  3059. <row>
  3060. <entry><constant>V4L2_WHITE_BALANCE_CLOUDY</constant>&nbsp;</entry>
  3061. <entry>White balance preset for moderately overcast sky.
  3062. This option corresponds approximately to 6500...8000 K color temperature
  3063. range.</entry>
  3064. </row>
  3065. <row>
  3066. <entry><constant>V4L2_WHITE_BALANCE_SHADE</constant>&nbsp;</entry>
  3067. <entry>White balance preset for shade or heavily overcast
  3068. sky. It corresponds approximately to 9000...10000 K color temperature.
  3069. </entry>
  3070. </row>
  3071. </tbody>
  3072. </entrytbl>
  3073. </row>
  3074. <row><entry></entry></row>
  3075. <row id="v4l2-wide-dynamic-range">
  3076. <entry spanname="id"><constant>V4L2_CID_WIDE_DYNAMIC_RANGE</constant></entry>
  3077. <entry>boolean</entry>
  3078. </row>
  3079. <row>
  3080. <entry spanname="descr">Enables or disables the camera's wide dynamic
  3081. range feature. This feature allows to obtain clear images in situations where
  3082. intensity of the illumination varies significantly throughout the scene, i.e.
  3083. there are simultaneously very dark and very bright areas. It is most commonly
  3084. realized in cameras by combining two subsequent frames with different exposure
  3085. times. <footnote id="ctypeconv"><para> This control may be changed to a menu
  3086. control in the future, if more options are required.</para></footnote></entry>
  3087. </row>
  3088. <row><entry></entry></row>
  3089. <row id="v4l2-image-stabilization">
  3090. <entry spanname="id"><constant>V4L2_CID_IMAGE_STABILIZATION</constant></entry>
  3091. <entry>boolean</entry>
  3092. </row>
  3093. <row>
  3094. <entry spanname="descr">Enables or disables image stabilization.
  3095. <footnoteref linkend="ctypeconv"/></entry>
  3096. </row>
  3097. <row><entry></entry></row>
  3098. <row>
  3099. <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY</constant>&nbsp;</entry>
  3100. <entry>integer menu</entry>
  3101. </row><row><entry spanname="descr">Determines ISO equivalent of an
  3102. image sensor indicating the sensor's sensitivity to light. The numbers are
  3103. expressed in arithmetic scale, as per <xref linkend="iso12232" /> standard,
  3104. where doubling the sensor sensitivity is represented by doubling the numerical
  3105. ISO value. Applications should interpret the values as standard ISO values
  3106. multiplied by 1000, e.g. control value 800 stands for ISO 0.8. Drivers will
  3107. usually support only a subset of standard ISO values. The effect of setting
  3108. this control while the <constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>
  3109. control is set to a value other than <constant>V4L2_CID_ISO_SENSITIVITY_MANUAL
  3110. </constant> is undefined, drivers should ignore such requests.</entry>
  3111. </row>
  3112. <row><entry></entry></row>
  3113. <row id="v4l2-iso-sensitivity-auto-type">
  3114. <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
  3115. <entry>enum&nbsp;v4l2_iso_sensitivity_type</entry>
  3116. </row><row><entry spanname="descr">Enables or disables automatic ISO
  3117. sensitivity adjustments.</entry>
  3118. </row>
  3119. <row>
  3120. <entrytbl spanname="descr" cols="2">
  3121. <tbody valign="top">
  3122. <row>
  3123. <entry><constant>V4L2_CID_ISO_SENSITIVITY_MANUAL</constant>&nbsp;</entry>
  3124. <entry>Manual ISO sensitivity.</entry>
  3125. </row>
  3126. <row>
  3127. <entry><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
  3128. <entry>Automatic ISO sensitivity adjustments.</entry>
  3129. </row>
  3130. </tbody>
  3131. </entrytbl>
  3132. </row>
  3133. <row><entry></entry></row>
  3134. <row id="v4l2-scene-mode">
  3135. <entry spanname="id"><constant>V4L2_CID_SCENE_MODE</constant>&nbsp;</entry>
  3136. <entry>enum&nbsp;v4l2_scene_mode</entry>
  3137. </row><row><entry spanname="descr">This control allows to select
  3138. scene programs as the camera automatic modes optimized for common shooting
  3139. scenes. Within these modes the camera determines best exposure, aperture,
  3140. focusing, light metering, white balance and equivalent sensitivity. The
  3141. controls of those parameters are influenced by the scene mode control.
  3142. An exact behavior in each mode is subject to the camera specification.
  3143. <para>When the scene mode feature is not used, this control should be set to
  3144. <constant>V4L2_SCENE_MODE_NONE</constant> to make sure the other possibly
  3145. related controls are accessible. The following scene programs are defined:
  3146. </para>
  3147. </entry>
  3148. </row>
  3149. <row>
  3150. <entrytbl spanname="descr" cols="2">
  3151. <tbody valign="top">
  3152. <row>
  3153. <entry><constant>V4L2_SCENE_MODE_NONE</constant>&nbsp;</entry>
  3154. <entry>The scene mode feature is disabled.</entry>
  3155. </row>
  3156. <row>
  3157. <entry><constant>V4L2_SCENE_MODE_BACKLIGHT</constant>&nbsp;</entry>
  3158. <entry>Backlight. Compensates for dark shadows when light is
  3159. coming from behind a subject, also by automatically turning
  3160. on the flash.</entry>
  3161. </row>
  3162. <row>
  3163. <entry><constant>V4L2_SCENE_MODE_BEACH_SNOW</constant>&nbsp;</entry>
  3164. <entry>Beach and snow. This mode compensates for all-white or
  3165. bright scenes, which tend to look gray and low contrast, when camera's automatic
  3166. exposure is based on an average scene brightness. To compensate, this mode
  3167. automatically slightly overexposes the frames. The white balance may also be
  3168. adjusted to compensate for the fact that reflected snow looks bluish rather
  3169. than white.</entry>
  3170. </row>
  3171. <row>
  3172. <entry><constant>V4L2_SCENE_MODE_CANDLELIGHT</constant>&nbsp;</entry>
  3173. <entry>Candle light. The camera generally raises the ISO
  3174. sensitivity and lowers the shutter speed. This mode compensates for relatively
  3175. close subject in the scene. The flash is disabled in order to preserve the
  3176. ambiance of the light.</entry>
  3177. </row>
  3178. <row>
  3179. <entry><constant>V4L2_SCENE_MODE_DAWN_DUSK</constant>&nbsp;</entry>
  3180. <entry>Dawn and dusk. Preserves the colors seen in low
  3181. natural light before dusk and after down. The camera may turn off the flash,
  3182. and automatically focus at infinity. It will usually boost saturation and
  3183. lower the shutter speed.</entry>
  3184. </row>
  3185. <row>
  3186. <entry><constant>V4L2_SCENE_MODE_FALL_COLORS</constant>&nbsp;</entry>
  3187. <entry>Fall colors. Increases saturation and adjusts white
  3188. balance for color enhancement. Pictures of autumn leaves get saturated reds
  3189. and yellows.</entry>
  3190. </row>
  3191. <row>
  3192. <entry><constant>V4L2_SCENE_MODE_FIREWORKS</constant>&nbsp;</entry>
  3193. <entry>Fireworks. Long exposure times are used to capture
  3194. the expanding burst of light from a firework. The camera may invoke image
  3195. stabilization.</entry>
  3196. </row>
  3197. <row>
  3198. <entry><constant>V4L2_SCENE_MODE_LANDSCAPE</constant>&nbsp;</entry>
  3199. <entry>Landscape. The camera may choose a small aperture to
  3200. provide deep depth of field and long exposure duration to help capture detail
  3201. in dim light conditions. The focus is fixed at infinity. Suitable for distant
  3202. and wide scenery.</entry>
  3203. </row>
  3204. <row>
  3205. <entry><constant>V4L2_SCENE_MODE_NIGHT</constant>&nbsp;</entry>
  3206. <entry>Night, also known as Night Landscape. Designed for low
  3207. light conditions, it preserves detail in the dark areas without blowing out bright
  3208. objects. The camera generally sets itself to a medium-to-high ISO sensitivity,
  3209. with a relatively long exposure time, and turns flash off. As such, there will be
  3210. increased image noise and the possibility of blurred image.</entry>
  3211. </row>
  3212. <row>
  3213. <entry><constant>V4L2_SCENE_MODE_PARTY_INDOOR</constant>&nbsp;</entry>
  3214. <entry>Party and indoor. Designed to capture indoor scenes
  3215. that are lit by indoor background lighting as well as the flash. The camera
  3216. usually increases ISO sensitivity, and adjusts exposure for the low light
  3217. conditions.</entry>
  3218. </row>
  3219. <row>
  3220. <entry><constant>V4L2_SCENE_MODE_PORTRAIT</constant>&nbsp;</entry>
  3221. <entry>Portrait. The camera adjusts the aperture so that the
  3222. depth of field is reduced, which helps to isolate the subject against a smooth
  3223. background. Most cameras recognize the presence of faces in the scene and focus
  3224. on them. The color hue is adjusted to enhance skin tones. The intensity of the
  3225. flash is often reduced.</entry>
  3226. </row>
  3227. <row>
  3228. <entry><constant>V4L2_SCENE_MODE_SPORTS</constant>&nbsp;</entry>
  3229. <entry>Sports. Significantly increases ISO and uses a fast
  3230. shutter speed to freeze motion of rapidly-moving subjects. Increased image
  3231. noise may be seen in this mode.</entry>
  3232. </row>
  3233. <row>
  3234. <entry><constant>V4L2_SCENE_MODE_SUNSET</constant>&nbsp;</entry>
  3235. <entry>Sunset. Preserves deep hues seen in sunsets and
  3236. sunrises. It bumps up the saturation.</entry>
  3237. </row>
  3238. <row>
  3239. <entry><constant>V4L2_SCENE_MODE_TEXT</constant>&nbsp;</entry>
  3240. <entry>Text. It applies extra contrast and sharpness, it is
  3241. typically a black-and-white mode optimized for readability. Automatic focus
  3242. may be switched to close-up mode and this setting may also involve some
  3243. lens-distortion correction.</entry>
  3244. </row>
  3245. </tbody>
  3246. </entrytbl>
  3247. </row>
  3248. <row><entry></entry></row>
  3249. <row>
  3250. <entry spanname="id"><constant>V4L2_CID_3A_LOCK</constant></entry>
  3251. <entry>bitmask</entry>
  3252. </row>
  3253. <row>
  3254. <entry spanname="descr">This control locks or unlocks the automatic
  3255. focus, exposure and white balance. The automatic adjustments can be paused
  3256. independently by setting the corresponding lock bit to 1. The camera then retains
  3257. the settings until the lock bit is cleared. The following lock bits are defined:
  3258. </entry>
  3259. </row>
  3260. <row>
  3261. <entrytbl spanname="descr" cols="2">
  3262. <tbody valign="top">
  3263. <row>
  3264. <entry><constant>V4L2_LOCK_EXPOSURE</constant></entry>
  3265. <entry>Automatic exposure adjustments lock.</entry>
  3266. </row>
  3267. <row>
  3268. <entry><constant>V4L2_LOCK_WHITE_BALANCE</constant></entry>
  3269. <entry>Automatic white balance adjustments lock.</entry>
  3270. </row>
  3271. <row>
  3272. <entry><constant>V4L2_LOCK_FOCUS</constant></entry>
  3273. <entry>Automatic focus lock.</entry>
  3274. </row>
  3275. </tbody>
  3276. </entrytbl>
  3277. </row>
  3278. <row><entry spanname="descr">
  3279. When a given algorithm is not enabled, drivers should ignore requests
  3280. to lock it and should return no error. An example might be an application
  3281. setting bit <constant>V4L2_LOCK_WHITE_BALANCE</constant> when the
  3282. <constant>V4L2_CID_AUTO_WHITE_BALANCE</constant> control is set to
  3283. <constant>FALSE</constant>. The value of this control may be changed
  3284. by exposure, white balance or focus controls.</entry>
  3285. </row>
  3286. <row><entry></entry></row>
  3287. </tbody>
  3288. </tgroup>
  3289. </table>
  3290. </section>
  3291. <section id="fm-tx-controls">
  3292. <title>FM Transmitter Control Reference</title>
  3293. <para>The FM Transmitter (FM_TX) class includes controls for common features of
  3294. FM transmissions capable devices. Currently this class includes parameters for audio
  3295. compression, pilot tone generation, audio deviation limiter, RDS transmission and
  3296. tuning power features.</para>
  3297. <table pgwide="1" frame="none" id="fm-tx-control-id">
  3298. <title>FM_TX Control IDs</title>
  3299. <tgroup cols="4">
  3300. <colspec colname="c1" colwidth="1*" />
  3301. <colspec colname="c2" colwidth="6*" />
  3302. <colspec colname="c3" colwidth="2*" />
  3303. <colspec colname="c4" colwidth="6*" />
  3304. <spanspec namest="c1" nameend="c2" spanname="id" />
  3305. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3306. <thead>
  3307. <row>
  3308. <entry spanname="id" align="left">ID</entry>
  3309. <entry align="left">Type</entry>
  3310. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3311. </row>
  3312. </thead>
  3313. <tbody valign="top">
  3314. <row><entry></entry></row>
  3315. <row>
  3316. <entry spanname="id"><constant>V4L2_CID_FM_TX_CLASS</constant>&nbsp;</entry>
  3317. <entry>class</entry>
  3318. </row><row><entry spanname="descr">The FM_TX class
  3319. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  3320. description of this control class.</entry>
  3321. </row>
  3322. <row>
  3323. <entry spanname="id"><constant>V4L2_CID_RDS_TX_DEVIATION</constant>&nbsp;</entry>
  3324. <entry>integer</entry>
  3325. </row>
  3326. <row><entry spanname="descr">Configures RDS signal frequency deviation level in Hz.
  3327. The range and step are driver-specific.</entry>
  3328. </row>
  3329. <row>
  3330. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PI</constant>&nbsp;</entry>
  3331. <entry>integer</entry>
  3332. </row>
  3333. <row><entry spanname="descr">Sets the RDS Programme Identification field
  3334. for transmission.</entry>
  3335. </row>
  3336. <row>
  3337. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PTY</constant>&nbsp;</entry>
  3338. <entry>integer</entry>
  3339. </row>
  3340. <row><entry spanname="descr">Sets the RDS Programme Type field for transmission.
  3341. This encodes up to 31 pre-defined programme types.</entry>
  3342. </row>
  3343. <row>
  3344. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PS_NAME</constant>&nbsp;</entry>
  3345. <entry>string</entry>
  3346. </row>
  3347. <row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission.
  3348. It is intended for static display on a receiver. It is the primary aid to listeners in programme service
  3349. identification and selection. In Annex E of <xref linkend="en50067" />, the RDS specification,
  3350. there is a full description of the correct character encoding for Programme Service name strings.
  3351. Also from RDS specification, PS is usually a single eight character text. However, it is also possible
  3352. to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
  3353. with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry>
  3354. </row>
  3355. <row>
  3356. <entry spanname="id"><constant>V4L2_CID_RDS_TX_RADIO_TEXT</constant>&nbsp;</entry>
  3357. <entry>string</entry>
  3358. </row>
  3359. <row><entry spanname="descr">Sets the Radio Text info for transmission. It is a textual description of
  3360. what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
  3361. programme-related information or any other text. In these cases, RadioText should be used in addition to
  3362. <constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
  3363. in Annex E of <xref linkend="en50067" />. The length of Radio Text strings depends on which RDS Block is being
  3364. used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
  3365. to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
  3366. with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
  3367. </row>
  3368. <row>
  3369. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant>&nbsp;</entry>
  3370. <entry>boolean</entry>
  3371. </row>
  3372. <row><entry spanname="descr">Enables or disables the audio deviation limiter feature.
  3373. The limiter is useful when trying to maximize the audio volume, minimize receiver-generated
  3374. distortion and prevent overmodulation.
  3375. </entry>
  3376. </row>
  3377. <row>
  3378. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_RELEASE_TIME</constant>&nbsp;</entry>
  3379. <entry>integer</entry>
  3380. </row>
  3381. <row><entry spanname="descr">Sets the audio deviation limiter feature release time.
  3382. Unit is in useconds. Step and range are driver-specific.</entry>
  3383. </row>
  3384. <row>
  3385. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_DEVIATION</constant>&nbsp;</entry>
  3386. <entry>integer</entry>
  3387. </row>
  3388. <row><entry spanname="descr">Configures audio frequency deviation level in Hz.
  3389. The range and step are driver-specific.</entry>
  3390. </row>
  3391. <row>
  3392. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ENABLED</constant>&nbsp;</entry>
  3393. <entry>boolean</entry>
  3394. </row>
  3395. <row><entry spanname="descr">Enables or disables the audio compression feature.
  3396. This feature amplifies signals below the threshold by a fixed gain and compresses audio
  3397. signals above the threshold by the ratio of Threshold/(Gain + Threshold).</entry>
  3398. </row>
  3399. <row>
  3400. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_GAIN</constant>&nbsp;</entry>
  3401. <entry>integer</entry>
  3402. </row>
  3403. <row><entry spanname="descr">Sets the gain for audio compression feature. It is
  3404. a dB value. The range and step are driver-specific.</entry>
  3405. </row>
  3406. <row>
  3407. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_THRESHOLD</constant>&nbsp;</entry>
  3408. <entry>integer</entry>
  3409. </row>
  3410. <row><entry spanname="descr">Sets the threshold level for audio compression freature.
  3411. It is a dB value. The range and step are driver-specific.</entry>
  3412. </row>
  3413. <row>
  3414. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME</constant>&nbsp;</entry>
  3415. <entry>integer</entry>
  3416. </row>
  3417. <row><entry spanname="descr">Sets the attack time for audio compression feature.
  3418. It is a useconds value. The range and step are driver-specific.</entry>
  3419. </row>
  3420. <row>
  3421. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME</constant>&nbsp;</entry>
  3422. <entry>integer</entry>
  3423. </row>
  3424. <row><entry spanname="descr">Sets the release time for audio compression feature.
  3425. It is a useconds value. The range and step are driver-specific.</entry>
  3426. </row>
  3427. <row>
  3428. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_ENABLED</constant>&nbsp;</entry>
  3429. <entry>boolean</entry>
  3430. </row>
  3431. <row><entry spanname="descr">Enables or disables the pilot tone generation feature.</entry>
  3432. </row>
  3433. <row>
  3434. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_DEVIATION</constant>&nbsp;</entry>
  3435. <entry>integer</entry>
  3436. </row>
  3437. <row><entry spanname="descr">Configures pilot tone frequency deviation level. Unit is
  3438. in Hz. The range and step are driver-specific.</entry>
  3439. </row>
  3440. <row>
  3441. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_FREQUENCY</constant>&nbsp;</entry>
  3442. <entry>integer</entry>
  3443. </row>
  3444. <row><entry spanname="descr">Configures pilot tone frequency value. Unit is
  3445. in Hz. The range and step are driver-specific.</entry>
  3446. </row>
  3447. <row>
  3448. <entry spanname="id"><constant>V4L2_CID_TUNE_PREEMPHASIS</constant>&nbsp;</entry>
  3449. <entry>integer</entry>
  3450. </row>
  3451. <row id="v4l2-preemphasis"><entry spanname="descr">Configures the pre-emphasis value for broadcasting.
  3452. A pre-emphasis filter is applied to the broadcast to accentuate the high audio frequencies.
  3453. Depending on the region, a time constant of either 50 or 75 useconds is used. The enum&nbsp;v4l2_preemphasis
  3454. defines possible values for pre-emphasis. Here they are:</entry>
  3455. </row><row>
  3456. <entrytbl spanname="descr" cols="2">
  3457. <tbody valign="top">
  3458. <row>
  3459. <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant>&nbsp;</entry>
  3460. <entry>No pre-emphasis is applied.</entry>
  3461. </row>
  3462. <row>
  3463. <entry><constant>V4L2_PREEMPHASIS_50_uS</constant>&nbsp;</entry>
  3464. <entry>A pre-emphasis of 50 uS is used.</entry>
  3465. </row>
  3466. <row>
  3467. <entry><constant>V4L2_PREEMPHASIS_75_uS</constant>&nbsp;</entry>
  3468. <entry>A pre-emphasis of 75 uS is used.</entry>
  3469. </row>
  3470. </tbody>
  3471. </entrytbl>
  3472. </row>
  3473. <row>
  3474. <entry spanname="id"><constant>V4L2_CID_TUNE_POWER_LEVEL</constant>&nbsp;</entry>
  3475. <entry>integer</entry>
  3476. </row>
  3477. <row><entry spanname="descr">Sets the output power level for signal transmission.
  3478. Unit is in dBuV. Range and step are driver-specific.</entry>
  3479. </row>
  3480. <row>
  3481. <entry spanname="id"><constant>V4L2_CID_TUNE_ANTENNA_CAPACITOR</constant>&nbsp;</entry>
  3482. <entry>integer</entry>
  3483. </row>
  3484. <row><entry spanname="descr">This selects the value of antenna tuning capacitor
  3485. manually or automatically if set to zero. Unit, range and step are driver-specific.</entry>
  3486. </row>
  3487. <row><entry></entry></row>
  3488. </tbody>
  3489. </tgroup>
  3490. </table>
  3491. <para>For more details about RDS specification, refer to
  3492. <xref linkend="en50067" /> document, from CENELEC.</para>
  3493. </section>
  3494. <section id="flash-controls">
  3495. <title>Flash Control Reference</title>
  3496. <note>
  3497. <title>Experimental</title>
  3498. <para>This is an <link linkend="experimental">experimental</link>
  3499. interface and may change in the future.</para>
  3500. </note>
  3501. <para>
  3502. The V4L2 flash controls are intended to provide generic access
  3503. to flash controller devices. Flash controller devices are
  3504. typically used in digital cameras.
  3505. </para>
  3506. <para>
  3507. The interface can support both LED and xenon flash devices. As
  3508. of writing this, there is no xenon flash driver using this
  3509. interface.
  3510. </para>
  3511. <section id="flash-controls-use-cases">
  3512. <title>Supported use cases</title>
  3513. <section>
  3514. <title>Unsynchronised LED flash (software strobe)</title>
  3515. <para>
  3516. Unsynchronised LED flash is controlled directly by the
  3517. host as the sensor. The flash must be enabled by the host
  3518. before the exposure of the image starts and disabled once
  3519. it ends. The host is fully responsible for the timing of
  3520. the flash.
  3521. </para>
  3522. <para>Example of such device: Nokia N900.</para>
  3523. </section>
  3524. <section>
  3525. <title>Synchronised LED flash (hardware strobe)</title>
  3526. <para>
  3527. The synchronised LED flash is pre-programmed by the host
  3528. (power and timeout) but controlled by the sensor through a
  3529. strobe signal from the sensor to the flash.
  3530. </para>
  3531. <para>
  3532. The sensor controls the flash duration and timing. This
  3533. information typically must be made available to the
  3534. sensor.
  3535. </para>
  3536. </section>
  3537. <section>
  3538. <title>LED flash as torch</title>
  3539. <para>
  3540. LED flash may be used as torch in conjunction with another
  3541. use case involving camera or individually.
  3542. </para>
  3543. </section>
  3544. </section>
  3545. <table pgwide="1" frame="none" id="flash-control-id">
  3546. <title>Flash Control IDs</title>
  3547. <tgroup cols="4">
  3548. <colspec colname="c1" colwidth="1*" />
  3549. <colspec colname="c2" colwidth="6*" />
  3550. <colspec colname="c3" colwidth="2*" />
  3551. <colspec colname="c4" colwidth="6*" />
  3552. <spanspec namest="c1" nameend="c2" spanname="id" />
  3553. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3554. <thead>
  3555. <row>
  3556. <entry spanname="id" align="left">ID</entry>
  3557. <entry align="left">Type</entry>
  3558. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3559. </row>
  3560. </thead>
  3561. <tbody valign="top">
  3562. <row><entry></entry></row>
  3563. <row>
  3564. <entry spanname="id"><constant>V4L2_CID_FLASH_CLASS</constant></entry>
  3565. <entry>class</entry>
  3566. </row>
  3567. <row>
  3568. <entry spanname="descr">The FLASH class descriptor.</entry>
  3569. </row>
  3570. <row>
  3571. <entry spanname="id"><constant>V4L2_CID_FLASH_LED_MODE</constant></entry>
  3572. <entry>menu</entry>
  3573. </row>
  3574. <row id="v4l2-flash-led-mode">
  3575. <entry spanname="descr">Defines the mode of the flash LED,
  3576. the high-power white LED attached to the flash controller.
  3577. Setting this control may not be possible in presence of
  3578. some faults. See V4L2_CID_FLASH_FAULT.</entry>
  3579. </row>
  3580. <row>
  3581. <entrytbl spanname="descr" cols="2">
  3582. <tbody valign="top">
  3583. <row>
  3584. <entry><constant>V4L2_FLASH_LED_MODE_NONE</constant></entry>
  3585. <entry>Off.</entry>
  3586. </row>
  3587. <row>
  3588. <entry><constant>V4L2_FLASH_LED_MODE_FLASH</constant></entry>
  3589. <entry>Flash mode.</entry>
  3590. </row>
  3591. <row>
  3592. <entry><constant>V4L2_FLASH_LED_MODE_TORCH</constant></entry>
  3593. <entry>Torch mode. See V4L2_CID_FLASH_TORCH_INTENSITY.</entry>
  3594. </row>
  3595. </tbody>
  3596. </entrytbl>
  3597. </row>
  3598. <row>
  3599. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_SOURCE</constant></entry>
  3600. <entry>menu</entry>
  3601. </row>
  3602. <row id="v4l2-flash-strobe-source"><entry
  3603. spanname="descr">Defines the source of the flash LED
  3604. strobe.</entry>
  3605. </row>
  3606. <row>
  3607. <entrytbl spanname="descr" cols="2">
  3608. <tbody valign="top">
  3609. <row>
  3610. <entry><constant>V4L2_FLASH_STROBE_SOURCE_SOFTWARE</constant></entry>
  3611. <entry>The flash strobe is triggered by using
  3612. the V4L2_CID_FLASH_STROBE control.</entry>
  3613. </row>
  3614. <row>
  3615. <entry><constant>V4L2_FLASH_STROBE_SOURCE_EXTERNAL</constant></entry>
  3616. <entry>The flash strobe is triggered by an
  3617. external source. Typically this is a sensor,
  3618. which makes it possible to synchronises the
  3619. flash strobe start to exposure start.</entry>
  3620. </row>
  3621. </tbody>
  3622. </entrytbl>
  3623. </row>
  3624. <row>
  3625. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE</constant></entry>
  3626. <entry>button</entry>
  3627. </row>
  3628. <row>
  3629. <entry spanname="descr">Strobe flash. Valid when
  3630. V4L2_CID_FLASH_LED_MODE is set to
  3631. V4L2_FLASH_LED_MODE_FLASH and V4L2_CID_FLASH_STROBE_SOURCE
  3632. is set to V4L2_FLASH_STROBE_SOURCE_SOFTWARE. Setting this
  3633. control may not be possible in presence of some faults.
  3634. See V4L2_CID_FLASH_FAULT.</entry>
  3635. </row>
  3636. <row>
  3637. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STOP</constant></entry>
  3638. <entry>button</entry>
  3639. </row>
  3640. <row><entry spanname="descr">Stop flash strobe immediately.</entry>
  3641. </row>
  3642. <row>
  3643. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STATUS</constant></entry>
  3644. <entry>boolean</entry>
  3645. </row>
  3646. <row>
  3647. <entry spanname="descr">Strobe status: whether the flash
  3648. is strobing at the moment or not. This is a read-only
  3649. control.</entry>
  3650. </row>
  3651. <row>
  3652. <entry spanname="id"><constant>V4L2_CID_FLASH_TIMEOUT</constant></entry>
  3653. <entry>integer</entry>
  3654. </row>
  3655. <row>
  3656. <entry spanname="descr">Hardware timeout for flash. The
  3657. flash strobe is stopped after this period of time has
  3658. passed from the start of the strobe.</entry>
  3659. </row>
  3660. <row>
  3661. <entry spanname="id"><constant>V4L2_CID_FLASH_INTENSITY</constant></entry>
  3662. <entry>integer</entry>
  3663. </row>
  3664. <row>
  3665. <entry spanname="descr">Intensity of the flash strobe when
  3666. the flash LED is in flash mode
  3667. (V4L2_FLASH_LED_MODE_FLASH). The unit should be milliamps
  3668. (mA) if possible.</entry>
  3669. </row>
  3670. <row>
  3671. <entry spanname="id"><constant>V4L2_CID_FLASH_TORCH_INTENSITY</constant></entry>
  3672. <entry>integer</entry>
  3673. </row>
  3674. <row>
  3675. <entry spanname="descr">Intensity of the flash LED in
  3676. torch mode (V4L2_FLASH_LED_MODE_TORCH). The unit should be
  3677. milliamps (mA) if possible. Setting this control may not
  3678. be possible in presence of some faults. See
  3679. V4L2_CID_FLASH_FAULT.</entry>
  3680. </row>
  3681. <row>
  3682. <entry spanname="id"><constant>V4L2_CID_FLASH_INDICATOR_INTENSITY</constant></entry>
  3683. <entry>integer</entry>
  3684. </row>
  3685. <row>
  3686. <entry spanname="descr">Intensity of the indicator LED.
  3687. The indicator LED may be fully independent of the flash
  3688. LED. The unit should be microamps (uA) if possible.</entry>
  3689. </row>
  3690. <row>
  3691. <entry spanname="id"><constant>V4L2_CID_FLASH_FAULT</constant></entry>
  3692. <entry>bitmask</entry>
  3693. </row>
  3694. <row>
  3695. <entry spanname="descr">Faults related to the flash. The
  3696. faults tell about specific problems in the flash chip
  3697. itself or the LEDs attached to it. Faults may prevent
  3698. further use of some of the flash controls. In particular,
  3699. V4L2_CID_FLASH_LED_MODE is set to V4L2_FLASH_LED_MODE_NONE
  3700. if the fault affects the flash LED. Exactly which faults
  3701. have such an effect is chip dependent. Reading the faults
  3702. resets the control and returns the chip to a usable state
  3703. if possible.</entry>
  3704. </row>
  3705. <row>
  3706. <entrytbl spanname="descr" cols="2">
  3707. <tbody valign="top">
  3708. <row>
  3709. <entry><constant>V4L2_FLASH_FAULT_OVER_VOLTAGE</constant></entry>
  3710. <entry>Flash controller voltage to the flash LED
  3711. has exceeded the limit specific to the flash
  3712. controller.</entry>
  3713. </row>
  3714. <row>
  3715. <entry><constant>V4L2_FLASH_FAULT_TIMEOUT</constant></entry>
  3716. <entry>The flash strobe was still on when
  3717. the timeout set by the user ---
  3718. V4L2_CID_FLASH_TIMEOUT control --- has expired.
  3719. Not all flash controllers may set this in all
  3720. such conditions.</entry>
  3721. </row>
  3722. <row>
  3723. <entry><constant>V4L2_FLASH_FAULT_OVER_TEMPERATURE</constant></entry>
  3724. <entry>The flash controller has overheated.</entry>
  3725. </row>
  3726. <row>
  3727. <entry><constant>V4L2_FLASH_FAULT_SHORT_CIRCUIT</constant></entry>
  3728. <entry>The short circuit protection of the flash
  3729. controller has been triggered.</entry>
  3730. </row>
  3731. <row>
  3732. <entry><constant>V4L2_FLASH_FAULT_OVER_CURRENT</constant></entry>
  3733. <entry>Current in the LED power supply has exceeded the limit
  3734. specific to the flash controller.</entry>
  3735. </row>
  3736. <row>
  3737. <entry><constant>V4L2_FLASH_FAULT_INDICATOR</constant></entry>
  3738. <entry>The flash controller has detected a short or open
  3739. circuit condition on the indicator LED.</entry>
  3740. </row>
  3741. </tbody>
  3742. </entrytbl>
  3743. </row>
  3744. <row>
  3745. <entry spanname="id"><constant>V4L2_CID_FLASH_CHARGE</constant></entry>
  3746. <entry>boolean</entry>
  3747. </row>
  3748. <row><entry spanname="descr">Enable or disable charging of the xenon
  3749. flash capacitor.</entry>
  3750. </row>
  3751. <row>
  3752. <entry spanname="id"><constant>V4L2_CID_FLASH_READY</constant></entry>
  3753. <entry>boolean</entry>
  3754. </row>
  3755. <row>
  3756. <entry spanname="descr">Is the flash ready to strobe?
  3757. Xenon flashes require their capacitors charged before
  3758. strobing. LED flashes often require a cooldown period
  3759. after strobe during which another strobe will not be
  3760. possible. This is a read-only control.</entry>
  3761. </row>
  3762. <row><entry></entry></row>
  3763. </tbody>
  3764. </tgroup>
  3765. </table>
  3766. </section>
  3767. <section id="jpeg-controls">
  3768. <title>JPEG Control Reference</title>
  3769. <para>The JPEG class includes controls for common features of JPEG
  3770. encoders and decoders. Currently it includes features for codecs
  3771. implementing progressive baseline DCT compression process with
  3772. Huffman entrophy coding.</para>
  3773. <table pgwide="1" frame="none" id="jpeg-control-id">
  3774. <title>JPEG Control IDs</title>
  3775. <tgroup cols="4">
  3776. <colspec colname="c1" colwidth="1*" />
  3777. <colspec colname="c2" colwidth="6*" />
  3778. <colspec colname="c3" colwidth="2*" />
  3779. <colspec colname="c4" colwidth="6*" />
  3780. <spanspec namest="c1" nameend="c2" spanname="id" />
  3781. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3782. <thead>
  3783. <row>
  3784. <entry spanname="id" align="left">ID</entry>
  3785. <entry align="left">Type</entry>
  3786. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3787. </row>
  3788. </thead>
  3789. <tbody valign="top">
  3790. <row><entry></entry></row>
  3791. <row>
  3792. <entry spanname="id"><constant>V4L2_CID_JPEG_CLASS</constant>&nbsp;</entry>
  3793. <entry>class</entry>
  3794. </row><row><entry spanname="descr">The JPEG class descriptor. Calling
  3795. &VIDIOC-QUERYCTRL; for this control will return a description of this
  3796. control class.
  3797. </entry>
  3798. </row>
  3799. <row>
  3800. <entry spanname="id"><constant>V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant></entry>
  3801. <entry>menu</entry>
  3802. </row>
  3803. <row id="v4l2-jpeg-chroma-subsampling">
  3804. <entry spanname="descr">The chroma subsampling factors describe how
  3805. each component of an input image is sampled, in respect to maximum
  3806. sample rate in each spatial dimension. See <xref linkend="itu-t81"/>,
  3807. clause A.1.1. for more details. The <constant>
  3808. V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant> control determines how
  3809. Cb and Cr components are downsampled after coverting an input image
  3810. from RGB to Y'CbCr color space.
  3811. </entry>
  3812. </row>
  3813. <row id = "v4l2-jpeg-chroma-subsampling">
  3814. <entrytbl spanname="descr" cols="2">
  3815. <tbody valign="top">
  3816. <row>
  3817. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_444</constant>
  3818. </entry><entry>No chroma subsampling, each pixel has
  3819. Y, Cr and Cb values.</entry>
  3820. </row>
  3821. <row>
  3822. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_422</constant>
  3823. </entry><entry>Horizontally subsample Cr, Cb components
  3824. by a factor of 2.</entry>
  3825. </row>
  3826. <row>
  3827. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_420</constant>
  3828. </entry><entry>Subsample Cr, Cb components horizontally
  3829. and vertically by 2.</entry>
  3830. </row>
  3831. <row>
  3832. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_411</constant>
  3833. </entry><entry>Horizontally subsample Cr, Cb components
  3834. by a factor of 4.</entry>
  3835. </row>
  3836. <row>
  3837. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_410</constant>
  3838. </entry><entry>Subsample Cr, Cb components horizontally
  3839. by 4 and vertically by 2.</entry>
  3840. </row>
  3841. <row>
  3842. <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_GRAY</constant>
  3843. </entry><entry>Use only luminance component.</entry>
  3844. </row>
  3845. </tbody>
  3846. </entrytbl>
  3847. </row>
  3848. <row>
  3849. <entry spanname="id"><constant>V4L2_CID_JPEG_RESTART_INTERVAL</constant>
  3850. </entry><entry>integer</entry>
  3851. </row>
  3852. <row><entry spanname="descr">
  3853. The restart interval determines an interval of inserting RSTm
  3854. markers (m = 0..7). The purpose of these markers is to additionally
  3855. reinitialize the encoder process, in order to process blocks of
  3856. an image independently.
  3857. For the lossy compression processes the restart interval unit is
  3858. MCU (Minimum Coded Unit) and its value is contained in DRI
  3859. (Define Restart Interval) marker. If <constant>
  3860. V4L2_CID_JPEG_RESTART_INTERVAL</constant> control is set to 0,
  3861. DRI and RSTm markers will not be inserted.
  3862. </entry>
  3863. </row>
  3864. <row id="jpeg-quality-control">
  3865. <entry spanname="id"><constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant></entry>
  3866. <entry>integer</entry>
  3867. </row>
  3868. <row>
  3869. <entry spanname="descr">
  3870. <constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control
  3871. determines trade-off between image quality and size.
  3872. It provides simpler method for applications to control image quality,
  3873. without a need for direct reconfiguration of luminance and chrominance
  3874. quantization tables.
  3875. In cases where a driver uses quantization tables configured directly
  3876. by an application, using interfaces defined elsewhere, <constant>
  3877. V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control should be set
  3878. by driver to 0.
  3879. <para>The value range of this control is driver-specific. Only
  3880. positive, non-zero values are meaningful. The recommended range
  3881. is 1 - 100, where larger values correspond to better image quality.
  3882. </para>
  3883. </entry>
  3884. </row>
  3885. <row id="jpeg-active-marker-control">
  3886. <entry spanname="id"><constant>V4L2_CID_JPEG_ACTIVE_MARKER</constant></entry>
  3887. <entry>bitmask</entry>
  3888. </row>
  3889. <row>
  3890. <entry spanname="descr">Specify which JPEG markers are included
  3891. in compressed stream. This control is valid only for encoders.
  3892. </entry>
  3893. </row>
  3894. <row>
  3895. <entrytbl spanname="descr" cols="2">
  3896. <tbody valign="top">
  3897. <row>
  3898. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP0</constant></entry>
  3899. <entry>Application data segment APP<subscript>0</subscript>.</entry>
  3900. </row><row>
  3901. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP1</constant></entry>
  3902. <entry>Application data segment APP<subscript>1</subscript>.</entry>
  3903. </row><row>
  3904. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_COM</constant></entry>
  3905. <entry>Comment segment.</entry>
  3906. </row><row>
  3907. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DQT</constant></entry>
  3908. <entry>Quantization tables segment.</entry>
  3909. </row><row>
  3910. <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DHT</constant></entry>
  3911. <entry>Huffman tables segment.</entry>
  3912. </row>
  3913. </tbody>
  3914. </entrytbl>
  3915. </row>
  3916. <row><entry></entry></row>
  3917. </tbody>
  3918. </tgroup>
  3919. </table>
  3920. <para>For more details about JPEG specification, refer
  3921. to <xref linkend="itu-t81"/>, <xref linkend="jfif"/>,
  3922. <xref linkend="w3c-jpeg-jfif"/>.</para>
  3923. </section>
  3924. <section id="image-source-controls">
  3925. <title>Image Source Control Reference</title>
  3926. <note>
  3927. <title>Experimental</title>
  3928. <para>This is an <link
  3929. linkend="experimental">experimental</link> interface and may
  3930. change in the future.</para>
  3931. </note>
  3932. <para>
  3933. The Image Source control class is intended for low-level
  3934. control of image source devices such as image sensors. The
  3935. devices feature an analogue to digital converter and a bus
  3936. transmitter to transmit the image data out of the device.
  3937. </para>
  3938. <table pgwide="1" frame="none" id="image-source-control-id">
  3939. <title>Image Source Control IDs</title>
  3940. <tgroup cols="4">
  3941. <colspec colname="c1" colwidth="1*" />
  3942. <colspec colname="c2" colwidth="6*" />
  3943. <colspec colname="c3" colwidth="2*" />
  3944. <colspec colname="c4" colwidth="6*" />
  3945. <spanspec namest="c1" nameend="c2" spanname="id" />
  3946. <spanspec namest="c2" nameend="c4" spanname="descr" />
  3947. <thead>
  3948. <row>
  3949. <entry spanname="id" align="left">ID</entry>
  3950. <entry align="left">Type</entry>
  3951. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  3952. </row>
  3953. </thead>
  3954. <tbody valign="top">
  3955. <row><entry></entry></row>
  3956. <row>
  3957. <entry spanname="id"><constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant></entry>
  3958. <entry>class</entry>
  3959. </row>
  3960. <row>
  3961. <entry spanname="descr">The IMAGE_SOURCE class descriptor.</entry>
  3962. </row>
  3963. <row>
  3964. <entry spanname="id"><constant>V4L2_CID_VBLANK</constant></entry>
  3965. <entry>integer</entry>
  3966. </row>
  3967. <row>
  3968. <entry spanname="descr">Vertical blanking. The idle period
  3969. after every frame during which no image data is produced.
  3970. The unit of vertical blanking is a line. Every line has
  3971. length of the image width plus horizontal blanking at the
  3972. pixel rate defined by
  3973. <constant>V4L2_CID_PIXEL_RATE</constant> control in the
  3974. same sub-device.</entry>
  3975. </row>
  3976. <row>
  3977. <entry spanname="id"><constant>V4L2_CID_HBLANK</constant></entry>
  3978. <entry>integer</entry>
  3979. </row>
  3980. <row>
  3981. <entry spanname="descr">Horizontal blanking. The idle
  3982. period after every line of image data during which no
  3983. image data is produced. The unit of horizontal blanking is
  3984. pixels.</entry>
  3985. </row>
  3986. <row>
  3987. <entry spanname="id"><constant>V4L2_CID_ANALOGUE_GAIN</constant></entry>
  3988. <entry>integer</entry>
  3989. </row>
  3990. <row>
  3991. <entry spanname="descr">Analogue gain is gain affecting
  3992. all colour components in the pixel matrix. The gain
  3993. operation is performed in the analogue domain before A/D
  3994. conversion.
  3995. </entry>
  3996. </row>
  3997. <row><entry></entry></row>
  3998. </tbody>
  3999. </tgroup>
  4000. </table>
  4001. </section>
  4002. <section id="image-process-controls">
  4003. <title>Image Process Control Reference</title>
  4004. <note>
  4005. <title>Experimental</title>
  4006. <para>This is an <link
  4007. linkend="experimental">experimental</link> interface and may
  4008. change in the future.</para>
  4009. </note>
  4010. <para>
  4011. The Image Source control class is intended for low-level control of
  4012. image processing functions. Unlike
  4013. <constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant>, the controls in
  4014. this class affect processing the image, and do not control capturing
  4015. of it.
  4016. </para>
  4017. <table pgwide="1" frame="none" id="image-process-control-id">
  4018. <title>Image Source Control IDs</title>
  4019. <tgroup cols="4">
  4020. <colspec colname="c1" colwidth="1*" />
  4021. <colspec colname="c2" colwidth="6*" />
  4022. <colspec colname="c3" colwidth="2*" />
  4023. <colspec colname="c4" colwidth="6*" />
  4024. <spanspec namest="c1" nameend="c2" spanname="id" />
  4025. <spanspec namest="c2" nameend="c4" spanname="descr" />
  4026. <thead>
  4027. <row>
  4028. <entry spanname="id" align="left">ID</entry>
  4029. <entry align="left">Type</entry>
  4030. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  4031. </row>
  4032. </thead>
  4033. <tbody valign="top">
  4034. <row><entry></entry></row>
  4035. <row>
  4036. <entry spanname="id"><constant>V4L2_CID_IMAGE_PROC_CLASS</constant></entry>
  4037. <entry>class</entry>
  4038. </row>
  4039. <row>
  4040. <entry spanname="descr">The IMAGE_PROC class descriptor.</entry>
  4041. </row>
  4042. <row>
  4043. <entry spanname="id"><constant>V4L2_CID_LINK_FREQ</constant></entry>
  4044. <entry>integer menu</entry>
  4045. </row>
  4046. <row>
  4047. <entry spanname="descr">Data bus frequency. Together with the
  4048. media bus pixel code, bus type (clock cycles per sample), the
  4049. data bus frequency defines the pixel rate
  4050. (<constant>V4L2_CID_PIXEL_RATE</constant>) in the
  4051. pixel array (or possibly elsewhere, if the device is not an
  4052. image sensor). The frame rate can be calculated from the pixel
  4053. clock, image width and height and horizontal and vertical
  4054. blanking. While the pixel rate control may be defined elsewhere
  4055. than in the subdev containing the pixel array, the frame rate
  4056. cannot be obtained from that information. This is because only
  4057. on the pixel array it can be assumed that the vertical and
  4058. horizontal blanking information is exact: no other blanking is
  4059. allowed in the pixel array. The selection of frame rate is
  4060. performed by selecting the desired horizontal and vertical
  4061. blanking. The unit of this control is Hz. </entry>
  4062. </row>
  4063. <row>
  4064. <entry spanname="id"><constant>V4L2_CID_PIXEL_RATE</constant></entry>
  4065. <entry>64-bit integer</entry>
  4066. </row>
  4067. <row>
  4068. <entry spanname="descr">Pixel rate in the source pads of
  4069. the subdev. This control is read-only and its unit is
  4070. pixels / second.
  4071. </entry>
  4072. </row>
  4073. <row><entry></entry></row>
  4074. </tbody>
  4075. </tgroup>
  4076. </table>
  4077. </section>
  4078. </section>