camera/docs/docs.html

   1 <!DOCTYPE html>
   2 <html>
   3 <!-- Copyright (C) 2012 The Android Open Source Project
   4
   5      Licensed under the Apache License, Version 2.0 (the "License");
   6      you may not use this file except in compliance with the License.
   7      You may obtain a copy of the License at
   8
   9           http://www.apache.org/licenses/LICENSE-2.0
  10
  11      Unless required by applicable law or agreed to in writing, software
  12      distributed under the License is distributed on an "AS IS" BASIS,
  13      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14      See the License for the specific language governing permissions and
  15      limitations under the License.
  16 -->
  17 <head>
  18   <!-- automatically generated from html.mako. do NOT edit directly -->
  19   <meta charset="utf-8" />
  20   <title>Android Camera HAL3.4 Properties</title>
  21   <style type="text/css">
  22      body { background-color: #f7f7f7; font-family: Roboto, sans-serif;}
  23      h1 { color: #333333; }
  24      h2 { color: #333333; }
  25      a:link { color: #258aaf; text-decoration: none}
  26      a:hover { color: #459aaf; text-decoration: underline }
  27      a:visited { color: #154a5f; text-decoration: none}
  28     .section { color: #eeeeee; font-size: 1.5em; font-weight: bold; background-color: #888888; padding: 0.5em 0em 0.5em 0.5em; border-width: thick thin thin thin; border-color: #111111 #777777 #777777 #777777}
  29     .kind { color: #eeeeee; font-size: 1.2em; font-weight: bold; padding-left: 1.5em; background-color: #aaaaaa }
  30     .entry { background-color: #f0f0f0 }
  31     .entry_cont { background-color: #f0f0f0 }
  32     .entries_header { background-color: #dddddd; text-align: center}
  33
  34     /* toc style */
  35     .toc_section_header { font-size:1.3em;  }
  36     .toc_kind_header { font-size:1.2em;  }
  37     .toc_deprecated { text-decoration:line-through; }
  38
  39     /* table column sizes */
  40     table { border-collapse:collapse; table-layout: fixed; width: 100%; word-wrap: break-word }
  41     td,th { border: 1px solid; border-color: #aaaaaa; padding-left: 0.5em; padding-right: 0.5em }
  42     .th_name { width: 20% }
  43     .th_units { width: 10% }
  44     .th_tags { width: 5% }
  45     .th_details { width: 25% }
  46     .th_type { width: 20% }
  47     .th_description { width: 20% }
  48     .th_range { width: 10% }
  49     td { font-size: 0.9em; }
  50
  51     /* hide the first thead, we need it there only to enforce column sizes */
  52     .thead_dummy { visibility: hidden; }
  53
  54     /* Entry flair */
  55     .entry_name { color: #333333; padding-left:1.0em; font-size:1.1em; font-family: monospace; vertical-align:top; }
  56     .entry_name_deprecated { text-decoration:line-through; }
  57
  58     /* Entry type flair */
  59     .entry_type_name { font-size:1.1em; color: #669900; font-weight: bold;}
  60     .entry_type_name_enum:after { color: #669900; font-weight: bold; content:" (enum)" }
  61     .entry_type_visibility { font-weight: bolder; padding-left:1em}
  62     .entry_type_synthetic { font-weight: bolder; color: #996600; }
  63     .entry_type_hwlevel { font-weight: bolder; color: #000066; }
  64     .entry_type_deprecated { font-weight: bolder; color: #4D4D4D; }
  65     .entry_type_enum_name { font-family: monospace; font-weight: bolder; }
  66     .entry_type_enum_notes:before { content:" - " }
  67     .entry_type_enum_notes>p:first-child { display:inline; }
  68     .entry_type_enum_value:before { content:" = " }
  69     .entry_type_enum_value { font-family: monospace; }
  70     .entry ul { margin: 0 0 0 0; list-style-position: inside; padding-left: 0.5em; }
  71     .entry ul li { padding: 0 0 0 0; margin: 0 0 0 0;}
  72     .entry_range_deprecated { font-weight: bolder; }
  73
  74     /* Entry tags flair */
  75     .entry_tags ul { list-style-type: none; }
  76
  77     /* Entry details (full docs) flair */
  78     .entry_details_header { font-weight: bold; background-color: #dddddd;
  79       text-align: center; font-size: 1.1em; margin-left: 0em; margin-right: 0em; }
  80
  81     /* Entry spacer flair */
  82     .entry_spacer { background-color: transparent; border-style: none; height: 0.5em; }
  83
  84     /* TODO: generate abbr element for each tag link? */
  85     /* TODO for each x.y.z try to link it to the entry */
  86
  87   </style>
  88
  89   <style>
  90
  91     {
  92       /* broken...
  93          supposedly there is a bug in chrome that it lays out tables before
  94          it knows its being printed, so the page-break-* styles are ignored
  95          */
  96         tr { page-break-after: always; page-break-inside: avoid; }
  97     }
  98
  99   </style>
 100 </head>
 101
 102
 103
 104 <body>
 105   <h1>Android Camera HAL3.2 Properties</h1>
 106
 107
 108   <h2>Table of Contents</h2>
 109   <ul class="toc">
 110     <li><a href="#tag_index" class="toc_section_header">Tags</a></li>
 111     <li>
 112       <span class="toc_section_header"><a href="#section_colorCorrection">colorCorrection</a></span>
 113       <ul class="toc_section">
 114         <li>
 115           <span class="toc_kind_header">controls</span>
 116           <ul class="toc_section">
 117             <li
 118             ><a href="#controls_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 119             <li
 120             ><a href="#controls_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 121             <li
 122             ><a href="#controls_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 123             <li
 124             ><a href="#controls_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 125           </ul>
 126         </li>
 127         <li>
 128           <span class="toc_kind_header">dynamic</span>
 129           <ul class="toc_section">
 130             <li
 131             ><a href="#dynamic_android.colorCorrection.mode">android.colorCorrection.mode</a></li>
 132             <li
 133             ><a href="#dynamic_android.colorCorrection.transform">android.colorCorrection.transform</a></li>
 134             <li
 135             ><a href="#dynamic_android.colorCorrection.gains">android.colorCorrection.gains</a></li>
 136             <li
 137             ><a href="#dynamic_android.colorCorrection.aberrationMode">android.colorCorrection.aberrationMode</a></li>
 138           </ul>
 139         </li>
 140         <li>
 141           <span class="toc_kind_header">static</span>
 142           <ul class="toc_section">
 143             <li
 144             ><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a></li>
 145           </ul>
 146         </li>
 147       </ul> <!-- toc_section -->
 148     </li>
 149     <li>
 150       <span class="toc_section_header"><a href="#section_control">control</a></span>
 151       <ul class="toc_section">
 152         <li>
 153           <span class="toc_kind_header">controls</span>
 154           <ul class="toc_section">
 155             <li
 156             ><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 157             <li
 158             ><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 159             <li
 160             ><a href="#controls_android.control.aeLock">android.control.aeLock</a></li>
 161             <li
 162             ><a href="#controls_android.control.aeMode">android.control.aeMode</a></li>
 163             <li
 164             ><a href="#controls_android.control.aeRegions">android.control.aeRegions</a></li>
 165             <li
 166             ><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 167             <li
 168             ><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 169             <li
 170             ><a href="#controls_android.control.afMode">android.control.afMode</a></li>
 171             <li
 172             ><a href="#controls_android.control.afRegions">android.control.afRegions</a></li>
 173             <li
 174             ><a href="#controls_android.control.afTrigger">android.control.afTrigger</a></li>
 175             <li
 176             ><a href="#controls_android.control.awbLock">android.control.awbLock</a></li>
 177             <li
 178             ><a href="#controls_android.control.awbMode">android.control.awbMode</a></li>
 179             <li
 180             ><a href="#controls_android.control.awbRegions">android.control.awbRegions</a></li>
 181             <li
 182             ><a href="#controls_android.control.captureIntent">android.control.captureIntent</a></li>
 183             <li
 184             ><a href="#controls_android.control.effectMode">android.control.effectMode</a></li>
 185             <li
 186             ><a href="#controls_android.control.mode">android.control.mode</a></li>
 187             <li
 188             ><a href="#controls_android.control.sceneMode">android.control.sceneMode</a></li>
 189             <li
 190             ><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 191             <li
 192             ><a href="#controls_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a></li>
 193             <li
 194             ><a href="#controls_android.control.enableZsl">android.control.enableZsl</a></li>
 195           </ul>
 196         </li>
 197         <li>
 198           <span class="toc_kind_header">static</span>
 199           <ul class="toc_section">
 200             <li
 201             ><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a></li>
 202             <li
 203             ><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a></li>
 204             <li
 205             ><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a></li>
 206             <li
 207             ><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a></li>
 208             <li
 209             ><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a></li>
 210             <li
 211             ><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a></li>
 212             <li
 213             ><a href="#static_android.control.availableEffects">android.control.availableEffects</a></li>
 214             <li
 215             ><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a></li>
 216             <li
 217             ><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a></li>
 218             <li
 219             ><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a></li>
 220             <li
 221             ><a href="#static_android.control.maxRegions">android.control.maxRegions</a></li>
 222             <li
 223             ><a href="#static_android.control.maxRegionsAe">android.control.maxRegionsAe</a></li>
 224             <li
 225             ><a href="#static_android.control.maxRegionsAwb">android.control.maxRegionsAwb</a></li>
 226             <li
 227             ><a href="#static_android.control.maxRegionsAf">android.control.maxRegionsAf</a></li>
 228             <li
 229             ><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a></li>
 230             <li
 231             ><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a></li>
 232             <li
 233             ><a href="#static_android.control.aeLockAvailable">android.control.aeLockAvailable</a></li>
 234             <li
 235             ><a href="#static_android.control.awbLockAvailable">android.control.awbLockAvailable</a></li>
 236             <li
 237             ><a href="#static_android.control.availableModes">android.control.availableModes</a></li>
 238             <li
 239             ><a href="#static_android.control.postRawSensitivityBoostRange">android.control.postRawSensitivityBoostRange</a></li>
 240           </ul>
 241         </li>
 242         <li>
 243           <span class="toc_kind_header">dynamic</span>
 244           <ul class="toc_section">
 245             <li
 246                 class="toc_deprecated"
 247             ><a href="#dynamic_android.control.aePrecaptureId">android.control.aePrecaptureId</a></li>
 248             <li
 249             ><a href="#dynamic_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a></li>
 250             <li
 251             ><a href="#dynamic_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a></li>
 252             <li
 253             ><a href="#dynamic_android.control.aeLock">android.control.aeLock</a></li>
 254             <li
 255             ><a href="#dynamic_android.control.aeMode">android.control.aeMode</a></li>
 256             <li
 257             ><a href="#dynamic_android.control.aeRegions">android.control.aeRegions</a></li>
 258             <li
 259             ><a href="#dynamic_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a></li>
 260             <li
 261             ><a href="#dynamic_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a></li>
 262             <li
 263             ><a href="#dynamic_android.control.aeState">android.control.aeState</a></li>
 264             <li
 265             ><a href="#dynamic_android.control.afMode">android.control.afMode</a></li>
 266             <li
 267             ><a href="#dynamic_android.control.afRegions">android.control.afRegions</a></li>
 268             <li
 269             ><a href="#dynamic_android.control.afTrigger">android.control.afTrigger</a></li>
 270             <li
 271             ><a href="#dynamic_android.control.afState">android.control.afState</a></li>
 272             <li
 273                 class="toc_deprecated"
 274             ><a href="#dynamic_android.control.afTriggerId">android.control.afTriggerId</a></li>
 275             <li
 276             ><a href="#dynamic_android.control.awbLock">android.control.awbLock</a></li>
 277             <li
 278             ><a href="#dynamic_android.control.awbMode">android.control.awbMode</a></li>
 279             <li
 280             ><a href="#dynamic_android.control.awbRegions">android.control.awbRegions</a></li>
 281             <li
 282             ><a href="#dynamic_android.control.captureIntent">android.control.captureIntent</a></li>
 283             <li
 284             ><a href="#dynamic_android.control.awbState">android.control.awbState</a></li>
 285             <li
 286             ><a href="#dynamic_android.control.effectMode">android.control.effectMode</a></li>
 287             <li
 288             ><a href="#dynamic_android.control.mode">android.control.mode</a></li>
 289             <li
 290             ><a href="#dynamic_android.control.sceneMode">android.control.sceneMode</a></li>
 291             <li
 292             ><a href="#dynamic_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a></li>
 293             <li
 294             ><a href="#dynamic_android.control.postRawSensitivityBoost">android.control.postRawSensitivityBoost</a></li>
 295             <li
 296             ><a href="#dynamic_android.control.enableZsl">android.control.enableZsl</a></li>
 297           </ul>
 298         </li>
 299       </ul> <!-- toc_section -->
 300     </li>
 301     <li>
 302       <span class="toc_section_header"><a href="#section_demosaic">demosaic</a></span>
 303       <ul class="toc_section">
 304         <li>
 305           <span class="toc_kind_header">controls</span>
 306           <ul class="toc_section">
 307             <li
 308             ><a href="#controls_android.demosaic.mode">android.demosaic.mode</a></li>
 309           </ul>
 310         </li>
 311       </ul> <!-- toc_section -->
 312     </li>
 313     <li>
 314       <span class="toc_section_header"><a href="#section_edge">edge</a></span>
 315       <ul class="toc_section">
 316         <li>
 317           <span class="toc_kind_header">controls</span>
 318           <ul class="toc_section">
 319             <li
 320             ><a href="#controls_android.edge.mode">android.edge.mode</a></li>
 321             <li
 322             ><a href="#controls_android.edge.strength">android.edge.strength</a></li>
 323           </ul>
 324         </li>
 325         <li>
 326           <span class="toc_kind_header">static</span>
 327           <ul class="toc_section">
 328             <li
 329             ><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a></li>
 330           </ul>
 331         </li>
 332         <li>
 333           <span class="toc_kind_header">dynamic</span>
 334           <ul class="toc_section">
 335             <li
 336             ><a href="#dynamic_android.edge.mode">android.edge.mode</a></li>
 337           </ul>
 338         </li>
 339       </ul> <!-- toc_section -->
 340     </li>
 341     <li>
 342       <span class="toc_section_header"><a href="#section_flash">flash</a></span>
 343       <ul class="toc_section">
 344         <li>
 345           <span class="toc_kind_header">controls</span>
 346           <ul class="toc_section">
 347             <li
 348             ><a href="#controls_android.flash.firingPower">android.flash.firingPower</a></li>
 349             <li
 350             ><a href="#controls_android.flash.firingTime">android.flash.firingTime</a></li>
 351             <li
 352             ><a href="#controls_android.flash.mode">android.flash.mode</a></li>
 353           </ul>
 354         </li>
 355         <li>
 356           <span class="toc_kind_header">static</span>
 357           <ul class="toc_section">
 358
 359             <li
 360             ><a href="#static_android.flash.info.available">android.flash.info.available</a></li>
 361             <li
 362             ><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a></li>
 363
 364             <li
 365             ><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a></li>
 366             <li
 367             ><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a></li>
 368           </ul>
 369         </li>
 370         <li>
 371           <span class="toc_kind_header">dynamic</span>
 372           <ul class="toc_section">
 373             <li
 374             ><a href="#dynamic_android.flash.firingPower">android.flash.firingPower</a></li>
 375             <li
 376             ><a href="#dynamic_android.flash.firingTime">android.flash.firingTime</a></li>
 377             <li
 378             ><a href="#dynamic_android.flash.mode">android.flash.mode</a></li>
 379             <li
 380             ><a href="#dynamic_android.flash.state">android.flash.state</a></li>
 381           </ul>
 382         </li>
 383       </ul> <!-- toc_section -->
 384     </li>
 385     <li>
 386       <span class="toc_section_header"><a href="#section_hotPixel">hotPixel</a></span>
 387       <ul class="toc_section">
 388         <li>
 389           <span class="toc_kind_header">controls</span>
 390           <ul class="toc_section">
 391             <li
 392             ><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a></li>
 393           </ul>
 394         </li>
 395         <li>
 396           <span class="toc_kind_header">static</span>
 397           <ul class="toc_section">
 398             <li
 399             ><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a></li>
 400           </ul>
 401         </li>
 402         <li>
 403           <span class="toc_kind_header">dynamic</span>
 404           <ul class="toc_section">
 405             <li
 406             ><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a></li>
 407           </ul>
 408         </li>
 409       </ul> <!-- toc_section -->
 410     </li>
 411     <li>
 412       <span class="toc_section_header"><a href="#section_jpeg">jpeg</a></span>
 413       <ul class="toc_section">
 414         <li>
 415           <span class="toc_kind_header">controls</span>
 416           <ul class="toc_section">
 417             <li
 418             ><a href="#controls_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 419             <li
 420             ><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 421             <li
 422             ><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 423             <li
 424             ><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 425             <li
 426             ><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a></li>
 427             <li
 428             ><a href="#controls_android.jpeg.quality">android.jpeg.quality</a></li>
 429             <li
 430             ><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 431             <li
 432             ><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 433           </ul>
 434         </li>
 435         <li>
 436           <span class="toc_kind_header">static</span>
 437           <ul class="toc_section">
 438             <li
 439             ><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a></li>
 440             <li
 441             ><a href="#static_android.jpeg.maxSize">android.jpeg.maxSize</a></li>
 442           </ul>
 443         </li>
 444         <li>
 445           <span class="toc_kind_header">dynamic</span>
 446           <ul class="toc_section">
 447             <li
 448             ><a href="#dynamic_android.jpeg.gpsLocation">android.jpeg.gpsLocation</a></li>
 449             <li
 450             ><a href="#dynamic_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a></li>
 451             <li
 452             ><a href="#dynamic_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a></li>
 453             <li
 454             ><a href="#dynamic_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a></li>
 455             <li
 456             ><a href="#dynamic_android.jpeg.orientation">android.jpeg.orientation</a></li>
 457             <li
 458             ><a href="#dynamic_android.jpeg.quality">android.jpeg.quality</a></li>
 459             <li
 460             ><a href="#dynamic_android.jpeg.size">android.jpeg.size</a></li>
 461             <li
 462             ><a href="#dynamic_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a></li>
 463             <li
 464             ><a href="#dynamic_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a></li>
 465           </ul>
 466         </li>
 467       </ul> <!-- toc_section -->
 468     </li>
 469     <li>
 470       <span class="toc_section_header"><a href="#section_lens">lens</a></span>
 471       <ul class="toc_section">
 472         <li>
 473           <span class="toc_kind_header">controls</span>
 474           <ul class="toc_section">
 475             <li
 476             ><a href="#controls_android.lens.aperture">android.lens.aperture</a></li>
 477             <li
 478             ><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a></li>
 479             <li
 480             ><a href="#controls_android.lens.focalLength">android.lens.focalLength</a></li>
 481             <li
 482             ><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a></li>
 483             <li
 484             ><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 485           </ul>
 486         </li>
 487         <li>
 488           <span class="toc_kind_header">static</span>
 489           <ul class="toc_section">
 490
 491             <li
 492             ><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a></li>
 493             <li
 494             ><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a></li>
 495             <li
 496             ><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a></li>
 497             <li
 498             ><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a></li>
 499             <li
 500             ><a href="#static_android.lens.info.hyperfocalDistance">android.lens.info.hyperfocalDistance</a></li>
 501             <li
 502             ><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a></li>
 503             <li
 504             ><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a></li>
 505             <li
 506             ><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a></li>
 507
 508             <li
 509             ><a href="#static_android.lens.facing">android.lens.facing</a></li>
 510             <li
 511             ><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a></li>
 512             <li
 513             ><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a></li>
 514             <li
 515             ><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>
 516             <li
 517             ><a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a></li>
 518           </ul>
 519         </li>
 520         <li>
 521           <span class="toc_kind_header">dynamic</span>
 522           <ul class="toc_section">
 523             <li
 524             ><a href="#dynamic_android.lens.aperture">android.lens.aperture</a></li>
 525             <li
 526             ><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a></li>
 527             <li
 528             ><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a></li>
 529             <li
 530             ><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a></li>
 531             <li
 532             ><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a></li>
 533             <li
 534             ><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a></li>
 535             <li
 536             ><a href="#dynamic_android.lens.state">android.lens.state</a></li>
 537             <li
 538             ><a href="#dynamic_android.lens.poseRotation">android.lens.poseRotation</a></li>
 539             <li
 540             ><a href="#dynamic_android.lens.poseTranslation">android.lens.poseTranslation</a></li>
 541             <li
 542             ><a href="#dynamic_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a></li>
 543             <li
 544             ><a href="#dynamic_android.lens.radialDistortion">android.lens.radialDistortion</a></li>
 545           </ul>
 546         </li>
 547       </ul> <!-- toc_section -->
 548     </li>
 549     <li>
 550       <span class="toc_section_header"><a href="#section_noiseReduction">noiseReduction</a></span>
 551       <ul class="toc_section">
 552         <li>
 553           <span class="toc_kind_header">controls</span>
 554           <ul class="toc_section">
 555             <li
 556             ><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 557             <li
 558             ><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a></li>
 559           </ul>
 560         </li>
 561         <li>
 562           <span class="toc_kind_header">static</span>
 563           <ul class="toc_section">
 564             <li
 565             ><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a></li>
 566           </ul>
 567         </li>
 568         <li>
 569           <span class="toc_kind_header">dynamic</span>
 570           <ul class="toc_section">
 571             <li
 572             ><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a></li>
 573           </ul>
 574         </li>
 575       </ul> <!-- toc_section -->
 576     </li>
 577     <li>
 578       <span class="toc_section_header"><a href="#section_quirks">quirks</a></span>
 579       <ul class="toc_section">
 580         <li>
 581           <span class="toc_kind_header">static</span>
 582           <ul class="toc_section">
 583             <li
 584                 class="toc_deprecated"
 585             ><a href="#static_android.quirks.meteringCropRegion">android.quirks.meteringCropRegion</a></li>
 586             <li
 587                 class="toc_deprecated"
 588             ><a href="#static_android.quirks.triggerAfWithAuto">android.quirks.triggerAfWithAuto</a></li>
 589             <li
 590                 class="toc_deprecated"
 591             ><a href="#static_android.quirks.useZslFormat">android.quirks.useZslFormat</a></li>
 592             <li
 593                 class="toc_deprecated"
 594             ><a href="#static_android.quirks.usePartialResult">android.quirks.usePartialResult</a></li>
 595           </ul>
 596         </li>
 597         <li>
 598           <span class="toc_kind_header">dynamic</span>
 599           <ul class="toc_section">
 600             <li
 601                 class="toc_deprecated"
 602             ><a href="#dynamic_android.quirks.partialResult">android.quirks.partialResult</a></li>
 603           </ul>
 604         </li>
 605       </ul> <!-- toc_section -->
 606     </li>
 607     <li>
 608       <span class="toc_section_header"><a href="#section_request">request</a></span>
 609       <ul class="toc_section">
 610         <li>
 611           <span class="toc_kind_header">controls</span>
 612           <ul class="toc_section">
 613             <li
 614                 class="toc_deprecated"
 615             ><a href="#controls_android.request.frameCount">android.request.frameCount</a></li>
 616             <li
 617             ><a href="#controls_android.request.id">android.request.id</a></li>
 618             <li
 619                 class="toc_deprecated"
 620             ><a href="#controls_android.request.inputStreams">android.request.inputStreams</a></li>
 621             <li
 622             ><a href="#controls_android.request.metadataMode">android.request.metadataMode</a></li>
 623             <li
 624                 class="toc_deprecated"
 625             ><a href="#controls_android.request.outputStreams">android.request.outputStreams</a></li>
 626             <li
 627                 class="toc_deprecated"
 628             ><a href="#controls_android.request.type">android.request.type</a></li>
 629           </ul>
 630         </li>
 631         <li>
 632           <span class="toc_kind_header">static</span>
 633           <ul class="toc_section">
 634             <li
 635             ><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a></li>
 636             <li
 637             ><a href="#static_android.request.maxNumOutputRaw">android.request.maxNumOutputRaw</a></li>
 638             <li
 639             ><a href="#static_android.request.maxNumOutputProc">android.request.maxNumOutputProc</a></li>
 640             <li
 641             ><a href="#static_android.request.maxNumOutputProcStalling">android.request.maxNumOutputProcStalling</a></li>
 642             <li
 643                 class="toc_deprecated"
 644             ><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a></li>
 645             <li
 646             ><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a></li>
 647             <li
 648             ><a href="#static_android.request.pipelineMaxDepth">android.request.pipelineMaxDepth</a></li>
 649             <li
 650             ><a href="#static_android.request.partialResultCount">android.request.partialResultCount</a></li>
 651             <li
 652             ><a href="#static_android.request.availableCapabilities">android.request.availableCapabilities</a></li>
 653             <li
 654             ><a href="#static_android.request.availableRequestKeys">android.request.availableRequestKeys</a></li>
 655             <li
 656             ><a href="#static_android.request.availableResultKeys">android.request.availableResultKeys</a></li>
 657             <li
 658             ><a href="#static_android.request.availableCharacteristicsKeys">android.request.availableCharacteristicsKeys</a></li>
 659           </ul>
 660         </li>
 661         <li>
 662           <span class="toc_kind_header">dynamic</span>
 663           <ul class="toc_section">
 664             <li
 665                 class="toc_deprecated"
 666             ><a href="#dynamic_android.request.frameCount">android.request.frameCount</a></li>
 667             <li
 668             ><a href="#dynamic_android.request.id">android.request.id</a></li>
 669             <li
 670             ><a href="#dynamic_android.request.metadataMode">android.request.metadataMode</a></li>
 671             <li
 672                 class="toc_deprecated"
 673             ><a href="#dynamic_android.request.outputStreams">android.request.outputStreams</a></li>
 674             <li
 675             ><a href="#dynamic_android.request.pipelineDepth">android.request.pipelineDepth</a></li>
 676           </ul>
 677         </li>
 678       </ul> <!-- toc_section -->
 679     </li>
 680     <li>
 681       <span class="toc_section_header"><a href="#section_scaler">scaler</a></span>
 682       <ul class="toc_section">
 683         <li>
 684           <span class="toc_kind_header">controls</span>
 685           <ul class="toc_section">
 686             <li
 687             ><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 688           </ul>
 689         </li>
 690         <li>
 691           <span class="toc_kind_header">static</span>
 692           <ul class="toc_section">
 693             <li
 694                 class="toc_deprecated"
 695             ><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a></li>
 696             <li
 697                 class="toc_deprecated"
 698             ><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a></li>
 699             <li
 700                 class="toc_deprecated"
 701             ><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a></li>
 702             <li
 703             ><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a></li>
 704             <li
 705                 class="toc_deprecated"
 706             ><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a></li>
 707             <li
 708                 class="toc_deprecated"
 709             ><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a></li>
 710             <li
 711                 class="toc_deprecated"
 712             ><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a></li>
 713             <li
 714                 class="toc_deprecated"
 715             ><a href="#static_android.scaler.availableRawSizes">android.scaler.availableRawSizes</a></li>
 716             <li
 717             ><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a></li>
 718             <li
 719             ><a href="#static_android.scaler.availableStreamConfigurations">android.scaler.availableStreamConfigurations</a></li>
 720             <li
 721             ><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a></li>
 722             <li
 723             ><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a></li>
 724             <li
 725             ><a href="#static_android.scaler.streamConfigurationMap">android.scaler.streamConfigurationMap</a></li>
 726             <li
 727             ><a href="#static_android.scaler.croppingType">android.scaler.croppingType</a></li>
 728           </ul>
 729         </li>
 730         <li>
 731           <span class="toc_kind_header">dynamic</span>
 732           <ul class="toc_section">
 733             <li
 734             ><a href="#dynamic_android.scaler.cropRegion">android.scaler.cropRegion</a></li>
 735           </ul>
 736         </li>
 737       </ul> <!-- toc_section -->
 738     </li>
 739     <li>
 740       <span class="toc_section_header"><a href="#section_sensor">sensor</a></span>
 741       <ul class="toc_section">
 742         <li>
 743           <span class="toc_kind_header">controls</span>
 744           <ul class="toc_section">
 745             <li
 746             ><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 747             <li
 748             ><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 749             <li
 750             ><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 751             <li
 752             ><a href="#controls_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 753             <li
 754             ><a href="#controls_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 755           </ul>
 756         </li>
 757         <li>
 758           <span class="toc_kind_header">static</span>
 759           <ul class="toc_section">
 760
 761             <li
 762             ><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a></li>
 763             <li
 764             ><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a></li>
 765             <li
 766             ><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a></li>
 767             <li
 768             ><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a></li>
 769             <li
 770             ><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a></li>
 771             <li
 772             ><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a></li>
 773             <li
 774             ><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a></li>
 775             <li
 776             ><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a></li>
 777             <li
 778             ><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a></li>
 779             <li
 780             ><a href="#static_android.sensor.info.lensShadingApplied">android.sensor.info.lensShadingApplied</a></li>
 781             <li
 782             ><a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a></li>
 783
 784             <li
 785             ><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a></li>
 786             <li
 787             ><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a></li>
 788             <li
 789             ><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a></li>
 790             <li
 791             ><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a></li>
 792             <li
 793             ><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a></li>
 794             <li
 795             ><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a></li>
 796             <li
 797             ><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a></li>
 798             <li
 799             ><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a></li>
 800             <li
 801             ><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a></li>
 802             <li
 803             ><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a></li>
 804             <li
 805             ><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a></li>
 806             <li
 807             ><a href="#static_android.sensor.orientation">android.sensor.orientation</a></li>
 808             <li
 809             ><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a></li>
 810             <li
 811             ><a href="#static_android.sensor.availableTestPatternModes">android.sensor.availableTestPatternModes</a></li>
 812             <li
 813             ><a href="#static_android.sensor.opticalBlackRegions">android.sensor.opticalBlackRegions</a></li>
 814             <li
 815             ><a href="#static_android.sensor.opaqueRawSize">android.sensor.opaqueRawSize</a></li>
 816           </ul>
 817         </li>
 818         <li>
 819           <span class="toc_kind_header">dynamic</span>
 820           <ul class="toc_section">
 821             <li
 822             ><a href="#dynamic_android.sensor.exposureTime">android.sensor.exposureTime</a></li>
 823             <li
 824             ><a href="#dynamic_android.sensor.frameDuration">android.sensor.frameDuration</a></li>
 825             <li
 826             ><a href="#dynamic_android.sensor.sensitivity">android.sensor.sensitivity</a></li>
 827             <li
 828             ><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a></li>
 829             <li
 830             ><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a></li>
 831             <li
 832             ><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a></li>
 833             <li
 834             ><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a></li>
 835             <li
 836             ><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a></li>
 837             <li
 838             ><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a></li>
 839             <li
 840             ><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a></li>
 841             <li
 842             ><a href="#dynamic_android.sensor.testPatternData">android.sensor.testPatternData</a></li>
 843             <li
 844             ><a href="#dynamic_android.sensor.testPatternMode">android.sensor.testPatternMode</a></li>
 845             <li
 846             ><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a></li>
 847             <li
 848             ><a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a></li>
 849             <li
 850             ><a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a></li>
 851           </ul>
 852         </li>
 853       </ul> <!-- toc_section -->
 854     </li>
 855     <li>
 856       <span class="toc_section_header"><a href="#section_shading">shading</a></span>
 857       <ul class="toc_section">
 858         <li>
 859           <span class="toc_kind_header">controls</span>
 860           <ul class="toc_section">
 861             <li
 862             ><a href="#controls_android.shading.mode">android.shading.mode</a></li>
 863             <li
 864             ><a href="#controls_android.shading.strength">android.shading.strength</a></li>
 865           </ul>
 866         </li>
 867         <li>
 868           <span class="toc_kind_header">dynamic</span>
 869           <ul class="toc_section">
 870             <li
 871             ><a href="#dynamic_android.shading.mode">android.shading.mode</a></li>
 872           </ul>
 873         </li>
 874         <li>
 875           <span class="toc_kind_header">static</span>
 876           <ul class="toc_section">
 877             <li
 878             ><a href="#static_android.shading.availableModes">android.shading.availableModes</a></li>
 879           </ul>
 880         </li>
 881       </ul> <!-- toc_section -->
 882     </li>
 883     <li>
 884       <span class="toc_section_header"><a href="#section_statistics">statistics</a></span>
 885       <ul class="toc_section">
 886         <li>
 887           <span class="toc_kind_header">controls</span>
 888           <ul class="toc_section">
 889             <li
 890             ><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 891             <li
 892             ><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 893             <li
 894             ><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 895             <li
 896             ><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 897             <li
 898             ><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 899           </ul>
 900         </li>
 901         <li>
 902           <span class="toc_kind_header">static</span>
 903           <ul class="toc_section">
 904
 905             <li
 906             ><a href="#static_android.statistics.info.availableFaceDetectModes">android.statistics.info.availableFaceDetectModes</a></li>
 907             <li
 908             ><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a></li>
 909             <li
 910             ><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a></li>
 911             <li
 912             ><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a></li>
 913             <li
 914             ><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a></li>
 915             <li
 916             ><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a></li>
 917             <li
 918             ><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a></li>
 919             <li
 920             ><a href="#static_android.statistics.info.availableLensShadingMapModes">android.statistics.info.availableLensShadingMapModes</a></li>
 921
 922           </ul>
 923         </li>
 924         <li>
 925           <span class="toc_kind_header">dynamic</span>
 926           <ul class="toc_section">
 927             <li
 928             ><a href="#dynamic_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a></li>
 929             <li
 930             ><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a></li>
 931             <li
 932             ><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a></li>
 933             <li
 934             ><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a></li>
 935             <li
 936             ><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a></li>
 937             <li
 938             ><a href="#dynamic_android.statistics.faces">android.statistics.faces</a></li>
 939             <li
 940             ><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a></li>
 941             <li
 942             ><a href="#dynamic_android.statistics.histogramMode">android.statistics.histogramMode</a></li>
 943             <li
 944             ><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a></li>
 945             <li
 946             ><a href="#dynamic_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a></li>
 947             <li
 948             ><a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.statistics.lensShadingCorrectionMap</a></li>
 949             <li
 950             ><a href="#dynamic_android.statistics.lensShadingMap">android.statistics.lensShadingMap</a></li>
 951             <li
 952                 class="toc_deprecated"
 953             ><a href="#dynamic_android.statistics.predictedColorGains">android.statistics.predictedColorGains</a></li>
 954             <li
 955                 class="toc_deprecated"
 956             ><a href="#dynamic_android.statistics.predictedColorTransform">android.statistics.predictedColorTransform</a></li>
 957             <li
 958             ><a href="#dynamic_android.statistics.sceneFlicker">android.statistics.sceneFlicker</a></li>
 959             <li
 960             ><a href="#dynamic_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a></li>
 961             <li
 962             ><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a></li>
 963             <li
 964             ><a href="#dynamic_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a></li>
 965           </ul>
 966         </li>
 967       </ul> <!-- toc_section -->
 968     </li>
 969     <li>
 970       <span class="toc_section_header"><a href="#section_tonemap">tonemap</a></span>
 971       <ul class="toc_section">
 972         <li>
 973           <span class="toc_kind_header">controls</span>
 974           <ul class="toc_section">
 975             <li
 976             ><a href="#controls_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
 977             <li
 978             ><a href="#controls_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
 979             <li
 980             ><a href="#controls_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
 981             <li
 982             ><a href="#controls_android.tonemap.curve">android.tonemap.curve</a></li>
 983             <li
 984             ><a href="#controls_android.tonemap.mode">android.tonemap.mode</a></li>
 985             <li
 986             ><a href="#controls_android.tonemap.gamma">android.tonemap.gamma</a></li>
 987             <li
 988             ><a href="#controls_android.tonemap.presetCurve">android.tonemap.presetCurve</a></li>
 989           </ul>
 990         </li>
 991         <li>
 992           <span class="toc_kind_header">static</span>
 993           <ul class="toc_section">
 994             <li
 995             ><a href="#static_android.tonemap.maxCurvePoints">android.tonemap.maxCurvePoints</a></li>
 996             <li
 997             ><a href="#static_android.tonemap.availableToneMapModes">android.tonemap.availableToneMapModes</a></li>
 998           </ul>
 999         </li>
1000         <li>
1001           <span class="toc_kind_header">dynamic</span>
1002           <ul class="toc_section">
1003             <li
1004             ><a href="#dynamic_android.tonemap.curveBlue">android.tonemap.curveBlue</a></li>
1005             <li
1006             ><a href="#dynamic_android.tonemap.curveGreen">android.tonemap.curveGreen</a></li>
1007             <li
1008             ><a href="#dynamic_android.tonemap.curveRed">android.tonemap.curveRed</a></li>
1009             <li
1010             ><a href="#dynamic_android.tonemap.curve">android.tonemap.curve</a></li>
1011             <li
1012             ><a href="#dynamic_android.tonemap.mode">android.tonemap.mode</a></li>
1013             <li
1014             ><a href="#dynamic_android.tonemap.gamma">android.tonemap.gamma</a></li>
1015             <li
1016             ><a href="#dynamic_android.tonemap.presetCurve">android.tonemap.presetCurve</a></li>
1017           </ul>
1018         </li>
1019       </ul> <!-- toc_section -->
1020     </li>
1021     <li>
1022       <span class="toc_section_header"><a href="#section_led">led</a></span>
1023       <ul class="toc_section">
1024         <li>
1025           <span class="toc_kind_header">controls</span>
1026           <ul class="toc_section">
1027             <li
1028             ><a href="#controls_android.led.transmit">android.led.transmit</a></li>
1029           </ul>
1030         </li>
1031         <li>
1032           <span class="toc_kind_header">dynamic</span>
1033           <ul class="toc_section">
1034             <li
1035             ><a href="#dynamic_android.led.transmit">android.led.transmit</a></li>
1036           </ul>
1037         </li>
1038         <li>
1039           <span class="toc_kind_header">static</span>
1040           <ul class="toc_section">
1041             <li
1042             ><a href="#static_android.led.availableLeds">android.led.availableLeds</a></li>
1043           </ul>
1044         </li>
1045       </ul> <!-- toc_section -->
1046     </li>
1047     <li>
1048       <span class="toc_section_header"><a href="#section_info">info</a></span>
1049       <ul class="toc_section">
1050         <li>
1051           <span class="toc_kind_header">static</span>
1052           <ul class="toc_section">
1053             <li
1054             ><a href="#static_android.info.supportedHardwareLevel">android.info.supportedHardwareLevel</a></li>
1055           </ul>
1056         </li>
1057       </ul> <!-- toc_section -->
1058     </li>
1059     <li>
1060       <span class="toc_section_header"><a href="#section_blackLevel">blackLevel</a></span>
1061       <ul class="toc_section">
1062         <li>
1063           <span class="toc_kind_header">controls</span>
1064           <ul class="toc_section">
1065             <li
1066             ><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a></li>
1067           </ul>
1068         </li>
1069         <li>
1070           <span class="toc_kind_header">dynamic</span>
1071           <ul class="toc_section">
1072             <li
1073             ><a href="#dynamic_android.blackLevel.lock">android.blackLevel.lock</a></li>
1074           </ul>
1075         </li>
1076       </ul> <!-- toc_section -->
1077     </li>
1078     <li>
1079       <span class="toc_section_header"><a href="#section_sync">sync</a></span>
1080       <ul class="toc_section">
1081         <li>
1082           <span class="toc_kind_header">dynamic</span>
1083           <ul class="toc_section">
1084             <li
1085             ><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a></li>
1086           </ul>
1087         </li>
1088         <li>
1089           <span class="toc_kind_header">static</span>
1090           <ul class="toc_section">
1091             <li
1092             ><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a></li>
1093           </ul>
1094         </li>
1095       </ul> <!-- toc_section -->
1096     </li>
1097     <li>
1098       <span class="toc_section_header"><a href="#section_reprocess">reprocess</a></span>
1099       <ul class="toc_section">
1100         <li>
1101           <span class="toc_kind_header">controls</span>
1102           <ul class="toc_section">
1103             <li
1104             ><a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a></li>
1105           </ul>
1106         </li>
1107         <li>
1108           <span class="toc_kind_header">dynamic</span>
1109           <ul class="toc_section">
1110             <li
1111             ><a href="#dynamic_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a></li>
1112           </ul>
1113         </li>
1114         <li>
1115           <span class="toc_kind_header">static</span>
1116           <ul class="toc_section">
1117             <li
1118             ><a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a></li>
1119           </ul>
1120         </li>
1121       </ul> <!-- toc_section -->
1122     </li>
1123     <li>
1124       <span class="toc_section_header"><a href="#section_depth">depth</a></span>
1125       <ul class="toc_section">
1126         <li>
1127           <span class="toc_kind_header">static</span>
1128           <ul class="toc_section">
1129             <li
1130             ><a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a></li>
1131             <li
1132             ><a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a></li>
1133             <li
1134             ><a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a></li>
1135             <li
1136             ><a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a></li>
1137             <li
1138             ><a href="#static_android.depth.depthIsExclusive">android.depth.depthIsExclusive</a></li>
1139           </ul>
1140         </li>
1141       </ul> <!-- toc_section -->
1142     </li>
1143   </ul>
1144
1145
1146   <h1>Properties</h1>
1147   <table class="properties">
1148
1149     <thead class="thead_dummy">
1150       <tr>
1151         <th class="th_name">Property Name</th>
1152         <th class="th_type">Type</th>
1153         <th class="th_description">Description</th>
1154         <th class="th_units">Units</th>
1155         <th class="th_range">Range</th>
1156         <th class="th_tags">Tags</th>
1157       </tr>
1158     </thead> <!-- so that the first occurrence of thead is not
1159                          above the first occurrence of tr -->
1160 <!-- <namespace name="android"> -->
1161   <tr><td colspan="6" id="section_colorCorrection" class="section">colorCorrection</td></tr>
1162
1163
1164       <tr><td colspan="6" class="kind">controls</td></tr>
1165
1166       <thead class="entries_header">
1167         <tr>
1168           <th class="th_name">Property Name</th>
1169           <th class="th_type">Type</th>
1170           <th class="th_description">Description</th>
1171           <th class="th_units">Units</th>
1172           <th class="th_range">Range</th>
1173           <th class="th_tags">Tags</th>
1174         </tr>
1175       </thead>
1176
1177       <tbody>
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188           <tr class="entry" id="controls_android.colorCorrection.mode">
1189             <td class="entry_name
1190              " rowspan="5">
1191               android.<wbr/>color<wbr/>Correction.<wbr/>mode
1192             </td>
1193             <td class="entry_type">
1194                 <span class="entry_type_name entry_type_name_enum">byte</span>
1195
1196               <span class="entry_type_visibility"> [public]</span>
1197
1198
1199               <span class="entry_type_hwlevel">[full] </span>
1200
1201
1202
1203                 <ul class="entry_type_enum">
1204                   <li>
1205                     <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
1206                     <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
1207 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
1208 <p>All advanced white balance adjustments (not specified
1209 by our white balance pipeline) must be disabled.<wbr/></p>
1210 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1211 TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
1212 this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
1213                   </li>
1214                   <li>
1215                     <span class="entry_type_enum_name">FAST</span>
1216                     <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
1217 capture rate relative to sensor raw output.<wbr/></p>
1218 <p>Advanced white balance adjustments above and beyond
1219 the specified white balance pipeline may be applied.<wbr/></p>
1220 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1221 the camera device uses the last frame's AWB values
1222 (or defaults if AWB has never been run).<wbr/></p></span>
1223                   </li>
1224                   <li>
1225                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1226                     <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
1227 quality but the capture rate might be reduced (relative to sensor
1228 raw output rate)</p>
1229 <p>Advanced white balance adjustments above and beyond
1230 the specified white balance pipeline may be applied.<wbr/></p>
1231 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1232 the camera device uses the last frame's AWB values
1233 (or defaults if AWB has never been run).<wbr/></p></span>
1234                   </li>
1235                 </ul>
1236
1237             </td> <!-- entry_type -->
1238
1239             <td class="entry_description">
1240               <p>The mode control selects how the image data is converted from the
1241 sensor's native color into linear sRGB color.<wbr/></p>
1242             </td>
1243
1244             <td class="entry_units">
1245             </td>
1246
1247             <td class="entry_range">
1248             </td>
1249
1250             <td class="entry_tags">
1251             </td>
1252
1253           </tr>
1254           <tr class="entries_header">
1255             <th class="th_details" colspan="5">Details</th>
1256           </tr>
1257           <tr class="entry_cont">
1258             <td class="entry_details" colspan="5">
1259               <p>When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> this
1260 control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
1261 application controls how the color mapping is performed.<wbr/></p>
1262 <p>We define the expected processing pipeline below.<wbr/> For consistency
1263 across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1264 <p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
1265 do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
1266 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
1267 camera device (in the results) and be roughly correct.<wbr/></p>
1268 <p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
1269 FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
1270 as what was produced by the camera device in the earlier frame.<wbr/></p>
1271 <p>The expected processing pipeline is as follows:</p>
1272 <p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
1273 <p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
1274 gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
1275 matrix (applied after demosaic).<wbr/></p>
1276 <p>The 4-channel white-balance gains are defined as:</p>
1277 <pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
1278 </code></pre>
1279 <p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
1280 output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
1281 These may be identical for a given camera device implementation; if
1282 the camera device does not support a separate gain for even/<wbr/>odd green
1283 channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
1284 <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1285 <p>The matrices for color transforms are defined as a 9-entry vector:</p>
1286 <pre><code><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
1287 </code></pre>
1288 <p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
1289 to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
1290 <p>with colors as follows:</p>
1291 <pre><code>r' = I0r + I1g + I2b
1292 g' = I3r + I4g + I5b
1293 b' = I6r + I7g + I8b
1294 </code></pre>
1295 <p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
1296 values are clipped to fit within the range.<wbr/></p>
1297             </td>
1298           </tr>
1299
1300           <tr class="entries_header">
1301             <th class="th_details" colspan="5">HAL Implementation Details</th>
1302           </tr>
1303           <tr class="entry_cont">
1304             <td class="entry_details" colspan="5">
1305               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if color correction control is available
1306 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
1307 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
1308 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY should generate the same output.<wbr/></p>
1309             </td>
1310           </tr>
1311
1312           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1313            <!-- end of entry -->
1314
1315
1316           <tr class="entry" id="controls_android.colorCorrection.transform">
1317             <td class="entry_name
1318              " rowspan="3">
1319               android.<wbr/>color<wbr/>Correction.<wbr/>transform
1320             </td>
1321             <td class="entry_type">
1322                 <span class="entry_type_name">rational</span>
1323                 <span class="entry_type_container">x</span>
1324
1325                 <span class="entry_type_array">
1326                   3 x 3
1327                 </span>
1328               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
1329
1330
1331               <span class="entry_type_hwlevel">[full] </span>
1332
1333
1334                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
1335
1336
1337             </td> <!-- entry_type -->
1338
1339             <td class="entry_description">
1340               <p>A color transform matrix to use to transform
1341 from sensor RGB color space to output linear sRGB color space.<wbr/></p>
1342             </td>
1343
1344             <td class="entry_units">
1345               Unitless scale factors
1346             </td>
1347
1348             <td class="entry_range">
1349             </td>
1350
1351             <td class="entry_tags">
1352             </td>
1353
1354           </tr>
1355           <tr class="entries_header">
1356             <th class="th_details" colspan="5">Details</th>
1357           </tr>
1358           <tr class="entry_cont">
1359             <td class="entry_details" colspan="5">
1360               <p>This matrix is either set by the camera device when the request
1361 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
1362 directly by the application in the request when the
1363 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1364 <p>In the latter case,<wbr/> the camera device may round the matrix to account
1365 for precision issues; the final rounded matrix should be reported back
1366 in this matrix result metadata.<wbr/> The transform should keep the magnitude
1367 of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
1368 values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
1369 <p>The valid range of each matrix element varies on different devices,<wbr/> but
1370 values within [-1.<wbr/>5,<wbr/> 3.<wbr/>0] are guaranteed not to be clipped.<wbr/></p>
1371             </td>
1372           </tr>
1373
1374
1375           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1376            <!-- end of entry -->
1377
1378
1379           <tr class="entry" id="controls_android.colorCorrection.gains">
1380             <td class="entry_name
1381              " rowspan="5">
1382               android.<wbr/>color<wbr/>Correction.<wbr/>gains
1383             </td>
1384             <td class="entry_type">
1385                 <span class="entry_type_name">float</span>
1386                 <span class="entry_type_container">x</span>
1387
1388                 <span class="entry_type_array">
1389                   4
1390                 </span>
1391               <span class="entry_type_visibility"> [public as rggbChannelVector]</span>
1392
1393
1394               <span class="entry_type_hwlevel">[full] </span>
1395
1396
1397                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
1398
1399
1400             </td> <!-- entry_type -->
1401
1402             <td class="entry_description">
1403               <p>Gains applying to Bayer raw color channels for
1404 white-balance.<wbr/></p>
1405             </td>
1406
1407             <td class="entry_units">
1408               Unitless gain factors
1409             </td>
1410
1411             <td class="entry_range">
1412             </td>
1413
1414             <td class="entry_tags">
1415             </td>
1416
1417           </tr>
1418           <tr class="entries_header">
1419             <th class="th_details" colspan="5">Details</th>
1420           </tr>
1421           <tr class="entry_cont">
1422             <td class="entry_details" colspan="5">
1423               <p>These per-channel gains are either set by the camera device
1424 when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
1425 TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
1426 request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
1427 TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1428 <p>The gains in the result metadata are the gains actually
1429 applied by the camera device to the current frame.<wbr/></p>
1430 <p>The valid range of gains varies on different devices,<wbr/> but gains
1431 between [1.<wbr/>0,<wbr/> 3.<wbr/>0] are guaranteed not to be clipped.<wbr/> Even if a given
1432 device allows gains below 1.<wbr/>0,<wbr/> this is usually not recommended because
1433 this can create color artifacts.<wbr/></p>
1434             </td>
1435           </tr>
1436
1437           <tr class="entries_header">
1438             <th class="th_details" colspan="5">HAL Implementation Details</th>
1439           </tr>
1440           <tr class="entry_cont">
1441             <td class="entry_details" colspan="5">
1442               <p>The 4-channel white-balance gains are defined in
1443 the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
1444 for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
1445 is the gain for green pixels on the odd rows.<wbr/></p>
1446 <p>If a HAL does not support a separate gain for even/<wbr/>odd green
1447 channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
1448 <code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1449             </td>
1450           </tr>
1451
1452           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1453            <!-- end of entry -->
1454
1455
1456           <tr class="entry" id="controls_android.colorCorrection.aberrationMode">
1457             <td class="entry_name
1458              " rowspan="3">
1459               android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
1460             </td>
1461             <td class="entry_type">
1462                 <span class="entry_type_name entry_type_name_enum">byte</span>
1463
1464               <span class="entry_type_visibility"> [public]</span>
1465
1466
1467               <span class="entry_type_hwlevel">[legacy] </span>
1468
1469
1470
1471                 <ul class="entry_type_enum">
1472                   <li>
1473                     <span class="entry_type_enum_name">OFF</span>
1474                     <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
1475                   </li>
1476                   <li>
1477                     <span class="entry_type_enum_name">FAST</span>
1478                     <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
1479 relative to sensor raw output.<wbr/></p></span>
1480                   </li>
1481                   <li>
1482                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1483                     <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but the capture rate might be
1484 reduced (relative to sensor raw output rate)</p></span>
1485                   </li>
1486                 </ul>
1487
1488             </td> <!-- entry_type -->
1489
1490             <td class="entry_description">
1491               <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
1492             </td>
1493
1494             <td class="entry_units">
1495             </td>
1496
1497             <td class="entry_range">
1498               <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
1499             </td>
1500
1501             <td class="entry_tags">
1502             </td>
1503
1504           </tr>
1505           <tr class="entries_header">
1506             <th class="th_details" colspan="5">Details</th>
1507           </tr>
1508           <tr class="entry_cont">
1509             <td class="entry_details" colspan="5">
1510               <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
1511 can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
1512 the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
1513 minimize the chromatic artifacts that may occur along the object boundaries in an
1514 image.<wbr/></p>
1515 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
1516 correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
1517 use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
1518 capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
1519 applying aberration correction.<wbr/></p>
1520 <p>LEGACY devices will always be in FAST mode.<wbr/></p>
1521             </td>
1522           </tr>
1523
1524
1525           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1526            <!-- end of entry -->
1527
1528
1529
1530       <!-- end of kind -->
1531       </tbody>
1532       <tr><td colspan="6" class="kind">dynamic</td></tr>
1533
1534       <thead class="entries_header">
1535         <tr>
1536           <th class="th_name">Property Name</th>
1537           <th class="th_type">Type</th>
1538           <th class="th_description">Description</th>
1539           <th class="th_units">Units</th>
1540           <th class="th_range">Range</th>
1541           <th class="th_tags">Tags</th>
1542         </tr>
1543       </thead>
1544
1545       <tbody>
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556           <tr class="entry" id="dynamic_android.colorCorrection.mode">
1557             <td class="entry_name
1558              " rowspan="5">
1559               android.<wbr/>color<wbr/>Correction.<wbr/>mode
1560             </td>
1561             <td class="entry_type">
1562                 <span class="entry_type_name entry_type_name_enum">byte</span>
1563
1564               <span class="entry_type_visibility"> [public]</span>
1565
1566
1567               <span class="entry_type_hwlevel">[full] </span>
1568
1569
1570
1571                 <ul class="entry_type_enum">
1572                   <li>
1573                     <span class="entry_type_enum_name">TRANSFORM_MATRIX</span>
1574                     <span class="entry_type_enum_notes"><p>Use the <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> matrix
1575 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> to do color conversion.<wbr/></p>
1576 <p>All advanced white balance adjustments (not specified
1577 by our white balance pipeline) must be disabled.<wbr/></p>
1578 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1579 TRANSFORM_<wbr/>MATRIX is ignored.<wbr/> The camera device will override
1580 this value to either FAST or HIGH_<wbr/>QUALITY.<wbr/></p></span>
1581                   </li>
1582                   <li>
1583                     <span class="entry_type_enum_name">FAST</span>
1584                     <span class="entry_type_enum_notes"><p>Color correction processing must not slow down
1585 capture rate relative to sensor raw output.<wbr/></p>
1586 <p>Advanced white balance adjustments above and beyond
1587 the specified white balance pipeline may be applied.<wbr/></p>
1588 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1589 the camera device uses the last frame's AWB values
1590 (or defaults if AWB has never been run).<wbr/></p></span>
1591                   </li>
1592                   <li>
1593                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1594                     <span class="entry_type_enum_notes"><p>Color correction processing operates at improved
1595 quality but the capture rate might be reduced (relative to sensor
1596 raw output rate)</p>
1597 <p>Advanced white balance adjustments above and beyond
1598 the specified white balance pipeline may be applied.<wbr/></p>
1599 <p>If AWB is enabled with <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != OFF</code>,<wbr/> then
1600 the camera device uses the last frame's AWB values
1601 (or defaults if AWB has never been run).<wbr/></p></span>
1602                   </li>
1603                 </ul>
1604
1605             </td> <!-- entry_type -->
1606
1607             <td class="entry_description">
1608               <p>The mode control selects how the image data is converted from the
1609 sensor's native color into linear sRGB color.<wbr/></p>
1610             </td>
1611
1612             <td class="entry_units">
1613             </td>
1614
1615             <td class="entry_range">
1616             </td>
1617
1618             <td class="entry_tags">
1619             </td>
1620
1621           </tr>
1622           <tr class="entries_header">
1623             <th class="th_details" colspan="5">Details</th>
1624           </tr>
1625           <tr class="entry_cont">
1626             <td class="entry_details" colspan="5">
1627               <p>When auto-white balance (AWB) is enabled with <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> this
1628 control is overridden by the AWB routine.<wbr/> When AWB is disabled,<wbr/> the
1629 application controls how the color mapping is performed.<wbr/></p>
1630 <p>We define the expected processing pipeline below.<wbr/> For consistency
1631 across devices,<wbr/> this is always the case with TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1632 <p>When either FULL or HIGH_<wbr/>QUALITY is used,<wbr/> the camera device may
1633 do additional processing but <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
1634 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> will still be provided by the
1635 camera device (in the results) and be roughly correct.<wbr/></p>
1636 <p>Switching to TRANSFORM_<wbr/>MATRIX and using the data provided from
1637 FAST or HIGH_<wbr/>QUALITY will yield a picture with the same white point
1638 as what was produced by the camera device in the earlier frame.<wbr/></p>
1639 <p>The expected processing pipeline is as follows:</p>
1640 <p><img alt="White balance processing pipeline" src="images/camera2/metadata/android.colorCorrection.mode/processing_pipeline.png"/></p>
1641 <p>The white balance is encoded by two values,<wbr/> a 4-channel white-balance
1642 gain vector (applied in the Bayer domain),<wbr/> and a 3x3 color transform
1643 matrix (applied after demosaic).<wbr/></p>
1644 <p>The 4-channel white-balance gains are defined as:</p>
1645 <pre><code><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> = [ R G_<wbr/>even G_<wbr/>odd B ]
1646 </code></pre>
1647 <p>where <code>G_<wbr/>even</code> is the gain for green pixels on even rows of the
1648 output,<wbr/> and <code>G_<wbr/>odd</code> is the gain for green pixels on the odd rows.<wbr/>
1649 These may be identical for a given camera device implementation; if
1650 the camera device does not support a separate gain for even/<wbr/>odd green
1651 channels,<wbr/> it will use the <code>G_<wbr/>even</code> value,<wbr/> and write <code>G_<wbr/>odd</code> equal to
1652 <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1653 <p>The matrices for color transforms are defined as a 9-entry vector:</p>
1654 <pre><code><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> = [ I0 I1 I2 I3 I4 I5 I6 I7 I8 ]
1655 </code></pre>
1656 <p>which define a transform from input sensor colors,<wbr/> <code>P_<wbr/>in = [ r g b ]</code>,<wbr/>
1657 to output linear sRGB,<wbr/> <code>P_<wbr/>out = [ r' g' b' ]</code>,<wbr/></p>
1658 <p>with colors as follows:</p>
1659 <pre><code>r' = I0r + I1g + I2b
1660 g' = I3r + I4g + I5b
1661 b' = I6r + I7g + I8b
1662 </code></pre>
1663 <p>Both the input and output value ranges must match.<wbr/> Overflow/<wbr/>underflow
1664 values are clipped to fit within the range.<wbr/></p>
1665             </td>
1666           </tr>
1667
1668           <tr class="entries_header">
1669             <th class="th_details" colspan="5">HAL Implementation Details</th>
1670           </tr>
1671           <tr class="entry_cont">
1672             <td class="entry_details" colspan="5">
1673               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if color correction control is available
1674 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
1675 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
1676 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY should generate the same output.<wbr/></p>
1677             </td>
1678           </tr>
1679
1680           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1681            <!-- end of entry -->
1682
1683
1684           <tr class="entry" id="dynamic_android.colorCorrection.transform">
1685             <td class="entry_name
1686              " rowspan="3">
1687               android.<wbr/>color<wbr/>Correction.<wbr/>transform
1688             </td>
1689             <td class="entry_type">
1690                 <span class="entry_type_name">rational</span>
1691                 <span class="entry_type_container">x</span>
1692
1693                 <span class="entry_type_array">
1694                   3 x 3
1695                 </span>
1696               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
1697
1698
1699               <span class="entry_type_hwlevel">[full] </span>
1700
1701
1702                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
1703
1704
1705             </td> <!-- entry_type -->
1706
1707             <td class="entry_description">
1708               <p>A color transform matrix to use to transform
1709 from sensor RGB color space to output linear sRGB color space.<wbr/></p>
1710             </td>
1711
1712             <td class="entry_units">
1713               Unitless scale factors
1714             </td>
1715
1716             <td class="entry_range">
1717             </td>
1718
1719             <td class="entry_tags">
1720             </td>
1721
1722           </tr>
1723           <tr class="entries_header">
1724             <th class="th_details" colspan="5">Details</th>
1725           </tr>
1726           <tr class="entry_cont">
1727             <td class="entry_details" colspan="5">
1728               <p>This matrix is either set by the camera device when the request
1729 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not TRANSFORM_<wbr/>MATRIX,<wbr/> or
1730 directly by the application in the request when the
1731 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1732 <p>In the latter case,<wbr/> the camera device may round the matrix to account
1733 for precision issues; the final rounded matrix should be reported back
1734 in this matrix result metadata.<wbr/> The transform should keep the magnitude
1735 of the output color values within <code>[0,<wbr/> 1.<wbr/>0]</code> (assuming input color
1736 values is within the normalized range <code>[0,<wbr/> 1.<wbr/>0]</code>),<wbr/> or clipping may occur.<wbr/></p>
1737 <p>The valid range of each matrix element varies on different devices,<wbr/> but
1738 values within [-1.<wbr/>5,<wbr/> 3.<wbr/>0] are guaranteed not to be clipped.<wbr/></p>
1739             </td>
1740           </tr>
1741
1742
1743           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1744            <!-- end of entry -->
1745
1746
1747           <tr class="entry" id="dynamic_android.colorCorrection.gains">
1748             <td class="entry_name
1749              " rowspan="5">
1750               android.<wbr/>color<wbr/>Correction.<wbr/>gains
1751             </td>
1752             <td class="entry_type">
1753                 <span class="entry_type_name">float</span>
1754                 <span class="entry_type_container">x</span>
1755
1756                 <span class="entry_type_array">
1757                   4
1758                 </span>
1759               <span class="entry_type_visibility"> [public as rggbChannelVector]</span>
1760
1761
1762               <span class="entry_type_hwlevel">[full] </span>
1763
1764
1765                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
1766
1767
1768             </td> <!-- entry_type -->
1769
1770             <td class="entry_description">
1771               <p>Gains applying to Bayer raw color channels for
1772 white-balance.<wbr/></p>
1773             </td>
1774
1775             <td class="entry_units">
1776               Unitless gain factors
1777             </td>
1778
1779             <td class="entry_range">
1780             </td>
1781
1782             <td class="entry_tags">
1783             </td>
1784
1785           </tr>
1786           <tr class="entries_header">
1787             <th class="th_details" colspan="5">Details</th>
1788           </tr>
1789           <tr class="entry_cont">
1790             <td class="entry_details" colspan="5">
1791               <p>These per-channel gains are either set by the camera device
1792 when the request <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is not
1793 TRANSFORM_<wbr/>MATRIX,<wbr/> or directly by the application in the
1794 request when the <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> is
1795 TRANSFORM_<wbr/>MATRIX.<wbr/></p>
1796 <p>The gains in the result metadata are the gains actually
1797 applied by the camera device to the current frame.<wbr/></p>
1798 <p>The valid range of gains varies on different devices,<wbr/> but gains
1799 between [1.<wbr/>0,<wbr/> 3.<wbr/>0] are guaranteed not to be clipped.<wbr/> Even if a given
1800 device allows gains below 1.<wbr/>0,<wbr/> this is usually not recommended because
1801 this can create color artifacts.<wbr/></p>
1802             </td>
1803           </tr>
1804
1805           <tr class="entries_header">
1806             <th class="th_details" colspan="5">HAL Implementation Details</th>
1807           </tr>
1808           <tr class="entry_cont">
1809             <td class="entry_details" colspan="5">
1810               <p>The 4-channel white-balance gains are defined in
1811 the order of <code>[R G_<wbr/>even G_<wbr/>odd B]</code>,<wbr/> where <code>G_<wbr/>even</code> is the gain
1812 for green pixels on even rows of the output,<wbr/> and <code>G_<wbr/>odd</code>
1813 is the gain for green pixels on the odd rows.<wbr/></p>
1814 <p>If a HAL does not support a separate gain for even/<wbr/>odd green
1815 channels,<wbr/> it must use the <code>G_<wbr/>even</code> value,<wbr/> and write
1816 <code>G_<wbr/>odd</code> equal to <code>G_<wbr/>even</code> in the output result metadata.<wbr/></p>
1817             </td>
1818           </tr>
1819
1820           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1821            <!-- end of entry -->
1822
1823
1824           <tr class="entry" id="dynamic_android.colorCorrection.aberrationMode">
1825             <td class="entry_name
1826              " rowspan="3">
1827               android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode
1828             </td>
1829             <td class="entry_type">
1830                 <span class="entry_type_name entry_type_name_enum">byte</span>
1831
1832               <span class="entry_type_visibility"> [public]</span>
1833
1834
1835               <span class="entry_type_hwlevel">[legacy] </span>
1836
1837
1838
1839                 <ul class="entry_type_enum">
1840                   <li>
1841                     <span class="entry_type_enum_name">OFF</span>
1842                     <span class="entry_type_enum_notes"><p>No aberration correction is applied.<wbr/></p></span>
1843                   </li>
1844                   <li>
1845                     <span class="entry_type_enum_name">FAST</span>
1846                     <span class="entry_type_enum_notes"><p>Aberration correction will not slow down capture rate
1847 relative to sensor raw output.<wbr/></p></span>
1848                   </li>
1849                   <li>
1850                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
1851                     <span class="entry_type_enum_notes"><p>Aberration correction operates at improved quality but the capture rate might be
1852 reduced (relative to sensor raw output rate)</p></span>
1853                   </li>
1854                 </ul>
1855
1856             </td> <!-- entry_type -->
1857
1858             <td class="entry_description">
1859               <p>Mode of operation for the chromatic aberration correction algorithm.<wbr/></p>
1860             </td>
1861
1862             <td class="entry_units">
1863             </td>
1864
1865             <td class="entry_range">
1866               <p><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></p>
1867             </td>
1868
1869             <td class="entry_tags">
1870             </td>
1871
1872           </tr>
1873           <tr class="entries_header">
1874             <th class="th_details" colspan="5">Details</th>
1875           </tr>
1876           <tr class="entry_cont">
1877             <td class="entry_details" colspan="5">
1878               <p>Chromatic (color) aberration is caused by the fact that different wavelengths of light
1879 can not focus on the same point after exiting from the lens.<wbr/> This metadata defines
1880 the high level control of chromatic aberration correction algorithm,<wbr/> which aims to
1881 minimize the chromatic artifacts that may occur along the object boundaries in an
1882 image.<wbr/></p>
1883 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean that camera device determined aberration
1884 correction will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device will
1885 use the highest-quality aberration correction algorithms,<wbr/> even if it slows down
1886 capture rate.<wbr/> FAST means the camera device will not slow down capture rate when
1887 applying aberration correction.<wbr/></p>
1888 <p>LEGACY devices will always be in FAST mode.<wbr/></p>
1889             </td>
1890           </tr>
1891
1892
1893           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1894            <!-- end of entry -->
1895
1896
1897
1898       <!-- end of kind -->
1899       </tbody>
1900       <tr><td colspan="6" class="kind">static</td></tr>
1901
1902       <thead class="entries_header">
1903         <tr>
1904           <th class="th_name">Property Name</th>
1905           <th class="th_type">Type</th>
1906           <th class="th_description">Description</th>
1907           <th class="th_units">Units</th>
1908           <th class="th_range">Range</th>
1909           <th class="th_tags">Tags</th>
1910         </tr>
1911       </thead>
1912
1913       <tbody>
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924           <tr class="entry" id="static_android.colorCorrection.availableAberrationModes">
1925             <td class="entry_name
1926              " rowspan="5">
1927               android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes
1928             </td>
1929             <td class="entry_type">
1930                 <span class="entry_type_name">byte</span>
1931                 <span class="entry_type_container">x</span>
1932
1933                 <span class="entry_type_array">
1934                   n
1935                 </span>
1936               <span class="entry_type_visibility"> [public as enumList]</span>
1937
1938
1939               <span class="entry_type_hwlevel">[legacy] </span>
1940
1941
1942                 <div class="entry_type_notes">list of enums</div>
1943
1944
1945             </td> <!-- entry_type -->
1946
1947             <td class="entry_description">
1948               <p>List of aberration correction modes for <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a> that are
1949 supported by this camera device.<wbr/></p>
1950             </td>
1951
1952             <td class="entry_units">
1953             </td>
1954
1955             <td class="entry_range">
1956               <p>Any value listed in <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></p>
1957             </td>
1958
1959             <td class="entry_tags">
1960               <ul class="entry_tags">
1961                   <li><a href="#tag_V1">V1</a></li>
1962               </ul>
1963             </td>
1964
1965           </tr>
1966           <tr class="entries_header">
1967             <th class="th_details" colspan="5">Details</th>
1968           </tr>
1969           <tr class="entry_cont">
1970             <td class="entry_details" colspan="5">
1971               <p>This key lists the valid modes for <a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a>.<wbr/>  If no
1972 aberration correction modes are available for a device,<wbr/> this list will solely include
1973 OFF mode.<wbr/> All camera devices will support either OFF or FAST mode.<wbr/></p>
1974 <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always list
1975 OFF mode.<wbr/> This includes all FULL level devices.<wbr/></p>
1976 <p>LEGACY devices will always only support FAST mode.<wbr/></p>
1977             </td>
1978           </tr>
1979
1980           <tr class="entries_header">
1981             <th class="th_details" colspan="5">HAL Implementation Details</th>
1982           </tr>
1983           <tr class="entry_cont">
1984             <td class="entry_details" colspan="5">
1985               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if chromatic aberration control is available
1986 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
1987 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
1988 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
1989             </td>
1990           </tr>
1991
1992           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
1993            <!-- end of entry -->
1994
1995
1996
1997       <!-- end of kind -->
1998       </tbody>
1999
2000   <!-- end of section -->
2001   <tr><td colspan="6" id="section_control" class="section">control</td></tr>
2002
2003
2004       <tr><td colspan="6" class="kind">controls</td></tr>
2005
2006       <thead class="entries_header">
2007         <tr>
2008           <th class="th_name">Property Name</th>
2009           <th class="th_type">Type</th>
2010           <th class="th_description">Description</th>
2011           <th class="th_units">Units</th>
2012           <th class="th_range">Range</th>
2013           <th class="th_tags">Tags</th>
2014         </tr>
2015       </thead>
2016
2017       <tbody>
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028           <tr class="entry" id="controls_android.control.aeAntibandingMode">
2029             <td class="entry_name
2030              " rowspan="5">
2031               android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
2032             </td>
2033             <td class="entry_type">
2034                 <span class="entry_type_name entry_type_name_enum">byte</span>
2035
2036               <span class="entry_type_visibility"> [public]</span>
2037
2038
2039               <span class="entry_type_hwlevel">[legacy] </span>
2040
2041
2042
2043                 <ul class="entry_type_enum">
2044                   <li>
2045                     <span class="entry_type_enum_name">OFF</span>
2046                     <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
2047 avoid banding problems.<wbr/></p></span>
2048                   </li>
2049                   <li>
2050                     <span class="entry_type_enum_name">50HZ</span>
2051                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
2052 avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
2053                   </li>
2054                   <li>
2055                     <span class="entry_type_enum_name">60HZ</span>
2056                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
2057 avoid banding problems with 60Hz illumination
2058 sources.<wbr/></p></span>
2059                   </li>
2060                   <li>
2061                     <span class="entry_type_enum_name">AUTO</span>
2062                     <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
2063 antibanding routine to the current illumination
2064 condition.<wbr/> This is the default mode if AUTO is
2065 available on given camera device.<wbr/></p></span>
2066                   </li>
2067                 </ul>
2068
2069             </td> <!-- entry_type -->
2070
2071             <td class="entry_description">
2072               <p>The desired setting for the camera device's auto-exposure
2073 algorithm's antibanding compensation.<wbr/></p>
2074             </td>
2075
2076             <td class="entry_units">
2077             </td>
2078
2079             <td class="entry_range">
2080               <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
2081             </td>
2082
2083             <td class="entry_tags">
2084               <ul class="entry_tags">
2085                   <li><a href="#tag_BC">BC</a></li>
2086               </ul>
2087             </td>
2088
2089           </tr>
2090           <tr class="entries_header">
2091             <th class="th_details" colspan="5">Details</th>
2092           </tr>
2093           <tr class="entry_cont">
2094             <td class="entry_details" colspan="5">
2095               <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
2096 lights,<wbr/> flicker at the rate of the power supply frequency
2097 (60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
2098 typically not noticeable to a person,<wbr/> it can be visible to
2099 a camera device.<wbr/> If a camera sets its exposure time to the
2100 wrong value,<wbr/> the flicker may become visible in the
2101 viewfinder as flicker or in a final captured image,<wbr/> as a
2102 set of variable-brightness bands across the image.<wbr/></p>
2103 <p>Therefore,<wbr/> the auto-exposure routines of camera devices
2104 include antibanding routines that ensure that the chosen
2105 exposure value will not cause such banding.<wbr/> The choice of
2106 exposure time depends on the rate of flicker,<wbr/> which the
2107 camera device can detect automatically,<wbr/> or the expected
2108 rate can be selected by the application using this
2109 control.<wbr/></p>
2110 <p>A given camera device may not support all of the possible
2111 options for the antibanding mode.<wbr/> The
2112 <a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
2113 the available modes for a given camera device.<wbr/></p>
2114 <p>AUTO mode is the default if it is available on given
2115 camera device.<wbr/> When AUTO mode is not available,<wbr/> the
2116 default will be either 50HZ or 60HZ,<wbr/> and both 50HZ
2117 and 60HZ will be available.<wbr/></p>
2118 <p>If manual exposure control is enabled (by setting
2119 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
2120 then this setting has no effect,<wbr/> and the application must
2121 ensure it selects exposure times that do not cause banding
2122 issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
2123 the application in this.<wbr/></p>
2124             </td>
2125           </tr>
2126
2127           <tr class="entries_header">
2128             <th class="th_details" colspan="5">HAL Implementation Details</th>
2129           </tr>
2130           <tr class="entry_cont">
2131             <td class="entry_details" colspan="5">
2132               <p>For all capture request templates,<wbr/> this field must be set
2133 to AUTO if AUTO mode is available.<wbr/> If AUTO is not available,<wbr/>
2134 the default must be either 50HZ or 60HZ,<wbr/> and both 50HZ and
2135 60HZ must be available.<wbr/></p>
2136 <p>If manual exposure control is enabled (by setting
2137 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
2138 then the exposure values provided by the application must not be
2139 adjusted for antibanding.<wbr/></p>
2140             </td>
2141           </tr>
2142
2143           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2144            <!-- end of entry -->
2145
2146
2147           <tr class="entry" id="controls_android.control.aeExposureCompensation">
2148             <td class="entry_name
2149              " rowspan="3">
2150               android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
2151             </td>
2152             <td class="entry_type">
2153                 <span class="entry_type_name">int32</span>
2154
2155               <span class="entry_type_visibility"> [public]</span>
2156
2157
2158               <span class="entry_type_hwlevel">[legacy] </span>
2159
2160
2161
2162
2163             </td> <!-- entry_type -->
2164
2165             <td class="entry_description">
2166               <p>Adjustment to auto-exposure (AE) target image
2167 brightness.<wbr/></p>
2168             </td>
2169
2170             <td class="entry_units">
2171               Compensation steps
2172             </td>
2173
2174             <td class="entry_range">
2175               <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
2176             </td>
2177
2178             <td class="entry_tags">
2179               <ul class="entry_tags">
2180                   <li><a href="#tag_BC">BC</a></li>
2181               </ul>
2182             </td>
2183
2184           </tr>
2185           <tr class="entries_header">
2186             <th class="th_details" colspan="5">Details</th>
2187           </tr>
2188           <tr class="entry_cont">
2189             <td class="entry_details" colspan="5">
2190               <p>The adjustment is measured as a count of steps,<wbr/> with the
2191 step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
2192 allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
2193 <p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
2194 will mean an exposure compensation of +2 EV; -3 will mean an
2195 exposure compensation of -1 EV.<wbr/> One EV represents a doubling
2196 of image brightness.<wbr/> Note that this control will only be
2197 effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
2198 will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
2199 <p>In the event of exposure compensation value being changed,<wbr/> camera device
2200 may take several frames to reach the newly requested exposure target.<wbr/>
2201 During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
2202 state.<wbr/> Once the new exposure target is reached,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> will
2203 change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
2204 FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
2205             </td>
2206           </tr>
2207
2208
2209           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2210            <!-- end of entry -->
2211
2212
2213           <tr class="entry" id="controls_android.control.aeLock">
2214             <td class="entry_name
2215              " rowspan="3">
2216               android.<wbr/>control.<wbr/>ae<wbr/>Lock
2217             </td>
2218             <td class="entry_type">
2219                 <span class="entry_type_name entry_type_name_enum">byte</span>
2220
2221               <span class="entry_type_visibility"> [public as boolean]</span>
2222
2223
2224               <span class="entry_type_hwlevel">[legacy] </span>
2225
2226
2227
2228                 <ul class="entry_type_enum">
2229                   <li>
2230                     <span class="entry_type_enum_name">OFF</span>
2231                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
2232 is free to update its parameters.<wbr/></p></span>
2233                   </li>
2234                   <li>
2235                     <span class="entry_type_enum_name">ON</span>
2236                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
2237 must not update the exposure and sensitivity parameters
2238 while the lock is active.<wbr/></p>
2239 <p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
2240 will still take effect while auto-exposure is locked.<wbr/></p>
2241 <p>Some rare LEGACY devices may not support
2242 this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
2243                   </li>
2244                 </ul>
2245
2246             </td> <!-- entry_type -->
2247
2248             <td class="entry_description">
2249               <p>Whether auto-exposure (AE) is currently locked to its latest
2250 calculated values.<wbr/></p>
2251             </td>
2252
2253             <td class="entry_units">
2254             </td>
2255
2256             <td class="entry_range">
2257             </td>
2258
2259             <td class="entry_tags">
2260               <ul class="entry_tags">
2261                   <li><a href="#tag_BC">BC</a></li>
2262               </ul>
2263             </td>
2264
2265           </tr>
2266           <tr class="entries_header">
2267             <th class="th_details" colspan="5">Details</th>
2268           </tr>
2269           <tr class="entry_cont">
2270             <td class="entry_details" colspan="5">
2271               <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
2272 and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
2273 <p>Note that even when AE is locked,<wbr/> the flash may be fired if
2274 the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
2275 ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
2276 <p>When <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> is changed,<wbr/> even if the AE lock
2277 is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
2278 <p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
2279 when AE is already locked,<wbr/> the camera device will not change the exposure time
2280 (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
2281 parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
2282 is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
2283 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> the scene may become overexposed.<wbr/>
2284 Similarly,<wbr/> AE precapture trigger CANCEL has no effect when AE is already locked.<wbr/></p>
2285 <p>When an AE precapture sequence is triggered,<wbr/> AE unlock will not be able to unlock
2286 the AE if AE is locked by the camera device internally during precapture metering
2287 sequence In other words,<wbr/> submitting requests with AE unlock has no effect for an
2288 ongoing precapture metering sequence.<wbr/> Otherwise,<wbr/> the precapture metering sequence
2289 will never succeed in a sequence of preview requests where AE lock is always set
2290 to <code>false</code>.<wbr/></p>
2291 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
2292 get locked do not necessarily correspond to the settings that were present in the
2293 latest capture result received from the camera device,<wbr/> since additional captures
2294 and AE updates may have occurred even before the result was sent out.<wbr/> If an
2295 application is switching between automatic and manual control and wishes to eliminate
2296 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
2297 <ol>
2298 <li>Starting in auto-AE mode:</li>
2299 <li>Lock AE</li>
2300 <li>Wait for the first result to be output that has the AE locked</li>
2301 <li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
2302 <li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
2303 </ol>
2304 <p>See <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE lock related state transition details.<wbr/></p>
2305             </td>
2306           </tr>
2307
2308
2309           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2310            <!-- end of entry -->
2311
2312
2313           <tr class="entry" id="controls_android.control.aeMode">
2314             <td class="entry_name
2315              " rowspan="3">
2316               android.<wbr/>control.<wbr/>ae<wbr/>Mode
2317             </td>
2318             <td class="entry_type">
2319                 <span class="entry_type_name entry_type_name_enum">byte</span>
2320
2321               <span class="entry_type_visibility"> [public]</span>
2322
2323
2324               <span class="entry_type_hwlevel">[legacy] </span>
2325
2326
2327
2328                 <ul class="entry_type_enum">
2329                   <li>
2330                     <span class="entry_type_enum_name">OFF</span>
2331                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
2332 <p>The application-selected <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2333 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> and
2334 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
2335 device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
2336 a flash unit for this camera device.<wbr/></p>
2337 <p>Note that auto-white balance (AWB) and auto-focus (AF)
2338 behavior is device dependent when AE is in OFF mode.<wbr/>
2339 To have consistent behavior across different devices,<wbr/>
2340 it is recommended to either set AWB and AF to OFF mode
2341 or lock AWB and AF before setting AE to OFF.<wbr/>
2342 See <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>,<wbr/>
2343 <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a>,<wbr/> and <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
2344 for more details.<wbr/></p>
2345 <p>LEGACY devices do not support the OFF mode and will
2346 override attempts to use this value to ON.<wbr/></p></span>
2347                   </li>
2348                   <li>
2349                     <span class="entry_type_enum_name">ON</span>
2350                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
2351 with no flash control.<wbr/></p>
2352 <p>The application's values for
2353 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2354 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
2355 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
2356 application has control over the various
2357 android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
2358                   </li>
2359                   <li>
2360                     <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
2361                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
2362 the camera's flash unit,<wbr/> firing it in low-light
2363 conditions.<wbr/></p>
2364 <p>The flash may be fired during a precapture sequence
2365 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
2366 may be fired for captures for which the
2367 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
2368 STILL_<wbr/>CAPTURE</p></span>
2369                   </li>
2370                   <li>
2371                     <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
2372                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
2373 the camera's flash unit,<wbr/> always firing it for still
2374 captures.<wbr/></p>
2375 <p>The flash may be fired during a precapture sequence
2376 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
2377 will always be fired for captures for which the
2378 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
2379 STILL_<wbr/>CAPTURE</p></span>
2380                   </li>
2381                   <li>
2382                     <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
2383                     <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
2384 reduction.<wbr/></p>
2385 <p>If deemed necessary by the camera device,<wbr/> a red eye
2386 reduction flash will fire during the precapture
2387 sequence.<wbr/></p></span>
2388                   </li>
2389                 </ul>
2390
2391             </td> <!-- entry_type -->
2392
2393             <td class="entry_description">
2394               <p>The desired mode for the camera device's
2395 auto-exposure routine.<wbr/></p>
2396             </td>
2397
2398             <td class="entry_units">
2399             </td>
2400
2401             <td class="entry_range">
2402               <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
2403             </td>
2404
2405             <td class="entry_tags">
2406               <ul class="entry_tags">
2407                   <li><a href="#tag_BC">BC</a></li>
2408               </ul>
2409             </td>
2410
2411           </tr>
2412           <tr class="entries_header">
2413             <th class="th_details" colspan="5">Details</th>
2414           </tr>
2415           <tr class="entry_cont">
2416             <td class="entry_details" colspan="5">
2417               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
2418 AUTO.<wbr/></p>
2419 <p>When set to any of the ON modes,<wbr/> the camera device's
2420 auto-exposure routine is enabled,<wbr/> overriding the
2421 application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
2422 and frame duration (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
2423 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
2424 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
2425 is selected,<wbr/> the camera device's flash unit controls are
2426 also overridden.<wbr/></p>
2427 <p>The FLASH modes are only available if the camera device
2428 has a flash unit (<a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> is <code>true</code>).<wbr/></p>
2429 <p>If flash TORCH mode is desired,<wbr/> this field must be set to
2430 ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
2431 <p>When set to any of the ON modes,<wbr/> the values chosen by the
2432 camera device auto-exposure routine for the overridden
2433 fields for a given capture will be available in its
2434 CaptureResult.<wbr/></p>
2435             </td>
2436           </tr>
2437
2438
2439           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2440            <!-- end of entry -->
2441
2442
2443           <tr class="entry" id="controls_android.control.aeRegions">
2444             <td class="entry_name
2445              " rowspan="5">
2446               android.<wbr/>control.<wbr/>ae<wbr/>Regions
2447             </td>
2448             <td class="entry_type">
2449                 <span class="entry_type_name">int32</span>
2450                 <span class="entry_type_container">x</span>
2451
2452                 <span class="entry_type_array">
2453                   5 x area_count
2454                 </span>
2455               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
2456
2457
2458
2459
2460
2461
2462             </td> <!-- entry_type -->
2463
2464             <td class="entry_description">
2465               <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
2466             </td>
2467
2468             <td class="entry_units">
2469               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
2470             </td>
2471
2472             <td class="entry_range">
2473               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
2474 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
2475             </td>
2476
2477             <td class="entry_tags">
2478               <ul class="entry_tags">
2479                   <li><a href="#tag_BC">BC</a></li>
2480               </ul>
2481             </td>
2482
2483           </tr>
2484           <tr class="entries_header">
2485             <th class="th_details" colspan="5">Details</th>
2486           </tr>
2487           <tr class="entry_cont">
2488             <td class="entry_details" colspan="5">
2489               <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
2490 Otherwise will always be present.<wbr/></p>
2491 <p>The maximum number of regions supported by the device is determined by the value
2492 of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
2493 <p>The coordinate system is based on the active pixel array,<wbr/>
2494 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
2495 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
2496 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
2497 bottom-right pixel in the active pixel array.<wbr/></p>
2498 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
2499 for every pixel in the area.<wbr/> This means that a large metering area
2500 with the same weight as a smaller area will have more effect in
2501 the metering result.<wbr/> Metering areas can partially overlap and the
2502 camera device will add the weights in the overlap region.<wbr/></p>
2503 <p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
2504 region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
2505 weight is ignored.<wbr/></p>
2506 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
2507 camera device.<wbr/></p>
2508 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
2509 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
2510 region and output only the intersection rectangle as the metering region in the result
2511 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
2512 not reported in the result metadata.<wbr/></p>
2513             </td>
2514           </tr>
2515
2516           <tr class="entries_header">
2517             <th class="th_details" colspan="5">HAL Implementation Details</th>
2518           </tr>
2519           <tr class="entry_cont">
2520             <td class="entry_details" colspan="5">
2521               <p>The HAL level representation of MeteringRectangle[] is a
2522 int[5 * area_<wbr/>count].<wbr/>
2523 Every five elements represent a metering region of
2524 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
2525 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
2526 exclusive on xmax and ymax.<wbr/></p>
2527             </td>
2528           </tr>
2529
2530           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2531            <!-- end of entry -->
2532
2533
2534           <tr class="entry" id="controls_android.control.aeTargetFpsRange">
2535             <td class="entry_name
2536              " rowspan="3">
2537               android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
2538             </td>
2539             <td class="entry_type">
2540                 <span class="entry_type_name">int32</span>
2541                 <span class="entry_type_container">x</span>
2542
2543                 <span class="entry_type_array">
2544                   2
2545                 </span>
2546               <span class="entry_type_visibility"> [public as rangeInt]</span>
2547
2548
2549               <span class="entry_type_hwlevel">[legacy] </span>
2550
2551
2552
2553
2554             </td> <!-- entry_type -->
2555
2556             <td class="entry_description">
2557               <p>Range over which the auto-exposure routine can
2558 adjust the capture frame rate to maintain good
2559 exposure.<wbr/></p>
2560             </td>
2561
2562             <td class="entry_units">
2563               Frames per second (FPS)
2564             </td>
2565
2566             <td class="entry_range">
2567               <p>Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a></p>
2568             </td>
2569
2570             <td class="entry_tags">
2571               <ul class="entry_tags">
2572                   <li><a href="#tag_BC">BC</a></li>
2573               </ul>
2574             </td>
2575
2576           </tr>
2577           <tr class="entries_header">
2578             <th class="th_details" colspan="5">Details</th>
2579           </tr>
2580           <tr class="entry_cont">
2581             <td class="entry_details" colspan="5">
2582               <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
2583 manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
2584 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
2585             </td>
2586           </tr>
2587
2588
2589           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2590            <!-- end of entry -->
2591
2592
2593           <tr class="entry" id="controls_android.control.aePrecaptureTrigger">
2594             <td class="entry_name
2595              " rowspan="5">
2596               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
2597             </td>
2598             <td class="entry_type">
2599                 <span class="entry_type_name entry_type_name_enum">byte</span>
2600
2601               <span class="entry_type_visibility"> [public]</span>
2602
2603
2604               <span class="entry_type_hwlevel">[limited] </span>
2605
2606
2607
2608                 <ul class="entry_type_enum">
2609                   <li>
2610                     <span class="entry_type_enum_name">IDLE</span>
2611                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
2612                   </li>
2613                   <li>
2614                     <span class="entry_type_enum_name">START</span>
2615                     <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
2616 by the camera device.<wbr/></p>
2617 <p>The exact effect of the precapture trigger depends on
2618 the current AE mode and state.<wbr/></p></span>
2619                   </li>
2620                   <li>
2621                     <span class="entry_type_enum_name">CANCEL</span>
2622                     <span class="entry_type_enum_notes"><p>The camera device will cancel any currently active or completed
2623 precapture metering sequence,<wbr/> the auto-exposure routine will return to its
2624 initial state.<wbr/></p></span>
2625                   </li>
2626                 </ul>
2627
2628             </td> <!-- entry_type -->
2629
2630             <td class="entry_description">
2631               <p>Whether the camera device will trigger a precapture
2632 metering sequence when it processes this request.<wbr/></p>
2633             </td>
2634
2635             <td class="entry_units">
2636             </td>
2637
2638             <td class="entry_range">
2639             </td>
2640
2641             <td class="entry_tags">
2642               <ul class="entry_tags">
2643                   <li><a href="#tag_BC">BC</a></li>
2644               </ul>
2645             </td>
2646
2647           </tr>
2648           <tr class="entries_header">
2649             <th class="th_details" colspan="5">Details</th>
2650           </tr>
2651           <tr class="entry_cont">
2652             <td class="entry_details" colspan="5">
2653               <p>This entry is normally set to IDLE,<wbr/> or is not
2654 included at all in the request settings.<wbr/> When included and
2655 set to START,<wbr/> the camera device will trigger the auto-exposure (AE)
2656 precapture metering sequence.<wbr/></p>
2657 <p>When set to CANCEL,<wbr/> the camera device will cancel any active
2658 precapture metering trigger,<wbr/> and return to its initial AE state.<wbr/>
2659 If a precapture metering sequence is already completed,<wbr/> and the camera
2660 device has implicitly locked the AE for subsequent still capture,<wbr/> the
2661 CANCEL trigger will unlock the AE and return to its initial AE state.<wbr/></p>
2662 <p>The precapture sequence should be triggered before starting a
2663 high-quality still capture for final metering decisions to
2664 be made,<wbr/> and for firing pre-capture flash pulses to estimate
2665 scene brightness and required final capture flash power,<wbr/> when
2666 the flash is enabled.<wbr/></p>
2667 <p>Normally,<wbr/> this entry should be set to START for only a
2668 single request,<wbr/> and the application should wait until the
2669 sequence completes before starting a new one.<wbr/></p>
2670 <p>When a precapture metering sequence is finished,<wbr/> the camera device
2671 may lock the auto-exposure routine internally to be able to accurately expose the
2672 subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE</code>).<wbr/>
2673 For this case,<wbr/> the AE may not resume normal scan if no subsequent still capture is
2674 submitted.<wbr/> To ensure that the AE routine restarts normal scan,<wbr/> the application should
2675 submit a request with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == true</code>,<wbr/> followed by a request
2676 with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == false</code>,<wbr/> if the application decides not to submit a
2677 still capture request after the precapture sequence completes.<wbr/> Alternatively,<wbr/> for
2678 API level 23 or newer devices,<wbr/> the CANCEL can be used to unlock the camera device
2679 internally locked AE if the application doesn't submit a still capture request after
2680 the AE precapture trigger.<wbr/> Note that,<wbr/> the CANCEL was added in API level 23,<wbr/> and must not
2681 be used in devices that have earlier API levels.<wbr/></p>
2682 <p>The exact effect of auto-exposure (AE) precapture trigger
2683 depends on the current AE mode and state; see
2684 <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
2685 details.<wbr/></p>
2686 <p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
2687 capturing a high-resolution JPEG image will automatically trigger a
2688 precapture sequence before the high-resolution capture,<wbr/> including
2689 potentially firing a pre-capture flash.<wbr/></p>
2690 <p>Using the precapture trigger and the auto-focus trigger <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
2691 simultaneously is allowed.<wbr/> However,<wbr/> since these triggers often require cooperation between
2692 the auto-focus and auto-exposure routines (for example,<wbr/> the may need to be enabled for a
2693 focus sweep),<wbr/> the camera device may delay acting on a later trigger until the previous
2694 trigger has been fully handled.<wbr/> This may lead to longer intervals between the trigger and
2695 changes to <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> indicating the start of the precapture sequence,<wbr/> for
2696 example.<wbr/></p>
2697 <p>If both the precapture and the auto-focus trigger are activated on the same request,<wbr/> then
2698 the camera device will complete them in the optimal order for that device.<wbr/></p>
2699             </td>
2700           </tr>
2701
2702           <tr class="entries_header">
2703             <th class="th_details" colspan="5">HAL Implementation Details</th>
2704           </tr>
2705           <tr class="entry_cont">
2706             <td class="entry_details" colspan="5">
2707               <p>The HAL must support triggering the AE precapture trigger while an AF trigger is active
2708 (and vice versa),<wbr/> or at the same time as the AF trigger.<wbr/>  It is acceptable for the HAL to
2709 treat these as two consecutive triggers,<wbr/> for example handling the AF trigger and then the
2710 AE trigger.<wbr/>  Or the HAL may choose to optimize the case with both triggers fired at once,<wbr/>
2711 to minimize the latency for converging both focus and exposure/<wbr/>flash usage.<wbr/></p>
2712             </td>
2713           </tr>
2714
2715           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2716            <!-- end of entry -->
2717
2718
2719           <tr class="entry" id="controls_android.control.afMode">
2720             <td class="entry_name
2721              " rowspan="5">
2722               android.<wbr/>control.<wbr/>af<wbr/>Mode
2723             </td>
2724             <td class="entry_type">
2725                 <span class="entry_type_name entry_type_name_enum">byte</span>
2726
2727               <span class="entry_type_visibility"> [public]</span>
2728
2729
2730               <span class="entry_type_hwlevel">[legacy] </span>
2731
2732
2733
2734                 <ul class="entry_type_enum">
2735                   <li>
2736                     <span class="entry_type_enum_name">OFF</span>
2737                     <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
2738 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
2739 application.<wbr/></p></span>
2740                   </li>
2741                   <li>
2742                     <span class="entry_type_enum_name">AUTO</span>
2743                     <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
2744 <p>In this mode,<wbr/> the lens does not move unless
2745 the autofocus trigger action is called.<wbr/> When that trigger
2746 is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
2747 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
2748 <p>Always supported if lens is not fixed focus.<wbr/></p>
2749 <p>Use <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> to determine if lens
2750 is fixed-focus.<wbr/></p>
2751 <p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
2752 and sets the AF state to INACTIVE.<wbr/></p></span>
2753                   </li>
2754                   <li>
2755                     <span class="entry_type_enum_name">MACRO</span>
2756                     <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
2757 <p>In this mode,<wbr/> the lens does not move unless the
2758 autofocus trigger action is called.<wbr/> When that trigger is
2759 activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
2760 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
2761 mode is optimized for focusing on objects very close to
2762 the camera.<wbr/></p>
2763 <p>When that trigger is activated,<wbr/> AF will transition to
2764 ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
2765 NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
2766 position to default,<wbr/> and sets the AF state to
2767 INACTIVE.<wbr/></p></span>
2768                   </li>
2769                   <li>
2770                     <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
2771                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
2772 position continually to attempt to provide a
2773 constantly-in-focus image stream.<wbr/></p>
2774 <p>The focusing behavior should be suitable for good quality
2775 video recording; typically this means slower focus
2776 movement and no overshoots.<wbr/> When the AF trigger is not
2777 involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
2778 and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
2779 states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
2780 the algorithm should immediately transition into
2781 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
2782 lens position until a cancel AF trigger is received.<wbr/></p>
2783 <p>Once cancel is received,<wbr/> the algorithm should transition
2784 back to INACTIVE and resume passive scan.<wbr/> Note that this
2785 behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
2786 ongoing PASSIVE_<wbr/>SCAN must immediately be
2787 canceled.<wbr/></p></span>
2788                   </li>
2789                   <li>
2790                     <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
2791                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
2792 position continually to attempt to provide a
2793 constantly-in-focus image stream.<wbr/></p>
2794 <p>The focusing behavior should be suitable for still image
2795 capture; typically this means focusing as fast as
2796 possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
2797 algorithm should start in INACTIVE state,<wbr/> and then
2798 transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
2799 appropriate as it attempts to maintain focus.<wbr/> When the AF
2800 trigger is activated,<wbr/> the algorithm should finish its
2801 PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
2802 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
2803 lens position until a cancel AF trigger is received.<wbr/></p>
2804 <p>When the AF cancel trigger is activated,<wbr/> the algorithm
2805 should transition back to INACTIVE and then act as if it
2806 has just been started.<wbr/></p></span>
2807                   </li>
2808                   <li>
2809                     <span class="entry_type_enum_name">EDOF</span>
2810                     <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
2811 <p>The camera device will produce images with an extended
2812 depth of field automatically; no special focusing
2813 operations need to be done before taking a picture.<wbr/></p>
2814 <p>AF triggers are ignored,<wbr/> and the AF state will always be
2815 INACTIVE.<wbr/></p></span>
2816                   </li>
2817                 </ul>
2818
2819             </td> <!-- entry_type -->
2820
2821             <td class="entry_description">
2822               <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
2823 mode it is set to.<wbr/></p>
2824             </td>
2825
2826             <td class="entry_units">
2827             </td>
2828
2829             <td class="entry_range">
2830               <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
2831             </td>
2832
2833             <td class="entry_tags">
2834               <ul class="entry_tags">
2835                   <li><a href="#tag_BC">BC</a></li>
2836               </ul>
2837             </td>
2838
2839           </tr>
2840           <tr class="entries_header">
2841             <th class="th_details" colspan="5">Details</th>
2842           </tr>
2843           <tr class="entry_cont">
2844             <td class="entry_details" colspan="5">
2845               <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
2846 (i.<wbr/>e.<wbr/> <code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>).<wbr/> Also note that
2847 when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/> the behavior of AF is device
2848 dependent.<wbr/> It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> before
2849 setting <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> to OFF,<wbr/> or set AF mode to OFF when AE is OFF.<wbr/></p>
2850 <p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
2851 the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
2852 in result metadata.<wbr/></p>
2853             </td>
2854           </tr>
2855
2856           <tr class="entries_header">
2857             <th class="th_details" colspan="5">HAL Implementation Details</th>
2858           </tr>
2859           <tr class="entry_cont">
2860             <td class="entry_details" colspan="5">
2861               <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
2862 request (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> <code>==</code> START).<wbr/> After an AF trigger,<wbr/> the afState will end
2863 up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
2864 <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> which indicates that the lens is
2865 locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
2866 after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
2867 the same focal plane remains in focus.<wbr/></p>
2868 <p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
2869 scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
2870 (see <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> the HAL should maintain the
2871 same lock behavior as above.<wbr/></p>
2872 <p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
2873 focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a>.<wbr/>
2874 However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
2875 manual control.<wbr/></p>
2876 <p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
2877 camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
2878 remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
2879 by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
2880 that will arise on camera modules with open-loop VCMs.<wbr/></p>
2881             </td>
2882           </tr>
2883
2884           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2885            <!-- end of entry -->
2886
2887
2888           <tr class="entry" id="controls_android.control.afRegions">
2889             <td class="entry_name
2890              " rowspan="5">
2891               android.<wbr/>control.<wbr/>af<wbr/>Regions
2892             </td>
2893             <td class="entry_type">
2894                 <span class="entry_type_name">int32</span>
2895                 <span class="entry_type_container">x</span>
2896
2897                 <span class="entry_type_array">
2898                   5 x area_count
2899                 </span>
2900               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
2901
2902
2903
2904
2905
2906
2907             </td> <!-- entry_type -->
2908
2909             <td class="entry_description">
2910               <p>List of metering areas to use for auto-focus.<wbr/></p>
2911             </td>
2912
2913             <td class="entry_units">
2914               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
2915             </td>
2916
2917             <td class="entry_range">
2918               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
2919 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
2920             </td>
2921
2922             <td class="entry_tags">
2923               <ul class="entry_tags">
2924                   <li><a href="#tag_BC">BC</a></li>
2925               </ul>
2926             </td>
2927
2928           </tr>
2929           <tr class="entries_header">
2930             <th class="th_details" colspan="5">Details</th>
2931           </tr>
2932           <tr class="entry_cont">
2933             <td class="entry_details" colspan="5">
2934               <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
2935 Otherwise will always be present.<wbr/></p>
2936 <p>The maximum number of focus areas supported by the device is determined by the value
2937 of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
2938 <p>The coordinate system is based on the active pixel array,<wbr/>
2939 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
2940 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
2941 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
2942 bottom-right pixel in the active pixel array.<wbr/></p>
2943 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
2944 for every pixel in the area.<wbr/> This means that a large metering area
2945 with the same weight as a smaller area will have more effect in
2946 the metering result.<wbr/> Metering areas can partially overlap and the
2947 camera device will add the weights in the overlap region.<wbr/></p>
2948 <p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
2949 is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
2950 ignored.<wbr/></p>
2951 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
2952 camera device.<wbr/></p>
2953 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
2954 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
2955 region and output only the intersection rectangle as the metering region in the result
2956 metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
2957 not reported in the result metadata.<wbr/></p>
2958             </td>
2959           </tr>
2960
2961           <tr class="entries_header">
2962             <th class="th_details" colspan="5">HAL Implementation Details</th>
2963           </tr>
2964           <tr class="entry_cont">
2965             <td class="entry_details" colspan="5">
2966               <p>The HAL level representation of MeteringRectangle[] is a
2967 int[5 * area_<wbr/>count].<wbr/>
2968 Every five elements represent a metering region of
2969 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
2970 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
2971 exclusive on xmax and ymax.<wbr/></p>
2972             </td>
2973           </tr>
2974
2975           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
2976            <!-- end of entry -->
2977
2978
2979           <tr class="entry" id="controls_android.control.afTrigger">
2980             <td class="entry_name
2981              " rowspan="5">
2982               android.<wbr/>control.<wbr/>af<wbr/>Trigger
2983             </td>
2984             <td class="entry_type">
2985                 <span class="entry_type_name entry_type_name_enum">byte</span>
2986
2987               <span class="entry_type_visibility"> [public]</span>
2988
2989
2990               <span class="entry_type_hwlevel">[legacy] </span>
2991
2992
2993
2994                 <ul class="entry_type_enum">
2995                   <li>
2996                     <span class="entry_type_enum_name">IDLE</span>
2997                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
2998                   </li>
2999                   <li>
3000                     <span class="entry_type_enum_name">START</span>
3001                     <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
3002                   </li>
3003                   <li>
3004                     <span class="entry_type_enum_name">CANCEL</span>
3005                     <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
3006 state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
3007                   </li>
3008                 </ul>
3009
3010             </td> <!-- entry_type -->
3011
3012             <td class="entry_description">
3013               <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
3014             </td>
3015
3016             <td class="entry_units">
3017             </td>
3018
3019             <td class="entry_range">
3020             </td>
3021
3022             <td class="entry_tags">
3023               <ul class="entry_tags">
3024                   <li><a href="#tag_BC">BC</a></li>
3025               </ul>
3026             </td>
3027
3028           </tr>
3029           <tr class="entries_header">
3030             <th class="th_details" colspan="5">Details</th>
3031           </tr>
3032           <tr class="entry_cont">
3033             <td class="entry_details" colspan="5">
3034               <p>This entry is normally set to IDLE,<wbr/> or is not
3035 included at all in the request settings.<wbr/></p>
3036 <p>When included and set to START,<wbr/> the camera device will trigger the
3037 autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
3038 <p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
3039 and return to its initial AF state.<wbr/></p>
3040 <p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
3041 single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
3042 START for multiple captures in a row means restarting the AF operation over
3043 and over again.<wbr/></p>
3044 <p>See <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for what the trigger means for each AF mode.<wbr/></p>
3045 <p>Using the autofocus trigger and the precapture trigger <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>
3046 simultaneously is allowed.<wbr/> However,<wbr/> since these triggers often require cooperation between
3047 the auto-focus and auto-exposure routines (for example,<wbr/> the may need to be enabled for a
3048 focus sweep),<wbr/> the camera device may delay acting on a later trigger until the previous
3049 trigger has been fully handled.<wbr/> This may lead to longer intervals between the trigger and
3050 changes to <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>,<wbr/> for example.<wbr/></p>
3051             </td>
3052           </tr>
3053
3054           <tr class="entries_header">
3055             <th class="th_details" colspan="5">HAL Implementation Details</th>
3056           </tr>
3057           <tr class="entry_cont">
3058             <td class="entry_details" colspan="5">
3059               <p>The HAL must support triggering the AF trigger while an AE precapture trigger is active
3060 (and vice versa),<wbr/> or at the same time as the AE trigger.<wbr/>  It is acceptable for the HAL to
3061 treat these as two consecutive triggers,<wbr/> for example handling the AF trigger and then the
3062 AE trigger.<wbr/>  Or the HAL may choose to optimize the case with both triggers fired at once,<wbr/>
3063 to minimize the latency for converging both focus and exposure/<wbr/>flash usage.<wbr/></p>
3064             </td>
3065           </tr>
3066
3067           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3068            <!-- end of entry -->
3069
3070
3071           <tr class="entry" id="controls_android.control.awbLock">
3072             <td class="entry_name
3073              " rowspan="3">
3074               android.<wbr/>control.<wbr/>awb<wbr/>Lock
3075             </td>
3076             <td class="entry_type">
3077                 <span class="entry_type_name entry_type_name_enum">byte</span>
3078
3079               <span class="entry_type_visibility"> [public as boolean]</span>
3080
3081
3082               <span class="entry_type_hwlevel">[legacy] </span>
3083
3084
3085
3086                 <ul class="entry_type_enum">
3087                   <li>
3088                     <span class="entry_type_enum_name">OFF</span>
3089                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
3090 algorithm is free to update its parameters if in AUTO
3091 mode.<wbr/></p></span>
3092                   </li>
3093                   <li>
3094                     <span class="entry_type_enum_name">ON</span>
3095                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
3096 algorithm will not update its parameters while the lock
3097 is active.<wbr/></p></span>
3098                   </li>
3099                 </ul>
3100
3101             </td> <!-- entry_type -->
3102
3103             <td class="entry_description">
3104               <p>Whether auto-white balance (AWB) is currently locked to its
3105 latest calculated values.<wbr/></p>
3106             </td>
3107
3108             <td class="entry_units">
3109             </td>
3110
3111             <td class="entry_range">
3112             </td>
3113
3114             <td class="entry_tags">
3115               <ul class="entry_tags">
3116                   <li><a href="#tag_BC">BC</a></li>
3117               </ul>
3118             </td>
3119
3120           </tr>
3121           <tr class="entries_header">
3122             <th class="th_details" colspan="5">Details</th>
3123           </tr>
3124           <tr class="entry_cont">
3125             <td class="entry_details" colspan="5">
3126               <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
3127 and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
3128 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
3129 get locked do not necessarily correspond to the settings that were present in the
3130 latest capture result received from the camera device,<wbr/> since additional captures
3131 and AWB updates may have occurred even before the result was sent out.<wbr/> If an
3132 application is switching between automatic and manual control and wishes to eliminate
3133 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
3134 <ol>
3135 <li>Starting in auto-AWB mode:</li>
3136 <li>Lock AWB</li>
3137 <li>Wait for the first result to be output that has the AWB locked</li>
3138 <li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
3139 <li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
3140 </ol>
3141 <p>Note that AWB lock is only meaningful when
3142 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
3143 AWB is already fixed to a specific setting.<wbr/></p>
3144 <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
3145             </td>
3146           </tr>
3147
3148
3149           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3150            <!-- end of entry -->
3151
3152
3153           <tr class="entry" id="controls_android.control.awbMode">
3154             <td class="entry_name
3155              " rowspan="3">
3156               android.<wbr/>control.<wbr/>awb<wbr/>Mode
3157             </td>
3158             <td class="entry_type">
3159                 <span class="entry_type_name entry_type_name_enum">byte</span>
3160
3161               <span class="entry_type_visibility"> [public]</span>
3162
3163
3164               <span class="entry_type_hwlevel">[legacy] </span>
3165
3166
3167
3168                 <ul class="entry_type_enum">
3169                   <li>
3170                     <span class="entry_type_enum_name">OFF</span>
3171                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
3172 <p>The application-selected color transform matrix
3173 (<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
3174 (<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
3175 device for manual white balance control.<wbr/></p></span>
3176                   </li>
3177                   <li>
3178                     <span class="entry_type_enum_name">AUTO</span>
3179                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
3180 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3181 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3182 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3183 values used by the camera device for the transform and gains
3184 will be available in the capture result for this request.<wbr/></p></span>
3185                   </li>
3186                   <li>
3187                     <span class="entry_type_enum_name">INCANDESCENT</span>
3188                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3189 the camera device uses incandescent light as the assumed scene
3190 illumination for white balance.<wbr/></p>
3191 <p>While the exact white balance transforms are up to the
3192 camera device,<wbr/> they will approximately match the CIE
3193 standard illuminant A.<wbr/></p>
3194 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3195 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3196 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3197 values used by the camera device for the transform and gains
3198 will be available in the capture result for this request.<wbr/></p></span>
3199                   </li>
3200                   <li>
3201                     <span class="entry_type_enum_name">FLUORESCENT</span>
3202                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3203 the camera device uses fluorescent light as the assumed scene
3204 illumination for white balance.<wbr/></p>
3205 <p>While the exact white balance transforms are up to the
3206 camera device,<wbr/> they will approximately match the CIE
3207 standard illuminant F2.<wbr/></p>
3208 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3209 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3210 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3211 values used by the camera device for the transform and gains
3212 will be available in the capture result for this request.<wbr/></p></span>
3213                   </li>
3214                   <li>
3215                     <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
3216                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3217 the camera device uses warm fluorescent light as the assumed scene
3218 illumination for white balance.<wbr/></p>
3219 <p>While the exact white balance transforms are up to the
3220 camera device,<wbr/> they will approximately match the CIE
3221 standard illuminant F4.<wbr/></p>
3222 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3223 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3224 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3225 values used by the camera device for the transform and gains
3226 will be available in the capture result for this request.<wbr/></p></span>
3227                   </li>
3228                   <li>
3229                     <span class="entry_type_enum_name">DAYLIGHT</span>
3230                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3231 the camera device uses daylight light as the assumed scene
3232 illumination for white balance.<wbr/></p>
3233 <p>While the exact white balance transforms are up to the
3234 camera device,<wbr/> they will approximately match the CIE
3235 standard illuminant D65.<wbr/></p>
3236 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3237 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3238 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3239 values used by the camera device for the transform and gains
3240 will be available in the capture result for this request.<wbr/></p></span>
3241                   </li>
3242                   <li>
3243                     <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
3244                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3245 the camera device uses cloudy daylight light as the assumed scene
3246 illumination for white balance.<wbr/></p>
3247 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3248 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3249 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3250 values used by the camera device for the transform and gains
3251 will be available in the capture result for this request.<wbr/></p></span>
3252                   </li>
3253                   <li>
3254                     <span class="entry_type_enum_name">TWILIGHT</span>
3255                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3256 the camera device uses twilight light as the assumed scene
3257 illumination for white balance.<wbr/></p>
3258 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3259 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3260 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3261 values used by the camera device for the transform and gains
3262 will be available in the capture result for this request.<wbr/></p></span>
3263                   </li>
3264                   <li>
3265                     <span class="entry_type_enum_name">SHADE</span>
3266                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
3267 the camera device uses shade light as the assumed scene
3268 illumination for white balance.<wbr/></p>
3269 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
3270 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
3271 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
3272 values used by the camera device for the transform and gains
3273 will be available in the capture result for this request.<wbr/></p></span>
3274                   </li>
3275                 </ul>
3276
3277             </td> <!-- entry_type -->
3278
3279             <td class="entry_description">
3280               <p>Whether auto-white balance (AWB) is currently setting the color
3281 transform fields,<wbr/> and what its illumination target
3282 is.<wbr/></p>
3283             </td>
3284
3285             <td class="entry_units">
3286             </td>
3287
3288             <td class="entry_range">
3289               <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
3290             </td>
3291
3292             <td class="entry_tags">
3293               <ul class="entry_tags">
3294                   <li><a href="#tag_BC">BC</a></li>
3295               </ul>
3296             </td>
3297
3298           </tr>
3299           <tr class="entries_header">
3300             <th class="th_details" colspan="5">Details</th>
3301           </tr>
3302           <tr class="entry_cont">
3303             <td class="entry_details" colspan="5">
3304               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
3305 <p>When set to the ON mode,<wbr/> the camera device's auto-white balance
3306 routine is enabled,<wbr/> overriding the application's selected
3307 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
3308 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/> Note that when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
3309 is OFF,<wbr/> the behavior of AWB is device dependent.<wbr/> It is recommened to
3310 also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> before
3311 setting AE mode to OFF.<wbr/></p>
3312 <p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
3313 routine is disabled.<wbr/> The application manually controls the white
3314 balance by <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>
3315 and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
3316 <p>When set to any other modes,<wbr/> the camera device's auto-white
3317 balance routine is disabled.<wbr/> The camera device uses each
3318 particular illumination target for white balance
3319 adjustment.<wbr/> The application's values for
3320 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/>
3321 <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
3322 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
3323             </td>
3324           </tr>
3325
3326
3327           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3328            <!-- end of entry -->
3329
3330
3331           <tr class="entry" id="controls_android.control.awbRegions">
3332             <td class="entry_name
3333              " rowspan="5">
3334               android.<wbr/>control.<wbr/>awb<wbr/>Regions
3335             </td>
3336             <td class="entry_type">
3337                 <span class="entry_type_name">int32</span>
3338                 <span class="entry_type_container">x</span>
3339
3340                 <span class="entry_type_array">
3341                   5 x area_count
3342                 </span>
3343               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
3344
3345
3346
3347
3348
3349
3350             </td> <!-- entry_type -->
3351
3352             <td class="entry_description">
3353               <p>List of metering areas to use for auto-white-balance illuminant
3354 estimation.<wbr/></p>
3355             </td>
3356
3357             <td class="entry_units">
3358               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
3359             </td>
3360
3361             <td class="entry_range">
3362               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
3363 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
3364             </td>
3365
3366             <td class="entry_tags">
3367               <ul class="entry_tags">
3368                   <li><a href="#tag_BC">BC</a></li>
3369               </ul>
3370             </td>
3371
3372           </tr>
3373           <tr class="entries_header">
3374             <th class="th_details" colspan="5">Details</th>
3375           </tr>
3376           <tr class="entry_cont">
3377             <td class="entry_details" colspan="5">
3378               <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
3379 Otherwise will always be present.<wbr/></p>
3380 <p>The maximum number of regions supported by the device is determined by the value
3381 of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
3382 <p>The coordinate system is based on the active pixel array,<wbr/>
3383 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
3384 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
3385 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
3386 bottom-right pixel in the active pixel array.<wbr/></p>
3387 <p>The weight must range from 0 to 1000,<wbr/> and represents a weight
3388 for every pixel in the area.<wbr/> This means that a large metering area
3389 with the same weight as a smaller area will have more effect in
3390 the metering result.<wbr/> Metering areas can partially overlap and the
3391 camera device will add the weights in the overlap region.<wbr/></p>
3392 <p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
3393 only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
3394 0 weight is ignored.<wbr/></p>
3395 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
3396 camera device.<wbr/></p>
3397 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
3398 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
3399 region and output only the intersection rectangle as the metering region in the result
3400 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
3401 not reported in the result metadata.<wbr/></p>
3402             </td>
3403           </tr>
3404
3405           <tr class="entries_header">
3406             <th class="th_details" colspan="5">HAL Implementation Details</th>
3407           </tr>
3408           <tr class="entry_cont">
3409             <td class="entry_details" colspan="5">
3410               <p>The HAL level representation of MeteringRectangle[] is a
3411 int[5 * area_<wbr/>count].<wbr/>
3412 Every five elements represent a metering region of
3413 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
3414 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
3415 exclusive on xmax and ymax.<wbr/></p>
3416             </td>
3417           </tr>
3418
3419           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3420            <!-- end of entry -->
3421
3422
3423           <tr class="entry" id="controls_android.control.captureIntent">
3424             <td class="entry_name
3425              " rowspan="3">
3426               android.<wbr/>control.<wbr/>capture<wbr/>Intent
3427             </td>
3428             <td class="entry_type">
3429                 <span class="entry_type_name entry_type_name_enum">byte</span>
3430
3431               <span class="entry_type_visibility"> [public]</span>
3432
3433
3434               <span class="entry_type_hwlevel">[legacy] </span>
3435
3436
3437
3438                 <ul class="entry_type_enum">
3439                   <li>
3440                     <span class="entry_type_enum_name">CUSTOM</span>
3441                     <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
3442 categories.<wbr/> The camera device will default to preview-like
3443 behavior.<wbr/></p></span>
3444                   </li>
3445                   <li>
3446                     <span class="entry_type_enum_name">PREVIEW</span>
3447                     <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
3448 <p>The precapture trigger may be used to start off a metering
3449 w/<wbr/>flash sequence.<wbr/></p></span>
3450                   </li>
3451                   <li>
3452                     <span class="entry_type_enum_name">STILL_CAPTURE</span>
3453                     <span class="entry_type_enum_notes"><p>This request is for a still capture-type
3454 use case.<wbr/></p>
3455 <p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
3456                   </li>
3457                   <li>
3458                     <span class="entry_type_enum_name">VIDEO_RECORD</span>
3459                     <span class="entry_type_enum_notes"><p>This request is for a video recording
3460 use case.<wbr/></p></span>
3461                   </li>
3462                   <li>
3463                     <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
3464                     <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
3465 image while recording video) use case.<wbr/></p>
3466 <p>The camera device should take the highest-quality image
3467 possible (given the other settings) without disrupting the
3468 frame rate of video recording.<wbr/>  </p></span>
3469                   </li>
3470                   <li>
3471                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
3472                     <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
3473 application will stream full-resolution images and
3474 reprocess one or several later for a final
3475 capture.<wbr/></p></span>
3476                   </li>
3477                   <li>
3478                     <span class="entry_type_enum_name">MANUAL</span>
3479                     <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
3480 the applications want to directly control the capture parameters.<wbr/></p>
3481 <p>For example,<wbr/> the application may wish to manually control
3482 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> etc.<wbr/></p></span>
3483                   </li>
3484                 </ul>
3485
3486             </td> <!-- entry_type -->
3487
3488             <td class="entry_description">
3489               <p>Information to the camera device 3A (auto-exposure,<wbr/>
3490 auto-focus,<wbr/> auto-white balance) routines about the purpose
3491 of this capture,<wbr/> to help the camera device to decide optimal 3A
3492 strategy.<wbr/></p>
3493             </td>
3494
3495             <td class="entry_units">
3496             </td>
3497
3498             <td class="entry_range">
3499             </td>
3500
3501             <td class="entry_tags">
3502               <ul class="entry_tags">
3503                   <li><a href="#tag_BC">BC</a></li>
3504               </ul>
3505             </td>
3506
3507           </tr>
3508           <tr class="entries_header">
3509             <th class="th_details" colspan="5">Details</th>
3510           </tr>
3511           <tr class="entry_cont">
3512             <td class="entry_details" colspan="5">
3513               <p>This control (except for MANUAL) is only effective if
3514 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
3515 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
3516 contains PRIVATE_<wbr/>REPROCESSING or YUV_<wbr/>REPROCESSING.<wbr/> MANUAL will be supported if
3517 <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are
3518 always supported.<wbr/></p>
3519             </td>
3520           </tr>
3521
3522
3523           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3524            <!-- end of entry -->
3525
3526
3527           <tr class="entry" id="controls_android.control.effectMode">
3528             <td class="entry_name
3529              " rowspan="3">
3530               android.<wbr/>control.<wbr/>effect<wbr/>Mode
3531             </td>
3532             <td class="entry_type">
3533                 <span class="entry_type_name entry_type_name_enum">byte</span>
3534
3535               <span class="entry_type_visibility"> [public]</span>
3536
3537
3538               <span class="entry_type_hwlevel">[legacy] </span>
3539
3540
3541
3542                 <ul class="entry_type_enum">
3543                   <li>
3544                     <span class="entry_type_enum_name">OFF</span>
3545                     <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
3546                   </li>
3547                   <li>
3548                     <span class="entry_type_enum_name">MONO</span>
3549                     <span class="entry_type_enum_optional">[optional]</span>
3550                     <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
3551 a single color.<wbr/></p>
3552 <p>This will typically be grayscale.<wbr/></p></span>
3553                   </li>
3554                   <li>
3555                     <span class="entry_type_enum_name">NEGATIVE</span>
3556                     <span class="entry_type_enum_optional">[optional]</span>
3557                     <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
3558 are inverted.<wbr/></p></span>
3559                   </li>
3560                   <li>
3561                     <span class="entry_type_enum_name">SOLARIZE</span>
3562                     <span class="entry_type_enum_optional">[optional]</span>
3563                     <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
3564 image is wholly or partially reversed in
3565 tone.<wbr/></p></span>
3566                   </li>
3567                   <li>
3568                     <span class="entry_type_enum_name">SEPIA</span>
3569                     <span class="entry_type_enum_optional">[optional]</span>
3570                     <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
3571 gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
3572                   </li>
3573                   <li>
3574                     <span class="entry_type_enum_name">POSTERIZE</span>
3575                     <span class="entry_type_enum_optional">[optional]</span>
3576                     <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
3577 discrete regions of tone rather than a continuous
3578 gradient of tones.<wbr/></p></span>
3579                   </li>
3580                   <li>
3581                     <span class="entry_type_enum_name">WHITEBOARD</span>
3582                     <span class="entry_type_enum_optional">[optional]</span>
3583                     <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
3584 as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
3585                   </li>
3586                   <li>
3587                     <span class="entry_type_enum_name">BLACKBOARD</span>
3588                     <span class="entry_type_enum_optional">[optional]</span>
3589                     <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
3590 as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
3591                   </li>
3592                   <li>
3593                     <span class="entry_type_enum_name">AQUA</span>
3594                     <span class="entry_type_enum_optional">[optional]</span>
3595                     <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
3596                   </li>
3597                 </ul>
3598
3599             </td> <!-- entry_type -->
3600
3601             <td class="entry_description">
3602               <p>A special color effect to apply.<wbr/></p>
3603             </td>
3604
3605             <td class="entry_units">
3606             </td>
3607
3608             <td class="entry_range">
3609               <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
3610             </td>
3611
3612             <td class="entry_tags">
3613               <ul class="entry_tags">
3614                   <li><a href="#tag_BC">BC</a></li>
3615               </ul>
3616             </td>
3617
3618           </tr>
3619           <tr class="entries_header">
3620             <th class="th_details" colspan="5">Details</th>
3621           </tr>
3622           <tr class="entry_cont">
3623             <td class="entry_details" colspan="5">
3624               <p>When this mode is set,<wbr/> a color effect will be applied
3625 to images produced by the camera device.<wbr/> The interpretation
3626 and implementation of these color effects is left to the
3627 implementor of the camera device,<wbr/> and should not be
3628 depended on to be consistent (or present) across all
3629 devices.<wbr/></p>
3630             </td>
3631           </tr>
3632
3633
3634           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3635            <!-- end of entry -->
3636
3637
3638           <tr class="entry" id="controls_android.control.mode">
3639             <td class="entry_name
3640              " rowspan="3">
3641               android.<wbr/>control.<wbr/>mode
3642             </td>
3643             <td class="entry_type">
3644                 <span class="entry_type_name entry_type_name_enum">byte</span>
3645
3646               <span class="entry_type_visibility"> [public]</span>
3647
3648
3649               <span class="entry_type_hwlevel">[legacy] </span>
3650
3651
3652
3653                 <ul class="entry_type_enum">
3654                   <li>
3655                     <span class="entry_type_enum_name">OFF</span>
3656                     <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
3657 <p>All control by the device's metering and focusing (3A)
3658 routines is disabled,<wbr/> and no other settings in
3659 android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
3660 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
3661 device to select post-processing values for processing
3662 blocks that do not allow for manual control,<wbr/> or are not
3663 exposed by the camera API.<wbr/></p>
3664 <p>However,<wbr/> the camera device's 3A routines may continue to
3665 collect statistics and update their internal state so that
3666 when control is switched to AUTO mode,<wbr/> good control values
3667 can be immediately applied.<wbr/></p></span>
3668                   </li>
3669                   <li>
3670                     <span class="entry_type_enum_name">AUTO</span>
3671                     <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
3672 <p>Manual control of capture parameters is disabled.<wbr/> All
3673 controls in android.<wbr/>control.<wbr/>* besides sceneMode take
3674 effect.<wbr/></p></span>
3675                   </li>
3676                   <li>
3677                     <span class="entry_type_enum_name">USE_SCENE_MODE</span>
3678                     <span class="entry_type_enum_optional">[optional]</span>
3679                     <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
3680 <p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
3681 control.<wbr/>afMode controls; the camera device will ignore
3682 those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
3683 FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still active.<wbr/>
3684 This setting can only be used if scene mode is supported (i.<wbr/>e.<wbr/>
3685 <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
3686 contain some modes other than DISABLED).<wbr/></p></span>
3687                   </li>
3688                   <li>
3689                     <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
3690                     <span class="entry_type_enum_optional">[optional]</span>
3691                     <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
3692 used by camera device background auto-exposure,<wbr/> auto-white balance and
3693 auto-focus algorithms (3A) to update their statistics.<wbr/></p>
3694 <p>Specifically,<wbr/> the 3A routines are locked to the last
3695 values set from a request with AUTO,<wbr/> OFF,<wbr/> or
3696 USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
3697 collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
3698 discarded by the camera device.<wbr/></p></span>
3699                   </li>
3700                 </ul>
3701
3702             </td> <!-- entry_type -->
3703
3704             <td class="entry_description">
3705               <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
3706 routines.<wbr/></p>
3707             </td>
3708
3709             <td class="entry_units">
3710             </td>
3711
3712             <td class="entry_range">
3713               <p><a href="#static_android.control.availableModes">android.<wbr/>control.<wbr/>available<wbr/>Modes</a></p>
3714             </td>
3715
3716             <td class="entry_tags">
3717               <ul class="entry_tags">
3718                   <li><a href="#tag_BC">BC</a></li>
3719               </ul>
3720             </td>
3721
3722           </tr>
3723           <tr class="entries_header">
3724             <th class="th_details" colspan="5">Details</th>
3725           </tr>
3726           <tr class="entry_cont">
3727             <td class="entry_details" colspan="5">
3728               <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
3729 by the camera device is disabled.<wbr/> The application must set the fields for
3730 capture parameters itself.<wbr/></p>
3731 <p>When set to AUTO,<wbr/> the individual algorithm controls in
3732 android.<wbr/>control.<wbr/>* are in effect,<wbr/> such as <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>.<wbr/></p>
3733 <p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
3734 android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
3735 one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
3736 as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
3737 <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">capture results</a>.<wbr/></p>
3738 <p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
3739 is that this frame will not be used by camera device background 3A statistics
3740 update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
3741 where the application doesn't want a 3A manual control capture to affect
3742 the subsequent auto 3A capture results.<wbr/></p>
3743             </td>
3744           </tr>
3745
3746
3747           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
3748            <!-- end of entry -->
3749
3750
3751           <tr class="entry" id="controls_android.control.sceneMode">
3752             <td class="entry_name
3753              " rowspan="5">
3754               android.<wbr/>control.<wbr/>scene<wbr/>Mode
3755             </td>
3756             <td class="entry_type">
3757                 <span class="entry_type_name entry_type_name_enum">byte</span>
3758
3759               <span class="entry_type_visibility"> [public]</span>
3760
3761
3762               <span class="entry_type_hwlevel">[legacy] </span>
3763
3764
3765
3766                 <ul class="entry_type_enum">
3767                   <li>
3768                     <span class="entry_type_enum_name">DISABLED</span>
3769                     <span class="entry_type_enum_value">0</span>
3770                     <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
3771                   </li>
3772                   <li>
3773                     <span class="entry_type_enum_name">FACE_PRIORITY</span>
3774                     <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
3775 detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
3776 auto-exposure routines.<wbr/></p>
3777 <p>If face detection statistics are disabled
3778 (i.<wbr/>e.<wbr/> <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> is set to OFF),<wbr/>
3779 this should still operate correctly (but will not return
3780 face detection statistics to the framework).<wbr/></p>
3781 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
3782 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
3783 remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
3784                   </li>
3785                   <li>
3786                     <span class="entry_type_enum_name">ACTION</span>
3787                     <span class="entry_type_enum_optional">[optional]</span>
3788                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
3789 <p>Similar to SPORTS.<wbr/></p></span>
3790                   </li>
3791                   <li>
3792                     <span class="entry_type_enum_name">PORTRAIT</span>
3793                     <span class="entry_type_enum_optional">[optional]</span>
3794                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
3795                   </li>
3796                   <li>
3797                     <span class="entry_type_enum_name">LANDSCAPE</span>
3798                     <span class="entry_type_enum_optional">[optional]</span>
3799                     <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
3800                   </li>
3801                   <li>
3802                     <span class="entry_type_enum_name">NIGHT</span>
3803                     <span class="entry_type_enum_optional">[optional]</span>
3804                     <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
3805                   </li>
3806                   <li>
3807                     <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
3808                     <span class="entry_type_enum_optional">[optional]</span>
3809                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
3810 settings.<wbr/></p></span>
3811                   </li>
3812                   <li>
3813                     <span class="entry_type_enum_name">THEATRE</span>
3814                     <span class="entry_type_enum_optional">[optional]</span>
3815                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
3816 remain off.<wbr/></p></span>
3817                   </li>
3818                   <li>
3819                     <span class="entry_type_enum_name">BEACH</span>
3820                     <span class="entry_type_enum_optional">[optional]</span>
3821                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
3822                   </li>
3823                   <li>
3824                     <span class="entry_type_enum_name">SNOW</span>
3825                     <span class="entry_type_enum_optional">[optional]</span>
3826                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
3827                   </li>
3828                   <li>
3829                     <span class="entry_type_enum_name">SUNSET</span>
3830                     <span class="entry_type_enum_optional">[optional]</span>
3831                     <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
3832                   </li>
3833                   <li>
3834                     <span class="entry_type_enum_name">STEADYPHOTO</span>
3835                     <span class="entry_type_enum_optional">[optional]</span>
3836                     <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
3837 device motion (for example: due to hand shake).<wbr/></p></span>
3838                   </li>
3839                   <li>
3840                     <span class="entry_type_enum_name">FIREWORKS</span>
3841                     <span class="entry_type_enum_optional">[optional]</span>
3842                     <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
3843                   </li>
3844                   <li>
3845                     <span class="entry_type_enum_name">SPORTS</span>
3846                     <span class="entry_type_enum_optional">[optional]</span>
3847                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
3848 <p>Similar to ACTION.<wbr/></p></span>
3849                   </li>
3850                   <li>
3851                     <span class="entry_type_enum_name">PARTY</span>
3852                     <span class="entry_type_enum_optional">[optional]</span>
3853                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
3854 people.<wbr/></p></span>
3855                   </li>
3856                   <li>
3857                     <span class="entry_type_enum_name">CANDLELIGHT</span>
3858                     <span class="entry_type_enum_optional">[optional]</span>
3859                     <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
3860 is a flame.<wbr/></p></span>
3861                   </li>
3862                   <li>
3863                     <span class="entry_type_enum_name">BARCODE</span>
3864                     <span class="entry_type_enum_optional">[optional]</span>
3865                     <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
3866 for use by camera applications that wish to read the
3867 barcode value.<wbr/></p></span>
3868                   </li>
3869                   <li>
3870                     <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
3871                     <span class="entry_type_enum_deprecated">[deprecated]</span>
3872                     <span class="entry_type_enum_optional">[optional]</span>
3873                     <span class="entry_type_enum_notes"><p>This is deprecated,<wbr/> please use <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>
3874 and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>
3875 for high speed video recording.<wbr/></p>
3876 <p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
3877 <p>The supported high speed video sizes and fps ranges are specified in
3878 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
3879 output frame rates,<wbr/> the application is only allowed to select video size
3880 and fps range combinations listed in this static metadata.<wbr/> The fps range
3881 can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
3882 <p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
3883 ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
3884 controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
3885 and post-processing parameters is possible.<wbr/> All other controls operate the
3886 same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
3887 android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
3888 <ul>
3889 <li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
3890 <li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
3891 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
3892 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
3893 <li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
3894 <li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
3895 <li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
3896 <li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
3897 <li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
3898 <li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
3899 </ul>
3900 <p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
3901 <ul>
3902 <li><a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>
3903 <li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
3904 <li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
3905 <li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
3906 </ul>
3907 <p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
3908 be lower than what camera can output,<wbr/> depending on the destination Surfaces for
3909 the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
3910 the application need check if the video encoder is capable of supporting the
3911 high frame rate for a given video size,<wbr/> or it will end up with lower recording
3912 frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
3913 rate will be bounded by the screen refresh rate.<wbr/></p>
3914 <p>The camera device will only support up to 2 output high speed streams
3915 (processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
3916 in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
3917 <ul>
3918 <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
3919 format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
3920 min(2,<wbr/> <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>[Processed (but not-stalling)]).<wbr/></li>
3921 <li>The stream sizes are selected from the sizes reported by
3922 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
3923 <li>No processed non-stalling or raw streams are configured.<wbr/></li>
3924 </ul>
3925 <p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
3926 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> will be ignored by the camera device,<wbr/>
3927 the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
3928 and the returned capture result metadata will give the fps range choosen
3929 by the camera device.<wbr/></p>
3930 <p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
3931 reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
3932 the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
3933                   </li>
3934                   <li>
3935                     <span class="entry_type_enum_name">HDR</span>
3936                     <span class="entry_type_enum_optional">[optional]</span>
3937                     <span class="entry_type_enum_notes"><p>Turn on a device-specific high dynamic range (HDR) mode.<wbr/></p>
3938 <p>In this scene mode,<wbr/> the camera device captures images
3939 that keep a larger range of scene illumination levels
3940 visible in the final image.<wbr/> For example,<wbr/> when taking a
3941 picture of a object in front of a bright window,<wbr/> both
3942 the object and the scene through the window may be
3943 visible when using HDR mode,<wbr/> while in normal AUTO mode,<wbr/>
3944 one or the other may be poorly exposed.<wbr/> As a tradeoff,<wbr/>
3945 HDR mode generally takes much longer to capture a single
3946 image,<wbr/> has no user control,<wbr/> and may have other artifacts
3947 depending on the HDR method used.<wbr/></p>
3948 <p>Therefore,<wbr/> HDR captures operate at a much slower rate
3949 than regular captures.<wbr/></p>
3950 <p>In this mode,<wbr/> on LIMITED or FULL devices,<wbr/> when a request
3951 is made with a <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> of
3952 STILL_<wbr/>CAPTURE,<wbr/> the camera device will capture an image
3953 using a high dynamic range capture technique.<wbr/>  On LEGACY
3954 devices,<wbr/> captures that target a JPEG-format output will
3955 be captured with HDR,<wbr/> and the capture intent is not
3956 relevant.<wbr/></p>
3957 <p>The HDR capture may involve the device capturing a burst
3958 of images internally and combining them into one,<wbr/> or it
3959 may involve the device using specialized high dynamic
3960 range capture hardware.<wbr/> In all cases,<wbr/> a single image is
3961 produced in response to a capture request submitted
3962 while in HDR mode.<wbr/></p>
3963 <p>Since substantial post-processing is generally needed to
3964 produce an HDR image,<wbr/> only YUV,<wbr/> PRIVATE,<wbr/> and JPEG
3965 outputs are supported for LIMITED/<wbr/>FULL device HDR
3966 captures,<wbr/> and only JPEG outputs are supported for LEGACY
3967 HDR captures.<wbr/> Using a RAW output for HDR capture is not
3968 supported.<wbr/></p>
3969 <p>Some devices may also support always-on HDR,<wbr/> which
3970 applies HDR processing at full frame rate.<wbr/>  For these
3971 devices,<wbr/> intents other than STILL_<wbr/>CAPTURE will also
3972 produce an HDR output with no frame rate impact compared
3973 to normal operation,<wbr/> though the quality may be lower
3974 than for STILL_<wbr/>CAPTURE intents.<wbr/></p>
3975 <p>If SCENE_<wbr/>MODE_<wbr/>HDR is used with unsupported output types
3976 or capture intents,<wbr/> the images captured will be as if
3977 the SCENE_<wbr/>MODE was not enabled at all.<wbr/></p></span>
3978                   </li>
3979                   <li>
3980                     <span class="entry_type_enum_name">FACE_PRIORITY_LOW_LIGHT</span>
3981                     <span class="entry_type_enum_optional">[optional]</span>
3982                     <span class="entry_type_enum_hidden">[hidden]</span>
3983                     <span class="entry_type_enum_notes"><p>Same as FACE_<wbr/>PRIORITY scene mode,<wbr/> except that the camera
3984 device will choose higher sensitivity values (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
3985 under low light conditions.<wbr/></p>
3986 <p>The camera device may be tuned to expose the images in a reduced
3987 sensitivity range to produce the best quality images.<wbr/> For example,<wbr/>
3988 if the <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a> gives range of [100,<wbr/> 1600],<wbr/>
3989 the camera device auto-exposure routine tuning process may limit the actual
3990 exposure sensitivity range to [100,<wbr/> 1200] to ensure that the noise level isn't
3991 exessive in order to preserve the image quality.<wbr/> Under this situation,<wbr/> the image under
3992 low light may be under-exposed when the sensor max exposure time (bounded by the
3993 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of the
3994 ON_<wbr/>* modes) and effective max sensitivity are reached.<wbr/> This scene mode allows the
3995 camera device auto-exposure routine to increase the sensitivity up to the max
3996 sensitivity specified by <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a> when the scene is too
3997 dark and the max exposure time is reached.<wbr/> The captured images may be noisier
3998 compared with the images captured in normal FACE_<wbr/>PRIORITY mode; therefore,<wbr/> it is
3999 recommended that the application only use this scene mode when it is capable of
4000 reducing the noise level of the captured images.<wbr/></p>
4001 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
4002 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
4003 remain active when FACE_<wbr/>PRIORITY_<wbr/>LOW_<wbr/>LIGHT is set.<wbr/></p></span>
4004                   </li>
4005                   <li>
4006                     <span class="entry_type_enum_name">DEVICE_CUSTOM_START</span>
4007                     <span class="entry_type_enum_optional">[optional]</span>
4008                     <span class="entry_type_enum_hidden">[hidden]</span>
4009                     <span class="entry_type_enum_value">100</span>
4010                     <span class="entry_type_enum_notes"><p>Scene mode values within the range of
4011 <code>[DEVICE_<wbr/>CUSTOM_<wbr/>START,<wbr/> DEVICE_<wbr/>CUSTOM_<wbr/>END]</code> are reserved for device specific
4012 customized scene modes.<wbr/></p></span>
4013                   </li>
4014                   <li>
4015                     <span class="entry_type_enum_name">DEVICE_CUSTOM_END</span>
4016                     <span class="entry_type_enum_optional">[optional]</span>
4017                     <span class="entry_type_enum_hidden">[hidden]</span>
4018                     <span class="entry_type_enum_value">127</span>
4019                     <span class="entry_type_enum_notes"><p>Scene mode values within the range of
4020 <code>[DEVICE_<wbr/>CUSTOM_<wbr/>START,<wbr/> DEVICE_<wbr/>CUSTOM_<wbr/>END]</code> are reserved for device specific
4021 customized scene modes.<wbr/></p></span>
4022                   </li>
4023                 </ul>
4024
4025             </td> <!-- entry_type -->
4026
4027             <td class="entry_description">
4028               <p>Control for which scene mode is currently active.<wbr/></p>
4029             </td>
4030
4031             <td class="entry_units">
4032             </td>
4033
4034             <td class="entry_range">
4035               <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
4036             </td>
4037
4038             <td class="entry_tags">
4039               <ul class="entry_tags">
4040                   <li><a href="#tag_BC">BC</a></li>
4041               </ul>
4042             </td>
4043
4044           </tr>
4045           <tr class="entries_header">
4046             <th class="th_details" colspan="5">Details</th>
4047           </tr>
4048           <tr class="entry_cont">
4049             <td class="entry_details" colspan="5">
4050               <p>Scene modes are custom camera modes optimized for a certain set of conditions and
4051 capture settings.<wbr/></p>
4052 <p>This is the mode that that is active when
4053 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code>.<wbr/> Aside from FACE_<wbr/>PRIORITY,<wbr/> these modes will
4054 disable <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
4055 while in use.<wbr/></p>
4056 <p>The interpretation and implementation of these scene modes is left
4057 to the implementor of the camera device.<wbr/> Their behavior will not be
4058 consistent across all devices,<wbr/> and any given device may only implement
4059 a subset of these modes.<wbr/></p>
4060             </td>
4061           </tr>
4062
4063           <tr class="entries_header">
4064             <th class="th_details" colspan="5">HAL Implementation Details</th>
4065           </tr>
4066           <tr class="entry_cont">
4067             <td class="entry_details" colspan="5">
4068               <p>HAL implementations that include scene modes are expected to provide
4069 the per-scene settings to use for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
4070 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
4071 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
4072 <p>For HIGH_<wbr/>SPEED_<wbr/>VIDEO mode,<wbr/> if it is included in <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>,<wbr/>
4073 the HAL must list supported video size and fps range in
4074 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> For a given size,<wbr/> e.<wbr/>g.<wbr/>
4075 1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
4076 mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
4077 requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/>
4078 This mode is deprecated in HAL3.<wbr/>3,<wbr/> to support high speed video recording,<wbr/> please implement
4079 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a> and CONSTRAINED_<wbr/>HIGH_<wbr/>SPEED_<wbr/>VIDEO
4080 capbility defined in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
4081             </td>
4082           </tr>
4083
4084           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4085            <!-- end of entry -->
4086
4087
4088           <tr class="entry" id="controls_android.control.videoStabilizationMode">
4089             <td class="entry_name
4090              " rowspan="3">
4091               android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
4092             </td>
4093             <td class="entry_type">
4094                 <span class="entry_type_name entry_type_name_enum">byte</span>
4095
4096               <span class="entry_type_visibility"> [public]</span>
4097
4098
4099               <span class="entry_type_hwlevel">[legacy] </span>
4100
4101
4102
4103                 <ul class="entry_type_enum">
4104                   <li>
4105                     <span class="entry_type_enum_name">OFF</span>
4106                     <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
4107                   </li>
4108                   <li>
4109                     <span class="entry_type_enum_name">ON</span>
4110                     <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
4111                   </li>
4112                 </ul>
4113
4114             </td> <!-- entry_type -->
4115
4116             <td class="entry_description">
4117               <p>Whether video stabilization is
4118 active.<wbr/></p>
4119             </td>
4120
4121             <td class="entry_units">
4122             </td>
4123
4124             <td class="entry_range">
4125             </td>
4126
4127             <td class="entry_tags">
4128               <ul class="entry_tags">
4129                   <li><a href="#tag_BC">BC</a></li>
4130               </ul>
4131             </td>
4132
4133           </tr>
4134           <tr class="entries_header">
4135             <th class="th_details" colspan="5">Details</th>
4136           </tr>
4137           <tr class="entry_cont">
4138             <td class="entry_details" colspan="5">
4139               <p>Video stabilization automatically warps images from
4140 the camera in order to stabilize motion between consecutive frames.<wbr/></p>
4141 <p>If enabled,<wbr/> video stabilization can modify the
4142 <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
4143 <p>Switching between different video stabilization modes may take several
4144 frames to initialize,<wbr/> the camera device will report the current mode
4145 in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
4146 the video stabilization modes in the first several capture results may
4147 still be "OFF",<wbr/> and it will become "ON" when the initialization is
4148 done.<wbr/></p>
4149 <p>In addition,<wbr/> not all recording sizes or frame rates may be supported for
4150 stabilization by a device that reports stabilization support.<wbr/> It is guaranteed
4151 that an output targeting a MediaRecorder or MediaCodec will be stabilized if
4152 the recording resolution is less than or equal to 1920 x 1080 (width less than
4153 or equal to 1920,<wbr/> height less than or equal to 1080),<wbr/> and the recording
4154 frame rate is less than or equal to 30fps.<wbr/>  At other sizes,<wbr/> the CaptureResult
4155 <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a> field will return
4156 OFF if the recording output is not stabilized,<wbr/> or if there are no output
4157 Surface types that can be stabilized.<wbr/></p>
4158 <p>If a camera device supports both this mode and OIS
4159 (<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
4160 produce undesirable interaction,<wbr/> so it is recommended not to enable
4161 both at the same time.<wbr/></p>
4162             </td>
4163           </tr>
4164
4165
4166           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4167            <!-- end of entry -->
4168
4169
4170           <tr class="entry" id="controls_android.control.postRawSensitivityBoost">
4171             <td class="entry_name
4172              " rowspan="3">
4173               android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost
4174             </td>
4175             <td class="entry_type">
4176                 <span class="entry_type_name">int32</span>
4177
4178               <span class="entry_type_visibility"> [public]</span>
4179
4180
4181
4182
4183
4184
4185             </td> <!-- entry_type -->
4186
4187             <td class="entry_description">
4188               <p>The amount of additional sensitivity boost applied to output images
4189 after RAW sensor data is captured.<wbr/></p>
4190             </td>
4191
4192             <td class="entry_units">
4193               ISO arithmetic units,<wbr/> the same as android.<wbr/>sensor.<wbr/>sensitivity
4194             </td>
4195
4196             <td class="entry_range">
4197               <p><a href="#static_android.control.postRawSensitivityBoostRange">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost<wbr/>Range</a></p>
4198             </td>
4199
4200             <td class="entry_tags">
4201             </td>
4202
4203           </tr>
4204           <tr class="entries_header">
4205             <th class="th_details" colspan="5">Details</th>
4206           </tr>
4207           <tr class="entry_cont">
4208             <td class="entry_details" colspan="5">
4209               <p>Some camera devices support additional digital sensitivity boosting in the
4210 camera processing pipeline after sensor RAW image is captured.<wbr/>
4211 Such a boost will be applied to YUV/<wbr/>JPEG format output images but will not
4212 have effect on RAW output formats like RAW_<wbr/>SENSOR,<wbr/> RAW10,<wbr/> RAW12 or RAW_<wbr/>OPAQUE.<wbr/></p>
4213 <p>This key will be <code>null</code> for devices that do not support any RAW format
4214 outputs.<wbr/> For devices that do support RAW format outputs,<wbr/> this key will always
4215 present,<wbr/> and if a device does not support post RAW sensitivity boost,<wbr/> it will
4216 list <code>100</code> in this key.<wbr/></p>
4217 <p>If the camera device cannot apply the exact boost requested,<wbr/> it will reduce the
4218 boost to the nearest supported value.<wbr/>
4219 The final boost value used will be available in the output capture result.<wbr/></p>
4220 <p>For devices that support post RAW sensitivity boost,<wbr/> the YUV/<wbr/>JPEG output images
4221 of such device will have the total sensitivity of
4222 <code><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> * <a href="#controls_android.control.postRawSensitivityBoost">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost</a> /<wbr/> 100</code>
4223 The sensitivity of RAW format images will always be <code><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></code></p>
4224 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
4225 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
4226             </td>
4227           </tr>
4228
4229
4230           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4231            <!-- end of entry -->
4232
4233
4234           <tr class="entry" id="controls_android.control.enableZsl">
4235             <td class="entry_name
4236              " rowspan="5">
4237               android.<wbr/>control.<wbr/>enable<wbr/>Zsl
4238             </td>
4239             <td class="entry_type">
4240                 <span class="entry_type_name entry_type_name_enum">byte</span>
4241
4242               <span class="entry_type_visibility"> [public as boolean]</span>
4243
4244
4245
4246
4247
4248                 <ul class="entry_type_enum">
4249                   <li>
4250                     <span class="entry_type_enum_name">FALSE</span>
4251                     <span class="entry_type_enum_notes"><p>Requests with <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE must be captured
4252 after previous requests.<wbr/></p></span>
4253                   </li>
4254                   <li>
4255                     <span class="entry_type_enum_name">TRUE</span>
4256                     <span class="entry_type_enum_notes"><p>Requests with <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE may or may not be
4257 captured before previous requests.<wbr/></p></span>
4258                   </li>
4259                 </ul>
4260
4261             </td> <!-- entry_type -->
4262
4263             <td class="entry_description">
4264               <p>Allow camera device to enable zero-shutter-lag mode for requests with
4265 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE.<wbr/></p>
4266             </td>
4267
4268             <td class="entry_units">
4269             </td>
4270
4271             <td class="entry_range">
4272             </td>
4273
4274             <td class="entry_tags">
4275             </td>
4276
4277           </tr>
4278           <tr class="entries_header">
4279             <th class="th_details" colspan="5">Details</th>
4280           </tr>
4281           <tr class="entry_cont">
4282             <td class="entry_details" colspan="5">
4283               <p>If enableZsl is <code>true</code>,<wbr/> the camera device may enable zero-shutter-lag mode for requests with
4284 STILL_<wbr/>CAPTURE capture intent.<wbr/> The camera device may use images captured in the past to
4285 produce output images for a zero-shutter-lag request.<wbr/> The result metadata including the
4286 <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> reflects the source frames used to produce output images.<wbr/>
4287 Therefore,<wbr/> the contents of the output images and the result metadata may be out of order
4288 compared to previous regular requests.<wbr/> enableZsl does not affect requests with other
4289 capture intents.<wbr/></p>
4290 <p>For example,<wbr/> when requests are submitted in the following order:
4291   Request A: enableZsl is ON,<wbr/> <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> is PREVIEW
4292   Request B: enableZsl is ON,<wbr/> <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> is STILL_<wbr/>CAPTURE</p>
4293 <p>The output images for request B may have contents captured before the output images for
4294 request A,<wbr/> and the result metadata for request B may be older than the result metadata for
4295 request A.<wbr/></p>
4296 <p>Note that when enableZsl is <code>true</code>,<wbr/> it is not guaranteed to get output images captured in
4297 the past for requests with STILL_<wbr/>CAPTURE capture intent.<wbr/></p>
4298 <p>For applications targeting SDK versions O and newer,<wbr/> the value of enableZsl in
4299 TEMPLATE_<wbr/>STILL_<wbr/>CAPTURE template may be <code>true</code>.<wbr/> The value in other templates is always
4300 <code>false</code> if present.<wbr/></p>
4301 <p>For applications targeting SDK versions older than O,<wbr/> the value of enableZsl in all
4302 capture templates is always <code>false</code> if present.<wbr/></p>
4303             </td>
4304           </tr>
4305
4306           <tr class="entries_header">
4307             <th class="th_details" colspan="5">HAL Implementation Details</th>
4308           </tr>
4309           <tr class="entry_cont">
4310             <td class="entry_details" colspan="5">
4311               <p>It is valid for HAL to produce regular output images for requests with STILL_<wbr/>CAPTURE
4312 capture intent.<wbr/></p>
4313             </td>
4314           </tr>
4315
4316           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4317            <!-- end of entry -->
4318
4319
4320
4321       <!-- end of kind -->
4322       </tbody>
4323       <tr><td colspan="6" class="kind">static</td></tr>
4324
4325       <thead class="entries_header">
4326         <tr>
4327           <th class="th_name">Property Name</th>
4328           <th class="th_type">Type</th>
4329           <th class="th_description">Description</th>
4330           <th class="th_units">Units</th>
4331           <th class="th_range">Range</th>
4332           <th class="th_tags">Tags</th>
4333         </tr>
4334       </thead>
4335
4336       <tbody>
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347           <tr class="entry" id="static_android.control.aeAvailableAntibandingModes">
4348             <td class="entry_name
4349              " rowspan="3">
4350               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes
4351             </td>
4352             <td class="entry_type">
4353                 <span class="entry_type_name">byte</span>
4354                 <span class="entry_type_container">x</span>
4355
4356                 <span class="entry_type_array">
4357                   n
4358                 </span>
4359               <span class="entry_type_visibility"> [public as enumList]</span>
4360
4361
4362               <span class="entry_type_hwlevel">[legacy] </span>
4363
4364
4365                 <div class="entry_type_notes">list of enums</div>
4366
4367
4368             </td> <!-- entry_type -->
4369
4370             <td class="entry_description">
4371               <p>List of auto-exposure antibanding modes for <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> that are
4372 supported by this camera device.<wbr/></p>
4373             </td>
4374
4375             <td class="entry_units">
4376             </td>
4377
4378             <td class="entry_range">
4379               <p>Any value listed in <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a></p>
4380             </td>
4381
4382             <td class="entry_tags">
4383               <ul class="entry_tags">
4384                   <li><a href="#tag_BC">BC</a></li>
4385               </ul>
4386             </td>
4387
4388           </tr>
4389           <tr class="entries_header">
4390             <th class="th_details" colspan="5">Details</th>
4391           </tr>
4392           <tr class="entry_cont">
4393             <td class="entry_details" colspan="5">
4394               <p>Not all of the auto-exposure anti-banding modes may be
4395 supported by a given camera device.<wbr/> This field lists the
4396 valid anti-banding modes that the application may request
4397 for this camera device with the
4398 <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> control.<wbr/></p>
4399             </td>
4400           </tr>
4401
4402
4403           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4404            <!-- end of entry -->
4405
4406
4407           <tr class="entry" id="static_android.control.aeAvailableModes">
4408             <td class="entry_name
4409              " rowspan="3">
4410               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes
4411             </td>
4412             <td class="entry_type">
4413                 <span class="entry_type_name">byte</span>
4414                 <span class="entry_type_container">x</span>
4415
4416                 <span class="entry_type_array">
4417                   n
4418                 </span>
4419               <span class="entry_type_visibility"> [public as enumList]</span>
4420
4421
4422               <span class="entry_type_hwlevel">[legacy] </span>
4423
4424
4425                 <div class="entry_type_notes">list of enums</div>
4426
4427
4428             </td> <!-- entry_type -->
4429
4430             <td class="entry_description">
4431               <p>List of auto-exposure modes for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> that are supported by this camera
4432 device.<wbr/></p>
4433             </td>
4434
4435             <td class="entry_units">
4436             </td>
4437
4438             <td class="entry_range">
4439               <p>Any value listed in <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a></p>
4440             </td>
4441
4442             <td class="entry_tags">
4443               <ul class="entry_tags">
4444                   <li><a href="#tag_BC">BC</a></li>
4445               </ul>
4446             </td>
4447
4448           </tr>
4449           <tr class="entries_header">
4450             <th class="th_details" colspan="5">Details</th>
4451           </tr>
4452           <tr class="entry_cont">
4453             <td class="entry_details" colspan="5">
4454               <p>Not all the auto-exposure modes may be supported by a
4455 given camera device,<wbr/> especially if no flash unit is
4456 available.<wbr/> This entry lists the valid modes for
4457 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> for this camera device.<wbr/></p>
4458 <p>All camera devices support ON,<wbr/> and all camera devices with flash
4459 units support ON_<wbr/>AUTO_<wbr/>FLASH and ON_<wbr/>ALWAYS_<wbr/>FLASH.<wbr/></p>
4460 <p>FULL mode camera devices always support OFF mode,<wbr/>
4461 which enables application control of camera exposure time,<wbr/>
4462 sensitivity,<wbr/> and frame duration.<wbr/></p>
4463 <p>LEGACY mode camera devices never support OFF mode.<wbr/>
4464 LIMITED mode devices support OFF if they support the MANUAL_<wbr/>SENSOR
4465 capability.<wbr/></p>
4466             </td>
4467           </tr>
4468
4469
4470           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4471            <!-- end of entry -->
4472
4473
4474           <tr class="entry" id="static_android.control.aeAvailableTargetFpsRanges">
4475             <td class="entry_name
4476              " rowspan="3">
4477               android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges
4478             </td>
4479             <td class="entry_type">
4480                 <span class="entry_type_name">int32</span>
4481                 <span class="entry_type_container">x</span>
4482
4483                 <span class="entry_type_array">
4484                   2 x n
4485                 </span>
4486               <span class="entry_type_visibility"> [public as rangeInt]</span>
4487
4488
4489               <span class="entry_type_hwlevel">[legacy] </span>
4490
4491
4492                 <div class="entry_type_notes">list of pairs of frame rates</div>
4493
4494
4495             </td> <!-- entry_type -->
4496
4497             <td class="entry_description">
4498               <p>List of frame rate ranges for <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> supported by
4499 this camera device.<wbr/></p>
4500             </td>
4501
4502             <td class="entry_units">
4503               Frames per second (FPS)
4504             </td>
4505
4506             <td class="entry_range">
4507             </td>
4508
4509             <td class="entry_tags">
4510               <ul class="entry_tags">
4511                   <li><a href="#tag_BC">BC</a></li>
4512               </ul>
4513             </td>
4514
4515           </tr>
4516           <tr class="entries_header">
4517             <th class="th_details" colspan="5">Details</th>
4518           </tr>
4519           <tr class="entry_cont">
4520             <td class="entry_details" colspan="5">
4521               <p>For devices at the LEGACY level or above:</p>
4522 <ul>
4523 <li>
4524 <p>For constant-framerate recording,<wbr/> for each normal
4525 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a>,<wbr/> that is,<wbr/> a
4526 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a> that has
4527 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#quality">quality</a> in
4528 the range [<a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#QUALITY_LOW">QUALITY_<wbr/>LOW</a>,<wbr/>
4529 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#QUALITY_2160P">QUALITY_<wbr/>2160P</a>],<wbr/> if the profile is
4530 supported by the device and has
4531 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#videoFrameRate">videoFrameRate</a> <code>x</code>,<wbr/> this list will
4532 always include (<code>x</code>,<wbr/><code>x</code>).<wbr/></p>
4533 </li>
4534 <li>
4535 <p>Also,<wbr/> a camera device must either not support any
4536 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a>,<wbr/>
4537 or support at least one
4538 normal <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html">CamcorderProfile</a> that has
4539 <a href="https://developer.android.com/reference/android/media/CamcorderProfile.html#videoFrameRate">videoFrameRate</a> <code>x</code> &gt;= 24.<wbr/></p>
4540 </li>
4541 </ul>
4542 <p>For devices at the LIMITED level or above:</p>
4543 <ul>
4544 <li>For YUV_<wbr/>420_<wbr/>888 burst capture use case,<wbr/> this list will always include (<code>min</code>,<wbr/> <code>max</code>)
4545 and (<code>max</code>,<wbr/> <code>max</code>) where <code>min</code> &lt;= 15 and <code>max</code> = the maximum output frame rate of the
4546 maximum YUV_<wbr/>420_<wbr/>888 output size.<wbr/></li>
4547 </ul>
4548             </td>
4549           </tr>
4550
4551
4552           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4553            <!-- end of entry -->
4554
4555
4556           <tr class="entry" id="static_android.control.aeCompensationRange">
4557             <td class="entry_name
4558              " rowspan="1">
4559               android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range
4560             </td>
4561             <td class="entry_type">
4562                 <span class="entry_type_name">int32</span>
4563                 <span class="entry_type_container">x</span>
4564
4565                 <span class="entry_type_array">
4566                   2
4567                 </span>
4568               <span class="entry_type_visibility"> [public as rangeInt]</span>
4569
4570
4571               <span class="entry_type_hwlevel">[legacy] </span>
4572
4573
4574
4575
4576             </td> <!-- entry_type -->
4577
4578             <td class="entry_description">
4579               <p>Maximum and minimum exposure compensation values for
4580 <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a>,<wbr/> in counts of <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a>,<wbr/>
4581 that are supported by this camera device.<wbr/></p>
4582             </td>
4583
4584             <td class="entry_units">
4585             </td>
4586
4587             <td class="entry_range">
4588               <p>Range [0,<wbr/>0] indicates that exposure compensation is not supported.<wbr/></p>
4589 <p>For LIMITED and FULL devices,<wbr/> range must follow below requirements if exposure
4590 compensation is supported (<code>range != [0,<wbr/> 0]</code>):</p>
4591 <p><code>Min.<wbr/>exposure compensation * <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> &lt;= -2 EV</code></p>
4592 <p><code>Max.<wbr/>exposure compensation * <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> &gt;= 2 EV</code></p>
4593 <p>LEGACY devices may support a smaller range than this.<wbr/></p>
4594             </td>
4595
4596             <td class="entry_tags">
4597               <ul class="entry_tags">
4598                   <li><a href="#tag_BC">BC</a></li>
4599               </ul>
4600             </td>
4601
4602           </tr>
4603
4604
4605           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4606            <!-- end of entry -->
4607
4608
4609           <tr class="entry" id="static_android.control.aeCompensationStep">
4610             <td class="entry_name
4611              " rowspan="5">
4612               android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step
4613             </td>
4614             <td class="entry_type">
4615                 <span class="entry_type_name">rational</span>
4616
4617               <span class="entry_type_visibility"> [public]</span>
4618
4619
4620               <span class="entry_type_hwlevel">[legacy] </span>
4621
4622
4623
4624
4625             </td> <!-- entry_type -->
4626
4627             <td class="entry_description">
4628               <p>Smallest step by which the exposure compensation
4629 can be changed.<wbr/></p>
4630             </td>
4631
4632             <td class="entry_units">
4633               Exposure Value (EV)
4634             </td>
4635
4636             <td class="entry_range">
4637             </td>
4638
4639             <td class="entry_tags">
4640               <ul class="entry_tags">
4641                   <li><a href="#tag_BC">BC</a></li>
4642               </ul>
4643             </td>
4644
4645           </tr>
4646           <tr class="entries_header">
4647             <th class="th_details" colspan="5">Details</th>
4648           </tr>
4649           <tr class="entry_cont">
4650             <td class="entry_details" colspan="5">
4651               <p>This is the unit for <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a>.<wbr/> For example,<wbr/> if this key has
4652 a value of <code>1/<wbr/>2</code>,<wbr/> then a setting of <code>-2</code> for <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> means
4653 that the target EV offset for the auto-exposure routine is -1 EV.<wbr/></p>
4654 <p>One unit of EV compensation changes the brightness of the captured image by a factor
4655 of two.<wbr/> +1 EV doubles the image brightness,<wbr/> while -1 EV halves the image brightness.<wbr/></p>
4656             </td>
4657           </tr>
4658
4659           <tr class="entries_header">
4660             <th class="th_details" colspan="5">HAL Implementation Details</th>
4661           </tr>
4662           <tr class="entry_cont">
4663             <td class="entry_details" colspan="5">
4664               <p>This must be less than or equal to 1/<wbr/>2.<wbr/></p>
4665             </td>
4666           </tr>
4667
4668           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4669            <!-- end of entry -->
4670
4671
4672           <tr class="entry" id="static_android.control.afAvailableModes">
4673             <td class="entry_name
4674              " rowspan="3">
4675               android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes
4676             </td>
4677             <td class="entry_type">
4678                 <span class="entry_type_name">byte</span>
4679                 <span class="entry_type_container">x</span>
4680
4681                 <span class="entry_type_array">
4682                   n
4683                 </span>
4684               <span class="entry_type_visibility"> [public as enumList]</span>
4685
4686
4687               <span class="entry_type_hwlevel">[legacy] </span>
4688
4689
4690                 <div class="entry_type_notes">List of enums</div>
4691
4692
4693             </td> <!-- entry_type -->
4694
4695             <td class="entry_description">
4696               <p>List of auto-focus (AF) modes for <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> that are
4697 supported by this camera device.<wbr/></p>
4698             </td>
4699
4700             <td class="entry_units">
4701             </td>
4702
4703             <td class="entry_range">
4704               <p>Any value listed in <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a></p>
4705             </td>
4706
4707             <td class="entry_tags">
4708               <ul class="entry_tags">
4709                   <li><a href="#tag_BC">BC</a></li>
4710               </ul>
4711             </td>
4712
4713           </tr>
4714           <tr class="entries_header">
4715             <th class="th_details" colspan="5">Details</th>
4716           </tr>
4717           <tr class="entry_cont">
4718             <td class="entry_details" colspan="5">
4719               <p>Not all the auto-focus modes may be supported by a
4720 given camera device.<wbr/> This entry lists the valid modes for
4721 <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> for this camera device.<wbr/></p>
4722 <p>All LIMITED and FULL mode camera devices will support OFF mode,<wbr/> and all
4723 camera devices with adjustable focuser units
4724 (<code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>) will support AUTO mode.<wbr/></p>
4725 <p>LEGACY devices will support OFF mode only if they support
4726 focusing to infinity (by also setting <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> to
4727 <code>0.<wbr/>0f</code>).<wbr/></p>
4728             </td>
4729           </tr>
4730
4731
4732           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4733            <!-- end of entry -->
4734
4735
4736           <tr class="entry" id="static_android.control.availableEffects">
4737             <td class="entry_name
4738              " rowspan="3">
4739               android.<wbr/>control.<wbr/>available<wbr/>Effects
4740             </td>
4741             <td class="entry_type">
4742                 <span class="entry_type_name">byte</span>
4743                 <span class="entry_type_container">x</span>
4744
4745                 <span class="entry_type_array">
4746                   n
4747                 </span>
4748               <span class="entry_type_visibility"> [public as enumList]</span>
4749
4750
4751               <span class="entry_type_hwlevel">[legacy] </span>
4752
4753
4754                 <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>effect<wbr/>Mode).<wbr/></div>
4755
4756
4757             </td> <!-- entry_type -->
4758
4759             <td class="entry_description">
4760               <p>List of color effects for <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a> that are supported by this camera
4761 device.<wbr/></p>
4762             </td>
4763
4764             <td class="entry_units">
4765             </td>
4766
4767             <td class="entry_range">
4768               <p>Any value listed in <a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></p>
4769             </td>
4770
4771             <td class="entry_tags">
4772               <ul class="entry_tags">
4773                   <li><a href="#tag_BC">BC</a></li>
4774               </ul>
4775             </td>
4776
4777           </tr>
4778           <tr class="entries_header">
4779             <th class="th_details" colspan="5">Details</th>
4780           </tr>
4781           <tr class="entry_cont">
4782             <td class="entry_details" colspan="5">
4783               <p>This list contains the color effect modes that can be applied to
4784 images produced by the camera device.<wbr/>
4785 Implementations are not expected to be consistent across all devices.<wbr/>
4786 If no color effect modes are available for a device,<wbr/> this will only list
4787 OFF.<wbr/></p>
4788 <p>A color effect will only be applied if
4789 <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF.<wbr/>  OFF is always included in this list.<wbr/></p>
4790 <p>This control has no effect on the operation of other control routines such
4791 as auto-exposure,<wbr/> white balance,<wbr/> or focus.<wbr/></p>
4792             </td>
4793           </tr>
4794
4795
4796           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4797            <!-- end of entry -->
4798
4799
4800           <tr class="entry" id="static_android.control.availableSceneModes">
4801             <td class="entry_name
4802              " rowspan="3">
4803               android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes
4804             </td>
4805             <td class="entry_type">
4806                 <span class="entry_type_name">byte</span>
4807                 <span class="entry_type_container">x</span>
4808
4809                 <span class="entry_type_array">
4810                   n
4811                 </span>
4812               <span class="entry_type_visibility"> [public as enumList]</span>
4813
4814
4815               <span class="entry_type_hwlevel">[legacy] </span>
4816
4817
4818                 <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>scene<wbr/>Mode).<wbr/></div>
4819
4820
4821             </td> <!-- entry_type -->
4822
4823             <td class="entry_description">
4824               <p>List of scene modes for <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> that are supported by this camera
4825 device.<wbr/></p>
4826             </td>
4827
4828             <td class="entry_units">
4829             </td>
4830
4831             <td class="entry_range">
4832               <p>Any value listed in <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a></p>
4833             </td>
4834
4835             <td class="entry_tags">
4836               <ul class="entry_tags">
4837                   <li><a href="#tag_BC">BC</a></li>
4838               </ul>
4839             </td>
4840
4841           </tr>
4842           <tr class="entries_header">
4843             <th class="th_details" colspan="5">Details</th>
4844           </tr>
4845           <tr class="entry_cont">
4846             <td class="entry_details" colspan="5">
4847               <p>This list contains scene modes that can be set for the camera device.<wbr/>
4848 Only scene modes that have been fully implemented for the
4849 camera device may be included here.<wbr/> Implementations are not expected
4850 to be consistent across all devices.<wbr/></p>
4851 <p>If no scene modes are supported by the camera device,<wbr/> this
4852 will be set to DISABLED.<wbr/> Otherwise DISABLED will not be listed.<wbr/></p>
4853 <p>FACE_<wbr/>PRIORITY is always listed if face detection is
4854 supported (i.<wbr/>e.<wbr/><code><a href="#static_android.statistics.info.maxFaceCount">android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Face<wbr/>Count</a> &gt;
4855 0</code>).<wbr/></p>
4856             </td>
4857           </tr>
4858
4859
4860           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4861            <!-- end of entry -->
4862
4863
4864           <tr class="entry" id="static_android.control.availableVideoStabilizationModes">
4865             <td class="entry_name
4866              " rowspan="3">
4867               android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes
4868             </td>
4869             <td class="entry_type">
4870                 <span class="entry_type_name">byte</span>
4871                 <span class="entry_type_container">x</span>
4872
4873                 <span class="entry_type_array">
4874                   n
4875                 </span>
4876               <span class="entry_type_visibility"> [public as enumList]</span>
4877
4878
4879               <span class="entry_type_hwlevel">[legacy] </span>
4880
4881
4882                 <div class="entry_type_notes">List of enums.<wbr/></div>
4883
4884
4885             </td> <!-- entry_type -->
4886
4887             <td class="entry_description">
4888               <p>List of video stabilization modes for <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>
4889 that are supported by this camera device.<wbr/></p>
4890             </td>
4891
4892             <td class="entry_units">
4893             </td>
4894
4895             <td class="entry_range">
4896               <p>Any value listed in <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a></p>
4897             </td>
4898
4899             <td class="entry_tags">
4900               <ul class="entry_tags">
4901                   <li><a href="#tag_BC">BC</a></li>
4902               </ul>
4903             </td>
4904
4905           </tr>
4906           <tr class="entries_header">
4907             <th class="th_details" colspan="5">Details</th>
4908           </tr>
4909           <tr class="entry_cont">
4910             <td class="entry_details" colspan="5">
4911               <p>OFF will always be listed.<wbr/></p>
4912             </td>
4913           </tr>
4914
4915
4916           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4917            <!-- end of entry -->
4918
4919
4920           <tr class="entry" id="static_android.control.awbAvailableModes">
4921             <td class="entry_name
4922              " rowspan="3">
4923               android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes
4924             </td>
4925             <td class="entry_type">
4926                 <span class="entry_type_name">byte</span>
4927                 <span class="entry_type_container">x</span>
4928
4929                 <span class="entry_type_array">
4930                   n
4931                 </span>
4932               <span class="entry_type_visibility"> [public as enumList]</span>
4933
4934
4935               <span class="entry_type_hwlevel">[legacy] </span>
4936
4937
4938                 <div class="entry_type_notes">List of enums</div>
4939
4940
4941             </td> <!-- entry_type -->
4942
4943             <td class="entry_description">
4944               <p>List of auto-white-balance modes for <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> that are supported by this
4945 camera device.<wbr/></p>
4946             </td>
4947
4948             <td class="entry_units">
4949             </td>
4950
4951             <td class="entry_range">
4952               <p>Any value listed in <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a></p>
4953             </td>
4954
4955             <td class="entry_tags">
4956               <ul class="entry_tags">
4957                   <li><a href="#tag_BC">BC</a></li>
4958               </ul>
4959             </td>
4960
4961           </tr>
4962           <tr class="entries_header">
4963             <th class="th_details" colspan="5">Details</th>
4964           </tr>
4965           <tr class="entry_cont">
4966             <td class="entry_details" colspan="5">
4967               <p>Not all the auto-white-balance modes may be supported by a
4968 given camera device.<wbr/> This entry lists the valid modes for
4969 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> for this camera device.<wbr/></p>
4970 <p>All camera devices will support ON mode.<wbr/></p>
4971 <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always support OFF
4972 mode,<wbr/> which enables application control of white balance,<wbr/> by using
4973 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a> and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>(<a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> must be set to TRANSFORM_<wbr/>MATRIX).<wbr/> This includes all FULL
4974 mode camera devices.<wbr/></p>
4975             </td>
4976           </tr>
4977
4978
4979           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
4980            <!-- end of entry -->
4981
4982
4983           <tr class="entry" id="static_android.control.maxRegions">
4984             <td class="entry_name
4985              " rowspan="1">
4986               android.<wbr/>control.<wbr/>max<wbr/>Regions
4987             </td>
4988             <td class="entry_type">
4989                 <span class="entry_type_name">int32</span>
4990                 <span class="entry_type_container">x</span>
4991
4992                 <span class="entry_type_array">
4993                   3
4994                 </span>
4995               <span class="entry_type_visibility"> [ndk_public]</span>
4996
4997
4998               <span class="entry_type_hwlevel">[legacy] </span>
4999
5000
5001
5002
5003             </td> <!-- entry_type -->
5004
5005             <td class="entry_description">
5006               <p>List of the maximum number of regions that can be used for metering in
5007 auto-exposure (AE),<wbr/> auto-white balance (AWB),<wbr/> and auto-focus (AF);
5008 this corresponds to the the maximum number of elements in
5009 <a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a>,<wbr/> <a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a>,<wbr/>
5010 and <a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
5011             </td>
5012
5013             <td class="entry_units">
5014             </td>
5015
5016             <td class="entry_range">
5017               <p>Value must be &gt;= 0 for each element.<wbr/> For full-capability devices
5018 this value must be &gt;= 1 for AE and AF.<wbr/> The order of the elements is:
5019 <code>(AE,<wbr/> AWB,<wbr/> AF)</code>.<wbr/></p>
5020             </td>
5021
5022             <td class="entry_tags">
5023               <ul class="entry_tags">
5024                   <li><a href="#tag_BC">BC</a></li>
5025               </ul>
5026             </td>
5027
5028           </tr>
5029
5030
5031           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5032            <!-- end of entry -->
5033
5034
5035           <tr class="entry" id="static_android.control.maxRegionsAe">
5036             <td class="entry_name
5037              " rowspan="5">
5038               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae
5039             </td>
5040             <td class="entry_type">
5041                 <span class="entry_type_name">int32</span>
5042
5043               <span class="entry_type_visibility"> [java_public]</span>
5044
5045               <span class="entry_type_synthetic">[synthetic] </span>
5046
5047               <span class="entry_type_hwlevel">[legacy] </span>
5048
5049
5050
5051
5052             </td> <!-- entry_type -->
5053
5054             <td class="entry_description">
5055               <p>The maximum number of metering regions that can be used by the auto-exposure (AE)
5056 routine.<wbr/></p>
5057             </td>
5058
5059             <td class="entry_units">
5060             </td>
5061
5062             <td class="entry_range">
5063               <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
5064 value will be &gt;= 1.<wbr/></p>
5065             </td>
5066
5067             <td class="entry_tags">
5068             </td>
5069
5070           </tr>
5071           <tr class="entries_header">
5072             <th class="th_details" colspan="5">Details</th>
5073           </tr>
5074           <tr class="entry_cont">
5075             <td class="entry_details" colspan="5">
5076               <p>This corresponds to the the maximum allowed number of elements in
5077 <a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a>.<wbr/></p>
5078             </td>
5079           </tr>
5080
5081           <tr class="entries_header">
5082             <th class="th_details" colspan="5">HAL Implementation Details</th>
5083           </tr>
5084           <tr class="entry_cont">
5085             <td class="entry_details" colspan="5">
5086               <p>This entry is private to the framework.<wbr/> Fill in
5087 maxRegions to have this entry be automatically populated.<wbr/></p>
5088             </td>
5089           </tr>
5090
5091           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5092            <!-- end of entry -->
5093
5094
5095           <tr class="entry" id="static_android.control.maxRegionsAwb">
5096             <td class="entry_name
5097              " rowspan="5">
5098               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb
5099             </td>
5100             <td class="entry_type">
5101                 <span class="entry_type_name">int32</span>
5102
5103               <span class="entry_type_visibility"> [java_public]</span>
5104
5105               <span class="entry_type_synthetic">[synthetic] </span>
5106
5107               <span class="entry_type_hwlevel">[legacy] </span>
5108
5109
5110
5111
5112             </td> <!-- entry_type -->
5113
5114             <td class="entry_description">
5115               <p>The maximum number of metering regions that can be used by the auto-white balance (AWB)
5116 routine.<wbr/></p>
5117             </td>
5118
5119             <td class="entry_units">
5120             </td>
5121
5122             <td class="entry_range">
5123               <p>Value will be &gt;= 0.<wbr/></p>
5124             </td>
5125
5126             <td class="entry_tags">
5127             </td>
5128
5129           </tr>
5130           <tr class="entries_header">
5131             <th class="th_details" colspan="5">Details</th>
5132           </tr>
5133           <tr class="entry_cont">
5134             <td class="entry_details" colspan="5">
5135               <p>This corresponds to the the maximum allowed number of elements in
5136 <a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a>.<wbr/></p>
5137             </td>
5138           </tr>
5139
5140           <tr class="entries_header">
5141             <th class="th_details" colspan="5">HAL Implementation Details</th>
5142           </tr>
5143           <tr class="entry_cont">
5144             <td class="entry_details" colspan="5">
5145               <p>This entry is private to the framework.<wbr/> Fill in
5146 maxRegions to have this entry be automatically populated.<wbr/></p>
5147             </td>
5148           </tr>
5149
5150           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5151            <!-- end of entry -->
5152
5153
5154           <tr class="entry" id="static_android.control.maxRegionsAf">
5155             <td class="entry_name
5156              " rowspan="5">
5157               android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af
5158             </td>
5159             <td class="entry_type">
5160                 <span class="entry_type_name">int32</span>
5161
5162               <span class="entry_type_visibility"> [java_public]</span>
5163
5164               <span class="entry_type_synthetic">[synthetic] </span>
5165
5166               <span class="entry_type_hwlevel">[legacy] </span>
5167
5168
5169
5170
5171             </td> <!-- entry_type -->
5172
5173             <td class="entry_description">
5174               <p>The maximum number of metering regions that can be used by the auto-focus (AF) routine.<wbr/></p>
5175             </td>
5176
5177             <td class="entry_units">
5178             </td>
5179
5180             <td class="entry_range">
5181               <p>Value will be &gt;= 0.<wbr/> For FULL-capability devices,<wbr/> this
5182 value will be &gt;= 1.<wbr/></p>
5183             </td>
5184
5185             <td class="entry_tags">
5186             </td>
5187
5188           </tr>
5189           <tr class="entries_header">
5190             <th class="th_details" colspan="5">Details</th>
5191           </tr>
5192           <tr class="entry_cont">
5193             <td class="entry_details" colspan="5">
5194               <p>This corresponds to the the maximum allowed number of elements in
5195 <a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a>.<wbr/></p>
5196             </td>
5197           </tr>
5198
5199           <tr class="entries_header">
5200             <th class="th_details" colspan="5">HAL Implementation Details</th>
5201           </tr>
5202           <tr class="entry_cont">
5203             <td class="entry_details" colspan="5">
5204               <p>This entry is private to the framework.<wbr/> Fill in
5205 maxRegions to have this entry be automatically populated.<wbr/></p>
5206             </td>
5207           </tr>
5208
5209           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5210            <!-- end of entry -->
5211
5212
5213           <tr class="entry" id="static_android.control.sceneModeOverrides">
5214             <td class="entry_name
5215              " rowspan="5">
5216               android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides
5217             </td>
5218             <td class="entry_type">
5219                 <span class="entry_type_name">byte</span>
5220                 <span class="entry_type_container">x</span>
5221
5222                 <span class="entry_type_array">
5223                   3 x length(availableSceneModes)
5224                 </span>
5225               <span class="entry_type_visibility"> [system]</span>
5226
5227
5228               <span class="entry_type_hwlevel">[limited] </span>
5229
5230
5231
5232
5233             </td> <!-- entry_type -->
5234
5235             <td class="entry_description">
5236               <p>Ordered list of auto-exposure,<wbr/> auto-white balance,<wbr/> and auto-focus
5237 settings to use with each available scene mode.<wbr/></p>
5238             </td>
5239
5240             <td class="entry_units">
5241             </td>
5242
5243             <td class="entry_range">
5244               <p>For each available scene mode,<wbr/> the list must contain three
5245 entries containing the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
5246 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values used
5247 by the camera device.<wbr/> The entry order is <code>(aeMode,<wbr/> awbMode,<wbr/> afMode)</code>
5248 where aeMode has the lowest index position.<wbr/></p>
5249             </td>
5250
5251             <td class="entry_tags">
5252               <ul class="entry_tags">
5253                   <li><a href="#tag_BC">BC</a></li>
5254               </ul>
5255             </td>
5256
5257           </tr>
5258           <tr class="entries_header">
5259             <th class="th_details" colspan="5">Details</th>
5260           </tr>
5261           <tr class="entry_cont">
5262             <td class="entry_details" colspan="5">
5263               <p>When a scene mode is enabled,<wbr/> the camera device is expected
5264 to override <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/>
5265 and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> with its preferred settings for
5266 that scene mode.<wbr/></p>
5267 <p>The order of this list matches that of availableSceneModes,<wbr/>
5268 with 3 entries for each mode.<wbr/>  The overrides listed
5269 for FACE_<wbr/>PRIORITY and FACE_<wbr/>PRIORITY_<wbr/>LOW_<wbr/>LIGHT (if supported) are ignored,<wbr/>
5270 since for that mode the application-set <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
5271 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> values are
5272 used instead,<wbr/> matching the behavior when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>
5273 is set to AUTO.<wbr/> It is recommended that the FACE_<wbr/>PRIORITY and
5274 FACE_<wbr/>PRIORITY_<wbr/>LOW_<wbr/>LIGHT (if supported) overrides should be set to 0.<wbr/></p>
5275 <p>For example,<wbr/> if availableSceneModes contains
5276 <code>(FACE_<wbr/>PRIORITY,<wbr/> ACTION,<wbr/> NIGHT)</code>,<wbr/>  then the camera framework
5277 expects sceneModeOverrides to have 9 entries formatted like:
5278 <code>(0,<wbr/> 0,<wbr/> 0,<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> AUTO,<wbr/> CONTINUOUS_<wbr/>PICTURE,<wbr/>
5279 ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> INCANDESCENT,<wbr/> AUTO)</code>.<wbr/></p>
5280             </td>
5281           </tr>
5282
5283           <tr class="entries_header">
5284             <th class="th_details" colspan="5">HAL Implementation Details</th>
5285           </tr>
5286           <tr class="entry_cont">
5287             <td class="entry_details" colspan="5">
5288               <p>To maintain backward compatibility,<wbr/> this list will be made available
5289 in the static metadata of the camera service.<wbr/>  The camera service will
5290 use these values to set <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
5291 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> when using a scene
5292 mode other than FACE_<wbr/>PRIORITY and FACE_<wbr/>PRIORITY_<wbr/>LOW_<wbr/>LIGHT (if supported).<wbr/></p>
5293             </td>
5294           </tr>
5295
5296           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5297            <!-- end of entry -->
5298
5299
5300           <tr class="entry" id="static_android.control.availableHighSpeedVideoConfigurations">
5301             <td class="entry_name
5302              " rowspan="5">
5303               android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations
5304             </td>
5305             <td class="entry_type">
5306                 <span class="entry_type_name">int32</span>
5307                 <span class="entry_type_container">x</span>
5308
5309                 <span class="entry_type_array">
5310                   5 x n
5311                 </span>
5312               <span class="entry_type_visibility"> [hidden as highSpeedVideoConfiguration]</span>
5313
5314
5315               <span class="entry_type_hwlevel">[limited] </span>
5316
5317
5318
5319
5320             </td> <!-- entry_type -->
5321
5322             <td class="entry_description">
5323               <p>List of available high speed video size,<wbr/> fps range and max batch size configurations
5324 supported by the camera device,<wbr/> in the format of (width,<wbr/> height,<wbr/> fps_<wbr/>min,<wbr/> fps_<wbr/>max,<wbr/> batch_<wbr/>size_<wbr/>max).<wbr/></p>
5325             </td>
5326
5327             <td class="entry_units">
5328             </td>
5329
5330             <td class="entry_range">
5331               <p>For each configuration,<wbr/> the fps_<wbr/>max &gt;= 120fps.<wbr/></p>
5332             </td>
5333
5334             <td class="entry_tags">
5335               <ul class="entry_tags">
5336                   <li><a href="#tag_V1">V1</a></li>
5337               </ul>
5338             </td>
5339
5340           </tr>
5341           <tr class="entries_header">
5342             <th class="th_details" colspan="5">Details</th>
5343           </tr>
5344           <tr class="entry_cont">
5345             <td class="entry_details" colspan="5">
5346               <p>When CONSTRAINED_<wbr/>HIGH_<wbr/>SPEED_<wbr/>VIDEO is supported in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>,<wbr/>
5347 this metadata will list the supported high speed video size,<wbr/> fps range and max batch size
5348 configurations.<wbr/> All the sizes listed in this configuration will be a subset of the sizes
5349 reported by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">StreamConfigurationMap#getOutputSizes</a>
5350 for processed non-stalling formats.<wbr/></p>
5351 <p>For the high speed video use case,<wbr/> the application must
5352 select the video size and fps range from this metadata to configure the recording and
5353 preview streams and setup the recording requests.<wbr/> For example,<wbr/> if the application intends
5354 to do high speed recording,<wbr/> it can select the maximum size reported by this metadata to
5355 configure output streams.<wbr/> Once the size is selected,<wbr/> application can filter this metadata
5356 by selected size and get the supported fps ranges,<wbr/> and use these fps ranges to setup the
5357 recording requests.<wbr/> Note that for the use case of multiple output streams,<wbr/> application
5358 must select one unique size from this metadata to use (e.<wbr/>g.,<wbr/> preview and recording streams
5359 must have the same size).<wbr/> Otherwise,<wbr/> the high speed capture session creation will fail.<wbr/></p>
5360 <p>The min and max fps will be multiple times of 30fps.<wbr/></p>
5361 <p>High speed video streaming extends significant performance pressue to camera hardware,<wbr/>
5362 to achieve efficient high speed streaming,<wbr/> the camera device may have to aggregate
5363 multiple frames together and send to camera device for processing where the request
5364 controls are same for all the frames in this batch.<wbr/> Max batch size indicates
5365 the max possible number of frames the camera device will group together for this high
5366 speed stream configuration.<wbr/> This max batch size will be used to generate a high speed
5367 recording request list by
5368 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>.<wbr/>
5369 The max batch size for each configuration will satisfy below conditions:</p>
5370 <ul>
5371 <li>Each max batch size will be a divisor of its corresponding fps_<wbr/>max /<wbr/> 30.<wbr/> For example,<wbr/>
5372 if max_<wbr/>fps is 300,<wbr/> max batch size will only be 1,<wbr/> 2,<wbr/> 5,<wbr/> or 10.<wbr/></li>
5373 <li>The camera device may choose smaller internal batch size for each configuration,<wbr/> but
5374 the actual batch size will be a divisor of max batch size.<wbr/> For example,<wbr/> if the max batch
5375 size is 8,<wbr/> the actual batch size used by camera device will only be 1,<wbr/> 2,<wbr/> 4,<wbr/> or 8.<wbr/></li>
5376 <li>The max batch size in each configuration entry must be no larger than 32.<wbr/></li>
5377 </ul>
5378 <p>The camera device doesn't have to support batch mode to achieve high speed video recording,<wbr/>
5379 in such case,<wbr/> batch_<wbr/>size_<wbr/>max will be reported as 1 in each configuration entry.<wbr/></p>
5380 <p>This fps ranges in this configuration list can only be used to create requests
5381 that are submitted to a high speed camera capture session created by
5382 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>.<wbr/>
5383 The fps ranges reported in this metadata must not be used to setup capture requests for
5384 normal capture session,<wbr/> or it will cause request error.<wbr/></p>
5385             </td>
5386           </tr>
5387
5388           <tr class="entries_header">
5389             <th class="th_details" colspan="5">HAL Implementation Details</th>
5390           </tr>
5391           <tr class="entry_cont">
5392             <td class="entry_details" colspan="5">
5393               <p>All the sizes listed in this configuration will be a subset of the sizes reported by
5394 <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> for processed non-stalling output formats.<wbr/>
5395 Note that for all high speed video configurations,<wbr/> HAL must be able to support a minimum
5396 of two streams,<wbr/> though the application might choose to configure just one stream.<wbr/></p>
5397 <p>The HAL may support multiple sensor modes for high speed outputs,<wbr/> for example,<wbr/> 120fps
5398 sensor mode and 120fps recording,<wbr/> 240fps sensor mode for 240fps recording.<wbr/> The application
5399 usually starts preview first,<wbr/> then starts recording.<wbr/> To avoid sensor mode switch caused
5400 stutter when starting recording as much as possible,<wbr/> the application may want to ensure
5401 the same sensor mode is used for preview and recording.<wbr/> Therefore,<wbr/> The HAL must advertise
5402 the variable fps range [30,<wbr/> fps_<wbr/>max] for each fixed fps range in this configuration list.<wbr/>
5403 For example,<wbr/> if the HAL advertises [120,<wbr/> 120] and [240,<wbr/> 240],<wbr/> the HAL must also advertise
5404 [30,<wbr/> 120] and [30,<wbr/> 240] for each configuration.<wbr/> In doing so,<wbr/> if the application intends to
5405 do 120fps recording,<wbr/> it can select [30,<wbr/> 120] to start preview,<wbr/> and [120,<wbr/> 120] to start
5406 recording.<wbr/> For these variable fps ranges,<wbr/> it's up to the HAL to decide the actual fps
5407 values that are suitable for smooth preview streaming.<wbr/> If the HAL sees different max_<wbr/>fps
5408 values that fall into different sensor modes in a sequence of requests,<wbr/> the HAL must
5409 switch the sensor mode as quick as possible to minimize the mode switch caused stutter.<wbr/></p>
5410             </td>
5411           </tr>
5412
5413           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5414            <!-- end of entry -->
5415
5416
5417           <tr class="entry" id="static_android.control.aeLockAvailable">
5418             <td class="entry_name
5419              " rowspan="3">
5420               android.<wbr/>control.<wbr/>ae<wbr/>Lock<wbr/>Available
5421             </td>
5422             <td class="entry_type">
5423                 <span class="entry_type_name entry_type_name_enum">byte</span>
5424
5425               <span class="entry_type_visibility"> [public as boolean]</span>
5426
5427
5428               <span class="entry_type_hwlevel">[legacy] </span>
5429
5430
5431
5432                 <ul class="entry_type_enum">
5433                   <li>
5434                     <span class="entry_type_enum_name">FALSE</span>
5435                   </li>
5436                   <li>
5437                     <span class="entry_type_enum_name">TRUE</span>
5438                   </li>
5439                 </ul>
5440
5441             </td> <!-- entry_type -->
5442
5443             <td class="entry_description">
5444               <p>Whether the camera device supports <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></p>
5445             </td>
5446
5447             <td class="entry_units">
5448             </td>
5449
5450             <td class="entry_range">
5451             </td>
5452
5453             <td class="entry_tags">
5454               <ul class="entry_tags">
5455                   <li><a href="#tag_BC">BC</a></li>
5456               </ul>
5457             </td>
5458
5459           </tr>
5460           <tr class="entries_header">
5461             <th class="th_details" colspan="5">Details</th>
5462           </tr>
5463           <tr class="entry_cont">
5464             <td class="entry_details" colspan="5">
5465               <p>Devices with MANUAL_<wbr/>SENSOR capability or BURST_<wbr/>CAPTURE capability will always
5466 list <code>true</code>.<wbr/> This includes FULL devices.<wbr/></p>
5467             </td>
5468           </tr>
5469
5470
5471           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5472            <!-- end of entry -->
5473
5474
5475           <tr class="entry" id="static_android.control.awbLockAvailable">
5476             <td class="entry_name
5477              " rowspan="3">
5478               android.<wbr/>control.<wbr/>awb<wbr/>Lock<wbr/>Available
5479             </td>
5480             <td class="entry_type">
5481                 <span class="entry_type_name entry_type_name_enum">byte</span>
5482
5483               <span class="entry_type_visibility"> [public as boolean]</span>
5484
5485
5486               <span class="entry_type_hwlevel">[legacy] </span>
5487
5488
5489
5490                 <ul class="entry_type_enum">
5491                   <li>
5492                     <span class="entry_type_enum_name">FALSE</span>
5493                   </li>
5494                   <li>
5495                     <span class="entry_type_enum_name">TRUE</span>
5496                   </li>
5497                 </ul>
5498
5499             </td> <!-- entry_type -->
5500
5501             <td class="entry_description">
5502               <p>Whether the camera device supports <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></p>
5503             </td>
5504
5505             <td class="entry_units">
5506             </td>
5507
5508             <td class="entry_range">
5509             </td>
5510
5511             <td class="entry_tags">
5512               <ul class="entry_tags">
5513                   <li><a href="#tag_BC">BC</a></li>
5514               </ul>
5515             </td>
5516
5517           </tr>
5518           <tr class="entries_header">
5519             <th class="th_details" colspan="5">Details</th>
5520           </tr>
5521           <tr class="entry_cont">
5522             <td class="entry_details" colspan="5">
5523               <p>Devices with MANUAL_<wbr/>POST_<wbr/>PROCESSING capability or BURST_<wbr/>CAPTURE capability will
5524 always list <code>true</code>.<wbr/> This includes FULL devices.<wbr/></p>
5525             </td>
5526           </tr>
5527
5528
5529           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5530            <!-- end of entry -->
5531
5532
5533           <tr class="entry" id="static_android.control.availableModes">
5534             <td class="entry_name
5535              " rowspan="3">
5536               android.<wbr/>control.<wbr/>available<wbr/>Modes
5537             </td>
5538             <td class="entry_type">
5539                 <span class="entry_type_name">byte</span>
5540                 <span class="entry_type_container">x</span>
5541
5542                 <span class="entry_type_array">
5543                   n
5544                 </span>
5545               <span class="entry_type_visibility"> [public as enumList]</span>
5546
5547
5548               <span class="entry_type_hwlevel">[legacy] </span>
5549
5550
5551                 <div class="entry_type_notes">List of enums (android.<wbr/>control.<wbr/>mode).<wbr/></div>
5552
5553
5554             </td> <!-- entry_type -->
5555
5556             <td class="entry_description">
5557               <p>List of control modes for <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> that are supported by this camera
5558 device.<wbr/></p>
5559             </td>
5560
5561             <td class="entry_units">
5562             </td>
5563
5564             <td class="entry_range">
5565               <p>Any value listed in <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a></p>
5566             </td>
5567
5568             <td class="entry_tags">
5569             </td>
5570
5571           </tr>
5572           <tr class="entries_header">
5573             <th class="th_details" colspan="5">Details</th>
5574           </tr>
5575           <tr class="entry_cont">
5576             <td class="entry_details" colspan="5">
5577               <p>This list contains control modes that can be set for the camera device.<wbr/>
5578 LEGACY mode devices will always support AUTO mode.<wbr/> LIMITED and FULL
5579 devices will always support OFF,<wbr/> AUTO modes.<wbr/></p>
5580             </td>
5581           </tr>
5582
5583
5584           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5585            <!-- end of entry -->
5586
5587
5588           <tr class="entry" id="static_android.control.postRawSensitivityBoostRange">
5589             <td class="entry_name
5590              " rowspan="5">
5591               android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost<wbr/>Range
5592             </td>
5593             <td class="entry_type">
5594                 <span class="entry_type_name">int32</span>
5595                 <span class="entry_type_container">x</span>
5596
5597                 <span class="entry_type_array">
5598                   2
5599                 </span>
5600               <span class="entry_type_visibility"> [public as rangeInt]</span>
5601
5602
5603
5604
5605                 <div class="entry_type_notes">Range of supported post RAW sensitivitiy boosts</div>
5606
5607
5608             </td> <!-- entry_type -->
5609
5610             <td class="entry_description">
5611               <p>Range of boosts for <a href="#controls_android.control.postRawSensitivityBoost">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost</a> supported
5612 by this camera device.<wbr/></p>
5613             </td>
5614
5615             <td class="entry_units">
5616               ISO arithmetic units,<wbr/> the same as android.<wbr/>sensor.<wbr/>sensitivity
5617             </td>
5618
5619             <td class="entry_range">
5620             </td>
5621
5622             <td class="entry_tags">
5623             </td>
5624
5625           </tr>
5626           <tr class="entries_header">
5627             <th class="th_details" colspan="5">Details</th>
5628           </tr>
5629           <tr class="entry_cont">
5630             <td class="entry_details" colspan="5">
5631               <p>Devices support post RAW sensitivity boost  will advertise
5632 <a href="#controls_android.control.postRawSensitivityBoost">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost</a> key for controling
5633 post RAW sensitivity boost.<wbr/></p>
5634 <p>This key will be <code>null</code> for devices that do not support any RAW format
5635 outputs.<wbr/> For devices that do support RAW format outputs,<wbr/> this key will always
5636 present,<wbr/> and if a device does not support post RAW sensitivity boost,<wbr/> it will
5637 list <code>(100,<wbr/> 100)</code> in this key.<wbr/></p>
5638             </td>
5639           </tr>
5640
5641           <tr class="entries_header">
5642             <th class="th_details" colspan="5">HAL Implementation Details</th>
5643           </tr>
5644           <tr class="entry_cont">
5645             <td class="entry_details" colspan="5">
5646               <p>This key is added in HAL3.<wbr/>4.<wbr/> For HAL3.<wbr/>3 or earlier devices,<wbr/> camera framework will
5647 generate this key as <code>(100,<wbr/> 100)</code> if device supports any of RAW output formats.<wbr/>
5648 All HAL3.<wbr/>4 and above devices should list this key if device supports any of RAW
5649 output formats.<wbr/></p>
5650             </td>
5651           </tr>
5652
5653           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5654            <!-- end of entry -->
5655
5656
5657
5658       <!-- end of kind -->
5659       </tbody>
5660       <tr><td colspan="6" class="kind">dynamic</td></tr>
5661
5662       <thead class="entries_header">
5663         <tr>
5664           <th class="th_name">Property Name</th>
5665           <th class="th_type">Type</th>
5666           <th class="th_description">Description</th>
5667           <th class="th_units">Units</th>
5668           <th class="th_range">Range</th>
5669           <th class="th_tags">Tags</th>
5670         </tr>
5671       </thead>
5672
5673       <tbody>
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684           <tr class="entry" id="dynamic_android.control.aePrecaptureId">
5685             <td class="entry_name
5686                 entry_name_deprecated
5687              " rowspan="3">
5688               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Id
5689             </td>
5690             <td class="entry_type">
5691                 <span class="entry_type_name">int32</span>
5692
5693               <span class="entry_type_visibility"> [system]</span>
5694
5695
5696
5697               <span class="entry_type_deprecated">[deprecated] </span>
5698
5699
5700
5701             </td> <!-- entry_type -->
5702
5703             <td class="entry_description">
5704               <p>The ID sent with the latest
5705 CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING call</p>
5706             </td>
5707
5708             <td class="entry_units">
5709             </td>
5710
5711             <td class="entry_range">
5712               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
5713             </td>
5714
5715             <td class="entry_tags">
5716             </td>
5717
5718           </tr>
5719           <tr class="entries_header">
5720             <th class="th_details" colspan="5">Details</th>
5721           </tr>
5722           <tr class="entry_cont">
5723             <td class="entry_details" colspan="5">
5724               <p>Must be 0 if no
5725 CAMERA2_<wbr/>TRIGGER_<wbr/>PRECAPTURE_<wbr/>METERING trigger received yet
5726 by HAL.<wbr/> Always updated even if AE algorithm ignores the
5727 trigger</p>
5728             </td>
5729           </tr>
5730
5731
5732           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5733            <!-- end of entry -->
5734
5735
5736           <tr class="entry" id="dynamic_android.control.aeAntibandingMode">
5737             <td class="entry_name
5738              " rowspan="5">
5739               android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode
5740             </td>
5741             <td class="entry_type">
5742                 <span class="entry_type_name entry_type_name_enum">byte</span>
5743
5744               <span class="entry_type_visibility"> [public]</span>
5745
5746
5747               <span class="entry_type_hwlevel">[legacy] </span>
5748
5749
5750
5751                 <ul class="entry_type_enum">
5752                   <li>
5753                     <span class="entry_type_enum_name">OFF</span>
5754                     <span class="entry_type_enum_notes"><p>The camera device will not adjust exposure duration to
5755 avoid banding problems.<wbr/></p></span>
5756                   </li>
5757                   <li>
5758                     <span class="entry_type_enum_name">50HZ</span>
5759                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
5760 avoid banding problems with 50Hz illumination sources.<wbr/></p></span>
5761                   </li>
5762                   <li>
5763                     <span class="entry_type_enum_name">60HZ</span>
5764                     <span class="entry_type_enum_notes"><p>The camera device will adjust exposure duration to
5765 avoid banding problems with 60Hz illumination
5766 sources.<wbr/></p></span>
5767                   </li>
5768                   <li>
5769                     <span class="entry_type_enum_name">AUTO</span>
5770                     <span class="entry_type_enum_notes"><p>The camera device will automatically adapt its
5771 antibanding routine to the current illumination
5772 condition.<wbr/> This is the default mode if AUTO is
5773 available on given camera device.<wbr/></p></span>
5774                   </li>
5775                 </ul>
5776
5777             </td> <!-- entry_type -->
5778
5779             <td class="entry_description">
5780               <p>The desired setting for the camera device's auto-exposure
5781 algorithm's antibanding compensation.<wbr/></p>
5782             </td>
5783
5784             <td class="entry_units">
5785             </td>
5786
5787             <td class="entry_range">
5788               <p><a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a></p>
5789             </td>
5790
5791             <td class="entry_tags">
5792               <ul class="entry_tags">
5793                   <li><a href="#tag_BC">BC</a></li>
5794               </ul>
5795             </td>
5796
5797           </tr>
5798           <tr class="entries_header">
5799             <th class="th_details" colspan="5">Details</th>
5800           </tr>
5801           <tr class="entry_cont">
5802             <td class="entry_details" colspan="5">
5803               <p>Some kinds of lighting fixtures,<wbr/> such as some fluorescent
5804 lights,<wbr/> flicker at the rate of the power supply frequency
5805 (60Hz or 50Hz,<wbr/> depending on country).<wbr/> While this is
5806 typically not noticeable to a person,<wbr/> it can be visible to
5807 a camera device.<wbr/> If a camera sets its exposure time to the
5808 wrong value,<wbr/> the flicker may become visible in the
5809 viewfinder as flicker or in a final captured image,<wbr/> as a
5810 set of variable-brightness bands across the image.<wbr/></p>
5811 <p>Therefore,<wbr/> the auto-exposure routines of camera devices
5812 include antibanding routines that ensure that the chosen
5813 exposure value will not cause such banding.<wbr/> The choice of
5814 exposure time depends on the rate of flicker,<wbr/> which the
5815 camera device can detect automatically,<wbr/> or the expected
5816 rate can be selected by the application using this
5817 control.<wbr/></p>
5818 <p>A given camera device may not support all of the possible
5819 options for the antibanding mode.<wbr/> The
5820 <a href="#static_android.control.aeAvailableAntibandingModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Antibanding<wbr/>Modes</a> key contains
5821 the available modes for a given camera device.<wbr/></p>
5822 <p>AUTO mode is the default if it is available on given
5823 camera device.<wbr/> When AUTO mode is not available,<wbr/> the
5824 default will be either 50HZ or 60HZ,<wbr/> and both 50HZ
5825 and 60HZ will be available.<wbr/></p>
5826 <p>If manual exposure control is enabled (by setting
5827 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
5828 then this setting has no effect,<wbr/> and the application must
5829 ensure it selects exposure times that do not cause banding
5830 issues.<wbr/> The <a href="#dynamic_android.statistics.sceneFlicker">android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker</a> key can assist
5831 the application in this.<wbr/></p>
5832             </td>
5833           </tr>
5834
5835           <tr class="entries_header">
5836             <th class="th_details" colspan="5">HAL Implementation Details</th>
5837           </tr>
5838           <tr class="entry_cont">
5839             <td class="entry_details" colspan="5">
5840               <p>For all capture request templates,<wbr/> this field must be set
5841 to AUTO if AUTO mode is available.<wbr/> If AUTO is not available,<wbr/>
5842 the default must be either 50HZ or 60HZ,<wbr/> and both 50HZ and
5843 60HZ must be available.<wbr/></p>
5844 <p>If manual exposure control is enabled (by setting
5845 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> to OFF),<wbr/>
5846 then the exposure values provided by the application must not be
5847 adjusted for antibanding.<wbr/></p>
5848             </td>
5849           </tr>
5850
5851           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5852            <!-- end of entry -->
5853
5854
5855           <tr class="entry" id="dynamic_android.control.aeExposureCompensation">
5856             <td class="entry_name
5857              " rowspan="3">
5858               android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation
5859             </td>
5860             <td class="entry_type">
5861                 <span class="entry_type_name">int32</span>
5862
5863               <span class="entry_type_visibility"> [public]</span>
5864
5865
5866               <span class="entry_type_hwlevel">[legacy] </span>
5867
5868
5869
5870
5871             </td> <!-- entry_type -->
5872
5873             <td class="entry_description">
5874               <p>Adjustment to auto-exposure (AE) target image
5875 brightness.<wbr/></p>
5876             </td>
5877
5878             <td class="entry_units">
5879               Compensation steps
5880             </td>
5881
5882             <td class="entry_range">
5883               <p><a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a></p>
5884             </td>
5885
5886             <td class="entry_tags">
5887               <ul class="entry_tags">
5888                   <li><a href="#tag_BC">BC</a></li>
5889               </ul>
5890             </td>
5891
5892           </tr>
5893           <tr class="entries_header">
5894             <th class="th_details" colspan="5">Details</th>
5895           </tr>
5896           <tr class="entry_cont">
5897             <td class="entry_details" colspan="5">
5898               <p>The adjustment is measured as a count of steps,<wbr/> with the
5899 step size defined by <a href="#static_android.control.aeCompensationStep">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Step</a> and the
5900 allowed range by <a href="#static_android.control.aeCompensationRange">android.<wbr/>control.<wbr/>ae<wbr/>Compensation<wbr/>Range</a>.<wbr/></p>
5901 <p>For example,<wbr/> if the exposure value (EV) step is 0.<wbr/>333,<wbr/> '6'
5902 will mean an exposure compensation of +2 EV; -3 will mean an
5903 exposure compensation of -1 EV.<wbr/> One EV represents a doubling
5904 of image brightness.<wbr/> Note that this control will only be
5905 effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF.<wbr/> This control
5906 will take effect even when <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> <code>== true</code>.<wbr/></p>
5907 <p>In the event of exposure compensation value being changed,<wbr/> camera device
5908 may take several frames to reach the newly requested exposure target.<wbr/>
5909 During that time,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> field will be in the SEARCHING
5910 state.<wbr/> Once the new exposure target is reached,<wbr/> <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> will
5911 change from SEARCHING to either CONVERGED,<wbr/> LOCKED (if AE lock is enabled),<wbr/> or
5912 FLASH_<wbr/>REQUIRED (if the scene is too dark for still capture).<wbr/></p>
5913             </td>
5914           </tr>
5915
5916
5917           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
5918            <!-- end of entry -->
5919
5920
5921           <tr class="entry" id="dynamic_android.control.aeLock">
5922             <td class="entry_name
5923              " rowspan="3">
5924               android.<wbr/>control.<wbr/>ae<wbr/>Lock
5925             </td>
5926             <td class="entry_type">
5927                 <span class="entry_type_name entry_type_name_enum">byte</span>
5928
5929               <span class="entry_type_visibility"> [public as boolean]</span>
5930
5931
5932               <span class="entry_type_hwlevel">[legacy] </span>
5933
5934
5935
5936                 <ul class="entry_type_enum">
5937                   <li>
5938                     <span class="entry_type_enum_name">OFF</span>
5939                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is disabled; the AE algorithm
5940 is free to update its parameters.<wbr/></p></span>
5941                   </li>
5942                   <li>
5943                     <span class="entry_type_enum_name">ON</span>
5944                     <span class="entry_type_enum_notes"><p>Auto-exposure lock is enabled; the AE algorithm
5945 must not update the exposure and sensitivity parameters
5946 while the lock is active.<wbr/></p>
5947 <p><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> setting changes
5948 will still take effect while auto-exposure is locked.<wbr/></p>
5949 <p>Some rare LEGACY devices may not support
5950 this,<wbr/> in which case the value will always be overridden to OFF.<wbr/></p></span>
5951                   </li>
5952                 </ul>
5953
5954             </td> <!-- entry_type -->
5955
5956             <td class="entry_description">
5957               <p>Whether auto-exposure (AE) is currently locked to its latest
5958 calculated values.<wbr/></p>
5959             </td>
5960
5961             <td class="entry_units">
5962             </td>
5963
5964             <td class="entry_range">
5965             </td>
5966
5967             <td class="entry_tags">
5968               <ul class="entry_tags">
5969                   <li><a href="#tag_BC">BC</a></li>
5970               </ul>
5971             </td>
5972
5973           </tr>
5974           <tr class="entries_header">
5975             <th class="th_details" colspan="5">Details</th>
5976           </tr>
5977           <tr class="entry_cont">
5978             <td class="entry_details" colspan="5">
5979               <p>When set to <code>true</code> (ON),<wbr/> the AE algorithm is locked to its latest parameters,<wbr/>
5980 and will not change exposure settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
5981 <p>Note that even when AE is locked,<wbr/> the flash may be fired if
5982 the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>AUTO_<wbr/>FLASH /<wbr/>
5983 ON_<wbr/>ALWAYS_<wbr/>FLASH /<wbr/> ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE.<wbr/></p>
5984 <p>When <a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a> is changed,<wbr/> even if the AE lock
5985 is ON,<wbr/> the camera device will still adjust its exposure value.<wbr/></p>
5986 <p>If AE precapture is triggered (see <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>)
5987 when AE is already locked,<wbr/> the camera device will not change the exposure time
5988 (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) and sensitivity (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
5989 parameters.<wbr/> The flash may be fired if the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
5990 is ON_<wbr/>AUTO_<wbr/>FLASH/<wbr/>ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE and the scene is too dark.<wbr/> If the
5991 <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> the scene may become overexposed.<wbr/>
5992 Similarly,<wbr/> AE precapture trigger CANCEL has no effect when AE is already locked.<wbr/></p>
5993 <p>When an AE precapture sequence is triggered,<wbr/> AE unlock will not be able to unlock
5994 the AE if AE is locked by the camera device internally during precapture metering
5995 sequence In other words,<wbr/> submitting requests with AE unlock has no effect for an
5996 ongoing precapture metering sequence.<wbr/> Otherwise,<wbr/> the precapture metering sequence
5997 will never succeed in a sequence of preview requests where AE lock is always set
5998 to <code>false</code>.<wbr/></p>
5999 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
6000 get locked do not necessarily correspond to the settings that were present in the
6001 latest capture result received from the camera device,<wbr/> since additional captures
6002 and AE updates may have occurred even before the result was sent out.<wbr/> If an
6003 application is switching between automatic and manual control and wishes to eliminate
6004 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
6005 <ol>
6006 <li>Starting in auto-AE mode:</li>
6007 <li>Lock AE</li>
6008 <li>Wait for the first result to be output that has the AE locked</li>
6009 <li>Copy exposure settings from that result into a request,<wbr/> set the request to manual AE</li>
6010 <li>Submit the capture request,<wbr/> proceed to run manual AE as desired.<wbr/></li>
6011 </ol>
6012 <p>See <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE lock related state transition details.<wbr/></p>
6013             </td>
6014           </tr>
6015
6016
6017           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6018            <!-- end of entry -->
6019
6020
6021           <tr class="entry" id="dynamic_android.control.aeMode">
6022             <td class="entry_name
6023              " rowspan="3">
6024               android.<wbr/>control.<wbr/>ae<wbr/>Mode
6025             </td>
6026             <td class="entry_type">
6027                 <span class="entry_type_name entry_type_name_enum">byte</span>
6028
6029               <span class="entry_type_visibility"> [public]</span>
6030
6031
6032               <span class="entry_type_hwlevel">[legacy] </span>
6033
6034
6035
6036                 <ul class="entry_type_enum">
6037                   <li>
6038                     <span class="entry_type_enum_name">OFF</span>
6039                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is disabled.<wbr/></p>
6040 <p>The application-selected <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
6041 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> and
6042 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are used by the camera
6043 device,<wbr/> along with android.<wbr/>flash.<wbr/>* fields,<wbr/> if there's
6044 a flash unit for this camera device.<wbr/></p>
6045 <p>Note that auto-white balance (AWB) and auto-focus (AF)
6046 behavior is device dependent when AE is in OFF mode.<wbr/>
6047 To have consistent behavior across different devices,<wbr/>
6048 it is recommended to either set AWB and AF to OFF mode
6049 or lock AWB and AF before setting AE to OFF.<wbr/>
6050 See <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>,<wbr/>
6051 <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a>,<wbr/> and <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
6052 for more details.<wbr/></p>
6053 <p>LEGACY devices do not support the OFF mode and will
6054 override attempts to use this value to ON.<wbr/></p></span>
6055                   </li>
6056                   <li>
6057                     <span class="entry_type_enum_name">ON</span>
6058                     <span class="entry_type_enum_notes"><p>The camera device's autoexposure routine is active,<wbr/>
6059 with no flash control.<wbr/></p>
6060 <p>The application's values for
6061 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
6062 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
6063 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> are ignored.<wbr/> The
6064 application has control over the various
6065 android.<wbr/>flash.<wbr/>* fields.<wbr/></p></span>
6066                   </li>
6067                   <li>
6068                     <span class="entry_type_enum_name">ON_AUTO_FLASH</span>
6069                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
6070 the camera's flash unit,<wbr/> firing it in low-light
6071 conditions.<wbr/></p>
6072 <p>The flash may be fired during a precapture sequence
6073 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
6074 may be fired for captures for which the
6075 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
6076 STILL_<wbr/>CAPTURE</p></span>
6077                   </li>
6078                   <li>
6079                     <span class="entry_type_enum_name">ON_ALWAYS_FLASH</span>
6080                     <span class="entry_type_enum_notes"><p>Like ON,<wbr/> except that the camera device also controls
6081 the camera's flash unit,<wbr/> always firing it for still
6082 captures.<wbr/></p>
6083 <p>The flash may be fired during a precapture sequence
6084 (triggered by <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>) and
6085 will always be fired for captures for which the
6086 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> field is set to
6087 STILL_<wbr/>CAPTURE</p></span>
6088                   </li>
6089                   <li>
6090                     <span class="entry_type_enum_name">ON_AUTO_FLASH_REDEYE</span>
6091                     <span class="entry_type_enum_notes"><p>Like ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/> but with automatic red eye
6092 reduction.<wbr/></p>
6093 <p>If deemed necessary by the camera device,<wbr/> a red eye
6094 reduction flash will fire during the precapture
6095 sequence.<wbr/></p></span>
6096                   </li>
6097                 </ul>
6098
6099             </td> <!-- entry_type -->
6100
6101             <td class="entry_description">
6102               <p>The desired mode for the camera device's
6103 auto-exposure routine.<wbr/></p>
6104             </td>
6105
6106             <td class="entry_units">
6107             </td>
6108
6109             <td class="entry_range">
6110               <p><a href="#static_android.control.aeAvailableModes">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Modes</a></p>
6111             </td>
6112
6113             <td class="entry_tags">
6114               <ul class="entry_tags">
6115                   <li><a href="#tag_BC">BC</a></li>
6116               </ul>
6117             </td>
6118
6119           </tr>
6120           <tr class="entries_header">
6121             <th class="th_details" colspan="5">Details</th>
6122           </tr>
6123           <tr class="entry_cont">
6124             <td class="entry_details" colspan="5">
6125               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is
6126 AUTO.<wbr/></p>
6127 <p>When set to any of the ON modes,<wbr/> the camera device's
6128 auto-exposure routine is enabled,<wbr/> overriding the
6129 application's selected exposure time,<wbr/> sensor sensitivity,<wbr/>
6130 and frame duration (<a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
6131 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and
6132 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>).<wbr/> If one of the FLASH modes
6133 is selected,<wbr/> the camera device's flash unit controls are
6134 also overridden.<wbr/></p>
6135 <p>The FLASH modes are only available if the camera device
6136 has a flash unit (<a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> is <code>true</code>).<wbr/></p>
6137 <p>If flash TORCH mode is desired,<wbr/> this field must be set to
6138 ON or OFF,<wbr/> and <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> set to TORCH.<wbr/></p>
6139 <p>When set to any of the ON modes,<wbr/> the values chosen by the
6140 camera device auto-exposure routine for the overridden
6141 fields for a given capture will be available in its
6142 CaptureResult.<wbr/></p>
6143             </td>
6144           </tr>
6145
6146
6147           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6148            <!-- end of entry -->
6149
6150
6151           <tr class="entry" id="dynamic_android.control.aeRegions">
6152             <td class="entry_name
6153              " rowspan="5">
6154               android.<wbr/>control.<wbr/>ae<wbr/>Regions
6155             </td>
6156             <td class="entry_type">
6157                 <span class="entry_type_name">int32</span>
6158                 <span class="entry_type_container">x</span>
6159
6160                 <span class="entry_type_array">
6161                   5 x area_count
6162                 </span>
6163               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
6164
6165
6166
6167
6168
6169
6170             </td> <!-- entry_type -->
6171
6172             <td class="entry_description">
6173               <p>List of metering areas to use for auto-exposure adjustment.<wbr/></p>
6174             </td>
6175
6176             <td class="entry_units">
6177               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
6178             </td>
6179
6180             <td class="entry_range">
6181               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
6182 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
6183             </td>
6184
6185             <td class="entry_tags">
6186               <ul class="entry_tags">
6187                   <li><a href="#tag_BC">BC</a></li>
6188               </ul>
6189             </td>
6190
6191           </tr>
6192           <tr class="entries_header">
6193             <th class="th_details" colspan="5">Details</th>
6194           </tr>
6195           <tr class="entry_cont">
6196             <td class="entry_details" colspan="5">
6197               <p>Not available if <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a> is 0.<wbr/>
6198 Otherwise will always be present.<wbr/></p>
6199 <p>The maximum number of regions supported by the device is determined by the value
6200 of <a href="#static_android.control.maxRegionsAe">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Ae</a>.<wbr/></p>
6201 <p>The coordinate system is based on the active pixel array,<wbr/>
6202 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
6203 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
6204 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
6205 bottom-right pixel in the active pixel array.<wbr/></p>
6206 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
6207 for every pixel in the area.<wbr/> This means that a large metering area
6208 with the same weight as a smaller area will have more effect in
6209 the metering result.<wbr/> Metering areas can partially overlap and the
6210 camera device will add the weights in the overlap region.<wbr/></p>
6211 <p>The weights are relative to weights of other exposure metering regions,<wbr/> so if only one
6212 region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0
6213 weight is ignored.<wbr/></p>
6214 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
6215 camera device.<wbr/></p>
6216 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
6217 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
6218 region and output only the intersection rectangle as the metering region in the result
6219 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
6220 not reported in the result metadata.<wbr/></p>
6221             </td>
6222           </tr>
6223
6224           <tr class="entries_header">
6225             <th class="th_details" colspan="5">HAL Implementation Details</th>
6226           </tr>
6227           <tr class="entry_cont">
6228             <td class="entry_details" colspan="5">
6229               <p>The HAL level representation of MeteringRectangle[] is a
6230 int[5 * area_<wbr/>count].<wbr/>
6231 Every five elements represent a metering region of
6232 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
6233 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
6234 exclusive on xmax and ymax.<wbr/></p>
6235             </td>
6236           </tr>
6237
6238           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6239            <!-- end of entry -->
6240
6241
6242           <tr class="entry" id="dynamic_android.control.aeTargetFpsRange">
6243             <td class="entry_name
6244              " rowspan="3">
6245               android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range
6246             </td>
6247             <td class="entry_type">
6248                 <span class="entry_type_name">int32</span>
6249                 <span class="entry_type_container">x</span>
6250
6251                 <span class="entry_type_array">
6252                   2
6253                 </span>
6254               <span class="entry_type_visibility"> [public as rangeInt]</span>
6255
6256
6257               <span class="entry_type_hwlevel">[legacy] </span>
6258
6259
6260
6261
6262             </td> <!-- entry_type -->
6263
6264             <td class="entry_description">
6265               <p>Range over which the auto-exposure routine can
6266 adjust the capture frame rate to maintain good
6267 exposure.<wbr/></p>
6268             </td>
6269
6270             <td class="entry_units">
6271               Frames per second (FPS)
6272             </td>
6273
6274             <td class="entry_range">
6275               <p>Any of the entries in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a></p>
6276             </td>
6277
6278             <td class="entry_tags">
6279               <ul class="entry_tags">
6280                   <li><a href="#tag_BC">BC</a></li>
6281               </ul>
6282             </td>
6283
6284           </tr>
6285           <tr class="entries_header">
6286             <th class="th_details" colspan="5">Details</th>
6287           </tr>
6288           <tr class="entry_cont">
6289             <td class="entry_details" colspan="5">
6290               <p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
6291 manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
6292 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
6293             </td>
6294           </tr>
6295
6296
6297           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6298            <!-- end of entry -->
6299
6300
6301           <tr class="entry" id="dynamic_android.control.aePrecaptureTrigger">
6302             <td class="entry_name
6303              " rowspan="5">
6304               android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger
6305             </td>
6306             <td class="entry_type">
6307                 <span class="entry_type_name entry_type_name_enum">byte</span>
6308
6309               <span class="entry_type_visibility"> [public]</span>
6310
6311
6312               <span class="entry_type_hwlevel">[limited] </span>
6313
6314
6315
6316                 <ul class="entry_type_enum">
6317                   <li>
6318                     <span class="entry_type_enum_name">IDLE</span>
6319                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
6320                   </li>
6321                   <li>
6322                     <span class="entry_type_enum_name">START</span>
6323                     <span class="entry_type_enum_notes"><p>The precapture metering sequence will be started
6324 by the camera device.<wbr/></p>
6325 <p>The exact effect of the precapture trigger depends on
6326 the current AE mode and state.<wbr/></p></span>
6327                   </li>
6328                   <li>
6329                     <span class="entry_type_enum_name">CANCEL</span>
6330                     <span class="entry_type_enum_notes"><p>The camera device will cancel any currently active or completed
6331 precapture metering sequence,<wbr/> the auto-exposure routine will return to its
6332 initial state.<wbr/></p></span>
6333                   </li>
6334                 </ul>
6335
6336             </td> <!-- entry_type -->
6337
6338             <td class="entry_description">
6339               <p>Whether the camera device will trigger a precapture
6340 metering sequence when it processes this request.<wbr/></p>
6341             </td>
6342
6343             <td class="entry_units">
6344             </td>
6345
6346             <td class="entry_range">
6347             </td>
6348
6349             <td class="entry_tags">
6350               <ul class="entry_tags">
6351                   <li><a href="#tag_BC">BC</a></li>
6352               </ul>
6353             </td>
6354
6355           </tr>
6356           <tr class="entries_header">
6357             <th class="th_details" colspan="5">Details</th>
6358           </tr>
6359           <tr class="entry_cont">
6360             <td class="entry_details" colspan="5">
6361               <p>This entry is normally set to IDLE,<wbr/> or is not
6362 included at all in the request settings.<wbr/> When included and
6363 set to START,<wbr/> the camera device will trigger the auto-exposure (AE)
6364 precapture metering sequence.<wbr/></p>
6365 <p>When set to CANCEL,<wbr/> the camera device will cancel any active
6366 precapture metering trigger,<wbr/> and return to its initial AE state.<wbr/>
6367 If a precapture metering sequence is already completed,<wbr/> and the camera
6368 device has implicitly locked the AE for subsequent still capture,<wbr/> the
6369 CANCEL trigger will unlock the AE and return to its initial AE state.<wbr/></p>
6370 <p>The precapture sequence should be triggered before starting a
6371 high-quality still capture for final metering decisions to
6372 be made,<wbr/> and for firing pre-capture flash pulses to estimate
6373 scene brightness and required final capture flash power,<wbr/> when
6374 the flash is enabled.<wbr/></p>
6375 <p>Normally,<wbr/> this entry should be set to START for only a
6376 single request,<wbr/> and the application should wait until the
6377 sequence completes before starting a new one.<wbr/></p>
6378 <p>When a precapture metering sequence is finished,<wbr/> the camera device
6379 may lock the auto-exposure routine internally to be able to accurately expose the
6380 subsequent still capture image (<code><a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE</code>).<wbr/>
6381 For this case,<wbr/> the AE may not resume normal scan if no subsequent still capture is
6382 submitted.<wbr/> To ensure that the AE routine restarts normal scan,<wbr/> the application should
6383 submit a request with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == true</code>,<wbr/> followed by a request
6384 with <code><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> == false</code>,<wbr/> if the application decides not to submit a
6385 still capture request after the precapture sequence completes.<wbr/> Alternatively,<wbr/> for
6386 API level 23 or newer devices,<wbr/> the CANCEL can be used to unlock the camera device
6387 internally locked AE if the application doesn't submit a still capture request after
6388 the AE precapture trigger.<wbr/> Note that,<wbr/> the CANCEL was added in API level 23,<wbr/> and must not
6389 be used in devices that have earlier API levels.<wbr/></p>
6390 <p>The exact effect of auto-exposure (AE) precapture trigger
6391 depends on the current AE mode and state; see
6392 <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> for AE precapture state transition
6393 details.<wbr/></p>
6394 <p>On LEGACY-level devices,<wbr/> the precapture trigger is not supported;
6395 capturing a high-resolution JPEG image will automatically trigger a
6396 precapture sequence before the high-resolution capture,<wbr/> including
6397 potentially firing a pre-capture flash.<wbr/></p>
6398 <p>Using the precapture trigger and the auto-focus trigger <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>
6399 simultaneously is allowed.<wbr/> However,<wbr/> since these triggers often require cooperation between
6400 the auto-focus and auto-exposure routines (for example,<wbr/> the may need to be enabled for a
6401 focus sweep),<wbr/> the camera device may delay acting on a later trigger until the previous
6402 trigger has been fully handled.<wbr/> This may lead to longer intervals between the trigger and
6403 changes to <a href="#dynamic_android.control.aeState">android.<wbr/>control.<wbr/>ae<wbr/>State</a> indicating the start of the precapture sequence,<wbr/> for
6404 example.<wbr/></p>
6405 <p>If both the precapture and the auto-focus trigger are activated on the same request,<wbr/> then
6406 the camera device will complete them in the optimal order for that device.<wbr/></p>
6407             </td>
6408           </tr>
6409
6410           <tr class="entries_header">
6411             <th class="th_details" colspan="5">HAL Implementation Details</th>
6412           </tr>
6413           <tr class="entry_cont">
6414             <td class="entry_details" colspan="5">
6415               <p>The HAL must support triggering the AE precapture trigger while an AF trigger is active
6416 (and vice versa),<wbr/> or at the same time as the AF trigger.<wbr/>  It is acceptable for the HAL to
6417 treat these as two consecutive triggers,<wbr/> for example handling the AF trigger and then the
6418 AE trigger.<wbr/>  Or the HAL may choose to optimize the case with both triggers fired at once,<wbr/>
6419 to minimize the latency for converging both focus and exposure/<wbr/>flash usage.<wbr/></p>
6420             </td>
6421           </tr>
6422
6423           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6424            <!-- end of entry -->
6425
6426
6427           <tr class="entry" id="dynamic_android.control.aeState">
6428             <td class="entry_name
6429              " rowspan="3">
6430               android.<wbr/>control.<wbr/>ae<wbr/>State
6431             </td>
6432             <td class="entry_type">
6433                 <span class="entry_type_name entry_type_name_enum">byte</span>
6434
6435               <span class="entry_type_visibility"> [public]</span>
6436
6437
6438               <span class="entry_type_hwlevel">[limited] </span>
6439
6440
6441
6442                 <ul class="entry_type_enum">
6443                   <li>
6444                     <span class="entry_type_enum_name">INACTIVE</span>
6445                     <span class="entry_type_enum_notes"><p>AE is off or recently reset.<wbr/></p>
6446 <p>When a camera device is opened,<wbr/> it starts in
6447 this state.<wbr/> This is a transient state,<wbr/> the camera device may skip reporting
6448 this state in capture result.<wbr/></p></span>
6449                   </li>
6450                   <li>
6451                     <span class="entry_type_enum_name">SEARCHING</span>
6452                     <span class="entry_type_enum_notes"><p>AE doesn't yet have a good set of control values
6453 for the current scene.<wbr/></p>
6454 <p>This is a transient state,<wbr/> the camera device may skip
6455 reporting this state in capture result.<wbr/></p></span>
6456                   </li>
6457                   <li>
6458                     <span class="entry_type_enum_name">CONVERGED</span>
6459                     <span class="entry_type_enum_notes"><p>AE has a good set of control values for the
6460 current scene.<wbr/></p></span>
6461                   </li>
6462                   <li>
6463                     <span class="entry_type_enum_name">LOCKED</span>
6464                     <span class="entry_type_enum_notes"><p>AE has been locked.<wbr/></p></span>
6465                   </li>
6466                   <li>
6467                     <span class="entry_type_enum_name">FLASH_REQUIRED</span>
6468                     <span class="entry_type_enum_notes"><p>AE has a good set of control values,<wbr/> but flash
6469 needs to be fired for good quality still
6470 capture.<wbr/></p></span>
6471                   </li>
6472                   <li>
6473                     <span class="entry_type_enum_name">PRECAPTURE</span>
6474                     <span class="entry_type_enum_notes"><p>AE has been asked to do a precapture sequence
6475 and is currently executing it.<wbr/></p>
6476 <p>Precapture can be triggered through setting
6477 <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> to START.<wbr/> Currently
6478 active and completed (if it causes camera device internal AE lock) precapture
6479 metering sequence can be canceled through setting
6480 <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> to CANCEL.<wbr/></p>
6481 <p>Once PRECAPTURE completes,<wbr/> AE will transition to CONVERGED
6482 or FLASH_<wbr/>REQUIRED as appropriate.<wbr/> This is a transient
6483 state,<wbr/> the camera device may skip reporting this state in
6484 capture result.<wbr/></p></span>
6485                   </li>
6486                 </ul>
6487
6488             </td> <!-- entry_type -->
6489
6490             <td class="entry_description">
6491               <p>Current state of the auto-exposure (AE) algorithm.<wbr/></p>
6492             </td>
6493
6494             <td class="entry_units">
6495             </td>
6496
6497             <td class="entry_range">
6498             </td>
6499
6500             <td class="entry_tags">
6501             </td>
6502
6503           </tr>
6504           <tr class="entries_header">
6505             <th class="th_details" colspan="5">Details</th>
6506           </tr>
6507           <tr class="entry_cont">
6508             <td class="entry_details" colspan="5">
6509               <p>Switching between or enabling AE modes (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>) always
6510 resets the AE state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
6511 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
6512 the algorithm states to INACTIVE.<wbr/></p>
6513 <p>The camera device can do several state transitions between two results,<wbr/> if it is
6514 allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
6515 seen in a result.<wbr/></p>
6516 <p>The state in the result is the state for this image (in sync with this image): if
6517 AE state becomes CONVERGED,<wbr/> then the image data associated with this result should
6518 be good to use.<wbr/></p>
6519 <p>Below are state transition tables for different AE modes.<wbr/></p>
6520 <table>
6521 <thead>
6522 <tr>
6523 <th align="center">State</th>
6524 <th align="center">Transition Cause</th>
6525 <th align="center">New State</th>
6526 <th align="center">Notes</th>
6527 </tr>
6528 </thead>
6529 <tbody>
6530 <tr>
6531 <td align="center">INACTIVE</td>
6532 <td align="center"></td>
6533 <td align="center">INACTIVE</td>
6534 <td align="center">Camera device auto exposure algorithm is disabled</td>
6535 </tr>
6536 </tbody>
6537 </table>
6538 <p>When <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is AE_<wbr/>MODE_<wbr/>ON_<wbr/>*:</p>
6539 <table>
6540 <thead>
6541 <tr>
6542 <th align="center">State</th>
6543 <th align="center">Transition Cause</th>
6544 <th align="center">New State</th>
6545 <th align="center">Notes</th>
6546 </tr>
6547 </thead>
6548 <tbody>
6549 <tr>
6550 <td align="center">INACTIVE</td>
6551 <td align="center">Camera device initiates AE scan</td>
6552 <td align="center">SEARCHING</td>
6553 <td align="center">Values changing</td>
6554 </tr>
6555 <tr>
6556 <td align="center">INACTIVE</td>
6557 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
6558 <td align="center">LOCKED</td>
6559 <td align="center">Values locked</td>
6560 </tr>
6561 <tr>
6562 <td align="center">SEARCHING</td>
6563 <td align="center">Camera device finishes AE scan</td>
6564 <td align="center">CONVERGED</td>
6565 <td align="center">Good values,<wbr/> not changing</td>
6566 </tr>
6567 <tr>
6568 <td align="center">SEARCHING</td>
6569 <td align="center">Camera device finishes AE scan</td>
6570 <td align="center">FLASH_<wbr/>REQUIRED</td>
6571 <td align="center">Converged but too dark w/<wbr/>o flash</td>
6572 </tr>
6573 <tr>
6574 <td align="center">SEARCHING</td>
6575 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
6576 <td align="center">LOCKED</td>
6577 <td align="center">Values locked</td>
6578 </tr>
6579 <tr>
6580 <td align="center">CONVERGED</td>
6581 <td align="center">Camera device initiates AE scan</td>
6582 <td align="center">SEARCHING</td>
6583 <td align="center">Values changing</td>
6584 </tr>
6585 <tr>
6586 <td align="center">CONVERGED</td>
6587 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
6588 <td align="center">LOCKED</td>
6589 <td align="center">Values locked</td>
6590 </tr>
6591 <tr>
6592 <td align="center">FLASH_<wbr/>REQUIRED</td>
6593 <td align="center">Camera device initiates AE scan</td>
6594 <td align="center">SEARCHING</td>
6595 <td align="center">Values changing</td>
6596 </tr>
6597 <tr>
6598 <td align="center">FLASH_<wbr/>REQUIRED</td>
6599 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
6600 <td align="center">LOCKED</td>
6601 <td align="center">Values locked</td>
6602 </tr>
6603 <tr>
6604 <td align="center">LOCKED</td>
6605 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
6606 <td align="center">SEARCHING</td>
6607 <td align="center">Values not good after unlock</td>
6608 </tr>
6609 <tr>
6610 <td align="center">LOCKED</td>
6611 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
6612 <td align="center">CONVERGED</td>
6613 <td align="center">Values good after unlock</td>
6614 </tr>
6615 <tr>
6616 <td align="center">LOCKED</td>
6617 <td align="center"><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
6618 <td align="center">FLASH_<wbr/>REQUIRED</td>
6619 <td align="center">Exposure good,<wbr/> but too dark</td>
6620 </tr>
6621 <tr>
6622 <td align="center">PRECAPTURE</td>
6623 <td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is OFF</td>
6624 <td align="center">CONVERGED</td>
6625 <td align="center">Ready for high-quality capture</td>
6626 </tr>
6627 <tr>
6628 <td align="center">PRECAPTURE</td>
6629 <td align="center">Sequence done.<wbr/> <a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a> is ON</td>
6630 <td align="center">LOCKED</td>
6631 <td align="center">Ready for high-quality capture</td>
6632 </tr>
6633 <tr>
6634 <td align="center">LOCKED</td>
6635 <td align="center">aeLock is ON and aePrecaptureTrigger is START</td>
6636 <td align="center">LOCKED</td>
6637 <td align="center">Precapture trigger is ignored when AE is already locked</td>
6638 </tr>
6639 <tr>
6640 <td align="center">LOCKED</td>
6641 <td align="center">aeLock is ON and aePrecaptureTrigger is CANCEL</td>
6642 <td align="center">LOCKED</td>
6643 <td align="center">Precapture trigger is ignored when AE is already locked</td>
6644 </tr>
6645 <tr>
6646 <td align="center">Any state (excluding LOCKED)</td>
6647 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START</td>
6648 <td align="center">PRECAPTURE</td>
6649 <td align="center">Start AE precapture metering sequence</td>
6650 </tr>
6651 <tr>
6652 <td align="center">Any state (excluding LOCKED)</td>
6653 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is CANCEL</td>
6654 <td align="center">INACTIVE</td>
6655 <td align="center">Currently active precapture metering sequence is canceled</td>
6656 </tr>
6657 </tbody>
6658 </table>
6659 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
6660 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
6661 can be skipped in that manner is called a transient state.<wbr/></p>
6662 <p>For example,<wbr/> for above AE modes (AE_<wbr/>MODE_<wbr/>ON_<wbr/>*),<wbr/> in addition to the state transitions
6663 listed in above table,<wbr/> it is also legal for the camera device to skip one or more
6664 transient states between two results.<wbr/> See below table for examples:</p>
6665 <table>
6666 <thead>
6667 <tr>
6668 <th align="center">State</th>
6669 <th align="center">Transition Cause</th>
6670 <th align="center">New State</th>
6671 <th align="center">Notes</th>
6672 </tr>
6673 </thead>
6674 <tbody>
6675 <tr>
6676 <td align="center">INACTIVE</td>
6677 <td align="center">Camera device finished AE scan</td>
6678 <td align="center">CONVERGED</td>
6679 <td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
6680 </tr>
6681 <tr>
6682 <td align="center">Any state (excluding LOCKED)</td>
6683 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START,<wbr/> sequence done</td>
6684 <td align="center">FLASH_<wbr/>REQUIRED</td>
6685 <td align="center">Converged but too dark w/<wbr/>o flash after a precapture sequence,<wbr/> transient states are skipped by camera device.<wbr/></td>
6686 </tr>
6687 <tr>
6688 <td align="center">Any state (excluding LOCKED)</td>
6689 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is START,<wbr/> sequence done</td>
6690 <td align="center">CONVERGED</td>
6691 <td align="center">Converged after a precapture sequence,<wbr/> transient states are skipped by camera device.<wbr/></td>
6692 </tr>
6693 <tr>
6694 <td align="center">Any state (excluding LOCKED)</td>
6695 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is CANCEL,<wbr/> converged</td>
6696 <td align="center">FLASH_<wbr/>REQUIRED</td>
6697 <td align="center">Converged but too dark w/<wbr/>o flash after a precapture sequence is canceled,<wbr/> transient states are skipped by camera device.<wbr/></td>
6698 </tr>
6699 <tr>
6700 <td align="center">Any state (excluding LOCKED)</td>
6701 <td align="center"><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is CANCEL,<wbr/> converged</td>
6702 <td align="center">CONVERGED</td>
6703 <td align="center">Converged after a precapture sequenceis canceled,<wbr/> transient states are skipped by camera device.<wbr/></td>
6704 </tr>
6705 <tr>
6706 <td align="center">CONVERGED</td>
6707 <td align="center">Camera device finished AE scan</td>
6708 <td align="center">FLASH_<wbr/>REQUIRED</td>
6709 <td align="center">Converged but too dark w/<wbr/>o flash after a new scan,<wbr/> transient states are skipped by camera device.<wbr/></td>
6710 </tr>
6711 <tr>
6712 <td align="center">FLASH_<wbr/>REQUIRED</td>
6713 <td align="center">Camera device finished AE scan</td>
6714 <td align="center">CONVERGED</td>
6715 <td align="center">Converged after a new scan,<wbr/> transient states are skipped by camera device.<wbr/></td>
6716 </tr>
6717 </tbody>
6718 </table>
6719             </td>
6720           </tr>
6721
6722
6723           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6724            <!-- end of entry -->
6725
6726
6727           <tr class="entry" id="dynamic_android.control.afMode">
6728             <td class="entry_name
6729              " rowspan="5">
6730               android.<wbr/>control.<wbr/>af<wbr/>Mode
6731             </td>
6732             <td class="entry_type">
6733                 <span class="entry_type_name entry_type_name_enum">byte</span>
6734
6735               <span class="entry_type_visibility"> [public]</span>
6736
6737
6738               <span class="entry_type_hwlevel">[legacy] </span>
6739
6740
6741
6742                 <ul class="entry_type_enum">
6743                   <li>
6744                     <span class="entry_type_enum_name">OFF</span>
6745                     <span class="entry_type_enum_notes"><p>The auto-focus routine does not control the lens;
6746 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> is controlled by the
6747 application.<wbr/></p></span>
6748                   </li>
6749                   <li>
6750                     <span class="entry_type_enum_name">AUTO</span>
6751                     <span class="entry_type_enum_notes"><p>Basic automatic focus mode.<wbr/></p>
6752 <p>In this mode,<wbr/> the lens does not move unless
6753 the autofocus trigger action is called.<wbr/> When that trigger
6754 is activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
6755 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/></p>
6756 <p>Always supported if lens is not fixed focus.<wbr/></p>
6757 <p>Use <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> to determine if lens
6758 is fixed-focus.<wbr/></p>
6759 <p>Triggering AF_<wbr/>CANCEL resets the lens position to default,<wbr/>
6760 and sets the AF state to INACTIVE.<wbr/></p></span>
6761                   </li>
6762                   <li>
6763                     <span class="entry_type_enum_name">MACRO</span>
6764                     <span class="entry_type_enum_notes"><p>Close-up focusing mode.<wbr/></p>
6765 <p>In this mode,<wbr/> the lens does not move unless the
6766 autofocus trigger action is called.<wbr/> When that trigger is
6767 activated,<wbr/> AF will transition to ACTIVE_<wbr/>SCAN,<wbr/> then to
6768 the outcome of the scan (FOCUSED or NOT_<wbr/>FOCUSED).<wbr/> This
6769 mode is optimized for focusing on objects very close to
6770 the camera.<wbr/></p>
6771 <p>When that trigger is activated,<wbr/> AF will transition to
6772 ACTIVE_<wbr/>SCAN,<wbr/> then to the outcome of the scan (FOCUSED or
6773 NOT_<wbr/>FOCUSED).<wbr/> Triggering cancel AF resets the lens
6774 position to default,<wbr/> and sets the AF state to
6775 INACTIVE.<wbr/></p></span>
6776                   </li>
6777                   <li>
6778                     <span class="entry_type_enum_name">CONTINUOUS_VIDEO</span>
6779                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
6780 position continually to attempt to provide a
6781 constantly-in-focus image stream.<wbr/></p>
6782 <p>The focusing behavior should be suitable for good quality
6783 video recording; typically this means slower focus
6784 movement and no overshoots.<wbr/> When the AF trigger is not
6785 involved,<wbr/> the AF algorithm should start in INACTIVE state,<wbr/>
6786 and then transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED
6787 states as appropriate.<wbr/> When the AF trigger is activated,<wbr/>
6788 the algorithm should immediately transition into
6789 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
6790 lens position until a cancel AF trigger is received.<wbr/></p>
6791 <p>Once cancel is received,<wbr/> the algorithm should transition
6792 back to INACTIVE and resume passive scan.<wbr/> Note that this
6793 behavior is not identical to CONTINUOUS_<wbr/>PICTURE,<wbr/> since an
6794 ongoing PASSIVE_<wbr/>SCAN must immediately be
6795 canceled.<wbr/></p></span>
6796                   </li>
6797                   <li>
6798                     <span class="entry_type_enum_name">CONTINUOUS_PICTURE</span>
6799                     <span class="entry_type_enum_notes"><p>In this mode,<wbr/> the AF algorithm modifies the lens
6800 position continually to attempt to provide a
6801 constantly-in-focus image stream.<wbr/></p>
6802 <p>The focusing behavior should be suitable for still image
6803 capture; typically this means focusing as fast as
6804 possible.<wbr/> When the AF trigger is not involved,<wbr/> the AF
6805 algorithm should start in INACTIVE state,<wbr/> and then
6806 transition into PASSIVE_<wbr/>SCAN and PASSIVE_<wbr/>FOCUSED states as
6807 appropriate as it attempts to maintain focus.<wbr/> When the AF
6808 trigger is activated,<wbr/> the algorithm should finish its
6809 PASSIVE_<wbr/>SCAN if active,<wbr/> and then transition into
6810 AF_<wbr/>FOCUSED or AF_<wbr/>NOT_<wbr/>FOCUSED as appropriate,<wbr/> and lock the
6811 lens position until a cancel AF trigger is received.<wbr/></p>
6812 <p>When the AF cancel trigger is activated,<wbr/> the algorithm
6813 should transition back to INACTIVE and then act as if it
6814 has just been started.<wbr/></p></span>
6815                   </li>
6816                   <li>
6817                     <span class="entry_type_enum_name">EDOF</span>
6818                     <span class="entry_type_enum_notes"><p>Extended depth of field (digital focus) mode.<wbr/></p>
6819 <p>The camera device will produce images with an extended
6820 depth of field automatically; no special focusing
6821 operations need to be done before taking a picture.<wbr/></p>
6822 <p>AF triggers are ignored,<wbr/> and the AF state will always be
6823 INACTIVE.<wbr/></p></span>
6824                   </li>
6825                 </ul>
6826
6827             </td> <!-- entry_type -->
6828
6829             <td class="entry_description">
6830               <p>Whether auto-focus (AF) is currently enabled,<wbr/> and what
6831 mode it is set to.<wbr/></p>
6832             </td>
6833
6834             <td class="entry_units">
6835             </td>
6836
6837             <td class="entry_range">
6838               <p><a href="#static_android.control.afAvailableModes">android.<wbr/>control.<wbr/>af<wbr/>Available<wbr/>Modes</a></p>
6839             </td>
6840
6841             <td class="entry_tags">
6842               <ul class="entry_tags">
6843                   <li><a href="#tag_BC">BC</a></li>
6844               </ul>
6845             </td>
6846
6847           </tr>
6848           <tr class="entries_header">
6849             <th class="th_details" colspan="5">Details</th>
6850           </tr>
6851           <tr class="entry_cont">
6852             <td class="entry_details" colspan="5">
6853               <p>Only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> = AUTO and the lens is not fixed focus
6854 (i.<wbr/>e.<wbr/> <code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> &gt; 0</code>).<wbr/> Also note that
6855 when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/> the behavior of AF is device
6856 dependent.<wbr/> It is recommended to lock AF by using <a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> before
6857 setting <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> to OFF,<wbr/> or set AF mode to OFF when AE is OFF.<wbr/></p>
6858 <p>If the lens is controlled by the camera device auto-focus algorithm,<wbr/>
6859 the camera device will report the current AF status in <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>
6860 in result metadata.<wbr/></p>
6861             </td>
6862           </tr>
6863
6864           <tr class="entries_header">
6865             <th class="th_details" colspan="5">HAL Implementation Details</th>
6866           </tr>
6867           <tr class="entry_cont">
6868             <td class="entry_details" colspan="5">
6869               <p>When afMode is AUTO or MACRO,<wbr/> the lens must not move until an AF trigger is sent in a
6870 request (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a> <code>==</code> START).<wbr/> After an AF trigger,<wbr/> the afState will end
6871 up with either FOCUSED_<wbr/>LOCKED or NOT_<wbr/>FOCUSED_<wbr/>LOCKED state (see
6872 <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> which indicates that the lens is
6873 locked and will not move.<wbr/> If camera movement (e.<wbr/>g.<wbr/> tilting camera) causes the lens to move
6874 after the lens is locked,<wbr/> the HAL must compensate this movement appropriately such that
6875 the same focal plane remains in focus.<wbr/></p>
6876 <p>When afMode is one of the continuous auto focus modes,<wbr/> the HAL is free to start a AF
6877 scan whenever it's not locked.<wbr/> When the lens is locked after an AF trigger
6878 (see <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for detailed state transitions),<wbr/> the HAL should maintain the
6879 same lock behavior as above.<wbr/></p>
6880 <p>When afMode is OFF,<wbr/> the application controls focus manually.<wbr/> The accuracy of the
6881 focus distance control depends on the <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a>.<wbr/>
6882 However,<wbr/> the lens must not move regardless of the camera movement for any focus distance
6883 manual control.<wbr/></p>
6884 <p>To put this in concrete terms,<wbr/> if the camera has lens elements which may move based on
6885 camera orientation or motion (e.<wbr/>g.<wbr/> due to gravity),<wbr/> then the HAL must drive the lens to
6886 remain in a fixed position invariant to the camera's orientation or motion,<wbr/> for example,<wbr/>
6887 by using accelerometer measurements in the lens control logic.<wbr/> This is a typical issue
6888 that will arise on camera modules with open-loop VCMs.<wbr/></p>
6889             </td>
6890           </tr>
6891
6892           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6893            <!-- end of entry -->
6894
6895
6896           <tr class="entry" id="dynamic_android.control.afRegions">
6897             <td class="entry_name
6898              " rowspan="5">
6899               android.<wbr/>control.<wbr/>af<wbr/>Regions
6900             </td>
6901             <td class="entry_type">
6902                 <span class="entry_type_name">int32</span>
6903                 <span class="entry_type_container">x</span>
6904
6905                 <span class="entry_type_array">
6906                   5 x area_count
6907                 </span>
6908               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
6909
6910
6911
6912
6913
6914
6915             </td> <!-- entry_type -->
6916
6917             <td class="entry_description">
6918               <p>List of metering areas to use for auto-focus.<wbr/></p>
6919             </td>
6920
6921             <td class="entry_units">
6922               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
6923             </td>
6924
6925             <td class="entry_range">
6926               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
6927 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
6928             </td>
6929
6930             <td class="entry_tags">
6931               <ul class="entry_tags">
6932                   <li><a href="#tag_BC">BC</a></li>
6933               </ul>
6934             </td>
6935
6936           </tr>
6937           <tr class="entries_header">
6938             <th class="th_details" colspan="5">Details</th>
6939           </tr>
6940           <tr class="entry_cont">
6941             <td class="entry_details" colspan="5">
6942               <p>Not available if <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a> is 0.<wbr/>
6943 Otherwise will always be present.<wbr/></p>
6944 <p>The maximum number of focus areas supported by the device is determined by the value
6945 of <a href="#static_android.control.maxRegionsAf">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Af</a>.<wbr/></p>
6946 <p>The coordinate system is based on the active pixel array,<wbr/>
6947 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
6948 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
6949 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
6950 bottom-right pixel in the active pixel array.<wbr/></p>
6951 <p>The weight must be within <code>[0,<wbr/> 1000]</code>,<wbr/> and represents a weight
6952 for every pixel in the area.<wbr/> This means that a large metering area
6953 with the same weight as a smaller area will have more effect in
6954 the metering result.<wbr/> Metering areas can partially overlap and the
6955 camera device will add the weights in the overlap region.<wbr/></p>
6956 <p>The weights are relative to weights of other metering regions,<wbr/> so if only one region
6957 is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with 0 weight is
6958 ignored.<wbr/></p>
6959 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
6960 camera device.<wbr/></p>
6961 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
6962 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
6963 region and output only the intersection rectangle as the metering region in the result
6964 metadata.<wbr/> If the region is entirely outside the crop region,<wbr/> it will be ignored and
6965 not reported in the result metadata.<wbr/></p>
6966             </td>
6967           </tr>
6968
6969           <tr class="entries_header">
6970             <th class="th_details" colspan="5">HAL Implementation Details</th>
6971           </tr>
6972           <tr class="entry_cont">
6973             <td class="entry_details" colspan="5">
6974               <p>The HAL level representation of MeteringRectangle[] is a
6975 int[5 * area_<wbr/>count].<wbr/>
6976 Every five elements represent a metering region of
6977 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
6978 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
6979 exclusive on xmax and ymax.<wbr/></p>
6980             </td>
6981           </tr>
6982
6983           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
6984            <!-- end of entry -->
6985
6986
6987           <tr class="entry" id="dynamic_android.control.afTrigger">
6988             <td class="entry_name
6989              " rowspan="5">
6990               android.<wbr/>control.<wbr/>af<wbr/>Trigger
6991             </td>
6992             <td class="entry_type">
6993                 <span class="entry_type_name entry_type_name_enum">byte</span>
6994
6995               <span class="entry_type_visibility"> [public]</span>
6996
6997
6998               <span class="entry_type_hwlevel">[legacy] </span>
6999
7000
7001
7002                 <ul class="entry_type_enum">
7003                   <li>
7004                     <span class="entry_type_enum_name">IDLE</span>
7005                     <span class="entry_type_enum_notes"><p>The trigger is idle.<wbr/></p></span>
7006                   </li>
7007                   <li>
7008                     <span class="entry_type_enum_name">START</span>
7009                     <span class="entry_type_enum_notes"><p>Autofocus will trigger now.<wbr/></p></span>
7010                   </li>
7011                   <li>
7012                     <span class="entry_type_enum_name">CANCEL</span>
7013                     <span class="entry_type_enum_notes"><p>Autofocus will return to its initial
7014 state,<wbr/> and cancel any currently active trigger.<wbr/></p></span>
7015                   </li>
7016                 </ul>
7017
7018             </td> <!-- entry_type -->
7019
7020             <td class="entry_description">
7021               <p>Whether the camera device will trigger autofocus for this request.<wbr/></p>
7022             </td>
7023
7024             <td class="entry_units">
7025             </td>
7026
7027             <td class="entry_range">
7028             </td>
7029
7030             <td class="entry_tags">
7031               <ul class="entry_tags">
7032                   <li><a href="#tag_BC">BC</a></li>
7033               </ul>
7034             </td>
7035
7036           </tr>
7037           <tr class="entries_header">
7038             <th class="th_details" colspan="5">Details</th>
7039           </tr>
7040           <tr class="entry_cont">
7041             <td class="entry_details" colspan="5">
7042               <p>This entry is normally set to IDLE,<wbr/> or is not
7043 included at all in the request settings.<wbr/></p>
7044 <p>When included and set to START,<wbr/> the camera device will trigger the
7045 autofocus algorithm.<wbr/> If autofocus is disabled,<wbr/> this trigger has no effect.<wbr/></p>
7046 <p>When set to CANCEL,<wbr/> the camera device will cancel any active trigger,<wbr/>
7047 and return to its initial AF state.<wbr/></p>
7048 <p>Generally,<wbr/> applications should set this entry to START or CANCEL for only a
7049 single capture,<wbr/> and then return it to IDLE (or not set at all).<wbr/> Specifying
7050 START for multiple captures in a row means restarting the AF operation over
7051 and over again.<wbr/></p>
7052 <p>See <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a> for what the trigger means for each AF mode.<wbr/></p>
7053 <p>Using the autofocus trigger and the precapture trigger <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>
7054 simultaneously is allowed.<wbr/> However,<wbr/> since these triggers often require cooperation between
7055 the auto-focus and auto-exposure routines (for example,<wbr/> the may need to be enabled for a
7056 focus sweep),<wbr/> the camera device may delay acting on a later trigger until the previous
7057 trigger has been fully handled.<wbr/> This may lead to longer intervals between the trigger and
7058 changes to <a href="#dynamic_android.control.afState">android.<wbr/>control.<wbr/>af<wbr/>State</a>,<wbr/> for example.<wbr/></p>
7059             </td>
7060           </tr>
7061
7062           <tr class="entries_header">
7063             <th class="th_details" colspan="5">HAL Implementation Details</th>
7064           </tr>
7065           <tr class="entry_cont">
7066             <td class="entry_details" colspan="5">
7067               <p>The HAL must support triggering the AF trigger while an AE precapture trigger is active
7068 (and vice versa),<wbr/> or at the same time as the AE trigger.<wbr/>  It is acceptable for the HAL to
7069 treat these as two consecutive triggers,<wbr/> for example handling the AF trigger and then the
7070 AE trigger.<wbr/>  Or the HAL may choose to optimize the case with both triggers fired at once,<wbr/>
7071 to minimize the latency for converging both focus and exposure/<wbr/>flash usage.<wbr/></p>
7072             </td>
7073           </tr>
7074
7075           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7076            <!-- end of entry -->
7077
7078
7079           <tr class="entry" id="dynamic_android.control.afState">
7080             <td class="entry_name
7081              " rowspan="3">
7082               android.<wbr/>control.<wbr/>af<wbr/>State
7083             </td>
7084             <td class="entry_type">
7085                 <span class="entry_type_name entry_type_name_enum">byte</span>
7086
7087               <span class="entry_type_visibility"> [public]</span>
7088
7089
7090               <span class="entry_type_hwlevel">[legacy] </span>
7091
7092
7093
7094                 <ul class="entry_type_enum">
7095                   <li>
7096                     <span class="entry_type_enum_name">INACTIVE</span>
7097                     <span class="entry_type_enum_notes"><p>AF is off or has not yet tried to scan/<wbr/>been asked
7098 to scan.<wbr/></p>
7099 <p>When a camera device is opened,<wbr/> it starts in this
7100 state.<wbr/> This is a transient state,<wbr/> the camera device may
7101 skip reporting this state in capture
7102 result.<wbr/></p></span>
7103                   </li>
7104                   <li>
7105                     <span class="entry_type_enum_name">PASSIVE_SCAN</span>
7106                     <span class="entry_type_enum_notes"><p>AF is currently performing an AF scan initiated the
7107 camera device in a continuous autofocus mode.<wbr/></p>
7108 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
7109 state,<wbr/> the camera device may skip reporting this state in
7110 capture result.<wbr/></p></span>
7111                   </li>
7112                   <li>
7113                     <span class="entry_type_enum_name">PASSIVE_FOCUSED</span>
7114                     <span class="entry_type_enum_notes"><p>AF currently believes it is in focus,<wbr/> but may
7115 restart scanning at any time.<wbr/></p>
7116 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient
7117 state,<wbr/> the camera device may skip reporting this state in
7118 capture result.<wbr/></p></span>
7119                   </li>
7120                   <li>
7121                     <span class="entry_type_enum_name">ACTIVE_SCAN</span>
7122                     <span class="entry_type_enum_notes"><p>AF is performing an AF scan because it was
7123 triggered by AF trigger.<wbr/></p>
7124 <p>Only used by AUTO or MACRO AF modes.<wbr/> This is a transient
7125 state,<wbr/> the camera device may skip reporting this state in
7126 capture result.<wbr/></p></span>
7127                   </li>
7128                   <li>
7129                     <span class="entry_type_enum_name">FOCUSED_LOCKED</span>
7130                     <span class="entry_type_enum_notes"><p>AF believes it is focused correctly and has locked
7131 focus.<wbr/></p>
7132 <p>This state is reached only after an explicit START AF trigger has been
7133 sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus has been obtained.<wbr/></p>
7134 <p>The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) is changed or
7135 a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>).<wbr/></p></span>
7136                   </li>
7137                   <li>
7138                     <span class="entry_type_enum_name">NOT_FOCUSED_LOCKED</span>
7139                     <span class="entry_type_enum_notes"><p>AF has failed to focus successfully and has locked
7140 focus.<wbr/></p>
7141 <p>This state is reached only after an explicit START AF trigger has been
7142 sent (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>),<wbr/> when good focus cannot be obtained.<wbr/></p>
7143 <p>The lens will remain stationary until the AF mode (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) is changed or
7144 a new AF trigger is sent to the camera device (<a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a>).<wbr/></p></span>
7145                   </li>
7146                   <li>
7147                     <span class="entry_type_enum_name">PASSIVE_UNFOCUSED</span>
7148                     <span class="entry_type_enum_notes"><p>AF finished a passive scan without finding focus,<wbr/>
7149 and may restart scanning at any time.<wbr/></p>
7150 <p>Only used by CONTINUOUS_<wbr/>* AF modes.<wbr/> This is a transient state,<wbr/> the camera
7151 device may skip reporting this state in capture result.<wbr/></p>
7152 <p>LEGACY camera devices do not support this state.<wbr/> When a passive
7153 scan has finished,<wbr/> it will always go to PASSIVE_<wbr/>FOCUSED.<wbr/></p></span>
7154                   </li>
7155                 </ul>
7156
7157             </td> <!-- entry_type -->
7158
7159             <td class="entry_description">
7160               <p>Current state of auto-focus (AF) algorithm.<wbr/></p>
7161             </td>
7162
7163             <td class="entry_units">
7164             </td>
7165
7166             <td class="entry_range">
7167             </td>
7168
7169             <td class="entry_tags">
7170             </td>
7171
7172           </tr>
7173           <tr class="entries_header">
7174             <th class="th_details" colspan="5">Details</th>
7175           </tr>
7176           <tr class="entry_cont">
7177             <td class="entry_details" colspan="5">
7178               <p>Switching between or enabling AF modes (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>) always
7179 resets the AF state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
7180 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
7181 the algorithm states to INACTIVE.<wbr/></p>
7182 <p>The camera device can do several state transitions between two results,<wbr/> if it is
7183 allowed by the state transition table.<wbr/> For example: INACTIVE may never actually be
7184 seen in a result.<wbr/></p>
7185 <p>The state in the result is the state for this image (in sync with this image): if
7186 AF state becomes FOCUSED,<wbr/> then the image data associated with this result should
7187 be sharp.<wbr/></p>
7188 <p>Below are state transition tables for different AF modes.<wbr/></p>
7189 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>OFF or AF_<wbr/>MODE_<wbr/>EDOF:</p>
7190 <table>
7191 <thead>
7192 <tr>
7193 <th align="center">State</th>
7194 <th align="center">Transition Cause</th>
7195 <th align="center">New State</th>
7196 <th align="center">Notes</th>
7197 </tr>
7198 </thead>
7199 <tbody>
7200 <tr>
7201 <td align="center">INACTIVE</td>
7202 <td align="center"></td>
7203 <td align="center">INACTIVE</td>
7204 <td align="center">Never changes</td>
7205 </tr>
7206 </tbody>
7207 </table>
7208 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>AUTO or AF_<wbr/>MODE_<wbr/>MACRO:</p>
7209 <table>
7210 <thead>
7211 <tr>
7212 <th align="center">State</th>
7213 <th align="center">Transition Cause</th>
7214 <th align="center">New State</th>
7215 <th align="center">Notes</th>
7216 </tr>
7217 </thead>
7218 <tbody>
7219 <tr>
7220 <td align="center">INACTIVE</td>
7221 <td align="center">AF_<wbr/>TRIGGER</td>
7222 <td align="center">ACTIVE_<wbr/>SCAN</td>
7223 <td align="center">Start AF sweep,<wbr/> Lens now moving</td>
7224 </tr>
7225 <tr>
7226 <td align="center">ACTIVE_<wbr/>SCAN</td>
7227 <td align="center">AF sweep done</td>
7228 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7229 <td align="center">Focused,<wbr/> Lens now locked</td>
7230 </tr>
7231 <tr>
7232 <td align="center">ACTIVE_<wbr/>SCAN</td>
7233 <td align="center">AF sweep done</td>
7234 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7235 <td align="center">Not focused,<wbr/> Lens now locked</td>
7236 </tr>
7237 <tr>
7238 <td align="center">ACTIVE_<wbr/>SCAN</td>
7239 <td align="center">AF_<wbr/>CANCEL</td>
7240 <td align="center">INACTIVE</td>
7241 <td align="center">Cancel/<wbr/>reset AF,<wbr/> Lens now locked</td>
7242 </tr>
7243 <tr>
7244 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7245 <td align="center">AF_<wbr/>CANCEL</td>
7246 <td align="center">INACTIVE</td>
7247 <td align="center">Cancel/<wbr/>reset AF</td>
7248 </tr>
7249 <tr>
7250 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7251 <td align="center">AF_<wbr/>TRIGGER</td>
7252 <td align="center">ACTIVE_<wbr/>SCAN</td>
7253 <td align="center">Start new sweep,<wbr/> Lens now moving</td>
7254 </tr>
7255 <tr>
7256 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7257 <td align="center">AF_<wbr/>CANCEL</td>
7258 <td align="center">INACTIVE</td>
7259 <td align="center">Cancel/<wbr/>reset AF</td>
7260 </tr>
7261 <tr>
7262 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7263 <td align="center">AF_<wbr/>TRIGGER</td>
7264 <td align="center">ACTIVE_<wbr/>SCAN</td>
7265 <td align="center">Start new sweep,<wbr/> Lens now moving</td>
7266 </tr>
7267 <tr>
7268 <td align="center">Any state</td>
7269 <td align="center">Mode change</td>
7270 <td align="center">INACTIVE</td>
7271 <td align="center"></td>
7272 </tr>
7273 </tbody>
7274 </table>
7275 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
7276 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
7277 can be skipped in that manner is called a transient state.<wbr/></p>
7278 <p>For example,<wbr/> for these AF modes (AF_<wbr/>MODE_<wbr/>AUTO and AF_<wbr/>MODE_<wbr/>MACRO),<wbr/> in addition to the
7279 state transitions listed in above table,<wbr/> it is also legal for the camera device to skip
7280 one or more transient states between two results.<wbr/> See below table for examples:</p>
7281 <table>
7282 <thead>
7283 <tr>
7284 <th align="center">State</th>
7285 <th align="center">Transition Cause</th>
7286 <th align="center">New State</th>
7287 <th align="center">Notes</th>
7288 </tr>
7289 </thead>
7290 <tbody>
7291 <tr>
7292 <td align="center">INACTIVE</td>
7293 <td align="center">AF_<wbr/>TRIGGER</td>
7294 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7295 <td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
7296 </tr>
7297 <tr>
7298 <td align="center">INACTIVE</td>
7299 <td align="center">AF_<wbr/>TRIGGER</td>
7300 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7301 <td align="center">Focus failed after a scan,<wbr/> lens is now locked.<wbr/></td>
7302 </tr>
7303 <tr>
7304 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7305 <td align="center">AF_<wbr/>TRIGGER</td>
7306 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7307 <td align="center">Focus is already good or good after a scan,<wbr/> lens is now locked.<wbr/></td>
7308 </tr>
7309 <tr>
7310 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7311 <td align="center">AF_<wbr/>TRIGGER</td>
7312 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7313 <td align="center">Focus is good after a scan,<wbr/> lens is not locked.<wbr/></td>
7314 </tr>
7315 </tbody>
7316 </table>
7317 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>VIDEO:</p>
7318 <table>
7319 <thead>
7320 <tr>
7321 <th align="center">State</th>
7322 <th align="center">Transition Cause</th>
7323 <th align="center">New State</th>
7324 <th align="center">Notes</th>
7325 </tr>
7326 </thead>
7327 <tbody>
7328 <tr>
7329 <td align="center">INACTIVE</td>
7330 <td align="center">Camera device initiates new scan</td>
7331 <td align="center">PASSIVE_<wbr/>SCAN</td>
7332 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7333 </tr>
7334 <tr>
7335 <td align="center">INACTIVE</td>
7336 <td align="center">AF_<wbr/>TRIGGER</td>
7337 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7338 <td align="center">AF state query,<wbr/> Lens now locked</td>
7339 </tr>
7340 <tr>
7341 <td align="center">PASSIVE_<wbr/>SCAN</td>
7342 <td align="center">Camera device completes current scan</td>
7343 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7344 <td align="center">End AF scan,<wbr/> Lens now locked</td>
7345 </tr>
7346 <tr>
7347 <td align="center">PASSIVE_<wbr/>SCAN</td>
7348 <td align="center">Camera device fails current scan</td>
7349 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7350 <td align="center">End AF scan,<wbr/> Lens now locked</td>
7351 </tr>
7352 <tr>
7353 <td align="center">PASSIVE_<wbr/>SCAN</td>
7354 <td align="center">AF_<wbr/>TRIGGER</td>
7355 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7356 <td align="center">Immediate transition,<wbr/> if focus is good.<wbr/> Lens now locked</td>
7357 </tr>
7358 <tr>
7359 <td align="center">PASSIVE_<wbr/>SCAN</td>
7360 <td align="center">AF_<wbr/>TRIGGER</td>
7361 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7362 <td align="center">Immediate transition,<wbr/> if focus is bad.<wbr/> Lens now locked</td>
7363 </tr>
7364 <tr>
7365 <td align="center">PASSIVE_<wbr/>SCAN</td>
7366 <td align="center">AF_<wbr/>CANCEL</td>
7367 <td align="center">INACTIVE</td>
7368 <td align="center">Reset lens position,<wbr/> Lens now locked</td>
7369 </tr>
7370 <tr>
7371 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7372 <td align="center">Camera device initiates new scan</td>
7373 <td align="center">PASSIVE_<wbr/>SCAN</td>
7374 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7375 </tr>
7376 <tr>
7377 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7378 <td align="center">Camera device initiates new scan</td>
7379 <td align="center">PASSIVE_<wbr/>SCAN</td>
7380 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7381 </tr>
7382 <tr>
7383 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7384 <td align="center">AF_<wbr/>TRIGGER</td>
7385 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7386 <td align="center">Immediate transition,<wbr/> lens now locked</td>
7387 </tr>
7388 <tr>
7389 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7390 <td align="center">AF_<wbr/>TRIGGER</td>
7391 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7392 <td align="center">Immediate transition,<wbr/> lens now locked</td>
7393 </tr>
7394 <tr>
7395 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7396 <td align="center">AF_<wbr/>TRIGGER</td>
7397 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7398 <td align="center">No effect</td>
7399 </tr>
7400 <tr>
7401 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7402 <td align="center">AF_<wbr/>CANCEL</td>
7403 <td align="center">INACTIVE</td>
7404 <td align="center">Restart AF scan</td>
7405 </tr>
7406 <tr>
7407 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7408 <td align="center">AF_<wbr/>TRIGGER</td>
7409 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7410 <td align="center">No effect</td>
7411 </tr>
7412 <tr>
7413 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7414 <td align="center">AF_<wbr/>CANCEL</td>
7415 <td align="center">INACTIVE</td>
7416 <td align="center">Restart AF scan</td>
7417 </tr>
7418 </tbody>
7419 </table>
7420 <p>When <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> is AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>PICTURE:</p>
7421 <table>
7422 <thead>
7423 <tr>
7424 <th align="center">State</th>
7425 <th align="center">Transition Cause</th>
7426 <th align="center">New State</th>
7427 <th align="center">Notes</th>
7428 </tr>
7429 </thead>
7430 <tbody>
7431 <tr>
7432 <td align="center">INACTIVE</td>
7433 <td align="center">Camera device initiates new scan</td>
7434 <td align="center">PASSIVE_<wbr/>SCAN</td>
7435 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7436 </tr>
7437 <tr>
7438 <td align="center">INACTIVE</td>
7439 <td align="center">AF_<wbr/>TRIGGER</td>
7440 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7441 <td align="center">AF state query,<wbr/> Lens now locked</td>
7442 </tr>
7443 <tr>
7444 <td align="center">PASSIVE_<wbr/>SCAN</td>
7445 <td align="center">Camera device completes current scan</td>
7446 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7447 <td align="center">End AF scan,<wbr/> Lens now locked</td>
7448 </tr>
7449 <tr>
7450 <td align="center">PASSIVE_<wbr/>SCAN</td>
7451 <td align="center">Camera device fails current scan</td>
7452 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7453 <td align="center">End AF scan,<wbr/> Lens now locked</td>
7454 </tr>
7455 <tr>
7456 <td align="center">PASSIVE_<wbr/>SCAN</td>
7457 <td align="center">AF_<wbr/>TRIGGER</td>
7458 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7459 <td align="center">Eventual transition once the focus is good.<wbr/> Lens now locked</td>
7460 </tr>
7461 <tr>
7462 <td align="center">PASSIVE_<wbr/>SCAN</td>
7463 <td align="center">AF_<wbr/>TRIGGER</td>
7464 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7465 <td align="center">Eventual transition if cannot find focus.<wbr/> Lens now locked</td>
7466 </tr>
7467 <tr>
7468 <td align="center">PASSIVE_<wbr/>SCAN</td>
7469 <td align="center">AF_<wbr/>CANCEL</td>
7470 <td align="center">INACTIVE</td>
7471 <td align="center">Reset lens position,<wbr/> Lens now locked</td>
7472 </tr>
7473 <tr>
7474 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7475 <td align="center">Camera device initiates new scan</td>
7476 <td align="center">PASSIVE_<wbr/>SCAN</td>
7477 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7478 </tr>
7479 <tr>
7480 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7481 <td align="center">Camera device initiates new scan</td>
7482 <td align="center">PASSIVE_<wbr/>SCAN</td>
7483 <td align="center">Start AF scan,<wbr/> Lens now moving</td>
7484 </tr>
7485 <tr>
7486 <td align="center">PASSIVE_<wbr/>FOCUSED</td>
7487 <td align="center">AF_<wbr/>TRIGGER</td>
7488 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7489 <td align="center">Immediate trans.<wbr/> Lens now locked</td>
7490 </tr>
7491 <tr>
7492 <td align="center">PASSIVE_<wbr/>UNFOCUSED</td>
7493 <td align="center">AF_<wbr/>TRIGGER</td>
7494 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7495 <td align="center">Immediate trans.<wbr/> Lens now locked</td>
7496 </tr>
7497 <tr>
7498 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7499 <td align="center">AF_<wbr/>TRIGGER</td>
7500 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7501 <td align="center">No effect</td>
7502 </tr>
7503 <tr>
7504 <td align="center">FOCUSED_<wbr/>LOCKED</td>
7505 <td align="center">AF_<wbr/>CANCEL</td>
7506 <td align="center">INACTIVE</td>
7507 <td align="center">Restart AF scan</td>
7508 </tr>
7509 <tr>
7510 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7511 <td align="center">AF_<wbr/>TRIGGER</td>
7512 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7513 <td align="center">No effect</td>
7514 </tr>
7515 <tr>
7516 <td align="center">NOT_<wbr/>FOCUSED_<wbr/>LOCKED</td>
7517 <td align="center">AF_<wbr/>CANCEL</td>
7518 <td align="center">INACTIVE</td>
7519 <td align="center">Restart AF scan</td>
7520 </tr>
7521 </tbody>
7522 </table>
7523 <p>When switch between AF_<wbr/>MODE_<wbr/>CONTINUOUS_<wbr/>* (CAF modes) and AF_<wbr/>MODE_<wbr/>AUTO/<wbr/>AF_<wbr/>MODE_<wbr/>MACRO
7524 (AUTO modes),<wbr/> the initial INACTIVE or PASSIVE_<wbr/>SCAN states may be skipped by the
7525 camera device.<wbr/> When a trigger is included in a mode switch request,<wbr/> the trigger
7526 will be evaluated in the context of the new mode in the request.<wbr/>
7527 See below table for examples:</p>
7528 <table>
7529 <thead>
7530 <tr>
7531 <th align="center">State</th>
7532 <th align="center">Transition Cause</th>
7533 <th align="center">New State</th>
7534 <th align="center">Notes</th>
7535 </tr>
7536 </thead>
7537 <tbody>
7538 <tr>
7539 <td align="center">any state</td>
7540 <td align="center">CAF--&gt;AUTO mode switch</td>
7541 <td align="center">INACTIVE</td>
7542 <td align="center">Mode switch without trigger,<wbr/> initial state must be INACTIVE</td>
7543 </tr>
7544 <tr>
7545 <td align="center">any state</td>
7546 <td align="center">CAF--&gt;AUTO mode switch with AF_<wbr/>TRIGGER</td>
7547 <td align="center">trigger-reachable states from INACTIVE</td>
7548 <td align="center">Mode switch with trigger,<wbr/> INACTIVE is skipped</td>
7549 </tr>
7550 <tr>
7551 <td align="center">any state</td>
7552 <td align="center">AUTO--&gt;CAF mode switch</td>
7553 <td align="center">passively reachable states from INACTIVE</td>
7554 <td align="center">Mode switch without trigger,<wbr/> passive transient state is skipped</td>
7555 </tr>
7556 </tbody>
7557 </table>
7558             </td>
7559           </tr>
7560
7561
7562           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7563            <!-- end of entry -->
7564
7565
7566           <tr class="entry" id="dynamic_android.control.afTriggerId">
7567             <td class="entry_name
7568                 entry_name_deprecated
7569              " rowspan="3">
7570               android.<wbr/>control.<wbr/>af<wbr/>Trigger<wbr/>Id
7571             </td>
7572             <td class="entry_type">
7573                 <span class="entry_type_name">int32</span>
7574
7575               <span class="entry_type_visibility"> [system]</span>
7576
7577
7578
7579               <span class="entry_type_deprecated">[deprecated] </span>
7580
7581
7582
7583             </td> <!-- entry_type -->
7584
7585             <td class="entry_description">
7586               <p>The ID sent with the latest
7587 CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS call</p>
7588             </td>
7589
7590             <td class="entry_units">
7591             </td>
7592
7593             <td class="entry_range">
7594               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
7595             </td>
7596
7597             <td class="entry_tags">
7598             </td>
7599
7600           </tr>
7601           <tr class="entries_header">
7602             <th class="th_details" colspan="5">Details</th>
7603           </tr>
7604           <tr class="entry_cont">
7605             <td class="entry_details" colspan="5">
7606               <p>Must be 0 if no CAMERA2_<wbr/>TRIGGER_<wbr/>AUTOFOCUS trigger
7607 received yet by HAL.<wbr/> Always updated even if AF algorithm
7608 ignores the trigger</p>
7609             </td>
7610           </tr>
7611
7612
7613           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7614            <!-- end of entry -->
7615
7616
7617           <tr class="entry" id="dynamic_android.control.awbLock">
7618             <td class="entry_name
7619              " rowspan="3">
7620               android.<wbr/>control.<wbr/>awb<wbr/>Lock
7621             </td>
7622             <td class="entry_type">
7623                 <span class="entry_type_name entry_type_name_enum">byte</span>
7624
7625               <span class="entry_type_visibility"> [public as boolean]</span>
7626
7627
7628               <span class="entry_type_hwlevel">[legacy] </span>
7629
7630
7631
7632                 <ul class="entry_type_enum">
7633                   <li>
7634                     <span class="entry_type_enum_name">OFF</span>
7635                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is disabled; the AWB
7636 algorithm is free to update its parameters if in AUTO
7637 mode.<wbr/></p></span>
7638                   </li>
7639                   <li>
7640                     <span class="entry_type_enum_name">ON</span>
7641                     <span class="entry_type_enum_notes"><p>Auto-white balance lock is enabled; the AWB
7642 algorithm will not update its parameters while the lock
7643 is active.<wbr/></p></span>
7644                   </li>
7645                 </ul>
7646
7647             </td> <!-- entry_type -->
7648
7649             <td class="entry_description">
7650               <p>Whether auto-white balance (AWB) is currently locked to its
7651 latest calculated values.<wbr/></p>
7652             </td>
7653
7654             <td class="entry_units">
7655             </td>
7656
7657             <td class="entry_range">
7658             </td>
7659
7660             <td class="entry_tags">
7661               <ul class="entry_tags">
7662                   <li><a href="#tag_BC">BC</a></li>
7663               </ul>
7664             </td>
7665
7666           </tr>
7667           <tr class="entries_header">
7668             <th class="th_details" colspan="5">Details</th>
7669           </tr>
7670           <tr class="entry_cont">
7671             <td class="entry_details" colspan="5">
7672               <p>When set to <code>true</code> (ON),<wbr/> the AWB algorithm is locked to its latest parameters,<wbr/>
7673 and will not change color balance settings until the lock is set to <code>false</code> (OFF).<wbr/></p>
7674 <p>Since the camera device has a pipeline of in-flight requests,<wbr/> the settings that
7675 get locked do not necessarily correspond to the settings that were present in the
7676 latest capture result received from the camera device,<wbr/> since additional captures
7677 and AWB updates may have occurred even before the result was sent out.<wbr/> If an
7678 application is switching between automatic and manual control and wishes to eliminate
7679 any flicker during the switch,<wbr/> the following procedure is recommended:</p>
7680 <ol>
7681 <li>Starting in auto-AWB mode:</li>
7682 <li>Lock AWB</li>
7683 <li>Wait for the first result to be output that has the AWB locked</li>
7684 <li>Copy AWB settings from that result into a request,<wbr/> set the request to manual AWB</li>
7685 <li>Submit the capture request,<wbr/> proceed to run manual AWB as desired.<wbr/></li>
7686 </ol>
7687 <p>Note that AWB lock is only meaningful when
7688 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is in the AUTO mode; in other modes,<wbr/>
7689 AWB is already fixed to a specific setting.<wbr/></p>
7690 <p>Some LEGACY devices may not support ON; the value is then overridden to OFF.<wbr/></p>
7691             </td>
7692           </tr>
7693
7694
7695           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7696            <!-- end of entry -->
7697
7698
7699           <tr class="entry" id="dynamic_android.control.awbMode">
7700             <td class="entry_name
7701              " rowspan="3">
7702               android.<wbr/>control.<wbr/>awb<wbr/>Mode
7703             </td>
7704             <td class="entry_type">
7705                 <span class="entry_type_name entry_type_name_enum">byte</span>
7706
7707               <span class="entry_type_visibility"> [public]</span>
7708
7709
7710               <span class="entry_type_hwlevel">[legacy] </span>
7711
7712
7713
7714                 <ul class="entry_type_enum">
7715                   <li>
7716                     <span class="entry_type_enum_name">OFF</span>
7717                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled.<wbr/></p>
7718 <p>The application-selected color transform matrix
7719 (<a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>) and gains
7720 (<a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>) are used by the camera
7721 device for manual white balance control.<wbr/></p></span>
7722                   </li>
7723                   <li>
7724                     <span class="entry_type_enum_name">AUTO</span>
7725                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is active.<wbr/></p>
7726 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7727 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7728 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7729 values used by the camera device for the transform and gains
7730 will be available in the capture result for this request.<wbr/></p></span>
7731                   </li>
7732                   <li>
7733                     <span class="entry_type_enum_name">INCANDESCENT</span>
7734                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7735 the camera device uses incandescent light as the assumed scene
7736 illumination for white balance.<wbr/></p>
7737 <p>While the exact white balance transforms are up to the
7738 camera device,<wbr/> they will approximately match the CIE
7739 standard illuminant A.<wbr/></p>
7740 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7741 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7742 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7743 values used by the camera device for the transform and gains
7744 will be available in the capture result for this request.<wbr/></p></span>
7745                   </li>
7746                   <li>
7747                     <span class="entry_type_enum_name">FLUORESCENT</span>
7748                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7749 the camera device uses fluorescent light as the assumed scene
7750 illumination for white balance.<wbr/></p>
7751 <p>While the exact white balance transforms are up to the
7752 camera device,<wbr/> they will approximately match the CIE
7753 standard illuminant F2.<wbr/></p>
7754 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7755 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7756 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7757 values used by the camera device for the transform and gains
7758 will be available in the capture result for this request.<wbr/></p></span>
7759                   </li>
7760                   <li>
7761                     <span class="entry_type_enum_name">WARM_FLUORESCENT</span>
7762                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7763 the camera device uses warm fluorescent light as the assumed scene
7764 illumination for white balance.<wbr/></p>
7765 <p>While the exact white balance transforms are up to the
7766 camera device,<wbr/> they will approximately match the CIE
7767 standard illuminant F4.<wbr/></p>
7768 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7769 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7770 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7771 values used by the camera device for the transform and gains
7772 will be available in the capture result for this request.<wbr/></p></span>
7773                   </li>
7774                   <li>
7775                     <span class="entry_type_enum_name">DAYLIGHT</span>
7776                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7777 the camera device uses daylight light as the assumed scene
7778 illumination for white balance.<wbr/></p>
7779 <p>While the exact white balance transforms are up to the
7780 camera device,<wbr/> they will approximately match the CIE
7781 standard illuminant D65.<wbr/></p>
7782 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7783 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7784 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7785 values used by the camera device for the transform and gains
7786 will be available in the capture result for this request.<wbr/></p></span>
7787                   </li>
7788                   <li>
7789                     <span class="entry_type_enum_name">CLOUDY_DAYLIGHT</span>
7790                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7791 the camera device uses cloudy daylight light as the assumed scene
7792 illumination for white balance.<wbr/></p>
7793 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7794 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7795 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7796 values used by the camera device for the transform and gains
7797 will be available in the capture result for this request.<wbr/></p></span>
7798                   </li>
7799                   <li>
7800                     <span class="entry_type_enum_name">TWILIGHT</span>
7801                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7802 the camera device uses twilight light as the assumed scene
7803 illumination for white balance.<wbr/></p>
7804 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7805 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7806 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7807 values used by the camera device for the transform and gains
7808 will be available in the capture result for this request.<wbr/></p></span>
7809                   </li>
7810                   <li>
7811                     <span class="entry_type_enum_name">SHADE</span>
7812                     <span class="entry_type_enum_notes"><p>The camera device's auto-white balance routine is disabled;
7813 the camera device uses shade light as the assumed scene
7814 illumination for white balance.<wbr/></p>
7815 <p>The application's values for <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>
7816 and <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> are ignored.<wbr/>
7817 For devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability,<wbr/> the
7818 values used by the camera device for the transform and gains
7819 will be available in the capture result for this request.<wbr/></p></span>
7820                   </li>
7821                 </ul>
7822
7823             </td> <!-- entry_type -->
7824
7825             <td class="entry_description">
7826               <p>Whether auto-white balance (AWB) is currently setting the color
7827 transform fields,<wbr/> and what its illumination target
7828 is.<wbr/></p>
7829             </td>
7830
7831             <td class="entry_units">
7832             </td>
7833
7834             <td class="entry_range">
7835               <p><a href="#static_android.control.awbAvailableModes">android.<wbr/>control.<wbr/>awb<wbr/>Available<wbr/>Modes</a></p>
7836             </td>
7837
7838             <td class="entry_tags">
7839               <ul class="entry_tags">
7840                   <li><a href="#tag_BC">BC</a></li>
7841               </ul>
7842             </td>
7843
7844           </tr>
7845           <tr class="entries_header">
7846             <th class="th_details" colspan="5">Details</th>
7847           </tr>
7848           <tr class="entry_cont">
7849             <td class="entry_details" colspan="5">
7850               <p>This control is only effective if <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is AUTO.<wbr/></p>
7851 <p>When set to the ON mode,<wbr/> the camera device's auto-white balance
7852 routine is enabled,<wbr/> overriding the application's selected
7853 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
7854 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/> Note that when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>
7855 is OFF,<wbr/> the behavior of AWB is device dependent.<wbr/> It is recommened to
7856 also set AWB mode to OFF or lock AWB by using <a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> before
7857 setting AE mode to OFF.<wbr/></p>
7858 <p>When set to the OFF mode,<wbr/> the camera device's auto-white balance
7859 routine is disabled.<wbr/> The application manually controls the white
7860 balance by <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/> <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a>
7861 and <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a>.<wbr/></p>
7862 <p>When set to any other modes,<wbr/> the camera device's auto-white
7863 balance routine is disabled.<wbr/> The camera device uses each
7864 particular illumination target for white balance
7865 adjustment.<wbr/> The application's values for
7866 <a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a>,<wbr/>
7867 <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> and
7868 <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> are ignored.<wbr/></p>
7869             </td>
7870           </tr>
7871
7872
7873           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7874            <!-- end of entry -->
7875
7876
7877           <tr class="entry" id="dynamic_android.control.awbRegions">
7878             <td class="entry_name
7879              " rowspan="5">
7880               android.<wbr/>control.<wbr/>awb<wbr/>Regions
7881             </td>
7882             <td class="entry_type">
7883                 <span class="entry_type_name">int32</span>
7884                 <span class="entry_type_container">x</span>
7885
7886                 <span class="entry_type_array">
7887                   5 x area_count
7888                 </span>
7889               <span class="entry_type_visibility"> [public as meteringRectangle]</span>
7890
7891
7892
7893
7894
7895
7896             </td> <!-- entry_type -->
7897
7898             <td class="entry_description">
7899               <p>List of metering areas to use for auto-white-balance illuminant
7900 estimation.<wbr/></p>
7901             </td>
7902
7903             <td class="entry_units">
7904               Pixel coordinates within android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
7905             </td>
7906
7907             <td class="entry_range">
7908               <p>Coordinates must be between <code>[(0,<wbr/>0),<wbr/> (width,<wbr/> height))</code> of
7909 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></p>
7910             </td>
7911
7912             <td class="entry_tags">
7913               <ul class="entry_tags">
7914                   <li><a href="#tag_BC">BC</a></li>
7915               </ul>
7916             </td>
7917
7918           </tr>
7919           <tr class="entries_header">
7920             <th class="th_details" colspan="5">Details</th>
7921           </tr>
7922           <tr class="entry_cont">
7923             <td class="entry_details" colspan="5">
7924               <p>Not available if <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a> is 0.<wbr/>
7925 Otherwise will always be present.<wbr/></p>
7926 <p>The maximum number of regions supported by the device is determined by the value
7927 of <a href="#static_android.control.maxRegionsAwb">android.<wbr/>control.<wbr/>max<wbr/>Regions<wbr/>Awb</a>.<wbr/></p>
7928 <p>The coordinate system is based on the active pixel array,<wbr/>
7929 with (0,<wbr/>0) being the top-left pixel in the active pixel array,<wbr/> and
7930 (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>width - 1,<wbr/>
7931 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>height - 1) being the
7932 bottom-right pixel in the active pixel array.<wbr/></p>
7933 <p>The weight must range from 0 to 1000,<wbr/> and represents a weight
7934 for every pixel in the area.<wbr/> This means that a large metering area
7935 with the same weight as a smaller area will have more effect in
7936 the metering result.<wbr/> Metering areas can partially overlap and the
7937 camera device will add the weights in the overlap region.<wbr/></p>
7938 <p>The weights are relative to weights of other white balance metering regions,<wbr/> so if
7939 only one region is used,<wbr/> all non-zero weights will have the same effect.<wbr/> A region with
7940 0 weight is ignored.<wbr/></p>
7941 <p>If all regions have 0 weight,<wbr/> then no specific metering area needs to be used by the
7942 camera device.<wbr/></p>
7943 <p>If the metering region is outside the used <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> returned in
7944 capture result metadata,<wbr/> the camera device will ignore the sections outside the crop
7945 region and output only the intersection rectangle as the metering region in the result
7946 metadata.<wbr/>  If the region is entirely outside the crop region,<wbr/> it will be ignored and
7947 not reported in the result metadata.<wbr/></p>
7948             </td>
7949           </tr>
7950
7951           <tr class="entries_header">
7952             <th class="th_details" colspan="5">HAL Implementation Details</th>
7953           </tr>
7954           <tr class="entry_cont">
7955             <td class="entry_details" colspan="5">
7956               <p>The HAL level representation of MeteringRectangle[] is a
7957 int[5 * area_<wbr/>count].<wbr/>
7958 Every five elements represent a metering region of
7959 (xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax,<wbr/> weight).<wbr/>
7960 The rectangle is defined to be inclusive on xmin and ymin,<wbr/> but
7961 exclusive on xmax and ymax.<wbr/></p>
7962             </td>
7963           </tr>
7964
7965           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
7966            <!-- end of entry -->
7967
7968
7969           <tr class="entry" id="dynamic_android.control.captureIntent">
7970             <td class="entry_name
7971              " rowspan="3">
7972               android.<wbr/>control.<wbr/>capture<wbr/>Intent
7973             </td>
7974             <td class="entry_type">
7975                 <span class="entry_type_name entry_type_name_enum">byte</span>
7976
7977               <span class="entry_type_visibility"> [public]</span>
7978
7979
7980               <span class="entry_type_hwlevel">[legacy] </span>
7981
7982
7983
7984                 <ul class="entry_type_enum">
7985                   <li>
7986                     <span class="entry_type_enum_name">CUSTOM</span>
7987                     <span class="entry_type_enum_notes"><p>The goal of this request doesn't fall into the other
7988 categories.<wbr/> The camera device will default to preview-like
7989 behavior.<wbr/></p></span>
7990                   </li>
7991                   <li>
7992                     <span class="entry_type_enum_name">PREVIEW</span>
7993                     <span class="entry_type_enum_notes"><p>This request is for a preview-like use case.<wbr/></p>
7994 <p>The precapture trigger may be used to start off a metering
7995 w/<wbr/>flash sequence.<wbr/></p></span>
7996                   </li>
7997                   <li>
7998                     <span class="entry_type_enum_name">STILL_CAPTURE</span>
7999                     <span class="entry_type_enum_notes"><p>This request is for a still capture-type
8000 use case.<wbr/></p>
8001 <p>If the flash unit is under automatic control,<wbr/> it may fire as needed.<wbr/></p></span>
8002                   </li>
8003                   <li>
8004                     <span class="entry_type_enum_name">VIDEO_RECORD</span>
8005                     <span class="entry_type_enum_notes"><p>This request is for a video recording
8006 use case.<wbr/></p></span>
8007                   </li>
8008                   <li>
8009                     <span class="entry_type_enum_name">VIDEO_SNAPSHOT</span>
8010                     <span class="entry_type_enum_notes"><p>This request is for a video snapshot (still
8011 image while recording video) use case.<wbr/></p>
8012 <p>The camera device should take the highest-quality image
8013 possible (given the other settings) without disrupting the
8014 frame rate of video recording.<wbr/>  </p></span>
8015                   </li>
8016                   <li>
8017                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
8018                     <span class="entry_type_enum_notes"><p>This request is for a ZSL usecase; the
8019 application will stream full-resolution images and
8020 reprocess one or several later for a final
8021 capture.<wbr/></p></span>
8022                   </li>
8023                   <li>
8024                     <span class="entry_type_enum_name">MANUAL</span>
8025                     <span class="entry_type_enum_notes"><p>This request is for manual capture use case where
8026 the applications want to directly control the capture parameters.<wbr/></p>
8027 <p>For example,<wbr/> the application may wish to manually control
8028 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> etc.<wbr/></p></span>
8029                   </li>
8030                 </ul>
8031
8032             </td> <!-- entry_type -->
8033
8034             <td class="entry_description">
8035               <p>Information to the camera device 3A (auto-exposure,<wbr/>
8036 auto-focus,<wbr/> auto-white balance) routines about the purpose
8037 of this capture,<wbr/> to help the camera device to decide optimal 3A
8038 strategy.<wbr/></p>
8039             </td>
8040
8041             <td class="entry_units">
8042             </td>
8043
8044             <td class="entry_range">
8045             </td>
8046
8047             <td class="entry_tags">
8048               <ul class="entry_tags">
8049                   <li><a href="#tag_BC">BC</a></li>
8050               </ul>
8051             </td>
8052
8053           </tr>
8054           <tr class="entries_header">
8055             <th class="th_details" colspan="5">Details</th>
8056           </tr>
8057           <tr class="entry_cont">
8058             <td class="entry_details" colspan="5">
8059               <p>This control (except for MANUAL) is only effective if
8060 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> != OFF</code> and any 3A routine is active.<wbr/></p>
8061 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG will be supported if <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
8062 contains PRIVATE_<wbr/>REPROCESSING or YUV_<wbr/>REPROCESSING.<wbr/> MANUAL will be supported if
8063 <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains MANUAL_<wbr/>SENSOR.<wbr/> Other intent values are
8064 always supported.<wbr/></p>
8065             </td>
8066           </tr>
8067
8068
8069           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8070            <!-- end of entry -->
8071
8072
8073           <tr class="entry" id="dynamic_android.control.awbState">
8074             <td class="entry_name
8075              " rowspan="3">
8076               android.<wbr/>control.<wbr/>awb<wbr/>State
8077             </td>
8078             <td class="entry_type">
8079                 <span class="entry_type_name entry_type_name_enum">byte</span>
8080
8081               <span class="entry_type_visibility"> [public]</span>
8082
8083
8084               <span class="entry_type_hwlevel">[limited] </span>
8085
8086
8087
8088                 <ul class="entry_type_enum">
8089                   <li>
8090                     <span class="entry_type_enum_name">INACTIVE</span>
8091                     <span class="entry_type_enum_notes"><p>AWB is not in auto mode,<wbr/> or has not yet started metering.<wbr/></p>
8092 <p>When a camera device is opened,<wbr/> it starts in this
8093 state.<wbr/> This is a transient state,<wbr/> the camera device may
8094 skip reporting this state in capture
8095 result.<wbr/></p></span>
8096                   </li>
8097                   <li>
8098                     <span class="entry_type_enum_name">SEARCHING</span>
8099                     <span class="entry_type_enum_notes"><p>AWB doesn't yet have a good set of control
8100 values for the current scene.<wbr/></p>
8101 <p>This is a transient state,<wbr/> the camera device
8102 may skip reporting this state in capture result.<wbr/></p></span>
8103                   </li>
8104                   <li>
8105                     <span class="entry_type_enum_name">CONVERGED</span>
8106                     <span class="entry_type_enum_notes"><p>AWB has a good set of control values for the
8107 current scene.<wbr/></p></span>
8108                   </li>
8109                   <li>
8110                     <span class="entry_type_enum_name">LOCKED</span>
8111                     <span class="entry_type_enum_notes"><p>AWB has been locked.<wbr/></p></span>
8112                   </li>
8113                 </ul>
8114
8115             </td> <!-- entry_type -->
8116
8117             <td class="entry_description">
8118               <p>Current state of auto-white balance (AWB) algorithm.<wbr/></p>
8119             </td>
8120
8121             <td class="entry_units">
8122             </td>
8123
8124             <td class="entry_range">
8125             </td>
8126
8127             <td class="entry_tags">
8128             </td>
8129
8130           </tr>
8131           <tr class="entries_header">
8132             <th class="th_details" colspan="5">Details</th>
8133           </tr>
8134           <tr class="entry_cont">
8135             <td class="entry_details" colspan="5">
8136               <p>Switching between or enabling AWB modes (<a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>) always
8137 resets the AWB state to INACTIVE.<wbr/> Similarly,<wbr/> switching between <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a>,<wbr/>
8138 or <a href="#controls_android.control.sceneMode">android.<wbr/>control.<wbr/>scene<wbr/>Mode</a> if <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code> resets all
8139 the algorithm states to INACTIVE.<wbr/></p>
8140 <p>The camera device can do several state transitions between two results,<wbr/> if it is
8141 allowed by the state transition table.<wbr/> So INACTIVE may never actually be seen in
8142 a result.<wbr/></p>
8143 <p>The state in the result is the state for this image (in sync with this image): if
8144 AWB state becomes CONVERGED,<wbr/> then the image data associated with this result should
8145 be good to use.<wbr/></p>
8146 <p>Below are state transition tables for different AWB modes.<wbr/></p>
8147 <p>When <code><a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> != AWB_<wbr/>MODE_<wbr/>AUTO</code>:</p>
8148 <table>
8149 <thead>
8150 <tr>
8151 <th align="center">State</th>
8152 <th align="center">Transition Cause</th>
8153 <th align="center">New State</th>
8154 <th align="center">Notes</th>
8155 </tr>
8156 </thead>
8157 <tbody>
8158 <tr>
8159 <td align="center">INACTIVE</td>
8160 <td align="center"></td>
8161 <td align="center">INACTIVE</td>
8162 <td align="center">Camera device auto white balance algorithm is disabled</td>
8163 </tr>
8164 </tbody>
8165 </table>
8166 <p>When <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> is AWB_<wbr/>MODE_<wbr/>AUTO:</p>
8167 <table>
8168 <thead>
8169 <tr>
8170 <th align="center">State</th>
8171 <th align="center">Transition Cause</th>
8172 <th align="center">New State</th>
8173 <th align="center">Notes</th>
8174 </tr>
8175 </thead>
8176 <tbody>
8177 <tr>
8178 <td align="center">INACTIVE</td>
8179 <td align="center">Camera device initiates AWB scan</td>
8180 <td align="center">SEARCHING</td>
8181 <td align="center">Values changing</td>
8182 </tr>
8183 <tr>
8184 <td align="center">INACTIVE</td>
8185 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
8186 <td align="center">LOCKED</td>
8187 <td align="center">Values locked</td>
8188 </tr>
8189 <tr>
8190 <td align="center">SEARCHING</td>
8191 <td align="center">Camera device finishes AWB scan</td>
8192 <td align="center">CONVERGED</td>
8193 <td align="center">Good values,<wbr/> not changing</td>
8194 </tr>
8195 <tr>
8196 <td align="center">SEARCHING</td>
8197 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
8198 <td align="center">LOCKED</td>
8199 <td align="center">Values locked</td>
8200 </tr>
8201 <tr>
8202 <td align="center">CONVERGED</td>
8203 <td align="center">Camera device initiates AWB scan</td>
8204 <td align="center">SEARCHING</td>
8205 <td align="center">Values changing</td>
8206 </tr>
8207 <tr>
8208 <td align="center">CONVERGED</td>
8209 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is ON</td>
8210 <td align="center">LOCKED</td>
8211 <td align="center">Values locked</td>
8212 </tr>
8213 <tr>
8214 <td align="center">LOCKED</td>
8215 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
8216 <td align="center">SEARCHING</td>
8217 <td align="center">Values not good after unlock</td>
8218 </tr>
8219 </tbody>
8220 </table>
8221 <p>For the above table,<wbr/> the camera device may skip reporting any state changes that happen
8222 without application intervention (i.<wbr/>e.<wbr/> mode switch,<wbr/> trigger,<wbr/> locking).<wbr/> Any state that
8223 can be skipped in that manner is called a transient state.<wbr/></p>
8224 <p>For example,<wbr/> for this AWB mode (AWB_<wbr/>MODE_<wbr/>AUTO),<wbr/> in addition to the state transitions
8225 listed in above table,<wbr/> it is also legal for the camera device to skip one or more
8226 transient states between two results.<wbr/> See below table for examples:</p>
8227 <table>
8228 <thead>
8229 <tr>
8230 <th align="center">State</th>
8231 <th align="center">Transition Cause</th>
8232 <th align="center">New State</th>
8233 <th align="center">Notes</th>
8234 </tr>
8235 </thead>
8236 <tbody>
8237 <tr>
8238 <td align="center">INACTIVE</td>
8239 <td align="center">Camera device finished AWB scan</td>
8240 <td align="center">CONVERGED</td>
8241 <td align="center">Values are already good,<wbr/> transient states are skipped by camera device.<wbr/></td>
8242 </tr>
8243 <tr>
8244 <td align="center">LOCKED</td>
8245 <td align="center"><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a> is OFF</td>
8246 <td align="center">CONVERGED</td>
8247 <td align="center">Values good after unlock,<wbr/> transient states are skipped by camera device.<wbr/></td>
8248 </tr>
8249 </tbody>
8250 </table>
8251             </td>
8252           </tr>
8253
8254
8255           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8256            <!-- end of entry -->
8257
8258
8259           <tr class="entry" id="dynamic_android.control.effectMode">
8260             <td class="entry_name
8261              " rowspan="3">
8262               android.<wbr/>control.<wbr/>effect<wbr/>Mode
8263             </td>
8264             <td class="entry_type">
8265                 <span class="entry_type_name entry_type_name_enum">byte</span>
8266
8267               <span class="entry_type_visibility"> [public]</span>
8268
8269
8270               <span class="entry_type_hwlevel">[legacy] </span>
8271
8272
8273
8274                 <ul class="entry_type_enum">
8275                   <li>
8276                     <span class="entry_type_enum_name">OFF</span>
8277                     <span class="entry_type_enum_notes"><p>No color effect will be applied.<wbr/></p></span>
8278                   </li>
8279                   <li>
8280                     <span class="entry_type_enum_name">MONO</span>
8281                     <span class="entry_type_enum_optional">[optional]</span>
8282                     <span class="entry_type_enum_notes"><p>A "monocolor" effect where the image is mapped into
8283 a single color.<wbr/></p>
8284 <p>This will typically be grayscale.<wbr/></p></span>
8285                   </li>
8286                   <li>
8287                     <span class="entry_type_enum_name">NEGATIVE</span>
8288                     <span class="entry_type_enum_optional">[optional]</span>
8289                     <span class="entry_type_enum_notes"><p>A "photo-negative" effect where the image's colors
8290 are inverted.<wbr/></p></span>
8291                   </li>
8292                   <li>
8293                     <span class="entry_type_enum_name">SOLARIZE</span>
8294                     <span class="entry_type_enum_optional">[optional]</span>
8295                     <span class="entry_type_enum_notes"><p>A "solarisation" effect (Sabattier effect) where the
8296 image is wholly or partially reversed in
8297 tone.<wbr/></p></span>
8298                   </li>
8299                   <li>
8300                     <span class="entry_type_enum_name">SEPIA</span>
8301                     <span class="entry_type_enum_optional">[optional]</span>
8302                     <span class="entry_type_enum_notes"><p>A "sepia" effect where the image is mapped into warm
8303 gray,<wbr/> red,<wbr/> and brown tones.<wbr/></p></span>
8304                   </li>
8305                   <li>
8306                     <span class="entry_type_enum_name">POSTERIZE</span>
8307                     <span class="entry_type_enum_optional">[optional]</span>
8308                     <span class="entry_type_enum_notes"><p>A "posterization" effect where the image uses
8309 discrete regions of tone rather than a continuous
8310 gradient of tones.<wbr/></p></span>
8311                   </li>
8312                   <li>
8313                     <span class="entry_type_enum_name">WHITEBOARD</span>
8314                     <span class="entry_type_enum_optional">[optional]</span>
8315                     <span class="entry_type_enum_notes"><p>A "whiteboard" effect where the image is typically displayed
8316 as regions of white,<wbr/> with black or grey details.<wbr/></p></span>
8317                   </li>
8318                   <li>
8319                     <span class="entry_type_enum_name">BLACKBOARD</span>
8320                     <span class="entry_type_enum_optional">[optional]</span>
8321                     <span class="entry_type_enum_notes"><p>A "blackboard" effect where the image is typically displayed
8322 as regions of black,<wbr/> with white or grey details.<wbr/></p></span>
8323                   </li>
8324                   <li>
8325                     <span class="entry_type_enum_name">AQUA</span>
8326                     <span class="entry_type_enum_optional">[optional]</span>
8327                     <span class="entry_type_enum_notes"><p>An "aqua" effect where a blue hue is added to the image.<wbr/></p></span>
8328                   </li>
8329                 </ul>
8330
8331             </td> <!-- entry_type -->
8332
8333             <td class="entry_description">
8334               <p>A special color effect to apply.<wbr/></p>
8335             </td>
8336
8337             <td class="entry_units">
8338             </td>
8339
8340             <td class="entry_range">
8341               <p><a href="#static_android.control.availableEffects">android.<wbr/>control.<wbr/>available<wbr/>Effects</a></p>
8342             </td>
8343
8344             <td class="entry_tags">
8345               <ul class="entry_tags">
8346                   <li><a href="#tag_BC">BC</a></li>
8347               </ul>
8348             </td>
8349
8350           </tr>
8351           <tr class="entries_header">
8352             <th class="th_details" colspan="5">Details</th>
8353           </tr>
8354           <tr class="entry_cont">
8355             <td class="entry_details" colspan="5">
8356               <p>When this mode is set,<wbr/> a color effect will be applied
8357 to images produced by the camera device.<wbr/> The interpretation
8358 and implementation of these color effects is left to the
8359 implementor of the camera device,<wbr/> and should not be
8360 depended on to be consistent (or present) across all
8361 devices.<wbr/></p>
8362             </td>
8363           </tr>
8364
8365
8366           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8367            <!-- end of entry -->
8368
8369
8370           <tr class="entry" id="dynamic_android.control.mode">
8371             <td class="entry_name
8372              " rowspan="3">
8373               android.<wbr/>control.<wbr/>mode
8374             </td>
8375             <td class="entry_type">
8376                 <span class="entry_type_name entry_type_name_enum">byte</span>
8377
8378               <span class="entry_type_visibility"> [public]</span>
8379
8380
8381               <span class="entry_type_hwlevel">[legacy] </span>
8382
8383
8384
8385                 <ul class="entry_type_enum">
8386                   <li>
8387                     <span class="entry_type_enum_name">OFF</span>
8388                     <span class="entry_type_enum_notes"><p>Full application control of pipeline.<wbr/></p>
8389 <p>All control by the device's metering and focusing (3A)
8390 routines is disabled,<wbr/> and no other settings in
8391 android.<wbr/>control.<wbr/>* have any effect,<wbr/> except that
8392 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> may be used by the camera
8393 device to select post-processing values for processing
8394 blocks that do not allow for manual control,<wbr/> or are not
8395 exposed by the camera API.<wbr/></p>
8396 <p>However,<wbr/> the camera device's 3A routines may continue to
8397 collect statistics and update their internal state so that
8398 when control is switched to AUTO mode,<wbr/> good control values
8399 can be immediately applied.<wbr/></p></span>
8400                   </li>
8401                   <li>
8402                     <span class="entry_type_enum_name">AUTO</span>
8403                     <span class="entry_type_enum_notes"><p>Use settings for each individual 3A routine.<wbr/></p>
8404 <p>Manual control of capture parameters is disabled.<wbr/> All
8405 controls in android.<wbr/>control.<wbr/>* besides sceneMode take
8406 effect.<wbr/></p></span>
8407                   </li>
8408                   <li>
8409                     <span class="entry_type_enum_name">USE_SCENE_MODE</span>
8410                     <span class="entry_type_enum_optional">[optional]</span>
8411                     <span class="entry_type_enum_notes"><p>Use a specific scene mode.<wbr/></p>
8412 <p>Enabling this disables control.<wbr/>aeMode,<wbr/> control.<wbr/>awbMode and
8413 control.<wbr/>afMode controls; the camera device will ignore
8414 those settings while USE_<wbr/>SCENE_<wbr/>MODE is active (except for
8415 FACE_<wbr/>PRIORITY scene mode).<wbr/> Other control entries are still active.<wbr/>
8416 This setting can only be used if scene mode is supported (i.<wbr/>e.<wbr/>
8417 <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>
8418 contain some modes other than DISABLED).<wbr/></p></span>
8419                   </li>
8420                   <li>
8421                     <span class="entry_type_enum_name">OFF_KEEP_STATE</span>
8422                     <span class="entry_type_enum_optional">[optional]</span>
8423                     <span class="entry_type_enum_notes"><p>Same as OFF mode,<wbr/> except that this capture will not be
8424 used by camera device background auto-exposure,<wbr/> auto-white balance and
8425 auto-focus algorithms (3A) to update their statistics.<wbr/></p>
8426 <p>Specifically,<wbr/> the 3A routines are locked to the last
8427 values set from a request with AUTO,<wbr/> OFF,<wbr/> or
8428 USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> and any statistics or state updates
8429 collected from manual captures with OFF_<wbr/>KEEP_<wbr/>STATE will be
8430 discarded by the camera device.<wbr/></p></span>
8431                   </li>
8432                 </ul>
8433
8434             </td> <!-- entry_type -->
8435
8436             <td class="entry_description">
8437               <p>Overall mode of 3A (auto-exposure,<wbr/> auto-white-balance,<wbr/> auto-focus) control
8438 routines.<wbr/></p>
8439             </td>
8440
8441             <td class="entry_units">
8442             </td>
8443
8444             <td class="entry_range">
8445               <p><a href="#static_android.control.availableModes">android.<wbr/>control.<wbr/>available<wbr/>Modes</a></p>
8446             </td>
8447
8448             <td class="entry_tags">
8449               <ul class="entry_tags">
8450                   <li><a href="#tag_BC">BC</a></li>
8451               </ul>
8452             </td>
8453
8454           </tr>
8455           <tr class="entries_header">
8456             <th class="th_details" colspan="5">Details</th>
8457           </tr>
8458           <tr class="entry_cont">
8459             <td class="entry_details" colspan="5">
8460               <p>This is a top-level 3A control switch.<wbr/> When set to OFF,<wbr/> all 3A control
8461 by the camera device is disabled.<wbr/> The application must set the fields for
8462 capture parameters itself.<wbr/></p>
8463 <p>When set to AUTO,<wbr/> the individual algorithm controls in
8464 android.<wbr/>control.<wbr/>* are in effect,<wbr/> such as <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>.<wbr/></p>
8465 <p>When set to USE_<wbr/>SCENE_<wbr/>MODE,<wbr/> the individual controls in
8466 android.<wbr/>control.<wbr/>* are mostly disabled,<wbr/> and the camera device implements
8467 one of the scene mode settings (such as ACTION,<wbr/> SUNSET,<wbr/> or PARTY)
8468 as it wishes.<wbr/> The camera device scene mode 3A settings are provided by
8469 <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">capture results</a>.<wbr/></p>
8470 <p>When set to OFF_<wbr/>KEEP_<wbr/>STATE,<wbr/> it is similar to OFF mode,<wbr/> the only difference
8471 is that this frame will not be used by camera device background 3A statistics
8472 update,<wbr/> as if this frame is never captured.<wbr/> This mode can be used in the scenario
8473 where the application doesn't want a 3A manual control capture to affect
8474 the subsequent auto 3A capture results.<wbr/></p>
8475             </td>
8476           </tr>
8477
8478
8479           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8480            <!-- end of entry -->
8481
8482
8483           <tr class="entry" id="dynamic_android.control.sceneMode">
8484             <td class="entry_name
8485              " rowspan="5">
8486               android.<wbr/>control.<wbr/>scene<wbr/>Mode
8487             </td>
8488             <td class="entry_type">
8489                 <span class="entry_type_name entry_type_name_enum">byte</span>
8490
8491               <span class="entry_type_visibility"> [public]</span>
8492
8493
8494               <span class="entry_type_hwlevel">[legacy] </span>
8495
8496
8497
8498                 <ul class="entry_type_enum">
8499                   <li>
8500                     <span class="entry_type_enum_name">DISABLED</span>
8501                     <span class="entry_type_enum_value">0</span>
8502                     <span class="entry_type_enum_notes"><p>Indicates that no scene modes are set for a given capture request.<wbr/></p></span>
8503                   </li>
8504                   <li>
8505                     <span class="entry_type_enum_name">FACE_PRIORITY</span>
8506                     <span class="entry_type_enum_notes"><p>If face detection support exists,<wbr/> use face
8507 detection data for auto-focus,<wbr/> auto-white balance,<wbr/> and
8508 auto-exposure routines.<wbr/></p>
8509 <p>If face detection statistics are disabled
8510 (i.<wbr/>e.<wbr/> <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> is set to OFF),<wbr/>
8511 this should still operate correctly (but will not return
8512 face detection statistics to the framework).<wbr/></p>
8513 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
8514 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
8515 remain active when FACE_<wbr/>PRIORITY is set.<wbr/></p></span>
8516                   </li>
8517                   <li>
8518                     <span class="entry_type_enum_name">ACTION</span>
8519                     <span class="entry_type_enum_optional">[optional]</span>
8520                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving objects.<wbr/></p>
8521 <p>Similar to SPORTS.<wbr/></p></span>
8522                   </li>
8523                   <li>
8524                     <span class="entry_type_enum_name">PORTRAIT</span>
8525                     <span class="entry_type_enum_optional">[optional]</span>
8526                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people.<wbr/></p></span>
8527                   </li>
8528                   <li>
8529                     <span class="entry_type_enum_name">LANDSCAPE</span>
8530                     <span class="entry_type_enum_optional">[optional]</span>
8531                     <span class="entry_type_enum_notes"><p>Optimized for photos of distant macroscopic objects.<wbr/></p></span>
8532                   </li>
8533                   <li>
8534                     <span class="entry_type_enum_name">NIGHT</span>
8535                     <span class="entry_type_enum_optional">[optional]</span>
8536                     <span class="entry_type_enum_notes"><p>Optimized for low-light settings.<wbr/></p></span>
8537                   </li>
8538                   <li>
8539                     <span class="entry_type_enum_name">NIGHT_PORTRAIT</span>
8540                     <span class="entry_type_enum_optional">[optional]</span>
8541                     <span class="entry_type_enum_notes"><p>Optimized for still photos of people in low-light
8542 settings.<wbr/></p></span>
8543                   </li>
8544                   <li>
8545                     <span class="entry_type_enum_name">THEATRE</span>
8546                     <span class="entry_type_enum_optional">[optional]</span>
8547                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings where flash must
8548 remain off.<wbr/></p></span>
8549                   </li>
8550                   <li>
8551                     <span class="entry_type_enum_name">BEACH</span>
8552                     <span class="entry_type_enum_optional">[optional]</span>
8553                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor beach settings.<wbr/></p></span>
8554                   </li>
8555                   <li>
8556                     <span class="entry_type_enum_name">SNOW</span>
8557                     <span class="entry_type_enum_optional">[optional]</span>
8558                     <span class="entry_type_enum_notes"><p>Optimized for bright,<wbr/> outdoor settings containing snow.<wbr/></p></span>
8559                   </li>
8560                   <li>
8561                     <span class="entry_type_enum_name">SUNSET</span>
8562                     <span class="entry_type_enum_optional">[optional]</span>
8563                     <span class="entry_type_enum_notes"><p>Optimized for scenes of the setting sun.<wbr/></p></span>
8564                   </li>
8565                   <li>
8566                     <span class="entry_type_enum_name">STEADYPHOTO</span>
8567                     <span class="entry_type_enum_optional">[optional]</span>
8568                     <span class="entry_type_enum_notes"><p>Optimized to avoid blurry photos due to small amounts of
8569 device motion (for example: due to hand shake).<wbr/></p></span>
8570                   </li>
8571                   <li>
8572                     <span class="entry_type_enum_name">FIREWORKS</span>
8573                     <span class="entry_type_enum_optional">[optional]</span>
8574                     <span class="entry_type_enum_notes"><p>Optimized for nighttime photos of fireworks.<wbr/></p></span>
8575                   </li>
8576                   <li>
8577                     <span class="entry_type_enum_name">SPORTS</span>
8578                     <span class="entry_type_enum_optional">[optional]</span>
8579                     <span class="entry_type_enum_notes"><p>Optimized for photos of quickly moving people.<wbr/></p>
8580 <p>Similar to ACTION.<wbr/></p></span>
8581                   </li>
8582                   <li>
8583                     <span class="entry_type_enum_name">PARTY</span>
8584                     <span class="entry_type_enum_optional">[optional]</span>
8585                     <span class="entry_type_enum_notes"><p>Optimized for dim,<wbr/> indoor settings with multiple moving
8586 people.<wbr/></p></span>
8587                   </li>
8588                   <li>
8589                     <span class="entry_type_enum_name">CANDLELIGHT</span>
8590                     <span class="entry_type_enum_optional">[optional]</span>
8591                     <span class="entry_type_enum_notes"><p>Optimized for dim settings where the main light source
8592 is a flame.<wbr/></p></span>
8593                   </li>
8594                   <li>
8595                     <span class="entry_type_enum_name">BARCODE</span>
8596                     <span class="entry_type_enum_optional">[optional]</span>
8597                     <span class="entry_type_enum_notes"><p>Optimized for accurately capturing a photo of barcode
8598 for use by camera applications that wish to read the
8599 barcode value.<wbr/></p></span>
8600                   </li>
8601                   <li>
8602                     <span class="entry_type_enum_name">HIGH_SPEED_VIDEO</span>
8603                     <span class="entry_type_enum_deprecated">[deprecated]</span>
8604                     <span class="entry_type_enum_optional">[optional]</span>
8605                     <span class="entry_type_enum_notes"><p>This is deprecated,<wbr/> please use <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>
8606 and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>
8607 for high speed video recording.<wbr/></p>
8608 <p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.<wbr/></p>
8609 <p>The supported high speed video sizes and fps ranges are specified in
8610 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> To get desired
8611 output frame rates,<wbr/> the application is only allowed to select video size
8612 and fps range combinations listed in this static metadata.<wbr/> The fps range
8613 can be control via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
8614 <p>In this mode,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
8615 ON,<wbr/> ON,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
8616 controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
8617 and post-processing parameters is possible.<wbr/> All other controls operate the
8618 same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
8619 android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
8620 <ul>
8621 <li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
8622 <li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
8623 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
8624 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
8625 <li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
8626 <li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
8627 <li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
8628 <li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
8629 <li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
8630 <li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
8631 </ul>
8632 <p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
8633 <ul>
8634 <li><a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> (automatic flash for still capture will not work since aeMode is ON)</li>
8635 <li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
8636 <li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
8637 <li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></li>
8638 </ul>
8639 <p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
8640 be lower than what camera can output,<wbr/> depending on the destination Surfaces for
8641 the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
8642 the application need check if the video encoder is capable of supporting the
8643 high frame rate for a given video size,<wbr/> or it will end up with lower recording
8644 frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the preview frame
8645 rate will be bounded by the screen refresh rate.<wbr/></p>
8646 <p>The camera device will only support up to 2 output high speed streams
8647 (processed non-stalling format defined in <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>)
8648 in this mode.<wbr/> This control will be effective only if all of below conditions are true:</p>
8649 <ul>
8650 <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
8651 format output streams,<wbr/> where maxNumHighSpeedStreams is calculated as
8652 min(2,<wbr/> <a href="#static_android.request.maxNumOutputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams</a>[Processed (but not-stalling)]).<wbr/></li>
8653 <li>The stream sizes are selected from the sizes reported by
8654 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/></li>
8655 <li>No processed non-stalling or raw streams are configured.<wbr/></li>
8656 </ul>
8657 <p>When above conditions are NOT satistied,<wbr/> the controls of this mode and
8658 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> will be ignored by the camera device,<wbr/>
8659 the camera device will fall back to <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> <code>==</code> AUTO,<wbr/>
8660 and the returned capture result metadata will give the fps range choosen
8661 by the camera device.<wbr/></p>
8662 <p>Switching into or out of this mode may trigger some camera ISP/<wbr/>sensor
8663 reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
8664 the application avoids unnecessary scene mode switch as much as possible.<wbr/></p></span>
8665                   </li>
8666                   <li>
8667                     <span class="entry_type_enum_name">HDR</span>
8668                     <span class="entry_type_enum_optional">[optional]</span>
8669                     <span class="entry_type_enum_notes"><p>Turn on a device-specific high dynamic range (HDR) mode.<wbr/></p>
8670 <p>In this scene mode,<wbr/> the camera device captures images
8671 that keep a larger range of scene illumination levels
8672 visible in the final image.<wbr/> For example,<wbr/> when taking a
8673 picture of a object in front of a bright window,<wbr/> both
8674 the object and the scene through the window may be
8675 visible when using HDR mode,<wbr/> while in normal AUTO mode,<wbr/>
8676 one or the other may be poorly exposed.<wbr/> As a tradeoff,<wbr/>
8677 HDR mode generally takes much longer to capture a single
8678 image,<wbr/> has no user control,<wbr/> and may have other artifacts
8679 depending on the HDR method used.<wbr/></p>
8680 <p>Therefore,<wbr/> HDR captures operate at a much slower rate
8681 than regular captures.<wbr/></p>
8682 <p>In this mode,<wbr/> on LIMITED or FULL devices,<wbr/> when a request
8683 is made with a <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> of
8684 STILL_<wbr/>CAPTURE,<wbr/> the camera device will capture an image
8685 using a high dynamic range capture technique.<wbr/>  On LEGACY
8686 devices,<wbr/> captures that target a JPEG-format output will
8687 be captured with HDR,<wbr/> and the capture intent is not
8688 relevant.<wbr/></p>
8689 <p>The HDR capture may involve the device capturing a burst
8690 of images internally and combining them into one,<wbr/> or it
8691 may involve the device using specialized high dynamic
8692 range capture hardware.<wbr/> In all cases,<wbr/> a single image is
8693 produced in response to a capture request submitted
8694 while in HDR mode.<wbr/></p>
8695 <p>Since substantial post-processing is generally needed to
8696 produce an HDR image,<wbr/> only YUV,<wbr/> PRIVATE,<wbr/> and JPEG
8697 outputs are supported for LIMITED/<wbr/>FULL device HDR
8698 captures,<wbr/> and only JPEG outputs are supported for LEGACY
8699 HDR captures.<wbr/> Using a RAW output for HDR capture is not
8700 supported.<wbr/></p>
8701 <p>Some devices may also support always-on HDR,<wbr/> which
8702 applies HDR processing at full frame rate.<wbr/>  For these
8703 devices,<wbr/> intents other than STILL_<wbr/>CAPTURE will also
8704 produce an HDR output with no frame rate impact compared
8705 to normal operation,<wbr/> though the quality may be lower
8706 than for STILL_<wbr/>CAPTURE intents.<wbr/></p>
8707 <p>If SCENE_<wbr/>MODE_<wbr/>HDR is used with unsupported output types
8708 or capture intents,<wbr/> the images captured will be as if
8709 the SCENE_<wbr/>MODE was not enabled at all.<wbr/></p></span>
8710                   </li>
8711                   <li>
8712                     <span class="entry_type_enum_name">FACE_PRIORITY_LOW_LIGHT</span>
8713                     <span class="entry_type_enum_optional">[optional]</span>
8714                     <span class="entry_type_enum_hidden">[hidden]</span>
8715                     <span class="entry_type_enum_notes"><p>Same as FACE_<wbr/>PRIORITY scene mode,<wbr/> except that the camera
8716 device will choose higher sensitivity values (<a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>)
8717 under low light conditions.<wbr/></p>
8718 <p>The camera device may be tuned to expose the images in a reduced
8719 sensitivity range to produce the best quality images.<wbr/> For example,<wbr/>
8720 if the <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a> gives range of [100,<wbr/> 1600],<wbr/>
8721 the camera device auto-exposure routine tuning process may limit the actual
8722 exposure sensitivity range to [100,<wbr/> 1200] to ensure that the noise level isn't
8723 exessive in order to preserve the image quality.<wbr/> Under this situation,<wbr/> the image under
8724 low light may be under-exposed when the sensor max exposure time (bounded by the
8725 <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a> when <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of the
8726 ON_<wbr/>* modes) and effective max sensitivity are reached.<wbr/> This scene mode allows the
8727 camera device auto-exposure routine to increase the sensitivity up to the max
8728 sensitivity specified by <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a> when the scene is too
8729 dark and the max exposure time is reached.<wbr/> The captured images may be noisier
8730 compared with the images captured in normal FACE_<wbr/>PRIORITY mode; therefore,<wbr/> it is
8731 recommended that the application only use this scene mode when it is capable of
8732 reducing the noise level of the captured images.<wbr/></p>
8733 <p>Unlike the other scene modes,<wbr/> <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
8734 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
8735 remain active when FACE_<wbr/>PRIORITY_<wbr/>LOW_<wbr/>LIGHT is set.<wbr/></p></span>
8736                   </li>
8737                   <li>
8738                     <span class="entry_type_enum_name">DEVICE_CUSTOM_START</span>
8739                     <span class="entry_type_enum_optional">[optional]</span>
8740                     <span class="entry_type_enum_hidden">[hidden]</span>
8741                     <span class="entry_type_enum_value">100</span>
8742                     <span class="entry_type_enum_notes"><p>Scene mode values within the range of
8743 <code>[DEVICE_<wbr/>CUSTOM_<wbr/>START,<wbr/> DEVICE_<wbr/>CUSTOM_<wbr/>END]</code> are reserved for device specific
8744 customized scene modes.<wbr/></p></span>
8745                   </li>
8746                   <li>
8747                     <span class="entry_type_enum_name">DEVICE_CUSTOM_END</span>
8748                     <span class="entry_type_enum_optional">[optional]</span>
8749                     <span class="entry_type_enum_hidden">[hidden]</span>
8750                     <span class="entry_type_enum_value">127</span>
8751                     <span class="entry_type_enum_notes"><p>Scene mode values within the range of
8752 <code>[DEVICE_<wbr/>CUSTOM_<wbr/>START,<wbr/> DEVICE_<wbr/>CUSTOM_<wbr/>END]</code> are reserved for device specific
8753 customized scene modes.<wbr/></p></span>
8754                   </li>
8755                 </ul>
8756
8757             </td> <!-- entry_type -->
8758
8759             <td class="entry_description">
8760               <p>Control for which scene mode is currently active.<wbr/></p>
8761             </td>
8762
8763             <td class="entry_units">
8764             </td>
8765
8766             <td class="entry_range">
8767               <p><a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a></p>
8768             </td>
8769
8770             <td class="entry_tags">
8771               <ul class="entry_tags">
8772                   <li><a href="#tag_BC">BC</a></li>
8773               </ul>
8774             </td>
8775
8776           </tr>
8777           <tr class="entries_header">
8778             <th class="th_details" colspan="5">Details</th>
8779           </tr>
8780           <tr class="entry_cont">
8781             <td class="entry_details" colspan="5">
8782               <p>Scene modes are custom camera modes optimized for a certain set of conditions and
8783 capture settings.<wbr/></p>
8784 <p>This is the mode that that is active when
8785 <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == USE_<wbr/>SCENE_<wbr/>MODE</code>.<wbr/> Aside from FACE_<wbr/>PRIORITY,<wbr/> these modes will
8786 disable <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>
8787 while in use.<wbr/></p>
8788 <p>The interpretation and implementation of these scene modes is left
8789 to the implementor of the camera device.<wbr/> Their behavior will not be
8790 consistent across all devices,<wbr/> and any given device may only implement
8791 a subset of these modes.<wbr/></p>
8792             </td>
8793           </tr>
8794
8795           <tr class="entries_header">
8796             <th class="th_details" colspan="5">HAL Implementation Details</th>
8797           </tr>
8798           <tr class="entry_cont">
8799             <td class="entry_details" colspan="5">
8800               <p>HAL implementations that include scene modes are expected to provide
8801 the per-scene settings to use for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/>
8802 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>,<wbr/> and <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> in
8803 <a href="#static_android.control.sceneModeOverrides">android.<wbr/>control.<wbr/>scene<wbr/>Mode<wbr/>Overrides</a>.<wbr/></p>
8804 <p>For HIGH_<wbr/>SPEED_<wbr/>VIDEO mode,<wbr/> if it is included in <a href="#static_android.control.availableSceneModes">android.<wbr/>control.<wbr/>available<wbr/>Scene<wbr/>Modes</a>,<wbr/>
8805 the HAL must list supported video size and fps range in
8806 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a>.<wbr/> For a given size,<wbr/> e.<wbr/>g.<wbr/>
8807 1280x720,<wbr/> if the HAL has two different sensor configurations for normal streaming
8808 mode and high speed streaming,<wbr/> when this scene mode is set/<wbr/>reset in a sequence of capture
8809 requests,<wbr/> the HAL may have to switch between different sensor modes.<wbr/>
8810 This mode is deprecated in HAL3.<wbr/>3,<wbr/> to support high speed video recording,<wbr/> please implement
8811 <a href="#static_android.control.availableHighSpeedVideoConfigurations">android.<wbr/>control.<wbr/>available<wbr/>High<wbr/>Speed<wbr/>Video<wbr/>Configurations</a> and CONSTRAINED_<wbr/>HIGH_<wbr/>SPEED_<wbr/>VIDEO
8812 capbility defined in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
8813             </td>
8814           </tr>
8815
8816           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8817            <!-- end of entry -->
8818
8819
8820           <tr class="entry" id="dynamic_android.control.videoStabilizationMode">
8821             <td class="entry_name
8822              " rowspan="3">
8823               android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode
8824             </td>
8825             <td class="entry_type">
8826                 <span class="entry_type_name entry_type_name_enum">byte</span>
8827
8828               <span class="entry_type_visibility"> [public]</span>
8829
8830
8831               <span class="entry_type_hwlevel">[legacy] </span>
8832
8833
8834
8835                 <ul class="entry_type_enum">
8836                   <li>
8837                     <span class="entry_type_enum_name">OFF</span>
8838                     <span class="entry_type_enum_notes"><p>Video stabilization is disabled.<wbr/></p></span>
8839                   </li>
8840                   <li>
8841                     <span class="entry_type_enum_name">ON</span>
8842                     <span class="entry_type_enum_notes"><p>Video stabilization is enabled.<wbr/></p></span>
8843                   </li>
8844                 </ul>
8845
8846             </td> <!-- entry_type -->
8847
8848             <td class="entry_description">
8849               <p>Whether video stabilization is
8850 active.<wbr/></p>
8851             </td>
8852
8853             <td class="entry_units">
8854             </td>
8855
8856             <td class="entry_range">
8857             </td>
8858
8859             <td class="entry_tags">
8860               <ul class="entry_tags">
8861                   <li><a href="#tag_BC">BC</a></li>
8862               </ul>
8863             </td>
8864
8865           </tr>
8866           <tr class="entries_header">
8867             <th class="th_details" colspan="5">Details</th>
8868           </tr>
8869           <tr class="entry_cont">
8870             <td class="entry_details" colspan="5">
8871               <p>Video stabilization automatically warps images from
8872 the camera in order to stabilize motion between consecutive frames.<wbr/></p>
8873 <p>If enabled,<wbr/> video stabilization can modify the
8874 <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a> to keep the video stream stabilized.<wbr/></p>
8875 <p>Switching between different video stabilization modes may take several
8876 frames to initialize,<wbr/> the camera device will report the current mode
8877 in capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/>
8878 the video stabilization modes in the first several capture results may
8879 still be "OFF",<wbr/> and it will become "ON" when the initialization is
8880 done.<wbr/></p>
8881 <p>In addition,<wbr/> not all recording sizes or frame rates may be supported for
8882 stabilization by a device that reports stabilization support.<wbr/> It is guaranteed
8883 that an output targeting a MediaRecorder or MediaCodec will be stabilized if
8884 the recording resolution is less than or equal to 1920 x 1080 (width less than
8885 or equal to 1920,<wbr/> height less than or equal to 1080),<wbr/> and the recording
8886 frame rate is less than or equal to 30fps.<wbr/>  At other sizes,<wbr/> the CaptureResult
8887 <a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a> field will return
8888 OFF if the recording output is not stabilized,<wbr/> or if there are no output
8889 Surface types that can be stabilized.<wbr/></p>
8890 <p>If a camera device supports both this mode and OIS
8891 (<a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may
8892 produce undesirable interaction,<wbr/> so it is recommended not to enable
8893 both at the same time.<wbr/></p>
8894             </td>
8895           </tr>
8896
8897
8898           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8899            <!-- end of entry -->
8900
8901
8902           <tr class="entry" id="dynamic_android.control.postRawSensitivityBoost">
8903             <td class="entry_name
8904              " rowspan="3">
8905               android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost
8906             </td>
8907             <td class="entry_type">
8908                 <span class="entry_type_name">int32</span>
8909
8910               <span class="entry_type_visibility"> [public]</span>
8911
8912
8913
8914
8915
8916
8917             </td> <!-- entry_type -->
8918
8919             <td class="entry_description">
8920               <p>The amount of additional sensitivity boost applied to output images
8921 after RAW sensor data is captured.<wbr/></p>
8922             </td>
8923
8924             <td class="entry_units">
8925               ISO arithmetic units,<wbr/> the same as android.<wbr/>sensor.<wbr/>sensitivity
8926             </td>
8927
8928             <td class="entry_range">
8929               <p><a href="#static_android.control.postRawSensitivityBoostRange">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost<wbr/>Range</a></p>
8930             </td>
8931
8932             <td class="entry_tags">
8933             </td>
8934
8935           </tr>
8936           <tr class="entries_header">
8937             <th class="th_details" colspan="5">Details</th>
8938           </tr>
8939           <tr class="entry_cont">
8940             <td class="entry_details" colspan="5">
8941               <p>Some camera devices support additional digital sensitivity boosting in the
8942 camera processing pipeline after sensor RAW image is captured.<wbr/>
8943 Such a boost will be applied to YUV/<wbr/>JPEG format output images but will not
8944 have effect on RAW output formats like RAW_<wbr/>SENSOR,<wbr/> RAW10,<wbr/> RAW12 or RAW_<wbr/>OPAQUE.<wbr/></p>
8945 <p>This key will be <code>null</code> for devices that do not support any RAW format
8946 outputs.<wbr/> For devices that do support RAW format outputs,<wbr/> this key will always
8947 present,<wbr/> and if a device does not support post RAW sensitivity boost,<wbr/> it will
8948 list <code>100</code> in this key.<wbr/></p>
8949 <p>If the camera device cannot apply the exact boost requested,<wbr/> it will reduce the
8950 boost to the nearest supported value.<wbr/>
8951 The final boost value used will be available in the output capture result.<wbr/></p>
8952 <p>For devices that support post RAW sensitivity boost,<wbr/> the YUV/<wbr/>JPEG output images
8953 of such device will have the total sensitivity of
8954 <code><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> * <a href="#controls_android.control.postRawSensitivityBoost">android.<wbr/>control.<wbr/>post<wbr/>Raw<wbr/>Sensitivity<wbr/>Boost</a> /<wbr/> 100</code>
8955 The sensitivity of RAW format images will always be <code><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></code></p>
8956 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
8957 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
8958             </td>
8959           </tr>
8960
8961
8962           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
8963            <!-- end of entry -->
8964
8965
8966           <tr class="entry" id="dynamic_android.control.enableZsl">
8967             <td class="entry_name
8968              " rowspan="5">
8969               android.<wbr/>control.<wbr/>enable<wbr/>Zsl
8970             </td>
8971             <td class="entry_type">
8972                 <span class="entry_type_name entry_type_name_enum">byte</span>
8973
8974               <span class="entry_type_visibility"> [public as boolean]</span>
8975
8976
8977
8978
8979
8980                 <ul class="entry_type_enum">
8981                   <li>
8982                     <span class="entry_type_enum_name">FALSE</span>
8983                     <span class="entry_type_enum_notes"><p>Requests with <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE must be captured
8984 after previous requests.<wbr/></p></span>
8985                   </li>
8986                   <li>
8987                     <span class="entry_type_enum_name">TRUE</span>
8988                     <span class="entry_type_enum_notes"><p>Requests with <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE may or may not be
8989 captured before previous requests.<wbr/></p></span>
8990                   </li>
8991                 </ul>
8992
8993             </td> <!-- entry_type -->
8994
8995             <td class="entry_description">
8996               <p>Allow camera device to enable zero-shutter-lag mode for requests with
8997 <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> == STILL_<wbr/>CAPTURE.<wbr/></p>
8998             </td>
8999
9000             <td class="entry_units">
9001             </td>
9002
9003             <td class="entry_range">
9004             </td>
9005
9006             <td class="entry_tags">
9007             </td>
9008
9009           </tr>
9010           <tr class="entries_header">
9011             <th class="th_details" colspan="5">Details</th>
9012           </tr>
9013           <tr class="entry_cont">
9014             <td class="entry_details" colspan="5">
9015               <p>If enableZsl is <code>true</code>,<wbr/> the camera device may enable zero-shutter-lag mode for requests with
9016 STILL_<wbr/>CAPTURE capture intent.<wbr/> The camera device may use images captured in the past to
9017 produce output images for a zero-shutter-lag request.<wbr/> The result metadata including the
9018 <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> reflects the source frames used to produce output images.<wbr/>
9019 Therefore,<wbr/> the contents of the output images and the result metadata may be out of order
9020 compared to previous regular requests.<wbr/> enableZsl does not affect requests with other
9021 capture intents.<wbr/></p>
9022 <p>For example,<wbr/> when requests are submitted in the following order:
9023   Request A: enableZsl is ON,<wbr/> <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> is PREVIEW
9024   Request B: enableZsl is ON,<wbr/> <a href="#controls_android.control.captureIntent">android.<wbr/>control.<wbr/>capture<wbr/>Intent</a> is STILL_<wbr/>CAPTURE</p>
9025 <p>The output images for request B may have contents captured before the output images for
9026 request A,<wbr/> and the result metadata for request B may be older than the result metadata for
9027 request A.<wbr/></p>
9028 <p>Note that when enableZsl is <code>true</code>,<wbr/> it is not guaranteed to get output images captured in
9029 the past for requests with STILL_<wbr/>CAPTURE capture intent.<wbr/></p>
9030 <p>For applications targeting SDK versions O and newer,<wbr/> the value of enableZsl in
9031 TEMPLATE_<wbr/>STILL_<wbr/>CAPTURE template may be <code>true</code>.<wbr/> The value in other templates is always
9032 <code>false</code> if present.<wbr/></p>
9033 <p>For applications targeting SDK versions older than O,<wbr/> the value of enableZsl in all
9034 capture templates is always <code>false</code> if present.<wbr/></p>
9035             </td>
9036           </tr>
9037
9038           <tr class="entries_header">
9039             <th class="th_details" colspan="5">HAL Implementation Details</th>
9040           </tr>
9041           <tr class="entry_cont">
9042             <td class="entry_details" colspan="5">
9043               <p>It is valid for HAL to produce regular output images for requests with STILL_<wbr/>CAPTURE
9044 capture intent.<wbr/></p>
9045             </td>
9046           </tr>
9047
9048           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9049            <!-- end of entry -->
9050
9051
9052
9053       <!-- end of kind -->
9054       </tbody>
9055
9056   <!-- end of section -->
9057   <tr><td colspan="6" id="section_demosaic" class="section">demosaic</td></tr>
9058
9059
9060       <tr><td colspan="6" class="kind">controls</td></tr>
9061
9062       <thead class="entries_header">
9063         <tr>
9064           <th class="th_name">Property Name</th>
9065           <th class="th_type">Type</th>
9066           <th class="th_description">Description</th>
9067           <th class="th_units">Units</th>
9068           <th class="th_range">Range</th>
9069           <th class="th_tags">Tags</th>
9070         </tr>
9071       </thead>
9072
9073       <tbody>
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084           <tr class="entry" id="controls_android.demosaic.mode">
9085             <td class="entry_name
9086              " rowspan="1">
9087               android.<wbr/>demosaic.<wbr/>mode
9088             </td>
9089             <td class="entry_type">
9090                 <span class="entry_type_name entry_type_name_enum">byte</span>
9091
9092               <span class="entry_type_visibility"> [system]</span>
9093
9094
9095
9096
9097
9098                 <ul class="entry_type_enum">
9099                   <li>
9100                     <span class="entry_type_enum_name">FAST</span>
9101                     <span class="entry_type_enum_notes"><p>Minimal or no slowdown of frame rate compared to
9102 Bayer RAW output.<wbr/></p></span>
9103                   </li>
9104                   <li>
9105                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
9106                     <span class="entry_type_enum_notes"><p>Improved processing quality but the frame rate might be slowed down
9107 relative to raw output.<wbr/></p></span>
9108                   </li>
9109                 </ul>
9110
9111             </td> <!-- entry_type -->
9112
9113             <td class="entry_description">
9114               <p>Controls the quality of the demosaicing
9115 processing.<wbr/></p>
9116             </td>
9117
9118             <td class="entry_units">
9119             </td>
9120
9121             <td class="entry_range">
9122             </td>
9123
9124             <td class="entry_tags">
9125               <ul class="entry_tags">
9126                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9127               </ul>
9128             </td>
9129
9130           </tr>
9131
9132
9133           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9134            <!-- end of entry -->
9135
9136
9137
9138       <!-- end of kind -->
9139       </tbody>
9140
9141   <!-- end of section -->
9142   <tr><td colspan="6" id="section_edge" class="section">edge</td></tr>
9143
9144
9145       <tr><td colspan="6" class="kind">controls</td></tr>
9146
9147       <thead class="entries_header">
9148         <tr>
9149           <th class="th_name">Property Name</th>
9150           <th class="th_type">Type</th>
9151           <th class="th_description">Description</th>
9152           <th class="th_units">Units</th>
9153           <th class="th_range">Range</th>
9154           <th class="th_tags">Tags</th>
9155         </tr>
9156       </thead>
9157
9158       <tbody>
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169           <tr class="entry" id="controls_android.edge.mode">
9170             <td class="entry_name
9171              " rowspan="5">
9172               android.<wbr/>edge.<wbr/>mode
9173             </td>
9174             <td class="entry_type">
9175                 <span class="entry_type_name entry_type_name_enum">byte</span>
9176
9177               <span class="entry_type_visibility"> [public]</span>
9178
9179
9180               <span class="entry_type_hwlevel">[full] </span>
9181
9182
9183
9184                 <ul class="entry_type_enum">
9185                   <li>
9186                     <span class="entry_type_enum_name">OFF</span>
9187                     <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
9188                   </li>
9189                   <li>
9190                     <span class="entry_type_enum_name">FAST</span>
9191                     <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate
9192 relative to sensor output.<wbr/> It may be the same as OFF if edge enhancement will
9193 slow down frame rate relative to sensor.<wbr/></p></span>
9194                   </li>
9195                   <li>
9196                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
9197                     <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of possibly reduced output frame rate.<wbr/></p></span>
9198                   </li>
9199                   <li>
9200                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
9201                     <span class="entry_type_enum_optional">[optional]</span>
9202                     <span class="entry_type_enum_notes"><p>Edge enhancement is applied at different levels for different output streams,<wbr/>
9203 based on resolution.<wbr/> Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>) or below have
9204 edge enhancement applied,<wbr/> while higher-resolution streams have no edge enhancement
9205 applied.<wbr/> The level of edge enhancement for low-resolution streams is tuned so that
9206 frame rate is not impacted,<wbr/> and the quality is equal to or better than FAST (since it
9207 is only applied to lower-resolution outputs,<wbr/> quality may improve from FAST).<wbr/></p>
9208 <p>This mode is intended to be used by applications operating in a zero-shutter-lag mode
9209 with YUV or PRIVATE reprocessing,<wbr/> where the application continuously captures
9210 high-resolution intermediate buffers into a circular buffer,<wbr/> from which a final image is
9211 produced via reprocessing when a user takes a picture.<wbr/>  For such a use case,<wbr/> the
9212 high-resolution buffers must not have edge enhancement applied to maximize efficiency of
9213 preview and to avoid double-applying enhancement when reprocessed,<wbr/> while low-resolution
9214 buffers (used for recording or preview,<wbr/> generally) need edge enhancement applied for
9215 reasonable preview quality.<wbr/></p>
9216 <p>This mode is guaranteed to be supported by devices that support either the
9217 YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING capabilities
9218 (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> lists either of those capabilities) and it will
9219 be the default mode for CAMERA3_<wbr/>TEMPLATE_<wbr/>ZERO_<wbr/>SHUTTER_<wbr/>LAG template.<wbr/></p></span>
9220                   </li>
9221                 </ul>
9222
9223             </td> <!-- entry_type -->
9224
9225             <td class="entry_description">
9226               <p>Operation mode for edge
9227 enhancement.<wbr/></p>
9228             </td>
9229
9230             <td class="entry_units">
9231             </td>
9232
9233             <td class="entry_range">
9234               <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
9235             </td>
9236
9237             <td class="entry_tags">
9238               <ul class="entry_tags">
9239                   <li><a href="#tag_V1">V1</a></li>
9240                   <li><a href="#tag_REPROC">REPROC</a></li>
9241               </ul>
9242             </td>
9243
9244           </tr>
9245           <tr class="entries_header">
9246             <th class="th_details" colspan="5">Details</th>
9247           </tr>
9248           <tr class="entry_cont">
9249             <td class="entry_details" colspan="5">
9250               <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
9251 no enhancement will be applied by the camera device.<wbr/></p>
9252 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
9253 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
9254 camera device will use the highest-quality enhancement algorithms,<wbr/>
9255 even if it slows down capture rate.<wbr/> FAST means the camera device will
9256 not slow down capture rate when applying edge enhancement.<wbr/> FAST may be the same as OFF if
9257 edge enhancement will slow down capture rate.<wbr/> Every output stream will have a similar
9258 amount of enhancement applied.<wbr/></p>
9259 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG is meant to be used by applications that maintain a continuous circular
9260 buffer of high-resolution images during preview and reprocess image(s) from that buffer
9261 into a final capture when triggered by the user.<wbr/> In this mode,<wbr/> the camera device applies
9262 edge enhancement to low-resolution streams (below maximum recording resolution) to
9263 maximize preview quality,<wbr/> but does not apply edge enhancement to high-resolution streams,<wbr/>
9264 since those will be reprocessed later if necessary.<wbr/></p>
9265 <p>For YUV_<wbr/>REPROCESSING,<wbr/> these FAST/<wbr/>HIGH_<wbr/>QUALITY modes both mean that the camera
9266 device will apply FAST/<wbr/>HIGH_<wbr/>QUALITY YUV-domain edge enhancement,<wbr/> respectively.<wbr/>
9267 The camera device may adjust its internal edge enhancement parameters for best
9268 image quality based on the <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a>,<wbr/> if it is set.<wbr/></p>
9269             </td>
9270           </tr>
9271
9272           <tr class="entries_header">
9273             <th class="th_details" colspan="5">HAL Implementation Details</th>
9274           </tr>
9275           <tr class="entry_cont">
9276             <td class="entry_details" colspan="5">
9277               <p>For YUV_<wbr/>REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> to
9278 adjust the internal edge enhancement reduction parameters appropriately to get the best
9279 quality images.<wbr/></p>
9280             </td>
9281           </tr>
9282
9283           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9284            <!-- end of entry -->
9285
9286
9287           <tr class="entry" id="controls_android.edge.strength">
9288             <td class="entry_name
9289              " rowspan="1">
9290               android.<wbr/>edge.<wbr/>strength
9291             </td>
9292             <td class="entry_type">
9293                 <span class="entry_type_name">byte</span>
9294
9295               <span class="entry_type_visibility"> [system]</span>
9296
9297
9298
9299
9300
9301
9302             </td> <!-- entry_type -->
9303
9304             <td class="entry_description">
9305               <p>Control the amount of edge enhancement
9306 applied to the images</p>
9307             </td>
9308
9309             <td class="entry_units">
9310               1-10; 10 is maximum sharpening
9311             </td>
9312
9313             <td class="entry_range">
9314             </td>
9315
9316             <td class="entry_tags">
9317               <ul class="entry_tags">
9318                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9319               </ul>
9320             </td>
9321
9322           </tr>
9323
9324
9325           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9326            <!-- end of entry -->
9327
9328
9329
9330       <!-- end of kind -->
9331       </tbody>
9332       <tr><td colspan="6" class="kind">static</td></tr>
9333
9334       <thead class="entries_header">
9335         <tr>
9336           <th class="th_name">Property Name</th>
9337           <th class="th_type">Type</th>
9338           <th class="th_description">Description</th>
9339           <th class="th_units">Units</th>
9340           <th class="th_range">Range</th>
9341           <th class="th_tags">Tags</th>
9342         </tr>
9343       </thead>
9344
9345       <tbody>
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356           <tr class="entry" id="static_android.edge.availableEdgeModes">
9357             <td class="entry_name
9358              " rowspan="5">
9359               android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes
9360             </td>
9361             <td class="entry_type">
9362                 <span class="entry_type_name">byte</span>
9363                 <span class="entry_type_container">x</span>
9364
9365                 <span class="entry_type_array">
9366                   n
9367                 </span>
9368               <span class="entry_type_visibility"> [public as enumList]</span>
9369
9370
9371               <span class="entry_type_hwlevel">[full] </span>
9372
9373
9374                 <div class="entry_type_notes">list of enums</div>
9375
9376
9377             </td> <!-- entry_type -->
9378
9379             <td class="entry_description">
9380               <p>List of edge enhancement modes for <a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a> that are supported by this camera
9381 device.<wbr/></p>
9382             </td>
9383
9384             <td class="entry_units">
9385             </td>
9386
9387             <td class="entry_range">
9388               <p>Any value listed in <a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a></p>
9389             </td>
9390
9391             <td class="entry_tags">
9392               <ul class="entry_tags">
9393                   <li><a href="#tag_V1">V1</a></li>
9394                   <li><a href="#tag_REPROC">REPROC</a></li>
9395               </ul>
9396             </td>
9397
9398           </tr>
9399           <tr class="entries_header">
9400             <th class="th_details" colspan="5">Details</th>
9401           </tr>
9402           <tr class="entry_cont">
9403             <td class="entry_details" colspan="5">
9404               <p>Full-capability camera devices must always support OFF; camera devices that support
9405 YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING will list ZERO_<wbr/>SHUTTER_<wbr/>LAG; all devices will
9406 list FAST.<wbr/></p>
9407             </td>
9408           </tr>
9409
9410           <tr class="entries_header">
9411             <th class="th_details" colspan="5">HAL Implementation Details</th>
9412           </tr>
9413           <tr class="entry_cont">
9414             <td class="entry_details" colspan="5">
9415               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if edge enhancement control is available
9416 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
9417 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
9418 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
9419             </td>
9420           </tr>
9421
9422           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9423            <!-- end of entry -->
9424
9425
9426
9427       <!-- end of kind -->
9428       </tbody>
9429       <tr><td colspan="6" class="kind">dynamic</td></tr>
9430
9431       <thead class="entries_header">
9432         <tr>
9433           <th class="th_name">Property Name</th>
9434           <th class="th_type">Type</th>
9435           <th class="th_description">Description</th>
9436           <th class="th_units">Units</th>
9437           <th class="th_range">Range</th>
9438           <th class="th_tags">Tags</th>
9439         </tr>
9440       </thead>
9441
9442       <tbody>
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453           <tr class="entry" id="dynamic_android.edge.mode">
9454             <td class="entry_name
9455              " rowspan="5">
9456               android.<wbr/>edge.<wbr/>mode
9457             </td>
9458             <td class="entry_type">
9459                 <span class="entry_type_name entry_type_name_enum">byte</span>
9460
9461               <span class="entry_type_visibility"> [public]</span>
9462
9463
9464               <span class="entry_type_hwlevel">[full] </span>
9465
9466
9467
9468                 <ul class="entry_type_enum">
9469                   <li>
9470                     <span class="entry_type_enum_name">OFF</span>
9471                     <span class="entry_type_enum_notes"><p>No edge enhancement is applied.<wbr/></p></span>
9472                   </li>
9473                   <li>
9474                     <span class="entry_type_enum_name">FAST</span>
9475                     <span class="entry_type_enum_notes"><p>Apply edge enhancement at a quality level that does not slow down frame rate
9476 relative to sensor output.<wbr/> It may be the same as OFF if edge enhancement will
9477 slow down frame rate relative to sensor.<wbr/></p></span>
9478                   </li>
9479                   <li>
9480                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
9481                     <span class="entry_type_enum_notes"><p>Apply high-quality edge enhancement,<wbr/> at a cost of possibly reduced output frame rate.<wbr/></p></span>
9482                   </li>
9483                   <li>
9484                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
9485                     <span class="entry_type_enum_optional">[optional]</span>
9486                     <span class="entry_type_enum_notes"><p>Edge enhancement is applied at different levels for different output streams,<wbr/>
9487 based on resolution.<wbr/> Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>) or below have
9488 edge enhancement applied,<wbr/> while higher-resolution streams have no edge enhancement
9489 applied.<wbr/> The level of edge enhancement for low-resolution streams is tuned so that
9490 frame rate is not impacted,<wbr/> and the quality is equal to or better than FAST (since it
9491 is only applied to lower-resolution outputs,<wbr/> quality may improve from FAST).<wbr/></p>
9492 <p>This mode is intended to be used by applications operating in a zero-shutter-lag mode
9493 with YUV or PRIVATE reprocessing,<wbr/> where the application continuously captures
9494 high-resolution intermediate buffers into a circular buffer,<wbr/> from which a final image is
9495 produced via reprocessing when a user takes a picture.<wbr/>  For such a use case,<wbr/> the
9496 high-resolution buffers must not have edge enhancement applied to maximize efficiency of
9497 preview and to avoid double-applying enhancement when reprocessed,<wbr/> while low-resolution
9498 buffers (used for recording or preview,<wbr/> generally) need edge enhancement applied for
9499 reasonable preview quality.<wbr/></p>
9500 <p>This mode is guaranteed to be supported by devices that support either the
9501 YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING capabilities
9502 (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> lists either of those capabilities) and it will
9503 be the default mode for CAMERA3_<wbr/>TEMPLATE_<wbr/>ZERO_<wbr/>SHUTTER_<wbr/>LAG template.<wbr/></p></span>
9504                   </li>
9505                 </ul>
9506
9507             </td> <!-- entry_type -->
9508
9509             <td class="entry_description">
9510               <p>Operation mode for edge
9511 enhancement.<wbr/></p>
9512             </td>
9513
9514             <td class="entry_units">
9515             </td>
9516
9517             <td class="entry_range">
9518               <p><a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a></p>
9519             </td>
9520
9521             <td class="entry_tags">
9522               <ul class="entry_tags">
9523                   <li><a href="#tag_V1">V1</a></li>
9524                   <li><a href="#tag_REPROC">REPROC</a></li>
9525               </ul>
9526             </td>
9527
9528           </tr>
9529           <tr class="entries_header">
9530             <th class="th_details" colspan="5">Details</th>
9531           </tr>
9532           <tr class="entry_cont">
9533             <td class="entry_details" colspan="5">
9534               <p>Edge enhancement improves sharpness and details in the captured image.<wbr/> OFF means
9535 no enhancement will be applied by the camera device.<wbr/></p>
9536 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined enhancement
9537 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the
9538 camera device will use the highest-quality enhancement algorithms,<wbr/>
9539 even if it slows down capture rate.<wbr/> FAST means the camera device will
9540 not slow down capture rate when applying edge enhancement.<wbr/> FAST may be the same as OFF if
9541 edge enhancement will slow down capture rate.<wbr/> Every output stream will have a similar
9542 amount of enhancement applied.<wbr/></p>
9543 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG is meant to be used by applications that maintain a continuous circular
9544 buffer of high-resolution images during preview and reprocess image(s) from that buffer
9545 into a final capture when triggered by the user.<wbr/> In this mode,<wbr/> the camera device applies
9546 edge enhancement to low-resolution streams (below maximum recording resolution) to
9547 maximize preview quality,<wbr/> but does not apply edge enhancement to high-resolution streams,<wbr/>
9548 since those will be reprocessed later if necessary.<wbr/></p>
9549 <p>For YUV_<wbr/>REPROCESSING,<wbr/> these FAST/<wbr/>HIGH_<wbr/>QUALITY modes both mean that the camera
9550 device will apply FAST/<wbr/>HIGH_<wbr/>QUALITY YUV-domain edge enhancement,<wbr/> respectively.<wbr/>
9551 The camera device may adjust its internal edge enhancement parameters for best
9552 image quality based on the <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a>,<wbr/> if it is set.<wbr/></p>
9553             </td>
9554           </tr>
9555
9556           <tr class="entries_header">
9557             <th class="th_details" colspan="5">HAL Implementation Details</th>
9558           </tr>
9559           <tr class="entry_cont">
9560             <td class="entry_details" colspan="5">
9561               <p>For YUV_<wbr/>REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> to
9562 adjust the internal edge enhancement reduction parameters appropriately to get the best
9563 quality images.<wbr/></p>
9564             </td>
9565           </tr>
9566
9567           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9568            <!-- end of entry -->
9569
9570
9571
9572       <!-- end of kind -->
9573       </tbody>
9574
9575   <!-- end of section -->
9576   <tr><td colspan="6" id="section_flash" class="section">flash</td></tr>
9577
9578
9579       <tr><td colspan="6" class="kind">controls</td></tr>
9580
9581       <thead class="entries_header">
9582         <tr>
9583           <th class="th_name">Property Name</th>
9584           <th class="th_type">Type</th>
9585           <th class="th_description">Description</th>
9586           <th class="th_units">Units</th>
9587           <th class="th_range">Range</th>
9588           <th class="th_tags">Tags</th>
9589         </tr>
9590       </thead>
9591
9592       <tbody>
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603           <tr class="entry" id="controls_android.flash.firingPower">
9604             <td class="entry_name
9605              " rowspan="3">
9606               android.<wbr/>flash.<wbr/>firing<wbr/>Power
9607             </td>
9608             <td class="entry_type">
9609                 <span class="entry_type_name">byte</span>
9610
9611               <span class="entry_type_visibility"> [system]</span>
9612
9613
9614
9615
9616
9617
9618             </td> <!-- entry_type -->
9619
9620             <td class="entry_description">
9621               <p>Power for flash firing/<wbr/>torch</p>
9622             </td>
9623
9624             <td class="entry_units">
9625               10 is max power; 0 is no flash.<wbr/> Linear
9626             </td>
9627
9628             <td class="entry_range">
9629               <p>0 - 10</p>
9630             </td>
9631
9632             <td class="entry_tags">
9633               <ul class="entry_tags">
9634                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9635               </ul>
9636             </td>
9637
9638           </tr>
9639           <tr class="entries_header">
9640             <th class="th_details" colspan="5">Details</th>
9641           </tr>
9642           <tr class="entry_cont">
9643             <td class="entry_details" colspan="5">
9644               <p>Power for snapshot may use a different scale than
9645 for torch mode.<wbr/> Only one entry for torch mode will be
9646 used</p>
9647             </td>
9648           </tr>
9649
9650
9651           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9652            <!-- end of entry -->
9653
9654
9655           <tr class="entry" id="controls_android.flash.firingTime">
9656             <td class="entry_name
9657              " rowspan="3">
9658               android.<wbr/>flash.<wbr/>firing<wbr/>Time
9659             </td>
9660             <td class="entry_type">
9661                 <span class="entry_type_name">int64</span>
9662
9663               <span class="entry_type_visibility"> [system]</span>
9664
9665
9666
9667
9668
9669
9670             </td> <!-- entry_type -->
9671
9672             <td class="entry_description">
9673               <p>Firing time of flash relative to start of
9674 exposure</p>
9675             </td>
9676
9677             <td class="entry_units">
9678               nanoseconds
9679             </td>
9680
9681             <td class="entry_range">
9682               <p>0-(exposure time-flash duration)</p>
9683             </td>
9684
9685             <td class="entry_tags">
9686               <ul class="entry_tags">
9687                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9688               </ul>
9689             </td>
9690
9691           </tr>
9692           <tr class="entries_header">
9693             <th class="th_details" colspan="5">Details</th>
9694           </tr>
9695           <tr class="entry_cont">
9696             <td class="entry_details" colspan="5">
9697               <p>Clamped to (0,<wbr/> exposure time - flash
9698 duration).<wbr/></p>
9699             </td>
9700           </tr>
9701
9702
9703           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9704            <!-- end of entry -->
9705
9706
9707           <tr class="entry" id="controls_android.flash.mode">
9708             <td class="entry_name
9709              " rowspan="3">
9710               android.<wbr/>flash.<wbr/>mode
9711             </td>
9712             <td class="entry_type">
9713                 <span class="entry_type_name entry_type_name_enum">byte</span>
9714
9715               <span class="entry_type_visibility"> [public]</span>
9716
9717
9718               <span class="entry_type_hwlevel">[legacy] </span>
9719
9720
9721
9722                 <ul class="entry_type_enum">
9723                   <li>
9724                     <span class="entry_type_enum_name">OFF</span>
9725                     <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
9726                   </li>
9727                   <li>
9728                     <span class="entry_type_enum_name">SINGLE</span>
9729                     <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
9730 for this capture.<wbr/></p></span>
9731                   </li>
9732                   <li>
9733                     <span class="entry_type_enum_name">TORCH</span>
9734                     <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
9735                   </li>
9736                 </ul>
9737
9738             </td> <!-- entry_type -->
9739
9740             <td class="entry_description">
9741               <p>The desired mode for for the camera device's flash control.<wbr/></p>
9742             </td>
9743
9744             <td class="entry_units">
9745             </td>
9746
9747             <td class="entry_range">
9748             </td>
9749
9750             <td class="entry_tags">
9751               <ul class="entry_tags">
9752                   <li><a href="#tag_BC">BC</a></li>
9753               </ul>
9754             </td>
9755
9756           </tr>
9757           <tr class="entries_header">
9758             <th class="th_details" colspan="5">Details</th>
9759           </tr>
9760           <tr class="entry_cont">
9761             <td class="entry_details" colspan="5">
9762               <p>This control is only effective when flash unit is available
9763 (<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
9764 <p>When this control is used,<wbr/> the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> must be set to ON or OFF.<wbr/>
9765 Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
9766 ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
9767 <p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
9768 <p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
9769 device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
9770 control should be used along with auto-exposure (AE) precapture metering sequence
9771 (<a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>),<wbr/> otherwise,<wbr/> the image may be incorrectly exposed.<wbr/></p>
9772 <p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
9773 for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
9774 <p>The flash status will be reported by <a href="#dynamic_android.flash.state">android.<wbr/>flash.<wbr/>state</a> in the capture result metadata.<wbr/></p>
9775             </td>
9776           </tr>
9777
9778
9779           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9780            <!-- end of entry -->
9781
9782
9783
9784       <!-- end of kind -->
9785       </tbody>
9786       <tr><td colspan="6" class="kind">static</td></tr>
9787
9788       <thead class="entries_header">
9789         <tr>
9790           <th class="th_name">Property Name</th>
9791           <th class="th_type">Type</th>
9792           <th class="th_description">Description</th>
9793           <th class="th_units">Units</th>
9794           <th class="th_range">Range</th>
9795           <th class="th_tags">Tags</th>
9796         </tr>
9797       </thead>
9798
9799       <tbody>
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812           <tr class="entry" id="static_android.flash.info.available">
9813             <td class="entry_name
9814              " rowspan="3">
9815               android.<wbr/>flash.<wbr/>info.<wbr/>available
9816             </td>
9817             <td class="entry_type">
9818                 <span class="entry_type_name entry_type_name_enum">byte</span>
9819
9820               <span class="entry_type_visibility"> [public as boolean]</span>
9821
9822
9823               <span class="entry_type_hwlevel">[legacy] </span>
9824
9825
9826
9827                 <ul class="entry_type_enum">
9828                   <li>
9829                     <span class="entry_type_enum_name">FALSE</span>
9830                   </li>
9831                   <li>
9832                     <span class="entry_type_enum_name">TRUE</span>
9833                   </li>
9834                 </ul>
9835
9836             </td> <!-- entry_type -->
9837
9838             <td class="entry_description">
9839               <p>Whether this camera device has a
9840 flash unit.<wbr/></p>
9841             </td>
9842
9843             <td class="entry_units">
9844             </td>
9845
9846             <td class="entry_range">
9847             </td>
9848
9849             <td class="entry_tags">
9850               <ul class="entry_tags">
9851                   <li><a href="#tag_BC">BC</a></li>
9852               </ul>
9853             </td>
9854
9855           </tr>
9856           <tr class="entries_header">
9857             <th class="th_details" colspan="5">Details</th>
9858           </tr>
9859           <tr class="entry_cont">
9860             <td class="entry_details" colspan="5">
9861               <p>Will be <code>false</code> if no flash is available.<wbr/></p>
9862 <p>If there is no flash unit,<wbr/> none of the flash controls do
9863 anything.<wbr/></p>
9864             </td>
9865           </tr>
9866
9867
9868           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9869            <!-- end of entry -->
9870
9871
9872           <tr class="entry" id="static_android.flash.info.chargeDuration">
9873             <td class="entry_name
9874              " rowspan="3">
9875               android.<wbr/>flash.<wbr/>info.<wbr/>charge<wbr/>Duration
9876             </td>
9877             <td class="entry_type">
9878                 <span class="entry_type_name">int64</span>
9879
9880               <span class="entry_type_visibility"> [system]</span>
9881
9882
9883
9884
9885
9886
9887             </td> <!-- entry_type -->
9888
9889             <td class="entry_description">
9890               <p>Time taken before flash can fire
9891 again</p>
9892             </td>
9893
9894             <td class="entry_units">
9895               nanoseconds
9896             </td>
9897
9898             <td class="entry_range">
9899               <p>0-1e9</p>
9900             </td>
9901
9902             <td class="entry_tags">
9903               <ul class="entry_tags">
9904                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9905               </ul>
9906             </td>
9907
9908           </tr>
9909           <tr class="entries_header">
9910             <th class="th_details" colspan="5">Details</th>
9911           </tr>
9912           <tr class="entry_cont">
9913             <td class="entry_details" colspan="5">
9914               <p>1 second too long/<wbr/>too short for recharge? Should
9915 this be power-dependent?</p>
9916             </td>
9917           </tr>
9918
9919
9920           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9921            <!-- end of entry -->
9922
9923
9924
9925
9926
9927           <tr class="entry" id="static_android.flash.colorTemperature">
9928             <td class="entry_name
9929              " rowspan="1">
9930               android.<wbr/>flash.<wbr/>color<wbr/>Temperature
9931             </td>
9932             <td class="entry_type">
9933                 <span class="entry_type_name">byte</span>
9934
9935               <span class="entry_type_visibility"> [system]</span>
9936
9937
9938
9939
9940
9941
9942             </td> <!-- entry_type -->
9943
9944             <td class="entry_description">
9945               <p>The x,<wbr/>y whitepoint of the
9946 flash</p>
9947             </td>
9948
9949             <td class="entry_units">
9950               pair of floats
9951             </td>
9952
9953             <td class="entry_range">
9954               <p>0-1 for both</p>
9955             </td>
9956
9957             <td class="entry_tags">
9958               <ul class="entry_tags">
9959                   <li><a href="#tag_FUTURE">FUTURE</a></li>
9960               </ul>
9961             </td>
9962
9963           </tr>
9964
9965
9966           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
9967            <!-- end of entry -->
9968
9969
9970           <tr class="entry" id="static_android.flash.maxEnergy">
9971             <td class="entry_name
9972              " rowspan="1">
9973               android.<wbr/>flash.<wbr/>max<wbr/>Energy
9974             </td>
9975             <td class="entry_type">
9976                 <span class="entry_type_name">byte</span>
9977
9978               <span class="entry_type_visibility"> [system]</span>
9979
9980
9981
9982
9983
9984
9985             </td> <!-- entry_type -->
9986
9987             <td class="entry_description">
9988               <p>Max energy output of the flash for a full
9989 power single flash</p>
9990             </td>
9991
9992             <td class="entry_units">
9993               lumen-seconds
9994             </td>
9995
9996             <td class="entry_range">
9997               <p>&gt;= 0</p>
9998             </td>
9999
10000             <td class="entry_tags">
10001               <ul class="entry_tags">
10002                   <li><a href="#tag_FUTURE">FUTURE</a></li>
10003               </ul>
10004             </td>
10005
10006           </tr>
10007
10008
10009           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10010            <!-- end of entry -->
10011
10012
10013
10014       <!-- end of kind -->
10015       </tbody>
10016       <tr><td colspan="6" class="kind">dynamic</td></tr>
10017
10018       <thead class="entries_header">
10019         <tr>
10020           <th class="th_name">Property Name</th>
10021           <th class="th_type">Type</th>
10022           <th class="th_description">Description</th>
10023           <th class="th_units">Units</th>
10024           <th class="th_range">Range</th>
10025           <th class="th_tags">Tags</th>
10026         </tr>
10027       </thead>
10028
10029       <tbody>
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040           <tr class="entry" id="dynamic_android.flash.firingPower">
10041             <td class="entry_name
10042              " rowspan="3">
10043               android.<wbr/>flash.<wbr/>firing<wbr/>Power
10044             </td>
10045             <td class="entry_type">
10046                 <span class="entry_type_name">byte</span>
10047
10048               <span class="entry_type_visibility"> [system]</span>
10049
10050
10051
10052
10053
10054
10055             </td> <!-- entry_type -->
10056
10057             <td class="entry_description">
10058               <p>Power for flash firing/<wbr/>torch</p>
10059             </td>
10060
10061             <td class="entry_units">
10062               10 is max power; 0 is no flash.<wbr/> Linear
10063             </td>
10064
10065             <td class="entry_range">
10066               <p>0 - 10</p>
10067             </td>
10068
10069             <td class="entry_tags">
10070               <ul class="entry_tags">
10071                   <li><a href="#tag_FUTURE">FUTURE</a></li>
10072               </ul>
10073             </td>
10074
10075           </tr>
10076           <tr class="entries_header">
10077             <th class="th_details" colspan="5">Details</th>
10078           </tr>
10079           <tr class="entry_cont">
10080             <td class="entry_details" colspan="5">
10081               <p>Power for snapshot may use a different scale than
10082 for torch mode.<wbr/> Only one entry for torch mode will be
10083 used</p>
10084             </td>
10085           </tr>
10086
10087
10088           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10089            <!-- end of entry -->
10090
10091
10092           <tr class="entry" id="dynamic_android.flash.firingTime">
10093             <td class="entry_name
10094              " rowspan="3">
10095               android.<wbr/>flash.<wbr/>firing<wbr/>Time
10096             </td>
10097             <td class="entry_type">
10098                 <span class="entry_type_name">int64</span>
10099
10100               <span class="entry_type_visibility"> [system]</span>
10101
10102
10103
10104
10105
10106
10107             </td> <!-- entry_type -->
10108
10109             <td class="entry_description">
10110               <p>Firing time of flash relative to start of
10111 exposure</p>
10112             </td>
10113
10114             <td class="entry_units">
10115               nanoseconds
10116             </td>
10117
10118             <td class="entry_range">
10119               <p>0-(exposure time-flash duration)</p>
10120             </td>
10121
10122             <td class="entry_tags">
10123               <ul class="entry_tags">
10124                   <li><a href="#tag_FUTURE">FUTURE</a></li>
10125               </ul>
10126             </td>
10127
10128           </tr>
10129           <tr class="entries_header">
10130             <th class="th_details" colspan="5">Details</th>
10131           </tr>
10132           <tr class="entry_cont">
10133             <td class="entry_details" colspan="5">
10134               <p>Clamped to (0,<wbr/> exposure time - flash
10135 duration).<wbr/></p>
10136             </td>
10137           </tr>
10138
10139
10140           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10141            <!-- end of entry -->
10142
10143
10144           <tr class="entry" id="dynamic_android.flash.mode">
10145             <td class="entry_name
10146              " rowspan="3">
10147               android.<wbr/>flash.<wbr/>mode
10148             </td>
10149             <td class="entry_type">
10150                 <span class="entry_type_name entry_type_name_enum">byte</span>
10151
10152               <span class="entry_type_visibility"> [public]</span>
10153
10154
10155               <span class="entry_type_hwlevel">[legacy] </span>
10156
10157
10158
10159                 <ul class="entry_type_enum">
10160                   <li>
10161                     <span class="entry_type_enum_name">OFF</span>
10162                     <span class="entry_type_enum_notes"><p>Do not fire the flash for this capture.<wbr/></p></span>
10163                   </li>
10164                   <li>
10165                     <span class="entry_type_enum_name">SINGLE</span>
10166                     <span class="entry_type_enum_notes"><p>If the flash is available and charged,<wbr/> fire flash
10167 for this capture.<wbr/></p></span>
10168                   </li>
10169                   <li>
10170                     <span class="entry_type_enum_name">TORCH</span>
10171                     <span class="entry_type_enum_notes"><p>Transition flash to continuously on.<wbr/></p></span>
10172                   </li>
10173                 </ul>
10174
10175             </td> <!-- entry_type -->
10176
10177             <td class="entry_description">
10178               <p>The desired mode for for the camera device's flash control.<wbr/></p>
10179             </td>
10180
10181             <td class="entry_units">
10182             </td>
10183
10184             <td class="entry_range">
10185             </td>
10186
10187             <td class="entry_tags">
10188               <ul class="entry_tags">
10189                   <li><a href="#tag_BC">BC</a></li>
10190               </ul>
10191             </td>
10192
10193           </tr>
10194           <tr class="entries_header">
10195             <th class="th_details" colspan="5">Details</th>
10196           </tr>
10197           <tr class="entry_cont">
10198             <td class="entry_details" colspan="5">
10199               <p>This control is only effective when flash unit is available
10200 (<code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == true</code>).<wbr/></p>
10201 <p>When this control is used,<wbr/> the <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> must be set to ON or OFF.<wbr/>
10202 Otherwise,<wbr/> the camera device auto-exposure related flash control (ON_<wbr/>AUTO_<wbr/>FLASH,<wbr/>
10203 ON_<wbr/>ALWAYS_<wbr/>FLASH,<wbr/> or ON_<wbr/>AUTO_<wbr/>FLASH_<wbr/>REDEYE) will override this control.<wbr/></p>
10204 <p>When set to OFF,<wbr/> the camera device will not fire flash for this capture.<wbr/></p>
10205 <p>When set to SINGLE,<wbr/> the camera device will fire flash regardless of the camera
10206 device's auto-exposure routine's result.<wbr/> When used in still capture case,<wbr/> this
10207 control should be used along with auto-exposure (AE) precapture metering sequence
10208 (<a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>),<wbr/> otherwise,<wbr/> the image may be incorrectly exposed.<wbr/></p>
10209 <p>When set to TORCH,<wbr/> the flash will be on continuously.<wbr/> This mode can be used
10210 for use cases such as preview,<wbr/> auto-focus assist,<wbr/> still capture,<wbr/> or video recording.<wbr/></p>
10211 <p>The flash status will be reported by <a href="#dynamic_android.flash.state">android.<wbr/>flash.<wbr/>state</a> in the capture result metadata.<wbr/></p>
10212             </td>
10213           </tr>
10214
10215
10216           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10217            <!-- end of entry -->
10218
10219
10220           <tr class="entry" id="dynamic_android.flash.state">
10221             <td class="entry_name
10222              " rowspan="3">
10223               android.<wbr/>flash.<wbr/>state
10224             </td>
10225             <td class="entry_type">
10226                 <span class="entry_type_name entry_type_name_enum">byte</span>
10227
10228               <span class="entry_type_visibility"> [public]</span>
10229
10230
10231               <span class="entry_type_hwlevel">[limited] </span>
10232
10233
10234
10235                 <ul class="entry_type_enum">
10236                   <li>
10237                     <span class="entry_type_enum_name">UNAVAILABLE</span>
10238                     <span class="entry_type_enum_notes"><p>No flash on camera.<wbr/></p></span>
10239                   </li>
10240                   <li>
10241                     <span class="entry_type_enum_name">CHARGING</span>
10242                     <span class="entry_type_enum_notes"><p>Flash is charging and cannot be fired.<wbr/></p></span>
10243                   </li>
10244                   <li>
10245                     <span class="entry_type_enum_name">READY</span>
10246                     <span class="entry_type_enum_notes"><p>Flash is ready to fire.<wbr/></p></span>
10247                   </li>
10248                   <li>
10249                     <span class="entry_type_enum_name">FIRED</span>
10250                     <span class="entry_type_enum_notes"><p>Flash fired for this capture.<wbr/></p></span>
10251                   </li>
10252                   <li>
10253                     <span class="entry_type_enum_name">PARTIAL</span>
10254                     <span class="entry_type_enum_notes"><p>Flash partially illuminated this frame.<wbr/></p>
10255 <p>This is usually due to the next or previous frame having
10256 the flash fire,<wbr/> and the flash spilling into this capture
10257 due to hardware limitations.<wbr/></p></span>
10258                   </li>
10259                 </ul>
10260
10261             </td> <!-- entry_type -->
10262
10263             <td class="entry_description">
10264               <p>Current state of the flash
10265 unit.<wbr/></p>
10266             </td>
10267
10268             <td class="entry_units">
10269             </td>
10270
10271             <td class="entry_range">
10272             </td>
10273
10274             <td class="entry_tags">
10275             </td>
10276
10277           </tr>
10278           <tr class="entries_header">
10279             <th class="th_details" colspan="5">Details</th>
10280           </tr>
10281           <tr class="entry_cont">
10282             <td class="entry_details" colspan="5">
10283               <p>When the camera device doesn't have flash unit
10284 (i.<wbr/>e.<wbr/> <code><a href="#static_android.flash.info.available">android.<wbr/>flash.<wbr/>info.<wbr/>available</a> == false</code>),<wbr/> this state will always be UNAVAILABLE.<wbr/>
10285 Other states indicate the current flash status.<wbr/></p>
10286 <p>In certain conditions,<wbr/> this will be available on LEGACY devices:</p>
10287 <ul>
10288 <li>Flash-less cameras always return UNAVAILABLE.<wbr/></li>
10289 <li>Using <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>==</code> ON_<wbr/>ALWAYS_<wbr/>FLASH
10290    will always return FIRED.<wbr/></li>
10291 <li>Using <a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> <code>==</code> TORCH
10292    will always return FIRED.<wbr/></li>
10293 </ul>
10294 <p>In all other conditions the state will not be available on
10295 LEGACY devices (i.<wbr/>e.<wbr/> it will be <code>null</code>).<wbr/></p>
10296             </td>
10297           </tr>
10298
10299
10300           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10301            <!-- end of entry -->
10302
10303
10304
10305       <!-- end of kind -->
10306       </tbody>
10307
10308   <!-- end of section -->
10309   <tr><td colspan="6" id="section_hotPixel" class="section">hotPixel</td></tr>
10310
10311
10312       <tr><td colspan="6" class="kind">controls</td></tr>
10313
10314       <thead class="entries_header">
10315         <tr>
10316           <th class="th_name">Property Name</th>
10317           <th class="th_type">Type</th>
10318           <th class="th_description">Description</th>
10319           <th class="th_units">Units</th>
10320           <th class="th_range">Range</th>
10321           <th class="th_tags">Tags</th>
10322         </tr>
10323       </thead>
10324
10325       <tbody>
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336           <tr class="entry" id="controls_android.hotPixel.mode">
10337             <td class="entry_name
10338              " rowspan="3">
10339               android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
10340             </td>
10341             <td class="entry_type">
10342                 <span class="entry_type_name entry_type_name_enum">byte</span>
10343
10344               <span class="entry_type_visibility"> [public]</span>
10345
10346
10347
10348
10349
10350                 <ul class="entry_type_enum">
10351                   <li>
10352                     <span class="entry_type_enum_name">OFF</span>
10353                     <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
10354 <p>The frame rate must not be reduced relative to sensor raw output
10355 for this option.<wbr/></p>
10356 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10357                   </li>
10358                   <li>
10359                     <span class="entry_type_enum_name">FAST</span>
10360                     <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
10361 rate relative to sensor raw output.<wbr/></p>
10362 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10363                   </li>
10364                   <li>
10365                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
10366                     <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
10367 of possibly reduced frame rate relative to sensor raw output.<wbr/></p>
10368 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10369                   </li>
10370                 </ul>
10371
10372             </td> <!-- entry_type -->
10373
10374             <td class="entry_description">
10375               <p>Operational mode for hot pixel correction.<wbr/></p>
10376             </td>
10377
10378             <td class="entry_units">
10379             </td>
10380
10381             <td class="entry_range">
10382               <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
10383             </td>
10384
10385             <td class="entry_tags">
10386               <ul class="entry_tags">
10387                   <li><a href="#tag_V1">V1</a></li>
10388                   <li><a href="#tag_RAW">RAW</a></li>
10389               </ul>
10390             </td>
10391
10392           </tr>
10393           <tr class="entries_header">
10394             <th class="th_details" colspan="5">Details</th>
10395           </tr>
10396           <tr class="entry_cont">
10397             <td class="entry_details" colspan="5">
10398               <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
10399 that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
10400 are stuck at an arbitrary value or are oversensitive).<wbr/></p>
10401             </td>
10402           </tr>
10403
10404
10405           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10406            <!-- end of entry -->
10407
10408
10409
10410       <!-- end of kind -->
10411       </tbody>
10412       <tr><td colspan="6" class="kind">static</td></tr>
10413
10414       <thead class="entries_header">
10415         <tr>
10416           <th class="th_name">Property Name</th>
10417           <th class="th_type">Type</th>
10418           <th class="th_description">Description</th>
10419           <th class="th_units">Units</th>
10420           <th class="th_range">Range</th>
10421           <th class="th_tags">Tags</th>
10422         </tr>
10423       </thead>
10424
10425       <tbody>
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436           <tr class="entry" id="static_android.hotPixel.availableHotPixelModes">
10437             <td class="entry_name
10438              " rowspan="5">
10439               android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes
10440             </td>
10441             <td class="entry_type">
10442                 <span class="entry_type_name">byte</span>
10443                 <span class="entry_type_container">x</span>
10444
10445                 <span class="entry_type_array">
10446                   n
10447                 </span>
10448               <span class="entry_type_visibility"> [public as enumList]</span>
10449
10450
10451
10452
10453                 <div class="entry_type_notes">list of enums</div>
10454
10455
10456             </td> <!-- entry_type -->
10457
10458             <td class="entry_description">
10459               <p>List of hot pixel correction modes for <a href="#controls_android.hotPixel.mode">android.<wbr/>hot<wbr/>Pixel.<wbr/>mode</a> that are supported by this
10460 camera device.<wbr/></p>
10461             </td>
10462
10463             <td class="entry_units">
10464             </td>
10465
10466             <td class="entry_range">
10467               <p>Any value listed in <a href="#controls_android.hotPixel.mode">android.<wbr/>hot<wbr/>Pixel.<wbr/>mode</a></p>
10468             </td>
10469
10470             <td class="entry_tags">
10471               <ul class="entry_tags">
10472                   <li><a href="#tag_V1">V1</a></li>
10473                   <li><a href="#tag_RAW">RAW</a></li>
10474               </ul>
10475             </td>
10476
10477           </tr>
10478           <tr class="entries_header">
10479             <th class="th_details" colspan="5">Details</th>
10480           </tr>
10481           <tr class="entry_cont">
10482             <td class="entry_details" colspan="5">
10483               <p>FULL mode camera devices will always support FAST.<wbr/></p>
10484             </td>
10485           </tr>
10486
10487           <tr class="entries_header">
10488             <th class="th_details" colspan="5">HAL Implementation Details</th>
10489           </tr>
10490           <tr class="entry_cont">
10491             <td class="entry_details" colspan="5">
10492               <p>To avoid performance issues,<wbr/> there will be significantly fewer hot
10493 pixels than actual pixels on the camera sensor.<wbr/>
10494 HAL must support both FAST and HIGH_<wbr/>QUALITY if hot pixel correction control is available
10495 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
10496 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
10497 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
10498             </td>
10499           </tr>
10500
10501           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10502            <!-- end of entry -->
10503
10504
10505
10506       <!-- end of kind -->
10507       </tbody>
10508       <tr><td colspan="6" class="kind">dynamic</td></tr>
10509
10510       <thead class="entries_header">
10511         <tr>
10512           <th class="th_name">Property Name</th>
10513           <th class="th_type">Type</th>
10514           <th class="th_description">Description</th>
10515           <th class="th_units">Units</th>
10516           <th class="th_range">Range</th>
10517           <th class="th_tags">Tags</th>
10518         </tr>
10519       </thead>
10520
10521       <tbody>
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532           <tr class="entry" id="dynamic_android.hotPixel.mode">
10533             <td class="entry_name
10534              " rowspan="3">
10535               android.<wbr/>hot<wbr/>Pixel.<wbr/>mode
10536             </td>
10537             <td class="entry_type">
10538                 <span class="entry_type_name entry_type_name_enum">byte</span>
10539
10540               <span class="entry_type_visibility"> [public]</span>
10541
10542
10543
10544
10545
10546                 <ul class="entry_type_enum">
10547                   <li>
10548                     <span class="entry_type_enum_name">OFF</span>
10549                     <span class="entry_type_enum_notes"><p>No hot pixel correction is applied.<wbr/></p>
10550 <p>The frame rate must not be reduced relative to sensor raw output
10551 for this option.<wbr/></p>
10552 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10553                   </li>
10554                   <li>
10555                     <span class="entry_type_enum_name">FAST</span>
10556                     <span class="entry_type_enum_notes"><p>Hot pixel correction is applied,<wbr/> without reducing frame
10557 rate relative to sensor raw output.<wbr/></p>
10558 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10559                   </li>
10560                   <li>
10561                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
10562                     <span class="entry_type_enum_notes"><p>High-quality hot pixel correction is applied,<wbr/> at a cost
10563 of possibly reduced frame rate relative to sensor raw output.<wbr/></p>
10564 <p>The hotpixel map may be returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/></p></span>
10565                   </li>
10566                 </ul>
10567
10568             </td> <!-- entry_type -->
10569
10570             <td class="entry_description">
10571               <p>Operational mode for hot pixel correction.<wbr/></p>
10572             </td>
10573
10574             <td class="entry_units">
10575             </td>
10576
10577             <td class="entry_range">
10578               <p><a href="#static_android.hotPixel.availableHotPixelModes">android.<wbr/>hot<wbr/>Pixel.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Modes</a></p>
10579             </td>
10580
10581             <td class="entry_tags">
10582               <ul class="entry_tags">
10583                   <li><a href="#tag_V1">V1</a></li>
10584                   <li><a href="#tag_RAW">RAW</a></li>
10585               </ul>
10586             </td>
10587
10588           </tr>
10589           <tr class="entries_header">
10590             <th class="th_details" colspan="5">Details</th>
10591           </tr>
10592           <tr class="entry_cont">
10593             <td class="entry_details" colspan="5">
10594               <p>Hotpixel correction interpolates out,<wbr/> or otherwise removes,<wbr/> pixels
10595 that do not accurately measure the incoming light (i.<wbr/>e.<wbr/> pixels that
10596 are stuck at an arbitrary value or are oversensitive).<wbr/></p>
10597             </td>
10598           </tr>
10599
10600
10601           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10602            <!-- end of entry -->
10603
10604
10605
10606       <!-- end of kind -->
10607       </tbody>
10608
10609   <!-- end of section -->
10610   <tr><td colspan="6" id="section_jpeg" class="section">jpeg</td></tr>
10611
10612
10613       <tr><td colspan="6" class="kind">controls</td></tr>
10614
10615       <thead class="entries_header">
10616         <tr>
10617           <th class="th_name">Property Name</th>
10618           <th class="th_type">Type</th>
10619           <th class="th_description">Description</th>
10620           <th class="th_units">Units</th>
10621           <th class="th_range">Range</th>
10622           <th class="th_tags">Tags</th>
10623         </tr>
10624       </thead>
10625
10626       <tbody>
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637           <tr class="entry" id="controls_android.jpeg.gpsLocation">
10638             <td class="entry_name
10639              " rowspan="3">
10640               android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
10641             </td>
10642             <td class="entry_type">
10643                 <span class="entry_type_name">byte</span>
10644
10645               <span class="entry_type_visibility"> [java_public as location]</span>
10646
10647               <span class="entry_type_synthetic">[synthetic] </span>
10648
10649               <span class="entry_type_hwlevel">[legacy] </span>
10650
10651
10652
10653
10654             </td> <!-- entry_type -->
10655
10656             <td class="entry_description">
10657               <p>A location object to use when generating image GPS metadata.<wbr/></p>
10658             </td>
10659
10660             <td class="entry_units">
10661             </td>
10662
10663             <td class="entry_range">
10664             </td>
10665
10666             <td class="entry_tags">
10667             </td>
10668
10669           </tr>
10670           <tr class="entries_header">
10671             <th class="th_details" colspan="5">Details</th>
10672           </tr>
10673           <tr class="entry_cont">
10674             <td class="entry_details" colspan="5">
10675               <p>Setting a location object in a request will include the GPS coordinates of the location
10676 into any JPEG images captured based on the request.<wbr/> These coordinates can then be
10677 viewed by anyone who receives the JPEG image.<wbr/></p>
10678             </td>
10679           </tr>
10680
10681
10682           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10683            <!-- end of entry -->
10684
10685
10686           <tr class="entry" id="controls_android.jpeg.gpsCoordinates">
10687             <td class="entry_name
10688              " rowspan="1">
10689               android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
10690             </td>
10691             <td class="entry_type">
10692                 <span class="entry_type_name">double</span>
10693                 <span class="entry_type_container">x</span>
10694
10695                 <span class="entry_type_array">
10696                   3
10697                 </span>
10698               <span class="entry_type_visibility"> [ndk_public]</span>
10699
10700
10701               <span class="entry_type_hwlevel">[legacy] </span>
10702
10703
10704                 <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>
10705
10706
10707             </td> <!-- entry_type -->
10708
10709             <td class="entry_description">
10710               <p>GPS coordinates to include in output JPEG
10711 EXIF.<wbr/></p>
10712             </td>
10713
10714             <td class="entry_units">
10715             </td>
10716
10717             <td class="entry_range">
10718               <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
10719             </td>
10720
10721             <td class="entry_tags">
10722               <ul class="entry_tags">
10723                   <li><a href="#tag_BC">BC</a></li>
10724               </ul>
10725             </td>
10726
10727           </tr>
10728
10729
10730           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10731            <!-- end of entry -->
10732
10733
10734           <tr class="entry" id="controls_android.jpeg.gpsProcessingMethod">
10735             <td class="entry_name
10736              " rowspan="1">
10737               android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
10738             </td>
10739             <td class="entry_type">
10740                 <span class="entry_type_name">byte</span>
10741
10742               <span class="entry_type_visibility"> [ndk_public as string]</span>
10743
10744
10745               <span class="entry_type_hwlevel">[legacy] </span>
10746
10747
10748
10749
10750             </td> <!-- entry_type -->
10751
10752             <td class="entry_description">
10753               <p>32 characters describing GPS algorithm to
10754 include in EXIF.<wbr/></p>
10755             </td>
10756
10757             <td class="entry_units">
10758               UTF-8 null-terminated string
10759             </td>
10760
10761             <td class="entry_range">
10762             </td>
10763
10764             <td class="entry_tags">
10765               <ul class="entry_tags">
10766                   <li><a href="#tag_BC">BC</a></li>
10767               </ul>
10768             </td>
10769
10770           </tr>
10771
10772
10773           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10774            <!-- end of entry -->
10775
10776
10777           <tr class="entry" id="controls_android.jpeg.gpsTimestamp">
10778             <td class="entry_name
10779              " rowspan="1">
10780               android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
10781             </td>
10782             <td class="entry_type">
10783                 <span class="entry_type_name">int64</span>
10784
10785               <span class="entry_type_visibility"> [ndk_public]</span>
10786
10787
10788               <span class="entry_type_hwlevel">[legacy] </span>
10789
10790
10791
10792
10793             </td> <!-- entry_type -->
10794
10795             <td class="entry_description">
10796               <p>Time GPS fix was made to include in
10797 EXIF.<wbr/></p>
10798             </td>
10799
10800             <td class="entry_units">
10801               UTC in seconds since January 1,<wbr/> 1970
10802             </td>
10803
10804             <td class="entry_range">
10805             </td>
10806
10807             <td class="entry_tags">
10808               <ul class="entry_tags">
10809                   <li><a href="#tag_BC">BC</a></li>
10810               </ul>
10811             </td>
10812
10813           </tr>
10814
10815
10816           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10817            <!-- end of entry -->
10818
10819
10820           <tr class="entry" id="controls_android.jpeg.orientation">
10821             <td class="entry_name
10822              " rowspan="3">
10823               android.<wbr/>jpeg.<wbr/>orientation
10824             </td>
10825             <td class="entry_type">
10826                 <span class="entry_type_name">int32</span>
10827
10828               <span class="entry_type_visibility"> [public]</span>
10829
10830
10831               <span class="entry_type_hwlevel">[legacy] </span>
10832
10833
10834
10835
10836             </td> <!-- entry_type -->
10837
10838             <td class="entry_description">
10839               <p>The orientation for a JPEG image.<wbr/></p>
10840             </td>
10841
10842             <td class="entry_units">
10843               Degrees in multiples of 90
10844             </td>
10845
10846             <td class="entry_range">
10847               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
10848             </td>
10849
10850             <td class="entry_tags">
10851               <ul class="entry_tags">
10852                   <li><a href="#tag_BC">BC</a></li>
10853               </ul>
10854             </td>
10855
10856           </tr>
10857           <tr class="entries_header">
10858             <th class="th_details" colspan="5">Details</th>
10859           </tr>
10860           <tr class="entry_cont">
10861             <td class="entry_details" colspan="5">
10862               <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
10863 to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
10864 upright.<wbr/></p>
10865 <p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
10866 rotate the image data to match this orientation.<wbr/> When the image data is rotated,<wbr/>
10867 the thumbnail data will also be rotated.<wbr/></p>
10868 <p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
10869 by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
10870 <p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
10871 sample code may be used:</p>
10872 <pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
10873     if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
10874     int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);
10875
10876     //<wbr/> Round device orientation to a multiple of 90
10877     deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;
10878
10879     //<wbr/> Reverse device orientation for front-facing cameras
10880     boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
10881     if (facingFront) deviceOrientation = -deviceOrientation;
10882
10883     //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
10884     //<wbr/> the image upright relative to the device orientation
10885     int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
10886
10887     return jpegOrientation;
10888 }
10889 </code></pre>
10890             </td>
10891           </tr>
10892
10893
10894           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10895            <!-- end of entry -->
10896
10897
10898           <tr class="entry" id="controls_android.jpeg.quality">
10899             <td class="entry_name
10900              " rowspan="3">
10901               android.<wbr/>jpeg.<wbr/>quality
10902             </td>
10903             <td class="entry_type">
10904                 <span class="entry_type_name">byte</span>
10905
10906               <span class="entry_type_visibility"> [public]</span>
10907
10908
10909               <span class="entry_type_hwlevel">[legacy] </span>
10910
10911
10912
10913
10914             </td> <!-- entry_type -->
10915
10916             <td class="entry_description">
10917               <p>Compression quality of the final JPEG
10918 image.<wbr/></p>
10919             </td>
10920
10921             <td class="entry_units">
10922             </td>
10923
10924             <td class="entry_range">
10925               <p>1-100; larger is higher quality</p>
10926             </td>
10927
10928             <td class="entry_tags">
10929               <ul class="entry_tags">
10930                   <li><a href="#tag_BC">BC</a></li>
10931               </ul>
10932             </td>
10933
10934           </tr>
10935           <tr class="entries_header">
10936             <th class="th_details" colspan="5">Details</th>
10937           </tr>
10938           <tr class="entry_cont">
10939             <td class="entry_details" colspan="5">
10940               <p>85-95 is typical usage range.<wbr/></p>
10941             </td>
10942           </tr>
10943
10944
10945           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10946            <!-- end of entry -->
10947
10948
10949           <tr class="entry" id="controls_android.jpeg.thumbnailQuality">
10950             <td class="entry_name
10951              " rowspan="1">
10952               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
10953             </td>
10954             <td class="entry_type">
10955                 <span class="entry_type_name">byte</span>
10956
10957               <span class="entry_type_visibility"> [public]</span>
10958
10959
10960               <span class="entry_type_hwlevel">[legacy] </span>
10961
10962
10963
10964
10965             </td> <!-- entry_type -->
10966
10967             <td class="entry_description">
10968               <p>Compression quality of JPEG
10969 thumbnail.<wbr/></p>
10970             </td>
10971
10972             <td class="entry_units">
10973             </td>
10974
10975             <td class="entry_range">
10976               <p>1-100; larger is higher quality</p>
10977             </td>
10978
10979             <td class="entry_tags">
10980               <ul class="entry_tags">
10981                   <li><a href="#tag_BC">BC</a></li>
10982               </ul>
10983             </td>
10984
10985           </tr>
10986
10987
10988           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
10989            <!-- end of entry -->
10990
10991
10992           <tr class="entry" id="controls_android.jpeg.thumbnailSize">
10993             <td class="entry_name
10994              " rowspan="5">
10995               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
10996             </td>
10997             <td class="entry_type">
10998                 <span class="entry_type_name">int32</span>
10999                 <span class="entry_type_container">x</span>
11000
11001                 <span class="entry_type_array">
11002                   2
11003                 </span>
11004               <span class="entry_type_visibility"> [public as size]</span>
11005
11006
11007               <span class="entry_type_hwlevel">[legacy] </span>
11008
11009
11010
11011
11012             </td> <!-- entry_type -->
11013
11014             <td class="entry_description">
11015               <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
11016             </td>
11017
11018             <td class="entry_units">
11019             </td>
11020
11021             <td class="entry_range">
11022               <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
11023             </td>
11024
11025             <td class="entry_tags">
11026               <ul class="entry_tags">
11027                   <li><a href="#tag_BC">BC</a></li>
11028               </ul>
11029             </td>
11030
11031           </tr>
11032           <tr class="entries_header">
11033             <th class="th_details" colspan="5">Details</th>
11034           </tr>
11035           <tr class="entry_cont">
11036             <td class="entry_details" colspan="5">
11037               <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
11038 but the captured JPEG will still be a valid image.<wbr/></p>
11039 <p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
11040 should have the same aspect ratio as the main JPEG output.<wbr/></p>
11041 <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
11042 ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
11043 For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
11044 16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
11045 generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
11046 Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
11047 <p>When an <a href="#controls_android.jpeg.orientation">android.<wbr/>jpeg.<wbr/>orientation</a> of non-zero degree is requested,<wbr/>
11048 the camera device will handle thumbnail rotation in one of the following ways:</p>
11049 <ul>
11050 <li>Set the <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>
11051   and keep jpeg and thumbnail image data unrotated.<wbr/></li>
11052 <li>Rotate the jpeg and thumbnail image data and not set
11053   <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>.<wbr/> In this
11054   case,<wbr/> LIMITED or FULL hardware level devices will report rotated thumnail size in
11055   capture result,<wbr/> so the width and height will be interchanged if 90 or 270 degree
11056   orientation is requested.<wbr/> LEGACY device will always report unrotated thumbnail
11057   size.<wbr/></li>
11058 </ul>
11059             </td>
11060           </tr>
11061
11062           <tr class="entries_header">
11063             <th class="th_details" colspan="5">HAL Implementation Details</th>
11064           </tr>
11065           <tr class="entry_cont">
11066             <td class="entry_details" colspan="5">
11067               <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
11068 The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
11069 The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
11070 thumbnail image cropping.<wbr/></p>
11071             </td>
11072           </tr>
11073
11074           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11075            <!-- end of entry -->
11076
11077
11078
11079       <!-- end of kind -->
11080       </tbody>
11081       <tr><td colspan="6" class="kind">static</td></tr>
11082
11083       <thead class="entries_header">
11084         <tr>
11085           <th class="th_name">Property Name</th>
11086           <th class="th_type">Type</th>
11087           <th class="th_description">Description</th>
11088           <th class="th_units">Units</th>
11089           <th class="th_range">Range</th>
11090           <th class="th_tags">Tags</th>
11091         </tr>
11092       </thead>
11093
11094       <tbody>
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105           <tr class="entry" id="static_android.jpeg.availableThumbnailSizes">
11106             <td class="entry_name
11107              " rowspan="3">
11108               android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes
11109             </td>
11110             <td class="entry_type">
11111                 <span class="entry_type_name">int32</span>
11112                 <span class="entry_type_container">x</span>
11113
11114                 <span class="entry_type_array">
11115                   2 x n
11116                 </span>
11117               <span class="entry_type_visibility"> [public as size]</span>
11118
11119
11120               <span class="entry_type_hwlevel">[legacy] </span>
11121
11122
11123
11124
11125             </td> <!-- entry_type -->
11126
11127             <td class="entry_description">
11128               <p>List of JPEG thumbnail sizes for <a href="#controls_android.jpeg.thumbnailSize">android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size</a> supported by this
11129 camera device.<wbr/></p>
11130             </td>
11131
11132             <td class="entry_units">
11133             </td>
11134
11135             <td class="entry_range">
11136             </td>
11137
11138             <td class="entry_tags">
11139               <ul class="entry_tags">
11140                   <li><a href="#tag_BC">BC</a></li>
11141               </ul>
11142             </td>
11143
11144           </tr>
11145           <tr class="entries_header">
11146             <th class="th_details" colspan="5">Details</th>
11147           </tr>
11148           <tr class="entry_cont">
11149             <td class="entry_details" colspan="5">
11150               <p>This list will include at least one non-zero resolution,<wbr/> plus <code>(0,<wbr/>0)</code> for indicating no
11151 thumbnail should be generated.<wbr/></p>
11152 <p>Below condiditions will be satisfied for this size list:</p>
11153 <ul>
11154 <li>The sizes will be sorted by increasing pixel area (width x height).<wbr/>
11155 If several resolutions have the same area,<wbr/> they will be sorted by increasing width.<wbr/></li>
11156 <li>The aspect ratio of the largest thumbnail size will be same as the
11157 aspect ratio of largest JPEG output size in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a>.<wbr/>
11158 The largest size is defined as the size that has the largest pixel area
11159 in a given size list.<wbr/></li>
11160 <li>Each output JPEG size in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> will have at least
11161 one corresponding size that has the same aspect ratio in availableThumbnailSizes,<wbr/>
11162 and vice versa.<wbr/></li>
11163 <li>All non-<code>(0,<wbr/> 0)</code> sizes will have non-zero widths and heights.<wbr/></li>
11164 </ul>
11165             </td>
11166           </tr>
11167
11168
11169           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11170            <!-- end of entry -->
11171
11172
11173           <tr class="entry" id="static_android.jpeg.maxSize">
11174             <td class="entry_name
11175              " rowspan="3">
11176               android.<wbr/>jpeg.<wbr/>max<wbr/>Size
11177             </td>
11178             <td class="entry_type">
11179                 <span class="entry_type_name">int32</span>
11180
11181               <span class="entry_type_visibility"> [system]</span>
11182
11183
11184
11185
11186
11187
11188             </td> <!-- entry_type -->
11189
11190             <td class="entry_description">
11191               <p>Maximum size in bytes for the compressed
11192 JPEG buffer</p>
11193             </td>
11194
11195             <td class="entry_units">
11196             </td>
11197
11198             <td class="entry_range">
11199               <p>Must be large enough to fit any JPEG produced by
11200 the camera</p>
11201             </td>
11202
11203             <td class="entry_tags">
11204             </td>
11205
11206           </tr>
11207           <tr class="entries_header">
11208             <th class="th_details" colspan="5">Details</th>
11209           </tr>
11210           <tr class="entry_cont">
11211             <td class="entry_details" colspan="5">
11212               <p>This is used for sizing the gralloc buffers for
11213 JPEG</p>
11214             </td>
11215           </tr>
11216
11217
11218           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11219            <!-- end of entry -->
11220
11221
11222
11223       <!-- end of kind -->
11224       </tbody>
11225       <tr><td colspan="6" class="kind">dynamic</td></tr>
11226
11227       <thead class="entries_header">
11228         <tr>
11229           <th class="th_name">Property Name</th>
11230           <th class="th_type">Type</th>
11231           <th class="th_description">Description</th>
11232           <th class="th_units">Units</th>
11233           <th class="th_range">Range</th>
11234           <th class="th_tags">Tags</th>
11235         </tr>
11236       </thead>
11237
11238       <tbody>
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249           <tr class="entry" id="dynamic_android.jpeg.gpsLocation">
11250             <td class="entry_name
11251              " rowspan="3">
11252               android.<wbr/>jpeg.<wbr/>gps<wbr/>Location
11253             </td>
11254             <td class="entry_type">
11255                 <span class="entry_type_name">byte</span>
11256
11257               <span class="entry_type_visibility"> [java_public as location]</span>
11258
11259               <span class="entry_type_synthetic">[synthetic] </span>
11260
11261               <span class="entry_type_hwlevel">[legacy] </span>
11262
11263
11264
11265
11266             </td> <!-- entry_type -->
11267
11268             <td class="entry_description">
11269               <p>A location object to use when generating image GPS metadata.<wbr/></p>
11270             </td>
11271
11272             <td class="entry_units">
11273             </td>
11274
11275             <td class="entry_range">
11276             </td>
11277
11278             <td class="entry_tags">
11279             </td>
11280
11281           </tr>
11282           <tr class="entries_header">
11283             <th class="th_details" colspan="5">Details</th>
11284           </tr>
11285           <tr class="entry_cont">
11286             <td class="entry_details" colspan="5">
11287               <p>Setting a location object in a request will include the GPS coordinates of the location
11288 into any JPEG images captured based on the request.<wbr/> These coordinates can then be
11289 viewed by anyone who receives the JPEG image.<wbr/></p>
11290             </td>
11291           </tr>
11292
11293
11294           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11295            <!-- end of entry -->
11296
11297
11298           <tr class="entry" id="dynamic_android.jpeg.gpsCoordinates">
11299             <td class="entry_name
11300              " rowspan="1">
11301               android.<wbr/>jpeg.<wbr/>gps<wbr/>Coordinates
11302             </td>
11303             <td class="entry_type">
11304                 <span class="entry_type_name">double</span>
11305                 <span class="entry_type_container">x</span>
11306
11307                 <span class="entry_type_array">
11308                   3
11309                 </span>
11310               <span class="entry_type_visibility"> [ndk_public]</span>
11311
11312
11313               <span class="entry_type_hwlevel">[legacy] </span>
11314
11315
11316                 <div class="entry_type_notes">latitude,<wbr/> longitude,<wbr/> altitude.<wbr/> First two in degrees,<wbr/> the third in meters</div>
11317
11318
11319             </td> <!-- entry_type -->
11320
11321             <td class="entry_description">
11322               <p>GPS coordinates to include in output JPEG
11323 EXIF.<wbr/></p>
11324             </td>
11325
11326             <td class="entry_units">
11327             </td>
11328
11329             <td class="entry_range">
11330               <p>(-180 - 180],<wbr/> [-90,<wbr/>90],<wbr/> [-inf,<wbr/> inf]</p>
11331             </td>
11332
11333             <td class="entry_tags">
11334               <ul class="entry_tags">
11335                   <li><a href="#tag_BC">BC</a></li>
11336               </ul>
11337             </td>
11338
11339           </tr>
11340
11341
11342           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11343            <!-- end of entry -->
11344
11345
11346           <tr class="entry" id="dynamic_android.jpeg.gpsProcessingMethod">
11347             <td class="entry_name
11348              " rowspan="1">
11349               android.<wbr/>jpeg.<wbr/>gps<wbr/>Processing<wbr/>Method
11350             </td>
11351             <td class="entry_type">
11352                 <span class="entry_type_name">byte</span>
11353
11354               <span class="entry_type_visibility"> [ndk_public as string]</span>
11355
11356
11357               <span class="entry_type_hwlevel">[legacy] </span>
11358
11359
11360
11361
11362             </td> <!-- entry_type -->
11363
11364             <td class="entry_description">
11365               <p>32 characters describing GPS algorithm to
11366 include in EXIF.<wbr/></p>
11367             </td>
11368
11369             <td class="entry_units">
11370               UTF-8 null-terminated string
11371             </td>
11372
11373             <td class="entry_range">
11374             </td>
11375
11376             <td class="entry_tags">
11377               <ul class="entry_tags">
11378                   <li><a href="#tag_BC">BC</a></li>
11379               </ul>
11380             </td>
11381
11382           </tr>
11383
11384
11385           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11386            <!-- end of entry -->
11387
11388
11389           <tr class="entry" id="dynamic_android.jpeg.gpsTimestamp">
11390             <td class="entry_name
11391              " rowspan="1">
11392               android.<wbr/>jpeg.<wbr/>gps<wbr/>Timestamp
11393             </td>
11394             <td class="entry_type">
11395                 <span class="entry_type_name">int64</span>
11396
11397               <span class="entry_type_visibility"> [ndk_public]</span>
11398
11399
11400               <span class="entry_type_hwlevel">[legacy] </span>
11401
11402
11403
11404
11405             </td> <!-- entry_type -->
11406
11407             <td class="entry_description">
11408               <p>Time GPS fix was made to include in
11409 EXIF.<wbr/></p>
11410             </td>
11411
11412             <td class="entry_units">
11413               UTC in seconds since January 1,<wbr/> 1970
11414             </td>
11415
11416             <td class="entry_range">
11417             </td>
11418
11419             <td class="entry_tags">
11420               <ul class="entry_tags">
11421                   <li><a href="#tag_BC">BC</a></li>
11422               </ul>
11423             </td>
11424
11425           </tr>
11426
11427
11428           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11429            <!-- end of entry -->
11430
11431
11432           <tr class="entry" id="dynamic_android.jpeg.orientation">
11433             <td class="entry_name
11434              " rowspan="3">
11435               android.<wbr/>jpeg.<wbr/>orientation
11436             </td>
11437             <td class="entry_type">
11438                 <span class="entry_type_name">int32</span>
11439
11440               <span class="entry_type_visibility"> [public]</span>
11441
11442
11443               <span class="entry_type_hwlevel">[legacy] </span>
11444
11445
11446
11447
11448             </td> <!-- entry_type -->
11449
11450             <td class="entry_description">
11451               <p>The orientation for a JPEG image.<wbr/></p>
11452             </td>
11453
11454             <td class="entry_units">
11455               Degrees in multiples of 90
11456             </td>
11457
11458             <td class="entry_range">
11459               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
11460             </td>
11461
11462             <td class="entry_tags">
11463               <ul class="entry_tags">
11464                   <li><a href="#tag_BC">BC</a></li>
11465               </ul>
11466             </td>
11467
11468           </tr>
11469           <tr class="entries_header">
11470             <th class="th_details" colspan="5">Details</th>
11471           </tr>
11472           <tr class="entry_cont">
11473             <td class="entry_details" colspan="5">
11474               <p>The clockwise rotation angle in degrees,<wbr/> relative to the orientation
11475 to the camera,<wbr/> that the JPEG picture needs to be rotated by,<wbr/> to be viewed
11476 upright.<wbr/></p>
11477 <p>Camera devices may either encode this value into the JPEG EXIF header,<wbr/> or
11478 rotate the image data to match this orientation.<wbr/> When the image data is rotated,<wbr/>
11479 the thumbnail data will also be rotated.<wbr/></p>
11480 <p>Note that this orientation is relative to the orientation of the camera sensor,<wbr/> given
11481 by <a href="#static_android.sensor.orientation">android.<wbr/>sensor.<wbr/>orientation</a>.<wbr/></p>
11482 <p>To translate from the device orientation given by the Android sensor APIs,<wbr/> the following
11483 sample code may be used:</p>
11484 <pre><code>private int getJpegOrientation(CameraCharacteristics c,<wbr/> int deviceOrientation) {
11485     if (deviceOrientation == android.<wbr/>view.<wbr/>Orientation<wbr/>Event<wbr/>Listener.<wbr/>ORIENTATION_<wbr/>UNKNOWN) return 0;
11486     int sensorOrientation = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>SENSOR_<wbr/>ORIENTATION);
11487
11488     //<wbr/> Round device orientation to a multiple of 90
11489     deviceOrientation = (deviceOrientation + 45) /<wbr/> 90 * 90;
11490
11491     //<wbr/> Reverse device orientation for front-facing cameras
11492     boolean facingFront = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING) == Camera<wbr/>Characteristics.<wbr/>LENS_<wbr/>FACING_<wbr/>FRONT;
11493     if (facingFront) deviceOrientation = -deviceOrientation;
11494
11495     //<wbr/> Calculate desired JPEG orientation relative to camera orientation to make
11496     //<wbr/> the image upright relative to the device orientation
11497     int jpegOrientation = (sensorOrientation + deviceOrientation + 360) % 360;
11498
11499     return jpegOrientation;
11500 }
11501 </code></pre>
11502             </td>
11503           </tr>
11504
11505
11506           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11507            <!-- end of entry -->
11508
11509
11510           <tr class="entry" id="dynamic_android.jpeg.quality">
11511             <td class="entry_name
11512              " rowspan="3">
11513               android.<wbr/>jpeg.<wbr/>quality
11514             </td>
11515             <td class="entry_type">
11516                 <span class="entry_type_name">byte</span>
11517
11518               <span class="entry_type_visibility"> [public]</span>
11519
11520
11521               <span class="entry_type_hwlevel">[legacy] </span>
11522
11523
11524
11525
11526             </td> <!-- entry_type -->
11527
11528             <td class="entry_description">
11529               <p>Compression quality of the final JPEG
11530 image.<wbr/></p>
11531             </td>
11532
11533             <td class="entry_units">
11534             </td>
11535
11536             <td class="entry_range">
11537               <p>1-100; larger is higher quality</p>
11538             </td>
11539
11540             <td class="entry_tags">
11541               <ul class="entry_tags">
11542                   <li><a href="#tag_BC">BC</a></li>
11543               </ul>
11544             </td>
11545
11546           </tr>
11547           <tr class="entries_header">
11548             <th class="th_details" colspan="5">Details</th>
11549           </tr>
11550           <tr class="entry_cont">
11551             <td class="entry_details" colspan="5">
11552               <p>85-95 is typical usage range.<wbr/></p>
11553             </td>
11554           </tr>
11555
11556
11557           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11558            <!-- end of entry -->
11559
11560
11561           <tr class="entry" id="dynamic_android.jpeg.size">
11562             <td class="entry_name
11563              " rowspan="3">
11564               android.<wbr/>jpeg.<wbr/>size
11565             </td>
11566             <td class="entry_type">
11567                 <span class="entry_type_name">int32</span>
11568
11569               <span class="entry_type_visibility"> [system]</span>
11570
11571
11572
11573
11574
11575
11576             </td> <!-- entry_type -->
11577
11578             <td class="entry_description">
11579               <p>The size of the compressed JPEG image,<wbr/> in
11580 bytes</p>
11581             </td>
11582
11583             <td class="entry_units">
11584             </td>
11585
11586             <td class="entry_range">
11587               <p>&gt;= 0</p>
11588             </td>
11589
11590             <td class="entry_tags">
11591               <ul class="entry_tags">
11592                   <li><a href="#tag_FUTURE">FUTURE</a></li>
11593               </ul>
11594             </td>
11595
11596           </tr>
11597           <tr class="entries_header">
11598             <th class="th_details" colspan="5">Details</th>
11599           </tr>
11600           <tr class="entry_cont">
11601             <td class="entry_details" colspan="5">
11602               <p>If no JPEG output is produced for the request,<wbr/>
11603 this must be 0.<wbr/></p>
11604 <p>Otherwise,<wbr/> this describes the real size of the compressed
11605 JPEG image placed in the output stream.<wbr/>  More specifically,<wbr/>
11606 if <a href="#static_android.jpeg.maxSize">android.<wbr/>jpeg.<wbr/>max<wbr/>Size</a> = 1000000,<wbr/> and a specific capture
11607 has <a href="#dynamic_android.jpeg.size">android.<wbr/>jpeg.<wbr/>size</a> = 500000,<wbr/> then the output buffer from
11608 the JPEG stream will be 1000000 bytes,<wbr/> of which the first
11609 500000 make up the real data.<wbr/></p>
11610             </td>
11611           </tr>
11612
11613
11614           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11615            <!-- end of entry -->
11616
11617
11618           <tr class="entry" id="dynamic_android.jpeg.thumbnailQuality">
11619             <td class="entry_name
11620              " rowspan="1">
11621               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Quality
11622             </td>
11623             <td class="entry_type">
11624                 <span class="entry_type_name">byte</span>
11625
11626               <span class="entry_type_visibility"> [public]</span>
11627
11628
11629               <span class="entry_type_hwlevel">[legacy] </span>
11630
11631
11632
11633
11634             </td> <!-- entry_type -->
11635
11636             <td class="entry_description">
11637               <p>Compression quality of JPEG
11638 thumbnail.<wbr/></p>
11639             </td>
11640
11641             <td class="entry_units">
11642             </td>
11643
11644             <td class="entry_range">
11645               <p>1-100; larger is higher quality</p>
11646             </td>
11647
11648             <td class="entry_tags">
11649               <ul class="entry_tags">
11650                   <li><a href="#tag_BC">BC</a></li>
11651               </ul>
11652             </td>
11653
11654           </tr>
11655
11656
11657           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11658            <!-- end of entry -->
11659
11660
11661           <tr class="entry" id="dynamic_android.jpeg.thumbnailSize">
11662             <td class="entry_name
11663              " rowspan="5">
11664               android.<wbr/>jpeg.<wbr/>thumbnail<wbr/>Size
11665             </td>
11666             <td class="entry_type">
11667                 <span class="entry_type_name">int32</span>
11668                 <span class="entry_type_container">x</span>
11669
11670                 <span class="entry_type_array">
11671                   2
11672                 </span>
11673               <span class="entry_type_visibility"> [public as size]</span>
11674
11675
11676               <span class="entry_type_hwlevel">[legacy] </span>
11677
11678
11679
11680
11681             </td> <!-- entry_type -->
11682
11683             <td class="entry_description">
11684               <p>Resolution of embedded JPEG thumbnail.<wbr/></p>
11685             </td>
11686
11687             <td class="entry_units">
11688             </td>
11689
11690             <td class="entry_range">
11691               <p><a href="#static_android.jpeg.availableThumbnailSizes">android.<wbr/>jpeg.<wbr/>available<wbr/>Thumbnail<wbr/>Sizes</a></p>
11692             </td>
11693
11694             <td class="entry_tags">
11695               <ul class="entry_tags">
11696                   <li><a href="#tag_BC">BC</a></li>
11697               </ul>
11698             </td>
11699
11700           </tr>
11701           <tr class="entries_header">
11702             <th class="th_details" colspan="5">Details</th>
11703           </tr>
11704           <tr class="entry_cont">
11705             <td class="entry_details" colspan="5">
11706               <p>When set to (0,<wbr/> 0) value,<wbr/> the JPEG EXIF will not contain thumbnail,<wbr/>
11707 but the captured JPEG will still be a valid image.<wbr/></p>
11708 <p>For best results,<wbr/> when issuing a request for a JPEG image,<wbr/> the thumbnail size selected
11709 should have the same aspect ratio as the main JPEG output.<wbr/></p>
11710 <p>If the thumbnail image aspect ratio differs from the JPEG primary image aspect
11711 ratio,<wbr/> the camera device creates the thumbnail by cropping it from the primary image.<wbr/>
11712 For example,<wbr/> if the primary image has 4:3 aspect ratio,<wbr/> the thumbnail image has
11713 16:9 aspect ratio,<wbr/> the primary image will be cropped vertically (letterbox) to
11714 generate the thumbnail image.<wbr/> The thumbnail image will always have a smaller Field
11715 Of View (FOV) than the primary image when aspect ratios differ.<wbr/></p>
11716 <p>When an <a href="#controls_android.jpeg.orientation">android.<wbr/>jpeg.<wbr/>orientation</a> of non-zero degree is requested,<wbr/>
11717 the camera device will handle thumbnail rotation in one of the following ways:</p>
11718 <ul>
11719 <li>Set the <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>
11720   and keep jpeg and thumbnail image data unrotated.<wbr/></li>
11721 <li>Rotate the jpeg and thumbnail image data and not set
11722   <a href="https://developer.android.com/reference/android/media/ExifInterface.html#TAG_ORIENTATION">EXIF orientation flag</a>.<wbr/> In this
11723   case,<wbr/> LIMITED or FULL hardware level devices will report rotated thumnail size in
11724   capture result,<wbr/> so the width and height will be interchanged if 90 or 270 degree
11725   orientation is requested.<wbr/> LEGACY device will always report unrotated thumbnail
11726   size.<wbr/></li>
11727 </ul>
11728             </td>
11729           </tr>
11730
11731           <tr class="entries_header">
11732             <th class="th_details" colspan="5">HAL Implementation Details</th>
11733           </tr>
11734           <tr class="entry_cont">
11735             <td class="entry_details" colspan="5">
11736               <p>The HAL must not squeeze or stretch the downscaled primary image to generate thumbnail.<wbr/>
11737 The cropping must be done on the primary jpeg image rather than the sensor active array.<wbr/>
11738 The stream cropping rule specified by "S5.<wbr/> Cropping" in camera3.<wbr/>h doesn't apply to the
11739 thumbnail image cropping.<wbr/></p>
11740             </td>
11741           </tr>
11742
11743           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11744            <!-- end of entry -->
11745
11746
11747
11748       <!-- end of kind -->
11749       </tbody>
11750
11751   <!-- end of section -->
11752   <tr><td colspan="6" id="section_lens" class="section">lens</td></tr>
11753
11754
11755       <tr><td colspan="6" class="kind">controls</td></tr>
11756
11757       <thead class="entries_header">
11758         <tr>
11759           <th class="th_name">Property Name</th>
11760           <th class="th_type">Type</th>
11761           <th class="th_description">Description</th>
11762           <th class="th_units">Units</th>
11763           <th class="th_range">Range</th>
11764           <th class="th_tags">Tags</th>
11765         </tr>
11766       </thead>
11767
11768       <tbody>
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779           <tr class="entry" id="controls_android.lens.aperture">
11780             <td class="entry_name
11781              " rowspan="3">
11782               android.<wbr/>lens.<wbr/>aperture
11783             </td>
11784             <td class="entry_type">
11785                 <span class="entry_type_name">float</span>
11786
11787               <span class="entry_type_visibility"> [public]</span>
11788
11789
11790               <span class="entry_type_hwlevel">[full] </span>
11791
11792
11793
11794
11795             </td> <!-- entry_type -->
11796
11797             <td class="entry_description">
11798               <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
11799 effective aperture diameter.<wbr/></p>
11800             </td>
11801
11802             <td class="entry_units">
11803               The f-number (f/<wbr/>N)
11804             </td>
11805
11806             <td class="entry_range">
11807               <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
11808             </td>
11809
11810             <td class="entry_tags">
11811               <ul class="entry_tags">
11812                   <li><a href="#tag_V1">V1</a></li>
11813               </ul>
11814             </td>
11815
11816           </tr>
11817           <tr class="entries_header">
11818             <th class="th_details" colspan="5">Details</th>
11819           </tr>
11820           <tr class="entry_cont">
11821             <td class="entry_details" colspan="5">
11822               <p>Setting this value is only supported on the camera devices that have a variable
11823 aperture lens.<wbr/></p>
11824 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
11825 this can be set along with <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
11826 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
11827 to achieve manual exposure control.<wbr/></p>
11828 <p>The requested aperture value may take several frames to reach the
11829 requested value; the camera device will report the current (intermediate)
11830 aperture size in capture result metadata while the aperture is changing.<wbr/>
11831 While the aperture is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
11832 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
11833 the ON modes,<wbr/> this will be overridden by the camera device
11834 auto-exposure algorithm,<wbr/> the overridden values are then provided
11835 back to the user in the corresponding result.<wbr/></p>
11836             </td>
11837           </tr>
11838
11839
11840           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11841            <!-- end of entry -->
11842
11843
11844           <tr class="entry" id="controls_android.lens.filterDensity">
11845             <td class="entry_name
11846              " rowspan="3">
11847               android.<wbr/>lens.<wbr/>filter<wbr/>Density
11848             </td>
11849             <td class="entry_type">
11850                 <span class="entry_type_name">float</span>
11851
11852               <span class="entry_type_visibility"> [public]</span>
11853
11854
11855               <span class="entry_type_hwlevel">[full] </span>
11856
11857
11858
11859
11860             </td> <!-- entry_type -->
11861
11862             <td class="entry_description">
11863               <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
11864             </td>
11865
11866             <td class="entry_units">
11867               Exposure Value (EV)
11868             </td>
11869
11870             <td class="entry_range">
11871               <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
11872             </td>
11873
11874             <td class="entry_tags">
11875               <ul class="entry_tags">
11876                   <li><a href="#tag_V1">V1</a></li>
11877               </ul>
11878             </td>
11879
11880           </tr>
11881           <tr class="entries_header">
11882             <th class="th_details" colspan="5">Details</th>
11883           </tr>
11884           <tr class="entry_cont">
11885             <td class="entry_details" colspan="5">
11886               <p>This control will not be supported on most camera devices.<wbr/></p>
11887 <p>Lens filters are typically used to lower the amount of light the
11888 sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
11889 step is the standard logarithmic representation,<wbr/> which are
11890 non-negative,<wbr/> and inversely proportional to the amount of light
11891 hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
11892 in no reduction of the incoming light,<wbr/> and setting this to 2 would
11893 mean that the filter is set to reduce incoming light by two stops
11894 (allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
11895 <p>It may take several frames before the lens filter density changes
11896 to the requested value.<wbr/> While the filter density is still changing,<wbr/>
11897 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
11898             </td>
11899           </tr>
11900
11901
11902           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11903            <!-- end of entry -->
11904
11905
11906           <tr class="entry" id="controls_android.lens.focalLength">
11907             <td class="entry_name
11908              " rowspan="3">
11909               android.<wbr/>lens.<wbr/>focal<wbr/>Length
11910             </td>
11911             <td class="entry_type">
11912                 <span class="entry_type_name">float</span>
11913
11914               <span class="entry_type_visibility"> [public]</span>
11915
11916
11917               <span class="entry_type_hwlevel">[legacy] </span>
11918
11919
11920
11921
11922             </td> <!-- entry_type -->
11923
11924             <td class="entry_description">
11925               <p>The desired lens focal length; used for optical zoom.<wbr/></p>
11926             </td>
11927
11928             <td class="entry_units">
11929               Millimeters
11930             </td>
11931
11932             <td class="entry_range">
11933               <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
11934             </td>
11935
11936             <td class="entry_tags">
11937               <ul class="entry_tags">
11938                   <li><a href="#tag_V1">V1</a></li>
11939               </ul>
11940             </td>
11941
11942           </tr>
11943           <tr class="entries_header">
11944             <th class="th_details" colspan="5">Details</th>
11945           </tr>
11946           <tr class="entry_cont">
11947             <td class="entry_details" colspan="5">
11948               <p>This setting controls the physical focal length of the camera
11949 device's lens.<wbr/> Changing the focal length changes the field of
11950 view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
11951 <p>Like <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> this
11952 setting won't be applied instantaneously,<wbr/> and it may take several
11953 frames before the lens can change to the requested focal length.<wbr/>
11954 While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
11955 be set to MOVING.<wbr/></p>
11956 <p>Optical zoom will not be supported on most devices.<wbr/></p>
11957             </td>
11958           </tr>
11959
11960
11961           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
11962            <!-- end of entry -->
11963
11964
11965           <tr class="entry" id="controls_android.lens.focusDistance">
11966             <td class="entry_name
11967              " rowspan="3">
11968               android.<wbr/>lens.<wbr/>focus<wbr/>Distance
11969             </td>
11970             <td class="entry_type">
11971                 <span class="entry_type_name">float</span>
11972
11973               <span class="entry_type_visibility"> [public]</span>
11974
11975
11976               <span class="entry_type_hwlevel">[full] </span>
11977
11978
11979
11980
11981             </td> <!-- entry_type -->
11982
11983             <td class="entry_description">
11984               <p>Desired distance to plane of sharpest focus,<wbr/>
11985 measured from frontmost surface of the lens.<wbr/></p>
11986             </td>
11987
11988             <td class="entry_units">
11989               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
11990             </td>
11991
11992             <td class="entry_range">
11993               <p>&gt;= 0</p>
11994             </td>
11995
11996             <td class="entry_tags">
11997               <ul class="entry_tags">
11998                   <li><a href="#tag_BC">BC</a></li>
11999                   <li><a href="#tag_V1">V1</a></li>
12000               </ul>
12001             </td>
12002
12003           </tr>
12004           <tr class="entries_header">
12005             <th class="th_details" colspan="5">Details</th>
12006           </tr>
12007           <tr class="entry_cont">
12008             <td class="entry_details" colspan="5">
12009               <p>This control can be used for setting manual focus,<wbr/> on devices that support
12010 the MANUAL_<wbr/>SENSOR capability and have a variable-focus lens (see
12011 <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>).<wbr/></p>
12012 <p>A value of <code>0.<wbr/>0f</code> means infinity focus.<wbr/> The value set will be clamped to
12013 <code>[0.<wbr/>0f,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code>.<wbr/></p>
12014 <p>Like <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> this setting won't be applied
12015 instantaneously,<wbr/> and it may take several frames before the lens
12016 can move to the requested focus distance.<wbr/> While the lens is still moving,<wbr/>
12017 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
12018 <p>LEGACY devices support at most setting this to <code>0.<wbr/>0f</code>
12019 for infinity focus.<wbr/></p>
12020             </td>
12021           </tr>
12022
12023
12024           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12025            <!-- end of entry -->
12026
12027
12028           <tr class="entry" id="controls_android.lens.opticalStabilizationMode">
12029             <td class="entry_name
12030              " rowspan="3">
12031               android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
12032             </td>
12033             <td class="entry_type">
12034                 <span class="entry_type_name entry_type_name_enum">byte</span>
12035
12036               <span class="entry_type_visibility"> [public]</span>
12037
12038
12039               <span class="entry_type_hwlevel">[limited] </span>
12040
12041
12042
12043                 <ul class="entry_type_enum">
12044                   <li>
12045                     <span class="entry_type_enum_name">OFF</span>
12046                     <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
12047                   </li>
12048                   <li>
12049                     <span class="entry_type_enum_name">ON</span>
12050                     <span class="entry_type_enum_optional">[optional]</span>
12051                     <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
12052                   </li>
12053                 </ul>
12054
12055             </td> <!-- entry_type -->
12056
12057             <td class="entry_description">
12058               <p>Sets whether the camera device uses optical image stabilization (OIS)
12059 when capturing images.<wbr/></p>
12060             </td>
12061
12062             <td class="entry_units">
12063             </td>
12064
12065             <td class="entry_range">
12066               <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
12067             </td>
12068
12069             <td class="entry_tags">
12070               <ul class="entry_tags">
12071                   <li><a href="#tag_V1">V1</a></li>
12072               </ul>
12073             </td>
12074
12075           </tr>
12076           <tr class="entries_header">
12077             <th class="th_details" colspan="5">Details</th>
12078           </tr>
12079           <tr class="entry_cont">
12080             <td class="entry_details" colspan="5">
12081               <p>OIS is used to compensate for motion blur due to small
12082 movements of the camera during capture.<wbr/> Unlike digital image
12083 stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
12084 makes use of mechanical elements to stabilize the camera
12085 sensor,<wbr/> and thus allows for longer exposure times before
12086 camera shake becomes apparent.<wbr/></p>
12087 <p>Switching between different optical stabilization modes may take several
12088 frames to initialize,<wbr/> the camera device will report the current mode in
12089 capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
12090 optical stabilization modes in the first several capture results may still
12091 be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
12092 <p>If a camera device supports both OIS and digital image stabilization
12093 (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
12094 interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
12095 <p>Not all devices will support OIS; see
12096 <a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
12097 available controls.<wbr/></p>
12098             </td>
12099           </tr>
12100
12101
12102           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12103            <!-- end of entry -->
12104
12105
12106
12107       <!-- end of kind -->
12108       </tbody>
12109       <tr><td colspan="6" class="kind">static</td></tr>
12110
12111       <thead class="entries_header">
12112         <tr>
12113           <th class="th_name">Property Name</th>
12114           <th class="th_type">Type</th>
12115           <th class="th_description">Description</th>
12116           <th class="th_units">Units</th>
12117           <th class="th_range">Range</th>
12118           <th class="th_tags">Tags</th>
12119         </tr>
12120       </thead>
12121
12122       <tbody>
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135           <tr class="entry" id="static_android.lens.info.availableApertures">
12136             <td class="entry_name
12137              " rowspan="3">
12138               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures
12139             </td>
12140             <td class="entry_type">
12141                 <span class="entry_type_name">float</span>
12142                 <span class="entry_type_container">x</span>
12143
12144                 <span class="entry_type_array">
12145                   n
12146                 </span>
12147               <span class="entry_type_visibility"> [public]</span>
12148
12149
12150               <span class="entry_type_hwlevel">[full] </span>
12151
12152
12153
12154
12155             </td> <!-- entry_type -->
12156
12157             <td class="entry_description">
12158               <p>List of aperture size values for <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a> that are
12159 supported by this camera device.<wbr/></p>
12160             </td>
12161
12162             <td class="entry_units">
12163               The aperture f-number
12164             </td>
12165
12166             <td class="entry_range">
12167             </td>
12168
12169             <td class="entry_tags">
12170               <ul class="entry_tags">
12171                   <li><a href="#tag_V1">V1</a></li>
12172               </ul>
12173             </td>
12174
12175           </tr>
12176           <tr class="entries_header">
12177             <th class="th_details" colspan="5">Details</th>
12178           </tr>
12179           <tr class="entry_cont">
12180             <td class="entry_details" colspan="5">
12181               <p>If the camera device doesn't support a variable lens aperture,<wbr/>
12182 this list will contain only one value,<wbr/> which is the fixed aperture size.<wbr/></p>
12183 <p>If the camera device supports a variable aperture,<wbr/> the aperture values
12184 in this list will be sorted in ascending order.<wbr/></p>
12185             </td>
12186           </tr>
12187
12188
12189           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12190            <!-- end of entry -->
12191
12192
12193           <tr class="entry" id="static_android.lens.info.availableFilterDensities">
12194             <td class="entry_name
12195              " rowspan="3">
12196               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities
12197             </td>
12198             <td class="entry_type">
12199                 <span class="entry_type_name">float</span>
12200                 <span class="entry_type_container">x</span>
12201
12202                 <span class="entry_type_array">
12203                   n
12204                 </span>
12205               <span class="entry_type_visibility"> [public]</span>
12206
12207
12208               <span class="entry_type_hwlevel">[full] </span>
12209
12210
12211
12212
12213             </td> <!-- entry_type -->
12214
12215             <td class="entry_description">
12216               <p>List of neutral density filter values for
12217 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> that are supported by this camera device.<wbr/></p>
12218             </td>
12219
12220             <td class="entry_units">
12221               Exposure value (EV)
12222             </td>
12223
12224             <td class="entry_range">
12225               <p>Values are &gt;= 0</p>
12226             </td>
12227
12228             <td class="entry_tags">
12229               <ul class="entry_tags">
12230                   <li><a href="#tag_V1">V1</a></li>
12231               </ul>
12232             </td>
12233
12234           </tr>
12235           <tr class="entries_header">
12236             <th class="th_details" colspan="5">Details</th>
12237           </tr>
12238           <tr class="entry_cont">
12239             <td class="entry_details" colspan="5">
12240               <p>If a neutral density filter is not supported by this camera device,<wbr/>
12241 this list will contain only 0.<wbr/> Otherwise,<wbr/> this list will include every
12242 filter density supported by the camera device,<wbr/> in ascending order.<wbr/></p>
12243             </td>
12244           </tr>
12245
12246
12247           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12248            <!-- end of entry -->
12249
12250
12251           <tr class="entry" id="static_android.lens.info.availableFocalLengths">
12252             <td class="entry_name
12253              " rowspan="3">
12254               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths
12255             </td>
12256             <td class="entry_type">
12257                 <span class="entry_type_name">float</span>
12258                 <span class="entry_type_container">x</span>
12259
12260                 <span class="entry_type_array">
12261                   n
12262                 </span>
12263               <span class="entry_type_visibility"> [public]</span>
12264
12265
12266               <span class="entry_type_hwlevel">[legacy] </span>
12267
12268
12269                 <div class="entry_type_notes">The list of available focal lengths</div>
12270
12271
12272             </td> <!-- entry_type -->
12273
12274             <td class="entry_description">
12275               <p>List of focal lengths for <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a> that are supported by this camera
12276 device.<wbr/></p>
12277             </td>
12278
12279             <td class="entry_units">
12280               Millimeters
12281             </td>
12282
12283             <td class="entry_range">
12284               <p>Values are &gt; 0</p>
12285             </td>
12286
12287             <td class="entry_tags">
12288               <ul class="entry_tags">
12289                   <li><a href="#tag_BC">BC</a></li>
12290                   <li><a href="#tag_V1">V1</a></li>
12291               </ul>
12292             </td>
12293
12294           </tr>
12295           <tr class="entries_header">
12296             <th class="th_details" colspan="5">Details</th>
12297           </tr>
12298           <tr class="entry_cont">
12299             <td class="entry_details" colspan="5">
12300               <p>If optical zoom is not supported,<wbr/> this list will only contain
12301 a single value corresponding to the fixed focal length of the
12302 device.<wbr/> Otherwise,<wbr/> this list will include every focal length supported
12303 by the camera device,<wbr/> in ascending order.<wbr/></p>
12304             </td>
12305           </tr>
12306
12307
12308           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12309            <!-- end of entry -->
12310
12311
12312           <tr class="entry" id="static_android.lens.info.availableOpticalStabilization">
12313             <td class="entry_name
12314              " rowspan="3">
12315               android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization
12316             </td>
12317             <td class="entry_type">
12318                 <span class="entry_type_name">byte</span>
12319                 <span class="entry_type_container">x</span>
12320
12321                 <span class="entry_type_array">
12322                   n
12323                 </span>
12324               <span class="entry_type_visibility"> [public as enumList]</span>
12325
12326
12327               <span class="entry_type_hwlevel">[limited] </span>
12328
12329
12330                 <div class="entry_type_notes">list of enums</div>
12331
12332
12333             </td> <!-- entry_type -->
12334
12335             <td class="entry_description">
12336               <p>List of optical image stabilization (OIS) modes for
12337 <a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> that are supported by this camera device.<wbr/></p>
12338             </td>
12339
12340             <td class="entry_units">
12341             </td>
12342
12343             <td class="entry_range">
12344               <p>Any value listed in <a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a></p>
12345             </td>
12346
12347             <td class="entry_tags">
12348               <ul class="entry_tags">
12349                   <li><a href="#tag_V1">V1</a></li>
12350               </ul>
12351             </td>
12352
12353           </tr>
12354           <tr class="entries_header">
12355             <th class="th_details" colspan="5">Details</th>
12356           </tr>
12357           <tr class="entry_cont">
12358             <td class="entry_details" colspan="5">
12359               <p>If OIS is not supported by a given camera device,<wbr/> this list will
12360 contain only OFF.<wbr/></p>
12361             </td>
12362           </tr>
12363
12364
12365           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12366            <!-- end of entry -->
12367
12368
12369           <tr class="entry" id="static_android.lens.info.hyperfocalDistance">
12370             <td class="entry_name
12371              " rowspan="3">
12372               android.<wbr/>lens.<wbr/>info.<wbr/>hyperfocal<wbr/>Distance
12373             </td>
12374             <td class="entry_type">
12375                 <span class="entry_type_name">float</span>
12376
12377               <span class="entry_type_visibility"> [public]</span>
12378
12379
12380               <span class="entry_type_hwlevel">[limited] </span>
12381
12382
12383
12384
12385             </td> <!-- entry_type -->
12386
12387             <td class="entry_description">
12388               <p>Hyperfocal distance for this lens.<wbr/></p>
12389             </td>
12390
12391             <td class="entry_units">
12392               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
12393             </td>
12394
12395             <td class="entry_range">
12396               <p>If lens is fixed focus,<wbr/> &gt;= 0.<wbr/> If lens has focuser unit,<wbr/> the value is
12397 within <code>(0.<wbr/>0f,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code></p>
12398             </td>
12399
12400             <td class="entry_tags">
12401             </td>
12402
12403           </tr>
12404           <tr class="entries_header">
12405             <th class="th_details" colspan="5">Details</th>
12406           </tr>
12407           <tr class="entry_cont">
12408             <td class="entry_details" colspan="5">
12409               <p>If the lens is not fixed focus,<wbr/> the camera device will report this
12410 field when <a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a> is APPROXIMATE or CALIBRATED.<wbr/></p>
12411             </td>
12412           </tr>
12413
12414
12415           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12416            <!-- end of entry -->
12417
12418
12419           <tr class="entry" id="static_android.lens.info.minimumFocusDistance">
12420             <td class="entry_name
12421              " rowspan="5">
12422               android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance
12423             </td>
12424             <td class="entry_type">
12425                 <span class="entry_type_name">float</span>
12426
12427               <span class="entry_type_visibility"> [public]</span>
12428
12429
12430               <span class="entry_type_hwlevel">[limited] </span>
12431
12432
12433
12434
12435             </td> <!-- entry_type -->
12436
12437             <td class="entry_description">
12438               <p>Shortest distance from frontmost surface
12439 of the lens that can be brought into sharp focus.<wbr/></p>
12440             </td>
12441
12442             <td class="entry_units">
12443               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
12444             </td>
12445
12446             <td class="entry_range">
12447               <p>&gt;= 0</p>
12448             </td>
12449
12450             <td class="entry_tags">
12451               <ul class="entry_tags">
12452                   <li><a href="#tag_V1">V1</a></li>
12453               </ul>
12454             </td>
12455
12456           </tr>
12457           <tr class="entries_header">
12458             <th class="th_details" colspan="5">Details</th>
12459           </tr>
12460           <tr class="entry_cont">
12461             <td class="entry_details" colspan="5">
12462               <p>If the lens is fixed-focus,<wbr/> this will be
12463 0.<wbr/></p>
12464             </td>
12465           </tr>
12466
12467           <tr class="entries_header">
12468             <th class="th_details" colspan="5">HAL Implementation Details</th>
12469           </tr>
12470           <tr class="entry_cont">
12471             <td class="entry_details" colspan="5">
12472               <p>Mandatory for FULL devices; LIMITED devices
12473 must always set this value to 0 for fixed-focus; and may omit
12474 the minimum focus distance otherwise.<wbr/></p>
12475 <p>This field is also mandatory for all devices advertising
12476 the MANUAL_<wbr/>SENSOR capability.<wbr/></p>
12477             </td>
12478           </tr>
12479
12480           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12481            <!-- end of entry -->
12482
12483
12484           <tr class="entry" id="static_android.lens.info.shadingMapSize">
12485             <td class="entry_name
12486              " rowspan="3">
12487               android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size
12488             </td>
12489             <td class="entry_type">
12490                 <span class="entry_type_name">int32</span>
12491                 <span class="entry_type_container">x</span>
12492
12493                 <span class="entry_type_array">
12494                   2
12495                 </span>
12496               <span class="entry_type_visibility"> [ndk_public as size]</span>
12497
12498
12499               <span class="entry_type_hwlevel">[full] </span>
12500
12501
12502                 <div class="entry_type_notes">width and height (N,<wbr/> M) of lens shading map provided by the camera device.<wbr/></div>
12503
12504
12505             </td> <!-- entry_type -->
12506
12507             <td class="entry_description">
12508               <p>Dimensions of lens shading map.<wbr/></p>
12509             </td>
12510
12511             <td class="entry_units">
12512             </td>
12513
12514             <td class="entry_range">
12515               <p>Both values &gt;= 1</p>
12516             </td>
12517
12518             <td class="entry_tags">
12519               <ul class="entry_tags">
12520                   <li><a href="#tag_V1">V1</a></li>
12521               </ul>
12522             </td>
12523
12524           </tr>
12525           <tr class="entries_header">
12526             <th class="th_details" colspan="5">Details</th>
12527           </tr>
12528           <tr class="entry_cont">
12529             <td class="entry_details" colspan="5">
12530               <p>The map should be on the order of 30-40 rows and columns,<wbr/> and
12531 must be smaller than 64x64.<wbr/></p>
12532             </td>
12533           </tr>
12534
12535
12536           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12537            <!-- end of entry -->
12538
12539
12540           <tr class="entry" id="static_android.lens.info.focusDistanceCalibration">
12541             <td class="entry_name
12542              " rowspan="5">
12543               android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration
12544             </td>
12545             <td class="entry_type">
12546                 <span class="entry_type_name entry_type_name_enum">byte</span>
12547
12548               <span class="entry_type_visibility"> [public]</span>
12549
12550
12551               <span class="entry_type_hwlevel">[limited] </span>
12552
12553
12554
12555                 <ul class="entry_type_enum">
12556                   <li>
12557                     <span class="entry_type_enum_name">UNCALIBRATED</span>
12558                     <span class="entry_type_enum_notes"><p>The lens focus distance is not accurate,<wbr/> and the units used for
12559 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> do not correspond to any physical units.<wbr/></p>
12560 <p>Setting the lens to the same focus distance on separate occasions may
12561 result in a different real focus distance,<wbr/> depending on factors such
12562 as the orientation of the device,<wbr/> the age of the focusing mechanism,<wbr/>
12563 and the device temperature.<wbr/> The focus distance value will still be
12564 in the range of <code>[0,<wbr/> <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>]</code>,<wbr/> where 0
12565 represents the farthest focus.<wbr/></p></span>
12566                   </li>
12567                   <li>
12568                     <span class="entry_type_enum_name">APPROXIMATE</span>
12569                     <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters.<wbr/></p>
12570 <p>However,<wbr/> setting the lens to the same focus distance
12571 on separate occasions may result in a different real
12572 focus distance,<wbr/> depending on factors such as the
12573 orientation of the device,<wbr/> the age of the focusing
12574 mechanism,<wbr/> and the device temperature.<wbr/></p></span>
12575                   </li>
12576                   <li>
12577                     <span class="entry_type_enum_name">CALIBRATED</span>
12578                     <span class="entry_type_enum_notes"><p>The lens focus distance is measured in diopters,<wbr/> and
12579 is calibrated.<wbr/></p>
12580 <p>The lens mechanism is calibrated so that setting the
12581 same focus distance is repeatable on multiple
12582 occasions with good accuracy,<wbr/> and the focus distance
12583 corresponds to the real physical distance to the plane
12584 of best focus.<wbr/></p></span>
12585                   </li>
12586                 </ul>
12587
12588             </td> <!-- entry_type -->
12589
12590             <td class="entry_description">
12591               <p>The lens focus distance calibration quality.<wbr/></p>
12592             </td>
12593
12594             <td class="entry_units">
12595             </td>
12596
12597             <td class="entry_range">
12598             </td>
12599
12600             <td class="entry_tags">
12601               <ul class="entry_tags">
12602                   <li><a href="#tag_V1">V1</a></li>
12603               </ul>
12604             </td>
12605
12606           </tr>
12607           <tr class="entries_header">
12608             <th class="th_details" colspan="5">Details</th>
12609           </tr>
12610           <tr class="entry_cont">
12611             <td class="entry_details" colspan="5">
12612               <p>The lens focus distance calibration quality determines the reliability of
12613 focus related metadata entries,<wbr/> i.<wbr/>e.<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
12614 <a href="#dynamic_android.lens.focusRange">android.<wbr/>lens.<wbr/>focus<wbr/>Range</a>,<wbr/> <a href="#static_android.lens.info.hyperfocalDistance">android.<wbr/>lens.<wbr/>info.<wbr/>hyperfocal<wbr/>Distance</a>,<wbr/> and
12615 <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a>.<wbr/></p>
12616 <p>APPROXIMATE and CALIBRATED devices report the focus metadata in
12617 units of diopters (1/<wbr/>meter),<wbr/> so <code>0.<wbr/>0f</code> represents focusing at infinity,<wbr/>
12618 and increasing positive numbers represent focusing closer and closer
12619 to the camera device.<wbr/> The focus distance control also uses diopters
12620 on these devices.<wbr/></p>
12621 <p>UNCALIBRATED devices do not use units that are directly comparable
12622 to any real physical measurement,<wbr/> but <code>0.<wbr/>0f</code> still represents farthest
12623 focus,<wbr/> and <a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> represents the
12624 nearest focus the device can achieve.<wbr/></p>
12625             </td>
12626           </tr>
12627
12628           <tr class="entries_header">
12629             <th class="th_details" colspan="5">HAL Implementation Details</th>
12630           </tr>
12631           <tr class="entry_cont">
12632             <td class="entry_details" colspan="5">
12633               <p>For devices advertise APPROXIMATE quality or higher,<wbr/> diopters 0 (infinity
12634 focus) must work.<wbr/> When autofocus is disabled (<a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a> == OFF)
12635 and the lens focus distance is set to 0 diopters
12636 (<a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> == 0),<wbr/> the lens will move to focus at infinity
12637 and is stably focused at infinity even if the device tilts.<wbr/> It may take the
12638 lens some time to move; during the move the lens state should be MOVING and
12639 the output diopter value should be changing toward 0.<wbr/></p>
12640             </td>
12641           </tr>
12642
12643           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12644            <!-- end of entry -->
12645
12646
12647
12648
12649
12650           <tr class="entry" id="static_android.lens.facing">
12651             <td class="entry_name
12652              " rowspan="1">
12653               android.<wbr/>lens.<wbr/>facing
12654             </td>
12655             <td class="entry_type">
12656                 <span class="entry_type_name entry_type_name_enum">byte</span>
12657
12658               <span class="entry_type_visibility"> [public]</span>
12659
12660
12661               <span class="entry_type_hwlevel">[legacy] </span>
12662
12663
12664
12665                 <ul class="entry_type_enum">
12666                   <li>
12667                     <span class="entry_type_enum_name">FRONT</span>
12668                     <span class="entry_type_enum_notes"><p>The camera device faces the same direction as the device's screen.<wbr/></p></span>
12669                   </li>
12670                   <li>
12671                     <span class="entry_type_enum_name">BACK</span>
12672                     <span class="entry_type_enum_notes"><p>The camera device faces the opposite direction as the device's screen.<wbr/></p></span>
12673                   </li>
12674                   <li>
12675                     <span class="entry_type_enum_name">EXTERNAL</span>
12676                     <span class="entry_type_enum_notes"><p>The camera device is an external camera,<wbr/> and has no fixed facing relative to the
12677 device's screen.<wbr/></p></span>
12678                   </li>
12679                 </ul>
12680
12681             </td> <!-- entry_type -->
12682
12683             <td class="entry_description">
12684               <p>Direction the camera faces relative to
12685 device screen.<wbr/></p>
12686             </td>
12687
12688             <td class="entry_units">
12689             </td>
12690
12691             <td class="entry_range">
12692             </td>
12693
12694             <td class="entry_tags">
12695             </td>
12696
12697           </tr>
12698
12699
12700           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12701            <!-- end of entry -->
12702
12703
12704           <tr class="entry" id="static_android.lens.poseRotation">
12705             <td class="entry_name
12706              " rowspan="3">
12707               android.<wbr/>lens.<wbr/>pose<wbr/>Rotation
12708             </td>
12709             <td class="entry_type">
12710                 <span class="entry_type_name">float</span>
12711                 <span class="entry_type_container">x</span>
12712
12713                 <span class="entry_type_array">
12714                   4
12715                 </span>
12716               <span class="entry_type_visibility"> [public]</span>
12717
12718
12719
12720
12721
12722
12723             </td> <!-- entry_type -->
12724
12725             <td class="entry_description">
12726               <p>The orientation of the camera relative to the sensor
12727 coordinate system.<wbr/></p>
12728             </td>
12729
12730             <td class="entry_units">
12731
12732             Quaternion coefficients
12733
12734             </td>
12735
12736             <td class="entry_range">
12737             </td>
12738
12739             <td class="entry_tags">
12740               <ul class="entry_tags">
12741                   <li><a href="#tag_DEPTH">DEPTH</a></li>
12742               </ul>
12743             </td>
12744
12745           </tr>
12746           <tr class="entries_header">
12747             <th class="th_details" colspan="5">Details</th>
12748           </tr>
12749           <tr class="entry_cont">
12750             <td class="entry_details" colspan="5">
12751               <p>The four coefficients that describe the quaternion
12752 rotation from the Android sensor coordinate system to a
12753 camera-aligned coordinate system where the X-axis is
12754 aligned with the long side of the image sensor,<wbr/> the Y-axis
12755 is aligned with the short side of the image sensor,<wbr/> and
12756 the Z-axis is aligned with the optical axis of the sensor.<wbr/></p>
12757 <p>To convert from the quaternion coefficients <code>(x,<wbr/>y,<wbr/>z,<wbr/>w)</code>
12758 to the axis of rotation <code>(a_<wbr/>x,<wbr/> a_<wbr/>y,<wbr/> a_<wbr/>z)</code> and rotation
12759 amount <code>theta</code>,<wbr/> the following formulas can be used:</p>
12760 <pre><code> theta = 2 * acos(w)
12761 a_<wbr/>x = x /<wbr/> sin(theta/<wbr/>2)
12762 a_<wbr/>y = y /<wbr/> sin(theta/<wbr/>2)
12763 a_<wbr/>z = z /<wbr/> sin(theta/<wbr/>2)
12764 </code></pre>
12765 <p>To create a 3x3 rotation matrix that applies the rotation
12766 defined by this quaternion,<wbr/> the following matrix can be
12767 used:</p>
12768 <pre><code>R = [ 1 - 2y^2 - 2z^2,<wbr/>       2xy - 2zw,<wbr/>       2xz + 2yw,<wbr/>
12769            2xy + 2zw,<wbr/> 1 - 2x^2 - 2z^2,<wbr/>       2yz - 2xw,<wbr/>
12770            2xz - 2yw,<wbr/>       2yz + 2xw,<wbr/> 1 - 2x^2 - 2y^2 ]
12771 </code></pre>
12772 <p>This matrix can then be used to apply the rotation to a
12773  column vector point with</p>
12774 <p><code>p' = Rp</code></p>
12775 <p>where <code>p</code> is in the device sensor coordinate system,<wbr/> and
12776  <code>p'</code> is in the camera-oriented coordinate system.<wbr/></p>
12777             </td>
12778           </tr>
12779
12780
12781           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12782            <!-- end of entry -->
12783
12784
12785           <tr class="entry" id="static_android.lens.poseTranslation">
12786             <td class="entry_name
12787              " rowspan="3">
12788               android.<wbr/>lens.<wbr/>pose<wbr/>Translation
12789             </td>
12790             <td class="entry_type">
12791                 <span class="entry_type_name">float</span>
12792                 <span class="entry_type_container">x</span>
12793
12794                 <span class="entry_type_array">
12795                   3
12796                 </span>
12797               <span class="entry_type_visibility"> [public]</span>
12798
12799
12800
12801
12802
12803
12804             </td> <!-- entry_type -->
12805
12806             <td class="entry_description">
12807               <p>Position of the camera optical center.<wbr/></p>
12808             </td>
12809
12810             <td class="entry_units">
12811               Meters
12812             </td>
12813
12814             <td class="entry_range">
12815             </td>
12816
12817             <td class="entry_tags">
12818               <ul class="entry_tags">
12819                   <li><a href="#tag_DEPTH">DEPTH</a></li>
12820               </ul>
12821             </td>
12822
12823           </tr>
12824           <tr class="entries_header">
12825             <th class="th_details" colspan="5">Details</th>
12826           </tr>
12827           <tr class="entry_cont">
12828             <td class="entry_details" colspan="5">
12829               <p>The position of the camera device's lens optical center,<wbr/>
12830 as a three-dimensional vector <code>(x,<wbr/>y,<wbr/>z)</code>,<wbr/> relative to the
12831 optical center of the largest camera device facing in the
12832 same direction as this camera,<wbr/> in the <a href="https://developer.android.com/reference/android/hardware/SensorEvent.html">Android sensor coordinate
12833 axes</a>.<wbr/> Note that only the axis definitions are shared with
12834 the sensor coordinate system,<wbr/> but not the origin.<wbr/></p>
12835 <p>If this device is the largest or only camera device with a
12836 given facing,<wbr/> then this position will be <code>(0,<wbr/> 0,<wbr/> 0)</code>; a
12837 camera device with a lens optical center located 3 cm from
12838 the main sensor along the +X axis (to the right from the
12839 user's perspective) will report <code>(0.<wbr/>03,<wbr/> 0,<wbr/> 0)</code>.<wbr/></p>
12840 <p>To transform a pixel coordinates between two cameras
12841 facing the same direction,<wbr/> first the source camera
12842 <a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a> must be corrected for.<wbr/>  Then
12843 the source camera <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a> needs
12844 to be applied,<wbr/> followed by the <a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a>
12845 of the source camera,<wbr/> the translation of the source camera
12846 relative to the destination camera,<wbr/> the
12847 <a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a> of the destination camera,<wbr/> and
12848 finally the inverse of <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a>
12849 of the destination camera.<wbr/> This obtains a
12850 radial-distortion-free coordinate in the destination
12851 camera pixel coordinates.<wbr/></p>
12852 <p>To compare this against a real image from the destination
12853 camera,<wbr/> the destination camera image then needs to be
12854 corrected for radial distortion before comparison or
12855 sampling.<wbr/></p>
12856             </td>
12857           </tr>
12858
12859
12860           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12861            <!-- end of entry -->
12862
12863
12864           <tr class="entry" id="static_android.lens.intrinsicCalibration">
12865             <td class="entry_name
12866              " rowspan="3">
12867               android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration
12868             </td>
12869             <td class="entry_type">
12870                 <span class="entry_type_name">float</span>
12871                 <span class="entry_type_container">x</span>
12872
12873                 <span class="entry_type_array">
12874                   5
12875                 </span>
12876               <span class="entry_type_visibility"> [public]</span>
12877
12878
12879
12880
12881
12882
12883             </td> <!-- entry_type -->
12884
12885             <td class="entry_description">
12886               <p>The parameters for this camera device's intrinsic
12887 calibration.<wbr/></p>
12888             </td>
12889
12890             <td class="entry_units">
12891
12892             Pixels in the
12893             android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size
12894             coordinate system.<wbr/>
12895
12896             </td>
12897
12898             <td class="entry_range">
12899             </td>
12900
12901             <td class="entry_tags">
12902               <ul class="entry_tags">
12903                   <li><a href="#tag_DEPTH">DEPTH</a></li>
12904               </ul>
12905             </td>
12906
12907           </tr>
12908           <tr class="entries_header">
12909             <th class="th_details" colspan="5">Details</th>
12910           </tr>
12911           <tr class="entry_cont">
12912             <td class="entry_details" colspan="5">
12913               <p>The five calibration parameters that describe the
12914 transform from camera-centric 3D coordinates to sensor
12915 pixel coordinates:</p>
12916 <pre><code>[f_<wbr/>x,<wbr/> f_<wbr/>y,<wbr/> c_<wbr/>x,<wbr/> c_<wbr/>y,<wbr/> s]
12917 </code></pre>
12918 <p>Where <code>f_<wbr/>x</code> and <code>f_<wbr/>y</code> are the horizontal and vertical
12919 focal lengths,<wbr/> <code>[c_<wbr/>x,<wbr/> c_<wbr/>y]</code> is the position of the optical
12920 axis,<wbr/> and <code>s</code> is a skew parameter for the sensor plane not
12921 being aligned with the lens plane.<wbr/></p>
12922 <p>These are typically used within a transformation matrix K:</p>
12923 <pre><code>K = [ f_<wbr/>x,<wbr/>   s,<wbr/> c_<wbr/>x,<wbr/>
12924        0,<wbr/> f_<wbr/>y,<wbr/> c_<wbr/>y,<wbr/>
12925        0    0,<wbr/>   1 ]
12926 </code></pre>
12927 <p>which can then be combined with the camera pose rotation
12928 <code>R</code> and translation <code>t</code> (<a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a> and
12929 <a href="#static_android.lens.poseTranslation">android.<wbr/>lens.<wbr/>pose<wbr/>Translation</a>,<wbr/> respective) to calculate the
12930 complete transform from world coordinates to pixel
12931 coordinates:</p>
12932 <pre><code>P = [ K 0   * [ R t
12933      0 1 ]     0 1 ]
12934 </code></pre>
12935 <p>and with <code>p_<wbr/>w</code> being a point in the world coordinate system
12936 and <code>p_<wbr/>s</code> being a point in the camera active pixel array
12937 coordinate system,<wbr/> and with the mapping including the
12938 homogeneous division by z:</p>
12939 <pre><code> p_<wbr/>h = (x_<wbr/>h,<wbr/> y_<wbr/>h,<wbr/> z_<wbr/>h) = P p_<wbr/>w
12940 p_<wbr/>s = p_<wbr/>h /<wbr/> z_<wbr/>h
12941 </code></pre>
12942 <p>so <code>[x_<wbr/>s,<wbr/> y_<wbr/>s]</code> is the pixel coordinates of the world
12943 point,<wbr/> <code>z_<wbr/>s = 1</code>,<wbr/> and <code>w_<wbr/>s</code> is a measurement of disparity
12944 (depth) in pixel coordinates.<wbr/></p>
12945 <p>Note that the coordinate system for this transform is the
12946 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> system,<wbr/>
12947 where <code>(0,<wbr/>0)</code> is the top-left of the
12948 preCorrectionActiveArraySize rectangle.<wbr/> Once the pose and
12949 intrinsic calibration transforms have been applied to a
12950 world point,<wbr/> then the <a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a>
12951 transform needs to be applied,<wbr/> and the result adjusted to
12952 be in the <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> coordinate
12953 system (where <code>(0,<wbr/> 0)</code> is the top-left of the
12954 activeArraySize rectangle),<wbr/> to determine the final pixel
12955 coordinate of the world point for processed (non-RAW)
12956 output buffers.<wbr/></p>
12957             </td>
12958           </tr>
12959
12960
12961           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
12962            <!-- end of entry -->
12963
12964
12965           <tr class="entry" id="static_android.lens.radialDistortion">
12966             <td class="entry_name
12967              " rowspan="3">
12968               android.<wbr/>lens.<wbr/>radial<wbr/>Distortion
12969             </td>
12970             <td class="entry_type">
12971                 <span class="entry_type_name">float</span>
12972                 <span class="entry_type_container">x</span>
12973
12974                 <span class="entry_type_array">
12975                   6
12976                 </span>
12977               <span class="entry_type_visibility"> [public]</span>
12978
12979
12980
12981
12982
12983
12984             </td> <!-- entry_type -->
12985
12986             <td class="entry_description">
12987               <p>The correction coefficients to correct for this camera device's
12988 radial and tangential lens distortion.<wbr/></p>
12989             </td>
12990
12991             <td class="entry_units">
12992
12993             Unitless coefficients.<wbr/>
12994
12995             </td>
12996
12997             <td class="entry_range">
12998             </td>
12999
13000             <td class="entry_tags">
13001               <ul class="entry_tags">
13002                   <li><a href="#tag_DEPTH">DEPTH</a></li>
13003               </ul>
13004             </td>
13005
13006           </tr>
13007           <tr class="entries_header">
13008             <th class="th_details" colspan="5">Details</th>
13009           </tr>
13010           <tr class="entry_cont">
13011             <td class="entry_details" colspan="5">
13012               <p>Four radial distortion coefficients <code>[kappa_<wbr/>0,<wbr/> kappa_<wbr/>1,<wbr/> kappa_<wbr/>2,<wbr/>
13013 kappa_<wbr/>3]</code> and two tangential distortion coefficients
13014 <code>[kappa_<wbr/>4,<wbr/> kappa_<wbr/>5]</code> that can be used to correct the
13015 lens's geometric distortion with the mapping equations:</p>
13016 <pre><code> x_<wbr/>c = x_<wbr/>i * ( kappa_<wbr/>0 + kappa_<wbr/>1 * r^2 + kappa_<wbr/>2 * r^4 + kappa_<wbr/>3 * r^6 ) +
13017        kappa_<wbr/>4 * (2 * x_<wbr/>i * y_<wbr/>i) + kappa_<wbr/>5 * ( r^2 + 2 * x_<wbr/>i^2 )
13018  y_<wbr/>c = y_<wbr/>i * ( kappa_<wbr/>0 + kappa_<wbr/>1 * r^2 + kappa_<wbr/>2 * r^4 + kappa_<wbr/>3 * r^6 ) +
13019        kappa_<wbr/>5 * (2 * x_<wbr/>i * y_<wbr/>i) + kappa_<wbr/>4 * ( r^2 + 2 * y_<wbr/>i^2 )
13020 </code></pre>
13021 <p>Here,<wbr/> <code>[x_<wbr/>c,<wbr/> y_<wbr/>c]</code> are the coordinates to sample in the
13022 input image that correspond to the pixel values in the
13023 corrected image at the coordinate <code>[x_<wbr/>i,<wbr/> y_<wbr/>i]</code>:</p>
13024 <pre><code> correctedImage(x_<wbr/>i,<wbr/> y_<wbr/>i) = sample_<wbr/>at(x_<wbr/>c,<wbr/> y_<wbr/>c,<wbr/> inputImage)
13025 </code></pre>
13026 <p>The pixel coordinates are defined in a normalized
13027 coordinate system related to the
13028 <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a> calibration fields.<wbr/>
13029 Both <code>[x_<wbr/>i,<wbr/> y_<wbr/>i]</code> and <code>[x_<wbr/>c,<wbr/> y_<wbr/>c]</code> have <code>(0,<wbr/>0)</code> at the
13030 lens optical center <code>[c_<wbr/>x,<wbr/> c_<wbr/>y]</code>.<wbr/> The maximum magnitudes
13031 of both x and y coordinates are normalized to be 1 at the
13032 edge further from the optical center,<wbr/> so the range
13033 for both dimensions is <code>-1 &lt;= x &lt;= 1</code>.<wbr/></p>
13034 <p>Finally,<wbr/> <code>r</code> represents the radial distance from the
13035 optical center,<wbr/> <code>r^2 = x_<wbr/>i^2 + y_<wbr/>i^2</code>,<wbr/> and its magnitude
13036 is therefore no larger than <code>|<wbr/>r|<wbr/> &lt;= sqrt(2)</code>.<wbr/></p>
13037 <p>The distortion model used is the Brown-Conrady model.<wbr/></p>
13038             </td>
13039           </tr>
13040
13041
13042           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13043            <!-- end of entry -->
13044
13045
13046
13047       <!-- end of kind -->
13048       </tbody>
13049       <tr><td colspan="6" class="kind">dynamic</td></tr>
13050
13051       <thead class="entries_header">
13052         <tr>
13053           <th class="th_name">Property Name</th>
13054           <th class="th_type">Type</th>
13055           <th class="th_description">Description</th>
13056           <th class="th_units">Units</th>
13057           <th class="th_range">Range</th>
13058           <th class="th_tags">Tags</th>
13059         </tr>
13060       </thead>
13061
13062       <tbody>
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073           <tr class="entry" id="dynamic_android.lens.aperture">
13074             <td class="entry_name
13075              " rowspan="3">
13076               android.<wbr/>lens.<wbr/>aperture
13077             </td>
13078             <td class="entry_type">
13079                 <span class="entry_type_name">float</span>
13080
13081               <span class="entry_type_visibility"> [public]</span>
13082
13083
13084               <span class="entry_type_hwlevel">[full] </span>
13085
13086
13087
13088
13089             </td> <!-- entry_type -->
13090
13091             <td class="entry_description">
13092               <p>The desired lens aperture size,<wbr/> as a ratio of lens focal length to the
13093 effective aperture diameter.<wbr/></p>
13094             </td>
13095
13096             <td class="entry_units">
13097               The f-number (f/<wbr/>N)
13098             </td>
13099
13100             <td class="entry_range">
13101               <p><a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a></p>
13102             </td>
13103
13104             <td class="entry_tags">
13105               <ul class="entry_tags">
13106                   <li><a href="#tag_V1">V1</a></li>
13107               </ul>
13108             </td>
13109
13110           </tr>
13111           <tr class="entries_header">
13112             <th class="th_details" colspan="5">Details</th>
13113           </tr>
13114           <tr class="entry_cont">
13115             <td class="entry_details" colspan="5">
13116               <p>Setting this value is only supported on the camera devices that have a variable
13117 aperture lens.<wbr/></p>
13118 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is OFF,<wbr/>
13119 this can be set along with <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>,<wbr/>
13120 <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>,<wbr/> and <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>
13121 to achieve manual exposure control.<wbr/></p>
13122 <p>The requested aperture value may take several frames to reach the
13123 requested value; the camera device will report the current (intermediate)
13124 aperture size in capture result metadata while the aperture is changing.<wbr/>
13125 While the aperture is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
13126 <p>When this is supported and <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> is one of
13127 the ON modes,<wbr/> this will be overridden by the camera device
13128 auto-exposure algorithm,<wbr/> the overridden values are then provided
13129 back to the user in the corresponding result.<wbr/></p>
13130             </td>
13131           </tr>
13132
13133
13134           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13135            <!-- end of entry -->
13136
13137
13138           <tr class="entry" id="dynamic_android.lens.filterDensity">
13139             <td class="entry_name
13140              " rowspan="3">
13141               android.<wbr/>lens.<wbr/>filter<wbr/>Density
13142             </td>
13143             <td class="entry_type">
13144                 <span class="entry_type_name">float</span>
13145
13146               <span class="entry_type_visibility"> [public]</span>
13147
13148
13149               <span class="entry_type_hwlevel">[full] </span>
13150
13151
13152
13153
13154             </td> <!-- entry_type -->
13155
13156             <td class="entry_description">
13157               <p>The desired setting for the lens neutral density filter(s).<wbr/></p>
13158             </td>
13159
13160             <td class="entry_units">
13161               Exposure Value (EV)
13162             </td>
13163
13164             <td class="entry_range">
13165               <p><a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a></p>
13166             </td>
13167
13168             <td class="entry_tags">
13169               <ul class="entry_tags">
13170                   <li><a href="#tag_V1">V1</a></li>
13171               </ul>
13172             </td>
13173
13174           </tr>
13175           <tr class="entries_header">
13176             <th class="th_details" colspan="5">Details</th>
13177           </tr>
13178           <tr class="entry_cont">
13179             <td class="entry_details" colspan="5">
13180               <p>This control will not be supported on most camera devices.<wbr/></p>
13181 <p>Lens filters are typically used to lower the amount of light the
13182 sensor is exposed to (measured in steps of EV).<wbr/> As used here,<wbr/> an EV
13183 step is the standard logarithmic representation,<wbr/> which are
13184 non-negative,<wbr/> and inversely proportional to the amount of light
13185 hitting the sensor.<wbr/>  For example,<wbr/> setting this to 0 would result
13186 in no reduction of the incoming light,<wbr/> and setting this to 2 would
13187 mean that the filter is set to reduce incoming light by two stops
13188 (allowing 1/<wbr/>4 of the prior amount of light to the sensor).<wbr/></p>
13189 <p>It may take several frames before the lens filter density changes
13190 to the requested value.<wbr/> While the filter density is still changing,<wbr/>
13191 <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will be set to MOVING.<wbr/></p>
13192             </td>
13193           </tr>
13194
13195
13196           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13197            <!-- end of entry -->
13198
13199
13200           <tr class="entry" id="dynamic_android.lens.focalLength">
13201             <td class="entry_name
13202              " rowspan="3">
13203               android.<wbr/>lens.<wbr/>focal<wbr/>Length
13204             </td>
13205             <td class="entry_type">
13206                 <span class="entry_type_name">float</span>
13207
13208               <span class="entry_type_visibility"> [public]</span>
13209
13210
13211               <span class="entry_type_hwlevel">[legacy] </span>
13212
13213
13214
13215
13216             </td> <!-- entry_type -->
13217
13218             <td class="entry_description">
13219               <p>The desired lens focal length; used for optical zoom.<wbr/></p>
13220             </td>
13221
13222             <td class="entry_units">
13223               Millimeters
13224             </td>
13225
13226             <td class="entry_range">
13227               <p><a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a></p>
13228             </td>
13229
13230             <td class="entry_tags">
13231               <ul class="entry_tags">
13232                   <li><a href="#tag_BC">BC</a></li>
13233               </ul>
13234             </td>
13235
13236           </tr>
13237           <tr class="entries_header">
13238             <th class="th_details" colspan="5">Details</th>
13239           </tr>
13240           <tr class="entry_cont">
13241             <td class="entry_details" colspan="5">
13242               <p>This setting controls the physical focal length of the camera
13243 device's lens.<wbr/> Changing the focal length changes the field of
13244 view of the camera device,<wbr/> and is usually used for optical zoom.<wbr/></p>
13245 <p>Like <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> this
13246 setting won't be applied instantaneously,<wbr/> and it may take several
13247 frames before the lens can change to the requested focal length.<wbr/>
13248 While the focal length is still changing,<wbr/> <a href="#dynamic_android.lens.state">android.<wbr/>lens.<wbr/>state</a> will
13249 be set to MOVING.<wbr/></p>
13250 <p>Optical zoom will not be supported on most devices.<wbr/></p>
13251             </td>
13252           </tr>
13253
13254
13255           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13256            <!-- end of entry -->
13257
13258
13259           <tr class="entry" id="dynamic_android.lens.focusDistance">
13260             <td class="entry_name
13261              " rowspan="3">
13262               android.<wbr/>lens.<wbr/>focus<wbr/>Distance
13263             </td>
13264             <td class="entry_type">
13265                 <span class="entry_type_name">float</span>
13266
13267               <span class="entry_type_visibility"> [public]</span>
13268
13269
13270               <span class="entry_type_hwlevel">[full] </span>
13271
13272
13273
13274
13275             </td> <!-- entry_type -->
13276
13277             <td class="entry_description">
13278               <p>Desired distance to plane of sharpest focus,<wbr/>
13279 measured from frontmost surface of the lens.<wbr/></p>
13280             </td>
13281
13282             <td class="entry_units">
13283               See android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details
13284             </td>
13285
13286             <td class="entry_range">
13287               <p>&gt;= 0</p>
13288             </td>
13289
13290             <td class="entry_tags">
13291               <ul class="entry_tags">
13292                   <li><a href="#tag_BC">BC</a></li>
13293               </ul>
13294             </td>
13295
13296           </tr>
13297           <tr class="entries_header">
13298             <th class="th_details" colspan="5">Details</th>
13299           </tr>
13300           <tr class="entry_cont">
13301             <td class="entry_details" colspan="5">
13302               <p>Should be zero for fixed-focus cameras</p>
13303             </td>
13304           </tr>
13305
13306
13307           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13308            <!-- end of entry -->
13309
13310
13311           <tr class="entry" id="dynamic_android.lens.focusRange">
13312             <td class="entry_name
13313              " rowspan="3">
13314               android.<wbr/>lens.<wbr/>focus<wbr/>Range
13315             </td>
13316             <td class="entry_type">
13317                 <span class="entry_type_name">float</span>
13318                 <span class="entry_type_container">x</span>
13319
13320                 <span class="entry_type_array">
13321                   2
13322                 </span>
13323               <span class="entry_type_visibility"> [public as pairFloatFloat]</span>
13324
13325
13326               <span class="entry_type_hwlevel">[limited] </span>
13327
13328
13329                 <div class="entry_type_notes">Range of scene distances that are in focus</div>
13330
13331
13332             </td> <!-- entry_type -->
13333
13334             <td class="entry_description">
13335               <p>The range of scene distances that are in
13336 sharp focus (depth of field).<wbr/></p>
13337             </td>
13338
13339             <td class="entry_units">
13340               A pair of focus distances in diopters: (near,<wbr/>
13341           far); see android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration for details.<wbr/>
13342             </td>
13343
13344             <td class="entry_range">
13345               <p>&gt;=0</p>
13346             </td>
13347
13348             <td class="entry_tags">
13349               <ul class="entry_tags">
13350                   <li><a href="#tag_BC">BC</a></li>
13351               </ul>
13352             </td>
13353
13354           </tr>
13355           <tr class="entries_header">
13356             <th class="th_details" colspan="5">Details</th>
13357           </tr>
13358           <tr class="entry_cont">
13359             <td class="entry_details" colspan="5">
13360               <p>If variable focus not supported,<wbr/> can still report
13361 fixed depth of field range</p>
13362             </td>
13363           </tr>
13364
13365
13366           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13367            <!-- end of entry -->
13368
13369
13370           <tr class="entry" id="dynamic_android.lens.opticalStabilizationMode">
13371             <td class="entry_name
13372              " rowspan="3">
13373               android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode
13374             </td>
13375             <td class="entry_type">
13376                 <span class="entry_type_name entry_type_name_enum">byte</span>
13377
13378               <span class="entry_type_visibility"> [public]</span>
13379
13380
13381               <span class="entry_type_hwlevel">[limited] </span>
13382
13383
13384
13385                 <ul class="entry_type_enum">
13386                   <li>
13387                     <span class="entry_type_enum_name">OFF</span>
13388                     <span class="entry_type_enum_notes"><p>Optical stabilization is unavailable.<wbr/></p></span>
13389                   </li>
13390                   <li>
13391                     <span class="entry_type_enum_name">ON</span>
13392                     <span class="entry_type_enum_optional">[optional]</span>
13393                     <span class="entry_type_enum_notes"><p>Optical stabilization is enabled.<wbr/></p></span>
13394                   </li>
13395                 </ul>
13396
13397             </td> <!-- entry_type -->
13398
13399             <td class="entry_description">
13400               <p>Sets whether the camera device uses optical image stabilization (OIS)
13401 when capturing images.<wbr/></p>
13402             </td>
13403
13404             <td class="entry_units">
13405             </td>
13406
13407             <td class="entry_range">
13408               <p><a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a></p>
13409             </td>
13410
13411             <td class="entry_tags">
13412               <ul class="entry_tags">
13413                   <li><a href="#tag_V1">V1</a></li>
13414               </ul>
13415             </td>
13416
13417           </tr>
13418           <tr class="entries_header">
13419             <th class="th_details" colspan="5">Details</th>
13420           </tr>
13421           <tr class="entry_cont">
13422             <td class="entry_details" colspan="5">
13423               <p>OIS is used to compensate for motion blur due to small
13424 movements of the camera during capture.<wbr/> Unlike digital image
13425 stabilization (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> OIS
13426 makes use of mechanical elements to stabilize the camera
13427 sensor,<wbr/> and thus allows for longer exposure times before
13428 camera shake becomes apparent.<wbr/></p>
13429 <p>Switching between different optical stabilization modes may take several
13430 frames to initialize,<wbr/> the camera device will report the current mode in
13431 capture result metadata.<wbr/> For example,<wbr/> When "ON" mode is requested,<wbr/> the
13432 optical stabilization modes in the first several capture results may still
13433 be "OFF",<wbr/> and it will become "ON" when the initialization is done.<wbr/></p>
13434 <p>If a camera device supports both OIS and digital image stabilization
13435 (<a href="#controls_android.control.videoStabilizationMode">android.<wbr/>control.<wbr/>video<wbr/>Stabilization<wbr/>Mode</a>),<wbr/> turning both modes on may produce undesirable
13436 interaction,<wbr/> so it is recommended not to enable both at the same time.<wbr/></p>
13437 <p>Not all devices will support OIS; see
13438 <a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a> for
13439 available controls.<wbr/></p>
13440             </td>
13441           </tr>
13442
13443
13444           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13445            <!-- end of entry -->
13446
13447
13448           <tr class="entry" id="dynamic_android.lens.state">
13449             <td class="entry_name
13450              " rowspan="3">
13451               android.<wbr/>lens.<wbr/>state
13452             </td>
13453             <td class="entry_type">
13454                 <span class="entry_type_name entry_type_name_enum">byte</span>
13455
13456               <span class="entry_type_visibility"> [public]</span>
13457
13458
13459               <span class="entry_type_hwlevel">[limited] </span>
13460
13461
13462
13463                 <ul class="entry_type_enum">
13464                   <li>
13465                     <span class="entry_type_enum_name">STATIONARY</span>
13466                     <span class="entry_type_enum_notes"><p>The lens parameters (<a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
13467 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>) are not changing.<wbr/></p></span>
13468                   </li>
13469                   <li>
13470                     <span class="entry_type_enum_name">MOVING</span>
13471                     <span class="entry_type_enum_notes"><p>One or several of the lens parameters
13472 (<a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
13473 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> or <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>) is
13474 currently changing.<wbr/></p></span>
13475                   </li>
13476                 </ul>
13477
13478             </td> <!-- entry_type -->
13479
13480             <td class="entry_description">
13481               <p>Current lens status.<wbr/></p>
13482             </td>
13483
13484             <td class="entry_units">
13485             </td>
13486
13487             <td class="entry_range">
13488             </td>
13489
13490             <td class="entry_tags">
13491               <ul class="entry_tags">
13492                   <li><a href="#tag_V1">V1</a></li>
13493               </ul>
13494             </td>
13495
13496           </tr>
13497           <tr class="entries_header">
13498             <th class="th_details" colspan="5">Details</th>
13499           </tr>
13500           <tr class="entry_cont">
13501             <td class="entry_details" colspan="5">
13502               <p>For lens parameters <a href="#controls_android.lens.focalLength">android.<wbr/>lens.<wbr/>focal<wbr/>Length</a>,<wbr/> <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a>,<wbr/>
13503 <a href="#controls_android.lens.filterDensity">android.<wbr/>lens.<wbr/>filter<wbr/>Density</a> and <a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a>,<wbr/> when changes are requested,<wbr/>
13504 they may take several frames to reach the requested values.<wbr/> This state indicates
13505 the current status of the lens parameters.<wbr/></p>
13506 <p>When the state is STATIONARY,<wbr/> the lens parameters are not changing.<wbr/> This could be
13507 either because the parameters are all fixed,<wbr/> or because the lens has had enough
13508 time to reach the most recently-requested values.<wbr/>
13509 If all these lens parameters are not changable for a camera device,<wbr/> as listed below:</p>
13510 <ul>
13511 <li>Fixed focus (<code><a href="#static_android.lens.info.minimumFocusDistance">android.<wbr/>lens.<wbr/>info.<wbr/>minimum<wbr/>Focus<wbr/>Distance</a> == 0</code>),<wbr/> which means
13512 <a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a> parameter will always be 0.<wbr/></li>
13513 <li>Fixed focal length (<a href="#static_android.lens.info.availableFocalLengths">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Focal<wbr/>Lengths</a> contains single value),<wbr/>
13514 which means the optical zoom is not supported.<wbr/></li>
13515 <li>No ND filter (<a href="#static_android.lens.info.availableFilterDensities">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Filter<wbr/>Densities</a> contains only 0).<wbr/></li>
13516 <li>Fixed aperture (<a href="#static_android.lens.info.availableApertures">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Apertures</a> contains single value).<wbr/></li>
13517 </ul>
13518 <p>Then this state will always be STATIONARY.<wbr/></p>
13519 <p>When the state is MOVING,<wbr/> it indicates that at least one of the lens parameters
13520 is changing.<wbr/></p>
13521             </td>
13522           </tr>
13523
13524
13525           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13526            <!-- end of entry -->
13527
13528
13529           <tr class="entry" id="dynamic_android.lens.poseRotation">
13530             <td class="entry_name
13531              " rowspan="3">
13532               android.<wbr/>lens.<wbr/>pose<wbr/>Rotation
13533             </td>
13534             <td class="entry_type">
13535                 <span class="entry_type_name">float</span>
13536                 <span class="entry_type_container">x</span>
13537
13538                 <span class="entry_type_array">
13539                   4
13540                 </span>
13541               <span class="entry_type_visibility"> [public]</span>
13542
13543
13544
13545
13546
13547
13548             </td> <!-- entry_type -->
13549
13550             <td class="entry_description">
13551               <p>The orientation of the camera relative to the sensor
13552 coordinate system.<wbr/></p>
13553             </td>
13554
13555             <td class="entry_units">
13556
13557             Quaternion coefficients
13558
13559             </td>
13560
13561             <td class="entry_range">
13562             </td>
13563
13564             <td class="entry_tags">
13565               <ul class="entry_tags">
13566                   <li><a href="#tag_DEPTH">DEPTH</a></li>
13567               </ul>
13568             </td>
13569
13570           </tr>
13571           <tr class="entries_header">
13572             <th class="th_details" colspan="5">Details</th>
13573           </tr>
13574           <tr class="entry_cont">
13575             <td class="entry_details" colspan="5">
13576               <p>The four coefficients that describe the quaternion
13577 rotation from the Android sensor coordinate system to a
13578 camera-aligned coordinate system where the X-axis is
13579 aligned with the long side of the image sensor,<wbr/> the Y-axis
13580 is aligned with the short side of the image sensor,<wbr/> and
13581 the Z-axis is aligned with the optical axis of the sensor.<wbr/></p>
13582 <p>To convert from the quaternion coefficients <code>(x,<wbr/>y,<wbr/>z,<wbr/>w)</code>
13583 to the axis of rotation <code>(a_<wbr/>x,<wbr/> a_<wbr/>y,<wbr/> a_<wbr/>z)</code> and rotation
13584 amount <code>theta</code>,<wbr/> the following formulas can be used:</p>
13585 <pre><code> theta = 2 * acos(w)
13586 a_<wbr/>x = x /<wbr/> sin(theta/<wbr/>2)
13587 a_<wbr/>y = y /<wbr/> sin(theta/<wbr/>2)
13588 a_<wbr/>z = z /<wbr/> sin(theta/<wbr/>2)
13589 </code></pre>
13590 <p>To create a 3x3 rotation matrix that applies the rotation
13591 defined by this quaternion,<wbr/> the following matrix can be
13592 used:</p>
13593 <pre><code>R = [ 1 - 2y^2 - 2z^2,<wbr/>       2xy - 2zw,<wbr/>       2xz + 2yw,<wbr/>
13594            2xy + 2zw,<wbr/> 1 - 2x^2 - 2z^2,<wbr/>       2yz - 2xw,<wbr/>
13595            2xz - 2yw,<wbr/>       2yz + 2xw,<wbr/> 1 - 2x^2 - 2y^2 ]
13596 </code></pre>
13597 <p>This matrix can then be used to apply the rotation to a
13598  column vector point with</p>
13599 <p><code>p' = Rp</code></p>
13600 <p>where <code>p</code> is in the device sensor coordinate system,<wbr/> and
13601  <code>p'</code> is in the camera-oriented coordinate system.<wbr/></p>
13602             </td>
13603           </tr>
13604
13605
13606           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13607            <!-- end of entry -->
13608
13609
13610           <tr class="entry" id="dynamic_android.lens.poseTranslation">
13611             <td class="entry_name
13612              " rowspan="3">
13613               android.<wbr/>lens.<wbr/>pose<wbr/>Translation
13614             </td>
13615             <td class="entry_type">
13616                 <span class="entry_type_name">float</span>
13617                 <span class="entry_type_container">x</span>
13618
13619                 <span class="entry_type_array">
13620                   3
13621                 </span>
13622               <span class="entry_type_visibility"> [public]</span>
13623
13624
13625
13626
13627
13628
13629             </td> <!-- entry_type -->
13630
13631             <td class="entry_description">
13632               <p>Position of the camera optical center.<wbr/></p>
13633             </td>
13634
13635             <td class="entry_units">
13636               Meters
13637             </td>
13638
13639             <td class="entry_range">
13640             </td>
13641
13642             <td class="entry_tags">
13643               <ul class="entry_tags">
13644                   <li><a href="#tag_DEPTH">DEPTH</a></li>
13645               </ul>
13646             </td>
13647
13648           </tr>
13649           <tr class="entries_header">
13650             <th class="th_details" colspan="5">Details</th>
13651           </tr>
13652           <tr class="entry_cont">
13653             <td class="entry_details" colspan="5">
13654               <p>The position of the camera device's lens optical center,<wbr/>
13655 as a three-dimensional vector <code>(x,<wbr/>y,<wbr/>z)</code>,<wbr/> relative to the
13656 optical center of the largest camera device facing in the
13657 same direction as this camera,<wbr/> in the <a href="https://developer.android.com/reference/android/hardware/SensorEvent.html">Android sensor coordinate
13658 axes</a>.<wbr/> Note that only the axis definitions are shared with
13659 the sensor coordinate system,<wbr/> but not the origin.<wbr/></p>
13660 <p>If this device is the largest or only camera device with a
13661 given facing,<wbr/> then this position will be <code>(0,<wbr/> 0,<wbr/> 0)</code>; a
13662 camera device with a lens optical center located 3 cm from
13663 the main sensor along the +X axis (to the right from the
13664 user's perspective) will report <code>(0.<wbr/>03,<wbr/> 0,<wbr/> 0)</code>.<wbr/></p>
13665 <p>To transform a pixel coordinates between two cameras
13666 facing the same direction,<wbr/> first the source camera
13667 <a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a> must be corrected for.<wbr/>  Then
13668 the source camera <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a> needs
13669 to be applied,<wbr/> followed by the <a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a>
13670 of the source camera,<wbr/> the translation of the source camera
13671 relative to the destination camera,<wbr/> the
13672 <a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a> of the destination camera,<wbr/> and
13673 finally the inverse of <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a>
13674 of the destination camera.<wbr/> This obtains a
13675 radial-distortion-free coordinate in the destination
13676 camera pixel coordinates.<wbr/></p>
13677 <p>To compare this against a real image from the destination
13678 camera,<wbr/> the destination camera image then needs to be
13679 corrected for radial distortion before comparison or
13680 sampling.<wbr/></p>
13681             </td>
13682           </tr>
13683
13684
13685           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13686            <!-- end of entry -->
13687
13688
13689           <tr class="entry" id="dynamic_android.lens.intrinsicCalibration">
13690             <td class="entry_name
13691              " rowspan="3">
13692               android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration
13693             </td>
13694             <td class="entry_type">
13695                 <span class="entry_type_name">float</span>
13696                 <span class="entry_type_container">x</span>
13697
13698                 <span class="entry_type_array">
13699                   5
13700                 </span>
13701               <span class="entry_type_visibility"> [public]</span>
13702
13703
13704
13705
13706
13707
13708             </td> <!-- entry_type -->
13709
13710             <td class="entry_description">
13711               <p>The parameters for this camera device's intrinsic
13712 calibration.<wbr/></p>
13713             </td>
13714
13715             <td class="entry_units">
13716
13717             Pixels in the
13718             android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size
13719             coordinate system.<wbr/>
13720
13721             </td>
13722
13723             <td class="entry_range">
13724             </td>
13725
13726             <td class="entry_tags">
13727               <ul class="entry_tags">
13728                   <li><a href="#tag_DEPTH">DEPTH</a></li>
13729               </ul>
13730             </td>
13731
13732           </tr>
13733           <tr class="entries_header">
13734             <th class="th_details" colspan="5">Details</th>
13735           </tr>
13736           <tr class="entry_cont">
13737             <td class="entry_details" colspan="5">
13738               <p>The five calibration parameters that describe the
13739 transform from camera-centric 3D coordinates to sensor
13740 pixel coordinates:</p>
13741 <pre><code>[f_<wbr/>x,<wbr/> f_<wbr/>y,<wbr/> c_<wbr/>x,<wbr/> c_<wbr/>y,<wbr/> s]
13742 </code></pre>
13743 <p>Where <code>f_<wbr/>x</code> and <code>f_<wbr/>y</code> are the horizontal and vertical
13744 focal lengths,<wbr/> <code>[c_<wbr/>x,<wbr/> c_<wbr/>y]</code> is the position of the optical
13745 axis,<wbr/> and <code>s</code> is a skew parameter for the sensor plane not
13746 being aligned with the lens plane.<wbr/></p>
13747 <p>These are typically used within a transformation matrix K:</p>
13748 <pre><code>K = [ f_<wbr/>x,<wbr/>   s,<wbr/> c_<wbr/>x,<wbr/>
13749        0,<wbr/> f_<wbr/>y,<wbr/> c_<wbr/>y,<wbr/>
13750        0    0,<wbr/>   1 ]
13751 </code></pre>
13752 <p>which can then be combined with the camera pose rotation
13753 <code>R</code> and translation <code>t</code> (<a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a> and
13754 <a href="#static_android.lens.poseTranslation">android.<wbr/>lens.<wbr/>pose<wbr/>Translation</a>,<wbr/> respective) to calculate the
13755 complete transform from world coordinates to pixel
13756 coordinates:</p>
13757 <pre><code>P = [ K 0   * [ R t
13758      0 1 ]     0 1 ]
13759 </code></pre>
13760 <p>and with <code>p_<wbr/>w</code> being a point in the world coordinate system
13761 and <code>p_<wbr/>s</code> being a point in the camera active pixel array
13762 coordinate system,<wbr/> and with the mapping including the
13763 homogeneous division by z:</p>
13764 <pre><code> p_<wbr/>h = (x_<wbr/>h,<wbr/> y_<wbr/>h,<wbr/> z_<wbr/>h) = P p_<wbr/>w
13765 p_<wbr/>s = p_<wbr/>h /<wbr/> z_<wbr/>h
13766 </code></pre>
13767 <p>so <code>[x_<wbr/>s,<wbr/> y_<wbr/>s]</code> is the pixel coordinates of the world
13768 point,<wbr/> <code>z_<wbr/>s = 1</code>,<wbr/> and <code>w_<wbr/>s</code> is a measurement of disparity
13769 (depth) in pixel coordinates.<wbr/></p>
13770 <p>Note that the coordinate system for this transform is the
13771 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> system,<wbr/>
13772 where <code>(0,<wbr/>0)</code> is the top-left of the
13773 preCorrectionActiveArraySize rectangle.<wbr/> Once the pose and
13774 intrinsic calibration transforms have been applied to a
13775 world point,<wbr/> then the <a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a>
13776 transform needs to be applied,<wbr/> and the result adjusted to
13777 be in the <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> coordinate
13778 system (where <code>(0,<wbr/> 0)</code> is the top-left of the
13779 activeArraySize rectangle),<wbr/> to determine the final pixel
13780 coordinate of the world point for processed (non-RAW)
13781 output buffers.<wbr/></p>
13782             </td>
13783           </tr>
13784
13785
13786           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13787            <!-- end of entry -->
13788
13789
13790           <tr class="entry" id="dynamic_android.lens.radialDistortion">
13791             <td class="entry_name
13792              " rowspan="3">
13793               android.<wbr/>lens.<wbr/>radial<wbr/>Distortion
13794             </td>
13795             <td class="entry_type">
13796                 <span class="entry_type_name">float</span>
13797                 <span class="entry_type_container">x</span>
13798
13799                 <span class="entry_type_array">
13800                   6
13801                 </span>
13802               <span class="entry_type_visibility"> [public]</span>
13803
13804
13805
13806
13807
13808
13809             </td> <!-- entry_type -->
13810
13811             <td class="entry_description">
13812               <p>The correction coefficients to correct for this camera device's
13813 radial and tangential lens distortion.<wbr/></p>
13814             </td>
13815
13816             <td class="entry_units">
13817
13818             Unitless coefficients.<wbr/>
13819
13820             </td>
13821
13822             <td class="entry_range">
13823             </td>
13824
13825             <td class="entry_tags">
13826               <ul class="entry_tags">
13827                   <li><a href="#tag_DEPTH">DEPTH</a></li>
13828               </ul>
13829             </td>
13830
13831           </tr>
13832           <tr class="entries_header">
13833             <th class="th_details" colspan="5">Details</th>
13834           </tr>
13835           <tr class="entry_cont">
13836             <td class="entry_details" colspan="5">
13837               <p>Four radial distortion coefficients <code>[kappa_<wbr/>0,<wbr/> kappa_<wbr/>1,<wbr/> kappa_<wbr/>2,<wbr/>
13838 kappa_<wbr/>3]</code> and two tangential distortion coefficients
13839 <code>[kappa_<wbr/>4,<wbr/> kappa_<wbr/>5]</code> that can be used to correct the
13840 lens's geometric distortion with the mapping equations:</p>
13841 <pre><code> x_<wbr/>c = x_<wbr/>i * ( kappa_<wbr/>0 + kappa_<wbr/>1 * r^2 + kappa_<wbr/>2 * r^4 + kappa_<wbr/>3 * r^6 ) +
13842        kappa_<wbr/>4 * (2 * x_<wbr/>i * y_<wbr/>i) + kappa_<wbr/>5 * ( r^2 + 2 * x_<wbr/>i^2 )
13843  y_<wbr/>c = y_<wbr/>i * ( kappa_<wbr/>0 + kappa_<wbr/>1 * r^2 + kappa_<wbr/>2 * r^4 + kappa_<wbr/>3 * r^6 ) +
13844        kappa_<wbr/>5 * (2 * x_<wbr/>i * y_<wbr/>i) + kappa_<wbr/>4 * ( r^2 + 2 * y_<wbr/>i^2 )
13845 </code></pre>
13846 <p>Here,<wbr/> <code>[x_<wbr/>c,<wbr/> y_<wbr/>c]</code> are the coordinates to sample in the
13847 input image that correspond to the pixel values in the
13848 corrected image at the coordinate <code>[x_<wbr/>i,<wbr/> y_<wbr/>i]</code>:</p>
13849 <pre><code> correctedImage(x_<wbr/>i,<wbr/> y_<wbr/>i) = sample_<wbr/>at(x_<wbr/>c,<wbr/> y_<wbr/>c,<wbr/> inputImage)
13850 </code></pre>
13851 <p>The pixel coordinates are defined in a normalized
13852 coordinate system related to the
13853 <a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a> calibration fields.<wbr/>
13854 Both <code>[x_<wbr/>i,<wbr/> y_<wbr/>i]</code> and <code>[x_<wbr/>c,<wbr/> y_<wbr/>c]</code> have <code>(0,<wbr/>0)</code> at the
13855 lens optical center <code>[c_<wbr/>x,<wbr/> c_<wbr/>y]</code>.<wbr/> The maximum magnitudes
13856 of both x and y coordinates are normalized to be 1 at the
13857 edge further from the optical center,<wbr/> so the range
13858 for both dimensions is <code>-1 &lt;= x &lt;= 1</code>.<wbr/></p>
13859 <p>Finally,<wbr/> <code>r</code> represents the radial distance from the
13860 optical center,<wbr/> <code>r^2 = x_<wbr/>i^2 + y_<wbr/>i^2</code>,<wbr/> and its magnitude
13861 is therefore no larger than <code>|<wbr/>r|<wbr/> &lt;= sqrt(2)</code>.<wbr/></p>
13862 <p>The distortion model used is the Brown-Conrady model.<wbr/></p>
13863             </td>
13864           </tr>
13865
13866
13867           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
13868            <!-- end of entry -->
13869
13870
13871
13872       <!-- end of kind -->
13873       </tbody>
13874
13875   <!-- end of section -->
13876   <tr><td colspan="6" id="section_noiseReduction" class="section">noiseReduction</td></tr>
13877
13878
13879       <tr><td colspan="6" class="kind">controls</td></tr>
13880
13881       <thead class="entries_header">
13882         <tr>
13883           <th class="th_name">Property Name</th>
13884           <th class="th_type">Type</th>
13885           <th class="th_description">Description</th>
13886           <th class="th_units">Units</th>
13887           <th class="th_range">Range</th>
13888           <th class="th_tags">Tags</th>
13889         </tr>
13890       </thead>
13891
13892       <tbody>
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903           <tr class="entry" id="controls_android.noiseReduction.mode">
13904             <td class="entry_name
13905              " rowspan="5">
13906               android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
13907             </td>
13908             <td class="entry_type">
13909                 <span class="entry_type_name entry_type_name_enum">byte</span>
13910
13911               <span class="entry_type_visibility"> [public]</span>
13912
13913
13914               <span class="entry_type_hwlevel">[full] </span>
13915
13916
13917
13918                 <ul class="entry_type_enum">
13919                   <li>
13920                     <span class="entry_type_enum_name">OFF</span>
13921                     <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
13922                   </li>
13923                   <li>
13924                     <span class="entry_type_enum_name">FAST</span>
13925                     <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
13926 output.<wbr/> It may be the same as OFF if noise reduction will reduce frame rate
13927 relative to sensor.<wbr/></p></span>
13928                   </li>
13929                   <li>
13930                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
13931                     <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of possibly reduced frame
13932 rate relative to sensor output.<wbr/></p></span>
13933                   </li>
13934                   <li>
13935                     <span class="entry_type_enum_name">MINIMAL</span>
13936                     <span class="entry_type_enum_optional">[optional]</span>
13937                     <span class="entry_type_enum_notes"><p>MINIMAL noise reduction is applied without reducing frame rate relative to
13938 sensor output.<wbr/> </p></span>
13939                   </li>
13940                   <li>
13941                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
13942                     <span class="entry_type_enum_optional">[optional]</span>
13943                     <span class="entry_type_enum_notes"><p>Noise reduction is applied at different levels for different output streams,<wbr/>
13944 based on resolution.<wbr/> Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>) or below have noise
13945 reduction applied,<wbr/> while higher-resolution streams have MINIMAL (if supported) or no
13946 noise reduction applied (if MINIMAL is not supported.<wbr/>) The degree of noise reduction
13947 for low-resolution streams is tuned so that frame rate is not impacted,<wbr/> and the quality
13948 is equal to or better than FAST (since it is only applied to lower-resolution outputs,<wbr/>
13949 quality may improve from FAST).<wbr/></p>
13950 <p>This mode is intended to be used by applications operating in a zero-shutter-lag mode
13951 with YUV or PRIVATE reprocessing,<wbr/> where the application continuously captures
13952 high-resolution intermediate buffers into a circular buffer,<wbr/> from which a final image is
13953 produced via reprocessing when a user takes a picture.<wbr/>  For such a use case,<wbr/> the
13954 high-resolution buffers must not have noise reduction applied to maximize efficiency of
13955 preview and to avoid over-applying noise filtering when reprocessing,<wbr/> while
13956 low-resolution buffers (used for recording or preview,<wbr/> generally) need noise reduction
13957 applied for reasonable preview quality.<wbr/></p>
13958 <p>This mode is guaranteed to be supported by devices that support either the
13959 YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING capabilities
13960 (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> lists either of those capabilities) and it will
13961 be the default mode for CAMERA3_<wbr/>TEMPLATE_<wbr/>ZERO_<wbr/>SHUTTER_<wbr/>LAG template.<wbr/></p></span>
13962                   </li>
13963                 </ul>
13964
13965             </td> <!-- entry_type -->
13966
13967             <td class="entry_description">
13968               <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
13969             </td>
13970
13971             <td class="entry_units">
13972             </td>
13973
13974             <td class="entry_range">
13975               <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
13976             </td>
13977
13978             <td class="entry_tags">
13979               <ul class="entry_tags">
13980                   <li><a href="#tag_V1">V1</a></li>
13981                   <li><a href="#tag_REPROC">REPROC</a></li>
13982               </ul>
13983             </td>
13984
13985           </tr>
13986           <tr class="entries_header">
13987             <th class="th_details" colspan="5">Details</th>
13988           </tr>
13989           <tr class="entry_cont">
13990             <td class="entry_details" colspan="5">
13991               <p>The noise reduction algorithm attempts to improve image quality by removing
13992 excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/></p>
13993 <p>OFF means no noise reduction will be applied by the camera device,<wbr/> for both raw and
13994 YUV domain.<wbr/></p>
13995 <p>MINIMAL means that only sensor raw domain basic noise reduction is enabled ,<wbr/>to remove
13996 demosaicing or other processing artifacts.<wbr/> For YUV_<wbr/>REPROCESSING,<wbr/> MINIMAL is same as OFF.<wbr/>
13997 This mode is optional,<wbr/> may not be support by all devices.<wbr/> The application should check
13998 <a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a> before using it.<wbr/></p>
13999 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
14000 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
14001 will use the highest-quality noise filtering algorithms,<wbr/>
14002 even if it slows down capture rate.<wbr/> FAST means the camera device will not
14003 slow down capture rate when applying noise filtering.<wbr/> FAST may be the same as MINIMAL if
14004 MINIMAL is listed,<wbr/> or the same as OFF if any noise filtering will slow down capture rate.<wbr/>
14005 Every output stream will have a similar amount of enhancement applied.<wbr/></p>
14006 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG is meant to be used by applications that maintain a continuous circular
14007 buffer of high-resolution images during preview and reprocess image(s) from that buffer
14008 into a final capture when triggered by the user.<wbr/> In this mode,<wbr/> the camera device applies
14009 noise reduction to low-resolution streams (below maximum recording resolution) to maximize
14010 preview quality,<wbr/> but does not apply noise reduction to high-resolution streams,<wbr/> since
14011 those will be reprocessed later if necessary.<wbr/></p>
14012 <p>For YUV_<wbr/>REPROCESSING,<wbr/> these FAST/<wbr/>HIGH_<wbr/>QUALITY modes both mean that the camera device
14013 will apply FAST/<wbr/>HIGH_<wbr/>QUALITY YUV domain noise reduction,<wbr/> respectively.<wbr/> The camera device
14014 may adjust the noise reduction parameters for best image quality based on the
14015 <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> if it is set.<wbr/></p>
14016             </td>
14017           </tr>
14018
14019           <tr class="entries_header">
14020             <th class="th_details" colspan="5">HAL Implementation Details</th>
14021           </tr>
14022           <tr class="entry_cont">
14023             <td class="entry_details" colspan="5">
14024               <p>For YUV_<wbr/>REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> to
14025 adjust the internal noise reduction parameters appropriately to get the best quality
14026 images.<wbr/></p>
14027             </td>
14028           </tr>
14029
14030           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14031            <!-- end of entry -->
14032
14033
14034           <tr class="entry" id="controls_android.noiseReduction.strength">
14035             <td class="entry_name
14036              " rowspan="1">
14037               android.<wbr/>noise<wbr/>Reduction.<wbr/>strength
14038             </td>
14039             <td class="entry_type">
14040                 <span class="entry_type_name">byte</span>
14041
14042               <span class="entry_type_visibility"> [system]</span>
14043
14044
14045
14046
14047
14048
14049             </td> <!-- entry_type -->
14050
14051             <td class="entry_description">
14052               <p>Control the amount of noise reduction
14053 applied to the images</p>
14054             </td>
14055
14056             <td class="entry_units">
14057               1-10; 10 is max noise reduction
14058             </td>
14059
14060             <td class="entry_range">
14061               <p>1 - 10</p>
14062             </td>
14063
14064             <td class="entry_tags">
14065               <ul class="entry_tags">
14066                   <li><a href="#tag_FUTURE">FUTURE</a></li>
14067               </ul>
14068             </td>
14069
14070           </tr>
14071
14072
14073           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14074            <!-- end of entry -->
14075
14076
14077
14078       <!-- end of kind -->
14079       </tbody>
14080       <tr><td colspan="6" class="kind">static</td></tr>
14081
14082       <thead class="entries_header">
14083         <tr>
14084           <th class="th_name">Property Name</th>
14085           <th class="th_type">Type</th>
14086           <th class="th_description">Description</th>
14087           <th class="th_units">Units</th>
14088           <th class="th_range">Range</th>
14089           <th class="th_tags">Tags</th>
14090         </tr>
14091       </thead>
14092
14093       <tbody>
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104           <tr class="entry" id="static_android.noiseReduction.availableNoiseReductionModes">
14105             <td class="entry_name
14106              " rowspan="5">
14107               android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes
14108             </td>
14109             <td class="entry_type">
14110                 <span class="entry_type_name">byte</span>
14111                 <span class="entry_type_container">x</span>
14112
14113                 <span class="entry_type_array">
14114                   n
14115                 </span>
14116               <span class="entry_type_visibility"> [public as enumList]</span>
14117
14118
14119               <span class="entry_type_hwlevel">[limited] </span>
14120
14121
14122                 <div class="entry_type_notes">list of enums</div>
14123
14124
14125             </td> <!-- entry_type -->
14126
14127             <td class="entry_description">
14128               <p>List of noise reduction modes for <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a> that are supported
14129 by this camera device.<wbr/></p>
14130             </td>
14131
14132             <td class="entry_units">
14133             </td>
14134
14135             <td class="entry_range">
14136               <p>Any value listed in <a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a></p>
14137             </td>
14138
14139             <td class="entry_tags">
14140               <ul class="entry_tags">
14141                   <li><a href="#tag_V1">V1</a></li>
14142                   <li><a href="#tag_REPROC">REPROC</a></li>
14143               </ul>
14144             </td>
14145
14146           </tr>
14147           <tr class="entries_header">
14148             <th class="th_details" colspan="5">Details</th>
14149           </tr>
14150           <tr class="entry_cont">
14151             <td class="entry_details" colspan="5">
14152               <p>Full-capability camera devices will always support OFF and FAST.<wbr/></p>
14153 <p>Camera devices that support YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING will support
14154 ZERO_<wbr/>SHUTTER_<wbr/>LAG.<wbr/></p>
14155 <p>Legacy-capability camera devices will only support FAST mode.<wbr/></p>
14156             </td>
14157           </tr>
14158
14159           <tr class="entries_header">
14160             <th class="th_details" colspan="5">HAL Implementation Details</th>
14161           </tr>
14162           <tr class="entry_cont">
14163             <td class="entry_details" colspan="5">
14164               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if noise reduction control is available
14165 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
14166 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
14167 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
14168             </td>
14169           </tr>
14170
14171           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14172            <!-- end of entry -->
14173
14174
14175
14176       <!-- end of kind -->
14177       </tbody>
14178       <tr><td colspan="6" class="kind">dynamic</td></tr>
14179
14180       <thead class="entries_header">
14181         <tr>
14182           <th class="th_name">Property Name</th>
14183           <th class="th_type">Type</th>
14184           <th class="th_description">Description</th>
14185           <th class="th_units">Units</th>
14186           <th class="th_range">Range</th>
14187           <th class="th_tags">Tags</th>
14188         </tr>
14189       </thead>
14190
14191       <tbody>
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202           <tr class="entry" id="dynamic_android.noiseReduction.mode">
14203             <td class="entry_name
14204              " rowspan="5">
14205               android.<wbr/>noise<wbr/>Reduction.<wbr/>mode
14206             </td>
14207             <td class="entry_type">
14208                 <span class="entry_type_name entry_type_name_enum">byte</span>
14209
14210               <span class="entry_type_visibility"> [public]</span>
14211
14212
14213               <span class="entry_type_hwlevel">[full] </span>
14214
14215
14216
14217                 <ul class="entry_type_enum">
14218                   <li>
14219                     <span class="entry_type_enum_name">OFF</span>
14220                     <span class="entry_type_enum_notes"><p>No noise reduction is applied.<wbr/></p></span>
14221                   </li>
14222                   <li>
14223                     <span class="entry_type_enum_name">FAST</span>
14224                     <span class="entry_type_enum_notes"><p>Noise reduction is applied without reducing frame rate relative to sensor
14225 output.<wbr/> It may be the same as OFF if noise reduction will reduce frame rate
14226 relative to sensor.<wbr/></p></span>
14227                   </li>
14228                   <li>
14229                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
14230                     <span class="entry_type_enum_notes"><p>High-quality noise reduction is applied,<wbr/> at the cost of possibly reduced frame
14231 rate relative to sensor output.<wbr/></p></span>
14232                   </li>
14233                   <li>
14234                     <span class="entry_type_enum_name">MINIMAL</span>
14235                     <span class="entry_type_enum_optional">[optional]</span>
14236                     <span class="entry_type_enum_notes"><p>MINIMAL noise reduction is applied without reducing frame rate relative to
14237 sensor output.<wbr/> </p></span>
14238                   </li>
14239                   <li>
14240                     <span class="entry_type_enum_name">ZERO_SHUTTER_LAG</span>
14241                     <span class="entry_type_enum_optional">[optional]</span>
14242                     <span class="entry_type_enum_notes"><p>Noise reduction is applied at different levels for different output streams,<wbr/>
14243 based on resolution.<wbr/> Streams at maximum recording resolution (see <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a>) or below have noise
14244 reduction applied,<wbr/> while higher-resolution streams have MINIMAL (if supported) or no
14245 noise reduction applied (if MINIMAL is not supported.<wbr/>) The degree of noise reduction
14246 for low-resolution streams is tuned so that frame rate is not impacted,<wbr/> and the quality
14247 is equal to or better than FAST (since it is only applied to lower-resolution outputs,<wbr/>
14248 quality may improve from FAST).<wbr/></p>
14249 <p>This mode is intended to be used by applications operating in a zero-shutter-lag mode
14250 with YUV or PRIVATE reprocessing,<wbr/> where the application continuously captures
14251 high-resolution intermediate buffers into a circular buffer,<wbr/> from which a final image is
14252 produced via reprocessing when a user takes a picture.<wbr/>  For such a use case,<wbr/> the
14253 high-resolution buffers must not have noise reduction applied to maximize efficiency of
14254 preview and to avoid over-applying noise filtering when reprocessing,<wbr/> while
14255 low-resolution buffers (used for recording or preview,<wbr/> generally) need noise reduction
14256 applied for reasonable preview quality.<wbr/></p>
14257 <p>This mode is guaranteed to be supported by devices that support either the
14258 YUV_<wbr/>REPROCESSING or PRIVATE_<wbr/>REPROCESSING capabilities
14259 (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> lists either of those capabilities) and it will
14260 be the default mode for CAMERA3_<wbr/>TEMPLATE_<wbr/>ZERO_<wbr/>SHUTTER_<wbr/>LAG template.<wbr/></p></span>
14261                   </li>
14262                 </ul>
14263
14264             </td> <!-- entry_type -->
14265
14266             <td class="entry_description">
14267               <p>Mode of operation for the noise reduction algorithm.<wbr/></p>
14268             </td>
14269
14270             <td class="entry_units">
14271             </td>
14272
14273             <td class="entry_range">
14274               <p><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a></p>
14275             </td>
14276
14277             <td class="entry_tags">
14278               <ul class="entry_tags">
14279                   <li><a href="#tag_V1">V1</a></li>
14280                   <li><a href="#tag_REPROC">REPROC</a></li>
14281               </ul>
14282             </td>
14283
14284           </tr>
14285           <tr class="entries_header">
14286             <th class="th_details" colspan="5">Details</th>
14287           </tr>
14288           <tr class="entry_cont">
14289             <td class="entry_details" colspan="5">
14290               <p>The noise reduction algorithm attempts to improve image quality by removing
14291 excessive noise added by the capture process,<wbr/> especially in dark conditions.<wbr/></p>
14292 <p>OFF means no noise reduction will be applied by the camera device,<wbr/> for both raw and
14293 YUV domain.<wbr/></p>
14294 <p>MINIMAL means that only sensor raw domain basic noise reduction is enabled ,<wbr/>to remove
14295 demosaicing or other processing artifacts.<wbr/> For YUV_<wbr/>REPROCESSING,<wbr/> MINIMAL is same as OFF.<wbr/>
14296 This mode is optional,<wbr/> may not be support by all devices.<wbr/> The application should check
14297 <a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a> before using it.<wbr/></p>
14298 <p>FAST/<wbr/>HIGH_<wbr/>QUALITY both mean camera device determined noise filtering
14299 will be applied.<wbr/> HIGH_<wbr/>QUALITY mode indicates that the camera device
14300 will use the highest-quality noise filtering algorithms,<wbr/>
14301 even if it slows down capture rate.<wbr/> FAST means the camera device will not
14302 slow down capture rate when applying noise filtering.<wbr/> FAST may be the same as MINIMAL if
14303 MINIMAL is listed,<wbr/> or the same as OFF if any noise filtering will slow down capture rate.<wbr/>
14304 Every output stream will have a similar amount of enhancement applied.<wbr/></p>
14305 <p>ZERO_<wbr/>SHUTTER_<wbr/>LAG is meant to be used by applications that maintain a continuous circular
14306 buffer of high-resolution images during preview and reprocess image(s) from that buffer
14307 into a final capture when triggered by the user.<wbr/> In this mode,<wbr/> the camera device applies
14308 noise reduction to low-resolution streams (below maximum recording resolution) to maximize
14309 preview quality,<wbr/> but does not apply noise reduction to high-resolution streams,<wbr/> since
14310 those will be reprocessed later if necessary.<wbr/></p>
14311 <p>For YUV_<wbr/>REPROCESSING,<wbr/> these FAST/<wbr/>HIGH_<wbr/>QUALITY modes both mean that the camera device
14312 will apply FAST/<wbr/>HIGH_<wbr/>QUALITY YUV domain noise reduction,<wbr/> respectively.<wbr/> The camera device
14313 may adjust the noise reduction parameters for best image quality based on the
14314 <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> if it is set.<wbr/></p>
14315             </td>
14316           </tr>
14317
14318           <tr class="entries_header">
14319             <th class="th_details" colspan="5">HAL Implementation Details</th>
14320           </tr>
14321           <tr class="entry_cont">
14322             <td class="entry_details" colspan="5">
14323               <p>For YUV_<wbr/>REPROCESSING The HAL can use <a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a> to
14324 adjust the internal noise reduction parameters appropriately to get the best quality
14325 images.<wbr/></p>
14326             </td>
14327           </tr>
14328
14329           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14330            <!-- end of entry -->
14331
14332
14333
14334       <!-- end of kind -->
14335       </tbody>
14336
14337   <!-- end of section -->
14338   <tr><td colspan="6" id="section_quirks" class="section">quirks</td></tr>
14339
14340
14341       <tr><td colspan="6" class="kind">static</td></tr>
14342
14343       <thead class="entries_header">
14344         <tr>
14345           <th class="th_name">Property Name</th>
14346           <th class="th_type">Type</th>
14347           <th class="th_description">Description</th>
14348           <th class="th_units">Units</th>
14349           <th class="th_range">Range</th>
14350           <th class="th_tags">Tags</th>
14351         </tr>
14352       </thead>
14353
14354       <tbody>
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365           <tr class="entry" id="static_android.quirks.meteringCropRegion">
14366             <td class="entry_name
14367                 entry_name_deprecated
14368              " rowspan="3">
14369               android.<wbr/>quirks.<wbr/>metering<wbr/>Crop<wbr/>Region
14370             </td>
14371             <td class="entry_type">
14372                 <span class="entry_type_name">byte</span>
14373
14374               <span class="entry_type_visibility"> [system]</span>
14375
14376
14377
14378               <span class="entry_type_deprecated">[deprecated] </span>
14379
14380
14381
14382             </td> <!-- entry_type -->
14383
14384             <td class="entry_description">
14385               <p>If set to 1,<wbr/> the camera service does not
14386 scale 'normalized' coordinates with respect to the crop
14387 region.<wbr/> This applies to metering input (a{e,<wbr/>f,<wbr/>wb}Region
14388 and output (face rectangles).<wbr/></p>
14389             </td>
14390
14391             <td class="entry_units">
14392             </td>
14393
14394             <td class="entry_range">
14395               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14396             </td>
14397
14398             <td class="entry_tags">
14399             </td>
14400
14401           </tr>
14402           <tr class="entries_header">
14403             <th class="th_details" colspan="5">Details</th>
14404           </tr>
14405           <tr class="entry_cont">
14406             <td class="entry_details" colspan="5">
14407               <p>Normalized coordinates refer to those in the
14408 (-1000,<wbr/>1000) range mentioned in the
14409 android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p>
14410 <p>HAL implementations should instead always use and emit
14411 sensor array-relative coordinates for all region data.<wbr/> Does
14412 not need to be listed in static metadata.<wbr/> Support will be
14413 removed in future versions of camera service.<wbr/></p>
14414             </td>
14415           </tr>
14416
14417
14418           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14419            <!-- end of entry -->
14420
14421
14422           <tr class="entry" id="static_android.quirks.triggerAfWithAuto">
14423             <td class="entry_name
14424                 entry_name_deprecated
14425              " rowspan="3">
14426               android.<wbr/>quirks.<wbr/>trigger<wbr/>Af<wbr/>With<wbr/>Auto
14427             </td>
14428             <td class="entry_type">
14429                 <span class="entry_type_name">byte</span>
14430
14431               <span class="entry_type_visibility"> [system]</span>
14432
14433
14434
14435               <span class="entry_type_deprecated">[deprecated] </span>
14436
14437
14438
14439             </td> <!-- entry_type -->
14440
14441             <td class="entry_description">
14442               <p>If set to 1,<wbr/> then the camera service always
14443 switches to FOCUS_<wbr/>MODE_<wbr/>AUTO before issuing a AF
14444 trigger.<wbr/></p>
14445             </td>
14446
14447             <td class="entry_units">
14448             </td>
14449
14450             <td class="entry_range">
14451               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14452             </td>
14453
14454             <td class="entry_tags">
14455             </td>
14456
14457           </tr>
14458           <tr class="entries_header">
14459             <th class="th_details" colspan="5">Details</th>
14460           </tr>
14461           <tr class="entry_cont">
14462             <td class="entry_details" colspan="5">
14463               <p>HAL implementations should implement AF trigger
14464 modes for AUTO,<wbr/> MACRO,<wbr/> CONTINUOUS_<wbr/>FOCUS,<wbr/> and
14465 CONTINUOUS_<wbr/>PICTURE modes instead of using this flag.<wbr/> Does
14466 not need to be listed in static metadata.<wbr/> Support will be
14467 removed in future versions of camera service</p>
14468             </td>
14469           </tr>
14470
14471
14472           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14473            <!-- end of entry -->
14474
14475
14476           <tr class="entry" id="static_android.quirks.useZslFormat">
14477             <td class="entry_name
14478                 entry_name_deprecated
14479              " rowspan="3">
14480               android.<wbr/>quirks.<wbr/>use<wbr/>Zsl<wbr/>Format
14481             </td>
14482             <td class="entry_type">
14483                 <span class="entry_type_name">byte</span>
14484
14485               <span class="entry_type_visibility"> [system]</span>
14486
14487
14488
14489               <span class="entry_type_deprecated">[deprecated] </span>
14490
14491
14492
14493             </td> <!-- entry_type -->
14494
14495             <td class="entry_description">
14496               <p>If set to 1,<wbr/> the camera service uses
14497 CAMERA2_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>ZSL instead of
14498 HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>IMPLEMENTATION_<wbr/>DEFINED for the zero
14499 shutter lag stream</p>
14500             </td>
14501
14502             <td class="entry_units">
14503             </td>
14504
14505             <td class="entry_range">
14506               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14507             </td>
14508
14509             <td class="entry_tags">
14510             </td>
14511
14512           </tr>
14513           <tr class="entries_header">
14514             <th class="th_details" colspan="5">Details</th>
14515           </tr>
14516           <tr class="entry_cont">
14517             <td class="entry_details" colspan="5">
14518               <p>HAL implementations should use gralloc usage flags
14519 to determine that a stream will be used for
14520 zero-shutter-lag,<wbr/> instead of relying on an explicit
14521 format setting.<wbr/> Does not need to be listed in static
14522 metadata.<wbr/> Support will be removed in future versions of
14523 camera service.<wbr/></p>
14524             </td>
14525           </tr>
14526
14527
14528           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14529            <!-- end of entry -->
14530
14531
14532           <tr class="entry" id="static_android.quirks.usePartialResult">
14533             <td class="entry_name
14534                 entry_name_deprecated
14535              " rowspan="5">
14536               android.<wbr/>quirks.<wbr/>use<wbr/>Partial<wbr/>Result
14537             </td>
14538             <td class="entry_type">
14539                 <span class="entry_type_name">byte</span>
14540
14541               <span class="entry_type_visibility"> [hidden]</span>
14542
14543
14544
14545               <span class="entry_type_deprecated">[deprecated] </span>
14546
14547
14548
14549             </td> <!-- entry_type -->
14550
14551             <td class="entry_description">
14552               <p>If set to 1,<wbr/> the HAL will always split result
14553 metadata for a single capture into multiple buffers,<wbr/>
14554 returned using multiple process_<wbr/>capture_<wbr/>result calls.<wbr/></p>
14555             </td>
14556
14557             <td class="entry_units">
14558             </td>
14559
14560             <td class="entry_range">
14561               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14562             </td>
14563
14564             <td class="entry_tags">
14565             </td>
14566
14567           </tr>
14568           <tr class="entries_header">
14569             <th class="th_details" colspan="5">Details</th>
14570           </tr>
14571           <tr class="entry_cont">
14572             <td class="entry_details" colspan="5">
14573               <p>Does not need to be listed in static
14574 metadata.<wbr/> Support for partial results will be reworked in
14575 future versions of camera service.<wbr/> This quirk will stop
14576 working at that point; DO NOT USE without careful
14577 consideration of future support.<wbr/></p>
14578             </td>
14579           </tr>
14580
14581           <tr class="entries_header">
14582             <th class="th_details" colspan="5">HAL Implementation Details</th>
14583           </tr>
14584           <tr class="entry_cont">
14585             <td class="entry_details" colspan="5">
14586               <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
14587 for information on how to implement partial results.<wbr/></p>
14588             </td>
14589           </tr>
14590
14591           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14592            <!-- end of entry -->
14593
14594
14595
14596       <!-- end of kind -->
14597       </tbody>
14598       <tr><td colspan="6" class="kind">dynamic</td></tr>
14599
14600       <thead class="entries_header">
14601         <tr>
14602           <th class="th_name">Property Name</th>
14603           <th class="th_type">Type</th>
14604           <th class="th_description">Description</th>
14605           <th class="th_units">Units</th>
14606           <th class="th_range">Range</th>
14607           <th class="th_tags">Tags</th>
14608         </tr>
14609       </thead>
14610
14611       <tbody>
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622           <tr class="entry" id="dynamic_android.quirks.partialResult">
14623             <td class="entry_name
14624                 entry_name_deprecated
14625              " rowspan="5">
14626               android.<wbr/>quirks.<wbr/>partial<wbr/>Result
14627             </td>
14628             <td class="entry_type">
14629                 <span class="entry_type_name entry_type_name_enum">byte</span>
14630
14631               <span class="entry_type_visibility"> [hidden as boolean]</span>
14632
14633
14634
14635               <span class="entry_type_deprecated">[deprecated] </span>
14636
14637
14638                 <ul class="entry_type_enum">
14639                   <li>
14640                     <span class="entry_type_enum_name">FINAL</span>
14641                     <span class="entry_type_enum_notes"><p>The last or only metadata result buffer
14642 for this capture.<wbr/></p></span>
14643                   </li>
14644                   <li>
14645                     <span class="entry_type_enum_name">PARTIAL</span>
14646                     <span class="entry_type_enum_notes"><p>A partial buffer of result metadata for this
14647 capture.<wbr/> More result buffers for this capture will be sent
14648 by the camera device,<wbr/> the last of which will be marked
14649 FINAL.<wbr/></p></span>
14650                   </li>
14651                 </ul>
14652
14653             </td> <!-- entry_type -->
14654
14655             <td class="entry_description">
14656               <p>Whether a result given to the framework is the
14657 final one for the capture,<wbr/> or only a partial that contains a
14658 subset of the full set of dynamic metadata
14659 values.<wbr/></p>
14660             </td>
14661
14662             <td class="entry_units">
14663             </td>
14664
14665             <td class="entry_range">
14666               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14667               <p>Optional.<wbr/> Default value is FINAL.<wbr/></p>
14668             </td>
14669
14670             <td class="entry_tags">
14671             </td>
14672
14673           </tr>
14674           <tr class="entries_header">
14675             <th class="th_details" colspan="5">Details</th>
14676           </tr>
14677           <tr class="entry_cont">
14678             <td class="entry_details" colspan="5">
14679               <p>The entries in the result metadata buffers for a
14680 single capture may not overlap,<wbr/> except for this entry.<wbr/> The
14681 FINAL buffers must retain FIFO ordering relative to the
14682 requests that generate them,<wbr/> so the FINAL buffer for frame 3 must
14683 always be sent to the framework after the FINAL buffer for frame 2,<wbr/> and
14684 before the FINAL buffer for frame 4.<wbr/> PARTIAL buffers may be returned
14685 in any order relative to other frames,<wbr/> but all PARTIAL buffers for a given
14686 capture must arrive before the FINAL buffer for that capture.<wbr/> This entry may
14687 only be used by the camera device if quirks.<wbr/>usePartialResult is set to 1.<wbr/></p>
14688             </td>
14689           </tr>
14690
14691           <tr class="entries_header">
14692             <th class="th_details" colspan="5">HAL Implementation Details</th>
14693           </tr>
14694           <tr class="entry_cont">
14695             <td class="entry_details" colspan="5">
14696               <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
14697 for information on how to implement partial results.<wbr/></p>
14698             </td>
14699           </tr>
14700
14701           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14702            <!-- end of entry -->
14703
14704
14705
14706       <!-- end of kind -->
14707       </tbody>
14708
14709   <!-- end of section -->
14710   <tr><td colspan="6" id="section_request" class="section">request</td></tr>
14711
14712
14713       <tr><td colspan="6" class="kind">controls</td></tr>
14714
14715       <thead class="entries_header">
14716         <tr>
14717           <th class="th_name">Property Name</th>
14718           <th class="th_type">Type</th>
14719           <th class="th_description">Description</th>
14720           <th class="th_units">Units</th>
14721           <th class="th_range">Range</th>
14722           <th class="th_tags">Tags</th>
14723         </tr>
14724       </thead>
14725
14726       <tbody>
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737           <tr class="entry" id="controls_android.request.frameCount">
14738             <td class="entry_name
14739                 entry_name_deprecated
14740              " rowspan="1">
14741               android.<wbr/>request.<wbr/>frame<wbr/>Count
14742             </td>
14743             <td class="entry_type">
14744                 <span class="entry_type_name">int32</span>
14745
14746               <span class="entry_type_visibility"> [system]</span>
14747
14748
14749
14750               <span class="entry_type_deprecated">[deprecated] </span>
14751
14752
14753
14754             </td> <!-- entry_type -->
14755
14756             <td class="entry_description">
14757               <p>A frame counter set by the framework.<wbr/> Must
14758 be maintained unchanged in output frame.<wbr/> This value monotonically
14759 increases with every new result (that is,<wbr/> each new result has a unique
14760 frameCount value).<wbr/></p>
14761             </td>
14762
14763             <td class="entry_units">
14764               incrementing integer
14765             </td>
14766
14767             <td class="entry_range">
14768               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14769               <p>Any int.<wbr/></p>
14770             </td>
14771
14772             <td class="entry_tags">
14773             </td>
14774
14775           </tr>
14776
14777
14778           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14779            <!-- end of entry -->
14780
14781
14782           <tr class="entry" id="controls_android.request.id">
14783             <td class="entry_name
14784              " rowspan="1">
14785               android.<wbr/>request.<wbr/>id
14786             </td>
14787             <td class="entry_type">
14788                 <span class="entry_type_name">int32</span>
14789
14790               <span class="entry_type_visibility"> [hidden]</span>
14791
14792
14793
14794
14795
14796
14797             </td> <!-- entry_type -->
14798
14799             <td class="entry_description">
14800               <p>An application-specified ID for the current
14801 request.<wbr/> Must be maintained unchanged in output
14802 frame</p>
14803             </td>
14804
14805             <td class="entry_units">
14806               arbitrary integer assigned by application
14807             </td>
14808
14809             <td class="entry_range">
14810               <p>Any int</p>
14811             </td>
14812
14813             <td class="entry_tags">
14814               <ul class="entry_tags">
14815                   <li><a href="#tag_V1">V1</a></li>
14816               </ul>
14817             </td>
14818
14819           </tr>
14820
14821
14822           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14823            <!-- end of entry -->
14824
14825
14826           <tr class="entry" id="controls_android.request.inputStreams">
14827             <td class="entry_name
14828                 entry_name_deprecated
14829              " rowspan="3">
14830               android.<wbr/>request.<wbr/>input<wbr/>Streams
14831             </td>
14832             <td class="entry_type">
14833                 <span class="entry_type_name">int32</span>
14834                 <span class="entry_type_container">x</span>
14835
14836                 <span class="entry_type_array">
14837                   n
14838                 </span>
14839               <span class="entry_type_visibility"> [system]</span>
14840
14841
14842
14843               <span class="entry_type_deprecated">[deprecated] </span>
14844
14845
14846
14847             </td> <!-- entry_type -->
14848
14849             <td class="entry_description">
14850               <p>List which camera reprocess stream is used
14851 for the source of reprocessing data.<wbr/></p>
14852             </td>
14853
14854             <td class="entry_units">
14855               List of camera reprocess stream IDs
14856             </td>
14857
14858             <td class="entry_range">
14859               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14860               <p>Typically,<wbr/> only one entry allowed,<wbr/> must be a valid reprocess stream ID.<wbr/></p>
14861             </td>
14862
14863             <td class="entry_tags">
14864               <ul class="entry_tags">
14865                   <li><a href="#tag_HAL2">HAL2</a></li>
14866               </ul>
14867             </td>
14868
14869           </tr>
14870           <tr class="entries_header">
14871             <th class="th_details" colspan="5">Details</th>
14872           </tr>
14873           <tr class="entry_cont">
14874             <td class="entry_details" colspan="5">
14875               <p>Only meaningful when <a href="#controls_android.request.type">android.<wbr/>request.<wbr/>type</a> ==
14876 REPROCESS.<wbr/> Ignored otherwise</p>
14877             </td>
14878           </tr>
14879
14880
14881           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14882            <!-- end of entry -->
14883
14884
14885           <tr class="entry" id="controls_android.request.metadataMode">
14886             <td class="entry_name
14887              " rowspan="1">
14888               android.<wbr/>request.<wbr/>metadata<wbr/>Mode
14889             </td>
14890             <td class="entry_type">
14891                 <span class="entry_type_name entry_type_name_enum">byte</span>
14892
14893               <span class="entry_type_visibility"> [system]</span>
14894
14895
14896
14897
14898
14899                 <ul class="entry_type_enum">
14900                   <li>
14901                     <span class="entry_type_enum_name">NONE</span>
14902                     <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
14903 for application-bound buffer data.<wbr/> If no
14904 application-bound streams exist,<wbr/> no frame should be
14905 placed in the output frame queue.<wbr/> If such streams
14906 exist,<wbr/> a frame should be placed on the output queue
14907 with null metadata but with the necessary output buffer
14908 information.<wbr/> Timestamp information should still be
14909 included with any output stream buffers</p></span>
14910                   </li>
14911                   <li>
14912                     <span class="entry_type_enum_name">FULL</span>
14913                     <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
14914 only be produced if they are separately
14915 enabled</p></span>
14916                   </li>
14917                 </ul>
14918
14919             </td> <!-- entry_type -->
14920
14921             <td class="entry_description">
14922               <p>How much metadata to produce on
14923 output</p>
14924             </td>
14925
14926             <td class="entry_units">
14927             </td>
14928
14929             <td class="entry_range">
14930             </td>
14931
14932             <td class="entry_tags">
14933               <ul class="entry_tags">
14934                   <li><a href="#tag_FUTURE">FUTURE</a></li>
14935               </ul>
14936             </td>
14937
14938           </tr>
14939
14940
14941           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
14942            <!-- end of entry -->
14943
14944
14945           <tr class="entry" id="controls_android.request.outputStreams">
14946             <td class="entry_name
14947                 entry_name_deprecated
14948              " rowspan="3">
14949               android.<wbr/>request.<wbr/>output<wbr/>Streams
14950             </td>
14951             <td class="entry_type">
14952                 <span class="entry_type_name">int32</span>
14953                 <span class="entry_type_container">x</span>
14954
14955                 <span class="entry_type_array">
14956                   n
14957                 </span>
14958               <span class="entry_type_visibility"> [system]</span>
14959
14960
14961
14962               <span class="entry_type_deprecated">[deprecated] </span>
14963
14964
14965
14966             </td> <!-- entry_type -->
14967
14968             <td class="entry_description">
14969               <p>Lists which camera output streams image data
14970 from this capture must be sent to</p>
14971             </td>
14972
14973             <td class="entry_units">
14974               List of camera stream IDs
14975             </td>
14976
14977             <td class="entry_range">
14978               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
14979               <p>List must only include streams that have been
14980 created</p>
14981             </td>
14982
14983             <td class="entry_tags">
14984               <ul class="entry_tags">
14985                   <li><a href="#tag_HAL2">HAL2</a></li>
14986               </ul>
14987             </td>
14988
14989           </tr>
14990           <tr class="entries_header">
14991             <th class="th_details" colspan="5">Details</th>
14992           </tr>
14993           <tr class="entry_cont">
14994             <td class="entry_details" colspan="5">
14995               <p>If no output streams are listed,<wbr/> then the image
14996 data should simply be discarded.<wbr/> The image data must
14997 still be captured for metadata and statistics production,<wbr/>
14998 and the lens and flash must operate as requested.<wbr/></p>
14999             </td>
15000           </tr>
15001
15002
15003           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15004            <!-- end of entry -->
15005
15006
15007           <tr class="entry" id="controls_android.request.type">
15008             <td class="entry_name
15009                 entry_name_deprecated
15010              " rowspan="1">
15011               android.<wbr/>request.<wbr/>type
15012             </td>
15013             <td class="entry_type">
15014                 <span class="entry_type_name entry_type_name_enum">byte</span>
15015
15016               <span class="entry_type_visibility"> [system]</span>
15017
15018
15019
15020               <span class="entry_type_deprecated">[deprecated] </span>
15021
15022
15023                 <ul class="entry_type_enum">
15024                   <li>
15025                     <span class="entry_type_enum_name">CAPTURE</span>
15026                     <span class="entry_type_enum_notes"><p>Capture a new image from the imaging hardware,<wbr/>
15027 and process it according to the
15028 settings</p></span>
15029                   </li>
15030                   <li>
15031                     <span class="entry_type_enum_name">REPROCESS</span>
15032                     <span class="entry_type_enum_notes"><p>Process previously captured data; the
15033 <a href="#controls_android.request.inputStreams">android.<wbr/>request.<wbr/>input<wbr/>Streams</a> parameter determines the
15034 source reprocessing stream.<wbr/> TODO: Mark dynamic metadata
15035 needed for reprocessing with [RP]</p></span>
15036                   </li>
15037                 </ul>
15038
15039             </td> <!-- entry_type -->
15040
15041             <td class="entry_description">
15042               <p>The type of the request; either CAPTURE or
15043 REPROCESS.<wbr/> For HAL3,<wbr/> this tag is redundant.<wbr/></p>
15044             </td>
15045
15046             <td class="entry_units">
15047             </td>
15048
15049             <td class="entry_range">
15050               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
15051             </td>
15052
15053             <td class="entry_tags">
15054               <ul class="entry_tags">
15055                   <li><a href="#tag_HAL2">HAL2</a></li>
15056               </ul>
15057             </td>
15058
15059           </tr>
15060
15061
15062           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15063            <!-- end of entry -->
15064
15065
15066
15067       <!-- end of kind -->
15068       </tbody>
15069       <tr><td colspan="6" class="kind">static</td></tr>
15070
15071       <thead class="entries_header">
15072         <tr>
15073           <th class="th_name">Property Name</th>
15074           <th class="th_type">Type</th>
15075           <th class="th_description">Description</th>
15076           <th class="th_units">Units</th>
15077           <th class="th_range">Range</th>
15078           <th class="th_tags">Tags</th>
15079         </tr>
15080       </thead>
15081
15082       <tbody>
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093           <tr class="entry" id="static_android.request.maxNumOutputStreams">
15094             <td class="entry_name
15095              " rowspan="3">
15096               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Streams
15097             </td>
15098             <td class="entry_type">
15099                 <span class="entry_type_name">int32</span>
15100                 <span class="entry_type_container">x</span>
15101
15102                 <span class="entry_type_array">
15103                   3
15104                 </span>
15105               <span class="entry_type_visibility"> [ndk_public]</span>
15106
15107
15108               <span class="entry_type_hwlevel">[legacy] </span>
15109
15110
15111
15112
15113             </td> <!-- entry_type -->
15114
15115             <td class="entry_description">
15116               <p>The maximum numbers of different types of output streams
15117 that can be configured and used simultaneously by a camera device.<wbr/></p>
15118             </td>
15119
15120             <td class="entry_units">
15121             </td>
15122
15123             <td class="entry_range">
15124               <p>For processed (and stalling) format streams,<wbr/> &gt;= 1.<wbr/></p>
15125 <p>For Raw format (either stalling or non-stalling) streams,<wbr/> &gt;= 0.<wbr/></p>
15126 <p>For processed (but not stalling) format streams,<wbr/> &gt;= 3
15127 for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
15128 &gt;= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>).<wbr/></p>
15129             </td>
15130
15131             <td class="entry_tags">
15132               <ul class="entry_tags">
15133                   <li><a href="#tag_BC">BC</a></li>
15134               </ul>
15135             </td>
15136
15137           </tr>
15138           <tr class="entries_header">
15139             <th class="th_details" colspan="5">Details</th>
15140           </tr>
15141           <tr class="entry_cont">
15142             <td class="entry_details" colspan="5">
15143               <p>This is a 3 element tuple that contains the max number of output simultaneous
15144 streams for raw sensor,<wbr/> processed (but not stalling),<wbr/> and processed (and stalling)
15145 formats respectively.<wbr/> For example,<wbr/> assuming that JPEG is typically a processed and
15146 stalling stream,<wbr/> if max raw sensor format output stream number is 1,<wbr/> max YUV streams
15147 number is 3,<wbr/> and max JPEG stream number is 2,<wbr/> then this tuple should be <code>(1,<wbr/> 3,<wbr/> 2)</code>.<wbr/></p>
15148 <p>This lists the upper bound of the number of output streams supported by
15149 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
15150 CPU resources that will consume more power.<wbr/> The image format for an output stream can
15151 be any supported format provided by <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a>.<wbr/>
15152 The formats defined in <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> can be catergorized
15153 into the 3 stream types as below:</p>
15154 <ul>
15155 <li>Processed (but stalling): any non-RAW format with a stallDurations &gt; 0.<wbr/>
15156   Typically <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG format</a>.<wbr/></li>
15157 <li>Raw formats: <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">RAW_<wbr/>SENSOR</a>,<wbr/> <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">RAW10</a>,<wbr/> or <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW12">RAW12</a>.<wbr/></li>
15158 <li>Processed (but not-stalling): any non-RAW format without a stall duration.<wbr/>
15159   Typically <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">YUV_<wbr/>420_<wbr/>888</a>,<wbr/>
15160   <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#NV21">NV21</a>,<wbr/> or
15161   <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YV12">YV12</a>.<wbr/></li>
15162 </ul>
15163             </td>
15164           </tr>
15165
15166
15167           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15168            <!-- end of entry -->
15169
15170
15171           <tr class="entry" id="static_android.request.maxNumOutputRaw">
15172             <td class="entry_name
15173              " rowspan="3">
15174               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Raw
15175             </td>
15176             <td class="entry_type">
15177                 <span class="entry_type_name">int32</span>
15178
15179               <span class="entry_type_visibility"> [java_public]</span>
15180
15181               <span class="entry_type_synthetic">[synthetic] </span>
15182
15183               <span class="entry_type_hwlevel">[legacy] </span>
15184
15185
15186
15187
15188             </td> <!-- entry_type -->
15189
15190             <td class="entry_description">
15191               <p>The maximum numbers of different types of output streams
15192 that can be configured and used simultaneously by a camera device
15193 for any <code>RAW</code> formats.<wbr/></p>
15194             </td>
15195
15196             <td class="entry_units">
15197             </td>
15198
15199             <td class="entry_range">
15200               <p>&gt;= 0</p>
15201             </td>
15202
15203             <td class="entry_tags">
15204             </td>
15205
15206           </tr>
15207           <tr class="entries_header">
15208             <th class="th_details" colspan="5">Details</th>
15209           </tr>
15210           <tr class="entry_cont">
15211             <td class="entry_details" colspan="5">
15212               <p>This value contains the max number of output simultaneous
15213 streams from the raw sensor.<wbr/></p>
15214 <p>This lists the upper bound of the number of output streams supported by
15215 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
15216 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
15217 be any <code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
15218 <p>In particular,<wbr/> a <code>RAW</code> format is typically one of:</p>
15219 <ul>
15220 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">RAW_<wbr/>SENSOR</a></li>
15221 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">RAW10</a></li>
15222 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW12">RAW12</a></li>
15223 </ul>
15224 <p>LEGACY mode devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> LEGACY)
15225 never support raw streams.<wbr/></p>
15226             </td>
15227           </tr>
15228
15229
15230           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15231            <!-- end of entry -->
15232
15233
15234           <tr class="entry" id="static_android.request.maxNumOutputProc">
15235             <td class="entry_name
15236              " rowspan="3">
15237               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc
15238             </td>
15239             <td class="entry_type">
15240                 <span class="entry_type_name">int32</span>
15241
15242               <span class="entry_type_visibility"> [java_public]</span>
15243
15244               <span class="entry_type_synthetic">[synthetic] </span>
15245
15246               <span class="entry_type_hwlevel">[legacy] </span>
15247
15248
15249
15250
15251             </td> <!-- entry_type -->
15252
15253             <td class="entry_description">
15254               <p>The maximum numbers of different types of output streams
15255 that can be configured and used simultaneously by a camera device
15256 for any processed (but not-stalling) formats.<wbr/></p>
15257             </td>
15258
15259             <td class="entry_units">
15260             </td>
15261
15262             <td class="entry_range">
15263               <p>&gt;= 3
15264 for FULL mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>);
15265 &gt;= 2 for LIMITED mode devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>).<wbr/></p>
15266             </td>
15267
15268             <td class="entry_tags">
15269             </td>
15270
15271           </tr>
15272           <tr class="entries_header">
15273             <th class="th_details" colspan="5">Details</th>
15274           </tr>
15275           <tr class="entry_cont">
15276             <td class="entry_details" colspan="5">
15277               <p>This value contains the max number of output simultaneous
15278 streams for any processed (but not-stalling) formats.<wbr/></p>
15279 <p>This lists the upper bound of the number of output streams supported by
15280 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
15281 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
15282 be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
15283 <p>Processed (but not-stalling) is defined as any non-RAW format without a stall duration.<wbr/>
15284 Typically:</p>
15285 <ul>
15286 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">YUV_<wbr/>420_<wbr/>888</a></li>
15287 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#NV21">NV21</a></li>
15288 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YV12">YV12</a></li>
15289 <li>Implementation-defined formats,<wbr/> i.<wbr/>e.<wbr/> <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#isOutputSupportedFor(Class)">StreamConfigurationMap#isOutputSupportedFor(Class)</a></li>
15290 </ul>
15291 <p>For full guarantees,<wbr/> query <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a> with a
15292 processed format -- it will return 0 for a non-stalling stream.<wbr/></p>
15293 <p>LEGACY devices will support at least 2 processing/<wbr/>non-stalling streams.<wbr/></p>
15294             </td>
15295           </tr>
15296
15297
15298           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15299            <!-- end of entry -->
15300
15301
15302           <tr class="entry" id="static_android.request.maxNumOutputProcStalling">
15303             <td class="entry_name
15304              " rowspan="3">
15305               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Proc<wbr/>Stalling
15306             </td>
15307             <td class="entry_type">
15308                 <span class="entry_type_name">int32</span>
15309
15310               <span class="entry_type_visibility"> [java_public]</span>
15311
15312               <span class="entry_type_synthetic">[synthetic] </span>
15313
15314               <span class="entry_type_hwlevel">[legacy] </span>
15315
15316
15317
15318
15319             </td> <!-- entry_type -->
15320
15321             <td class="entry_description">
15322               <p>The maximum numbers of different types of output streams
15323 that can be configured and used simultaneously by a camera device
15324 for any processed (and stalling) formats.<wbr/></p>
15325             </td>
15326
15327             <td class="entry_units">
15328             </td>
15329
15330             <td class="entry_range">
15331               <p>&gt;= 1</p>
15332             </td>
15333
15334             <td class="entry_tags">
15335             </td>
15336
15337           </tr>
15338           <tr class="entries_header">
15339             <th class="th_details" colspan="5">Details</th>
15340           </tr>
15341           <tr class="entry_cont">
15342             <td class="entry_details" colspan="5">
15343               <p>This value contains the max number of output simultaneous
15344 streams for any processed (but not-stalling) formats.<wbr/></p>
15345 <p>This lists the upper bound of the number of output streams supported by
15346 the camera device.<wbr/> Using more streams simultaneously may require more hardware and
15347 CPU resources that will consume more power.<wbr/> The image format for this kind of an output stream can
15348 be any non-<code>RAW</code> and supported format provided by <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/></p>
15349 <p>A processed and stalling format is defined as any non-RAW format with a stallDurations
15350 &gt; 0.<wbr/>  Typically only the <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">JPEG format</a> is a
15351 stalling format.<wbr/></p>
15352 <p>For full guarantees,<wbr/> query <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a> with a
15353 processed format -- it will return a non-0 value for a stalling stream.<wbr/></p>
15354 <p>LEGACY devices will support up to 1 processing/<wbr/>stalling stream.<wbr/></p>
15355             </td>
15356           </tr>
15357
15358
15359           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15360            <!-- end of entry -->
15361
15362
15363           <tr class="entry" id="static_android.request.maxNumReprocessStreams">
15364             <td class="entry_name
15365                 entry_name_deprecated
15366              " rowspan="3">
15367               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Reprocess<wbr/>Streams
15368             </td>
15369             <td class="entry_type">
15370                 <span class="entry_type_name">int32</span>
15371                 <span class="entry_type_container">x</span>
15372
15373                 <span class="entry_type_array">
15374                   1
15375                 </span>
15376               <span class="entry_type_visibility"> [system]</span>
15377
15378
15379
15380               <span class="entry_type_deprecated">[deprecated] </span>
15381
15382
15383
15384             </td> <!-- entry_type -->
15385
15386             <td class="entry_description">
15387               <p>How many reprocessing streams of any type
15388 can be allocated at the same time.<wbr/></p>
15389             </td>
15390
15391             <td class="entry_units">
15392             </td>
15393
15394             <td class="entry_range">
15395               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
15396               <p>&gt;= 0</p>
15397             </td>
15398
15399             <td class="entry_tags">
15400               <ul class="entry_tags">
15401                   <li><a href="#tag_HAL2">HAL2</a></li>
15402               </ul>
15403             </td>
15404
15405           </tr>
15406           <tr class="entries_header">
15407             <th class="th_details" colspan="5">Details</th>
15408           </tr>
15409           <tr class="entry_cont">
15410             <td class="entry_details" colspan="5">
15411               <p>Only used by HAL2.<wbr/>x.<wbr/></p>
15412 <p>When set to 0,<wbr/> it means no reprocess stream is supported.<wbr/></p>
15413             </td>
15414           </tr>
15415
15416
15417           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15418            <!-- end of entry -->
15419
15420
15421           <tr class="entry" id="static_android.request.maxNumInputStreams">
15422             <td class="entry_name
15423              " rowspan="5">
15424               android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams
15425             </td>
15426             <td class="entry_type">
15427                 <span class="entry_type_name">int32</span>
15428
15429               <span class="entry_type_visibility"> [public]</span>
15430
15431
15432               <span class="entry_type_hwlevel">[full] </span>
15433
15434
15435
15436
15437             </td> <!-- entry_type -->
15438
15439             <td class="entry_description">
15440               <p>The maximum numbers of any type of input streams
15441 that can be configured and used simultaneously by a camera device.<wbr/></p>
15442             </td>
15443
15444             <td class="entry_units">
15445             </td>
15446
15447             <td class="entry_range">
15448               <p>0 or 1.<wbr/></p>
15449             </td>
15450
15451             <td class="entry_tags">
15452               <ul class="entry_tags">
15453                   <li><a href="#tag_REPROC">REPROC</a></li>
15454               </ul>
15455             </td>
15456
15457           </tr>
15458           <tr class="entries_header">
15459             <th class="th_details" colspan="5">Details</th>
15460           </tr>
15461           <tr class="entry_cont">
15462             <td class="entry_details" colspan="5">
15463               <p>When set to 0,<wbr/> it means no input stream is supported.<wbr/></p>
15464 <p>The image format for a input stream can be any supported format returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputFormats">StreamConfigurationMap#getInputFormats</a>.<wbr/> When using an
15465 input stream,<wbr/> there must be at least one output stream configured to to receive the
15466 reprocessed images.<wbr/></p>
15467 <p>When an input stream and some output streams are used in a reprocessing request,<wbr/>
15468 only the input buffer will be used to produce these output stream buffers,<wbr/> and a
15469 new sensor image will not be captured.<wbr/></p>
15470 <p>For example,<wbr/> for Zero Shutter Lag (ZSL) still capture use case,<wbr/> the input
15471 stream image format will be PRIVATE,<wbr/> the associated output stream image format
15472 should be JPEG.<wbr/></p>
15473             </td>
15474           </tr>
15475
15476           <tr class="entries_header">
15477             <th class="th_details" colspan="5">HAL Implementation Details</th>
15478           </tr>
15479           <tr class="entry_cont">
15480             <td class="entry_details" colspan="5">
15481               <p>For the reprocessing flow and controls,<wbr/> see
15482 hardware/<wbr/>libhardware/<wbr/>include/<wbr/>hardware/<wbr/>camera3.<wbr/>h Section 10 for more details.<wbr/></p>
15483             </td>
15484           </tr>
15485
15486           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15487            <!-- end of entry -->
15488
15489
15490           <tr class="entry" id="static_android.request.pipelineMaxDepth">
15491             <td class="entry_name
15492              " rowspan="5">
15493               android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth
15494             </td>
15495             <td class="entry_type">
15496                 <span class="entry_type_name">byte</span>
15497
15498               <span class="entry_type_visibility"> [public]</span>
15499
15500
15501               <span class="entry_type_hwlevel">[legacy] </span>
15502
15503
15504
15505
15506             </td> <!-- entry_type -->
15507
15508             <td class="entry_description">
15509               <p>Specifies the number of maximum pipeline stages a frame
15510 has to go through from when it's exposed to when it's available
15511 to the framework.<wbr/></p>
15512             </td>
15513
15514             <td class="entry_units">
15515             </td>
15516
15517             <td class="entry_range">
15518             </td>
15519
15520             <td class="entry_tags">
15521             </td>
15522
15523           </tr>
15524           <tr class="entries_header">
15525             <th class="th_details" colspan="5">Details</th>
15526           </tr>
15527           <tr class="entry_cont">
15528             <td class="entry_details" colspan="5">
15529               <p>A typical minimum value for this is 2 (one stage to expose,<wbr/>
15530 one stage to readout) from the sensor.<wbr/> The ISP then usually adds
15531 its own stages to do custom HW processing.<wbr/> Further stages may be
15532 added by SW processing.<wbr/></p>
15533 <p>Depending on what settings are used (e.<wbr/>g.<wbr/> YUV,<wbr/> JPEG) and what
15534 processing is enabled (e.<wbr/>g.<wbr/> face detection),<wbr/> the actual pipeline
15535 depth (specified by <a href="#dynamic_android.request.pipelineDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Depth</a>) may be less than
15536 the max pipeline depth.<wbr/></p>
15537 <p>A pipeline depth of X stages is equivalent to a pipeline latency of
15538 X frame intervals.<wbr/></p>
15539 <p>This value will normally be 8 or less,<wbr/> however,<wbr/> for high speed capture session,<wbr/>
15540 the max pipeline depth will be up to 8 x size of high speed capture request list.<wbr/></p>
15541             </td>
15542           </tr>
15543
15544           <tr class="entries_header">
15545             <th class="th_details" colspan="5">HAL Implementation Details</th>
15546           </tr>
15547           <tr class="entry_cont">
15548             <td class="entry_details" colspan="5">
15549               <p>This value should be 4 or less,<wbr/> expect for the high speed recording session,<wbr/> where the
15550 max batch sizes may be larger than 1.<wbr/></p>
15551             </td>
15552           </tr>
15553
15554           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15555            <!-- end of entry -->
15556
15557
15558           <tr class="entry" id="static_android.request.partialResultCount">
15559             <td class="entry_name
15560              " rowspan="3">
15561               android.<wbr/>request.<wbr/>partial<wbr/>Result<wbr/>Count
15562             </td>
15563             <td class="entry_type">
15564                 <span class="entry_type_name">int32</span>
15565
15566               <span class="entry_type_visibility"> [public]</span>
15567
15568
15569
15570
15571
15572
15573             </td> <!-- entry_type -->
15574
15575             <td class="entry_description">
15576               <p>Defines how many sub-components
15577 a result will be composed of.<wbr/></p>
15578             </td>
15579
15580             <td class="entry_units">
15581             </td>
15582
15583             <td class="entry_range">
15584               <p>&gt;= 1</p>
15585             </td>
15586
15587             <td class="entry_tags">
15588             </td>
15589
15590           </tr>
15591           <tr class="entries_header">
15592             <th class="th_details" colspan="5">Details</th>
15593           </tr>
15594           <tr class="entry_cont">
15595             <td class="entry_details" colspan="5">
15596               <p>In order to combat the pipeline latency,<wbr/> partial results
15597 may be delivered to the application layer from the camera device as
15598 soon as they are available.<wbr/></p>
15599 <p>Optional; defaults to 1.<wbr/> A value of 1 means that partial
15600 results are not supported,<wbr/> and only the final TotalCaptureResult will
15601 be produced by the camera device.<wbr/></p>
15602 <p>A typical use case for this might be: after requesting an
15603 auto-focus (AF) lock the new AF state might be available 50%
15604 of the way through the pipeline.<wbr/>  The camera device could
15605 then immediately dispatch this state via a partial result to
15606 the application,<wbr/> and the rest of the metadata via later
15607 partial results.<wbr/></p>
15608             </td>
15609           </tr>
15610
15611
15612           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
15613            <!-- end of entry -->
15614
15615
15616           <tr class="entry" id="static_android.request.availableCapabilities">
15617             <td class="entry_name
15618              " rowspan="5">
15619               android.<wbr/>request.<wbr/>available<wbr/>Capabilities
15620             </td>
15621             <td class="entry_type">
15622                 <span class="entry_type_name entry_type_name_enum">byte</span>
15623                 <span class="entry_type_container">x</span>
15624
15625                 <span class="entry_type_array">
15626                   n
15627                 </span>
15628               <span class="entry_type_visibility"> [public]</span>
15629
15630
15631               <span class="entry_type_hwlevel">[legacy] </span>
15632
15633
15634
15635                 <ul class="entry_type_enum">
15636                   <li>
15637                     <span class="entry_type_enum_name">BACKWARD_COMPATIBLE</span>
15638                     <span class="entry_type_enum_notes"><p>The minimal set of capabilities that every camera
15639 device (regardless of <a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>)
15640 supports.<wbr/></p>
15641 <p>This capability is listed by all normal devices,<wbr/> and
15642 indicates that the camera device has a feature set
15643 that's comparable to the baseline requirements for the
15644 older android.<wbr/>hardware.<wbr/>Camera API.<wbr/></p>
15645 <p>Devices with the DEPTH_<wbr/>OUTPUT capability might not list this
15646 capability,<wbr/> indicating that they support only depth measurement,<wbr/>
15647 not standard color output.<wbr/></p></span>
15648                   </li>
15649                   <li>
15650                     <span class="entry_type_enum_name">MANUAL_SENSOR</span>
15651                     <span class="entry_type_enum_optional">[optional]</span>
15652                     <span class="entry_type_enum_notes"><p>The camera device can be manually controlled (3A algorithms such
15653 as auto-exposure,<wbr/> and auto-focus can be bypassed).<wbr/>
15654 The camera device supports basic manual control of the sensor image
15655 acquisition related stages.<wbr/> This means the following controls are
15656 guaranteed to be supported:</p>
15657 <ul>
15658 <li>Manual frame duration control<ul>
15659 <li><a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a></li>
15660 <li><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a></li>
15661 </ul>
15662 </li>
15663 <li>Manual exposure control<ul>
15664 <li><a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a></li>
15665 <li><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></li>
15666 </ul>
15667 </li>
15668 <li>Manual sensitivity control<ul>
15669 <li><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></li>
15670 <li><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></li>
15671 </ul>
15672 </li>
15673 <li>Manual lens control (if the lens is adjustable)<ul>
15674 <li>android.<wbr/>lens.<wbr/>*</li>
15675 </ul>
15676 </li>
15677 <li>Manual flash control (if a flash unit is present)<ul>
15678 <li>android.<wbr/>flash.<wbr/>*</li>
15679 </ul>
15680 </li>
15681 <li>Manual black level locking<ul>
15682 <li><a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a></li>
15683 </ul>
15684 </li>
15685 <li>Auto exposure lock<ul>
15686 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
15687 </ul>
15688 </li>
15689 </ul>
15690 <p>If any of the above 3A algorithms are enabled,<wbr/> then the camera
15691 device will accurately report the values applied by 3A in the
15692 result.<wbr/></p>
15693 <p>A given camera device may also support additional manual sensor controls,<wbr/>
15694 but this capability only covers the above list of controls.<wbr/></p>
15695 <p>If this is supported,<wbr/> <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> will
15696 additionally return a min frame duration that is greater than
15697 zero for each supported size-format combination.<wbr/></p></span>
15698                   </li>
15699                   <li>
15700                     <span class="entry_type_enum_name">MANUAL_POST_PROCESSING</span>
15701                     <span class="entry_type_enum_optional">[optional]</span>
15702                     <span class="entry_type_enum_notes"><p>The camera device post-processing stages can be manually controlled.<wbr/>
15703 The camera device supports basic manual control of the image post-processing
15704 stages.<wbr/> This means the following controls are guaranteed to be supported:</p>
15705 <ul>
15706 <li>
15707 <p>Manual tonemap control</p>
15708 <ul>
15709 <li><a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a></li>
15710 <li><a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></li>
15711 <li><a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></li>
15712 <li><a href="#controls_android.tonemap.gamma">android.<wbr/>tonemap.<wbr/>gamma</a></li>
15713 <li><a href="#controls_android.tonemap.presetCurve">android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve</a></li>
15714 </ul>
15715 </li>
15716 <li>
15717 <p>Manual white balance control</p>
15718 <ul>
15719 <li><a href="#controls_android.colorCorrection.transform">android.<wbr/>color<wbr/>Correction.<wbr/>transform</a></li>
15720 <li><a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a></li>
15721 </ul>
15722 </li>
15723 <li>Manual lens shading map control<ul>
15724 <li><a href="#controls_android.shading.mode">android.<wbr/>shading.<wbr/>mode</a></li>
15725 <li><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a></li>
15726 <li><a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a></li>
15727 <li><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a></li>
15728 </ul>
15729 </li>
15730 <li>Manual aberration correction control (if aberration correction is supported)<ul>
15731 <li><a href="#controls_android.colorCorrection.aberrationMode">android.<wbr/>color<wbr/>Correction.<wbr/>aberration<wbr/>Mode</a></li>
15732 <li><a href="#static_android.colorCorrection.availableAberrationModes">android.<wbr/>color<wbr/>Correction.<wbr/>available<wbr/>Aberration<wbr/>Modes</a></li>
15733 </ul>
15734 </li>
15735 <li>Auto white balance lock<ul>
15736 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
15737 </ul>
15738 </li>
15739 </ul>
15740 <p>If auto white balance is enabled,<wbr/> then the camera device
15741 will accurately report the values applied by AWB in the result.<wbr/></p>
15742 <p>A given camera device may also support additional post-processing
15743 controls,<wbr/> but this capability only covers the above list of controls.<wbr/></p></span>
15744                   </li>
15745                   <li>
15746                     <span class="entry_type_enum_name">RAW</span>
15747                     <span class="entry_type_enum_optional">[optional]</span>
15748                     <span class="entry_type_enum_notes"><p>The camera device supports outputting RAW buffers and
15749 metadata for interpreting them.<wbr/></p>
15750 <p>Devices supporting the RAW capability allow both for
15751 saving DNG files,<wbr/> and for direct application processing of
15752 raw sensor images.<wbr/></p>
15753 <ul>
15754 <li>RAW_<wbr/>SENSOR is supported as an output format.<wbr/></li>
15755 <li>The maximum available resolution for RAW_<wbr/>SENSOR streams
15756   will match either the value in
15757   <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a> or
15758   <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a>.<wbr/></li>
15759 <li>All DNG-related optional metadata entries are provided
15760   by the camera device.<wbr/></li>
15761 </ul></span>
15762                   </li>
15763                   <li>
15764                     <span class="entry_type_enum_name">PRIVATE_REPROCESSING</span>
15765                     <span class="entry_type_enum_optional">[optional]</span>
15766                     <span class="entry_type_enum_notes"><p>The camera device supports the Zero Shutter Lag reprocessing use case.<wbr/></p>
15767 <ul>
15768 <li>One input stream is supported,<wbr/> that is,<wbr/> <code><a href="#static_android.request.maxNumInputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams</a> == 1</code>.<wbr/></li>
15769 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> is supported as an output/<wbr/>input format,<wbr/>
15770   that is,<wbr/> <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> is included in the lists of
15771   formats returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputFormats">StreamConfigurationMap#getInputFormats</a> and <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputFormats">StreamConfigurationMap#getOutputFormats</a>.<wbr/></li>
15772 <li><a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getValidOutputFormatsForInput">StreamConfigurationMap#getValidOutputFormatsForInput</a>
15773   returns non empty int[] for each supported input format returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputFormats">StreamConfigurationMap#getInputFormats</a>.<wbr/></li>
15774 <li>Each size returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputSizes">getInputSizes(ImageFormat.<wbr/>PRIVATE)</a> is also included in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">getOutputSizes(ImageFormat.<wbr/>PRIVATE)</a></li>
15775 <li>Using <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> does not cause a frame rate drop
15776   relative to the sensor's maximum capture rate (at that resolution).<wbr/></li>
15777 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> will be reprocessable into both
15778   <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> and
15779   <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> formats.<wbr/></li>
15780 <li>The maximum available resolution for PRIVATE streams
15781   (both input/<wbr/>output) will match the maximum available
15782   resolution of JPEG streams.<wbr/></li>
15783 <li>Static metadata <a href="#static_android.reprocess.maxCaptureStall">android.<wbr/>reprocess.<wbr/>max<wbr/>Capture<wbr/>Stall</a>.<wbr/></li>
15784 <li>Only below controls are effective for reprocessing requests and
15785   will be present in capture results,<wbr/> other controls in reprocess
15786   requests will be ignored by the camera device.<wbr/><ul>
15787 <li>android.<wbr/>jpeg.<wbr/>*</li>
15788 <li><a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a></li>
15789 <li><a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a></li>
15790 </ul>
15791 </li>
15792 <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a> and
15793   <a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a> will both list ZERO_<wbr/>SHUTTER_<wbr/>LAG as a supported mode.<wbr/></li>
15794 </ul></span>
15795                   </li>
15796                   <li>
15797                     <span class="entry_type_enum_name">READ_SENSOR_SETTINGS</span>
15798                     <span class="entry_type_enum_optional">[optional]</span>
15799                     <span class="entry_type_enum_notes"><p>The camera device supports accurately reporting the sensor settings for many of
15800 the sensor controls while the built-in 3A algorithm is running.<wbr/>  This allows
15801 reporting of sensor settings even when these settings cannot be manually changed.<wbr/></p>
15802 <p>The values reported for the following controls are guaranteed to be available
15803 in the CaptureResult,<wbr/> including when 3A is enabled:</p>
15804 <ul>
15805 <li>Exposure control<ul>
15806 <li><a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a></li>
15807 </ul>
15808 </li>
15809 <li>Sensitivity control<ul>
15810 <li><a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a></li>
15811 </ul>
15812 </li>
15813 <li>Lens controls (if the lens is adjustable)<ul>
15814 <li><a href="#controls_android.lens.focusDistance">android.<wbr/>lens.<wbr/>focus<wbr/>Distance</a></li>
15815 <li><a href="#controls_android.lens.aperture">android.<wbr/>lens.<wbr/>aperture</a></li>
15816 </ul>
15817 </li>
15818 </ul>
15819 <p>This capability is a subset of the MANUAL_<wbr/>SENSOR control capability,<wbr/> and will
15820 always be included if the MANUAL_<wbr/>SENSOR capability is available.<wbr/></p></span>
15821                   </li>
15822                   <li>
15823                     <span class="entry_type_enum_name">BURST_CAPTURE</span>
15824                     <span class="entry_type_enum_optional">[optional]</span>
15825                     <span class="entry_type_enum_notes"><p>The camera device supports capturing high-resolution images at &gt;= 20 frames per
15826 second,<wbr/> in at least the uncompressed YUV format,<wbr/> when post-processing settings are set
15827 to FAST.<wbr/> Additionally,<wbr/> maximum-resolution images can be captured at &gt;= 10 frames
15828 per second.<wbr/>  Here,<wbr/> 'high resolution' means at least 8 megapixels,<wbr/> or the maximum
15829 resolution of the device,<wbr/> whichever is smaller.<wbr/></p>
15830 <p>More specifically,<wbr/> this means that a size matching the camera device's active array
15831 size is listed as a supported size for the <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> format in either <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">StreamConfigurationMap#getOutputSizes</a> or <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighResolutionOutputSizes">StreamConfigurationMap#getHighResolutionOutputSizes</a>,<wbr/>
15832 with a minimum frame duration for that format and size of either &lt;= 1/<wbr/>20 s,<wbr/> or
15833 &lt;= 1/<wbr/>10 s,<wbr/> respectively; and the <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a> entry
15834 lists at least one FPS range where the minimum FPS is &gt;= 1 /<wbr/> minimumFrameDuration
15835 for the maximum-size YUV_<wbr/>420_<wbr/>888 format.<wbr/>  If that maximum size is listed in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighResolutionOutputSizes">StreamConfigurationMap#getHighResolutionOutputSizes</a>,<wbr/>
15836 then the list of resolutions for YUV_<wbr/>420_<wbr/>888 from <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">StreamConfigurationMap#getOutputSizes</a> contains at
15837 least one resolution &gt;= 8 megapixels,<wbr/> with a minimum frame duration of &lt;= 1/<wbr/>20
15838 s.<wbr/></p>
15839 <p>If the device supports the <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">ImageFormat#RAW10</a>,<wbr/> <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW12">ImageFormat#RAW12</a>,<wbr/> then those can also be captured at the same rate
15840 as the maximum-size YUV_<wbr/>420_<wbr/>888 resolution is.<wbr/></p>
15841 <p>If the device supports the PRIVATE_<wbr/>REPROCESSING capability,<wbr/> then the same guarantees
15842 as for the YUV_<wbr/>420_<wbr/>888 format also apply to the <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> format.<wbr/></p>
15843 <p>In addition,<wbr/> the <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> field is guaranted to have a value between 0
15844 and 4,<wbr/> inclusive.<wbr/> <a href="#static_android.control.aeLockAvailable">android.<wbr/>control.<wbr/>ae<wbr/>Lock<wbr/>Available</a> and <a href="#static_android.control.awbLockAvailable">android.<wbr/>control.<wbr/>awb<wbr/>Lock<wbr/>Available</a>
15845 are also guaranteed to be <code>true</code> so burst capture with these two locks ON yields
15846 consistent image output.<wbr/></p></span>
15847                   </li>
15848                   <li>
15849                     <span class="entry_type_enum_name">YUV_REPROCESSING</span>
15850                     <span class="entry_type_enum_optional">[optional]</span>
15851                     <span class="entry_type_enum_notes"><p>The camera device supports the YUV_<wbr/>420_<wbr/>888 reprocessing use case,<wbr/> similar as
15852 PRIVATE_<wbr/>REPROCESSING,<wbr/> This capability requires the camera device to support the
15853 following:</p>
15854 <ul>
15855 <li>One input stream is supported,<wbr/> that is,<wbr/> <code><a href="#static_android.request.maxNumInputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams</a> == 1</code>.<wbr/></li>
15856 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> is supported as an output/<wbr/>input format,<wbr/> that is,<wbr/>
15857   YUV_<wbr/>420_<wbr/>888 is included in the lists of formats returned by
15858   <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputFormats">StreamConfigurationMap#getInputFormats</a> and
15859   <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputFormats">StreamConfigurationMap#getOutputFormats</a>.<wbr/></li>
15860 <li><a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getValidOutputFormatsForInput">StreamConfigurationMap#getValidOutputFormatsForInput</a>
15861   returns non-empty int[] for each supported input format returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputFormats">StreamConfigurationMap#getInputFormats</a>.<wbr/></li>
15862 <li>Each size returned by <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getInputSizes">get<wbr/>Input<wbr/>Sizes(YUV_<wbr/>420_<wbr/>888)</a> is also included in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputSizes">get<wbr/>Output<wbr/>Sizes(YUV_<wbr/>420_<wbr/>888)</a></li>
15863 <li>Using <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> does not cause a frame rate drop
15864   relative to the sensor's maximum capture rate (at that resolution).<wbr/></li>
15865 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> will be reprocessable into both
15866   <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> and <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> formats.<wbr/></li>
15867 <li>The maximum available resolution for <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a> streams (both input/<wbr/>output) will match the
15868   maximum available resolution of <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a> streams.<wbr/></li>
15869 <li>Static metadata <a href="#static_android.reprocess.maxCaptureStall">android.<wbr/>reprocess.<wbr/>max<wbr/>Capture<wbr/>Stall</a>.<wbr/></li>
15870 <li>Only the below controls are effective for reprocessing requests and will be present
15871   in capture results.<wbr/> The reprocess requests are from the original capture results that
15872   are associated with the intermediate <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a>
15873   output buffers.<wbr/>  All other controls in the reprocess requests will be ignored by the
15874   camera device.<wbr/><ul>
15875 <li>android.<wbr/>jpeg.<wbr/>*</li>
15876 <li><a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a></li>
15877 <li><a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a></li>
15878 <li><a href="#controls_android.reprocess.effectiveExposureFactor">android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor</a></li>
15879 </ul>
15880 </li>
15881 <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.<wbr/>noise<wbr/>Reduction.<wbr/>available<wbr/>Noise<wbr/>Reduction<wbr/>Modes</a> and
15882   <a href="#static_android.edge.availableEdgeModes">android.<wbr/>edge.<wbr/>available<wbr/>Edge<wbr/>Modes</a> will both list ZERO_<wbr/>SHUTTER_<wbr/>LAG as a supported mode.<wbr/></li>
15883 </ul></span>
15884                   </li>
15885                   <li>
15886                     <span class="entry_type_enum_name">DEPTH_OUTPUT</span>
15887                     <span class="entry_type_enum_optional">[optional]</span>
15888                     <span class="entry_type_enum_notes"><p>The camera device can produce depth measurements from its field of view.<wbr/></p>
15889 <p>This capability requires the camera device to support the following:</p>
15890 <ul>
15891 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH16">ImageFormat#DEPTH16</a> is supported as an output format.<wbr/></li>
15892 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH_POINT_CLOUD">Image<wbr/>Format#DEPTH_<wbr/>POINT_<wbr/>CLOUD</a> is optionally supported as an
15893   output format.<wbr/></li>
15894 <li>This camera device,<wbr/> and all camera devices with the same <a href="#static_android.lens.facing">android.<wbr/>lens.<wbr/>facing</a>,<wbr/>
15895   will list the following calibration entries in both
15896   <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a> and
15897   <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">CaptureResult</a>:<ul>
15898 <li><a href="#static_android.lens.poseTranslation">android.<wbr/>lens.<wbr/>pose<wbr/>Translation</a></li>
15899 <li><a href="#static_android.lens.poseRotation">android.<wbr/>lens.<wbr/>pose<wbr/>Rotation</a></li>
15900 <li><a href="#static_android.lens.intrinsicCalibration">android.<wbr/>lens.<wbr/>intrinsic<wbr/>Calibration</a></li>
15901 <li><a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a></li>
15902 </ul>
15903 </li>
15904 <li>The <a href="#static_android.depth.depthIsExclusive">android.<wbr/>depth.<wbr/>depth<wbr/>Is<wbr/>Exclusive</a> entry is listed by this device.<wbr/></li>
15905 <li>A LIMITED camera with only the DEPTH_<wbr/>OUTPUT capability does not have to support
15906   normal YUV_<wbr/>420_<wbr/>888,<wbr/> JPEG,<wbr/> and PRIV-format outputs.<wbr/> It only has to support the DEPTH16
15907   format.<wbr/></li>
15908 </ul>
15909 <p>Generally,<wbr/> depth output operates at a slower frame rate than standard color capture,<wbr/>
15910 so the DEPTH16 and DEPTH_<wbr/>POINT_<wbr/>CLOUD formats will commonly have a stall duration that
15911 should be accounted for (see
15912 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>).<wbr/>
15913 On a device that supports both depth and color-based output,<wbr/> to enable smooth preview,<wbr/>
15914 using a repeating burst is recommended,<wbr/> where a depth-output target is only included
15915 once every N frames,<wbr/> where N is the ratio between preview output rate and depth output
15916 rate,<wbr/> including depth stall time.<wbr/></p></span>
15917                   </li>
15918                   <li>
15919                     <span class="entry_type_enum_name">CONSTRAINED_HIGH_SPEED_VIDEO</span>
15920                     <span class="entry_type_enum_optional">[optional]</span>
15921                     <span class="entry_type_enum_notes"><p>The device supports constrained high speed video recording (frame rate &gt;=120fps)
15922 use case.<wbr/> The camera device will support high speed capture session created by
15923 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>,<wbr/> which
15924 only accepts high speed request lists created by
15925 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraConstrainedHighSpeedCaptureSession.html#createHighSpeedRequestList">CameraConstrainedHighSpeedCaptureSession#createHighSpeedRequestList</a>.<wbr/></p>
15926 <p>A camera device can still support high speed video streaming by advertising the high speed
15927 FPS ranges in <a href="#static_android.control.aeAvailableTargetFpsRanges">android.<wbr/>control.<wbr/>ae<wbr/>Available<wbr/>Target<wbr/>Fps<wbr/>Ranges</a>.<wbr/> For this case,<wbr/> all normal
15928 capture request per frame control and synchronization requirements will apply to
15929 the high speed fps ranges,<wbr/> the same as all other fps ranges.<wbr/> This capability describes
15930 the capability of a specialized operating mode with many limitations (see below),<wbr/> which
15931 is only targeted at high speed video recording.<wbr/></p>
15932 <p>The supported high speed video sizes and fps ranges are specified in
15933 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoFpsRanges">StreamConfigurationMap#getHighSpeedVideoFpsRanges</a>.<wbr/>
15934 To get desired output frame rates,<wbr/> the application is only allowed to select video size
15935 and FPS range combinations provided by
15936 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoSizes">StreamConfigurationMap#getHighSpeedVideoSizes</a>.<wbr/>
15937 The fps range can be controlled via <a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a>.<wbr/></p>
15938 <p>In this capability,<wbr/> the camera device will override aeMode,<wbr/> awbMode,<wbr/> and afMode to
15939 ON,<wbr/> AUTO,<wbr/> and CONTINUOUS_<wbr/>VIDEO,<wbr/> respectively.<wbr/> All post-processing block mode
15940 controls will be overridden to be FAST.<wbr/> Therefore,<wbr/> no manual control of capture
15941 and post-processing parameters is possible.<wbr/> All other controls operate the
15942 same as when <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> == AUTO.<wbr/> This means that all other
15943 android.<wbr/>control.<wbr/>* fields continue to work,<wbr/> such as</p>
15944 <ul>
15945 <li><a href="#controls_android.control.aeTargetFpsRange">android.<wbr/>control.<wbr/>ae<wbr/>Target<wbr/>Fps<wbr/>Range</a></li>
15946 <li><a href="#controls_android.control.aeExposureCompensation">android.<wbr/>control.<wbr/>ae<wbr/>Exposure<wbr/>Compensation</a></li>
15947 <li><a href="#controls_android.control.aeLock">android.<wbr/>control.<wbr/>ae<wbr/>Lock</a></li>
15948 <li><a href="#controls_android.control.awbLock">android.<wbr/>control.<wbr/>awb<wbr/>Lock</a></li>
15949 <li><a href="#controls_android.control.effectMode">android.<wbr/>control.<wbr/>effect<wbr/>Mode</a></li>
15950 <li><a href="#controls_android.control.aeRegions">android.<wbr/>control.<wbr/>ae<wbr/>Regions</a></li>
15951 <li><a href="#controls_android.control.afRegions">android.<wbr/>control.<wbr/>af<wbr/>Regions</a></li>
15952 <li><a href="#controls_android.control.awbRegions">android.<wbr/>control.<wbr/>awb<wbr/>Regions</a></li>
15953 <li><a href="#controls_android.control.afTrigger">android.<wbr/>control.<wbr/>af<wbr/>Trigger</a></li>
15954 <li><a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a></li>
15955 </ul>
15956 <p>Outside of android.<wbr/>control.<wbr/>*,<wbr/> the following controls will work:</p>
15957 <ul>
15958 <li><a href="#controls_android.flash.mode">android.<wbr/>flash.<wbr/>mode</a> (TORCH mode only,<wbr/> automatic flash for still capture will not
15959 work since aeMode is ON)</li>
15960 <li><a href="#controls_android.lens.opticalStabilizationMode">android.<wbr/>lens.<wbr/>optical<wbr/>Stabilization<wbr/>Mode</a> (if it is supported)</li>
15961 <li><a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a></li>
15962 <li><a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> (if it is supported)</li>
15963 </ul>
15964 <p>For high speed recording use case,<wbr/> the actual maximum supported frame rate may
15965 be lower than what camera can output,<wbr/> depending on the destination Surfaces for
15966 the image data.<wbr/> For example,<wbr/> if the destination surface is from video encoder,<wbr/>
15967 the application need check if the video encoder is capable of supporting the
15968 high frame rate for a given video size,<wbr/> or it will end up with lower recording
15969 frame rate.<wbr/> If the destination surface is from preview window,<wbr/> the actual preview frame
15970 rate will be bounded by the screen refresh rate.<wbr/></p>
15971 <p>The camera device will only support up to 2 high speed simultaneous output surfaces
15972 (preview and recording surfaces)
15973 in this mode.<wbr/> Above controls will be effective only if all of below conditions are true:</p>
15974 <ul>
15975 <li>The application creates a camera capture session with no more than 2 surfaces via
15976 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>.<wbr/> The
15977 targeted surfaces must be preview surface (either from
15978 <a href="https://developer.android.com/reference/android/view/SurfaceView.html">SurfaceView</a> or <a href="https://developer.android.com/reference/android/graphics/SurfaceTexture.html">SurfaceTexture</a>) or
15979 recording surface(either from <a href="https://developer.android.com/reference/android/media/MediaRecorder.html#getSurface">MediaRecorder#getSurface</a> or
15980 <a href="https://developer.android.com/reference/android/media/MediaCodec.html#createInputSurface">MediaCodec#createInputSurface</a>).<wbr/></li>
15981 <li>The stream sizes are selected from the sizes reported by
15982 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoSizes">StreamConfigurationMap#getHighSpeedVideoSizes</a>.<wbr/></li>
15983 <li>The FPS ranges are selected from
15984 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getHighSpeedVideoFpsRanges">StreamConfigurationMap#getHighSpeedVideoFpsRanges</a>.<wbr/></li>
15985 </ul>
15986 <p>When above conditions are NOT satistied,<wbr/>
15987 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createConstrainedHighSpeedCaptureSession">CameraDevice#createConstrainedHighSpeedCaptureSession</a>
15988 will fail.<wbr/></p>
15989 <p>Switching to a FPS range that has different maximum FPS may trigger some camera device
15990 reconfigurations,<wbr/> which may introduce extra latency.<wbr/> It is recommended that
15991 the application avoids unnecessary maximum target FPS changes as much as possible
15992 during high speed streaming.<wbr/></p></span>
15993                   </li>
15994                 </ul>
15995
15996             </td> <!-- entry_type -->
15997
15998             <td class="entry_description">
15999               <p>List of capabilities that this camera device
16000 advertises as fully supporting.<wbr/></p>
16001             </td>
16002
16003             <td class="entry_units">
16004             </td>
16005
16006             <td class="entry_range">
16007             </td>
16008
16009             <td class="entry_tags">
16010             </td>
16011
16012           </tr>
16013           <tr class="entries_header">
16014             <th class="th_details" colspan="5">Details</th>
16015           </tr>
16016           <tr class="entry_cont">
16017             <td class="entry_details" colspan="5">
16018               <p>A capability is a contract that the camera device makes in order
16019 to be able to satisfy one or more use cases.<wbr/></p>
16020 <p>Listing a capability guarantees that the whole set of features
16021 required to support a common use will all be available.<wbr/></p>
16022 <p>Using a subset of the functionality provided by an unsupported
16023 capability may be possible on a specific camera device implementation;
16024 to do this query each of <a href="#static_android.request.availableRequestKeys">android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys</a>,<wbr/>
16025 <a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a>,<wbr/>
16026 <a href="#static_android.request.availableCharacteristicsKeys">android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys</a>.<wbr/></p>
16027 <p>The following capabilities are guaranteed to be available on
16028 <a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> <code>==</code> FULL devices:</p>
16029 <ul>
16030 <li>MANUAL_<wbr/>SENSOR</li>
16031 <li>MANUAL_<wbr/>POST_<wbr/>PROCESSING</li>
16032 </ul>
16033 <p>Other capabilities may be available on either FULL or LIMITED
16034 devices,<wbr/> but the application should query this key to be sure.<wbr/></p>
16035             </td>
16036           </tr>
16037
16038           <tr class="entries_header">
16039             <th class="th_details" colspan="5">HAL Implementation Details</th>
16040           </tr>
16041           <tr class="entry_cont">
16042             <td class="entry_details" colspan="5">
16043               <p>Additional constraint details per-capability will be available
16044 in the Compatibility Test Suite.<wbr/></p>
16045 <p>Minimum baseline requirements required for the
16046 BACKWARD_<wbr/>COMPATIBLE capability are not explicitly listed.<wbr/>
16047 Instead refer to "BC" tags and the camera CTS tests in the
16048 android.<wbr/>hardware.<wbr/>camera2.<wbr/>cts package.<wbr/></p>
16049 <p>Listed controls that can be either request or result (e.<wbr/>g.<wbr/>
16050 <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a>) must be available both in the
16051 request and the result in order to be considered to be
16052 capability-compliant.<wbr/></p>
16053 <p>For example,<wbr/> if the HAL claims to support MANUAL control,<wbr/>
16054 then exposure time must be configurable via the request <em>and</em>
16055 the actual exposure applied must be available via
16056 the result.<wbr/></p>
16057 <p>If MANUAL_<wbr/>SENSOR is omitted,<wbr/> the HAL may choose to omit the
16058 <a href="#static_android.scaler.availableMinFrameDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations</a> static property entirely.<wbr/></p>
16059 <p>For PRIVATE_<wbr/>REPROCESSING and YUV_<wbr/>REPROCESSING capabilities,<wbr/> see
16060 hardware/<wbr/>libhardware/<wbr/>include/<wbr/>hardware/<wbr/>camera3.<wbr/>h Section 10 for more information.<wbr/></p>
16061 <p>Devices that support the MANUAL_<wbr/>SENSOR capability must support the
16062 CAMERA3_<wbr/>TEMPLATE_<wbr/>MANUAL template defined in camera3.<wbr/>h.<wbr/></p>
16063 <p>Devices that support the PRIVATE_<wbr/>REPROCESSING capability or the
16064 YUV_<wbr/>REPROCESSING capability must support the
16065 CAMERA3_<wbr/>TEMPLATE_<wbr/>ZERO_<wbr/>SHUTTER_<wbr/>LAG template defined in camera3.<wbr/>h.<wbr/></p>
16066 <p>For DEPTH_<wbr/>OUTPUT,<wbr/> the depth-format keys
16067 <a href="#static_android.depth.availableDepthStreamConfigurations">android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Stream<wbr/>Configurations</a>,<wbr/>
16068 <a href="#static_android.depth.availableDepthMinFrameDurations">android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Min<wbr/>Frame<wbr/>Durations</a>,<wbr/>
16069 <a href="#static_android.depth.availableDepthStallDurations">android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Stall<wbr/>Durations</a> must be available,<wbr/> in
16070 addition to the other keys explicitly mentioned in the DEPTH_<wbr/>OUTPUT
16071 enum notes.<wbr/> The entry <a href="#static_android.depth.maxDepthSamples">android.<wbr/>depth.<wbr/>max<wbr/>Depth<wbr/>Samples</a> must be available
16072 if the DEPTH_<wbr/>POINT_<wbr/>CLOUD format is supported (HAL pixel format BLOB,<wbr/> dataspace
16073 DEPTH).<wbr/></p>
16074             </td>
16075           </tr>
16076
16077           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16078            <!-- end of entry -->
16079
16080
16081           <tr class="entry" id="static_android.request.availableRequestKeys">
16082             <td class="entry_name
16083              " rowspan="5">
16084               android.<wbr/>request.<wbr/>available<wbr/>Request<wbr/>Keys
16085             </td>
16086             <td class="entry_type">
16087                 <span class="entry_type_name">int32</span>
16088                 <span class="entry_type_container">x</span>
16089
16090                 <span class="entry_type_array">
16091                   n
16092                 </span>
16093               <span class="entry_type_visibility"> [ndk_public]</span>
16094
16095
16096               <span class="entry_type_hwlevel">[legacy] </span>
16097
16098
16099
16100
16101             </td> <!-- entry_type -->
16102
16103             <td class="entry_description">
16104               <p>A list of all keys that the camera device has available
16105 to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureRequest.html">CaptureRequest</a>.<wbr/></p>
16106             </td>
16107
16108             <td class="entry_units">
16109             </td>
16110
16111             <td class="entry_range">
16112             </td>
16113
16114             <td class="entry_tags">
16115             </td>
16116
16117           </tr>
16118           <tr class="entries_header">
16119             <th class="th_details" colspan="5">Details</th>
16120           </tr>
16121           <tr class="entry_cont">
16122             <td class="entry_details" colspan="5">
16123               <p>Attempting to set a key into a CaptureRequest that is not
16124 listed here will result in an invalid request and will be rejected
16125 by the camera device.<wbr/></p>
16126 <p>This field can be used to query the feature set of a camera device
16127 at a more granular level than capabilities.<wbr/> This is especially
16128 important for optional keys that are not listed under any capability
16129 in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
16130             </td>
16131           </tr>
16132
16133           <tr class="entries_header">
16134             <th class="th_details" colspan="5">HAL Implementation Details</th>
16135           </tr>
16136           <tr class="entry_cont">
16137             <td class="entry_details" colspan="5">
16138               <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
16139 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
16140 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
16141 vendor extensions API and not against this field.<wbr/></p>
16142 <p>The HAL must not consume any request tags that are not listed either
16143 here or in the vendor tag list.<wbr/></p>
16144 <p>The public camera2 API will always make the vendor tags visible
16145 via
16146 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureRequestKeys">CameraCharacteristics#getAvailableCaptureRequestKeys</a>.<wbr/></p>
16147             </td>
16148           </tr>
16149
16150           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16151            <!-- end of entry -->
16152
16153
16154           <tr class="entry" id="static_android.request.availableResultKeys">
16155             <td class="entry_name
16156              " rowspan="5">
16157               android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys
16158             </td>
16159             <td class="entry_type">
16160                 <span class="entry_type_name">int32</span>
16161                 <span class="entry_type_container">x</span>
16162
16163                 <span class="entry_type_array">
16164                   n
16165                 </span>
16166               <span class="entry_type_visibility"> [ndk_public]</span>
16167
16168
16169               <span class="entry_type_hwlevel">[legacy] </span>
16170
16171
16172
16173
16174             </td> <!-- entry_type -->
16175
16176             <td class="entry_description">
16177               <p>A list of all keys that the camera device has available
16178 to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html">CaptureResult</a>.<wbr/></p>
16179             </td>
16180
16181             <td class="entry_units">
16182             </td>
16183
16184             <td class="entry_range">
16185             </td>
16186
16187             <td class="entry_tags">
16188             </td>
16189
16190           </tr>
16191           <tr class="entries_header">
16192             <th class="th_details" colspan="5">Details</th>
16193           </tr>
16194           <tr class="entry_cont">
16195             <td class="entry_details" colspan="5">
16196               <p>Attempting to get a key from a CaptureResult that is not
16197 listed here will always return a <code>null</code> value.<wbr/> Getting a key from
16198 a CaptureResult that is listed here will generally never return a <code>null</code>
16199 value.<wbr/></p>
16200 <p>The following keys may return <code>null</code> unless they are enabled:</p>
16201 <ul>
16202 <li><a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> (non-null iff <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON)</li>
16203 </ul>
16204 <p>(Those sometimes-null keys will nevertheless be listed here
16205 if they are available.<wbr/>)</p>
16206 <p>This field can be used to query the feature set of a camera device
16207 at a more granular level than capabilities.<wbr/> This is especially
16208 important for optional keys that are not listed under any capability
16209 in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
16210             </td>
16211           </tr>
16212
16213           <tr class="entries_header">
16214             <th class="th_details" colspan="5">HAL Implementation Details</th>
16215           </tr>
16216           <tr class="entry_cont">
16217             <td class="entry_details" colspan="5">
16218               <p>Tags listed here must always have an entry in the result metadata,<wbr/>
16219 even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
16220 matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
16221 <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
16222 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
16223 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
16224 vendor extensions API and not against this field.<wbr/></p>
16225 <p>The HAL must not produce any result tags that are not listed either
16226 here or in the vendor tag list.<wbr/></p>
16227 <p>The public camera2 API will always make the vendor tags visible via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureResultKeys">CameraCharacteristics#getAvailableCaptureResultKeys</a>.<wbr/></p>
16228             </td>
16229           </tr>
16230
16231           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16232            <!-- end of entry -->
16233
16234
16235           <tr class="entry" id="static_android.request.availableCharacteristicsKeys">
16236             <td class="entry_name
16237              " rowspan="5">
16238               android.<wbr/>request.<wbr/>available<wbr/>Characteristics<wbr/>Keys
16239             </td>
16240             <td class="entry_type">
16241                 <span class="entry_type_name">int32</span>
16242                 <span class="entry_type_container">x</span>
16243
16244                 <span class="entry_type_array">
16245                   n
16246                 </span>
16247               <span class="entry_type_visibility"> [ndk_public]</span>
16248
16249
16250               <span class="entry_type_hwlevel">[legacy] </span>
16251
16252
16253
16254
16255             </td> <!-- entry_type -->
16256
16257             <td class="entry_description">
16258               <p>A list of all keys that the camera device has available
16259 to use with <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a>.<wbr/></p>
16260             </td>
16261
16262             <td class="entry_units">
16263             </td>
16264
16265             <td class="entry_range">
16266             </td>
16267
16268             <td class="entry_tags">
16269             </td>
16270
16271           </tr>
16272           <tr class="entries_header">
16273             <th class="th_details" colspan="5">Details</th>
16274           </tr>
16275           <tr class="entry_cont">
16276             <td class="entry_details" colspan="5">
16277               <p>This entry follows the same rules as
16278 <a href="#static_android.request.availableResultKeys">android.<wbr/>request.<wbr/>available<wbr/>Result<wbr/>Keys</a> (except that it applies for
16279 CameraCharacteristics instead of CaptureResult).<wbr/> See above for more
16280 details.<wbr/></p>
16281             </td>
16282           </tr>
16283
16284           <tr class="entries_header">
16285             <th class="th_details" colspan="5">HAL Implementation Details</th>
16286           </tr>
16287           <tr class="entry_cont">
16288             <td class="entry_details" colspan="5">
16289               <p>Keys listed here must always have an entry in the static info metadata,<wbr/>
16290 even if that size is 0 elements.<wbr/> Only array-type tags (e.<wbr/>g.<wbr/> lists,<wbr/>
16291 matrices,<wbr/> strings) are allowed to have 0 elements.<wbr/></p>
16292 <p>Vendor tags must not be listed here.<wbr/> Use the vendor tag metadata
16293 extensions C api instead (refer to camera3.<wbr/>h for more details).<wbr/></p>
16294 <p>Setting/<wbr/>getting vendor tags will be checked against the metadata
16295 vendor extensions API and not against this field.<wbr/></p>
16296 <p>The HAL must not have any tags in its static info that are not listed
16297 either here or in the vendor tag list.<wbr/></p>
16298 <p>The public camera2 API will always make the vendor tags visible
16299 via <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getKeys">CameraCharacteristics#getKeys</a>.<wbr/></p>
16300             </td>
16301           </tr>
16302
16303           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16304            <!-- end of entry -->
16305
16306
16307
16308       <!-- end of kind -->
16309       </tbody>
16310       <tr><td colspan="6" class="kind">dynamic</td></tr>
16311
16312       <thead class="entries_header">
16313         <tr>
16314           <th class="th_name">Property Name</th>
16315           <th class="th_type">Type</th>
16316           <th class="th_description">Description</th>
16317           <th class="th_units">Units</th>
16318           <th class="th_range">Range</th>
16319           <th class="th_tags">Tags</th>
16320         </tr>
16321       </thead>
16322
16323       <tbody>
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334           <tr class="entry" id="dynamic_android.request.frameCount">
16335             <td class="entry_name
16336                 entry_name_deprecated
16337              " rowspan="3">
16338               android.<wbr/>request.<wbr/>frame<wbr/>Count
16339             </td>
16340             <td class="entry_type">
16341                 <span class="entry_type_name">int32</span>
16342
16343               <span class="entry_type_visibility"> [hidden]</span>
16344
16345
16346
16347               <span class="entry_type_deprecated">[deprecated] </span>
16348
16349
16350
16351             </td> <!-- entry_type -->
16352
16353             <td class="entry_description">
16354               <p>A frame counter set by the framework.<wbr/> This value monotonically
16355 increases with every new result (that is,<wbr/> each new result has a unique
16356 frameCount value).<wbr/></p>
16357             </td>
16358
16359             <td class="entry_units">
16360               count of frames
16361             </td>
16362
16363             <td class="entry_range">
16364               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
16365               <p>&gt; 0</p>
16366             </td>
16367
16368             <td class="entry_tags">
16369             </td>
16370
16371           </tr>
16372           <tr class="entries_header">
16373             <th class="th_details" colspan="5">Details</th>
16374           </tr>
16375           <tr class="entry_cont">
16376             <td class="entry_details" colspan="5">
16377               <p>Reset on release()</p>
16378             </td>
16379           </tr>
16380
16381
16382           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16383            <!-- end of entry -->
16384
16385
16386           <tr class="entry" id="dynamic_android.request.id">
16387             <td class="entry_name
16388              " rowspan="1">
16389               android.<wbr/>request.<wbr/>id
16390             </td>
16391             <td class="entry_type">
16392                 <span class="entry_type_name">int32</span>
16393
16394               <span class="entry_type_visibility"> [hidden]</span>
16395
16396
16397
16398
16399
16400
16401             </td> <!-- entry_type -->
16402
16403             <td class="entry_description">
16404               <p>An application-specified ID for the current
16405 request.<wbr/> Must be maintained unchanged in output
16406 frame</p>
16407             </td>
16408
16409             <td class="entry_units">
16410               arbitrary integer assigned by application
16411             </td>
16412
16413             <td class="entry_range">
16414               <p>Any int</p>
16415             </td>
16416
16417             <td class="entry_tags">
16418               <ul class="entry_tags">
16419                   <li><a href="#tag_V1">V1</a></li>
16420               </ul>
16421             </td>
16422
16423           </tr>
16424
16425
16426           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16427            <!-- end of entry -->
16428
16429
16430           <tr class="entry" id="dynamic_android.request.metadataMode">
16431             <td class="entry_name
16432              " rowspan="1">
16433               android.<wbr/>request.<wbr/>metadata<wbr/>Mode
16434             </td>
16435             <td class="entry_type">
16436                 <span class="entry_type_name entry_type_name_enum">byte</span>
16437
16438               <span class="entry_type_visibility"> [system]</span>
16439
16440
16441
16442
16443
16444                 <ul class="entry_type_enum">
16445                   <li>
16446                     <span class="entry_type_enum_name">NONE</span>
16447                     <span class="entry_type_enum_notes"><p>No metadata should be produced on output,<wbr/> except
16448 for application-bound buffer data.<wbr/> If no
16449 application-bound streams exist,<wbr/> no frame should be
16450 placed in the output frame queue.<wbr/> If such streams
16451 exist,<wbr/> a frame should be placed on the output queue
16452 with null metadata but with the necessary output buffer
16453 information.<wbr/> Timestamp information should still be
16454 included with any output stream buffers</p></span>
16455                   </li>
16456                   <li>
16457                     <span class="entry_type_enum_name">FULL</span>
16458                     <span class="entry_type_enum_notes"><p>All metadata should be produced.<wbr/> Statistics will
16459 only be produced if they are separately
16460 enabled</p></span>
16461                   </li>
16462                 </ul>
16463
16464             </td> <!-- entry_type -->
16465
16466             <td class="entry_description">
16467               <p>How much metadata to produce on
16468 output</p>
16469             </td>
16470
16471             <td class="entry_units">
16472             </td>
16473
16474             <td class="entry_range">
16475             </td>
16476
16477             <td class="entry_tags">
16478               <ul class="entry_tags">
16479                   <li><a href="#tag_FUTURE">FUTURE</a></li>
16480               </ul>
16481             </td>
16482
16483           </tr>
16484
16485
16486           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16487            <!-- end of entry -->
16488
16489
16490           <tr class="entry" id="dynamic_android.request.outputStreams">
16491             <td class="entry_name
16492                 entry_name_deprecated
16493              " rowspan="3">
16494               android.<wbr/>request.<wbr/>output<wbr/>Streams
16495             </td>
16496             <td class="entry_type">
16497                 <span class="entry_type_name">int32</span>
16498                 <span class="entry_type_container">x</span>
16499
16500                 <span class="entry_type_array">
16501                   n
16502                 </span>
16503               <span class="entry_type_visibility"> [system]</span>
16504
16505
16506
16507               <span class="entry_type_deprecated">[deprecated] </span>
16508
16509
16510
16511             </td> <!-- entry_type -->
16512
16513             <td class="entry_description">
16514               <p>Lists which camera output streams image data
16515 from this capture must be sent to</p>
16516             </td>
16517
16518             <td class="entry_units">
16519               List of camera stream IDs
16520             </td>
16521
16522             <td class="entry_range">
16523               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
16524               <p>List must only include streams that have been
16525 created</p>
16526             </td>
16527
16528             <td class="entry_tags">
16529               <ul class="entry_tags">
16530                   <li><a href="#tag_HAL2">HAL2</a></li>
16531               </ul>
16532             </td>
16533
16534           </tr>
16535           <tr class="entries_header">
16536             <th class="th_details" colspan="5">Details</th>
16537           </tr>
16538           <tr class="entry_cont">
16539             <td class="entry_details" colspan="5">
16540               <p>If no output streams are listed,<wbr/> then the image
16541 data should simply be discarded.<wbr/> The image data must
16542 still be captured for metadata and statistics production,<wbr/>
16543 and the lens and flash must operate as requested.<wbr/></p>
16544             </td>
16545           </tr>
16546
16547
16548           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16549            <!-- end of entry -->
16550
16551
16552           <tr class="entry" id="dynamic_android.request.pipelineDepth">
16553             <td class="entry_name
16554              " rowspan="5">
16555               android.<wbr/>request.<wbr/>pipeline<wbr/>Depth
16556             </td>
16557             <td class="entry_type">
16558                 <span class="entry_type_name">byte</span>
16559
16560               <span class="entry_type_visibility"> [public]</span>
16561
16562
16563               <span class="entry_type_hwlevel">[legacy] </span>
16564
16565
16566
16567
16568             </td> <!-- entry_type -->
16569
16570             <td class="entry_description">
16571               <p>Specifies the number of pipeline stages the frame went
16572 through from when it was exposed to when the final completed result
16573 was available to the framework.<wbr/></p>
16574             </td>
16575
16576             <td class="entry_units">
16577             </td>
16578
16579             <td class="entry_range">
16580               <p>&lt;= <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a></p>
16581             </td>
16582
16583             <td class="entry_tags">
16584             </td>
16585
16586           </tr>
16587           <tr class="entries_header">
16588             <th class="th_details" colspan="5">Details</th>
16589           </tr>
16590           <tr class="entry_cont">
16591             <td class="entry_details" colspan="5">
16592               <p>Depending on what settings are used in the request,<wbr/> and
16593 what streams are configured,<wbr/> the data may undergo less processing,<wbr/>
16594 and some pipeline stages skipped.<wbr/></p>
16595 <p>See <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> for more details.<wbr/></p>
16596             </td>
16597           </tr>
16598
16599           <tr class="entries_header">
16600             <th class="th_details" colspan="5">HAL Implementation Details</th>
16601           </tr>
16602           <tr class="entry_cont">
16603             <td class="entry_details" colspan="5">
16604               <p>This value must always represent the accurate count of how many
16605 pipeline stages were actually used.<wbr/></p>
16606             </td>
16607           </tr>
16608
16609           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16610            <!-- end of entry -->
16611
16612
16613
16614       <!-- end of kind -->
16615       </tbody>
16616
16617   <!-- end of section -->
16618   <tr><td colspan="6" id="section_scaler" class="section">scaler</td></tr>
16619
16620
16621       <tr><td colspan="6" class="kind">controls</td></tr>
16622
16623       <thead class="entries_header">
16624         <tr>
16625           <th class="th_name">Property Name</th>
16626           <th class="th_type">Type</th>
16627           <th class="th_description">Description</th>
16628           <th class="th_units">Units</th>
16629           <th class="th_range">Range</th>
16630           <th class="th_tags">Tags</th>
16631         </tr>
16632       </thead>
16633
16634       <tbody>
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645           <tr class="entry" id="controls_android.scaler.cropRegion">
16646             <td class="entry_name
16647              " rowspan="5">
16648               android.<wbr/>scaler.<wbr/>crop<wbr/>Region
16649             </td>
16650             <td class="entry_type">
16651                 <span class="entry_type_name">int32</span>
16652                 <span class="entry_type_container">x</span>
16653
16654                 <span class="entry_type_array">
16655                   4
16656                 </span>
16657               <span class="entry_type_visibility"> [public as rectangle]</span>
16658
16659
16660               <span class="entry_type_hwlevel">[legacy] </span>
16661
16662
16663
16664
16665             </td> <!-- entry_type -->
16666
16667             <td class="entry_description">
16668               <p>The desired region of the sensor to read out for this capture.<wbr/></p>
16669             </td>
16670
16671             <td class="entry_units">
16672               Pixel coordinates relative to
16673           android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
16674             </td>
16675
16676             <td class="entry_range">
16677             </td>
16678
16679             <td class="entry_tags">
16680               <ul class="entry_tags">
16681                   <li><a href="#tag_BC">BC</a></li>
16682               </ul>
16683             </td>
16684
16685           </tr>
16686           <tr class="entries_header">
16687             <th class="th_details" colspan="5">Details</th>
16688           </tr>
16689           <tr class="entry_cont">
16690             <td class="entry_details" colspan="5">
16691               <p>This control can be used to implement digital zoom.<wbr/></p>
16692 <p>The crop region coordinate system is based off
16693 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with <code>(0,<wbr/> 0)</code> being the
16694 top-left corner of the sensor active array.<wbr/></p>
16695 <p>Output streams use this rectangle to produce their output,<wbr/>
16696 cropping to a smaller region if necessary to maintain the
16697 stream's aspect ratio,<wbr/> then scaling the sensor input to
16698 match the output's configured resolution.<wbr/></p>
16699 <p>The crop region is applied after the RAW to other color
16700 space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
16701 (e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
16702 croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
16703 <p>For non-raw streams,<wbr/> any additional per-stream cropping will
16704 be done to maximize the final pixel area of the stream.<wbr/></p>
16705 <p>For example,<wbr/> if the crop region is set to a 4:3 aspect
16706 ratio,<wbr/> then 4:3 streams will use the exact crop
16707 region.<wbr/> 16:9 streams will further crop vertically
16708 (letterbox).<wbr/></p>
16709 <p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
16710 outputs will crop horizontally (pillarbox),<wbr/> and 16:9
16711 streams will match exactly.<wbr/> These additional crops will
16712 be centered within the crop region.<wbr/></p>
16713 <p>The width and height of the crop region cannot
16714 be set to be smaller than
16715 <code>floor( activeArraySize.<wbr/>width /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code> and
16716 <code>floor( activeArraySize.<wbr/>height /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code>,<wbr/> respectively.<wbr/></p>
16717 <p>The camera device may adjust the crop region to account
16718 for rounding and other hardware requirements; the final
16719 crop region used will be included in the output capture
16720 result.<wbr/></p>
16721             </td>
16722           </tr>
16723
16724           <tr class="entries_header">
16725             <th class="th_details" colspan="5">HAL Implementation Details</th>
16726           </tr>
16727           <tr class="entry_cont">
16728             <td class="entry_details" colspan="5">
16729               <p>The output streams must maintain square pixels at all
16730 times,<wbr/> no matter what the relative aspect ratios of the
16731 crop region and the stream are.<wbr/>  Negative values for
16732 corner are allowed for raw output if full pixel array is
16733 larger than active pixel array.<wbr/> Width and height may be
16734 rounded to nearest larger supportable width,<wbr/> especially
16735 for raw output,<wbr/> where only a few fixed scales may be
16736 possible.<wbr/></p>
16737 <p>For a set of output streams configured,<wbr/> if the sensor output is cropped to a smaller
16738 size than active array size,<wbr/> the HAL need follow below cropping rules:</p>
16739 <ul>
16740 <li>
16741 <p>The HAL need handle the cropRegion as if the sensor crop size is the effective active
16742 array size.<wbr/>More specifically,<wbr/> the HAL must transform the request cropRegion from
16743 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> to the sensor cropped pixel area size in this way:</p>
16744 <ol>
16745 <li>Translate the requested cropRegion w.<wbr/>r.<wbr/>t.,<wbr/> the left top corner of the sensor
16746 cropped pixel area by (tx,<wbr/> ty),<wbr/>
16747 where <code>tx = sensorCrop.<wbr/>top * (sensorCrop.<wbr/>height /<wbr/> activeArraySize.<wbr/>height)</code>
16748 and <code>tx = sensorCrop.<wbr/>left * (sensorCrop.<wbr/>width /<wbr/> activeArraySize.<wbr/>width)</code>.<wbr/> The
16749 (sensorCrop.<wbr/>top,<wbr/> sensorCrop.<wbr/>left) is the coordinate based off the
16750 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></li>
16751 <li>Scale the width and height of requested cropRegion with scaling factor of
16752 sensor<wbr/>Crop.<wbr/>width/<wbr/>active<wbr/>Array<wbr/>Size.<wbr/>width and sensor<wbr/>Crop.<wbr/>height/<wbr/>active<wbr/>Array<wbr/>Size.<wbr/>height
16753 respectively.<wbr/>
16754 Once this new cropRegion is calculated,<wbr/> the HAL must use this region to crop the image
16755 with regard to the sensor crop size (effective active array size).<wbr/> The HAL still need
16756 follow the general cropping rule for this new cropRegion and effective active
16757 array size.<wbr/></li>
16758 </ol>
16759 </li>
16760 <li>
16761 <p>The HAL must report the cropRegion with regard to <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>
16762 The HAL need convert the new cropRegion generated above w.<wbr/>r.<wbr/>t.,<wbr/> full active array size.<wbr/>
16763 The reported cropRegion may be slightly different with the requested cropRegion since
16764 the HAL may adjust the crop region to account for rounding,<wbr/> conversion error,<wbr/> or other
16765 hardware limitations.<wbr/></p>
16766 </li>
16767 </ul>
16768 <p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
16769             </td>
16770           </tr>
16771
16772           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16773            <!-- end of entry -->
16774
16775
16776
16777       <!-- end of kind -->
16778       </tbody>
16779       <tr><td colspan="6" class="kind">static</td></tr>
16780
16781       <thead class="entries_header">
16782         <tr>
16783           <th class="th_name">Property Name</th>
16784           <th class="th_type">Type</th>
16785           <th class="th_description">Description</th>
16786           <th class="th_units">Units</th>
16787           <th class="th_range">Range</th>
16788           <th class="th_tags">Tags</th>
16789         </tr>
16790       </thead>
16791
16792       <tbody>
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803           <tr class="entry" id="static_android.scaler.availableFormats">
16804             <td class="entry_name
16805                 entry_name_deprecated
16806              " rowspan="5">
16807               android.<wbr/>scaler.<wbr/>available<wbr/>Formats
16808             </td>
16809             <td class="entry_type">
16810                 <span class="entry_type_name entry_type_name_enum">int32</span>
16811                 <span class="entry_type_container">x</span>
16812
16813                 <span class="entry_type_array">
16814                   n
16815                 </span>
16816               <span class="entry_type_visibility"> [hidden as imageFormat]</span>
16817
16818
16819
16820               <span class="entry_type_deprecated">[deprecated] </span>
16821
16822
16823                 <ul class="entry_type_enum">
16824                   <li>
16825                     <span class="entry_type_enum_name">RAW16</span>
16826                     <span class="entry_type_enum_optional">[optional]</span>
16827                     <span class="entry_type_enum_value">0x20</span>
16828                     <span class="entry_type_enum_notes"><p>RAW16 is a standard,<wbr/> cross-platform format for raw image
16829 buffers with 16-bit pixels.<wbr/></p>
16830 <p>Buffers of this format are typically expected to have a
16831 Bayer Color Filter Array (CFA) layout,<wbr/> which is given in
16832 <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>.<wbr/> Sensors with
16833 CFAs that are not representable by a format in
16834 <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a> should not
16835 use this format.<wbr/></p>
16836 <p>Buffers of this format will also follow the constraints given for
16837 RAW_<wbr/>OPAQUE buffers,<wbr/> but with relaxed performance constraints.<wbr/></p>
16838 <p>This format is intended to give users access to the full contents
16839 of the buffers coming directly from the image sensor prior to any
16840 cropping or scaling operations,<wbr/> and all coordinate systems for
16841 metadata used for this format are relative to the size of the
16842 active region of the image sensor before any geometric distortion
16843 correction has been applied (i.<wbr/>e.<wbr/>
16844 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a>).<wbr/> Supported
16845 dimensions for this format are limited to the full dimensions of
16846 the sensor (e.<wbr/>g.<wbr/> either <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a> or
16847 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> will be the
16848 only supported output size).<wbr/></p>
16849 <p>See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a> for
16850 the full set of performance guarantees.<wbr/></p></span>
16851                   </li>
16852                   <li>
16853                     <span class="entry_type_enum_name">RAW_OPAQUE</span>
16854                     <span class="entry_type_enum_optional">[optional]</span>
16855                     <span class="entry_type_enum_value">0x24</span>
16856                     <span class="entry_type_enum_notes"><p>RAW_<wbr/>OPAQUE (or
16857 <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_PRIVATE">RAW_<wbr/>PRIVATE</a>
16858 as referred in public API) is a format for raw image buffers
16859 coming from an image sensor.<wbr/></p>
16860 <p>The actual structure of buffers of this format is
16861 platform-specific,<wbr/> but must follow several constraints:</p>
16862 <ol>
16863 <li>No image post-processing operations may have been applied to
16864 buffers of this type.<wbr/> These buffers contain raw image data coming
16865 directly from the image sensor.<wbr/></li>
16866 <li>If a buffer of this format is passed to the camera device for
16867 reprocessing,<wbr/> the resulting images will be identical to the images
16868 produced if the buffer had come directly from the sensor and was
16869 processed with the same settings.<wbr/></li>
16870 </ol>
16871 <p>The intended use for this format is to allow access to the native
16872 raw format buffers coming directly from the camera sensor without
16873 any additional conversions or decrease in framerate.<wbr/></p>
16874 <p>See <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a> for the full set of
16875 performance guarantees.<wbr/></p></span>
16876                   </li>
16877                   <li>
16878                     <span class="entry_type_enum_name">YV12</span>
16879                     <span class="entry_type_enum_optional">[optional]</span>
16880                     <span class="entry_type_enum_value">0x32315659</span>
16881                     <span class="entry_type_enum_notes"><p>YCrCb 4:2:0 Planar</p></span>
16882                   </li>
16883                   <li>
16884                     <span class="entry_type_enum_name">YCrCb_420_SP</span>
16885                     <span class="entry_type_enum_optional">[optional]</span>
16886                     <span class="entry_type_enum_value">0x11</span>
16887                     <span class="entry_type_enum_notes"><p>NV21</p></span>
16888                   </li>
16889                   <li>
16890                     <span class="entry_type_enum_name">IMPLEMENTATION_DEFINED</span>
16891                     <span class="entry_type_enum_value">0x22</span>
16892                     <span class="entry_type_enum_notes"><p>System internal format,<wbr/> not application-accessible</p></span>
16893                   </li>
16894                   <li>
16895                     <span class="entry_type_enum_name">YCbCr_420_888</span>
16896                     <span class="entry_type_enum_value">0x23</span>
16897                     <span class="entry_type_enum_notes"><p>Flexible YUV420 Format</p></span>
16898                   </li>
16899                   <li>
16900                     <span class="entry_type_enum_name">BLOB</span>
16901                     <span class="entry_type_enum_value">0x21</span>
16902                     <span class="entry_type_enum_notes"><p>JPEG format</p></span>
16903                   </li>
16904                 </ul>
16905
16906             </td> <!-- entry_type -->
16907
16908             <td class="entry_description">
16909               <p>The list of image formats that are supported by this
16910 camera device for output streams.<wbr/></p>
16911             </td>
16912
16913             <td class="entry_units">
16914             </td>
16915
16916             <td class="entry_range">
16917               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
16918             </td>
16919
16920             <td class="entry_tags">
16921               <ul class="entry_tags">
16922                   <li><a href="#tag_BC">BC</a></li>
16923               </ul>
16924             </td>
16925
16926           </tr>
16927           <tr class="entries_header">
16928             <th class="th_details" colspan="5">Details</th>
16929           </tr>
16930           <tr class="entry_cont">
16931             <td class="entry_details" colspan="5">
16932               <p>All camera devices will support JPEG and YUV_<wbr/>420_<wbr/>888 formats.<wbr/></p>
16933 <p>When set to YUV_<wbr/>420_<wbr/>888,<wbr/> application can access the YUV420 data directly.<wbr/></p>
16934             </td>
16935           </tr>
16936
16937           <tr class="entries_header">
16938             <th class="th_details" colspan="5">HAL Implementation Details</th>
16939           </tr>
16940           <tr class="entry_cont">
16941             <td class="entry_details" colspan="5">
16942               <p>These format values are from HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>* in
16943 system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h.<wbr/></p>
16944 <p>When IMPLEMENTATION_<wbr/>DEFINED is used,<wbr/> the platform
16945 gralloc module will select a format based on the usage flags provided
16946 by the camera HAL device and the other endpoint of the stream.<wbr/> It is
16947 usually used by preview and recording streams,<wbr/> where the application doesn't
16948 need access the image data.<wbr/></p>
16949 <p>YCb<wbr/>Cr_<wbr/>420_<wbr/>888 format must be supported by the HAL.<wbr/> When an image stream
16950 needs CPU/<wbr/>application direct access,<wbr/> this format will be used.<wbr/></p>
16951 <p>The BLOB format must be supported by the HAL.<wbr/> This is used for the JPEG stream.<wbr/></p>
16952 <p>A RAW_<wbr/>OPAQUE buffer should contain only pixel data.<wbr/> It is strongly
16953 recommended that any information used by the camera device when
16954 processing images is fully expressed by the result metadata
16955 for that image buffer.<wbr/></p>
16956             </td>
16957           </tr>
16958
16959           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
16960            <!-- end of entry -->
16961
16962
16963           <tr class="entry" id="static_android.scaler.availableJpegMinDurations">
16964             <td class="entry_name
16965                 entry_name_deprecated
16966              " rowspan="3">
16967               android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Min<wbr/>Durations
16968             </td>
16969             <td class="entry_type">
16970                 <span class="entry_type_name">int64</span>
16971                 <span class="entry_type_container">x</span>
16972
16973                 <span class="entry_type_array">
16974                   n
16975                 </span>
16976               <span class="entry_type_visibility"> [hidden]</span>
16977
16978
16979
16980               <span class="entry_type_deprecated">[deprecated] </span>
16981
16982
16983
16984             </td> <!-- entry_type -->
16985
16986             <td class="entry_description">
16987               <p>The minimum frame duration that is supported
16988 for each resolution in <a href="#static_android.scaler.availableJpegSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes</a>.<wbr/></p>
16989             </td>
16990
16991             <td class="entry_units">
16992               Nanoseconds
16993             </td>
16994
16995             <td class="entry_range">
16996               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
16997               <p>TODO: Remove property.<wbr/></p>
16998             </td>
16999
17000             <td class="entry_tags">
17001               <ul class="entry_tags">
17002                   <li><a href="#tag_BC">BC</a></li>
17003               </ul>
17004             </td>
17005
17006           </tr>
17007           <tr class="entries_header">
17008             <th class="th_details" colspan="5">Details</th>
17009           </tr>
17010           <tr class="entry_cont">
17011             <td class="entry_details" colspan="5">
17012               <p>This corresponds to the minimum steady-state frame duration when only
17013 that JPEG stream is active and captured in a burst,<wbr/> with all
17014 processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST.<wbr/></p>
17015 <p>When multiple streams are configured,<wbr/> the minimum
17016 frame duration will be &gt;= max(individual stream min
17017 durations)</p>
17018             </td>
17019           </tr>
17020
17021
17022           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17023            <!-- end of entry -->
17024
17025
17026           <tr class="entry" id="static_android.scaler.availableJpegSizes">
17027             <td class="entry_name
17028                 entry_name_deprecated
17029              " rowspan="5">
17030               android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes
17031             </td>
17032             <td class="entry_type">
17033                 <span class="entry_type_name">int32</span>
17034                 <span class="entry_type_container">x</span>
17035
17036                 <span class="entry_type_array">
17037                   n x 2
17038                 </span>
17039               <span class="entry_type_visibility"> [hidden as size]</span>
17040
17041
17042
17043               <span class="entry_type_deprecated">[deprecated] </span>
17044
17045
17046
17047             </td> <!-- entry_type -->
17048
17049             <td class="entry_description">
17050               <p>The JPEG resolutions that are supported by this camera device.<wbr/></p>
17051             </td>
17052
17053             <td class="entry_units">
17054             </td>
17055
17056             <td class="entry_range">
17057               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
17058               <p>TODO: Remove property.<wbr/></p>
17059             </td>
17060
17061             <td class="entry_tags">
17062               <ul class="entry_tags">
17063                   <li><a href="#tag_BC">BC</a></li>
17064               </ul>
17065             </td>
17066
17067           </tr>
17068           <tr class="entries_header">
17069             <th class="th_details" colspan="5">Details</th>
17070           </tr>
17071           <tr class="entry_cont">
17072             <td class="entry_details" colspan="5">
17073               <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/> All camera devices will support
17074 sensor maximum resolution (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>).<wbr/></p>
17075             </td>
17076           </tr>
17077
17078           <tr class="entries_header">
17079             <th class="th_details" colspan="5">HAL Implementation Details</th>
17080           </tr>
17081           <tr class="entry_cont">
17082             <td class="entry_details" colspan="5">
17083               <p>The HAL must include sensor maximum resolution
17084 (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>),<wbr/>
17085 and should include half/<wbr/>quarter of sensor maximum resolution.<wbr/></p>
17086             </td>
17087           </tr>
17088
17089           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17090            <!-- end of entry -->
17091
17092
17093           <tr class="entry" id="static_android.scaler.availableMaxDigitalZoom">
17094             <td class="entry_name
17095              " rowspan="3">
17096               android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom
17097             </td>
17098             <td class="entry_type">
17099                 <span class="entry_type_name">float</span>
17100
17101               <span class="entry_type_visibility"> [public]</span>
17102
17103
17104               <span class="entry_type_hwlevel">[legacy] </span>
17105
17106
17107
17108
17109             </td> <!-- entry_type -->
17110
17111             <td class="entry_description">
17112               <p>The maximum ratio between both active area width
17113 and crop region width,<wbr/> and active area height and
17114 crop region height,<wbr/> for <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
17115             </td>
17116
17117             <td class="entry_units">
17118               Zoom scale factor
17119             </td>
17120
17121             <td class="entry_range">
17122               <p>&gt;=1</p>
17123             </td>
17124
17125             <td class="entry_tags">
17126               <ul class="entry_tags">
17127                   <li><a href="#tag_BC">BC</a></li>
17128               </ul>
17129             </td>
17130
17131           </tr>
17132           <tr class="entries_header">
17133             <th class="th_details" colspan="5">Details</th>
17134           </tr>
17135           <tr class="entry_cont">
17136             <td class="entry_details" colspan="5">
17137               <p>This represents the maximum amount of zooming possible by
17138 the camera device,<wbr/> or equivalently,<wbr/> the minimum cropping
17139 window size.<wbr/></p>
17140 <p>Crop regions that have a width or height that is smaller
17141 than this ratio allows will be rounded up to the minimum
17142 allowed size by the camera device.<wbr/></p>
17143             </td>
17144           </tr>
17145
17146
17147           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17148            <!-- end of entry -->
17149
17150
17151           <tr class="entry" id="static_android.scaler.availableProcessedMinDurations">
17152             <td class="entry_name
17153                 entry_name_deprecated
17154              " rowspan="3">
17155               android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Min<wbr/>Durations
17156             </td>
17157             <td class="entry_type">
17158                 <span class="entry_type_name">int64</span>
17159                 <span class="entry_type_container">x</span>
17160
17161                 <span class="entry_type_array">
17162                   n
17163                 </span>
17164               <span class="entry_type_visibility"> [hidden]</span>
17165
17166
17167
17168               <span class="entry_type_deprecated">[deprecated] </span>
17169
17170
17171
17172             </td> <!-- entry_type -->
17173
17174             <td class="entry_description">
17175               <p>For each available processed output size (defined in
17176 <a href="#static_android.scaler.availableProcessedSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes</a>),<wbr/> this property lists the
17177 minimum supportable frame duration for that size.<wbr/></p>
17178             </td>
17179
17180             <td class="entry_units">
17181               Nanoseconds
17182             </td>
17183
17184             <td class="entry_range">
17185               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
17186             </td>
17187
17188             <td class="entry_tags">
17189               <ul class="entry_tags">
17190                   <li><a href="#tag_BC">BC</a></li>
17191               </ul>
17192             </td>
17193
17194           </tr>
17195           <tr class="entries_header">
17196             <th class="th_details" colspan="5">Details</th>
17197           </tr>
17198           <tr class="entry_cont">
17199             <td class="entry_details" colspan="5">
17200               <p>This should correspond to the frame duration when only that processed
17201 stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
17202 set to FAST.<wbr/></p>
17203 <p>When multiple streams are configured,<wbr/> the minimum frame duration will
17204 be &gt;= max(individual stream min durations).<wbr/></p>
17205             </td>
17206           </tr>
17207
17208
17209           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17210            <!-- end of entry -->
17211
17212
17213           <tr class="entry" id="static_android.scaler.availableProcessedSizes">
17214             <td class="entry_name
17215                 entry_name_deprecated
17216              " rowspan="5">
17217               android.<wbr/>scaler.<wbr/>available<wbr/>Processed<wbr/>Sizes
17218             </td>
17219             <td class="entry_type">
17220                 <span class="entry_type_name">int32</span>
17221                 <span class="entry_type_container">x</span>
17222
17223                 <span class="entry_type_array">
17224                   n x 2
17225                 </span>
17226               <span class="entry_type_visibility"> [hidden as size]</span>
17227
17228
17229
17230               <span class="entry_type_deprecated">[deprecated] </span>
17231
17232
17233
17234             </td> <!-- entry_type -->
17235
17236             <td class="entry_description">
17237               <p>The resolutions available for use with
17238 processed output streams,<wbr/> such as YV12,<wbr/> NV12,<wbr/> and
17239 platform opaque YUV/<wbr/>RGB streams to the GPU or video
17240 encoders.<wbr/></p>
17241             </td>
17242
17243             <td class="entry_units">
17244             </td>
17245
17246             <td class="entry_range">
17247               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
17248             </td>
17249
17250             <td class="entry_tags">
17251               <ul class="entry_tags">
17252                   <li><a href="#tag_BC">BC</a></li>
17253               </ul>
17254             </td>
17255
17256           </tr>
17257           <tr class="entries_header">
17258             <th class="th_details" colspan="5">Details</th>
17259           </tr>
17260           <tr class="entry_cont">
17261             <td class="entry_details" colspan="5">
17262               <p>The resolutions are listed as <code>(width,<wbr/> height)</code> pairs.<wbr/></p>
17263 <p>For a given use case,<wbr/> the actual maximum supported resolution
17264 may be lower than what is listed here,<wbr/> depending on the destination
17265 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
17266 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
17267 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
17268 can provide.<wbr/></p>
17269 <p>Please reference the documentation for the image data destination to
17270 check if it limits the maximum size for image data.<wbr/></p>
17271             </td>
17272           </tr>
17273
17274           <tr class="entries_header">
17275             <th class="th_details" colspan="5">HAL Implementation Details</th>
17276           </tr>
17277           <tr class="entry_cont">
17278             <td class="entry_details" colspan="5">
17279               <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
17280 the HAL must include all JPEG sizes listed in <a href="#static_android.scaler.availableJpegSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Jpeg<wbr/>Sizes</a>
17281 and each below resolution if it is smaller than or equal to the sensor
17282 maximum resolution (if they are not listed in JPEG sizes already):</p>
17283 <ul>
17284 <li>240p (320 x 240)</li>
17285 <li>480p (640 x 480)</li>
17286 <li>720p (1280 x 720)</li>
17287 <li>1080p (1920 x 1080)</li>
17288 </ul>
17289 <p>For LIMITED capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
17290 the HAL only has to list up to the maximum video size supported by the devices.<wbr/></p>
17291             </td>
17292           </tr>
17293
17294           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17295            <!-- end of entry -->
17296
17297
17298           <tr class="entry" id="static_android.scaler.availableRawMinDurations">
17299             <td class="entry_name
17300                 entry_name_deprecated
17301              " rowspan="3">
17302               android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Min<wbr/>Durations
17303             </td>
17304             <td class="entry_type">
17305                 <span class="entry_type_name">int64</span>
17306                 <span class="entry_type_container">x</span>
17307
17308                 <span class="entry_type_array">
17309                   n
17310                 </span>
17311               <span class="entry_type_visibility"> [system]</span>
17312
17313
17314
17315               <span class="entry_type_deprecated">[deprecated] </span>
17316
17317
17318
17319             </td> <!-- entry_type -->
17320
17321             <td class="entry_description">
17322               <p>For each available raw output size (defined in
17323 <a href="#static_android.scaler.availableRawSizes">android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes</a>),<wbr/> this property lists the minimum
17324 supportable frame duration for that size.<wbr/></p>
17325             </td>
17326
17327             <td class="entry_units">
17328               Nanoseconds
17329             </td>
17330
17331             <td class="entry_range">
17332               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
17333             </td>
17334
17335             <td class="entry_tags">
17336               <ul class="entry_tags">
17337                   <li><a href="#tag_BC">BC</a></li>
17338               </ul>
17339             </td>
17340
17341           </tr>
17342           <tr class="entries_header">
17343             <th class="th_details" colspan="5">Details</th>
17344           </tr>
17345           <tr class="entry_cont">
17346             <td class="entry_details" colspan="5">
17347               <p>Should correspond to the frame duration when only the raw stream is
17348 active.<wbr/></p>
17349 <p>When multiple streams are configured,<wbr/> the minimum
17350 frame duration will be &gt;= max(individual stream min
17351 durations)</p>
17352             </td>
17353           </tr>
17354
17355
17356           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17357            <!-- end of entry -->
17358
17359
17360           <tr class="entry" id="static_android.scaler.availableRawSizes">
17361             <td class="entry_name
17362                 entry_name_deprecated
17363              " rowspan="1">
17364               android.<wbr/>scaler.<wbr/>available<wbr/>Raw<wbr/>Sizes
17365             </td>
17366             <td class="entry_type">
17367                 <span class="entry_type_name">int32</span>
17368                 <span class="entry_type_container">x</span>
17369
17370                 <span class="entry_type_array">
17371                   n x 2
17372                 </span>
17373               <span class="entry_type_visibility"> [system as size]</span>
17374
17375
17376
17377               <span class="entry_type_deprecated">[deprecated] </span>
17378
17379
17380
17381             </td> <!-- entry_type -->
17382
17383             <td class="entry_description">
17384               <p>The resolutions available for use with raw
17385 sensor output streams,<wbr/> listed as width,<wbr/>
17386 height</p>
17387             </td>
17388
17389             <td class="entry_units">
17390             </td>
17391
17392             <td class="entry_range">
17393               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
17394             </td>
17395
17396             <td class="entry_tags">
17397             </td>
17398
17399           </tr>
17400
17401
17402           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17403            <!-- end of entry -->
17404
17405
17406           <tr class="entry" id="static_android.scaler.availableInputOutputFormatsMap">
17407             <td class="entry_name
17408              " rowspan="5">
17409               android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map
17410             </td>
17411             <td class="entry_type">
17412                 <span class="entry_type_name">int32</span>
17413
17414               <span class="entry_type_visibility"> [hidden as reprocessFormatsMap]</span>
17415
17416
17417
17418
17419
17420
17421             </td> <!-- entry_type -->
17422
17423             <td class="entry_description">
17424               <p>The mapping of image formats that are supported by this
17425 camera device for input streams,<wbr/> to their corresponding output formats.<wbr/></p>
17426             </td>
17427
17428             <td class="entry_units">
17429             </td>
17430
17431             <td class="entry_range">
17432             </td>
17433
17434             <td class="entry_tags">
17435               <ul class="entry_tags">
17436                   <li><a href="#tag_REPROC">REPROC</a></li>
17437               </ul>
17438             </td>
17439
17440           </tr>
17441           <tr class="entries_header">
17442             <th class="th_details" colspan="5">Details</th>
17443           </tr>
17444           <tr class="entry_cont">
17445             <td class="entry_details" colspan="5">
17446               <p>All camera devices with at least 1
17447 <a href="#static_android.request.maxNumInputStreams">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Input<wbr/>Streams</a> will have at least one
17448 available input format.<wbr/></p>
17449 <p>The camera device will support the following map of formats,<wbr/>
17450 if its dependent capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>) is supported:</p>
17451 <table>
17452 <thead>
17453 <tr>
17454 <th align="left">Input Format</th>
17455 <th align="left">Output Format</th>
17456 <th align="left">Capability</th>
17457 </tr>
17458 </thead>
17459 <tbody>
17460 <tr>
17461 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>
17462 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17463 <td align="left">PRIVATE_<wbr/>REPROCESSING</td>
17464 </tr>
17465 <tr>
17466 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>
17467 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
17468 <td align="left">PRIVATE_<wbr/>REPROCESSING</td>
17469 </tr>
17470 <tr>
17471 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
17472 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17473 <td align="left">YUV_<wbr/>REPROCESSING</td>
17474 </tr>
17475 <tr>
17476 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
17477 <td align="left"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
17478 <td align="left">YUV_<wbr/>REPROCESSING</td>
17479 </tr>
17480 </tbody>
17481 </table>
17482 <p>PRIVATE refers to a device-internal format that is not directly application-visible.<wbr/>  A
17483 PRIVATE input surface can be acquired by <a href="https://developer.android.com/reference/android/media/ImageReader.html#newInstance">ImageReader#newInstance</a>
17484 with <a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a> as the format.<wbr/></p>
17485 <p>For a PRIVATE_<wbr/>REPROCESSING-capable camera device,<wbr/> using the PRIVATE format as either input
17486 or output will never hurt maximum frame rate (i.<wbr/>e.<wbr/>  <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">getOutputStallDuration(ImageFormat.<wbr/>PRIVATE,<wbr/> size)</a> is always 0),<wbr/></p>
17487 <p>Attempting to configure an input stream with output streams not
17488 listed as available in this map is not valid.<wbr/></p>
17489             </td>
17490           </tr>
17491
17492           <tr class="entries_header">
17493             <th class="th_details" colspan="5">HAL Implementation Details</th>
17494           </tr>
17495           <tr class="entry_cont">
17496             <td class="entry_details" colspan="5">
17497               <p>For the formats,<wbr/> see <code>system/<wbr/>core/<wbr/>include/<wbr/>system/<wbr/>graphics.<wbr/>h</code> for a definition
17498 of the image format enumerations.<wbr/> The PRIVATE format refers to the
17499 HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>IMPLEMENTATION_<wbr/>DEFINED format.<wbr/> The HAL could determine
17500 the actual format by using the gralloc usage flags.<wbr/>
17501 For ZSL use case in particular,<wbr/> the HAL could choose appropriate format (partially
17502 processed YUV or RAW based format) by checking the format and GRALLOC_<wbr/>USAGE_<wbr/>HW_<wbr/>CAMERA_<wbr/>ZSL.<wbr/>
17503 See camera3.<wbr/>h for more details.<wbr/></p>
17504 <p>This value is encoded as a variable-size array-of-arrays.<wbr/>
17505 The inner array always contains <code>[format,<wbr/> length,<wbr/> ...<wbr/>]</code> where
17506 <code>...<wbr/></code> has <code>length</code> elements.<wbr/> An inner array is followed by another
17507 inner array if the total metadata entry size hasn't yet been exceeded.<wbr/></p>
17508 <p>A code sample to read/<wbr/>write this encoding (with a device that
17509 supports reprocessing IMPLEMENTATION_<wbr/>DEFINED to YUV_<wbr/>420_<wbr/>888,<wbr/> and JPEG,<wbr/>
17510 and reprocessing YUV_<wbr/>420_<wbr/>888 to YUV_<wbr/>420_<wbr/>888 and JPEG):</p>
17511 <pre><code>//<wbr/> reading
17512 int32_<wbr/>t* contents = &amp;entry.<wbr/>i32[0];
17513 for (size_<wbr/>t i = 0; i &lt; entry.<wbr/>count; ) {
17514     int32_<wbr/>t format = contents[i++];
17515     int32_<wbr/>t length = contents[i++];
17516     int32_<wbr/>t output_<wbr/>formats[length];
17517     memcpy(&amp;output_<wbr/>formats[0],<wbr/> &amp;contents[i],<wbr/>
17518            length * sizeof(int32_<wbr/>t));
17519     i += length;
17520 }
17521
17522 //<wbr/> writing (static example,<wbr/> PRIVATE_<wbr/>REPROCESSING + YUV_<wbr/>REPROCESSING)
17523 int32_<wbr/>t[] contents = {
17524   IMPLEMENTATION_<wbr/>DEFINED,<wbr/> 2,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
17525   YUV_<wbr/>420_<wbr/>888,<wbr/> 2,<wbr/> YUV_<wbr/>420_<wbr/>888,<wbr/> BLOB,<wbr/>
17526 };
17527 update_<wbr/>camera_<wbr/>metadata_<wbr/>entry(metadata,<wbr/> index,<wbr/> &amp;contents[0],<wbr/>
17528       sizeof(contents)/<wbr/>sizeof(contents[0]),<wbr/> &amp;updated_<wbr/>entry);
17529 </code></pre>
17530 <p>If the HAL claims to support any of the capabilities listed in the
17531 above details,<wbr/> then it must also support all the input-output
17532 combinations listed for that capability.<wbr/> It can optionally support
17533 additional formats if it so chooses.<wbr/></p>
17534             </td>
17535           </tr>
17536
17537           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17538            <!-- end of entry -->
17539
17540
17541           <tr class="entry" id="static_android.scaler.availableStreamConfigurations">
17542             <td class="entry_name
17543              " rowspan="5">
17544               android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations
17545             </td>
17546             <td class="entry_type">
17547                 <span class="entry_type_name entry_type_name_enum">int32</span>
17548                 <span class="entry_type_container">x</span>
17549
17550                 <span class="entry_type_array">
17551                   n x 4
17552                 </span>
17553               <span class="entry_type_visibility"> [ndk_public as streamConfiguration]</span>
17554
17555
17556               <span class="entry_type_hwlevel">[legacy] </span>
17557
17558
17559
17560                 <ul class="entry_type_enum">
17561                   <li>
17562                     <span class="entry_type_enum_name">OUTPUT</span>
17563                   </li>
17564                   <li>
17565                     <span class="entry_type_enum_name">INPUT</span>
17566                   </li>
17567                 </ul>
17568
17569             </td> <!-- entry_type -->
17570
17571             <td class="entry_description">
17572               <p>The available stream configurations that this
17573 camera device supports
17574 (i.<wbr/>e.<wbr/> format,<wbr/> width,<wbr/> height,<wbr/> output/<wbr/>input stream).<wbr/></p>
17575             </td>
17576
17577             <td class="entry_units">
17578             </td>
17579
17580             <td class="entry_range">
17581             </td>
17582
17583             <td class="entry_tags">
17584             </td>
17585
17586           </tr>
17587           <tr class="entries_header">
17588             <th class="th_details" colspan="5">Details</th>
17589           </tr>
17590           <tr class="entry_cont">
17591             <td class="entry_details" colspan="5">
17592               <p>The configurations are listed as <code>(format,<wbr/> width,<wbr/> height,<wbr/> input?)</code>
17593 tuples.<wbr/></p>
17594 <p>For a given use case,<wbr/> the actual maximum supported resolution
17595 may be lower than what is listed here,<wbr/> depending on the destination
17596 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
17597 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
17598 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
17599 can provide.<wbr/></p>
17600 <p>Please reference the documentation for the image data destination to
17601 check if it limits the maximum size for image data.<wbr/></p>
17602 <p>Not all output formats may be supported in a configuration with
17603 an input stream of a particular format.<wbr/> For more details,<wbr/> see
17604 <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
17605 <p>The following table describes the minimum required output stream
17606 configurations based on the hardware level
17607 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
17608 <table>
17609 <thead>
17610 <tr>
17611 <th align="center">Format</th>
17612 <th align="center">Size</th>
17613 <th align="center">Hardware Level</th>
17614 <th align="center">Notes</th>
17615 </tr>
17616 </thead>
17617 <tbody>
17618 <tr>
17619 <td align="center">JPEG</td>
17620 <td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a></td>
17621 <td align="center">Any</td>
17622 <td align="center"></td>
17623 </tr>
17624 <tr>
17625 <td align="center">JPEG</td>
17626 <td align="center">1920x1080 (1080p)</td>
17627 <td align="center">Any</td>
17628 <td align="center">if 1080p &lt;= activeArraySize</td>
17629 </tr>
17630 <tr>
17631 <td align="center">JPEG</td>
17632 <td align="center">1280x720 (720)</td>
17633 <td align="center">Any</td>
17634 <td align="center">if 720p &lt;= activeArraySize</td>
17635 </tr>
17636 <tr>
17637 <td align="center">JPEG</td>
17638 <td align="center">640x480 (480p)</td>
17639 <td align="center">Any</td>
17640 <td align="center">if 480p &lt;= activeArraySize</td>
17641 </tr>
17642 <tr>
17643 <td align="center">JPEG</td>
17644 <td align="center">320x240 (240p)</td>
17645 <td align="center">Any</td>
17646 <td align="center">if 240p &lt;= activeArraySize</td>
17647 </tr>
17648 <tr>
17649 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
17650 <td align="center">all output sizes available for JPEG</td>
17651 <td align="center">FULL</td>
17652 <td align="center"></td>
17653 </tr>
17654 <tr>
17655 <td align="center">YUV_<wbr/>420_<wbr/>888</td>
17656 <td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
17657 <td align="center">LIMITED</td>
17658 <td align="center"></td>
17659 </tr>
17660 <tr>
17661 <td align="center">IMPLEMENTATION_<wbr/>DEFINED</td>
17662 <td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
17663 <td align="center">Any</td>
17664 <td align="center"></td>
17665 </tr>
17666 </tbody>
17667 </table>
17668 <p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> for additional
17669 mandatory stream configurations on a per-capability basis.<wbr/></p>
17670             </td>
17671           </tr>
17672
17673           <tr class="entries_header">
17674             <th class="th_details" colspan="5">HAL Implementation Details</th>
17675           </tr>
17676           <tr class="entry_cont">
17677             <td class="entry_details" colspan="5">
17678               <p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
17679 of sensor maximum resolution for JPEG formats (regardless of hardware
17680 level).<wbr/></p>
17681 <p>(The following is a rewording of the above required table):</p>
17682 <p>For JPEG format,<wbr/> the sizes may be restricted by below conditions:</p>
17683 <ul>
17684 <li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
17685 (e.<wbr/>g.<wbr/> 4:3,<wbr/> 16:9,<wbr/> 3:2 etc.<wbr/>).<wbr/> If the sensor maximum resolution
17686 (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>) has an aspect ratio other than these,<wbr/>
17687 it does not have to be included in the supported JPEG sizes.<wbr/></li>
17688 <li>Some hardware JPEG encoders may have pixel boundary alignment requirements,<wbr/> such as
17689 the dimensions being a multiple of 16.<wbr/></li>
17690 </ul>
17691 <p>Therefore,<wbr/> the maximum JPEG size may be smaller than sensor maximum resolution.<wbr/>
17692 However,<wbr/> the largest JPEG size must be as close as possible to the sensor maximum
17693 resolution given above constraints.<wbr/> It is required that after aspect ratio adjustments,<wbr/>
17694 additional size reduction due to other issues must be less than 3% in area.<wbr/> For example,<wbr/>
17695 if the sensor maximum resolution is 3280x2464,<wbr/> if the maximum JPEG size has aspect
17696 ratio 4:3,<wbr/> the JPEG encoder alignment requirement is 16,<wbr/> the maximum JPEG size will be
17697 3264x2448.<wbr/></p>
17698 <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
17699 the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
17700 here as output streams.<wbr/></p>
17701 <p>It must also include each below resolution if it is smaller than or
17702 equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
17703 formats),<wbr/> as output streams:</p>
17704 <ul>
17705 <li>240p (320 x 240)</li>
17706 <li>480p (640 x 480)</li>
17707 <li>720p (1280 x 720)</li>
17708 <li>1080p (1920 x 1080)</li>
17709 </ul>
17710 <p>For LIMITED capability devices
17711 (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
17712 the HAL only has to list up to the maximum video size
17713 supported by the device.<wbr/></p>
17714 <p>Regardless of hardware level,<wbr/> every output resolution available for
17715 YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
17716 <p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
17717 <ul>
17718 <li>availableFormats</li>
17719 <li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
17720 </ul>
17721             </td>
17722           </tr>
17723
17724           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17725            <!-- end of entry -->
17726
17727
17728           <tr class="entry" id="static_android.scaler.availableMinFrameDurations">
17729             <td class="entry_name
17730              " rowspan="3">
17731               android.<wbr/>scaler.<wbr/>available<wbr/>Min<wbr/>Frame<wbr/>Durations
17732             </td>
17733             <td class="entry_type">
17734                 <span class="entry_type_name">int64</span>
17735                 <span class="entry_type_container">x</span>
17736
17737                 <span class="entry_type_array">
17738                   4 x n
17739                 </span>
17740               <span class="entry_type_visibility"> [ndk_public as streamConfigurationDuration]</span>
17741
17742
17743               <span class="entry_type_hwlevel">[legacy] </span>
17744
17745
17746
17747
17748             </td> <!-- entry_type -->
17749
17750             <td class="entry_description">
17751               <p>This lists the minimum frame duration for each
17752 format/<wbr/>size combination.<wbr/></p>
17753             </td>
17754
17755             <td class="entry_units">
17756               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
17757             </td>
17758
17759             <td class="entry_range">
17760             </td>
17761
17762             <td class="entry_tags">
17763               <ul class="entry_tags">
17764                   <li><a href="#tag_V1">V1</a></li>
17765               </ul>
17766             </td>
17767
17768           </tr>
17769           <tr class="entries_header">
17770             <th class="th_details" colspan="5">Details</th>
17771           </tr>
17772           <tr class="entry_cont">
17773             <td class="entry_details" colspan="5">
17774               <p>This should correspond to the frame duration when only that
17775 stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
17776 set to either OFF or FAST.<wbr/></p>
17777 <p>When multiple streams are used in a request,<wbr/> the minimum frame
17778 duration will be max(individual stream min durations).<wbr/></p>
17779 <p>The minimum frame duration of a stream (of a particular format,<wbr/> size)
17780 is the same regardless of whether the stream is input or output.<wbr/></p>
17781 <p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> and
17782 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a> for more details about
17783 calculating the max frame rate.<wbr/></p>
17784 <p>(Keep in sync with
17785 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>)</p>
17786             </td>
17787           </tr>
17788
17789
17790           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17791            <!-- end of entry -->
17792
17793
17794           <tr class="entry" id="static_android.scaler.availableStallDurations">
17795             <td class="entry_name
17796              " rowspan="5">
17797               android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations
17798             </td>
17799             <td class="entry_type">
17800                 <span class="entry_type_name">int64</span>
17801                 <span class="entry_type_container">x</span>
17802
17803                 <span class="entry_type_array">
17804                   4 x n
17805                 </span>
17806               <span class="entry_type_visibility"> [ndk_public as streamConfigurationDuration]</span>
17807
17808
17809               <span class="entry_type_hwlevel">[legacy] </span>
17810
17811
17812
17813
17814             </td> <!-- entry_type -->
17815
17816             <td class="entry_description">
17817               <p>This lists the maximum stall duration for each
17818 output format/<wbr/>size combination.<wbr/></p>
17819             </td>
17820
17821             <td class="entry_units">
17822               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
17823             </td>
17824
17825             <td class="entry_range">
17826             </td>
17827
17828             <td class="entry_tags">
17829               <ul class="entry_tags">
17830                   <li><a href="#tag_V1">V1</a></li>
17831               </ul>
17832             </td>
17833
17834           </tr>
17835           <tr class="entries_header">
17836             <th class="th_details" colspan="5">Details</th>
17837           </tr>
17838           <tr class="entry_cont">
17839             <td class="entry_details" colspan="5">
17840               <p>A stall duration is how much extra time would get added
17841 to the normal minimum frame duration for a repeating request
17842 that has streams with non-zero stall.<wbr/></p>
17843 <p>For example,<wbr/> consider JPEG captures which have the following
17844 characteristics:</p>
17845 <ul>
17846 <li>JPEG streams act like processed YUV streams in requests for which
17847 they are not included; in requests in which they are directly
17848 referenced,<wbr/> they act as JPEG streams.<wbr/> This is because supporting a
17849 JPEG stream requires the underlying YUV data to always be ready for
17850 use by a JPEG encoder,<wbr/> but the encoder will only be used (and impact
17851 frame duration) on requests that actually reference a JPEG stream.<wbr/></li>
17852 <li>The JPEG processor can run concurrently to the rest of the camera
17853 pipeline,<wbr/> but cannot process more than 1 capture at a time.<wbr/></li>
17854 </ul>
17855 <p>In other words,<wbr/> using a repeating YUV request would result
17856 in a steady frame rate (let's say it's 30 FPS).<wbr/> If a single
17857 JPEG request is submitted periodically,<wbr/> the frame rate will stay
17858 at 30 FPS (as long as we wait for the previous JPEG to return each
17859 time).<wbr/> If we try to submit a repeating YUV + JPEG request,<wbr/> then
17860 the frame rate will drop from 30 FPS.<wbr/></p>
17861 <p>In general,<wbr/> submitting a new request with a non-0 stall time
17862 stream will <em>not</em> cause a frame rate drop unless there are still
17863 outstanding buffers for that stream from previous requests.<wbr/></p>
17864 <p>Submitting a repeating request with streams (call this <code>S</code>)
17865 is the same as setting the minimum frame duration from
17866 the normal minimum frame duration corresponding to <code>S</code>,<wbr/> added with
17867 the maximum stall duration for <code>S</code>.<wbr/></p>
17868 <p>If interleaving requests with and without a stall duration,<wbr/>
17869 a request will stall by the maximum of the remaining times
17870 for each can-stall stream with outstanding buffers.<wbr/></p>
17871 <p>This means that a stalling request will not have an exposure start
17872 until the stall has completed.<wbr/></p>
17873 <p>This should correspond to the stall duration when only that stream is
17874 active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode) set to FAST
17875 or OFF.<wbr/> Setting any of the processing modes to HIGH_<wbr/>QUALITY
17876 effectively results in an indeterminate stall duration for all
17877 streams in a request (the regular stall calculation rules are
17878 ignored).<wbr/></p>
17879 <p>The following formats may always have a stall duration:</p>
17880 <ul>
17881 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></li>
17882 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW_SENSOR">ImageFormat#RAW_<wbr/>SENSOR</a></li>
17883 </ul>
17884 <p>The following formats will never have a stall duration:</p>
17885 <ul>
17886 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></li>
17887 <li><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#RAW10">ImageFormat#RAW10</a></li>
17888 </ul>
17889 <p>All other formats may or may not have an allowed stall duration on
17890 a per-capability basis; refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>
17891 for more details.<wbr/></p>
17892 <p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> for more information about
17893 calculating the max frame rate (absent stalls).<wbr/></p>
17894 <p>(Keep up to date with
17895 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a> )</p>
17896             </td>
17897           </tr>
17898
17899           <tr class="entries_header">
17900             <th class="th_details" colspan="5">HAL Implementation Details</th>
17901           </tr>
17902           <tr class="entry_cont">
17903             <td class="entry_details" colspan="5">
17904               <p>If possible,<wbr/> it is recommended that all non-JPEG formats
17905 (such as RAW16) should not have a stall duration.<wbr/> RAW10,<wbr/> RAW12,<wbr/> RAW_<wbr/>OPAQUE
17906 and IMPLEMENTATION_<wbr/>DEFINED must not have stall durations.<wbr/></p>
17907             </td>
17908           </tr>
17909
17910           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
17911            <!-- end of entry -->
17912
17913
17914           <tr class="entry" id="static_android.scaler.streamConfigurationMap">
17915             <td class="entry_name
17916              " rowspan="5">
17917               android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map
17918             </td>
17919             <td class="entry_type">
17920                 <span class="entry_type_name">int32</span>
17921
17922               <span class="entry_type_visibility"> [java_public as streamConfigurationMap]</span>
17923
17924               <span class="entry_type_synthetic">[synthetic] </span>
17925
17926               <span class="entry_type_hwlevel">[legacy] </span>
17927
17928
17929
17930
17931             </td> <!-- entry_type -->
17932
17933             <td class="entry_description">
17934               <p>The available stream configurations that this
17935 camera device supports; also includes the minimum frame durations
17936 and the stall durations for each format/<wbr/>size combination.<wbr/></p>
17937             </td>
17938
17939             <td class="entry_units">
17940             </td>
17941
17942             <td class="entry_range">
17943             </td>
17944
17945             <td class="entry_tags">
17946             </td>
17947
17948           </tr>
17949           <tr class="entries_header">
17950             <th class="th_details" colspan="5">Details</th>
17951           </tr>
17952           <tr class="entry_cont">
17953             <td class="entry_details" colspan="5">
17954               <p>All camera devices will support sensor maximum resolution (defined by
17955 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>) for the JPEG format.<wbr/></p>
17956 <p>For a given use case,<wbr/> the actual maximum supported resolution
17957 may be lower than what is listed here,<wbr/> depending on the destination
17958 Surface for the image data.<wbr/> For example,<wbr/> for recording video,<wbr/>
17959 the video encoder chosen may have a maximum size limit (e.<wbr/>g.<wbr/> 1080p)
17960 smaller than what the camera (e.<wbr/>g.<wbr/> maximum resolution is 3264x2448)
17961 can provide.<wbr/></p>
17962 <p>Please reference the documentation for the image data destination to
17963 check if it limits the maximum size for image data.<wbr/></p>
17964 <p>The following table describes the minimum required output stream
17965 configurations based on the hardware level
17966 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a>):</p>
17967 <table>
17968 <thead>
17969 <tr>
17970 <th align="center">Format</th>
17971 <th align="center">Size</th>
17972 <th align="center">Hardware Level</th>
17973 <th align="center">Notes</th>
17974 </tr>
17975 </thead>
17976 <tbody>
17977 <tr>
17978 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17979 <td align="center"><a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> (*1)</td>
17980 <td align="center">Any</td>
17981 <td align="center"></td>
17982 </tr>
17983 <tr>
17984 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17985 <td align="center">1920x1080 (1080p)</td>
17986 <td align="center">Any</td>
17987 <td align="center">if 1080p &lt;= activeArraySize</td>
17988 </tr>
17989 <tr>
17990 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17991 <td align="center">1280x720 (720p)</td>
17992 <td align="center">Any</td>
17993 <td align="center">if 720p &lt;= activeArraySize</td>
17994 </tr>
17995 <tr>
17996 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
17997 <td align="center">640x480 (480p)</td>
17998 <td align="center">Any</td>
17999 <td align="center">if 480p &lt;= activeArraySize</td>
18000 </tr>
18001 <tr>
18002 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#JPEG">ImageFormat#JPEG</a></td>
18003 <td align="center">320x240 (240p)</td>
18004 <td align="center">Any</td>
18005 <td align="center">if 240p &lt;= activeArraySize</td>
18006 </tr>
18007 <tr>
18008 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
18009 <td align="center">all output sizes available for JPEG</td>
18010 <td align="center">FULL</td>
18011 <td align="center"></td>
18012 </tr>
18013 <tr>
18014 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#YUV_420_888">Image<wbr/>Format#YUV_<wbr/>420_<wbr/>888</a></td>
18015 <td align="center">all output sizes available for JPEG,<wbr/> up to the maximum video size</td>
18016 <td align="center">LIMITED</td>
18017 <td align="center"></td>
18018 </tr>
18019 <tr>
18020 <td align="center"><a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#PRIVATE">ImageFormat#PRIVATE</a></td>
18021 <td align="center">same as YUV_<wbr/>420_<wbr/>888</td>
18022 <td align="center">Any</td>
18023 <td align="center"></td>
18024 </tr>
18025 </tbody>
18026 </table>
18027 <p>Refer to <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> and <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">CameraDevice#createCaptureSession</a> for additional mandatory
18028 stream configurations on a per-capability basis.<wbr/></p>
18029 <p>*1: For JPEG format,<wbr/> the sizes may be restricted by below conditions:</p>
18030 <ul>
18031 <li>The HAL may choose the aspect ratio of each Jpeg size to be one of well known ones
18032 (e.<wbr/>g.<wbr/> 4:3,<wbr/> 16:9,<wbr/> 3:2 etc.<wbr/>).<wbr/> If the sensor maximum resolution
18033 (defined by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>) has an aspect ratio other than these,<wbr/>
18034 it does not have to be included in the supported JPEG sizes.<wbr/></li>
18035 <li>Some hardware JPEG encoders may have pixel boundary alignment requirements,<wbr/> such as
18036 the dimensions being a multiple of 16.<wbr/>
18037 Therefore,<wbr/> the maximum JPEG size may be smaller than sensor maximum resolution.<wbr/>
18038 However,<wbr/> the largest JPEG size will be as close as possible to the sensor maximum
18039 resolution given above constraints.<wbr/> It is required that after aspect ratio adjustments,<wbr/>
18040 additional size reduction due to other issues must be less than 3% in area.<wbr/> For example,<wbr/>
18041 if the sensor maximum resolution is 3280x2464,<wbr/> if the maximum JPEG size has aspect
18042 ratio 4:3,<wbr/> and the JPEG encoder alignment requirement is 16,<wbr/> the maximum JPEG size will be
18043 3264x2448.<wbr/></li>
18044 </ul>
18045             </td>
18046           </tr>
18047
18048           <tr class="entries_header">
18049             <th class="th_details" colspan="5">HAL Implementation Details</th>
18050           </tr>
18051           <tr class="entry_cont">
18052             <td class="entry_details" colspan="5">
18053               <p>Do not set this property directly
18054 (it is synthetic and will not be available at the HAL layer);
18055 set the <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> instead.<wbr/></p>
18056 <p>Not all output formats may be supported in a configuration with
18057 an input stream of a particular format.<wbr/> For more details,<wbr/> see
18058 <a href="#static_android.scaler.availableInputOutputFormatsMap">android.<wbr/>scaler.<wbr/>available<wbr/>Input<wbr/>Output<wbr/>Formats<wbr/>Map</a>.<wbr/></p>
18059 <p>It is recommended (but not mandatory) to also include half/<wbr/>quarter
18060 of sensor maximum resolution for JPEG formats (regardless of hardware
18061 level).<wbr/></p>
18062 <p>(The following is a rewording of the above required table):</p>
18063 <p>The HAL must include sensor maximum resolution (defined by
18064 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>).<wbr/></p>
18065 <p>For FULL capability devices (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL</code>),<wbr/>
18066 the HAL must include all YUV_<wbr/>420_<wbr/>888 sizes that have JPEG sizes listed
18067 here as output streams.<wbr/></p>
18068 <p>It must also include each below resolution if it is smaller than or
18069 equal to the sensor maximum resolution (for both YUV_<wbr/>420_<wbr/>888 and JPEG
18070 formats),<wbr/> as output streams:</p>
18071 <ul>
18072 <li>240p (320 x 240)</li>
18073 <li>480p (640 x 480)</li>
18074 <li>720p (1280 x 720)</li>
18075 <li>1080p (1920 x 1080)</li>
18076 </ul>
18077 <p>For LIMITED capability devices
18078 (<code><a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == LIMITED</code>),<wbr/>
18079 the HAL only has to list up to the maximum video size
18080 supported by the device.<wbr/></p>
18081 <p>Regardless of hardware level,<wbr/> every output resolution available for
18082 YUV_<wbr/>420_<wbr/>888 must also be available for IMPLEMENTATION_<wbr/>DEFINED.<wbr/></p>
18083 <p>This supercedes the following fields,<wbr/> which are now deprecated:</p>
18084 <ul>
18085 <li>availableFormats</li>
18086 <li>available[Processed,<wbr/>Raw,<wbr/>Jpeg]Sizes</li>
18087 </ul>
18088             </td>
18089           </tr>
18090
18091           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18092            <!-- end of entry -->
18093
18094
18095           <tr class="entry" id="static_android.scaler.croppingType">
18096             <td class="entry_name
18097              " rowspan="3">
18098               android.<wbr/>scaler.<wbr/>cropping<wbr/>Type
18099             </td>
18100             <td class="entry_type">
18101                 <span class="entry_type_name entry_type_name_enum">byte</span>
18102
18103               <span class="entry_type_visibility"> [public]</span>
18104
18105
18106               <span class="entry_type_hwlevel">[legacy] </span>
18107
18108
18109
18110                 <ul class="entry_type_enum">
18111                   <li>
18112                     <span class="entry_type_enum_name">CENTER_ONLY</span>
18113                     <span class="entry_type_enum_notes"><p>The camera device only supports centered crop regions.<wbr/></p></span>
18114                   </li>
18115                   <li>
18116                     <span class="entry_type_enum_name">FREEFORM</span>
18117                     <span class="entry_type_enum_notes"><p>The camera device supports arbitrarily chosen crop regions.<wbr/></p></span>
18118                   </li>
18119                 </ul>
18120
18121             </td> <!-- entry_type -->
18122
18123             <td class="entry_description">
18124               <p>The crop type that this camera device supports.<wbr/></p>
18125             </td>
18126
18127             <td class="entry_units">
18128             </td>
18129
18130             <td class="entry_range">
18131             </td>
18132
18133             <td class="entry_tags">
18134             </td>
18135
18136           </tr>
18137           <tr class="entries_header">
18138             <th class="th_details" colspan="5">Details</th>
18139           </tr>
18140           <tr class="entry_cont">
18141             <td class="entry_details" colspan="5">
18142               <p>When passing a non-centered crop region (<a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>) to a camera
18143 device that only supports CENTER_<wbr/>ONLY cropping,<wbr/> the camera device will move the
18144 crop region to the center of the sensor active array (<a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>)
18145 and keep the crop region width and height unchanged.<wbr/> The camera device will return the
18146 final used crop region in metadata result <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
18147 <p>Camera devices that support FREEFORM cropping will support any crop region that
18148 is inside of the active array.<wbr/> The camera device will apply the same crop region and
18149 return the final used crop region in capture result metadata <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>.<wbr/></p>
18150 <p>LEGACY capability devices will only support CENTER_<wbr/>ONLY cropping.<wbr/></p>
18151             </td>
18152           </tr>
18153
18154
18155           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18156            <!-- end of entry -->
18157
18158
18159
18160       <!-- end of kind -->
18161       </tbody>
18162       <tr><td colspan="6" class="kind">dynamic</td></tr>
18163
18164       <thead class="entries_header">
18165         <tr>
18166           <th class="th_name">Property Name</th>
18167           <th class="th_type">Type</th>
18168           <th class="th_description">Description</th>
18169           <th class="th_units">Units</th>
18170           <th class="th_range">Range</th>
18171           <th class="th_tags">Tags</th>
18172         </tr>
18173       </thead>
18174
18175       <tbody>
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186           <tr class="entry" id="dynamic_android.scaler.cropRegion">
18187             <td class="entry_name
18188              " rowspan="5">
18189               android.<wbr/>scaler.<wbr/>crop<wbr/>Region
18190             </td>
18191             <td class="entry_type">
18192                 <span class="entry_type_name">int32</span>
18193                 <span class="entry_type_container">x</span>
18194
18195                 <span class="entry_type_array">
18196                   4
18197                 </span>
18198               <span class="entry_type_visibility"> [public as rectangle]</span>
18199
18200
18201               <span class="entry_type_hwlevel">[legacy] </span>
18202
18203
18204
18205
18206             </td> <!-- entry_type -->
18207
18208             <td class="entry_description">
18209               <p>The desired region of the sensor to read out for this capture.<wbr/></p>
18210             </td>
18211
18212             <td class="entry_units">
18213               Pixel coordinates relative to
18214           android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
18215             </td>
18216
18217             <td class="entry_range">
18218             </td>
18219
18220             <td class="entry_tags">
18221               <ul class="entry_tags">
18222                   <li><a href="#tag_BC">BC</a></li>
18223               </ul>
18224             </td>
18225
18226           </tr>
18227           <tr class="entries_header">
18228             <th class="th_details" colspan="5">Details</th>
18229           </tr>
18230           <tr class="entry_cont">
18231             <td class="entry_details" colspan="5">
18232               <p>This control can be used to implement digital zoom.<wbr/></p>
18233 <p>The crop region coordinate system is based off
18234 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with <code>(0,<wbr/> 0)</code> being the
18235 top-left corner of the sensor active array.<wbr/></p>
18236 <p>Output streams use this rectangle to produce their output,<wbr/>
18237 cropping to a smaller region if necessary to maintain the
18238 stream's aspect ratio,<wbr/> then scaling the sensor input to
18239 match the output's configured resolution.<wbr/></p>
18240 <p>The crop region is applied after the RAW to other color
18241 space (e.<wbr/>g.<wbr/> YUV) conversion.<wbr/> Since raw streams
18242 (e.<wbr/>g.<wbr/> RAW16) don't have the conversion stage,<wbr/> they are not
18243 croppable.<wbr/> The crop region will be ignored by raw streams.<wbr/></p>
18244 <p>For non-raw streams,<wbr/> any additional per-stream cropping will
18245 be done to maximize the final pixel area of the stream.<wbr/></p>
18246 <p>For example,<wbr/> if the crop region is set to a 4:3 aspect
18247 ratio,<wbr/> then 4:3 streams will use the exact crop
18248 region.<wbr/> 16:9 streams will further crop vertically
18249 (letterbox).<wbr/></p>
18250 <p>Conversely,<wbr/> if the crop region is set to a 16:9,<wbr/> then 4:3
18251 outputs will crop horizontally (pillarbox),<wbr/> and 16:9
18252 streams will match exactly.<wbr/> These additional crops will
18253 be centered within the crop region.<wbr/></p>
18254 <p>The width and height of the crop region cannot
18255 be set to be smaller than
18256 <code>floor( activeArraySize.<wbr/>width /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code> and
18257 <code>floor( activeArraySize.<wbr/>height /<wbr/> <a href="#static_android.scaler.availableMaxDigitalZoom">android.<wbr/>scaler.<wbr/>available<wbr/>Max<wbr/>Digital<wbr/>Zoom</a> )</code>,<wbr/> respectively.<wbr/></p>
18258 <p>The camera device may adjust the crop region to account
18259 for rounding and other hardware requirements; the final
18260 crop region used will be included in the output capture
18261 result.<wbr/></p>
18262             </td>
18263           </tr>
18264
18265           <tr class="entries_header">
18266             <th class="th_details" colspan="5">HAL Implementation Details</th>
18267           </tr>
18268           <tr class="entry_cont">
18269             <td class="entry_details" colspan="5">
18270               <p>The output streams must maintain square pixels at all
18271 times,<wbr/> no matter what the relative aspect ratios of the
18272 crop region and the stream are.<wbr/>  Negative values for
18273 corner are allowed for raw output if full pixel array is
18274 larger than active pixel array.<wbr/> Width and height may be
18275 rounded to nearest larger supportable width,<wbr/> especially
18276 for raw output,<wbr/> where only a few fixed scales may be
18277 possible.<wbr/></p>
18278 <p>For a set of output streams configured,<wbr/> if the sensor output is cropped to a smaller
18279 size than active array size,<wbr/> the HAL need follow below cropping rules:</p>
18280 <ul>
18281 <li>
18282 <p>The HAL need handle the cropRegion as if the sensor crop size is the effective active
18283 array size.<wbr/>More specifically,<wbr/> the HAL must transform the request cropRegion from
18284 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> to the sensor cropped pixel area size in this way:</p>
18285 <ol>
18286 <li>Translate the requested cropRegion w.<wbr/>r.<wbr/>t.,<wbr/> the left top corner of the sensor
18287 cropped pixel area by (tx,<wbr/> ty),<wbr/>
18288 where <code>tx = sensorCrop.<wbr/>top * (sensorCrop.<wbr/>height /<wbr/> activeArraySize.<wbr/>height)</code>
18289 and <code>tx = sensorCrop.<wbr/>left * (sensorCrop.<wbr/>width /<wbr/> activeArraySize.<wbr/>width)</code>.<wbr/> The
18290 (sensorCrop.<wbr/>top,<wbr/> sensorCrop.<wbr/>left) is the coordinate based off the
18291 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></li>
18292 <li>Scale the width and height of requested cropRegion with scaling factor of
18293 sensor<wbr/>Crop.<wbr/>width/<wbr/>active<wbr/>Array<wbr/>Size.<wbr/>width and sensor<wbr/>Crop.<wbr/>height/<wbr/>active<wbr/>Array<wbr/>Size.<wbr/>height
18294 respectively.<wbr/>
18295 Once this new cropRegion is calculated,<wbr/> the HAL must use this region to crop the image
18296 with regard to the sensor crop size (effective active array size).<wbr/> The HAL still need
18297 follow the general cropping rule for this new cropRegion and effective active
18298 array size.<wbr/></li>
18299 </ol>
18300 </li>
18301 <li>
18302 <p>The HAL must report the cropRegion with regard to <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/>
18303 The HAL need convert the new cropRegion generated above w.<wbr/>r.<wbr/>t.,<wbr/> full active array size.<wbr/>
18304 The reported cropRegion may be slightly different with the requested cropRegion since
18305 the HAL may adjust the crop region to account for rounding,<wbr/> conversion error,<wbr/> or other
18306 hardware limitations.<wbr/></p>
18307 </li>
18308 </ul>
18309 <p>HAL2.<wbr/>x uses only (x,<wbr/> y,<wbr/> width)</p>
18310             </td>
18311           </tr>
18312
18313           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18314            <!-- end of entry -->
18315
18316
18317
18318       <!-- end of kind -->
18319       </tbody>
18320
18321   <!-- end of section -->
18322   <tr><td colspan="6" id="section_sensor" class="section">sensor</td></tr>
18323
18324
18325       <tr><td colspan="6" class="kind">controls</td></tr>
18326
18327       <thead class="entries_header">
18328         <tr>
18329           <th class="th_name">Property Name</th>
18330           <th class="th_type">Type</th>
18331           <th class="th_description">Description</th>
18332           <th class="th_units">Units</th>
18333           <th class="th_range">Range</th>
18334           <th class="th_tags">Tags</th>
18335         </tr>
18336       </thead>
18337
18338       <tbody>
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349           <tr class="entry" id="controls_android.sensor.exposureTime">
18350             <td class="entry_name
18351              " rowspan="3">
18352               android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
18353             </td>
18354             <td class="entry_type">
18355                 <span class="entry_type_name">int64</span>
18356
18357               <span class="entry_type_visibility"> [public]</span>
18358
18359
18360               <span class="entry_type_hwlevel">[full] </span>
18361
18362
18363
18364
18365             </td> <!-- entry_type -->
18366
18367             <td class="entry_description">
18368               <p>Duration each pixel is exposed to
18369 light.<wbr/></p>
18370             </td>
18371
18372             <td class="entry_units">
18373               Nanoseconds
18374             </td>
18375
18376             <td class="entry_range">
18377               <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
18378             </td>
18379
18380             <td class="entry_tags">
18381               <ul class="entry_tags">
18382                   <li><a href="#tag_V1">V1</a></li>
18383               </ul>
18384             </td>
18385
18386           </tr>
18387           <tr class="entries_header">
18388             <th class="th_details" colspan="5">Details</th>
18389           </tr>
18390           <tr class="entry_cont">
18391             <td class="entry_details" colspan="5">
18392               <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
18393 duration exposed to the nearest possible value (rather than expose longer).<wbr/>
18394 The final exposure time used will be available in the output capture result.<wbr/></p>
18395 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
18396 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
18397             </td>
18398           </tr>
18399
18400
18401           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18402            <!-- end of entry -->
18403
18404
18405           <tr class="entry" id="controls_android.sensor.frameDuration">
18406             <td class="entry_name
18407              " rowspan="5">
18408               android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
18409             </td>
18410             <td class="entry_type">
18411                 <span class="entry_type_name">int64</span>
18412
18413               <span class="entry_type_visibility"> [public]</span>
18414
18415
18416               <span class="entry_type_hwlevel">[full] </span>
18417
18418
18419
18420
18421             </td> <!-- entry_type -->
18422
18423             <td class="entry_description">
18424               <p>Duration from start of frame exposure to
18425 start of next frame exposure.<wbr/></p>
18426             </td>
18427
18428             <td class="entry_units">
18429               Nanoseconds
18430             </td>
18431
18432             <td class="entry_range">
18433               <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
18434 <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
18435 is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
18436             </td>
18437
18438             <td class="entry_tags">
18439               <ul class="entry_tags">
18440                   <li><a href="#tag_V1">V1</a></li>
18441               </ul>
18442             </td>
18443
18444           </tr>
18445           <tr class="entries_header">
18446             <th class="th_details" colspan="5">Details</th>
18447           </tr>
18448           <tr class="entry_cont">
18449             <td class="entry_details" colspan="5">
18450               <p>The maximum frame rate that can be supported by a camera subsystem is
18451 a function of many factors:</p>
18452 <ul>
18453 <li>Requested resolutions of output image streams</li>
18454 <li>Availability of binning /<wbr/> skipping modes on the imager</li>
18455 <li>The bandwidth of the imager interface</li>
18456 <li>The bandwidth of the various ISP processing blocks</li>
18457 </ul>
18458 <p>Since these factors can vary greatly between different ISPs and
18459 sensors,<wbr/> the camera abstraction tries to represent the bandwidth
18460 restrictions with as simple a model as possible.<wbr/></p>
18461 <p>The model presented has the following characteristics:</p>
18462 <ul>
18463 <li>The image sensor is always configured to output the smallest
18464 resolution possible given the application's requested output stream
18465 sizes.<wbr/>  The smallest resolution is defined as being at least as large
18466 as the largest requested output stream size; the camera pipeline must
18467 never digitally upsample sensor data when the crop region covers the
18468 whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
18469 resolutions are configured,<wbr/> the sensor can provide a higher frame
18470 rate.<wbr/></li>
18471 <li>Since any request may use any or all the currently configured
18472 output streams,<wbr/> the sensor and ISP must be configured to support
18473 scaling a single capture to all the streams at the same time.<wbr/>  This
18474 means the camera pipeline must be ready to produce the largest
18475 requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
18476 frame rate of a given configured stream set is governed only by the
18477 largest requested stream resolution.<wbr/></li>
18478 <li>Using more than one output stream in a request does not affect the
18479 frame duration.<wbr/></li>
18480 <li>Certain format-streams may need to do additional background processing
18481 before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
18482 can run concurrently to the rest of the camera pipeline,<wbr/> but
18483 cannot process more than 1 capture at a time.<wbr/></li>
18484 </ul>
18485 <p>The necessary information for the application,<wbr/> given the model above,<wbr/>
18486 is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field using
18487 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.<wbr/>
18488 These are used to determine the maximum frame rate /<wbr/> minimum frame
18489 duration that is possible for a given stream configuration.<wbr/></p>
18490 <p>Specifically,<wbr/> the application can use the following rules to
18491 determine the minimum frame duration it can request from the camera
18492 device:</p>
18493 <ol>
18494 <li>Let the set of currently configured input/<wbr/>output streams
18495 be called <code>S</code>.<wbr/></li>
18496 <li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by looking
18497 it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>
18498 (with its respective size/<wbr/>format).<wbr/> Let this set of frame durations be
18499 called <code>F</code>.<wbr/></li>
18500 <li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
18501 for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
18502 used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
18503 </ol>
18504 <p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>
18505 using its respective size/<wbr/>format),<wbr/> then the frame duration in <code>F</code>
18506 determines the steady state frame rate that the application will get
18507 if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind of
18508 request be called <code>Rsimple</code>.<wbr/></p>
18509 <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
18510 by a single capture of a new request <code>Rstall</code> (which has at least
18511 one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
18512 same minimum frame duration this will not cause a frame rate loss
18513 if all buffers from the previous <code>Rstall</code> have already been
18514 delivered.<wbr/></p>
18515 <p>For more details about stalling,<wbr/> see
18516 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>.<wbr/></p>
18517 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
18518 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
18519             </td>
18520           </tr>
18521
18522           <tr class="entries_header">
18523             <th class="th_details" colspan="5">HAL Implementation Details</th>
18524           </tr>
18525           <tr class="entry_cont">
18526             <td class="entry_details" colspan="5">
18527               <p>For more details about stalling,<wbr/> see
18528 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
18529             </td>
18530           </tr>
18531
18532           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18533            <!-- end of entry -->
18534
18535
18536           <tr class="entry" id="controls_android.sensor.sensitivity">
18537             <td class="entry_name
18538              " rowspan="5">
18539               android.<wbr/>sensor.<wbr/>sensitivity
18540             </td>
18541             <td class="entry_type">
18542                 <span class="entry_type_name">int32</span>
18543
18544               <span class="entry_type_visibility"> [public]</span>
18545
18546
18547               <span class="entry_type_hwlevel">[full] </span>
18548
18549
18550
18551
18552             </td> <!-- entry_type -->
18553
18554             <td class="entry_description">
18555               <p>The amount of gain applied to sensor data
18556 before processing.<wbr/></p>
18557             </td>
18558
18559             <td class="entry_units">
18560               ISO arithmetic units
18561             </td>
18562
18563             <td class="entry_range">
18564               <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
18565             </td>
18566
18567             <td class="entry_tags">
18568               <ul class="entry_tags">
18569                   <li><a href="#tag_V1">V1</a></li>
18570               </ul>
18571             </td>
18572
18573           </tr>
18574           <tr class="entries_header">
18575             <th class="th_details" colspan="5">Details</th>
18576           </tr>
18577           <tr class="entry_cont">
18578             <td class="entry_details" colspan="5">
18579               <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
18580 as defined in ISO 12232:2006.<wbr/></p>
18581 <p>The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a>,<wbr/> and
18582 if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity</a>,<wbr/> the camera device
18583 is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
18584 <p>If the camera device cannot apply the exact sensitivity
18585 requested,<wbr/> it will reduce the gain to the nearest supported
18586 value.<wbr/> The final sensitivity used will be available in the
18587 output capture result.<wbr/></p>
18588 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
18589 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
18590             </td>
18591           </tr>
18592
18593           <tr class="entries_header">
18594             <th class="th_details" colspan="5">HAL Implementation Details</th>
18595           </tr>
18596           <tr class="entry_cont">
18597             <td class="entry_details" colspan="5">
18598               <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
18599             </td>
18600           </tr>
18601
18602           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18603            <!-- end of entry -->
18604
18605
18606           <tr class="entry" id="controls_android.sensor.testPatternData">
18607             <td class="entry_name
18608              " rowspan="5">
18609               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
18610             </td>
18611             <td class="entry_type">
18612                 <span class="entry_type_name">int32</span>
18613                 <span class="entry_type_container">x</span>
18614
18615                 <span class="entry_type_array">
18616                   4
18617                 </span>
18618               <span class="entry_type_visibility"> [public]</span>
18619
18620
18621
18622
18623
18624
18625             </td> <!-- entry_type -->
18626
18627             <td class="entry_description">
18628               <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
18629 when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
18630             </td>
18631
18632             <td class="entry_units">
18633             </td>
18634
18635             <td class="entry_range">
18636             </td>
18637
18638             <td class="entry_tags">
18639             </td>
18640
18641           </tr>
18642           <tr class="entries_header">
18643             <th class="th_details" colspan="5">Details</th>
18644           </tr>
18645           <tr class="entry_cont">
18646             <td class="entry_details" colspan="5">
18647               <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
18648 The camera device then uses the most significant X bits
18649 that correspond to how many bits are in its Bayer raw sensor
18650 output.<wbr/></p>
18651 <p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
18652 10 most significant bits from each color channel.<wbr/></p>
18653             </td>
18654           </tr>
18655
18656           <tr class="entries_header">
18657             <th class="th_details" colspan="5">HAL Implementation Details</th>
18658           </tr>
18659           <tr class="entry_cont">
18660             <td class="entry_details" colspan="5">
18661
18662             </td>
18663           </tr>
18664
18665           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18666            <!-- end of entry -->
18667
18668
18669           <tr class="entry" id="controls_android.sensor.testPatternMode">
18670             <td class="entry_name
18671              " rowspan="5">
18672               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
18673             </td>
18674             <td class="entry_type">
18675                 <span class="entry_type_name entry_type_name_enum">int32</span>
18676
18677               <span class="entry_type_visibility"> [public]</span>
18678
18679
18680
18681
18682
18683                 <ul class="entry_type_enum">
18684                   <li>
18685                     <span class="entry_type_enum_name">OFF</span>
18686                     <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
18687 device returns captures from the image sensor.<wbr/></p>
18688 <p>This is the default if the key is not set.<wbr/></p></span>
18689                   </li>
18690                   <li>
18691                     <span class="entry_type_enum_name">SOLID_COLOR</span>
18692                     <span class="entry_type_enum_notes"><p>Each pixel in <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> is replaced by its
18693 respective color channel provided in
18694 <a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
18695 <p>For example:</p>
18696 <pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
18697 </code></pre>
18698 <p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
18699 <pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
18700 </code></pre>
18701 <p>All red pixels are 100% red.<wbr/> Only the odd green pixels
18702 are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
18703                   </li>
18704                   <li>
18705                     <span class="entry_type_enum_name">COLOR_BARS</span>
18706                     <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
18707 <p>The vertical bars (left-to-right) are as follows:</p>
18708 <ul>
18709 <li>100% white</li>
18710 <li>yellow</li>
18711 <li>cyan</li>
18712 <li>green</li>
18713 <li>magenta</li>
18714 <li>red</li>
18715 <li>blue</li>
18716 <li>black</li>
18717 </ul>
18718 <p>In general the image would look like the following:</p>
18719 <pre><code>W Y C G M R B K
18720 W Y C G M R B K
18721 W Y C G M R B K
18722 W Y C G M R B K
18723 W Y C G M R B K
18724 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18725 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18726 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
18727
18728 (B = Blue,<wbr/> K = Black)
18729 </code></pre>
18730 <p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
18731 When this is not possible,<wbr/> the bar size should be rounded
18732 down to the nearest integer and the pattern can repeat
18733 on the right side.<wbr/></p>
18734 <p>Each bar's height must always take up the full sensor
18735 pixel array height.<wbr/></p>
18736 <p>Each pixel in this test pattern must be set to either
18737 0% intensity or 100% intensity.<wbr/></p></span>
18738                   </li>
18739                   <li>
18740                     <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
18741                     <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
18742 each bar should start at its specified color at the top,<wbr/>
18743 and fade to gray at the bottom.<wbr/></p>
18744 <p>Furthermore each bar is further subdivided into a left and
18745 right half.<wbr/> The left half should have a smooth gradient,<wbr/>
18746 and the right half should have a quantized gradient.<wbr/></p>
18747 <p>In particular,<wbr/> the right half's should consist of blocks of the
18748 same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
18749 <p>The least significant bits in the quantized gradient should
18750 be copied from the most significant bits of the smooth gradient.<wbr/></p>
18751 <p>The height of each bar should always be a multiple of 128.<wbr/>
18752 When this is not the case,<wbr/> the pattern should repeat at the bottom
18753 of the image.<wbr/></p></span>
18754                   </li>
18755                   <li>
18756                     <span class="entry_type_enum_name">PN9</span>
18757                     <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
18758 generated from a PN9 512-bit sequence (typically implemented
18759 in hardware with a linear feedback shift register).<wbr/></p>
18760 <p>The generator should be reset at the beginning of each frame,<wbr/>
18761 and thus each subsequent raw frame with this test pattern should
18762 be exactly the same as the last.<wbr/></p></span>
18763                   </li>
18764                   <li>
18765                     <span class="entry_type_enum_name">CUSTOM1</span>
18766                     <span class="entry_type_enum_value">256</span>
18767                     <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
18768 available only on this camera device are at least this numeric
18769 value.<wbr/></p>
18770 <p>All of the custom test patterns will be static
18771 (that is the raw image must not vary from frame to frame).<wbr/></p></span>
18772                   </li>
18773                 </ul>
18774
18775             </td> <!-- entry_type -->
18776
18777             <td class="entry_description">
18778               <p>When enabled,<wbr/> the sensor sends a test pattern instead of
18779 doing a real exposure from the camera.<wbr/></p>
18780             </td>
18781
18782             <td class="entry_units">
18783             </td>
18784
18785             <td class="entry_range">
18786               <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
18787             </td>
18788
18789             <td class="entry_tags">
18790             </td>
18791
18792           </tr>
18793           <tr class="entries_header">
18794             <th class="th_details" colspan="5">Details</th>
18795           </tr>
18796           <tr class="entry_cont">
18797             <td class="entry_details" colspan="5">
18798               <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
18799 by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
18800 work as normal.<wbr/></p>
18801 <p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
18802 occur (and that the test pattern remain unmodified,<wbr/> since the flash
18803 would not actually affect it).<wbr/></p>
18804 <p>Defaults to OFF.<wbr/></p>
18805             </td>
18806           </tr>
18807
18808           <tr class="entries_header">
18809             <th class="th_details" colspan="5">HAL Implementation Details</th>
18810           </tr>
18811           <tr class="entry_cont">
18812             <td class="entry_details" colspan="5">
18813               <p>All test patterns are specified in the Bayer domain.<wbr/></p>
18814 <p>The HAL may choose to substitute test patterns from the sensor
18815 with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
18816 indistinguishable to the ISP whether the data came from the
18817 sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
18818             </td>
18819           </tr>
18820
18821           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18822            <!-- end of entry -->
18823
18824
18825
18826       <!-- end of kind -->
18827       </tbody>
18828       <tr><td colspan="6" class="kind">static</td></tr>
18829
18830       <thead class="entries_header">
18831         <tr>
18832           <th class="th_name">Property Name</th>
18833           <th class="th_type">Type</th>
18834           <th class="th_description">Description</th>
18835           <th class="th_units">Units</th>
18836           <th class="th_range">Range</th>
18837           <th class="th_tags">Tags</th>
18838         </tr>
18839       </thead>
18840
18841       <tbody>
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854           <tr class="entry" id="static_android.sensor.info.activeArraySize">
18855             <td class="entry_name
18856              " rowspan="5">
18857               android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size
18858             </td>
18859             <td class="entry_type">
18860                 <span class="entry_type_name">int32</span>
18861                 <span class="entry_type_container">x</span>
18862
18863                 <span class="entry_type_array">
18864                   4
18865                 </span>
18866               <span class="entry_type_visibility"> [public as rectangle]</span>
18867
18868
18869               <span class="entry_type_hwlevel">[legacy] </span>
18870
18871
18872                 <div class="entry_type_notes">Four ints defining the active pixel rectangle</div>
18873
18874
18875             </td> <!-- entry_type -->
18876
18877             <td class="entry_description">
18878               <p>The area of the image sensor which corresponds to active pixels after any geometric
18879 distortion correction has been applied.<wbr/></p>
18880             </td>
18881
18882             <td class="entry_units">
18883               Pixel coordinates on the image sensor
18884             </td>
18885
18886             <td class="entry_range">
18887             </td>
18888
18889             <td class="entry_tags">
18890               <ul class="entry_tags">
18891                   <li><a href="#tag_RAW">RAW</a></li>
18892               </ul>
18893             </td>
18894
18895           </tr>
18896           <tr class="entries_header">
18897             <th class="th_details" colspan="5">Details</th>
18898           </tr>
18899           <tr class="entry_cont">
18900             <td class="entry_details" colspan="5">
18901               <p>This is the rectangle representing the size of the active region of the sensor (i.<wbr/>e.<wbr/>
18902 the region that actually receives light from the scene) after any geometric correction
18903 has been applied,<wbr/> and should be treated as the maximum size in pixels of any of the
18904 image output formats aside from the raw formats.<wbr/></p>
18905 <p>This rectangle is defined relative to the full pixel array; (0,<wbr/>0) is the top-left of
18906 the full pixel array,<wbr/> and the size of the full pixel array is given by
18907 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
18908 <p>The coordinate system for most other keys that list pixel coordinates,<wbr/> including
18909 <a href="#controls_android.scaler.cropRegion">android.<wbr/>scaler.<wbr/>crop<wbr/>Region</a>,<wbr/> is defined relative to the active array rectangle given in
18910 this field,<wbr/> with <code>(0,<wbr/> 0)</code> being the top-left of this rectangle.<wbr/></p>
18911 <p>The active array may be smaller than the full pixel array,<wbr/> since the full array may
18912 include black calibration pixels or other inactive regions,<wbr/> and geometric correction
18913 resulting in scaling or cropping may have been applied.<wbr/></p>
18914             </td>
18915           </tr>
18916
18917           <tr class="entries_header">
18918             <th class="th_details" colspan="5">HAL Implementation Details</th>
18919           </tr>
18920           <tr class="entry_cont">
18921             <td class="entry_details" colspan="5">
18922               <p>This array contains <code>(xmin,<wbr/> ymin,<wbr/> width,<wbr/> height)</code>.<wbr/> The <code>(xmin,<wbr/> ymin)</code> must be
18923 &gt;= <code>(0,<wbr/>0)</code>.<wbr/>
18924 The <code>(width,<wbr/> height)</code> must be &lt;= <code><a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a></code>.<wbr/></p>
18925             </td>
18926           </tr>
18927
18928           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18929            <!-- end of entry -->
18930
18931
18932           <tr class="entry" id="static_android.sensor.info.sensitivityRange">
18933             <td class="entry_name
18934              " rowspan="3">
18935               android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range
18936             </td>
18937             <td class="entry_type">
18938                 <span class="entry_type_name">int32</span>
18939                 <span class="entry_type_container">x</span>
18940
18941                 <span class="entry_type_array">
18942                   2
18943                 </span>
18944               <span class="entry_type_visibility"> [public as rangeInt]</span>
18945
18946
18947               <span class="entry_type_hwlevel">[full] </span>
18948
18949
18950                 <div class="entry_type_notes">Range of supported sensitivities</div>
18951
18952
18953             </td> <!-- entry_type -->
18954
18955             <td class="entry_description">
18956               <p>Range of sensitivities for <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> supported by this
18957 camera device.<wbr/></p>
18958             </td>
18959
18960             <td class="entry_units">
18961             </td>
18962
18963             <td class="entry_range">
18964               <p>Min &lt;= 100,<wbr/> Max &gt;= 800</p>
18965             </td>
18966
18967             <td class="entry_tags">
18968               <ul class="entry_tags">
18969                   <li><a href="#tag_BC">BC</a></li>
18970                   <li><a href="#tag_V1">V1</a></li>
18971               </ul>
18972             </td>
18973
18974           </tr>
18975           <tr class="entries_header">
18976             <th class="th_details" colspan="5">Details</th>
18977           </tr>
18978           <tr class="entry_cont">
18979             <td class="entry_details" colspan="5">
18980               <p>The values are the standard ISO sensitivity values,<wbr/>
18981 as defined in ISO 12232:2006.<wbr/></p>
18982             </td>
18983           </tr>
18984
18985
18986           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
18987            <!-- end of entry -->
18988
18989
18990           <tr class="entry" id="static_android.sensor.info.colorFilterArrangement">
18991             <td class="entry_name
18992              " rowspan="1">
18993               android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement
18994             </td>
18995             <td class="entry_type">
18996                 <span class="entry_type_name entry_type_name_enum">byte</span>
18997
18998               <span class="entry_type_visibility"> [public]</span>
18999
19000
19001               <span class="entry_type_hwlevel">[full] </span>
19002
19003
19004
19005                 <ul class="entry_type_enum">
19006                   <li>
19007                     <span class="entry_type_enum_name">RGGB</span>
19008                   </li>
19009                   <li>
19010                     <span class="entry_type_enum_name">GRBG</span>
19011                   </li>
19012                   <li>
19013                     <span class="entry_type_enum_name">GBRG</span>
19014                   </li>
19015                   <li>
19016                     <span class="entry_type_enum_name">BGGR</span>
19017                   </li>
19018                   <li>
19019                     <span class="entry_type_enum_name">RGB</span>
19020                     <span class="entry_type_enum_notes"><p>Sensor is not Bayer; output has 3 16-bit
19021 values for each pixel,<wbr/> instead of just 1 16-bit value
19022 per pixel.<wbr/></p></span>
19023                   </li>
19024                 </ul>
19025
19026             </td> <!-- entry_type -->
19027
19028             <td class="entry_description">
19029               <p>The arrangement of color filters on sensor;
19030 represents the colors in the top-left 2x2 section of
19031 the sensor,<wbr/> in reading order.<wbr/></p>
19032             </td>
19033
19034             <td class="entry_units">
19035             </td>
19036
19037             <td class="entry_range">
19038             </td>
19039
19040             <td class="entry_tags">
19041               <ul class="entry_tags">
19042                   <li><a href="#tag_RAW">RAW</a></li>
19043               </ul>
19044             </td>
19045
19046           </tr>
19047
19048
19049           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19050            <!-- end of entry -->
19051
19052
19053           <tr class="entry" id="static_android.sensor.info.exposureTimeRange">
19054             <td class="entry_name
19055              " rowspan="3">
19056               android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range
19057             </td>
19058             <td class="entry_type">
19059                 <span class="entry_type_name">int64</span>
19060                 <span class="entry_type_container">x</span>
19061
19062                 <span class="entry_type_array">
19063                   2
19064                 </span>
19065               <span class="entry_type_visibility"> [public as rangeLong]</span>
19066
19067
19068               <span class="entry_type_hwlevel">[full] </span>
19069
19070
19071                 <div class="entry_type_notes">nanoseconds</div>
19072
19073
19074             </td> <!-- entry_type -->
19075
19076             <td class="entry_description">
19077               <p>The range of image exposure times for <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> supported
19078 by this camera device.<wbr/></p>
19079             </td>
19080
19081             <td class="entry_units">
19082               Nanoseconds
19083             </td>
19084
19085             <td class="entry_range">
19086               <p>The minimum exposure time will be less than 100 us.<wbr/> For FULL
19087 capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
19088 the maximum exposure time will be greater than 100ms.<wbr/></p>
19089             </td>
19090
19091             <td class="entry_tags">
19092               <ul class="entry_tags">
19093                   <li><a href="#tag_V1">V1</a></li>
19094               </ul>
19095             </td>
19096
19097           </tr>
19098
19099           <tr class="entries_header">
19100             <th class="th_details" colspan="5">HAL Implementation Details</th>
19101           </tr>
19102           <tr class="entry_cont">
19103             <td class="entry_details" colspan="5">
19104               <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
19105 The maximum of the range SHOULD be at least 1 second (1e9),<wbr/> MUST be at least
19106 100ms.<wbr/></p>
19107             </td>
19108           </tr>
19109
19110           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19111            <!-- end of entry -->
19112
19113
19114           <tr class="entry" id="static_android.sensor.info.maxFrameDuration">
19115             <td class="entry_name
19116              " rowspan="5">
19117               android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration
19118             </td>
19119             <td class="entry_type">
19120                 <span class="entry_type_name">int64</span>
19121
19122               <span class="entry_type_visibility"> [public]</span>
19123
19124
19125               <span class="entry_type_hwlevel">[full] </span>
19126
19127
19128
19129
19130             </td> <!-- entry_type -->
19131
19132             <td class="entry_description">
19133               <p>The maximum possible frame duration (minimum frame rate) for
19134 <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> that is supported this camera device.<wbr/></p>
19135             </td>
19136
19137             <td class="entry_units">
19138               Nanoseconds
19139             </td>
19140
19141             <td class="entry_range">
19142               <p>For FULL capability devices
19143 (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/> at least 100ms.<wbr/></p>
19144             </td>
19145
19146             <td class="entry_tags">
19147               <ul class="entry_tags">
19148                   <li><a href="#tag_V1">V1</a></li>
19149               </ul>
19150             </td>
19151
19152           </tr>
19153           <tr class="entries_header">
19154             <th class="th_details" colspan="5">Details</th>
19155           </tr>
19156           <tr class="entry_cont">
19157             <td class="entry_details" colspan="5">
19158               <p>Attempting to use frame durations beyond the maximum will result in the frame
19159 duration being clipped to the maximum.<wbr/> See that control for a full definition of frame
19160 durations.<wbr/></p>
19161 <p>Refer to <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>
19162 for the minimum frame duration values.<wbr/></p>
19163             </td>
19164           </tr>
19165
19166           <tr class="entries_header">
19167             <th class="th_details" colspan="5">HAL Implementation Details</th>
19168           </tr>
19169           <tr class="entry_cont">
19170             <td class="entry_details" colspan="5">
19171               <p>For FULL capability devices (<a href="#static_android.info.supportedHardwareLevel">android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level</a> == FULL),<wbr/>
19172 The maximum of the range SHOULD be at least
19173 1 second (1e9),<wbr/> MUST be at least 100ms (100e6).<wbr/></p>
19174 <p><a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a> must be greater or
19175 equal to the <a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a> max
19176 value (since exposure time overrides frame duration).<wbr/></p>
19177 <p>Available minimum frame durations for JPEG must be no greater
19178 than that of the YUV_<wbr/>420_<wbr/>888/<wbr/>IMPLEMENTATION_<wbr/>DEFINED
19179 minimum frame durations (for that respective size).<wbr/></p>
19180 <p>Since JPEG processing is considered offline and can take longer than
19181 a single uncompressed capture,<wbr/> refer to
19182 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>
19183 for details about encoding this scenario.<wbr/></p>
19184             </td>
19185           </tr>
19186
19187           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19188            <!-- end of entry -->
19189
19190
19191           <tr class="entry" id="static_android.sensor.info.physicalSize">
19192             <td class="entry_name
19193              " rowspan="5">
19194               android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size
19195             </td>
19196             <td class="entry_type">
19197                 <span class="entry_type_name">float</span>
19198                 <span class="entry_type_container">x</span>
19199
19200                 <span class="entry_type_array">
19201                   2
19202                 </span>
19203               <span class="entry_type_visibility"> [public as sizeF]</span>
19204
19205
19206               <span class="entry_type_hwlevel">[legacy] </span>
19207
19208
19209                 <div class="entry_type_notes">width x height</div>
19210
19211
19212             </td> <!-- entry_type -->
19213
19214             <td class="entry_description">
19215               <p>The physical dimensions of the full pixel
19216 array.<wbr/></p>
19217             </td>
19218
19219             <td class="entry_units">
19220               Millimeters
19221             </td>
19222
19223             <td class="entry_range">
19224             </td>
19225
19226             <td class="entry_tags">
19227               <ul class="entry_tags">
19228                   <li><a href="#tag_V1">V1</a></li>
19229                   <li><a href="#tag_BC">BC</a></li>
19230               </ul>
19231             </td>
19232
19233           </tr>
19234           <tr class="entries_header">
19235             <th class="th_details" colspan="5">Details</th>
19236           </tr>
19237           <tr class="entry_cont">
19238             <td class="entry_details" colspan="5">
19239               <p>This is the physical size of the sensor pixel
19240 array defined by <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19241             </td>
19242           </tr>
19243
19244           <tr class="entries_header">
19245             <th class="th_details" colspan="5">HAL Implementation Details</th>
19246           </tr>
19247           <tr class="entry_cont">
19248             <td class="entry_details" colspan="5">
19249               <p>Needed for FOV calculation for old API</p>
19250             </td>
19251           </tr>
19252
19253           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19254            <!-- end of entry -->
19255
19256
19257           <tr class="entry" id="static_android.sensor.info.pixelArraySize">
19258             <td class="entry_name
19259              " rowspan="3">
19260               android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size
19261             </td>
19262             <td class="entry_type">
19263                 <span class="entry_type_name">int32</span>
19264                 <span class="entry_type_container">x</span>
19265
19266                 <span class="entry_type_array">
19267                   2
19268                 </span>
19269               <span class="entry_type_visibility"> [public as size]</span>
19270
19271
19272               <span class="entry_type_hwlevel">[legacy] </span>
19273
19274
19275
19276
19277             </td> <!-- entry_type -->
19278
19279             <td class="entry_description">
19280               <p>Dimensions of the full pixel array,<wbr/> possibly
19281 including black calibration pixels.<wbr/></p>
19282             </td>
19283
19284             <td class="entry_units">
19285               Pixels
19286             </td>
19287
19288             <td class="entry_range">
19289             </td>
19290
19291             <td class="entry_tags">
19292               <ul class="entry_tags">
19293                   <li><a href="#tag_RAW">RAW</a></li>
19294                   <li><a href="#tag_BC">BC</a></li>
19295               </ul>
19296             </td>
19297
19298           </tr>
19299           <tr class="entries_header">
19300             <th class="th_details" colspan="5">Details</th>
19301           </tr>
19302           <tr class="entry_cont">
19303             <td class="entry_details" colspan="5">
19304               <p>The pixel count of the full pixel array of the image sensor,<wbr/> which covers
19305 <a href="#static_android.sensor.info.physicalSize">android.<wbr/>sensor.<wbr/>info.<wbr/>physical<wbr/>Size</a> area.<wbr/>  This represents the full pixel dimensions of
19306 the raw buffers produced by this sensor.<wbr/></p>
19307 <p>If a camera device supports raw sensor formats,<wbr/> either this or
19308 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> is the maximum dimensions for the raw
19309 output formats listed in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> (this depends on
19310 whether or not the image sensor returns buffers containing pixels that are not
19311 part of the active array region for blacklevel calibration or other purposes).<wbr/></p>
19312 <p>Some parts of the full pixel array may not receive light from the scene,<wbr/>
19313 or be otherwise inactive.<wbr/>  The <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> key
19314 defines the rectangle of active pixels that will be included in processed image
19315 formats.<wbr/></p>
19316             </td>
19317           </tr>
19318
19319
19320           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19321            <!-- end of entry -->
19322
19323
19324           <tr class="entry" id="static_android.sensor.info.whiteLevel">
19325             <td class="entry_name
19326              " rowspan="5">
19327               android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level
19328             </td>
19329             <td class="entry_type">
19330                 <span class="entry_type_name">int32</span>
19331
19332               <span class="entry_type_visibility"> [public]</span>
19333
19334
19335
19336
19337
19338
19339             </td> <!-- entry_type -->
19340
19341             <td class="entry_description">
19342               <p>Maximum raw value output by sensor.<wbr/></p>
19343             </td>
19344
19345             <td class="entry_units">
19346             </td>
19347
19348             <td class="entry_range">
19349               <p>&gt; 255 (8-bit output)</p>
19350             </td>
19351
19352             <td class="entry_tags">
19353               <ul class="entry_tags">
19354                   <li><a href="#tag_RAW">RAW</a></li>
19355               </ul>
19356             </td>
19357
19358           </tr>
19359           <tr class="entries_header">
19360             <th class="th_details" colspan="5">Details</th>
19361           </tr>
19362           <tr class="entry_cont">
19363             <td class="entry_details" colspan="5">
19364               <p>This specifies the fully-saturated encoding level for the raw
19365 sample values from the sensor.<wbr/>  This is typically caused by the
19366 sensor becoming highly non-linear or clipping.<wbr/> The minimum for
19367 each channel is specified by the offset in the
19368 <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> key.<wbr/></p>
19369 <p>The white level is typically determined either by sensor bit depth
19370 (8-14 bits is expected),<wbr/> or by the point where the sensor response
19371 becomes too non-linear to be useful.<wbr/>  The default value for this is
19372 maximum representable value for a 16-bit raw sample (2^16 - 1).<wbr/></p>
19373 <p>The white level values of captured images may vary for different
19374 capture settings (e.<wbr/>g.,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>).<wbr/> This key
19375 represents a coarse approximation for such case.<wbr/> It is recommended
19376 to use <a href="#dynamic_android.sensor.dynamicWhiteLevel">android.<wbr/>sensor.<wbr/>dynamic<wbr/>White<wbr/>Level</a> for captures when supported
19377 by the camera device,<wbr/> which provides more accurate white level values.<wbr/></p>
19378             </td>
19379           </tr>
19380
19381           <tr class="entries_header">
19382             <th class="th_details" colspan="5">HAL Implementation Details</th>
19383           </tr>
19384           <tr class="entry_cont">
19385             <td class="entry_details" colspan="5">
19386               <p>The full bit depth of the sensor must be available in the raw data,<wbr/>
19387 so the value for linear sensors should not be significantly lower
19388 than maximum raw value supported,<wbr/> i.<wbr/>e.<wbr/> 2^(sensor bits per pixel).<wbr/></p>
19389             </td>
19390           </tr>
19391
19392           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19393            <!-- end of entry -->
19394
19395
19396           <tr class="entry" id="static_android.sensor.info.timestampSource">
19397             <td class="entry_name
19398              " rowspan="5">
19399               android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source
19400             </td>
19401             <td class="entry_type">
19402                 <span class="entry_type_name entry_type_name_enum">byte</span>
19403
19404               <span class="entry_type_visibility"> [public]</span>
19405
19406
19407               <span class="entry_type_hwlevel">[legacy] </span>
19408
19409
19410
19411                 <ul class="entry_type_enum">
19412                   <li>
19413                     <span class="entry_type_enum_name">UNKNOWN</span>
19414                     <span class="entry_type_enum_notes"><p>Timestamps from <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> are in nanoseconds and monotonic,<wbr/>
19415 but can not be compared to timestamps from other subsystems
19416 (e.<wbr/>g.<wbr/> accelerometer,<wbr/> gyro etc.<wbr/>),<wbr/> or other instances of the same or different
19417 camera devices in the same system.<wbr/> Timestamps between streams and results for
19418 a single camera instance are comparable,<wbr/> and the timestamps for all buffers
19419 and the result metadata generated by a single capture are identical.<wbr/></p></span>
19420                   </li>
19421                   <li>
19422                     <span class="entry_type_enum_name">REALTIME</span>
19423                     <span class="entry_type_enum_notes"><p>Timestamps from <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> are in the same timebase as
19424 <a href="https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtimeNanos">SystemClock#elapsedRealtimeNanos</a>,<wbr/>
19425 and they can be compared to other timestamps using that base.<wbr/></p></span>
19426                   </li>
19427                 </ul>
19428
19429             </td> <!-- entry_type -->
19430
19431             <td class="entry_description">
19432               <p>The time base source for sensor capture start timestamps.<wbr/></p>
19433             </td>
19434
19435             <td class="entry_units">
19436             </td>
19437
19438             <td class="entry_range">
19439             </td>
19440
19441             <td class="entry_tags">
19442               <ul class="entry_tags">
19443                   <li><a href="#tag_V1">V1</a></li>
19444               </ul>
19445             </td>
19446
19447           </tr>
19448           <tr class="entries_header">
19449             <th class="th_details" colspan="5">Details</th>
19450           </tr>
19451           <tr class="entry_cont">
19452             <td class="entry_details" colspan="5">
19453               <p>The timestamps provided for captures are always in nanoseconds and monotonic,<wbr/> but
19454 may not based on a time source that can be compared to other system time sources.<wbr/></p>
19455 <p>This characteristic defines the source for the timestamps,<wbr/> and therefore whether they
19456 can be compared against other system time sources/<wbr/>timestamps.<wbr/></p>
19457             </td>
19458           </tr>
19459
19460           <tr class="entries_header">
19461             <th class="th_details" colspan="5">HAL Implementation Details</th>
19462           </tr>
19463           <tr class="entry_cont">
19464             <td class="entry_details" colspan="5">
19465               <p>For camera devices implement UNKNOWN,<wbr/> the camera framework expects that the timestamp
19466 source to be SYSTEM_<wbr/>TIME_<wbr/>MONOTONIC.<wbr/> For camera devices implement REALTIME,<wbr/> the camera
19467 framework expects that the timestamp source to be SYSTEM_<wbr/>TIME_<wbr/>BOOTTIME.<wbr/> See
19468 system/<wbr/>core/<wbr/>include/<wbr/>utils/<wbr/>Timers.<wbr/>h for the definition of SYSTEM_<wbr/>TIME_<wbr/>MONOTONIC and
19469 SYSTEM_<wbr/>TIME_<wbr/>BOOTTIME.<wbr/> Note that HAL must follow above expectation; otherwise video
19470 recording might suffer unexpected behavior.<wbr/></p>
19471 <p>Also,<wbr/> camera devices implements REALTIME must pass the ITS sensor fusion test which
19472 tests the alignment between camera timestamps and gyro sensor timestamps.<wbr/></p>
19473             </td>
19474           </tr>
19475
19476           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19477            <!-- end of entry -->
19478
19479
19480           <tr class="entry" id="static_android.sensor.info.lensShadingApplied">
19481             <td class="entry_name
19482              " rowspan="3">
19483               android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied
19484             </td>
19485             <td class="entry_type">
19486                 <span class="entry_type_name entry_type_name_enum">byte</span>
19487
19488               <span class="entry_type_visibility"> [public as boolean]</span>
19489
19490
19491
19492
19493
19494                 <ul class="entry_type_enum">
19495                   <li>
19496                     <span class="entry_type_enum_name">FALSE</span>
19497                   </li>
19498                   <li>
19499                     <span class="entry_type_enum_name">TRUE</span>
19500                   </li>
19501                 </ul>
19502
19503             </td> <!-- entry_type -->
19504
19505             <td class="entry_description">
19506               <p>Whether the RAW images output from this camera device are subject to
19507 lens shading correction.<wbr/></p>
19508             </td>
19509
19510             <td class="entry_units">
19511             </td>
19512
19513             <td class="entry_range">
19514             </td>
19515
19516             <td class="entry_tags">
19517             </td>
19518
19519           </tr>
19520           <tr class="entries_header">
19521             <th class="th_details" colspan="5">Details</th>
19522           </tr>
19523           <tr class="entry_cont">
19524             <td class="entry_details" colspan="5">
19525               <p>If TRUE,<wbr/> all images produced by the camera device in the RAW image formats will
19526 have lens shading correction already applied to it.<wbr/> If FALSE,<wbr/> the images will
19527 not be adjusted for lens shading correction.<wbr/>
19528 See <a href="#static_android.request.maxNumOutputRaw">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Raw</a> for a list of RAW image formats.<wbr/></p>
19529 <p>This key will be <code>null</code> for all devices do not report this information.<wbr/>
19530 Devices with RAW capability will always report this information in this key.<wbr/></p>
19531             </td>
19532           </tr>
19533
19534
19535           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19536            <!-- end of entry -->
19537
19538
19539           <tr class="entry" id="static_android.sensor.info.preCorrectionActiveArraySize">
19540             <td class="entry_name
19541              " rowspan="5">
19542               android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size
19543             </td>
19544             <td class="entry_type">
19545                 <span class="entry_type_name">int32</span>
19546                 <span class="entry_type_container">x</span>
19547
19548                 <span class="entry_type_array">
19549                   4
19550                 </span>
19551               <span class="entry_type_visibility"> [public as rectangle]</span>
19552
19553
19554               <span class="entry_type_hwlevel">[legacy] </span>
19555
19556
19557                 <div class="entry_type_notes">Four ints defining the active pixel rectangle</div>
19558
19559
19560             </td> <!-- entry_type -->
19561
19562             <td class="entry_description">
19563               <p>The area of the image sensor which corresponds to active pixels prior to the
19564 application of any geometric distortion correction.<wbr/></p>
19565             </td>
19566
19567             <td class="entry_units">
19568               Pixel coordinates on the image sensor
19569             </td>
19570
19571             <td class="entry_range">
19572             </td>
19573
19574             <td class="entry_tags">
19575               <ul class="entry_tags">
19576                   <li><a href="#tag_RAW">RAW</a></li>
19577               </ul>
19578             </td>
19579
19580           </tr>
19581           <tr class="entries_header">
19582             <th class="th_details" colspan="5">Details</th>
19583           </tr>
19584           <tr class="entry_cont">
19585             <td class="entry_details" colspan="5">
19586               <p>This is the rectangle representing the size of the active region of the sensor (i.<wbr/>e.<wbr/>
19587 the region that actually receives light from the scene) before any geometric correction
19588 has been applied,<wbr/> and should be treated as the active region rectangle for any of the
19589 raw formats.<wbr/>  All metadata associated with raw processing (e.<wbr/>g.<wbr/> the lens shading
19590 correction map,<wbr/> and radial distortion fields) treats the top,<wbr/> left of this rectangle as
19591 the origin,<wbr/> (0,<wbr/>0).<wbr/></p>
19592 <p>The size of this region determines the maximum field of view and the maximum number of
19593 pixels that an image from this sensor can contain,<wbr/> prior to the application of
19594 geometric distortion correction.<wbr/> The effective maximum pixel dimensions of a
19595 post-distortion-corrected image is given by the <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>
19596 field,<wbr/> and the effective maximum field of view for a post-distortion-corrected image
19597 can be calculated by applying the geometric distortion correction fields to this
19598 rectangle,<wbr/> and cropping to the rectangle given in <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19599 <p>E.<wbr/>g.<wbr/> to calculate position of a pixel,<wbr/> (x,<wbr/>y),<wbr/> in a processed YUV output image with the
19600 dimensions in <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> given the position of a pixel,<wbr/>
19601 (x',<wbr/> y'),<wbr/> in the raw pixel array with dimensions give in
19602 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>:</p>
19603 <ol>
19604 <li>Choose a pixel (x',<wbr/> y') within the active array region of the raw buffer given in
19605 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a>,<wbr/> otherwise this pixel is considered
19606 to be outside of the FOV,<wbr/> and will not be shown in the processed output image.<wbr/></li>
19607 <li>Apply geometric distortion correction to get the post-distortion pixel coordinate,<wbr/>
19608 (x_<wbr/>i,<wbr/> y_<wbr/>i).<wbr/> When applying geometric correction metadata,<wbr/> note that metadata for raw
19609 buffers is defined relative to the top,<wbr/> left of the
19610 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> rectangle.<wbr/></li>
19611 <li>If the resulting corrected pixel coordinate is within the region given in
19612 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> then the position of this pixel in the
19613 processed output image buffer is <code>(x_<wbr/>i - activeArray.<wbr/>left,<wbr/> y_<wbr/>i - activeArray.<wbr/>top)</code>,<wbr/>
19614 when the top,<wbr/> left coordinate of that buffer is treated as (0,<wbr/> 0).<wbr/></li>
19615 </ol>
19616 <p>Thus,<wbr/> for pixel x',<wbr/>y' = (25,<wbr/> 25) on a sensor where <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>
19617 is (100,<wbr/>100),<wbr/> <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a> is (10,<wbr/> 10,<wbr/> 100,<wbr/> 100),<wbr/>
19618 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a> is (20,<wbr/> 20,<wbr/> 80,<wbr/> 80),<wbr/> and the geometric distortion
19619 correction doesn't change the pixel coordinate,<wbr/> the resulting pixel selected in
19620 pixel coordinates would be x,<wbr/>y = (25,<wbr/> 25) relative to the top,<wbr/>left of the raw buffer
19621 with dimensions given in <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>,<wbr/> and would be (5,<wbr/> 5)
19622 relative to the top,<wbr/>left of post-processed YUV output buffer with dimensions given in
19623 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19624 <p>The currently supported fields that correct for geometric distortion are:</p>
19625 <ol>
19626 <li><a href="#static_android.lens.radialDistortion">android.<wbr/>lens.<wbr/>radial<wbr/>Distortion</a>.<wbr/></li>
19627 </ol>
19628 <p>If all of the geometric distortion fields are no-ops,<wbr/> this rectangle will be the same
19629 as the post-distortion-corrected rectangle given in
19630 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19631 <p>This rectangle is defined relative to the full pixel array; (0,<wbr/>0) is the top-left of
19632 the full pixel array,<wbr/> and the size of the full pixel array is given by
19633 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19634 <p>The pre-correction active array may be smaller than the full pixel array,<wbr/> since the
19635 full array may include black calibration pixels or other inactive regions.<wbr/></p>
19636             </td>
19637           </tr>
19638
19639           <tr class="entries_header">
19640             <th class="th_details" colspan="5">HAL Implementation Details</th>
19641           </tr>
19642           <tr class="entry_cont">
19643             <td class="entry_details" colspan="5">
19644               <p>This array contains <code>(xmin,<wbr/> ymin,<wbr/> width,<wbr/> height)</code>.<wbr/> The <code>(xmin,<wbr/> ymin)</code> must be
19645 &gt;= <code>(0,<wbr/>0)</code>.<wbr/>
19646 The <code>(width,<wbr/> height)</code> must be &lt;= <code><a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a></code>.<wbr/></p>
19647 <p>If omitted by the HAL implementation,<wbr/> the camera framework will assume that this is
19648 the same as the post-correction active array region given in
19649 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
19650             </td>
19651           </tr>
19652
19653           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19654            <!-- end of entry -->
19655
19656
19657
19658
19659
19660           <tr class="entry" id="static_android.sensor.referenceIlluminant1">
19661             <td class="entry_name
19662              " rowspan="5">
19663               android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1
19664             </td>
19665             <td class="entry_type">
19666                 <span class="entry_type_name entry_type_name_enum">byte</span>
19667
19668               <span class="entry_type_visibility"> [public]</span>
19669
19670
19671
19672
19673
19674                 <ul class="entry_type_enum">
19675                   <li>
19676                     <span class="entry_type_enum_name">DAYLIGHT</span>
19677                     <span class="entry_type_enum_value">1</span>
19678                   </li>
19679                   <li>
19680                     <span class="entry_type_enum_name">FLUORESCENT</span>
19681                     <span class="entry_type_enum_value">2</span>
19682                   </li>
19683                   <li>
19684                     <span class="entry_type_enum_name">TUNGSTEN</span>
19685                     <span class="entry_type_enum_value">3</span>
19686                     <span class="entry_type_enum_notes"><p>Incandescent light</p></span>
19687                   </li>
19688                   <li>
19689                     <span class="entry_type_enum_name">FLASH</span>
19690                     <span class="entry_type_enum_value">4</span>
19691                   </li>
19692                   <li>
19693                     <span class="entry_type_enum_name">FINE_WEATHER</span>
19694                     <span class="entry_type_enum_value">9</span>
19695                   </li>
19696                   <li>
19697                     <span class="entry_type_enum_name">CLOUDY_WEATHER</span>
19698                     <span class="entry_type_enum_value">10</span>
19699                   </li>
19700                   <li>
19701                     <span class="entry_type_enum_name">SHADE</span>
19702                     <span class="entry_type_enum_value">11</span>
19703                   </li>
19704                   <li>
19705                     <span class="entry_type_enum_name">DAYLIGHT_FLUORESCENT</span>
19706                     <span class="entry_type_enum_value">12</span>
19707                     <span class="entry_type_enum_notes"><p>D 5700 - 7100K</p></span>
19708                   </li>
19709                   <li>
19710                     <span class="entry_type_enum_name">DAY_WHITE_FLUORESCENT</span>
19711                     <span class="entry_type_enum_value">13</span>
19712                     <span class="entry_type_enum_notes"><p>N 4600 - 5400K</p></span>
19713                   </li>
19714                   <li>
19715                     <span class="entry_type_enum_name">COOL_WHITE_FLUORESCENT</span>
19716                     <span class="entry_type_enum_value">14</span>
19717                     <span class="entry_type_enum_notes"><p>W 3900 - 4500K</p></span>
19718                   </li>
19719                   <li>
19720                     <span class="entry_type_enum_name">WHITE_FLUORESCENT</span>
19721                     <span class="entry_type_enum_value">15</span>
19722                     <span class="entry_type_enum_notes"><p>WW 3200 - 3700K</p></span>
19723                   </li>
19724                   <li>
19725                     <span class="entry_type_enum_name">STANDARD_A</span>
19726                     <span class="entry_type_enum_value">17</span>
19727                   </li>
19728                   <li>
19729                     <span class="entry_type_enum_name">STANDARD_B</span>
19730                     <span class="entry_type_enum_value">18</span>
19731                   </li>
19732                   <li>
19733                     <span class="entry_type_enum_name">STANDARD_C</span>
19734                     <span class="entry_type_enum_value">19</span>
19735                   </li>
19736                   <li>
19737                     <span class="entry_type_enum_name">D55</span>
19738                     <span class="entry_type_enum_value">20</span>
19739                   </li>
19740                   <li>
19741                     <span class="entry_type_enum_name">D65</span>
19742                     <span class="entry_type_enum_value">21</span>
19743                   </li>
19744                   <li>
19745                     <span class="entry_type_enum_name">D75</span>
19746                     <span class="entry_type_enum_value">22</span>
19747                   </li>
19748                   <li>
19749                     <span class="entry_type_enum_name">D50</span>
19750                     <span class="entry_type_enum_value">23</span>
19751                   </li>
19752                   <li>
19753                     <span class="entry_type_enum_name">ISO_STUDIO_TUNGSTEN</span>
19754                     <span class="entry_type_enum_value">24</span>
19755                   </li>
19756                 </ul>
19757
19758             </td> <!-- entry_type -->
19759
19760             <td class="entry_description">
19761               <p>The standard reference illuminant used as the scene light source when
19762 calculating the <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
19763 <a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
19764 <a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> matrices.<wbr/></p>
19765             </td>
19766
19767             <td class="entry_units">
19768             </td>
19769
19770             <td class="entry_range">
19771             </td>
19772
19773             <td class="entry_tags">
19774               <ul class="entry_tags">
19775                   <li><a href="#tag_RAW">RAW</a></li>
19776               </ul>
19777             </td>
19778
19779           </tr>
19780           <tr class="entries_header">
19781             <th class="th_details" colspan="5">Details</th>
19782           </tr>
19783           <tr class="entry_cont">
19784             <td class="entry_details" colspan="5">
19785               <p>The values in this key correspond to the values defined for the
19786 EXIF LightSource tag.<wbr/> These illuminants are standard light sources
19787 that are often used calibrating camera devices.<wbr/></p>
19788 <p>If this key is present,<wbr/> then <a href="#static_android.sensor.colorTransform1">android.<wbr/>sensor.<wbr/>color<wbr/>Transform1</a>,<wbr/>
19789 <a href="#static_android.sensor.calibrationTransform1">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1</a>,<wbr/> and
19790 <a href="#static_android.sensor.forwardMatrix1">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1</a> will also be present.<wbr/></p>
19791 <p>Some devices may choose to provide a second set of calibration
19792 information for improved quality,<wbr/> including
19793 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> and its corresponding matrices.<wbr/></p>
19794             </td>
19795           </tr>
19796
19797           <tr class="entries_header">
19798             <th class="th_details" colspan="5">HAL Implementation Details</th>
19799           </tr>
19800           <tr class="entry_cont">
19801             <td class="entry_details" colspan="5">
19802               <p>The first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
19803 and corresponding matrices must be present to support the RAW capability
19804 and DNG output.<wbr/></p>
19805 <p>When producing raw images with a color profile that has only been
19806 calibrated against a single light source,<wbr/> it is valid to omit
19807 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> along with the
19808 <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/> <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/>
19809 and <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
19810 <p>If only <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> is included,<wbr/> it should be
19811 chosen so that it is representative of typical scene lighting.<wbr/>  In
19812 general,<wbr/> D50 or DAYLIGHT will be chosen for this case.<wbr/></p>
19813 <p>If both <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> and
19814 <a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a> are included,<wbr/> they should be
19815 chosen to represent the typical range of scene lighting conditions.<wbr/>
19816 In general,<wbr/> low color temperature illuminant such as Standard-A will
19817 be chosen for the first reference illuminant and a higher color
19818 temperature illuminant such as D65 will be chosen for the second
19819 reference illuminant.<wbr/></p>
19820             </td>
19821           </tr>
19822
19823           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19824            <!-- end of entry -->
19825
19826
19827           <tr class="entry" id="static_android.sensor.referenceIlluminant2">
19828             <td class="entry_name
19829              " rowspan="3">
19830               android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2
19831             </td>
19832             <td class="entry_type">
19833                 <span class="entry_type_name">byte</span>
19834
19835               <span class="entry_type_visibility"> [public]</span>
19836
19837
19838
19839
19840
19841
19842             </td> <!-- entry_type -->
19843
19844             <td class="entry_description">
19845               <p>The standard reference illuminant used as the scene light source when
19846 calculating the <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/>
19847 <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/> and
19848 <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> matrices.<wbr/></p>
19849             </td>
19850
19851             <td class="entry_units">
19852             </td>
19853
19854             <td class="entry_range">
19855               <p>Any value listed in <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a></p>
19856             </td>
19857
19858             <td class="entry_tags">
19859               <ul class="entry_tags">
19860                   <li><a href="#tag_RAW">RAW</a></li>
19861               </ul>
19862             </td>
19863
19864           </tr>
19865           <tr class="entries_header">
19866             <th class="th_details" colspan="5">Details</th>
19867           </tr>
19868           <tr class="entry_cont">
19869             <td class="entry_details" colspan="5">
19870               <p>See <a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a> for more details.<wbr/></p>
19871 <p>If this key is present,<wbr/> then <a href="#static_android.sensor.colorTransform2">android.<wbr/>sensor.<wbr/>color<wbr/>Transform2</a>,<wbr/>
19872 <a href="#static_android.sensor.calibrationTransform2">android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2</a>,<wbr/> and
19873 <a href="#static_android.sensor.forwardMatrix2">android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2</a> will also be present.<wbr/></p>
19874             </td>
19875           </tr>
19876
19877
19878           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19879            <!-- end of entry -->
19880
19881
19882           <tr class="entry" id="static_android.sensor.calibrationTransform1">
19883             <td class="entry_name
19884              " rowspan="3">
19885               android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform1
19886             </td>
19887             <td class="entry_type">
19888                 <span class="entry_type_name">rational</span>
19889                 <span class="entry_type_container">x</span>
19890
19891                 <span class="entry_type_array">
19892                   3 x 3
19893                 </span>
19894               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
19895
19896
19897
19898
19899                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
19900
19901
19902             </td> <!-- entry_type -->
19903
19904             <td class="entry_description">
19905               <p>A per-device calibration transform matrix that maps from the
19906 reference sensor colorspace to the actual device sensor colorspace.<wbr/></p>
19907             </td>
19908
19909             <td class="entry_units">
19910             </td>
19911
19912             <td class="entry_range">
19913             </td>
19914
19915             <td class="entry_tags">
19916               <ul class="entry_tags">
19917                   <li><a href="#tag_RAW">RAW</a></li>
19918               </ul>
19919             </td>
19920
19921           </tr>
19922           <tr class="entries_header">
19923             <th class="th_details" colspan="5">Details</th>
19924           </tr>
19925           <tr class="entry_cont">
19926             <td class="entry_details" colspan="5">
19927               <p>This matrix is used to correct for per-device variations in the
19928 sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
19929 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
19930 contains a per-device calibration transform that maps colors
19931 from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
19932 colorspace) into this camera device's native sensor color
19933 space under the first reference illuminant
19934 (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
19935             </td>
19936           </tr>
19937
19938
19939           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
19940            <!-- end of entry -->
19941
19942
19943           <tr class="entry" id="static_android.sensor.calibrationTransform2">
19944             <td class="entry_name
19945              " rowspan="3">
19946               android.<wbr/>sensor.<wbr/>calibration<wbr/>Transform2
19947             </td>
19948             <td class="entry_type">
19949                 <span class="entry_type_name">rational</span>
19950                 <span class="entry_type_container">x</span>
19951
19952                 <span class="entry_type_array">
19953                   3 x 3
19954                 </span>
19955               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
19956
19957
19958
19959
19960                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
19961
19962
19963             </td> <!-- entry_type -->
19964
19965             <td class="entry_description">
19966               <p>A per-device calibration transform matrix that maps from the
19967 reference sensor colorspace to the actual device sensor colorspace
19968 (this is the colorspace of the raw buffer data).<wbr/></p>
19969             </td>
19970
19971             <td class="entry_units">
19972             </td>
19973
19974             <td class="entry_range">
19975             </td>
19976
19977             <td class="entry_tags">
19978               <ul class="entry_tags">
19979                   <li><a href="#tag_RAW">RAW</a></li>
19980               </ul>
19981             </td>
19982
19983           </tr>
19984           <tr class="entries_header">
19985             <th class="th_details" colspan="5">Details</th>
19986           </tr>
19987           <tr class="entry_cont">
19988             <td class="entry_details" colspan="5">
19989               <p>This matrix is used to correct for per-device variations in the
19990 sensor colorspace,<wbr/> and is used for processing raw buffer data.<wbr/></p>
19991 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
19992 contains a per-device calibration transform that maps colors
19993 from reference sensor color space (i.<wbr/>e.<wbr/> the "golden module"
19994 colorspace) into this camera device's native sensor color
19995 space under the second reference illuminant
19996 (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
19997 <p>This matrix will only be present if the second reference
19998 illuminant is present.<wbr/></p>
19999             </td>
20000           </tr>
20001
20002
20003           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20004            <!-- end of entry -->
20005
20006
20007           <tr class="entry" id="static_android.sensor.colorTransform1">
20008             <td class="entry_name
20009              " rowspan="3">
20010               android.<wbr/>sensor.<wbr/>color<wbr/>Transform1
20011             </td>
20012             <td class="entry_type">
20013                 <span class="entry_type_name">rational</span>
20014                 <span class="entry_type_container">x</span>
20015
20016                 <span class="entry_type_array">
20017                   3 x 3
20018                 </span>
20019               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
20020
20021
20022
20023
20024                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
20025
20026
20027             </td> <!-- entry_type -->
20028
20029             <td class="entry_description">
20030               <p>A matrix that transforms color values from CIE XYZ color space to
20031 reference sensor color space.<wbr/></p>
20032             </td>
20033
20034             <td class="entry_units">
20035             </td>
20036
20037             <td class="entry_range">
20038             </td>
20039
20040             <td class="entry_tags">
20041               <ul class="entry_tags">
20042                   <li><a href="#tag_RAW">RAW</a></li>
20043               </ul>
20044             </td>
20045
20046           </tr>
20047           <tr class="entries_header">
20048             <th class="th_details" colspan="5">Details</th>
20049           </tr>
20050           <tr class="entry_cont">
20051             <td class="entry_details" colspan="5">
20052               <p>This matrix is used to convert from the standard CIE XYZ color
20053 space to the reference sensor colorspace,<wbr/> and is used when processing
20054 raw buffer data.<wbr/></p>
20055 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
20056 contains a color transform matrix that maps colors from the CIE
20057 XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
20058 "golden module" colorspace) under the first reference illuminant
20059 (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>).<wbr/></p>
20060 <p>The white points chosen in both the reference sensor color space
20061 and the CIE XYZ colorspace when calculating this transform will
20062 match the standard white point for the first reference illuminant
20063 (i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
20064             </td>
20065           </tr>
20066
20067
20068           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20069            <!-- end of entry -->
20070
20071
20072           <tr class="entry" id="static_android.sensor.colorTransform2">
20073             <td class="entry_name
20074              " rowspan="3">
20075               android.<wbr/>sensor.<wbr/>color<wbr/>Transform2
20076             </td>
20077             <td class="entry_type">
20078                 <span class="entry_type_name">rational</span>
20079                 <span class="entry_type_container">x</span>
20080
20081                 <span class="entry_type_array">
20082                   3 x 3
20083                 </span>
20084               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
20085
20086
20087
20088
20089                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
20090
20091
20092             </td> <!-- entry_type -->
20093
20094             <td class="entry_description">
20095               <p>A matrix that transforms color values from CIE XYZ color space to
20096 reference sensor color space.<wbr/></p>
20097             </td>
20098
20099             <td class="entry_units">
20100             </td>
20101
20102             <td class="entry_range">
20103             </td>
20104
20105             <td class="entry_tags">
20106               <ul class="entry_tags">
20107                   <li><a href="#tag_RAW">RAW</a></li>
20108               </ul>
20109             </td>
20110
20111           </tr>
20112           <tr class="entries_header">
20113             <th class="th_details" colspan="5">Details</th>
20114           </tr>
20115           <tr class="entry_cont">
20116             <td class="entry_details" colspan="5">
20117               <p>This matrix is used to convert from the standard CIE XYZ color
20118 space to the reference sensor colorspace,<wbr/> and is used when processing
20119 raw buffer data.<wbr/></p>
20120 <p>The matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and
20121 contains a color transform matrix that maps colors from the CIE
20122 XYZ color space to the reference sensor color space (i.<wbr/>e.<wbr/> the
20123 "golden module" colorspace) under the second reference illuminant
20124 (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>).<wbr/></p>
20125 <p>The white points chosen in both the reference sensor color space
20126 and the CIE XYZ colorspace when calculating this transform will
20127 match the standard white point for the second reference illuminant
20128 (i.<wbr/>e.<wbr/> no chromatic adaptation will be applied by this transform).<wbr/></p>
20129 <p>This matrix will only be present if the second reference
20130 illuminant is present.<wbr/></p>
20131             </td>
20132           </tr>
20133
20134
20135           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20136            <!-- end of entry -->
20137
20138
20139           <tr class="entry" id="static_android.sensor.forwardMatrix1">
20140             <td class="entry_name
20141              " rowspan="3">
20142               android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix1
20143             </td>
20144             <td class="entry_type">
20145                 <span class="entry_type_name">rational</span>
20146                 <span class="entry_type_container">x</span>
20147
20148                 <span class="entry_type_array">
20149                   3 x 3
20150                 </span>
20151               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
20152
20153
20154
20155
20156                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
20157
20158
20159             </td> <!-- entry_type -->
20160
20161             <td class="entry_description">
20162               <p>A matrix that transforms white balanced camera colors from the reference
20163 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
20164             </td>
20165
20166             <td class="entry_units">
20167             </td>
20168
20169             <td class="entry_range">
20170             </td>
20171
20172             <td class="entry_tags">
20173               <ul class="entry_tags">
20174                   <li><a href="#tag_RAW">RAW</a></li>
20175               </ul>
20176             </td>
20177
20178           </tr>
20179           <tr class="entries_header">
20180             <th class="th_details" colspan="5">Details</th>
20181           </tr>
20182           <tr class="entry_cont">
20183             <td class="entry_details" colspan="5">
20184               <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
20185 is used when processing raw buffer data.<wbr/></p>
20186 <p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
20187 a color transform matrix that maps white balanced colors from the
20188 reference sensor color space to the CIE XYZ color space with a D50 white
20189 point.<wbr/></p>
20190 <p>Under the first reference illuminant (<a href="#static_android.sensor.referenceIlluminant1">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant1</a>)
20191 this matrix is chosen so that the standard white point for this reference
20192 illuminant in the reference sensor colorspace is mapped to D50 in the
20193 CIE XYZ colorspace.<wbr/></p>
20194             </td>
20195           </tr>
20196
20197
20198           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20199            <!-- end of entry -->
20200
20201
20202           <tr class="entry" id="static_android.sensor.forwardMatrix2">
20203             <td class="entry_name
20204              " rowspan="3">
20205               android.<wbr/>sensor.<wbr/>forward<wbr/>Matrix2
20206             </td>
20207             <td class="entry_type">
20208                 <span class="entry_type_name">rational</span>
20209                 <span class="entry_type_container">x</span>
20210
20211                 <span class="entry_type_array">
20212                   3 x 3
20213                 </span>
20214               <span class="entry_type_visibility"> [public as colorSpaceTransform]</span>
20215
20216
20217
20218
20219                 <div class="entry_type_notes">3x3 matrix in row-major-order</div>
20220
20221
20222             </td> <!-- entry_type -->
20223
20224             <td class="entry_description">
20225               <p>A matrix that transforms white balanced camera colors from the reference
20226 sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.<wbr/></p>
20227             </td>
20228
20229             <td class="entry_units">
20230             </td>
20231
20232             <td class="entry_range">
20233             </td>
20234
20235             <td class="entry_tags">
20236               <ul class="entry_tags">
20237                   <li><a href="#tag_RAW">RAW</a></li>
20238               </ul>
20239             </td>
20240
20241           </tr>
20242           <tr class="entries_header">
20243             <th class="th_details" colspan="5">Details</th>
20244           </tr>
20245           <tr class="entry_cont">
20246             <td class="entry_details" colspan="5">
20247               <p>This matrix is used to convert to the standard CIE XYZ colorspace,<wbr/> and
20248 is used when processing raw buffer data.<wbr/></p>
20249 <p>This matrix is expressed as a 3x3 matrix in row-major-order,<wbr/> and contains
20250 a color transform matrix that maps white balanced colors from the
20251 reference sensor color space to the CIE XYZ color space with a D50 white
20252 point.<wbr/></p>
20253 <p>Under the second reference illuminant (<a href="#static_android.sensor.referenceIlluminant2">android.<wbr/>sensor.<wbr/>reference<wbr/>Illuminant2</a>)
20254 this matrix is chosen so that the standard white point for this reference
20255 illuminant in the reference sensor colorspace is mapped to D50 in the
20256 CIE XYZ colorspace.<wbr/></p>
20257 <p>This matrix will only be present if the second reference
20258 illuminant is present.<wbr/></p>
20259             </td>
20260           </tr>
20261
20262
20263           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20264            <!-- end of entry -->
20265
20266
20267           <tr class="entry" id="static_android.sensor.baseGainFactor">
20268             <td class="entry_name
20269              " rowspan="1">
20270               android.<wbr/>sensor.<wbr/>base<wbr/>Gain<wbr/>Factor
20271             </td>
20272             <td class="entry_type">
20273                 <span class="entry_type_name">rational</span>
20274
20275               <span class="entry_type_visibility"> [system]</span>
20276
20277
20278
20279
20280
20281
20282             </td> <!-- entry_type -->
20283
20284             <td class="entry_description">
20285               <p>Gain factor from electrons to raw units when
20286 ISO=100</p>
20287             </td>
20288
20289             <td class="entry_units">
20290             </td>
20291
20292             <td class="entry_range">
20293             </td>
20294
20295             <td class="entry_tags">
20296               <ul class="entry_tags">
20297                   <li><a href="#tag_FUTURE">FUTURE</a></li>
20298               </ul>
20299             </td>
20300
20301           </tr>
20302
20303
20304           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20305            <!-- end of entry -->
20306
20307
20308           <tr class="entry" id="static_android.sensor.blackLevelPattern">
20309             <td class="entry_name
20310              " rowspan="5">
20311               android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern
20312             </td>
20313             <td class="entry_type">
20314                 <span class="entry_type_name">int32</span>
20315                 <span class="entry_type_container">x</span>
20316
20317                 <span class="entry_type_array">
20318                   4
20319                 </span>
20320               <span class="entry_type_visibility"> [public as blackLevelPattern]</span>
20321
20322
20323
20324
20325                 <div class="entry_type_notes">2x2 raw count block</div>
20326
20327
20328             </td> <!-- entry_type -->
20329
20330             <td class="entry_description">
20331               <p>A fixed black level offset for each of the color filter arrangement
20332 (CFA) mosaic channels.<wbr/></p>
20333             </td>
20334
20335             <td class="entry_units">
20336             </td>
20337
20338             <td class="entry_range">
20339               <p>&gt;= 0 for each.<wbr/></p>
20340             </td>
20341
20342             <td class="entry_tags">
20343               <ul class="entry_tags">
20344                   <li><a href="#tag_RAW">RAW</a></li>
20345               </ul>
20346             </td>
20347
20348           </tr>
20349           <tr class="entries_header">
20350             <th class="th_details" colspan="5">Details</th>
20351           </tr>
20352           <tr class="entry_cont">
20353             <td class="entry_details" colspan="5">
20354               <p>This key specifies the zero light value for each of the CFA mosaic
20355 channels in the camera sensor.<wbr/>  The maximal value output by the
20356 sensor is represented by the value in <a href="#static_android.sensor.info.whiteLevel">android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level</a>.<wbr/></p>
20357 <p>The values are given in the same order as channels listed for the CFA
20358 layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>),<wbr/> i.<wbr/>e.<wbr/> the
20359 nth value given corresponds to the black level offset for the nth
20360 color channel listed in the CFA.<wbr/></p>
20361 <p>The black level values of captured images may vary for different
20362 capture settings (e.<wbr/>g.,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>).<wbr/> This key
20363 represents a coarse approximation for such case.<wbr/> It is recommended to
20364 use <a href="#dynamic_android.sensor.dynamicBlackLevel">android.<wbr/>sensor.<wbr/>dynamic<wbr/>Black<wbr/>Level</a> or use pixels from
20365 <a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a> directly for captures when
20366 supported by the camera device,<wbr/> which provides more accurate black
20367 level values.<wbr/> For raw capture in particular,<wbr/> it is recommended to use
20368 pixels from <a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a> to calculate black
20369 level values for each frame.<wbr/></p>
20370             </td>
20371           </tr>
20372
20373           <tr class="entries_header">
20374             <th class="th_details" colspan="5">HAL Implementation Details</th>
20375           </tr>
20376           <tr class="entry_cont">
20377             <td class="entry_details" colspan="5">
20378               <p>The values are given in row-column scan order,<wbr/> with the first value
20379 corresponding to the element of the CFA in row=0,<wbr/> column=0.<wbr/></p>
20380             </td>
20381           </tr>
20382
20383           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20384            <!-- end of entry -->
20385
20386
20387           <tr class="entry" id="static_android.sensor.maxAnalogSensitivity">
20388             <td class="entry_name
20389              " rowspan="3">
20390               android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity
20391             </td>
20392             <td class="entry_type">
20393                 <span class="entry_type_name">int32</span>
20394
20395               <span class="entry_type_visibility"> [public]</span>
20396
20397
20398               <span class="entry_type_hwlevel">[full] </span>
20399
20400
20401
20402
20403             </td> <!-- entry_type -->
20404
20405             <td class="entry_description">
20406               <p>Maximum sensitivity that is implemented
20407 purely through analog gain.<wbr/></p>
20408             </td>
20409
20410             <td class="entry_units">
20411             </td>
20412
20413             <td class="entry_range">
20414             </td>
20415
20416             <td class="entry_tags">
20417               <ul class="entry_tags">
20418                   <li><a href="#tag_V1">V1</a></li>
20419                   <li><a href="#tag_FULL">FULL</a></li>
20420               </ul>
20421             </td>
20422
20423           </tr>
20424           <tr class="entries_header">
20425             <th class="th_details" colspan="5">Details</th>
20426           </tr>
20427           <tr class="entry_cont">
20428             <td class="entry_details" colspan="5">
20429               <p>For <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a> values less than or
20430 equal to this,<wbr/> all applied gain must be analog.<wbr/> For
20431 values above this,<wbr/> the gain applied can be a mix of analog and
20432 digital.<wbr/></p>
20433             </td>
20434           </tr>
20435
20436
20437           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20438            <!-- end of entry -->
20439
20440
20441           <tr class="entry" id="static_android.sensor.orientation">
20442             <td class="entry_name
20443              " rowspan="3">
20444               android.<wbr/>sensor.<wbr/>orientation
20445             </td>
20446             <td class="entry_type">
20447                 <span class="entry_type_name">int32</span>
20448
20449               <span class="entry_type_visibility"> [public]</span>
20450
20451
20452               <span class="entry_type_hwlevel">[legacy] </span>
20453
20454
20455
20456
20457             </td> <!-- entry_type -->
20458
20459             <td class="entry_description">
20460               <p>Clockwise angle through which the output image needs to be rotated to be
20461 upright on the device screen in its native orientation.<wbr/></p>
20462             </td>
20463
20464             <td class="entry_units">
20465               Degrees of clockwise rotation; always a multiple of
20466           90
20467             </td>
20468
20469             <td class="entry_range">
20470               <p>0,<wbr/> 90,<wbr/> 180,<wbr/> 270</p>
20471             </td>
20472
20473             <td class="entry_tags">
20474               <ul class="entry_tags">
20475                   <li><a href="#tag_BC">BC</a></li>
20476               </ul>
20477             </td>
20478
20479           </tr>
20480           <tr class="entries_header">
20481             <th class="th_details" colspan="5">Details</th>
20482           </tr>
20483           <tr class="entry_cont">
20484             <td class="entry_details" colspan="5">
20485               <p>Also defines the direction of rolling shutter readout,<wbr/> which is from top to bottom in
20486 the sensor's coordinate system.<wbr/></p>
20487             </td>
20488           </tr>
20489
20490
20491           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20492            <!-- end of entry -->
20493
20494
20495           <tr class="entry" id="static_android.sensor.profileHueSatMapDimensions">
20496             <td class="entry_name
20497              " rowspan="3">
20498               android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions
20499             </td>
20500             <td class="entry_type">
20501                 <span class="entry_type_name">int32</span>
20502                 <span class="entry_type_container">x</span>
20503
20504                 <span class="entry_type_array">
20505                   3
20506                 </span>
20507               <span class="entry_type_visibility"> [system]</span>
20508
20509
20510
20511
20512                 <div class="entry_type_notes">Number of samples for hue,<wbr/> saturation,<wbr/> and value</div>
20513
20514
20515             </td> <!-- entry_type -->
20516
20517             <td class="entry_description">
20518               <p>The number of input samples for each dimension of
20519 <a href="#dynamic_android.sensor.profileHueSatMap">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map</a>.<wbr/></p>
20520             </td>
20521
20522             <td class="entry_units">
20523             </td>
20524
20525             <td class="entry_range">
20526               <p>Hue &gt;= 1,<wbr/>
20527 Saturation &gt;= 2,<wbr/>
20528 Value &gt;= 1</p>
20529             </td>
20530
20531             <td class="entry_tags">
20532               <ul class="entry_tags">
20533                   <li><a href="#tag_RAW">RAW</a></li>
20534               </ul>
20535             </td>
20536
20537           </tr>
20538           <tr class="entries_header">
20539             <th class="th_details" colspan="5">Details</th>
20540           </tr>
20541           <tr class="entry_cont">
20542             <td class="entry_details" colspan="5">
20543               <p>The number of input samples for the hue,<wbr/> saturation,<wbr/> and value
20544 dimension of <a href="#dynamic_android.sensor.profileHueSatMap">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map</a>.<wbr/> The order of the
20545 dimensions given is hue,<wbr/> saturation,<wbr/> value; where hue is the 0th
20546 element.<wbr/></p>
20547             </td>
20548           </tr>
20549
20550
20551           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20552            <!-- end of entry -->
20553
20554
20555           <tr class="entry" id="static_android.sensor.availableTestPatternModes">
20556             <td class="entry_name
20557              " rowspan="5">
20558               android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes
20559             </td>
20560             <td class="entry_type">
20561                 <span class="entry_type_name">int32</span>
20562                 <span class="entry_type_container">x</span>
20563
20564                 <span class="entry_type_array">
20565                   n
20566                 </span>
20567               <span class="entry_type_visibility"> [public]</span>
20568
20569
20570
20571
20572                 <div class="entry_type_notes">list of enums</div>
20573
20574
20575             </td> <!-- entry_type -->
20576
20577             <td class="entry_description">
20578               <p>List of sensor test pattern modes for <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a>
20579 supported by this camera device.<wbr/></p>
20580             </td>
20581
20582             <td class="entry_units">
20583             </td>
20584
20585             <td class="entry_range">
20586               <p>Any value listed in <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a></p>
20587             </td>
20588
20589             <td class="entry_tags">
20590             </td>
20591
20592           </tr>
20593           <tr class="entries_header">
20594             <th class="th_details" colspan="5">Details</th>
20595           </tr>
20596           <tr class="entry_cont">
20597             <td class="entry_details" colspan="5">
20598               <p>Defaults to OFF,<wbr/> and always includes OFF if defined.<wbr/></p>
20599             </td>
20600           </tr>
20601
20602           <tr class="entries_header">
20603             <th class="th_details" colspan="5">HAL Implementation Details</th>
20604           </tr>
20605           <tr class="entry_cont">
20606             <td class="entry_details" colspan="5">
20607               <p>All custom modes must be &gt;= CUSTOM1.<wbr/></p>
20608             </td>
20609           </tr>
20610
20611           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20612            <!-- end of entry -->
20613
20614
20615           <tr class="entry" id="static_android.sensor.opticalBlackRegions">
20616             <td class="entry_name
20617              " rowspan="5">
20618               android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions
20619             </td>
20620             <td class="entry_type">
20621                 <span class="entry_type_name">int32</span>
20622                 <span class="entry_type_container">x</span>
20623
20624                 <span class="entry_type_array">
20625                   4 x num_regions
20626                 </span>
20627               <span class="entry_type_visibility"> [public as rectangle]</span>
20628
20629
20630
20631
20632
20633
20634             </td> <!-- entry_type -->
20635
20636             <td class="entry_description">
20637               <p>List of disjoint rectangles indicating the sensor
20638 optically shielded black pixel regions.<wbr/></p>
20639             </td>
20640
20641             <td class="entry_units">
20642             </td>
20643
20644             <td class="entry_range">
20645             </td>
20646
20647             <td class="entry_tags">
20648             </td>
20649
20650           </tr>
20651           <tr class="entries_header">
20652             <th class="th_details" colspan="5">Details</th>
20653           </tr>
20654           <tr class="entry_cont">
20655             <td class="entry_details" colspan="5">
20656               <p>In most camera sensors,<wbr/> the active array is surrounded by some
20657 optically shielded pixel areas.<wbr/> By blocking light,<wbr/> these pixels
20658 provides a reliable black reference for black level compensation
20659 in active array region.<wbr/></p>
20660 <p>This key provides a list of disjoint rectangles specifying the
20661 regions of optically shielded (with metal shield) black pixel
20662 regions if the camera device is capable of reading out these black
20663 pixels in the output raw images.<wbr/> In comparison to the fixed black
20664 level values reported by <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a>,<wbr/> this key
20665 may provide a more accurate way for the application to calculate
20666 black level of each captured raw images.<wbr/></p>
20667 <p>When this key is reported,<wbr/> the <a href="#dynamic_android.sensor.dynamicBlackLevel">android.<wbr/>sensor.<wbr/>dynamic<wbr/>Black<wbr/>Level</a> and
20668 <a href="#dynamic_android.sensor.dynamicWhiteLevel">android.<wbr/>sensor.<wbr/>dynamic<wbr/>White<wbr/>Level</a> will also be reported.<wbr/></p>
20669             </td>
20670           </tr>
20671
20672           <tr class="entries_header">
20673             <th class="th_details" colspan="5">HAL Implementation Details</th>
20674           </tr>
20675           <tr class="entry_cont">
20676             <td class="entry_details" colspan="5">
20677               <p>This array contains (xmin,<wbr/> ymin,<wbr/> width,<wbr/> height).<wbr/> The (xmin,<wbr/> ymin)
20678 must be &gt;= (0,<wbr/>0) and &lt;=
20679 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/> The (width,<wbr/> height) must be
20680 &lt;= <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/> Each region must be
20681 outside the region reported by
20682 <a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pre<wbr/>Correction<wbr/>Active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
20683 <p>The HAL must report minimal number of disjoint regions for the
20684 optically shielded back pixel regions.<wbr/> For example,<wbr/> if a region can
20685 be covered by one rectangle,<wbr/> the HAL must not split this region into
20686 multiple rectangles.<wbr/></p>
20687             </td>
20688           </tr>
20689
20690           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20691            <!-- end of entry -->
20692
20693
20694           <tr class="entry" id="static_android.sensor.opaqueRawSize">
20695             <td class="entry_name
20696              " rowspan="5">
20697               android.<wbr/>sensor.<wbr/>opaque<wbr/>Raw<wbr/>Size
20698             </td>
20699             <td class="entry_type">
20700                 <span class="entry_type_name">int32</span>
20701                 <span class="entry_type_container">x</span>
20702
20703                 <span class="entry_type_array">
20704                   n x 3
20705                 </span>
20706               <span class="entry_type_visibility"> [system]</span>
20707
20708
20709
20710
20711
20712
20713             </td> <!-- entry_type -->
20714
20715             <td class="entry_description">
20716               <p>Size in bytes for all the listed opaque RAW buffer sizes</p>
20717             </td>
20718
20719             <td class="entry_units">
20720             </td>
20721
20722             <td class="entry_range">
20723               <p>Must be large enough to fit the opaque RAW of corresponding size produced by
20724 the camera</p>
20725             </td>
20726
20727             <td class="entry_tags">
20728             </td>
20729
20730           </tr>
20731           <tr class="entries_header">
20732             <th class="th_details" colspan="5">Details</th>
20733           </tr>
20734           <tr class="entry_cont">
20735             <td class="entry_details" colspan="5">
20736               <p>This configurations are listed as <code>(width,<wbr/> height,<wbr/> size_<wbr/>in_<wbr/>bytes)</code> tuples.<wbr/>
20737 This is used for sizing the gralloc buffers for opaque RAW buffers.<wbr/>
20738 All RAW_<wbr/>OPAQUE output stream configuration listed in
20739 <a href="#static_android.scaler.availableStreamConfigurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stream<wbr/>Configurations</a> will have a corresponding tuple in
20740 this key.<wbr/></p>
20741             </td>
20742           </tr>
20743
20744           <tr class="entries_header">
20745             <th class="th_details" colspan="5">HAL Implementation Details</th>
20746           </tr>
20747           <tr class="entry_cont">
20748             <td class="entry_details" colspan="5">
20749               <p>This key is added in HAL3.<wbr/>4.<wbr/>
20750 For HAL3.<wbr/>4 or above: devices advertising RAW_<wbr/>OPAQUE format output must list this key.<wbr/>
20751 For HAL3.<wbr/>3 or earlier devices: if RAW_<wbr/>OPAQUE ouput is advertised,<wbr/> camera framework
20752 will derive this key by assuming each pixel takes two bytes and no padding bytes
20753 between rows.<wbr/></p>
20754             </td>
20755           </tr>
20756
20757           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20758            <!-- end of entry -->
20759
20760
20761
20762       <!-- end of kind -->
20763       </tbody>
20764       <tr><td colspan="6" class="kind">dynamic</td></tr>
20765
20766       <thead class="entries_header">
20767         <tr>
20768           <th class="th_name">Property Name</th>
20769           <th class="th_type">Type</th>
20770           <th class="th_description">Description</th>
20771           <th class="th_units">Units</th>
20772           <th class="th_range">Range</th>
20773           <th class="th_tags">Tags</th>
20774         </tr>
20775       </thead>
20776
20777       <tbody>
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788           <tr class="entry" id="dynamic_android.sensor.exposureTime">
20789             <td class="entry_name
20790              " rowspan="3">
20791               android.<wbr/>sensor.<wbr/>exposure<wbr/>Time
20792             </td>
20793             <td class="entry_type">
20794                 <span class="entry_type_name">int64</span>
20795
20796               <span class="entry_type_visibility"> [public]</span>
20797
20798
20799               <span class="entry_type_hwlevel">[full] </span>
20800
20801
20802
20803
20804             </td> <!-- entry_type -->
20805
20806             <td class="entry_description">
20807               <p>Duration each pixel is exposed to
20808 light.<wbr/></p>
20809             </td>
20810
20811             <td class="entry_units">
20812               Nanoseconds
20813             </td>
20814
20815             <td class="entry_range">
20816               <p><a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></p>
20817             </td>
20818
20819             <td class="entry_tags">
20820               <ul class="entry_tags">
20821                   <li><a href="#tag_V1">V1</a></li>
20822               </ul>
20823             </td>
20824
20825           </tr>
20826           <tr class="entries_header">
20827             <th class="th_details" colspan="5">Details</th>
20828           </tr>
20829           <tr class="entry_cont">
20830             <td class="entry_details" colspan="5">
20831               <p>If the sensor can't expose this exact duration,<wbr/> it will shorten the
20832 duration exposed to the nearest possible value (rather than expose longer).<wbr/>
20833 The final exposure time used will be available in the output capture result.<wbr/></p>
20834 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
20835 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
20836             </td>
20837           </tr>
20838
20839
20840           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20841            <!-- end of entry -->
20842
20843
20844           <tr class="entry" id="dynamic_android.sensor.frameDuration">
20845             <td class="entry_name
20846              " rowspan="5">
20847               android.<wbr/>sensor.<wbr/>frame<wbr/>Duration
20848             </td>
20849             <td class="entry_type">
20850                 <span class="entry_type_name">int64</span>
20851
20852               <span class="entry_type_visibility"> [public]</span>
20853
20854
20855               <span class="entry_type_hwlevel">[full] </span>
20856
20857
20858
20859
20860             </td> <!-- entry_type -->
20861
20862             <td class="entry_description">
20863               <p>Duration from start of frame exposure to
20864 start of next frame exposure.<wbr/></p>
20865             </td>
20866
20867             <td class="entry_units">
20868               Nanoseconds
20869             </td>
20870
20871             <td class="entry_range">
20872               <p>See <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a>,<wbr/>
20873 <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a>.<wbr/> The duration
20874 is capped to <code>max(duration,<wbr/> exposureTime + overhead)</code>.<wbr/></p>
20875             </td>
20876
20877             <td class="entry_tags">
20878               <ul class="entry_tags">
20879                   <li><a href="#tag_V1">V1</a></li>
20880               </ul>
20881             </td>
20882
20883           </tr>
20884           <tr class="entries_header">
20885             <th class="th_details" colspan="5">Details</th>
20886           </tr>
20887           <tr class="entry_cont">
20888             <td class="entry_details" colspan="5">
20889               <p>The maximum frame rate that can be supported by a camera subsystem is
20890 a function of many factors:</p>
20891 <ul>
20892 <li>Requested resolutions of output image streams</li>
20893 <li>Availability of binning /<wbr/> skipping modes on the imager</li>
20894 <li>The bandwidth of the imager interface</li>
20895 <li>The bandwidth of the various ISP processing blocks</li>
20896 </ul>
20897 <p>Since these factors can vary greatly between different ISPs and
20898 sensors,<wbr/> the camera abstraction tries to represent the bandwidth
20899 restrictions with as simple a model as possible.<wbr/></p>
20900 <p>The model presented has the following characteristics:</p>
20901 <ul>
20902 <li>The image sensor is always configured to output the smallest
20903 resolution possible given the application's requested output stream
20904 sizes.<wbr/>  The smallest resolution is defined as being at least as large
20905 as the largest requested output stream size; the camera pipeline must
20906 never digitally upsample sensor data when the crop region covers the
20907 whole sensor.<wbr/> In general,<wbr/> this means that if only small output stream
20908 resolutions are configured,<wbr/> the sensor can provide a higher frame
20909 rate.<wbr/></li>
20910 <li>Since any request may use any or all the currently configured
20911 output streams,<wbr/> the sensor and ISP must be configured to support
20912 scaling a single capture to all the streams at the same time.<wbr/>  This
20913 means the camera pipeline must be ready to produce the largest
20914 requested output size without any delay.<wbr/>  Therefore,<wbr/> the overall
20915 frame rate of a given configured stream set is governed only by the
20916 largest requested stream resolution.<wbr/></li>
20917 <li>Using more than one output stream in a request does not affect the
20918 frame duration.<wbr/></li>
20919 <li>Certain format-streams may need to do additional background processing
20920 before data is consumed/<wbr/>produced by that stream.<wbr/> These processors
20921 can run concurrently to the rest of the camera pipeline,<wbr/> but
20922 cannot process more than 1 capture at a time.<wbr/></li>
20923 </ul>
20924 <p>The necessary information for the application,<wbr/> given the model above,<wbr/>
20925 is provided via the <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> field using
20926 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.<wbr/>
20927 These are used to determine the maximum frame rate /<wbr/> minimum frame
20928 duration that is possible for a given stream configuration.<wbr/></p>
20929 <p>Specifically,<wbr/> the application can use the following rules to
20930 determine the minimum frame duration it can request from the camera
20931 device:</p>
20932 <ol>
20933 <li>Let the set of currently configured input/<wbr/>output streams
20934 be called <code>S</code>.<wbr/></li>
20935 <li>Find the minimum frame durations for each stream in <code>S</code>,<wbr/> by looking
20936 it up in <a href="#static_android.scaler.streamConfigurationMap">android.<wbr/>scaler.<wbr/>stream<wbr/>Configuration<wbr/>Map</a> using <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>
20937 (with its respective size/<wbr/>format).<wbr/> Let this set of frame durations be
20938 called <code>F</code>.<wbr/></li>
20939 <li>For any given request <code>R</code>,<wbr/> the minimum frame duration allowed
20940 for <code>R</code> is the maximum out of all values in <code>F</code>.<wbr/> Let the streams
20941 used in <code>R</code> be called <code>S_<wbr/>r</code>.<wbr/></li>
20942 </ol>
20943 <p>If none of the streams in <code>S_<wbr/>r</code> have a stall time (listed in <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>
20944 using its respective size/<wbr/>format),<wbr/> then the frame duration in <code>F</code>
20945 determines the steady state frame rate that the application will get
20946 if it uses <code>R</code> as a repeating request.<wbr/> Let this special kind of
20947 request be called <code>Rsimple</code>.<wbr/></p>
20948 <p>A repeating request <code>Rsimple</code> can be <em>occasionally</em> interleaved
20949 by a single capture of a new request <code>Rstall</code> (which has at least
20950 one in-use stream with a non-0 stall time) and if <code>Rstall</code> has the
20951 same minimum frame duration this will not cause a frame rate loss
20952 if all buffers from the previous <code>Rstall</code> have already been
20953 delivered.<wbr/></p>
20954 <p>For more details about stalling,<wbr/> see
20955 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputStallDuration">StreamConfigurationMap#getOutputStallDuration</a>.<wbr/></p>
20956 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
20957 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
20958             </td>
20959           </tr>
20960
20961           <tr class="entries_header">
20962             <th class="th_details" colspan="5">HAL Implementation Details</th>
20963           </tr>
20964           <tr class="entry_cont">
20965             <td class="entry_details" colspan="5">
20966               <p>For more details about stalling,<wbr/> see
20967 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a>.<wbr/></p>
20968             </td>
20969           </tr>
20970
20971           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
20972            <!-- end of entry -->
20973
20974
20975           <tr class="entry" id="dynamic_android.sensor.sensitivity">
20976             <td class="entry_name
20977              " rowspan="5">
20978               android.<wbr/>sensor.<wbr/>sensitivity
20979             </td>
20980             <td class="entry_type">
20981                 <span class="entry_type_name">int32</span>
20982
20983               <span class="entry_type_visibility"> [public]</span>
20984
20985
20986               <span class="entry_type_hwlevel">[full] </span>
20987
20988
20989
20990
20991             </td> <!-- entry_type -->
20992
20993             <td class="entry_description">
20994               <p>The amount of gain applied to sensor data
20995 before processing.<wbr/></p>
20996             </td>
20997
20998             <td class="entry_units">
20999               ISO arithmetic units
21000             </td>
21001
21002             <td class="entry_range">
21003               <p><a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a></p>
21004             </td>
21005
21006             <td class="entry_tags">
21007               <ul class="entry_tags">
21008                   <li><a href="#tag_V1">V1</a></li>
21009               </ul>
21010             </td>
21011
21012           </tr>
21013           <tr class="entries_header">
21014             <th class="th_details" colspan="5">Details</th>
21015           </tr>
21016           <tr class="entry_cont">
21017             <td class="entry_details" colspan="5">
21018               <p>The sensitivity is the standard ISO sensitivity value,<wbr/>
21019 as defined in ISO 12232:2006.<wbr/></p>
21020 <p>The sensitivity must be within <a href="#static_android.sensor.info.sensitivityRange">android.<wbr/>sensor.<wbr/>info.<wbr/>sensitivity<wbr/>Range</a>,<wbr/> and
21021 if if it less than <a href="#static_android.sensor.maxAnalogSensitivity">android.<wbr/>sensor.<wbr/>max<wbr/>Analog<wbr/>Sensitivity</a>,<wbr/> the camera device
21022 is guaranteed to use only analog amplification for applying the gain.<wbr/></p>
21023 <p>If the camera device cannot apply the exact sensitivity
21024 requested,<wbr/> it will reduce the gain to the nearest supported
21025 value.<wbr/> The final sensitivity used will be available in the
21026 output capture result.<wbr/></p>
21027 <p>This control is only effective if <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> or <a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> is set to
21028 OFF; otherwise the auto-exposure algorithm will override this value.<wbr/></p>
21029             </td>
21030           </tr>
21031
21032           <tr class="entries_header">
21033             <th class="th_details" colspan="5">HAL Implementation Details</th>
21034           </tr>
21035           <tr class="entry_cont">
21036             <td class="entry_details" colspan="5">
21037               <p>ISO 12232:2006 REI method is acceptable.<wbr/></p>
21038             </td>
21039           </tr>
21040
21041           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21042            <!-- end of entry -->
21043
21044
21045           <tr class="entry" id="dynamic_android.sensor.timestamp">
21046             <td class="entry_name
21047              " rowspan="5">
21048               android.<wbr/>sensor.<wbr/>timestamp
21049             </td>
21050             <td class="entry_type">
21051                 <span class="entry_type_name">int64</span>
21052
21053               <span class="entry_type_visibility"> [public]</span>
21054
21055
21056               <span class="entry_type_hwlevel">[legacy] </span>
21057
21058
21059
21060
21061             </td> <!-- entry_type -->
21062
21063             <td class="entry_description">
21064               <p>Time at start of exposure of first
21065 row of the image sensor active array,<wbr/> in nanoseconds.<wbr/></p>
21066             </td>
21067
21068             <td class="entry_units">
21069               Nanoseconds
21070             </td>
21071
21072             <td class="entry_range">
21073               <p>&gt; 0</p>
21074             </td>
21075
21076             <td class="entry_tags">
21077               <ul class="entry_tags">
21078                   <li><a href="#tag_BC">BC</a></li>
21079               </ul>
21080             </td>
21081
21082           </tr>
21083           <tr class="entries_header">
21084             <th class="th_details" colspan="5">Details</th>
21085           </tr>
21086           <tr class="entry_cont">
21087             <td class="entry_details" colspan="5">
21088               <p>The timestamps are also included in all image
21089 buffers produced for the same capture,<wbr/> and will be identical
21090 on all the outputs.<wbr/></p>
21091 <p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> UNKNOWN,<wbr/>
21092 the timestamps measure time since an unspecified starting point,<wbr/>
21093 and are monotonically increasing.<wbr/> They can be compared with the
21094 timestamps for other captures from the same camera device,<wbr/> but are
21095 not guaranteed to be comparable to any other time source.<wbr/></p>
21096 <p>When <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/> the
21097 timestamps measure time in the same timebase as <a href="https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtimeNanos">SystemClock#elapsedRealtimeNanos</a>,<wbr/> and they can
21098 be compared to other timestamps from other subsystems that
21099 are using that base.<wbr/></p>
21100 <p>For reprocessing,<wbr/> the timestamp will match the start of exposure of
21101 the input image,<wbr/> i.<wbr/>e.<wbr/> <a href="https://developer.android.com/reference/CaptureResult.html#SENSOR_TIMESTAMP">the
21102 timestamp</a> in the TotalCaptureResult that was used to create the
21103 reprocess capture request.<wbr/></p>
21104             </td>
21105           </tr>
21106
21107           <tr class="entries_header">
21108             <th class="th_details" colspan="5">HAL Implementation Details</th>
21109           </tr>
21110           <tr class="entry_cont">
21111             <td class="entry_details" colspan="5">
21112               <p>All timestamps must be in reference to the kernel's
21113 CLOCK_<wbr/>BOOTTIME monotonic clock,<wbr/> which properly accounts for
21114 time spent asleep.<wbr/> This allows for synchronization with
21115 sensors that continue to operate while the system is
21116 otherwise asleep.<wbr/></p>
21117 <p>If <a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME,<wbr/>
21118 The timestamp must be synchronized with the timestamps from other
21119 sensor subsystems that are using the same timebase.<wbr/></p>
21120 <p>For reprocessing,<wbr/> the input image's start of exposure can be looked up
21121 with <a href="#dynamic_android.sensor.timestamp">android.<wbr/>sensor.<wbr/>timestamp</a> from the metadata included in the
21122 capture request.<wbr/></p>
21123             </td>
21124           </tr>
21125
21126           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21127            <!-- end of entry -->
21128
21129
21130           <tr class="entry" id="dynamic_android.sensor.temperature">
21131             <td class="entry_name
21132              " rowspan="1">
21133               android.<wbr/>sensor.<wbr/>temperature
21134             </td>
21135             <td class="entry_type">
21136                 <span class="entry_type_name">float</span>
21137
21138               <span class="entry_type_visibility"> [system]</span>
21139
21140
21141
21142
21143
21144
21145             </td> <!-- entry_type -->
21146
21147             <td class="entry_description">
21148               <p>The temperature of the sensor,<wbr/> sampled at the time
21149 exposure began for this frame.<wbr/></p>
21150 <p>The thermal diode being queried should be inside the sensor PCB,<wbr/> or
21151 somewhere close to it.<wbr/></p>
21152             </td>
21153
21154             <td class="entry_units">
21155               Celsius
21156             </td>
21157
21158             <td class="entry_range">
21159               <p>Optional.<wbr/> This value is missing if no temperature is available.<wbr/></p>
21160             </td>
21161
21162             <td class="entry_tags">
21163               <ul class="entry_tags">
21164                   <li><a href="#tag_FUTURE">FUTURE</a></li>
21165               </ul>
21166             </td>
21167
21168           </tr>
21169
21170
21171           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21172            <!-- end of entry -->
21173
21174
21175           <tr class="entry" id="dynamic_android.sensor.neutralColorPoint">
21176             <td class="entry_name
21177              " rowspan="3">
21178               android.<wbr/>sensor.<wbr/>neutral<wbr/>Color<wbr/>Point
21179             </td>
21180             <td class="entry_type">
21181                 <span class="entry_type_name">rational</span>
21182                 <span class="entry_type_container">x</span>
21183
21184                 <span class="entry_type_array">
21185                   3
21186                 </span>
21187               <span class="entry_type_visibility"> [public]</span>
21188
21189
21190
21191
21192
21193
21194             </td> <!-- entry_type -->
21195
21196             <td class="entry_description">
21197               <p>The estimated camera neutral color in the native sensor colorspace at
21198 the time of capture.<wbr/></p>
21199             </td>
21200
21201             <td class="entry_units">
21202             </td>
21203
21204             <td class="entry_range">
21205             </td>
21206
21207             <td class="entry_tags">
21208               <ul class="entry_tags">
21209                   <li><a href="#tag_RAW">RAW</a></li>
21210               </ul>
21211             </td>
21212
21213           </tr>
21214           <tr class="entries_header">
21215             <th class="th_details" colspan="5">Details</th>
21216           </tr>
21217           <tr class="entry_cont">
21218             <td class="entry_details" colspan="5">
21219               <p>This value gives the neutral color point encoded as an RGB value in the
21220 native sensor color space.<wbr/>  The neutral color point indicates the
21221 currently estimated white point of the scene illumination.<wbr/>  It can be
21222 used to interpolate between the provided color transforms when
21223 processing raw sensor data.<wbr/></p>
21224 <p>The order of the values is R,<wbr/> G,<wbr/> B; where R is in the lowest index.<wbr/></p>
21225             </td>
21226           </tr>
21227
21228
21229           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21230            <!-- end of entry -->
21231
21232
21233           <tr class="entry" id="dynamic_android.sensor.noiseProfile">
21234             <td class="entry_name
21235              " rowspan="5">
21236               android.<wbr/>sensor.<wbr/>noise<wbr/>Profile
21237             </td>
21238             <td class="entry_type">
21239                 <span class="entry_type_name">double</span>
21240                 <span class="entry_type_container">x</span>
21241
21242                 <span class="entry_type_array">
21243                   2 x CFA Channels
21244                 </span>
21245               <span class="entry_type_visibility"> [public as pairDoubleDouble]</span>
21246
21247
21248
21249
21250                 <div class="entry_type_notes">Pairs of noise model coefficients</div>
21251
21252
21253             </td> <!-- entry_type -->
21254
21255             <td class="entry_description">
21256               <p>Noise model coefficients for each CFA mosaic channel.<wbr/></p>
21257             </td>
21258
21259             <td class="entry_units">
21260             </td>
21261
21262             <td class="entry_range">
21263             </td>
21264
21265             <td class="entry_tags">
21266               <ul class="entry_tags">
21267                   <li><a href="#tag_RAW">RAW</a></li>
21268               </ul>
21269             </td>
21270
21271           </tr>
21272           <tr class="entries_header">
21273             <th class="th_details" colspan="5">Details</th>
21274           </tr>
21275           <tr class="entry_cont">
21276             <td class="entry_details" colspan="5">
21277               <p>This key contains two noise model coefficients for each CFA channel
21278 corresponding to the sensor amplification (S) and sensor readout
21279 noise (O).<wbr/>  These are given as pairs of coefficients for each channel
21280 in the same order as channels listed for the CFA layout key
21281 (see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>).<wbr/>  This is
21282 represented as an array of Pair&lt;Double,<wbr/> Double&gt;,<wbr/> where
21283 the first member of the Pair at index n is the S coefficient and the
21284 second member is the O coefficient for the nth color channel in the CFA.<wbr/></p>
21285 <p>These coefficients are used in a two parameter noise model to describe
21286 the amount of noise present in the image for each CFA channel.<wbr/>  The
21287 noise model used here is:</p>
21288 <p>N(x) = sqrt(Sx + O)</p>
21289 <p>Where x represents the recorded signal of a CFA channel normalized to
21290 the range [0,<wbr/> 1],<wbr/> and S and O are the noise model coeffiecients for
21291 that channel.<wbr/></p>
21292 <p>A more detailed description of the noise model can be found in the
21293 Adobe DNG specification for the NoiseProfile tag.<wbr/></p>
21294             </td>
21295           </tr>
21296
21297           <tr class="entries_header">
21298             <th class="th_details" colspan="5">HAL Implementation Details</th>
21299           </tr>
21300           <tr class="entry_cont">
21301             <td class="entry_details" colspan="5">
21302               <p>For a CFA layout of RGGB,<wbr/> the list of coefficients would be given as
21303 an array of doubles S0,<wbr/>O0,<wbr/>S1,<wbr/>O1,...,<wbr/> where S0 and O0 are the coefficients
21304 for the red channel,<wbr/> S1 and O1 are the coefficients for the first green
21305 channel,<wbr/> etc.<wbr/></p>
21306             </td>
21307           </tr>
21308
21309           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21310            <!-- end of entry -->
21311
21312
21313           <tr class="entry" id="dynamic_android.sensor.profileHueSatMap">
21314             <td class="entry_name
21315              " rowspan="3">
21316               android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map
21317             </td>
21318             <td class="entry_type">
21319                 <span class="entry_type_name">float</span>
21320                 <span class="entry_type_container">x</span>
21321
21322                 <span class="entry_type_array">
21323                   hue_samples x saturation_samples x value_samples x 3
21324                 </span>
21325               <span class="entry_type_visibility"> [system]</span>
21326
21327
21328
21329
21330                 <div class="entry_type_notes">Mapping for hue,<wbr/> saturation,<wbr/> and value</div>
21331
21332
21333             </td> <!-- entry_type -->
21334
21335             <td class="entry_description">
21336               <p>A mapping containing a hue shift,<wbr/> saturation scale,<wbr/> and value scale
21337 for each pixel.<wbr/></p>
21338             </td>
21339
21340             <td class="entry_units">
21341
21342           The hue shift is given in degrees; saturation and value scale factors are
21343           unitless and are between 0 and 1 inclusive
21344
21345             </td>
21346
21347             <td class="entry_range">
21348             </td>
21349
21350             <td class="entry_tags">
21351               <ul class="entry_tags">
21352                   <li><a href="#tag_RAW">RAW</a></li>
21353               </ul>
21354             </td>
21355
21356           </tr>
21357           <tr class="entries_header">
21358             <th class="th_details" colspan="5">Details</th>
21359           </tr>
21360           <tr class="entry_cont">
21361             <td class="entry_details" colspan="5">
21362               <p>hue_<wbr/>samples,<wbr/> saturation_<wbr/>samples,<wbr/> and value_<wbr/>samples are given in
21363 <a href="#static_android.sensor.profileHueSatMapDimensions">android.<wbr/>sensor.<wbr/>profile<wbr/>Hue<wbr/>Sat<wbr/>Map<wbr/>Dimensions</a>.<wbr/></p>
21364 <p>Each entry of this map contains three floats corresponding to the
21365 hue shift,<wbr/> saturation scale,<wbr/> and value scale,<wbr/> respectively; where the
21366 hue shift has the lowest index.<wbr/> The map entries are stored in the key
21367 in nested loop order,<wbr/> with the value divisions in the outer loop,<wbr/> the
21368 hue divisions in the middle loop,<wbr/> and the saturation divisions in the
21369 inner loop.<wbr/> All zero input saturation entries are required to have a
21370 value scale factor of 1.<wbr/>0.<wbr/></p>
21371             </td>
21372           </tr>
21373
21374
21375           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21376            <!-- end of entry -->
21377
21378
21379           <tr class="entry" id="dynamic_android.sensor.profileToneCurve">
21380             <td class="entry_name
21381              " rowspan="3">
21382               android.<wbr/>sensor.<wbr/>profile<wbr/>Tone<wbr/>Curve
21383             </td>
21384             <td class="entry_type">
21385                 <span class="entry_type_name">float</span>
21386                 <span class="entry_type_container">x</span>
21387
21388                 <span class="entry_type_array">
21389                   samples x 2
21390                 </span>
21391               <span class="entry_type_visibility"> [system]</span>
21392
21393
21394
21395
21396                 <div class="entry_type_notes">Samples defining a spline for a tone-mapping curve</div>
21397
21398
21399             </td> <!-- entry_type -->
21400
21401             <td class="entry_description">
21402               <p>A list of x,<wbr/>y samples defining a tone-mapping curve for gamma adjustment.<wbr/></p>
21403             </td>
21404
21405             <td class="entry_units">
21406             </td>
21407
21408             <td class="entry_range">
21409               <p>Each sample has an input range of <code>[0,<wbr/> 1]</code> and an output range of
21410 <code>[0,<wbr/> 1]</code>.<wbr/>  The first sample is required to be <code>(0,<wbr/> 0)</code>,<wbr/> and the last
21411 sample is required to be <code>(1,<wbr/> 1)</code>.<wbr/></p>
21412             </td>
21413
21414             <td class="entry_tags">
21415               <ul class="entry_tags">
21416                   <li><a href="#tag_RAW">RAW</a></li>
21417               </ul>
21418             </td>
21419
21420           </tr>
21421           <tr class="entries_header">
21422             <th class="th_details" colspan="5">Details</th>
21423           </tr>
21424           <tr class="entry_cont">
21425             <td class="entry_details" colspan="5">
21426               <p>This key contains a default tone curve that can be applied while
21427 processing the image as a starting point for user adjustments.<wbr/>
21428 The curve is specified as a list of value pairs in linear gamma.<wbr/>
21429 The curve is interpolated using a cubic spline.<wbr/></p>
21430             </td>
21431           </tr>
21432
21433
21434           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21435            <!-- end of entry -->
21436
21437
21438           <tr class="entry" id="dynamic_android.sensor.greenSplit">
21439             <td class="entry_name
21440              " rowspan="5">
21441               android.<wbr/>sensor.<wbr/>green<wbr/>Split
21442             </td>
21443             <td class="entry_type">
21444                 <span class="entry_type_name">float</span>
21445
21446               <span class="entry_type_visibility"> [public]</span>
21447
21448
21449
21450
21451
21452
21453             </td> <!-- entry_type -->
21454
21455             <td class="entry_description">
21456               <p>The worst-case divergence between Bayer green channels.<wbr/></p>
21457             </td>
21458
21459             <td class="entry_units">
21460             </td>
21461
21462             <td class="entry_range">
21463               <p>&gt;= 0</p>
21464             </td>
21465
21466             <td class="entry_tags">
21467               <ul class="entry_tags">
21468                   <li><a href="#tag_RAW">RAW</a></li>
21469               </ul>
21470             </td>
21471
21472           </tr>
21473           <tr class="entries_header">
21474             <th class="th_details" colspan="5">Details</th>
21475           </tr>
21476           <tr class="entry_cont">
21477             <td class="entry_details" colspan="5">
21478               <p>This value is an estimate of the worst case split between the
21479 Bayer green channels in the red and blue rows in the sensor color
21480 filter array.<wbr/></p>
21481 <p>The green split is calculated as follows:</p>
21482 <ol>
21483 <li>A 5x5 pixel (or larger) window W within the active sensor array is
21484 chosen.<wbr/> The term 'pixel' here is taken to mean a group of 4 Bayer
21485 mosaic channels (R,<wbr/> Gr,<wbr/> Gb,<wbr/> B).<wbr/>  The location and size of the window
21486 chosen is implementation defined,<wbr/> and should be chosen to provide a
21487 green split estimate that is both representative of the entire image
21488 for this camera sensor,<wbr/> and can be calculated quickly.<wbr/></li>
21489 <li>The arithmetic mean of the green channels from the red
21490 rows (mean_<wbr/>Gr) within W is computed.<wbr/></li>
21491 <li>The arithmetic mean of the green channels from the blue
21492 rows (mean_<wbr/>Gb) within W is computed.<wbr/></li>
21493 <li>The maximum ratio R of the two means is computed as follows:
21494 <code>R = max((mean_<wbr/>Gr + 1)/<wbr/>(mean_<wbr/>Gb + 1),<wbr/> (mean_<wbr/>Gb + 1)/<wbr/>(mean_<wbr/>Gr + 1))</code></li>
21495 </ol>
21496 <p>The ratio R is the green split divergence reported for this property,<wbr/>
21497 which represents how much the green channels differ in the mosaic
21498 pattern.<wbr/>  This value is typically used to determine the treatment of
21499 the green mosaic channels when demosaicing.<wbr/></p>
21500 <p>The green split value can be roughly interpreted as follows:</p>
21501 <ul>
21502 <li>R &lt; 1.<wbr/>03 is a negligible split (&lt;3% divergence).<wbr/></li>
21503 <li>1.<wbr/>20 &lt;= R &gt;= 1.<wbr/>03 will require some software
21504 correction to avoid demosaic errors (3-20% divergence).<wbr/></li>
21505 <li>R &gt; 1.<wbr/>20 will require strong software correction to produce
21506 a usuable image (&gt;20% divergence).<wbr/></li>
21507 </ul>
21508             </td>
21509           </tr>
21510
21511           <tr class="entries_header">
21512             <th class="th_details" colspan="5">HAL Implementation Details</th>
21513           </tr>
21514           <tr class="entry_cont">
21515             <td class="entry_details" colspan="5">
21516               <p>The green split given may be a static value based on prior
21517 characterization of the camera sensor using the green split
21518 calculation method given here over a large,<wbr/> representative,<wbr/> sample
21519 set of images.<wbr/>  Other methods of calculation that produce equivalent
21520 results,<wbr/> and can be interpreted in the same manner,<wbr/> may be used.<wbr/></p>
21521             </td>
21522           </tr>
21523
21524           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21525            <!-- end of entry -->
21526
21527
21528           <tr class="entry" id="dynamic_android.sensor.testPatternData">
21529             <td class="entry_name
21530              " rowspan="5">
21531               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data
21532             </td>
21533             <td class="entry_type">
21534                 <span class="entry_type_name">int32</span>
21535                 <span class="entry_type_container">x</span>
21536
21537                 <span class="entry_type_array">
21538                   4
21539                 </span>
21540               <span class="entry_type_visibility"> [public]</span>
21541
21542
21543
21544
21545
21546
21547             </td> <!-- entry_type -->
21548
21549             <td class="entry_description">
21550               <p>A pixel <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> that supplies the test pattern
21551 when <a href="#controls_android.sensor.testPatternMode">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode</a> is SOLID_<wbr/>COLOR.<wbr/></p>
21552             </td>
21553
21554             <td class="entry_units">
21555             </td>
21556
21557             <td class="entry_range">
21558             </td>
21559
21560             <td class="entry_tags">
21561             </td>
21562
21563           </tr>
21564           <tr class="entries_header">
21565             <th class="th_details" colspan="5">Details</th>
21566           </tr>
21567           <tr class="entry_cont">
21568             <td class="entry_details" colspan="5">
21569               <p>Each color channel is treated as an unsigned 32-bit integer.<wbr/>
21570 The camera device then uses the most significant X bits
21571 that correspond to how many bits are in its Bayer raw sensor
21572 output.<wbr/></p>
21573 <p>For example,<wbr/> a sensor with RAW10 Bayer output would use the
21574 10 most significant bits from each color channel.<wbr/></p>
21575             </td>
21576           </tr>
21577
21578           <tr class="entries_header">
21579             <th class="th_details" colspan="5">HAL Implementation Details</th>
21580           </tr>
21581           <tr class="entry_cont">
21582             <td class="entry_details" colspan="5">
21583
21584             </td>
21585           </tr>
21586
21587           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21588            <!-- end of entry -->
21589
21590
21591           <tr class="entry" id="dynamic_android.sensor.testPatternMode">
21592             <td class="entry_name
21593              " rowspan="5">
21594               android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Mode
21595             </td>
21596             <td class="entry_type">
21597                 <span class="entry_type_name entry_type_name_enum">int32</span>
21598
21599               <span class="entry_type_visibility"> [public]</span>
21600
21601
21602
21603
21604
21605                 <ul class="entry_type_enum">
21606                   <li>
21607                     <span class="entry_type_enum_name">OFF</span>
21608                     <span class="entry_type_enum_notes"><p>No test pattern mode is used,<wbr/> and the camera
21609 device returns captures from the image sensor.<wbr/></p>
21610 <p>This is the default if the key is not set.<wbr/></p></span>
21611                   </li>
21612                   <li>
21613                     <span class="entry_type_enum_name">SOLID_COLOR</span>
21614                     <span class="entry_type_enum_notes"><p>Each pixel in <code>[R,<wbr/> G_<wbr/>even,<wbr/> G_<wbr/>odd,<wbr/> B]</code> is replaced by its
21615 respective color channel provided in
21616 <a href="#controls_android.sensor.testPatternData">android.<wbr/>sensor.<wbr/>test<wbr/>Pattern<wbr/>Data</a>.<wbr/></p>
21617 <p>For example:</p>
21618 <pre><code>android.<wbr/>testPatternData = [0,<wbr/> 0xFFFFFFFF,<wbr/> 0xFFFFFFFF,<wbr/> 0]
21619 </code></pre>
21620 <p>All green pixels are 100% green.<wbr/> All red/<wbr/>blue pixels are black.<wbr/></p>
21621 <pre><code>android.<wbr/>testPatternData = [0xFFFFFFFF,<wbr/> 0,<wbr/> 0xFFFFFFFF,<wbr/> 0]
21622 </code></pre>
21623 <p>All red pixels are 100% red.<wbr/> Only the odd green pixels
21624 are 100% green.<wbr/> All blue pixels are 100% black.<wbr/></p></span>
21625                   </li>
21626                   <li>
21627                     <span class="entry_type_enum_name">COLOR_BARS</span>
21628                     <span class="entry_type_enum_notes"><p>All pixel data is replaced with an 8-bar color pattern.<wbr/></p>
21629 <p>The vertical bars (left-to-right) are as follows:</p>
21630 <ul>
21631 <li>100% white</li>
21632 <li>yellow</li>
21633 <li>cyan</li>
21634 <li>green</li>
21635 <li>magenta</li>
21636 <li>red</li>
21637 <li>blue</li>
21638 <li>black</li>
21639 </ul>
21640 <p>In general the image would look like the following:</p>
21641 <pre><code>W Y C G M R B K
21642 W Y C G M R B K
21643 W Y C G M R B K
21644 W Y C G M R B K
21645 W Y C G M R B K
21646 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
21647 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
21648 .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/> .<wbr/>
21649
21650 (B = Blue,<wbr/> K = Black)
21651 </code></pre>
21652 <p>Each bar should take up 1/<wbr/>8 of the sensor pixel array width.<wbr/>
21653 When this is not possible,<wbr/> the bar size should be rounded
21654 down to the nearest integer and the pattern can repeat
21655 on the right side.<wbr/></p>
21656 <p>Each bar's height must always take up the full sensor
21657 pixel array height.<wbr/></p>
21658 <p>Each pixel in this test pattern must be set to either
21659 0% intensity or 100% intensity.<wbr/></p></span>
21660                   </li>
21661                   <li>
21662                     <span class="entry_type_enum_name">COLOR_BARS_FADE_TO_GRAY</span>
21663                     <span class="entry_type_enum_notes"><p>The test pattern is similar to COLOR_<wbr/>BARS,<wbr/> except that
21664 each bar should start at its specified color at the top,<wbr/>
21665 and fade to gray at the bottom.<wbr/></p>
21666 <p>Furthermore each bar is further subdivided into a left and
21667 right half.<wbr/> The left half should have a smooth gradient,<wbr/>
21668 and the right half should have a quantized gradient.<wbr/></p>
21669 <p>In particular,<wbr/> the right half's should consist of blocks of the
21670 same color for 1/<wbr/>16th active sensor pixel array width.<wbr/></p>
21671 <p>The least significant bits in the quantized gradient should
21672 be copied from the most significant bits of the smooth gradient.<wbr/></p>
21673 <p>The height of each bar should always be a multiple of 128.<wbr/>
21674 When this is not the case,<wbr/> the pattern should repeat at the bottom
21675 of the image.<wbr/></p></span>
21676                   </li>
21677                   <li>
21678                     <span class="entry_type_enum_name">PN9</span>
21679                     <span class="entry_type_enum_notes"><p>All pixel data is replaced by a pseudo-random sequence
21680 generated from a PN9 512-bit sequence (typically implemented
21681 in hardware with a linear feedback shift register).<wbr/></p>
21682 <p>The generator should be reset at the beginning of each frame,<wbr/>
21683 and thus each subsequent raw frame with this test pattern should
21684 be exactly the same as the last.<wbr/></p></span>
21685                   </li>
21686                   <li>
21687                     <span class="entry_type_enum_name">CUSTOM1</span>
21688                     <span class="entry_type_enum_value">256</span>
21689                     <span class="entry_type_enum_notes"><p>The first custom test pattern.<wbr/> All custom patterns that are
21690 available only on this camera device are at least this numeric
21691 value.<wbr/></p>
21692 <p>All of the custom test patterns will be static
21693 (that is the raw image must not vary from frame to frame).<wbr/></p></span>
21694                   </li>
21695                 </ul>
21696
21697             </td> <!-- entry_type -->
21698
21699             <td class="entry_description">
21700               <p>When enabled,<wbr/> the sensor sends a test pattern instead of
21701 doing a real exposure from the camera.<wbr/></p>
21702             </td>
21703
21704             <td class="entry_units">
21705             </td>
21706
21707             <td class="entry_range">
21708               <p><a href="#static_android.sensor.availableTestPatternModes">android.<wbr/>sensor.<wbr/>available<wbr/>Test<wbr/>Pattern<wbr/>Modes</a></p>
21709             </td>
21710
21711             <td class="entry_tags">
21712             </td>
21713
21714           </tr>
21715           <tr class="entries_header">
21716             <th class="th_details" colspan="5">Details</th>
21717           </tr>
21718           <tr class="entry_cont">
21719             <td class="entry_details" colspan="5">
21720               <p>When a test pattern is enabled,<wbr/> all manual sensor controls specified
21721 by android.<wbr/>sensor.<wbr/>* will be ignored.<wbr/> All other controls should
21722 work as normal.<wbr/></p>
21723 <p>For example,<wbr/> if manual flash is enabled,<wbr/> flash firing should still
21724 occur (and that the test pattern remain unmodified,<wbr/> since the flash
21725 would not actually affect it).<wbr/></p>
21726 <p>Defaults to OFF.<wbr/></p>
21727             </td>
21728           </tr>
21729
21730           <tr class="entries_header">
21731             <th class="th_details" colspan="5">HAL Implementation Details</th>
21732           </tr>
21733           <tr class="entry_cont">
21734             <td class="entry_details" colspan="5">
21735               <p>All test patterns are specified in the Bayer domain.<wbr/></p>
21736 <p>The HAL may choose to substitute test patterns from the sensor
21737 with test patterns from on-device memory.<wbr/> In that case,<wbr/> it should be
21738 indistinguishable to the ISP whether the data came from the
21739 sensor interconnect bus (such as CSI2) or memory.<wbr/></p>
21740             </td>
21741           </tr>
21742
21743           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21744            <!-- end of entry -->
21745
21746
21747           <tr class="entry" id="dynamic_android.sensor.rollingShutterSkew">
21748             <td class="entry_name
21749              " rowspan="5">
21750               android.<wbr/>sensor.<wbr/>rolling<wbr/>Shutter<wbr/>Skew
21751             </td>
21752             <td class="entry_type">
21753                 <span class="entry_type_name">int64</span>
21754
21755               <span class="entry_type_visibility"> [public]</span>
21756
21757
21758               <span class="entry_type_hwlevel">[limited] </span>
21759
21760
21761
21762
21763             </td> <!-- entry_type -->
21764
21765             <td class="entry_description">
21766               <p>Duration between the start of first row exposure
21767 and the start of last row exposure.<wbr/></p>
21768             </td>
21769
21770             <td class="entry_units">
21771               Nanoseconds
21772             </td>
21773
21774             <td class="entry_range">
21775               <p>&gt;= 0 and &lt;
21776 <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>.<wbr/></p>
21777             </td>
21778
21779             <td class="entry_tags">
21780               <ul class="entry_tags">
21781                   <li><a href="#tag_V1">V1</a></li>
21782               </ul>
21783             </td>
21784
21785           </tr>
21786           <tr class="entries_header">
21787             <th class="th_details" colspan="5">Details</th>
21788           </tr>
21789           <tr class="entry_cont">
21790             <td class="entry_details" colspan="5">
21791               <p>This is the exposure time skew between the first and last
21792 row exposure start times.<wbr/> The first row and the last row are
21793 the first and last rows inside of the
21794 <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
21795 <p>For typical camera sensors that use rolling shutters,<wbr/> this is also equivalent
21796 to the frame readout time.<wbr/></p>
21797             </td>
21798           </tr>
21799
21800           <tr class="entries_header">
21801             <th class="th_details" colspan="5">HAL Implementation Details</th>
21802           </tr>
21803           <tr class="entry_cont">
21804             <td class="entry_details" colspan="5">
21805               <p>The HAL must report <code>0</code> if the sensor is using global shutter,<wbr/> where all pixels begin
21806 exposure at the same time.<wbr/></p>
21807             </td>
21808           </tr>
21809
21810           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21811            <!-- end of entry -->
21812
21813
21814           <tr class="entry" id="dynamic_android.sensor.dynamicBlackLevel">
21815             <td class="entry_name
21816              " rowspan="5">
21817               android.<wbr/>sensor.<wbr/>dynamic<wbr/>Black<wbr/>Level
21818             </td>
21819             <td class="entry_type">
21820                 <span class="entry_type_name">float</span>
21821                 <span class="entry_type_container">x</span>
21822
21823                 <span class="entry_type_array">
21824                   4
21825                 </span>
21826               <span class="entry_type_visibility"> [public]</span>
21827
21828
21829
21830
21831                 <div class="entry_type_notes">2x2 raw count block</div>
21832
21833
21834             </td> <!-- entry_type -->
21835
21836             <td class="entry_description">
21837               <p>A per-frame dynamic black level offset for each of the color filter
21838 arrangement (CFA) mosaic channels.<wbr/></p>
21839             </td>
21840
21841             <td class="entry_units">
21842             </td>
21843
21844             <td class="entry_range">
21845               <p>&gt;= 0 for each.<wbr/></p>
21846             </td>
21847
21848             <td class="entry_tags">
21849               <ul class="entry_tags">
21850                   <li><a href="#tag_RAW">RAW</a></li>
21851               </ul>
21852             </td>
21853
21854           </tr>
21855           <tr class="entries_header">
21856             <th class="th_details" colspan="5">Details</th>
21857           </tr>
21858           <tr class="entry_cont">
21859             <td class="entry_details" colspan="5">
21860               <p>Camera sensor black levels may vary dramatically for different
21861 capture settings (e.<wbr/>g.<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>).<wbr/> The fixed black
21862 level reported by <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> may be too
21863 inaccurate to represent the actual value on a per-frame basis.<wbr/> The
21864 camera device internal pipeline relies on reliable black level values
21865 to process the raw images appropriately.<wbr/> To get the best image
21866 quality,<wbr/> the camera device may choose to estimate the per frame black
21867 level values either based on optically shielded black regions
21868 (<a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a>) or its internal model.<wbr/></p>
21869 <p>This key reports the camera device estimated per-frame zero light
21870 value for each of the CFA mosaic channels in the camera sensor.<wbr/> The
21871 <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> may only represent a coarse
21872 approximation of the actual black level values.<wbr/> This value is the
21873 black level used in camera device internal image processing pipeline
21874 and generally more accurate than the fixed black level values.<wbr/>
21875 However,<wbr/> since they are estimated values by the camera device,<wbr/> they
21876 may not be as accurate as the black level values calculated from the
21877 optical black pixels reported by <a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a>.<wbr/></p>
21878 <p>The values are given in the same order as channels listed for the CFA
21879 layout key (see <a href="#static_android.sensor.info.colorFilterArrangement">android.<wbr/>sensor.<wbr/>info.<wbr/>color<wbr/>Filter<wbr/>Arrangement</a>),<wbr/> i.<wbr/>e.<wbr/> the
21880 nth value given corresponds to the black level offset for the nth
21881 color channel listed in the CFA.<wbr/></p>
21882 <p>This key will be available if <a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a> is
21883 available or the camera device advertises this key via
21884 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureResultKeys">CameraCharacteristics#getAvailableCaptureResultKeys</a>.<wbr/></p>
21885             </td>
21886           </tr>
21887
21888           <tr class="entries_header">
21889             <th class="th_details" colspan="5">HAL Implementation Details</th>
21890           </tr>
21891           <tr class="entry_cont">
21892             <td class="entry_details" colspan="5">
21893               <p>The values are given in row-column scan order,<wbr/> with the first value
21894 corresponding to the element of the CFA in row=0,<wbr/> column=0.<wbr/></p>
21895             </td>
21896           </tr>
21897
21898           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21899            <!-- end of entry -->
21900
21901
21902           <tr class="entry" id="dynamic_android.sensor.dynamicWhiteLevel">
21903             <td class="entry_name
21904              " rowspan="5">
21905               android.<wbr/>sensor.<wbr/>dynamic<wbr/>White<wbr/>Level
21906             </td>
21907             <td class="entry_type">
21908                 <span class="entry_type_name">int32</span>
21909
21910               <span class="entry_type_visibility"> [public]</span>
21911
21912
21913
21914
21915
21916
21917             </td> <!-- entry_type -->
21918
21919             <td class="entry_description">
21920               <p>Maximum raw value output by sensor for this frame.<wbr/></p>
21921             </td>
21922
21923             <td class="entry_units">
21924             </td>
21925
21926             <td class="entry_range">
21927               <p>&gt;= 0</p>
21928             </td>
21929
21930             <td class="entry_tags">
21931               <ul class="entry_tags">
21932                   <li><a href="#tag_RAW">RAW</a></li>
21933               </ul>
21934             </td>
21935
21936           </tr>
21937           <tr class="entries_header">
21938             <th class="th_details" colspan="5">Details</th>
21939           </tr>
21940           <tr class="entry_cont">
21941             <td class="entry_details" colspan="5">
21942               <p>Since the <a href="#static_android.sensor.blackLevelPattern">android.<wbr/>sensor.<wbr/>black<wbr/>Level<wbr/>Pattern</a> may change for different
21943 capture settings (e.<wbr/>g.,<wbr/> <a href="#controls_android.sensor.sensitivity">android.<wbr/>sensor.<wbr/>sensitivity</a>),<wbr/> the white
21944 level will change accordingly.<wbr/> This key is similar to
21945 <a href="#static_android.sensor.info.whiteLevel">android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level</a>,<wbr/> but specifies the camera device
21946 estimated white level for each frame.<wbr/></p>
21947 <p>This key will be available if <a href="#static_android.sensor.opticalBlackRegions">android.<wbr/>sensor.<wbr/>optical<wbr/>Black<wbr/>Regions</a> is
21948 available or the camera device advertises this key via
21949 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html#getAvailableCaptureRequestKeys">CameraCharacteristics#getAvailableCaptureRequestKeys</a>.<wbr/></p>
21950             </td>
21951           </tr>
21952
21953           <tr class="entries_header">
21954             <th class="th_details" colspan="5">HAL Implementation Details</th>
21955           </tr>
21956           <tr class="entry_cont">
21957             <td class="entry_details" colspan="5">
21958               <p>The full bit depth of the sensor must be available in the raw data,<wbr/>
21959 so the value for linear sensors should not be significantly lower
21960 than maximum raw value supported,<wbr/> i.<wbr/>e.<wbr/> 2^(sensor bits per pixel).<wbr/></p>
21961             </td>
21962           </tr>
21963
21964           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
21965            <!-- end of entry -->
21966
21967
21968
21969       <!-- end of kind -->
21970       </tbody>
21971
21972   <!-- end of section -->
21973   <tr><td colspan="6" id="section_shading" class="section">shading</td></tr>
21974
21975
21976       <tr><td colspan="6" class="kind">controls</td></tr>
21977
21978       <thead class="entries_header">
21979         <tr>
21980           <th class="th_name">Property Name</th>
21981           <th class="th_type">Type</th>
21982           <th class="th_description">Description</th>
21983           <th class="th_units">Units</th>
21984           <th class="th_range">Range</th>
21985           <th class="th_tags">Tags</th>
21986         </tr>
21987       </thead>
21988
21989       <tbody>
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000           <tr class="entry" id="controls_android.shading.mode">
22001             <td class="entry_name
22002              " rowspan="3">
22003               android.<wbr/>shading.<wbr/>mode
22004             </td>
22005             <td class="entry_type">
22006                 <span class="entry_type_name entry_type_name_enum">byte</span>
22007
22008               <span class="entry_type_visibility"> [public]</span>
22009
22010
22011               <span class="entry_type_hwlevel">[full] </span>
22012
22013
22014
22015                 <ul class="entry_type_enum">
22016                   <li>
22017                     <span class="entry_type_enum_name">OFF</span>
22018                     <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
22019                   </li>
22020                   <li>
22021                     <span class="entry_type_enum_name">FAST</span>
22022                     <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
22023 frame rate relative to sensor raw output</p></span>
22024                   </li>
22025                   <li>
22026                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
22027                     <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
22028 cost of possibly reduced frame rate.<wbr/></p></span>
22029                   </li>
22030                 </ul>
22031
22032             </td> <!-- entry_type -->
22033
22034             <td class="entry_description">
22035               <p>Quality of lens shading correction applied
22036 to the image data.<wbr/></p>
22037             </td>
22038
22039             <td class="entry_units">
22040             </td>
22041
22042             <td class="entry_range">
22043               <p><a href="#static_android.shading.availableModes">android.<wbr/>shading.<wbr/>available<wbr/>Modes</a></p>
22044             </td>
22045
22046             <td class="entry_tags">
22047             </td>
22048
22049           </tr>
22050           <tr class="entries_header">
22051             <th class="th_details" colspan="5">Details</th>
22052           </tr>
22053           <tr class="entry_cont">
22054             <td class="entry_details" colspan="5">
22055               <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
22056 camera device,<wbr/> and an identity lens shading map data will be provided
22057 if <code><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON</code>.<wbr/> For example,<wbr/> for lens
22058 shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
22059 the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a> for this case will be an identity
22060 map shown below:</p>
22061 <pre><code>[ 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22062  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22063  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22064  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22065  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22066  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
22067 </code></pre>
22068 <p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
22069 device.<wbr/> Applications can request lens shading map data by setting
22070 <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> to ON,<wbr/> and then the camera device will provide lens
22071 shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a>; the returned shading map
22072 data will be the one applied by the camera device for this capture request.<wbr/></p>
22073 <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
22074 the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
22075 AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code>
22076 OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
22077 to be converged before using the returned shading map data.<wbr/></p>
22078             </td>
22079           </tr>
22080
22081
22082           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22083            <!-- end of entry -->
22084
22085
22086           <tr class="entry" id="controls_android.shading.strength">
22087             <td class="entry_name
22088              " rowspan="1">
22089               android.<wbr/>shading.<wbr/>strength
22090             </td>
22091             <td class="entry_type">
22092                 <span class="entry_type_name">byte</span>
22093
22094               <span class="entry_type_visibility"> [system]</span>
22095
22096
22097
22098
22099
22100
22101             </td> <!-- entry_type -->
22102
22103             <td class="entry_description">
22104               <p>Control the amount of shading correction
22105 applied to the images</p>
22106             </td>
22107
22108             <td class="entry_units">
22109               unitless: 1-10; 10 is full shading
22110           compensation
22111             </td>
22112
22113             <td class="entry_range">
22114             </td>
22115
22116             <td class="entry_tags">
22117               <ul class="entry_tags">
22118                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22119               </ul>
22120             </td>
22121
22122           </tr>
22123
22124
22125           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22126            <!-- end of entry -->
22127
22128
22129
22130       <!-- end of kind -->
22131       </tbody>
22132       <tr><td colspan="6" class="kind">dynamic</td></tr>
22133
22134       <thead class="entries_header">
22135         <tr>
22136           <th class="th_name">Property Name</th>
22137           <th class="th_type">Type</th>
22138           <th class="th_description">Description</th>
22139           <th class="th_units">Units</th>
22140           <th class="th_range">Range</th>
22141           <th class="th_tags">Tags</th>
22142         </tr>
22143       </thead>
22144
22145       <tbody>
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156           <tr class="entry" id="dynamic_android.shading.mode">
22157             <td class="entry_name
22158              " rowspan="3">
22159               android.<wbr/>shading.<wbr/>mode
22160             </td>
22161             <td class="entry_type">
22162                 <span class="entry_type_name entry_type_name_enum">byte</span>
22163
22164               <span class="entry_type_visibility"> [public]</span>
22165
22166
22167               <span class="entry_type_hwlevel">[full] </span>
22168
22169
22170
22171                 <ul class="entry_type_enum">
22172                   <li>
22173                     <span class="entry_type_enum_name">OFF</span>
22174                     <span class="entry_type_enum_notes"><p>No lens shading correction is applied.<wbr/></p></span>
22175                   </li>
22176                   <li>
22177                     <span class="entry_type_enum_name">FAST</span>
22178                     <span class="entry_type_enum_notes"><p>Apply lens shading corrections,<wbr/> without slowing
22179 frame rate relative to sensor raw output</p></span>
22180                   </li>
22181                   <li>
22182                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
22183                     <span class="entry_type_enum_notes"><p>Apply high-quality lens shading correction,<wbr/> at the
22184 cost of possibly reduced frame rate.<wbr/></p></span>
22185                   </li>
22186                 </ul>
22187
22188             </td> <!-- entry_type -->
22189
22190             <td class="entry_description">
22191               <p>Quality of lens shading correction applied
22192 to the image data.<wbr/></p>
22193             </td>
22194
22195             <td class="entry_units">
22196             </td>
22197
22198             <td class="entry_range">
22199               <p><a href="#static_android.shading.availableModes">android.<wbr/>shading.<wbr/>available<wbr/>Modes</a></p>
22200             </td>
22201
22202             <td class="entry_tags">
22203             </td>
22204
22205           </tr>
22206           <tr class="entries_header">
22207             <th class="th_details" colspan="5">Details</th>
22208           </tr>
22209           <tr class="entry_cont">
22210             <td class="entry_details" colspan="5">
22211               <p>When set to OFF mode,<wbr/> no lens shading correction will be applied by the
22212 camera device,<wbr/> and an identity lens shading map data will be provided
22213 if <code><a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> == ON</code>.<wbr/> For example,<wbr/> for lens
22214 shading map with size of <code>[ 4,<wbr/> 3 ]</code>,<wbr/>
22215 the output <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a> for this case will be an identity
22216 map shown below:</p>
22217 <pre><code>[ 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22218  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22219  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22220  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22221  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>
22222  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
22223 </code></pre>
22224 <p>When set to other modes,<wbr/> lens shading correction will be applied by the camera
22225 device.<wbr/> Applications can request lens shading map data by setting
22226 <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> to ON,<wbr/> and then the camera device will provide lens
22227 shading map data in <a href="#dynamic_android.statistics.lensShadingCorrectionMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map</a>; the returned shading map
22228 data will be the one applied by the camera device for this capture request.<wbr/></p>
22229 <p>The shading map data may depend on the auto-exposure (AE) and AWB statistics,<wbr/> therefore
22230 the reliability of the map data may be affected by the AE and AWB algorithms.<wbr/> When AE and
22231 AWB are in AUTO modes(<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code>
22232 OFF),<wbr/> to get best results,<wbr/> it is recommended that the applications wait for the AE and AWB
22233 to be converged before using the returned shading map data.<wbr/></p>
22234             </td>
22235           </tr>
22236
22237
22238           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22239            <!-- end of entry -->
22240
22241
22242
22243       <!-- end of kind -->
22244       </tbody>
22245       <tr><td colspan="6" class="kind">static</td></tr>
22246
22247       <thead class="entries_header">
22248         <tr>
22249           <th class="th_name">Property Name</th>
22250           <th class="th_type">Type</th>
22251           <th class="th_description">Description</th>
22252           <th class="th_units">Units</th>
22253           <th class="th_range">Range</th>
22254           <th class="th_tags">Tags</th>
22255         </tr>
22256       </thead>
22257
22258       <tbody>
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269           <tr class="entry" id="static_android.shading.availableModes">
22270             <td class="entry_name
22271              " rowspan="5">
22272               android.<wbr/>shading.<wbr/>available<wbr/>Modes
22273             </td>
22274             <td class="entry_type">
22275                 <span class="entry_type_name">byte</span>
22276                 <span class="entry_type_container">x</span>
22277
22278                 <span class="entry_type_array">
22279                   n
22280                 </span>
22281               <span class="entry_type_visibility"> [public as enumList]</span>
22282
22283
22284               <span class="entry_type_hwlevel">[legacy] </span>
22285
22286
22287                 <div class="entry_type_notes">List of enums (android.<wbr/>shading.<wbr/>mode).<wbr/></div>
22288
22289
22290             </td> <!-- entry_type -->
22291
22292             <td class="entry_description">
22293               <p>List of lens shading modes for <a href="#controls_android.shading.mode">android.<wbr/>shading.<wbr/>mode</a> that are supported by this camera device.<wbr/></p>
22294             </td>
22295
22296             <td class="entry_units">
22297             </td>
22298
22299             <td class="entry_range">
22300               <p>Any value listed in <a href="#controls_android.shading.mode">android.<wbr/>shading.<wbr/>mode</a></p>
22301             </td>
22302
22303             <td class="entry_tags">
22304             </td>
22305
22306           </tr>
22307           <tr class="entries_header">
22308             <th class="th_details" colspan="5">Details</th>
22309           </tr>
22310           <tr class="entry_cont">
22311             <td class="entry_details" colspan="5">
22312               <p>This list contains lens shading modes that can be set for the camera device.<wbr/>
22313 Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always
22314 list OFF and FAST mode.<wbr/> This includes all FULL level devices.<wbr/>
22315 LEGACY devices will always only support FAST mode.<wbr/></p>
22316             </td>
22317           </tr>
22318
22319           <tr class="entries_header">
22320             <th class="th_details" colspan="5">HAL Implementation Details</th>
22321           </tr>
22322           <tr class="entry_cont">
22323             <td class="entry_details" colspan="5">
22324               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if lens shading correction control is
22325 available on the camera device,<wbr/> but the underlying implementation can be the same for
22326 both modes.<wbr/> That is,<wbr/> if the highest quality implementation on the camera device does not
22327 slow down capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
22328             </td>
22329           </tr>
22330
22331           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22332            <!-- end of entry -->
22333
22334
22335
22336       <!-- end of kind -->
22337       </tbody>
22338
22339   <!-- end of section -->
22340   <tr><td colspan="6" id="section_statistics" class="section">statistics</td></tr>
22341
22342
22343       <tr><td colspan="6" class="kind">controls</td></tr>
22344
22345       <thead class="entries_header">
22346         <tr>
22347           <th class="th_name">Property Name</th>
22348           <th class="th_type">Type</th>
22349           <th class="th_description">Description</th>
22350           <th class="th_units">Units</th>
22351           <th class="th_range">Range</th>
22352           <th class="th_tags">Tags</th>
22353         </tr>
22354       </thead>
22355
22356       <tbody>
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367           <tr class="entry" id="controls_android.statistics.faceDetectMode">
22368             <td class="entry_name
22369              " rowspan="5">
22370               android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
22371             </td>
22372             <td class="entry_type">
22373                 <span class="entry_type_name entry_type_name_enum">byte</span>
22374
22375               <span class="entry_type_visibility"> [public]</span>
22376
22377
22378               <span class="entry_type_hwlevel">[legacy] </span>
22379
22380
22381
22382                 <ul class="entry_type_enum">
22383                   <li>
22384                     <span class="entry_type_enum_name">OFF</span>
22385                     <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
22386 results.<wbr/></p></span>
22387                   </li>
22388                   <li>
22389                     <span class="entry_type_enum_name">SIMPLE</span>
22390                     <span class="entry_type_enum_optional">[optional]</span>
22391                     <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
22392                   </li>
22393                   <li>
22394                     <span class="entry_type_enum_name">FULL</span>
22395                     <span class="entry_type_enum_optional">[optional]</span>
22396                     <span class="entry_type_enum_notes"><p>Return all face
22397 metadata.<wbr/></p>
22398 <p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
22399                   </li>
22400                 </ul>
22401
22402             </td> <!-- entry_type -->
22403
22404             <td class="entry_description">
22405               <p>Operating mode for the face detector
22406 unit.<wbr/></p>
22407             </td>
22408
22409             <td class="entry_units">
22410             </td>
22411
22412             <td class="entry_range">
22413               <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
22414             </td>
22415
22416             <td class="entry_tags">
22417               <ul class="entry_tags">
22418                   <li><a href="#tag_BC">BC</a></li>
22419               </ul>
22420             </td>
22421
22422           </tr>
22423           <tr class="entries_header">
22424             <th class="th_details" colspan="5">Details</th>
22425           </tr>
22426           <tr class="entry_cont">
22427             <td class="entry_details" colspan="5">
22428               <p>Whether face detection is enabled,<wbr/> and whether it
22429 should output just the basic fields or the full set of
22430 fields.<wbr/></p>
22431             </td>
22432           </tr>
22433
22434           <tr class="entries_header">
22435             <th class="th_details" colspan="5">HAL Implementation Details</th>
22436           </tr>
22437           <tr class="entry_cont">
22438             <td class="entry_details" colspan="5">
22439               <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
22440 <a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
22441 FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
22442 <a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
22443             </td>
22444           </tr>
22445
22446           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22447            <!-- end of entry -->
22448
22449
22450           <tr class="entry" id="controls_android.statistics.histogramMode">
22451             <td class="entry_name
22452              " rowspan="1">
22453               android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
22454             </td>
22455             <td class="entry_type">
22456                 <span class="entry_type_name entry_type_name_enum">byte</span>
22457
22458               <span class="entry_type_visibility"> [system as boolean]</span>
22459
22460
22461
22462
22463
22464                 <ul class="entry_type_enum">
22465                   <li>
22466                     <span class="entry_type_enum_name">OFF</span>
22467                   </li>
22468                   <li>
22469                     <span class="entry_type_enum_name">ON</span>
22470                   </li>
22471                 </ul>
22472
22473             </td> <!-- entry_type -->
22474
22475             <td class="entry_description">
22476               <p>Operating mode for histogram
22477 generation</p>
22478             </td>
22479
22480             <td class="entry_units">
22481             </td>
22482
22483             <td class="entry_range">
22484             </td>
22485
22486             <td class="entry_tags">
22487               <ul class="entry_tags">
22488                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22489               </ul>
22490             </td>
22491
22492           </tr>
22493
22494
22495           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22496            <!-- end of entry -->
22497
22498
22499           <tr class="entry" id="controls_android.statistics.sharpnessMapMode">
22500             <td class="entry_name
22501              " rowspan="1">
22502               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
22503             </td>
22504             <td class="entry_type">
22505                 <span class="entry_type_name entry_type_name_enum">byte</span>
22506
22507               <span class="entry_type_visibility"> [system as boolean]</span>
22508
22509
22510
22511
22512
22513                 <ul class="entry_type_enum">
22514                   <li>
22515                     <span class="entry_type_enum_name">OFF</span>
22516                   </li>
22517                   <li>
22518                     <span class="entry_type_enum_name">ON</span>
22519                   </li>
22520                 </ul>
22521
22522             </td> <!-- entry_type -->
22523
22524             <td class="entry_description">
22525               <p>Operating mode for sharpness map
22526 generation</p>
22527             </td>
22528
22529             <td class="entry_units">
22530             </td>
22531
22532             <td class="entry_range">
22533             </td>
22534
22535             <td class="entry_tags">
22536               <ul class="entry_tags">
22537                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22538               </ul>
22539             </td>
22540
22541           </tr>
22542
22543
22544           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22545            <!-- end of entry -->
22546
22547
22548           <tr class="entry" id="controls_android.statistics.hotPixelMapMode">
22549             <td class="entry_name
22550              " rowspan="3">
22551               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
22552             </td>
22553             <td class="entry_type">
22554                 <span class="entry_type_name entry_type_name_enum">byte</span>
22555
22556               <span class="entry_type_visibility"> [public as boolean]</span>
22557
22558
22559
22560
22561
22562                 <ul class="entry_type_enum">
22563                   <li>
22564                     <span class="entry_type_enum_name">OFF</span>
22565                     <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
22566                   </li>
22567                   <li>
22568                     <span class="entry_type_enum_name">ON</span>
22569                     <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
22570                   </li>
22571                 </ul>
22572
22573             </td> <!-- entry_type -->
22574
22575             <td class="entry_description">
22576               <p>Operating mode for hot pixel map generation.<wbr/></p>
22577             </td>
22578
22579             <td class="entry_units">
22580             </td>
22581
22582             <td class="entry_range">
22583               <p><a href="#static_android.statistics.info.availableHotPixelMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes</a></p>
22584             </td>
22585
22586             <td class="entry_tags">
22587               <ul class="entry_tags">
22588                   <li><a href="#tag_V1">V1</a></li>
22589                   <li><a href="#tag_RAW">RAW</a></li>
22590               </ul>
22591             </td>
22592
22593           </tr>
22594           <tr class="entries_header">
22595             <th class="th_details" colspan="5">Details</th>
22596           </tr>
22597           <tr class="entry_cont">
22598             <td class="entry_details" colspan="5">
22599               <p>If set to <code>true</code>,<wbr/> a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/>
22600 If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
22601             </td>
22602           </tr>
22603
22604
22605           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22606            <!-- end of entry -->
22607
22608
22609           <tr class="entry" id="controls_android.statistics.lensShadingMapMode">
22610             <td class="entry_name
22611              " rowspan="3">
22612               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
22613             </td>
22614             <td class="entry_type">
22615                 <span class="entry_type_name entry_type_name_enum">byte</span>
22616
22617               <span class="entry_type_visibility"> [public]</span>
22618
22619
22620               <span class="entry_type_hwlevel">[full] </span>
22621
22622
22623
22624                 <ul class="entry_type_enum">
22625                   <li>
22626                     <span class="entry_type_enum_name">OFF</span>
22627                     <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
22628                   </li>
22629                   <li>
22630                     <span class="entry_type_enum_name">ON</span>
22631                     <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
22632                   </li>
22633                 </ul>
22634
22635             </td> <!-- entry_type -->
22636
22637             <td class="entry_description">
22638               <p>Whether the camera device will output the lens
22639 shading map in output result metadata.<wbr/></p>
22640             </td>
22641
22642             <td class="entry_units">
22643             </td>
22644
22645             <td class="entry_range">
22646               <p><a href="#static_android.statistics.info.availableLensShadingMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Lens<wbr/>Shading<wbr/>Map<wbr/>Modes</a></p>
22647             </td>
22648
22649             <td class="entry_tags">
22650               <ul class="entry_tags">
22651                   <li><a href="#tag_RAW">RAW</a></li>
22652               </ul>
22653             </td>
22654
22655           </tr>
22656           <tr class="entries_header">
22657             <th class="th_details" colspan="5">Details</th>
22658           </tr>
22659           <tr class="entry_cont">
22660             <td class="entry_details" colspan="5">
22661               <p>When set to ON,<wbr/>
22662 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
22663 the output result metadata.<wbr/></p>
22664 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
22665             </td>
22666           </tr>
22667
22668
22669           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22670            <!-- end of entry -->
22671
22672
22673
22674       <!-- end of kind -->
22675       </tbody>
22676       <tr><td colspan="6" class="kind">static</td></tr>
22677
22678       <thead class="entries_header">
22679         <tr>
22680           <th class="th_name">Property Name</th>
22681           <th class="th_type">Type</th>
22682           <th class="th_description">Description</th>
22683           <th class="th_units">Units</th>
22684           <th class="th_range">Range</th>
22685           <th class="th_tags">Tags</th>
22686         </tr>
22687       </thead>
22688
22689       <tbody>
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
22701
22702           <tr class="entry" id="static_android.statistics.info.availableFaceDetectModes">
22703             <td class="entry_name
22704              " rowspan="3">
22705               android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes
22706             </td>
22707             <td class="entry_type">
22708                 <span class="entry_type_name">byte</span>
22709                 <span class="entry_type_container">x</span>
22710
22711                 <span class="entry_type_array">
22712                   n
22713                 </span>
22714               <span class="entry_type_visibility"> [public as enumList]</span>
22715
22716
22717               <span class="entry_type_hwlevel">[legacy] </span>
22718
22719
22720                 <div class="entry_type_notes">List of enums from android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</div>
22721
22722
22723             </td> <!-- entry_type -->
22724
22725             <td class="entry_description">
22726               <p>List of face detection modes for <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> that are
22727 supported by this camera device.<wbr/></p>
22728             </td>
22729
22730             <td class="entry_units">
22731             </td>
22732
22733             <td class="entry_range">
22734               <p>Any value listed in <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a></p>
22735             </td>
22736
22737             <td class="entry_tags">
22738             </td>
22739
22740           </tr>
22741           <tr class="entries_header">
22742             <th class="th_details" colspan="5">Details</th>
22743           </tr>
22744           <tr class="entry_cont">
22745             <td class="entry_details" colspan="5">
22746               <p>OFF is always supported.<wbr/></p>
22747             </td>
22748           </tr>
22749
22750
22751           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22752            <!-- end of entry -->
22753
22754
22755           <tr class="entry" id="static_android.statistics.info.histogramBucketCount">
22756             <td class="entry_name
22757              " rowspan="1">
22758               android.<wbr/>statistics.<wbr/>info.<wbr/>histogram<wbr/>Bucket<wbr/>Count
22759             </td>
22760             <td class="entry_type">
22761                 <span class="entry_type_name">int32</span>
22762
22763               <span class="entry_type_visibility"> [system]</span>
22764
22765
22766
22767
22768
22769
22770             </td> <!-- entry_type -->
22771
22772             <td class="entry_description">
22773               <p>Number of histogram buckets
22774 supported</p>
22775             </td>
22776
22777             <td class="entry_units">
22778             </td>
22779
22780             <td class="entry_range">
22781               <p>&gt;= 64</p>
22782             </td>
22783
22784             <td class="entry_tags">
22785               <ul class="entry_tags">
22786                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22787               </ul>
22788             </td>
22789
22790           </tr>
22791
22792
22793           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22794            <!-- end of entry -->
22795
22796
22797           <tr class="entry" id="static_android.statistics.info.maxFaceCount">
22798             <td class="entry_name
22799              " rowspan="1">
22800               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Face<wbr/>Count
22801             </td>
22802             <td class="entry_type">
22803                 <span class="entry_type_name">int32</span>
22804
22805               <span class="entry_type_visibility"> [public]</span>
22806
22807
22808               <span class="entry_type_hwlevel">[legacy] </span>
22809
22810
22811
22812
22813             </td> <!-- entry_type -->
22814
22815             <td class="entry_description">
22816               <p>The maximum number of simultaneously detectable
22817 faces.<wbr/></p>
22818             </td>
22819
22820             <td class="entry_units">
22821             </td>
22822
22823             <td class="entry_range">
22824               <p>0 for cameras without available face detection; otherwise:
22825 <code>&gt;=4</code> for LIMITED or FULL hwlevel devices or
22826 <code>&gt;0</code> for LEGACY devices.<wbr/></p>
22827             </td>
22828
22829             <td class="entry_tags">
22830               <ul class="entry_tags">
22831                   <li><a href="#tag_BC">BC</a></li>
22832               </ul>
22833             </td>
22834
22835           </tr>
22836
22837
22838           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22839            <!-- end of entry -->
22840
22841
22842           <tr class="entry" id="static_android.statistics.info.maxHistogramCount">
22843             <td class="entry_name
22844              " rowspan="1">
22845               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Histogram<wbr/>Count
22846             </td>
22847             <td class="entry_type">
22848                 <span class="entry_type_name">int32</span>
22849
22850               <span class="entry_type_visibility"> [system]</span>
22851
22852
22853
22854
22855
22856
22857             </td> <!-- entry_type -->
22858
22859             <td class="entry_description">
22860               <p>Maximum value possible for a histogram
22861 bucket</p>
22862             </td>
22863
22864             <td class="entry_units">
22865             </td>
22866
22867             <td class="entry_range">
22868             </td>
22869
22870             <td class="entry_tags">
22871               <ul class="entry_tags">
22872                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22873               </ul>
22874             </td>
22875
22876           </tr>
22877
22878
22879           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22880            <!-- end of entry -->
22881
22882
22883           <tr class="entry" id="static_android.statistics.info.maxSharpnessMapValue">
22884             <td class="entry_name
22885              " rowspan="1">
22886               android.<wbr/>statistics.<wbr/>info.<wbr/>max<wbr/>Sharpness<wbr/>Map<wbr/>Value
22887             </td>
22888             <td class="entry_type">
22889                 <span class="entry_type_name">int32</span>
22890
22891               <span class="entry_type_visibility"> [system]</span>
22892
22893
22894
22895
22896
22897
22898             </td> <!-- entry_type -->
22899
22900             <td class="entry_description">
22901               <p>Maximum value possible for a sharpness map
22902 region.<wbr/></p>
22903             </td>
22904
22905             <td class="entry_units">
22906             </td>
22907
22908             <td class="entry_range">
22909             </td>
22910
22911             <td class="entry_tags">
22912               <ul class="entry_tags">
22913                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22914               </ul>
22915             </td>
22916
22917           </tr>
22918
22919
22920           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22921            <!-- end of entry -->
22922
22923
22924           <tr class="entry" id="static_android.statistics.info.sharpnessMapSize">
22925             <td class="entry_name
22926              " rowspan="1">
22927               android.<wbr/>statistics.<wbr/>info.<wbr/>sharpness<wbr/>Map<wbr/>Size
22928             </td>
22929             <td class="entry_type">
22930                 <span class="entry_type_name">int32</span>
22931                 <span class="entry_type_container">x</span>
22932
22933                 <span class="entry_type_array">
22934                   2
22935                 </span>
22936               <span class="entry_type_visibility"> [system as size]</span>
22937
22938
22939
22940
22941                 <div class="entry_type_notes">width x height</div>
22942
22943
22944             </td> <!-- entry_type -->
22945
22946             <td class="entry_description">
22947               <p>Dimensions of the sharpness
22948 map</p>
22949             </td>
22950
22951             <td class="entry_units">
22952             </td>
22953
22954             <td class="entry_range">
22955               <p>Must be at least 32 x 32</p>
22956             </td>
22957
22958             <td class="entry_tags">
22959               <ul class="entry_tags">
22960                   <li><a href="#tag_FUTURE">FUTURE</a></li>
22961               </ul>
22962             </td>
22963
22964           </tr>
22965
22966
22967           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
22968            <!-- end of entry -->
22969
22970
22971           <tr class="entry" id="static_android.statistics.info.availableHotPixelMapModes">
22972             <td class="entry_name
22973              " rowspan="3">
22974               android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes
22975             </td>
22976             <td class="entry_type">
22977                 <span class="entry_type_name">byte</span>
22978                 <span class="entry_type_container">x</span>
22979
22980                 <span class="entry_type_array">
22981                   n
22982                 </span>
22983               <span class="entry_type_visibility"> [public as boolean]</span>
22984
22985
22986
22987
22988                 <div class="entry_type_notes">list of enums</div>
22989
22990
22991             </td> <!-- entry_type -->
22992
22993             <td class="entry_description">
22994               <p>List of hot pixel map output modes for <a href="#controls_android.statistics.hotPixelMapMode">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode</a> that are
22995 supported by this camera device.<wbr/></p>
22996             </td>
22997
22998             <td class="entry_units">
22999             </td>
23000
23001             <td class="entry_range">
23002               <p>Any value listed in <a href="#controls_android.statistics.hotPixelMapMode">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode</a></p>
23003             </td>
23004
23005             <td class="entry_tags">
23006               <ul class="entry_tags">
23007                   <li><a href="#tag_V1">V1</a></li>
23008                   <li><a href="#tag_RAW">RAW</a></li>
23009               </ul>
23010             </td>
23011
23012           </tr>
23013           <tr class="entries_header">
23014             <th class="th_details" colspan="5">Details</th>
23015           </tr>
23016           <tr class="entry_cont">
23017             <td class="entry_details" colspan="5">
23018               <p>If no hotpixel map output is available for this camera device,<wbr/> this will contain only
23019 <code>false</code>.<wbr/></p>
23020 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
23021             </td>
23022           </tr>
23023
23024
23025           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23026            <!-- end of entry -->
23027
23028
23029           <tr class="entry" id="static_android.statistics.info.availableLensShadingMapModes">
23030             <td class="entry_name
23031              " rowspan="3">
23032               android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Lens<wbr/>Shading<wbr/>Map<wbr/>Modes
23033             </td>
23034             <td class="entry_type">
23035                 <span class="entry_type_name">byte</span>
23036                 <span class="entry_type_container">x</span>
23037
23038                 <span class="entry_type_array">
23039                   n
23040                 </span>
23041               <span class="entry_type_visibility"> [public as enumList]</span>
23042
23043
23044
23045
23046                 <div class="entry_type_notes">list of enums</div>
23047
23048
23049             </td> <!-- entry_type -->
23050
23051             <td class="entry_description">
23052               <p>List of lens shading map output modes for <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a> that
23053 are supported by this camera device.<wbr/></p>
23054             </td>
23055
23056             <td class="entry_units">
23057             </td>
23058
23059             <td class="entry_range">
23060               <p>Any value listed in <a href="#controls_android.statistics.lensShadingMapMode">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode</a></p>
23061             </td>
23062
23063             <td class="entry_tags">
23064             </td>
23065
23066           </tr>
23067           <tr class="entries_header">
23068             <th class="th_details" colspan="5">Details</th>
23069           </tr>
23070           <tr class="entry_cont">
23071             <td class="entry_details" colspan="5">
23072               <p>If no lens shading map output is available for this camera device,<wbr/> this key will
23073 contain only OFF.<wbr/></p>
23074 <p>ON is always supported on devices with the RAW capability.<wbr/>
23075 LEGACY mode devices will always only support OFF.<wbr/></p>
23076             </td>
23077           </tr>
23078
23079
23080           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23081            <!-- end of entry -->
23082
23083
23084
23085
23086
23087
23088       <!-- end of kind -->
23089       </tbody>
23090       <tr><td colspan="6" class="kind">dynamic</td></tr>
23091
23092       <thead class="entries_header">
23093         <tr>
23094           <th class="th_name">Property Name</th>
23095           <th class="th_type">Type</th>
23096           <th class="th_description">Description</th>
23097           <th class="th_units">Units</th>
23098           <th class="th_range">Range</th>
23099           <th class="th_tags">Tags</th>
23100         </tr>
23101       </thead>
23102
23103       <tbody>
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114           <tr class="entry" id="dynamic_android.statistics.faceDetectMode">
23115             <td class="entry_name
23116              " rowspan="5">
23117               android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode
23118             </td>
23119             <td class="entry_type">
23120                 <span class="entry_type_name entry_type_name_enum">byte</span>
23121
23122               <span class="entry_type_visibility"> [public]</span>
23123
23124
23125               <span class="entry_type_hwlevel">[legacy] </span>
23126
23127
23128
23129                 <ul class="entry_type_enum">
23130                   <li>
23131                     <span class="entry_type_enum_name">OFF</span>
23132                     <span class="entry_type_enum_notes"><p>Do not include face detection statistics in capture
23133 results.<wbr/></p></span>
23134                   </li>
23135                   <li>
23136                     <span class="entry_type_enum_name">SIMPLE</span>
23137                     <span class="entry_type_enum_optional">[optional]</span>
23138                     <span class="entry_type_enum_notes"><p>Return face rectangle and confidence values only.<wbr/></p></span>
23139                   </li>
23140                   <li>
23141                     <span class="entry_type_enum_name">FULL</span>
23142                     <span class="entry_type_enum_optional">[optional]</span>
23143                     <span class="entry_type_enum_notes"><p>Return all face
23144 metadata.<wbr/></p>
23145 <p>In this mode,<wbr/> face rectangles,<wbr/> scores,<wbr/> landmarks,<wbr/> and face IDs are all valid.<wbr/></p></span>
23146                   </li>
23147                 </ul>
23148
23149             </td> <!-- entry_type -->
23150
23151             <td class="entry_description">
23152               <p>Operating mode for the face detector
23153 unit.<wbr/></p>
23154             </td>
23155
23156             <td class="entry_units">
23157             </td>
23158
23159             <td class="entry_range">
23160               <p><a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a></p>
23161             </td>
23162
23163             <td class="entry_tags">
23164               <ul class="entry_tags">
23165                   <li><a href="#tag_BC">BC</a></li>
23166               </ul>
23167             </td>
23168
23169           </tr>
23170           <tr class="entries_header">
23171             <th class="th_details" colspan="5">Details</th>
23172           </tr>
23173           <tr class="entry_cont">
23174             <td class="entry_details" colspan="5">
23175               <p>Whether face detection is enabled,<wbr/> and whether it
23176 should output just the basic fields or the full set of
23177 fields.<wbr/></p>
23178             </td>
23179           </tr>
23180
23181           <tr class="entries_header">
23182             <th class="th_details" colspan="5">HAL Implementation Details</th>
23183           </tr>
23184           <tr class="entry_cont">
23185             <td class="entry_details" colspan="5">
23186               <p>SIMPLE mode must fill in <a href="#dynamic_android.statistics.faceRectangles">android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles</a> and
23187 <a href="#dynamic_android.statistics.faceScores">android.<wbr/>statistics.<wbr/>face<wbr/>Scores</a>.<wbr/>
23188 FULL mode must also fill in <a href="#dynamic_android.statistics.faceIds">android.<wbr/>statistics.<wbr/>face<wbr/>Ids</a>,<wbr/> and
23189 <a href="#dynamic_android.statistics.faceLandmarks">android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks</a>.<wbr/></p>
23190             </td>
23191           </tr>
23192
23193           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23194            <!-- end of entry -->
23195
23196
23197           <tr class="entry" id="dynamic_android.statistics.faceIds">
23198             <td class="entry_name
23199              " rowspan="3">
23200               android.<wbr/>statistics.<wbr/>face<wbr/>Ids
23201             </td>
23202             <td class="entry_type">
23203                 <span class="entry_type_name">int32</span>
23204                 <span class="entry_type_container">x</span>
23205
23206                 <span class="entry_type_array">
23207                   n
23208                 </span>
23209               <span class="entry_type_visibility"> [ndk_public]</span>
23210
23211
23212               <span class="entry_type_hwlevel">[legacy] </span>
23213
23214
23215
23216
23217             </td> <!-- entry_type -->
23218
23219             <td class="entry_description">
23220               <p>List of unique IDs for detected faces.<wbr/></p>
23221             </td>
23222
23223             <td class="entry_units">
23224             </td>
23225
23226             <td class="entry_range">
23227             </td>
23228
23229             <td class="entry_tags">
23230               <ul class="entry_tags">
23231                   <li><a href="#tag_BC">BC</a></li>
23232               </ul>
23233             </td>
23234
23235           </tr>
23236           <tr class="entries_header">
23237             <th class="th_details" colspan="5">Details</th>
23238           </tr>
23239           <tr class="entry_cont">
23240             <td class="entry_details" colspan="5">
23241               <p>Each detected face is given a unique ID that is valid for as long as the face is visible
23242 to the camera device.<wbr/>  A face that leaves the field of view and later returns may be
23243 assigned a new ID.<wbr/></p>
23244 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
23245             </td>
23246           </tr>
23247
23248
23249           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23250            <!-- end of entry -->
23251
23252
23253           <tr class="entry" id="dynamic_android.statistics.faceLandmarks">
23254             <td class="entry_name
23255              " rowspan="3">
23256               android.<wbr/>statistics.<wbr/>face<wbr/>Landmarks
23257             </td>
23258             <td class="entry_type">
23259                 <span class="entry_type_name">int32</span>
23260                 <span class="entry_type_container">x</span>
23261
23262                 <span class="entry_type_array">
23263                   n x 6
23264                 </span>
23265               <span class="entry_type_visibility"> [ndk_public]</span>
23266
23267
23268               <span class="entry_type_hwlevel">[legacy] </span>
23269
23270
23271                 <div class="entry_type_notes">(leftEyeX,<wbr/> leftEyeY,<wbr/> rightEyeX,<wbr/> rightEyeY,<wbr/> mouthX,<wbr/> mouthY)</div>
23272
23273
23274             </td> <!-- entry_type -->
23275
23276             <td class="entry_description">
23277               <p>List of landmarks for detected
23278 faces.<wbr/></p>
23279             </td>
23280
23281             <td class="entry_units">
23282             </td>
23283
23284             <td class="entry_range">
23285             </td>
23286
23287             <td class="entry_tags">
23288               <ul class="entry_tags">
23289                   <li><a href="#tag_BC">BC</a></li>
23290               </ul>
23291             </td>
23292
23293           </tr>
23294           <tr class="entries_header">
23295             <th class="th_details" colspan="5">Details</th>
23296           </tr>
23297           <tr class="entry_cont">
23298             <td class="entry_details" colspan="5">
23299               <p>The coordinate system is that of <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with
23300 <code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
23301 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> == FULL</p>
23302             </td>
23303           </tr>
23304
23305
23306           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23307            <!-- end of entry -->
23308
23309
23310           <tr class="entry" id="dynamic_android.statistics.faceRectangles">
23311             <td class="entry_name
23312              " rowspan="3">
23313               android.<wbr/>statistics.<wbr/>face<wbr/>Rectangles
23314             </td>
23315             <td class="entry_type">
23316                 <span class="entry_type_name">int32</span>
23317                 <span class="entry_type_container">x</span>
23318
23319                 <span class="entry_type_array">
23320                   n x 4
23321                 </span>
23322               <span class="entry_type_visibility"> [ndk_public as rectangle]</span>
23323
23324
23325               <span class="entry_type_hwlevel">[legacy] </span>
23326
23327
23328                 <div class="entry_type_notes">(xmin,<wbr/> ymin,<wbr/> xmax,<wbr/> ymax).<wbr/> (0,<wbr/>0) is top-left of active pixel area</div>
23329
23330
23331             </td> <!-- entry_type -->
23332
23333             <td class="entry_description">
23334               <p>List of the bounding rectangles for detected
23335 faces.<wbr/></p>
23336             </td>
23337
23338             <td class="entry_units">
23339             </td>
23340
23341             <td class="entry_range">
23342             </td>
23343
23344             <td class="entry_tags">
23345               <ul class="entry_tags">
23346                   <li><a href="#tag_BC">BC</a></li>
23347               </ul>
23348             </td>
23349
23350           </tr>
23351           <tr class="entries_header">
23352             <th class="th_details" colspan="5">Details</th>
23353           </tr>
23354           <tr class="entry_cont">
23355             <td class="entry_details" colspan="5">
23356               <p>The coordinate system is that of <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>,<wbr/> with
23357 <code>(0,<wbr/> 0)</code> being the top-left pixel of the active array.<wbr/></p>
23358 <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF</p>
23359             </td>
23360           </tr>
23361
23362
23363           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23364            <!-- end of entry -->
23365
23366
23367           <tr class="entry" id="dynamic_android.statistics.faceScores">
23368             <td class="entry_name
23369              " rowspan="5">
23370               android.<wbr/>statistics.<wbr/>face<wbr/>Scores
23371             </td>
23372             <td class="entry_type">
23373                 <span class="entry_type_name">byte</span>
23374                 <span class="entry_type_container">x</span>
23375
23376                 <span class="entry_type_array">
23377                   n
23378                 </span>
23379               <span class="entry_type_visibility"> [ndk_public]</span>
23380
23381
23382               <span class="entry_type_hwlevel">[legacy] </span>
23383
23384
23385
23386
23387             </td> <!-- entry_type -->
23388
23389             <td class="entry_description">
23390               <p>List of the face confidence scores for
23391 detected faces</p>
23392             </td>
23393
23394             <td class="entry_units">
23395             </td>
23396
23397             <td class="entry_range">
23398               <p>1-100</p>
23399             </td>
23400
23401             <td class="entry_tags">
23402               <ul class="entry_tags">
23403                   <li><a href="#tag_BC">BC</a></li>
23404               </ul>
23405             </td>
23406
23407           </tr>
23408           <tr class="entries_header">
23409             <th class="th_details" colspan="5">Details</th>
23410           </tr>
23411           <tr class="entry_cont">
23412             <td class="entry_details" colspan="5">
23413               <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> != OFF.<wbr/></p>
23414             </td>
23415           </tr>
23416
23417           <tr class="entries_header">
23418             <th class="th_details" colspan="5">HAL Implementation Details</th>
23419           </tr>
23420           <tr class="entry_cont">
23421             <td class="entry_details" colspan="5">
23422               <p>The value should be meaningful (for example,<wbr/> setting 100 at
23423 all times is illegal).<wbr/></p>
23424             </td>
23425           </tr>
23426
23427           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23428            <!-- end of entry -->
23429
23430
23431           <tr class="entry" id="dynamic_android.statistics.faces">
23432             <td class="entry_name
23433              " rowspan="3">
23434               android.<wbr/>statistics.<wbr/>faces
23435             </td>
23436             <td class="entry_type">
23437                 <span class="entry_type_name">int32</span>
23438                 <span class="entry_type_container">x</span>
23439
23440                 <span class="entry_type_array">
23441                   n
23442                 </span>
23443               <span class="entry_type_visibility"> [java_public as face]</span>
23444
23445               <span class="entry_type_synthetic">[synthetic] </span>
23446
23447               <span class="entry_type_hwlevel">[legacy] </span>
23448
23449
23450
23451
23452             </td> <!-- entry_type -->
23453
23454             <td class="entry_description">
23455               <p>List of the faces detected through camera face detection
23456 in this capture.<wbr/></p>
23457             </td>
23458
23459             <td class="entry_units">
23460             </td>
23461
23462             <td class="entry_range">
23463             </td>
23464
23465             <td class="entry_tags">
23466             </td>
23467
23468           </tr>
23469           <tr class="entries_header">
23470             <th class="th_details" colspan="5">Details</th>
23471           </tr>
23472           <tr class="entry_cont">
23473             <td class="entry_details" colspan="5">
23474               <p>Only available if <a href="#controls_android.statistics.faceDetectMode">android.<wbr/>statistics.<wbr/>face<wbr/>Detect<wbr/>Mode</a> <code>!=</code> OFF.<wbr/></p>
23475             </td>
23476           </tr>
23477
23478
23479           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23480            <!-- end of entry -->
23481
23482
23483           <tr class="entry" id="dynamic_android.statistics.histogram">
23484             <td class="entry_name
23485              " rowspan="3">
23486               android.<wbr/>statistics.<wbr/>histogram
23487             </td>
23488             <td class="entry_type">
23489                 <span class="entry_type_name">int32</span>
23490                 <span class="entry_type_container">x</span>
23491
23492                 <span class="entry_type_array">
23493                   n x 3
23494                 </span>
23495               <span class="entry_type_visibility"> [system]</span>
23496
23497
23498
23499
23500                 <div class="entry_type_notes">count of pixels for each color channel that fall into each histogram bucket,<wbr/> scaled to be between 0 and maxHistogramCount</div>
23501
23502
23503             </td> <!-- entry_type -->
23504
23505             <td class="entry_description">
23506               <p>A 3-channel histogram based on the raw
23507 sensor data</p>
23508             </td>
23509
23510             <td class="entry_units">
23511             </td>
23512
23513             <td class="entry_range">
23514             </td>
23515
23516             <td class="entry_tags">
23517               <ul class="entry_tags">
23518                   <li><a href="#tag_FUTURE">FUTURE</a></li>
23519               </ul>
23520             </td>
23521
23522           </tr>
23523           <tr class="entries_header">
23524             <th class="th_details" colspan="5">Details</th>
23525           </tr>
23526           <tr class="entry_cont">
23527             <td class="entry_details" colspan="5">
23528               <p>The k'th bucket (0-based) covers the input range
23529 (with w = <a href="#static_android.sensor.info.whiteLevel">android.<wbr/>sensor.<wbr/>info.<wbr/>white<wbr/>Level</a>) of [ k * w/<wbr/>N,<wbr/>
23530 (k + 1) * w /<wbr/> N ).<wbr/> If only a monochrome sharpness map is
23531 supported,<wbr/> all channels should have the same data</p>
23532             </td>
23533           </tr>
23534
23535
23536           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23537            <!-- end of entry -->
23538
23539
23540           <tr class="entry" id="dynamic_android.statistics.histogramMode">
23541             <td class="entry_name
23542              " rowspan="1">
23543               android.<wbr/>statistics.<wbr/>histogram<wbr/>Mode
23544             </td>
23545             <td class="entry_type">
23546                 <span class="entry_type_name entry_type_name_enum">byte</span>
23547
23548               <span class="entry_type_visibility"> [system as boolean]</span>
23549
23550
23551
23552
23553
23554                 <ul class="entry_type_enum">
23555                   <li>
23556                     <span class="entry_type_enum_name">OFF</span>
23557                   </li>
23558                   <li>
23559                     <span class="entry_type_enum_name">ON</span>
23560                   </li>
23561                 </ul>
23562
23563             </td> <!-- entry_type -->
23564
23565             <td class="entry_description">
23566               <p>Operating mode for histogram
23567 generation</p>
23568             </td>
23569
23570             <td class="entry_units">
23571             </td>
23572
23573             <td class="entry_range">
23574             </td>
23575
23576             <td class="entry_tags">
23577               <ul class="entry_tags">
23578                   <li><a href="#tag_FUTURE">FUTURE</a></li>
23579               </ul>
23580             </td>
23581
23582           </tr>
23583
23584
23585           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23586            <!-- end of entry -->
23587
23588
23589           <tr class="entry" id="dynamic_android.statistics.sharpnessMap">
23590             <td class="entry_name
23591              " rowspan="3">
23592               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map
23593             </td>
23594             <td class="entry_type">
23595                 <span class="entry_type_name">int32</span>
23596                 <span class="entry_type_container">x</span>
23597
23598                 <span class="entry_type_array">
23599                   n x m x 3
23600                 </span>
23601               <span class="entry_type_visibility"> [system]</span>
23602
23603
23604
23605
23606                 <div class="entry_type_notes">estimated sharpness for each region of the input image.<wbr/> Normalized to be between 0 and maxSharpnessMapValue.<wbr/> Higher values mean sharper (better focused)</div>
23607
23608
23609             </td> <!-- entry_type -->
23610
23611             <td class="entry_description">
23612               <p>A 3-channel sharpness map,<wbr/> based on the raw
23613 sensor data</p>
23614             </td>
23615
23616             <td class="entry_units">
23617             </td>
23618
23619             <td class="entry_range">
23620             </td>
23621
23622             <td class="entry_tags">
23623               <ul class="entry_tags">
23624                   <li><a href="#tag_FUTURE">FUTURE</a></li>
23625               </ul>
23626             </td>
23627
23628           </tr>
23629           <tr class="entries_header">
23630             <th class="th_details" colspan="5">Details</th>
23631           </tr>
23632           <tr class="entry_cont">
23633             <td class="entry_details" colspan="5">
23634               <p>If only a monochrome sharpness map is supported,<wbr/>
23635 all channels should have the same data</p>
23636             </td>
23637           </tr>
23638
23639
23640           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23641            <!-- end of entry -->
23642
23643
23644           <tr class="entry" id="dynamic_android.statistics.sharpnessMapMode">
23645             <td class="entry_name
23646              " rowspan="1">
23647               android.<wbr/>statistics.<wbr/>sharpness<wbr/>Map<wbr/>Mode
23648             </td>
23649             <td class="entry_type">
23650                 <span class="entry_type_name entry_type_name_enum">byte</span>
23651
23652               <span class="entry_type_visibility"> [system as boolean]</span>
23653
23654
23655
23656
23657
23658                 <ul class="entry_type_enum">
23659                   <li>
23660                     <span class="entry_type_enum_name">OFF</span>
23661                   </li>
23662                   <li>
23663                     <span class="entry_type_enum_name">ON</span>
23664                   </li>
23665                 </ul>
23666
23667             </td> <!-- entry_type -->
23668
23669             <td class="entry_description">
23670               <p>Operating mode for sharpness map
23671 generation</p>
23672             </td>
23673
23674             <td class="entry_units">
23675             </td>
23676
23677             <td class="entry_range">
23678             </td>
23679
23680             <td class="entry_tags">
23681               <ul class="entry_tags">
23682                   <li><a href="#tag_FUTURE">FUTURE</a></li>
23683               </ul>
23684             </td>
23685
23686           </tr>
23687
23688
23689           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23690            <!-- end of entry -->
23691
23692
23693           <tr class="entry" id="dynamic_android.statistics.lensShadingCorrectionMap">
23694             <td class="entry_name
23695              " rowspan="3">
23696               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Correction<wbr/>Map
23697             </td>
23698             <td class="entry_type">
23699                 <span class="entry_type_name">byte</span>
23700
23701               <span class="entry_type_visibility"> [java_public as lensShadingMap]</span>
23702
23703
23704               <span class="entry_type_hwlevel">[full] </span>
23705
23706
23707
23708
23709             </td> <!-- entry_type -->
23710
23711             <td class="entry_description">
23712               <p>The shading map is a low-resolution floating-point map
23713 that lists the coefficients used to correct for vignetting,<wbr/> for each
23714 Bayer color channel.<wbr/></p>
23715             </td>
23716
23717             <td class="entry_units">
23718             </td>
23719
23720             <td class="entry_range">
23721               <p>Each gain factor is &gt;= 1</p>
23722             </td>
23723
23724             <td class="entry_tags">
23725             </td>
23726
23727           </tr>
23728           <tr class="entries_header">
23729             <th class="th_details" colspan="5">Details</th>
23730           </tr>
23731           <tr class="entry_cont">
23732             <td class="entry_details" colspan="5">
23733               <p>The map provided here is the same map that is used by the camera device to
23734 correct both color shading and vignetting for output non-RAW images.<wbr/></p>
23735 <p>When there is no lens shading correction applied to RAW
23736 output images (<a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a> <code>==</code>
23737 false),<wbr/> this map is the complete lens shading correction
23738 map; when there is some lens shading correction applied to
23739 the RAW output image (<a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a><code>==</code> true),<wbr/> this map reports the remaining lens shading
23740 correction map that needs to be applied to get shading
23741 corrected images that match the camera device's output for
23742 non-RAW formats.<wbr/></p>
23743 <p>For a complete shading correction map,<wbr/> the least shaded
23744 section of the image will have a gain factor of 1; all
23745 other sections will have gains above 1.<wbr/></p>
23746 <p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
23747 will take into account the colorCorrection settings.<wbr/></p>
23748 <p>The shading map is for the entire active pixel array,<wbr/> and is not
23749 affected by the crop region specified in the request.<wbr/> Each shading map
23750 entry is the value of the shading compensation map over a specific
23751 pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
23752 map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
23753 (x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
23754 pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
23755 The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
23756 <p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
23757 channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
23758 The shading map is stored in a fully interleaved format.<wbr/></p>
23759 <p>The shading map will generally have on the order of 30-40 rows and columns,<wbr/>
23760 and will be smaller than 64x64.<wbr/></p>
23761 <p>As an example,<wbr/> given a very small map defined as:</p>
23762 <pre><code>width,<wbr/>height = [ 4,<wbr/> 3 ]
23763 values =
23764 [ 1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>
23765     1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>3,<wbr/>
23766   1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>1,<wbr/>  1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/>
23767     1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>2,<wbr/>
23768   1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/>   1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/>
23769     1.<wbr/>2,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3 ]
23770 </code></pre>
23771 <p>The low-resolution scaling map images for each channel are
23772 (displayed using nearest-neighbor interpolation):</p>
23773 <p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
23774 <img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
23775 <img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
23776 <img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
23777 <p>As a visualization only,<wbr/> inverting the full-color map to recover an
23778 image of a gray wall (using bicubic interpolation for visual quality) as captured by the sensor gives:</p>
23779 <p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
23780             </td>
23781           </tr>
23782
23783
23784           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23785            <!-- end of entry -->
23786
23787
23788           <tr class="entry" id="dynamic_android.statistics.lensShadingMap">
23789             <td class="entry_name
23790              " rowspan="5">
23791               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map
23792             </td>
23793             <td class="entry_type">
23794                 <span class="entry_type_name">float</span>
23795                 <span class="entry_type_container">x</span>
23796
23797                 <span class="entry_type_array">
23798                   4 x n x m
23799                 </span>
23800               <span class="entry_type_visibility"> [ndk_public]</span>
23801
23802
23803               <span class="entry_type_hwlevel">[full] </span>
23804
23805
23806                 <div class="entry_type_notes">2D array of float gain factors per channel to correct lens shading</div>
23807
23808
23809             </td> <!-- entry_type -->
23810
23811             <td class="entry_description">
23812               <p>The shading map is a low-resolution floating-point map
23813 that lists the coefficients used to correct for vignetting and color shading,<wbr/>
23814 for each Bayer color channel of RAW image data.<wbr/></p>
23815             </td>
23816
23817             <td class="entry_units">
23818             </td>
23819
23820             <td class="entry_range">
23821               <p>Each gain factor is &gt;= 1</p>
23822             </td>
23823
23824             <td class="entry_tags">
23825             </td>
23826
23827           </tr>
23828           <tr class="entries_header">
23829             <th class="th_details" colspan="5">Details</th>
23830           </tr>
23831           <tr class="entry_cont">
23832             <td class="entry_details" colspan="5">
23833               <p>The map provided here is the same map that is used by the camera device to
23834 correct both color shading and vignetting for output non-RAW images.<wbr/></p>
23835 <p>When there is no lens shading correction applied to RAW
23836 output images (<a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a> <code>==</code>
23837 false),<wbr/> this map is the complete lens shading correction
23838 map; when there is some lens shading correction applied to
23839 the RAW output image (<a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a><code>==</code> true),<wbr/> this map reports the remaining lens shading
23840 correction map that needs to be applied to get shading
23841 corrected images that match the camera device's output for
23842 non-RAW formats.<wbr/></p>
23843 <p>For a complete shading correction map,<wbr/> the least shaded
23844 section of the image will have a gain factor of 1; all
23845 other sections will have gains above 1.<wbr/></p>
23846 <p>When <a href="#controls_android.colorCorrection.mode">android.<wbr/>color<wbr/>Correction.<wbr/>mode</a> = TRANSFORM_<wbr/>MATRIX,<wbr/> the map
23847 will take into account the colorCorrection settings.<wbr/></p>
23848 <p>The shading map is for the entire active pixel array,<wbr/> and is not
23849 affected by the crop region specified in the request.<wbr/> Each shading map
23850 entry is the value of the shading compensation map over a specific
23851 pixel on the sensor.<wbr/>  Specifically,<wbr/> with a (N x M) resolution shading
23852 map,<wbr/> and an active pixel array size (W x H),<wbr/> shading map entry
23853 (x,<wbr/>y) ϵ (0 ...<wbr/> N-1,<wbr/> 0 ...<wbr/> M-1) is the value of the shading map at
23854 pixel ( ((W-1)/<wbr/>(N-1)) * x,<wbr/> ((H-1)/<wbr/>(M-1)) * y) for the four color channels.<wbr/>
23855 The map is assumed to be bilinearly interpolated between the sample points.<wbr/></p>
23856 <p>The channel order is [R,<wbr/> Geven,<wbr/> Godd,<wbr/> B],<wbr/> where Geven is the green
23857 channel for the even rows of a Bayer pattern,<wbr/> and Godd is the odd rows.<wbr/>
23858 The shading map is stored in a fully interleaved format,<wbr/> and its size
23859 is provided in the camera static metadata by <a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a>.<wbr/></p>
23860 <p>The shading map will generally have on the order of 30-40 rows and columns,<wbr/>
23861 and will be smaller than 64x64.<wbr/></p>
23862 <p>As an example,<wbr/> given a very small map defined as:</p>
23863 <pre><code><a href="#static_android.lens.info.shadingMapSize">android.<wbr/>lens.<wbr/>info.<wbr/>shading<wbr/>Map<wbr/>Size</a> = [ 4,<wbr/> 3 ]
23864 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> =
23865 [ 1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/>
23866     1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>3,<wbr/>
23867   1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>1,<wbr/>  1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/>
23868     1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/>  1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/> 1.<wbr/>25,<wbr/> 1.<wbr/>2,<wbr/>
23869   1.<wbr/>3,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3,<wbr/>   1.<wbr/>2,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>2,<wbr/>
23870     1.<wbr/>2,<wbr/> 1.<wbr/>1,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>2,<wbr/>  1.<wbr/>3,<wbr/> 1.<wbr/>15,<wbr/> 1.<wbr/>2,<wbr/> 1.<wbr/>3 ]
23871 </code></pre>
23872 <p>The low-resolution scaling map images for each channel are
23873 (displayed using nearest-neighbor interpolation):</p>
23874 <p><img alt="Red lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/red_shading.png"/>
23875 <img alt="Green (even rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_e_shading.png"/>
23876 <img alt="Green (odd rows) lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/green_o_shading.png"/>
23877 <img alt="Blue lens shading map" src="images/camera2/metadata/android.statistics.lensShadingMap/blue_shading.png"/></p>
23878 <p>As a visualization only,<wbr/> inverting the full-color map to recover an
23879 image of a gray wall (using bicubic interpolation for visual quality)
23880 as captured by the sensor gives:</p>
23881 <p><img alt="Image of a uniform white wall (inverse shading map)" src="images/camera2/metadata/android.statistics.lensShadingMap/inv_shading.png"/></p>
23882 <p>Note that the RAW image data might be subject to lens shading
23883 correction not reported on this map.<wbr/> Query
23884 <a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a> to see if RAW image data has subject
23885 to lens shading correction.<wbr/> If <a href="#static_android.sensor.info.lensShadingApplied">android.<wbr/>sensor.<wbr/>info.<wbr/>lens<wbr/>Shading<wbr/>Applied</a>
23886 is TRUE,<wbr/> the RAW image data is subject to partial or full lens shading
23887 correction.<wbr/> In the case full lens shading correction is applied to RAW
23888 images,<wbr/> the gain factor map reported in this key will contain all 1.<wbr/>0 gains.<wbr/>
23889 In other words,<wbr/> the map reported in this key is the remaining lens shading
23890 that needs to be applied on the RAW image to get images without lens shading
23891 artifacts.<wbr/> See <a href="#static_android.request.maxNumOutputRaw">android.<wbr/>request.<wbr/>max<wbr/>Num<wbr/>Output<wbr/>Raw</a> for a list of RAW image
23892 formats.<wbr/></p>
23893             </td>
23894           </tr>
23895
23896           <tr class="entries_header">
23897             <th class="th_details" colspan="5">HAL Implementation Details</th>
23898           </tr>
23899           <tr class="entry_cont">
23900             <td class="entry_details" colspan="5">
23901               <p>The lens shading map calculation may depend on exposure and white balance statistics.<wbr/>
23902 When AE and AWB are in AUTO modes
23903 (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>!=</code> OFF and <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>!=</code> OFF),<wbr/> the HAL
23904 may have all the information it need to generate most accurate lens shading map.<wbr/> When
23905 AE or AWB are in manual mode
23906 (<a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> <code>==</code> OFF or <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a> <code>==</code> OFF),<wbr/> the shading map
23907 may be adversely impacted by manual exposure or white balance parameters.<wbr/> To avoid
23908 generating unreliable shading map data,<wbr/> the HAL may choose to lock the shading map with
23909 the latest known good map generated when the AE and AWB are in AUTO modes.<wbr/></p>
23910             </td>
23911           </tr>
23912
23913           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23914            <!-- end of entry -->
23915
23916
23917           <tr class="entry" id="dynamic_android.statistics.predictedColorGains">
23918             <td class="entry_name
23919                 entry_name_deprecated
23920              " rowspan="3">
23921               android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Gains
23922             </td>
23923             <td class="entry_type">
23924                 <span class="entry_type_name">float</span>
23925                 <span class="entry_type_container">x</span>
23926
23927                 <span class="entry_type_array">
23928                   4
23929                 </span>
23930               <span class="entry_type_visibility"> [hidden]</span>
23931
23932
23933
23934               <span class="entry_type_deprecated">[deprecated] </span>
23935
23936                 <div class="entry_type_notes">A 1D array of floats for 4 color channel gains</div>
23937
23938
23939             </td> <!-- entry_type -->
23940
23941             <td class="entry_description">
23942               <p>The best-fit color channel gains calculated
23943 by the camera device's statistics units for the current output frame.<wbr/></p>
23944             </td>
23945
23946             <td class="entry_units">
23947             </td>
23948
23949             <td class="entry_range">
23950               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
23951             </td>
23952
23953             <td class="entry_tags">
23954             </td>
23955
23956           </tr>
23957           <tr class="entries_header">
23958             <th class="th_details" colspan="5">Details</th>
23959           </tr>
23960           <tr class="entry_cont">
23961             <td class="entry_details" colspan="5">
23962               <p>This may be different than the gains used for this frame,<wbr/>
23963 since statistics processing on data from a new frame
23964 typically completes after the transform has already been
23965 applied to that frame.<wbr/></p>
23966 <p>The 4 channel gains are defined in Bayer domain,<wbr/>
23967 see <a href="#controls_android.colorCorrection.gains">android.<wbr/>color<wbr/>Correction.<wbr/>gains</a> for details.<wbr/></p>
23968 <p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
23969 regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
23970             </td>
23971           </tr>
23972
23973
23974           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
23975            <!-- end of entry -->
23976
23977
23978           <tr class="entry" id="dynamic_android.statistics.predictedColorTransform">
23979             <td class="entry_name
23980                 entry_name_deprecated
23981              " rowspan="3">
23982               android.<wbr/>statistics.<wbr/>predicted<wbr/>Color<wbr/>Transform
23983             </td>
23984             <td class="entry_type">
23985                 <span class="entry_type_name">rational</span>
23986                 <span class="entry_type_container">x</span>
23987
23988                 <span class="entry_type_array">
23989                   3 x 3
23990                 </span>
23991               <span class="entry_type_visibility"> [hidden]</span>
23992
23993
23994
23995               <span class="entry_type_deprecated">[deprecated] </span>
23996
23997                 <div class="entry_type_notes">3x3 rational matrix in row-major order</div>
23998
23999
24000             </td> <!-- entry_type -->
24001
24002             <td class="entry_description">
24003               <p>The best-fit color transform matrix estimate
24004 calculated by the camera device's statistics units for the current
24005 output frame.<wbr/></p>
24006             </td>
24007
24008             <td class="entry_units">
24009             </td>
24010
24011             <td class="entry_range">
24012               <p><span class="entry_range_deprecated">Deprecated</span>. Do not use.</p>
24013             </td>
24014
24015             <td class="entry_tags">
24016             </td>
24017
24018           </tr>
24019           <tr class="entries_header">
24020             <th class="th_details" colspan="5">Details</th>
24021           </tr>
24022           <tr class="entry_cont">
24023             <td class="entry_details" colspan="5">
24024               <p>The camera device will provide the estimate from its
24025 statistics unit on the white balance transforms to use
24026 for the next frame.<wbr/> These are the values the camera device believes
24027 are the best fit for the current output frame.<wbr/> This may
24028 be different than the transform used for this frame,<wbr/> since
24029 statistics processing on data from a new frame typically
24030 completes after the transform has already been applied to
24031 that frame.<wbr/></p>
24032 <p>These estimates must be provided for all frames,<wbr/> even if
24033 capture settings and color transforms are set by the application.<wbr/></p>
24034 <p>This value should always be calculated by the auto-white balance (AWB) block,<wbr/>
24035 regardless of the android.<wbr/>control.<wbr/>* current values.<wbr/></p>
24036             </td>
24037           </tr>
24038
24039
24040           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24041            <!-- end of entry -->
24042
24043
24044           <tr class="entry" id="dynamic_android.statistics.sceneFlicker">
24045             <td class="entry_name
24046              " rowspan="3">
24047               android.<wbr/>statistics.<wbr/>scene<wbr/>Flicker
24048             </td>
24049             <td class="entry_type">
24050                 <span class="entry_type_name entry_type_name_enum">byte</span>
24051
24052               <span class="entry_type_visibility"> [public]</span>
24053
24054
24055               <span class="entry_type_hwlevel">[full] </span>
24056
24057
24058
24059                 <ul class="entry_type_enum">
24060                   <li>
24061                     <span class="entry_type_enum_name">NONE</span>
24062                     <span class="entry_type_enum_notes"><p>The camera device does not detect any flickering illumination
24063 in the current scene.<wbr/></p></span>
24064                   </li>
24065                   <li>
24066                     <span class="entry_type_enum_name">50HZ</span>
24067                     <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 50Hz
24068 in the current scene.<wbr/></p></span>
24069                   </li>
24070                   <li>
24071                     <span class="entry_type_enum_name">60HZ</span>
24072                     <span class="entry_type_enum_notes"><p>The camera device detects illumination flickering at 60Hz
24073 in the current scene.<wbr/></p></span>
24074                   </li>
24075                 </ul>
24076
24077             </td> <!-- entry_type -->
24078
24079             <td class="entry_description">
24080               <p>The camera device estimated scene illumination lighting
24081 frequency.<wbr/></p>
24082             </td>
24083
24084             <td class="entry_units">
24085             </td>
24086
24087             <td class="entry_range">
24088             </td>
24089
24090             <td class="entry_tags">
24091             </td>
24092
24093           </tr>
24094           <tr class="entries_header">
24095             <th class="th_details" colspan="5">Details</th>
24096           </tr>
24097           <tr class="entry_cont">
24098             <td class="entry_details" colspan="5">
24099               <p>Many light sources,<wbr/> such as most fluorescent lights,<wbr/> flicker at a rate
24100 that depends on the local utility power standards.<wbr/> This flicker must be
24101 accounted for by auto-exposure routines to avoid artifacts in captured images.<wbr/>
24102 The camera device uses this entry to tell the application what the scene
24103 illuminant frequency is.<wbr/></p>
24104 <p>When manual exposure control is enabled
24105 (<code><a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a> == OFF</code> or <code><a href="#controls_android.control.mode">android.<wbr/>control.<wbr/>mode</a> ==
24106 OFF</code>),<wbr/> the <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> doesn't perform
24107 antibanding,<wbr/> and the application can ensure it selects
24108 exposure times that do not cause banding issues by looking
24109 into this metadata field.<wbr/> See
24110 <a href="#controls_android.control.aeAntibandingMode">android.<wbr/>control.<wbr/>ae<wbr/>Antibanding<wbr/>Mode</a> for more details.<wbr/></p>
24111 <p>Reports NONE if there doesn't appear to be flickering illumination.<wbr/></p>
24112             </td>
24113           </tr>
24114
24115
24116           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24117            <!-- end of entry -->
24118
24119
24120           <tr class="entry" id="dynamic_android.statistics.hotPixelMapMode">
24121             <td class="entry_name
24122              " rowspan="3">
24123               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map<wbr/>Mode
24124             </td>
24125             <td class="entry_type">
24126                 <span class="entry_type_name entry_type_name_enum">byte</span>
24127
24128               <span class="entry_type_visibility"> [public as boolean]</span>
24129
24130
24131
24132
24133
24134                 <ul class="entry_type_enum">
24135                   <li>
24136                     <span class="entry_type_enum_name">OFF</span>
24137                     <span class="entry_type_enum_notes"><p>Hot pixel map production is disabled.<wbr/></p></span>
24138                   </li>
24139                   <li>
24140                     <span class="entry_type_enum_name">ON</span>
24141                     <span class="entry_type_enum_notes"><p>Hot pixel map production is enabled.<wbr/></p></span>
24142                   </li>
24143                 </ul>
24144
24145             </td> <!-- entry_type -->
24146
24147             <td class="entry_description">
24148               <p>Operating mode for hot pixel map generation.<wbr/></p>
24149             </td>
24150
24151             <td class="entry_units">
24152             </td>
24153
24154             <td class="entry_range">
24155               <p><a href="#static_android.statistics.info.availableHotPixelMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Hot<wbr/>Pixel<wbr/>Map<wbr/>Modes</a></p>
24156             </td>
24157
24158             <td class="entry_tags">
24159               <ul class="entry_tags">
24160                   <li><a href="#tag_V1">V1</a></li>
24161                   <li><a href="#tag_RAW">RAW</a></li>
24162               </ul>
24163             </td>
24164
24165           </tr>
24166           <tr class="entries_header">
24167             <th class="th_details" colspan="5">Details</th>
24168           </tr>
24169           <tr class="entry_cont">
24170             <td class="entry_details" colspan="5">
24171               <p>If set to <code>true</code>,<wbr/> a hot pixel map is returned in <a href="#dynamic_android.statistics.hotPixelMap">android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map</a>.<wbr/>
24172 If set to <code>false</code>,<wbr/> no hot pixel map will be returned.<wbr/></p>
24173             </td>
24174           </tr>
24175
24176
24177           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24178            <!-- end of entry -->
24179
24180
24181           <tr class="entry" id="dynamic_android.statistics.hotPixelMap">
24182             <td class="entry_name
24183              " rowspan="5">
24184               android.<wbr/>statistics.<wbr/>hot<wbr/>Pixel<wbr/>Map
24185             </td>
24186             <td class="entry_type">
24187                 <span class="entry_type_name">int32</span>
24188                 <span class="entry_type_container">x</span>
24189
24190                 <span class="entry_type_array">
24191                   2 x n
24192                 </span>
24193               <span class="entry_type_visibility"> [public as point]</span>
24194
24195
24196
24197
24198                 <div class="entry_type_notes">list of coordinates based on android.<wbr/>sensor.<wbr/>pixel<wbr/>Array<wbr/>Size</div>
24199
24200
24201             </td> <!-- entry_type -->
24202
24203             <td class="entry_description">
24204               <p>List of <code>(x,<wbr/> y)</code> coordinates of hot/<wbr/>defective pixels on the sensor.<wbr/></p>
24205             </td>
24206
24207             <td class="entry_units">
24208             </td>
24209
24210             <td class="entry_range">
24211               <p>n &lt;= number of pixels on the sensor.<wbr/>
24212 The <code>(x,<wbr/> y)</code> coordinates must be bounded by
24213 <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/></p>
24214             </td>
24215
24216             <td class="entry_tags">
24217               <ul class="entry_tags">
24218                   <li><a href="#tag_V1">V1</a></li>
24219                   <li><a href="#tag_RAW">RAW</a></li>
24220               </ul>
24221             </td>
24222
24223           </tr>
24224           <tr class="entries_header">
24225             <th class="th_details" colspan="5">Details</th>
24226           </tr>
24227           <tr class="entry_cont">
24228             <td class="entry_details" colspan="5">
24229               <p>A coordinate <code>(x,<wbr/> y)</code> must lie between <code>(0,<wbr/> 0)</code>,<wbr/> and
24230 <code>(width - 1,<wbr/> height - 1)</code> (inclusive),<wbr/> which are the top-left and
24231 bottom-right of the pixel array,<wbr/> respectively.<wbr/> The width and
24232 height dimensions are given in <a href="#static_android.sensor.info.pixelArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>pixel<wbr/>Array<wbr/>Size</a>.<wbr/>
24233 This may include hot pixels that lie outside of the active array
24234 bounds given by <a href="#static_android.sensor.info.activeArraySize">android.<wbr/>sensor.<wbr/>info.<wbr/>active<wbr/>Array<wbr/>Size</a>.<wbr/></p>
24235             </td>
24236           </tr>
24237
24238           <tr class="entries_header">
24239             <th class="th_details" colspan="5">HAL Implementation Details</th>
24240           </tr>
24241           <tr class="entry_cont">
24242             <td class="entry_details" colspan="5">
24243               <p>A hotpixel map contains the coordinates of pixels on the camera
24244 sensor that do report valid values (usually due to defects in
24245 the camera sensor).<wbr/> This includes pixels that are stuck at certain
24246 values,<wbr/> or have a response that does not accuractly encode the
24247 incoming light from the scene.<wbr/></p>
24248 <p>To avoid performance issues,<wbr/> there should be significantly fewer hot
24249 pixels than actual pixels on the camera sensor.<wbr/></p>
24250             </td>
24251           </tr>
24252
24253           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24254            <!-- end of entry -->
24255
24256
24257           <tr class="entry" id="dynamic_android.statistics.lensShadingMapMode">
24258             <td class="entry_name
24259              " rowspan="3">
24260               android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map<wbr/>Mode
24261             </td>
24262             <td class="entry_type">
24263                 <span class="entry_type_name entry_type_name_enum">byte</span>
24264
24265               <span class="entry_type_visibility"> [public]</span>
24266
24267
24268               <span class="entry_type_hwlevel">[full] </span>
24269
24270
24271
24272                 <ul class="entry_type_enum">
24273                   <li>
24274                     <span class="entry_type_enum_name">OFF</span>
24275                     <span class="entry_type_enum_notes"><p>Do not include a lens shading map in the capture result.<wbr/></p></span>
24276                   </li>
24277                   <li>
24278                     <span class="entry_type_enum_name">ON</span>
24279                     <span class="entry_type_enum_notes"><p>Include a lens shading map in the capture result.<wbr/></p></span>
24280                   </li>
24281                 </ul>
24282
24283             </td> <!-- entry_type -->
24284
24285             <td class="entry_description">
24286               <p>Whether the camera device will output the lens
24287 shading map in output result metadata.<wbr/></p>
24288             </td>
24289
24290             <td class="entry_units">
24291             </td>
24292
24293             <td class="entry_range">
24294               <p><a href="#static_android.statistics.info.availableLensShadingMapModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Lens<wbr/>Shading<wbr/>Map<wbr/>Modes</a></p>
24295             </td>
24296
24297             <td class="entry_tags">
24298               <ul class="entry_tags">
24299                   <li><a href="#tag_RAW">RAW</a></li>
24300               </ul>
24301             </td>
24302
24303           </tr>
24304           <tr class="entries_header">
24305             <th class="th_details" colspan="5">Details</th>
24306           </tr>
24307           <tr class="entry_cont">
24308             <td class="entry_details" colspan="5">
24309               <p>When set to ON,<wbr/>
24310 <a href="#dynamic_android.statistics.lensShadingMap">android.<wbr/>statistics.<wbr/>lens<wbr/>Shading<wbr/>Map</a> will be provided in
24311 the output result metadata.<wbr/></p>
24312 <p>ON is always supported on devices with the RAW capability.<wbr/></p>
24313             </td>
24314           </tr>
24315
24316
24317           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24318            <!-- end of entry -->
24319
24320
24321
24322       <!-- end of kind -->
24323       </tbody>
24324
24325   <!-- end of section -->
24326   <tr><td colspan="6" id="section_tonemap" class="section">tonemap</td></tr>
24327
24328
24329       <tr><td colspan="6" class="kind">controls</td></tr>
24330
24331       <thead class="entries_header">
24332         <tr>
24333           <th class="th_name">Property Name</th>
24334           <th class="th_type">Type</th>
24335           <th class="th_description">Description</th>
24336           <th class="th_units">Units</th>
24337           <th class="th_range">Range</th>
24338           <th class="th_tags">Tags</th>
24339         </tr>
24340       </thead>
24341
24342       <tbody>
24343
24344
24345
24346
24347
24348
24349
24350
24351
24352
24353           <tr class="entry" id="controls_android.tonemap.curveBlue">
24354             <td class="entry_name
24355              " rowspan="3">
24356               android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
24357             </td>
24358             <td class="entry_type">
24359                 <span class="entry_type_name">float</span>
24360                 <span class="entry_type_container">x</span>
24361
24362                 <span class="entry_type_array">
24363                   n x 2
24364                 </span>
24365               <span class="entry_type_visibility"> [ndk_public]</span>
24366
24367
24368               <span class="entry_type_hwlevel">[full] </span>
24369
24370
24371                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
24372
24373
24374             </td> <!-- entry_type -->
24375
24376             <td class="entry_description">
24377               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
24378 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24379 CONTRAST_<wbr/>CURVE.<wbr/></p>
24380             </td>
24381
24382             <td class="entry_units">
24383             </td>
24384
24385             <td class="entry_range">
24386             </td>
24387
24388             <td class="entry_tags">
24389             </td>
24390
24391           </tr>
24392           <tr class="entries_header">
24393             <th class="th_details" colspan="5">Details</th>
24394           </tr>
24395           <tr class="entry_cont">
24396             <td class="entry_details" colspan="5">
24397               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
24398             </td>
24399           </tr>
24400
24401
24402           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24403            <!-- end of entry -->
24404
24405
24406           <tr class="entry" id="controls_android.tonemap.curveGreen">
24407             <td class="entry_name
24408              " rowspan="3">
24409               android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
24410             </td>
24411             <td class="entry_type">
24412                 <span class="entry_type_name">float</span>
24413                 <span class="entry_type_container">x</span>
24414
24415                 <span class="entry_type_array">
24416                   n x 2
24417                 </span>
24418               <span class="entry_type_visibility"> [ndk_public]</span>
24419
24420
24421               <span class="entry_type_hwlevel">[full] </span>
24422
24423
24424                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
24425
24426
24427             </td> <!-- entry_type -->
24428
24429             <td class="entry_description">
24430               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
24431 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24432 CONTRAST_<wbr/>CURVE.<wbr/></p>
24433             </td>
24434
24435             <td class="entry_units">
24436             </td>
24437
24438             <td class="entry_range">
24439             </td>
24440
24441             <td class="entry_tags">
24442             </td>
24443
24444           </tr>
24445           <tr class="entries_header">
24446             <th class="th_details" colspan="5">Details</th>
24447           </tr>
24448           <tr class="entry_cont">
24449             <td class="entry_details" colspan="5">
24450               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
24451             </td>
24452           </tr>
24453
24454
24455           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24456            <!-- end of entry -->
24457
24458
24459           <tr class="entry" id="controls_android.tonemap.curveRed">
24460             <td class="entry_name
24461              " rowspan="5">
24462               android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
24463             </td>
24464             <td class="entry_type">
24465                 <span class="entry_type_name">float</span>
24466                 <span class="entry_type_container">x</span>
24467
24468                 <span class="entry_type_array">
24469                   n x 2
24470                 </span>
24471               <span class="entry_type_visibility"> [ndk_public]</span>
24472
24473
24474               <span class="entry_type_hwlevel">[full] </span>
24475
24476
24477                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
24478
24479
24480             </td> <!-- entry_type -->
24481
24482             <td class="entry_description">
24483               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
24484 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24485 CONTRAST_<wbr/>CURVE.<wbr/></p>
24486             </td>
24487
24488             <td class="entry_units">
24489             </td>
24490
24491             <td class="entry_range">
24492               <p>0-1 on both input and output coordinates,<wbr/> normalized
24493 as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
24494             </td>
24495
24496             <td class="entry_tags">
24497             </td>
24498
24499           </tr>
24500           <tr class="entries_header">
24501             <th class="th_details" colspan="5">Details</th>
24502           </tr>
24503           <tr class="entry_cont">
24504             <td class="entry_details" colspan="5">
24505               <p>Each channel's curve is defined by an array of control points:</p>
24506 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
24507   [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
24508 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
24509 <p>These are sorted in order of increasing <code>Pin</code>; it is
24510 required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
24511 define a complete mapping.<wbr/> For input values between control points,<wbr/>
24512 the camera device must linearly interpolate between the control
24513 points.<wbr/></p>
24514 <p>Each curve can have an independent number of points,<wbr/> and the number
24515 of points can be less than max (that is,<wbr/> the request doesn't have to
24516 always provide a curve with number of points equivalent to
24517 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
24518 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
24519 only specify the red channel and the precision is limited to 4
24520 digits,<wbr/> for conciseness.<wbr/></p>
24521 <p>Linear mapping:</p>
24522 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
24523 </code></pre>
24524 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
24525 <p>Invert mapping:</p>
24526 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 0 ]
24527 </code></pre>
24528 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
24529 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
24530 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
24531   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2920,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4002,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4812,<wbr/>
24532   0.<wbr/>2667,<wbr/> 0.<wbr/>5484,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6069,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6594,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7072,<wbr/>
24533   0.<wbr/>5333,<wbr/> 0.<wbr/>7515,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7928,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8317,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8685,<wbr/>
24534   0.<wbr/>8000,<wbr/> 0.<wbr/>9035,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9370,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9691,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
24535 </code></pre>
24536 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
24537 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
24538 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
24539   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2864,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4007,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4845,<wbr/>
24540   0.<wbr/>2667,<wbr/> 0.<wbr/>5532,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6125,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6652,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7130,<wbr/>
24541   0.<wbr/>5333,<wbr/> 0.<wbr/>7569,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7977,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8360,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8721,<wbr/>
24542   0.<wbr/>8000,<wbr/> 0.<wbr/>9063,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9389,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9701,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
24543 </code></pre>
24544 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
24545             </td>
24546           </tr>
24547
24548           <tr class="entries_header">
24549             <th class="th_details" colspan="5">HAL Implementation Details</th>
24550           </tr>
24551           <tr class="entry_cont">
24552             <td class="entry_details" colspan="5">
24553               <p>For good quality of mapping,<wbr/> at least 128 control points are
24554 preferred.<wbr/></p>
24555 <p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
24556 control points used as are available.<wbr/></p>
24557             </td>
24558           </tr>
24559
24560           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24561            <!-- end of entry -->
24562
24563
24564           <tr class="entry" id="controls_android.tonemap.curve">
24565             <td class="entry_name
24566              " rowspan="5">
24567               android.<wbr/>tonemap.<wbr/>curve
24568             </td>
24569             <td class="entry_type">
24570                 <span class="entry_type_name">float</span>
24571
24572               <span class="entry_type_visibility"> [java_public as tonemapCurve]</span>
24573
24574               <span class="entry_type_synthetic">[synthetic] </span>
24575
24576               <span class="entry_type_hwlevel">[full] </span>
24577
24578
24579
24580
24581             </td> <!-- entry_type -->
24582
24583             <td class="entry_description">
24584               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
24585 is CONTRAST_<wbr/>CURVE.<wbr/></p>
24586             </td>
24587
24588             <td class="entry_units">
24589             </td>
24590
24591             <td class="entry_range">
24592             </td>
24593
24594             <td class="entry_tags">
24595             </td>
24596
24597           </tr>
24598           <tr class="entries_header">
24599             <th class="th_details" colspan="5">Details</th>
24600           </tr>
24601           <tr class="entry_cont">
24602             <td class="entry_details" colspan="5">
24603               <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
24604 channels respectively.<wbr/> The following example uses the red channel as an
24605 example.<wbr/> The same logic applies to green and blue channel.<wbr/>
24606 Each channel's curve is defined by an array of control points:</p>
24607 <pre><code>curveRed =
24608   [ P0(in,<wbr/> out),<wbr/> P1(in,<wbr/> out),<wbr/> P2(in,<wbr/> out),<wbr/> P3(in,<wbr/> out),<wbr/> ...,<wbr/> PN(in,<wbr/> out) ]
24609 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
24610 <p>These are sorted in order of increasing <code>Pin</code>; it is always
24611 guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
24612 define a complete mapping.<wbr/> For input values between control points,<wbr/>
24613 the camera device must linearly interpolate between the control
24614 points.<wbr/></p>
24615 <p>Each curve can have an independent number of points,<wbr/> and the number
24616 of points can be less than max (that is,<wbr/> the request doesn't have to
24617 always provide a curve with number of points equivalent to
24618 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
24619 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
24620 only specify the red channel and the precision is limited to 4
24621 digits,<wbr/> for conciseness.<wbr/></p>
24622 <p>Linear mapping:</p>
24623 <pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
24624 </code></pre>
24625 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
24626 <p>Invert mapping:</p>
24627 <pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
24628 </code></pre>
24629 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
24630 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
24631 <pre><code>curveRed = [
24632   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2920),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4002),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4812),<wbr/>
24633   (0.<wbr/>2667,<wbr/> 0.<wbr/>5484),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6069),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6594),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7072),<wbr/>
24634   (0.<wbr/>5333,<wbr/> 0.<wbr/>7515),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7928),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8317),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8685),<wbr/>
24635   (0.<wbr/>8000,<wbr/> 0.<wbr/>9035),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9370),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9691),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
24636 </code></pre>
24637 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
24638 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
24639 <pre><code>curveRed = [
24640   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2864),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4007),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4845),<wbr/>
24641   (0.<wbr/>2667,<wbr/> 0.<wbr/>5532),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6125),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6652),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7130),<wbr/>
24642   (0.<wbr/>5333,<wbr/> 0.<wbr/>7569),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7977),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8360),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8721),<wbr/>
24643   (0.<wbr/>8000,<wbr/> 0.<wbr/>9063),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9389),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9701),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
24644 </code></pre>
24645 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
24646             </td>
24647           </tr>
24648
24649           <tr class="entries_header">
24650             <th class="th_details" colspan="5">HAL Implementation Details</th>
24651           </tr>
24652           <tr class="entry_cont">
24653             <td class="entry_details" colspan="5">
24654               <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
24655 curveBlue entries.<wbr/></p>
24656             </td>
24657           </tr>
24658
24659           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24660            <!-- end of entry -->
24661
24662
24663           <tr class="entry" id="controls_android.tonemap.mode">
24664             <td class="entry_name
24665              " rowspan="3">
24666               android.<wbr/>tonemap.<wbr/>mode
24667             </td>
24668             <td class="entry_type">
24669                 <span class="entry_type_name entry_type_name_enum">byte</span>
24670
24671               <span class="entry_type_visibility"> [public]</span>
24672
24673
24674               <span class="entry_type_hwlevel">[full] </span>
24675
24676
24677
24678                 <ul class="entry_type_enum">
24679                   <li>
24680                     <span class="entry_type_enum_name">CONTRAST_CURVE</span>
24681                     <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
24682 the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
24683 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
24684 for applying the tonemapping curve specified by
24685 <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
24686 <p>Must not slow down frame rate relative to raw
24687 sensor output.<wbr/></p></span>
24688                   </li>
24689                   <li>
24690                     <span class="entry_type_enum_name">FAST</span>
24691                     <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
24692 reducing frame rate compared to raw sensor output.<wbr/></p></span>
24693                   </li>
24694                   <li>
24695                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
24696                     <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
24697 the cost of possibly reduced frame rate compared to raw sensor output.<wbr/></p></span>
24698                   </li>
24699                   <li>
24700                     <span class="entry_type_enum_name">GAMMA_VALUE</span>
24701                     <span class="entry_type_enum_notes"><p>Use the gamma value specified in <a href="#controls_android.tonemap.gamma">android.<wbr/>tonemap.<wbr/>gamma</a> to peform
24702 tonemapping.<wbr/></p>
24703 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
24704 for applying the tonemapping curve specified by <a href="#controls_android.tonemap.gamma">android.<wbr/>tonemap.<wbr/>gamma</a>.<wbr/></p>
24705 <p>Must not slow down frame rate relative to raw sensor output.<wbr/></p></span>
24706                   </li>
24707                   <li>
24708                     <span class="entry_type_enum_name">PRESET_CURVE</span>
24709                     <span class="entry_type_enum_notes"><p>Use the preset tonemapping curve specified in
24710 <a href="#controls_android.tonemap.presetCurve">android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve</a> to peform tonemapping.<wbr/></p>
24711 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
24712 for applying the tonemapping curve specified by
24713 <a href="#controls_android.tonemap.presetCurve">android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve</a>.<wbr/></p>
24714 <p>Must not slow down frame rate relative to raw sensor output.<wbr/></p></span>
24715                   </li>
24716                 </ul>
24717
24718             </td> <!-- entry_type -->
24719
24720             <td class="entry_description">
24721               <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
24722             </td>
24723
24724             <td class="entry_units">
24725             </td>
24726
24727             <td class="entry_range">
24728               <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
24729             </td>
24730
24731             <td class="entry_tags">
24732             </td>
24733
24734           </tr>
24735           <tr class="entries_header">
24736             <th class="th_details" colspan="5">Details</th>
24737           </tr>
24738           <tr class="entry_cont">
24739             <td class="entry_details" colspan="5">
24740               <p>When switching to an application-defined contrast curve by setting
24741 <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
24742 per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
24743 mapping from input high-bit-depth pixel value to the output
24744 low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
24745 and output may change depending on the camera pipeline,<wbr/> the values
24746 are specified by normalized floating-point numbers.<wbr/></p>
24747 <p>More-complex color mapping operations such as 3D color look-up
24748 tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
24749 transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24750 CONTRAST_<wbr/>CURVE.<wbr/></p>
24751 <p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
24752 emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
24753 These values are always available,<wbr/> and as close as possible to the
24754 actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
24755 <p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
24756 provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
24757 roughly the same.<wbr/></p>
24758             </td>
24759           </tr>
24760
24761
24762           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24763            <!-- end of entry -->
24764
24765
24766           <tr class="entry" id="controls_android.tonemap.gamma">
24767             <td class="entry_name
24768              " rowspan="3">
24769               android.<wbr/>tonemap.<wbr/>gamma
24770             </td>
24771             <td class="entry_type">
24772                 <span class="entry_type_name">float</span>
24773
24774               <span class="entry_type_visibility"> [public]</span>
24775
24776
24777
24778
24779
24780
24781             </td> <!-- entry_type -->
24782
24783             <td class="entry_description">
24784               <p>Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24785 GAMMA_<wbr/>VALUE</p>
24786             </td>
24787
24788             <td class="entry_units">
24789             </td>
24790
24791             <td class="entry_range">
24792             </td>
24793
24794             <td class="entry_tags">
24795             </td>
24796
24797           </tr>
24798           <tr class="entries_header">
24799             <th class="th_details" colspan="5">Details</th>
24800           </tr>
24801           <tr class="entry_cont">
24802             <td class="entry_details" colspan="5">
24803               <p>The tonemap curve will be defined the following formula:
24804 * OUT = pow(IN,<wbr/> 1.<wbr/>0 /<wbr/> gamma)
24805 where IN and OUT is the input pixel value scaled to range [0.<wbr/>0,<wbr/> 1.<wbr/>0],<wbr/>
24806 pow is the power function and gamma is the gamma value specified by this
24807 key.<wbr/></p>
24808 <p>The same curve will be applied to all color channels.<wbr/> The camera device
24809 may clip the input gamma value to its supported range.<wbr/> The actual applied
24810 value will be returned in capture result.<wbr/></p>
24811 <p>The valid range of gamma value varies on different devices,<wbr/> but values
24812 within [1.<wbr/>0,<wbr/> 5.<wbr/>0] are guaranteed not to be clipped.<wbr/></p>
24813             </td>
24814           </tr>
24815
24816
24817           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24818            <!-- end of entry -->
24819
24820
24821           <tr class="entry" id="controls_android.tonemap.presetCurve">
24822             <td class="entry_name
24823              " rowspan="3">
24824               android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve
24825             </td>
24826             <td class="entry_type">
24827                 <span class="entry_type_name entry_type_name_enum">byte</span>
24828
24829               <span class="entry_type_visibility"> [public]</span>
24830
24831
24832
24833
24834
24835                 <ul class="entry_type_enum">
24836                   <li>
24837                     <span class="entry_type_enum_name">SRGB</span>
24838                     <span class="entry_type_enum_notes"><p>Tonemapping curve is defined by sRGB</p></span>
24839                   </li>
24840                   <li>
24841                     <span class="entry_type_enum_name">REC709</span>
24842                     <span class="entry_type_enum_notes"><p>Tonemapping curve is defined by ITU-R BT.<wbr/>709</p></span>
24843                   </li>
24844                 </ul>
24845
24846             </td> <!-- entry_type -->
24847
24848             <td class="entry_description">
24849               <p>Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
24850 PRESET_<wbr/>CURVE</p>
24851             </td>
24852
24853             <td class="entry_units">
24854             </td>
24855
24856             <td class="entry_range">
24857             </td>
24858
24859             <td class="entry_tags">
24860             </td>
24861
24862           </tr>
24863           <tr class="entries_header">
24864             <th class="th_details" colspan="5">Details</th>
24865           </tr>
24866           <tr class="entry_cont">
24867             <td class="entry_details" colspan="5">
24868               <p>The tonemap curve will be defined by specified standard.<wbr/></p>
24869 <p>sRGB (approximated by 16 control points):</p>
24870 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
24871 <p>Rec.<wbr/> 709 (approximated by 16 control points):</p>
24872 <p><img alt="Rec. 709 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png"/></p>
24873 <p>Note that above figures show a 16 control points approximation of preset
24874 curves.<wbr/> Camera devices may apply a different approximation to the curve.<wbr/></p>
24875             </td>
24876           </tr>
24877
24878
24879           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24880            <!-- end of entry -->
24881
24882
24883
24884       <!-- end of kind -->
24885       </tbody>
24886       <tr><td colspan="6" class="kind">static</td></tr>
24887
24888       <thead class="entries_header">
24889         <tr>
24890           <th class="th_name">Property Name</th>
24891           <th class="th_type">Type</th>
24892           <th class="th_description">Description</th>
24893           <th class="th_units">Units</th>
24894           <th class="th_range">Range</th>
24895           <th class="th_tags">Tags</th>
24896         </tr>
24897       </thead>
24898
24899       <tbody>
24900
24901
24902
24903
24904
24905
24906
24907
24908
24909
24910           <tr class="entry" id="static_android.tonemap.maxCurvePoints">
24911             <td class="entry_name
24912              " rowspan="5">
24913               android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points
24914             </td>
24915             <td class="entry_type">
24916                 <span class="entry_type_name">int32</span>
24917
24918               <span class="entry_type_visibility"> [public]</span>
24919
24920
24921               <span class="entry_type_hwlevel">[full] </span>
24922
24923
24924
24925
24926             </td> <!-- entry_type -->
24927
24928             <td class="entry_description">
24929               <p>Maximum number of supported points in the
24930 tonemap curve that can be used for <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
24931             </td>
24932
24933             <td class="entry_units">
24934             </td>
24935
24936             <td class="entry_range">
24937             </td>
24938
24939             <td class="entry_tags">
24940             </td>
24941
24942           </tr>
24943           <tr class="entries_header">
24944             <th class="th_details" colspan="5">Details</th>
24945           </tr>
24946           <tr class="entry_cont">
24947             <td class="entry_details" colspan="5">
24948               <p>If the actual number of points provided by the application (in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>*) is
24949 less than this maximum,<wbr/> the camera device will resample the curve to its internal
24950 representation,<wbr/> using linear interpolation.<wbr/></p>
24951 <p>The output curves in the result metadata may have a different number
24952 of points than the input curves,<wbr/> and will represent the actual
24953 hardware curves used as closely as possible when linearly interpolated.<wbr/></p>
24954             </td>
24955           </tr>
24956
24957           <tr class="entries_header">
24958             <th class="th_details" colspan="5">HAL Implementation Details</th>
24959           </tr>
24960           <tr class="entry_cont">
24961             <td class="entry_details" colspan="5">
24962               <p>This value must be at least 64.<wbr/> This should be at least 128.<wbr/></p>
24963             </td>
24964           </tr>
24965
24966           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
24967            <!-- end of entry -->
24968
24969
24970           <tr class="entry" id="static_android.tonemap.availableToneMapModes">
24971             <td class="entry_name
24972              " rowspan="5">
24973               android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes
24974             </td>
24975             <td class="entry_type">
24976                 <span class="entry_type_name">byte</span>
24977                 <span class="entry_type_container">x</span>
24978
24979                 <span class="entry_type_array">
24980                   n
24981                 </span>
24982               <span class="entry_type_visibility"> [public as enumList]</span>
24983
24984
24985               <span class="entry_type_hwlevel">[full] </span>
24986
24987
24988                 <div class="entry_type_notes">list of enums</div>
24989
24990
24991             </td> <!-- entry_type -->
24992
24993             <td class="entry_description">
24994               <p>List of tonemapping modes for <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> that are supported by this camera
24995 device.<wbr/></p>
24996             </td>
24997
24998             <td class="entry_units">
24999             </td>
25000
25001             <td class="entry_range">
25002               <p>Any value listed in <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a></p>
25003             </td>
25004
25005             <td class="entry_tags">
25006             </td>
25007
25008           </tr>
25009           <tr class="entries_header">
25010             <th class="th_details" colspan="5">Details</th>
25011           </tr>
25012           <tr class="entry_cont">
25013             <td class="entry_details" colspan="5">
25014               <p>Camera devices that support the MANUAL_<wbr/>POST_<wbr/>PROCESSING capability will always contain
25015 at least one of below mode combinations:</p>
25016 <ul>
25017 <li>CONTRAST_<wbr/>CURVE,<wbr/> FAST and HIGH_<wbr/>QUALITY</li>
25018 <li>GAMMA_<wbr/>VALUE,<wbr/> PRESET_<wbr/>CURVE,<wbr/> FAST and HIGH_<wbr/>QUALITY</li>
25019 </ul>
25020 <p>This includes all FULL level devices.<wbr/></p>
25021             </td>
25022           </tr>
25023
25024           <tr class="entries_header">
25025             <th class="th_details" colspan="5">HAL Implementation Details</th>
25026           </tr>
25027           <tr class="entry_cont">
25028             <td class="entry_details" colspan="5">
25029               <p>HAL must support both FAST and HIGH_<wbr/>QUALITY if automatic tonemap control is available
25030 on the camera device,<wbr/> but the underlying implementation can be the same for both modes.<wbr/>
25031 That is,<wbr/> if the highest quality implementation on the camera device does not slow down
25032 capture rate,<wbr/> then FAST and HIGH_<wbr/>QUALITY will generate the same output.<wbr/></p>
25033             </td>
25034           </tr>
25035
25036           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25037            <!-- end of entry -->
25038
25039
25040
25041       <!-- end of kind -->
25042       </tbody>
25043       <tr><td colspan="6" class="kind">dynamic</td></tr>
25044
25045       <thead class="entries_header">
25046         <tr>
25047           <th class="th_name">Property Name</th>
25048           <th class="th_type">Type</th>
25049           <th class="th_description">Description</th>
25050           <th class="th_units">Units</th>
25051           <th class="th_range">Range</th>
25052           <th class="th_tags">Tags</th>
25053         </tr>
25054       </thead>
25055
25056       <tbody>
25057
25058
25059
25060
25061
25062
25063
25064
25065
25066
25067           <tr class="entry" id="dynamic_android.tonemap.curveBlue">
25068             <td class="entry_name
25069              " rowspan="3">
25070               android.<wbr/>tonemap.<wbr/>curve<wbr/>Blue
25071             </td>
25072             <td class="entry_type">
25073                 <span class="entry_type_name">float</span>
25074                 <span class="entry_type_container">x</span>
25075
25076                 <span class="entry_type_array">
25077                   n x 2
25078                 </span>
25079               <span class="entry_type_visibility"> [ndk_public]</span>
25080
25081
25082               <span class="entry_type_hwlevel">[full] </span>
25083
25084
25085                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
25086
25087
25088             </td> <!-- entry_type -->
25089
25090             <td class="entry_description">
25091               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the blue
25092 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25093 CONTRAST_<wbr/>CURVE.<wbr/></p>
25094             </td>
25095
25096             <td class="entry_units">
25097             </td>
25098
25099             <td class="entry_range">
25100             </td>
25101
25102             <td class="entry_tags">
25103             </td>
25104
25105           </tr>
25106           <tr class="entries_header">
25107             <th class="th_details" colspan="5">Details</th>
25108           </tr>
25109           <tr class="entry_cont">
25110             <td class="entry_details" colspan="5">
25111               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
25112             </td>
25113           </tr>
25114
25115
25116           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25117            <!-- end of entry -->
25118
25119
25120           <tr class="entry" id="dynamic_android.tonemap.curveGreen">
25121             <td class="entry_name
25122              " rowspan="3">
25123               android.<wbr/>tonemap.<wbr/>curve<wbr/>Green
25124             </td>
25125             <td class="entry_type">
25126                 <span class="entry_type_name">float</span>
25127                 <span class="entry_type_container">x</span>
25128
25129                 <span class="entry_type_array">
25130                   n x 2
25131                 </span>
25132               <span class="entry_type_visibility"> [ndk_public]</span>
25133
25134
25135               <span class="entry_type_hwlevel">[full] </span>
25136
25137
25138                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
25139
25140
25141             </td> <!-- entry_type -->
25142
25143             <td class="entry_description">
25144               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the green
25145 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25146 CONTRAST_<wbr/>CURVE.<wbr/></p>
25147             </td>
25148
25149             <td class="entry_units">
25150             </td>
25151
25152             <td class="entry_range">
25153             </td>
25154
25155             <td class="entry_tags">
25156             </td>
25157
25158           </tr>
25159           <tr class="entries_header">
25160             <th class="th_details" colspan="5">Details</th>
25161           </tr>
25162           <tr class="entry_cont">
25163             <td class="entry_details" colspan="5">
25164               <p>See <a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> for more details.<wbr/></p>
25165             </td>
25166           </tr>
25167
25168
25169           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25170            <!-- end of entry -->
25171
25172
25173           <tr class="entry" id="dynamic_android.tonemap.curveRed">
25174             <td class="entry_name
25175              " rowspan="5">
25176               android.<wbr/>tonemap.<wbr/>curve<wbr/>Red
25177             </td>
25178             <td class="entry_type">
25179                 <span class="entry_type_name">float</span>
25180                 <span class="entry_type_container">x</span>
25181
25182                 <span class="entry_type_array">
25183                   n x 2
25184                 </span>
25185               <span class="entry_type_visibility"> [ndk_public]</span>
25186
25187
25188               <span class="entry_type_hwlevel">[full] </span>
25189
25190
25191                 <div class="entry_type_notes">1D array of float pairs (P_<wbr/>IN,<wbr/> P_<wbr/>OUT).<wbr/> The maximum number of pairs is specified by android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points.<wbr/></div>
25192
25193
25194             </td> <!-- entry_type -->
25195
25196             <td class="entry_description">
25197               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve for the red
25198 channel,<wbr/> to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25199 CONTRAST_<wbr/>CURVE.<wbr/></p>
25200             </td>
25201
25202             <td class="entry_units">
25203             </td>
25204
25205             <td class="entry_range">
25206               <p>0-1 on both input and output coordinates,<wbr/> normalized
25207 as a floating-point value such that 0 == black and 1 == white.<wbr/></p>
25208             </td>
25209
25210             <td class="entry_tags">
25211             </td>
25212
25213           </tr>
25214           <tr class="entries_header">
25215             <th class="th_details" colspan="5">Details</th>
25216           </tr>
25217           <tr class="entry_cont">
25218             <td class="entry_details" colspan="5">
25219               <p>Each channel's curve is defined by an array of control points:</p>
25220 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> =
25221   [ P0in,<wbr/> P0out,<wbr/> P1in,<wbr/> P1out,<wbr/> P2in,<wbr/> P2out,<wbr/> P3in,<wbr/> P3out,<wbr/> ...,<wbr/> PNin,<wbr/> PNout ]
25222 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
25223 <p>These are sorted in order of increasing <code>Pin</code>; it is
25224 required that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
25225 define a complete mapping.<wbr/> For input values between control points,<wbr/>
25226 the camera device must linearly interpolate between the control
25227 points.<wbr/></p>
25228 <p>Each curve can have an independent number of points,<wbr/> and the number
25229 of points can be less than max (that is,<wbr/> the request doesn't have to
25230 always provide a curve with number of points equivalent to
25231 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
25232 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
25233 only specify the red channel and the precision is limited to 4
25234 digits,<wbr/> for conciseness.<wbr/></p>
25235 <p>Linear mapping:</p>
25236 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0 ]
25237 </code></pre>
25238 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
25239 <p>Invert mapping:</p>
25240 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [ 0,<wbr/> 1.<wbr/>0,<wbr/> 1.<wbr/>0,<wbr/> 0 ]
25241 </code></pre>
25242 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
25243 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
25244 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
25245   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2920,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4002,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4812,<wbr/>
25246   0.<wbr/>2667,<wbr/> 0.<wbr/>5484,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6069,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6594,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7072,<wbr/>
25247   0.<wbr/>5333,<wbr/> 0.<wbr/>7515,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7928,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8317,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8685,<wbr/>
25248   0.<wbr/>8000,<wbr/> 0.<wbr/>9035,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9370,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9691,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
25249 </code></pre>
25250 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
25251 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
25252 <pre><code><a href="#controls_android.tonemap.curveRed">android.<wbr/>tonemap.<wbr/>curve<wbr/>Red</a> = [
25253   0.<wbr/>0000,<wbr/> 0.<wbr/>0000,<wbr/> 0.<wbr/>0667,<wbr/> 0.<wbr/>2864,<wbr/> 0.<wbr/>1333,<wbr/> 0.<wbr/>4007,<wbr/> 0.<wbr/>2000,<wbr/> 0.<wbr/>4845,<wbr/>
25254   0.<wbr/>2667,<wbr/> 0.<wbr/>5532,<wbr/> 0.<wbr/>3333,<wbr/> 0.<wbr/>6125,<wbr/> 0.<wbr/>4000,<wbr/> 0.<wbr/>6652,<wbr/> 0.<wbr/>4667,<wbr/> 0.<wbr/>7130,<wbr/>
25255   0.<wbr/>5333,<wbr/> 0.<wbr/>7569,<wbr/> 0.<wbr/>6000,<wbr/> 0.<wbr/>7977,<wbr/> 0.<wbr/>6667,<wbr/> 0.<wbr/>8360,<wbr/> 0.<wbr/>7333,<wbr/> 0.<wbr/>8721,<wbr/>
25256   0.<wbr/>8000,<wbr/> 0.<wbr/>9063,<wbr/> 0.<wbr/>8667,<wbr/> 0.<wbr/>9389,<wbr/> 0.<wbr/>9333,<wbr/> 0.<wbr/>9701,<wbr/> 1.<wbr/>0000,<wbr/> 1.<wbr/>0000 ]
25257 </code></pre>
25258 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
25259             </td>
25260           </tr>
25261
25262           <tr class="entries_header">
25263             <th class="th_details" colspan="5">HAL Implementation Details</th>
25264           </tr>
25265           <tr class="entry_cont">
25266             <td class="entry_details" colspan="5">
25267               <p>For good quality of mapping,<wbr/> at least 128 control points are
25268 preferred.<wbr/></p>
25269 <p>A typical use case of this would be a gamma-1/<wbr/>2.<wbr/>2 curve,<wbr/> with as many
25270 control points used as are available.<wbr/></p>
25271             </td>
25272           </tr>
25273
25274           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25275            <!-- end of entry -->
25276
25277
25278           <tr class="entry" id="dynamic_android.tonemap.curve">
25279             <td class="entry_name
25280              " rowspan="5">
25281               android.<wbr/>tonemap.<wbr/>curve
25282             </td>
25283             <td class="entry_type">
25284                 <span class="entry_type_name">float</span>
25285
25286               <span class="entry_type_visibility"> [java_public as tonemapCurve]</span>
25287
25288               <span class="entry_type_synthetic">[synthetic] </span>
25289
25290               <span class="entry_type_hwlevel">[full] </span>
25291
25292
25293
25294
25295             </td> <!-- entry_type -->
25296
25297             <td class="entry_description">
25298               <p>Tonemapping /<wbr/> contrast /<wbr/> gamma curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a>
25299 is CONTRAST_<wbr/>CURVE.<wbr/></p>
25300             </td>
25301
25302             <td class="entry_units">
25303             </td>
25304
25305             <td class="entry_range">
25306             </td>
25307
25308             <td class="entry_tags">
25309             </td>
25310
25311           </tr>
25312           <tr class="entries_header">
25313             <th class="th_details" colspan="5">Details</th>
25314           </tr>
25315           <tr class="entry_cont">
25316             <td class="entry_details" colspan="5">
25317               <p>The tonemapCurve consist of three curves for each of red,<wbr/> green,<wbr/> and blue
25318 channels respectively.<wbr/> The following example uses the red channel as an
25319 example.<wbr/> The same logic applies to green and blue channel.<wbr/>
25320 Each channel's curve is defined by an array of control points:</p>
25321 <pre><code>curveRed =
25322   [ P0(in,<wbr/> out),<wbr/> P1(in,<wbr/> out),<wbr/> P2(in,<wbr/> out),<wbr/> P3(in,<wbr/> out),<wbr/> ...,<wbr/> PN(in,<wbr/> out) ]
25323 2 &lt;= N &lt;= <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a></code></pre>
25324 <p>These are sorted in order of increasing <code>Pin</code>; it is always
25325 guaranteed that input values 0.<wbr/>0 and 1.<wbr/>0 are included in the list to
25326 define a complete mapping.<wbr/> For input values between control points,<wbr/>
25327 the camera device must linearly interpolate between the control
25328 points.<wbr/></p>
25329 <p>Each curve can have an independent number of points,<wbr/> and the number
25330 of points can be less than max (that is,<wbr/> the request doesn't have to
25331 always provide a curve with number of points equivalent to
25332 <a href="#static_android.tonemap.maxCurvePoints">android.<wbr/>tonemap.<wbr/>max<wbr/>Curve<wbr/>Points</a>).<wbr/></p>
25333 <p>A few examples,<wbr/> and their corresponding graphical mappings; these
25334 only specify the red channel and the precision is limited to 4
25335 digits,<wbr/> for conciseness.<wbr/></p>
25336 <p>Linear mapping:</p>
25337 <pre><code>curveRed = [ (0,<wbr/> 0),<wbr/> (1.<wbr/>0,<wbr/> 1.<wbr/>0) ]
25338 </code></pre>
25339 <p><img alt="Linear mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/linear_tonemap.png"/></p>
25340 <p>Invert mapping:</p>
25341 <pre><code>curveRed = [ (0,<wbr/> 1.<wbr/>0),<wbr/> (1.<wbr/>0,<wbr/> 0) ]
25342 </code></pre>
25343 <p><img alt="Inverting mapping curve" src="images/camera2/metadata/android.tonemap.curveRed/inverse_tonemap.png"/></p>
25344 <p>Gamma 1/<wbr/>2.<wbr/>2 mapping,<wbr/> with 16 control points:</p>
25345 <pre><code>curveRed = [
25346   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2920),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4002),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4812),<wbr/>
25347   (0.<wbr/>2667,<wbr/> 0.<wbr/>5484),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6069),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6594),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7072),<wbr/>
25348   (0.<wbr/>5333,<wbr/> 0.<wbr/>7515),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7928),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8317),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8685),<wbr/>
25349   (0.<wbr/>8000,<wbr/> 0.<wbr/>9035),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9370),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9691),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
25350 </code></pre>
25351 <p><img alt="Gamma = 1/2.2 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/gamma_tonemap.png"/></p>
25352 <p>Standard sRGB gamma mapping,<wbr/> per IEC 61966-2-1:1999,<wbr/> with 16 control points:</p>
25353 <pre><code>curveRed = [
25354   (0.<wbr/>0000,<wbr/> 0.<wbr/>0000),<wbr/> (0.<wbr/>0667,<wbr/> 0.<wbr/>2864),<wbr/> (0.<wbr/>1333,<wbr/> 0.<wbr/>4007),<wbr/> (0.<wbr/>2000,<wbr/> 0.<wbr/>4845),<wbr/>
25355   (0.<wbr/>2667,<wbr/> 0.<wbr/>5532),<wbr/> (0.<wbr/>3333,<wbr/> 0.<wbr/>6125),<wbr/> (0.<wbr/>4000,<wbr/> 0.<wbr/>6652),<wbr/> (0.<wbr/>4667,<wbr/> 0.<wbr/>7130),<wbr/>
25356   (0.<wbr/>5333,<wbr/> 0.<wbr/>7569),<wbr/> (0.<wbr/>6000,<wbr/> 0.<wbr/>7977),<wbr/> (0.<wbr/>6667,<wbr/> 0.<wbr/>8360),<wbr/> (0.<wbr/>7333,<wbr/> 0.<wbr/>8721),<wbr/>
25357   (0.<wbr/>8000,<wbr/> 0.<wbr/>9063),<wbr/> (0.<wbr/>8667,<wbr/> 0.<wbr/>9389),<wbr/> (0.<wbr/>9333,<wbr/> 0.<wbr/>9701),<wbr/> (1.<wbr/>0000,<wbr/> 1.<wbr/>0000) ]
25358 </code></pre>
25359 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
25360             </td>
25361           </tr>
25362
25363           <tr class="entries_header">
25364             <th class="th_details" colspan="5">HAL Implementation Details</th>
25365           </tr>
25366           <tr class="entry_cont">
25367             <td class="entry_details" colspan="5">
25368               <p>This entry is created by the framework from the curveRed,<wbr/> curveGreen and
25369 curveBlue entries.<wbr/></p>
25370             </td>
25371           </tr>
25372
25373           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25374            <!-- end of entry -->
25375
25376
25377           <tr class="entry" id="dynamic_android.tonemap.mode">
25378             <td class="entry_name
25379              " rowspan="3">
25380               android.<wbr/>tonemap.<wbr/>mode
25381             </td>
25382             <td class="entry_type">
25383                 <span class="entry_type_name entry_type_name_enum">byte</span>
25384
25385               <span class="entry_type_visibility"> [public]</span>
25386
25387
25388               <span class="entry_type_hwlevel">[full] </span>
25389
25390
25391
25392                 <ul class="entry_type_enum">
25393                   <li>
25394                     <span class="entry_type_enum_name">CONTRAST_CURVE</span>
25395                     <span class="entry_type_enum_notes"><p>Use the tone mapping curve specified in
25396 the <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>* entries.<wbr/></p>
25397 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
25398 for applying the tonemapping curve specified by
25399 <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/></p>
25400 <p>Must not slow down frame rate relative to raw
25401 sensor output.<wbr/></p></span>
25402                   </li>
25403                   <li>
25404                     <span class="entry_type_enum_name">FAST</span>
25405                     <span class="entry_type_enum_notes"><p>Advanced gamma mapping and color enhancement may be applied,<wbr/> without
25406 reducing frame rate compared to raw sensor output.<wbr/></p></span>
25407                   </li>
25408                   <li>
25409                     <span class="entry_type_enum_name">HIGH_QUALITY</span>
25410                     <span class="entry_type_enum_notes"><p>High-quality gamma mapping and color enhancement will be applied,<wbr/> at
25411 the cost of possibly reduced frame rate compared to raw sensor output.<wbr/></p></span>
25412                   </li>
25413                   <li>
25414                     <span class="entry_type_enum_name">GAMMA_VALUE</span>
25415                     <span class="entry_type_enum_notes"><p>Use the gamma value specified in <a href="#controls_android.tonemap.gamma">android.<wbr/>tonemap.<wbr/>gamma</a> to peform
25416 tonemapping.<wbr/></p>
25417 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
25418 for applying the tonemapping curve specified by <a href="#controls_android.tonemap.gamma">android.<wbr/>tonemap.<wbr/>gamma</a>.<wbr/></p>
25419 <p>Must not slow down frame rate relative to raw sensor output.<wbr/></p></span>
25420                   </li>
25421                   <li>
25422                     <span class="entry_type_enum_name">PRESET_CURVE</span>
25423                     <span class="entry_type_enum_notes"><p>Use the preset tonemapping curve specified in
25424 <a href="#controls_android.tonemap.presetCurve">android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve</a> to peform tonemapping.<wbr/></p>
25425 <p>All color enhancement and tonemapping must be disabled,<wbr/> except
25426 for applying the tonemapping curve specified by
25427 <a href="#controls_android.tonemap.presetCurve">android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve</a>.<wbr/></p>
25428 <p>Must not slow down frame rate relative to raw sensor output.<wbr/></p></span>
25429                   </li>
25430                 </ul>
25431
25432             </td> <!-- entry_type -->
25433
25434             <td class="entry_description">
25435               <p>High-level global contrast/<wbr/>gamma/<wbr/>tonemapping control.<wbr/></p>
25436             </td>
25437
25438             <td class="entry_units">
25439             </td>
25440
25441             <td class="entry_range">
25442               <p><a href="#static_android.tonemap.availableToneMapModes">android.<wbr/>tonemap.<wbr/>available<wbr/>Tone<wbr/>Map<wbr/>Modes</a></p>
25443             </td>
25444
25445             <td class="entry_tags">
25446             </td>
25447
25448           </tr>
25449           <tr class="entries_header">
25450             <th class="th_details" colspan="5">Details</th>
25451           </tr>
25452           <tr class="entry_cont">
25453             <td class="entry_details" colspan="5">
25454               <p>When switching to an application-defined contrast curve by setting
25455 <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> to CONTRAST_<wbr/>CURVE,<wbr/> the curve is defined
25456 per-channel with a set of <code>(in,<wbr/> out)</code> points that specify the
25457 mapping from input high-bit-depth pixel value to the output
25458 low-bit-depth value.<wbr/>  Since the actual pixel ranges of both input
25459 and output may change depending on the camera pipeline,<wbr/> the values
25460 are specified by normalized floating-point numbers.<wbr/></p>
25461 <p>More-complex color mapping operations such as 3D color look-up
25462 tables,<wbr/> selective chroma enhancement,<wbr/> or other non-linear color
25463 transforms will be disabled when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25464 CONTRAST_<wbr/>CURVE.<wbr/></p>
25465 <p>When using either FAST or HIGH_<wbr/>QUALITY,<wbr/> the camera device will
25466 emit its own tonemap curve in <a href="#controls_android.tonemap.curve">android.<wbr/>tonemap.<wbr/>curve</a>.<wbr/>
25467 These values are always available,<wbr/> and as close as possible to the
25468 actually used nonlinear/<wbr/>nonglobal transforms.<wbr/></p>
25469 <p>If a request is sent with CONTRAST_<wbr/>CURVE with the camera device's
25470 provided curve in FAST or HIGH_<wbr/>QUALITY,<wbr/> the image's tonemap will be
25471 roughly the same.<wbr/></p>
25472             </td>
25473           </tr>
25474
25475
25476           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25477            <!-- end of entry -->
25478
25479
25480           <tr class="entry" id="dynamic_android.tonemap.gamma">
25481             <td class="entry_name
25482              " rowspan="3">
25483               android.<wbr/>tonemap.<wbr/>gamma
25484             </td>
25485             <td class="entry_type">
25486                 <span class="entry_type_name">float</span>
25487
25488               <span class="entry_type_visibility"> [public]</span>
25489
25490
25491
25492
25493
25494
25495             </td> <!-- entry_type -->
25496
25497             <td class="entry_description">
25498               <p>Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25499 GAMMA_<wbr/>VALUE</p>
25500             </td>
25501
25502             <td class="entry_units">
25503             </td>
25504
25505             <td class="entry_range">
25506             </td>
25507
25508             <td class="entry_tags">
25509             </td>
25510
25511           </tr>
25512           <tr class="entries_header">
25513             <th class="th_details" colspan="5">Details</th>
25514           </tr>
25515           <tr class="entry_cont">
25516             <td class="entry_details" colspan="5">
25517               <p>The tonemap curve will be defined the following formula:
25518 * OUT = pow(IN,<wbr/> 1.<wbr/>0 /<wbr/> gamma)
25519 where IN and OUT is the input pixel value scaled to range [0.<wbr/>0,<wbr/> 1.<wbr/>0],<wbr/>
25520 pow is the power function and gamma is the gamma value specified by this
25521 key.<wbr/></p>
25522 <p>The same curve will be applied to all color channels.<wbr/> The camera device
25523 may clip the input gamma value to its supported range.<wbr/> The actual applied
25524 value will be returned in capture result.<wbr/></p>
25525 <p>The valid range of gamma value varies on different devices,<wbr/> but values
25526 within [1.<wbr/>0,<wbr/> 5.<wbr/>0] are guaranteed not to be clipped.<wbr/></p>
25527             </td>
25528           </tr>
25529
25530
25531           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25532            <!-- end of entry -->
25533
25534
25535           <tr class="entry" id="dynamic_android.tonemap.presetCurve">
25536             <td class="entry_name
25537              " rowspan="3">
25538               android.<wbr/>tonemap.<wbr/>preset<wbr/>Curve
25539             </td>
25540             <td class="entry_type">
25541                 <span class="entry_type_name entry_type_name_enum">byte</span>
25542
25543               <span class="entry_type_visibility"> [public]</span>
25544
25545
25546
25547
25548
25549                 <ul class="entry_type_enum">
25550                   <li>
25551                     <span class="entry_type_enum_name">SRGB</span>
25552                     <span class="entry_type_enum_notes"><p>Tonemapping curve is defined by sRGB</p></span>
25553                   </li>
25554                   <li>
25555                     <span class="entry_type_enum_name">REC709</span>
25556                     <span class="entry_type_enum_notes"><p>Tonemapping curve is defined by ITU-R BT.<wbr/>709</p></span>
25557                   </li>
25558                 </ul>
25559
25560             </td> <!-- entry_type -->
25561
25562             <td class="entry_description">
25563               <p>Tonemapping curve to use when <a href="#controls_android.tonemap.mode">android.<wbr/>tonemap.<wbr/>mode</a> is
25564 PRESET_<wbr/>CURVE</p>
25565             </td>
25566
25567             <td class="entry_units">
25568             </td>
25569
25570             <td class="entry_range">
25571             </td>
25572
25573             <td class="entry_tags">
25574             </td>
25575
25576           </tr>
25577           <tr class="entries_header">
25578             <th class="th_details" colspan="5">Details</th>
25579           </tr>
25580           <tr class="entry_cont">
25581             <td class="entry_details" colspan="5">
25582               <p>The tonemap curve will be defined by specified standard.<wbr/></p>
25583 <p>sRGB (approximated by 16 control points):</p>
25584 <p><img alt="sRGB tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/srgb_tonemap.png"/></p>
25585 <p>Rec.<wbr/> 709 (approximated by 16 control points):</p>
25586 <p><img alt="Rec. 709 tonemapping curve" src="images/camera2/metadata/android.tonemap.curveRed/rec709_tonemap.png"/></p>
25587 <p>Note that above figures show a 16 control points approximation of preset
25588 curves.<wbr/> Camera devices may apply a different approximation to the curve.<wbr/></p>
25589             </td>
25590           </tr>
25591
25592
25593           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25594            <!-- end of entry -->
25595
25596
25597
25598       <!-- end of kind -->
25599       </tbody>
25600
25601   <!-- end of section -->
25602   <tr><td colspan="6" id="section_led" class="section">led</td></tr>
25603
25604
25605       <tr><td colspan="6" class="kind">controls</td></tr>
25606
25607       <thead class="entries_header">
25608         <tr>
25609           <th class="th_name">Property Name</th>
25610           <th class="th_type">Type</th>
25611           <th class="th_description">Description</th>
25612           <th class="th_units">Units</th>
25613           <th class="th_range">Range</th>
25614           <th class="th_tags">Tags</th>
25615         </tr>
25616       </thead>
25617
25618       <tbody>
25619
25620
25621
25622
25623
25624
25625
25626
25627
25628
25629           <tr class="entry" id="controls_android.led.transmit">
25630             <td class="entry_name
25631              " rowspan="1">
25632               android.<wbr/>led.<wbr/>transmit
25633             </td>
25634             <td class="entry_type">
25635                 <span class="entry_type_name entry_type_name_enum">byte</span>
25636
25637               <span class="entry_type_visibility"> [hidden as boolean]</span>
25638
25639
25640
25641
25642
25643                 <ul class="entry_type_enum">
25644                   <li>
25645                     <span class="entry_type_enum_name">OFF</span>
25646                   </li>
25647                   <li>
25648                     <span class="entry_type_enum_name">ON</span>
25649                   </li>
25650                 </ul>
25651
25652             </td> <!-- entry_type -->
25653
25654             <td class="entry_description">
25655               <p>This LED is nominally used to indicate to the user
25656 that the camera is powered on and may be streaming images back to the
25657 Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
25658 disable this when video is processed locally and not transmitted to
25659 any untrusted applications.<wbr/></p>
25660 <p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
25661 transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
25662 data is stored locally on the device.<wbr/></p>
25663 <p>The LED <em>may</em> be off if a trusted application is using the data that
25664 doesn't violate the above rules.<wbr/></p>
25665             </td>
25666
25667             <td class="entry_units">
25668             </td>
25669
25670             <td class="entry_range">
25671             </td>
25672
25673             <td class="entry_tags">
25674             </td>
25675
25676           </tr>
25677
25678
25679           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25680            <!-- end of entry -->
25681
25682
25683
25684       <!-- end of kind -->
25685       </tbody>
25686       <tr><td colspan="6" class="kind">dynamic</td></tr>
25687
25688       <thead class="entries_header">
25689         <tr>
25690           <th class="th_name">Property Name</th>
25691           <th class="th_type">Type</th>
25692           <th class="th_description">Description</th>
25693           <th class="th_units">Units</th>
25694           <th class="th_range">Range</th>
25695           <th class="th_tags">Tags</th>
25696         </tr>
25697       </thead>
25698
25699       <tbody>
25700
25701
25702
25703
25704
25705
25706
25707
25708
25709
25710           <tr class="entry" id="dynamic_android.led.transmit">
25711             <td class="entry_name
25712              " rowspan="1">
25713               android.<wbr/>led.<wbr/>transmit
25714             </td>
25715             <td class="entry_type">
25716                 <span class="entry_type_name entry_type_name_enum">byte</span>
25717
25718               <span class="entry_type_visibility"> [hidden as boolean]</span>
25719
25720
25721
25722
25723
25724                 <ul class="entry_type_enum">
25725                   <li>
25726                     <span class="entry_type_enum_name">OFF</span>
25727                   </li>
25728                   <li>
25729                     <span class="entry_type_enum_name">ON</span>
25730                   </li>
25731                 </ul>
25732
25733             </td> <!-- entry_type -->
25734
25735             <td class="entry_description">
25736               <p>This LED is nominally used to indicate to the user
25737 that the camera is powered on and may be streaming images back to the
25738 Application Processor.<wbr/> In certain rare circumstances,<wbr/> the OS may
25739 disable this when video is processed locally and not transmitted to
25740 any untrusted applications.<wbr/></p>
25741 <p>In particular,<wbr/> the LED <em>must</em> always be on when the data could be
25742 transmitted off the device.<wbr/> The LED <em>should</em> always be on whenever
25743 data is stored locally on the device.<wbr/></p>
25744 <p>The LED <em>may</em> be off if a trusted application is using the data that
25745 doesn't violate the above rules.<wbr/></p>
25746             </td>
25747
25748             <td class="entry_units">
25749             </td>
25750
25751             <td class="entry_range">
25752             </td>
25753
25754             <td class="entry_tags">
25755             </td>
25756
25757           </tr>
25758
25759
25760           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25761            <!-- end of entry -->
25762
25763
25764
25765       <!-- end of kind -->
25766       </tbody>
25767       <tr><td colspan="6" class="kind">static</td></tr>
25768
25769       <thead class="entries_header">
25770         <tr>
25771           <th class="th_name">Property Name</th>
25772           <th class="th_type">Type</th>
25773           <th class="th_description">Description</th>
25774           <th class="th_units">Units</th>
25775           <th class="th_range">Range</th>
25776           <th class="th_tags">Tags</th>
25777         </tr>
25778       </thead>
25779
25780       <tbody>
25781
25782
25783
25784
25785
25786
25787
25788
25789
25790
25791           <tr class="entry" id="static_android.led.availableLeds">
25792             <td class="entry_name
25793              " rowspan="1">
25794               android.<wbr/>led.<wbr/>available<wbr/>Leds
25795             </td>
25796             <td class="entry_type">
25797                 <span class="entry_type_name entry_type_name_enum">byte</span>
25798                 <span class="entry_type_container">x</span>
25799
25800                 <span class="entry_type_array">
25801                   n
25802                 </span>
25803               <span class="entry_type_visibility"> [hidden]</span>
25804
25805
25806
25807
25808
25809                 <ul class="entry_type_enum">
25810                   <li>
25811                     <span class="entry_type_enum_name">TRANSMIT</span>
25812                     <span class="entry_type_enum_notes"><p><a href="#controls_android.led.transmit">android.<wbr/>led.<wbr/>transmit</a> control is used.<wbr/></p></span>
25813                   </li>
25814                 </ul>
25815
25816             </td> <!-- entry_type -->
25817
25818             <td class="entry_description">
25819               <p>A list of camera LEDs that are available on this system.<wbr/></p>
25820             </td>
25821
25822             <td class="entry_units">
25823             </td>
25824
25825             <td class="entry_range">
25826             </td>
25827
25828             <td class="entry_tags">
25829             </td>
25830
25831           </tr>
25832
25833
25834           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
25835            <!-- end of entry -->
25836
25837
25838
25839       <!-- end of kind -->
25840       </tbody>
25841
25842   <!-- end of section -->
25843   <tr><td colspan="6" id="section_info" class="section">info</td></tr>
25844
25845
25846       <tr><td colspan="6" class="kind">static</td></tr>
25847
25848       <thead class="entries_header">
25849         <tr>
25850           <th class="th_name">Property Name</th>
25851           <th class="th_type">Type</th>
25852           <th class="th_description">Description</th>
25853           <th class="th_units">Units</th>
25854           <th class="th_range">Range</th>
25855           <th class="th_tags">Tags</th>
25856         </tr>
25857       </thead>
25858
25859       <tbody>
25860
25861
25862
25863
25864
25865
25866
25867
25868
25869
25870           <tr class="entry" id="static_android.info.supportedHardwareLevel">
25871             <td class="entry_name
25872              " rowspan="5">
25873               android.<wbr/>info.<wbr/>supported<wbr/>Hardware<wbr/>Level
25874             </td>
25875             <td class="entry_type">
25876                 <span class="entry_type_name entry_type_name_enum">byte</span>
25877
25878               <span class="entry_type_visibility"> [public]</span>
25879
25880
25881               <span class="entry_type_hwlevel">[legacy] </span>
25882
25883
25884
25885                 <ul class="entry_type_enum">
25886                   <li>
25887                     <span class="entry_type_enum_name">LIMITED</span>
25888                     <span class="entry_type_enum_notes"><p>This camera device does not have enough capabilities to qualify as a <code>FULL</code> device or
25889 better.<wbr/></p>
25890 <p>Only the stream configurations listed in the <code>LEGACY</code> and <code>LIMITED</code> tables in the
25891 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a> documentation are guaranteed to be supported.<wbr/></p>
25892 <p>All <code>LIMITED</code> devices support the <code>BACKWARDS_<wbr/>COMPATIBLE</code> capability,<wbr/> indicating basic
25893 support for color image capture.<wbr/> The only exception is that the device may
25894 alternatively support only the <code>DEPTH_<wbr/>OUTPUT</code> capability,<wbr/> if it can only output depth
25895 measurements and not color images.<wbr/></p>
25896 <p><code>LIMITED</code> devices and above require the use of <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a>
25897 to lock exposure metering (and calculate flash power,<wbr/> for cameras with flash) before
25898 capturing a high-quality still image.<wbr/></p>
25899 <p>A <code>LIMITED</code> device that only lists the <code>BACKWARDS_<wbr/>COMPATIBLE</code> capability is only
25900 required to support full-automatic operation and post-processing (<code>OFF</code> is not
25901 supported for <a href="#controls_android.control.aeMode">android.<wbr/>control.<wbr/>ae<wbr/>Mode</a>,<wbr/> <a href="#controls_android.control.afMode">android.<wbr/>control.<wbr/>af<wbr/>Mode</a>,<wbr/> or
25902 <a href="#controls_android.control.awbMode">android.<wbr/>control.<wbr/>awb<wbr/>Mode</a>)</p>
25903 <p>Additional capabilities may optionally be supported by a <code>LIMITED</code>-level device,<wbr/> and
25904 can be checked for in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p></span>
25905                   </li>
25906                   <li>
25907                     <span class="entry_type_enum_name">FULL</span>
25908                     <span class="entry_type_enum_notes"><p>This camera device is capable of supporting advanced imaging applications.<wbr/></p>
25909 <p>The stream configurations listed in the <code>FULL</code>,<wbr/> <code>LEGACY</code> and <code>LIMITED</code> tables in the
25910 <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a> documentation are guaranteed to be supported.<wbr/></p>
25911 <p>A <code>FULL</code> device will support below capabilities:</p>
25912 <ul>
25913 <li><code>BURST_<wbr/>CAPTURE</code> capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains
25914   <code>BURST_<wbr/>CAPTURE</code>)</li>
25915 <li>Per frame control (<a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> <code>==</code> PER_<wbr/>FRAME_<wbr/>CONTROL)</li>
25916 <li>Manual sensor control (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains <code>MANUAL_<wbr/>SENSOR</code>)</li>
25917 <li>Manual post-processing control (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains
25918   <code>MANUAL_<wbr/>POST_<wbr/>PROCESSING</code>)</li>
25919 <li>The required exposure time range defined in <a href="#static_android.sensor.info.exposureTimeRange">android.<wbr/>sensor.<wbr/>info.<wbr/>exposure<wbr/>Time<wbr/>Range</a></li>
25920 <li>The required maxFrameDuration defined in <a href="#static_android.sensor.info.maxFrameDuration">android.<wbr/>sensor.<wbr/>info.<wbr/>max<wbr/>Frame<wbr/>Duration</a></li>
25921 </ul>
25922 <p>Note:
25923 Pre-API level 23,<wbr/> FULL devices also supported arbitrary cropping region
25924 (<a href="#static_android.scaler.croppingType">android.<wbr/>scaler.<wbr/>cropping<wbr/>Type</a> <code>== FREEFORM</code>); this requirement was relaxed in API level
25925 23,<wbr/> and <code>FULL</code> devices may only support <code>CENTERED</code> cropping.<wbr/></p></span>
25926                   </li>
25927                   <li>
25928                     <span class="entry_type_enum_name">LEGACY</span>
25929                     <span class="entry_type_enum_notes"><p>This camera device is running in backward compatibility mode.<wbr/></p>
25930 <p>Only the stream configurations listed in the <code>LEGACY</code> table in the <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a>
25931 documentation are supported.<wbr/></p>
25932 <p>A <code>LEGACY</code> device does not support per-frame control,<wbr/> manual sensor control,<wbr/> manual
25933 post-processing,<wbr/> arbitrary cropping regions,<wbr/> and has relaxed performance constraints.<wbr/>
25934 No additional capabilities beyond <code>BACKWARD_<wbr/>COMPATIBLE</code> will ever be listed by a
25935 <code>LEGACY</code> device in <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a>.<wbr/></p>
25936 <p>In addition,<wbr/> the <a href="#controls_android.control.aePrecaptureTrigger">android.<wbr/>control.<wbr/>ae<wbr/>Precapture<wbr/>Trigger</a> is not functional on <code>LEGACY</code>
25937 devices.<wbr/> Instead,<wbr/> every request that includes a JPEG-format output target is treated
25938 as triggering a still capture,<wbr/> internally executing a precapture trigger.<wbr/>  This may
25939 fire the flash for flash power metering during precapture,<wbr/> and then fire the flash
25940 for the final capture,<wbr/> if a flash is available on the device and the AE mode is set to
25941 enable the flash.<wbr/></p></span>
25942                   </li>
25943                   <li>
25944                     <span class="entry_type_enum_name">3</span>
25945                     <span class="entry_type_enum_notes"><p>This camera device is capable of YUV reprocessing and RAW data capture,<wbr/> in addition to
25946 FULL-level capabilities.<wbr/></p>
25947 <p>The stream configurations listed in the <code>LEVEL_<wbr/>3</code>,<wbr/> <code>RAW</code>,<wbr/> <code>FULL</code>,<wbr/> <code>LEGACY</code> and
25948 <code>LIMITED</code> tables in the <a href="https://developer.android.com/reference/android/hardware/camera2/CameraDevice.html#createCaptureSession">createCaptureSession</a>
25949 documentation are guaranteed to be supported.<wbr/></p>
25950 <p>The following additional capabilities are guaranteed to be supported:</p>
25951 <ul>
25952 <li><code>YUV_<wbr/>REPROCESSING</code> capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains
25953   <code>YUV_<wbr/>REPROCESSING</code>)</li>
25954 <li><code>RAW</code> capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains
25955   <code>RAW</code>)</li>
25956 </ul></span>
25957                   </li>
25958                 </ul>
25959
25960             </td> <!-- entry_type -->
25961
25962             <td class="entry_description">
25963               <p>Generally classifies the overall set of the camera device functionality.<wbr/></p>
25964             </td>
25965
25966             <td class="entry_units">
25967             </td>
25968
25969             <td class="entry_range">
25970             </td>
25971
25972             <td class="entry_tags">
25973             </td>
25974
25975           </tr>
25976           <tr class="entries_header">
25977             <th class="th_details" colspan="5">Details</th>
25978           </tr>
25979           <tr class="entry_cont">
25980             <td class="entry_details" colspan="5">
25981               <p>The supported hardware level is a high-level description of the camera device's
25982 capabilities,<wbr/> summarizing several capabilities into one field.<wbr/>  Each level adds additional
25983 features to the previous one,<wbr/> and is always a strict superset of the previous level.<wbr/>
25984 The ordering is <code>LEGACY &lt; LIMITED &lt; FULL &lt; LEVEL_<wbr/>3</code>.<wbr/></p>
25985 <p>Starting from <code>LEVEL_<wbr/>3</code>,<wbr/> the level enumerations are guaranteed to be in increasing
25986 numerical value as well.<wbr/> To check if a given device is at least at a given hardware level,<wbr/>
25987 the following code snippet can be used:</p>
25988 <pre><code>//<wbr/> Returns true if the device supports the required hardware level,<wbr/> or better.<wbr/>
25989 boolean isHardwareLevelSupported(CameraCharacteristics c,<wbr/> int requiredLevel) {
25990     int deviceLevel = c.<wbr/>get(Camera<wbr/>Characteristics.<wbr/>INFO_<wbr/>SUPPORTED_<wbr/>HARDWARE_<wbr/>LEVEL);
25991     if (deviceLevel == Camera<wbr/>Characteristics.<wbr/>INFO_<wbr/>SUPPORTED_<wbr/>HARDWARE_<wbr/>LEVEL_<wbr/>LEGACY) {
25992         return requiredLevel == deviceLevel;
25993     }
25994     //<wbr/> deviceLevel is not LEGACY,<wbr/> can use numerical sort
25995     return requiredLevel &lt;= deviceLevel;
25996 }
25997 </code></pre>
25998 <p>At a high level,<wbr/> the levels are:</p>
25999 <ul>
26000 <li><code>LEGACY</code> devices operate in a backwards-compatibility mode for older
26001   Android devices,<wbr/> and have very limited capabilities.<wbr/></li>
26002 <li><code>LIMITED</code> devices represent the
26003   baseline feature set,<wbr/> and may also include additional capabilities that are
26004   subsets of <code>FULL</code>.<wbr/></li>
26005 <li><code>FULL</code> devices additionally support per-frame manual control of sensor,<wbr/> flash,<wbr/> lens and
26006   post-processing settings,<wbr/> and image capture at a high rate.<wbr/></li>
26007 <li><code>LEVEL_<wbr/>3</code> devices additionally support YUV reprocessing and RAW image capture,<wbr/> along
26008   with additional output stream configurations.<wbr/></li>
26009 </ul>
26010 <p>See the individual level enums for full descriptions of the supported capabilities.<wbr/>  The
26011 <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> entry describes the device's capabilities at a
26012 finer-grain level,<wbr/> if needed.<wbr/> In addition,<wbr/> many controls have their available settings or
26013 ranges defined in individual <a href="https://developer.android.com/reference/android/hardware/camera2/CameraCharacteristics.html">CameraCharacteristics</a> entries.<wbr/></p>
26014 <p>Some features are not part of any particular hardware level or capability and must be
26015 queried separately.<wbr/> These include:</p>
26016 <ul>
26017 <li>Calibrated timestamps (<a href="#static_android.sensor.info.timestampSource">android.<wbr/>sensor.<wbr/>info.<wbr/>timestamp<wbr/>Source</a> <code>==</code> REALTIME)</li>
26018 <li>Precision lens control (<a href="#static_android.lens.info.focusDistanceCalibration">android.<wbr/>lens.<wbr/>info.<wbr/>focus<wbr/>Distance<wbr/>Calibration</a> <code>==</code> CALIBRATED)</li>
26019 <li>Face detection (<a href="#static_android.statistics.info.availableFaceDetectModes">android.<wbr/>statistics.<wbr/>info.<wbr/>available<wbr/>Face<wbr/>Detect<wbr/>Modes</a>)</li>
26020 <li>Optical or electrical image stabilization
26021   (<a href="#static_android.lens.info.availableOpticalStabilization">android.<wbr/>lens.<wbr/>info.<wbr/>available<wbr/>Optical<wbr/>Stabilization</a>,<wbr/>
26022    <a href="#static_android.control.availableVideoStabilizationModes">android.<wbr/>control.<wbr/>available<wbr/>Video<wbr/>Stabilization<wbr/>Modes</a>)</li>
26023 </ul>
26024             </td>
26025           </tr>
26026
26027           <tr class="entries_header">
26028             <th class="th_details" colspan="5">HAL Implementation Details</th>
26029           </tr>
26030           <tr class="entry_cont">
26031             <td class="entry_details" colspan="5">
26032               <p>The camera 3 HAL device can implement one of three possible operational modes; LIMITED,<wbr/>
26033 FULL,<wbr/> and LEVEL_<wbr/>3.<wbr/></p>
26034 <p>FULL support or better is expected from new higher-end devices.<wbr/> Limited
26035 mode has hardware requirements roughly in line with those for a camera HAL device v1
26036 implementation,<wbr/> and is expected from older or inexpensive devices.<wbr/> Each level is a strict
26037 superset of the previous level,<wbr/> and they share the same essential operational flow.<wbr/></p>
26038 <p>For full details refer to "S3.<wbr/> Operational Modes" in camera3.<wbr/>h</p>
26039 <p>Camera HAL3+ must not implement LEGACY mode.<wbr/> It is there for backwards compatibility in
26040 the <code>android.<wbr/>hardware.<wbr/>camera2</code> user-facing API only on HALv1 devices,<wbr/> and is implemented
26041 by the camera framework code.<wbr/></p>
26042             </td>
26043           </tr>
26044
26045           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26046            <!-- end of entry -->
26047
26048
26049
26050       <!-- end of kind -->
26051       </tbody>
26052
26053   <!-- end of section -->
26054   <tr><td colspan="6" id="section_blackLevel" class="section">blackLevel</td></tr>
26055
26056
26057       <tr><td colspan="6" class="kind">controls</td></tr>
26058
26059       <thead class="entries_header">
26060         <tr>
26061           <th class="th_name">Property Name</th>
26062           <th class="th_type">Type</th>
26063           <th class="th_description">Description</th>
26064           <th class="th_units">Units</th>
26065           <th class="th_range">Range</th>
26066           <th class="th_tags">Tags</th>
26067         </tr>
26068       </thead>
26069
26070       <tbody>
26071
26072
26073
26074
26075
26076
26077
26078
26079
26080
26081           <tr class="entry" id="controls_android.blackLevel.lock">
26082             <td class="entry_name
26083              " rowspan="5">
26084               android.<wbr/>black<wbr/>Level.<wbr/>lock
26085             </td>
26086             <td class="entry_type">
26087                 <span class="entry_type_name entry_type_name_enum">byte</span>
26088
26089               <span class="entry_type_visibility"> [public as boolean]</span>
26090
26091
26092               <span class="entry_type_hwlevel">[full] </span>
26093
26094
26095
26096                 <ul class="entry_type_enum">
26097                   <li>
26098                     <span class="entry_type_enum_name">OFF</span>
26099                   </li>
26100                   <li>
26101                     <span class="entry_type_enum_name">ON</span>
26102                   </li>
26103                 </ul>
26104
26105             </td> <!-- entry_type -->
26106
26107             <td class="entry_description">
26108               <p>Whether black-level compensation is locked
26109 to its current values,<wbr/> or is free to vary.<wbr/></p>
26110             </td>
26111
26112             <td class="entry_units">
26113             </td>
26114
26115             <td class="entry_range">
26116             </td>
26117
26118             <td class="entry_tags">
26119               <ul class="entry_tags">
26120                   <li><a href="#tag_HAL2">HAL2</a></li>
26121               </ul>
26122             </td>
26123
26124           </tr>
26125           <tr class="entries_header">
26126             <th class="th_details" colspan="5">Details</th>
26127           </tr>
26128           <tr class="entry_cont">
26129             <td class="entry_details" colspan="5">
26130               <p>When set to <code>true</code> (ON),<wbr/> the values used for black-level
26131 compensation will not change until the lock is set to
26132 <code>false</code> (OFF).<wbr/></p>
26133 <p>Since changes to certain capture parameters (such as
26134 exposure time) may require resetting of black level
26135 compensation,<wbr/> the camera device must report whether setting
26136 the black level lock was successful in the output result
26137 metadata.<wbr/></p>
26138 <p>For example,<wbr/> if a sequence of requests is as follows:</p>
26139 <ul>
26140 <li>Request 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
26141 <li>Request 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
26142 <li>Request 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
26143 <li>Request 4: Exposure = 20ms,<wbr/> Black level lock = ON</li>
26144 <li>Request 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
26145 <li>Request 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
26146 </ul>
26147 <p>And the exposure change in Request 4 requires the camera
26148 device to reset the black level offsets,<wbr/> then the output
26149 result metadata is expected to be:</p>
26150 <ul>
26151 <li>Result 1: Exposure = 10ms,<wbr/> Black level lock = OFF</li>
26152 <li>Result 2: Exposure = 10ms,<wbr/> Black level lock = ON</li>
26153 <li>Result 3: Exposure = 10ms,<wbr/> Black level lock = ON</li>
26154 <li>Result 4: Exposure = 20ms,<wbr/> Black level lock = OFF</li>
26155 <li>Result 5: Exposure = 20ms,<wbr/> Black level lock = ON</li>
26156 <li>Result 6: Exposure = 20ms,<wbr/> Black level lock = ON</li>
26157 </ul>
26158 <p>This indicates to the application that on frame 4,<wbr/> black
26159 levels were reset due to exposure value changes,<wbr/> and pixel
26160 values may not be consistent across captures.<wbr/></p>
26161 <p>The camera device will maintain the lock to the extent
26162 possible,<wbr/> only overriding the lock to OFF when changes to
26163 other request parameters require a black level recalculation
26164 or reset.<wbr/></p>
26165             </td>
26166           </tr>
26167
26168           <tr class="entries_header">
26169             <th class="th_details" colspan="5">HAL Implementation Details</th>
26170           </tr>
26171           <tr class="entry_cont">
26172             <td class="entry_details" colspan="5">
26173               <p>If for some reason black level locking is no longer possible
26174 (for example,<wbr/> the analog gain has changed,<wbr/> which forces
26175 black level offsets to be recalculated),<wbr/> then the HAL must
26176 override this request (and it must report 'OFF' when this
26177 does happen) until the next capture for which locking is
26178 possible again.<wbr/></p>
26179             </td>
26180           </tr>
26181
26182           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26183            <!-- end of entry -->
26184
26185
26186
26187       <!-- end of kind -->
26188       </tbody>
26189       <tr><td colspan="6" class="kind">dynamic</td></tr>
26190
26191       <thead class="entries_header">
26192         <tr>
26193           <th class="th_name">Property Name</th>
26194           <th class="th_type">Type</th>
26195           <th class="th_description">Description</th>
26196           <th class="th_units">Units</th>
26197           <th class="th_range">Range</th>
26198           <th class="th_tags">Tags</th>
26199         </tr>
26200       </thead>
26201
26202       <tbody>
26203
26204
26205
26206
26207
26208
26209
26210
26211
26212
26213           <tr class="entry" id="dynamic_android.blackLevel.lock">
26214             <td class="entry_name
26215              " rowspan="5">
26216               android.<wbr/>black<wbr/>Level.<wbr/>lock
26217             </td>
26218             <td class="entry_type">
26219                 <span class="entry_type_name entry_type_name_enum">byte</span>
26220
26221               <span class="entry_type_visibility"> [public as boolean]</span>
26222
26223
26224               <span class="entry_type_hwlevel">[full] </span>
26225
26226
26227
26228                 <ul class="entry_type_enum">
26229                   <li>
26230                     <span class="entry_type_enum_name">OFF</span>
26231                   </li>
26232                   <li>
26233                     <span class="entry_type_enum_name">ON</span>
26234                   </li>
26235                 </ul>
26236
26237             </td> <!-- entry_type -->
26238
26239             <td class="entry_description">
26240               <p>Whether black-level compensation is locked
26241 to its current values,<wbr/> or is free to vary.<wbr/></p>
26242             </td>
26243
26244             <td class="entry_units">
26245             </td>
26246
26247             <td class="entry_range">
26248             </td>
26249
26250             <td class="entry_tags">
26251               <ul class="entry_tags">
26252                   <li><a href="#tag_HAL2">HAL2</a></li>
26253               </ul>
26254             </td>
26255
26256           </tr>
26257           <tr class="entries_header">
26258             <th class="th_details" colspan="5">Details</th>
26259           </tr>
26260           <tr class="entry_cont">
26261             <td class="entry_details" colspan="5">
26262               <p>Whether the black level offset was locked for this frame.<wbr/>  Should be
26263 ON if <a href="#controls_android.blackLevel.lock">android.<wbr/>black<wbr/>Level.<wbr/>lock</a> was ON in the capture request,<wbr/> unless
26264 a change in other capture settings forced the camera device to
26265 perform a black level reset.<wbr/></p>
26266             </td>
26267           </tr>
26268
26269           <tr class="entries_header">
26270             <th class="th_details" colspan="5">HAL Implementation Details</th>
26271           </tr>
26272           <tr class="entry_cont">
26273             <td class="entry_details" colspan="5">
26274               <p>If for some reason black level locking is no longer possible
26275 (for example,<wbr/> the analog gain has changed,<wbr/> which forces
26276 black level offsets to be recalculated),<wbr/> then the HAL must
26277 override this request (and it must report 'OFF' when this
26278 does happen) until the next capture for which locking is
26279 possible again.<wbr/></p>
26280             </td>
26281           </tr>
26282
26283           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26284            <!-- end of entry -->
26285
26286
26287
26288       <!-- end of kind -->
26289       </tbody>
26290
26291   <!-- end of section -->
26292   <tr><td colspan="6" id="section_sync" class="section">sync</td></tr>
26293
26294
26295       <tr><td colspan="6" class="kind">dynamic</td></tr>
26296
26297       <thead class="entries_header">
26298         <tr>
26299           <th class="th_name">Property Name</th>
26300           <th class="th_type">Type</th>
26301           <th class="th_description">Description</th>
26302           <th class="th_units">Units</th>
26303           <th class="th_range">Range</th>
26304           <th class="th_tags">Tags</th>
26305         </tr>
26306       </thead>
26307
26308       <tbody>
26309
26310
26311
26312
26313
26314
26315
26316
26317
26318
26319           <tr class="entry" id="dynamic_android.sync.frameNumber">
26320             <td class="entry_name
26321              " rowspan="5">
26322               android.<wbr/>sync.<wbr/>frame<wbr/>Number
26323             </td>
26324             <td class="entry_type">
26325                 <span class="entry_type_name entry_type_name_enum">int64</span>
26326
26327               <span class="entry_type_visibility"> [ndk_public]</span>
26328
26329
26330               <span class="entry_type_hwlevel">[legacy] </span>
26331
26332
26333
26334                 <ul class="entry_type_enum">
26335                   <li>
26336                     <span class="entry_type_enum_name">CONVERGING</span>
26337                     <span class="entry_type_enum_value">-1</span>
26338                     <span class="entry_type_enum_notes"><p>The current result is not yet fully synchronized to any request.<wbr/></p>
26339 <p>Synchronization is in progress,<wbr/> and reading metadata from this
26340 result may include a mix of data that have taken effect since the
26341 last synchronization time.<wbr/></p>
26342 <p>In some future result,<wbr/> within <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a> frames,<wbr/>
26343 this value will update to the actual frame number frame number
26344 the result is guaranteed to be synchronized to (as long as the
26345 request settings remain constant).<wbr/></p></span>
26346                   </li>
26347                   <li>
26348                     <span class="entry_type_enum_name">UNKNOWN</span>
26349                     <span class="entry_type_enum_value">-2</span>
26350                     <span class="entry_type_enum_notes"><p>The current result's synchronization status is unknown.<wbr/></p>
26351 <p>The result may have already converged,<wbr/> or it may be in
26352 progress.<wbr/>  Reading from this result may include some mix
26353 of settings from past requests.<wbr/></p>
26354 <p>After a settings change,<wbr/> the new settings will eventually all
26355 take effect for the output buffers and results.<wbr/> However,<wbr/> this
26356 value will not change when that happens.<wbr/> Altering settings
26357 rapidly may provide outcomes using mixes of settings from recent
26358 requests.<wbr/></p>
26359 <p>This value is intended primarily for backwards compatibility with
26360 the older camera implementations (for android.<wbr/>hardware.<wbr/>Camera).<wbr/></p></span>
26361                   </li>
26362                 </ul>
26363
26364             </td> <!-- entry_type -->
26365
26366             <td class="entry_description">
26367               <p>The frame number corresponding to the last request
26368 with which the output result (metadata + buffers) has been fully
26369 synchronized.<wbr/></p>
26370             </td>
26371
26372             <td class="entry_units">
26373             </td>
26374
26375             <td class="entry_range">
26376               <p>Either a non-negative value corresponding to a
26377 <code>frame_<wbr/>number</code>,<wbr/> or one of the two enums (CONVERGING /<wbr/> UNKNOWN).<wbr/></p>
26378             </td>
26379
26380             <td class="entry_tags">
26381               <ul class="entry_tags">
26382                   <li><a href="#tag_V1">V1</a></li>
26383               </ul>
26384             </td>
26385
26386           </tr>
26387           <tr class="entries_header">
26388             <th class="th_details" colspan="5">Details</th>
26389           </tr>
26390           <tr class="entry_cont">
26391             <td class="entry_details" colspan="5">
26392               <p>When a request is submitted to the camera device,<wbr/> there is usually a
26393 delay of several frames before the controls get applied.<wbr/> A camera
26394 device may either choose to account for this delay by implementing a
26395 pipeline and carefully submit well-timed atomic control updates,<wbr/> or
26396 it may start streaming control changes that span over several frame
26397 boundaries.<wbr/></p>
26398 <p>In the latter case,<wbr/> whenever a request's settings change relative to
26399 the previous submitted request,<wbr/> the full set of changes may take
26400 multiple frame durations to fully take effect.<wbr/> Some settings may
26401 take effect sooner (in less frame durations) than others.<wbr/></p>
26402 <p>While a set of control changes are being propagated,<wbr/> this value
26403 will be CONVERGING.<wbr/></p>
26404 <p>Once it is fully known that a set of control changes have been
26405 finished propagating,<wbr/> and the resulting updated control settings
26406 have been read back by the camera device,<wbr/> this value will be set
26407 to a non-negative frame number (corresponding to the request to
26408 which the results have synchronized to).<wbr/></p>
26409 <p>Older camera device implementations may not have a way to detect
26410 when all camera controls have been applied,<wbr/> and will always set this
26411 value to UNKNOWN.<wbr/></p>
26412 <p>FULL capability devices will always have this value set to the
26413 frame number of the request corresponding to this result.<wbr/></p>
26414 <p><em>Further details</em>:</p>
26415 <ul>
26416 <li>Whenever a request differs from the last request,<wbr/> any future
26417 results not yet returned may have this value set to CONVERGING (this
26418 could include any in-progress captures not yet returned by the camera
26419 device,<wbr/> for more details see pipeline considerations below).<wbr/></li>
26420 <li>Submitting a series of multiple requests that differ from the
26421 previous request (e.<wbr/>g.<wbr/> r1,<wbr/> r2,<wbr/> r3 s.<wbr/>t.<wbr/> r1 != r2 != r3)
26422 moves the new synchronization frame to the last non-repeating
26423 request (using the smallest frame number from the contiguous list of
26424 repeating requests).<wbr/></li>
26425 <li>Submitting the same request repeatedly will not change this value
26426 to CONVERGING,<wbr/> if it was already a non-negative value.<wbr/></li>
26427 <li>When this value changes to non-negative,<wbr/> that means that all of the
26428 metadata controls from the request have been applied,<wbr/> all of the
26429 metadata controls from the camera device have been read to the
26430 updated values (into the result),<wbr/> and all of the graphics buffers
26431 corresponding to this result are also synchronized to the request.<wbr/></li>
26432 </ul>
26433 <p><em>Pipeline considerations</em>:</p>
26434 <p>Submitting a request with updated controls relative to the previously
26435 submitted requests may also invalidate the synchronization state
26436 of all the results corresponding to currently in-flight requests.<wbr/></p>
26437 <p>In other words,<wbr/> results for this current request and up to
26438 <a href="#static_android.request.pipelineMaxDepth">android.<wbr/>request.<wbr/>pipeline<wbr/>Max<wbr/>Depth</a> prior requests may have their
26439 <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> change to CONVERGING.<wbr/></p>
26440             </td>
26441           </tr>
26442
26443           <tr class="entries_header">
26444             <th class="th_details" colspan="5">HAL Implementation Details</th>
26445           </tr>
26446           <tr class="entry_cont">
26447             <td class="entry_details" colspan="5">
26448               <p>Using UNKNOWN here is illegal unless <a href="#static_android.sync.maxLatency">android.<wbr/>sync.<wbr/>max<wbr/>Latency</a>
26449 is also UNKNOWN.<wbr/></p>
26450 <p>FULL capability devices should simply set this value to the
26451 <code>frame_<wbr/>number</code> of the request this result corresponds to.<wbr/></p>
26452             </td>
26453           </tr>
26454
26455           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26456            <!-- end of entry -->
26457
26458
26459
26460       <!-- end of kind -->
26461       </tbody>
26462       <tr><td colspan="6" class="kind">static</td></tr>
26463
26464       <thead class="entries_header">
26465         <tr>
26466           <th class="th_name">Property Name</th>
26467           <th class="th_type">Type</th>
26468           <th class="th_description">Description</th>
26469           <th class="th_units">Units</th>
26470           <th class="th_range">Range</th>
26471           <th class="th_tags">Tags</th>
26472         </tr>
26473       </thead>
26474
26475       <tbody>
26476
26477
26478
26479
26480
26481
26482
26483
26484
26485
26486           <tr class="entry" id="static_android.sync.maxLatency">
26487             <td class="entry_name
26488              " rowspan="5">
26489               android.<wbr/>sync.<wbr/>max<wbr/>Latency
26490             </td>
26491             <td class="entry_type">
26492                 <span class="entry_type_name entry_type_name_enum">int32</span>
26493
26494               <span class="entry_type_visibility"> [public]</span>
26495
26496
26497               <span class="entry_type_hwlevel">[legacy] </span>
26498
26499
26500
26501                 <ul class="entry_type_enum">
26502                   <li>
26503                     <span class="entry_type_enum_name">PER_FRAME_CONTROL</span>
26504                     <span class="entry_type_enum_value">0</span>
26505                     <span class="entry_type_enum_notes"><p>Every frame has the requests immediately applied.<wbr/></p>
26506 <p>Changing controls over multiple requests one after another will
26507 produce results that have those controls applied atomically
26508 each frame.<wbr/></p>
26509 <p>All FULL capability devices will have this as their maxLatency.<wbr/></p></span>
26510                   </li>
26511                   <li>
26512                     <span class="entry_type_enum_name">UNKNOWN</span>
26513                     <span class="entry_type_enum_value">-1</span>
26514                     <span class="entry_type_enum_notes"><p>Each new frame has some subset (potentially the entire set)
26515 of the past requests applied to the camera settings.<wbr/></p>
26516 <p>By submitting a series of identical requests,<wbr/> the camera device
26517 will eventually have the camera settings applied,<wbr/> but it is
26518 unknown when that exact point will be.<wbr/></p>
26519 <p>All LEGACY capability devices will have this as their maxLatency.<wbr/></p></span>
26520                   </li>
26521                 </ul>
26522
26523             </td> <!-- entry_type -->
26524
26525             <td class="entry_description">
26526               <p>The maximum number of frames that can occur after a request
26527 (different than the previous) has been submitted,<wbr/> and before the
26528 result's state becomes synchronized.<wbr/></p>
26529             </td>
26530
26531             <td class="entry_units">
26532               Frame counts
26533             </td>
26534
26535             <td class="entry_range">
26536               <p>A positive value,<wbr/> PER_<wbr/>FRAME_<wbr/>CONTROL,<wbr/> or UNKNOWN.<wbr/></p>
26537             </td>
26538
26539             <td class="entry_tags">
26540               <ul class="entry_tags">
26541                   <li><a href="#tag_V1">V1</a></li>
26542               </ul>
26543             </td>
26544
26545           </tr>
26546           <tr class="entries_header">
26547             <th class="th_details" colspan="5">Details</th>
26548           </tr>
26549           <tr class="entry_cont">
26550             <td class="entry_details" colspan="5">
26551               <p>This defines the maximum distance (in number of metadata results),<wbr/>
26552 between the frame number of the request that has new controls to apply
26553 and the frame number of the result that has all the controls applied.<wbr/></p>
26554 <p>In other words this acts as an upper boundary for how many frames
26555 must occur before the camera device knows for a fact that the new
26556 submitted camera settings have been applied in outgoing frames.<wbr/></p>
26557             </td>
26558           </tr>
26559
26560           <tr class="entries_header">
26561             <th class="th_details" colspan="5">HAL Implementation Details</th>
26562           </tr>
26563           <tr class="entry_cont">
26564             <td class="entry_details" colspan="5">
26565               <p>For example if maxLatency was 2,<wbr/></p>
26566 <pre><code>initial request = X (repeating)
26567 request1 = X
26568 request2 = Y
26569 request3 = Y
26570 request4 = Y
26571
26572 where requestN has frameNumber N,<wbr/> and the first of the repeating
26573 initial request's has frameNumber F (and F &lt; 1).<wbr/>
26574
26575 initial result = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
26576 result1 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == F }
26577 result2 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
26578 result3 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == CONVERGING }
26579 result4 = X' + { <a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2 }
26580
26581 where resultN has frameNumber N.<wbr/>
26582 </code></pre>
26583 <p>Since <code>result4</code> has a <code>frameNumber == 4</code> and
26584 <code><a href="#dynamic_android.sync.frameNumber">android.<wbr/>sync.<wbr/>frame<wbr/>Number</a> == 2</code>,<wbr/> the distance is clearly
26585 <code>4 - 2 = 2</code>.<wbr/></p>
26586 <p>Use <code>frame_<wbr/>count</code> from camera3_<wbr/>request_<wbr/>t instead of
26587 <a href="#controls_android.request.frameCount">android.<wbr/>request.<wbr/>frame<wbr/>Count</a> or
26588 <code><a href="https://developer.android.com/reference/android/hardware/camera2/CaptureResult.html#getFrameNumber">CaptureResult#getFrameNumber</a></code>.<wbr/></p>
26589 <p>LIMITED devices are strongly encouraged to use a non-negative
26590 value.<wbr/> If UNKNOWN is used here then app developers do not have a way
26591 to know when sensor settings have been applied.<wbr/></p>
26592             </td>
26593           </tr>
26594
26595           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26596            <!-- end of entry -->
26597
26598
26599
26600       <!-- end of kind -->
26601       </tbody>
26602
26603   <!-- end of section -->
26604   <tr><td colspan="6" id="section_reprocess" class="section">reprocess</td></tr>
26605
26606
26607       <tr><td colspan="6" class="kind">controls</td></tr>
26608
26609       <thead class="entries_header">
26610         <tr>
26611           <th class="th_name">Property Name</th>
26612           <th class="th_type">Type</th>
26613           <th class="th_description">Description</th>
26614           <th class="th_units">Units</th>
26615           <th class="th_range">Range</th>
26616           <th class="th_tags">Tags</th>
26617         </tr>
26618       </thead>
26619
26620       <tbody>
26621
26622
26623
26624
26625
26626
26627
26628
26629
26630
26631           <tr class="entry" id="controls_android.reprocess.effectiveExposureFactor">
26632             <td class="entry_name
26633              " rowspan="3">
26634               android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor
26635             </td>
26636             <td class="entry_type">
26637                 <span class="entry_type_name">float</span>
26638
26639               <span class="entry_type_visibility"> [java_public]</span>
26640
26641
26642               <span class="entry_type_hwlevel">[limited] </span>
26643
26644
26645
26646
26647             </td> <!-- entry_type -->
26648
26649             <td class="entry_description">
26650               <p>The amount of exposure time increase factor applied to the original output
26651 frame by the application processing before sending for reprocessing.<wbr/></p>
26652             </td>
26653
26654             <td class="entry_units">
26655               Relative exposure time increase factor.<wbr/>
26656             </td>
26657
26658             <td class="entry_range">
26659               <p>&gt;= 1.<wbr/>0</p>
26660             </td>
26661
26662             <td class="entry_tags">
26663               <ul class="entry_tags">
26664                   <li><a href="#tag_REPROC">REPROC</a></li>
26665               </ul>
26666             </td>
26667
26668           </tr>
26669           <tr class="entries_header">
26670             <th class="th_details" colspan="5">Details</th>
26671           </tr>
26672           <tr class="entry_cont">
26673             <td class="entry_details" colspan="5">
26674               <p>This is optional,<wbr/> and will be supported if the camera device supports YUV_<wbr/>REPROCESSING
26675 capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains YUV_<wbr/>REPROCESSING).<wbr/></p>
26676 <p>For some YUV reprocessing use cases,<wbr/> the application may choose to filter the original
26677 output frames to effectively reduce the noise to the same level as a frame that was
26678 captured with longer exposure time.<wbr/> To be more specific,<wbr/> assuming the original captured
26679 images were captured with a sensitivity of S and an exposure time of T,<wbr/> the model in
26680 the camera device is that the amount of noise in the image would be approximately what
26681 would be expected if the original capture parameters had been a sensitivity of
26682 S/<wbr/>effectiveExposureFactor and an exposure time of T*effectiveExposureFactor,<wbr/> rather
26683 than S and T respectively.<wbr/> If the captured images were processed by the application
26684 before being sent for reprocessing,<wbr/> then the application may have used image processing
26685 algorithms and/<wbr/>or multi-frame image fusion to reduce the noise in the
26686 application-processed images (input images).<wbr/> By using the effectiveExposureFactor
26687 control,<wbr/> the application can communicate to the camera device the actual noise level
26688 improvement in the application-processed image.<wbr/> With this information,<wbr/> the camera
26689 device can select appropriate noise reduction and edge enhancement parameters to avoid
26690 excessive noise reduction (<a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a>) and insufficient edge
26691 enhancement (<a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a>) being applied to the reprocessed frames.<wbr/></p>
26692 <p>For example,<wbr/> for multi-frame image fusion use case,<wbr/> the application may fuse
26693 multiple output frames together to a final frame for reprocessing.<wbr/> When N image are
26694 fused into 1 image for reprocessing,<wbr/> the exposure time increase factor could be up to
26695 square root of N (based on a simple photon shot noise model).<wbr/> The camera device will
26696 adjust the reprocessing noise reduction and edge enhancement parameters accordingly to
26697 produce the best quality images.<wbr/></p>
26698 <p>This is relative factor,<wbr/> 1.<wbr/>0 indicates the application hasn't processed the input
26699 buffer in a way that affects its effective exposure time.<wbr/></p>
26700 <p>This control is only effective for YUV reprocessing capture request.<wbr/> For noise
26701 reduction reprocessing,<wbr/> it is only effective when <code><a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a> != OFF</code>.<wbr/>
26702 Similarly,<wbr/> for edge enhancement reprocessing,<wbr/> it is only effective when
26703 <code><a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a> != OFF</code>.<wbr/></p>
26704             </td>
26705           </tr>
26706
26707
26708           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26709            <!-- end of entry -->
26710
26711
26712
26713       <!-- end of kind -->
26714       </tbody>
26715       <tr><td colspan="6" class="kind">dynamic</td></tr>
26716
26717       <thead class="entries_header">
26718         <tr>
26719           <th class="th_name">Property Name</th>
26720           <th class="th_type">Type</th>
26721           <th class="th_description">Description</th>
26722           <th class="th_units">Units</th>
26723           <th class="th_range">Range</th>
26724           <th class="th_tags">Tags</th>
26725         </tr>
26726       </thead>
26727
26728       <tbody>
26729
26730
26731
26732
26733
26734
26735
26736
26737
26738
26739           <tr class="entry" id="dynamic_android.reprocess.effectiveExposureFactor">
26740             <td class="entry_name
26741              " rowspan="3">
26742               android.<wbr/>reprocess.<wbr/>effective<wbr/>Exposure<wbr/>Factor
26743             </td>
26744             <td class="entry_type">
26745                 <span class="entry_type_name">float</span>
26746
26747               <span class="entry_type_visibility"> [java_public]</span>
26748
26749
26750               <span class="entry_type_hwlevel">[limited] </span>
26751
26752
26753
26754
26755             </td> <!-- entry_type -->
26756
26757             <td class="entry_description">
26758               <p>The amount of exposure time increase factor applied to the original output
26759 frame by the application processing before sending for reprocessing.<wbr/></p>
26760             </td>
26761
26762             <td class="entry_units">
26763               Relative exposure time increase factor.<wbr/>
26764             </td>
26765
26766             <td class="entry_range">
26767               <p>&gt;= 1.<wbr/>0</p>
26768             </td>
26769
26770             <td class="entry_tags">
26771               <ul class="entry_tags">
26772                   <li><a href="#tag_REPROC">REPROC</a></li>
26773               </ul>
26774             </td>
26775
26776           </tr>
26777           <tr class="entries_header">
26778             <th class="th_details" colspan="5">Details</th>
26779           </tr>
26780           <tr class="entry_cont">
26781             <td class="entry_details" colspan="5">
26782               <p>This is optional,<wbr/> and will be supported if the camera device supports YUV_<wbr/>REPROCESSING
26783 capability (<a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains YUV_<wbr/>REPROCESSING).<wbr/></p>
26784 <p>For some YUV reprocessing use cases,<wbr/> the application may choose to filter the original
26785 output frames to effectively reduce the noise to the same level as a frame that was
26786 captured with longer exposure time.<wbr/> To be more specific,<wbr/> assuming the original captured
26787 images were captured with a sensitivity of S and an exposure time of T,<wbr/> the model in
26788 the camera device is that the amount of noise in the image would be approximately what
26789 would be expected if the original capture parameters had been a sensitivity of
26790 S/<wbr/>effectiveExposureFactor and an exposure time of T*effectiveExposureFactor,<wbr/> rather
26791 than S and T respectively.<wbr/> If the captured images were processed by the application
26792 before being sent for reprocessing,<wbr/> then the application may have used image processing
26793 algorithms and/<wbr/>or multi-frame image fusion to reduce the noise in the
26794 application-processed images (input images).<wbr/> By using the effectiveExposureFactor
26795 control,<wbr/> the application can communicate to the camera device the actual noise level
26796 improvement in the application-processed image.<wbr/> With this information,<wbr/> the camera
26797 device can select appropriate noise reduction and edge enhancement parameters to avoid
26798 excessive noise reduction (<a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a>) and insufficient edge
26799 enhancement (<a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a>) being applied to the reprocessed frames.<wbr/></p>
26800 <p>For example,<wbr/> for multi-frame image fusion use case,<wbr/> the application may fuse
26801 multiple output frames together to a final frame for reprocessing.<wbr/> When N image are
26802 fused into 1 image for reprocessing,<wbr/> the exposure time increase factor could be up to
26803 square root of N (based on a simple photon shot noise model).<wbr/> The camera device will
26804 adjust the reprocessing noise reduction and edge enhancement parameters accordingly to
26805 produce the best quality images.<wbr/></p>
26806 <p>This is relative factor,<wbr/> 1.<wbr/>0 indicates the application hasn't processed the input
26807 buffer in a way that affects its effective exposure time.<wbr/></p>
26808 <p>This control is only effective for YUV reprocessing capture request.<wbr/> For noise
26809 reduction reprocessing,<wbr/> it is only effective when <code><a href="#controls_android.noiseReduction.mode">android.<wbr/>noise<wbr/>Reduction.<wbr/>mode</a> != OFF</code>.<wbr/>
26810 Similarly,<wbr/> for edge enhancement reprocessing,<wbr/> it is only effective when
26811 <code><a href="#controls_android.edge.mode">android.<wbr/>edge.<wbr/>mode</a> != OFF</code>.<wbr/></p>
26812             </td>
26813           </tr>
26814
26815
26816           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26817            <!-- end of entry -->
26818
26819
26820
26821       <!-- end of kind -->
26822       </tbody>
26823       <tr><td colspan="6" class="kind">static</td></tr>
26824
26825       <thead class="entries_header">
26826         <tr>
26827           <th class="th_name">Property Name</th>
26828           <th class="th_type">Type</th>
26829           <th class="th_description">Description</th>
26830           <th class="th_units">Units</th>
26831           <th class="th_range">Range</th>
26832           <th class="th_tags">Tags</th>
26833         </tr>
26834       </thead>
26835
26836       <tbody>
26837
26838
26839
26840
26841
26842
26843
26844
26845
26846
26847           <tr class="entry" id="static_android.reprocess.maxCaptureStall">
26848             <td class="entry_name
26849              " rowspan="3">
26850               android.<wbr/>reprocess.<wbr/>max<wbr/>Capture<wbr/>Stall
26851             </td>
26852             <td class="entry_type">
26853                 <span class="entry_type_name">int32</span>
26854
26855               <span class="entry_type_visibility"> [java_public]</span>
26856
26857
26858               <span class="entry_type_hwlevel">[limited] </span>
26859
26860
26861
26862
26863             </td> <!-- entry_type -->
26864
26865             <td class="entry_description">
26866               <p>The maximal camera capture pipeline stall (in unit of frame count) introduced by a
26867 reprocess capture request.<wbr/></p>
26868             </td>
26869
26870             <td class="entry_units">
26871               Number of frames.<wbr/>
26872             </td>
26873
26874             <td class="entry_range">
26875               <p>&lt;= 4</p>
26876             </td>
26877
26878             <td class="entry_tags">
26879               <ul class="entry_tags">
26880                   <li><a href="#tag_REPROC">REPROC</a></li>
26881               </ul>
26882             </td>
26883
26884           </tr>
26885           <tr class="entries_header">
26886             <th class="th_details" colspan="5">Details</th>
26887           </tr>
26888           <tr class="entry_cont">
26889             <td class="entry_details" colspan="5">
26890               <p>The key describes the maximal interference that one reprocess (input) request
26891 can introduce to the camera simultaneous streaming of regular (output) capture
26892 requests,<wbr/> including repeating requests.<wbr/></p>
26893 <p>When a reprocessing capture request is submitted while a camera output repeating request
26894 (e.<wbr/>g.<wbr/> preview) is being served by the camera device,<wbr/> it may preempt the camera capture
26895 pipeline for at least one frame duration so that the camera device is unable to process
26896 the following capture request in time for the next sensor start of exposure boundary.<wbr/>
26897 When this happens,<wbr/> the application may observe a capture time gap (longer than one frame
26898 duration) between adjacent capture output frames,<wbr/> which usually exhibits as preview
26899 glitch if the repeating request output targets include a preview surface.<wbr/> This key gives
26900 the worst-case number of frame stall introduced by one reprocess request with any kind of
26901 formats/<wbr/>sizes combination.<wbr/></p>
26902 <p>If this key reports 0,<wbr/> it means a reprocess request doesn't introduce any glitch to the
26903 ongoing camera repeating request outputs,<wbr/> as if this reprocess request is never issued.<wbr/></p>
26904 <p>This key is supported if the camera device supports PRIVATE or YUV reprocessing (
26905 i.<wbr/>e.<wbr/> <a href="#static_android.request.availableCapabilities">android.<wbr/>request.<wbr/>available<wbr/>Capabilities</a> contains PRIVATE_<wbr/>REPROCESSING or
26906 YUV_<wbr/>REPROCESSING).<wbr/></p>
26907             </td>
26908           </tr>
26909
26910
26911           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26912            <!-- end of entry -->
26913
26914
26915
26916       <!-- end of kind -->
26917       </tbody>
26918
26919   <!-- end of section -->
26920   <tr><td colspan="6" id="section_depth" class="section">depth</td></tr>
26921
26922
26923       <tr><td colspan="6" class="kind">static</td></tr>
26924
26925       <thead class="entries_header">
26926         <tr>
26927           <th class="th_name">Property Name</th>
26928           <th class="th_type">Type</th>
26929           <th class="th_description">Description</th>
26930           <th class="th_units">Units</th>
26931           <th class="th_range">Range</th>
26932           <th class="th_tags">Tags</th>
26933         </tr>
26934       </thead>
26935
26936       <tbody>
26937
26938
26939
26940
26941
26942
26943
26944
26945
26946
26947           <tr class="entry" id="static_android.depth.maxDepthSamples">
26948             <td class="entry_name
26949              " rowspan="3">
26950               android.<wbr/>depth.<wbr/>max<wbr/>Depth<wbr/>Samples
26951             </td>
26952             <td class="entry_type">
26953                 <span class="entry_type_name">int32</span>
26954
26955               <span class="entry_type_visibility"> [system]</span>
26956
26957
26958               <span class="entry_type_hwlevel">[limited] </span>
26959
26960
26961
26962
26963             </td> <!-- entry_type -->
26964
26965             <td class="entry_description">
26966               <p>Maximum number of points that a depth point cloud may contain.<wbr/></p>
26967             </td>
26968
26969             <td class="entry_units">
26970             </td>
26971
26972             <td class="entry_range">
26973             </td>
26974
26975             <td class="entry_tags">
26976               <ul class="entry_tags">
26977                   <li><a href="#tag_DEPTH">DEPTH</a></li>
26978               </ul>
26979             </td>
26980
26981           </tr>
26982           <tr class="entries_header">
26983             <th class="th_details" colspan="5">Details</th>
26984           </tr>
26985           <tr class="entry_cont">
26986             <td class="entry_details" colspan="5">
26987               <p>If a camera device supports outputting depth range data in the form of a depth point
26988 cloud (<a href="https://developer.android.com/reference/android/graphics/ImageFormat.html#DEPTH_POINT_CLOUD">Image<wbr/>Format#DEPTH_<wbr/>POINT_<wbr/>CLOUD</a>),<wbr/> this is the maximum
26989 number of points an output buffer may contain.<wbr/></p>
26990 <p>Any given buffer may contain between 0 and maxDepthSamples points,<wbr/> inclusive.<wbr/>
26991 If output in the depth point cloud format is not supported,<wbr/> this entry will
26992 not be defined.<wbr/></p>
26993             </td>
26994           </tr>
26995
26996
26997           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
26998            <!-- end of entry -->
26999
27000
27001           <tr class="entry" id="static_android.depth.availableDepthStreamConfigurations">
27002             <td class="entry_name
27003              " rowspan="3">
27004               android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Stream<wbr/>Configurations
27005             </td>
27006             <td class="entry_type">
27007                 <span class="entry_type_name entry_type_name_enum">int32</span>
27008                 <span class="entry_type_container">x</span>
27009
27010                 <span class="entry_type_array">
27011                   n x 4
27012                 </span>
27013               <span class="entry_type_visibility"> [ndk_public as streamConfiguration]</span>
27014
27015
27016               <span class="entry_type_hwlevel">[limited] </span>
27017
27018
27019
27020                 <ul class="entry_type_enum">
27021                   <li>
27022                     <span class="entry_type_enum_name">OUTPUT</span>
27023                   </li>
27024                   <li>
27025                     <span class="entry_type_enum_name">INPUT</span>
27026                   </li>
27027                 </ul>
27028
27029             </td> <!-- entry_type -->
27030
27031             <td class="entry_description">
27032               <p>The available depth dataspace stream
27033 configurations that this camera device supports
27034 (i.<wbr/>e.<wbr/> format,<wbr/> width,<wbr/> height,<wbr/> output/<wbr/>input stream).<wbr/></p>
27035             </td>
27036
27037             <td class="entry_units">
27038             </td>
27039
27040             <td class="entry_range">
27041             </td>
27042
27043             <td class="entry_tags">
27044               <ul class="entry_tags">
27045                   <li><a href="#tag_DEPTH">DEPTH</a></li>
27046               </ul>
27047             </td>
27048
27049           </tr>
27050           <tr class="entries_header">
27051             <th class="th_details" colspan="5">Details</th>
27052           </tr>
27053           <tr class="entry_cont">
27054             <td class="entry_details" colspan="5">
27055               <p>These are output stream configurations for use with
27056 dataSpace HAL_<wbr/>DATASPACE_<wbr/>DEPTH.<wbr/> The configurations are
27057 listed as <code>(format,<wbr/> width,<wbr/> height,<wbr/> input?)</code> tuples.<wbr/></p>
27058 <p>Only devices that support depth output for at least
27059 the HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>Y16 dense depth map may include
27060 this entry.<wbr/></p>
27061 <p>A device that also supports the HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>BLOB
27062 sparse depth point cloud must report a single entry for
27063 the format in this list as <code>(HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>BLOB,<wbr/>
27064 <a href="#static_android.depth.maxDepthSamples">android.<wbr/>depth.<wbr/>max<wbr/>Depth<wbr/>Samples</a>,<wbr/> 1,<wbr/> OUTPUT)</code> in addition to
27065 the entries for HAL_<wbr/>PIXEL_<wbr/>FORMAT_<wbr/>Y16.<wbr/></p>
27066             </td>
27067           </tr>
27068
27069
27070           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
27071            <!-- end of entry -->
27072
27073
27074           <tr class="entry" id="static_android.depth.availableDepthMinFrameDurations">
27075             <td class="entry_name
27076              " rowspan="3">
27077               android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Min<wbr/>Frame<wbr/>Durations
27078             </td>
27079             <td class="entry_type">
27080                 <span class="entry_type_name">int64</span>
27081                 <span class="entry_type_container">x</span>
27082
27083                 <span class="entry_type_array">
27084                   4 x n
27085                 </span>
27086               <span class="entry_type_visibility"> [ndk_public as streamConfigurationDuration]</span>
27087
27088
27089               <span class="entry_type_hwlevel">[limited] </span>
27090
27091
27092
27093
27094             </td> <!-- entry_type -->
27095
27096             <td class="entry_description">
27097               <p>This lists the minimum frame duration for each
27098 format/<wbr/>size combination for depth output formats.<wbr/></p>
27099             </td>
27100
27101             <td class="entry_units">
27102               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
27103             </td>
27104
27105             <td class="entry_range">
27106             </td>
27107
27108             <td class="entry_tags">
27109               <ul class="entry_tags">
27110                   <li><a href="#tag_DEPTH">DEPTH</a></li>
27111               </ul>
27112             </td>
27113
27114           </tr>
27115           <tr class="entries_header">
27116             <th class="th_details" colspan="5">Details</th>
27117           </tr>
27118           <tr class="entry_cont">
27119             <td class="entry_details" colspan="5">
27120               <p>This should correspond to the frame duration when only that
27121 stream is active,<wbr/> with all processing (typically in android.<wbr/>*.<wbr/>mode)
27122 set to either OFF or FAST.<wbr/></p>
27123 <p>When multiple streams are used in a request,<wbr/> the minimum frame
27124 duration will be max(individual stream min durations).<wbr/></p>
27125 <p>The minimum frame duration of a stream (of a particular format,<wbr/> size)
27126 is the same regardless of whether the stream is input or output.<wbr/></p>
27127 <p>See <a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a> and
27128 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a> for more details about
27129 calculating the max frame rate.<wbr/></p>
27130 <p>(Keep in sync with <a href="https://developer.android.com/reference/android/hardware/camera2/params/StreamConfigurationMap.html#getOutputMinFrameDuration">StreamConfigurationMap#getOutputMinFrameDuration</a>)</p>
27131             </td>
27132           </tr>
27133
27134
27135           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
27136            <!-- end of entry -->
27137
27138
27139           <tr class="entry" id="static_android.depth.availableDepthStallDurations">
27140             <td class="entry_name
27141              " rowspan="3">
27142               android.<wbr/>depth.<wbr/>available<wbr/>Depth<wbr/>Stall<wbr/>Durations
27143             </td>
27144             <td class="entry_type">
27145                 <span class="entry_type_name">int64</span>
27146                 <span class="entry_type_container">x</span>
27147
27148                 <span class="entry_type_array">
27149                   4 x n
27150                 </span>
27151               <span class="entry_type_visibility"> [ndk_public as streamConfigurationDuration]</span>
27152
27153
27154               <span class="entry_type_hwlevel">[limited] </span>
27155
27156
27157
27158
27159             </td> <!-- entry_type -->
27160
27161             <td class="entry_description">
27162               <p>This lists the maximum stall duration for each
27163 output format/<wbr/>size combination for depth streams.<wbr/></p>
27164             </td>
27165
27166             <td class="entry_units">
27167               (format,<wbr/> width,<wbr/> height,<wbr/> ns) x n
27168             </td>
27169
27170             <td class="entry_range">
27171             </td>
27172
27173             <td class="entry_tags">
27174               <ul class="entry_tags">
27175                   <li><a href="#tag_DEPTH">DEPTH</a></li>
27176               </ul>
27177             </td>
27178
27179           </tr>
27180           <tr class="entries_header">
27181             <th class="th_details" colspan="5">Details</th>
27182           </tr>
27183           <tr class="entry_cont">
27184             <td class="entry_details" colspan="5">
27185               <p>A stall duration is how much extra time would get added
27186 to the normal minimum frame duration for a repeating request
27187 that has streams with non-zero stall.<wbr/></p>
27188 <p>This functions similarly to
27189 <a href="#static_android.scaler.availableStallDurations">android.<wbr/>scaler.<wbr/>available<wbr/>Stall<wbr/>Durations</a> for depth
27190 streams.<wbr/></p>
27191 <p>All depth output stream formats may have a nonzero stall
27192 duration.<wbr/></p>
27193             </td>
27194           </tr>
27195
27196
27197           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
27198            <!-- end of entry -->
27199
27200
27201           <tr class="entry" id="static_android.depth.depthIsExclusive">
27202             <td class="entry_name
27203              " rowspan="3">
27204               android.<wbr/>depth.<wbr/>depth<wbr/>Is<wbr/>Exclusive
27205             </td>
27206             <td class="entry_type">
27207                 <span class="entry_type_name entry_type_name_enum">byte</span>
27208
27209               <span class="entry_type_visibility"> [public as boolean]</span>
27210
27211
27212               <span class="entry_type_hwlevel">[limited] </span>
27213
27214
27215
27216                 <ul class="entry_type_enum">
27217                   <li>
27218                     <span class="entry_type_enum_name">FALSE</span>
27219                   </li>
27220                   <li>
27221                     <span class="entry_type_enum_name">TRUE</span>
27222                   </li>
27223                 </ul>
27224
27225             </td> <!-- entry_type -->
27226
27227             <td class="entry_description">
27228               <p>Indicates whether a capture request may target both a
27229 DEPTH16 /<wbr/> DEPTH_<wbr/>POINT_<wbr/>CLOUD output,<wbr/> and normal color outputs (such as
27230 YUV_<wbr/>420_<wbr/>888,<wbr/> JPEG,<wbr/> or RAW) simultaneously.<wbr/></p>
27231             </td>
27232
27233             <td class="entry_units">
27234             </td>
27235
27236             <td class="entry_range">
27237             </td>
27238
27239             <td class="entry_tags">
27240             </td>
27241
27242           </tr>
27243           <tr class="entries_header">
27244             <th class="th_details" colspan="5">Details</th>
27245           </tr>
27246           <tr class="entry_cont">
27247             <td class="entry_details" colspan="5">
27248               <p>If TRUE,<wbr/> including both depth and color outputs in a single
27249 capture request is not supported.<wbr/> An application must interleave color
27250 and depth requests.<wbr/>  If FALSE,<wbr/> a single request can target both types
27251 of output.<wbr/></p>
27252 <p>Typically,<wbr/> this restriction exists on camera devices that
27253 need to emit a specific pattern or wavelength of light to
27254 measure depth values,<wbr/> which causes the color image to be
27255 corrupted during depth measurement.<wbr/></p>
27256             </td>
27257           </tr>
27258
27259
27260           <tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
27261            <!-- end of entry -->
27262
27263
27264
27265       <!-- end of kind -->
27266       </tbody>
27267
27268   <!-- end of section -->
27269 <!-- </namespace> -->
27270   </table>
27271
27272   <div class="tags" id="tag_index">
27273     <h2>Tags</h2>
27274     <ul>
27275       <li id="tag_BC">BC -
27276         Needed for backwards compatibility with old Java API
27277
27278         <ul class="tags_entries">
27279           <li><a href="#controls_android.control.aeAntibandingMode">android.control.aeAntibandingMode</a> (controls)</li>
27280           <li><a href="#controls_android.control.aeExposureCompensation">android.control.aeExposureCompensation</a> (controls)</li>
27281           <li><a href="#controls_android.control.aeLock">android.control.aeLock</a> (controls)</li>
27282           <li><a href="#controls_android.control.aeMode">android.control.aeMode</a> (controls)</li>
27283           <li><a href="#controls_android.control.aeRegions">android.control.aeRegions</a> (controls)</li>
27284           <li><a href="#controls_android.control.aeTargetFpsRange">android.control.aeTargetFpsRange</a> (controls)</li>
27285           <li><a href="#controls_android.control.aePrecaptureTrigger">android.control.aePrecaptureTrigger</a> (controls)</li>
27286           <li><a href="#controls_android.control.afMode">android.control.afMode</a> (controls)</li>
27287           <li><a href="#controls_android.control.afRegions">android.control.afRegions</a> (controls)</li>
27288           <li><a href="#controls_android.control.afTrigger">android.control.afTrigger</a> (controls)</li>
27289           <li><a href="#controls_android.control.awbLock">android.control.awbLock</a> (controls)</li>
27290           <li><a href="#controls_android.control.awbMode">android.control.awbMode</a> (controls)</li>
27291           <li><a href="#controls_android.control.awbRegions">android.control.awbRegions</a> (controls)</li>
27292           <li><a href="#controls_android.control.captureIntent">android.control.captureIntent</a> (controls)</li>
27293           <li><a href="#controls_android.control.effectMode">android.control.effectMode</a> (controls)</li>
27294           <li><a href="#controls_android.control.mode">android.control.mode</a> (controls)</li>
27295           <li><a href="#controls_android.control.sceneMode">android.control.sceneMode</a> (controls)</li>
27296           <li><a href="#controls_android.control.videoStabilizationMode">android.control.videoStabilizationMode</a> (controls)</li>
27297           <li><a href="#static_android.control.aeAvailableAntibandingModes">android.control.aeAvailableAntibandingModes</a> (static)</li>
27298           <li><a href="#static_android.control.aeAvailableModes">android.control.aeAvailableModes</a> (static)</li>
27299           <li><a href="#static_android.control.aeAvailableTargetFpsRanges">android.control.aeAvailableTargetFpsRanges</a> (static)</li>
27300           <li><a href="#static_android.control.aeCompensationRange">android.control.aeCompensationRange</a> (static)</li>
27301           <li><a href="#static_android.control.aeCompensationStep">android.control.aeCompensationStep</a> (static)</li>
27302           <li><a href="#static_android.control.afAvailableModes">android.control.afAvailableModes</a> (static)</li>
27303           <li><a href="#static_android.control.availableEffects">android.control.availableEffects</a> (static)</li>
27304           <li><a href="#static_android.control.availableSceneModes">android.control.availableSceneModes</a> (static)</li>
27305           <li><a href="#static_android.control.availableVideoStabilizationModes">android.control.availableVideoStabilizationModes</a> (static)</li>
27306           <li><a href="#static_android.control.awbAvailableModes">android.control.awbAvailableModes</a> (static)</li>
27307           <li><a href="#static_android.control.maxRegions">android.control.maxRegions</a> (static)</li>
27308           <li><a href="#static_android.control.sceneModeOverrides">android.control.sceneModeOverrides</a> (static)</li>
27309           <li><a href="#static_android.control.aeLockAvailable">android.control.aeLockAvailable</a> (static)</li>
27310           <li><a href="#static_android.control.awbLockAvailable">android.control.awbLockAvailable</a> (static)</li>
27311           <li><a href="#controls_android.flash.mode">android.flash.mode</a> (controls)</li>
27312           <li><a href="#static_android.flash.info.available">android.flash.info.available</a> (static)</li>
27313           <li><a href="#controls_android.jpeg.gpsCoordinates">android.jpeg.gpsCoordinates</a> (controls)</li>
27314           <li><a href="#controls_android.jpeg.gpsProcessingMethod">android.jpeg.gpsProcessingMethod</a> (controls)</li>
27315           <li><a href="#controls_android.jpeg.gpsTimestamp">android.jpeg.gpsTimestamp</a> (controls)</li>
27316           <li><a href="#controls_android.jpeg.orientation">android.jpeg.orientation</a> (controls)</li>
27317           <li><a href="#controls_android.jpeg.quality">android.jpeg.quality</a> (controls)</li>
27318           <li><a href="#controls_android.jpeg.thumbnailQuality">android.jpeg.thumbnailQuality</a> (controls)</li>
27319           <li><a href="#controls_android.jpeg.thumbnailSize">android.jpeg.thumbnailSize</a> (controls)</li>
27320           <li><a href="#static_android.jpeg.availableThumbnailSizes">android.jpeg.availableThumbnailSizes</a> (static)</li>
27321           <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
27322           <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
27323           <li><a href="#dynamic_android.lens.focusRange">android.lens.focusRange</a> (dynamic)</li>
27324           <li><a href="#static_android.request.maxNumOutputStreams">android.request.maxNumOutputStreams</a> (static)</li>
27325           <li><a href="#controls_android.scaler.cropRegion">android.scaler.cropRegion</a> (controls)</li>
27326           <li><a href="#static_android.scaler.availableFormats">android.scaler.availableFormats</a> (static)</li>
27327           <li><a href="#static_android.scaler.availableJpegMinDurations">android.scaler.availableJpegMinDurations</a> (static)</li>
27328           <li><a href="#static_android.scaler.availableJpegSizes">android.scaler.availableJpegSizes</a> (static)</li>
27329           <li><a href="#static_android.scaler.availableMaxDigitalZoom">android.scaler.availableMaxDigitalZoom</a> (static)</li>
27330           <li><a href="#static_android.scaler.availableProcessedMinDurations">android.scaler.availableProcessedMinDurations</a> (static)</li>
27331           <li><a href="#static_android.scaler.availableProcessedSizes">android.scaler.availableProcessedSizes</a> (static)</li>
27332           <li><a href="#static_android.scaler.availableRawMinDurations">android.scaler.availableRawMinDurations</a> (static)</li>
27333           <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
27334           <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
27335           <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
27336           <li><a href="#static_android.sensor.orientation">android.sensor.orientation</a> (static)</li>
27337           <li><a href="#dynamic_android.sensor.timestamp">android.sensor.timestamp</a> (dynamic)</li>
27338           <li><a href="#controls_android.statistics.faceDetectMode">android.statistics.faceDetectMode</a> (controls)</li>
27339           <li><a href="#static_android.statistics.info.maxFaceCount">android.statistics.info.maxFaceCount</a> (static)</li>
27340           <li><a href="#dynamic_android.statistics.faceIds">android.statistics.faceIds</a> (dynamic)</li>
27341           <li><a href="#dynamic_android.statistics.faceLandmarks">android.statistics.faceLandmarks</a> (dynamic)</li>
27342           <li><a href="#dynamic_android.statistics.faceRectangles">android.statistics.faceRectangles</a> (dynamic)</li>
27343           <li><a href="#dynamic_android.statistics.faceScores">android.statistics.faceScores</a> (dynamic)</li>
27344           <li><a href="#dynamic_android.lens.focalLength">android.lens.focalLength</a> (dynamic)</li>
27345           <li><a href="#dynamic_android.lens.focusDistance">android.lens.focusDistance</a> (dynamic)</li>
27346         </ul>
27347       </li> <!-- tag_BC -->
27348       <li id="tag_V1">V1 -
27349         New features for first camera 2 release (API1)
27350
27351         <ul class="tags_entries">
27352           <li><a href="#static_android.colorCorrection.availableAberrationModes">android.colorCorrection.availableAberrationModes</a> (static)</li>
27353           <li><a href="#static_android.control.availableHighSpeedVideoConfigurations">android.control.availableHighSpeedVideoConfigurations</a> (static)</li>
27354           <li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>
27355           <li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>
27356           <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
27357           <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
27358           <li><a href="#controls_android.lens.aperture">android.lens.aperture</a> (controls)</li>
27359           <li><a href="#controls_android.lens.filterDensity">android.lens.filterDensity</a> (controls)</li>
27360           <li><a href="#controls_android.lens.focalLength">android.lens.focalLength</a> (controls)</li>
27361           <li><a href="#controls_android.lens.focusDistance">android.lens.focusDistance</a> (controls)</li>
27362           <li><a href="#controls_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (controls)</li>
27363           <li><a href="#static_android.lens.info.availableApertures">android.lens.info.availableApertures</a> (static)</li>
27364           <li><a href="#static_android.lens.info.availableFilterDensities">android.lens.info.availableFilterDensities</a> (static)</li>
27365           <li><a href="#static_android.lens.info.availableFocalLengths">android.lens.info.availableFocalLengths</a> (static)</li>
27366           <li><a href="#static_android.lens.info.availableOpticalStabilization">android.lens.info.availableOpticalStabilization</a> (static)</li>
27367           <li><a href="#static_android.lens.info.minimumFocusDistance">android.lens.info.minimumFocusDistance</a> (static)</li>
27368           <li><a href="#static_android.lens.info.shadingMapSize">android.lens.info.shadingMapSize</a> (static)</li>
27369           <li><a href="#static_android.lens.info.focusDistanceCalibration">android.lens.info.focusDistanceCalibration</a> (static)</li>
27370           <li><a href="#dynamic_android.lens.state">android.lens.state</a> (dynamic)</li>
27371           <li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>
27372           <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>
27373           <li><a href="#controls_android.request.id">android.request.id</a> (controls)</li>
27374           <li><a href="#static_android.scaler.availableMinFrameDurations">android.scaler.availableMinFrameDurations</a> (static)</li>
27375           <li><a href="#static_android.scaler.availableStallDurations">android.scaler.availableStallDurations</a> (static)</li>
27376           <li><a href="#controls_android.sensor.exposureTime">android.sensor.exposureTime</a> (controls)</li>
27377           <li><a href="#controls_android.sensor.frameDuration">android.sensor.frameDuration</a> (controls)</li>
27378           <li><a href="#controls_android.sensor.sensitivity">android.sensor.sensitivity</a> (controls)</li>
27379           <li><a href="#static_android.sensor.info.sensitivityRange">android.sensor.info.sensitivityRange</a> (static)</li>
27380           <li><a href="#static_android.sensor.info.exposureTimeRange">android.sensor.info.exposureTimeRange</a> (static)</li>
27381           <li><a href="#static_android.sensor.info.maxFrameDuration">android.sensor.info.maxFrameDuration</a> (static)</li>
27382           <li><a href="#static_android.sensor.info.physicalSize">android.sensor.info.physicalSize</a> (static)</li>
27383           <li><a href="#static_android.sensor.info.timestampSource">android.sensor.info.timestampSource</a> (static)</li>
27384           <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
27385           <li><a href="#dynamic_android.sensor.rollingShutterSkew">android.sensor.rollingShutterSkew</a> (dynamic)</li>
27386           <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
27387           <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
27388           <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
27389           <li><a href="#dynamic_android.sync.frameNumber">android.sync.frameNumber</a> (dynamic)</li>
27390           <li><a href="#static_android.sync.maxLatency">android.sync.maxLatency</a> (static)</li>
27391           <li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>
27392           <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
27393           <li><a href="#dynamic_android.lens.aperture">android.lens.aperture</a> (dynamic)</li>
27394           <li><a href="#dynamic_android.lens.filterDensity">android.lens.filterDensity</a> (dynamic)</li>
27395           <li><a href="#dynamic_android.lens.opticalStabilizationMode">android.lens.opticalStabilizationMode</a> (dynamic)</li>
27396           <li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>
27397         </ul>
27398       </li> <!-- tag_V1 -->
27399       <li id="tag_RAW">RAW -
27400         Needed for useful RAW image processing and DNG file support
27401
27402         <ul class="tags_entries">
27403           <li><a href="#controls_android.hotPixel.mode">android.hotPixel.mode</a> (controls)</li>
27404           <li><a href="#static_android.hotPixel.availableHotPixelModes">android.hotPixel.availableHotPixelModes</a> (static)</li>
27405           <li><a href="#static_android.sensor.info.activeArraySize">android.sensor.info.activeArraySize</a> (static)</li>
27406           <li><a href="#static_android.sensor.info.colorFilterArrangement">android.sensor.info.colorFilterArrangement</a> (static)</li>
27407           <li><a href="#static_android.sensor.info.pixelArraySize">android.sensor.info.pixelArraySize</a> (static)</li>
27408           <li><a href="#static_android.sensor.info.whiteLevel">android.sensor.info.whiteLevel</a> (static)</li>
27409           <li><a href="#static_android.sensor.info.preCorrectionActiveArraySize">android.sensor.info.preCorrectionActiveArraySize</a> (static)</li>
27410           <li><a href="#static_android.sensor.referenceIlluminant1">android.sensor.referenceIlluminant1</a> (static)</li>
27411           <li><a href="#static_android.sensor.referenceIlluminant2">android.sensor.referenceIlluminant2</a> (static)</li>
27412           <li><a href="#static_android.sensor.calibrationTransform1">android.sensor.calibrationTransform1</a> (static)</li>
27413           <li><a href="#static_android.sensor.calibrationTransform2">android.sensor.calibrationTransform2</a> (static)</li>
27414           <li><a href="#static_android.sensor.colorTransform1">android.sensor.colorTransform1</a> (static)</li>
27415           <li><a href="#static_android.sensor.colorTransform2">android.sensor.colorTransform2</a> (static)</li>
27416           <li><a href="#static_android.sensor.forwardMatrix1">android.sensor.forwardMatrix1</a> (static)</li>
27417           <li><a href="#static_android.sensor.forwardMatrix2">android.sensor.forwardMatrix2</a> (static)</li>
27418           <li><a href="#static_android.sensor.blackLevelPattern">android.sensor.blackLevelPattern</a> (static)</li>
27419           <li><a href="#static_android.sensor.profileHueSatMapDimensions">android.sensor.profileHueSatMapDimensions</a> (static)</li>
27420           <li><a href="#dynamic_android.sensor.neutralColorPoint">android.sensor.neutralColorPoint</a> (dynamic)</li>
27421           <li><a href="#dynamic_android.sensor.noiseProfile">android.sensor.noiseProfile</a> (dynamic)</li>
27422           <li><a href="#dynamic_android.sensor.profileHueSatMap">android.sensor.profileHueSatMap</a> (dynamic)</li>
27423           <li><a href="#dynamic_android.sensor.profileToneCurve">android.sensor.profileToneCurve</a> (dynamic)</li>
27424           <li><a href="#dynamic_android.sensor.greenSplit">android.sensor.greenSplit</a> (dynamic)</li>
27425           <li><a href="#dynamic_android.sensor.dynamicBlackLevel">android.sensor.dynamicBlackLevel</a> (dynamic)</li>
27426           <li><a href="#dynamic_android.sensor.dynamicWhiteLevel">android.sensor.dynamicWhiteLevel</a> (dynamic)</li>
27427           <li><a href="#controls_android.statistics.hotPixelMapMode">android.statistics.hotPixelMapMode</a> (controls)</li>
27428           <li><a href="#static_android.statistics.info.availableHotPixelMapModes">android.statistics.info.availableHotPixelMapModes</a> (static)</li>
27429           <li><a href="#dynamic_android.statistics.hotPixelMap">android.statistics.hotPixelMap</a> (dynamic)</li>
27430           <li><a href="#controls_android.statistics.lensShadingMapMode">android.statistics.lensShadingMapMode</a> (controls)</li>
27431           <li><a href="#dynamic_android.hotPixel.mode">android.hotPixel.mode</a> (dynamic)</li>
27432         </ul>
27433       </li> <!-- tag_RAW -->
27434       <li id="tag_HAL2">HAL2 -
27435         Entry is only used by camera device HAL 2.x
27436
27437         <ul class="tags_entries">
27438           <li><a href="#controls_android.request.inputStreams">android.request.inputStreams</a> (controls)</li>
27439           <li><a href="#controls_android.request.outputStreams">android.request.outputStreams</a> (controls)</li>
27440           <li><a href="#controls_android.request.type">android.request.type</a> (controls)</li>
27441           <li><a href="#static_android.request.maxNumReprocessStreams">android.request.maxNumReprocessStreams</a> (static)</li>
27442           <li><a href="#controls_android.blackLevel.lock">android.blackLevel.lock</a> (controls)</li>
27443         </ul>
27444       </li> <!-- tag_HAL2 -->
27445       <li id="tag_FULL">FULL -
27446         Entry is required for full hardware level devices, and optional for other hardware levels
27447
27448         <ul class="tags_entries">
27449           <li><a href="#static_android.sensor.maxAnalogSensitivity">android.sensor.maxAnalogSensitivity</a> (static)</li>
27450         </ul>
27451       </li> <!-- tag_FULL -->
27452       <li id="tag_DEPTH">DEPTH -
27453         Entry is required for the depth capability.
27454
27455         <ul class="tags_entries">
27456           <li><a href="#static_android.lens.poseRotation">android.lens.poseRotation</a> (static)</li>
27457           <li><a href="#static_android.lens.poseTranslation">android.lens.poseTranslation</a> (static)</li>
27458           <li><a href="#static_android.lens.intrinsicCalibration">android.lens.intrinsicCalibration</a> (static)</li>
27459           <li><a href="#static_android.lens.radialDistortion">android.lens.radialDistortion</a> (static)</li>
27460           <li><a href="#static_android.depth.maxDepthSamples">android.depth.maxDepthSamples</a> (static)</li>
27461           <li><a href="#static_android.depth.availableDepthStreamConfigurations">android.depth.availableDepthStreamConfigurations</a> (static)</li>
27462           <li><a href="#static_android.depth.availableDepthMinFrameDurations">android.depth.availableDepthMinFrameDurations</a> (static)</li>
27463           <li><a href="#static_android.depth.availableDepthStallDurations">android.depth.availableDepthStallDurations</a> (static)</li>
27464         </ul>
27465       </li> <!-- tag_DEPTH -->
27466       <li id="tag_REPROC">REPROC -
27467         Entry is required for the YUV or PRIVATE reprocessing capability.
27468
27469         <ul class="tags_entries">
27470           <li><a href="#controls_android.edge.mode">android.edge.mode</a> (controls)</li>
27471           <li><a href="#static_android.edge.availableEdgeModes">android.edge.availableEdgeModes</a> (static)</li>
27472           <li><a href="#controls_android.noiseReduction.mode">android.noiseReduction.mode</a> (controls)</li>
27473           <li><a href="#static_android.noiseReduction.availableNoiseReductionModes">android.noiseReduction.availableNoiseReductionModes</a> (static)</li>
27474           <li><a href="#static_android.request.maxNumInputStreams">android.request.maxNumInputStreams</a> (static)</li>
27475           <li><a href="#static_android.scaler.availableInputOutputFormatsMap">android.scaler.availableInputOutputFormatsMap</a> (static)</li>
27476           <li><a href="#controls_android.reprocess.effectiveExposureFactor">android.reprocess.effectiveExposureFactor</a> (controls)</li>
27477           <li><a href="#static_android.reprocess.maxCaptureStall">android.reprocess.maxCaptureStall</a> (static)</li>
27478           <li><a href="#dynamic_android.edge.mode">android.edge.mode</a> (dynamic)</li>
27479           <li><a href="#dynamic_android.noiseReduction.mode">android.noiseReduction.mode</a> (dynamic)</li>
27480         </ul>
27481       </li> <!-- tag_REPROC -->
27482       <li id="tag_FUTURE">FUTURE -
27483         Entry is  under-specified and is not required for now. This is for book-keeping purpose,
27484         do not implement or use it, it may be revised for future.
27485
27486         <ul class="tags_entries">
27487           <li><a href="#controls_android.demosaic.mode">android.demosaic.mode</a> (controls)</li>
27488           <li><a href="#controls_android.edge.strength">android.edge.strength</a> (controls)</li>
27489           <li><a href="#controls_android.flash.firingPower">android.flash.firingPower</a> (controls)</li>
27490           <li><a href="#controls_android.flash.firingTime">android.flash.firingTime</a> (controls)</li>
27491           <li><a href="#static_android.flash.info.chargeDuration">android.flash.info.chargeDuration</a> (static)</li>
27492           <li><a href="#static_android.flash.colorTemperature">android.flash.colorTemperature</a> (static)</li>
27493           <li><a href="#static_android.flash.maxEnergy">android.flash.maxEnergy</a> (static)</li>
27494           <li><a href="#dynamic_android.jpeg.size">android.jpeg.size</a> (dynamic)</li>
27495           <li><a href="#controls_android.noiseReduction.strength">android.noiseReduction.strength</a> (controls)</li>
27496           <li><a href="#controls_android.request.metadataMode">android.request.metadataMode</a> (controls)</li>
27497           <li><a href="#static_android.sensor.baseGainFactor">android.sensor.baseGainFactor</a> (static)</li>
27498           <li><a href="#dynamic_android.sensor.temperature">android.sensor.temperature</a> (dynamic)</li>
27499           <li><a href="#controls_android.shading.strength">android.shading.strength</a> (controls)</li>
27500           <li><a href="#controls_android.statistics.histogramMode">android.statistics.histogramMode</a> (controls)</li>
27501           <li><a href="#controls_android.statistics.sharpnessMapMode">android.statistics.sharpnessMapMode</a> (controls)</li>
27502           <li><a href="#static_android.statistics.info.histogramBucketCount">android.statistics.info.histogramBucketCount</a> (static)</li>
27503           <li><a href="#static_android.statistics.info.maxHistogramCount">android.statistics.info.maxHistogramCount</a> (static)</li>
27504           <li><a href="#static_android.statistics.info.maxSharpnessMapValue">android.statistics.info.maxSharpnessMapValue</a> (static)</li>
27505           <li><a href="#static_android.statistics.info.sharpnessMapSize">android.statistics.info.sharpnessMapSize</a> (static)</li>
27506           <li><a href="#dynamic_android.statistics.histogram">android.statistics.histogram</a> (dynamic)</li>
27507           <li><a href="#dynamic_android.statistics.sharpnessMap">android.statistics.sharpnessMap</a> (dynamic)</li>
27508         </ul>
27509       </li> <!-- tag_FUTURE -->
27510     </ul>
27511   </div>
27512
27513   [ <a href="#">top</a> ]
27514
27515 </body>
27516 </html>