controls.xml 126 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366
  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) and
  230. <constant>V4L2_CID_POWER_LINE_FREQUENCY_60HZ</constant> (2).</entry>
  231. </row>
  232. <row>
  233. <entry><constant>V4L2_CID_HUE_AUTO</constant></entry>
  234. <entry>boolean</entry>
  235. <entry>Enables automatic hue control by the device. The
  236. effect of setting <constant>V4L2_CID_HUE</constant> while automatic
  237. hue control is enabled is undefined, drivers should ignore such
  238. request.</entry>
  239. </row>
  240. <row>
  241. <entry><constant>V4L2_CID_WHITE_BALANCE_TEMPERATURE</constant></entry>
  242. <entry>integer</entry>
  243. <entry>This control specifies the white balance settings
  244. as a color temperature in Kelvin. A driver should have a minimum of
  245. 2800 (incandescent) to 6500 (daylight). For more information about
  246. color temperature see <ulink
  247. url="http://en.wikipedia.org/wiki/Color_temperature">Wikipedia</ulink>.</entry>
  248. </row>
  249. <row>
  250. <entry><constant>V4L2_CID_SHARPNESS</constant></entry>
  251. <entry>integer</entry>
  252. <entry>Adjusts the sharpness filters in a camera. The
  253. minimum value disables the filters, higher values give a sharper
  254. picture.</entry>
  255. </row>
  256. <row>
  257. <entry><constant>V4L2_CID_BACKLIGHT_COMPENSATION</constant></entry>
  258. <entry>integer</entry>
  259. <entry>Adjusts the backlight compensation in a camera. The
  260. minimum value disables backlight compensation.</entry>
  261. </row>
  262. <row>
  263. <entry><constant>V4L2_CID_CHROMA_AGC</constant></entry>
  264. <entry>boolean</entry>
  265. <entry>Chroma automatic gain control.</entry>
  266. </row>
  267. <row>
  268. <entry><constant>V4L2_CID_CHROMA_GAIN</constant></entry>
  269. <entry>integer</entry>
  270. <entry>Adjusts the Chroma gain control (for use when chroma AGC
  271. is disabled).</entry>
  272. </row>
  273. <row>
  274. <entry><constant>V4L2_CID_COLOR_KILLER</constant></entry>
  275. <entry>boolean</entry>
  276. <entry>Enable the color killer (&ie; force a black &amp; white image in case of a weak video signal).</entry>
  277. </row>
  278. <row id="v4l2-colorfx">
  279. <entry><constant>V4L2_CID_COLORFX</constant></entry>
  280. <entry>enum</entry>
  281. <entry>Selects a color effect. Possible values for
  282. <constant>enum v4l2_colorfx</constant> are:
  283. <constant>V4L2_COLORFX_NONE</constant> (0),
  284. <constant>V4L2_COLORFX_BW</constant> (1),
  285. <constant>V4L2_COLORFX_SEPIA</constant> (2),
  286. <constant>V4L2_COLORFX_NEGATIVE</constant> (3),
  287. <constant>V4L2_COLORFX_EMBOSS</constant> (4),
  288. <constant>V4L2_COLORFX_SKETCH</constant> (5),
  289. <constant>V4L2_COLORFX_SKY_BLUE</constant> (6),
  290. <constant>V4L2_COLORFX_GRASS_GREEN</constant> (7),
  291. <constant>V4L2_COLORFX_SKIN_WHITEN</constant> (8) and
  292. <constant>V4L2_COLORFX_VIVID</constant> (9).</entry>
  293. </row>
  294. <row>
  295. <entry><constant>V4L2_CID_ROTATE</constant></entry>
  296. <entry>integer</entry>
  297. <entry>Rotates the image by specified angle. Common angles are 90,
  298. 270 and 180. Rotating the image to 90 and 270 will reverse the height
  299. and width of the display window. It is necessary to set the new height and
  300. width of the picture using the &VIDIOC-S-FMT; ioctl according to
  301. the rotation angle selected.</entry>
  302. </row>
  303. <row>
  304. <entry><constant>V4L2_CID_BG_COLOR</constant></entry>
  305. <entry>integer</entry>
  306. <entry>Sets the background color on the current output device.
  307. Background color needs to be specified in the RGB24 format. The
  308. supplied 32 bit value is interpreted as bits 0-7 Red color information,
  309. bits 8-15 Green color information, bits 16-23 Blue color
  310. information and bits 24-31 must be zero.</entry>
  311. </row>
  312. <row>
  313. <entry><constant>V4L2_CID_ILLUMINATORS_1</constant>
  314. <constant>V4L2_CID_ILLUMINATORS_2</constant></entry>
  315. <entry>boolean</entry>
  316. <entry>Switch on or off the illuminator 1 or 2 of the device
  317. (usually a microscope).</entry>
  318. </row>
  319. <row>
  320. <entry><constant>V4L2_CID_LASTP1</constant></entry>
  321. <entry></entry>
  322. <entry>End of the predefined control IDs (currently
  323. <constant>V4L2_CID_ILLUMINATORS_2</constant> + 1).</entry>
  324. </row>
  325. <row>
  326. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry>
  327. <entry>integer</entry>
  328. <entry>This is a read-only control that can be read by the application
  329. and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS.
  330. The value is the minimum number of CAPTURE buffers that is necessary for hardware
  331. to work.</entry>
  332. </row>
  333. <row>
  334. <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_OUTPUT</constant></entry>
  335. <entry>integer</entry>
  336. <entry>This is a read-only control that can be read by the application
  337. and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS.
  338. The value is the minimum number of OUTPUT buffers that is necessary for hardware
  339. to work.</entry>
  340. </row>
  341. <row>
  342. <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry>
  343. <entry></entry>
  344. <entry>ID of the first custom (driver specific) control.
  345. Applications depending on particular custom controls should check the
  346. driver name and version, see <xref linkend="querycap" />.</entry>
  347. </row>
  348. </tbody>
  349. </tgroup>
  350. </table>
  351. <para>Applications can enumerate the available controls with the
  352. &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls, get and set a
  353. control value with the &VIDIOC-G-CTRL; and &VIDIOC-S-CTRL; ioctls.
  354. Drivers must implement <constant>VIDIOC_QUERYCTRL</constant>,
  355. <constant>VIDIOC_G_CTRL</constant> and
  356. <constant>VIDIOC_S_CTRL</constant> when the device has one or more
  357. controls, <constant>VIDIOC_QUERYMENU</constant> when it has one or
  358. more menu type controls.</para>
  359. <example>
  360. <title>Enumerating all controls</title>
  361. <programlisting>
  362. &v4l2-queryctrl; queryctrl;
  363. &v4l2-querymenu; querymenu;
  364. static void
  365. enumerate_menu (void)
  366. {
  367. printf (" Menu items:\n");
  368. memset (&amp;querymenu, 0, sizeof (querymenu));
  369. querymenu.id = queryctrl.id;
  370. for (querymenu.index = queryctrl.minimum;
  371. querymenu.index &lt;= queryctrl.maximum;
  372. querymenu.index++) {
  373. if (0 == ioctl (fd, &VIDIOC-QUERYMENU;, &amp;querymenu)) {
  374. printf (" %s\n", querymenu.name);
  375. }
  376. }
  377. }
  378. memset (&amp;queryctrl, 0, sizeof (queryctrl));
  379. for (queryctrl.id = V4L2_CID_BASE;
  380. queryctrl.id &lt; V4L2_CID_LASTP1;
  381. queryctrl.id++) {
  382. if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  383. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  384. continue;
  385. printf ("Control %s\n", queryctrl.name);
  386. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  387. enumerate_menu ();
  388. } else {
  389. if (errno == EINVAL)
  390. continue;
  391. perror ("VIDIOC_QUERYCTRL");
  392. exit (EXIT_FAILURE);
  393. }
  394. }
  395. for (queryctrl.id = V4L2_CID_PRIVATE_BASE;;
  396. queryctrl.id++) {
  397. if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  398. if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
  399. continue;
  400. printf ("Control %s\n", queryctrl.name);
  401. if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
  402. enumerate_menu ();
  403. } else {
  404. if (errno == EINVAL)
  405. break;
  406. perror ("VIDIOC_QUERYCTRL");
  407. exit (EXIT_FAILURE);
  408. }
  409. }
  410. </programlisting>
  411. </example>
  412. <example>
  413. <title>Changing controls</title>
  414. <programlisting>
  415. &v4l2-queryctrl; queryctrl;
  416. &v4l2-control; control;
  417. memset (&amp;queryctrl, 0, sizeof (queryctrl));
  418. queryctrl.id = V4L2_CID_BRIGHTNESS;
  419. if (-1 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
  420. if (errno != EINVAL) {
  421. perror ("VIDIOC_QUERYCTRL");
  422. exit (EXIT_FAILURE);
  423. } else {
  424. printf ("V4L2_CID_BRIGHTNESS is not supported\n");
  425. }
  426. } else if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED) {
  427. printf ("V4L2_CID_BRIGHTNESS is not supported\n");
  428. } else {
  429. memset (&amp;control, 0, sizeof (control));
  430. control.id = V4L2_CID_BRIGHTNESS;
  431. control.value = queryctrl.default_value;
  432. if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)) {
  433. perror ("VIDIOC_S_CTRL");
  434. exit (EXIT_FAILURE);
  435. }
  436. }
  437. memset (&amp;control, 0, sizeof (control));
  438. control.id = V4L2_CID_CONTRAST;
  439. if (0 == ioctl (fd, &VIDIOC-G-CTRL;, &amp;control)) {
  440. control.value += 1;
  441. /* The driver may clamp the value or return ERANGE, ignored here */
  442. if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)
  443. &amp;&amp; errno != ERANGE) {
  444. perror ("VIDIOC_S_CTRL");
  445. exit (EXIT_FAILURE);
  446. }
  447. /* Ignore if V4L2_CID_CONTRAST is unsupported */
  448. } else if (errno != EINVAL) {
  449. perror ("VIDIOC_G_CTRL");
  450. exit (EXIT_FAILURE);
  451. }
  452. control.id = V4L2_CID_AUDIO_MUTE;
  453. control.value = TRUE; /* silence */
  454. /* Errors ignored */
  455. ioctl (fd, VIDIOC_S_CTRL, &amp;control);
  456. </programlisting>
  457. </example>
  458. </section>
  459. <section id="extended-controls">
  460. <title>Extended Controls</title>
  461. <section>
  462. <title>Introduction</title>
  463. <para>The control mechanism as originally designed was meant
  464. to be used for user settings (brightness, saturation, etc). However,
  465. it turned out to be a very useful model for implementing more
  466. complicated driver APIs where each driver implements only a subset of
  467. a larger API.</para>
  468. <para>The MPEG encoding API was the driving force behind
  469. designing and implementing this extended control mechanism: the MPEG
  470. standard is quite large and the currently supported hardware MPEG
  471. encoders each only implement a subset of this standard. Further more,
  472. many parameters relating to how the video is encoded into an MPEG
  473. stream are specific to the MPEG encoding chip since the MPEG standard
  474. only defines the format of the resulting MPEG stream, not how the
  475. video is actually encoded into that format.</para>
  476. <para>Unfortunately, the original control API lacked some
  477. features needed for these new uses and so it was extended into the
  478. (not terribly originally named) extended control API.</para>
  479. <para>Even though the MPEG encoding API was the first effort
  480. to use the Extended Control API, nowadays there are also other classes
  481. of Extended Controls, such as Camera Controls and FM Transmitter Controls.
  482. The Extended Controls API as well as all Extended Controls classes are
  483. described in the following text.</para>
  484. </section>
  485. <section>
  486. <title>The Extended Control API</title>
  487. <para>Three new ioctls are available: &VIDIOC-G-EXT-CTRLS;,
  488. &VIDIOC-S-EXT-CTRLS; and &VIDIOC-TRY-EXT-CTRLS;. These ioctls act on
  489. arrays of controls (as opposed to the &VIDIOC-G-CTRL; and
  490. &VIDIOC-S-CTRL; ioctls that act on a single control). This is needed
  491. since it is often required to atomically change several controls at
  492. once.</para>
  493. <para>Each of the new ioctls expects a pointer to a
  494. &v4l2-ext-controls;. This structure contains a pointer to the control
  495. array, a count of the number of controls in that array and a control
  496. class. Control classes are used to group similar controls into a
  497. single class. For example, control class
  498. <constant>V4L2_CTRL_CLASS_USER</constant> contains all user controls
  499. (&ie; all controls that can also be set using the old
  500. <constant>VIDIOC_S_CTRL</constant> ioctl). Control class
  501. <constant>V4L2_CTRL_CLASS_MPEG</constant> contains all controls
  502. relating to MPEG encoding, etc.</para>
  503. <para>All controls in the control array must belong to the
  504. specified control class. An error is returned if this is not the
  505. case.</para>
  506. <para>It is also possible to use an empty control array (count
  507. == 0) to check whether the specified control class is
  508. supported.</para>
  509. <para>The control array is a &v4l2-ext-control; array. The
  510. <structname>v4l2_ext_control</structname> structure is very similar to
  511. &v4l2-control;, except for the fact that it also allows for 64-bit
  512. values and pointers to be passed.</para>
  513. <para>It is important to realize that due to the flexibility of
  514. controls it is necessary to check whether the control you want to set
  515. actually is supported in the driver and what the valid range of values
  516. is. So use the &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls to
  517. check this. Also note that it is possible that some of the menu
  518. indices in a control of type <constant>V4L2_CTRL_TYPE_MENU</constant>
  519. may not be supported (<constant>VIDIOC_QUERYMENU</constant> will
  520. return an error). A good example is the list of supported MPEG audio
  521. bitrates. Some drivers only support one or two bitrates, others
  522. support a wider range.</para>
  523. <para>
  524. All controls use machine endianness.
  525. </para>
  526. </section>
  527. <section>
  528. <title>Enumerating Extended Controls</title>
  529. <para>The recommended way to enumerate over the extended
  530. controls is by using &VIDIOC-QUERYCTRL; in combination with the
  531. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag:</para>
  532. <informalexample>
  533. <programlisting>
  534. &v4l2-queryctrl; qctrl;
  535. qctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL;
  536. while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  537. /* ... */
  538. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  539. }
  540. </programlisting>
  541. </informalexample>
  542. <para>The initial control ID is set to 0 ORed with the
  543. <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag. The
  544. <constant>VIDIOC_QUERYCTRL</constant> ioctl will return the first
  545. control with a higher ID than the specified one. When no such controls
  546. are found an error is returned.</para>
  547. <para>If you want to get all controls within a specific control
  548. class, then you can set the initial
  549. <structfield>qctrl.id</structfield> value to the control class and add
  550. an extra check to break out of the loop when a control of another
  551. control class is found:</para>
  552. <informalexample>
  553. <programlisting>
  554. qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;
  555. while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
  556. if (V4L2_CTRL_ID2CLASS (qctrl.id) != V4L2_CTRL_CLASS_MPEG)
  557. break;
  558. /* ... */
  559. qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
  560. }
  561. </programlisting>
  562. </informalexample>
  563. <para>The 32-bit <structfield>qctrl.id</structfield> value is
  564. subdivided into three bit ranges: the top 4 bits are reserved for
  565. flags (&eg; <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>) and are not
  566. actually part of the ID. The remaining 28 bits form the control ID, of
  567. which the most significant 12 bits define the control class and the
  568. least significant 16 bits identify the control within the control
  569. class. It is guaranteed that these last 16 bits are always non-zero
  570. for controls. The range of 0x1000 and up are reserved for
  571. driver-specific controls. The macro
  572. <constant>V4L2_CTRL_ID2CLASS(id)</constant> returns the control class
  573. ID based on a control ID.</para>
  574. <para>If the driver does not support extended controls, then
  575. <constant>VIDIOC_QUERYCTRL</constant> will fail when used in
  576. combination with <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>. In
  577. that case the old method of enumerating control should be used (see
  578. 1.8). But if it is supported, then it is guaranteed to enumerate over
  579. all controls, including driver-private controls.</para>
  580. </section>
  581. <section>
  582. <title>Creating Control Panels</title>
  583. <para>It is possible to create control panels for a graphical
  584. user interface where the user can select the various controls.
  585. Basically you will have to iterate over all controls using the method
  586. described above. Each control class starts with a control of type
  587. <constant>V4L2_CTRL_TYPE_CTRL_CLASS</constant>.
  588. <constant>VIDIOC_QUERYCTRL</constant> will return the name of this
  589. control class which can be used as the title of a tab page within a
  590. control panel.</para>
  591. <para>The flags field of &v4l2-queryctrl; also contains hints on
  592. the behavior of the control. See the &VIDIOC-QUERYCTRL; documentation
  593. for more details.</para>
  594. </section>
  595. <section id="mpeg-controls">
  596. <title>MPEG Control Reference</title>
  597. <para>Below all controls within the MPEG control class are
  598. described. First the generic controls, then controls specific for
  599. certain hardware.</para>
  600. <section>
  601. <title>Generic MPEG Controls</title>
  602. <table pgwide="1" frame="none" id="mpeg-control-id">
  603. <title>MPEG Control IDs</title>
  604. <tgroup cols="4">
  605. <colspec colname="c1" colwidth="1*" />
  606. <colspec colname="c2" colwidth="6*" />
  607. <colspec colname="c3" colwidth="2*" />
  608. <colspec colname="c4" colwidth="6*" />
  609. <spanspec namest="c1" nameend="c2" spanname="id" />
  610. <spanspec namest="c2" nameend="c4" spanname="descr" />
  611. <thead>
  612. <row>
  613. <entry spanname="id" align="left">ID</entry>
  614. <entry align="left">Type</entry>
  615. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  616. </row>
  617. </thead>
  618. <tbody valign="top">
  619. <row><entry></entry></row>
  620. <row>
  621. <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant>&nbsp;</entry>
  622. <entry>class</entry>
  623. </row><row><entry spanname="descr">The MPEG class
  624. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  625. description of this control class. This description can be used as the
  626. caption of a Tab page in a GUI, for example.</entry>
  627. </row>
  628. <row><entry></entry></row>
  629. <row id="v4l2-mpeg-stream-type">
  630. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant>&nbsp;</entry>
  631. <entry>enum&nbsp;v4l2_mpeg_stream_type</entry>
  632. </row><row><entry spanname="descr">The MPEG-1, -2 or -4
  633. output stream type. One cannot assume anything here. Each hardware
  634. MPEG encoder tends to support different subsets of the available MPEG
  635. stream types. This control is specific to multiplexed MPEG streams.
  636. The currently defined stream types are:</entry>
  637. </row>
  638. <row>
  639. <entrytbl spanname="descr" cols="2">
  640. <tbody valign="top">
  641. <row>
  642. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_PS</constant>&nbsp;</entry>
  643. <entry>MPEG-2 program stream</entry>
  644. </row>
  645. <row>
  646. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_TS</constant>&nbsp;</entry>
  647. <entry>MPEG-2 transport stream</entry>
  648. </row>
  649. <row>
  650. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_SS</constant>&nbsp;</entry>
  651. <entry>MPEG-1 system stream</entry>
  652. </row>
  653. <row>
  654. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_DVD</constant>&nbsp;</entry>
  655. <entry>MPEG-2 DVD-compatible stream</entry>
  656. </row>
  657. <row>
  658. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_VCD</constant>&nbsp;</entry>
  659. <entry>MPEG-1 VCD-compatible stream</entry>
  660. </row>
  661. <row>
  662. <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD</constant>&nbsp;</entry>
  663. <entry>MPEG-2 SVCD-compatible stream</entry>
  664. </row>
  665. </tbody>
  666. </entrytbl>
  667. </row>
  668. <row><entry></entry></row>
  669. <row>
  670. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PMT</constant>&nbsp;</entry>
  671. <entry>integer</entry>
  672. </row><row><entry spanname="descr">Program Map Table
  673. Packet ID for the MPEG transport stream (default 16)</entry>
  674. </row>
  675. <row><entry></entry></row>
  676. <row>
  677. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_AUDIO</constant>&nbsp;</entry>
  678. <entry>integer</entry>
  679. </row><row><entry spanname="descr">Audio Packet ID for
  680. the MPEG transport stream (default 256)</entry>
  681. </row>
  682. <row><entry></entry></row>
  683. <row>
  684. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_VIDEO</constant>&nbsp;</entry>
  685. <entry>integer</entry>
  686. </row><row><entry spanname="descr">Video Packet ID for
  687. the MPEG transport stream (default 260)</entry>
  688. </row>
  689. <row><entry></entry></row>
  690. <row>
  691. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PCR</constant>&nbsp;</entry>
  692. <entry>integer</entry>
  693. </row><row><entry spanname="descr">Packet ID for the
  694. MPEG transport stream carrying PCR fields (default 259)</entry>
  695. </row>
  696. <row><entry></entry></row>
  697. <row>
  698. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_AUDIO</constant>&nbsp;</entry>
  699. <entry>integer</entry>
  700. </row><row><entry spanname="descr">Audio ID for MPEG
  701. PES</entry>
  702. </row>
  703. <row><entry></entry></row>
  704. <row>
  705. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_VIDEO</constant>&nbsp;</entry>
  706. <entry>integer</entry>
  707. </row><row><entry spanname="descr">Video ID for MPEG
  708. PES</entry>
  709. </row>
  710. <row><entry></entry></row>
  711. <row id="v4l2-mpeg-stream-vbi-fmt">
  712. <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant>&nbsp;</entry>
  713. <entry>enum&nbsp;v4l2_mpeg_stream_vbi_fmt</entry>
  714. </row><row><entry spanname="descr">Some cards can embed
  715. VBI data (&eg; Closed Caption, Teletext) into the MPEG stream. This
  716. control selects whether VBI data should be embedded, and if so, what
  717. embedding method should be used. The list of possible VBI formats
  718. depends on the driver. The currently defined VBI format types
  719. are:</entry>
  720. </row>
  721. <row>
  722. <entrytbl spanname="descr" cols="2">
  723. <tbody valign="top">
  724. <row>
  725. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_NONE</constant>&nbsp;</entry>
  726. <entry>No VBI in the MPEG stream</entry>
  727. </row>
  728. <row>
  729. <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_IVTV</constant>&nbsp;</entry>
  730. <entry>VBI in private packets, IVTV format (documented
  731. in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.vbi</filename>)</entry>
  732. </row>
  733. </tbody>
  734. </entrytbl>
  735. </row>
  736. <row><entry></entry></row>
  737. <row id="v4l2-mpeg-audio-sampling-freq">
  738. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant>&nbsp;</entry>
  739. <entry>enum&nbsp;v4l2_mpeg_audio_sampling_freq</entry>
  740. </row><row><entry spanname="descr">MPEG Audio sampling
  741. frequency. Possible values are:</entry>
  742. </row>
  743. <row>
  744. <entrytbl spanname="descr" cols="2">
  745. <tbody valign="top">
  746. <row>
  747. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100</constant>&nbsp;</entry>
  748. <entry>44.1 kHz</entry>
  749. </row>
  750. <row>
  751. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000</constant>&nbsp;</entry>
  752. <entry>48 kHz</entry>
  753. </row>
  754. <row>
  755. <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000</constant>&nbsp;</entry>
  756. <entry>32 kHz</entry>
  757. </row>
  758. </tbody>
  759. </entrytbl>
  760. </row>
  761. <row><entry></entry></row>
  762. <row id="v4l2-mpeg-audio-encoding">
  763. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant>&nbsp;</entry>
  764. <entry>enum&nbsp;v4l2_mpeg_audio_encoding</entry>
  765. </row><row><entry spanname="descr">MPEG Audio encoding.
  766. This control is specific to multiplexed MPEG streams.
  767. Possible values are:</entry>
  768. </row>
  769. <row>
  770. <entrytbl spanname="descr" cols="2">
  771. <tbody valign="top">
  772. <row>
  773. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_1</constant>&nbsp;</entry>
  774. <entry>MPEG-1/2 Layer I encoding</entry>
  775. </row>
  776. <row>
  777. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_2</constant>&nbsp;</entry>
  778. <entry>MPEG-1/2 Layer II encoding</entry>
  779. </row>
  780. <row>
  781. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_3</constant>&nbsp;</entry>
  782. <entry>MPEG-1/2 Layer III encoding</entry>
  783. </row>
  784. <row>
  785. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AAC</constant>&nbsp;</entry>
  786. <entry>MPEG-2/4 AAC (Advanced Audio Coding)</entry>
  787. </row>
  788. <row>
  789. <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AC3</constant>&nbsp;</entry>
  790. <entry>AC-3 aka ATSC A/52 encoding</entry>
  791. </row>
  792. </tbody>
  793. </entrytbl>
  794. </row>
  795. <row><entry></entry></row>
  796. <row id="v4l2-mpeg-audio-l1-bitrate">
  797. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant>&nbsp;</entry>
  798. <entry>enum&nbsp;v4l2_mpeg_audio_l1_bitrate</entry>
  799. </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate.
  800. Possible values are:</entry>
  801. </row>
  802. <row>
  803. <entrytbl spanname="descr" cols="2">
  804. <tbody valign="top">
  805. <row>
  806. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_32K</constant>&nbsp;</entry>
  807. <entry>32 kbit/s</entry></row>
  808. <row>
  809. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_64K</constant>&nbsp;</entry>
  810. <entry>64 kbit/s</entry>
  811. </row>
  812. <row>
  813. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_96K</constant>&nbsp;</entry>
  814. <entry>96 kbit/s</entry>
  815. </row>
  816. <row>
  817. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_128K</constant>&nbsp;</entry>
  818. <entry>128 kbit/s</entry>
  819. </row>
  820. <row>
  821. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_160K</constant>&nbsp;</entry>
  822. <entry>160 kbit/s</entry>
  823. </row>
  824. <row>
  825. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_192K</constant>&nbsp;</entry>
  826. <entry>192 kbit/s</entry>
  827. </row>
  828. <row>
  829. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_224K</constant>&nbsp;</entry>
  830. <entry>224 kbit/s</entry>
  831. </row>
  832. <row>
  833. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_256K</constant>&nbsp;</entry>
  834. <entry>256 kbit/s</entry>
  835. </row>
  836. <row>
  837. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_288K</constant>&nbsp;</entry>
  838. <entry>288 kbit/s</entry>
  839. </row>
  840. <row>
  841. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_320K</constant>&nbsp;</entry>
  842. <entry>320 kbit/s</entry>
  843. </row>
  844. <row>
  845. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_352K</constant>&nbsp;</entry>
  846. <entry>352 kbit/s</entry>
  847. </row>
  848. <row>
  849. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_384K</constant>&nbsp;</entry>
  850. <entry>384 kbit/s</entry>
  851. </row>
  852. <row>
  853. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_416K</constant>&nbsp;</entry>
  854. <entry>416 kbit/s</entry>
  855. </row>
  856. <row>
  857. <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_448K</constant>&nbsp;</entry>
  858. <entry>448 kbit/s</entry>
  859. </row>
  860. </tbody>
  861. </entrytbl>
  862. </row>
  863. <row><entry></entry></row>
  864. <row id="v4l2-mpeg-audio-l2-bitrate">
  865. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant>&nbsp;</entry>
  866. <entry>enum&nbsp;v4l2_mpeg_audio_l2_bitrate</entry>
  867. </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate.
  868. Possible values are:</entry>
  869. </row>
  870. <row>
  871. <entrytbl spanname="descr" cols="2">
  872. <tbody valign="top">
  873. <row>
  874. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_32K</constant>&nbsp;</entry>
  875. <entry>32 kbit/s</entry>
  876. </row>
  877. <row>
  878. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_48K</constant>&nbsp;</entry>
  879. <entry>48 kbit/s</entry>
  880. </row>
  881. <row>
  882. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_56K</constant>&nbsp;</entry>
  883. <entry>56 kbit/s</entry>
  884. </row>
  885. <row>
  886. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_64K</constant>&nbsp;</entry>
  887. <entry>64 kbit/s</entry>
  888. </row>
  889. <row>
  890. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_80K</constant>&nbsp;</entry>
  891. <entry>80 kbit/s</entry>
  892. </row>
  893. <row>
  894. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_96K</constant>&nbsp;</entry>
  895. <entry>96 kbit/s</entry>
  896. </row>
  897. <row>
  898. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_112K</constant>&nbsp;</entry>
  899. <entry>112 kbit/s</entry>
  900. </row>
  901. <row>
  902. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_128K</constant>&nbsp;</entry>
  903. <entry>128 kbit/s</entry>
  904. </row>
  905. <row>
  906. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_160K</constant>&nbsp;</entry>
  907. <entry>160 kbit/s</entry>
  908. </row>
  909. <row>
  910. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_192K</constant>&nbsp;</entry>
  911. <entry>192 kbit/s</entry>
  912. </row>
  913. <row>
  914. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_224K</constant>&nbsp;</entry>
  915. <entry>224 kbit/s</entry>
  916. </row>
  917. <row>
  918. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_256K</constant>&nbsp;</entry>
  919. <entry>256 kbit/s</entry>
  920. </row>
  921. <row>
  922. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_320K</constant>&nbsp;</entry>
  923. <entry>320 kbit/s</entry>
  924. </row>
  925. <row>
  926. <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_384K</constant>&nbsp;</entry>
  927. <entry>384 kbit/s</entry>
  928. </row>
  929. </tbody>
  930. </entrytbl>
  931. </row>
  932. <row><entry></entry></row>
  933. <row id="v4l2-mpeg-audio-l3-bitrate">
  934. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant>&nbsp;</entry>
  935. <entry>enum&nbsp;v4l2_mpeg_audio_l3_bitrate</entry>
  936. </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate.
  937. Possible values are:</entry>
  938. </row>
  939. <row>
  940. <entrytbl spanname="descr" cols="2">
  941. <tbody valign="top">
  942. <row>
  943. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_32K</constant>&nbsp;</entry>
  944. <entry>32 kbit/s</entry>
  945. </row>
  946. <row>
  947. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_40K</constant>&nbsp;</entry>
  948. <entry>40 kbit/s</entry>
  949. </row>
  950. <row>
  951. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_48K</constant>&nbsp;</entry>
  952. <entry>48 kbit/s</entry>
  953. </row>
  954. <row>
  955. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_56K</constant>&nbsp;</entry>
  956. <entry>56 kbit/s</entry>
  957. </row>
  958. <row>
  959. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_64K</constant>&nbsp;</entry>
  960. <entry>64 kbit/s</entry>
  961. </row>
  962. <row>
  963. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_80K</constant>&nbsp;</entry>
  964. <entry>80 kbit/s</entry>
  965. </row>
  966. <row>
  967. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_96K</constant>&nbsp;</entry>
  968. <entry>96 kbit/s</entry>
  969. </row>
  970. <row>
  971. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_112K</constant>&nbsp;</entry>
  972. <entry>112 kbit/s</entry>
  973. </row>
  974. <row>
  975. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_128K</constant>&nbsp;</entry>
  976. <entry>128 kbit/s</entry>
  977. </row>
  978. <row>
  979. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_160K</constant>&nbsp;</entry>
  980. <entry>160 kbit/s</entry>
  981. </row>
  982. <row>
  983. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_192K</constant>&nbsp;</entry>
  984. <entry>192 kbit/s</entry>
  985. </row>
  986. <row>
  987. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_224K</constant>&nbsp;</entry>
  988. <entry>224 kbit/s</entry>
  989. </row>
  990. <row>
  991. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_256K</constant>&nbsp;</entry>
  992. <entry>256 kbit/s</entry>
  993. </row>
  994. <row>
  995. <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_320K</constant>&nbsp;</entry>
  996. <entry>320 kbit/s</entry>
  997. </row>
  998. </tbody>
  999. </entrytbl>
  1000. </row>
  1001. <row><entry></entry></row>
  1002. <row>
  1003. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AAC_BITRATE</constant>&nbsp;</entry>
  1004. <entry>integer</entry>
  1005. </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry>
  1006. </row>
  1007. <row><entry></entry></row>
  1008. <row id="v4l2-mpeg-audio-ac3-bitrate">
  1009. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant>&nbsp;</entry>
  1010. <entry>enum&nbsp;v4l2_mpeg_audio_ac3_bitrate</entry>
  1011. </row><row><entry spanname="descr">AC-3 bitrate.
  1012. Possible values are:</entry>
  1013. </row>
  1014. <row>
  1015. <entrytbl spanname="descr" cols="2">
  1016. <tbody valign="top">
  1017. <row>
  1018. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_32K</constant>&nbsp;</entry>
  1019. <entry>32 kbit/s</entry>
  1020. </row>
  1021. <row>
  1022. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_40K</constant>&nbsp;</entry>
  1023. <entry>40 kbit/s</entry>
  1024. </row>
  1025. <row>
  1026. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_48K</constant>&nbsp;</entry>
  1027. <entry>48 kbit/s</entry>
  1028. </row>
  1029. <row>
  1030. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_56K</constant>&nbsp;</entry>
  1031. <entry>56 kbit/s</entry>
  1032. </row>
  1033. <row>
  1034. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_64K</constant>&nbsp;</entry>
  1035. <entry>64 kbit/s</entry>
  1036. </row>
  1037. <row>
  1038. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_80K</constant>&nbsp;</entry>
  1039. <entry>80 kbit/s</entry>
  1040. </row>
  1041. <row>
  1042. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_96K</constant>&nbsp;</entry>
  1043. <entry>96 kbit/s</entry>
  1044. </row>
  1045. <row>
  1046. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_112K</constant>&nbsp;</entry>
  1047. <entry>112 kbit/s</entry>
  1048. </row>
  1049. <row>
  1050. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_128K</constant>&nbsp;</entry>
  1051. <entry>128 kbit/s</entry>
  1052. </row>
  1053. <row>
  1054. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_160K</constant>&nbsp;</entry>
  1055. <entry>160 kbit/s</entry>
  1056. </row>
  1057. <row>
  1058. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_192K</constant>&nbsp;</entry>
  1059. <entry>192 kbit/s</entry>
  1060. </row>
  1061. <row>
  1062. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_224K</constant>&nbsp;</entry>
  1063. <entry>224 kbit/s</entry>
  1064. </row>
  1065. <row>
  1066. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_256K</constant>&nbsp;</entry>
  1067. <entry>256 kbit/s</entry>
  1068. </row>
  1069. <row>
  1070. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_320K</constant>&nbsp;</entry>
  1071. <entry>320 kbit/s</entry>
  1072. </row>
  1073. <row>
  1074. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_384K</constant>&nbsp;</entry>
  1075. <entry>384 kbit/s</entry>
  1076. </row>
  1077. <row>
  1078. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_448K</constant>&nbsp;</entry>
  1079. <entry>448 kbit/s</entry>
  1080. </row>
  1081. <row>
  1082. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_512K</constant>&nbsp;</entry>
  1083. <entry>512 kbit/s</entry>
  1084. </row>
  1085. <row>
  1086. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_576K</constant>&nbsp;</entry>
  1087. <entry>576 kbit/s</entry>
  1088. </row>
  1089. <row>
  1090. <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_640K</constant>&nbsp;</entry>
  1091. <entry>640 kbit/s</entry>
  1092. </row>
  1093. </tbody>
  1094. </entrytbl>
  1095. </row>
  1096. <row><entry></entry></row>
  1097. <row id="v4l2-mpeg-audio-mode">
  1098. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant>&nbsp;</entry>
  1099. <entry>enum&nbsp;v4l2_mpeg_audio_mode</entry>
  1100. </row><row><entry spanname="descr">MPEG Audio mode.
  1101. Possible values are:</entry>
  1102. </row>
  1103. <row>
  1104. <entrytbl spanname="descr" cols="2">
  1105. <tbody valign="top">
  1106. <row>
  1107. <entry><constant>V4L2_MPEG_AUDIO_MODE_STEREO</constant>&nbsp;</entry>
  1108. <entry>Stereo</entry>
  1109. </row>
  1110. <row>
  1111. <entry><constant>V4L2_MPEG_AUDIO_MODE_JOINT_STEREO</constant>&nbsp;</entry>
  1112. <entry>Joint Stereo</entry>
  1113. </row>
  1114. <row>
  1115. <entry><constant>V4L2_MPEG_AUDIO_MODE_DUAL</constant>&nbsp;</entry>
  1116. <entry>Bilingual</entry>
  1117. </row>
  1118. <row>
  1119. <entry><constant>V4L2_MPEG_AUDIO_MODE_MONO</constant>&nbsp;</entry>
  1120. <entry>Mono</entry>
  1121. </row>
  1122. </tbody>
  1123. </entrytbl>
  1124. </row>
  1125. <row><entry></entry></row>
  1126. <row id="v4l2-mpeg-audio-mode-extension">
  1127. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant>&nbsp;</entry>
  1128. <entry>enum&nbsp;v4l2_mpeg_audio_mode_extension</entry>
  1129. </row><row><entry spanname="descr">Joint Stereo
  1130. audio mode extension. In Layer I and II they indicate which subbands
  1131. are in intensity stereo. All other subbands are coded in stereo. Layer
  1132. III is not (yet) supported. Possible values
  1133. are:</entry>
  1134. </row>
  1135. <row>
  1136. <entrytbl spanname="descr" cols="2">
  1137. <tbody valign="top">
  1138. <row>
  1139. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4</constant>&nbsp;</entry>
  1140. <entry>Subbands 4-31 in intensity stereo</entry>
  1141. </row>
  1142. <row>
  1143. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8</constant>&nbsp;</entry>
  1144. <entry>Subbands 8-31 in intensity stereo</entry>
  1145. </row>
  1146. <row>
  1147. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12</constant>&nbsp;</entry>
  1148. <entry>Subbands 12-31 in intensity stereo</entry>
  1149. </row>
  1150. <row>
  1151. <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16</constant>&nbsp;</entry>
  1152. <entry>Subbands 16-31 in intensity stereo</entry>
  1153. </row>
  1154. </tbody>
  1155. </entrytbl>
  1156. </row>
  1157. <row><entry></entry></row>
  1158. <row id="v4l2-mpeg-audio-emphasis">
  1159. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant>&nbsp;</entry>
  1160. <entry>enum&nbsp;v4l2_mpeg_audio_emphasis</entry>
  1161. </row><row><entry spanname="descr">Audio Emphasis.
  1162. Possible values are:</entry>
  1163. </row>
  1164. <row>
  1165. <entrytbl spanname="descr" cols="2">
  1166. <tbody valign="top">
  1167. <row>
  1168. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_NONE</constant>&nbsp;</entry>
  1169. <entry>None</entry>
  1170. </row>
  1171. <row>
  1172. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS</constant>&nbsp;</entry>
  1173. <entry>50/15 microsecond emphasis</entry>
  1174. </row>
  1175. <row>
  1176. <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17</constant>&nbsp;</entry>
  1177. <entry>CCITT J.17</entry>
  1178. </row>
  1179. </tbody>
  1180. </entrytbl>
  1181. </row>
  1182. <row><entry></entry></row>
  1183. <row id="v4l2-mpeg-audio-crc">
  1184. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant>&nbsp;</entry>
  1185. <entry>enum&nbsp;v4l2_mpeg_audio_crc</entry>
  1186. </row><row><entry spanname="descr">CRC method. Possible
  1187. values are:</entry>
  1188. </row>
  1189. <row>
  1190. <entrytbl spanname="descr" cols="2">
  1191. <tbody valign="top">
  1192. <row>
  1193. <entry><constant>V4L2_MPEG_AUDIO_CRC_NONE</constant>&nbsp;</entry>
  1194. <entry>None</entry>
  1195. </row>
  1196. <row>
  1197. <entry><constant>V4L2_MPEG_AUDIO_CRC_CRC16</constant>&nbsp;</entry>
  1198. <entry>16 bit parity check</entry>
  1199. </row>
  1200. </tbody>
  1201. </entrytbl>
  1202. </row>
  1203. <row><entry></entry></row>
  1204. <row>
  1205. <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant>&nbsp;</entry>
  1206. <entry>boolean</entry>
  1207. </row><row><entry spanname="descr">Mutes the audio when
  1208. capturing. This is not done by muting audio hardware, which can still
  1209. produce a slight hiss, but in the encoder itself, guaranteeing a fixed
  1210. and reproducible audio bitstream. 0 = unmuted, 1 = muted.</entry>
  1211. </row>
  1212. <row><entry></entry></row>
  1213. <row id="v4l2-mpeg-video-encoding">
  1214. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant>&nbsp;</entry>
  1215. <entry>enum&nbsp;v4l2_mpeg_video_encoding</entry>
  1216. </row><row><entry spanname="descr">MPEG Video encoding
  1217. method. This control is specific to multiplexed MPEG streams.
  1218. Possible values are:</entry>
  1219. </row>
  1220. <row>
  1221. <entrytbl spanname="descr" cols="2">
  1222. <tbody valign="top">
  1223. <row>
  1224. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_1</constant>&nbsp;</entry>
  1225. <entry>MPEG-1 Video encoding</entry>
  1226. </row>
  1227. <row>
  1228. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_2</constant>&nbsp;</entry>
  1229. <entry>MPEG-2 Video encoding</entry>
  1230. </row>
  1231. <row>
  1232. <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC</constant>&nbsp;</entry>
  1233. <entry>MPEG-4 AVC (H.264) Video encoding</entry>
  1234. </row>
  1235. </tbody>
  1236. </entrytbl>
  1237. </row>
  1238. <row><entry></entry></row>
  1239. <row id="v4l2-mpeg-video-aspect">
  1240. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant>&nbsp;</entry>
  1241. <entry>enum&nbsp;v4l2_mpeg_video_aspect</entry>
  1242. </row><row><entry spanname="descr">Video aspect.
  1243. Possible values are:</entry>
  1244. </row>
  1245. <row>
  1246. <entrytbl spanname="descr" cols="2">
  1247. <tbody valign="top">
  1248. <row>
  1249. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_1x1</constant>&nbsp;</entry>
  1250. </row>
  1251. <row>
  1252. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_4x3</constant>&nbsp;</entry>
  1253. </row>
  1254. <row>
  1255. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_16x9</constant>&nbsp;</entry>
  1256. </row>
  1257. <row>
  1258. <entry><constant>V4L2_MPEG_VIDEO_ASPECT_221x100</constant>&nbsp;</entry>
  1259. </row>
  1260. </tbody>
  1261. </entrytbl>
  1262. </row>
  1263. <row><entry></entry></row>
  1264. <row>
  1265. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_B_FRAMES</constant>&nbsp;</entry>
  1266. <entry>integer</entry>
  1267. </row><row><entry spanname="descr">Number of B-Frames
  1268. (default 2)</entry>
  1269. </row>
  1270. <row><entry></entry></row>
  1271. <row>
  1272. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_SIZE</constant>&nbsp;</entry>
  1273. <entry>integer</entry>
  1274. </row><row><entry spanname="descr">GOP size (default
  1275. 12)</entry>
  1276. </row>
  1277. <row><entry></entry></row>
  1278. <row>
  1279. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant>&nbsp;</entry>
  1280. <entry>boolean</entry>
  1281. </row><row><entry spanname="descr">GOP closure (default
  1282. 1)</entry>
  1283. </row>
  1284. <row><entry></entry></row>
  1285. <row>
  1286. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant>&nbsp;</entry>
  1287. <entry>boolean</entry>
  1288. </row><row><entry spanname="descr">Enable 3:2 pulldown
  1289. (default 0)</entry>
  1290. </row>
  1291. <row><entry></entry></row>
  1292. <row id="v4l2-mpeg-video-bitrate-mode">
  1293. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant>&nbsp;</entry>
  1294. <entry>enum&nbsp;v4l2_mpeg_video_bitrate_mode</entry>
  1295. </row><row><entry spanname="descr">Video bitrate mode.
  1296. Possible values are:</entry>
  1297. </row>
  1298. <row>
  1299. <entrytbl spanname="descr" cols="2">
  1300. <tbody valign="top">
  1301. <row>
  1302. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_VBR</constant>&nbsp;</entry>
  1303. <entry>Variable bitrate</entry>
  1304. </row>
  1305. <row>
  1306. <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_CBR</constant>&nbsp;</entry>
  1307. <entry>Constant bitrate</entry>
  1308. </row>
  1309. </tbody>
  1310. </entrytbl>
  1311. </row>
  1312. <row><entry></entry></row>
  1313. <row>
  1314. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE</constant>&nbsp;</entry>
  1315. <entry>integer</entry>
  1316. </row><row><entry spanname="descr">Video bitrate in bits
  1317. per second.</entry>
  1318. </row>
  1319. <row><entry></entry></row>
  1320. <row>
  1321. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_PEAK</constant>&nbsp;</entry>
  1322. <entry>integer</entry>
  1323. </row><row><entry spanname="descr">Peak video bitrate in
  1324. bits per second. Must be larger or equal to the average video bitrate.
  1325. It is ignored if the video bitrate mode is set to constant
  1326. bitrate.</entry>
  1327. </row>
  1328. <row><entry></entry></row>
  1329. <row>
  1330. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION</constant>&nbsp;</entry>
  1331. <entry>integer</entry>
  1332. </row><row><entry spanname="descr">For every captured
  1333. frame, skip this many subsequent frames (default 0).</entry>
  1334. </row>
  1335. <row><entry></entry></row>
  1336. <row>
  1337. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant>&nbsp;</entry>
  1338. <entry>boolean</entry>
  1339. </row>
  1340. <row><entry spanname="descr">"Mutes" the video to a
  1341. fixed color when capturing. This is useful for testing, to produce a
  1342. fixed video bitstream. 0 = unmuted, 1 = muted.</entry>
  1343. </row>
  1344. <row><entry></entry></row>
  1345. <row>
  1346. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE_YUV</constant>&nbsp;</entry>
  1347. <entry>integer</entry>
  1348. </row><row><entry spanname="descr">Sets the "mute" color
  1349. of the video. The supplied 32-bit integer is interpreted as follows (bit
  1350. 0 = least significant bit):</entry>
  1351. </row>
  1352. <row>
  1353. <entrytbl spanname="descr" cols="2">
  1354. <tbody valign="top">
  1355. <row>
  1356. <entry>Bit 0:7</entry>
  1357. <entry>V chrominance information</entry>
  1358. </row>
  1359. <row>
  1360. <entry>Bit 8:15</entry>
  1361. <entry>U chrominance information</entry>
  1362. </row>
  1363. <row>
  1364. <entry>Bit 16:23</entry>
  1365. <entry>Y luminance information</entry>
  1366. </row>
  1367. <row>
  1368. <entry>Bit 24:31</entry>
  1369. <entry>Must be zero.</entry>
  1370. </row>
  1371. </tbody>
  1372. </entrytbl>
  1373. </row>
  1374. <row><entry></entry></row>
  1375. <row>
  1376. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE</constant>&nbsp;</entry>
  1377. <entry>boolean</entry>
  1378. </row>
  1379. <row><entry spanname="descr">If enabled the decoder expects to receive a single slice per buffer, otherwise
  1380. the decoder expects a single frame in per buffer. Applicable to the decoder, all codecs.
  1381. </entry>
  1382. </row>
  1383. <row><entry></entry></row>
  1384. <row>
  1385. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE</constant>&nbsp;</entry>
  1386. <entry>boolean</entry>
  1387. </row>
  1388. <row><entry spanname="descr">Enable writing sample aspect ratio in the Video Usability Information.
  1389. Applicable to the H264 encoder.</entry>
  1390. </row>
  1391. <row><entry></entry></row>
  1392. <row>
  1393. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC</constant>&nbsp;</entry>
  1394. <entry>enum&nbsp;v4l2_mpeg_video_h264_vui_sar_idc</entry>
  1395. </row>
  1396. <row><entry spanname="descr">VUI sample aspect ratio indicator for H.264 encoding. The value
  1397. is defined in the table E-1 in the standard. Applicable to the H264 encoder.</entry>
  1398. </row>
  1399. <row>
  1400. <entrytbl spanname="descr" cols="2">
  1401. <tbody valign="top">
  1402. <row>
  1403. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED</constant>&nbsp;</entry>
  1404. <entry>Unspecified</entry>
  1405. </row>
  1406. <row>
  1407. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1</constant>&nbsp;</entry>
  1408. <entry>1x1</entry>
  1409. </row>
  1410. <row>
  1411. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11</constant>&nbsp;</entry>
  1412. <entry>12x11</entry>
  1413. </row>
  1414. <row>
  1415. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11</constant>&nbsp;</entry>
  1416. <entry>10x11</entry>
  1417. </row>
  1418. <row>
  1419. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11</constant>&nbsp;</entry>
  1420. <entry>16x11</entry>
  1421. </row>
  1422. <row>
  1423. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33</constant>&nbsp;</entry>
  1424. <entry>40x33</entry>
  1425. </row>
  1426. <row>
  1427. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11</constant>&nbsp;</entry>
  1428. <entry>24x11</entry>
  1429. </row>
  1430. <row>
  1431. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11</constant>&nbsp;</entry>
  1432. <entry>20x11</entry>
  1433. </row>
  1434. <row>
  1435. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11</constant>&nbsp;</entry>
  1436. <entry>32x11</entry>
  1437. </row>
  1438. <row>
  1439. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33</constant>&nbsp;</entry>
  1440. <entry>80x33</entry>
  1441. </row>
  1442. <row>
  1443. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11</constant>&nbsp;</entry>
  1444. <entry>18x11</entry>
  1445. </row>
  1446. <row>
  1447. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11</constant>&nbsp;</entry>
  1448. <entry>15x11</entry>
  1449. </row>
  1450. <row>
  1451. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33</constant>&nbsp;</entry>
  1452. <entry>64x33</entry>
  1453. </row>
  1454. <row>
  1455. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99</constant>&nbsp;</entry>
  1456. <entry>160x99</entry>
  1457. </row>
  1458. <row>
  1459. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3</constant>&nbsp;</entry>
  1460. <entry>4x3</entry>
  1461. </row>
  1462. <row>
  1463. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2</constant>&nbsp;</entry>
  1464. <entry>3x2</entry>
  1465. </row>
  1466. <row>
  1467. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1</constant>&nbsp;</entry>
  1468. <entry>2x1</entry>
  1469. </row>
  1470. <row>
  1471. <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED</constant>&nbsp;</entry>
  1472. <entry>Extended SAR</entry>
  1473. </row>
  1474. </tbody>
  1475. </entrytbl>
  1476. </row>
  1477. <row><entry></entry></row>
  1478. <row>
  1479. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH</constant>&nbsp;</entry>
  1480. <entry>integer</entry>
  1481. </row>
  1482. <row><entry spanname="descr">Extended sample aspect ratio width for H.264 VUI encoding.
  1483. Applicable to the H264 encoder.</entry>
  1484. </row>
  1485. <row><entry></entry></row>
  1486. <row>
  1487. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT</constant>&nbsp;</entry>
  1488. <entry>integer</entry>
  1489. </row>
  1490. <row><entry spanname="descr">Extended sample aspect ratio height for H.264 VUI encoding.
  1491. Applicable to the H264 encoder.</entry>
  1492. </row>
  1493. <row><entry></entry></row>
  1494. <row>
  1495. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LEVEL</constant>&nbsp;</entry>
  1496. <entry>enum&nbsp;v4l2_mpeg_video_h264_level</entry>
  1497. </row>
  1498. <row><entry spanname="descr">The level information for the H264 video elementary stream.
  1499. Applicable to the H264 encoder.
  1500. Possible values are:</entry>
  1501. </row>
  1502. <row>
  1503. <entrytbl spanname="descr" cols="2">
  1504. <tbody valign="top">
  1505. <row>
  1506. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_0</constant>&nbsp;</entry>
  1507. <entry>Level 1.0</entry>
  1508. </row>
  1509. <row>
  1510. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1B</constant>&nbsp;</entry>
  1511. <entry>Level 1B</entry>
  1512. </row>
  1513. <row>
  1514. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_1</constant>&nbsp;</entry>
  1515. <entry>Level 1.1</entry>
  1516. </row>
  1517. <row>
  1518. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_2</constant>&nbsp;</entry>
  1519. <entry>Level 1.2</entry>
  1520. </row>
  1521. <row>
  1522. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_3</constant>&nbsp;</entry>
  1523. <entry>Level 1.3</entry>
  1524. </row>
  1525. <row>
  1526. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_0</constant>&nbsp;</entry>
  1527. <entry>Level 2.0</entry>
  1528. </row>
  1529. <row>
  1530. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_1</constant>&nbsp;</entry>
  1531. <entry>Level 2.1</entry>
  1532. </row>
  1533. <row>
  1534. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_2</constant>&nbsp;</entry>
  1535. <entry>Level 2.2</entry>
  1536. </row>
  1537. <row>
  1538. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_0</constant>&nbsp;</entry>
  1539. <entry>Level 3.0</entry>
  1540. </row>
  1541. <row>
  1542. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_1</constant>&nbsp;</entry>
  1543. <entry>Level 3.1</entry>
  1544. </row>
  1545. <row>
  1546. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_2</constant>&nbsp;</entry>
  1547. <entry>Level 3.2</entry>
  1548. </row>
  1549. <row>
  1550. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_0</constant>&nbsp;</entry>
  1551. <entry>Level 4.0</entry>
  1552. </row>
  1553. <row>
  1554. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_1</constant>&nbsp;</entry>
  1555. <entry>Level 4.1</entry>
  1556. </row>
  1557. <row>
  1558. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_2</constant>&nbsp;</entry>
  1559. <entry>Level 4.2</entry>
  1560. </row>
  1561. <row>
  1562. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_0</constant>&nbsp;</entry>
  1563. <entry>Level 5.0</entry>
  1564. </row>
  1565. <row>
  1566. <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_1</constant>&nbsp;</entry>
  1567. <entry>Level 5.1</entry>
  1568. </row>
  1569. </tbody>
  1570. </entrytbl>
  1571. </row>
  1572. <row><entry></entry></row>
  1573. <row>
  1574. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL</constant>&nbsp;</entry>
  1575. <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_level</entry>
  1576. </row>
  1577. <row><entry spanname="descr">The level information for the MPEG4 elementary stream.
  1578. Applicable to the MPEG4 encoder.
  1579. Possible values are:</entry>
  1580. </row>
  1581. <row>
  1582. <entrytbl spanname="descr" cols="2">
  1583. <tbody valign="top">
  1584. <row>
  1585. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0</constant>&nbsp;</entry>
  1586. <entry>Level 0</entry>
  1587. </row>
  1588. <row>
  1589. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0B</constant>&nbsp;</entry>
  1590. <entry>Level 0b</entry>
  1591. </row>
  1592. <row>
  1593. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_1</constant>&nbsp;</entry>
  1594. <entry>Level 1</entry>
  1595. </row>
  1596. <row>
  1597. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_2</constant>&nbsp;</entry>
  1598. <entry>Level 2</entry>
  1599. </row>
  1600. <row>
  1601. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3</constant>&nbsp;</entry>
  1602. <entry>Level 3</entry>
  1603. </row>
  1604. <row>
  1605. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3B</constant>&nbsp;</entry>
  1606. <entry>Level 3b</entry>
  1607. </row>
  1608. <row>
  1609. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_4</constant>&nbsp;</entry>
  1610. <entry>Level 4</entry>
  1611. </row>
  1612. <row>
  1613. <entry><constant>V4L2_MPEG_VIDEO_LEVEL_5</constant>&nbsp;</entry>
  1614. <entry>Level 5</entry>
  1615. </row>
  1616. </tbody>
  1617. </entrytbl>
  1618. </row>
  1619. <row><entry></entry></row>
  1620. <row>
  1621. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_PROFILE</constant>&nbsp;</entry>
  1622. <entry>enum&nbsp;v4l2_mpeg_h264_profile</entry>
  1623. </row>
  1624. <row><entry spanname="descr">The profile information for H264.
  1625. Applicable to the H264 encoder.
  1626. Possible values are:</entry>
  1627. </row>
  1628. <row>
  1629. <entrytbl spanname="descr" cols="2">
  1630. <tbody valign="top">
  1631. <row>
  1632. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE</constant>&nbsp;</entry>
  1633. <entry>Baseline profile</entry>
  1634. </row>
  1635. <row>
  1636. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE</constant>&nbsp;</entry>
  1637. <entry>Constrained Baseline profile</entry>
  1638. </row>
  1639. <row>
  1640. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MAIN</constant>&nbsp;</entry>
  1641. <entry>Main profile</entry>
  1642. </row>
  1643. <row>
  1644. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED</constant>&nbsp;</entry>
  1645. <entry>Extended profile</entry>
  1646. </row>
  1647. <row>
  1648. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH</constant>&nbsp;</entry>
  1649. <entry>High profile</entry>
  1650. </row>
  1651. <row>
  1652. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10</constant>&nbsp;</entry>
  1653. <entry>High 10 profile</entry>
  1654. </row>
  1655. <row>
  1656. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422</constant>&nbsp;</entry>
  1657. <entry>High 422 profile</entry>
  1658. </row>
  1659. <row>
  1660. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE</constant>&nbsp;</entry>
  1661. <entry>High 444 Predictive profile</entry>
  1662. </row>
  1663. <row>
  1664. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA</constant>&nbsp;</entry>
  1665. <entry>High 10 Intra profile</entry>
  1666. </row>
  1667. <row>
  1668. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA</constant>&nbsp;</entry>
  1669. <entry>High 422 Intra profile</entry>
  1670. </row>
  1671. <row>
  1672. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA</constant>&nbsp;</entry>
  1673. <entry>High 444 Intra profile</entry>
  1674. </row>
  1675. <row>
  1676. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA</constant>&nbsp;</entry>
  1677. <entry>CAVLC 444 Intra profile</entry>
  1678. </row>
  1679. <row>
  1680. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE</constant>&nbsp;</entry>
  1681. <entry>Scalable Baseline profile</entry>
  1682. </row>
  1683. <row>
  1684. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH</constant>&nbsp;</entry>
  1685. <entry>Scalable High profile</entry>
  1686. </row>
  1687. <row>
  1688. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA</constant>&nbsp;</entry>
  1689. <entry>Scalable High Intra profile</entry>
  1690. </row>
  1691. <row>
  1692. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH</constant>&nbsp;</entry>
  1693. <entry>Stereo High profile</entry>
  1694. </row>
  1695. <row>
  1696. <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH</constant>&nbsp;</entry>
  1697. <entry>Multiview High profile</entry>
  1698. </row>
  1699. </tbody>
  1700. </entrytbl>
  1701. </row>
  1702. <row><entry></entry></row>
  1703. <row>
  1704. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE</constant>&nbsp;</entry>
  1705. <entry>enum&nbsp;v4l2_mpeg_mpeg4_profile</entry>
  1706. </row>
  1707. <row><entry spanname="descr">The profile information for MPEG4.
  1708. Applicable to the MPEG4 encoder.
  1709. Possible values are:</entry>
  1710. </row>
  1711. <row>
  1712. <entrytbl spanname="descr" cols="2">
  1713. <tbody valign="top">
  1714. <row>
  1715. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE</constant>&nbsp;</entry>
  1716. <entry>Simple profile</entry>
  1717. </row>
  1718. <row>
  1719. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_SIMPLE</constant>&nbsp;</entry>
  1720. <entry>Advanced Simple profile</entry>
  1721. </row>
  1722. <row>
  1723. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_CORE</constant>&nbsp;</entry>
  1724. <entry>Core profile</entry>
  1725. </row>
  1726. <row>
  1727. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE_SCALABLE</constant>&nbsp;</entry>
  1728. <entry>Simple Scalable profile</entry>
  1729. </row>
  1730. <row>
  1731. <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_CODING_EFFICIENCY</constant>&nbsp;</entry>
  1732. <entry></entry>
  1733. </row>
  1734. </tbody>
  1735. </entrytbl>
  1736. </row>
  1737. <row><entry></entry></row>
  1738. <row>
  1739. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MAX_REF_PIC</constant>&nbsp;</entry>
  1740. <entry>integer</entry>
  1741. </row>
  1742. <row><entry spanname="descr">The maximum number of reference pictures used for encoding.
  1743. Applicable to the encoder.
  1744. </entry>
  1745. </row>
  1746. <row><entry></entry></row>
  1747. <row>
  1748. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant>&nbsp;</entry>
  1749. <entry>enum&nbsp;v4l2_mpeg_multi_slice_mode</entry>
  1750. </row>
  1751. <row><entry spanname="descr">Determines how the encoder should handle division of frame into slices.
  1752. Applicable to the encoder.
  1753. Possible values are:</entry>
  1754. </row>
  1755. <row>
  1756. <entrytbl spanname="descr" cols="2">
  1757. <tbody valign="top">
  1758. <row>
  1759. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE</constant>&nbsp;</entry>
  1760. <entry>Single slice per frame.</entry>
  1761. </row>
  1762. <row>
  1763. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>&nbsp;</entry>
  1764. <entry>Multiple slices with set maximum number of macroblocks per slice.</entry>
  1765. </row>
  1766. <row>
  1767. <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>&nbsp;</entry>
  1768. <entry>Multiple slice with set maximum size in bytes per slice.</entry>
  1769. </row>
  1770. </tbody>
  1771. </entrytbl>
  1772. </row>
  1773. <row><entry></entry></row>
  1774. <row>
  1775. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB</constant>&nbsp;</entry>
  1776. <entry>integer</entry>
  1777. </row>
  1778. <row><entry spanname="descr">The maximum number of macroblocks in a slice. Used when
  1779. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>.
  1780. Applicable to the encoder.</entry>
  1781. </row>
  1782. <row><entry></entry></row>
  1783. <row>
  1784. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES</constant>&nbsp;</entry>
  1785. <entry>integer</entry>
  1786. </row>
  1787. <row><entry spanname="descr">The maximum size of a slice in bytes. Used when
  1788. <constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>.
  1789. Applicable to the encoder.</entry>
  1790. </row>
  1791. <row><entry></entry></row>
  1792. <row>
  1793. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE</constant>&nbsp;</entry>
  1794. <entry>enum&nbsp;v4l2_mpeg_h264_loop_filter_mode</entry>
  1795. </row>
  1796. <row><entry spanname="descr">Loop filter mode for H264 encoder.
  1797. Possible values are:</entry>
  1798. </row>
  1799. <row>
  1800. <entrytbl spanname="descr" cols="2">
  1801. <tbody valign="top">
  1802. <row>
  1803. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED</constant>&nbsp;</entry>
  1804. <entry>Loop filter is enabled.</entry>
  1805. </row>
  1806. <row>
  1807. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED</constant>&nbsp;</entry>
  1808. <entry>Loop filter is disabled.</entry>
  1809. </row>
  1810. <row>
  1811. <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY</constant>&nbsp;</entry>
  1812. <entry>Loop filter is disabled at the slice boundary.</entry>
  1813. </row>
  1814. </tbody>
  1815. </entrytbl>
  1816. </row>
  1817. <row><entry></entry></row>
  1818. <row>
  1819. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA</constant>&nbsp;</entry>
  1820. <entry>integer</entry>
  1821. </row>
  1822. <row><entry spanname="descr">Loop filter alpha coefficient, defined in the H264 standard.
  1823. Applicable to the H264 encoder.</entry>
  1824. </row>
  1825. <row><entry></entry></row>
  1826. <row>
  1827. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA</constant>&nbsp;</entry>
  1828. <entry>integer</entry>
  1829. </row>
  1830. <row><entry spanname="descr">Loop filter beta coefficient, defined in the H264 standard.
  1831. Applicable to the H264 encoder.</entry>
  1832. </row>
  1833. <row><entry></entry></row>
  1834. <row>
  1835. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE</constant>&nbsp;</entry>
  1836. <entry>enum&nbsp;v4l2_mpeg_h264_symbol_mode</entry>
  1837. </row>
  1838. <row><entry spanname="descr">Entropy coding mode for H264 - CABAC/CAVALC.
  1839. Applicable to the H264 encoder.
  1840. Possible values are:</entry>
  1841. </row>
  1842. <row>
  1843. <entrytbl spanname="descr" cols="2">
  1844. <tbody valign="top">
  1845. <row>
  1846. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC</constant>&nbsp;</entry>
  1847. <entry>Use CAVLC entropy coding.</entry>
  1848. </row>
  1849. <row>
  1850. <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC</constant>&nbsp;</entry>
  1851. <entry>Use CABAC entropy coding.</entry>
  1852. </row>
  1853. </tbody>
  1854. </entrytbl>
  1855. </row>
  1856. <row><entry></entry></row>
  1857. <row>
  1858. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM</constant>&nbsp;</entry>
  1859. <entry>boolean</entry>
  1860. </row>
  1861. <row><entry spanname="descr">Enable 8X8 transform for H264. Applicable to the H264 encoder.</entry>
  1862. </row>
  1863. <row><entry></entry></row>
  1864. <row>
  1865. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB</constant>&nbsp;</entry>
  1866. <entry>integer</entry>
  1867. </row>
  1868. <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks
  1869. refreshed every frame. Each frame a succesive set of macroblocks is refreshed until the cycle completes and starts from the
  1870. top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry>
  1871. </row>
  1872. <row><entry></entry></row>
  1873. <row>
  1874. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE</constant>&nbsp;</entry>
  1875. <entry>boolean</entry>
  1876. </row>
  1877. <row><entry spanname="descr">Frame level rate control enable.
  1878. If this control is disabled then the quantization parameter for each frame type is constant and set with appropriate controls
  1879. (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>).
  1880. If frame rate control is enabled then quantization parameter is adjusted to meet the chosen bitrate. Minimum and maximum value
  1881. for the quantization parameter can be set with appropriate controls (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>).
  1882. Applicable to encoders.</entry>
  1883. </row>
  1884. <row><entry></entry></row>
  1885. <row>
  1886. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>&nbsp;</entry>
  1887. <entry>boolean</entry>
  1888. </row>
  1889. <row><entry spanname="descr">Macroblock level rate control enable.
  1890. Applicable to the MPEG4 and H264 encoders.</entry>
  1891. </row>
  1892. <row><entry></entry></row>
  1893. <row>
  1894. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_QPEL</constant>&nbsp;</entry>
  1895. <entry>boolean</entry>
  1896. </row>
  1897. <row><entry spanname="descr">Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 encoder.</entry>
  1898. </row>
  1899. <row><entry></entry></row>
  1900. <row>
  1901. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>&nbsp;</entry>
  1902. <entry>integer</entry>
  1903. </row>
  1904. <row><entry spanname="descr">Quantization parameter for an I frame for H263. Valid range: from 1 to 31.</entry>
  1905. </row>
  1906. <row><entry></entry></row>
  1907. <row>
  1908. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>&nbsp;</entry>
  1909. <entry>integer</entry>
  1910. </row>
  1911. <row><entry spanname="descr">Minimum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  1912. </row>
  1913. <row><entry></entry></row>
  1914. <row>
  1915. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MAX_QP</constant>&nbsp;</entry>
  1916. <entry>integer</entry>
  1917. </row>
  1918. <row><entry spanname="descr">Maximum quantization parameter for H263. Valid range: from 1 to 31.</entry>
  1919. </row>
  1920. <row><entry></entry></row>
  1921. <row>
  1922. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP</constant>&nbsp;</entry>
  1923. <entry>integer</entry>
  1924. </row>
  1925. <row><entry spanname="descr">Quantization parameter for an P frame for H263. Valid range: from 1 to 31.</entry>
  1926. </row>
  1927. <row><entry></entry></row>
  1928. <row>
  1929. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP</constant>&nbsp;</entry>
  1930. <entry>integer</entry>
  1931. </row>
  1932. <row><entry spanname="descr">Quantization parameter for an B frame for H263. Valid range: from 1 to 31.</entry>
  1933. </row>
  1934. <row><entry></entry></row>
  1935. <row>
  1936. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP</constant>&nbsp;</entry>
  1937. <entry>integer</entry>
  1938. </row>
  1939. <row><entry spanname="descr">Quantization parameter for an I frame for H264. Valid range: from 0 to 51.</entry>
  1940. </row>
  1941. <row><entry></entry></row>
  1942. <row>
  1943. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MIN_QP</constant>&nbsp;</entry>
  1944. <entry>integer</entry>
  1945. </row>
  1946. <row><entry spanname="descr">Minimum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  1947. </row>
  1948. <row><entry></entry></row>
  1949. <row>
  1950. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MAX_QP</constant>&nbsp;</entry>
  1951. <entry>integer</entry>
  1952. </row>
  1953. <row><entry spanname="descr">Maximum quantization parameter for H264. Valid range: from 0 to 51.</entry>
  1954. </row>
  1955. <row><entry></entry></row>
  1956. <row>
  1957. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP</constant>&nbsp;</entry>
  1958. <entry>integer</entry>
  1959. </row>
  1960. <row><entry spanname="descr">Quantization parameter for an P frame for H264. Valid range: from 0 to 51.</entry>
  1961. </row>
  1962. <row><entry></entry></row>
  1963. <row>
  1964. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP</constant>&nbsp;</entry>
  1965. <entry>integer</entry>
  1966. </row>
  1967. <row><entry spanname="descr">Quantization parameter for an B frame for H264. Valid range: from 0 to 51.</entry>
  1968. </row>
  1969. <row><entry></entry></row>
  1970. <row>
  1971. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP</constant>&nbsp;</entry>
  1972. <entry>integer</entry>
  1973. </row>
  1974. <row><entry spanname="descr">Quantization parameter for an I frame for MPEG4. Valid range: from 1 to 31.</entry>
  1975. </row>
  1976. <row><entry></entry></row>
  1977. <row>
  1978. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP</constant>&nbsp;</entry>
  1979. <entry>integer</entry>
  1980. </row>
  1981. <row><entry spanname="descr">Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  1982. </row>
  1983. <row><entry></entry></row>
  1984. <row>
  1985. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP</constant>&nbsp;</entry>
  1986. <entry>integer</entry>
  1987. </row>
  1988. <row><entry spanname="descr">Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
  1989. </row>
  1990. <row><entry></entry></row>
  1991. <row>
  1992. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP</constant>&nbsp;</entry>
  1993. <entry>integer</entry>
  1994. </row>
  1995. <row><entry spanname="descr">Quantization parameter for an P frame for MPEG4. Valid range: from 1 to 31.</entry>
  1996. </row>
  1997. <row><entry></entry></row>
  1998. <row>
  1999. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP</constant>&nbsp;</entry>
  2000. <entry>integer</entry>
  2001. </row>
  2002. <row><entry spanname="descr">Quantization parameter for an B frame for MPEG4. Valid range: from 1 to 31.</entry>
  2003. </row>
  2004. <row><entry></entry></row>
  2005. <row>
  2006. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_SIZE</constant>&nbsp;</entry>
  2007. <entry>integer</entry>
  2008. </row>
  2009. <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip.
  2010. The VBV is defined in the standard as a mean to verify that the produced stream will be succesfully decoded.
  2011. The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the
  2012. output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an
  2013. encoder or editing process may produce.".
  2014. Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry>
  2015. </row>
  2016. <row><entry></entry></row>
  2017. <row>
  2018. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE</constant>&nbsp;</entry>
  2019. <entry>integer</entry>
  2020. </row>
  2021. <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip.
  2022. The CPB is defined in the H264 standard as a mean to verify that the produced stream will be succesfully decoded.
  2023. Applicable to the H264 encoder.</entry>
  2024. </row>
  2025. <row><entry></entry></row>
  2026. <row>
  2027. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_PERIOD</constant>&nbsp;</entry>
  2028. <entry>integer</entry>
  2029. </row>
  2030. <row><entry spanname="descr">Period between I-frames in the open GOP for H264. In case of an open GOP
  2031. this is the period between two I-frames. The period between IDR (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE control.
  2032. An IDR frame, which stands for Instantaneous Decoding Refresh is an I-frame after which no prior frames are
  2033. referenced. This means that a stream can be restarted from an IDR frame without the need to store or decode any
  2034. previous frames. Applicable to the H264 encoder.</entry>
  2035. </row>
  2036. <row><entry></entry></row>
  2037. <row>
  2038. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_HEADER_MODE</constant>&nbsp;</entry>
  2039. <entry>enum&nbsp;v4l2_mpeg_header_mode</entry>
  2040. </row>
  2041. <row><entry spanname="descr">Determines whether the header is returned as the first buffer or is
  2042. it returned together with the first frame. Applicable to encoders.
  2043. Possible values are:</entry>
  2044. </row>
  2045. <row>
  2046. <entrytbl spanname="descr" cols="2">
  2047. <tbody valign="top">
  2048. <row>
  2049. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE</constant>&nbsp;</entry>
  2050. <entry>The stream header is returned separately in the first buffer.</entry>
  2051. </row>
  2052. <row>
  2053. <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME</constant>&nbsp;</entry>
  2054. <entry>The stream header is returned together with the first encoded frame.</entry>
  2055. </row>
  2056. </tbody>
  2057. </entrytbl>
  2058. </row>
  2059. <row><entry></entry></row>
  2060. <row>
  2061. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER</constant>&nbsp;</entry>
  2062. <entry>boolean</entry>
  2063. </row><row><entry spanname="descr">Enabled the deblocking post processing filter for MPEG4 decoder.
  2064. Applicable to the MPEG4 decoder.</entry>
  2065. </row>
  2066. <row><entry></entry></row>
  2067. <row>
  2068. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES</constant>&nbsp;</entry>
  2069. <entry>integer</entry>
  2070. </row><row><entry spanname="descr">vop_time_increment_resolution value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2071. </row>
  2072. <row><entry></entry></row>
  2073. <row>
  2074. <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC</constant>&nbsp;</entry>
  2075. <entry>integer</entry>
  2076. </row><row><entry spanname="descr">vop_time_increment value for MPEG4. Applicable to the MPEG4 encoder.</entry>
  2077. </row>
  2078. </tbody>
  2079. </tgroup>
  2080. </table>
  2081. </section>
  2082. <section>
  2083. <title>MFC 5.1 MPEG Controls</title>
  2084. <para>The following MPEG class controls deal with MPEG
  2085. decoding and encoding settings that are specific to the Multi Format Codec 5.1 device present
  2086. in the S5P family of SoCs by Samsung.
  2087. </para>
  2088. <table pgwide="1" frame="none" id="mfc51-control-id">
  2089. <title>MFC 5.1 Control IDs</title>
  2090. <tgroup cols="4">
  2091. <colspec colname="c1" colwidth="1*" />
  2092. <colspec colname="c2" colwidth="6*" />
  2093. <colspec colname="c3" colwidth="2*" />
  2094. <colspec colname="c4" colwidth="6*" />
  2095. <spanspec namest="c1" nameend="c2" spanname="id" />
  2096. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2097. <thead>
  2098. <row>
  2099. <entry spanname="id" align="left">ID</entry>
  2100. <entry align="left">Type</entry>
  2101. </row><row><entry spanname="descr" align="left">Description</entry>
  2102. </row>
  2103. </thead>
  2104. <tbody valign="top">
  2105. <row><entry></entry></row>
  2106. <row>
  2107. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant>&nbsp;</entry>
  2108. <entry>integer</entry>
  2109. </row><row><entry spanname="descr">If the display delay is enabled then the decoder has to return a
  2110. CAPTURE buffer after processing a certain number of OUTPUT buffers. If this number is low, then it may result in
  2111. buffers not being dequeued in display order. In addition hardware may still use those buffers as reference, thus
  2112. application should not write to those buffers. This feature can be used for example for generating thumbnails of videos.
  2113. Applicable to the H264 decoder.
  2114. </entry>
  2115. </row>
  2116. <row><entry></entry></row>
  2117. <row>
  2118. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>&nbsp;</entry>
  2119. <entry>integer</entry>
  2120. </row><row><entry spanname="descr">Display delay value for H264 decoder.
  2121. The decoder is forced to return a decoded frame after the set 'display delay' number of frames. If this number is
  2122. low it may result in frames returned out of dispaly order, in addition the hardware may still be using the returned buffer
  2123. as a reference picture for subsequent frames.
  2124. </entry>
  2125. </row>
  2126. <row><entry></entry></row>
  2127. <row>
  2128. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P</constant>&nbsp;</entry>
  2129. <entry>integer</entry>
  2130. </row><row><entry spanname="descr">The number of reference pictures used for encoding a P picture.
  2131. Applicable to the H264 encoder.</entry>
  2132. </row>
  2133. <row><entry></entry></row>
  2134. <row>
  2135. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING</constant>&nbsp;</entry>
  2136. <entry>boolean</entry>
  2137. </row><row><entry spanname="descr">Padding enable in the encoder - use a color instead of repeating border pixels.
  2138. Applicable to encoders.</entry>
  2139. </row>
  2140. <row><entry></entry></row>
  2141. <row>
  2142. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV</constant>&nbsp;</entry>
  2143. <entry>integer</entry>
  2144. </row><row><entry spanname="descr">Padding color in the encoder. Applicable to encoders. The supplied 32-bit integer is interpreted as follows (bit
  2145. 0 = least significant bit):</entry>
  2146. </row>
  2147. <row>
  2148. <entrytbl spanname="descr" cols="2">
  2149. <tbody valign="top">
  2150. <row>
  2151. <entry>Bit 0:7</entry>
  2152. <entry>V chrominance information</entry>
  2153. </row>
  2154. <row>
  2155. <entry>Bit 8:15</entry>
  2156. <entry>U chrominance information</entry>
  2157. </row>
  2158. <row>
  2159. <entry>Bit 16:23</entry>
  2160. <entry>Y luminance information</entry>
  2161. </row>
  2162. <row>
  2163. <entry>Bit 24:31</entry>
  2164. <entry>Must be zero.</entry>
  2165. </row>
  2166. </tbody>
  2167. </entrytbl>
  2168. </row>
  2169. <row><entry></entry></row>
  2170. <row>
  2171. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF</constant>&nbsp;</entry>
  2172. <entry>integer</entry>
  2173. </row><row><entry spanname="descr">Reaction coefficient for MFC rate control. Applicable to encoders.
  2174. <para>Note 1: Valid only when the frame level RC is enabled.</para>
  2175. <para>Note 2: For tight CBR, this field must be small (ex. 2 ~ 10).
  2176. For VBR, this field must be large (ex. 100 ~ 1000).</para>
  2177. <para>Note 3: It is not recommended to use the greater number than FRAME_RATE * (10^9 / BIT_RATE).</para>
  2178. </entry>
  2179. </row>
  2180. <row><entry></entry></row>
  2181. <row>
  2182. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK</constant>&nbsp;</entry>
  2183. <entry>boolean</entry>
  2184. </row><row><entry spanname="descr">Adaptive rate control for dark region.
  2185. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2186. Applicable to the H264 encoder.</entry>
  2187. </row>
  2188. <row><entry></entry></row>
  2189. <row>
  2190. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH</constant>&nbsp;</entry>
  2191. <entry>boolean</entry>
  2192. </row><row><entry spanname="descr">Adaptive rate control for smooth region.
  2193. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2194. Applicable to the H264 encoder.</entry>
  2195. </row>
  2196. <row><entry></entry></row>
  2197. <row>
  2198. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC</constant>&nbsp;</entry>
  2199. <entry>boolean</entry>
  2200. </row><row><entry spanname="descr">Adaptive rate control for static region.
  2201. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2202. Applicable to the H264 encoder.</entry>
  2203. </row>
  2204. <row><entry></entry></row>
  2205. <row>
  2206. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY</constant>&nbsp;</entry>
  2207. <entry>boolean</entry>
  2208. </row><row><entry spanname="descr">Adaptive rate control for activity region.
  2209. Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
  2210. Applicable to the H264 encoder.</entry>
  2211. </row>
  2212. <row><entry></entry></row>
  2213. <row>
  2214. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE</constant>&nbsp;</entry>
  2215. <entry>enum&nbsp;v4l2_mpeg_mfc51_frame_skip_mode</entry>
  2216. </row>
  2217. <row><entry spanname="descr">
  2218. Indicates in what conditions the encoder should skip frames. If encoding a frame would cause the encoded stream to be larger then
  2219. a chosen data limit then the frame will be skipped.
  2220. Possible values are:</entry>
  2221. </row>
  2222. <row>
  2223. <entrytbl spanname="descr" cols="2">
  2224. <tbody valign="top">
  2225. <row>
  2226. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED</constant>&nbsp;</entry>
  2227. <entry>Frame skip mode is disabled.</entry>
  2228. </row>
  2229. <row>
  2230. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT</constant>&nbsp;</entry>
  2231. <entry>Frame skip mode enabled and buffer limit is set by the chosen level and is defined by the standard.</entry>
  2232. </row>
  2233. <row>
  2234. <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT</constant>&nbsp;</entry>
  2235. <entry>Frame skip mode enabled and buffer limit is set by the VBV (MPEG1/2/4) or CPB (H264) buffer size control.</entry>
  2236. </row>
  2237. </tbody>
  2238. </entrytbl>
  2239. </row>
  2240. <row><entry></entry></row>
  2241. <row>
  2242. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT</constant>&nbsp;</entry>
  2243. <entry>integer</entry>
  2244. </row><row><entry spanname="descr">Enable rate-control with fixed target bit.
  2245. If this setting is enabled, then the rate control logic of the encoder will calculate the average bitrate
  2246. for a GOP and keep it below or equal the set bitrate target. Otherwise the rate control logic calculates the
  2247. overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case
  2248. the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the
  2249. average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that
  2250. the stream will meet tight bandwidth contraints. Applicable to encoders.
  2251. </entry>
  2252. </row>
  2253. <row><entry></entry></row>
  2254. <row>
  2255. <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE</constant>&nbsp;</entry>
  2256. <entry>enum&nbsp;v4l2_mpeg_mfc51_force_frame_type</entry>
  2257. </row>
  2258. <row><entry spanname="descr">Force a frame type for the next queued buffer. Applicable to encoders.
  2259. Possible values are:</entry>
  2260. </row>
  2261. <row>
  2262. <entrytbl spanname="descr" cols="2">
  2263. <tbody valign="top">
  2264. <row>
  2265. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED</constant>&nbsp;</entry>
  2266. <entry>Forcing a specific frame type disabled.</entry>
  2267. </row>
  2268. <row>
  2269. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME</constant>&nbsp;</entry>
  2270. <entry>Force an I-frame.</entry>
  2271. </row>
  2272. <row>
  2273. <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED</constant>&nbsp;</entry>
  2274. <entry>Force a non-coded frame.</entry>
  2275. </row>
  2276. </tbody>
  2277. </entrytbl>
  2278. </row>
  2279. </tbody>
  2280. </tgroup>
  2281. </table>
  2282. </section>
  2283. <section>
  2284. <title>CX2341x MPEG Controls</title>
  2285. <para>The following MPEG class controls deal with MPEG
  2286. encoding settings that are specific to the Conexant CX23415 and
  2287. CX23416 MPEG encoding chips.</para>
  2288. <table pgwide="1" frame="none" id="cx2341x-control-id">
  2289. <title>CX2341x Control IDs</title>
  2290. <tgroup cols="4">
  2291. <colspec colname="c1" colwidth="1*" />
  2292. <colspec colname="c2" colwidth="6*" />
  2293. <colspec colname="c3" colwidth="2*" />
  2294. <colspec colname="c4" colwidth="6*" />
  2295. <spanspec namest="c1" nameend="c2" spanname="id" />
  2296. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2297. <thead>
  2298. <row>
  2299. <entry spanname="id" align="left">ID</entry>
  2300. <entry align="left">Type</entry>
  2301. </row><row><entry spanname="descr" align="left">Description</entry>
  2302. </row>
  2303. </thead>
  2304. <tbody valign="top">
  2305. <row><entry></entry></row>
  2306. <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode">
  2307. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant>&nbsp;</entry>
  2308. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry>
  2309. </row><row><entry spanname="descr">Sets the Spatial
  2310. Filter mode (default <constant>MANUAL</constant>). Possible values
  2311. are:</entry>
  2312. </row>
  2313. <row>
  2314. <entrytbl spanname="descr" cols="2">
  2315. <tbody valign="top">
  2316. <row>
  2317. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2318. <entry>Choose the filter manually</entry>
  2319. </row>
  2320. <row>
  2321. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2322. <entry>Choose the filter automatically</entry>
  2323. </row>
  2324. </tbody>
  2325. </entrytbl>
  2326. </row>
  2327. <row><entry></entry></row>
  2328. <row>
  2329. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER</constant>&nbsp;</entry>
  2330. <entry>integer&nbsp;(0-15)</entry>
  2331. </row><row><entry spanname="descr">The setting for the
  2332. Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry>
  2333. </row>
  2334. <row><entry></entry></row>
  2335. <row id="luma-spatial-filter-type">
  2336. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2337. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry>
  2338. </row><row><entry spanname="descr">Select the algorithm
  2339. to use for the Luma Spatial Filter (default
  2340. <constant>1D_HOR</constant>). Possible values:</entry>
  2341. </row>
  2342. <row>
  2343. <entrytbl spanname="descr" cols="2">
  2344. <tbody valign="top">
  2345. <row>
  2346. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2347. <entry>No filter</entry>
  2348. </row>
  2349. <row>
  2350. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2351. <entry>One-dimensional horizontal</entry>
  2352. </row>
  2353. <row>
  2354. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT</constant>&nbsp;</entry>
  2355. <entry>One-dimensional vertical</entry>
  2356. </row>
  2357. <row>
  2358. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE</constant>&nbsp;</entry>
  2359. <entry>Two-dimensional separable</entry>
  2360. </row>
  2361. <row>
  2362. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE</constant>&nbsp;</entry>
  2363. <entry>Two-dimensional symmetrical
  2364. non-separable</entry>
  2365. </row>
  2366. </tbody>
  2367. </entrytbl>
  2368. </row>
  2369. <row><entry></entry></row>
  2370. <row id="chroma-spatial-filter-type">
  2371. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
  2372. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry>
  2373. </row><row><entry spanname="descr">Select the algorithm
  2374. for the Chroma Spatial Filter (default <constant>1D_HOR</constant>).
  2375. Possible values are:</entry>
  2376. </row>
  2377. <row>
  2378. <entrytbl spanname="descr" cols="2">
  2379. <tbody valign="top">
  2380. <row>
  2381. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2382. <entry>No filter</entry>
  2383. </row>
  2384. <row>
  2385. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
  2386. <entry>One-dimensional horizontal</entry>
  2387. </row>
  2388. </tbody>
  2389. </entrytbl>
  2390. </row>
  2391. <row><entry></entry></row>
  2392. <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode">
  2393. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant>&nbsp;</entry>
  2394. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry>
  2395. </row><row><entry spanname="descr">Sets the Temporal
  2396. Filter mode (default <constant>MANUAL</constant>). Possible values
  2397. are:</entry>
  2398. </row>
  2399. <row>
  2400. <entrytbl spanname="descr" cols="2">
  2401. <tbody valign="top">
  2402. <row>
  2403. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
  2404. <entry>Choose the filter manually</entry>
  2405. </row>
  2406. <row>
  2407. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
  2408. <entry>Choose the filter automatically</entry>
  2409. </row>
  2410. </tbody>
  2411. </entrytbl>
  2412. </row>
  2413. <row><entry></entry></row>
  2414. <row>
  2415. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER</constant>&nbsp;</entry>
  2416. <entry>integer&nbsp;(0-31)</entry>
  2417. </row><row><entry spanname="descr">The setting for the
  2418. Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale
  2419. capturing and 0 for scaled capturing.)</entry>
  2420. </row>
  2421. <row><entry></entry></row>
  2422. <row id="v4l2-mpeg-cx2341x-video-median-filter-type">
  2423. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant>&nbsp;</entry>
  2424. <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_median_filter_type</entry>
  2425. </row><row><entry spanname="descr">Median Filter Type
  2426. (default <constant>OFF</constant>). Possible values are:</entry>
  2427. </row>
  2428. <row>
  2429. <entrytbl spanname="descr" cols="2">
  2430. <tbody valign="top">
  2431. <row>
  2432. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF</constant>&nbsp;</entry>
  2433. <entry>No filter</entry>
  2434. </row>
  2435. <row>
  2436. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR</constant>&nbsp;</entry>
  2437. <entry>Horizontal filter</entry>
  2438. </row>
  2439. <row>
  2440. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT</constant>&nbsp;</entry>
  2441. <entry>Vertical filter</entry>
  2442. </row>
  2443. <row>
  2444. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT</constant>&nbsp;</entry>
  2445. <entry>Horizontal and vertical filter</entry>
  2446. </row>
  2447. <row>
  2448. <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG</constant>&nbsp;</entry>
  2449. <entry>Diagonal filter</entry>
  2450. </row>
  2451. </tbody>
  2452. </entrytbl>
  2453. </row>
  2454. <row><entry></entry></row>
  2455. <row>
  2456. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2457. <entry>integer&nbsp;(0-255)</entry>
  2458. </row><row><entry spanname="descr">Threshold above which
  2459. the luminance median filter is enabled (default 0)</entry>
  2460. </row>
  2461. <row><entry></entry></row>
  2462. <row>
  2463. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2464. <entry>integer&nbsp;(0-255)</entry>
  2465. </row><row><entry spanname="descr">Threshold below which
  2466. the luminance median filter is enabled (default 255)</entry>
  2467. </row>
  2468. <row><entry></entry></row>
  2469. <row>
  2470. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
  2471. <entry>integer&nbsp;(0-255)</entry>
  2472. </row><row><entry spanname="descr">Threshold above which
  2473. the chroma median filter is enabled (default 0)</entry>
  2474. </row>
  2475. <row><entry></entry></row>
  2476. <row>
  2477. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
  2478. <entry>integer&nbsp;(0-255)</entry>
  2479. </row><row><entry spanname="descr">Threshold below which
  2480. the chroma median filter is enabled (default 255)</entry>
  2481. </row>
  2482. <row><entry></entry></row>
  2483. <row>
  2484. <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant>&nbsp;</entry>
  2485. <entry>boolean</entry>
  2486. </row>
  2487. <row><entry spanname="descr">The CX2341X MPEG encoder
  2488. can insert one empty MPEG-2 PES packet into the stream between every
  2489. four video frames. The packet size is 2048 bytes, including the
  2490. packet_start_code_prefix and stream_id fields. The stream_id is 0xBF
  2491. (private stream 2). The payload consists of 0x00 bytes, to be filled
  2492. in by the application. 0 = do not insert, 1 = insert packets.</entry>
  2493. </row>
  2494. </tbody>
  2495. </tgroup>
  2496. </table>
  2497. </section>
  2498. </section>
  2499. <section id="camera-controls">
  2500. <title>Camera Control Reference</title>
  2501. <para>The Camera class includes controls for mechanical (or
  2502. equivalent digital) features of a device such as controllable lenses
  2503. or sensors.</para>
  2504. <table pgwide="1" frame="none" id="camera-control-id">
  2505. <title>Camera Control IDs</title>
  2506. <tgroup cols="4">
  2507. <colspec colname="c1" colwidth="1*" />
  2508. <colspec colname="c2" colwidth="6*" />
  2509. <colspec colname="c3" colwidth="2*" />
  2510. <colspec colname="c4" colwidth="6*" />
  2511. <spanspec namest="c1" nameend="c2" spanname="id" />
  2512. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2513. <thead>
  2514. <row>
  2515. <entry spanname="id" align="left">ID</entry>
  2516. <entry align="left">Type</entry>
  2517. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  2518. </row>
  2519. </thead>
  2520. <tbody valign="top">
  2521. <row><entry></entry></row>
  2522. <row>
  2523. <entry spanname="id"><constant>V4L2_CID_CAMERA_CLASS</constant>&nbsp;</entry>
  2524. <entry>class</entry>
  2525. </row><row><entry spanname="descr">The Camera class
  2526. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  2527. description of this control class.</entry>
  2528. </row>
  2529. <row><entry></entry></row>
  2530. <row id="v4l2-exposure-auto-type">
  2531. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant>&nbsp;</entry>
  2532. <entry>enum&nbsp;v4l2_exposure_auto_type</entry>
  2533. </row><row><entry spanname="descr">Enables automatic
  2534. adjustments of the exposure time and/or iris aperture. The effect of
  2535. manual changes of the exposure time or iris aperture while these
  2536. features are enabled is undefined, drivers should ignore such
  2537. requests. Possible values are:</entry>
  2538. </row>
  2539. <row>
  2540. <entrytbl spanname="descr" cols="2">
  2541. <tbody valign="top">
  2542. <row>
  2543. <entry><constant>V4L2_EXPOSURE_AUTO</constant>&nbsp;</entry>
  2544. <entry>Automatic exposure time, automatic iris
  2545. aperture.</entry>
  2546. </row>
  2547. <row>
  2548. <entry><constant>V4L2_EXPOSURE_MANUAL</constant>&nbsp;</entry>
  2549. <entry>Manual exposure time, manual iris.</entry>
  2550. </row>
  2551. <row>
  2552. <entry><constant>V4L2_EXPOSURE_SHUTTER_PRIORITY</constant>&nbsp;</entry>
  2553. <entry>Manual exposure time, auto iris.</entry>
  2554. </row>
  2555. <row>
  2556. <entry><constant>V4L2_EXPOSURE_APERTURE_PRIORITY</constant>&nbsp;</entry>
  2557. <entry>Auto exposure time, manual iris.</entry>
  2558. </row>
  2559. </tbody>
  2560. </entrytbl>
  2561. </row>
  2562. <row><entry></entry></row>
  2563. <row>
  2564. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_ABSOLUTE</constant>&nbsp;</entry>
  2565. <entry>integer</entry>
  2566. </row><row><entry spanname="descr">Determines the exposure
  2567. time of the camera sensor. The exposure time is limited by the frame
  2568. interval. Drivers should interpret the values as 100 &micro;s units,
  2569. where the value 1 stands for 1/10000th of a second, 10000 for 1 second
  2570. and 100000 for 10 seconds.</entry>
  2571. </row>
  2572. <row><entry></entry></row>
  2573. <row>
  2574. <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO_PRIORITY</constant>&nbsp;</entry>
  2575. <entry>boolean</entry>
  2576. </row><row><entry spanname="descr">When
  2577. <constant>V4L2_CID_EXPOSURE_AUTO</constant> is set to
  2578. <constant>AUTO</constant> or <constant>APERTURE_PRIORITY</constant>,
  2579. this control determines if the device may dynamically vary the frame
  2580. rate. By default this feature is disabled (0) and the frame rate must
  2581. remain constant.</entry>
  2582. </row>
  2583. <row><entry></entry></row>
  2584. <row>
  2585. <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant>&nbsp;</entry>
  2586. <entry>integer</entry>
  2587. </row><row><entry spanname="descr">This control turns the
  2588. camera horizontally by the specified amount. The unit is undefined. A
  2589. positive value moves the camera to the right (clockwise when viewed
  2590. from above), a negative value to the left. A value of zero does not
  2591. cause motion. This is a write-only control.</entry>
  2592. </row>
  2593. <row><entry></entry></row>
  2594. <row>
  2595. <entry spanname="id"><constant>V4L2_CID_TILT_RELATIVE</constant>&nbsp;</entry>
  2596. <entry>integer</entry>
  2597. </row><row><entry spanname="descr">This control turns the
  2598. camera vertically by the specified amount. The unit is undefined. A
  2599. positive value moves the camera up, a negative value down. A value of
  2600. zero does not cause motion. This is a write-only control.</entry>
  2601. </row>
  2602. <row><entry></entry></row>
  2603. <row>
  2604. <entry spanname="id"><constant>V4L2_CID_PAN_RESET</constant>&nbsp;</entry>
  2605. <entry>button</entry>
  2606. </row><row><entry spanname="descr">When this control is set,
  2607. the camera moves horizontally to the default position.</entry>
  2608. </row>
  2609. <row><entry></entry></row>
  2610. <row>
  2611. <entry spanname="id"><constant>V4L2_CID_TILT_RESET</constant>&nbsp;</entry>
  2612. <entry>button</entry>
  2613. </row><row><entry spanname="descr">When this control is set,
  2614. the camera moves vertically to the default position.</entry>
  2615. </row>
  2616. <row><entry></entry></row>
  2617. <row>
  2618. <entry spanname="id"><constant>V4L2_CID_PAN_ABSOLUTE</constant>&nbsp;</entry>
  2619. <entry>integer</entry>
  2620. </row><row><entry spanname="descr">This control
  2621. turns the camera horizontally to the specified position. Positive
  2622. values move the camera to the right (clockwise when viewed from above),
  2623. negative values to the left. Drivers should interpret the values as arc
  2624. seconds, with valid values between -180 * 3600 and +180 * 3600
  2625. inclusive.</entry>
  2626. </row>
  2627. <row><entry></entry></row>
  2628. <row>
  2629. <entry spanname="id"><constant>V4L2_CID_TILT_ABSOLUTE</constant>&nbsp;</entry>
  2630. <entry>integer</entry>
  2631. </row><row><entry spanname="descr">This control
  2632. turns the camera vertically to the specified position. Positive values
  2633. move the camera up, negative values down. Drivers should interpret the
  2634. values as arc seconds, with valid values between -180 * 3600 and +180
  2635. * 3600 inclusive.</entry>
  2636. </row>
  2637. <row><entry></entry></row>
  2638. <row>
  2639. <entry spanname="id"><constant>V4L2_CID_FOCUS_ABSOLUTE</constant>&nbsp;</entry>
  2640. <entry>integer</entry>
  2641. </row><row><entry spanname="descr">This control sets the
  2642. focal point of the camera to the specified position. The unit is
  2643. undefined. Positive values set the focus closer to the camera,
  2644. negative values towards infinity.</entry>
  2645. </row>
  2646. <row><entry></entry></row>
  2647. <row>
  2648. <entry spanname="id"><constant>V4L2_CID_FOCUS_RELATIVE</constant>&nbsp;</entry>
  2649. <entry>integer</entry>
  2650. </row><row><entry spanname="descr">This control moves the
  2651. focal point of the camera by the specified amount. The unit is
  2652. undefined. Positive values move the focus closer to the camera,
  2653. negative values towards infinity. This is a write-only control.</entry>
  2654. </row>
  2655. <row><entry></entry></row>
  2656. <row>
  2657. <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
  2658. <entry>boolean</entry>
  2659. </row><row><entry spanname="descr">Enables automatic focus
  2660. adjustments. The effect of manual focus adjustments while this feature
  2661. is enabled is undefined, drivers should ignore such requests.</entry>
  2662. </row>
  2663. <row><entry></entry></row>
  2664. <row>
  2665. <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry>
  2666. <entry>integer</entry>
  2667. </row><row><entry spanname="descr">Specify the objective lens
  2668. focal length as an absolute value. The zoom unit is driver-specific and its
  2669. value should be a positive integer.</entry>
  2670. </row>
  2671. <row><entry></entry></row>
  2672. <row>
  2673. <entry spanname="id"><constant>V4L2_CID_ZOOM_RELATIVE</constant>&nbsp;</entry>
  2674. <entry>integer</entry>
  2675. </row><row><entry spanname="descr">Specify the objective lens
  2676. focal length relatively to the current value. Positive values move the zoom
  2677. lens group towards the telephoto direction, negative values towards the
  2678. wide-angle direction. The zoom unit is driver-specific. This is a write-only control.</entry>
  2679. </row>
  2680. <row><entry></entry></row>
  2681. <row>
  2682. <entry spanname="id"><constant>V4L2_CID_ZOOM_CONTINUOUS</constant>&nbsp;</entry>
  2683. <entry>integer</entry>
  2684. </row><row><entry spanname="descr">Move the objective lens group
  2685. at the specified speed until it reaches physical device limits or until an
  2686. explicit request to stop the movement. A positive value moves the zoom lens
  2687. group towards the telephoto direction. A value of zero stops the zoom lens
  2688. group movement. A negative value moves the zoom lens group towards the
  2689. wide-angle direction. The zoom speed unit is driver-specific.</entry>
  2690. </row>
  2691. <row><entry></entry></row>
  2692. <row>
  2693. <entry spanname="id"><constant>V4L2_CID_IRIS_ABSOLUTE</constant>&nbsp;</entry>
  2694. <entry>integer</entry>
  2695. </row><row><entry spanname="descr">This control sets the
  2696. camera's aperture to the specified value. The unit is undefined.
  2697. Larger values open the iris wider, smaller values close it.</entry>
  2698. </row>
  2699. <row><entry></entry></row>
  2700. <row>
  2701. <entry spanname="id"><constant>V4L2_CID_IRIS_RELATIVE</constant>&nbsp;</entry>
  2702. <entry>integer</entry>
  2703. </row><row><entry spanname="descr">This control modifies the
  2704. camera's aperture by the specified amount. The unit is undefined.
  2705. Positive values open the iris one step further, negative values close
  2706. it one step further. This is a write-only control.</entry>
  2707. </row>
  2708. <row><entry></entry></row>
  2709. <row>
  2710. <entry spanname="id"><constant>V4L2_CID_PRIVACY</constant>&nbsp;</entry>
  2711. <entry>boolean</entry>
  2712. </row><row><entry spanname="descr">Prevent video from being acquired
  2713. by the camera. When this control is set to <constant>TRUE</constant> (1), no
  2714. image can be captured by the camera. Common means to enforce privacy are
  2715. mechanical obturation of the sensor and firmware image processing, but the
  2716. device is not restricted to these methods. Devices that implement the privacy
  2717. control must support read access and may support write access.</entry>
  2718. </row>
  2719. <row>
  2720. <entry spanname="id"><constant>V4L2_CID_BAND_STOP_FILTER</constant>&nbsp;</entry>
  2721. <entry>integer</entry>
  2722. </row><row><entry spanname="descr">Switch the band-stop filter of a
  2723. camera sensor on or off, or specify its strength. Such band-stop filters can
  2724. be used, for example, to filter out the fluorescent light component.</entry>
  2725. </row>
  2726. <row><entry></entry></row>
  2727. </tbody>
  2728. </tgroup>
  2729. </table>
  2730. </section>
  2731. <section id="fm-tx-controls">
  2732. <title>FM Transmitter Control Reference</title>
  2733. <para>The FM Transmitter (FM_TX) class includes controls for common features of
  2734. FM transmissions capable devices. Currently this class includes parameters for audio
  2735. compression, pilot tone generation, audio deviation limiter, RDS transmission and
  2736. tuning power features.</para>
  2737. <table pgwide="1" frame="none" id="fm-tx-control-id">
  2738. <title>FM_TX Control IDs</title>
  2739. <tgroup cols="4">
  2740. <colspec colname="c1" colwidth="1*" />
  2741. <colspec colname="c2" colwidth="6*" />
  2742. <colspec colname="c3" colwidth="2*" />
  2743. <colspec colname="c4" colwidth="6*" />
  2744. <spanspec namest="c1" nameend="c2" spanname="id" />
  2745. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2746. <thead>
  2747. <row>
  2748. <entry spanname="id" align="left">ID</entry>
  2749. <entry align="left">Type</entry>
  2750. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  2751. </row>
  2752. </thead>
  2753. <tbody valign="top">
  2754. <row><entry></entry></row>
  2755. <row>
  2756. <entry spanname="id"><constant>V4L2_CID_FM_TX_CLASS</constant>&nbsp;</entry>
  2757. <entry>class</entry>
  2758. </row><row><entry spanname="descr">The FM_TX class
  2759. descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
  2760. description of this control class.</entry>
  2761. </row>
  2762. <row>
  2763. <entry spanname="id"><constant>V4L2_CID_RDS_TX_DEVIATION</constant>&nbsp;</entry>
  2764. <entry>integer</entry>
  2765. </row>
  2766. <row><entry spanname="descr">Configures RDS signal frequency deviation level in Hz.
  2767. The range and step are driver-specific.</entry>
  2768. </row>
  2769. <row>
  2770. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PI</constant>&nbsp;</entry>
  2771. <entry>integer</entry>
  2772. </row>
  2773. <row><entry spanname="descr">Sets the RDS Programme Identification field
  2774. for transmission.</entry>
  2775. </row>
  2776. <row>
  2777. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PTY</constant>&nbsp;</entry>
  2778. <entry>integer</entry>
  2779. </row>
  2780. <row><entry spanname="descr">Sets the RDS Programme Type field for transmission.
  2781. This encodes up to 31 pre-defined programme types.</entry>
  2782. </row>
  2783. <row>
  2784. <entry spanname="id"><constant>V4L2_CID_RDS_TX_PS_NAME</constant>&nbsp;</entry>
  2785. <entry>string</entry>
  2786. </row>
  2787. <row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission.
  2788. It is intended for static display on a receiver. It is the primary aid to listeners in programme service
  2789. identification and selection. In Annex E of <xref linkend="en50067" />, the RDS specification,
  2790. there is a full description of the correct character encoding for Programme Service name strings.
  2791. Also from RDS specification, PS is usually a single eight character text. However, it is also possible
  2792. to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
  2793. with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry>
  2794. </row>
  2795. <row>
  2796. <entry spanname="id"><constant>V4L2_CID_RDS_TX_RADIO_TEXT</constant>&nbsp;</entry>
  2797. <entry>string</entry>
  2798. </row>
  2799. <row><entry spanname="descr">Sets the Radio Text info for transmission. It is a textual description of
  2800. what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
  2801. programme-related information or any other text. In these cases, RadioText should be used in addition to
  2802. <constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
  2803. in Annex E of <xref linkend="en50067" />. The length of Radio Text strings depends on which RDS Block is being
  2804. used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
  2805. to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
  2806. with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
  2807. </row>
  2808. <row>
  2809. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant>&nbsp;</entry>
  2810. <entry>boolean</entry>
  2811. </row>
  2812. <row><entry spanname="descr">Enables or disables the audio deviation limiter feature.
  2813. The limiter is useful when trying to maximize the audio volume, minimize receiver-generated
  2814. distortion and prevent overmodulation.
  2815. </entry>
  2816. </row>
  2817. <row>
  2818. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_RELEASE_TIME</constant>&nbsp;</entry>
  2819. <entry>integer</entry>
  2820. </row>
  2821. <row><entry spanname="descr">Sets the audio deviation limiter feature release time.
  2822. Unit is in useconds. Step and range are driver-specific.</entry>
  2823. </row>
  2824. <row>
  2825. <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_DEVIATION</constant>&nbsp;</entry>
  2826. <entry>integer</entry>
  2827. </row>
  2828. <row><entry spanname="descr">Configures audio frequency deviation level in Hz.
  2829. The range and step are driver-specific.</entry>
  2830. </row>
  2831. <row>
  2832. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ENABLED</constant>&nbsp;</entry>
  2833. <entry>boolean</entry>
  2834. </row>
  2835. <row><entry spanname="descr">Enables or disables the audio compression feature.
  2836. This feature amplifies signals below the threshold by a fixed gain and compresses audio
  2837. signals above the threshold by the ratio of Threshold/(Gain + Threshold).</entry>
  2838. </row>
  2839. <row>
  2840. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_GAIN</constant>&nbsp;</entry>
  2841. <entry>integer</entry>
  2842. </row>
  2843. <row><entry spanname="descr">Sets the gain for audio compression feature. It is
  2844. a dB value. The range and step are driver-specific.</entry>
  2845. </row>
  2846. <row>
  2847. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_THRESHOLD</constant>&nbsp;</entry>
  2848. <entry>integer</entry>
  2849. </row>
  2850. <row><entry spanname="descr">Sets the threshold level for audio compression freature.
  2851. It is a dB value. The range and step are driver-specific.</entry>
  2852. </row>
  2853. <row>
  2854. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME</constant>&nbsp;</entry>
  2855. <entry>integer</entry>
  2856. </row>
  2857. <row><entry spanname="descr">Sets the attack time for audio compression feature.
  2858. It is a useconds value. The range and step are driver-specific.</entry>
  2859. </row>
  2860. <row>
  2861. <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME</constant>&nbsp;</entry>
  2862. <entry>integer</entry>
  2863. </row>
  2864. <row><entry spanname="descr">Sets the release time for audio compression feature.
  2865. It is a useconds value. The range and step are driver-specific.</entry>
  2866. </row>
  2867. <row>
  2868. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_ENABLED</constant>&nbsp;</entry>
  2869. <entry>boolean</entry>
  2870. </row>
  2871. <row><entry spanname="descr">Enables or disables the pilot tone generation feature.</entry>
  2872. </row>
  2873. <row>
  2874. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_DEVIATION</constant>&nbsp;</entry>
  2875. <entry>integer</entry>
  2876. </row>
  2877. <row><entry spanname="descr">Configures pilot tone frequency deviation level. Unit is
  2878. in Hz. The range and step are driver-specific.</entry>
  2879. </row>
  2880. <row>
  2881. <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_FREQUENCY</constant>&nbsp;</entry>
  2882. <entry>integer</entry>
  2883. </row>
  2884. <row><entry spanname="descr">Configures pilot tone frequency value. Unit is
  2885. in Hz. The range and step are driver-specific.</entry>
  2886. </row>
  2887. <row>
  2888. <entry spanname="id"><constant>V4L2_CID_TUNE_PREEMPHASIS</constant>&nbsp;</entry>
  2889. <entry>integer</entry>
  2890. </row>
  2891. <row id="v4l2-preemphasis"><entry spanname="descr">Configures the pre-emphasis value for broadcasting.
  2892. A pre-emphasis filter is applied to the broadcast to accentuate the high audio frequencies.
  2893. Depending on the region, a time constant of either 50 or 75 useconds is used. The enum&nbsp;v4l2_preemphasis
  2894. defines possible values for pre-emphasis. Here they are:</entry>
  2895. </row><row>
  2896. <entrytbl spanname="descr" cols="2">
  2897. <tbody valign="top">
  2898. <row>
  2899. <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant>&nbsp;</entry>
  2900. <entry>No pre-emphasis is applied.</entry>
  2901. </row>
  2902. <row>
  2903. <entry><constant>V4L2_PREEMPHASIS_50_uS</constant>&nbsp;</entry>
  2904. <entry>A pre-emphasis of 50 uS is used.</entry>
  2905. </row>
  2906. <row>
  2907. <entry><constant>V4L2_PREEMPHASIS_75_uS</constant>&nbsp;</entry>
  2908. <entry>A pre-emphasis of 75 uS is used.</entry>
  2909. </row>
  2910. </tbody>
  2911. </entrytbl>
  2912. </row>
  2913. <row>
  2914. <entry spanname="id"><constant>V4L2_CID_TUNE_POWER_LEVEL</constant>&nbsp;</entry>
  2915. <entry>integer</entry>
  2916. </row>
  2917. <row><entry spanname="descr">Sets the output power level for signal transmission.
  2918. Unit is in dBuV. Range and step are driver-specific.</entry>
  2919. </row>
  2920. <row>
  2921. <entry spanname="id"><constant>V4L2_CID_TUNE_ANTENNA_CAPACITOR</constant>&nbsp;</entry>
  2922. <entry>integer</entry>
  2923. </row>
  2924. <row><entry spanname="descr">This selects the value of antenna tuning capacitor
  2925. manually or automatically if set to zero. Unit, range and step are driver-specific.</entry>
  2926. </row>
  2927. <row><entry></entry></row>
  2928. </tbody>
  2929. </tgroup>
  2930. </table>
  2931. <para>For more details about RDS specification, refer to
  2932. <xref linkend="en50067" /> document, from CENELEC.</para>
  2933. </section>
  2934. <section id="flash-controls">
  2935. <title>Flash Control Reference</title>
  2936. <note>
  2937. <title>Experimental</title>
  2938. <para>This is an <link linkend="experimental">experimental</link>
  2939. interface and may change in the future.</para>
  2940. </note>
  2941. <para>
  2942. The V4L2 flash controls are intended to provide generic access
  2943. to flash controller devices. Flash controller devices are
  2944. typically used in digital cameras.
  2945. </para>
  2946. <para>
  2947. The interface can support both LED and xenon flash devices. As
  2948. of writing this, there is no xenon flash driver using this
  2949. interface.
  2950. </para>
  2951. <section id="flash-controls-use-cases">
  2952. <title>Supported use cases</title>
  2953. <section>
  2954. <title>Unsynchronised LED flash (software strobe)</title>
  2955. <para>
  2956. Unsynchronised LED flash is controlled directly by the
  2957. host as the sensor. The flash must be enabled by the host
  2958. before the exposure of the image starts and disabled once
  2959. it ends. The host is fully responsible for the timing of
  2960. the flash.
  2961. </para>
  2962. <para>Example of such device: Nokia N900.</para>
  2963. </section>
  2964. <section>
  2965. <title>Synchronised LED flash (hardware strobe)</title>
  2966. <para>
  2967. The synchronised LED flash is pre-programmed by the host
  2968. (power and timeout) but controlled by the sensor through a
  2969. strobe signal from the sensor to the flash.
  2970. </para>
  2971. <para>
  2972. The sensor controls the flash duration and timing. This
  2973. information typically must be made available to the
  2974. sensor.
  2975. </para>
  2976. </section>
  2977. <section>
  2978. <title>LED flash as torch</title>
  2979. <para>
  2980. LED flash may be used as torch in conjunction with another
  2981. use case involving camera or individually.
  2982. </para>
  2983. </section>
  2984. </section>
  2985. <table pgwide="1" frame="none" id="flash-control-id">
  2986. <title>Flash Control IDs</title>
  2987. <tgroup cols="4">
  2988. <colspec colname="c1" colwidth="1*" />
  2989. <colspec colname="c2" colwidth="6*" />
  2990. <colspec colname="c3" colwidth="2*" />
  2991. <colspec colname="c4" colwidth="6*" />
  2992. <spanspec namest="c1" nameend="c2" spanname="id" />
  2993. <spanspec namest="c2" nameend="c4" spanname="descr" />
  2994. <thead>
  2995. <row>
  2996. <entry spanname="id" align="left">ID</entry>
  2997. <entry align="left">Type</entry>
  2998. </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
  2999. </row>
  3000. </thead>
  3001. <tbody valign="top">
  3002. <row><entry></entry></row>
  3003. <row>
  3004. <entry spanname="id"><constant>V4L2_CID_FLASH_CLASS</constant></entry>
  3005. <entry>class</entry>
  3006. </row>
  3007. <row>
  3008. <entry spanname="descr">The FLASH class descriptor.</entry>
  3009. </row>
  3010. <row>
  3011. <entry spanname="id"><constant>V4L2_CID_FLASH_LED_MODE</constant></entry>
  3012. <entry>menu</entry>
  3013. </row>
  3014. <row id="v4l2-flash-led-mode">
  3015. <entry spanname="descr">Defines the mode of the flash LED,
  3016. the high-power white LED attached to the flash controller.
  3017. Setting this control may not be possible in presence of
  3018. some faults. See V4L2_CID_FLASH_FAULT.</entry>
  3019. </row>
  3020. <row>
  3021. <entrytbl spanname="descr" cols="2">
  3022. <tbody valign="top">
  3023. <row>
  3024. <entry><constant>V4L2_FLASH_LED_MODE_NONE</constant></entry>
  3025. <entry>Off.</entry>
  3026. </row>
  3027. <row>
  3028. <entry><constant>V4L2_FLASH_LED_MODE_FLASH</constant></entry>
  3029. <entry>Flash mode.</entry>
  3030. </row>
  3031. <row>
  3032. <entry><constant>V4L2_FLASH_LED_MODE_TORCH</constant></entry>
  3033. <entry>Torch mode. See V4L2_CID_FLASH_TORCH_INTENSITY.</entry>
  3034. </row>
  3035. </tbody>
  3036. </entrytbl>
  3037. </row>
  3038. <row>
  3039. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_SOURCE</constant></entry>
  3040. <entry>menu</entry>
  3041. </row>
  3042. <row id="v4l2-flash-strobe-source"><entry
  3043. spanname="descr">Defines the source of the flash LED
  3044. strobe.</entry>
  3045. </row>
  3046. <row>
  3047. <entrytbl spanname="descr" cols="2">
  3048. <tbody valign="top">
  3049. <row>
  3050. <entry><constant>V4L2_FLASH_STROBE_SOURCE_SOFTWARE</constant></entry>
  3051. <entry>The flash strobe is triggered by using
  3052. the V4L2_CID_FLASH_STROBE control.</entry>
  3053. </row>
  3054. <row>
  3055. <entry><constant>V4L2_FLASH_STROBE_SOURCE_EXTERNAL</constant></entry>
  3056. <entry>The flash strobe is triggered by an
  3057. external source. Typically this is a sensor,
  3058. which makes it possible to synchronises the
  3059. flash strobe start to exposure start.</entry>
  3060. </row>
  3061. </tbody>
  3062. </entrytbl>
  3063. </row>
  3064. <row>
  3065. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE</constant></entry>
  3066. <entry>button</entry>
  3067. </row>
  3068. <row>
  3069. <entry spanname="descr">Strobe flash. Valid when
  3070. V4L2_CID_FLASH_LED_MODE is set to
  3071. V4L2_FLASH_LED_MODE_FLASH and V4L2_CID_FLASH_STROBE_SOURCE
  3072. is set to V4L2_FLASH_STROBE_SOURCE_SOFTWARE. Setting this
  3073. control may not be possible in presence of some faults.
  3074. See V4L2_CID_FLASH_FAULT.</entry>
  3075. </row>
  3076. <row>
  3077. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STOP</constant></entry>
  3078. <entry>button</entry>
  3079. </row>
  3080. <row><entry spanname="descr">Stop flash strobe immediately.</entry>
  3081. </row>
  3082. <row>
  3083. <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STATUS</constant></entry>
  3084. <entry>boolean</entry>
  3085. </row>
  3086. <row>
  3087. <entry spanname="descr">Strobe status: whether the flash
  3088. is strobing at the moment or not. This is a read-only
  3089. control.</entry>
  3090. </row>
  3091. <row>
  3092. <entry spanname="id"><constant>V4L2_CID_FLASH_TIMEOUT</constant></entry>
  3093. <entry>integer</entry>
  3094. </row>
  3095. <row>
  3096. <entry spanname="descr">Hardware timeout for flash. The
  3097. flash strobe is stopped after this period of time has
  3098. passed from the start of the strobe.</entry>
  3099. </row>
  3100. <row>
  3101. <entry spanname="id"><constant>V4L2_CID_FLASH_INTENSITY</constant></entry>
  3102. <entry>integer</entry>
  3103. </row>
  3104. <row>
  3105. <entry spanname="descr">Intensity of the flash strobe when
  3106. the flash LED is in flash mode
  3107. (V4L2_FLASH_LED_MODE_FLASH). The unit should be milliamps
  3108. (mA) if possible.</entry>
  3109. </row>
  3110. <row>
  3111. <entry spanname="id"><constant>V4L2_CID_FLASH_TORCH_INTENSITY</constant></entry>
  3112. <entry>integer</entry>
  3113. </row>
  3114. <row>
  3115. <entry spanname="descr">Intensity of the flash LED in
  3116. torch mode (V4L2_FLASH_LED_MODE_TORCH). The unit should be
  3117. milliamps (mA) if possible. Setting this control may not
  3118. be possible in presence of some faults. See
  3119. V4L2_CID_FLASH_FAULT.</entry>
  3120. </row>
  3121. <row>
  3122. <entry spanname="id"><constant>V4L2_CID_FLASH_INDICATOR_INTENSITY</constant></entry>
  3123. <entry>integer</entry>
  3124. </row>
  3125. <row>
  3126. <entry spanname="descr">Intensity of the indicator LED.
  3127. The indicator LED may be fully independent of the flash
  3128. LED. The unit should be microamps (uA) if possible.</entry>
  3129. </row>
  3130. <row>
  3131. <entry spanname="id"><constant>V4L2_CID_FLASH_FAULT</constant></entry>
  3132. <entry>bitmask</entry>
  3133. </row>
  3134. <row>
  3135. <entry spanname="descr">Faults related to the flash. The
  3136. faults tell about specific problems in the flash chip
  3137. itself or the LEDs attached to it. Faults may prevent
  3138. further use of some of the flash controls. In particular,
  3139. V4L2_CID_FLASH_LED_MODE is set to V4L2_FLASH_LED_MODE_NONE
  3140. if the fault affects the flash LED. Exactly which faults
  3141. have such an effect is chip dependent. Reading the faults
  3142. resets the control and returns the chip to a usable state
  3143. if possible.</entry>
  3144. </row>
  3145. <row>
  3146. <entrytbl spanname="descr" cols="2">
  3147. <tbody valign="top">
  3148. <row>
  3149. <entry><constant>V4L2_FLASH_FAULT_OVER_VOLTAGE</constant></entry>
  3150. <entry>Flash controller voltage to the flash LED
  3151. has exceeded the limit specific to the flash
  3152. controller.</entry>
  3153. </row>
  3154. <row>
  3155. <entry><constant>V4L2_FLASH_FAULT_TIMEOUT</constant></entry>
  3156. <entry>The flash strobe was still on when
  3157. the timeout set by the user ---
  3158. V4L2_CID_FLASH_TIMEOUT control --- has expired.
  3159. Not all flash controllers may set this in all
  3160. such conditions.</entry>
  3161. </row>
  3162. <row>
  3163. <entry><constant>V4L2_FLASH_FAULT_OVER_TEMPERATURE</constant></entry>
  3164. <entry>The flash controller has overheated.</entry>
  3165. </row>
  3166. <row>
  3167. <entry><constant>V4L2_FLASH_FAULT_SHORT_CIRCUIT</constant></entry>
  3168. <entry>The short circuit protection of the flash
  3169. controller has been triggered.</entry>
  3170. </row>
  3171. </tbody>
  3172. </entrytbl>
  3173. </row>
  3174. <row>
  3175. <entry spanname="id"><constant>V4L2_CID_FLASH_CHARGE</constant></entry>
  3176. <entry>boolean</entry>
  3177. </row>
  3178. <row><entry spanname="descr">Enable or disable charging of the xenon
  3179. flash capacitor.</entry>
  3180. </row>
  3181. <row>
  3182. <entry spanname="id"><constant>V4L2_CID_FLASH_READY</constant></entry>
  3183. <entry>boolean</entry>
  3184. </row>
  3185. <row>
  3186. <entry spanname="descr">Is the flash ready to strobe?
  3187. Xenon flashes require their capacitors charged before
  3188. strobing. LED flashes often require a cooldown period
  3189. after strobe during which another strobe will not be
  3190. possible. This is a read-only control.</entry>
  3191. </row>
  3192. <row><entry></entry></row>
  3193. </tbody>
  3194. </tgroup>
  3195. </table>
  3196. </section>
  3197. </section>
  3198. <!--
  3199. Local Variables:
  3200. mode: sgml
  3201. sgml-parent-document: "common.sgml"
  3202. indent-tabs-mode: nil
  3203. End:
  3204. -->